m3uzi 0.1.4 → 0.1.6

data/lib/m3uzi.rb

@@ -6,12 +6,13 @@ require 'm3uzi/version'
 
 class M3Uzi
 
-  # Unsupported: KEY PROGRAM-DATE-TIME DISCONTINUITY
-  VALID_TAGS = %w{TARGETDURATION MEDIA-SEQUENCE ALLOW-CACHE ENDLIST VERSION}
+  # Unsupported: PROGRAM-DATE-TIME DISCONTINUITY
+  VALID_TAGS = %w{TARGETDURATION MEDIA-SEQUENCE ALLOW-CACHE ENDLIST KEY}
 
   attr_accessor :files, :streams
   attr_accessor :tags, :comments
   attr_accessor :final_media_file
+  attr_accessor :version
 
   def initialize
     @files = []
@@ -19,6 +20,7 @@ class M3Uzi
     @tags = []
     @comments = []
     @final_media_file = true
+    @version = 1
   end
 
 
@@ -65,31 +67,38 @@ class M3Uzi
     m3u
   end
 
-  def write(path)
-    f = ::File.open(path, "w")
-    f << "#EXTM3U\n"
+  def write_to_io(io_stream)
+    check_version_restrictions
+    io_stream << "#EXTM3U\n"
+    io_stream << "#EXT-X-VERSION:#{@version.to_i}" if @version > 1
     comments.each do |comment|
-      f << "##{comment}\n"
+      io_stream << "##{comment}\n"
     end
     tags.each do |tag|
       next if %w{M3U ENDLIST}.include?(tag.name.to_s.upcase)
       if VALID_TAGS.include?(tag.name.to_s.upcase)
-        f << "#EXT-X-#{tag.name.to_s.upcase}"
+        io_stream << "#EXT-X-#{tag.name.to_s.upcase}"
       else
-        f << "##{tag.name.to_s.upcase}"
+        io_stream << "##{tag.name.to_s.upcase}"
       end
-      tag.value && f << ":#{tag.value}"
-      f << "\n"
+      tag.value && io_stream << ":#{tag.value}"
+      io_stream << "\n"
     end
     files.each do |file|
-      f << "#EXTINF:#{file.attribute_string}"
-      f << "\n#{file.path}\n"
+      io_stream << "#EXTINF:#{file.attribute_string}"
+      io_stream << "\n#{file.path}\n"
     end
     streams.each do |stream|
-      f << "#EXT-X-STREAM-INF:#{stream.attribute_string}"
-      f << "\n#{stream.path}\n"
+      io_stream << "#EXT-X-STREAM-INF:#{stream.attribute_string}"
+      io_stream << "\n#{stream.path}\n"
     end
-    f << "#EXT-X-ENDLIST\n" if files.length > 0 && final_media_file
+    io_stream << "#EXT-X-ENDLIST\n" if files.length > 0 && final_media_file
+  end
+
+  def write(path)
+    check_version_restrictions
+    f = ::File.open(path, "w")
+    write_to_io(f)
     f.close()
   end
 
@@ -105,7 +114,7 @@ class M3Uzi
   end
 
   def filenames
-    files.map{|file| file.path }
+    files.map { |file| file.path }
   end
 
 
@@ -120,7 +129,7 @@ class M3Uzi
   end
 
   def stream_names
-    streams.map{|stream| stream.path }
+    streams.map { |stream| stream.path }
   end
 
 
@@ -136,7 +145,7 @@ class M3Uzi
 
   def [](key)
     tag_name = key.to_s.upcase.gsub("_", "-")
-    obj = tags.detect{|tag| tag.name == tag_name }
+    obj = tags.detect { |tag| tag.name == tag_name }
     obj && obj.value
   end
 
@@ -160,6 +169,33 @@ class M3Uzi
     add_comment(comment)
   end
 
+  def check_version_restrictions
+    @version = 1
+
+    # Version 2 Features
+    if @tags.detect { |tag| tag.name == 'KEY' && tag.value.to_s =~ /,IV=/ }
+      @version = 2 if @version < 2
+    end
+
+    # Version 3 Features
+    if @files.detect { |file| file.duration.kind_of?(Float) }
+      @version = 3 if @version < 3
+    end
+
+    # Version 4 Features
+    if @files.detect { |file| file.byterange }
+      @version = 4 if @version < 4
+    end
+    if @tags.detect { |tag| ['MEDIA','I-FRAMES-ONLY'].include?(tag.name) }
+      @version = 4 if @version < 4
+    end
+
+    # NOTES
+    #   EXT-X-I-FRAME-STREAM-INF is supposed to be ignored by older clients.
+    #   AUDIO/VIDEO attributes of X-STREAM-INF are used in conjunction with MEDIA, so it should trigger v4.
+
+    @version
+  end
 
 protected
 

