m3u8 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afc4ec1f4627283241fc7e4f5eeb33d3ee69b17b
-  data.tar.gz: 4e04ba6b95728b5d5aa0c448e27d12331c37e5c5
+  metadata.gz: 941d9ae1544d5853fa64790089c269ce9b7cdc9c
+  data.tar.gz: fc32d9311ab491b6049b3a9c27ec6757886237d1
 SHA512:
-  metadata.gz: d360dd63410659e7e98b8d001886ae76ef925a8118c6850b7876cd6bbd1a88fc7917565cb407846b3e498aab15f510a3e5c921e36b46d76daa52059ff5c26266
-  data.tar.gz: 02dc01399f31cf0111c20123c06c86316ff1c54bb76238e8cbc884af44d2de5d974dda25a81287b19c44872ed12d088c661c462983762d06d361b357ffa4ca30
+  metadata.gz: e5bb40055129102f6b578533fcd0eb2904e9f43b7bfd3d5a9e6e2f14440095d401fbd4cb0fc04c10920ab60195703a5a7d7c1a94cfaafe939d093fbabe5e3521
+  data.tar.gz: bb47741dc6419161bb23e46c8c56478e978d2a6c71757b4665e80394ce74c676e078a8925de7601a8fc77e67561b2968fff5a87792d6e390c52d7f89dba4504f

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+### 0.3.0 (11/26/2014) - DEPRECIATED add_playlist and add_segment on Playlist, manipulate the items array directly instead. Extracted writing of playlists to it's own Writer class (only use directly if you want more control over the process). Added read convience method to Playlist so Reader doesn't have to be used directly unless more control is disired. Simplified validation and other aspects during this refactoring.
+
 ### 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.

data/README.md

@@ -66,6 +66,8 @@ Or install it yourself as:
    
   	#You can also access the playlist as a string
   	playlist.to_s
+
+    #There is a M3u8::Writer class if you want more control over the write process
     
     #values for :audio (Codec name)
     #aac-lc, he-aac, mp3
@@ -81,8 +83,7 @@ Or install it yourself as:
 ## Parsing Usage (new in v.2.0)
 
     file = File.open 'spec/fixtures/master.m3u8'
-    reader = M3u8::Reader.new
-    playlist = reader.read file
+    playlist = M3u8::Playlist.read file
     playlist.master?
     # => true
 
@@ -101,6 +102,8 @@ Or install it yourself as:
     item = M3u8::PlaylistItem.new options
     #add it to the top of the playlist
     playlist.items.insert 0, item
+
+    #There is a M3u8::Reader class if you want more control over parsing
 	
 ## Features
 * Distinction between segment and master playlists is handled automatically (no need to use a different class).

data/lib/m3u8.rb

@@ -4,6 +4,7 @@ require 'm3u8/playlist'
 require 'm3u8/playlist_item'
 require 'm3u8/segment_item'
 require 'm3u8/reader'
+require 'm3u8/writer'
 require 'm3u8/error'
 
 module M3u8

data/lib/m3u8/playlist.rb

@@ -1,11 +1,6 @@
 module M3u8
   class Playlist
     attr_accessor :items, :version, :cache, :target, :sequence
-    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 ' \
-      'be added.'
-    MIXED_TYPE_ERROR_MESSAGE = 'Playlist contains mixed types of items'
 
     def initialize(options = {})
       assign_options options
@@ -17,37 +12,14 @@ module M3u8
       item.codecs
     end
 
-    def add_playlist(program_id, playlist, bitrate, options = {})
-      validate_playlist_type true
-
-      params = { program_id: program_id, playlist: playlist, bitrate: bitrate,
-                 width: options[:width], height: options[:height],
-                 audio: options[:audio], profile: options[:profile],
-                 level: options[:level] }
-      item = PlaylistItem.new params
-      items.push item
-    end
-
-    def add_segment(duration, segment)
-      validate_playlist_type false
-
-      params = { duration: duration, segment: segment }
-      item = SegmentItem.new params
-      items.push item
+    def self.read(input)
+      reader = Reader.new
+      reader.read input
     end
 
     def write(output)
