m3u8 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 862441ecee4bbc8fe057efdefe16649ba31b6276
-  data.tar.gz: 2f9995c6089dcb771fc6a6781936952b4ad03200
+  metadata.gz: afc4ec1f4627283241fc7e4f5eeb33d3ee69b17b
+  data.tar.gz: 4e04ba6b95728b5d5aa0c448e27d12331c37e5c5
 SHA512:
-  metadata.gz: 94a2443f80f7f7f8d780bdd2d0fbc7ef2b8fe22c79e4753a292e1e48dfa740fd02817774408658adf2545fb82aecd93d56be156a1b0affe18d302376f2ff5394
-  data.tar.gz: 278b7d96d867e107d693874a35ee101c10b51800379b261e6d7b7c7728c55fec0b8a37e08af6080a01bd9e303c35edfbaff496d85c0eb1b6f0c1b473368b0bbe
+  metadata.gz: d360dd63410659e7e98b8d001886ae76ef925a8118c6850b7876cd6bbd1a88fc7917565cb407846b3e498aab15f510a3e5c921e36b46d76daa52059ff5c26266
+  data.tar.gz: 02dc01399f31cf0111c20123c06c86316ff1c54bb76238e8cbc884af44d2de5d974dda25a81287b19c44872ed12d088c661c462983762d06d361b357ffa4ca30

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+### 0.2.1 (11/26/2014) - Moved codec generation / validation to PlaylistItem, allowing for the flexibility to either specify :audio, :level, :profile when creating new instances (codecs value will be automatically generated) or just set the codecs attribute directly.
+
+### 0.2.0 (11/25/2014) - Added ability to parse m3u8 playlists with new Reader class. Introduced two new classes to represent the items that make up a Playlist: PlaylistItem and SegmentItem.
+
+### 0.1.3 (11/23/2014) - Fixed bug in codec string generation.
+
+### 0.1.0 (10/06/2014) - Initial release, provides ability to generate m3u8 playlists (master and segments).

data/README.md

@@ -31,24 +31,32 @@ Or install it yourself as:
 	
 	#create a master playlist and add child playlists for adaptive bitrate streaming:
 	playlist = M3u8::Playlist.new
-	options = { :width => 1920, :height => 1080, :profile => 'high', :level => 4.1, :audio => 'aac-lc'}
-    playlist.add_playlist '2', 'http://playlist_url_or_path_file', 50000, options
+    #create a new playlist item with options
+    options = { program_id: 1, width: 1920, height: 1080, width: 1920, height: 1080, 
+                profile: 'high', level: 4.1, audio: 'aac-lc', bitrate: 540, 
+                playlist: 'test.url' }
+    item = M3u8::PlaylistItem.new options
+    playlist.items.push item
+
+    #alternatively you can set codecs rather than having it generated automatically:
+    options = { program_id: 1, width: 1920, height: 1080, width: 1920, height: 1080, 
+                codecs: 'avc1.66.30,mp4a.40.2', bitrate: 540, playlist: 'test.url' }
+    item = M3u8::PlaylistItem.new options
     
-    #create a standard playlist and add TS segments:
+    #create a standard playlist and add MPEG-TS segments:
     playlist = M3u8::Playlist.new
-    playlist.add_segment 11.344644, "1080-7mbps00000.ts"
-    
-    #you can also add PlaylistItem or SegmentItem instances directly to the array of items in the playlist (new in v.2.0):
-    item = SegmentItem.new(duration: 11, segment: 'test.ts')
+    #create a new segment item with options
+    item = M3u8::SegmentItem.new duration: 11, segment: 'test.ts'
     playlist.items.push item
     
     #just get the codec string for custom use
-    options = { :profile => 'baseline', :level => 3.0, :audio => 'aac-lc' }
+    options = { profile: 'baseline', level: 3.0, audio: 'aac-lc' }
     codecs = M3u8::Playlist.codecs options
-     => "avc1.66.30,mp4a.40.2"
+    # => "avc1.66.30,mp4a.40.2"
 	
