ruby-ogginfo 0.3

data/History.txt

@@ -0,0 +1,12 @@
+=== 0.3 / 2008-03-15
+
+* write support through "vorbiscomment" binary
+* correct encoding handling
+
+=== 0.2 / 2005-07-11
+
+* tag["key"] is accessible with tag.key
+
+=== 0.1 / 2004-06-20
+
+* first public version

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/ogginfo.rb
+test/test_ruby-ogginfo.rb

data/README.txt

@@ -0,0 +1,35 @@
+= ruby-ogginfo
+
+http://ruby-ogginfo.rubyforge.org/
+
+== DESCRIPTION:
+
+ruby-ogginfo gives you access to low level information on ogg files
+(bitrate, length, samplerate, encoder, etc... ), as well as tag.
+It is written in pure ruby.
+
+== FEATURES/PROBLEMS
+
+* writing tags is not pure ruby yet, need to have "vorbiscomment"
+  command
+
+== SYNOPSIS:
+
+  require "ogginfo"
+  OggInfo.open("toto.ogg") do |ogg|
+    puts ogg.bitrate
+    puts ogg.artist
+    puts ogg
+  end
+
+== INSTALL:
+
+sudo gem install ruby-ogginfo
+
+== TODO:
+
+* writing tags in pure-ruby
+
+== LICENSE:
+
+Ruby

data/Rakefile

@@ -0,0 +1,18 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require 'lib/ogginfo.rb'
+
+Hoe.new('ruby-ogginfo', OggInfo::VERSION) do |p|
+  p.rubyforge_name = 'ruby-ogginfo'
+  p.author = 'Guillaume Pierronnet'
+  p.email = 'moumar@rubyforge.org'
+  p.summary = 'ruby-ogginfo is a pure-ruby library that gives low level informations on ogg files'
+  p.description = p.paragraphs_of('README.txt', 3).first
+  p.url = p.paragraphs_of('README.txt', 1).first
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.remote_rdoc_dir = ''
+end
+
+# vim: syntax=Ruby

data/lib/ogginfo.rb

