add streaming analytics | bug fixes | some minor improvements

Author: aminyazdanpanah

.appveyor.yml

@@ -16,7 +16,7 @@ environment:
     COMPOSER_NO_INTERACTION: 1
     ANSICON: 121x90 (121x90) # Console colors
 
-  ffmpeg_download: https://ffmpeg.zeranoe.com/builds/win64/static/ffmpeg-20190225-f948082-win64-static.zip
+  ffmpeg_download: https://ffmpeg.zeranoe.com/builds/win64/static/ffmpeg-20190725-923d5c4-win64-static.zip
 
   matrix:
     - PHP_VERSION: 7.1

.travis.yml

@@ -18,5 +18,4 @@ install:
   - sudo apt-get install ffmpeg
 
 script:
-  - /usr/bin/ffmpeg -y -i /home/travis/build/aminyazdanpanah/PHP-FFmpeg-video-streaming/tests/files/test.mp4 -c:v libx264 -s:v 256x144 -crf 20 -sc_threshold 0 -g 48 -keyint_min 48 -hls_list_size 0 -hls_time 5 -hls_allow_cache 1 -b:v 237k -maxrate 284k -hls_segment_filename /home/travis/build/aminyazdanpanah/PHP-FFmpeg-video-streaming/tests/files/test_144p_%04d.ts -strict -2 /home/travis/build/aminyazdanpanah/PHP-FFmpeg-video-streaming/tests/files/test_144p.m3u8 -s:v 426x240 -crf 20 -sc_threshold 0 -g 48 -keyint_min 48 -hls_list_size 0 -hls_time 5 -hls_allow_cache 1 -b:v 292k -maxrate 350k -hls_segment_filename /home/travis/build/aminyazdanpanah/PHP-FFmpeg-video-streaming/tests/files/test_240p_%04d.ts -strict -2 /home/travis/build/aminyazdanpanah/PHP-FFmpeg-video-streaming/tests/files/test_240p.m3u8 -s:v 640x360 -crf 20 -sc_threshold 0 -g 48 -keyint_min 48 -hls_list_size 0 -hls_time 5 -hls_allow_cache 1 -b:v 380k -maxrate 456k -hls_segment_filename /home/travis/build/aminyazdanpanah/PHP-FFmpeg-video-streaming/tests/files/test_360p_%04d.ts -strict -2 /home/travis/build/aminyazdanpanah/PHP-FFmpeg-video-streaming/tests/files/test_360p.m3u8
   - vendor/bin/phpunit tests

README.md