-      validate
-
-      output.puts '#EXTM3U'
-      write_header(output) unless master?
-
-      items.each do |item|
-        output.puts item.to_s
-      end
-
-      return if master?
-      output.puts '#EXT-X-ENDLIST'
+      writer = Writer.new output
+      writer.write self
     end
 
     def master?
@@ -82,20 +54,6 @@ module M3u8
       self.target = options[:target]
     end
 
-    def validate
-      return if valid?
-      fail PlaylistTypeError, MIXED_TYPE_ERROR_MESSAGE
-    end
-
-    def validate_playlist_type(master)
-      return if items.size == 0
-      if master && !master?
-        fail PlaylistTypeError, NON_MASTER_ERROR_MESSAGE
-      elsif !master && master?
-        fail PlaylistTypeError, MASTER_ERROR_MESSAGE
-      end
-    end
-
     def playlist_size
       items.select { |item| item.is_a?(PlaylistItem) }.size
     end
@@ -103,16 +61,5 @@ module M3u8
     def segment_size
       items.select { |item| item.is_a?(SegmentItem) }.size
     end
-
-    def write_header(output)
-      output.puts "#EXT-X-VERSION:#{version}"
-      output.puts "#EXT-X-MEDIA-SEQUENCE:#{sequence}"
-      output.puts "#EXT-X-ALLOW-CACHE:#{cache_string}"
-      output.puts "#EXT-X-TARGETDURATION:#{target}"
-    end
-
-    def cache_string
-      cache ? 'YES' : 'NO'
-    end
   end
 end

data/lib/m3u8/version.rb

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

data/lib/m3u8/writer.rb

@@ -0,0 +1,41 @@
+module M3u8
+  class Writer
+    attr_accessor :io
+
+    def initialize(io)
+      self.io = io
+    end
+
+    def write(playlist)
+      validate playlist
+
+      io.puts '#EXTM3U'
+      write_header(playlist) unless playlist.master?
+
+      playlist.items.each do |item|
+        io.puts item.to_s
+      end
+
+      return if playlist.master?
+      io.puts '#EXT-X-ENDLIST'
+    end
+
+    private
+
+    def validate(playlist)
+      return if playlist.valid?
+      fail PlaylistTypeError, 'Playlist is invalid.'
+    end
+
+    def write_header(playlist)
+      io.puts "#EXT-X-VERSION:#{playlist.version}"
+      io.puts "#EXT-X-MEDIA-SEQUENCE:#{playlist.sequence}"
+      io.puts "#EXT-X-ALLOW-CACHE:#{cache(playlist)}"
+      io.puts "#EXT-X-TARGETDURATION:#{playlist.target}"
+    end
+
+    def cache(playlist)
+      playlist.cache ? 'YES' : 'NO'
+    end
+  end
+end

data/spec/playlist_spec.rb

@@ -8,19 +8,23 @@ describe M3u8::Playlist do
   end
 
   it 'should render master playlist' do
+    options = { program_id: '1', playlist: 'playlist_url', bitrate: 6400,
+                audio: 'mp3' }
+    item = M3u8::PlaylistItem.new options
     playlist = M3u8::Playlist.new
