ruby-ogg 0.0.1 → 0.0.3

data/.gitignore

@@ -0,0 +1,8 @@
+doc/
+html/
+coverage/
+pkg/
+html/
+.yardoc/
+*~
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# This gem's dependencies are specified in ruby-ogg.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,71 @@
+= ruby-ogg
+
+== Synopsis
+
+ruby-ogg brings pure Ruby love to the Ogg container format. It provides
+a nice abstraction which permits you to access packets from an Ogg bitstream
+without worrying about strange things such as "captures" and "pages".
+For more information about Ogg bitstreams check out the blog post at
+http://dismaldenizen.wordpress.com/2010/08/20/the-ogg-container-format-explained
+
+ require 'ogg'
+ 
+ open("file.ogg", "rb") do |file|
+   dec = Ogg::Decoder.new(file) # Create a decoder for an Ogg file
+   packet = dec.read_packet     # Direct access to packet, no pages!
+   # Do something with the packet...
+ end
+
+== Vorbis
+
+Vorbis is not the same as Ogg. Vorbis is an audio codec which is commonly
+packed in the Ogg container format with the file extension ".ogg". Because
+Vorbis has become so deeply associated with Ogg (and I'm such a nice guy), a 
+Vorbis metadata decoder is bundled with ruby-ogg. This provides
+a good example of how to use ruby-ogg, and is also fully functional. See the 
+Vorbis::Info documentation for more information.
+
+ require 'vorbis'
+ 
+ Vorbis::Info.open('echoplex.ogg') do |info|
+   info.comments[:artist].first #=> "Nine Inch Nails"
+   info.comments[:title].first  #=> "Echoplex"
+   info.sample_rate             #=> 44100
+ end
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+ gem 'ruby-ogg'
+
+And then execute:
+
+ $ bundle
+
+Or install it yourself as:
+
+ $ gem install ruby-ogg
+
+== Requirements
+
+* Ruby 1.8+
+* RubyGems
+
+== Features
+
+* 100% pure Ruby
+* Read Ogg bitstreams
+* Read Vorbis metadata
+* Optionally validate page integrity with CRCs
+  (eg <code>Ogg::Decoder.new(file, :verify_checksum => true)</code>)
+
+== TODO
+
+* Write Ogg bitstreams
+* Write Vorbis metadata
+
+== Links
+
+* Bug reports: http://github.com/anibali/ruby-ogg/issues
+* Documentation: http://rdoc.info/github/anibali/ruby-ogg/master/frames

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "yard"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/tc_*.rb']
+  t.verbose = true
+end
+
+YARD::Rake::YardocTask.new

data/lib/ogg.rb

@@ -1,4 +1,4 @@
-require 'rubygems'
+$VERBOSE = false # Suppresses some BinData warnings.
 require 'bindata'
 
 require 'stringio'
@@ -32,10 +32,20 @@ module Ogg
   # unnecessary. However, if you do need to read pages, that functionality is 
   # available via the read_page method.
   class Decoder
+    # This property determines whether the integrity of pages should be checked
+    # using CRCs (a lot slower but more robust).
+    attr_accessor :verify_checksum
+    
     # Create a new Decoder from an IO which should be open for binary reading.
-    def initialize io
+    def initialize io, opts={}
       @io = io
       @packets = []
+      
+      opts = {
+        :verify_checksum => false,
+      }.merge!(Hash[opts.map {|k, v| [k.to_s.downcase.to_sym, v]}])
+      
+      @verify_checksum = opts[:verify_checksum]
     end
     
     # Moves the file cursor forward to the next potential page. You probably
@@ -63,7 +73,7 @@ module Ogg
         begin
           seek_to_page
           page = Page.read @io
-          page = nil unless page.verify_checksum
+          page = nil if @verify_checksum and not page.correct_checksum?
           break
         rescue Exception => ex
           # False alarm, keep looking...
@@ -147,11 +157,93 @@ module Ogg
     array    :segment_table, :type => :uint8, :initial_length => :page_segments
     string   :data, :read_length => lambda {segment_table.inject(0){|t,e| t+e}}
     
-    def verify_checksum
+    # Check page data against the header's CRC value.
+    def correct_checksum?
       poly = 0x04c11db7
-      # TODO: Implement CRC
-      return true
+      
+      cs = checksum + 0
+      self.checksum = 0
+      
+      raw = to_binary_s
+      
+      crc_reg = 0;
+      
+      raw.unpack('C*').each do |byte|
+        crc_reg = (crc_reg << 8) ^ CRC_LOOKUP[((crc_reg >> 24) & 0xff) ^ byte]
+        crc_reg %= 2**32
+      end
+      
+      self.checksum = cs
+      
+      return cs == crc_reg
     end
+    
+    # Cached CRC lookup table.
+    CRC_LOOKUP = [
+      0x00000000,0x04c11db7,0x09823b6e,0x0d4326d9,
+      0x130476dc,0x17c56b6b,0x1a864db2,0x1e475005,
+      0x2608edb8,0x22c9f00f,0x2f8ad6d6,0x2b4bcb61,
+      0x350c9b64,0x31cd86d3,0x3c8ea00a,0x384fbdbd,
+      0x4c11db70,0x48d0c6c7,0x4593e01e,0x4152fda9,
+      0x5f15adac,0x5bd4b01b,0x569796c2,0x52568b75,
+      0x6a1936c8,0x6ed82b7f,0x639b0da6,0x675a1011,
+      0x791d4014,0x7ddc5da3,0x709f7b7a,0x745e66cd,
+      0x9823b6e0,0x9ce2ab57,0x91a18d8e,0x95609039,
+      0x8b27c03c,0x8fe6dd8b,0x82a5fb52,0x8664e6e5,
+      0xbe2b5b58,0xbaea46ef,0xb7a96036,0xb3687d81,
+      0xad2f2d84,0xa9ee3033,0xa4ad16ea,0xa06c0b5d,
+      0xd4326d90,0xd0f37027,0xddb056fe,0xd9714b49,
+      0xc7361b4c,0xc3f706fb,0xceb42022,0xca753d95,
+      0xf23a8028,0xf6fb9d9f,0xfbb8bb46,0xff79a6f1,
+      0xe13ef6f4,0xe5ffeb43,0xe8bccd9a,0xec7dd02d,
+      0x34867077,0x30476dc0,0x3d044b19,0x39c556ae,
+      0x278206ab,0x23431b1c,0x2e003dc5,0x2ac12072,
+      0x128e9dcf,0x164f8078,0x1b0ca6a1,0x1fcdbb16,
+      0x018aeb13,0x054bf6a4,0x0808d07d,0x0cc9cdca,
+      0x7897ab07,0x7c56b6b0,0x71159069,0x75d48dde,
+      0x6b93dddb,0x6f52c06c,0x6211e6b5,0x66d0fb02,
+      0x5e9f46bf,0x5a5e5b08,0x571d7dd1,0x53dc6066,
+      0x4d9b3063,0x495a2dd4,0x44190b0d,0x40d816ba,
+      0xaca5c697,0xa864db20,0xa527fdf9,0xa1e6e04e,
+      0xbfa1b04b,0xbb60adfc,0xb6238b25,0xb2e29692,
+      0x8aad2b2f,0x8e6c3698,0x832f1041,0x87ee0df6,
+      0x99a95df3,0x9d684044,0x902b669d,0x94ea7b2a,
+      0xe0b41de7,0xe4750050,0xe9362689,0xedf73b3e,
+      0xf3b06b3b,0xf771768c,0xfa325055,0xfef34de2,
+      0xc6bcf05f,0xc27dede8,0xcf3ecb31,0xcbffd686,
+      0xd5b88683,0xd1799b34,0xdc3abded,0xd8fba05a,
+      0x690ce0ee,0x6dcdfd59,0x608edb80,0x644fc637,
+      0x7a089632,0x7ec98b85,0x738aad5c,0x774bb0eb,
+      0x4f040d56,0x4bc510e1,0x46863638,0x42472b8f,
+      0x5c007b8a,0x58c1663d,0x558240e4,0x51435d53,
+      0x251d3b9e,0x21dc2629,0x2c9f00f0,0x285e1d47,
+      0x36194d42,0x32d850f5,0x3f9b762c,0x3b5a6b9b,
+      0x0315d626,0x07d4cb91,0x0a97ed48,0x0e56f0ff,
+      0x1011a0fa,0x14d0bd4d,0x19939b94,0x1d528623,
+      0xf12f560e,0xf5ee4bb9,0xf8ad6d60,0xfc6c70d7,
+      0xe22b20d2,0xe6ea3d65,0xeba91bbc,0xef68060b,
+      0xd727bbb6,0xd3e6a601,0xdea580d8,0xda649d6f,
+      0xc423cd6a,0xc0e2d0dd,0xcda1f604,0xc960ebb3,
+      0xbd3e8d7e,0xb9ff90c9,0xb4bcb610,0xb07daba7,
+      0xae3afba2,0xaafbe615,0xa7b8c0cc,0xa379dd7b,
+      0x9b3660c6,0x9ff77d71,0x92b45ba8,0x9675461f,
+      0x8832161a,0x8cf30bad,0x81b02d74,0x857130c3,
+      0x5d8a9099,0x594b8d2e,0x5408abf7,0x50c9b640,
+      0x4e8ee645,0x4a4ffbf2,0x470cdd2b,0x43cdc09c,
+      0x7b827d21,0x7f436096,0x7200464f,0x76c15bf8,
+      0x68860bfd,0x6c47164a,0x61043093,0x65c52d24,
+      0x119b4be9,0x155a565e,0x18197087,0x1cd86d30,
+      0x029f3d35,0x065e2082,0x0b1d065b,0x0fdc1bec,
+      0x3793a651,0x3352bbe6,0x3e119d3f,0x3ad08088,
+      0x2497d08d,0x2056cd3a,0x2d15ebe3,0x29d4f654,
+      0xc5a92679,0xc1683bce,0xcc2b1d17,0xc8ea00a0,
+      0xd6ad50a5,0xd26c4d12,0xdf2f6bcb,0xdbee767c,
+      0xe3a1cbc1,0xe760d676,0xea23f0af,0xeee2ed18,
+      0xf0a5bd1d,0xf464a0aa,0xf9278673,0xfde69bc4,
+      0x89b8fd09,0x8d79e0be,0x803ac667,0x84fbdbd0,
+      0x9abc8bd5,0x9e7d9662,0x933eb0bb,0x97ffad0c,
+      0xafb010b1,0xab710d06,0xa6322bdf,0xa2f33668,
+      0xbcb4666d,0xb8757bda,0xb5365d03,0xb1f740b4].freeze
   end
 end
 

data/lib/ruby-ogg/version.rb

@@ -0,0 +1,3 @@
+module Ogg
+  VERSION = "0.0.3"
+end

data/lib/vorbis.rb

@@ -1,4 +1,3 @@
-require 'rubygems'
 require 'bindata'
 
 module Vorbis
@@ -107,8 +106,6 @@ module Vorbis
   # A BinData::BasePrimitive which represents a list of comments as per 
   # the Vorbis I comment header specification.
   class Comments < BinData::BasePrimitive
-    register(self.name, self)
-    
     def read_and_return_value(io)
       n_comments = read_uint32le(io)
       comments = InsensitiveHash.new

data/ruby-ogg.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby-ogg/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby-ogg"
+  spec.version       = Ogg::VERSION
+  spec.authors       = ["Aiden Nibali"]
+  spec.email         = ["dismal.denizen@gmail.com"]
+  spec.summary       = %q{A pure Ruby library for reading Ogg bitstreams, with a bundled Vorbis metadata reader.}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/anibali/ruby-ogg"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "yard"
+
+  spec.add_runtime_dependency "bindata", "~> 1.4"
+end

data/test/tc_ogg.rb

@@ -0,0 +1,41 @@
+require 'test/unit'
+
+require 'rubygems'
+require 'ogg'
+
+class OggTest < Test::Unit::TestCase
+  def setup
+    @test_dir = File.dirname(File.expand_path(__FILE__))
+  end  
+  
+  def test_read_page
+    dec = Ogg::Decoder.new(open(File.join(@test_dir, "sudo_modprobe.ogg")),
+      :verify_checksum => true)
+    # First page
+    page = dec.read_page
+    assert_equal 0, page.page_sequence_number
+    assert_equal 0, page.granule_position
+    assert_equal 30, page.data.size
+    assert_equal "\1vorbis", page.data[0..6]
+    # Second page
+    page = dec.read_page
+    assert_equal 1, page.page_sequence_number
+    assert_equal 18446744073709551615, page.granule_position
+    assert_equal 4335, page.data.size
+    assert_equal "\3vorbis", page.data[0..6]
+  end
+  
+  def test_read_packet
+    dec = Ogg::Decoder.new(open(File.join(@test_dir, "sudo_modprobe.ogg")),
+      :verify_checksum => true)
+    # First packet
+    packet = dec.read_packet
+    assert_equal 30, packet.size
+    assert_equal "\1vorbis", packet[0..6]
+    # Second packet
+    packet = dec.read_packet
+    assert_equal 173685, packet.size
+    assert_equal "\3vorbis", packet[0..6]
+  end
+end
+

data/test/tc_vorbis.rb

@@ -0,0 +1,21 @@
+require 'test/unit'
+
+require 'rubygems'
+require 'vorbis'
+
+class VorbisTest < Test::Unit::TestCase
+  def setup
+    @test_dir = File.dirname(File.expand_path(__FILE__))
+  end
+
+  def test_info_sudo_modprobe
+    Vorbis::Info.open(File.join(@test_dir, "sudo_modprobe.ogg")) do |info|
+      assert_equal ['http://linuxoutlaws.com'], info.comments['LICENSE']
+      assert_equal ['Sudo Modprobe (The Linux Outlaws Theme)'], info.comments['tItLe']
+      assert_equal ['The Linux Outlaws'], info.comments[:artist]
+      assert_equal(192000, info.nominal_bitrate)
+      assert_equal(44100, info.sample_rate)
+    end
+  end
+end
+

metadata

@@ -1,65 +1,126 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ruby-ogg
-version: !ruby/object:Gem::Version 
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Aiden Nibali
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2009-11-24 00:00:00 +11:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: bindata
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.0.0
-    version: 
-description: 
-email: dismal.denizen@gmail.com
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: A pure Ruby library for reading Ogg bitstreams, with a bundled Vorbis
+  metadata reader.
+email:
+- dismal.denizen@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- lib/vorbis.rb
+files:
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
 - lib/ogg.rb
-has_rdoc: true
-homepage: http://rubyforge.org/projects/ruby-ogg/
+- lib/ruby-ogg/version.rb
+- lib/vorbis.rb
+- ruby-ogg.gemspec
+- test/sudo_modprobe.ogg
+- test/tc_ogg.rb
+- test/tc_vorbis.rb
+homepage: https://github.com/anibali/ruby-ogg
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+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: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: ruby-ogg
-rubygems_version: 1.3.5
+rubyforge_project: 
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: A library for reading Ogg bitstreams
-test_files: []
-
+summary: A pure Ruby library for reading Ogg bitstreams, with a bundled Vorbis metadata
+  reader.
+test_files:
+- test/sudo_modprobe.ogg
+- test/tc_ogg.rb
+- test/tc_vorbis.rb
+has_rdoc: