m3uzi 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Brandon Arbini / Zencoder, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+M3Uzi
+======
+
+Read and write M3U files with (relative) ease.
+
+Usage
+------
+
+Read an M3U file:
+
+    M3Uzi.read("/path/to/file.m3u8")
+
+Write an M3U file:
+
+    m3u.write("/path/to/file.m3u8")
+
+Get a list of filenames:
+
+    m3u.filenames
+
+Get all file reference objects:
+
+    m3u.files
+
+Add a file to the M3U index:
+
+    m3u.add_file do |file|
+      file.path = "/path/to/file.ts"
+      file.duration = 10
+      file.description = "no desc"
+    end
+
+Get all tag reference objects:
+
+    m3u.tags
+
+Get an individual tag value (TARGETDURATION MEDIA-SEQUENCE ALLOW-CACHE STREAM-INF ENDLIST VERSION):
+
+    m3u[:targetduration]
+    m3u[:media_sequence]
+
+Set an individual tag value:
+
+    m3u[:targetduration] = 100
+
+Add a tag to the M3U index:
+
+    m3u.add_tag do |tag|
+      tag.name = "VERSION"
+      tag.value = "1"
+    end
+
+
+NOTES
+------
+* Target duration will be calculated and included if omitted
+
+
+TODO
+-----
+
+* Tags KEY, PROGRAM-DATE-TIME, and DISCONTINUITY are not supported
+* Stream info is not working yet
+* Tests need to be written
+* Needs to be turned into a gem
+
+
+(c) 2010 Brandon Arbini / Zencoder, Inc.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/lib/m3uzi/file.rb

@@ -0,0 +1,9 @@
+class M3Uzi
+
+  class File
+
+    attr_accessor :path, :duration, :description
+
+  end
+
+end

data/lib/m3uzi/stream.rb

@@ -0,0 +1,9 @@
+class M3Uzi
+
+  class Stream
+
+    attr_accessor :bandwidth, :program_id, :codecs, :resolution
+
+  end
+
+end

data/lib/m3uzi/tag.rb

@@ -0,0 +1,14 @@
+class M3Uzi
+
+  class Tag
+
+    attr_reader :name
+    attr_accessor :value
+
+    def name=(n)
+      @name = n.to_s.upcase.sub("_", "-")
+    end
+
+  end
+
+end

data/lib/m3uzi/version.rb

@@ -0,0 +1,3 @@
+class M3Uzi
+  VERSION = '0.1.0'
+end

data/lib/m3uzi.rb

