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: 393: 394: 

<?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 Gd extends \MvcCore\Ext\Tools\Image {

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

    /**
     * Load image into resource by given file full path.
     * @param string $imgFullPath
     * @throws \RuntimeException
     * @return bool|\MvcCore\Ext\Tools\Image|\MvcCore\Ext\Tools\Images\IImage
     */
    public function Load ($imgFullPath) {
        $result = FALSE;
        $loaded = $this->resource = @imagecreatefromstring(
            file_get_contents($imgFullPath)
        );
        if (!$loaded) return $result;
        // set dimensions
        list($width, $height) = getimagesize($imgFullPath);
        $this->setWidth($width);
        $this->setHeight($height);
        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) {
        $format = strtolower($format);
        if (!$format) $format = 'png';
        if ($format == \MvcCore\Ext\Tools\Images\IFormat::JPG) $format = 'jpeg';
        $functionName = 'image' . $format;
        if (!function_exists($functionName)) {
            $functionName = 'imagepng';
        }
        // always create a PNG24
        if ($format == \MvcCore\Ext\Tools\Images\IFormat::PNG) {
            imagesavealpha($this->resource, TRUE);
        }
        if (file_exists($fullPath)) unlink($fullPath);
        switch ($format) {
            case 'jpeg':
                $quality = is_int($quality) ? $quality : 100;
                $functionName($this->resource, $fullPath, $quality);
                break;
            default:
                $functionName($this->resource, $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) {
        $newImg = $this->CreateEmptyImageResource($width, $height);
        imagecopyresampled(
            $newImg, $this->resource,
            0, 0, 0, 0,
            $width, $height,
            $this->GetWidth(), $this->GetHeight()
        );
        $this->resource = $newImg;
        $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) {
        $x = min($this->GetWidth(), max(0, $x));
        $y = min($this->GetHeight(), max(0, $y));
        $width   = min($width,  $this->GetWidth() - $x);
        $height  = min($height, $this->GetHeight() - $y);
        $newImg = $this->CreateEmptyImageResource($width, $height);
        imagecopy($newImg, $this->resource, 0, 0, $x, $y, $width, $height);
        $this->resource = $newImg;
        $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);
        imagecopy(
            $newImage, $this->resource,
            $x, $y, 0, 0,
            $this->GetWidth(), $this->GetHeight()
        );
        $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) {
        list($r, $g, $b) = static::HexColor2RgbArrayColor($hexColor);
        // just `imagefill()` on the existing image doesn't work,
        // so we have to create a new image, fill it and then merge
        // the source image with the background-image together
        $newImg = imagecreatetruecolor(
            $this->GetWidth(), $this->GetHeight()
        );
        $color = imagecolorallocate($newImg, $r, $g, $b);
        imagefill($newImg, 0, 0, $color);
        imagecopy(
            $newImg, $this->resource,
            0, 0, 0, 0,
            $this->GetWidth(), $this->GetHeight()
        );
        $this->resource = $newImg;
        $this->reinitializeImage();
        return $this;
    }

    /**
     * Apply to whole image Photoshop like Unsharp Mask filter to sharp image.
     * This method is very 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) {
        \MvcCore\Ext\Tools\Images\Gds\UnsharpMask::Process(
            $this->resource, $amount, $radius, $threshold
        );
        $this->reinitializeImage();
        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 very time consuming!
     * @param string $maskImgFullPath
     * @throws \InvalidArgumentException
     * @return \MvcCore\Ext\Tools\Image
     */
    public function ApplyMask ($maskImgFullPath) {
        if (is_file($maskImgFullPath)) {
            $maskResource = @imagecreatefromstring(
                file_get_contents($maskImgFullPath)
            );
            if ($maskResource) {
                \MvcCore\Ext\Tools\Images\Gds\ApplyMask::Process(
                    $this->resource, $maskResource
                );
            } else {
                throw new \InvalidArgumentException(
                    "Mask image not possible to read: '$maskImgFullPath'."
                );
            }
        } 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 () {
        imagefilter($this->resource, IMG_FILTER_GRAYSCALE);
        $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) {
        $ratio = $threshold / 100.0;
        imagefilter($this->resource, IMG_FILTER_GRAYSCALE);
        imagefilter($this->resource, IMG_FILTER_BRIGHTNESS, -10);
        imagefilter($this->resource, IMG_FILTER_CONTRAST, -20);
        imagefilter($this->resource, IMG_FILTER_COLORIZE, 120 * $ratio, 60 * $ratio, 0, 0);
        $this->reinitializeImage();
        return $this;
    }

    /**
     * Round image corners with the same x-round and y-round sizes.
     * This method is very time consuming!
     * @param float $x X-rounding.
     * @param float $y Y-rounding.
     * @return \MvcCore\Ext\Tools\Image
     */
    public function RoundCorners ($x, $y) {
        \MvcCore\Ext\Tools\Images\Gds\RoundCorners::Process($this->resource, $x, $y);
        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') {
        if ($hexBgColor == 'transparent') {
            $transColor = imagecolorallocatealpha(
                $this->resource, 0, 0, 0, 127
            );
            imagefill($this->resource, 0, 0, $transColor);
            $this->resource = imagerotate($this->resource, -$angle, $transColor);
            imagealphablending($this->resource, TRUE);
            imagesavealpha($this->resource, TRUE);
        } else {
            list($r, $g, $b) = static::HexColor2RgbArrayColor($hexBgColor);
            $bgColor = imagecolorallocate(
                $this->resource, $r, $g, $b
            );
            $this->resource = imagerotate(
                $this->resource, - $angle, $bgColor, 0
            );
        }
        $this->setWidth(imagesx($this->resource));
        $this->setHeight(imagesy($this->resource));
        $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)) {
            $bgImg = @imagecreatefromstring(
                file_get_contents($bgImgFullPath)
            );
            if ($bgImg) {
                $w = $this->GetWidth();
                $h  =$this->GetHeight();
                $newImg = imagecreatetruecolor($w, $h);
                imagesavealpha($newImg, TRUE);
                imagealphablending($newImg, TRUE);
                $bgw = imagesx($bgImg);
                $bgh = imagesy($bgImg);
                if ($bgw != $w || $bgh != $h) {
                    imagecopyresampled($newImg, $bgImg, 0, 0, 0, 0, $w, $h, $bgw, $bgh);
                } else {
                    imagecopy($newImg, $bgImg, 0, 0, 0, 0, $w, $h);
                }
                imagedestroy($bgImg);
                imagecopy($newImg, $this->resource, 0, 0, 0, 0, $w, $h);
                imagedestroy($this->resource);
                $this->resource = $newImg;
                $this->reinitializeImage();
            } else {
                throw new \InvalidArgumentException(
                    "Background image not possible to read: '$bgImgFullPath'."
                );
            }
        } else {
            throw new \InvalidArgumentException(
                "Background image not found: '$bgImgFullPath'."
            );
        }
        return $this;
    }

    /**
     * Return always `FALSE`, because `GD` graphic library doesn't
     * support any vector images processing. There will be triggered `E_USER_NOTICE`.
     * @return bool
     */
    public function IsVectorGraphic () {
        trigger_error(
            "GD graphic library doesn't support any vector images processing. [\\".get_class()."::".__METHOD__."()]",
            E_USER_NOTICE
        );
        return FALSE;
    }

    /**
     * Do nothing with image, because `GD` graphic library doesn't
     * support any overlay images processing. There will be triggered `E_USER_NOTICE`.
     * @param string $overlayImgFullPath
     * @param int $x
     * @param int $y
     * @param int $alpha
     * @param int|\MvcCore\Ext\Tools\Images\IComposite $composite
     * @throws \InvalidArgumentException
     * @return \MvcCore\Ext\Tools\Image
     */
    public function AddOverlay (
        $overlayImgFullPath, $x = 0, $y = 0, $alpha = NULL,
        $composite = \MvcCore\Ext\Tools\Images\IComposite::NORMAL
    ) {
        trigger_error(
            "Adding an overlay image not implemented. [\\".get_class()."::".__METHOD__."()]",
            E_USER_NOTICE
        );
        return $this;
    }

    /**
     * Create new empty `GD` image resource instance.
     * @param int $width Pixel width.
     * @param int $height Pixel height.
     * @param string $hexBgColor Color in hexadecimal format with or without leading hash.
     * @return resource
     */
    public function CreateEmptyImageResource ($width, $height, $hexBgColor = 'transparent') {
        $newImg = imagecreatetruecolor($width, $height);
        imagesavealpha($newImg, true);
        imagealphablending($newImg, false);
        if ($hexBgColor == 'transparent') {
            $colour = imagecolorallocatealpha($newImg, 0, 0, 0, 127);
        } else {
            list($r, $g, $b) = static::HexColor2RgbArrayColor($hexBgColor);
            $colour = imagecolorallocatealpha($newImg, $r, $g, $b, 0);
        }
        imagefill($newImg, 0, 0, $colour);
        return $newImg;
    }

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