Switch to php ffi (#133)

Rewrite for php-ffi

Author: jcupitt

CHANGELOG.md

@@ -1,6 +1,27 @@
 # Changelog
+
 All notable changes to `:vips` will be documented in this file.
 
+## 2.0.0 - 2022-1-20
+
+Rewritten to use PHP FFI to call into the libvips library rather than a binary
+extension. This means php-vips now requires php 7.4 or later.
+
+### Added
+- `Interpolate` class
+
+### Deprecated
+- Nothing
+
+### Fixed
+- Nothing
+
+### Remove
+- Nothing
+
+### Security
+- Nothing
+
 ### 1.0.9 - 2021-11-20
 
 ### Added
@@ -18,7 +39,7 @@ All notable changes to `:vips` will be documented in this file.
 ### Security
 - Nothing
 
-### 1.0.8 - 2020-08-29
+## 1.0.8 - 2020-08-29
 
 ### Added
 - allow type names as type params to Image::setType() -- fixes issue with GType
@@ -36,7 +57,7 @@ All notable changes to `:vips` will be documented in this file.
 ### Security
 - Nothing
 
-### 1.0.7 - 2020-08-28
+## 1.0.7 - 2020-08-28
 
 ### Added
 - use nullable types and void return type where possible

README.md

@@ -2,8 +2,8 @@
 
 [![Build Status](https://travis-ci.org/libvips/php-vips.svg?branch=master)](https://travis-ci.org/libvips/php-vips)
 
-`php-vips` is a binding for [libvips](https://github.com/libvips/libvips) for
-PHP 7. 
+`php-vips` is a binding for [libvips](https://github.com/libvips/libvips) 8.7
+and later for PHP 7.4 and later.
 
 libvips is fast and needs little memory. The
 [`vips-php-bench`](https://github.com/jcupitt/php-vips-bench) repository
@@ -17,54 +17,30 @@ image. When the pipe is connected to a destination, the whole pipeline
 executes at once and in parallel, streaming the image from source to
 destination in a set of small fragments.
 
-This module builds upon the `vips` PHP extension:
+### Install
 
-https://github.com/libvips/php-vips-ext
+You need to [install the libvips
+library](https://libvips.github.io/libvips/install.html). It's in the linux
+package managers, homebrew and MacPorts, and there are Windows binaries on
+the vips website. For example, on Debian:
 
-You'll need to install that first. It's tested on Linux and macOS --- 
-Windows would need some work, but should be possible.  
-
-See the README there, but briefly:
-
-1. [Install the libvips library and
-   headers](https://libvips.github.io/libvips/install.html). It's in
-   the linux package managers, homebrew and MacPorts, and there are Windows
-   binaries on the vips website. For example, on Debian:
-
-   ```
-   sudo apt-get install libvips-dev
-   ```
-
-   Or macOS:
-
-   ```
-   brew install vips
-   ```
-
-2. Install the binary PHP extension. You'll need a PHP development environment
-   for this, since it will download and build the sources for the extension.
-   For example, on Debian:
-
-   ```
-   sudo apt-get install php-pear
-   ```
-
-   Then to download and build the extension it's:
+```
+sudo apt-get install libvips-dev
+```
 
-   ```
-   pecl install vips
-   ```
+Or macOS:
 
-   You may need to add `extension=vips.so` or equivalent to `php.ini`, see the
-   output of pecl.
+```
+brew install vips
+```
 
-3. Add vips to your `composer.json`:
+Then add vips to your `composer.json`:
 
-   ```
-     "require": {
-       "jcupitt/vips" : "1.0.7"
-     }
-   ```
+```
+"require": {
+    "jcupitt/vips" : "2.0.0"
+}
+```
 
 ### Example
 
@@ -156,17 +132,17 @@ introduction:
 
 https://libvips.github.io/libvips/API/current
 
-### How it works
+### TODO after merge
+
+- Support preloading, see https://www.php.net/manual/en/class.ffi.php
+
+- Rewrite the enum and doc generator in php.
+
+- Add source/target API
 
-The `vips` extension defines a simple but ugly way to call any libvips
-operation from PHP.  It uses libvips' own introspection facilities
-and does not depend on anything else (so no gobject-introspection,
-for example). It's a fairly short 1,600 lines of C.
+- Add progress callbacks etc.
 
-This module is a PHP layer over the ugly `vips` extension that
-tries to make a nice interface for programmers. It uses `__call()` and
-`__get()` to make all libvips operations appear as methods, and all
-libvips properties as properties of the PHP `Vips\Image` class.
+- Add mutable.
 
 ### Test and install
 

RELEASE-1.0.8 renamed to RELEASE-2.0.0

@@ -17,15 +17,15 @@
         }
     ],
     "require": {
-        "php": ">=7.2",
-        "ext-vips": ">=0.1.2",
+        "php": ">=7.4",
+        "ext-ffi": "*",
         "psr/log": "^1.1.3|^2.0|^3.0"
     },
     "require-dev": {
-        "php-parallel-lint/php-parallel-lint": "^1.2",
-        "phpdocumentor/phpdocumentor": "3.0.0",
-        "phpunit/phpunit": "^9.3",
-        "squizlabs/php_codesniffer": "^3.5"
+        "php-parallel-lint/php-parallel-lint": "^1.3",
+        "phpdocumentor/shim": "^3.3",
+        "phpunit/phpunit": "^9.5",
+        "squizlabs/php_codesniffer": "^3.6"
     },
     "autoload": {
         "psr-4": {
@@ -39,7 +39,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "1.0.x-dev"
+            "dev-master": "2.0.x-dev"
         }
     },
     "scripts": {

composer.json

@@ -0,0 +1,5 @@
+{
+    "require": {
+        "jcupitt/vips": "2.0.0"
+    }
+}

examples/composer.json

@@ -0,0 +1,44 @@
+#!/usr/bin/env php
+<?php
+
+require __DIR__ . '/vendor/autoload.php';
+use Jcupitt\Vips;
+
+Vips\Config::setLogger(new Vips\DebugLogger());
+
+if (count($argv) != 4) {
+    echo("usage: ./watermark.php input-image output-image watermark-image\n");
+    exit(1);
+}
+
+// we can stream the main image
+$image = Vips\Image::newFromFile($argv[1], ['access' => 'sequential']);
+
+// we'll read the watermark image many times, so we need random access for this
+$watermark = Vips\Image::newFromFile($argv[3]);
+
+// the watermark image needs to have an alpha channel
+if (!$watermark->hasAlpha() || $watermark->bands != 4) {
+    echo("watermark image is not RGBA\n");
+    exit(1);
+}
+
+// make the watermark semi-transparent
+$watermark = $watermark->multiply([1, 1, 1, 0.3])->cast("uchar");
+
+// repeat the watermark to the size of the image
+$watermark = $watermark->replicate(
+    1 + $image->width / $watermark->width,
+    1 + $image->height / $watermark->height
+);
+$watermark = $watermark->crop(0, 0, $image->width, $image->height);
+
+// composite the watermark over the main image
+$image = $image->composite2($watermark, 'over');
+
+$image->writeToFile($argv[2]);
+
+$image = null;
+$watermark = null;
+
+Vips\Config::shutDown();

examples/watermark-image.php

@@ -4,6 +4,8 @@
 require __DIR__ . '/vendor/autoload.php';
 use Jcupitt\Vips;
 
+#Vips\Config::setLogger(new Vips\DebugLogger());
+
 if (count($argv) != 4) {
     echo("usage: ./watermark-text.php input output \"some text\"\n");
     exit(1);
@@ -30,7 +32,7 @@
 $foreground = [255, 255, 255, 50];
 $background = [0, 0, 255, 50];
 
-// and a 10-pixel marghin
+// and a 10-pixel margin
 $margin = 10;
 
 $overlay = $text_mask->ifthenelse($foreground, $background, [

examples/watermark-text.php

@@ -0,0 +1,69 @@
+<?php
+
+/**
+ * PHP version 7
+ *
+ * LICENSE:
+ *
+ * Copyright (c) 2016 John Cupitt
+ *
+ * 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.
+ *
+ * @category  Images
+ * @package   Jcupitt\Vips
+ * @author    John Cupitt <jcupitt@gmail.com>
+ * @copyright 2016 John Cupitt
+ * @license   https://opensource.org/licenses/MIT MIT
+ * @link      https://github.com/jcupitt/php-vips
+ */
+
+namespace Jcupitt\Vips;
+
+/**
+ * The ArgumentFlags enum.
+ * @category  Images
+ * @package   Jcupitt\Vips
+ * @author    John Cupitt <jcupitt@gmail.com>
+ * @copyright 2016 John Cupitt
+ * @license   https://opensource.org/licenses/MIT MIT
+ * @link      https://github.com/jcupitt/php-vips
+ */
+abstract class ArgumentFlags
+{
+    const REQUIRED = 1;
+    const CONSTRUCT = 2;
+    const SET_ONCE = 4;
+    const SET_ALWAYS = 8;
+    const INPUT = 16;
+    const OUTPUT = 32;
+    const DEPRECATED = 64;
+    const MODIFY = 128;
+
+    const NAMES = [
+        "REQUIRED" => self::REQUIRED,
+        "CONSTRUCT" => self::CONSTRUCT,
+        "SET_ONCE" => self::SET_ONCE,
+        "SET_ALWAYS" => self::SET_ALWAYS,
+        "INPUT" => self::INPUT,
+        "OUTPUT" => self::OUTPUT,
+        "DEPRECATED" => self::DEPRECATED,
+        "MODIFY" => self::MODIFY,
+    ];
+}