Add Driver for php-vips extension

Author: MKCG

Readme.md

@@ -153,11 +153,12 @@ Dynamic::convertInto($reader, "/output.jpg", Format::JPG);
 
 ## Drivers
 
-| Name    | Requirements                  | Description                                                  |
-| ------- | ----------------------------- | ------------------------------------------------------------ |
-| Dynamic | one of : ext-imagick, ext-gd  | Manipulates images using the appropriate PHP image extension |
-| Gd      | ext-gd                        | gd use only 7 bits for the alpha channel instead of 8        |
-| Imagick | ext-imagick                   | imagick must have been compiled against ImageMagick >= 6.4.0 |
+| Name    | Requirements            | Description                                                  |
+| ------- | ----------------------- | ------------------------------------------------------------ |
+| Dynamic | at least one of the ext | Manipulates images using the appropriate PHP image extension |
+| Gd      | ext-gd                  | gd use only 7 bits for the alpha channel instead of 8        |
+| Imagick | ext-imagick             | imagick must have been compiled against ImageMagick >= 6.4.0 |
+| Vips    | ext-vips                |                                                              |
 
 
 ## Supported images format

composer.json

@@ -16,7 +16,8 @@
     },
     "suggests": {
         "ext-gd": "Required to convert images using gd",
-        "ext-imagick": "Required to convert images using imagick"
+        "ext-imagick": "Required to convert images using imagick",
+        "ext-vips": "Required to convert images using vips"
     },
     "autoload": {
         "psr-4": {

src/Driver/Dynamic.php

@@ -34,6 +34,7 @@ class Dynamic
     public static function loadFromFile(string $filepath): ?Context
     {
         $function = match(true) {
+            function_exists('vips_image_new_from_file') => static::useVips(...),
             class_exists("\Imagick") => static::useImagick(...),
             class_exists("\GdImage") => static::useGdImage(...),
             default => throw new \Exception()
@@ -80,4 +81,18 @@ private static function useImagick(string $filepath): ?Context
 
         return new Context($descriptor, $iterator);
     }
+
+    private static function useVips(string $filepath): ?Context
+    {
+        try {
+            $image = Vips::loadFromFile($filepath);
+            $descriptor = Vips::createImageDescriptor($image, $filepath);
+        } catch (\Exception $e) {
+            return null;
+        }
+
+        $iterator = Vips::createIterator($image, $descriptor);
+
+        return new Context($descriptor, $iterator);
+    }
 }

src/Driver/Vips.php

@@ -0,0 +1,97 @@
+<?php
+
+/**
+ * MIT License
+ *
+ * Copyright (c) 2021 Kevin Masseix
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+namespace MKCG\Image\QOI\Driver;
+
+use MKCG\Image\QOI\ImageDescriptor;
+use MKCG\Image\QOI\Colorspace;
+use MKCG\Image\QOI\Context;
+use MKCG\Image\QOI\Format;
+
+class Vips
+{
+    public static function loadFromFile(string $filepath): mixed
+    {
+        return match(($result = vips_image_new_from_file($filepath, []))) {
+            -1 => throw new \Exception(),
+            default => $result['out']
+        };
+    }
+
+    public static function createImageDescriptor($image, string $filepath): ImageDescriptor
+    {
+        $width    = static::get($image, 'width');
+        $height   = static::get($image, 'height');
+        $bands    = static::get($image, 'bands');
+        $interpretation = static::get($image, 'interpretation');
+        $channels = 3;
+
+        if ($bands === 2 || $bands > 4 || ($bands === 4 && $interpretation !== "cmyk")) {
+            $channels = 4;
+        }
+
+        return new ImageDescriptor($width, $height, $channels, Colorspace::SRGB);
+    }
+
+    public static function createIterator($image, ImageDescriptor $descriptor): iterable
+    {
+        $bin = vips_image_write_to_memory($image) or throw new \Exception();
+        $length = strlen($bin);
+
+        $bands = static::get($image, 'bands');
+
+        if ($bands === 1) {
+            for ($i = 0; $i < $length; $i++) {
+                $byte = ord($bin[$i]);
+                $alpha = $descriptor->channels === 4 ? $byte : 255;
+                yield [ $byte, $byte, $byte, $alpha ];
+            }
+        } else {
+            if ($length !== $descriptor->countBytes()) {
+                throw new \Exception();
+            }
+
+            for ($i = 0; $i < $length; $i += $descriptor->channels) {
+                $pixel = [
+                    ord($bin[$i]),
+                    ord($bin[$i + 1]),
+                    ord($bin[$i + 2]),
+                    $descriptor->channels == 4 ? ord($bin[$i + 3]) : 255,
+                ];
+
+                yield $pixel;
+            }
+        }
+    }
+
+    private static function get($image, $name)
+    {
+        return match(($result = vips_image_get($image, $name))) {
+            -1 => throw new \Exception(),
+            default => $result['out'],
+        };
+    }
+}

src/FFI/lib/Makefile

@@ -1,2 +1,2 @@
 build:
-	gcc qoi.c -O1 -std=gnu99 -shared -lm -o "./../bin/$(shell uname -p).so"
+	gcc qoi.c -O1 -std=gnu99 -shared -o "./../bin/$(shell uname -p).so"