-	#specify options for playlist, these are ignored if playlist becomes a master playlist (child playlist added):
-	options = { :version => 1, :cache => false, :target => 12, :sequence => 1}
+	#specify options for playlist, these are ignored if playlist becomes a master playlist
+    # (child playlist added):
+	options = { version: 1, cache: false, target: 12, sequence: 1 }
     playlist = M3u8::Playlist.new options
     
     #You can pass an IO object to the write method
@@ -76,13 +84,23 @@ Or install it yourself as:
     reader = M3u8::Reader.new
     playlist = reader.read file
     playlist.master?
-     => true
+    # => true
 
     #acess items in playlist:
     playlist.items
 
     playlist.items.first
-      => #<M3u8::PlaylistItem:0x007fa569bc7698 @program_id="1", @resolution="1920x1080", @codecs="avc1.640028,mp4a.40.2", @bandwidth="5042000", @playlist="hls/1080-7mbps/1080-7mbps.m3u8">
+    #  => #<M3u8::PlaylistItem:0x007fa569bc7698 @program_id="1", @resolution="1920x1080", 
+    #  @codecs="avc1.640028,mp4a.40.2", @bandwidth="5042000", 
+    #  @playlist="hls/1080-7mbps/1080-7mbps.m3u8">
+
+    #create a new playlist item with options
+    options = { program_id: 1, width: 1920, height: 1080, width: 1920, height: 1080, 
+                profile: 'high', level: 4.1, audio: 'aac-lc', bitrate: 540, 
+                playlist: 'test.url' }
+    item = M3u8::PlaylistItem.new options
+    #add it to the top of the playlist
+    playlist.items.insert 0, item
 	
 ## Features
 * Distinction between segment and master playlists is handled automatically (no need to use a different class).

data/lib/m3u8/playlist.rb

@@ -1,7 +1,6 @@
 module M3u8
   class Playlist
     attr_accessor :items, :version, :cache, :target, :sequence
-    MISSING_CODEC_MESSAGE = 'An audio or video codec should be provided.'
     NON_MASTER_ERROR_MESSAGE = 'Playlist is not a master playlist, playlist' \
       ' can not be added.'
     MASTER_ERROR_MESSAGE = 'Playlist is a master playlist, segment can not ' \
@@ -13,43 +12,18 @@ module M3u8
       self.items = []
     end
 
-    def assign_options(options)
-      options = {
-        version: 3,
-        sequence: 0,
-        cache: true,
-        target: 10
-      }.merge options
-
-      self.version = options[:version]
-      self.sequence = options[:sequence]
-      self.cache = options[:cache]
-      self.target = options[:target]
-    end
-
     def self.codecs(options = {})
-      playlist = Playlist.new
-      playlist.codecs options
+      item = PlaylistItem.new options
+      item.codecs
     end
 
     def add_playlist(program_id, playlist, bitrate, options = {})
-      options = {
-        width: nil,
-        height: nil,
-        profile: nil,
-        level: nil,
-        audio: nil
-      }.merge options
-
       validate_playlist_type true
 
-      codecs = codecs(audio: options[:audio], profile: options[:profile],
-                      level: options[:level])
-      fail MissingCodecError, MISSING_CODEC_MESSAGE if codecs.nil?
-
       params = { program_id: program_id, playlist: playlist, bitrate: bitrate,
                  width: options[:width], height: options[:height],
-                 codecs: codecs }
+                 audio: options[:audio], profile: options[:profile],
+                 level: options[:level] }
       item = PlaylistItem.new params
       items.push item
     end
@@ -62,27 +36,6 @@ module M3u8
       items.push item
     end
 
-    def codecs(options = {})
-      options = {
-        audio: nil,
-        profile: nil,
-        level: nil
-      }.merge options
-
-      audio_codec = audio_codec options[:audio]
-      video_codec = video_codec options[:profile], options[:level]
-
-      if video_codec.nil?
-        return audio_codec
-      else
-        if audio_codec.nil?
-          return video_codec
-        else
-          return "#{video_codec},#{audio_codec}"
-        end
-      end
-    end
-
     def write(output)
       validate
 
@@ -115,6 +68,20 @@ module M3u8
 
     private
 
