ruby-audio 0.2.0

data/LICENSE

@@ -0,0 +1,340 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+	51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year  name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Library General
+Public License instead of this License.

data/README

@@ -0,0 +1,38 @@
+= ruby-audio
+
+Gemified release of ruby/audio. ruby-audio wraps around libsndfile to provide
+simplified sound reading and writing support to ruby programs. The core is the
+Audio::Sound class, which is a subclass of NArray. Also provided is the
+Audio::Soundfile class, which is a wrapper around the wonderful libsndfile.
+
+== About This Release
+
+Since it wasn't being maintained, I've taken it under my wing to get it usable.
+Please contact me with any questions or comments.
+
+== Installation
+
+  gem install ruby-audio --source="http://gemcutter.org"
+
+=== Prerequisites
+
+- libsndfile[http://www.mega-nerd.com/libsndfile/]
+- SWIG[http://www.swig.org/]
+
+== License
+
+Copyright (C) 2010  Hans Fugal and Stephen Augenstein
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+spec = Gem::Specification.new do |s|
+  s.name    = 'ruby-audio'
+  s.version = '0.2.0'
+  s.summary = 'ruby-audio wraps around libsndfile to provide simplified sound reading and writing support to ruby programs'
+  s.authors  = ['Hans Fugal <hans@fugal.net>', 'Stephen Augenstein']
+  s.email    = 'perl.programmer@gmail.com'
+  s.homepage = 'http://github.com/warhammerkid/ruby-audio'
+
+  s.platform     = Gem::Platform::RUBY
+  s.has_rdoc     = true
+  s.files        = FileList['README', 'Rakefile', 'LICENSE', 'TODO', 'examples/**/*.rb', 'examples/**/*.wav', 'lib/**/*.rb', 'test/*.rb', 'test/*.wav', 'ext/sndfile/extconf.rb', 'ext/sndfile/sndfile.i']
+  s.require_path = 'lib'
+  s.extensions   = ["ext/sndfile/extconf.rb"]
+  s.test_files   = Dir[*['test/*.rb']]
+
+  s.add_dependency('narray')
+  s.requirements << 'libsndfile (http://www.mega-nerd.com/libsndfile/)'
+  s.requirements << 'SWIG (http://www.swig.org/)'
+end
+
+desc 'Default: Run the tests'
+task :default => :test
+
+# Rake gem & package routines
+Rake::GemPackageTask.new spec do |pkg|
+  pkg.need_tar = true
+  pkg.need_zip = true
+end
+
+desc "Generate documentation"
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ruby-audio'
+  rdoc.options << '--line-numbers' << '--main' << 'README'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Run tests"
+Rake::TestTask.new do |t|
+  t.libs += ['ext/sndfile']
+end

data/TODO

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1,27 @@
+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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,15 @@
+require 'mkmf'
+$CFLAGS = '-I/opt/local/include -I/opt/local/lib/ruby/gems/1.8/gems/narray-0.5.9.7 -I/Library/Ruby/Gems/1.8/gems/narray-0.5.9.7'
+$LDFLAGS = '-L/opt/local/lib -L/usr/local/lib'
+system 'swig -ruby -I/usr/include -I/usr/local/include -I/opt/local/include sndfile.i'
+unless find_library 'sndfile', 'sf_open'
+  raise 'You need to install libsndfile'
+  exit
+end
+dir_config 'narray', CONFIG['sitearchdir'], CONFIG['sitearchdir']
+# TODO /opt/local/lib/ruby/gems/1.8/gems/narray-0.5.9.4/narray.h
+unless have_header 'narray.h'
+  raise 'You need to install NArray =(0.5.9.7)'
+  exit
+end
+create_makefile 'sndfile'

data/ext/sndfile/sndfile.i

@@ -0,0 +1,90 @@
+// TODO: sf_command,
+%module "sndfile"
+%{
+#include <sndfile.h>
+#include <narray.h>
+%}
+
+// this bit brought to you by stdio.h
+#ifndef SEEK_SET
+#define SEEK_SET        0       /* set file offset to offset */
+#endif
+#ifndef SEEK_CUR
+#define SEEK_CUR        1       /* set file offset to current plus offset */
+#endif
+#ifndef SEEK_END
+#define SEEK_END        2       /* set file offset to EOF plus offset */
+#endif
+
+%include "typemaps.i"
+%typemap(out) int sf_format_check {
+  if ($1)
+    $result = Qtrue;
+  else
+    $result = Qfalse;
+}
+
+%typemap(out) sf_count_t {
+  $result = INT2NUM($1);
+}
+%typemap(in) sf_count_t {
+  $1 = (sf_count_t) NUM2INT($input);
+}
+
+// We have to do this or when a function like sf_get_string returns NULL it
+// will raise an exception when trying to create the string.
+%typemap(out) const char *{
+    if ($1 == 0) 
+	$result = Qnil;
+    else
+	$result = rb_str_new2($1);
+}
+
+%typemap(in) (short *ptr, sf_count_t),
+    (const short *ptr, sf_count_t)
+{
+if (!(NA_IsNArray($input) && NA_TYPE($input) == NA_SINT)) 
+    rb_raise(rb_eArgError, "Expected NArray.sint");
+$1 = NA_PTR_TYPE($input, $1_type); 
+$2 = NA_TOTAL($input);
+}
+%typemap(in) (int *ptr, sf_count_t),
+    (const int *ptr, sf_count_t)
+{
+if (!(NA_IsNArray($input) && NA_TYPE($input) == NA_LINT))
+	rb_raise(rb_eArgError, "Expected NArray.int");
+$1 = NA_PTR_TYPE($input, $1_type); 
+$2 = NA_TOTAL($input);
+}
+%typemap(in) (float *ptr, sf_count_t), 
+    (const float *ptr, sf_count_t)
+{
+if (!(NA_IsNArray($input) && NA_TYPE($input) == NA_SFLOAT))
+	rb_raise(rb_eArgError, "Expected NArray.sfloat");
+$1 = NA_PTR_TYPE($input, $1_type); 
+$2 = NA_TOTAL($input);
+}
+%typemap(in) (double *ptr, sf_count_t),
+    (const double *ptr, sf_count_t)
+{
+if (!(NA_IsNArray($input) && NA_TYPE($input) == NA_DFLOAT))
+	rb_raise(rb_eArgError, "Expected NArray.float");
+$1 = NA_PTR_TYPE($input, $1_type); 
+$2 = NA_TOTAL($input);
+}
+
+%typemap(in) (void *data, int datasize), (void *ptr, sf_count_t), 
+    (const void *ptr, sf_count_t)
+{
+if (!NA_IsNArray($input))
+    rb_raise(rb_eArgError, "Expected NArray");
+$1 = NA_STRUCT($input)->ptr;
+$2 = NA_TOTAL($input) * na_sizeof[NA_TYPE($input)];
+}
+
+
+// sf_perror and sf_error_str are deprecated. sf_error_str probably doesn't
+// work at all.
+
+%include "sndfile.h"
+// vim: filetype=c

data/lib/audio.rb

@@ -0,0 +1,134 @@
+require 'rubygems'
+require 'narray'
+
+# TODO: libsamplerate, portaudio
+module Audio
+  
+  # A Sound is a NArray with some audio convenience methods. It should always
+  # have the shape <tt>[frames,channels]</tt>. (Even when m=1)
+  #
+  # *Notice* for NArray users: because most audio libraries do not agree with
+  # NArray on type names, Sound.float has a different meaning than
+  # NArray.float. Also, the shape of a new Sound is different than you might
+  # expect:
+  #   s = Sound.float(10)
+  #   n = NArray.float(10)
+  #   s.shape			#=> [10,1]
+  #   n.shape			#=> [10]
+  #   s.typecode		#=> 4
+  #   n.typecode		#=> 5
+  class Sound < NArray
+
+    # Mapping from typecode to type symbols
+    TYPES = [nil,:char,:short,:long,:float,:double]
+
+    # typecode:: Same as NArray, or a member of TYPES
+    # frames::   Number of frames
+    # channels:: Number of channels
+    #
+    # Note that the resulting shape is always [frames,channels].
+    def self.new(typecode,frames,channels=1)
+      case typecode
+      when String, Symbol
+	typecode = TYPES.index(typecode.to_sym)
+      end
+      super(typecode,frames,channels)
+    end
+
+    # One of TYPES
+    def type
+      TYPES[typecode]
+    end
+
+    # The number of frames
+    def frames
+      self.shape[0]
+    end
+
+    # The number of channels
+    def channels
+      self.shape[1]
+    end
+
+    # Returns a new Sound with the data from channel i
+    def channel(i)
+      self[true,i]
+    end
+
+    # A frame, i.e. an array containing the samples at position i from each
+    # channel. For a two-channel sound:
+    #   sound.frame(i) #=> [0.42, 0.12]
+    #
+    # You may prefer to do this the NArray way: s[i,false]
+    def frame(i)
+      unless (0...frames).include? i
+	raise IndexError, "Index out of range"
+      end
+      self[i,false]
+    end
+
+    # For a two-channel sound:
+    #   s.set_frame(i,[0.42,0.24])
+    #   s.set_frame(i,0.42) #=> s.set_frame(i,[0.42,0.42])
+    #
+    # You may prefer to do this the NArray way: s[i,false] = val
+    def set_frame(i,val)
+      self[i,false] = val
+    end
+
+    def each_frame
+      frames.times do |i|
+	yield frame(i)
+      end
+    end
+
+    # Return a Sound with the channels interleaved.
+    #   Sound[[0,1],[2,3]].interleaved #=> Sound[[0,2,1,3]]
+    def interleave
+      self.transpose(1,0).reshape!(self.size,1)
+    end
+    alias_method :interleaved, :interleave
+
+    # Fill this Sound's channels with deinterleaved data.
+    #   Sound[[0,0],[0,0]].interleaved = NArray[0,2,1,3] #=> Sound[[0,1],[2,3]]
+    def interleave=(o)
+      self[] = o.reshape(channels,frames).transpose(1,0)
+      self
+    end
+    alias_method :interleaved=, :interleave=
+
+
+    # Creates a new Sound with the specified number of channels from the
+    # interleaved data in narray. narray should be evenly divisible by
+    # channels.
+    def self.deinterleave(narray,channels)
+      unless narray.size % channels == 0
+	raise ArgumentError, "narray not evenly divisible by channels"
+      end
+      frames = narray.size/channels
+      s = Sound.new(narray.typecode,frames,channels)
+      s.interleaved = narray
+      s
+    end
+    def deinterleave(channels)
+      self.class.deinterleave(self,channels)
+    end
+    def deinterleave!(channels)
+      s = deinterleave(channels)
+      reshape!(*s.shape)
+      self[] = s
+    end
+
+    %w{char short long float double}.each_with_index do |t,i|
+      eval "def self.#{t}(frames,channels=1); self.new(#{i+1},frames,channels); end"
+    end
+
+    # alias class methods
+    class << self
+      alias_method :byte,   :char
+      alias_method :sint,   :short
+      alias_method :int,    :long
+      alias_method :sfloat, :float
+    end
+  end
+end

data/lib/audio/sndfile.rb

@@ -0,0 +1,156 @@
+require 'audio'
+require 'sndfile.so'
+
+module Audio
+  # libsndfile[http://www.mega-nerd.com/libsndfile/]
+  #
+  # = Synopsis
+  #   require 'audio/sndfile'
+  #   
+  #   Audio::Soundfile.open('chunky_bacon.wav') do |sf|
+  #     sound = sf.readf_float(sf.frames)
+  #     puts "Maximum amplitude: #{sound.abs.max}"
+  #   end
+  #
+  # = Details
+  # Refer to the libsndfile api[http://www.mega-nerd.com/libsndfile/api.html].
+  #
+  # Usage is quite straightforward: drop the +sf_+ prefix, omit the
+  # <tt>SNDFILE*</tt> parameter, and use Sound or Numeric instead of
+  # (pointer, size) pairs. So, if you have a Soundfile object named +sf+, then
+  #   sf_read_float(SNDFILE, float *ptr, sf_count_t items) 
+  # becomes
+  #   buf = Sound.float(items)
+  #   sf.read_float(buf)
+  # or
+  #   buf = sf.read_float(items)  # creates a new Sound
+  # 
+  # Exceptions to this pattern are documented below.
+  #
+  # Constants are accessed as <tt>Soundfile::SF_FORMAT_WAV</tt>
+  class Soundfile
+    # SF_INFO
+    attr :info
+    attr_reader :mode
+
+    # mode:: One of %w{r w rw}
+    # info:: Instance of SF_INFO or nil
+    def initialize(path, mode='r', info=nil)
+      if info.nil?
+	info = SF_INFO.new
+      end
+      
+      modes = {:r => SFM_READ, :w => SFM_WRITE, :rw => SFM_RDWR}
+      unless Numeric === mode
+	mode = modes[mode.to_sym]
+      end
+      unless [SFM_READ, SFM_WRITE, SFM_RDWR].include? mode
+	raise ArgumentError, "Invalid mode" 
+      end
+
+      sf = Sndfile.sf_open(path.to_s, mode, info)
+      @sf = sf
+      @info = info
+      @mode = modes.invert[mode]
+      if block_given?
+	yield self
+	self.close
+      end
+    end
+
+    class << self
+      alias_method :open, :new
+    end
+
+    def frames
+      @info.frames
+    end
+    def samplerate
+      @info.samplerate
+    end
+    def channels
+      @info.channels
+    end
+    def format
+      @info.format
+    end
+    def sections
+      @info.sections
+    end
+    def seekable
+      @info.seekable
+    end
+
+    # The following are equivalent: 
+    #   sf_format_check(info) /* C */
+    #   sf.format_check       # ruby
+    def format_check
+      Sndfile.sf_format_check(@info)
+    end
+
+    TYPES = [nil,:char,:short,:int,:float,:double] #:nodoc:
+
+    # Automagic read method. Type is autodetected.
+    def read(na)
+      sym = "read_#{TYPES[na.typecode]}".to_sym
+      self.send sym, na
+    end
+
+    # Automagic write method. Type is autodetected.
+    def write(na)
+      sym = "write_#{TYPES[na.typecode]}".to_sym
+      self.send sym, na
+    end
+
+    %w{read readf}.each do |r|
+      %w{short int float double}.each do |t|
+	tc = TYPES.index(t.to_sym)
+	c = ', channels' if r == 'readf'
+	cmd = "#{r}_#{t}"
+	eval <<-EOF
+	  def #{cmd}(arg)
+	    if Numeric === arg
+	      na = NArray.new(#{tc}, arg#{c})
+	      n = Sndfile.sf_#{cmd}(@sf, na)
+	      Sound.deinterleave(na, channels)
+	    else
+	      na = arg
+	      n = Sndfile.sf_#{cmd}(@sf, na)
+	      na.deinterleave!(channels)
+	      n
+	    end
+	  end
+	EOF
+      end
+    end
+
+    %w{write writef}.each do |w|
+      %w{short int float double}.each do |t|
+	cmd = "#{w}_#{t}"
+	eval <<-EOF
+	  def #{cmd}(sound)
+	    raise "Format check failed: \#{perror}" unless format_check
+	    Sndfile.sf_#{cmd}(@sf, sound.interleave)
+	  end
+	EOF
+      end
+    end
+
+    def method_missing(name, *args) #:nodoc:
+      begin
+	Sndfile.send "sf_#{name}".to_sym, @sf, *args
+      rescue NameError
+	super
+      end
+    end
+
+    def self.const_missing(sym) #:nodoc:
+      begin
+	Sndfile.const_get(sym)
+      rescue NameError
+	super
+      end
+    end
+  end
+end
+

data/test/test_audio.rb

@@ -0,0 +1,82 @@
+require 'test/unit'
+require 'audio'
+
+class AudioTest < Test::Unit::TestCase
+  include Audio
+  def test_sound
+    %w{char short long float double}.each do |t|
+      eval "s = Sound.#{t}(10); assert_equal :#{t}, s.type"
+    end
+    s = Sound.float(6).indgen!
+    assert_equal [6,1], s.shape
+    assert_equal 1, s.channels
+    assert_equal 6, s.frames
+    s.reshape!(3,2)
+    assert_equal 2, s.channels
+    assert_equal 3, s.frames
+    assert_equal [[0.0,3.0,1.0,4.0,2.0,5.0]], s.interleave.to_a
+    assert_equal 6, s.size
+
+    s = Sound.byte(10); assert_equal :char, s.type
+    s = Sound.sint(10); assert_equal :short, s.type
+    s = Sound.int(10); assert_equal :long, s.type
+    s = Sound.sfloat(10); assert_equal :float, s.type
+
+    s = Sound.sfloat(10)
+    assert_equal 10, s.size
+    assert_equal 10, s.frames
+    assert_equal 1, s.channels
+    assert_equal :float, s.type
+    assert_kind_of NArray, s
+    s.channels.times do |i|
+      c = s.channel(i)
+      assert_kind_of NArray, c
+      assert_instance_of Sound, c
+      assert_equal 10, c.size
+    end
+
+    s = Sound.double(10,2)
+    assert_equal 2, s.channels
+    assert_equal 10, s.frames
+
+    c = s.channel(1)
+    assert_instance_of Sound, c
+    assert_equal 10, c.size
+
+    s.each_frame do |a|
+      assert_instance_of Sound, a
+      assert_kind_of Numeric, a[0]
+      assert_kind_of Numeric, a[1]
+    end
+
+    # test new
+    s = Sound.new(4,10)
+    assert_equal [10,1], s.shape
+    assert_equal 10, s.size
+    assert_equal 4, s.typecode
+    assert_equal :float, s.type
+    assert_equal 10, s.frames
+    assert_equal 1, s.channels
+
+    s = Sound.new(:long,10)
+    assert_equal [10,1], s.shape
+    assert_equal 10, s.size
+    assert_equal 3, s.typecode
+    assert_equal :long, s.type
+    assert_equal 10, s.frames
+    assert_equal 1, s.channels
+  end
+
+  def test_interleave
+    s = Sound.float(2,2).indgen!
+    i = s.interleave
+    assert_equal s[0,0], i[0]
+    assert_equal s[0,1], i[1]
+
+    s2 = Sound.deinterleave(i,2)
+    assert_equal s, s2
+
+    s2.interleave = i
+    assert_equal s, s2
+  end
+end

data/test/test_sndfile.rb

@@ -0,0 +1,191 @@
+require 'test/unit'
+require 'audio/sndfile'
+require 'narray'
+
+class SndfileTest < Test::Unit::TestCase
+  include Sndfile
+  TEST_WAV='test/what.wav'
+  STEREO_TEST_WAV='test/what2.wav'
+
+  def setup
+    raise "Invalid test wav" unless File.readable?(TEST_WAV)
+    @inf = SF_INFO.new
+    @sf = sf_open(TEST_WAV,SFM_RDWR,@inf)
+    raise "Couldn't open #{TEST_WAV}: #{sf_strerror(@sf)}" if @sf.nil?
+  end
+  
+  def teardown
+    sf_close(@sf)
+  end
+
+  def test_enums
+    enums = {
+      SF_FORMAT_WAV          => 0x010000,     
+      SF_FORMAT_AIFF         => 0x020000,     
+      SF_FORMAT_AU           => 0x030000,     
+      SF_FORMAT_RAW          => 0x040000,     
+      SF_FORMAT_PAF          => 0x050000,     
+      SF_FORMAT_SVX          => 0x060000,     
+      SF_FORMAT_NIST         => 0x070000,     
+      SF_FORMAT_VOC          => 0x080000,     
+      SF_FORMAT_IRCAM        => 0x0A0000,     
+      SF_FORMAT_W64          => 0x0B0000,     
+      SF_FORMAT_MAT4         => 0x0C0000,     
+      SF_FORMAT_MAT5         => 0x0D0000,     
+      SF_FORMAT_PVF          => 0x0E0000,     
+      SF_FORMAT_XI           => 0x0F0000,     
+      SF_FORMAT_HTK          => 0x100000,     
+      SF_FORMAT_SDS          => 0x110000,     
+      SF_FORMAT_AVR          => 0x120000,     
+      SF_FORMAT_WAVEX        => 0x130000,     
+      SF_FORMAT_SD2          => 0x160000,     
+      SF_FORMAT_FLAC         => 0x170000,     
+      SF_FORMAT_CAF          => 0x180000,     
+      SF_FORMAT_PCM_S8       => 0x0001,       
+      SF_FORMAT_PCM_16       => 0x0002,       
+      SF_FORMAT_PCM_24       => 0x0003,       
+      SF_FORMAT_PCM_32       => 0x0004,       
+      SF_FORMAT_PCM_U8       => 0x0005,       
+      SF_FORMAT_FLOAT        => 0x0006,       
+      SF_FORMAT_DOUBLE       => 0x0007,       
+      SF_FORMAT_ULAW         => 0x0010,       
+      SF_FORMAT_ALAW         => 0x0011,       
+      SF_FORMAT_IMA_ADPCM    => 0x0012,       
+      SF_FORMAT_MS_ADPCM     => 0x0013,       
+      SF_FORMAT_GSM610       => 0x0020,       
+      SF_FORMAT_VOX_ADPCM    => 0x0021,       
+      SF_FORMAT_G721_32      => 0x0030,       
+      SF_FORMAT_G723_24      => 0x0031,       
+      SF_FORMAT_G723_40      => 0x0032,       
+      SF_FORMAT_DWVW_12      => 0x0040,       
+      SF_FORMAT_DWVW_16      => 0x0041,       
+      SF_FORMAT_DWVW_24      => 0x0042,       
+      SF_FORMAT_DWVW_N       => 0x0043,       
+      SF_FORMAT_DPCM_8       => 0x0050,       
+      SF_FORMAT_DPCM_16      => 0x0051,       
+      SF_ENDIAN_FILE         => 0x00000000,   
+      SF_ENDIAN_LITTLE       => 0x10000000,   
+      SF_ENDIAN_BIG          => 0x20000000,   
+      SF_ENDIAN_CPU          => 0x30000000,   
+      SF_FORMAT_SUBMASK      => 0x0000FFFF,
+      SF_FORMAT_TYPEMASK     => 0x0FFF0000,
+      SF_FORMAT_ENDMASK      => 0x30000000
+    }
+
+    enums.each_pair do |k,v|
+      assert_equal k,v
+    end
+    assert_equal SF_ERR_UNSUPPORTED_ENCODING, 4
+  end
+
+  def test_info
+    assert ! sf_format_check(SF_INFO.new)
+    assert @inf.frames > 0
+    assert_equal 16000, @inf.samplerate
+    assert_equal 1, @inf.channels
+    assert_equal SF_FORMAT_WAV|SF_FORMAT_PCM_16, @inf.format
+    assert_equal 1, @inf.sections
+    #assert_equal true, @inf.seekable
+    assert sf_format_check(@inf)
+  end
+
+  def test_error
+    File.delete('bogus.wav') if File.exist?('bogus.wav')
+    s = sf_open('bogus.wav',SFM_READ,SF_INFO.new)
+    assert_nil s
+    # on some systems (or versions?) libsndfile gives either
+    # SF_ERR_UNRECOGNIZED_FORMAT or SF_ERR_SYSTEM, so we just check that there
+    # was _some_ error.
+    assert_not_equal SF_ERR_NO_ERROR, sf_error(nil)
+    sf_close(s)
+    assert_equal SF_ERR_NO_ERROR, sf_error(@sf)
+    assert_equal 'No Error.', sf_strerror(@sf)
+    assert_kind_of String, sf_error_number(1)
+  end
+
+  def test_file
+    s = sf_open(TEST_WAV,SFM_READ,SF_INFO.new)
+    assert_not_nil s
+    assert_equal 0, sf_close(s)
+  end
+
+  def test_read
+    a = NArray.float(1000)
+    sf_read_double(@sf, a)
+    assert a.max > 0
+  end
+
+  def test_write
+    a = NArray.float(1000)
+    sf_read_double(@sf, a)
+    sf2 = nil
+    assert_nothing_raised do
+      sf2 = sf_open('bogus.wav',SFM_RDWR, @inf)
+      sf_write_double(sf2, a)
+    end
+    b = NArray.float(1000)
+    sf_seek(sf2, 0, SEEK_SET)
+    sf_read_double(sf2, b)
+    assert a == b
+    sf_close(sf2)
+    File.delete('bogus.wav') if File.exist?('bogus.wav')
+  end
+
+  def test_string
+    assert_nil sf_get_string(@sf,SF_STR_COMMENT)
+  end
+
+  def test_magical_open
+    sf = Audio::Soundfile.open(TEST_WAV)
+    assert_instance_of Audio::Soundfile, sf
+    assert sf.format_check
+    assert_equal Audio::Soundfile::SF_FORMAT_WAV, 0x010000
+    sf.close
+  end
+
+  def test_magical_read
+    Audio::Soundfile.open(TEST_WAV) do |sf|
+      a = sf.read_float(100)
+      assert_instance_of Audio::Sound, a
+      assert_equal :float, a.type
+      assert_equal 4, a.typecode
+      assert a.size <= 100
+      assert_equal sf.channels, a.channels
+
+      n = sf.read_float(a)
+      assert n <= a.size
+      n = sf.read(a)
+      assert n <= a.size
+    end
+    Audio::Soundfile.open(STEREO_TEST_WAV) do |sf|
+      a = sf.read_float(100)
+      assert a.size <= 100
+      assert_equal sf.channels, a.channels
+
+      n = sf.read_float(a)
+      assert n <= a.size
+      n = sf.read(a)
+      assert n <= a.size
+    end
+  end
+
+  def test_magical_write
+    Audio::Soundfile.open(TEST_WAV) do |sf|
+      # Read data
+      a = sf.read_float(1000)
+
+      # Test magical write
+      sf2 = Audio::Soundfile.open('bogus.wav', 'rw', sf.info)
+      sf2.write(a)
+
+      # Check that read data matches written data
+      sf2.seek(0, SEEK_SET)
+      b = sf2.read_float(1000)
+      assert a == b
+
+      # Clean up
+      sf2.close
+      File.delete('bogus.wav') if File.exist?('bogus.wav')
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-audio
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Hans Fugal <hans@fugal.net>
+- Stephen Augenstein
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-09 00:00:00 -05: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: 
+description: 
+email: perl.programmer@gmail.com
+executables: []
+
+extensions: 
+- ext/sndfile/extconf.rb
+extra_rdoc_files: []
+
+files: 
+- README
+- 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
+has_rdoc: true
+homepage: http://github.com/warhammerkid/ruby-audio
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 
+- 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