m3u8 0.8.2 → 1.8.1

data/spec/lib/m3u8/scte35_time_signal_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe M3u8::Scte35TimeSignal do
+  def build_time_signal_hex(command_bytes, command_length: nil)
+    cmd_len = command_length || command_bytes.length
+    section_length = 11 + cmd_len + 6
+    header = splice_info_header(section_length, cmd_len)
+    command_hex = command_bytes.map { |b| format('%02X', b) }.join
+    "0x#{header}06#{command_hex}0000DEADBEEF"
+  end
+
+  def splice_info_header(section_length, cmd_length)
+    table_id = 'FC'
+    section_header = format('%04X', 0x3000 | section_length)
+    proto_and_pts = '000000000000'
+    cw_index = '00'
+    tier_cmd = format('%06X', (0xFFF << 12) | cmd_length)
+    "#{table_id}#{section_header}#{proto_and_pts}#{cw_index}#{tier_cmd}"
+  end
+
+  describe '.parse_from' do
+    it 'should parse time_signal with PTS time' do
+      # splice_time: time_specified(1)=1, reserved(6)=111111, pts(33)=90000
+      # 90000 = 0x15F90
+      # 1_111111_0_00000000_00000001_01011111_10010000
+      # = FE 00 01 5F 90
+      command_bytes = [0xFE, 0x00, 0x01, 0x5F, 0x90]
+      hex = build_time_signal_hex(command_bytes)
+      result = M3u8::Scte35.parse(hex)
+      cmd = result.splice_command
+
+      expect(cmd).to be_a(described_class)
+      expect(cmd.pts_time).to eq(90_000)
+    end
+
+    it 'should parse time_signal without time_specified' do
+      # time_specified(1)=0, reserved(7)=1111111
+      # = 0x7F (1 byte)
+      command_bytes = [0x7F]
+      hex = build_time_signal_hex(command_bytes)
+      result = M3u8::Scte35.parse(hex)
+      cmd = result.splice_command
+
+      expect(cmd).to be_a(described_class)
+      expect(cmd.pts_time).to be_nil
+    end
+  end
+end

data/spec/lib/m3u8/segment_item_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 
 describe M3u8::SegmentItem do
@@ -21,6 +22,29 @@ describe M3u8::SegmentItem do
     expect(item.comment).to eq 'anything'
   end
 
+  describe '.parse' do
+    it 'parses tag with duration and comment' do
+      tag = '#EXTINF:10.991,anything'
+      item = described_class.parse(tag)
+      expect(item.duration).to eq(10.991)
+      expect(item.comment).to eq('anything')
+    end
+
+    it 'parses tag with duration only' do
+      tag = '#EXTINF:10.991,'
+      item = described_class.parse(tag)
+      expect(item.duration).to eq(10.991)
+      expect(item.comment).to be_nil
+    end
+
+    it 'parses tag without trailing comma' do
+      tag = '#EXTINF:10.991'
+      item = described_class.parse(tag)
+      expect(item.duration).to eq(10.991)
+      expect(item.comment).to be_nil
+    end
+  end
+
   it 'should provide m3u8 format representation' do
     time_hash = { time: '2010-02-19T14:54:23.031' }
     time_item = M3u8::TimeItem.new(time_hash)
@@ -53,4 +77,27 @@ describe M3u8::SegmentItem do
     expected = "#EXTINF:10.991,anything\n#EXT-X-BYTERANGE:4500\ntest.ts"
     expect(output).to eq expected
   end
+
+  it 'wraps raw Time in program_date_time as TimeItem' do
+    time = Time.iso8601('2020-11-25T20:27:00Z')
+    hash = { duration: 10, segment: 'segment.aac',
+             program_date_time: time }
+    item = M3u8::SegmentItem.new(hash)
+    output = item.to_s
+    expected = "#EXTINF:10,\n" \
+               "#EXT-X-PROGRAM-DATE-TIME:2020-11-25T20:27:00Z\n" \
+               'segment.aac'
+    expect(output).to eq expected
+  end
+
+  it 'converts very small durations to floating point' do
+    time = Time.iso8601('2020-11-25T20:27:00Z')
+    hash = { duration: 0.000001, segment: 'test.ts', program_date_time: time }
+    item = M3u8::SegmentItem.new(hash)
+    output = item.to_s
+    expected = "#EXTINF:0.000001,\n" \
+               "#EXT-X-PROGRAM-DATE-TIME:2020-11-25T20:27:00Z\n" \
+               'test.ts'
+    expect(output).to eq expected
+  end
 end

