1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 

<?php

/**
 * MvcCore
 *
 * This source file is subject to the BSD 3 License
 * For the full copyright and license information, please view
 * the LICENSE.md file that are distributed with this source code.
 *
 * @copyright   Copyright (c) 2016 Tom Flidr (https://github.com/mvccore)
 * @license     https://mvccore.github.io/docs/mvccore/5.0.0/LICENCE.md
 */

namespace MvcCore\Ext\Tools\Images;

class Imagick extends \MvcCore\Ext\Tools\Image {

    /**
     * @var \Imagick
     */
    protected $resource;

    /**
     * @var string
     */
    protected $imgFullPath;

    /**
     * Load image into resource by given file fullpath.
     * @param string $imgFullPath
     * @throws \RuntimeException
     * @return bool|\MvcCore\Ext\Tools\Image
     */
    public function Load ($imgFullPath) {
        $result = FALSE;
        if ($this->resource) {
            unset($this->resource);
            $this->resource = NULL;
        }
        $errorMsgBase = "Image `{$imgFullPath}` was not possible to load by `\Imagick::readImage();`. ";
        try {
            $this->resource = new \Imagick($imgFullPath);
            if (!$this->resource->readImage($imgFullPath)) {
                return $result;
            }
            $this->imgFullPath = $imgFullPath;
        } catch (\Exception $e) { // backward compatibility
            throw new \RuntimeException(
                $errorMsgBase . $e->getMessage() ,$e->getCode()
            );
        } catch (\Throwable $e) {
            throw new \RuntimeException(
                $errorMsgBase . $e->getMessage() ,$e->getCode()
            );
        }
        // set dimensions
        $this->setWidth($this->resource->getImageWidth());
        $this->setHeight($this->resource->getImageHeight());
        return $this;
    }

    /**
     * Save image in desired full path by format and optional quality settings.
     * @param  string $fullPath
     * @param string|\MvcCore\Ext\Tools\Images\IFormat $format `png` by default.
     * @param int $quality `NULL` by default - no quality settings will be used.
     * @return \MvcCore\Ext\Tools\Image
     */
    public function Save ($fullPath, $format = \MvcCore\Ext\Tools\Images\IFormat::PNG, $quality = NULL) {
        if (!$format) $format = \MvcCore\Ext\Tools\Images\IFormat::PNG;
        $this->resource->stripimage();
        $this->resource->setImageFormat($format);
        if ($quality !== NULL && is_int($quality)) {
            $this->resource->setCompressionQuality($quality);
            $this->resource->setImageCompressionQuality($quality);
        }
        if (file_exists($fullPath)) unlink($fullPath);
        $this->resource->writeImage($fullPath);
        return $this;
    }

    /**
     * Resize image to desired with and height without maintaining the aspect ratio.
     * @param int $width Pixel width.
     * @param int $height Pixel height.
     * @return \MvcCore\Ext\Tools\Image
     */
    public function Resize ($width, $height) {
        // this is the check for vector formats because
        // they need to have a resolution set this does
        // only work if "resize" is the first step
        // in the image-pipeline
        if($this->IsVectorGraphic()) {
            // the resolution has to be set before loading the image,
            // that's why we have to destroy the instance and load it again
            $res = $this->resource->getImageResolution();
            $xRatio = $res['x'] / $this->resource->getImageWidth();
            $yRatio = $res['y'] / $this->resource->getImageHeight();
            $this->resource->removeImage();
            $this->resource->setResolution($width * $xRatio, $height * $yRatio);
            $this->resource->readImage($this->imgFullPath);
        } else {
            $this->resource->resizeimage(
                $width, $height, \Imagick::FILTER_UNDEFINED, 1, false
            );
        }
        $this->setWidth($width);
        $this->setHeight($height);
        $this->reinitializeImage();
        return $this;
    }

    /**
     * Crop image from left, top right or bottom side.
     * @param int $x Pixel size to crop from left.
     * @param int $y Pixel size to crop from top.
     * @param int $width Pixel size to crop from right.
     * @param int $height Pixel size to crop from bottom.
     * @return \MvcCore\Ext\Tools\Image
     */
    public function Crop ($x, $y, $width, $height) {
        $this->resource->cropImage($width, $height, $x, $y);
        $this->resource->setImagePage($width, $height, 0, 0);
        $this->setWidth($width);
        $this->setHeight($height);
        $this->reinitializeImage();
        return $this;
    }

