Clean up code and add dependency for image loading

Author: marijnvdwerf

composer.json

@@ -1,15 +1,23 @@
 {
-    "name": "marijnvdwerf/material-palette",
-    "authors": [
-        {
-            "name": "Marijn van der Werf",
-            "email": "[email protected]"
-        }
-    ],
-    "autoload": {
-        "psr-4":{
-            "marijnvdwerf\\palette\\": "src/"
-        }
-    },
-    "require": {}
+  "name": "marijnvdwerf/material-palette",
+  "authors": [
+    {
+      "name": "Marijn van der Werf",
+      "email": "[email protected]",
+      "homepage": "http://marijnvdwerf.nl"
+    }
+  ],
+  "autoload": {
+    "psr-4": {
+      "marijnvdwerf\\palette\\": "src/"
+    }
+  },
+  "require": {
+    "php": ">=5.3.2",
+    "intervention/image": "~2.2"
+  },
+  "suggest": {
+    "ext-gd": "to use the GD implementation",
+    "ext-imagick": "to use the Imagick implementation"
+  }
 }

composer.lock

@@ -1,36 +1,58 @@
 <?php
 
-use marijnvdwerf\palette\ImagickHistogramGenerator;
+use Intervention\Image\ImageManager;
 use marijnvdwerf\palette\Palette;
 use marijnvdwerf\palette\Swatch;
 
 require 'vendor/autoload.php';
 
-$histogramGenerator = new ImagickHistogramGenerator();
-$colorQuantizer = new \marijnvdwerf\palette\ColorCutQuantizer();
+?>
+    <style type="text/css">
+        body {
+            font-family: Roboto, sans-serif;
+        }
 
+        * {
+            margin: 0;
+            padding: 0;
+            box-sizing: border-box;
+        }
 
-$files = scandir('./specs/artwork');
-foreach ($files as $file) {
-    if ($file[0] === '.') {
-        continue;
-    }
+        .swatch {
+            padding: 15px;
+            list-style-type: none;
+        }
+
+        .swatch__color {
+            float: right;
+        }
 
-    $image = new Imagick('./specs/artwork/' . $file);
+        .album {
+            width: 320px;
+        }
+    </style>
 
-    $image->sampleImage(100, 100);
+<?php
+$basePath = './specs/artwork';
+$files = scandir($basePath);
 
-    $image->setFormat('png');
+$manager = new ImageManager(array('driver' => 'imagick'));
+foreach ($files as $filename) {
+    if ($filename[0] === '.') {
+        continue;
+    }
 
-    $swatches = $histogramGenerator->generate($image);
+    $image = $manager->make($basePath . '/' . $filename);
 
-    $swatches = $colorQuantizer->quantize($swatches, 16);
+    $palette = Palette::generate($image);
 
-    //$palette = Palette::generate($swatches);
 
-    echo '<h1>' . $file . '</h1>';
-    echo "<img src='data:image/png;base64," . base64_encode($image->getImageBlob()) . "' />";
-    printSwatches($swatches);
+    echo '<div class="album">';
+    echo "<img src='data:image/png;base64," . base64_encode($image->encode('png')) . "' />";
+    echo '<h1>' . $filename . '</h1>';
+    printPalette($palette);
+    //printSwatches($swatches);
+    echo '</div>';
 }
 
 
@@ -61,7 +83,7 @@ function printPalette(Palette $palette)
 
             $swatchName = implode(' ', array_filter([$v2, $v1]));
             if ($swatch !== null) {
-                echo sprintf('<li class="swatch" style="background-color: %s">%s</li>', $swatch->getColor(), $swatchName);
+                echo sprintf('<li class="swatch" style="background-color: %1$s"><span class="swatch__name">%2$s</span> <span class="swatch__color">%1$s</span></li>', $swatch->getColor(), $swatchName);
             } else {
                 echo sprintf('<li class="swatch swatch--empty">%s</li>', $swatchName);
             }
@@ -70,3 +92,4 @@ function printPalette(Palette $palette)
     }
     echo '</ul>';
 }
+

index.php

@@ -28,7 +28,7 @@ public function quantize($swatches, $maxColors)
             $vbox = $pq->extract();
 
             if (!$vbox->canSplit()) {
-// No more boxes to split, so break;
+                // No more boxes to split, so break;
                 break;
             }
 
@@ -234,5 +234,4 @@ function __toString()
         return sprintf('[VBox count:%d volume:%f]', count($this->swatches), $this->getVolume());
     }
 
-
 }

