m3u8 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54599784eb3cf885ed988991d50590eb1190b63d
-  data.tar.gz: ca8ce3a4faf778a961fd937057702ecba30a9905
+  metadata.gz: e5c073951f7f46336970cc6f1e16c38e89f4705d
+  data.tar.gz: af7de6933beb9ae49f2a88f4aad6124aafb4c88f
 SHA512:
-  metadata.gz: db42bd190ed77c6595b8ba4f42ccbdb28a8d42a4e0f0f840ab0d5b2b7fb480fb9e99b3415dbc3a172dd29126c08647ebf2e234c8d0d47d4b56afe0f9c6e34590
-  data.tar.gz: 5ac8f0fa3f99a83bf088435be2ff0625bc9d5db5f3159f88f575fe8c5d7a6e4561c671ec999c9359533a1c8c69685ce034c606ceae9c61acbc1a751388ff28b9
+  metadata.gz: f5440e1466f6f24dcf44f39e03ef44034b7aca088a81e5363e3778472b5d1d3c901d8c6cc40a78efdc9ce8c5354a789843d998606d661d3cf9f478798fd639f2
+  data.tar.gz: c02a202da39fd3d5611dcb3a059e56d2f64f0b036622f364fc21d27cfbf55d673fc8fc4c7ab967f4363024de3267b34f1cb916822468ff1e662e78ae8d649237

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+#### 0.5.2 (2/18/2015) - Fix issue where PlaylistItem.average_bandwidth would default to 0 instead of nil when not present in m3u8 being parsed.
+
 #### 0.5.1 (2/16/2015) - [takashisite](https://github.com/takashisite) added support for [EXT-X-DISCONTINUITY](https://tools.ietf.org/html/draft-pantos-http-live-streaming-14#section-4.3.2.3). Added support for [EXT-X-KEY](https://tools.ietf.org/html/draft-pantos-http-live-streaming-14#section-4.3.2.4) (keys for encrypted segments). 
 ***
 #### 0.5.0 (2/10/2015) - BREAKING: renamed PlaylistItem.playlist to PlaylistItem.uri, MediaItem.group to MediaItem.group_id, and PlaylistItem.bitrate to PlaylistItem.bandwidth so attributes more closely match the spec. Added support for EXT-X-I-FRAME-STREAM-INF, EXT-X-I-FRAMES-ONLY, EXT-X-BYTERANGE, and EXT-X-SESSION-DATA.

data/lib/m3u8.rb

@@ -14,7 +14,11 @@ require 'm3u8/error'
 # M3u8 provides parsing, generation, and validation of m3u8 playlists
 module M3u8
   def parse_attributes(line)