    /**
     * Image will be resized into sizes not larger than `$width`
     * or `$height` params with maintaining the aspect ratio and
     * places without image content will be filled with transparent
     * background color.
     * @param int $width Pixel width.
     * @param int $height Pixel height.
     * @return \MvcCore\Ext\Tools\Image
     */
    public function Frame ($width, $height) {
        $this->Contain($width, $height);
        $x = ($width - $this->GetWidth()) / 2;
        $y = ($height - $this->GetHeight()) / 2;
        $newImage = $this->CreateEmptyImageResource($width, $height);
        $newImage->compositeImage(
            $this->resource, \MvcCore\Ext\Tools\Images\Imagicks\IComposite::NORMAL,
            $x, $y
        );
        $this->resource = $newImage;
        $this->setWidth($width);
        $this->setHeight($height);
        $this->reinitializeImage();
        return $this;
    }

    /**
     * Set background color for prepared image.
     * @param string $hexColor Color in hexadecimal format with or without leading hash.
     * @return \MvcCore\Ext\Tools\Image
     */
    public function SetBackgroundColor ($hexColor = 'transparent') {
        $newImage = $this->CreateEmptyImageResource(
            $this->GetWidth(), $this->GetHeight(), $hexColor
        );
        $newImage->compositeImage(
            $this->resource, \MvcCore\Ext\Tools\Images\Imagicks\IComposite::NORMAL,
            0, 0
        );
        $this->resource = $newImage;
        $this->reinitializeImage();
        return $this;
    }

    /**
     * Apply to whole image Photoshop like Unsharp Mask filter to sharp image.
     * This method is time consuming!
     * @param int   $amount    Typically: 50 - 200, min. 0, max. 500.
     * @param float $radius    Typically: 0.5 - 1, min. 0, max. 50.
     * @param int   $threshold Typically: 0 - 5, min. 0, max. 255.
     * @return \MvcCore\Ext\Tools\Image
     */
    public function UnsharpMask ($amount, $radius, $threshold) {
        $sigma = ($radius < 1) ? $radius : sqrt($radius) ;
        $amount = ($amount * 2.55) / 100;
        $threshold = $threshold / 255;
        $this->resource->unsharpMaskImage(
            $radius , $sigma , $amount , $threshold
        );
        return $this;
    }

    /**
     * Apply to whole image Photoshop like Channel Mask.
     * Image given as first argument will be used as grayscale
     * channel mask applied to this image instance.
     * This method is time consuming!
     * @param string $maskImgFullPath
     * @throws \InvalidArgumentException
     * @return \MvcCore\Ext\Tools\Image
     */
    public function ApplyMask ($maskImgFullPath) {
        if (is_file($maskImgFullPath)) {
            $this->resource->setImageMatte(TRUE);
            $newImage = new \Imagick($maskImgFullPath);
            $newImage->readimage($maskImgFullPath);
            $newImage->resizeimage(
                $this->GetWidth(), $this->GetHeight(),
                \Imagick::FILTER_UNDEFINED, 1, false
            );
            $this->resource->compositeImage(
                $newImage, \Imagick::COMPOSITE_DSTIN, 0 ,0
            );
        } else {
            throw new \InvalidArgumentException(
                "Mask image not found: '$maskImgFullPath'."
            );
        }
        $this->reinitializeImage();
        return $this;
    }

    /**
     * Convert whole image to grayscale.
     * @return \MvcCore\Ext\Tools\Image
     */
    public function Grayscale () {
        $this->resource->setImageType(\Imagick::IMGTYPE_GRAYSCALEMATTE);
        $this->reinitializeImage();
        return $this;
    }

    /**
     * Applies a special effect to the image, similar to the effect achieved
     * in a photo darkroom by sepia toning. Threshold ranges from 0 to QuantumRange
     * and is a measure of the extent of the sepia toning. A threshold of 80 is
     * a good starting point for a reasonable tone.
     * @param float $threshold
     * @return \MvcCore\Ext\Tools\Image
     */
    public function Sepia ($threshold = 80) {
        $this->resource->sepiatoneimage($threshold);
        $this->reinitializeImage();
        return $this;
    }

    /**
     * Round image corners with the same x-round and y-round sizes.
     * @param float $x X-rounding.
     * @param float $y Y-rounding.
     * @return \MvcCore\Ext\Tools\Image
     */
    public function RoundCorners ($x, $y) {
        $this->resource->roundCorners($x, $y);
        $this->reinitializeImage();
        return $this;
    }

