ruby-audio 0.2.1 → 1.0.0

data/spec/buffer_spec.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe RubyAudio::Buffer do
+  it "should initialize properly" do
+    buf = RubyAudio::Buffer.new('float', 100, 2)
+    buf.channels.should == 2
+    buf.size.should == 100
+    buf.real_size.should == 0
+    buf.type.should == :float
+  end
+
+  it "should support pretty typed constructors" do
+    lambda {
+      [:short, :int, :float, :double].each do |type|
+        buf = RubyAudio::Buffer.send(type, 100)
+      end
+    }.should_not raise_error
+  end
+
+  it "should allow [] access on single channel buffers" do
+    buf = RubyAudio::Buffer.int(100, 1)
+    buf[0] = 1.3
+    buf[0].should == 1
+  end
+
+  it "should allow [] access on multi-channel buffers" do
+    buf = RubyAudio::Buffer.double(100, 2)
+    buf[0] = [0.5, 0.3]
+    buf[0].should == [0.5, 0.3]
+  end
+
+  it "should raise exception if channel count of set frame does not match buffer's" do
+    lambda {
+      buf = RubyAudio::Buffer.double(100, 2)
+      buf[0] = [0.4, 0.8, 0.8]
+    }.should raise_error(RubyAudio::Error, "array length must match channel count")
+  end
+
+  it "should return nil on out-of-bounds [] access" do
+    buf = RubyAudio::Buffer.float(100)
+    buf[101].should == nil
+    buf[-1].should == nil
+  end
+
+  it "should truncate invalid real size" do
+    buf = RubyAudio::Buffer.float(100)
+    buf.real_size = 101
+    buf.real_size.should == 100
+  end
+end

data/spec/sound_info_spec.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe RubyAudio::SoundInfo do
+  it "should initialize with default properties" do
+    info = RubyAudio::SoundInfo.new
+    info.channels.should == 0
+    info.samplerate.should == 0
+    info.format.should == 0
+  end
+
+  it "should allow setting properties on initialize" do
+    info = RubyAudio::SoundInfo.new(:channels => 1, :samplerate => 48000, :format => RubyAudio::FORMAT_WAV|RubyAudio::FORMAT_PCM_16)
+    info.channels.should == 1
+    info.samplerate.should == 48000
+    info.format.should == RubyAudio::FORMAT_WAV|RubyAudio::FORMAT_PCM_16
+  end
+
+  it "should allow setting properties after initialize" do
+    info = RubyAudio::SoundInfo.new
+    info.channels = 3
+    info.channels.should == 3
+  end
+
+  it "should not be valid if properties invalid" do
+    info = RubyAudio::SoundInfo.new(:channels => 1, :samplerate => 48000, :format => RubyAudio::FORMAT_WAV)
+    info.valid?.should == false
+    info.format = RubyAudio::FORMAT_WAV|RubyAudio::FORMAT_PCM_16
+    info.valid?.should == true
+  end
+
+  it "should allow cloning" do
+    info = RubyAudio::SoundInfo.new(:channels => 1, :samplerate => 48000, :format => RubyAudio::FORMAT_WAV|RubyAudio::FORMAT_PCM_16)
+    info2 = info.clone
+    info.object_id.should_not == info2.object_id
+    info.channels.should == info2.channels
+    info.samplerate.should == info2.samplerate
+    info.format.should == info2.format
+  end
+end

data/spec/sound_spec.rb

