Option to disable format sorting in HLS exporter.

Author: pascalbaljet

CHANGELOG.md

@@ -2,6 +2,57 @@
 
 All Notable changes to `pbmedia/laravel-ffmpeg` will be documented in this file
 
+## 2.1.0 - 2018-04-10
+
+### Added
+- Option to disable format sorting in HLS exporter.
+
+### Deprecated
+- Nothing
+
+### Fixed
+- Nothing
+
+### Removed
+- Nothing
+
+### Security
+- Nothing
+
+## 2.0.1 - 2018-02-30
+
+### Added
+- Nothing
+
+### Deprecated
+- Nothing
+
+### Fixed
+- Symfony 4.0 workaround
+
+### Removed
+- Nothing
+
+### Security
+- Nothing
+
+## 2.0.0 - 2018-02-19
+
+### Added
+- Support for Laravel 5.6.
+
+### Deprecated
+- Nothing
+
+### Fixed
+- Nothing
+
+### Removed
+- Support for Laravel 5.5 and earlier.
+
+### Security
+- Nothing
+
 ## 1.3.0 - 2017-11-13
 
 ### Added

README.md

@@ -235,6 +235,14 @@ $exporter = FFMpeg::open('steve_howe.mp4')
     });
 ```
 
+As of version 2.1.0 you can disable the sorting of the added formats as most players choose the first format as the default one.
+
+``` php
+$exporter = FFMpeg::open('steve_howe.mp4')
+    ->exportForHLS()
+    ->dontSortFormats();
+```
+
 ## Advanced
 
 The Media object you get when you 'open' a file, actually holds the Media object that belongs to the [underlying driver](https://github.com/PHP-FFMpeg/PHP-FFMpeg). It handles dynamic method calls as you can see [here](https://github.com/pascalbaljetmedia/laravel-ffmpeg/blob/master/src/Media.php#L114-L117). This way all methods of the underlying driver are still available to you.

src/HLSPlaylistExporter.php

@@ -17,6 +17,8 @@ class HLSPlaylistExporter extends MediaExporter
 
     protected $progressCallback;
 
+    protected $sortFormats = true;
+
     public function addFormat(VideoInterface $format, callable $callback = null): MediaExporter
     {
         $segmentedExporter = $this->getSegmentedExporterFromFormat($format);
@@ -30,6 +32,13 @@ public function addFormat(VideoInterface $format, callable $callback = null): Me
         return $this;
     }
 
+    public function dontSortFormats()
+    {
+        $this->sortFormats = false;
+
+        return $this;
+    }
+
     public function getFormatsSorted(): array
     {
         return array_map(function ($exporter) {
@@ -39,9 +48,11 @@ public function getFormatsSorted(): array
 
     public function getSegmentedExportersSorted(): array
     {
-        usort($this->segmentedExporters, function ($exportedA, $exportedB) {
-            return $exportedA->getFormat()->getKiloBitrate() <=> $exportedB->getFormat()->getKiloBitrate();
-        });
+        if ($this->sortFormats) {
+            usort($this->segmentedExporters, function ($exportedA, $exportedB) {
+                return $exportedA->getFormat()->getKiloBitrate() <=> $exportedB->getFormat()->getKiloBitrate();
+            });
+        }
 
         return $this->segmentedExporters;
     }
@@ -121,7 +132,9 @@ protected function getMasterPlaylistContents(): string
     {
         $lines = ['#EXTM3U'];
 
-        foreach ($this->getSegmentedExportersSorted() as $segmentedExporter) {
+        $segmentedExporters = $this->sortFormats ? $this->getSegmentedExportersSorted() : $this->getSegmentedExporters();
+
+        foreach ($segmentedExporters as $segmentedExporter) {
             $bitrate = $segmentedExporter->getFormat()->getKiloBitrate() * 1000;
 
             $lines[] = '#EXT-X-STREAM-INF:BANDWIDTH=' . $bitrate;

tests/HLSPlaylistExporterTest.php

@@ -180,4 +180,47 @@ public function testCreationOfPlaylist()
 
         @unlink($this->srcDir . '/MyPlaylist.m3u8');
     }
+
+    public function testDisableSortingOfFormats()
+    {
+        $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);
+
+        $media->shouldReceive('addFilter')->once();
+
+        $media->shouldReceive('save')->once()->withArgs([
+            $formatA, $this->srcDir . '/MyPlaylist_384_%05d.ts',
+        ]);
+
+        $media->shouldReceive('save')->once()->withArgs([
+            $formatB, $this->srcDir . '/MyPlaylist_512_%05d.ts',
+        ]);
+
+        $exporter = new HLSPlaylistExporter($media);
+
+        $exporter->addFormat($formatB)
+            ->addFormat($formatA)
+            ->dontSortFormats()
+            ->setPlaylistPath($playlist)
+            ->setSegmentLength(15);
+
+        $exporter->toDisk('local')->save($playlist);
+
+        $this->assertEquals(file_get_contents($this->srcDir . '/MyPlaylist.m3u8'),
+            '#EXTM3U' . PHP_EOL .
+            '#EXT-X-STREAM-INF:BANDWIDTH=512000' . PHP_EOL .
+            'MyPlaylist_512.m3u8' . PHP_EOL .
+            '#EXT-X-STREAM-INF:BANDWIDTH=384000' . PHP_EOL .
+            'MyPlaylist_384.m3u8'
+        );
+
+        @unlink($this->srcDir . '/MyPlaylist.m3u8');
+    }
 }