supernova-ws / SuperNova

tools/classes/SpriteLineGif.php

<?php
/** Created by Gorlum 21.01.2024 01:07 */

namespace Tools;

use GIFEndec\Decoder;
use GIFEndec\Events\FrameDecodedEvent;
use GIFEndec\Frame;
use GIFEndec\IO\FileStream;

class SpriteLineGif extends SpriteLine {
  /** @var bool $expandFrame Should frame be expanded for CSS animation? */
  protected $expandFrame = true;

  /** @var Frame[] $frames */
  protected $frames = [];
  /**
   * @var int
   */
  protected $maxWidth = 0;

  protected function addImage($imageFile) {
    $this->files[] = $imageFile;

    $this->frames = [];

    $this->height = $this->width = $this->maxWidth = 0;

    /** Open GIF as FileStream */
    // TODO - own class from loaded
    $gifStream = new FileStream($imageFile->fullPath);
    /** Create Decoder instance from MemoryStream */
    $gifDecoder = new Decoder($gifStream);

    /** Run decoder. Pass callback function to process decoded Frames when they're ready. */
    $gifDecoder->decode(function (FrameDecodedEvent $event) {
      $this->frames[] = $event->decodedFrame;

      $this->width    += $event->decodedFrame->getSize()->getWidth();
      $this->maxWidth = max($this->maxWidth, $event->decodedFrame->getSize()->getWidth());

      $this->height = max($this->height, $event->decodedFrame->getSize()->getHeight());
    });
    // For EXPAND_FRAME delta width would be equal size of the largest frame
//    $this->width = count($this->frames) * reset($this->frames)->getSize()->getWidth();
    if ($this->expandFrame) {
      $this->width = count($this->frames) * $this->maxWidth;
    }
  }

  /**
   * GIF image line considered always full
   *
   * @param $gridSize
   *
   * @return bool
   */
  protected function isFull($gridSize) {
    return true;
  }

  public function generate($posY, $scaleToPx) {
    // Extracting file name from full path
    $file     = reset($this->files);
    $onlyName = explode('.', $file->fileName);
    if (count($onlyName) > 1) {
      array_pop($onlyName);
    }
    $onlyName = implode('.', $onlyName);
    // You can't have this chars in CSS qualifier
    $onlyName = str_replace(['.', '#'], '_', $onlyName);

    // Expanding frames. Their sizes can change due to offset
    foreach ($this->frames as $i => $frame) {
      $this->expandFrame($i);
    }

//    $firstFrame = reset($this->frames);
//    $this->width  = imagesx($firstFrame->gdImage) * count($this->frames);
//    $this->height = imagesy($firstFrame->gdImage);
//    $maxDimension = max(imagesx($firstFrame->gdImage), imagesy($firstFrame->gdImage));
    $maxDimension = max($this->maxWidth, $this->height);

    // Recreating image - if any
    unset($this->image);
    $this->image = ImageContainer::create($this->width, $this->height);

    $durations = [];
    $position  = 0;
    foreach ($this->frames as $i => $frame) {
//      $frameGdImage = $this->expandFrame($i);
      $frameGdImage = $frame->gdImage;

The property gdImage does not seem to exist on GIFEndec\Frame.

      $width  = imagesx($frameGdImage);
      $height = imagesy($frameGdImage);

      $this->image->copyFromGd($frameGdImage, $position, 0);

//      $frame = $this->frames[$i];
      // Fixing duration 0 to 10
      $durations[$i] = ($duration = $frame->getDuration()) ? $duration : 10;

      $css = "%1\$s{$onlyName}_{$i}%2\$s{background-position: -{$position}px -{$posY}px;";

      // Extra info about frame
      $size   = $frame->getSize();
      $offset = $frame->getOffset();
      $css    = "/* Frame {$size->getWidth()}x{$size->getHeight()} @ ({$offset->getX()},{$offset->getY()}) duration {$frame->getDuration()} disposition {$frame->getDisposalMethod()} */" . $css;

      if ($scaleToPx > 0) {
        if ($maxDimension != $scaleToPx) {
          $css .= "zoom: calc({$scaleToPx}/{$maxDimension});";
        }
      }
      $css .= "width: {$width}px;height: {$height}px;}\n";

      if ($i === 0) {
        // If it's first frame - generating CSS for static image
        $css = "%1\$s{$onlyName}%2\$s,\n" . $css;
      }

      $this->css .= $css;

      $position += $width;
    }

    $totalDuration = array_sum($durations);
    $durInSec      = round($totalDuration / 100, 4);

    $animation  = '';
    $cumulative = 0;
    $position   = 0;
    foreach ($durations as $i => $duration) {
      $animation .= $cumulative . "%% {background-position-x: {$position}px;}\n";

      $cumulative += round($duration / $totalDuration * 100, 3);
      $position   -= imagesx($this->frames[$i]->gdImage);
    }
    $animation = "%1\$s{$onlyName}%2\$s {animation: {$onlyName}_animation%2\$s {$durInSec}s step-end infinite;}\n" .
      "@keyframes {$onlyName}_animation%2\$s {\n" .
      $animation .
      "}";

    $this->css .= $animation;
  }

