m3u8 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb897f32a24dabcd87ebd26a367425c8eae33113
-  data.tar.gz: 5726036c12d84a49d24ae14f21cf52e817c3bc1c
+  metadata.gz: 75266714b1670b4990419287c300fa920604bf1c
+  data.tar.gz: af15a6e305fcbf82517d0b2858aed3fa848a80b2
 SHA512:
-  metadata.gz: db0747bc9be34249f3fbf35d40255763e8b96cddcf9d857495361e8186df81fc4285e6740bc54abab804d2617504c77b8ac7befbb2cc2604e7de0a52d2963d65
-  data.tar.gz: ee311cc358cca4494c6d5c1a4fa8e64e50977076d8001d3a1258ca1a4762354f6886b903293f06a424136044b6112e1f4c501dfe449508238d4e6d5e1e7be0dd
+  metadata.gz: 787197f4b3f4807c17125928e3b976c46f66b914b4bf7566c34e5748dd9200d84492c7fa858874d21cbbb9b7dbbfc9b91f04bac8954760a8e18689514459589e
+  data.tar.gz: 7d279886bd83eacfcd8e2e71463f6b96075dd5e3ed8d742d3b0c5ee7c0dc97932a7c07943fe5b49bad9e44c6631023f916479c5b0a7936c035d9d37adec79e74

data/CHANGELOG.md

@@ -1,5 +1,11 @@
+0.7.1 (2/23/2017) - Added support for the EXT-X-DATERANGE tag. Minor refactoring of existing classes.
+
+***
+
 0.7.0 (2/3/2017) - Added support for EXT-X-INDEPENDENT-SEGMENTS and EXT-X-START tags. Minor version bumped due to changes of default values for new playlists.
 
+***
+
 0.6.9 (4/24/2016) - Merged pull request #17 from [ghn](https://github.com/ghn). Removes return when parsing next line in playlist.
 
 ***

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in m3u8.gemspec

data/Guardfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 guard :rspec, cmd: 'bundle exec rspec' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }

data/Rakefile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/lib/m3u8.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'bigdecimal'
 require 'stringio'
 Dir[File.dirname(__FILE__) + '/m3u8/*.rb'].sort.each { |file| require file }
@@ -12,10 +13,14 @@ module M3u8
   end
 
   def parse_attributes(line)