    /**
     * Rotate image with optional background color, transparent by default.
     * @param float $angle
     * @param string $hexBgColor Color in hexadecimal format with or without leading hash. Transparent by default.
     * @return \MvcCore\Ext\Tools\Image
     */
    public function Rotate ($angle, $hexBgColor = 'transparent') {
        $this->resource->rotateImage(
            new \ImagickPixel($hexBgColor == 'transparent' ? 'rgba(0%, 0%, 0%, 0.0)' : $hexBgColor),
            $angle
        );
        $this->setWidth($this->resource->getimagewidth());
        $this->setHeight($this->resource->getimageheight());
        $this->reinitializeImage();
        return $this;
    }

    /**
     * Set background image. If background image has different sizes,
     * it's resized without maintaining the aspect ratio to the same
     * sizes as current image instance.
     * @param  string $bgImgFullPath
     * @throws \InvalidArgumentException
     * @return \MvcCore\Ext\Tools\Image
     */
    public function SetBackgroundImage ($bgImgFullPath) {
        if (is_file($bgImgFullPath)) {
            $newImage = new \Imagick($bgImgFullPath);
            $newImage->readimage($bgImgFullPath);
            $newImage->resizeimage(
                $this->GetWidth(), $this->GetHeight(),
                \Imagick::FILTER_UNDEFINED, 1, FALSE
            );
            $newImage->compositeImage(
                $this->resource,
                \Imagick::COMPOSITE_DEFAULT,
                0 ,0
            );
            $this->resource = $newImage;
        } else {
            throw new \InvalidArgumentException(
                "Background image not found: '$bgImgFullPath'."
            );
        }
        $this->reinitializeImage();
        return $this;
    }

    /**
     * Return `TRUE` if image is vector graphic. `FALSE` otherwise.
     * @return bool
     */
    public function IsVectorGraphic () {
        $result = FALSE;
        try {
            $type = $this->resource->getimageformat();
            $vectorTypes = [
                "EPT","EPDF","EPI","EPS","EPS2",
                "EPS3","EPSF","EPSI","EPT","PDF",
                "PFA","PFB","PFM","PS","PS2",
                "PS3","PSB","SVG","SVGZ"
            ];
            if (in_array($type, $vectorTypes)) {
                $result = TRUE;
            }
        } catch (\Exception $e) { // backward compatibility
        } catch (\Throwable $e) {
        }
        return $result;
    }

    /**
     * Composite one image onto another at the specified offset.
     * @see http://php.net/manual/en/imagick.compositeimage.php
     * @see http://php.net/manual/en/imagick.constants.php#imagick.constants.composite-default
     * @param string $overlayImgFullPath
     * @param int $x
     * @param int $y
     * @param int $alpha
     * @param int|\MvcCore\Ext\Tools\Images\Imagicks\IComposite $composite
     * @throws \InvalidArgumentException
     * @return \MvcCore\Ext\Tools\Image
     */
    public function AddOverlay (
        $overlayImgFullPath, $x = 0, $y = 0, $alpha = NULL,
        $composite = \MvcCore\Ext\Tools\Images\Imagicks\IComposite::NORMAL
    ) {
        // 100 alpha is default
        if (!is_int($alpha)) $alpha = 100;
        $alpha = round($alpha / 100, 1);
        if (is_file($overlayImgFullPath)) {
            $newImage = new \Imagick($overlayImgFullPath);
            $newImage->readimage($overlayImgFullPath);
            $newImage->evaluateImage(
                \Imagick::EVALUATE_MULTIPLY, $alpha, \Imagick::CHANNEL_ALPHA
            );
            $this->resource->compositeImage(
                $newImage, $composite, $x ,$y
            );
        } else {
            throw new \InvalidArgumentException(
                "Overlay image not found: '$overlayImgFullPath'."
            );
        }
        $this->reinitializeImage();
        return $this;
    }

    /**
     * Create new empty`\Imagick` image instance.
     * @param int $width Pixel width.
     * @param int $height Pixel height.
     * @param string $hexBgColor Color in hexadecimal format with or without leading hash.
     * @return \Imagick
     */
    public function CreateEmptyImageResource ($width, $height, $hexBgColor = 'transparent') {
        $newImage = new \Imagick();
        $newImage->newimage(
            $width, $height,
            new \ImagickPixel($hexBgColor == 'transparent' ? 'rgba(0%, 0%, 0%, 0.0)' : $hexBgColor)
        );
        $newImage->setImageFormat('png');
        $this->reinitializeImage();
        return $newImage;
    }

    /**
     * Destroy current image instance resource in RAM.
     * @return \MvcCore\Ext\Tools\Image
     */
    protected function destroy() {
        $this->resource->destroy();
        return $this;
    }
}