-    playlist.add_playlist '1', 'playlist_url', 6400, audio: 'mp3'
+    playlist.items.push item
 
     output = "#EXTM3U\n" +
              %(#EXT-X-STREAM-INF:PROGRAM-ID=1,CODECS="mp4a.40.34") +
              ",BANDWIDTH=6400\nplaylist_url\n"
-
     expect(playlist.to_s).to eq output
 
-    playlist = M3u8::Playlist.new
-    options = { width: 1920, height: 1080, profile: 'high', level: 4.1,
+    options = { program_id: '2', playlist: 'playlist_url', bitrate: 50_000,
+                width: 1920, height: 1080, profile: 'high', level: 4.1,
                 audio: 'aac-lc' }
-    playlist.add_playlist '2', 'playlist_url', 50_000, options
+    item = M3u8::PlaylistItem.new options
+    playlist = M3u8::Playlist.new
+    playlist.items.push item
 
     output = "#EXTM3U\n" \
              '#EXT-X-STREAM-INF:PROGRAM-ID=2,RESOLUTION=1920x1080,' +
@@ -30,23 +34,29 @@ describe M3u8::Playlist do
     expect(playlist.to_s).to eq output
 
     playlist = M3u8::Playlist.new
-    playlist.add_playlist '1', 'playlist_url', 6400, audio: 'mp3'
-    options = { width: 1920, height: 1080, profile: 'high', level: 4.1,
+    options = { program_id: '1', playlist: 'playlist_url', bitrate: 6400,
+                audio: 'mp3' }
+    item = M3u8::PlaylistItem.new options
+    playlist.items.push item
+    options = { program_id: '2', playlist: 'playlist_url', bitrate: 50_000,
+                width: 1920, height: 1080, profile: 'high', level: 4.1,
                 audio: 'aac-lc' }
-    playlist.add_playlist '2', 'playlist_url', 50_000, options
+    item = M3u8::PlaylistItem.new options
+    playlist.items.push item
 
     output = "#EXTM3U\n" +
              %(#EXT-X-STREAM-INF:PROGRAM-ID=1,CODECS="mp4a.40.34") +
              ",BANDWIDTH=6400\nplaylist_url\n#EXT-X-STREAM-INF:PROGRAM-ID=2," +
              %(RESOLUTION=1920x1080,CODECS="avc1.640028,mp4a.40.2") +
              ",BANDWIDTH=50000\nplaylist_url\n"
-
     expect(playlist.to_s).to eq output
   end
 
   it 'should render playlist' do
+    options = { duration: 11.344644, segment: '1080-7mbps00000.ts' }
+    item =  M3u8::SegmentItem.new options
     playlist = M3u8::Playlist.new
-    playlist.add_segment 11.344644, '1080-7mbps00000.ts'
+    playlist.items.push item
 
     output = "#EXTM3U\n" \
       "#EXT-X-VERSION:3\n" \
@@ -56,10 +66,11 @@ describe M3u8::Playlist do
       "#EXTINF:11.344644,\n" \
       "1080-7mbps00000.ts\n" \
       "#EXT-X-ENDLIST\n"
-
     expect(playlist.to_s).to eq output
 
-    playlist.add_segment 11.261233, '1080-7mbps00001.ts'
+    options = { duration: 11.261233, segment: '1080-7mbps00001.ts' }
+    item =  M3u8::SegmentItem.new options
+    playlist.items.push item
 
     output = "#EXTM3U\n" \
       "#EXT-X-VERSION:3\n" \
@@ -71,12 +82,13 @@ describe M3u8::Playlist do
       "#EXTINF:11.261233,\n" \
       "1080-7mbps00001.ts\n" \
       "#EXT-X-ENDLIST\n"
-
     expect(playlist.to_s).to eq output
 
     options = { version: 1, cache: false, target: 12, sequence: 1 }
     playlist = M3u8::Playlist.new options
-    playlist.add_segment 11.344644, '1080-7mbps00000.ts'
+    options = { duration: 11.344644, segment: '1080-7mbps00000.ts' }
+    item =  M3u8::SegmentItem.new options
+    playlist.items.push item
 
     output = "#EXTM3U\n" \
       "#EXT-X-VERSION:1\n" \
@@ -93,7 +105,10 @@ describe M3u8::Playlist do
   it 'should write playlist to io' do
     test_io = StringIO.new
     playlist = M3u8::Playlist.new
-    playlist.add_playlist '1', 'playlist_url', 6400, audio: 'mp3'
+    options = { program_id: '1', playlist: 'playlist_url', bitrate: 6400,
+                audio: 'mp3' }
+    item = M3u8::PlaylistItem.new options
+    playlist.items.push item
     playlist.write test_io
 
     output = "#EXTM3U\n" +
@@ -115,26 +130,14 @@ describe M3u8::Playlist do
   it 'should report if it is a master playlist' do
     playlist = M3u8::Playlist.new
     expect(playlist.master?).to be false
+    options = { program_id: '1', playlist: 'playlist_url', bitrate: 6400,
+                audio: 'mp3' }
+    item = M3u8::PlaylistItem.new options
+    playlist.items.push item
 
-    playlist.add_playlist '1', 'playlist_url', 6400, audio: 'mp3'
     expect(playlist.master?).to be true
   end
 
-  it 'should raise error if type of playlist is changed' do
-    playlist = M3u8::Playlist.new
-    playlist.add_playlist '1', 'playlist_url', 6400, audio: 'mp3'
-
-    message = 'Playlist is a master playlist, segment can not be added.'
-    expect { playlist.add_segment 11.344644, '1080-7mbps00000.ts' }
-      .to raise_error(M3u8::PlaylistTypeError, message)
-
-    playlist = M3u8::Playlist.new
-    playlist.add_segment 11.344644, '1080-7mbps00000.ts'
-    message = 'Playlist is not a master playlist, playlist can not be added.'
-    expect { playlist.add_playlist '1', 'playlist_url', 6400 }
-      .to raise_error(M3u8::PlaylistTypeError, message)
-  end
-
   it 'should raise error on write if item types are mixed' do
     playlist = M3u8::Playlist.new
 
@@ -147,7 +150,7 @@ describe M3u8::Playlist do
     item = M3u8::SegmentItem.new(hash)
     playlist.items.push item
 
-    message = 'Playlist contains mixed types of items'
+    message = 'Playlist is invalid.'
     io = StringIO.new
     expect { playlist.write io }
       .to raise_error(M3u8::PlaylistTypeError, message)
@@ -184,4 +187,11 @@ describe M3u8::Playlist do
     expect(playlist.target).to be 12
     expect(playlist.sequence).to be 1
   end
+
+  it 'should allow reading of playlists' do
+    file = File.open 'spec/fixtures/master.m3u8'
+    playlist = M3u8::Playlist.read file
+    expect(playlist.master?).to be true
+    expect(playlist.items.size).to eq 6
+  end
 end

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ require 'm3u8/playlist'
 require 'm3u8/playlist_item'
 require 'm3u8/segment_item'
 require 'm3u8/reader'
+require 'm3u8/writer'
 require 'm3u8/error'
 
 require 'coveralls'

data/spec/writer_spec.rb

@@ -0,0 +1,136 @@
+require 'spec_helper'
+
+describe M3u8::Writer do
+  it 'should render master playlist' do
+    options = { program_id: '1', playlist: 'playlist_url', bitrate: 6400,
+                audio: 'mp3' }
+    item = M3u8::PlaylistItem.new options
+    playlist = M3u8::Playlist.new
+    playlist.items.push item
+
+    output = "#EXTM3U\n" +
+             %(#EXT-X-STREAM-INF:PROGRAM-ID=1,CODECS="mp4a.40.34") +
+             ",BANDWIDTH=6400\nplaylist_url\n"
+
+    io = StringIO.open
+    writer = M3u8::Writer.new io
+    writer.write playlist
+    expect(io.string).to eq output
+
+    options = { program_id: '2', playlist: 'playlist_url', bitrate: 50_000,
+                width: 1920, height: 1080, profile: 'high', level: 4.1,
+                audio: 'aac-lc' }
+    item = M3u8::PlaylistItem.new options
+    playlist = M3u8::Playlist.new
+    playlist.items.push item
+
+    output = "#EXTM3U\n" \
+             '#EXT-X-STREAM-INF:PROGRAM-ID=2,RESOLUTION=1920x1080,' +
+             %(CODECS="avc1.640028,mp4a.40.2",BANDWIDTH=50000\n) +
+             "playlist_url\n"
+
+    io = StringIO.open
+    writer = M3u8::Writer.new io
+    writer.write playlist
+    expect(io.string).to eq output
+
+    playlist = M3u8::Playlist.new
+    options = { program_id: '1', playlist: 'playlist_url', bitrate: 6400,
+                audio: 'mp3' }
+    item = M3u8::PlaylistItem.new options
+    playlist.items.push item
+    options = { program_id: '2', playlist: 'playlist_url', bitrate: 50_000,
+                width: 1920, height: 1080, profile: 'high', level: 4.1,
+                audio: 'aac-lc' }
+    item = M3u8::PlaylistItem.new options
+    playlist.items.push item
+
+    output = "#EXTM3U\n" +
+             %(#EXT-X-STREAM-INF:PROGRAM-ID=1,CODECS="mp4a.40.34") +
+             ",BANDWIDTH=6400\nplaylist_url\n#EXT-X-STREAM-INF:PROGRAM-ID=2," +
+             %(RESOLUTION=1920x1080,CODECS="avc1.640028,mp4a.40.2") +
+             ",BANDWIDTH=50000\nplaylist_url\n"
+
+    io = StringIO.open
+    writer = M3u8::Writer.new io
+    writer.write playlist
+    expect(io.string).to eq output
+  end
+
+  it 'should render playlist' do
+    options = { duration: 11.344644, segment: '1080-7mbps00000.ts' }
+    item =  M3u8::SegmentItem.new options
+    playlist = M3u8::Playlist.new
+    playlist.items.push item
+
+    output = "#EXTM3U\n" \
+      "#EXT-X-VERSION:3\n" \
+      "#EXT-X-MEDIA-SEQUENCE:0\n" \
+      "#EXT-X-ALLOW-CACHE:YES\n" \
+      "#EXT-X-TARGETDURATION:10\n" \
+      "#EXTINF:11.344644,\n" \
+      "1080-7mbps00000.ts\n" \
+      "#EXT-X-ENDLIST\n"
+    io = StringIO.open
+    writer = M3u8::Writer.new io
+    writer.write playlist
+    expect(io.string).to eq output
+
+    options = { duration: 11.261233, segment: '1080-7mbps00001.ts' }
+    item =  M3u8::SegmentItem.new options
+    playlist.items.push item
+
+    output = "#EXTM3U\n" \
+      "#EXT-X-VERSION:3\n" \
+      "#EXT-X-MEDIA-SEQUENCE:0\n" \
+      "#EXT-X-ALLOW-CACHE:YES\n" \
+      "#EXT-X-TARGETDURATION:10\n" \
+      "#EXTINF:11.344644,\n" \
+      "1080-7mbps00000.ts\n" \
+      "#EXTINF:11.261233,\n" \
+      "1080-7mbps00001.ts\n" \
+      "#EXT-X-ENDLIST\n"
+    io = StringIO.open
+    writer = M3u8::Writer.new io
+    writer.write playlist
+    expect(io.string).to eq output
+
+    options = { version: 1, cache: false, target: 12, sequence: 1 }
+    playlist = M3u8::Playlist.new options
+    options = { duration: 11.344644, segment: '1080-7mbps00000.ts' }
+    item =  M3u8::SegmentItem.new options
+    playlist.items.push item
+
+    output = "#EXTM3U\n" \
+      "#EXT-X-VERSION:1\n" \
+      "#EXT-X-MEDIA-SEQUENCE:1\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 = M3u8::Writer.new io
+    writer.write playlist
+    expect(io.string).to eq output
+  end
+
+  it 'should raise error on write if item types are mixed' do
+    playlist = M3u8::Playlist.new
+
+    hash = { program_id: 1, width: 1920, height: 1080, codecs: 'avc',
+             bitrate: 540, playlist: 'test.url' }
+    item = M3u8::PlaylistItem.new(hash)
+    playlist.items.push item
+
+    hash = { duration: 10.991, segment: 'test.ts' }
+    item = M3u8::SegmentItem.new(hash)
+    playlist.items.push item
+
+    message = 'Playlist is invalid.'
+    io = StringIO.new
+    writer = M3u8::Writer.new io
+    expect { writer.write playlist }
+      .to raise_error(M3u8::PlaylistTypeError, message)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: m3u8
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Seth Deckard
@@ -74,6 +74,7 @@ files:
 - lib/m3u8/reader.rb
 - lib/m3u8/segment_item.rb
 - lib/m3u8/version.rb
+- lib/m3u8/writer.rb
 - m3u8.gemspec
 - spec/fixtures/master.m3u8
 - spec/fixtures/playlist.m3u8
@@ -82,6 +83,7 @@ files:
 - spec/reader_spec.rb
 - spec/segment_item_spec.rb
 - spec/spec_helper.rb
+- spec/writer_spec.rb
 homepage: https://github.com/sethdeckard/m3u8
 licenses:
 - MIT
@@ -114,3 +116,4 @@ test_files:
 - spec/reader_spec.rb
 - spec/segment_item_spec.rb
 - spec/spec_helper.rb
+- spec/writer_spec.rb