@@ -0,0 +1,147 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe RubyAudio::Sound do
+  MONO_TEST_WAV = File.dirname(__FILE__)+'/data/what.wav'
+  STEREO_TEST_WAV = File.dirname(__FILE__)+'/data/what2.wav'
+  TEST_MP3 = File.dirname(__FILE__)+'/data/what.mp3'
+  OUT_WAV = File.dirname(__FILE__)+'/data/temp.wav'
+
+  after :each do
+    File.delete(OUT_WAV) if File.exists?(OUT_WAV)
+  end
+
+  it "should open a standard wav without issues" do
+    lambda {
+      RubyAudio::Sound.open(MONO_TEST_WAV)
+    }.should_not raise_error
+  end
+
+  it "should raise an exception if the mode is invalid" do
+    lambda {
+      RubyAudio::Sound.open(MONO_TEST_WAV, 'q')
+    }.should raise_error(ArgumentError, 'invalid access mode q')
+  end
+
+  it "should close the sound on block exit" do
+    s = nil
+    RubyAudio::Sound.open(MONO_TEST_WAV) do |snd|
+      snd.closed?.should be_false
+      s = snd
+    end
+    s.closed?.should be_true
+  end
+
+  it "should raise an exception for an unsupported file" do
+    lambda {
+      RubyAudio::Sound.open(TEST_MP3)
+    }.should raise_error(RubyAudio::Error, "File contains data in an unknown format.")
+  end
+
+  it "should raise an exception if file does not exist" do
+    lambda {
+      RubyAudio::Sound.open(TEST_MP3+'.not')
+    }.should raise_error(RubyAudio::Error, "System error : No such file or directory.")
+  end
+
+  it "should have the proper sound info" do
+    RubyAudio::Sound.open(MONO_TEST_WAV) do |snd|
+      snd.info.channels.should == 1
+      snd.info.samplerate.should == 16000
+      snd.info.format.should == RubyAudio::FORMAT_WAV|RubyAudio::FORMAT_PCM_16
+    end
+  end
+
+  it "should allow seeking" do
+    lambda {
+      RubyAudio::Sound.open(MONO_TEST_WAV) do |snd|
+        snd.seek(100)
+        buf = snd.read(:float, 100)
+        buf[0].should > 0
+      end
+    }.should_not raise_error
+  end
+
+  it "should raise exceptions for invalid seeks" do
+    lambda {
+      RubyAudio::Sound.open(MONO_TEST_WAV) {|snd| snd.seek(-1)}
+    }.should raise_error(RubyAudio::Error, "invalid seek")
+    lambda {
+      RubyAudio::Sound.open(MONO_TEST_WAV) {|snd| snd.seek(1000000)}
+    }.should raise_error(RubyAudio::Error, "invalid seek")
+  end
+
+  it "should allow reading samples from the sound" do
+    RubyAudio::Sound.open(STEREO_TEST_WAV) do |snd|
+      buf = snd.read(:float, 1000)
+      buf.size.should == 1000
+      buf.real_size.should == 1000
+      buf[999].length.should == 2
+    end
+  end
+
+  it "should allow reading into an existing buffer" do
+    buf = RubyAudio::Buffer.float(1000)
+    buf.real_size.should == 0
+    RubyAudio::Sound.open(MONO_TEST_WAV) do |snd|
+      snd.read(buf)
+    end
+    buf.real_size.should == 1000
+    buf[99].should > 0
+  end
+
+  it "should allow reading into an existing buffer partially" do
+    buf = RubyAudio::Buffer.float(1000)
+    buf.real_size.should == 0
+    RubyAudio::Sound.open(MONO_TEST_WAV) do |snd|
+      snd.read(buf, 100)
+    end
+    buf.real_size.should == 100
+    buf[99].should > 0
+    buf[100].should == nil
+  end
+
+  it "should raise exception for channel count mismatch on read" do
+    buf = RubyAudio::Buffer.float(1000, 1)
+    lambda {
+      RubyAudio::Sound.open(STEREO_TEST_WAV) do |snd|
+        snd.read(buf)
+      end
+    }.should raise_error(RubyAudio::Error, "channel count mismatch: 1 vs 2")
+  end
+
+  it "should allow writing to a new sound" do
+    in_buf = RubyAudio::Buffer.float(100)
+    out_buf = RubyAudio::Buffer.float(100)
+    out_info = nil
+    RubyAudio::Sound.open(MONO_TEST_WAV) do |snd|
+      snd.read(in_buf)
+      out_info = snd.info.clone
+    end
+
+    RubyAudio::Sound.open(OUT_WAV, 'rw', out_info) do |snd|
+      snd.write(in_buf)
+      snd.seek(0)
+      snd.read(out_buf)
+    end
+
+    out_buf[50].should == in_buf[50]
+  end
+
+  it "should allow writing to a new sound using <<" do
+    in_buf = RubyAudio::Buffer.float(100)
+    out_buf = RubyAudio::Buffer.float(100)
+    out_info = nil
+    RubyAudio::Sound.open(MONO_TEST_WAV) do |snd|
+      snd.read(in_buf)
+      out_info = snd.info.clone
+    end
+
+    RubyAudio::Sound.open(OUT_WAV, 'rw', out_info) do |snd|
+      snd << in_buf
+      snd.seek(0)
+      snd.read(out_buf)
+    end
+
+    out_buf[50].should == in_buf[50]
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+-f nested

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+require 'spec/autorun'
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'ext'))
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'ruby-audio'

metadata

@@ -1,58 +1,64 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-audio
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors: 
-- Hans Fugal <hans@fugal.net>
 - Stephen Augenstein
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-02-15 00:00:00 -05:00
+date: 2010-03-16 00:00:00 -04:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: narray
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+dependencies: []
+
 description: 
 email: perl.programmer@gmail.com
 executables: []
 
 extensions: 
-- ext/sndfile/extconf.rb
+- ext/extconf.rb
 extra_rdoc_files: []
 
 files: 
 - README.rdoc
 - Rakefile
 - LICENSE
-- TODO
-- examples/load_samples.rb
-- examples/t.rb
-- lib/audio/sndfile.rb
-- lib/audio.rb
-- test/test_audio.rb
-- test/test_sndfile.rb
-- test/what.wav
-- test/what2.wav
-- ext/sndfile/extconf.rb
-- ext/sndfile/sndfile.i
+- lib/ruby-audio/buffer.rb
+- lib/ruby-audio/sound.rb
+- lib/ruby-audio/sound_info.rb
+- lib/ruby-audio.rb
+- spec/buffer_spec.rb
+- spec/sound_info_spec.rb
+- spec/sound_spec.rb
+- spec/spec_helper.rb
+- spec/spec.opts
+- spec/data/what.wav
+- spec/data/what2.wav
+- spec/data/what.mp3
+- ext/extconf.rb
+- ext/ra_buffer.c
+- ext/ra_sound.c
+- ext/ra_soundinfo.c
+- ext/rubyaudio_ext.c
+- ext/ra_buffer.h
+- ext/ra_sound.h
+- ext/ra_soundinfo.h
 has_rdoc: true
 homepage: http://github.com/warhammerkid/ruby-audio
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --line-numbers
+- --main
+- README.rdoc
+- ext/ra_buffer.c
+- ext/ra_sound.c
+- ext/ra_soundinfo.c
+- ext/rubyaudio_ext.c
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -69,12 +75,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: 
 - libsndfile (http://www.mega-nerd.com/libsndfile/)
-- SWIG (http://www.swig.org/)
 rubyforge_project: 
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: ruby-audio wraps around libsndfile to provide simplified sound reading and writing support to ruby programs
 test_files: 
-- test/test_audio.rb
-- test/test_sndfile.rb
+- spec/buffer_spec.rb
+- spec/sound_info_spec.rb
+- spec/sound_spec.rb

data/TODO

@@ -1,5 +0,0 @@
-automagic write bug
-document Sndfile::SF_*
-sebastian's error
-leopard ugliness :(
-carl's request for optional 2nd argument to {write,read}_*

data/examples/load_samples.rb

@@ -1,27 +0,0 @@
-require 'ostruct'
-require 'pp'
-require 'rubygems'
-require 'google_chart'
-require 'narray'
-
-require 'lib/audio.rb'
-require 'lib/audio/sndfile.rb'
-
-@files = [
-'audio_files/063_1.WAV',
-'audio_files/063_2.WAV',
-'audio_files/063_3.WAV'
-]
-  
-@sound_files = []
-@files.each do |f|
-  @sound_files << Audio::Soundfile.open(f)
-end
-
-@sounds = []
-@sound_files.each do |sf|
-  @sounds << sf.read_int(sf.frames)
-end
-
-@f = @sounds.first
-@l = @sounds.last

data/examples/t.rb

@@ -1,10 +0,0 @@
-eval(File.read('load_samples.rb'))
-
-@samples_to_graph = 500
-lc = GoogleChart::LineChart.new('640x400', "Line Chart", false)
-lc.data "First Sound", @f.to_a[0][0..@samples_to_graph], '0000ff'
-lc.data "Last Sound", @l.to_a[0][0..@samples_to_graph], '00ff00'
-
-lc.axis :y, :range => [[@f.min, @l.min].min, [@f.max,@l.max].max], :color => 'ff00ff', :font_size => 16, :alignment => :center
-lc.axis :x, :range => [0,1000], :color => '00ffff', :font_size => 16, :alignment => :center
-puts lc.to_url

data/ext/sndfile/extconf.rb

@@ -1,31 +0,0 @@
-require 'rubygems'
-require 'mkmf'
-
-$CFLAGS = '-I/opt/local/include'
-$LDFLAGS = '-L/opt/local/lib -L/usr/local/lib'
-
-# Add narray header to path
-matches = Gem.source_index.find_name 'narray', Gem::Requirement.default
-if matches.empty?
-  raise 'You need to install NArray gem'
-  exit
-end
-spec = matches.last
-$CFLAGS += " -I#{spec.full_gem_path}"
-
-# libsndfile requirements
-unless find_library 'sndfile', 'sf_open'
-  raise 'You need to install libsndfile (http://www.mega-nerd.com/libsndfile/)'
-  exit
-end
-
-# NArray gem requirements (double check that header there)
-unless have_header 'narray.h'
-  raise 'You need to install NArray gem'
-  exit
-end
-
-# Swig
-system 'swig -ruby -I/usr/include -I/usr/local/include -I/opt/local/include sndfile.i'
-
-create_makefile 'sndfile'