  /**
   * @param int $i
   *
   * @return resource|\GdImage
   */
  protected function expandFrame($i) {
    /**
     * Disposal method
     * Values :
     *   0 - No disposal specified. The decoder is not required to take any action.
     *   1 - Do not dispose. The graphic is to be left in place.
     *   2 - Restore to background color. The area used by the graphic must be restored to the background color.
     *   3 - Restore to previous. The decoder is required to restore the area overwritten by the graphic with
     *       what was there prior to rendering the graphic.
     */
    $thisFrame = $this->frames[$i];
    if (!$this->expandFrame) {
      return $thisFrame->gdImage = $thisFrame->createGDImage();

The property gdImage does not seem to exist on GIFEndec\Frame.

    }

    if ($i === 0) {
      // This is first frame
      $sizeX = $this->maxWidth;
      $sizeY = $this->height;
//      $sizeX = $thisFrame->getSize()->getWidth() + $thisFrame->getOffset()->getX();
//      $sizeY = $thisFrame->getSize()->getHeight() + $thisFrame->getOffset()->getY();
    } else {
      $prevFrame = $this->frames[$i - 1];
      if (!in_array($prevFrame->getDisposalMethod(), [0, 1, 2])) {
        die("Disposal method {$prevFrame->getDisposalMethod()} does not supported yet");

Using exit here is not recommended.

      }

      // Creating detached copy of previous frame image
      $sizeX = imagesx($prevFrame->gdImage);
      $sizeY = imagesy($prevFrame->gdImage);
    }
    $newGdImage = imagecreatetruecolor($sizeX, $sizeY);
    imagealphablending($newGdImage, false);
    imagesavealpha($newGdImage, true);
    $color = imagecolorallocatealpha($newGdImage, 0, 0, 0, 127);
    imagefill($newGdImage, 0, 0, $color);

    if ($i !== 0) {
      imagecopy($newGdImage, $prevFrame->gdImage,

The variable $prevFrame does not seem to be defined for all execution paths leading up to this point.

        0, 0,
        0, 0, imagesx($prevFrame->gdImage), imagesy($prevFrame->gdImage)
      );

      if ($prevFrame->getDisposalMethod() === 2) {
        imagefilledrectangle($newGdImage,
          $prevFrame->getOffset()->getX(), $prevFrame->getOffset()->getY(),
          $prevFrame->getOffset()->getX() + ($prevFrame->getSize()->getWidth() - 1),
          $prevFrame->getOffset()->getY() + ($prevFrame->getSize()->getHeight() - 1),
          $color
        );
      }
    }

    $anImage = $thisFrame->createGDImage();
    imagecopy($newGdImage, $anImage,
      $thisFrame->getOffset()->getX(), $thisFrame->getOffset()->getY(),
      0, 0, imagesx($anImage), imagesy($anImage)
    );

    return $thisFrame->gdImage = $newGdImage;
  }

}