raiff 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+.DS_Store

data/README.rdoc

@@ -0,0 +1,9 @@
+= raiff
+
+Ruby AIFF parsing library.
+
+== Note on Patches/Pull Requests
+
+== Copyright
+
+Copyright (c) 2010 Scott Tadman, The Working Group. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "raiff"
+    gem.summary = %Q{Ruby AIFF Reading Library}
+    gem.description = %Q{Reads in AIFF file data and audio contents}
+    gem.email = "github@tadman.ca"
+    gem.homepage = "http://github.com/twg/raiff"
+    gem.authors = [ "Scott Tadman" ]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "raiff #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/raiff.rb

@@ -0,0 +1,63 @@
+class Raiff
+  # == Submodules ===========================================================
+  
+  autoload(:Chunk, 'raiff/chunk')
+  autoload(:File, 'raiff/file')
+
+  # == Properties ===========================================================
+  
+  attr_reader :channels, :sample_frames, :sample_size, :sample_rate
+  attr_reader :samples
+
+  # == Callbacks ============================================================
+
+  # == Class Methods ========================================================
+  
+  def self.open(file)
+    raiff = new(file)
+    
+    yield(raiff) if (block_given?)
+    
+    raiff
+  end
+
+  # == Instance Methods =====================================================
+
+  def initialize(file = nil)
+    @offset = 0
+    
+    if (file)
+      @file = Raiff::File.new(file)
+    
+      @form = Raiff::Chunk::Form.new(@file)
+      @chunks = @form.chunks
+      
+      common_chunk = (@chunks['COMM'] and @chunks['COMM'][0])
+      
+      if (common_chunk)
+        @channels = common_chunk.channels
+        @sample_frames = common_chunk.sample_frames
+        @sample_size = common_chunk.sample_size
+        @sample_rate = common_chunk.sample_rate
+      end
+      
+      @samples = [ ]
+
+      if (@chunks['SSND'])
+        @chunks['SSND'].each do |sound_data|
+          @samples += sound_data.samples
+        end
+      end
+    end
+  end
+  
+  def inspect
+    "<Raiff\##{object_id} channels=#{channels} sample_frames=#{sample_frames} sample_size=#{sample_size} sample_rate=#{sample_rate}>"
+  end
+  
+  def each_sample(&block)
+    @chunks['SSND'].each do |sound_data|
+      sound_data.samples.each(&:block)
+    end
+  end
+end

data/lib/raiff/chunk.rb

@@ -0,0 +1,25 @@
+class Raiff::Chunk
+  # == Constants ============================================================
+
+  autoload(:Common, 'raiff/chunk/common')
+  autoload(:Data, 'raiff/chunk/data')
+  autoload(:Form, 'raiff/chunk/form')
+  autoload(:SoundData, 'raiff/chunk/sound_data')
+
+  # == Properties ===========================================================
+
+  attr_reader :id, :size
+
+  # == Class Methods ========================================================
+  
+  # == Instance Methods =====================================================
+  
+  def initialize(file)
+    @id = file.read(4)
+    @size = file.unpack('N')[0]
+  end
+  
+  def inspect
+    "<#{self.class}\##{object_id} #{@id} #{@size}>"
+  end
+end

data/lib/raiff/chunk/common.rb

@@ -0,0 +1,26 @@
+class Raiff::Chunk::Common < Raiff::Chunk
+  # == Properties ===========================================================
+  
+  attr_reader :channels, :sample_frames, :sample_size, :sample_rate
+  attr_reader :bytes_per_sample
+
+  # == Class Methods ========================================================
+
+  # == Instance Methods =====================================================
+  
+  def initialize(file)
+    super(file)
+    
+    chunk_end = file.offset + @size
+    
+    @channels, @sample_frames, @sample_size = file.unpack('nNn')
+
+    @sample_rate = file.unpack_extended_float
+    
+    @bytes_per_sample = (@sample_size - 1) / 8 + 1
+  end
+
+  def inspect
+    "<#{self.class}\##{object_id} #{@id} #{@size} channels=#{channels} sample_frames=#{sample_frames} sample_size=#{sample_size} sample_rate=#{'%.2f' % sample_rate}>"
+  end
+end

data/lib/raiff/chunk/data.rb

@@ -0,0 +1,19 @@
+class Raiff::Chunk::Data < Raiff::Chunk
+  # == Properties ===========================================================
+  
+  attr_reader :data
+
+  # == Class Methods ========================================================
+
+  # == Instance Methods =====================================================
+  
+  def initialize(file)
+    super(file)
+    
+    @data = file.read(@size)
+    
+    if (@size % 2 == 1)
+      file.read(1)
+    end
+  end
+end

data/lib/raiff/chunk/form.rb

@@ -0,0 +1,35 @@
+class Raiff::Chunk::Form < Raiff::Chunk
+  # == Properties ===========================================================
+  
+  attr_reader :chunks
+
+  # == Class Methods ========================================================
+
+  # == Instance Methods =====================================================
+  
+  def initialize(file)
+    super(file)
+    
+    @type = file.read(4)
+    
+    @chunks = { }
+    common_chunk = nil
+    
+    while (!file.eof?)
+      chunk =
+        case (file.peek(4))
+        when 'COMM'
+          common_chunk = Raiff::Chunk::Common.new(file)
+        when 'SSND'
+          # FIX: Raise exception when there is no common block, but
+          #      a SoundData block occurs.
+          Raiff::Chunk::SoundData.new(file, common_chunk)
+        else
+          Raiff::Chunk::Data.new(file)
+        end
+        
+      @chunks[chunk.id] ||= [ ]
+      @chunks[chunk.id] << chunk
+    end
+  end
+end

