bug fixes and other minor improvements

Author: aminyazdanpanah

README.md

@@ -27,7 +27,7 @@ This package provides integration with **[PHP-FFMpeg](https://github.com/PHP-FFM
   - [Other Advanced Features](#other-advanced-features)
 - [Asynchronous Task Execution](#asynchronous-task-execution)
 - [Several Open Source Players](#several-open-source-players)
-- [Contributing and Reporting Bug](#contributing-and-reporting-bugs)
+- [Contributing and Reporting Bugs](#contributing-and-reporting-bugs)
 - [Credits](#credits)
 - [License](#license)
 
@@ -80,7 +80,7 @@ $video = $ffmpeg->open('/var/www/media/videos/video.mp4');
 #### 2. From Clouds
 You can open a file from a cloud by passing an array of cloud configuration to the `openFromCloud` method. 
 
-In **[this page](https://video.aminyazdanpanah.com/start/open-clouds)**, you will find some examples of opening a file from **[Amazon Web Services (AWS)](https://aws.amazon.com/)**, **[Google Cloud Storage](https://console.cloud.google.com/storage)**, **[Microsoft Azure Storage](https://azure.microsoft.com/en-us/features/storage-explorer/)**, and a custom cloud. 
+In **[this page](https://video.aminyazdanpanah.com/start/open-clouds)**, you will find some examples of opening a file from **[Amazon S3](https://aws.amazon.com/s3)**, **[Google Cloud Storage](https://console.cloud.google.com/storage)**, **[Microsoft Azure Storage](https://azure.microsoft.com/en-us/features/storage-explorer/)**, and a custom cloud. 
 ``` php
 $video = $ffmpeg->openFromCloud($from_google_cloud);
 ```
@@ -100,18 +100,18 @@ Generate representations manually:
 ``` php
 use Streaming\Representation;
 
-$rep_144p  = (new Representation)->setKiloBitrate(95)->setResize(256, 144);
-$rep_240p  = (new Representation)->setKiloBitrate(150)->setResize(426, 240);
-$rep_360p  = (new Representation)->setKiloBitrate(276)->setResize(640, 360);
-$rep_480p  = (new Representation)->setKiloBitrate(750)->setResize(854, 480);
-$rep_720p  = (new Representation)->setKiloBitrate(2048)->setResize(1280, 720);
-$rep_1080p = (new Representation)->setKiloBitrate(4096)->setResize(1920, 1080);
-$rep_2k    = (new Representation)->setKiloBitrate(6144)->setResize(2560, 1440);
-$rep_4k    = (new Representation)->setKiloBitrate(17408)->setResize(3840, 2160);
+$r_144p  = (new Representation)->setKiloBitrate(95)->setResize(256, 144);
+$r_240p  = (new Representation)->setKiloBitrate(150)->setResize(426, 240);
+$r_360p  = (new Representation)->setKiloBitrate(276)->setResize(640, 360);
+$r_480p  = (new Representation)->setKiloBitrate(750)->setResize(854, 480);
+$r_720p  = (new Representation)->setKiloBitrate(2048)->setResize(1280, 720);
+$r_1080p = (new Representation)->setKiloBitrate(4096)->setResize(1920, 1080);
+$r_2k    = (new Representation)->setKiloBitrate(6144)->setResize(2560, 1440);
+$r_4k    = (new Representation)->setKiloBitrate(17408)->setResize(3840, 2160);
 
 $video->DASH()
     ->HEVC()
-    ->addRepresentations($rep_144p, $rep_240p, $rep_360p, $rep_480p, $rep_720p, $rep_1080p, $rep_2k, $rep_4k)// add representations
+    ->addRepresentations($r_144p, $r_240p, $r_360p, $r_480p, $r_720p, $r_1080p, $r_2k, $r_4k)//add representations
     ->setAdaption('id=0,streams=v id=1,streams=a') // Set a adaption.
     ->save('/var/www/media/videos/dash-stream.mpd');
 ```
@@ -130,14 +130,14 @@ Generate representations manually:
 ``` php
 use Streaming\Representation;
 
-$rep_360p  = (new Representation)->setKiloBitrate(276)->setResize(640, 360);
-$rep_480p  = (new Representation)->setKiloBitrate(750)->setResize(854, 480);
-$rep_720p  = (new Representation)->setKiloBitrate(2048)->setResize(1280, 720);
+$r_360p  = (new Representation)->setKiloBitrate(276)->setResize(640, 360);
+$r_480p  = (new Representation)->setKiloBitrate(750)->setResize(854, 480);
+$r_720p  = (new Representation)->setKiloBitrate(2048)->setResize(1280, 720);
 
 $video->HLS()
     ->X264()
     ->setHlsBaseUrl('https://bucket.s3-us-west-1.amazonaws.com/videos') // Add a base URL
-    ->addRepresentations($rep_360p, $rep_480p, $rep_720p)// add representations
+    ->addRepresentations($r_360p, $r_480p, $r_720p)
     ->setHlsTime(5) // Set Hls Time. Default value is 10 
     ->setHlsAllowCache(false) // Default value is true 
     ->save();
@@ -147,7 +147,7 @@ $video->HLS()
 #### Encrypted HLS
 The encryption process requires some kind of secret (key) together with an encryption algorithm. HLS uses AES in cipher block chaining (CBC) mode. This means each block is encrypted using the ciphertext of the preceding block. [Learn more](https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation)
 
-You must specify a path to save a random key on your local machine and also a URL(or a path) to access the key on your website(the key you will save must be accessible from your website). You must pass both these parameters to the `generateRandomKeyInfo` method:
+You must specify a path to save a random key on your local machine and also a URL(or a path) to access the key on your website(the key you will save must be accessible from your website). You must pass both these parameters to the `encryption` method:
 ``` php
 //A path you want to save a random key on your server
 $save_to = '/home/public_html/PATH_TO_KEY_DIRECTORY/random_key.key';
@@ -206,16 +206,16 @@ $hls = $video->HLS()
 
 $hls->save();
 ```
-**NOTE:** If you open a file from cloud and did not pass a path to save a file, you will have to pass a local path to the `save` method.
+**NOTE:** If you opened a file from cloud and did not pass a path to save a file, you will have to pass a local path to the `save` method.
 
 #### 2. To Clouds
 You can save your files to a cloud by passing an array of cloud configuration to the `save` method. 
 
-In **[this page](https://video.aminyazdanpanah.com/start/open-clouds)**, you will find some examples of saving files to **[Amazon Web Services (AWS)](https://aws.amazon.com/)**, **[Google Cloud Storage](https://console.cloud.google.com/storage)**, **[Microsoft Azure Storage](https://azure.microsoft.com/en-us/features/storage-explorer/)**, and a custom cloud. 
+In **[this page](https://video.aminyazdanpanah.com/start/open-clouds)**, you will find some examples of saving files to **[Amazon S3](https://aws.amazon.com/s3)**, **[Google Cloud Storage](https://console.cloud.google.com/storage)**, **[Microsoft Azure Storage](https://azure.microsoft.com/en-us/features/storage-explorer/)**, and a custom cloud. 
 ``` php
 $dash->save(null, [$to_aws_cloud, $to_google_cloud, $to_microsoft_azure, $to_custom_cloud]);
 ``` 
-A path can also be passed to save a copy of files on your local machine.
+A path can also be passed to save a copy of files to your local machine.
 ``` php
 $hls->save('/var/www/media/videos/hls-stream.m3u8', [$to_google_cloud, $to_custom_cloud]);
 ```

src/AutoRepresentations.php

@@ -64,7 +64,7 @@ private function getKiloBitRate(): int
     {
         if (!$this->video->has('bit_rate')) {
             if (!$this->format->has('bit_rate')) {
-                throw new InvalidArgumentException("We could determine the value of video bitrate");
+                throw new InvalidArgumentException("We could not determine the value of video's bitrate");
             }
 
             return intval(($this->format->get('bit_rate') / 1024) * .9);
@@ -81,7 +81,7 @@ public function get(): array
         $k_bitrate = $this->getKiloBitRate();
         list($w, $h, $r) = $this->getDimensions();
 
-        $reps[] = $this->addRep($k_bitrate, $w, $h);
+        $reps = [$this->addRep($k_bitrate, $w, $h)];
 
         foreach ($this->side_values as $key => $height) {
             $reps[] = $this->addRep($this->k_bitrate_values[$key], Utilities::roundToEven($r * $height), $height);
@@ -99,7 +99,7 @@ public function get(): array
      */
     private function addRep($k_bitrate, $width, $height): Representation
     {
-        return (new Representation())->setKiloBitrate($k_bitrate)->setResize($width, $height);
+        return (new Representation)->setKiloBitrate($k_bitrate)->setResize($width, $height);
     }
 
     /**

src/Clouds/CloudManager.php renamed to src/Clouds/Cloud.php

@@ -14,20 +14,16 @@
 
 
 use Streaming\Exception\InvalidArgumentException;
-use Streaming\FileManager;
+use Streaming\File;
 
-class CloudManager
+class Cloud
 {
     /**
      * @param array $clouds
      * @param string $tmp_dir
      */
-    public static function uploadDirectory(?array $clouds, ?string $tmp_dir): void
+    public static function uploadDirectory(array $clouds, string $tmp_dir): void
     {
-        if (!$clouds) {
-            return;
-        }
-
         if (!is_array(current($clouds))) {
             $clouds = [$clouds];
         }
@@ -44,25 +40,24 @@ public static function uploadDirectory(?array $clouds, ?string $tmp_dir): void
      */
     public static function download(array $cloud, string $save_to = null): array
     {
-        list($save_to, $is_tmp) = $save_to ? [$save_to, false] : [FileManager::tmpFile(), true];
+        list($save_to, $is_tmp) = $save_to ? [$save_to, false] : [File::tmpFile(), true];
         static::transfer($cloud, __FUNCTION__, $save_to);
 
         return [$save_to, $is_tmp];
     }
 
     /**
-     * @param $cloud
+     * @param $cloud_c
      * @param $method
      * @param $path
      */
-    private static function transfer($cloud, $method, $path): void
+    private static function transfer(array $cloud_c, string $method, string $path): void
     {
-        if (is_array($cloud) && $cloud['cloud'] instanceof CloudInterface) {
-            $options = (isset($cloud['options']) && is_array($cloud['options'])) ? $cloud['options'] : [];
-            call_user_func_array([$cloud['cloud'], $method], [$path, $options]);
+        extract($cloud_c);
+        if (isset($cloud) && $cloud instanceof CloudInterface) {
+            call_user_func_array([$cloud, $method], [$path, $options ?? []]);
         } else {
-            throw new InvalidArgumentException('You must pass an array of clouds to the save method. 
-                and the cloud must be instance of CloudInterface');
+            throw new InvalidArgumentException('The cloud key must be instance of the CloudInterface');
         }
     }
 }

src/DASH.php

@@ -47,4 +47,4 @@ protected function getFilter(): Filter
     {
         return new DASHFilter($this);
     }
-}
+}

src/Export.php

@@ -12,7 +12,7 @@
 namespace Streaming;
 
 use FFMpeg\Exception\ExceptionInterface;
-use Streaming\Clouds\CloudManager;
+use Streaming\Clouds\Cloud;
 use Streaming\Exception\InvalidArgumentException;
 use Streaming\Exception\RuntimeException;
 use Streaming\Filters\Filter;
@@ -90,11 +90,25 @@ public function getPathInfo(): array
     /**
      * @param string|null $path
      */
-    private function moveTmpFolder(?string $path): void
+    private function moveTmp(?string $path): void
     {
-        if ($this->tmp_dir && $path) {
-            FileManager::moveDir($this->tmp_dir, pathinfo($path, PATHINFO_DIRNAME) . DIRECTORY_SEPARATOR);
+        if ($this->isTmpDir() && !is_null($path)) {
+            File::moveDir($this->tmp_dir, dirname($path));
             $this->path_info = pathinfo($path);
+            $this->tmp_dir = '';
+        }
+    }
+
+
+    /**
+     * @param array $clouds
+     * @param string $path
+     */
+    private function clouds(array $clouds, ?string $path): void
+    {
+        if (!empty($clouds)) {
+            Cloud::uploadDirectory($clouds, $this->tmp_dir);
+            $this->moveTmp($path);
         }
     }
 
@@ -103,15 +117,14 @@ private function moveTmpFolder(?string $path): void
      */
     private function getPath(): string
     {
-        $path = substr(str_replace("\\", "/", $this->path_info["dirname"] . "/" . $this->path_info["filename"]), 0, PHP_MAXPATHLEN);
+        $path = str_replace("\\", "/", $this->path_info["dirname"] . "/" . $this->path_info["filename"]);
 
         if ($this instanceof DASH) {
-            $path = $path . ".mpd";
+            $path .= ".mpd";
         } elseif ($this instanceof HLS) {
-            ExportHLSPlaylist::savePlayList($path . ".m3u8", $this->getRepresentations(), $this->path_info["filename"]);
-
-            $representations = $this->getRepresentations();
-            $path = $path . "_" . end($representations)->getHeight() . "p.m3u8";
+            $reps = $this->getRepresentations();
+            HLSPlaylist::save($path . ".m3u8", $reps);
+            $path .= "_" . end($reps)->getHeight() . "p.m3u8";
         }
 
         return $path;
@@ -125,44 +138,44 @@ abstract protected function getFilter(): Filter;
     /**
      * Run FFmpeg to package media content
      */
-    private function runFFmpeg(): void
+    private function run(): void
     {
         try {
             $this->media
                 ->addFilter($this->getFilter())
                 ->save($this->getFormat(), $this->getPath());
         } catch (ExceptionInterface $e) {
-            throw new RuntimeException(sprintf("There was an error saving files: \n\n reason: \n %s", $e->getMessage()), $e->getCode(), $e);
+            throw new RuntimeException("An error occurred while saving files: " . $e->getMessage(), $e->getCode(), $e);
         }
     }
 
     /**
-     * @param $path
+     * @param string|null $path
      */
-    private function tmpDirectory($path): void
+    private function tmpDirectory(?string $path): void
     {
-        $basename = $path ? pathinfo($path, PATHINFO_BASENAME) : Utilities::randomString();
+        $basename = $path ? basename($path) : Utilities::randomString();
 
-        $this->tmp_dir = FileManager::tmpDir();
+        $this->tmp_dir = File::tmpDir();
         $this->path_info = pathinfo($this->tmp_dir . $basename);
     }
 
     /**
      * @param $path
      * @param $clouds
      */
-    private function createPathInfoAndTmpDir($path, $clouds): void
+    private function makePaths(?string $path, array $clouds): void
     {
-        if (null !== $path) {
-            $this->path_info = pathinfo($path);
-            FileManager::makeDir($this->path_info["dirname"]);
-        }
-
         if ($clouds) {
             $this->tmpDirectory($path);
-        }
+        } elseif (!is_null($path)) {
+            if (strlen($path) > PHP_MAXPATHLEN) {
+                throw new InvalidArgumentException("The path is too long");
+            }
 
-        if (null === $path && $this->media->isTmp() && !$clouds) {
+            File::makeDir(dirname($path));
+            $this->path_info = pathinfo($path);
+        } elseif ($this->media->isTmp()) {
             throw new InvalidArgumentException("You need to specify a path. It is not possible to save to a tmp directory");
         }
     }
@@ -175,22 +188,9 @@ private function createPathInfoAndTmpDir($path, $clouds): void
      */
     public function save(string $path = null, array $clouds = [], bool $metadata = true)
     {
-        /**
-         * Synopsis
-         * ------------------------------------------------------------------------------
-         * 1. Create directory path, path info array, and temporary folders(if it is required).
-         * 2. Build object and run FFmpeg to package media content and save on the local machine.
-         * 3. If the cloud is specified, entire packaged files will be uploaded to clouds.
-         * 4. If files were saved into a tmp folder, then they will be moved to the local path(if the path is specified).
-         * 5. Return all video and also streams' metadata and save as a json file on the local machine(it won't save metadata to clouds because of some security reasons).
-         * 6. In the end, clear all tmp files.
-         * ------------------------------------------------------------------------------
-         */
-
-        $this->createPathInfoAndTmpDir($path, $clouds);
-        $this->runFFmpeg();
-        CloudManager::uploadDirectory($clouds, $this->tmp_dir);
-        $this->moveTmpFolder($path);
+        $this->makePaths($path, $clouds);
+        $this->run();
+        $this->clouds($clouds, $path);
 
         return $metadata ? (new Metadata($this))->extract() : $this;
     }
@@ -207,7 +207,7 @@ public function __destruct()
         }
 
         if ($this->tmp_dir) {
-            FileManager::deleteDirectory($this->tmp_dir);
+            File::deleteDirectory($this->tmp_dir);
         }
 
         if ($this instanceof HLS && $this->tmp_key_info_file) {