Add newFromMemory / writeToMemory

Author: kleisauke

src/Image.php

@@ -123,7 +123,7 @@
  * $im = $im->conv($mask);
  * ```
  *
- * `Image::new_from_array` creates an image from an array constant. The 8 at
+ * `Image::newFromArray` creates an image from an array constant. The 8 at
  * the end sets the scale: the amount to divide the image by after
  * integer convolution. See the libvips API docs for `vips_conv()` (the operation
  * invoked by `Image::conv`) for details on the convolution operator. See
@@ -930,6 +930,40 @@ public static function newFromArray(
         return $result;
     }
 
+    /**
+     * Wraps an Image around an area of memory containing a C-style array.
+     *
+     * @param array  $data   C-style array.
+     * @param int    $width  Image width in pixels.
+     * @param int    $height Image height in pixels.
+     * @param int    $bands  Number of bands.
+     * @param string $format Band format. (@see BandFormat)
+     *
+     * @return Image A new Image.
+     */
+    public static function newFromMemory(
+        array $data,
+        int $width,
+        int $height,
+        int $bands,
+        string $format
+    ): Image {
+        Utils::debugLog('newFromMemory', [
+            'instance' => null,
+            'arguments' => [$data, $width, $height, $bands, $format]
+        ]);
+
+        $result = vips_image_new_from_memory($data, $width, $height, $bands, $format);
+        if ($result === -1) {
+            self::errorVips();
+        }
+        $result = self::wrapResult($result);
+
+        Utils::debugLog('newFromMemory', ['result' => $result]);
+
+        return $result;
+    }
+
     /**
      * Make an interpolator from a name.
      *
@@ -1048,6 +1082,28 @@ public function writeToBuffer(string $suffix, array $options = []): string
         return $result;
     }
 
+    /**
+     * Write an image to a large memory array.
+     *
+     * @return array The memory array.
+     */
+    public function writeToMemory(): array
+    {
+        Utils::debugLog('writeToMemory', [
+            'instance' => $this,
+            'arguments' => []
+        ]);
+
+        $result = vips_image_write_to_memory($this->image);
+        if ($result === -1) {
+            self::errorVips();
+        }
+
+        Utils::debugLog('writeToMemory', ['result' => $result]);
+
+        return $result;
+    }
+
     /**
      * Copy to memory.
      *

tests/NewTest.php

@@ -107,6 +107,18 @@ public function testVipsNewInterpolator()
         $this->assertNotNull($interp);
         $this->assertEquals($widthInput * 2, $widthOutput);
     }
+
+    public function testVipsNewFromMemory()
+    {
+        $byte_array = array_fill(0, 200, 0);
+        $image = Vips\Image::newFromMemory($byte_array, 20, 10, 1, Vips\BandFormat::UCHAR);
+
+        $this->assertEquals($image->width, 20);
+        $this->assertEquals($image->height, 10);
+        $this->assertEquals($image->format, Vips\BandFormat::UCHAR);
+        $this->assertEquals($image->bands, 1);
+        $this->assertEquals($image->avg(), 0);
+    }
 }
 
 /*

tests/WriteTest.php

@@ -59,6 +59,15 @@ public function testVipsWriteToBuffer()
 
         $this->assertEquals($buffer1, $buffer2);
     }
+
+    public function testVipsWriteToMemory()
+    {
+        $byte_array = array_fill(0, 200, 0);
+        $image = Vips\Image::newFromMemory($byte_array, 20, 10, 1, Vips\BandFormat::UCHAR);
+        $mem_arr = $image->writeToMemory();
+
+        $this->assertEquals($byte_array, $mem_arr);
+    }
 }
 
 /*