Monitor HLS exports

Author: pascalbaljet

CHANGELOG.md

@@ -2,6 +2,23 @@
 
 All Notable changes to `pbmedia/laravel-ffmpeg` will be documented in this file
 
+## 1.3.0 - 2017-11-13
+
+### Added
+- Support for monitoring the progress of a HLS Export.
+
+### Deprecated
+- Nothing
+
+### Fixed
+- Some refactoring
+
+### Removed
+- Nothing
+
+### Security
+- Nothing
+
 ## 1.2.0 - 2017-11-13
 
 ### Added

README.md

@@ -177,6 +177,14 @@ $durationInSeconds = $media->getDurationInSeconds(); // returns an int
 $durationInMiliseconds = $media->getDurationInMiliseconds(); // returns a float
 ```
 
+When opening or saving files from or to a remote disk, temporary files will be created on your server. After you're done exporting or processing these files, you could clean them up by calling the ```cleanupTemporaryFiles()``` method:
+
+``` php
+FFMpeg::cleanupTemporaryFiles();
+```
+
+## HLS
+
 You can create a M3U8 playlist to do [HLS](https://en.wikipedia.org/wiki/HTTP_Live_Streaming). Exporting is currently only supported on local disks.
 
 ``` php
@@ -215,11 +223,14 @@ FFMpeg::open('steve_howe.mp4')
     ->save('adaptive_steve.m3u8');
 ```
 
-
-When opening or saving files from or to a remote disk, temporary files will be created on your server. After you're done exporting or processing these files, you could clean them up by calling the ```cleanupTemporaryFiles()``` method:
+As of version 1.3.0 you can monitor the transcoding progress of a HLS export. Use the ```onProgress``` method to provide a callback which gives you the completed percentage.
 
 ``` php
-FFMpeg::cleanupTemporaryFiles();
+$exporter = FFMpeg::open('steve_howe.mp4')
+    ->exportForHLS()
+    ->onProgress(function ($percentage) {
+        echo "$percentage % transcoded";
+    });
 ```
 
 ## Advanced

src/HLSPlaylistExporter.php

@@ -15,6 +15,8 @@ class HLSPlaylistExporter extends MediaExporter
 
     protected $saveMethod = 'savePlaylist';
 
+    protected $progressCallback;
+
     public function addFormat(VideoInterface $format, callable $callback = null): MediaExporter
     {
         $segmentedExporter = $this->getSegmentedExporterFromFormat($format);
@@ -75,11 +77,43 @@ public function getSegmentedExporters(): array
         return $this->segmentedExporters;
     }
 
+    public function onProgress(callable $callback)
+    {
+        $this->progressCallback = $callback;
+
+        return $this;
+    }
+
+    private function getSegmentedProgressCallback($key): callable
+    {
+        return function ($video, $format, $percentage) use ($key) {
+            $previousCompletedSegments = $key / count($this->segmentedExporters) * 100;
+
+            call_user_func($this->progressCallback,
+                $previousCompletedSegments + ($percentage / count($this->segmentedExporters))
+            );
+        };
+    }
+
+    public function prepareSegmentedExporters()
+    {
+        foreach ($this->segmentedExporters as $key => $segmentedExporter) {
+            if ($this->progressCallback) {
+                $segmentedExporter->getFormat()->on('progress', $this->getSegmentedProgressCallback($key));
+            }
+
+            $segmentedExporter->setSegmentLength($this->segmentLength);
+        }
+
+        return $this;
+    }
+
     protected function exportStreams()
     {
-        foreach ($this->segmentedExporters as $segmentedExporter) {
-            $segmentedExporter->setSegmentLength($this->segmentLength)
-                ->saveStream($this->playlistPath);
+        $this->prepareSegmentedExporters();
+
+        foreach ($this->segmentedExporters as $key => $segmentedExporter) {
+            $segmentedExporter->saveStream($this->playlistPath);
         }
     }
 

tests/HLSPlaylistExporterTest.php

@@ -69,6 +69,43 @@ public function testSegmentExporters()
         $this->assertEquals(15, $segmentedExporters[1]->getFilter()->getSegmentLength());
     }
 
+    public function testProgressCallbackOfSegmentExporters()
+    {
+        $file = $this->getVideoMedia()->getFile();
+
+        $media = Mockery::mock(Media::class);
+        $media->shouldReceive('getFile')->once()->andReturn($file);
+
+        $playlist = 'MyPlaylist.m3u8';
+
+        $formatA = (new \FFMpeg\Format\Video\X264)->setKiloBitrate(384);
+        $formatB = (new \FFMpeg\Format\Video\X264)->setKiloBitrate(512);
+
+        $totalPercentage = 0;
+        $HLSExporter     = new HLSPlaylistExporter($media);
+
+        $segmentedExporters = $HLSExporter->addFormat($formatA)
+            ->addFormat($formatB)
+            ->onProgress(function ($percentage) use (&$totalPercentage) {
+                $totalPercentage = $percentage;
+            })
+            ->prepareSegmentedExporters()
+            ->getSegmentedExporters();
+
+        $segmentedExporters[0]->getFormat()->emit('progress', [
+            $file, $formatA, 30,
+        ]);
+
+        $this->assertEquals(15, $totalPercentage);
+
+        $segmentedExporters[1]->getFormat()->emit('progress', [
+            $file, $formatA, 60,
+        ]);
+
+        $this->assertEquals(80, $totalPercentage);
+
+    }
+
     public function testSegmentExportersWithCallback()
     {
         $media = $this->getVideoMedia();