src/ColorCutQuantizer.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace marijnvdwerf\palette;
+
+use Intervention\Image\Image;
+
+class GDHistogramGenerator extends HistogramGenerator
+{
+
+    /**
+     * @return Swatch
+     */
+    private function getSwatch($color, $count)
+    {
+        // opacity ranges from 127 (transparent) to 0 (opaque). Should be from 0 to 1;
+        $alpha = (127 - $color['alpha']) / 127;
+        return new Swatch(new RGBColor($color['red'] / 255, $color['green'] / 255, $color['blue'] / 255, $alpha), $count);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function generate(Image $input)
+    {
+        $image = $input->getCore();
+
+        if (!(is_resource($image) && get_resource_type($image) === 'gd')) {
+            throw new \Exception('This generator only support images using the GD driver');
+        }
+
+        $srcImage = $image;
+        if (imagesx($image) > 100 || imagesy($image) > 100) {
+            // new canvas
+            $image = imagecreatetruecolor(100, 100);
+
+            // fill with transparent color
+            imagealphablending($image, false);
+            $transparent = imagecolorallocatealpha($image, 255, 255, 255, 127);
+            imagefilledrectangle($image, 0, 0, 100, 100, $transparent);
+            imagecolortransparent($image, $transparent);
+            imagealphablending($image, true);
+
+            // copy original
+            imagecopyresized($image, $srcImage, 0, 0, 0, 0, 100, 100, imagesx($srcImage), imagesy($srcImage));
+        }
+
+        $colorOccurences = [];
+        for ($y = 0; $y < imagesy($image); $y++) {
+            for ($x = 0; $x < imagesx($image); $x++) {
+                $color = imagecolorat($image, $x, $y);
+                if (!isset($colorOccurences[$color])) {
+                    $colorOccurences[$color] = 0;
+                }
+
+                $colorOccurences[$color]++;
+            }
+        }
+
+        $palette = [];
+        foreach ($colorOccurences as $colorIndex => $count) {
+            $palette[] = $this->getSwatch(imagecolorsforindex($image, $colorIndex), $count);
+        }
+
+        if ($srcImage !== $image) {
+            // Destroy image if it was generated by this function
+            imagedestroy($image);
+        }
+
+        return $palette;
+    }
+}

src/GDHistogramGenerator.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace marijnvdwerf\palette;
+
+use Intervention\Image\Image;
+
+abstract class HistogramGenerator
+{
+    /**
+     * @param $image Image
+     * @return Swatch[];
+     */
+    public abstract function generate(Image $image);
+}

src/HistogramGenerator.php

@@ -3,7 +3,10 @@
 namespace marijnvdwerf\palette;
 
 
-class ImagickHistogramGenerator
+use Imagick;
+use Intervention\Image\Image;
+
+class ImagickHistogramGenerator extends HistogramGenerator
 {
     /**
      * @param \ImagickPixel $pixel
@@ -16,11 +19,29 @@ private function swatchForPixel(\ImagickPixel $pixel)
 
 
     /**
-     * @return Swatch[]
+     * @inheritdoc
      */
-    public function generate(\Imagick $image)
+    public function generate(Image $input)
     {
-        return array_map([$this, 'swatchForPixel'], $image->getImageHistogram());
+        $srcImage = $input->getCore();
+        if (!$srcImage instanceof Imagick) {
+            throw new \Exception('This class only supports generating histograms for Imagick images');
+        }
+
+        $image = $srcImage;
+
+        if ($image->getImageWidth() > 100 || $image->getImageHeight() > 100) {
+            $image = clone $srcImage;
+            $image->resizeImage(100, 100, Imagick::FILTER_POINT, 1);
+        }
+
+        $histogram = array_map([$this, 'swatchForPixel'], $image->getImageHistogram());
+
+        if ($image !== $srcImage) {
+            $image->destroy();
+        }
+
+        return $histogram;
     }
 
 }

src/ImagickHistogramGenerator.php

@@ -2,6 +2,8 @@
 
 namespace marijnvdwerf\palette;
 
+use Intervention\Image\Image;
+
 class Palette
 {
     const TARGET_DARK_LUMA = 0.26;
@@ -49,22 +51,27 @@ class Palette
     private $darkMutedSwatch;
 
     /**
-     * @param $swatches Swatch[]
+     * @param Image $image
      * @return Palette
      */
-    public static function generate($swatches)
+    public static function generate(Image $image)
     {
-        $palette = new Palette();
-        $palette->swatches = $swatches;
-        $palette->highestPopulation = $palette->findMaxPopulation();
+        return PaletteGenerator::getInstance()->generate($image);
+    }
 
-        $palette->generateVariationColors();
+    /**
+     * @param $swatches Swatch[]
+     * @return Palette
+     */
+    public function __construct($swatches)
+    {
+        $this->swatches = $swatches;
+        $this->highestPopulation = $this->findMaxPopulation();
 
+        $this->generateVariationColors();
 
         // Now try and generate any missing colors
-        $palette->generateEmptySwatches();
-
-        return $palette;
+        $this->generateEmptySwatches();
     }
 
     private function findMaxPopulation()