@@ -0,0 +1,145 @@
+# $Id: ogginfo.rb 36 2008-03-15 01:01:51Z moumar $
+#
+# see http://www.xiph.org/ogg/vorbis/docs.html for documentation on vorbis format
+# http://www.xiph.org/ogg/vorbis/doc/v-comment.html
+
+require "iconv"
+
+class Hash 
+   ### lets you specify hash["key"] as hash.key
+   ### this came from CodingInRuby on RubyGarden
+   ### http://www.rubygarden.org/ruby?CodingInRuby 
+   def method_missing(meth,*args) 
+     if /=$/=~(meth=meth.id2name) then
+       self[meth[0...-1]] = (args.length<2 ? args[0] : args)
+     else
+       self[meth]
+     end
+   end
+end
+					    
+# Raised on any kind of error related to ruby-ogginfo
+class OggInfoError < StandardError ; end
+
+class OggInfo
+  VERSION = "0.3"
+  attr_reader :channels, :samplerate, :bitrate, :nominal_bitrate, :length
+  
+  # +tag+ is a hash containing the vorbis tag like "Artist", "Title", and the like
+  attr_reader :tag
+
+  # create new instance of OggInfo, using +charset+ to convert tags to
+  def initialize(filename, charset = "iso-8859-1")
+    @file = File.new(filename, "rb")
+    if charset !~ /^utf-?8$/i
+      @ic = Iconv.new(charset, "utf8")
+    end
+
+    find_next_page
+    extract_infos
+    find_next_page
+    extract_tag(charset)
+    @saved_tag = @tag.dup
+    extract_end
+    @bitrate = @file.stat.size.to_f*8/@length
+  end
+
+  # "block version" of ::new()
+  def self.open(*args)
+    m = self.new(*args)
+    ret = nil
+    if block_given?
+      begin
+        ret = yield(m)
+      ensure
+        m.close
+      end
+    else
+      ret = m
+    end
+    ret
+  end
+
+  # write any tags to file
+  def close
+    @ic.close
+    @file.close if @file and not @file.closed?
+    if @tag != @saved_tag
+      cmd = %w{vorbiscomment -w} 
+
+      @tag.each do |k,v|
+        cmd.concat(["-t", k.upcase+"="+v])
+      end
+      cmd << @file.path
+      system(*cmd)
+    end
+  end
+
+  # check the presence of a tag
+  def hastag?
+    !@tag.empty?
+  end
+  
+  def to_s
+    "channels #{@channels} samplerate #{@samplerate} bitrate #{@nominal_bitrate} bitrate #{@bitrate} length #{@length} #{@tag.inspect}"
+  end
+
+private
+  def find_next_page
+    header = 'OggS' # 0xf4 . 0x67 . 0x 67 . 0x53
+    bytes = @file.read(4)
+    bytes_read = 4
+
+    while header != bytes
+      #raise OggInfoError if bytes_read > 4096 or @file.eof? #bytes.nil?
+      raise OggInfoError if @file.eof? #bytes.nil?
+      bytes.slice!(0)
+      char = @file.read(1)
+      bytes_read += 1
+      bytes << char
+    end
+  end
+
+  def extract_infos
+    @file.seek(35, IO::SEEK_CUR) # seek after "vorbis"
+    @channels, @samplerate, up_br, @nominal_bitrate, down_br = @file.read(17).unpack("CV4")
+    if @nominal_bitrate == 0
+      if up == 2**32 - 1 or down == 2**32 - 1 
+	@nominal_bitrate = 0
+      else
+	@nominal_bitrate = (up_br + down_br)/2
+      end
+    end
+  end
+
+  def extract_tag(charset)
+    @tag = {}
+    @file.seek(22, IO::SEEK_CUR)
+    segs = @file.read(1).unpack("C")[0]
+    @file.seek(segs + 7, IO::SEEK_CUR)
+    size = @file.read(4).unpack("V")[0]
+    @file.seek(size, IO::SEEK_CUR)
+    tag_size = @file.read(4).unpack("V")[0]
+
+    tag_size.times do |i|
+      size = @file.read(4).unpack("V")[0]
+      comment = @file.read(size)
+      if @ic
+        comment = @ic.iconv( com ) rescue comment
+      end
+      key, val = comment.split(/=/)
+      @tag[key.downcase] = val
+    end
+  end
+
+  def extract_end
+    begin #Errno::EINVAL
+      @file.seek(-5000, IO::SEEK_END) #FIXME size of seeking
+      find_next_page
+      pos = @file.read(6).unpack("x2 V")[0] #FIXME pos is int64
+      @length = pos.to_f / @samplerate
+    rescue Errno::EINVAL
+      @length = 0
+    end
+  end
+end

data/test/test_ruby-ogginfo.rb