+    def assign_options(options)
+      options = {
+        version: 3,
+        sequence: 0,
+        cache: true,
+        target: 10
+      }.merge options
+
+      self.version = options[:version]
+      self.sequence = options[:sequence]
+      self.cache = options[:cache]
+      self.target = options[:target]
+    end
+
     def validate
       return if valid?
       fail PlaylistTypeError, MIXED_TYPE_ERROR_MESSAGE
@@ -147,26 +114,5 @@ module M3u8
     def cache_string
       cache ? 'YES' : 'NO'
     end
-
-    def audio_codec(audio)
-      return if audio.nil?
-      return 'mp4a.40.2' if audio.downcase == 'aac-lc'
-      return 'mp4a.40.5' if audio.downcase == 'he-aac'
-      return 'mp4a.40.34' if audio.downcase == 'mp3'
-    end
-
-    def video_codec(profile, level)
-      return if profile.nil? || level.nil?
-
-      profile = profile.downcase
-      return 'avc1.66.30' if profile == 'baseline' && level == 3.0
-      return 'avc1.42001f' if profile == 'baseline' && level == 3.1
-      return 'avc1.77.30' if profile == 'main' && level == 3.0
-      return 'avc1.4d001f' if profile == 'main' && level == 3.1
-      return 'avc1.4d0028' if profile == 'main' && level == 4.0
-      return 'avc1.64001f' if profile == 'high' && level == 3.1
-      return 'avc1.640028' if profile == 'high' &&
-                              (level == 4.0 || level == 4.1)
-    end
   end
 end

data/lib/m3u8/playlist_item.rb

@@ -1,6 +1,8 @@
 module M3u8
   class PlaylistItem
-    attr_accessor :program_id, :width, :height, :codecs, :bitrate, :playlist
+    attr_accessor :program_id, :width, :height, :codecs, :bitrate, :playlist,
+                  :audio, :level, :profile
+    MISSING_CODEC_MESSAGE = 'Audio or video codec info should be provided.'
 
     def initialize(params = {})
       params.each do |key, value|
@@ -13,16 +15,59 @@ module M3u8
       "#{width}x#{height}"
     end
 
+    def codecs
+      return @codecs unless @codecs.nil?
+
+      audio_codec = audio_codec audio
+      video_codec = video_codec profile, level
+
+      if video_codec.nil?
+        return audio_codec
+      else
+        if audio_codec.nil?
+          return video_codec
+        else
+          return "#{video_codec},#{audio_codec}"
+        end
+      end
+    end
+
     def to_s