@@ -0,0 +1,142 @@
+$:<< File.dirname(__FILE__)
+require 'm3uzi/tag'
+require 'm3uzi/file'
+require 'm3uzi/stream'
+require 'm3uzi/version'
+
+class M3Uzi
+
+  # Unsupported: KEY PROGRAM-DATE-TIME STREAM-INF DISCONTINUITY
+  VALID_TAGS = %w{TARGETDURATION MEDIA-SEQUENCE ALLOW-CACHE STREAM-INF ENDLIST VERSION}
+
+  attr_accessor :files
+  attr_accessor :tags
+
+  def initialize
+    @files = []
+    @tags = []
+  end
+
+
+  #-------------------------------------
+  # Read/Write M3U8 Files
+  #-------------------------------------
+
+  def self.read(path)
+    m3u = self.new
+    lines = ::File.readlines(path)
+    lines.each_with_index do |line, i|
+      case type(line)
+      when :tag
+        name, value = parse_general_tag(line)
+        m3u.add_tag do |tag|
+          tag.name = name
+          tag.value = value
+        end
+      when :info
+        duration, description = parse_file_tag(line)
+        m3u.add_file do |file|
+          file.path = lines[i+1].strip
+          file.duration = duration
+          file.description = description
+        end
+      else
+        next
+      end
+    end
+    m3u
+  end
+
+  def write(path)
+    f = ::File.open(path, "w")
+    f << "#EXTM3U\n"
+    tags.each do |tag|
+      next if %w{M3U ENDLIST}.include?(tag.name.to_s.upcase)
+      f << "#EXT-X-#{tag.name.to_s.upcase}"
+      tag.value && f << ":#{tag.value}"
+      f << "\n"
+    end
+    if !self[:targetduration]
+      f << "#EXT-X-TARGETDURATION:#{files.map(&:duration).sum}\n"
+    end
+    files.each do |file|
+      f << "#EXTINF:#{file.duration}"
+      file.description && f << ", #{file.description}"
+      f << "\n#{file.path}\n"
+    end
+    f << "#EXT-X-ENDLIST"
+    f.close()
+  end
+
+
+  #-------------------------------------
+  # Files
+  #-------------------------------------
+
+  def add_file(&block)
+    new_file = M3Uzi::File.new
+    yield(new_file)
+    @files << new_file
+  end
+
+  def filenames
+    files.map{|file| file.path }
+  end
+
+
+  #-------------------------------------
+  # Tags
+  #-------------------------------------
+
+  def add_tag(&block)
+    new_tag = M3Uzi::Tag.new
+    yield(new_tag)
+    @tags << new_tag
+  end
+
+  def [](key)
+    tag_name = key.to_s.upcase.sub("_", "-")
+    obj = tags.detect{|tag| tag.name == tag_name }
+    obj && obj.value
+  end
+
+  def []=(key, value)
+    add_tag do |tag|
+      tag.name = key
+      tag.value = value
+    end
+  end
+
+
+protected
+
+  def self.type(line)
+    case line
+    when /^\s*$/
+      :whitespace
+    when /^#(?!EXT)/
+      :comment
+    when /^#EXTINF/
+      :info
+    when /^#EXT(?!INF)/
+      :tag
+    else
+      :file
+    end
+  end
+
+  def self.parse_general_tag(line)
+    line.match(/^#EXT(?:-X-)?(?!STREAM-INF)([^:\n]+)(:([^\n]+))?$/).values_at(1, 3)
+  end
+
+  def self.parse_file_tag(line)
+    line.match(/^#EXTINF:[ \t]*(\d+),?[ \t]*(.*)$/).values_at(1, 2)
+  end
+
+  def self.parse_stream_tag(line)
+    match = line.match(/^#EXT-X-STREAM-INF:(.*)$/)[1]
+    attributes = match.split(/\s*,\s*/)
+    attributes.map{|a| a.split(/\s*=\s*/) }
+  end
+
+end

data/test/fixtures/index.m3u8

@@ -0,0 +1,366 @@
+#EXTM3U
+#EXT-X-TARGETDURATION:10
+#EXT-X-MEDIA-SEQUENCE:0
+#EXTINF:10, no desc
+fileSequence0.ts
+#EXTINF:10, no desc
+fileSequence1.ts
+#EXTINF:10, no desc
+fileSequence2.ts
+#EXTINF:10, no desc
+fileSequence3.ts
+#EXTINF:10, no desc
+fileSequence4.ts
+#EXTINF:10, no desc
+fileSequence5.ts
+#EXTINF:10, no desc
+fileSequence6.ts
+#EXTINF:10, no desc
+fileSequence7.ts
+#EXTINF:10, no desc
+fileSequence8.ts
+#EXTINF:10, no desc
+fileSequence9.ts
+#EXTINF:10, no desc
+fileSequence10.ts
+#EXTINF:10, no desc
+fileSequence11.ts
+#EXTINF:10, no desc
+fileSequence12.ts
+#EXTINF:10, no desc
+fileSequence13.ts
+#EXTINF:10, no desc
+fileSequence14.ts
+#EXTINF:10, no desc
+fileSequence15.ts
+#EXTINF:10, no desc
+fileSequence16.ts
+#EXTINF:10, no desc
+fileSequence17.ts
+#EXTINF:10, no desc
+fileSequence18.ts
+#EXTINF:10, no desc
+fileSequence19.ts
+#EXTINF:10, no desc
+fileSequence20.ts
+#EXTINF:10, no desc
+fileSequence21.ts
+#EXTINF:10, no desc
+fileSequence22.ts
+#EXTINF:10, no desc
+fileSequence23.ts
+#EXTINF:10, no desc
+fileSequence24.ts
+#EXTINF:10, no desc
+fileSequence25.ts
+#EXTINF:10, no desc
+fileSequence26.ts
+#EXTINF:10, no desc
+fileSequence27.ts
+#EXTINF:10, no desc
+fileSequence28.ts
+#EXTINF:10, no desc
+fileSequence29.ts
+#EXTINF:10, no desc
+fileSequence30.ts
+#EXTINF:10, no desc
+fileSequence31.ts
+#EXTINF:10, no desc
+fileSequence32.ts
+#EXTINF:10, no desc
+fileSequence33.ts
+#EXTINF:10, no desc
+fileSequence34.ts
+#EXTINF:10, no desc
+fileSequence35.ts
+#EXTINF:10, no desc
+fileSequence36.ts
+#EXTINF:10, no desc
+fileSequence37.ts
+#EXTINF:10, no desc
+fileSequence38.ts
+#EXTINF:10, no desc
+fileSequence39.ts
+#EXTINF:10, no desc
+fileSequence40.ts
+#EXTINF:10, no desc
+fileSequence41.ts
+#EXTINF:10, no desc
+fileSequence42.ts
+#EXTINF:10, no desc
+fileSequence43.ts
+#EXTINF:10, no desc
+fileSequence44.ts
+#EXTINF:10, no desc
+fileSequence45.ts
+#EXTINF:10, no desc
+fileSequence46.ts
+#EXTINF:10, no desc
+fileSequence47.ts
+#EXTINF:10, no desc
+fileSequence48.ts
+#EXTINF:10, no desc
+fileSequence49.ts
+#EXTINF:10, no desc
+fileSequence50.ts
+#EXTINF:10, no desc
+fileSequence51.ts
+#EXTINF:10, no desc
+fileSequence52.ts
+#EXTINF:10, no desc
+fileSequence53.ts
+#EXTINF:10, no desc
+fileSequence54.ts
+#EXTINF:10, no desc
+fileSequence55.ts
+#EXTINF:10, no desc
+fileSequence56.ts
+#EXTINF:10, no desc
+fileSequence57.ts
+#EXTINF:10, no desc
+fileSequence58.ts
+#EXTINF:10, no desc
+fileSequence59.ts
+#EXTINF:10, no desc
+fileSequence60.ts
+#EXTINF:10, no desc
+fileSequence61.ts
+#EXTINF:10, no desc
+fileSequence62.ts
+#EXTINF:10, no desc
+fileSequence63.ts
+#EXTINF:10, no desc
+fileSequence64.ts
+#EXTINF:10, no desc
+fileSequence65.ts
+#EXTINF:10, no desc
+fileSequence66.ts
+#EXTINF:10, no desc
+fileSequence67.ts
+#EXTINF:10, no desc
+fileSequence68.ts
+#EXTINF:10, no desc
+fileSequence69.ts
+#EXTINF:10, no desc
+fileSequence70.ts
+#EXTINF:10, no desc
+fileSequence71.ts
+#EXTINF:10, no desc
+fileSequence72.ts
+#EXTINF:10, no desc
+fileSequence73.ts
+#EXTINF:10, no desc
+fileSequence74.ts
+#EXTINF:10, no desc
+fileSequence75.ts
+#EXTINF:10, no desc
+fileSequence76.ts
+#EXTINF:10, no desc
+fileSequence77.ts
+#EXTINF:10, no desc
+fileSequence78.ts
+#EXTINF:10, no desc
+fileSequence79.ts
+#EXTINF:10, no desc
+fileSequence80.ts
+#EXTINF:10, no desc
+fileSequence81.ts
+#EXTINF:10, no desc
+fileSequence82.ts
+#EXTINF:10, no desc
+fileSequence83.ts
+#EXTINF:10, no desc
+fileSequence84.ts
+#EXTINF:10, no desc
+fileSequence85.ts
+#EXTINF:10, no desc
+fileSequence86.ts
+#EXTINF:10, no desc
+fileSequence87.ts
+#EXTINF:10, no desc
+fileSequence88.ts
+#EXTINF:10, no desc
+fileSequence89.ts
+#EXTINF:10, no desc
+fileSequence90.ts
+#EXTINF:10, no desc
+fileSequence91.ts
+#EXTINF:10, no desc
+fileSequence92.ts
+#EXTINF:10, no desc
+fileSequence93.ts
+#EXTINF:10, no desc
+fileSequence94.ts
+#EXTINF:10, no desc
+fileSequence95.ts
+#EXTINF:10, no desc
+fileSequence96.ts
+#EXTINF:10, no desc
+fileSequence97.ts
+#EXTINF:10, no desc
+fileSequence98.ts
+#EXTINF:10, no desc
+fileSequence99.ts
+#EXTINF:10, no desc
+fileSequence100.ts
+#EXTINF:10, no desc
+fileSequence101.ts
+#EXTINF:10, no desc
+fileSequence102.ts
+#EXTINF:10, no desc
+fileSequence103.ts
+#EXTINF:10, no desc
+fileSequence104.ts
+#EXTINF:10, no desc
+fileSequence105.ts
+#EXTINF:10, no desc
+fileSequence106.ts
+#EXTINF:10, no desc
+fileSequence107.ts
+#EXTINF:10, no desc
+fileSequence108.ts
+#EXTINF:10, no desc
+fileSequence109.ts
+#EXTINF:10, no desc
+fileSequence110.ts
+#EXTINF:10, no desc
+fileSequence111.ts
+#EXTINF:10, no desc
+fileSequence112.ts
+#EXTINF:10, no desc
+fileSequence113.ts
+#EXTINF:10, no desc
+fileSequence114.ts
+#EXTINF:10, no desc
+fileSequence115.ts
+#EXTINF:10, no desc
+fileSequence116.ts
+#EXTINF:10, no desc
+fileSequence117.ts
+#EXTINF:10, no desc
+fileSequence118.ts
+#EXTINF:10, no desc
+fileSequence119.ts
+#EXTINF:10, no desc
+fileSequence120.ts
+#EXTINF:10, no desc
+fileSequence121.ts
+#EXTINF:10, no desc
+fileSequence122.ts
+#EXTINF:10, no desc
+fileSequence123.ts
+#EXTINF:10, no desc
+fileSequence124.ts
+#EXTINF:10, no desc
+fileSequence125.ts
+#EXTINF:10, no desc
+fileSequence126.ts
+#EXTINF:10, no desc
+fileSequence127.ts
+#EXTINF:10, no desc
+fileSequence128.ts
+#EXTINF:10, no desc
+fileSequence129.ts
+#EXTINF:10, no desc
+fileSequence130.ts
+#EXTINF:10, no desc
+fileSequence131.ts
+#EXTINF:10, no desc
+fileSequence132.ts
+#EXTINF:10, no desc
+fileSequence133.ts
+#EXTINF:10, no desc
+fileSequence134.ts
+#EXTINF:10, no desc
+fileSequence135.ts
+#EXTINF:10, no desc
+fileSequence136.ts
+#EXTINF:10, no desc
+fileSequence137.ts
+#EXTINF:10, no desc
+fileSequence138.ts
+#EXTINF:10, no desc
+fileSequence139.ts
+#EXTINF:10, no desc
+fileSequence140.ts
+#EXTINF:10, no desc
+fileSequence141.ts
+#EXTINF:10, no desc
+fileSequence142.ts
+#EXTINF:10, no desc
+fileSequence143.ts
+#EXTINF:10, no desc
+fileSequence144.ts
+#EXTINF:10, no desc
+fileSequence145.ts
+#EXTINF:10, no desc
+fileSequence146.ts
+#EXTINF:10, no desc
+fileSequence147.ts
+#EXTINF:10, no desc
+fileSequence148.ts
+#EXTINF:10, no desc
+fileSequence149.ts
+#EXTINF:10, no desc
+fileSequence150.ts
+#EXTINF:10, no desc
+fileSequence151.ts
+#EXTINF:10, no desc
+fileSequence152.ts
+#EXTINF:10, no desc
+fileSequence153.ts
+#EXTINF:10, no desc
+fileSequence154.ts
+#EXTINF:10, no desc
+fileSequence155.ts
+#EXTINF:10, no desc
+fileSequence156.ts
+#EXTINF:10, no desc
+fileSequence157.ts
+#EXTINF:10, no desc
+fileSequence158.ts
+#EXTINF:10, no desc
+fileSequence159.ts
+#EXTINF:10, no desc
+fileSequence160.ts
+#EXTINF:10, no desc
+fileSequence161.ts
+#EXTINF:10, no desc
+fileSequence162.ts
+#EXTINF:10, no desc
+fileSequence163.ts
+#EXTINF:10, no desc
+fileSequence164.ts
+#EXTINF:10, no desc
+fileSequence165.ts
+#EXTINF:10, no desc
+fileSequence166.ts
+#EXTINF:10, no desc
+fileSequence167.ts
+#EXTINF:10, no desc
+fileSequence168.ts
+#EXTINF:10, no desc
+fileSequence169.ts
+#EXTINF:10, no desc
+fileSequence170.ts
+#EXTINF:10, no desc
+fileSequence171.ts
+#EXTINF:10, no desc
+fileSequence172.ts
+#EXTINF:10, no desc
+fileSequence173.ts
+#EXTINF:10, no desc
+fileSequence174.ts
+#EXTINF:10, no desc
+fileSequence175.ts
+#EXTINF:10, no desc
+fileSequence176.ts
+#EXTINF:10, no desc
+fileSequence177.ts
+#EXTINF:10, no desc
+fileSequence178.ts
+#EXTINF:10, no desc
+fileSequence179.ts
+#EXTINF:1, no desc
+fileSequence180.ts
+#EXT-X-ENDLIST

data/test/fixtures/stream.m3u8

@@ -0,0 +1,9 @@
+#EXTM3U
+#EXT-X-STREAM-INF:PROGRAM-ID=1, BANDWIDTH=200000
+gear1/prog_index.m3u8
+#EXT-X-STREAM-INF:PROGRAM-ID=1, BANDWIDTH=311111
+gear2/prog_index.m3u8
+#EXT-X-STREAM-INF:PROGRAM-ID=1, BANDWIDTH=484444
+gear3/prog_index.m3u8
+#EXT-X-STREAM-INF:PROGRAM-ID=1, BANDWIDTH=737777
+gear4/prog_index.m3u8

data/test/m3uzzi_test.rb

@@ -0,0 +1,18 @@
+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

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: m3uzi
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Brandon Arbini
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-27 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Read and write M3U files with (relative) ease.
+email: brandon@zencoder.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/m3uzi/file.rb
+- lib/m3uzi/stream.rb
+- lib/m3uzi/tag.rb
+- lib/m3uzi/version.rb
+- lib/m3uzi.rb
+- test/fixtures/index.m3u8
+- test/fixtures/stream.m3u8
+- test/m3uzzi_test.rb
+- LICENSE
+- Rakefile
+- README.md
+has_rdoc: true
+homepage: http://github.com/zencoder/m3uzi
+licenses: []
+
+post_install_message: 
+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
+signing_key: 
+specification_version: 3
+summary: Read and write M3U files with (relative) ease.
+test_files: []
+