-    array = line.scan(/([A-z-]+)\s*=\s*("[^"]*"|[^,]*)/)
+    array = line.gsub("\n", '').scan(/([A-z-]+)\s*=\s*("[^"]*"|[^,]*)/)
     Hash[array.map { |key, value| [key, value.gsub('"', '')] }]
   end
+
+  def parse_yes_no(value)
+    value == 'YES' ? true : false
+  end
 end

data/lib/m3u8/media_item.rb

@@ -1,6 +1,7 @@
 module M3u8
   # MediaItem represents a set of EXT-X-MEDIA attributes
   class MediaItem
+    include M3u8
     attr_accessor :type, :group_id, :language, :assoc_language, :name,
                   :autoselect, :default, :uri, :forced
 
@@ -10,6 +11,19 @@ module M3u8
       end
     end
 
+    def parse(text)
+      attributes = parse_attributes text
+      options = { type: attributes['TYPE'], group_id: attributes['GROUP-ID'],
+                  language: attributes['LANGUAGE'],
+                  assoc_language: attributes['ASSOC-LANGUAGE'],
+                  name: attributes['NAME'],
+                  autoselect: parse_yes_no(attributes['AUTOSELECT']),
+                  default: parse_yes_no(attributes['DEFAULT']),
+                  forced: parse_yes_no(attributes['FORCED']),
+                  uri: attributes['URI'] }
+      initialize options
+    end
+
     def to_s
       attributes = [type_format,
                     group_id_format,

data/lib/m3u8/playlist_item.rb

@@ -2,6 +2,7 @@ module M3u8
   # PlaylistItem represents a set of EXT-X-STREAM-INF or
   # EXT-X-I-FRAME-STREAM-INF attributes
   class PlaylistItem
+    include M3u8
     attr_accessor :program_id, :width, :height, :codecs, :bandwidth,
                   :audio_codec, :level, :profile, :video, :audio, :uri,
                   :average_bandwidth, :subtitles, :closed_captions, :iframe
@@ -14,6 +15,20 @@ module M3u8
       end
     end
 
+    def parse(text)
+      attributes = parse_attributes text
+      average = parse_average_bandwidth attributes['AVERAGE-BANDWIDTH']
+      options = { program_id: attributes['PROGRAM-ID'],
+                  codecs: attributes['CODECS'],
+                  bandwidth: attributes['BANDWIDTH'].to_i,
+                  average_bandwidth: average,
+                  video: attributes['VIDEO'], audio: attributes['AUDIO'],
+                  uri: attributes['URI'], subtitles: attributes['SUBTITLES'],
+                  closed_captions: attributes['CLOSED-CAPTIONS'] }
+      initialize options
+      parse_resolution attributes['RESOLUTION']
+    end
+
     def resolution
       return if width.nil?
       "#{width}x#{height}"
@@ -43,6 +58,16 @@ module M3u8
 
     private
 
+    def parse_average_bandwidth(value)
+      value.to_i unless value.nil?
+    end
+
+    def parse_resolution(resolution)
+      return if resolution.nil?
+      self.width = resolution.split('x')[0].to_i
+      self.height = resolution.split('x')[1].to_i
+    end
+
     def validate
       fail MissingCodecError, MISSING_CODEC_MESSAGE if codecs.nil?
     end

data/lib/m3u8/reader.rb

@@ -1,28 +1,15 @@
 module M3u8
   # Reader provides parsing of m3u8 playlists
   class Reader
-    attr_accessor :playlist, :item, :open, :master
-    PLAYLIST_START = '#EXTM3U'
-    PLAYLIST_TYPE_START = '#EXT-X-PLAYLIST-TYPE:'
-    VERSION_START = '#EXT-X-VERSION:'
-    SEQUENCE_START = '#EXT-X-MEDIA-SEQUENCE:'
-    CACHE_START = '#EXT-X-ALLOW-CACHE:'
-    TARGET_START = '#EXT-X-TARGETDURATION:'
-    IFRAME_START = '#EXT-X-I-FRAMES-ONLY'
-    STREAM_START = '#EXT-X-STREAM-INF:'
-    STREAM_IFRAME_START = '#EXT-X-I-FRAME-STREAM-INF:'
-    MEDIA_START = '#EXT-X-MEDIA:'
-    SESSION_DATA_START = '#EXT-X-SESSION-DATA:'
-    KEY_START = '#EXT-X-KEY:'
-    SEGMENT_START = '#EXTINF:'
-    SEGMENT_DISCONTINUITY_TAG_START = '#EXT-X-DISCONTINUITY'
-    BYTERANGE_START = '#EXT-X-BYTERANGE:'
-    RESOLUTION = 'RESOLUTION'
-    BANDWIDTH = 'BANDWIDTH'
-    AVERAGE_BANDWIDTH = 'AVERAGE-BANDWIDTH'
-    AUTOSELECT = 'AUTOSELECT'
-    DEFAULT = 'DEFAULT'
-    FORCED = 'FORCED'
+    include M3u8
+    attr_accessor :playlist, :item, :open, :master, :tags
+
+    def initialize(*)
+      @tags = [basic_tags,
+               media_segment_tags,
+               media_playlist_tags,
+               master_playlist_tags].inject(:merge)
+    end
 
     def read(input)
       self.playlist = Playlist.new
@@ -34,79 +21,64 @@ module M3u8
 
     private
 
-    def parse_line(line)
-      return if line.start_with? PLAYLIST_START
-      return if parse_master_playlist_tags line
-      return if parse_segment_tags line
-      return if parse_header_tags line
-      parse_next_line line if !item.nil? && open
+    def basic_tags
+      { '#EXT-X-VERSION' => proc { |line| parse_version line } }
     end
 
-    def parse_header_tags(line)
-      if line.start_with? PLAYLIST_TYPE_START
-        parse_playlist_type line
-      elsif line.start_with? VERSION_START
-        parse_version line
-      elsif line.start_with? SEQUENCE_START
-        parse_sequence line
-      elsif line.start_with? CACHE_START
-        parse_cache line
-      elsif line.start_with? TARGET_START
-        parse_target line
-      elsif line.start_with? IFRAME_START
-        playlist.iframes_only = true
-      else
-        return false
-      end
+    def media_segment_tags
+      { '#EXTINF' => proc { |line| parse_segment line },
+        '#EXT-X-DISCONTINUITY' => proc { |line| parse_discontinuity line },
+        '#EXT-X-BYTERANGE' => proc { |line| parse_byterange line },
+        '#EXT-X-KEY' => proc { |line| parse_key line }
+      }
     end
 
-    def parse_master_playlist_tags(line)
-      if line.start_with? STREAM_START
-        parse_stream line
-      elsif line.start_with? STREAM_IFRAME_START
-        parse_iframe_stream line
-      elsif line.start_with? MEDIA_START
-        parse_media line
-      elsif line.start_with? SEGMENT_DISCONTINUITY_TAG_START
-        parse_segment_discontinuity_tag line
-      elsif line.start_with? SESSION_DATA_START
-        parse_session_data line
-      else
-        return false
-      end
+    def media_playlist_tags
+      { '#EXT-X-MEDIA-SEQUENCE' => proc { |line| parse_sequence line },
+        '#EXT-X-ALLOW-CACHE' => proc { |line| parse_cache line },
+        '#EXT-X-TARGETDURATION' => proc { |line| parse_target line },
+        '#EXT-X-I-FRAMES-ONLY' => proc { playlist.iframes_only = true },
+        '#EXT-X-PLAYLIST-TYPE' => proc { |line| parse_playlist_type line }
+      }
     end
 
-    def parse_segment_tags(line)
-      if line.start_with? KEY_START
-        parse_key line
-      elsif line.start_with? SEGMENT_START
-        parse_segment line
-      elsif line.start_with? BYTERANGE_START
-        parse_byterange line
-      else
-        return false
-      end
+    def master_playlist_tags
+      { '#EXT-X-MEDIA' => proc { |line| parse_media line },
+        '#EXT-X-SESSION-DATA' => proc { |line| parse_session_data line },
+        '#EXT-X-STREAM-INF' => proc { |line| parse_stream line },
+        '#EXT-X-I-FRAME-STREAM-INF' => proc { |line| parse_iframe_stream line }
+      }
+    end
+
+    def parse_line(line)
+      return if match_tag(line)
+      parse_next_line line if !item.nil? && open
+    end
+
+    def match_tag(line)
+      tag = @tags.select { |key| line.start_with? key }
+      tag.values.first.call line unless tag.empty?
     end
 
     def parse_playlist_type(line)
-      playlist.type = line.gsub(PLAYLIST_TYPE_START, '').delete!("\n")
+      playlist.type = line.gsub('#EXT-X-PLAYLIST-TYPE:', '').delete!("\n")
     end
 
     def parse_version(line)
-      playlist.version = line.gsub(VERSION_START, '').to_i
+      playlist.version = line.gsub('#EXT-X-VERSION:', '').to_i
     end
 
     def parse_sequence(line)
-      playlist.sequence = line.gsub(SEQUENCE_START, '').to_i
+      playlist.sequence = line.gsub('#EXT-X-MEDIA-SEQUENCE:', '').to_i
     end
 
     def parse_cache(line)
-      line = line.gsub(CACHE_START, '')
+      line = line.gsub('#EXT-X-ALLOW-CACHE:', '')
       playlist.cache = parse_yes_no(line)
     end
 
     def parse_target(line)
-      playlist.target = line.gsub(TARGET_START, '').to_i
+      playlist.target = line.gsub('#EXT-X-TARGETDURATION:', '').to_i
     end
 
     def parse_stream(line)
@@ -114,9 +86,7 @@ module M3u8
       self.open = true
 
       self.item = M3u8::PlaylistItem.new
-      line = line.gsub STREAM_START, ''
-      attributes = parse_attributes line
-      parse_stream_attributes attributes
+      item.parse line
     end
 
     def parse_iframe_stream(line)
@@ -124,31 +94,12 @@ module M3u8
       self.open = false
 
       self.item = M3u8::PlaylistItem.new
+      item.parse line
       item.iframe = true
-      line = line.gsub STREAM_IFRAME_START, ''
-      attributes = parse_attributes line
-      parse_stream_attributes attributes
       playlist.items.push item
     end
 
-    def parse_stream_attributes(attributes)
-      attributes.each do |pair|
-        name = pair[0]
-        value = parse_value pair[1]
-        case name
-        when RESOLUTION
-          parse_resolution value
-        when BANDWIDTH
-          item.bandwidth = value.to_i
-        when AVERAGE_BANDWIDTH
-          item.average_bandwidth = value.to_i
-        else
-          set_value name, value
-        end
-      end
-    end
-
-    def parse_segment_discontinuity_tag(*)
+    def parse_discontinuity(*)
       self.master = false
       self.open = false
 
@@ -156,11 +107,6 @@ module M3u8
       playlist.items.push item
     end
 
-    def parse_resolution(resolution)
-      item.width = resolution.split('x')[0].to_i
-      item.height = resolution.split('x')[1].to_i
-    end
-
     def parse_key(line)
       item = M3u8::KeyItem.parse line
       playlist.items.push item
@@ -168,7 +114,7 @@ module M3u8
 
     def parse_segment(line)
       self.item = M3u8::SegmentItem.new
-      values = line.gsub(SEGMENT_START, '').gsub("\n", ',').split(',')
+      values = line.gsub('#EXTINF:', '').gsub("\n", ',').split(',')
       item.duration = values[0].to_f
       item.comment = values[1] unless values[1].nil?
 
@@ -177,7 +123,7 @@ module M3u8
     end
 
     def parse_byterange(line)
-      values = line.gsub(BYTERANGE_START, '').gsub("\n", ',').split '@'
+      values = line.gsub('#EXT-X-BYTERANGE:', '').gsub("\n", ',').split '@'
       item.byterange_length = values[0].to_i
       item.byterange_start = values[1].to_i unless values[1].nil?
     end
@@ -190,29 +136,10 @@ module M3u8
     def parse_media(line)
       self.open = false
       self.item = M3u8::MediaItem.new
-      line = line.gsub MEDIA_START, ''
-      attributes = parse_attributes line
-      parse_media_attributes attributes
+      item.parse line
       playlist.items.push item
     end
 
-    def parse_media_attributes(attributes)
-      attributes.each do |pair|
-        name = pair[0]
-        value = parse_value pair[1]
-        case name
-        when AUTOSELECT
-          item.autoselect = parse_yes_no value
-        when DEFAULT
-          item.default = parse_yes_no value
-        when FORCED
-          item.forced = parse_yes_no value
-        else
-          set_value name, value
-        end
-      end
-    end
-
     def parse_next_line(line)
       value = line.gsub "\n", ''
       if master
@@ -223,22 +150,5 @@ module M3u8
       playlist.items.push item
       self.open = false
     end
-
-    def parse_yes_no(string)
-      string == 'YES' ? true : false
-    end
-
-    def parse_attributes(line)
-      line.scan(/([A-z-]+)\s*=\s*("[^"]*"|[^,]*)/)
-    end
-
-    def parse_value(value)
-      value.gsub("\n", '').gsub('"', '')
-    end
-
-    def set_value(name, value)
-      name = name.downcase.gsub('-', '_')
-      item.instance_variable_set("@#{name}", value)
-    end
   end
 end

data/lib/m3u8/version.rb

@@ -1,4 +1,4 @@
 # M3u8 provides parsing, generation, and validation of m3u8 playlists
 module M3u8
-  VERSION = '0.5.1'
+  VERSION = '0.5.2'
 end

data/spec/m3u8_spec.rb

@@ -4,10 +4,17 @@ describe do
   let(:test_class) { Class.new { extend M3u8 } }
 
   it 'should parse attributes to hash' do
-    line = %(TEST-ID="Help",URI="http://test",ID=33)
+    line = %(TEST-ID="Help",URI="http://test",ID=33\n)
     hash = test_class.parse_attributes line
     expect(hash['TEST-ID']).to eq 'Help'
     expect(hash['URI']).to eq 'http://test'
     expect(hash['ID']).to eq '33'
   end
+
+  it 'should parse yes/no string' do
+    value = 'YES'
+    expect(test_class.parse_yes_no value).to be true
+    value = 'NO'
+    expect(test_class.parse_yes_no value).to be false
+  end
 end

data/spec/media_item_spec.rb

@@ -22,4 +22,22 @@ describe M3u8::MediaItem do
                'DEFAULT=NO,URI="frelo/prog_index.m3u8",FORCED=YES'
     expect(output).to eq expected
   end
+
+  it 'should parse m3u8 text into instance' do
+    format = '#EXT-X-MEDIA:TYPE=AUDIO,GROUP-ID="audio-lo",LANGUAGE="fre",' \
+             'ASSOC-LANGUAGE="spoken",NAME="Francais",AUTOSELECT=YES,' +
+             %("DEFAULT=NO,URI="frelo/prog_index.m3u8",FORCED=YES\n")
+    item = M3u8::MediaItem.new
+    item.parse format
+
+    expect(item.type).to eq 'AUDIO'
+    expect(item.group_id).to eq 'audio-lo'
+    expect(item.language).to eq 'fre'
+    expect(item.assoc_language).to eq 'spoken'
+    expect(item.name).to eq 'Francais'
+    expect(item.autoselect).to be true
+    expect(item.default).to be false
+    expect(item.uri).to eq 'frelo/prog_index.m3u8'
+    expect(item.forced).to be true
+  end
 end

data/spec/playlist_item_spec.rb

@@ -15,6 +15,43 @@ describe M3u8::PlaylistItem do
     expect(item.iframe).to be false
   end
 
+  it 'should parse m3u8 text into instance' do
+    format = %(#EXT-X-STREAM-INF:CODECS="avc",BANDWIDTH=540,) +
+             %(PROGRAM-ID=1,RESOLUTION=1920x1080,) +
+             %(AVERAGE-BANDWIDTH=550,AUDIO="test",VIDEO="test2",) +
+             %(SUBTITLES="subs",CLOSED-CAPTIONS="caps",URI="test.url")
+    item = M3u8::PlaylistItem.new
+    item.parse(format)
+    expect(item.program_id).to eq '1'
+    expect(item.codecs).to eq 'avc'
+    expect(item.bandwidth).to eq 540
+    expect(item.average_bandwidth).to eq 550
+    expect(item.width).to eq 1920
+    expect(item.height).to eq 1080
+    expect(item.audio).to eq 'test'
+    expect(item.video).to eq 'test2'
+    expect(item.subtitles).to eq 'subs'
+    expect(item.closed_captions).to eq 'caps'
+    expect(item.uri).to eq 'test.url'
+
+    format = %(#EXT-X-STREAM-INF:CODECS="avc",BANDWIDTH=540,) +
+             %(PROGRAM-ID=1,AUDIO="test",VIDEO="test2",) +
+             %(SUBTITLES="subs",CLOSED-CAPTIONS="caps",URI="test.url")
+    item = M3u8::PlaylistItem.new
+    item.parse(format)
+    expect(item.program_id).to eq '1'
+    expect(item.codecs).to eq 'avc'
+    expect(item.bandwidth).to eq 540
+    expect(item.average_bandwidth).to be_nil
+    expect(item.width).to be_nil
+    expect(item.height).to be_nil
+    expect(item.audio).to eq 'test'
+    expect(item.video).to eq 'test2'
+    expect(item.subtitles).to eq 'subs'
+    expect(item.closed_captions).to eq 'caps'
+    expect(item.uri).to eq 'test.url'
+  end
+
   it 'should provide m3u8 format representation' do
     hash = { program_id: 1, width: 1920, height: 1080, codecs: 'avc',
              bandwidth: 540, uri: 'test.url' }

data/spec/reader_spec.rb

@@ -17,6 +17,7 @@ describe M3u8::Reader do
     expect(item.codecs).to eq('avc1.640028,mp4a.40.2')
     expect(item.bandwidth).to eq(5_042_000)
     expect(item.iframe).to be false
+    expect(item.average_bandwidth).to be_nil
 
     expect(playlist.items.size).to eq 6
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: m3u8
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Seth Deckard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-16 00:00:00.000000000 Z
+date: 2015-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler