ruby-ogginfo 0.4.2 → 0.5

data/History.txt

@@ -1,3 +1,7 @@
+=== 0.5 / 2011-01-13
+
+* speex support (thanks to Grant Gardner)
+
 === 0.4.2 / 2010-03-13
 
 * bugfix on frame parsing

data/Manifest.txt

@@ -1,6 +1,6 @@
 History.txt
 Manifest.txt
-README.txt
+README.rdoc
 Rakefile
 setup.rb
 lib/ogginfo.rb

data/{README.txt → README.rdoc}

@@ -1,6 +1,7 @@
 = ruby-ogginfo
 
 http://ruby-ogginfo.rubyforge.org/
+https://github.com/moumar/ruby-ogginfo
 
 == DESCRIPTION:
 

data/Rakefile

@@ -2,6 +2,9 @@
 
 require 'rubygems'
 require 'hoe'
+
+Hoe.plugin :yard
+
 require 'lib/ogginfo.rb'
 
 Hoe.new('ruby-ogginfo', OggInfo::VERSION) do |p|
@@ -9,10 +12,11 @@ Hoe.new('ruby-ogginfo', OggInfo::VERSION) do |p|
   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.description = p.paragraphs_of('README.rdoc', 3).first
+  p.url = p.paragraphs_of('README.rdoc', 1).first
   p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
   p.remote_rdoc_dir = ''
+  p.rdoc_locations << "rubyforge.org:/var/www/gforge-projects/ruby-ogginfo/"
 end
 
 # vim: syntax=Ruby

data/lib/ogginfo.rb

@@ -23,7 +23,7 @@ end
 class OggInfoError < StandardError ; end
 
 class OggInfo
-  VERSION = "0.4.2"
+  VERSION = "0.5"
   CHECKSUM_TABLE = [
     0x00000000,0x04c11db7,0x09823b6e,0x0d4326d9,
     0x130476dc,0x17c56b6b,0x1a864db2,0x1e475005,
@@ -103,7 +103,7 @@ class OggInfo
     @file = File.new(@filename, "rb")
 
     frames = (1..2).collect { |i| OggInfo.read_frame(@file) }
-    extract_vorbis_infos(frames[0])
+    extract_bitstream_infos(frames[0])
     extract_tag(frames[1])
     convert_tag_charset("utf-8", @charset)
     @original_tag = @tag.dup
@@ -130,7 +130,7 @@ class OggInfo
 
   # commits any tags to file
   def close
-    if @tag != @original_tag
+    if @bitstream_format == "vorbis" && @tag != @original_tag
       cmd = %w{vorbiscomment -w} 
       convert_tag_charset(@charset, "utf-8")
 
@@ -202,20 +202,45 @@ class OggInfo
   end
 
 private
+  def extract_bitstream_infos(frame)
+     @file.seek(frame[:file_position] + frame[:header_size] + 1)
+     @bitstream_format = @file.read(6).rstrip()
+     case @bitstream_format
+	when "vorbis" : extract_vorbis_infos(frame)
+        when "peex"  :
+             #Speex does not align itself to a 4 byte boundary.
+             @bitstream_format="Speex" 
+             extract_speex_infos(frame)
+        else raise(OggInfoError,"Unknown bitstream format #{@bitstream_format}") 
+     end
+  end
+
+  def extract_speex_infos(frame)
+    @file.seek(frame[:file_position] + frame[:header_size] ) 
+    speex_string,speex_version,speex_version_id,header_size,@samplerate,mode,mode_bitstream_version,
+         @channels,bitrate,framesize,vbr = @file.read(28+ 9 * 4).unpack("A8A20VVVVVVVVV")
+    #not sure how to make sense of the bitrate info,picard doesn't show it either...
+  end
+
   def extract_vorbis_infos(frame)
-    @file.seek(frame[:file_position] + frame[:header_size] + 1 ) # seek after "vorbis"
+    @file.seek(frame[:file_position] + frame[:header_size] + 1 ) 
+    
     vorbis_string, vorbis_version, @channels, @samplerate, upper_bitrate, @nominal_bitrate, lower_bitrate = @file.read(27).unpack("a6VCV4")
     if @nominal_bitrate == 0
       if upper_bitrate == 2**32 - 1 or lower_bitrate == 2**32 - 1 
 	@nominal_bitrate = 0
       else
 	@nominal_bitrate = (upper_bitrate + lower_bitrate)/2
-      end
+      end 
     end
   end
 
   def extract_tag(frame)
-    @file.seek(frame[:file_position] + frame[:header_size] + 1 + "vorbis".size)
+    @file.seek(frame[:file_position] + frame[:header_size] )
+    # GG: Vorbis includes a preamble "vorbis", which is not included in the comments,
+    # but is definitely in the /libvorbis/lib/info.c _vorbis_pack_comment reference implementation.
+    # Speex does not seem to include this preamble.
+    @file.read(7) if @bitstream_format=="vorbis"
     vendor_length = @file.read(4).unpack("V").first
     @vendor = @file.read(vendor_length)
 

data/test/test_ruby-spxinfo.rb

@@ -0,0 +1,105 @@
+#!/usr/bin/ruby -w
+
+$:.unshift("lib/")
+
+require "test/unit"
+require "ogginfo"
+require "fileutils"
+require "tempfile"
+
+VALID_SPX = <<EOF
+T2dnUwACAAAAAAAAAACqcIpSAAAAACW1TjsBUFNwZWV4ICAgMS4ycmMxAAAAAAAAAAAAAAAAAAAB
+AAAAUAAAAAB9AAACAAAABAAAAAEAAAD/////gAIAAAAAAAABAAAAAAAAAAAAAAAAAAAAT2dnUwAA
+AAAAAAAAAACqcIpSAQAAAAaUXjQBSxkAAABFbmNvZGVkIHdpdGggU3BlZXggMS4ycmMxAgAAAA8A
+AABhdXRob3I9Y2l0eXJhaWwTAAAAdGl0bGU9RG9vcnMgQ2xvc2luZ09nZ1MABIM8AAAAAAAAqnCK
+UgIAAACs/BhtGVpaWlpaWlpaWlpaWlpaWlpaWlpaWlpaWlo/LBCTVAAAf///////////////i2H/
+///OGC3////nG75DPcWTvggVlVgByTX64iZe1BJJMRxHB9vi/RftG5IUq6urq6tKurjXCNDzq6ur
+qwq6urq6uTlH0FA/I4CCsFD3pMfLaX0RKpFyM8eoKYP4zLwTgnZlljnemINUXb1SGR4FIzdiIc3G
+HzbqwWpucYfpo9cdbMMEO7igq6urq6sKurq6urCrq6urqwq0JWwquTvXtgo4N4QmT3p3VizFtbRM
+cHVzHbFu7juLE5SnW6msiMbKC5gRL5VgOWuKE4KQ6h699dPu4GYIbS+kV5OUlu8em7sAq6vJwsIG
+29q6urCr1o4zPQq6vCqw2TvWKQ0/O5iMT0pLqPkTlvT3hR12RWke5BNI7zWf73HrSShkBWVy7Nsx
+dXqlViElJDMqtVpm3wYeSn7LN7Hy4v1BCztwq0Lrq6sEKNycInDCPQQOlAzSerScmZNkLOY/IvKD
+T2N3fMZLtqMC9gnTHl1cxFteffTF6vsZnYCbb7+zGdfILJxXVm8HszByXEYe1+bjpDxsuYOdhryv
+a7tgq0KNq8IIg9SfVWBCp40NjgPUKrz22Tq1lSo/O9KHTrN3OciTNddv2MIs8JCngQWwEufvTFkr
+J2StA2PL/LUyjpjfTfKo1TgiBgYm0WJSdK55CIXxM2HQ27tgjjingEkMJJuKu9BCq6snwgQsmrq4
+2TvUIQg4Of/CrYK/SkX9mvlyA+SmNCISQR2lTZ/kkq4wKmJNFiBYj4K3PLXGX0PEaq8pdnYO4G+8
+vjjjmCQdiX6dazlAPdarq6sKtNPcKNDrPcLCsAuKdtPcmbv0rdE/KDqHTDkHSWMp3lwcTGKhkTmM
+15tFCvwB9GLwk6nUkRaJmcIQXzd2oMJfVgeDwWXg6oSSP4kXJ2VAJgKFu7tAzHPtOmsKvJPdJ3BC
+q5RCqwjuu4jg2TnVLUY/Oza+kE81bl7zil4RSXxtlLGxr+c8QtY5qwkOLY9kv0EAm7JWKuj3FUIQ
+xMLTSe3natG74KeDDjsG3Hk5S7lASe2Ozy0KvJDQ6rCrq729yQwqurq6uTnTHQg/M8uekm+ZwBjp
+v4fnu1mzCmy0vI9IT79Cl5+WnlBMaOxduKoIzd38ijwcmuOPjCvX/ViQfDRJGfxCVZkMGzvwq6ur
+wqsKurq6urCrq6urqwq6urq6uTsSDCA8xHJBkS63Zxn3NziC6jupXqH58OHantmdQnEeMMN4N9bA
+gsIkkJUDtOGTPXVzA3iO5K85YHb22D756xttK7pQq6urqw0Kurq8KrDWq6urqwq0mrvcmTnRCIU8
+xHJCsPk7yToKMJN43YTSxG6Zy09HsLwU94uwMa4sYxbqzdXAtywFHGUFIytG9SGU4eG5ecNqUjzD
+SblsW7lAq6urJ6sEmrq1ZCCrDsmrwgwqurwg2TnSmOo8w93dT403yWxyVJ1+waPCCsSF2KtfDsAd
+CycuvpDeDEsbftaCwxGXmDNh2CWxi3du6JORWeQvU/OUqUDTm/lQyavCSasA1JzaurAOq6sNDgq6
+urq6uTmEHMo6f67rjvX7GRjz4As9XGgu6FsN31u5CMKtCEwaaNmnWnxbcttu3zjh5TglokHjVAiW
+2eKBKTPtSGM3QNvCe7rwjdaOjqsCeOzY6yDtwhz4CgzRy4wA2TnDIOk/2N3azM83YP7ZZouPrujR
+d+YgiEPSq7ZyL6ayBAJwUH1rYcRax/BHU55OGpWVI6Hm5sZmfPfqK6hzNALJm7sQ4w7tqw0L04yb
+ANDC+sIEtwjQ2OqxyZAjGKs5z0mZd38cTtkZJTyJnd+IKuxX4n3//t3jkcyO+C3c6fi3c23GPBff
+eWh5FhOzhooqy+WaA6frD1LiisPnG99gq6urqw46vCrr2rCrq6urqwuDi4q8KZM/g/E/KhCTVE03
+hO/5YXsRKNpdLPAsKKuuuc6wjgyBXfYUxWdl/pN9TBgdVvcw8GZ8JxVg0TPuMcJf95jFSQEUe7sQ
+jatCq6sKtCq464AAsg7rHAjQ4Nq/ORGITQs/Ij33U63zbSfUhr49L4clLH5sLYe9qwfYwOcMBtYU
+0vxuTYPzJfs/Ip2iKa8Gv464Z9mEq4IxK40o48uVK7hwVhw4JzgMO9jS34D4bXcJ8wx59j4nGRJW
+wnU9xAFlUmtH3zfy8Pwc3J/xnexI5ruEtSq25kLICJjQFTSe49yckXBVZO2Ok7oikQvv39DWPlJn
+c6Nn1vkN6/hQeOlvXnENoKk0OUA8yR91LQOOttja2ZDaVlY9xG8Esrq2yYA3fZPj6eFRleBGOOGS
+0HqSSR2y6BNVHwm/8NeyothnkX5tS0AEHyam0vFaJGwTpdhsclgJC7rA673fvRQO0O+AE0CElE8B
+HAnZ+Aw1mZNpwck9yW0xci3zSQCc9IOdPMLiH3huuzdUqfW6KITMF9CAMlhbX7vt3XHHvEhwCYgB
+IeWe2rotzxcdeOxQJsUMO7hwsIAO+lQWppkj1OANjbGrjgANkDz5yZNmJcw9yW80knQ7ZshyNd9G
+wpeIWpSnZJtIqyLzxGWrhMmPzfCsPbVzRyhF0F8yKure2rj+QLlK8whLdvv/wI08izqgQieK7QQE
+DWOHrCBCwhS3CwJ6vtNw2ZP3KY49xG8xcnWbKbCsh81M+SHdogx54TOZLLrLk/Q1diUSvnUecNUH
+05hhJYYIaLjjJm+T1HBBhBdJxf4M11GQu7mQeo5CPdoCdpuKuCB+AI687QqXQcMqCZP1ujM9zW00
+cjD29VyXsTQpwgSpMX1GlPmWYZHqH5FRBn7MaFrZB6hxHUHAkJHBE0b9sO9r5+RHDa2bVW42ZOM3
+67sxThNW9dQAtNp4Q0AO1k7JbQFNlWnK2ZNpxm89zS5EEiL3dfSTlisoTdwFc8K9XzuDv2UDqvqO
+WkL94EdrPdfVa/z/+dBw1ckmuSfIiSzOJ3NxJmvqrelDG7swgEl06/gJSrjtaUTt1NC9qxvaurq6
+uTv3X00=
+EOF
+
+class SpxInfoTest < Test::Unit::TestCase
+
+  TEMP_FILE = File.join(Dir.tmpdir, "test.spxinfo.spx")
+
+  def setup
+    valid_spx_file = VALID_SPX.unpack("m*").first
+    File.open(TEMP_FILE, "w") { |f| f.write(valid_spx_file) }
+  end
+
+  def teardown
+    FileUtils.rm_f(TEMP_FILE)
+  end
+
+  def test_infos
+    OggInfo.open(TEMP_FILE) do |spx|
+      assert_equal 1, spx.channels
+      assert_equal 32000, spx.samplerate
+      assert_in_delta(0.5, spx.length, 1)
+    end
+  end
+
+  def test_generated_info
+    generate_spx
+    OggInfo.open("test.spx") do |spx|
+      assert_equal 2, spx.channels
+      assert_equal 44100, spx.samplerate
+    end
+  end
+
+
+  def test_charset
+    generate_spx
+    OggInfo.open("test.spx", "utf-8") do |spx|
+      assert_equal "spxinfotest", spx.tag["author"]
+    end
+
+    OggInfo.open("test.spx", "iso-8859-1") do |spx|
+      assert_equal "hello\xe9", spx.tag["test"] 
+    end
+  end
+
+  def generate_spx
+    unless test(?f, "test.spx")
+      system("dd if=/dev/urandom bs=1024 count=3000 | speexenc --rate 44100 --stereo --author spxinfotest --title SpxInfoTest --comment test=\"hello\303\251\" - test.spx") or
+        flunk("cannot generate \"test.spx\", tests cannot be fully performed")
+    end
+  end
+end

metadata

@@ -1,7 +1,11 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-ogginfo
 version: !ruby/object:Gem::Version 
-  version: 0.4.2
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  version: "0.5"
 platform: ruby
 authors: 
 - Guillaume Pierronnet
@@ -9,19 +13,37 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-13 00:00:00 +01:00
+date: 2011-01-13 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: hoe
+  name: hoe-yard
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 2
+        version: 0.1.2
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.9.0
-    version: 
+        segments: 
+        - 2
+        - 8
+        - 0
+        version: 2.8.0
+  type: :development
+  version_requirements: *id002
 description: |-
   ruby-ogginfo gives you access to low level information on ogg files
   (bitrate, length, samplerate, encoder, etc... ), as well as tag.
@@ -34,43 +56,48 @@ extensions: []
 extra_rdoc_files: 
 - History.txt
 - Manifest.txt
-- README.txt
 files: 
 - History.txt
 - Manifest.txt
-- README.txt
+- README.rdoc
 - Rakefile
 - setup.rb
 - lib/ogginfo.rb
 - test/test_ruby-ogginfo.rb
-has_rdoc: true
-homepage: http://ruby-ogginfo.rubyforge.org/
+has_rdoc: yard
+homepage: |
+  http://ruby-ogginfo.rubyforge.org/
+
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --main
-- README.txt
+- --title
+- RubyOgginfo Documentation
+- --quiet
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: ruby-ogginfo
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: ruby-ogginfo is a pure-ruby library that gives low level informations on ogg files
 test_files: 
 - test/test_ruby-ogginfo.rb
+- test/test_ruby-spxinfo.rb