data/lib/raiff/chunk/sound_data.rb

@@ -0,0 +1,43 @@
+class Raiff::Chunk::SoundData < Raiff::Chunk
+  # == Properties ===========================================================
+  
+  attr_reader :offset, :block_size
+  attr_reader :samples
+
+  # == Class Methods ========================================================
+
+  # == Instance Methods =====================================================
+  
+  def initialize(file, common)
+    super(file)
+    
+    end_offset = file.offset + @size
+    
+    @offset, @block_size = file.unpack('NN')
+
+    file.read(@offset)
+    
+    sample_count = (end_offset - file.offset) / common.bytes_per_sample
+    bit_offset = common.bytes_per_sample * 8 - common.sample_size
+    value_offset = (1 << common.sample_size) - 1
+    
+    @samples = [ ]
+    
+    case (common.bytes_per_sample)
+    when 3
+      format = 'B24' * common.channels
+      
+      sample_count.times do
+        if (sample = file.unpack(format))
+          @samples << sample.collect { |s| (s.to_i(2) >> bit_offset) - value_offset }
+        end
+      end
+    else
+      format = %w[ C n x N ][common.bytes_per_sample] * common.channels
+      
+      sample_count.times do
+        @samples << file.unpack(format).collect { |i| (i >> bit_offset) - value_offset }
+      end
+    end
+  end
+end

data/lib/raiff/file.rb

@@ -0,0 +1,68 @@
+class Raiff::File
+  # == Constants ============================================================
+
+  # == Properties ===========================================================
+
+  attr_reader :offset
+
+  # == Class Methods ========================================================
+
+  # == Instance Methods =====================================================
+  
+  def initialize(file)
+    case (file)
+    when IO
+      @handle = file
+    else
+      @handle = File.open(file.to_s, 'r:BINARY')
+    end
+
+    @data = @handle.read
+    @offset = 0
+  end
+  
+  def eof?
+    @offset >= @data.length
+  end
+  
+  def advance(count = 1)
+    @offset += count
+  end
+  
+  def seek(offset)
+    @offset = offset
+  end
+  
+  def peek(bytes)
+    @data[@offset, bytes]
+  end
+  
+  def read(bytes)
+    data = @data[@offset, bytes]
+    
+    @offset += bytes
+    
+    data
+  end
+
+  def unpack_extended_float
+    extended = read(10).unpack('B80')[0]
+
+    sign = extended[0, 1]
+    exponent = extended[1, 15].to_i(2) - ((1 << 14) - 1)
+    fraction = extended[16, 64].to_i(2)
+    
+    ((sign == '1') ? -1.0 : 1.0) * (fraction.to_f / ((1 << 63) - 1)) * (2 ** exponent)
+  end
+
+  def unpack(format)
+    return if (@offset >= @data.length)
+
+    part = @data[@offset, @data.length].unpack(format)
+    advance(part.pack(format).length)
+    part
+
+  rescue TypeError
+    [ ]
+  end
+end

data/raiff.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{raiff}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Scott Tadman"]
+  s.date = %q{2010-12-06}
+  s.description = %q{Reads in AIFF file data and audio contents}
+  s.email = %q{github@tadman.ca}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/raiff.rb",
+     "lib/raiff/chunk.rb",
+     "lib/raiff/chunk/common.rb",
+     "lib/raiff/chunk/data.rb",
+     "lib/raiff/chunk/form.rb",
+     "lib/raiff/chunk/sound_data.rb",
+     "lib/raiff/file.rb",
+     "raiff.gemspec",
+     "sample/example-24bit.aiff",
+     "test/helper.rb",
+     "test/test_raiff.rb"
+  ]
+  s.homepage = %q{http://github.com/twg/raiff}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Ruby AIFF Reading Library}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_raiff.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'raiff'
+
+class Test::Unit::TestCase
+  def sample_file(name)
+    File.expand_path(File.join('..', 'sample', name), File.dirname(__FILE__))
+  end
+end

data/test/test_raiff.rb

@@ -0,0 +1,28 @@
+require File.expand_path('helper', File.dirname(__FILE__))
+
+class TestRaiff < Test::Unit::TestCase
+  def test_empty
+    raiff = Raiff.new
+    
+    assert raiff
+  end
+
+  def test_open_short_sample
+    raiff = Raiff.open(sample_file('example-24bit.aiff'))
+    
+    assert raiff
+    
+    assert_equal 23493, raiff.sample_frames
+  end
+
+  def test_failed_open
+    raised = false
+
+    raiff = Raiff.open('does.not.exist')
+
+  rescue Errno::ENOENT
+    raised = true
+  ensure
+    assert raised
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: raiff
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Scott Tadman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-06 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Reads in AIFF file data and audio contents
+email: github@tadman.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/raiff.rb
+- lib/raiff/chunk.rb
+- lib/raiff/chunk/common.rb
+- lib/raiff/chunk/data.rb
+- lib/raiff/chunk/form.rb
+- lib/raiff/chunk/sound_data.rb
+- lib/raiff/file.rb
+- raiff.gemspec
+- sample/example-24bit.aiff
+- test/helper.rb
+- test/test_raiff.rb
+has_rdoc: true
+homepage: http://github.com/twg/raiff
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby AIFF Reading Library
+test_files: 
+- test/helper.rb
+- test/test_raiff.rb