data/spec/lib/m3u8/server_control_item_spec.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe M3u8::ServerControlItem do
+  describe '.new' do
+    it 'assigns attributes from options' do
+      options = { can_skip_until: 36.0, can_skip_dateranges: true,
+                  hold_back: 15.0, part_hold_back: 3.0,
+                  can_block_reload: true }
+      item = described_class.new(options)
+      expect(item.can_skip_until).to eq(36.0)
+      expect(item.can_skip_dateranges).to be true
+      expect(item.hold_back).to eq(15.0)
+      expect(item.part_hold_back).to eq(3.0)
+      expect(item.can_block_reload).to be true
+    end
+  end
+
+  describe '.parse' do
+    it 'parses tag with all attributes' do
+      tag = '#EXT-X-SERVER-CONTROL:CAN-SKIP-UNTIL=36.0,' \
+            'CAN-SKIP-DATERANGES=YES,HOLD-BACK=15.0,' \
+            'PART-HOLD-BACK=3.0,CAN-BLOCK-RELOAD=YES'
+      item = described_class.parse(tag)
+      expect(item.can_skip_until).to eq(36.0)
+      expect(item.can_skip_dateranges).to be true
+      expect(item.hold_back).to eq(15.0)
+      expect(item.part_hold_back).to eq(3.0)
+      expect(item.can_block_reload).to be true
+    end
+
+    it 'parses tag without optional attributes' do
+      tag = '#EXT-X-SERVER-CONTROL:PART-HOLD-BACK=1.0,' \
+            'CAN-BLOCK-RELOAD=YES'
+      item = described_class.parse(tag)
+      expect(item.can_skip_until).to be_nil
+      expect(item.can_skip_dateranges).to be false
+      expect(item.part_hold_back).to eq(1.0)
+      expect(item.can_block_reload).to be true
+    end
+  end
+
+  describe '#to_s' do
+    it 'returns tag with all attributes' do
+      options = { can_skip_until: 36.0, can_skip_dateranges: true,
+                  hold_back: 15.0, part_hold_back: 3.0,
+                  can_block_reload: true }
+      item = described_class.new(options)
+      expected = '#EXT-X-SERVER-CONTROL:CAN-SKIP-UNTIL=36.0,' \
+                 'CAN-SKIP-DATERANGES=YES,HOLD-BACK=15.0,' \
+                 'PART-HOLD-BACK=3.0,CAN-BLOCK-RELOAD=YES'
+      expect(item.to_s).to eq(expected)
+    end
+
+    it 'returns tag with only required attributes' do
+      options = { part_hold_back: 1.0, can_block_reload: true }
+      item = described_class.new(options)
+      expected = '#EXT-X-SERVER-CONTROL:PART-HOLD-BACK=1.0,' \
+                 'CAN-BLOCK-RELOAD=YES'
+      expect(item.to_s).to eq(expected)
+    end
+  end
+end

data/spec/lib/m3u8/session_data_item_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 
 describe M3u8::SessionDataItem do

data/spec/lib/m3u8/session_key_item_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 
 describe M3u8::SessionKeyItem do

data/spec/lib/m3u8/skip_item_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe M3u8::SkipItem do
+  describe '.new' do
+    it 'assigns attributes from options' do
+      options = { skipped_segments: 10,
+                  recently_removed_dateranges: 'dr1\tdr2' }
+      item = described_class.new(options)
+      expect(item.skipped_segments).to eq(10)
+      expect(item.recently_removed_dateranges).to eq('dr1\tdr2')
+    end
+  end
+
+  describe '.parse' do
+    it 'parses tag with all attributes' do
+      tag = '#EXT-X-SKIP:SKIPPED-SEGMENTS=10,' \
+            'RECENTLY-REMOVED-DATERANGES="dr1\tdr2"'
+      item = described_class.parse(tag)
+      expect(item.skipped_segments).to eq(10)
+      expect(item.recently_removed_dateranges).to eq('dr1\tdr2')
+    end
+
+    it 'parses tag without optional attributes' do
+      tag = '#EXT-X-SKIP:SKIPPED-SEGMENTS=5'
+      item = described_class.parse(tag)
+      expect(item.skipped_segments).to eq(5)
+      expect(item.recently_removed_dateranges).to be_nil
+    end
+  end
+
+  describe '#to_s' do
+    it 'returns tag with all attributes' do
+      options = { skipped_segments: 10,
+                  recently_removed_dateranges: 'dr1\tdr2' }
+      item = described_class.new(options)
+      expected = '#EXT-X-SKIP:SKIPPED-SEGMENTS=10,' \
+                 'RECENTLY-REMOVED-DATERANGES="dr1\tdr2"'
+      expect(item.to_s).to eq(expected)
+    end
+
+    it 'returns tag with only required attributes' do
+      item = described_class.new(skipped_segments: 5)
+      expect(item.to_s).to eq('#EXT-X-SKIP:SKIPPED-SEGMENTS=5')
+    end
+  end
+end