data/lib/m3uzi/file.rb

@@ -1,10 +1,14 @@
 class M3Uzi
   class File
 
-    attr_accessor :path, :duration, :description
+    attr_accessor :path, :duration, :description, :byterange
 
     def attribute_string
-      "#{duration},#{description}"
+      if duration.kind_of?(Float)
+        "#{sprintf('%0.3f',duration)},#{description}"
+      else
+        "#{duration},#{description}"
+      end
     end
 
   end

data/lib/m3uzi/version.rb

@@ -1,3 +1,3 @@
 class M3Uzi
-  VERSION = '0.1.4'
+  VERSION = '0.1.6'
 end

data/test/m3uzi_test.rb

@@ -0,0 +1,78 @@
+$: << File.join(File.dirname(__FILE__),'../lib')
+require 'm3uzi'
+require 'test/unit'
+require 'rubygems'
+require 'shoulda'
+
+class M3UziTest < Test::Unit::TestCase
+
+  context "basic checks" do
+    should "instantiate an M3Uzi object" do
+      m3u = M3Uzi.new
+      assert_equal M3Uzi, m3u.class
+    end
+
+    should "read in an index file" do
+      m3u = M3Uzi.read(File.join(File.dirname(__FILE__), "fixtures/index.m3u8"))
+      assert_equal M3Uzi, m3u.class
+    end
+  end
+
+  context "with protocol versions" do
+    should "set version 2 for encryption IV" do
+      m3u = M3Uzi.new
+      m3u['KEY'] = "0x1234567890abcdef1234567890abcdef"
+      assert_equal 1, m3u.check_version_restrictions
+      m3u['KEY'] = "0x1234567890abcdef1234567890abcdef,IV=0x1234567890abcdef1234567890abcdef"
+      assert_equal 2, m3u.check_version_restrictions
+
+      output_stream = StringIO.new
+      m3u.write_to_io(output_stream)
+      assert output_stream.string =~ /,IV=/
+    end
+
+    should "set version 3 for floating point durations" do
+      m3u = M3Uzi.new
+      m3u.add_file do |f|
+        f.path = "stuff.ts"
+        f.duration = 10
+      end
+      assert_equal 1, m3u.check_version_restrictions
+
+      output_stream = StringIO.new
+      m3u.write_to_io(output_stream)
+      assert output_stream.string =~ /:10,/
+      assert output_stream.string !~ /:10\./
+
+      m3u = M3Uzi.new
+      m3u.add_file do |f|
+        f.path = "stuff.ts"
+        f.duration = 10.0
+      end
+      assert_equal 3, m3u.check_version_restrictions
+
+      output_stream = StringIO.new
+      m3u.write_to_io(output_stream)
+      assert output_stream.string =~ /:10\.000,/
+      assert output_stream.string !~ /:10,/
+    end
+
+    should "set version 4 for advanced features" do
+      m3u = M3Uzi.new
+      m3u.add_file do |f|
+        f.path = "stuff.ts"
+        f.duration = 10
+      end
+      assert_equal 1, m3u.check_version_restrictions
+
+      m3u = M3Uzi.new
+      m3u.add_file do |f|
+        f.path = "stuff.ts"
+        f.duration = 10.0
+        f.byterange = "1234@0"
+      end
+      assert_equal 4, m3u.check_version_restrictions
+    end
+  end
+
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: m3uzi
 version: !ruby/object:Gem::Version 
-  hash: 19
   prerelease: false
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - Brandon Arbini
@@ -16,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-09 00:00:00 -06:00
+date: 2011-10-10 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -38,7 +37,7 @@ files:
 - lib/m3uzi.rb
 - test/fixtures/index.m3u8
 - test/fixtures/stream.m3u8
-- test/m3uzzi_test.rb
+- test/m3uzi_test.rb
 - LICENSE
 - Rakefile
 - README.md
@@ -52,27 +51,23 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Read and write M3U files with (relative) ease.

data/test/m3uzzi_test.rb

@@ -1,18 +0,0 @@
-require 'rubygems'
-require 'm3uzzi'
-require 'test/unit'
-require 'shoulda'
-
-class M3UziTest < Test::Unit::TestCase
-
-  should "instantiate an M3Uzi object" do
-    m3u = M3Uzi.new
-    assert_equal M3Uzi, m3u.class
-  end
-
-  should "read in an index file" do
-    m3u = M3Uzi.read_file("#{Rails.root}/test/fixtures/index.m3u8")
-    assert_equal M3Uzi, m3u.class
-  end
-
-end