Skip to content

Fix imagick stale layers #879

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mlocati merged 2 commits into from
Jun 4, 2026
Merged

Fix imagick stale layers #879

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e32407
Add tests showing Imagick layers() returns stale frames after multi-f…
nlemoine Jun 4, 2026
1f0b1fa
Fix Imagick layers() returning stale frames after multi-frame operations
nlemoine Jun 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 21 additions & 7 deletions src/Imagick/Image.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,20 @@ public function getImagick()
return $this->imagick;
}

/**
* Replaces the underlying \Imagick instance, invalidating the cached
* layers (if any) since they wrap the replaced instance.
*
* @param \Imagick $imagick
*/
private function setImagick(\Imagick $imagick)
{
if ($imagick !== $this->imagick) {
$this->imagick = $imagick;
$this->layers = null;
}
}

/**
* {@inheritdoc}
*
Expand Down Expand Up @@ -152,13 +166,13 @@ public function crop(PointInterface $start, BoxInterface $size)
try {
if ($this->layers()->count() > 1) {
// Crop each layer separately
$this->imagick = $this->imagick->coalesceImages();
$this->setImagick($this->imagick->coalesceImages());
foreach ($this->imagick as $frame) {
$frame->cropImage($size->getWidth(), $size->getHeight(), $start->getX(), $start->getY());
// Reset canvas for gif format
$frame->setImagePage(0, 0, 0, 0);
}
$this->imagick = $this->imagick->deconstructImages();
$this->setImagick($this->imagick->deconstructImages());
} else {
$this->imagick->cropImage($size->getWidth(), $size->getHeight(), $start->getX(), $start->getY());
// Reset canvas for gif format
Expand Down Expand Up @@ -284,11 +298,11 @@ public function resize(BoxInterface $size, $filter = ImageInterface::FILTER_UNDE
{
try {
if ($this->layers()->count() > 1) {
$this->imagick = $this->imagick->coalesceImages();
$this->setImagick($this->imagick->coalesceImages());
foreach ($this->imagick as $frame) {
$frame->resizeImage($size->getWidth(), $size->getHeight(), $this->getFilter($filter), 1);
}
$this->imagick = $this->imagick->deconstructImages();
$this->setImagick($this->imagick->deconstructImages());
} else {
$this->imagick->resizeImage($size->getWidth(), $size->getHeight(), $this->getFilter($filter), 1);
}
Expand Down Expand Up @@ -425,7 +439,7 @@ private function prepareOutput(array $options, $path = null)
} else {
$this->layers()->merge();
}
$this->imagick = $this->applyImageOptions($this->imagick, $options, $path);
$this->setImagick($this->applyImageOptions($this->imagick, $options, $path));

// flatten only if image has multiple layers
if ((!isset($options['flatten']) || $options['flatten'] === true) && $this->layers()->count() > 1) {
Expand Down Expand Up @@ -739,9 +753,9 @@ private function flatten()
// @see https://github.com/mkoppanen/imagick/issues/45
try {
if (method_exists($this->imagick, 'mergeImageLayers') && defined('Imagick::LAYERMETHOD_UNDEFINED')) {
$this->imagick = $this->imagick->mergeImageLayers(\Imagick::LAYERMETHOD_UNDEFINED);
$this->setImagick($this->imagick->mergeImageLayers(\Imagick::LAYERMETHOD_UNDEFINED));
} elseif (method_exists($this->imagick, 'flattenImages')) {
$this->imagick = $this->imagick->flattenImages();
$this->setImagick($this->imagick->flattenImages());
}
} catch (\ImagickException $e) {
throw new RuntimeException('Flatten operation failed', $e->getCode(), $e);
Expand Down
43 changes: 43 additions & 0 deletions tests/tests/Imagick/ImageTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,49 @@ public function testAnimatedGifCrop()
);
}

public function testLayersReflectResizedFramesAfterResize()
{
$imagine = $this->getImagine();
$image = $imagine->open(IMAGINE_TEST_FIXTURESFOLDER . '/anima.gif');
$image->resize(new Box(59, 75));
$layers = $image->layers();
$this->assertCount(3, $layers);
$layers->coalesce();
foreach ($layers as $index => $frame) {
$this->assertEquals(new Box(59, 75), $frame->getSize(), sprintf('Frame %d should have the resized size', $index));
}
}

public function testLayersReflectCroppedFramesAfterCrop()
{
$imagine = $this->getImagine();
$image = $imagine->open(IMAGINE_TEST_FIXTURESFOLDER . '/anima.gif');
// Crop inside the region where the animation frames actually differ,
// so that deconstructImages() keeps all the frames
$image->crop(new Point(110, 70), new Box(50, 40));
$layers = $image->layers();
$this->assertCount(3, $layers);
$layers->coalesce();
foreach ($layers as $index => $frame) {
$this->assertEquals(new Box(50, 40), $frame->getSize(), sprintf('Frame %d should have the cropped size', $index));
}
}

public function testAnimatedDelayAndLoopsAreAppliedAfterResize()
{
$imagine = $this->getImagine();
$image = $imagine->open(IMAGINE_TEST_FIXTURESFOLDER . '/anima.gif');
$image->resize(new Box(59, 75));
$filename = $this->getTemporaryFilename('.gif');
$image->save($filename, array('animated' => true, 'animated.delay' => 500, 'animated.loops' => 3));
$imagick = new \Imagick($filename);
$delay = $imagick->getImageDelay();
$iterations = $imagick->getImageIterations();
$imagick->clear();
$this->assertSame(50, $delay);
$this->assertSame(3, $iterations);
}

public function testOptimize()
{
$imagine = $this->getImagine();
Expand Down
Loading