data/spec/lib/m3u8/time_item_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 
 describe M3u8::TimeItem do

data/spec/lib/m3u8/writer_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 
 describe M3u8::Writer do
@@ -16,7 +17,7 @@ describe M3u8::Writer do
         item = M3u8::PlaylistItem.new(options)
         playlist.items << item
         options = { data_id: 'com.test.movie.title', value: 'Test',
-                    uri: 'http://test', language: 'en' }
+                    language: 'en' }
         item = M3u8::SessionDataItem.new(options)
         playlist.items << item
 
@@ -27,7 +28,7 @@ describe M3u8::Writer do
                    %(RESOLUTION=1920x1080,CODECS="avc1.640029,mp4a.40.2") +
                    ",BANDWIDTH=50000\nplaylist_url\n" +
                    %(#EXT-X-SESSION-DATA:DATA-ID="com.test.movie.title",) +
-                   %(VALUE="Test",URI="http://test",LANGUAGE="en"\n)
+                   %(VALUE="Test",LANGUAGE="en"\n)
 
         io = StringIO.open
         writer = described_class.new(io)
@@ -44,9 +45,7 @@ describe M3u8::Writer do
         playlist = M3u8::Playlist.new
         playlist.items << item
 
-        expected = "#EXTM3U\n" +
-                   %(#EXT-X-STREAM-INF:PROGRAM-ID=1,CODECS="mp4a.40.34") +
-                   ",BANDWIDTH=6400\nplaylist_url\n"
+        expected = "#EXTM3U\n#EXT-X-STREAM-INF:PROGRAM-ID=1,CODECS=\"mp4a.40.34\",BANDWIDTH=6400\nplaylist_url\n"
 
         io = StringIO.open
         writer = described_class.new(io)
@@ -93,16 +92,16 @@ describe M3u8::Writer do
         writer.write(M3u8::Playlist.new)
 
         expected = "#EXTM3U\n" \
-          "#EXT-X-MEDIA-SEQUENCE:0\n" \
-          "#EXT-X-TARGETDURATION:10\n" \
-          "#EXT-X-ENDLIST\n"
+                   "#EXT-X-MEDIA-SEQUENCE:0\n" \
+                   "#EXT-X-TARGETDURATION:10\n" \
+                   "#EXT-X-ENDLIST\n"
         expect(io.string).to eq(expected)
       end
     end
 
     context 'when playlist is a media playlist' do
       it 'writes playlist to io' do
-        options = { version: 4, cache: false, target: 6.2, sequence: 1,
+        options = { version: 4, cache: false, target: 12, sequence: 1,
                     discontinuity_sequence: 10, type: 'EVENT',
                     iframes_only: true }
         playlist = M3u8::Playlist.new(options)
@@ -111,16 +110,16 @@ describe M3u8::Writer do
         playlist.items << item
 
         expected = "#EXTM3U\n" \
-          "#EXT-X-PLAYLIST-TYPE:EVENT\n" \
-          "#EXT-X-VERSION:4\n" \
-          "#EXT-X-I-FRAMES-ONLY\n" \
-          "#EXT-X-MEDIA-SEQUENCE:1\n" \
-          "#EXT-X-DISCONTINUITY-SEQUENCE:10\n" \
-          "#EXT-X-ALLOW-CACHE:NO\n" \
-          "#EXT-X-TARGETDURATION:6\n" \
-          "#EXTINF:11.344644,\n" \
-          "1080-7mbps00000.ts\n" \
-          "#EXT-X-ENDLIST\n"
+                   "#EXT-X-PLAYLIST-TYPE:EVENT\n" \
+                   "#EXT-X-VERSION:4\n" \
+                   "#EXT-X-I-FRAMES-ONLY\n" \
+                   "#EXT-X-MEDIA-SEQUENCE:1\n" \
+                   "#EXT-X-DISCONTINUITY-SEQUENCE:10\n" \
+                   "#EXT-X-ALLOW-CACHE:NO\n" \
+                   "#EXT-X-TARGETDURATION:12\n" \
+                   "#EXTINF:11.344644,\n" \
+                   "1080-7mbps00000.ts\n" \
+                   "#EXT-X-ENDLIST\n"
 
         io = StringIO.open
         writer = described_class.new(io)
@@ -133,7 +132,7 @@ describe M3u8::Writer do
       it 'writes playlist to io' do
         options = { duration: 11.344644, segment: '1080-7mbps00000.ts' }
         item =  M3u8::SegmentItem.new(options)
-        playlist = M3u8::Playlist.new(version: 7)
+        playlist = M3u8::Playlist.new(version: 7, target: 12)
         playlist.items << item
 
         options = { method: 'AES-128', uri: 'http://test.key',
@@ -149,7 +148,7 @@ describe M3u8::Writer do
         expected = "#EXTM3U\n" \
                    "#EXT-X-VERSION:7\n" \
                    "#EXT-X-MEDIA-SEQUENCE:0\n" \
-                   "#EXT-X-TARGETDURATION:10\n" \
+                   "#EXT-X-TARGETDURATION:12\n" \
                    "#EXTINF:11.344644,\n" \
                    "1080-7mbps00000.ts\n" +
                    %(#EXT-X-KEY:METHOD=AES-128,URI="http://test.key",) +
@@ -166,10 +165,49 @@ describe M3u8::Writer do
       end
     end
 
-    it 'raises error if item types are mixed' do
+    context 'when playlist is an LL-HLS media playlist' do
+      it 'writes server control and part inf in header' do
+        server_control = M3u8::ServerControlItem.new(
+          can_skip_until: 24.0, part_hold_back: 1.0,
+          can_block_reload: true
+        )
+        part_inf = M3u8::PartInfItem.new(part_target: 0.5)
+        playlist = M3u8::Playlist.new(
+          version: 9, target: 4, sequence: 100,
+          server_control: server_control, part_inf: part_inf,
+          live: true
+        )
+        item = M3u8::SegmentItem.new(duration: 4.0,
+                                     segment: 'seg100.mp4')
+        playlist.items << item
+
+        part = M3u8::PartItem.new(duration: 0.5,
+                                  uri: 'seg101.0.mp4',
+                                  independent: true)
+        playlist.items << part
+
+        io = StringIO.open
+        writer = described_class.new(io)
+        writer.write(playlist)
+
+        expect(io.string).to include(
+          '#EXT-X-SERVER-CONTROL:CAN-SKIP-UNTIL=24.0,' \
+          'PART-HOLD-BACK=1.0,CAN-BLOCK-RELOAD=YES'
+        )
+        expect(io.string).to include(
+          '#EXT-X-PART-INF:PART-TARGET=0.5'
+        )
+        expect(io.string).to include(
+          '#EXT-X-PART:DURATION=0.5,URI="seg101.0.mp4",INDEPENDENT=YES'
+        )
+        expect(io.string).not_to include('#EXT-X-ENDLIST')
+      end
+    end
+
+    it 'raises error with specific messages if item types are mixed' do
       playlist = M3u8::Playlist.new
-      options = { program_id: 1, width: 1920, height: 1080, codecs: 'avc',
-                  bandwidth: 540, playlist: 'test.url' }
+      options = { program_id: 1, width: 1920, height: 1080,
+                  codecs: 'avc', bandwidth: 540, uri: 'test.url' }
       item = M3u8::PlaylistItem.new(options)
       playlist.items << item
 
@@ -177,7 +215,8 @@ describe M3u8::Writer do
       item = M3u8::SegmentItem.new(options)
       playlist.items << item
 
-      message = 'Playlist is invalid.'
+      message = 'Playlist is invalid: Playlist contains both ' \
+                'master and media items'
       io = StringIO.new
       writer = described_class.new(io)
       expect { writer.write(playlist) }
@@ -220,8 +259,8 @@ describe M3u8::Writer do
         expect(playlist.master?).to be true
 
         expected = "#EXTM3U\n" \
-                 "#EXT-X-VERSION:6\n" \
-                 "#EXT-X-INDEPENDENT-SEGMENTS\n"
+                   "#EXT-X-VERSION:6\n" \
+                   "#EXT-X-INDEPENDENT-SEGMENTS\n"
 
         io = StringIO.open
         writer = described_class.new(io)
@@ -242,9 +281,9 @@ describe M3u8::Writer do
         writer.write_header(playlist)
 
         expected = "#EXTM3U\n" \
-          "#EXT-X-VERSION:7\n" \
-          "#EXT-X-MEDIA-SEQUENCE:0\n" \
-          "#EXT-X-TARGETDURATION:10\n"
+                   "#EXT-X-VERSION:7\n" \
+                   "#EXT-X-MEDIA-SEQUENCE:0\n" \
+                   "#EXT-X-TARGETDURATION:10\n"
 
         expect(io.string).to eq(expected)
       end

data/spec/lib/m3u8_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 
 describe do

data/spec/spec_helper.rb

@@ -1,100 +1,17 @@
 # frozen_string_literal: true
-require 'm3u8'
 require 'simplecov'
-require 'coveralls'
+SimpleCov.start do
+  minimum_coverage 100
+end
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
-  SimpleCov::Formatter::HTMLFormatter,
-  Coveralls::SimpleCov::Formatter
-])
-SimpleCov.start
+require 'm3u8'
 
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# The generated `.rspec` file contains `--require spec_helper` which will cause this
-# file to always be loaded, without a need to explicitly require it in any files.
-#
-# Given that it is always loaded, you are encouraged to keep this file as
-# light-weight as possible. Requiring heavyweight dependencies from this file
-# will add to the boot time of your test suite on EVERY test run, even for an
-# individual file that may not need all of that loaded. Instead, consider making
-# a separate helper file that requires the additional dependencies and performs
-# the additional setup, and require it from the spec files that actually need it.
-#
-# The `.rspec` file also contains a few flags that are not defaults but that
-# users commonly want.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
   config.expect_with :rspec do |expectations|
-    # This option will default to `true` in RSpec 4. It makes the `description`
-    # and `failure_message` of custom matchers include text for helper methods
-    # defined using `chain`, e.g.:
-    # be_bigger_than(2).and_smaller_than(4).description
-    #   # => "be bigger than 2 and smaller than 4"
-    # ...rather than:
-    #   # => "be bigger than 2"
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
 
-  # rspec-mocks config goes here. You can use an alternate test double
-  # library (such as bogus or mocha) by changing the `mock_with` option here.
   config.mock_with :rspec do |mocks|
-    # Prevents you from mocking or stubbing a method that does not exist on
-    # a real object. This is generally recommended, and will default to
-    # `true` in RSpec 4.
     mocks.verify_partial_doubles = true
   end
-
-# The settings below are suggested to provide a good initial experience
-# with RSpec, but feel free to customize to your heart's content.
-=begin
-  # These two settings work together to allow you to limit a spec run
-  # to individual examples or groups you care about by tagging them with
-  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
-  # get run.
-  config.filter_run :focus
-  config.run_all_when_everything_filtered = true
-
-  # Limits the available syntax to the non-monkey patched syntax that is recommended.
-  # For more details, see:
-  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
-  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
-  config.disable_monkey_patching!
-
-  # This setting enables warnings. It's recommended, but in some cases may
-  # be too noisy due to issues in dependencies.
-  config.warnings = true
-
-  # Many RSpec users commonly either run the entire suite or an individual
-  # file, and it's useful to allow more verbose output when running an
-  # individual spec file.
-  if config.files_to_run.one?
-    # Use the documentation formatter for detailed output,
-    # unless a formatter has already been configured
-    # (e.g. via a command-line flag).
-    config.default_formatter = 'doc'
-  end
-
-  # Print the 10 slowest examples and example groups at the
-  # end of the spec run, to help surface which specs are running
-  # particularly slow.
-  config.profile_examples = 10
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = :random
-
-  # Seed global randomization in this process using the `--seed` CLI option.
-  # Setting this allows you to use `--seed` to deterministically reproduce
-  # test failures related to randomization by passing the same `--seed` value
-  # as the one that triggered the failure.
-  Kernel.srand config.seed
-=end
 end