Add support for FetchVideoSource in video overlays

cloudinary · Sep 18, 2023 · 830b619 · 830b619
1 parent e3ca9f4
commit 830b619
Show file tree

Hide file tree

Showing 10 changed files with 149 additions and 20 deletions.
diff --git a/src/Transformation/Layer/BaseSourceQualifier.php b/src/Transformation/Layer/BaseSourceQualifier.php
@@ -28,6 +28,11 @@ class BaseSourceQualifier extends BaseQualifier
      */
     protected $sourceType;
 
+    /**
+     * @var string $assetType The type of the asset.
+     */
+    protected $assetType;
+
     /**
      * @var string The stack position of the layer.
      */
@@ -75,6 +80,20 @@ public function setStackPosition($stackPosition)
         return $this;
     }
 
+    /**
+     * Sets the asset type.
+     *
+     * @param string $assetType The type of the asset.
+     *
+     * @return $this
+     */
+    public function assetType($assetType)
+    {
+        $this->assetType = $assetType;
+
+        return $this;
+    }
+
     /**
      * Serializes to string.
      *
@@ -83,7 +102,8 @@ public function setStackPosition($stackPosition)
     public function __toString()
     {
         $sourceTypeStr = $this->sourceType ? "$this->sourceType:" : '';
+        $assetTypeStr  = $this->assetType && $this->assetType != "image" ? "$this->assetType:" : '';
 
-        return empty((string)$this->value) ? '' : "{$this->getSourceKey()}_{$sourceTypeStr}{$this->value}";
+        return empty((string)$this->value) ? '' : "{$this->getSourceKey()}_$assetTypeStr$sourceTypeStr$this->value";
     }
 }
diff --git a/src/Transformation/Layer/FetchImageSource.php b/src/Transformation/Layer/FetchImageSource.php
@@ -10,10 +10,6 @@
 
 namespace Cloudinary\Transformation;
 
-use Cloudinary\Asset\AssetDescriptor;
-use Cloudinary\Asset\BaseAsset;
-use Cloudinary\ClassUtils;
-
 /**
  * Defines how to manipulate an image layer.
  *
@@ -36,12 +32,12 @@ public function setSource($source)
     {
 
         if ($source instanceof BaseSourceQualifier) {
-            $this->getSourceQualifier()->setQualifierValue($source->getValue());
+            $this->getSourceQualifier()->fetchUrl($source->getValue());
 
             return $this;
         }
 
-        $this->getSourceQualifier()->setQualifierValue((string)$source);
+        $this->getSourceQualifier()->fetchUrl((string)$source);
 
 
         return $this;

diff --git a/src/Transformation/Layer/FetchSourceQualifier.php b/src/Transformation/Layer/FetchSourceQualifier.php
@@ -46,6 +46,10 @@ public function __construct($fetchUrl)
      */
     public function fetchUrl($fetchUrl)
     {
+        if (StringUtils::contains($fetchUrl, ':fetch:')) {
+            list($this->assetType, $this->sourceType, $fetchUrl) = explode(':', $fetchUrl, 3);
+        }
+
         $this->setQualifierValue(StringUtils::truncatePrefix($fetchUrl, 'fetch:'));
 
         return $this;

diff --git a/src/Transformation/Layer/FetchVideoSource.php b/src/Transformation/Layer/FetchVideoSource.php
@@ -0,0 +1,74 @@
+<?php
+/**
+ * This file is part of the Cloudinary PHP package.
+ *
+ * (c) Cloudinary
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Cloudinary\Transformation;
+
+use Cloudinary\ClassUtils;
+
+/**
+ * Defines how to manipulate a fetched video layer.
+ *
+ * **Learn more**: <a
+ * href=https://cloudinary.com/documentation/video_layers#layer_transformations target="_blank">
+ * Video overlays</a>
+ *
+ * @api
+ */
+class FetchVideoSource extends VideoSource
+{
+    /**
+     * VideoLayer constructor.
+     *
+     * @param $source
+     */
+    public function __construct($source)
+    {
+        parent::__construct($source);
+
+        $this->setSource($source);
+    }
+    /**
+     * Sets the source of the layer.
+     *
+     * @param string|FetchSourceQualifier $source The source.
+     *
+     * @return $this
+     */
+    public function setSource($source)
+    {
+
+        if ($source instanceof FetchSourceQualifier) {
+            $this->getSourceQualifier()->fetchUrl($source->getValue());
+
+            return $this;
+        }
+
+        $this->getSourceQualifier()->fetchUrl((string)$source);
+
+
+        return $this;
+    }
+
+    /**
+     * Gets the layer qualifier.
+     *
+     * @return FetchSourceQualifier
+     *
+     * @internal
+     */
+    protected function getSourceQualifier()
+    {
+        if (! isset($this->qualifiers['source'])) {
+            $this->qualifiers['source'] = (new FetchSourceQualifier(null))->assetType("video");
+        }
+
+        return $this->qualifiers['source'];
+    }
+}
diff --git a/src/Transformation/Layer/LayerQualifierFactory.php b/src/Transformation/Layer/LayerQualifierFactory.php
@@ -49,11 +49,12 @@ protected static function handleQualifierValue($layerQualifiers)
         // Handle layer params
         if (is_array($layerQualifiers)) {
             $resourceType = ArrayUtils::get($layerQualifiers, 'resource_type');
+            $deliveryType = ArrayUtils::get($layerQualifiers, 'type');
 
             // Fetch layer
-            $fetch = ArrayUtils::get($layerQualifiers, 'fetch');
-            if (! empty($fetch) || $resourceType === 'fetch') {
-                return new FetchSourceQualifier($fetch);
+            $fetchUrl = ArrayUtils::get($layerQualifiers, 'fetch', ArrayUtils::get($layerQualifiers, 'url'));
+            if (! empty($fetchUrl) || $deliveryType === 'fetch') {
+                return (new FetchSourceQualifier($fetchUrl))->assetType($resourceType);
             }
 
             $text     = ArrayUtils::get($layerQualifiers, 'text');
@@ -100,17 +101,17 @@ protected static function handleQualifierValue($layerQualifiers)
             if ($resourceType !== 'image') {
                 $components[] = $resourceType;
             }
-            $type = ArrayUtils::get($layerQualifiers, 'type');
-            if ($type !== 'upload') {
-                $components[] = $type;
+
+            if ($deliveryType !== 'upload') {
+                $components[] = $deliveryType;
             }
             $components[] = $publicId;
 
             // Build a valid layer string.
             $layerQualifiers = ArrayUtils::implodeQualifierValues(...$components);
         } elseif (is_string($layerQualifiers)) {
             // Handle fetch layer from string definition.
-            if (StringUtils::startsWith($layerQualifiers, 'fetch:')) {
+            if (StringUtils::contains($layerQualifiers, 'fetch:')) {
                 return new FetchSourceQualifier($layerQualifiers);
             }
         }

diff --git a/src/Transformation/Layer/VideoSourceQualifier.php b/src/Transformation/Layer/VideoSourceQualifier.php
@@ -18,9 +18,9 @@
 class VideoSourceQualifier extends BaseSourceQualifier
 {
     /**
-     * @var string $sourceType The type of the layer.
+     * @var string $assetType The asset type of the layer.
      */
-    protected $sourceType = 'video';
+    protected $assetType = 'video';
 
     /**
      * VideoSourceQualifier constructor.

diff --git a/src/Transformation/Layer/VideoSourceTrait.php b/src/Transformation/Layer/VideoSourceTrait.php
@@ -31,6 +31,18 @@ public static function video($videoId = null)
         return static::createWithSource(ClassUtils::verifyInstance($videoId, VideoSource::class));
     }
 
+    /**
+     * Adds another video layer from a remote URL.
+     *
+     * @param string|null $fetchUrl The URL of the asset to fetch.
+     *
+     * @return static|FetchVideoSource
+     */
+    public static function fetchVideo($fetchUrl)
+    {
+        return static::createWithSource(ClassUtils::verifyInstance($fetchUrl, FetchVideoSource::class));
+    }
+
     /**
      * Adds subtitles to a video.
      *

diff --git a/tests/TransformationTestCase.php b/tests/TransformationTestCase.php
@@ -26,15 +26,21 @@
  */
 abstract class TransformationTestCase extends TestCase
 {
-    const ASSET_ID = 'sample';
+    const ASSET_ID       = 'sample';
+    const VIDEO_ASSET_ID = 'dog';
 
     const IMG_EXT        = 'png';
     const IMG_EXT_JPG    = 'jpg';
     const IMG_EXT_GIF    = 'gif';
     const IMAGE_NAME     = self::ASSET_ID . '.' . self::IMG_EXT;
     const IMAGE_NAME_GIF = self::ASSET_ID . '.' . self::IMG_EXT_GIF;
 
+    const VIDEO_EXT       = 'mp4';
+    const VIDEO_NAME      = self::VIDEO_ASSET_ID . '.' . self::VIDEO_EXT;
     const FETCH_IMAGE_URL = 'https://res.cloudinary.com/demo/image/upload/' . self::IMAGE_NAME;
+    const FETCH_VIDEO_URL = 'https://res.cloudinary.com/demo/video/upload/' . self::VIDEO_NAME;
+
+    const B64_FETCH_VIDEO_URL = 'aHR0cHM6Ly9yZXMuY2xvdWRpbmFyeS5jb20vZGVtby92aWRlby91cGxvYWQvZG9nLm1wNA==';
 
     /**
      * Asserts that string representations of the objects are equal.

diff --git a/tests/Unit/Transformation/Common/ActionFromQualifiersTest.php b/tests/Unit/Transformation/Common/ActionFromQualifiersTest.php
@@ -656,6 +656,10 @@ public function layersQualifiersDataProvider()
             'private'                             => [['public_id' => 'logo', 'type' => 'private'], 'private:logo'],
             'format'                              => [['public_id' => 'logo', 'format' => 'png'], 'logo.png'],
             'video'                               => [['resource_type' => 'video', 'public_id' => 'cat'], 'video:cat'],
+            'fetch video'                         => [
+                ['resource_type' => 'video', 'url' => self::FETCH_VIDEO_URL],
+                'video:fetch:' . self::B64_FETCH_VIDEO_URL
+            ],
             'text'                                => [
                 ['public_id' => 'logo', 'text' => 'Hello World, Nice to meet you?'],
                 'text:logo:Hello%20World%252C%20Nice%20to%20meet%20you%3F',
@@ -722,6 +726,10 @@ public function layersQualifiersDataProvider()
                 'fetch:' . self::FETCH_IMAGE_URL,
                 'fetch:aHR0cHM6Ly9yZXMuY2xvdWRpbmFyeS5jb20vZGVtby9pbWFnZS91cGxvYWQvc2FtcGxlLnBuZw==',
             ],
+            'fetch video url'                     => [
+                'video:fetch:' . self::FETCH_VIDEO_URL,
+                'video:fetch:' . self::B64_FETCH_VIDEO_URL,
+            ],
             'logo'                                => [
                 ['public_id' => 'logo', 'type' => 'upload', 'resource_type' => 'image'],
                 'logo',

diff --git a/tests/Unit/Transformation/Video/VideoOverlayTest.php b/tests/Unit/Transformation/Video/VideoOverlayTest.php
@@ -10,7 +10,7 @@
 
 namespace Cloudinary\Test\Unit\Transformation\Video;
 
-use Cloudinary\Transformation\AudioSource;
+use Cloudinary\Test\TransformationTestCase;
 use Cloudinary\Transformation\Compass;
 use Cloudinary\Transformation\CompassPosition;
 use Cloudinary\Transformation\Concatenate;
@@ -25,12 +25,11 @@
 use Cloudinary\Transformation\VideoOverlay;
 use Cloudinary\Transformation\VideoSource;
 use Cloudinary\Transformation\VideoTransformation;
-use PHPUnit\Framework\TestCase;
 
 /**
  * Class VideoOverlayTest
  */
-final class VideoOverlayTest extends TestCase
+final class VideoOverlayTest extends TransformationTestCase
 {
     public function testVideoOverlay()
     {
@@ -109,6 +108,15 @@ public function testVideoCutter()
         );
     }
 
+    public function testVideoFetch()
+    {
+        self::assertEquals(
+            "l_video:fetch:" . self::B64_FETCH_VIDEO_URL . "/fl_layer_apply",
+            (string)(new VideoTransformation())
+                ->overlay(Overlay::videoSource(VideoSource::fetchVideo(self::FETCH_VIDEO_URL)))
+        );
+    }
+
     public function testAudioOverlay()
     {
         self::assertEquals(