From 4374d159317507e92401f6ddc58b7c2e78cd16d7 Mon Sep 17 00:00:00 2001
From: Oliver Vogel <oliver@olivervogel.com>
Date: Tue, 23 Aug 2022 20:21:00 +0200
Subject: [PATCH] Add encoders for MS Windows Bitmap format (BMP)

---
 src/Drivers/Abstract/AbstractImage.php        | 12 +++++++
 src/Drivers/Gd/Encoders/BmpEncoder.php        | 20 +++++++++++
 src/Drivers/Imagick/Encoders/BmpEncoder.php   | 26 ++++++++++++++
 tests/Drivers/Gd/Encoders/BmpEncoderTest.php  | 33 +++++++++++++++++
 .../Imagick/Encoders/BmpEncoderTest.php       | 36 +++++++++++++++++++
 5 files changed, 127 insertions(+)
 create mode 100644 src/Drivers/Gd/Encoders/BmpEncoder.php
 create mode 100644 src/Drivers/Imagick/Encoders/BmpEncoder.php
 create mode 100644 tests/Drivers/Gd/Encoders/BmpEncoderTest.php
 create mode 100644 tests/Drivers/Imagick/Encoders/BmpEncoderTest.php

diff --git a/src/Drivers/Abstract/AbstractImage.php b/src/Drivers/Abstract/AbstractImage.php
index fc2d6aad..1bd0f078 100644
--- a/src/Drivers/Abstract/AbstractImage.php
+++ b/src/Drivers/Abstract/AbstractImage.php
@@ -82,6 +82,18 @@ abstract class AbstractImage implements ImageInterface
         );
     }
 
+    public function toBitmap(): EncodedImage
+    {
+        return $this->encode(
+            $this->resolveDriverClass('Encoders\BmpEncoder')
+        );
+    }
+
+    public function toBmp(): EncodedImage
+    {
+        return $this->toBitmap();
+    }
+
     public function greyscale(): ImageInterface
     {
         return $this->modify(
diff --git a/src/Drivers/Gd/Encoders/BmpEncoder.php b/src/Drivers/Gd/Encoders/BmpEncoder.php
new file mode 100644
index 00000000..422c8b5b
--- /dev/null
+++ b/src/Drivers/Gd/Encoders/BmpEncoder.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace Intervention\Image\Drivers\Gd\Encoders;
+
+use Intervention\Image\Drivers\Abstract\Encoders\AbstractEncoder;
+use Intervention\Image\EncodedImage;
+use Intervention\Image\Interfaces\EncoderInterface;
+use Intervention\Image\Interfaces\ImageInterface;
+
+class BmpEncoder extends AbstractEncoder implements EncoderInterface
+{
+    public function encode(ImageInterface $image): EncodedImage
+    {
+        $data = $this->getBuffered(function () use ($image) {
+            imagebmp($image->getFrame()->getCore(), null, false);
+        });
+
+        return new EncodedImage($data, 'image/bmp');
+    }
+}
diff --git a/src/Drivers/Imagick/Encoders/BmpEncoder.php b/src/Drivers/Imagick/Encoders/BmpEncoder.php
new file mode 100644
index 00000000..6f6bd932
--- /dev/null
+++ b/src/Drivers/Imagick/Encoders/BmpEncoder.php
@@ -0,0 +1,26 @@
+<?php
+
+namespace Intervention\Image\Drivers\Imagick\Encoders;
+
+use Imagick;
+use Intervention\Image\Drivers\Abstract\Encoders\AbstractEncoder;
+use Intervention\Image\EncodedImage;
+use Intervention\Image\Interfaces\EncoderInterface;
+use Intervention\Image\Interfaces\ImageInterface;
+
+class BmpEncoder extends AbstractEncoder implements EncoderInterface
+{
+    public function encode(ImageInterface $image): EncodedImage
+    {
+        $format = 'bmp';
+        $compression = Imagick::COMPRESSION_NO;
+
+        $imagick = $image->getFrame()->getCore();
+        $imagick->setFormat($format);
+        $imagick->setImageFormat($format);
+        $imagick->setCompression($compression);
+        $imagick->setImageCompression($compression);
+
+        return new EncodedImage($imagick->getImagesBlob(), 'image/bmp');
+    }
+}
diff --git a/tests/Drivers/Gd/Encoders/BmpEncoderTest.php b/tests/Drivers/Gd/Encoders/BmpEncoderTest.php
new file mode 100644
index 00000000..d5e2480d
--- /dev/null
+++ b/tests/Drivers/Gd/Encoders/BmpEncoderTest.php
@@ -0,0 +1,33 @@
+<?php
+
+namespace Intervention\Image\Tests\Drivers\Gd\Encoders;
+
+use Intervention\Image\Collection;
+use Intervention\Image\Drivers\Gd\Encoders\BmpEncoder;
+use Intervention\Image\Drivers\Gd\Frame;
+use Intervention\Image\Drivers\Gd\Image;
+use Intervention\Image\Tests\TestCase;
+use Intervention\MimeSniffer\MimeSniffer;
+use Intervention\MimeSniffer\Types\ImageBmp;
+
+/**
+ * @requires extension gd
+ * @covers \Intervention\Image\Drivers\Gd\Encoders\PngEncoder
+ */
+class BmpEncoderTest extends TestCase
+{
+    protected function getTestImage(): Image
+    {
+        $frame = new Frame(imagecreatetruecolor(3, 2));
+
+        return new Image(new Collection([$frame]));
+    }
+
+    public function testEncode(): void
+    {
+        $image = $this->getTestImage();
+        $encoder = new BmpEncoder();
+        $result = $encoder->encode($image);
+        $this->assertTrue(MimeSniffer::createFromString($result)->matches(new ImageBmp));
+    }
+}
diff --git a/tests/Drivers/Imagick/Encoders/BmpEncoderTest.php b/tests/Drivers/Imagick/Encoders/BmpEncoderTest.php
new file mode 100644
index 00000000..2ae1dd51
--- /dev/null
+++ b/tests/Drivers/Imagick/Encoders/BmpEncoderTest.php
@@ -0,0 +1,36 @@
+<?php
+
+namespace Intervention\Image\Tests\Drivers\Imagick\Encoders;
+
+use Imagick;
+use ImagickPixel;
+use Intervention\Image\Drivers\Imagick\Encoders\BmpEncoder;
+use Intervention\Image\Drivers\Imagick\Image;
+use Intervention\Image\Tests\TestCase;
+use Intervention\MimeSniffer\MimeSniffer;
+use Intervention\MimeSniffer\Types\ImageBmp;
+
+/**
+ * @requires extension imagick
+ * @covers \Intervention\Image\Drivers\Imagick\Encoders\JpegEncoder
+ */
+class BmpEncoderTest extends TestCase
+{
+    protected function getTestImage(): Image
+    {
+        $imagick = new Imagick();
+        $imagick->newImage(3, 2, new ImagickPixel('red'), 'png');
+
+        return new Image($imagick);
+    }
+
+    public function testEncode(): void
+    {
+        $image = $this->getTestImage();
+        $encoder = new BmpEncoder();
+        $result = $encoder->encode($image);
+        $this->assertTrue(
+            MimeSniffer::createFromString($result)->matches(new ImageBmp())
+        );
+    }
+}