-    array = line.delete("\n").scan(/([A-z-]+)\s*=\s*("[^"]*"|[^,]*)/)
+    array = line.delete("\n").scan(/([A-z0-9-]+)\s*=\s*("[^"]*"|[^,]*)/)
     Hash[array.map { |key, value| [key, value.delete('"')] }]
   end
 
+  def parse_float(value)
+    value.nil? ? nil : value.to_f
+  end
+
   def parse_yes_no(value)
     value == 'YES' ? true : false
   end

data/lib/m3u8/byte_range.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module M3u8
   # ByteRange represents sub range of a resource
   class ByteRange

data/lib/m3u8/date_range_item.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+module M3u8
+  # DateRangeItem represents a #EXT-X-DATERANGE tag
+  class DateRangeItem
+    include M3u8
+    attr_accessor :id, :class_name, :start_date, :end_date, :duration,
+                  :planned_duration, :scte35_cmd, :scte35_out, :scte35_in,
+                  :end_on_next, :client_attributes
+
+    def initialize(options = {})
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+    def parse(text)
+      attributes = parse_attributes(text)
+      @id = attributes['ID']
+      @class_name = attributes['CLASS']
+      @start_date = attributes['START-DATE']
+      @end_date = attributes['END-DATE']
+      @duration = parse_float(attributes['DURATION'])
+      @planned_duration = parse_float(attributes['PLANNED-DURATION'])
+      @scte35_cmd = attributes['SCTE35-CMD']
+      @scte35_out = attributes['SCTE35-OUT']
+      @scte35_in = attributes['SCTE35-IN']
+      @end_on_next = attributes.key?('END-ON-NEXT') ? true : false
+      @client_attributes = parse_client_attributes(attributes)
+    end
+
+    def to_s
+      "#EXT-X-DATERANGE:#{formatted_attributes}"
+    end
+
+    private
+
+    def formatted_attributes
+      [%(ID="#{id}"),
+       class_name_format,
+       %(START-DATE="#{start_date}"),
+       end_date_format,
+       duration_format,
+       planned_duration_format,
+       client_attributes_format,
+       scte35_cmd_format,
+       scte35_out_format,
+       scte35_in_format,
+       end_on_next_format].compact.join(',')
+    end
+
+    def class_name_format
+      return if class_name.nil?
+      %(CLASS="#{class_name}")
+    end
+
+    def end_date_format
+      return if end_date.nil?
+      %(END-DATE="#{end_date}")
+    end
+
+    def duration_format
+      return if duration.nil?
+      "DURATION=#{duration}"
+    end
+
+    def planned_duration_format
+      return if planned_duration.nil?
+      "PLANNED-DURATION=#{planned_duration}"
+    end
+
+    def client_attributes_format
+      return if client_attributes.nil?
+      client_attributes.map do |attribute|
+        value = attribute.last
+        value_format = decimal?(value) ? value : %("#{value}")
+        "#{attribute.first}=#{value_format}"
+      end
+    end
+
+    def decimal?(value)
+      return true if value =~ /\A\d+\Z/
+      begin
+        return true if Float(value)
+      rescue
+        false
+      end
+    end
+
+    def scte35_cmd_format
+      return if scte35_cmd.nil?
+      "SCTE35-CMD=#{scte35_cmd}"
+    end
+
+    def scte35_out_format
+      return if scte35_out.nil?
+      "SCTE35-OUT=#{scte35_out}"
+    end
+
+    def scte35_in_format
+      return if scte35_in.nil?
+      "SCTE35-IN=#{scte35_in}"
+    end
+
+    def end_on_next_format
+      return unless end_on_next
+      'END-ON-NEXT=YES'
+    end
+
+    def parse_client_attributes(attributes)
+      attributes.select { |key| key.start_with?('X-') }
+    end
+  end
+end

data/lib/m3u8/discontinuity_item.rb

@@ -1,12 +1,10 @@
+# frozen_string_literal: true
 module M3u8
   # DiscontinuityItem represents a EXT-X-DISCONTINUITY tag to indicate a
   # discontinuity between the SegmentItems that proceed and follow it.
   class DiscontinuityItem
     attr_accessor :tag
 
-    def initialize
-    end
-
     def to_s
       "#EXT-X-DISCONTINUITY\n"
     end

data/lib/m3u8/encryptable.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module M3u8
   # Encapsulates logic common to encryption key tags
   module Encryptable

data/lib/m3u8/error.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module M3u8
   class PlaylistTypeError < StandardError
   end

data/lib/m3u8/key_item.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module M3u8
   # KeyItem represents a set of EXT-X-KEY attributes
   class KeyItem

data/lib/m3u8/map_item.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module M3u8
   # MapItem represents a EXT-X-MAP tag which specifies how to obtain the Media
   # Initialization Section

data/lib/m3u8/media_item.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module M3u8
   # MediaItem represents a set of EXT-X-MEDIA attributes
   class MediaItem

data/lib/m3u8/playback_start.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module M3u8
   # PlaybackStart represents a #EXT-X-START tag and attributes
   class PlaybackStart

data/lib/m3u8/playlist.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module M3u8
   # Playlist represents an m3u8 playlist, it can be a master playlist or a set
   # of media segments

data/lib/m3u8/playlist_item.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module M3u8
   # PlaylistItem represents a set of EXT-X-STREAM-INF or
   # EXT-X-I-FRAME-STREAM-INF attributes
@@ -36,17 +37,11 @@ module M3u8
     def codecs
       return @codecs unless @codecs.nil?
 
-      video_codec = video_codec profile, level
+      video = video_codec(profile, level)
+      return audio_codec if video.nil?
+      return video if audio_codec.nil?
 
-      if video_codec.nil?
-        return audio_codec
-      else
-        if audio_codec.nil?
-          return video_codec
-        else
-          return "#{video_codec},#{audio_codec}"
-        end
-      end
+      "#{video},#{audio_codec}"
     end
 
     def to_s
@@ -94,7 +89,7 @@ module M3u8
     end
 
     def validate
-      fail MissingCodecError, MISSING_CODEC_MESSAGE if codecs.nil?
+      raise MissingCodecError, MISSING_CODEC_MESSAGE if codecs.nil?
     end
 
     def m3u8_format
@@ -177,18 +172,17 @@ module M3u8
 
     def audio_codec
       return if @audio_codec.nil?
-      return 'mp4a.40.2' if @audio_codec.downcase == 'aac-lc'
-      return 'mp4a.40.5' if @audio_codec.downcase == 'he-aac'
-      return 'mp4a.40.34' if @audio_codec.downcase == 'mp3'
+      return 'mp4a.40.2' if @audio_codec.casecmp('aac-lc').zero?
+      return 'mp4a.40.5' if @audio_codec.casecmp('he-aac').zero?
+      return 'mp4a.40.34' if @audio_codec.casecmp('mp3').zero?
     end
 
     def video_codec(profile, level)
       return if profile.nil? || level.nil?
 
-      profile.downcase!
-      return baseline_codec_string(level) if profile == 'baseline'
-      return main_codec_string(level) if profile == 'main'
-      return high_codec_string(level) if profile == 'high'
+      return baseline_codec_string(level) if profile.casecmp('baseline').zero?
+      return main_codec_string(level) if profile.casecmp('main').zero?
+      return high_codec_string(level) if profile.casecmp('high').zero?
     end
 
     def baseline_codec_string(level)

data/lib/m3u8/reader.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module M3u8
   # Reader provides parsing of m3u8 playlists
   class Reader
@@ -27,17 +28,20 @@ module M3u8
     end
 
     def media_segment_tags
-      { '#EXTINF' => ->(line) { parse_segment(line) },
+      {
+        '#EXTINF' => ->(line) { parse_segment(line) },
         '#EXT-X-DISCONTINUITY' => ->(line) { parse_discontinuity(line) },
         '#EXT-X-BYTERANGE' => ->(line) { parse_byterange(line) },
         '#EXT-X-KEY' => ->(line) { parse_key(line) },
         '#EXT-X-MAP' => ->(line) { parse_map(line) },
-        '#EXT-X-PROGRAM-DATE-TIME' => ->(line) { parse_time(line) }
+        '#EXT-X-PROGRAM-DATE-TIME' => ->(line) { parse_time(line) },
+        '#EXT-X-DATERANGE' => ->(line) { parse_date_range(line) }
       }
     end
 
     def media_playlist_tags
-      { '#EXT-X-MEDIA-SEQUENCE' => ->(line) { parse_sequence(line) },
+      {
+        '#EXT-X-MEDIA-SEQUENCE' => ->(line) { parse_sequence(line) },
         '#EXT-X-ALLOW-CACHE' => ->(line) { parse_cache(line) },
         '#EXT-X-TARGETDURATION' => ->(line) { parse_target(line) },
         '#EXT-X-I-FRAMES-ONLY' => proc { playlist.iframes_only = true },
@@ -46,7 +50,8 @@ module M3u8
     end
 
     def master_playlist_tags
-      { '#EXT-X-MEDIA' => ->(line) { parse_media(line) },
+      {
+        '#EXT-X-MEDIA' => ->(line) { parse_media(line) },
         '#EXT-X-SESSION-DATA' => ->(line) { parse_session_data(line) },
         '#EXT-X-SESSION-KEY' => ->(line) { parse_session_key(line) },
         '#EXT-X-STREAM-INF' => ->(line) { parse_stream(line) },
@@ -55,17 +60,14 @@ module M3u8
     end
 
     def universal_tags
-      { '#EXT-X-START' => ->(line) { parse_start(line) },
+      {
+        '#EXT-X-START' => ->(line) { parse_start(line) },
         '#EXT-X-INDEPENDENT-SEGMENTS' => proc do
           playlist.independent_segments = true
         end
       }
     end
 
-    def parse_independent_segments(line)
-      parse_independent_segments
-    end
-
     def parse_line(line)
       return if match_tag(line)
       parse_next_line(line) if !item.nil? && open
@@ -179,6 +181,12 @@ module M3u8
       end
     end
 
+    def parse_date_range(line)
+      item = M3u8::DateRangeItem.new
+      item.parse(line)
+      playlist.items << item
+    end
+
     def parse_next_line(line)
       value = line.delete("\n").delete("\r")
       if master

data/lib/m3u8/segment_item.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module M3u8
   # SegmentItem represents EXTINF attributes with the URI that follows,
   # optionally allowing an EXT-X-BYTERANGE tag to be set.

data/lib/m3u8/session_data_item.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module M3u8
   # SessionDataItem represents a set of EXT-X-SESSION-DATA attributes
   class SessionDataItem

data/lib/m3u8/session_key_item.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module M3u8
   # KeyItem represents a set of EXT-X-SESSION-KEY attributes
   class SessionKeyItem

data/lib/m3u8/time_item.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module M3u8
   # TimeItem represents EXT-X-PROGRAM-DATE-TIME
   class TimeItem

data/lib/m3u8/version.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
 # M3u8 provides parsing, generation, and validation of m3u8 playlists
 module M3u8
-  VERSION = '0.7.0'
+  VERSION = '0.7.1'
 end

data/lib/m3u8/writer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module M3u8
   # Writer provides generation of text output of playlists in m3u8 format
   class Writer

data/spec/fixtures/date_range_scte35.m3u8

@@ -0,0 +1,16 @@
+#EXTM3U
+#EXT-X-TARGETDURATION:60
+#EXT-X-DATERANGE:ID="splice-6FFFFFF0",START-DATE="2014-03-05T11:
+15:00Z",PLANNED-DURATION=59.993,SCTE35-OUT=0xFC002F0000000000FF0
+00014056FFFFFF000E011622DCAFF000052636200000000000A0008029896F50
+000008700000000
+#EXTINF:20.0,
+http://media.example.com/first.ts
+#EXTINF:20.0,
+http://media.example.com/second.ts
+#EXTINF:20.0,
+http://media.example.com/third.ts
+#EXT-X-DATERANGE:ID="splice-6FFFFFF0",DURATION=59.993,SCTE35-IN=
+0xFC002A0000000000FF00000F056FFFFFF000401162802E6100000000000A00
+08029896F50000008700000000
+#EXT-X-ENDLIST

data/spec/lib/m3u8/byte_range_spec.rb

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

data/spec/lib/m3u8/date_range_item_spec.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+describe M3u8::DateRangeItem do
+  describe '#new' do
+    it 'should assign attributes via option hash' do
+      options = { id: 'test_id', class_name: 'test_class',
+                  start_date: '2014-03-05T11:15:00Z',
+                  end_date: '2014-03-05T11:16:00Z', duration: 60.1,
+                  planned_duration: 59.993,
+                  scte35_out: '0xFC002F0000000000FF0',
+                  scte35_in: '0xFC002F0000000000FF1',
+                  scte35_cmd: '0xFC002F0000000000FF2', end_on_next: true,
+                  client_attributes: { 'X-CUSTOM' => 45.3 } }
+      item = described_class.new(options)
+
+      expect(item.id).to eq('test_id')
+      expect(item.class_name).to eq('test_class')
+      expect(item.start_date).to eq('2014-03-05T11:15:00Z')
+      expect(item.end_date).to eq('2014-03-05T11:16:00Z')
+      expect(item.duration).to eq(60.1)
+      expect(item.planned_duration).to eq(59.993)
+      expect(item.scte35_out).to eq('0xFC002F0000000000FF0')
+      expect(item.scte35_in).to eq('0xFC002F0000000000FF1')
+      expect(item.scte35_cmd).to eq('0xFC002F0000000000FF2')
+      expect(item.end_on_next).to be true
+      expect(item.client_attributes.empty?).to be false
+      expect(item.client_attributes['X-CUSTOM']).to eq(45.3)
+    end
+  end
+
+  describe '#parse' do
+    it 'should parse m3u8 tag into instance' do
+      item = described_class.new
+      line = '#EXT-X-DATERANGE:ID="splice-6FFFFFF0",CLASS="test_class"' \
+      'START-DATE="2014-03-05T11:15:00Z",' \
+      'END-DATE="2014-03-05T11:16:00Z",DURATION=60.1,' \
+      'PLANNED-DURATION=59.993,SCTE35-OUT=0xFC002F0000000000FF0,' \
+      'SCTE35-IN=0xFC002F0000000000FF1,' \
+      'SCTE35-CMD=0xFC002F0000000000FF2,' \
+      'END-ON-NEXT=YES'
+      item.parse(line)
+
+      expect(item.id).to eq('splice-6FFFFFF0')
+      expect(item.class_name).to eq('test_class')
+      expect(item.start_date).to eq('2014-03-05T11:15:00Z')
+      expect(item.end_date).to eq('2014-03-05T11:16:00Z')
+      expect(item.duration).to eq(60.1)
+      expect(item.planned_duration).to eq(59.993)
+      expect(item.scte35_out).to eq('0xFC002F0000000000FF0')
+      expect(item.scte35_in).to eq('0xFC002F0000000000FF1')
+      expect(item.scte35_cmd).to eq('0xFC002F0000000000FF2')
+      expect(item.end_on_next).to be true
+      expect(item.client_attributes.empty?).to be true
+    end
+
+    it 'should ignore optional attributes' do
+      item = described_class.new
+      line = '#EXT-X-DATERANGE:ID="splice-6FFFFFF0",' \
+      'START-DATE="2014-03-05T11:15:00Z"'
+      item.parse(line)
+
+      expect(item.id).to eq('splice-6FFFFFF0')
+      expect(item.class_name).to be_nil
+      expect(item.start_date).to eq('2014-03-05T11:15:00Z')
+      expect(item.end_date).to be_nil
+      expect(item.duration).to be_nil
+      expect(item.planned_duration).to be_nil
+      expect(item.scte35_out).to be_nil
+      expect(item.scte35_in).to be_nil
+      expect(item.scte35_cmd).to be_nil
+      expect(item.end_on_next).to be false
+      expect(item.client_attributes.empty?).to be true
+    end
+
+    it 'should parse client-defined attributes' do
+      item = described_class.new
+      line = '#EXT-X-DATERANGE:ID="splice-6FFFFFF0",' \
+      'START-DATE="2014-03-05T11:15:00Z",' \
+      'X-CUSTOM-VALUE="test_value",'
+      item.parse(line)
+
+      expect(item.client_attributes['X-CUSTOM-VALUE']).to eq('test_value')
+    end
+  end
+
+  describe '#to_s' do
+    it 'should render m3u8 tag' do
+      options = { id: 'test_id', class_name: 'test_class',
+                  start_date: '2014-03-05T11:15:00Z',
+                  end_date: '2014-03-05T11:16:00Z', duration: 60.1,
+                  planned_duration: 59.993,
+                  scte35_out: '0xFC002F0000000000FF0',
+                  scte35_in: '0xFC002F0000000000FF1',
+                  scte35_cmd: '0xFC002F0000000000FF2', end_on_next: true,
+                  client_attributes: { 'X-CUSTOM' => 45.3,
+                                       'X-CUSTOM-TEXT' => 'test_value' } }
+      item = described_class.new(options)
+
+      expected = '#EXT-X-DATERANGE:ID="test_id",CLASS="test_class",' \
+      'START-DATE="2014-03-05T11:15:00Z",' \
+      'END-DATE="2014-03-05T11:16:00Z",DURATION=60.1,' \
+      'PLANNED-DURATION=59.993,' \
+      'X-CUSTOM=45.3,' \
+      'X-CUSTOM-TEXT="test_value",' \
+      'SCTE35-CMD=0xFC002F0000000000FF2,' \
+      'SCTE35-OUT=0xFC002F0000000000FF0,' \
+      'SCTE35-IN=0xFC002F0000000000FF1,' \
+      'END-ON-NEXT=YES'
+
+      expect(item.to_s).to eq(expected)
+    end
+
+    it 'should ignore optional attributes' do
+      options = { id: 'test_id', start_date: '2014-03-05T11:15:00Z' }
+      item = described_class.new(options)
+
+      expected = '#EXT-X-DATERANGE:ID="test_id",' \
+      'START-DATE="2014-03-05T11:15:00Z"'
+
+      expect(item.to_s).to eq(expected)
+    end
+  end
+end