+      validate
       "#EXT-X-STREAM-INF:PROGRAM-ID=#{program_id},#{resolution_format}" +
         %(CODECS="#{codecs}",BANDWIDTH=#{bitrate}\n#{playlist})
     end
 
     private
 
+    def validate
+      fail MissingCodecError, MISSING_CODEC_MESSAGE if codecs.nil?
+    end
+
     def resolution_format
       return if resolution.nil?
       "RESOLUTION=#{resolution},"
     end
+
+    def audio_codec(audio)
+      return if audio.nil?
+      return 'mp4a.40.2' if audio.downcase == 'aac-lc'
+      return 'mp4a.40.5' if audio.downcase == 'he-aac'
+      return 'mp4a.40.34' if audio.downcase == 'mp3'
+    end
+
+    def video_codec(profile, level)
+      return if profile.nil? || level.nil?
+
+      profile = profile.downcase
+      return 'avc1.66.30' if profile == 'baseline' && level == 3.0
+      return 'avc1.42001f' if profile == 'baseline' && level == 3.1
+      return 'avc1.77.30' if profile == 'main' && level == 3.0
+      return 'avc1.4d001f' if profile == 'main' && level == 3.1
+      return 'avc1.4d0028' if profile == 'main' && level == 4.0
+      return 'avc1.64001f' if profile == 'high' && level == 3.1
+      return 'avc1.640028' if profile == 'high' &&
+                              (level == 4.0 || level == 4.1)
+    end
   end
 end

data/lib/m3u8/version.rb

@@ -1,3 +1,3 @@
 module M3u8
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/spec/playlist_item_spec.rb

@@ -30,4 +30,88 @@ describe M3u8::PlaylistItem do
                %(CODECS="avc",BANDWIDTH=540\ntest.url)
     expect(output).to eq expected
   end
+
+  it 'should generate codecs string' do
+    item = M3u8::PlaylistItem.new
+    expect(item.codecs).to be_nil
+
+    item = M3u8::PlaylistItem.new codecs: 'test'
+    expect(item.codecs).to eq 'test'
+
+    item = M3u8::PlaylistItem.new audio: 'aac-lc'
+    expect(item.codecs).to eq 'mp4a.40.2'
+
+    item = M3u8::PlaylistItem.new audio: 'AAC-LC'
+    expect(item.codecs).to eq 'mp4a.40.2'
+
+    item = M3u8::PlaylistItem.new audio: 'he-aac'
+    expect(item.codecs).to eq 'mp4a.40.5'
+
+    item = M3u8::PlaylistItem.new audio: 'HE-AAC'
+    expect(item.codecs).to eq 'mp4a.40.5'
+
+    item = M3u8::PlaylistItem.new audio: 'he-acc1'
+    expect(item.codecs).to be_nil
+
+    item = M3u8::PlaylistItem.new audio: 'mp3'
+    expect(item.codecs).to eq 'mp4a.40.34'
+
+    item = M3u8::PlaylistItem.new audio: 'MP3'
+    expect(item.codecs).to eq 'mp4a.40.34'
+
+    options = { profile: 'baseline', level: 3.0 }
+    item = M3u8::PlaylistItem.new options
+    expect(item.codecs).to eq 'avc1.66.30'
+
+    options = { profile: 'baseline', level: 3.0, audio: 'aac-lc' }
+    item = M3u8::PlaylistItem.new options
+    expect(item.codecs).to eq 'avc1.66.30,mp4a.40.2'
+
+    options = { profile: 'baseline', level: 3.0, audio: 'mp3' }
+    item = M3u8::PlaylistItem.new options
+    expect(item.codecs).to eq 'avc1.66.30,mp4a.40.34'
+
+    options = { profile: 'baseline', level: 3.1 }
+    item = M3u8::PlaylistItem.new options
+    expect(item.codecs).to eq 'avc1.42001f'
+
+    options = { profile: 'baseline', level: 3.1, audio: 'he-aac' }
+    item = M3u8::PlaylistItem.new options
+    expect(item.codecs).to eq 'avc1.42001f,mp4a.40.5'
+
+    options = { profile: 'main', level: 3.0 }
+    item = M3u8::PlaylistItem.new options
+    expect(item.codecs).to eq 'avc1.77.30'
+
+    options = { profile: 'main', level: 3.0, audio: 'aac-lc' }
+    item = M3u8::PlaylistItem.new options
+    expect(item.codecs).to eq 'avc1.77.30,mp4a.40.2'
+
+    options = { profile: 'main', level: 3.1 }
+    item = M3u8::PlaylistItem.new options
+    expect(item.codecs).to eq 'avc1.4d001f'
+
+    options = { profile: 'main', level: 4.0 }
+    item = M3u8::PlaylistItem.new options
+    expect(item.codecs).to eq 'avc1.4d0028'
+
+    options = { profile: 'high', level: 3.1 }
+    item = M3u8::PlaylistItem.new options
+    expect(item.codecs).to eq 'avc1.64001f'
+
+    options = { profile: 'high', level: 4.0 }
+    item = M3u8::PlaylistItem.new options
+    expect(item.codecs).to eq 'avc1.640028'
+
+    options = { profile: 'high', level: 4.1 }
+    item = M3u8::PlaylistItem.new options
+    expect(item.codecs).to eq 'avc1.640028'
+  end
+
+  it 'should raise error if codecs are missing' do
+    params = { program_id: 1, bitrate: 540, playlist: 'test.url' }
+    item = M3u8::PlaylistItem.new params
+    message = 'Audio or video codec info should be provided.'
+    expect { item.to_s }.to raise_error(M3u8::MissingCodecError, message)
+  end
 end

data/spec/playlist_spec.rb

@@ -2,77 +2,9 @@ require 'spec_helper'
 
 describe M3u8::Playlist do
   it 'should generate codecs string' do
-    codecs = M3u8::Playlist.codecs
-    expect(codecs).to be_nil
-
-    codecs = M3u8::Playlist.codecs audio: 'aac-lc'
-    expect(codecs).to eq 'mp4a.40.2'
-
-    codecs = M3u8::Playlist.codecs audio: 'AAC-LC'
-    expect(codecs).to eq 'mp4a.40.2'
-
-    codecs = M3u8::Playlist.codecs audio: 'he-aac'
-    expect(codecs).to eq 'mp4a.40.5'
-
-    codecs = M3u8::Playlist.codecs audio: 'HE-AAC'
-    expect(codecs).to eq 'mp4a.40.5'
-
-    codecs = M3u8::Playlist.codecs audio: 'he-acc1'
-    expect(codecs).to be_nil
-
-    codecs = M3u8::Playlist.codecs audio: 'mp3'
-    expect(codecs).to eq 'mp4a.40.34'
-
-    codecs = M3u8::Playlist.codecs audio: 'MP3'
-    expect(codecs).to eq 'mp4a.40.34'
-
-    options = { profile: 'baseline', level: 3.0 }
-    codecs = M3u8::Playlist.codecs options
-    expect(codecs).to eq 'avc1.66.30'
-
     options = { profile: 'baseline', level: 3.0, audio: 'aac-lc' }
     codecs = M3u8::Playlist.codecs options
     expect(codecs).to eq 'avc1.66.30,mp4a.40.2'
-
-    options = { profile: 'baseline', level: 3.0, audio: 'mp3' }
-    codecs = M3u8::Playlist.codecs options
-    expect(codecs).to eq 'avc1.66.30,mp4a.40.34'
-
-    options = { profile: 'baseline', level: 3.1 }
-    codecs = M3u8::Playlist.codecs options
-    expect(codecs).to eq 'avc1.42001f'
-
-    options = { profile: 'baseline', level: 3.1, audio: 'he-aac' }
-    codecs = M3u8::Playlist.codecs options
-    expect(codecs).to eq 'avc1.42001f,mp4a.40.5'
-
-    options = { profile: 'main', level: 3.0 }
-    codecs = M3u8::Playlist.codecs options
-    expect(codecs).to eq 'avc1.77.30'
-
-    options = { profile: 'main', level: 3.0, audio: 'aac-lc' }
-    codecs = M3u8::Playlist.codecs options
-    expect(codecs).to eq 'avc1.77.30,mp4a.40.2'
-
-    options = { profile: 'main', level: 3.1 }
-    codecs = M3u8::Playlist.codecs options
-    expect(codecs).to eq 'avc1.4d001f'
-
-    options = { profile: 'main', level: 4.0 }
-    codecs = M3u8::Playlist.codecs options
-    expect(codecs).to eq 'avc1.4d0028'
-
-    options = { profile: 'high', level: 3.1 }
-    codecs = M3u8::Playlist.codecs options
-    expect(codecs).to eq 'avc1.64001f'
-
-    options = { profile: 'high', level: 4.0 }
-    codecs = M3u8::Playlist.codecs options
-    expect(codecs).to eq 'avc1.640028'
-
-    options = { profile: 'high', level: 4.1 }
-    codecs = M3u8::Playlist.codecs options
-    expect(codecs).to eq 'avc1.640028'
   end
 
   it 'should render master playlist' do
@@ -244,13 +176,6 @@ describe M3u8::Playlist do
     expect(playlist.valid?).to be false
   end
 
-  it 'should raise error if codecs are missing' do
-    playlist = M3u8::Playlist.new
-    message = 'An audio or video codec should be provided.'
-    expect { playlist.add_playlist '1', 'playlist_url', 6400 }
-      .to raise_error(M3u8::MissingCodecError, message)
-  end
-
   it 'should expose options as attributes' do
     options = { version: 1, cache: false, target: 12, sequence: 1 }
     playlist = M3u8::Playlist.new options

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: m3u8
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Seth Deckard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-25 00:00:00.000000000 Z
+date: 2014-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -62,6 +62,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md