@@ -1,12 +1,12 @@
 # 📼 PHP FFMPEG Video Streaming
 
 [![Build Status](https://travis-ci.org/aminyazdanpanah/PHP-FFmpeg-video-streaming.svg?branch=master)](https://travis-ci.org/aminyazdanpanah/PHP-FFmpeg-video-streaming)
-[![Latest Version on Packagist](https://img.shields.io/packagist/v/aminyazdanpanah/php-ffmpeg-video-streaming.svg?style=flat-square)](https://packagist.org/packages/aminyazdanpanah/php-ffmpeg-video-streaming)
+[![Build status](https://img.shields.io/appveyor/ci/aminyazdanpanah/PHP-FFmpeg-video-streaming/master.svg?style=flat-square&logo=appveyor)](https://ci.appveyor.com/project/aminyazdanpanah/php-ffmpeg-video-streaming)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/aminyazdanpanah/PHP-FFmpeg-video-streaming/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/aminyazdanpanah/PHP-FFmpeg-video-streaming/?branch=master)
-[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](https://github.com/aminyazdanpanah/PHP-FFmpeg-video-streaming/blob/master/LICENSE)
 [![Code Intelligence Status](https://scrutinizer-ci.com/g/aminyazdanpanah/PHP-FFmpeg-video-streaming/badges/code-intelligence.svg?b=master)](https://scrutinizer-ci.com/code-intelligence)
 [![Total Downloads](https://img.shields.io/packagist/dt/aminyazdanpanah/php-ffmpeg-video-streaming.svg?style=flat-square)](https://packagist.org/packages/aminyazdanpanah/php-ffmpeg-video-streaming)
-[![Build status](https://img.shields.io/appveyor/ci/aminyazdanpanah/PHP-FFmpeg-video-streaming/master.svg?style=flat-square&logo=appveyor)](https://ci.appveyor.com/project/aminyazdanpanah/php-ffmpeg-video-streaming)
+[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](https://github.com/aminyazdanpanah/PHP-FFmpeg-video-streaming/blob/master/LICENSE)
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/aminyazdanpanah/php-ffmpeg-video-streaming.svg?style=flat-square)](https://packagist.org/packages/aminyazdanpanah/php-ffmpeg-video-streaming)
 
 This package provides an integration with [PHP-FFmpeg](https://github.com/PHP-FFMpeg/PHP-FFMpeg) and packages well-known live streaming techniques such as DASH and HLS. Also you can use DRM for HLS packaging.
 
@@ -50,19 +50,21 @@ $listener = function ($audio, $format, $percentage) {
 //Also, it can be null-the default path is the input path.
 //These values are optional
 $output_path_dash = '/var/www/media/videos/test/dash/output.mpd'; //or null
-$output_path_hls = null; //or '/var/www/media/videos/test/hls/output.m3u8'
+$output_path_hls = null; //or '/var/www/media/videos/test/hls/output.m3u8';
+$output_path_encrypted_hls = '/var/www/media/videos/test/hls/output.m3u8'; // or null
 
-//The path to the key info for encrypted hls.
-//This value is optional.
-$url_to_key = "https://www.aminyazdanpanah.com/enc.key"; //Path to get the key on your website
-$path_to_save_key = "/var/www/media/keys/my_key/enc.key"; //Path to save the random key on your server
-$hls_key_info = new Streaming\KeyInfo($url_to_key, $path_to_save_key);
+//Path to acceess the key on your website.
+// NOTE: It is highly recommended to protect the key using a token or a session/cookie.
+$url_to_key = "https://www.aminyazdanpanah.com/enc.key";
+//Path to save the random key on your server.
+$path_to_save_key = "/var/www/media/keys/my_key/enc.key";
 
 $result_dash = dash($input_path, $output_path_dash, $listener); //Create dash files.
 $result_hls = hls($input_path, $output_path_hls, $listener, $hls_key_info); //Create hls files.
+$result_encrypted_hls = encrypted_hls($input_path, $output_path_encrypted_hls, $listener, $url_to_key, $path_to_save_key); //Create encrypted hls files
 
 //dupm the results
-var_dump($result_dash, $result_hls);
+var_dump($result_dash, $result_hls, $result_encrypted_hls);
 ```
 
 ## Documentation
@@ -216,28 +218,30 @@ Streaming\FFMpeg::create()
 
 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 cipher text of the preceding block. [read more](http://hlsbook.net/how-to-encrypt-hls-video-with-ffmpeg/)
+HLS uses AES in cipher block chaining (CBC) mode. This means each block is encrypted using the cipher text of the preceding block. [learn more](http://hlsbook.net/how-to-encrypt-hls-video-with-ffmpeg/)
 
 Before we can encrypt videos, we need an encryption key. However you can use any software that can generate key, this package requires a working OpenSSL to create the key:
 
-``` php 
-$url_to_key = "https://www.aminyazdanpanah.com/enc.key"; //Path to get the key on your website
-$path_to_save_key = "/var/www/media/keys/my_key/enc.key"; //Path to save the random key on your server
-$hls_key_info = new Streaming\KeyInfo($url_to_key, $path_to_save_key);
-```
- - **NOTE:** It is recommended to protect your key on your website using a token or a session/cookie.
+Getting OpenSSL: https://www.openssl.org/source/
+
+Getting OpenSSL(Windows): https://slproweb.com/products/Win32OpenSSL.html
 
 The next step is to pass key info to `setHlsKeyInfoFile` method:
 ``` php
+$url = "https://www.aminyazdanpanah.com/enc.key"; //Path to access the key on your website
+$path = "/var/www/media/keys/my_key/enc.key"; //Path to save the random key on your server
+
 Streaming\FFMpeg::create()
     ->open('/var/www/media/videos/test.mp4')
     ->HLS()
     ->X264()
-    ->setHlsKeyInfoFile($hls_key_info)
+    ->generateRandomKeyInfo($url, $path)
     ->autoGenerateRepresentations()
     ->save('/var/www/media/videos/hls/test.m3u8');
 ```
-- **Note:** Alternatively, you can generate a key info using another library and pass the path to the method.
+- **Note:** Alternatively, you can generate a key info using another library and pass the path to the `setHlsKeyInfoFile` method.
+- **NOTE:** It is highly recommended to protect your key on your website using a token or a session/cookie (e.x. https://wwww.aminyazdanpanah.com/enc.key?tk=J5HLhi97Tjk4N).
+- **NOTE:** For getting the benefit of the OpenSSL binary detection in windows, you need to add it to your system path otherwise, you have to pass the path to OpenSSL binary to the `generateRandomKeyInfo` method explicitly. 
 
 ### Other Advanced Features
 You can easily use other advanced features in the [PHP-FFMpeg](https://github.com/PHP-FFMpeg/PHP-FFMpeg) library. In fact, when you open a file with `open` method, it holds the Media object that belongs to the PHP-FFMpeg.

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "aminyazdanpanah/php-ffmpeg-video-streaming",
-    "description": "📹📼 PHP FFMpeg - Video Streaming - DASH, HLS http://video.aminyazdanpanah.com",
+    "description": "📼 PHP FFMpeg - Video Streaming - DASH, HLS http://video.aminyazdanpanah.com",
     "type": "library",
     "keywords": [
         "dash",
@@ -10,6 +10,9 @@
         "streaming",
         "chunk",
         "live",
+        "media",
+        "video-streaming",
+        "live-streaming",
         "AminYazdanpanah",
         "DynamicAdaptiveStreamingOverHTTP"
     ],
@@ -20,7 +23,7 @@
         {
             "name": "Amin Yazdanpanah",
             "email": "contact@aminyazdanpanah.com",
-            "homepage": "http://www.aminyazdanpanah.com"
+            "homepage": "https://www.aminyazdanpanah.com"
         }
     ],
     "minimum-stability": "dev",
@@ -45,7 +48,7 @@
     },
     "require": {
         "php": "^7.1",
-        "php-ffmpeg/php-ffmpeg": "^0.13"
+        "php-ffmpeg/php-ffmpeg": "^0.14"
     },
     "scripts": {
         "test": "vendor/bin/phpunit"

src/AutoRepresentations.php

@@ -19,15 +19,22 @@ class AutoRepresentations
     /** @var Stream $stream */
     private $stream;
 
-    /** @Const regular video's heights */
-    private const heights = [2160, 1080, 720, 480, 240, 144];
+    /** @var array side_values
+     * regular video's heights
+     */
+    private $side_values = [2160, 1080, 720, 480, 240, 144];
 
     /**
      * AutoRepresentations constructor.
      * @param Stream $stream
+     * @param null $side_values
      */
-    public function __construct(Stream $stream)
+    public function __construct(Stream $stream, $side_values)
     {
+        if(null !== $side_values){
+            $this->side_values = $side_values;
+        }
+
         $this->stream = $stream;
     }
 
@@ -65,7 +72,7 @@ public function get(): array
 
         $representations[] = $this->addRepresentation($kilobitrate, $width, $height);
 
-        $heights = array_filter(static::heights, function ($value) use ($height) {
+        $heights = array_filter($this->side_values, function ($value) use ($height) {
             return $value < $height;
         });
 

src/Export.php

@@ -34,14 +34,16 @@ abstract class Export
     public function __construct(Media $media)
     {
         $this->media = $media;
-        $this->path_info = $media->getPathInfo();
+        $this->path_info = pathinfo($media->getPath());
     }
 
     /**
      * @param string $path
-     * @return Export
+     * @param bool $analyse
+     * @param bool $delete_original_video
+     * @return mixed
      */
-    public function save(string $path = null): Export
+    public function save(string $path = null, $analyse = true, $delete_original_video = false)
     {
         $path = $this->getPath($path);
 
@@ -56,7 +58,12 @@ public function save(string $path = null): Export
             $path
         );
 
-        return $this;
+        if ($delete_original_video) {
+            sleep(1);
+            @unlink($this->media->getPath());
+        }
+
+        return ($analyse) ? (new StreamingAnalytics($this))->analyse() : $path;
     }
 
     /**
@@ -71,7 +78,7 @@ abstract protected function setFilter();
 
     private function getPath($path): string
     {
-        if(null !== $path){
+        if (null !== $path) {
             $this->path_info = pathinfo($path);
         }
 
@@ -98,4 +105,12 @@ public function getPathInfo(): array
     {
         return $this->path_info;
     }
+
+    /**
+     * @return object|Media
+     */
+    public function getMedia()
+    {
+        return $this->media;
+    }
 }

src/HLS.php

@@ -74,6 +74,24 @@ public function setHlsKeyInfoFile(string $hls_key_info_file): HLS
         return $this;
     }
 
+    /**
+     * @param string $url
+     * @param string $path
+     * @param string $binary
+     * @return HLS
+     * @throws Exception\Exception
+     */
+    public function generateRandomKeyInfo(string $url = null, string $path = null, string $binary = "openssl"): HLS
+    {
+        if (null === $url && null === $path){
+            $key_name = $url = Helper::randomString() . ".key";
+            $path = $this->path_info["dirname"] . DIRECTORY_SEPARATOR . $key_name;
+        }
+
+        $this->hls_key_info_file = (string) new KeyInfo($url, $path, $binary);
+        return $this;
+    }
+
     /**
      * @return string
      */

src/Helper.php

@@ -11,6 +11,7 @@
 
 namespace Streaming;
 
+
 class Helper
 {
     /**
@@ -35,10 +36,31 @@ public static function makeDir($dirname): void
         }
     }
 
+    /**
+     * @param int $length
+     * @return bool|string
+     */
     public static function randomString($length = 10)
     {
         $chars = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
         return substr(str_shuffle(str_repeat($chars, ceil($length / strlen($chars)))), 1, $length);
 
     }
+
+    /**
+     * @param $dir
+     * @return int|null
+     */
+    public static function directorySize($dir)
+    {
+        if (is_dir($dir)) {
+            $size = 0;
+            foreach (glob(rtrim($dir, '/') . '/*', GLOB_NOSORT) as $each) {
+                $size += is_file($each) ? filesize($each) : static::directorySize($each);
+            }
+            return $size;
+        }
+
+        return null;
+    }
 }

src/KeyInfo.php

@@ -33,7 +33,7 @@ class KeyInfo
      * @param string $binary
      * @throws Exception\Exception
      */
-    public function __construct($url, $path, $binary = "openssl")
+    public function __construct(string $url, string $path, $binary = "openssl")
     {
         $this->url = $url;
         $this->path = $path;
@@ -84,6 +84,6 @@ private function generateRandomKey(): string
      */
     private function generateIV(): string
     {
-        return $this->openssl->removeCommand('16')->addCommand(['-hex' ,'16'])->run();
+        return $this->openssl->reset()->addCommand(['rand', '-hex' ,'16'])->run();
     }
 }

src/Media.php

@@ -79,16 +79,24 @@ public function __call($method, $parameters)
     /**
      * @return mixed
      */
-    public function getFirstStream(): Stream
+    public function getVideoStream(): Stream
     {
-        return $this->media->getStreams()->first();
+        return $this->media->getStreams()->videos()->first();
     }
 
     /**
-     * @return array
+     * @return mixed
+     */
+    public function getAllStreams()
+    {
+        return $this->media->getStreams()->all();
+    }
+
+    /**
+     * @return string
      */
-    public function getPathInfo(): array
+    public function getPath(): string
     {
-        return pathinfo($this->path);
+        return $this->path;
     }
 }

src/Process/Process.php

@@ -91,6 +91,7 @@ public function addCommand($command): Process
         } else {
             $this->commands[] = $command;
         }
+
         return $this;
     }
 
@@ -114,4 +115,13 @@ public function getCommand(): array
     {
         return $this->commands;
     }
+
+    /**
+     * @return Process
+     */
+    public function reset()
+    {
+        $this->commands = [current($this->commands)];
+        return $this;
+    }
 }