Add Encoder Options for progressive Jpeg & interlaced GIF format

composer.json

@@ -21,7 +21,7 @@
     "require": {
         "php": "^8.1",
         "ext-mbstring": "*",
-        "intervention/gif": "^4.0.1"
+        "intervention/gif": "^4.1"
     },
     "require-dev": {
         "phpunit/phpunit": "^10.0",

src/Drivers/Gd/Encoders/GifEncoder.php

@@ -23,7 +23,9 @@ class GifEncoder extends GenericGifEncoder implements SpecializedInterface
 
         $gd = $image->core()->native();
         $data = $this->buffered(function () use ($gd) {
+            imageinterlace($gd, $this->interlaced);
             imagegif($gd);
+            imageinterlace($gd, false);
         });
 
         return new EncodedImage($data, 'image/gif');
@@ -41,8 +43,9 @@ class GifEncoder extends GenericGifEncoder implements SpecializedInterface
 
         foreach ($image as $frame) {
             $builder->addFrame(
-                (string) $this->encode($frame->toImage($image->driver())),
-                $frame->delay()
+                source: (string) $this->encode($frame->toImage($image->driver())),
+                delay: $frame->delay(),
+                interlaced: $this->interlaced
             );
         }
 

src/Drivers/Gd/Encoders/JpegEncoder.php

@@ -17,6 +17,7 @@ class JpegEncoder extends GenericJpegEncoder implements SpecializedInterface
         $output = Cloner::cloneBlended($image->core()->native(), background: $image->blendingColor());
 
         $data = $this->buffered(function () use ($output) {
+            imageinterlace($output, $this->progressive);
             imagejpeg($output, null, $this->quality);
         });
 

src/Drivers/Imagick/Encoders/GifEncoder.php

@@ -24,6 +24,10 @@ class GifEncoder extends GenericGifEncoder implements SpecializedInterface
         $imagick->setCompression($compression);
         $imagick->setImageCompression($compression);
 
+        if ($this->interlaced) {
+            $imagick->setInterlaceScheme(Imagick::INTERLACE_LINE);
+        }
+
         return new EncodedImage($imagick->getImagesBlob(), 'image/gif');
     }
 }

src/Drivers/Imagick/Encoders/JpegEncoder.php

@@ -37,6 +37,10 @@ class JpegEncoder extends GenericJpegEncoder implements SpecializedInterface
         $imagick->setImageCompressionQuality($this->quality);
         $imagick->setImageAlphaChannel(Imagick::ALPHACHANNEL_REMOVE);
 
+        if ($this->progressive) {
+            $imagick->setInterlaceScheme(Imagick::INTERLACE_PLANE);
+        }
+
         return new EncodedImage($imagick->getImagesBlob(), 'image/jpeg');
     }
 }

src/Encoders/FileExtensionEncoder.php