@@ -0,0 +1,151 @@
+#!/usr/bin/ruby -w
+
+$:.unshift("lib/")
+
+require "test/unit"
+require "ogginfo"
+require "fileutils"
+require "tempfile"
+
+VALID_OGG = <<EOF
+T2dnUwACAAAAAAAAAADjoIphAAAAAIDpYLkBHgF2b3JiaXMAAAAAAkSsAAAA
+AAAAAPoAAAAAAAC4AU9nZ1MAAAAAAAAAAAAA46CKYQEAAACKbpIfEC3/////
+/////////////8EDdm9yYmlzHQAAAFhpcGguT3JnIGxpYlZvcmJpcyBJIDIw
+MDcwNjIyAAAAAAEFdm9yYmlzIUJDVgEAAAEAGGNUKUaZUtJKiRlzlDFGmWKS
+SomlhBZCSJ1zFFOpOdeca6y5tSCEEBpTUCkFmVKOUmkZY5ApBZlSEEtJJXQS
+OiedYxBbScHWmGuLQbYchA2aUkwpxJRSikIIGVOMKcWUUkpCByV0DjrmHFOO
+SihBuJxzq7WWlmOLqXSSSuckZExCSCmFkkoHpVNOQkg1ltZSKR1zUlJqQegg
+hBBCtiCEDYLQkFUAAAEAwEAQGrIKAFAAABCKoRiKAoSGrAIAMgAABKAojuIo
+jiM5kmNJFhAasgoAAAIAEAAAwHAUSZEUybEkS9IsS9NEUVV91TZVVfZ1Xdd1
+Xdd1IDRkFQAAAQBASKeZpRogwgxkGAgNWQUAIAAAAEYowhADQkNWAQAAAQAA
+Yig5iCa05nxzjoNmOWgqxeZ0cCLV5kluKubmnHPOOSebc8Y455xzinJmMWgm
+tOaccxKDZiloJrTmnHOexOZBa6q05pxzxjmng3FGGOecc5q05kFqNtbmnHMW
+tKY5ai7F5pxzIuXmSW0u1eacc84555xzzjnnnHOqF6dzcE4455xzovbmWm5C
+F+eccz4Zp3tzQjjnnHPOOeecc84555xzgtCQVQAAEAAAQRg2hnGnIEifo4EY
+RYhpyKQH3aPDJGgMcgqpR6OjkVLqIJRUxkkpnSA0ZBUAAAgAACGEFFJIIYUU
+UkghhRRSiCGGGGLIKaecggoqqaSiijLKLLPMMssss8wy67CzzjrsMMQQQwyt
+tBJLTbXVWGOtueecaw7SWmmttdZKKaWUUkopCA1ZBQCAAAAQCBlkkEFGIYUU
+UoghppxyyimooAJCQ1YBAIAAAAIAAAA8yXNER3RER3RER3RER3REx3M8R5RE
+SZRESbRMy9RMTxVV1ZVdW9Zl3fZtYRd23fd13/d149eFYVmWZVmWZVmWZVmW
+ZVmWZVmC0JBVAAAIAACAEEIIIYUUUkghpRhjzDHnoJNQQiA0ZBUAAAgAIAAA
+AMBRHMVxJEdyJMmSLEmTNEuzPM3TPE30RFEUTdNURVd0Rd20RdmUTdd0Tdl0
+VVm1XVm2bdnWbV+Wbd/3fd/3fd/3fd/3fd/3dR0IDVkFAEgAAOhIjqRIiqRI
+juM4kiQBoSGrAAAZAAABACiKoziO40iSJEmWpEme5VmiZmqmZ3qqqAKhIasA
+AEAAAAEAAAAAACia4imm4imi4jmiI0qiZVqipmquKJuy67qu67qu67qu67qu
+67qu67qu67qu67qu67qu67qu67qu67ouEBqyCgCQAADQkRzJkRxJkRRJkRzJ
+AUJDVgEAMgAAAgBwDMeQFMmxLEvTPM3TPE30RE/0TE8VXdEFQkNWAQCAAAAC
+AAAAAAAwJMNSLEdzNEmUVEu1VE21VEsVVU9VVVVVVVVVVVVVVVVVVVVVVVVV
+VVVVVVVVVVVVVVVVVVU1TdM0TSA0ZCUAEAUAADpLLdbaK4CUglaDaBBkEHPv
+kFNOYhCiYsxBzEF1EEJpvcfMMQat5lgxhJjEWDOHFIPSAqEhKwSA0AwAgyQB
+kqYBkqYBAAAAAAAAgORpgCaKgCaKAAAAAAAAACBpGqCJIqCJIgAAAAAAAAAA
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+AAAAAAAAAAAAAAAAAAAAkqYBnikCmigCAAAAAAAAgCaKgGiqgKiaAAAAAAAA
+AKCJIiCqIiCaKgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAkqYBmigCnigCAAAA
+AAAAgCaKgKiagCiqAAAAAAAAAKCJJiCaKiCqJgAAAAAAAAAAAAAAAAAAAAAA
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+AAAAAAAAAAAAAAAAgAAAgAAHAIAAC6HQkBUBQJwAgMFxLAsAABxJ0iwAAHAk
+S9MAAMDSNFEEAABL00QRAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAMCAAwBAgAll
+oNCQlQBAFACAQTE8DWBZAMsCaBpA0wCeB/A8gCgCAAEAAAUOAAABNmhKLA5Q
+aMhKACAKAMCgKJZlWZ4HTdM0UYSmaZooQtM0TxShaZomihBFzzNNeKLnmSZM
+UxRNE4iiaQoAAChwAAAIsEFTYnGAQkNWAgAhAQAGR7EsT/M8zxNF01RVaJrn
+iaIoiqZpqio0zfNEURRN0zRVFZrmeaIoiqapqqoKTfM8URRF01RVVYXniaIo
+mqZpqqrrwvNEURRN0zRV1XUhiqJomqapqqrrukAUTdM0VVVVXReIommapqq6
+riwDUTRN01RV15VlYJqqqqqq67qyDFBNVVVV15VlgKq6quu6riwDVFV1XdeV
+ZRnguq7ryrJs2wBc13Vl2bYFAAAcOAAABBhBJxlVFmGjCRcegEJDVgQAUQAA
+gDFMKaaUYUxCKCE0ikkIKYRMSkqplVRBSCWlUioIqaRUSkalpZRSyiCUUlIq
+FYRUSiqlAACwAwcAsAMLodCQlQBAHgAAQYhSjDHGnJRSKcacc05KqRRjzjkn
+pWSMMeeck1IyxphzzkkpHXPOOeeklIw555xzUkrnnHPOOSmllM4555yUUkoI
+nXNOSimlc845JwAAqMABACDARpHNCUaCCg1ZCQCkAgAYHMeyNE3TPE8UNUnS
+NM/zPFE0TU2yNM3zPE8UTZPneZ4oiqJpqirP8zxRFEXTVFWuK4qmaZqqqqpk
+WRRF0TRVVXVhmqapqqrqujBNUVRV1XVdyLJpqqrryjJs2zRV1XVlGaiqqsqu
+LAPXVVXXlWUBAOAJDgBABTasjnBSNBZYaMhKACADAIAgBCGlFEJKKYSUUggp
+pRASAAAw4AAAEGBCGSg0ZEUAECcAACAkpYJOSiWhlFJKKaWUUkoppZRSSiml
+lFJKKaWUUkoppZRSSimllFJKKaWUUkoppZRSSimllFJKKaWUUkoppZRSSiml
+lFJKKaWUUkoppZNSSimllFJKKaWUUkoppZRSSimllFJKKaWUUkoppZRSSiml
+lFJKKaWUUkoppZSSUkoppZRSSimllFJKKaWUUkoppZRSSimllFJKKaWUUkkp
+pZRSSimllFJKKaWUUkoppZRSSimllFJKKaWUUkoppZRSSimllFJKKaWUUkop
+pZRSSimllFJKKaWUUkoppZRSSimllFJKKaWUUkoppZRSSimllFJKKaWUUkop
+pZRSSimllFJKKaWUUkoppZRSSimllFJKKaWUUkoppZRSSimllFJKKaWUUkop
+pZRSSimllFJKKaWUUkoppZRSSimllFJKKaWUUkoppZRSSimllFJKKaWUUkop
+pZRSSimllFJKKaWUUkoppZRSSimllFJKKaWUUkoppZRSSimllFJKKaWUUkop
+pZRSSimllAoA0I1wANB9MKEMFBqyEgBIBQAAjFGKMQipxVYhxJhzElprrUKI
+MecktJRiz5hzEEppLbaeMccglJJai72UzklJrbUYeyodo5JSSzH23kspJaXY
+Yuy9p5BCji3G2HvPMaUWW6ux915jSrHVGGPvvfcYY6ux1t577zG2VmuOBQBg
+NjgAQCTYsDrCSdFYYKEhKwGAkAAAwhilGGPMOeecc05KyRhzzkEIIYQQSikZ
+Y8w5CCGEEEIpJWPOOQchhFBCKKVkzDnoIIRQQiillM45Bx2EEEIJpZSSMecg
+hBBCCaWUUjrnIIQQQiilhFRKKZ2DEEIoIYRSSkkphBBCCKGEUFIpKYUQQggh
+hFBCSiWlEEIIIYQQSkilpJRSCCGEEEIIpZSUUgollBBCKKGkkkoppYQQSgih
+pFRSKqmUEkIIJYSSSkoplVRKKCGEUgAAwIEDAECAEXSSUWURNppw4QEoNGQl
+ABAFAAAZBx2UlhuAkHLUWocchBRbC5FDDFqMnXKMQUopZJAxxqSVkkLHGKTU
+YkuhgxR7z7mV1AIAACAIAAgwAQQGCAq+EAJiDABAECIzREJhFSwwKIMGh3kA
+8AARIREAJCYo0i4uoMsAF3Rx14EQghCEIBYHUEACDk644Yk3POEGJ+gUlToQ
+AAAAAIAFAHgAAEAogIiIZq7C4gIjQ2ODo8PjA0QAAAAAALAA4AMAAAkBIiKa
+uQqLC4wMjQ2ODo8PkAAAQAABAAAAABBAAAICAgAAAAAAAQAAAAICT2dnUwAE
+AAAAAAAAAADjoIphAgAAAIr86XUBAQA=
+====
+EOF
+
+class OggInfoTest < Test::Unit::TestCase
+
+  TEMP_FILE = File.join(Dir.tmpdir, "test_mp3info.ogg")
+
+  def setup
+    valid_ogg_file = VALID_OGG.unpack("m*").first
+    File.open(TEMP_FILE, "w") { |f| f.write(valid_ogg_file) }
+  end
+
+  def teardown
+    FileUtils.rm_f(TEMP_FILE)
+  end
+
+  def test_infos
+    OggInfo.open(TEMP_FILE) do |ogg|
+      assert_equal 64000, ogg.nominal_bitrate
+      assert_equal 2, ogg.channels
+      assert_equal 44100, ogg.samplerate
+      assert_equal 0, ogg.length
+      #average_bitrate
+    end
+  end
+
+  def test_length
+    generate_ogg
+    OggInfo.open("test.ogg") do |ogg|
+      assert_in_delta(17.0, ogg.length, 1)
+      assert_in_delta(67000.0, ogg.bitrate, 5000)
+    end
+  end
+
+  def test_tag_writing
+    generate_ogg
+    tag = {"title" => "mytitle", "artist" => "myartist" }
+    OggInfo.open("test.ogg") do |ogg|
+      tag.each { |k,v| ogg.tag[k] = v }
+    end
+
+    OggInfo.open("test.ogg") do |ogg|
+      assert_equal tag, ogg.tag
+    end
+  end
+
+  def generate_ogg
+    unless test(?f, "test.ogg")
+      system("dd if=/dev/urandom bs=1024 count=3000 | oggenc -q0 --raw -o test.ogg -") or
+        flunk("cannot generate \"test.ogg\", tests cannot be fully performed")
+    end
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-ogginfo
+version: !ruby/object:Gem::Version 
+  version: "0.3"
+platform: ruby
+authors: 
+- Guillaume Pierronnet
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-03-15 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+    version: 
+description: ruby-ogginfo gives you access to low level information on ogg files (bitrate, length, samplerate, encoder, etc... ), as well as tag. It is written in pure ruby.
+email: moumar@rubyforge.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/ogginfo.rb
+- test/test_ruby-ogginfo.rb
+has_rdoc: true
+homepage: http://ruby-ogginfo.rubyforge.org/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: ruby-ogginfo
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: ruby-ogginfo is a pure-ruby library that gives low level informations on ogg files
+test_files: 
+- test/test_ruby-ogginfo.rb