@@ -11,17 +11,17 @@ use Intervention\Image\Interfaces\ImageInterface;
 
 class FileExtensionEncoder extends AutoEncoder
 {
+    protected array $options = [];
+
     /**
      * Create new encoder instance to encode to format of given file extension
      *
      * @param null|string $extension Target file extension for example "png"
-     * @param int $quality
      * @return void
      */
-    public function __construct(
-        public ?string $extension = null,
-        public int $quality = self::DEFAULT_QUALITY
-    ) {
+    public function __construct(public ?string $extension = null, mixed ...$options)
+    {
+        $this->options = $options;
     }
 
     /**
@@ -52,15 +52,15 @@ class FileExtensionEncoder extends AutoEncoder
         }
 
         return match (strtolower($extension)) {
-            'webp' => new WebpEncoder(quality: $this->quality),
-            'avif' => new AvifEncoder(quality: $this->quality),
-            'jpeg', 'jpg' => new JpegEncoder(quality: $this->quality),
-            'bmp' => new BmpEncoder(),
-            'gif' => new GifEncoder(),
-            'png' => new PngEncoder(),
-            'tiff', 'tif' => new TiffEncoder(quality: $this->quality),
-            'jp2', 'j2k', 'jpf', 'jpm', 'jpg2', 'j2c', 'jpc', 'jpx' => new Jpeg2000Encoder(quality: $this->quality),
-            'heic', 'heif' => new HeicEncoder(quality: $this->quality),
+            'webp' => new WebpEncoder(...$this->options),
+            'avif' => new AvifEncoder(...$this->options),
+            'jpeg', 'jpg' => new JpegEncoder(...$this->options),
+            'bmp' => new BmpEncoder(...$this->options),
+            'gif' => new GifEncoder(...$this->options),
+            'png' => new PngEncoder(...$this->options),
+            'tiff', 'tif' => new TiffEncoder(...$this->options),
+            'jp2', 'j2k', 'jpf', 'jpm', 'jpg2', 'j2c', 'jpc', 'jpx' => new Jpeg2000Encoder(...$this->options),
+            'heic', 'heif' => new HeicEncoder(...$this->options),
             default => throw new EncoderException('No encoder found for file extension (' . $extension . ').'),
         };
     }

src/Encoders/FilePathEncoder.php

@@ -13,14 +13,13 @@ class FilePathEncoder extends FileExtensionEncoder
      * Create new encoder instance to encode to format of file extension in given path
      *
      * @param null|string $path
-     * @param int $quality
      * @return void
      */
-    public function __construct(protected ?string $path = null, public int $quality = self::DEFAULT_QUALITY)
+    public function __construct(protected ?string $path = null, mixed ...$options)
     {
         parent::__construct(
             is_null($path) ? $path : pathinfo($path, PATHINFO_EXTENSION),
-            $quality
+            ...$options
         );
     }
 

src/Encoders/GifEncoder.php

@@ -8,7 +8,7 @@ use Intervention\Image\Drivers\SpecializableEncoder;
 
 class GifEncoder extends SpecializableEncoder
 {
-    public function __construct()
+    public function __construct(public bool $interlaced = false)
     {
     }
 }

src/Encoders/JpegEncoder.php

@@ -8,7 +8,9 @@ use Intervention\Image\Drivers\SpecializableEncoder;
 
 class JpegEncoder extends SpecializableEncoder
 {
-    public function __construct(public int $quality = self::DEFAULT_QUALITY)
-    {
+    public function __construct(
+        public int $quality = self::DEFAULT_QUALITY,
+        public bool $progressive = false
+    ) {
     }
 }

src/Encoders/MediaTypeEncoder.php

@@ -12,17 +12,17 @@ use Intervention\Image\Interfaces\ImageInterface;
 
 class MediaTypeEncoder extends AbstractEncoder
 {
+    protected array $options = [];
+
     /**
      * Create new encoder instance
      *
      * @param null|string $mediaType Target media type for example "image/jpeg"
-     * @param int $quality
      * @return void
      */
-    public function __construct(
-        public ?string $mediaType = null,
-        public int $quality = self::DEFAULT_QUALITY
-    ) {
+    public function __construct(public ?string $mediaType = null, mixed ...$options)
+    {
+        $this->options = $options;
     }
 
     /**
@@ -50,12 +50,12 @@ class MediaTypeEncoder extends AbstractEncoder
     {
         return match (strtolower($mediaType)) {
             'image/webp',
-            'image/x-webp' => new WebpEncoder(quality: $this->quality),
+            'image/x-webp' => new WebpEncoder(...$this->options),
             'image/avif',
-            'image/x-avif' => new AvifEncoder(quality: $this->quality),
+            'image/x-avif' => new AvifEncoder(...$this->options),
             'image/jpeg',
             'image/jpg',
-            'image/pjpeg' => new JpegEncoder(quality: $this->quality),
+            'image/pjpeg' => new JpegEncoder(...$this->options),
             'image/bmp',
             'image/ms-bmp',
             'image/x-bitmap',
@@ -63,16 +63,16 @@ class MediaTypeEncoder extends AbstractEncoder
             'image/x-ms-bmp',
             'image/x-win-bitmap',
             'image/x-windows-bmp',
-            'image/x-xbitmap' => new BmpEncoder(),
-            'image/gif' => new GifEncoder(),
+            'image/x-xbitmap' => new BmpEncoder(...$this->options),
+            'image/gif' => new GifEncoder(...$this->options),
             'image/png',
-            'image/x-png' => new PngEncoder(),
-            'image/tiff' => new TiffEncoder(quality: $this->quality),
+            'image/x-png' => new PngEncoder(...$this->options),
+            'image/tiff' => new TiffEncoder(...$this->options),
             'image/jp2',
             'image/jpx',
-            'image/jpm' => new Jpeg2000Encoder(quality: $this->quality),
+            'image/jpm' => new Jpeg2000Encoder(...$this->options),
             'image/heic',
-            'image/heif', => new HeicEncoder(quality: $this->quality),
+            'image/heif', => new HeicEncoder(...$this->options),
             default => throw new EncoderException('No encoder found for media type (' . $mediaType . ').'),
         };
     }

src/Image.php

@@ -299,7 +299,7 @@ final class Image implements ImageInterface
      *
      * @see ImageInterface::save()
      */
-    public function save(?string $path = null, ...$options): ImageInterface
+    public function save(?string $path = null, mixed ...$options): ImageInterface
     {
         $path = is_null($path) ? $this->origin()->filePath() : $path;
 

src/Interfaces/ImageInterface.php

@@ -88,7 +88,7 @@ interface ImageInterface extends IteratorAggregate, Countable
      * @throws RuntimeException
      * @return ImageInterface
      */
-    public function save(?string $path = null, ...$options): self;
+    public function save(?string $path = null, mixed ...$options): self;
 
     /**
      * Apply given modifier to current image

tests/ImagickTestCase.php

@@ -35,4 +35,22 @@ abstract class ImagickTestCase extends BaseTestCase
             new Core($imagick)
         );
     }
+
+    public function createTestAnimation(): Image
+    {
+        $imagick = new Imagick();
+        $imagick->setFormat('gif');
+
+        for ($i = 0; $i < 3; $i++) {
+            $frame = new Imagick();
+            $frame->newImage(3, 2, new ImagickPixel('rgb(255, 0, 0)'), 'gif');
+            $frame->setImageDelay(10);
+            $imagick->addImage($frame);
+        }
+
+        return new Image(
+            new Driver(),
+            new Core($imagick)
+        );
+    }
 }

tests/Traits/CanDetectProgressiveJpeg.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Intervention\Image\Tests\Traits;
+
+use Intervention\Image\Traits\CanBuildFilePointer;
+
+trait CanDetectProgressiveJpeg
+{
+    use CanBuildFilePointer;
+
+    /**
+     * Checks if the given image data is progressive encoded Jpeg format
+     *
+     * @param string $imagedata
+     * @return bool
+     */
+    private function isProgressiveJpeg(string $imagedata): bool
+    {
+        $f = $this->buildFilePointer($imagedata);
+
+        while (!feof($f)) {
+            if (unpack('C', fread($f, 1))[1] !== 0xff) {
+                return false;
+            }
+
+            $blockType = unpack('C', fread($f, 1))[1];
+
+            switch (true) {
+                case $blockType == 0xd8:
+                case $blockType >= 0xd0 && $blockType <= 0xd7:
+                    break;
+
+                case $blockType == 0xc0:
+                    fclose($f);
+                    return false;
+
+                case $blockType == 0xc2:
+                    fclose($f);
+                    return true;
+
+                case $blockType == 0xd9:
+                    break 2;
+
+                default:
+                    $blockSize = unpack('n', fread($f, 2))[1];
+                    fseek($f, $blockSize - 2, SEEK_CUR);
+                    break;
+            }
+        }
+
+        fclose($f);
+
+        return false;
+    }
+}

tests/Unit/Drivers/Gd/Encoders/GifEncoderTest.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace Intervention\Image\Tests\Unit\Drivers\Gd\Encoders;
 
+use Intervention\Gif\Decoder;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\RequiresPhpExtension;
 use Intervention\Image\Encoders\GifEncoder;
@@ -20,5 +21,30 @@ final class GifEncoderTest extends GdTestCase
         $encoder = new GifEncoder();
         $result = $encoder->encode($image);
         $this->assertMediaType('image/gif', (string) $result);
+        $this->assertFalse(
+            Decoder::decode((string) $result)->getFirstFrame()->getImageDescriptor()->isInterlaced()
+        );
+    }
+
+    public function testEncodeInterlaced(): void
+    {
+        $image = $this->createTestImage(3, 2);
+        $encoder = new GifEncoder(interlaced: true);
+        $result = $encoder->encode($image);
+        $this->assertMediaType('image/gif', (string) $result);
+        $this->assertTrue(
+            Decoder::decode((string) $result)->getFirstFrame()->getImageDescriptor()->isInterlaced()
+        );
+    }
+
+    public function testEncodeInterlacedAnimation(): void
+    {
+        $image = $this->createTestAnimation(3, 2);
+        $encoder = new GifEncoder(interlaced: true);
+        $result = $encoder->encode($image);
+        $this->assertMediaType('image/gif', (string) $result);
+        $this->assertTrue(
+            Decoder::decode((string) $result)->getFirstFrame()->getImageDescriptor()->isInterlaced()
+        );
     }
 }

tests/Unit/Drivers/Gd/Encoders/JpegEncoderTest.php

@@ -8,12 +8,15 @@ use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\RequiresPhpExtension;
 use Intervention\Image\Encoders\JpegEncoder;
 use Intervention\Image\Tests\GdTestCase;
+use Intervention\Image\Tests\Traits\CanDetectProgressiveJpeg;
 
 #[RequiresPhpExtension('gd')]
 #[CoversClass(\Intervention\Image\Encoders\JpegEncoder::class)]
 #[CoversClass(\Intervention\Image\Drivers\Gd\Encoders\JpegEncoder::class)]
 final class JpegEncoderTest extends GdTestCase
 {
+    use CanDetectProgressiveJpeg;
+
     public function testEncode(): void
     {
         $image = $this->createTestImage(3, 2);
@@ -21,4 +24,13 @@ final class JpegEncoderTest extends GdTestCase
         $result = $encoder->encode($image);
         $this->assertMediaType('image/jpeg', (string) $result);
     }
+
+    public function testEncodeProgressive(): void
+    {
+        $image = $this->createTestImage(3, 2);
+        $encoder = new JpegEncoder(progressive: true);
+        $result = $encoder->encode($image);
+        $this->assertMediaType('image/jpeg', (string) $result);
+        $this->assertTrue($this->isProgressiveJpeg((string) $result));
+    }
 }

tests/Unit/Drivers/Imagick/Encoders/GifEncoderTest.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace Intervention\Image\Tests\Unit\Drivers\Imagick\Encoders;
 
+use Intervention\Gif\Decoder;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\RequiresPhpExtension;
 use Intervention\Image\Encoders\GifEncoder;
@@ -20,5 +21,30 @@ final class GifEncoderTest extends ImagickTestCase
         $encoder = new GifEncoder();
         $result = $encoder->encode($image);
         $this->assertMediaType('image/gif', (string) $result);
+        $this->assertFalse(
+            Decoder::decode((string) $result)->getFirstFrame()->getImageDescriptor()->isInterlaced()
+        );
+    }
+
+    public function testEncodeInterlaced(): void
+    {
+        $image = $this->createTestImage(3, 2);
+        $encoder = new GifEncoder(interlaced: true);
+        $result = $encoder->encode($image);
+        $this->assertMediaType('image/gif', (string) $result);
+        $this->assertTrue(
+            Decoder::decode((string) $result)->getFirstFrame()->getImageDescriptor()->isInterlaced()
+        );
+    }
+
+    public function testEncodeInterlacedAnimation(): void
+    {
+        $image = $this->createTestAnimation();
+        $encoder = new GifEncoder(interlaced: true);
+        $result = $encoder->encode($image);
+        $this->assertMediaType('image/gif', (string) $result);
+        $this->assertTrue(
+            Decoder::decode((string) $result)->getFirstFrame()->getImageDescriptor()->isInterlaced()
+        );
     }
 }

tests/Unit/Drivers/Imagick/Encoders/JpegEncoderTest.php

@@ -8,12 +8,15 @@ use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\RequiresPhpExtension;
 use Intervention\Image\Encoders\JpegEncoder;
 use Intervention\Image\Tests\ImagickTestCase;
+use Intervention\Image\Tests\Traits\CanDetectProgressiveJpeg;
 
 #[RequiresPhpExtension('imagick')]
 #[CoversClass(\Intervention\Image\Encoders\JpegEncoder::class)]
 #[CoversClass(\Intervention\Image\Drivers\Imagick\Encoders\JpegEncoder::class)]
 final class JpegEncoderTest extends ImagickTestCase
 {
+    use CanDetectProgressiveJpeg;
+
     public function testEncode(): void
     {
         $image = $this->createTestImage(3, 2);
@@ -21,4 +24,13 @@ final class JpegEncoderTest extends ImagickTestCase
         $result = $encoder->encode($image);
         $this->assertMediaType('image/jpeg', (string) $result);
     }
+
+    public function testEncodeProgressive(): void
+    {
+        $image = $this->createTestImage(3, 2);
+        $encoder = new JpegEncoder(progressive: true);
+        $result = $encoder->encode($image);
+        $this->assertMediaType('image/jpeg', (string) $result);
+        $this->assertTrue($this->isProgressiveJpeg((string) $result));
+    }
 }