farleyknight-sndx 0.1.0

data/CHANGELOG.txt

@@ -0,0 +1,5 @@
+
+== 0.1.0 
+
+First Gem release
+

data/Manifest.txt

@@ -0,0 +1,9 @@
+Manifest.txt
+README.txt
+CHANGELOG.txt
+Rakefile
+lib/sndx.rb
+test/test_sndx.rb
+ext/sndx/sndx.c
+ext/sndx/extconf.rb
+

data/README.txt

@@ -0,0 +1,62 @@
+= sndx
+
+* http://github.com/farleyknight/sndx
+
+== DESCRIPTION:
+
+  libsndfile + libXtract = Awesome audio analysis library
+
+== FEATURES/PROBLEMS:
+
+  * Wraps some of libsndfile
+  * Wraps some of libXtract
+  * Has tests so you see what I got working
+  * Doesn't wrap all of libXtract
+  * Don't think I really need to wrap much of libsndfile
+  * Just numbers so you have no idea what they mean unless you
+    put some kind of GUI on it..
+
+== SYNOPSIS:
+
+  >> require 'lib/sndx'
+  => true
+  >> @file = Sndfile.new("test/assets/48550__gusrikh__Hit_3.wav")
+  => #<Sndfile:0xb7def820>
+  >> Xtract.analyze(Xtract::MEAN, @file)
+  => -7.02867037034594e-05
+  >> Xtract.analyze(Xtract::SPECTRAL_CENTROID, @file)
+  => 0.114604391157627
+
+== REQUIREMENTS:
+
+  libsndfile [http://www.mega-nerd.com/libsndfile/]
+  libXtract  [http://libxtract.sourceforge.net]
+
+== INSTALL:
+
+  Not yet
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'hoe'
+gem 'rake-compiler', '>= 0.4.1'
+require "rake/extensiontask"
+
+require 'lib/sndx'
+
+HOE = Hoe.spec('sndx') do
+  developer('Farley Knight', 'farleyknight@gmail.com')
+  self.readme_file  = 'README.txt'
+  self.history_file = 'CHANGELOG.txt'
+  self.version      = Sndx::VERSION
+  self.spec_extras  = { :extensions => ["ext/sndx/extconf.rb"] }  
+  self.extra_deps   = ['rake-compiler', '>= 0.4.1']
+end
+
+Rake::ExtensionTask.new("sndx", HOE.spec) do |ext|
+  ext.lib_dir = File.join('lib', 'sndx')
+end
+

data/ext/sndx/extconf.rb

@@ -0,0 +1,15 @@
+
+require 'mkmf'
+
+unless find_library('sndfile', 'sf_open') 
+  abort "Couldn't find libsndfile! Make sure it's installed.."
+end
+
+unless find_library('xtract', 'xtract_init_mfcc')
+  abort "Couldn't find libxtract! Make sure it's installed.."
+end
+
+
+create_makefile('sndx/sndx')
+
+

data/ext/sndx/sndx.c

@@ -0,0 +1,312 @@
+#include <ruby.h>
+#include <sndfile.h>
+#include "xtract/libxtract.h"
+
+
+/*********************************************************
+  libsndfile
+**********************************************************/
+
+VALUE cSndfile;
+
+typedef struct {
+  char *filename;
+  SNDFILE *sndfile;
+  SF_INFO sf_info;
+} sndfile_t;
+
+
+// TODO: Close file upon dealloc
+// TODO: Should only receive a sndfile_t, not the three args for constructing
+// one
+VALUE Data_Wrap_sndfile_t(char *filename, SNDFILE *infile, SF_INFO sf_info) {
+  sndfile_t *sndfile = malloc(sizeof(sndfile_t));
+
+  sndfile->filename = filename;
+  sndfile->sndfile  = infile;
+  sndfile->sf_info  = sf_info;
+  
+  return Data_Wrap_Struct(cSndfile, 0, 0, sndfile);
+}
+
+sndfile_t *Data_Get_sndfile_t(VALUE value) {
+  sndfile_t *sndfile;
+  Data_Get_Struct(value, sndfile_t, sndfile);
+  return sndfile;
+}
+
+VALUE new(VALUE klass, VALUE filename) {
+  Check_Type(filename, T_STRING);
+
+  SNDFILE *infile;
+  SF_INFO  info;
+
+  memset(&info, 0, sizeof (info));
+
+  infile = sf_open(StringValuePtr(filename), SFM_READ, &info);
+  
+  if (infile == NULL) { 
+    rb_raise(rb_eRuntimeError, "Error : failed to open file '%s' : %s", StringValuePtr(filename), sf_strerror (NULL));
+    return Qnil;
+  } else {
+    // return Qnil;
+    return Data_Wrap_sndfile_t(StringValuePtr(filename), infile, info);
+  }
+}
+
+VALUE close(VALUE self) {
+  sndfile_t *sndfile = Data_Get_sndfile_t(self);
+  
+  if (sf_close(sndfile->sndfile)) {
+    return Qtrue;
+  } else {
+    rb_raise(rb_eRuntimeError, "Couldn't close Sndfile '%s'!", StringPtrValue(sndfile->filename));
+    return Qfalse;
+  }      
+}
+
+
+VALUE read_sample(VALUE self, VALUE index) {
+  sndfile_t *sndfile = Data_Get_sndfile_t(self);
+  
+  sf_seek(sndfile->sndfile, FIX2INT(index), SEEK_SET);
+
+  float *buffer = (float *) malloc(sizeof(float)*1);  
+  sf_readf_float(sndfile->sndfile, buffer, 1);
+  
+  return rb_float_new(buffer[0]);
+}
+
+int frame_count(sndfile_t *sndfile) {
+  return sndfile->sf_info.frames;
+}
+
+
+VALUE get(VALUE self, VALUE arg) {
+  long begin, length;
+
+  if (FIXNUM_P(arg)) {
+    return get_sample(self, FIX2INT(arg));
+  }
+
+  switch (rb_range_beg_len(arg, &begin, &length, frame_count(Data_Get_sndfile_t(self)), 0)) {
+  case Qfalse:
+    break;
+  case Qnil:
+    return Qnil;
+  default:
+    return get_range(self, begin, length);
+  }
+
+  rb_raise(rb_eRuntimeError, "Type must be either Fixnum or Range!");
+  return Qnil;
+}
+
+
+VALUE frames(VALUE self) {
+  sndfile_t *sndfile = Data_Get_sndfile_t(self);
+  
+  return INT2FIX(sndfile->sf_info.frames);
+}
+
+VALUE samplerate(VALUE self) {
+  sndfile_t *sndfile = Data_Get_sndfile_t(self);
+  return INT2FIX(sndfile->sf_info.samplerate);
+}
+
+VALUE filename(VALUE self) {
+  sndfile_t *sndfile = Data_Get_sndfile_t(self);
+  return rb_str_new2(sndfile->filename);
+}
+
+int channel_count(sndfile_t *sndfile) {
+  return sndfile->sf_info.channels;
+}
+
+VALUE channels(VALUE self) {
+  sndfile_t *sndfile = Data_Get_sndfile_t(self);
+  return INT2FIX(sndfile->sf_info.channels);
+}
+
+VALUE format_name(int format) {
+  VALUE name = rb_str_new2("");
+
+  if ((format | SF_FORMAT_WAV) == format)
+    rb_str_concat(name, rb_str_new2("Microsoft WAV"));
+  else if ((format | SF_FORMAT_AIFF) == format)
+    rb_str_concat(name, rb_str_new2("Apple/SGI AIFF"));
+  else if ((format | SF_FORMAT_AU) == format)
+    rb_str_concat(name, rb_str_new2("Sun/NeXT AU"));
+  else if ((format | SF_FORMAT_RAW) == format)
+    rb_str_concat(name, rb_str_new2("RAW PCM data"));
+  else
+    rb_str_concat(name, rb_str_new2("Dunno"));
+
+  if ((format | SF_FORMAT_PCM_S8) == format)
+    rb_str_concat(name, rb_str_new2(" 8 bit"));
+  else if ((format | SF_FORMAT_PCM_16) == format)
+    rb_str_concat(name, rb_str_new2(" 16 bit"));
+  else if ((format | SF_FORMAT_PCM_24) == format)
+    rb_str_concat(name, rb_str_new2(" 24 bit"));
+  else if ((format | SF_FORMAT_PCM_32) == format)
+    rb_str_concat(name, rb_str_new2(" 32 bit"));  
+  
+  return name;
+}
+
+
+VALUE format(VALUE self) {
+  sndfile_t *sndfile = Data_Get_sndfile_t(self);
+  return format_name(sndfile->sf_info.format);
+}
+
+
+/*********************************************************
+ libxtract
+**********************************************************/
+
+VALUE mXtract;
+
+float *all_samples(sndfile_t *sndfile) {
+  long length = frame_count(sndfile);
+  int i;  
+  float *buffer;
+
+  sf_seek(sndfile->sndfile, 0, SEEK_SET);
+  
+  buffer = calloc(sizeof(float), channel_count(sndfile) * length);  
+  int samples_read = sf_readf_float(sndfile->sndfile, buffer, length);
+
+  return buffer;
+}
+
+VALUE analyze(VALUE klass, VALUE analysis_code, VALUE sound) {
+  Check_Type(analysis_code, T_FIXNUM);
+  Check_Type(sound, T_DATA);  
+
+  sndfile_t *sndfile     = Data_Get_sndfile_t(sound);  
+  float result, *samples = all_samples(sndfile);
+  
+  int analysis_type = FIX2INT(analysis_code);
+
+  int return_code = xtract[analysis_type](samples, frame_count(sndfile), NULL, &result);
+
+  if (return_code == XTRACT_FEATURE_NOT_IMPLEMENTED) {
+    rb_raise(rb_eRuntimeError, "Xtract feature '%d' not implemented", analysis_type);
+    return Qnil;
+  } else {
+    return rb_float_new(result);
+  }
+}
+
+
+void Init_sndx() {
+  /*********************************************************
+    libsndfile
+  **********************************************************/
+
+  cSndfile = rb_define_class("Sndfile", rb_cObject);
+  rb_define_singleton_method(cSndfile, "new", new, 1);
+
+  // File handling and accessing
+  //  rb_define_method(cSndfile, "read", read, 2);
+  //  rb_define_method(cSndfile, "write", write, 1);
+  rb_define_method(cSndfile, "[]", get, 1);
+  rb_define_method(cSndfile, "read", read_sample, 1);
+  //  rb_define_method(cSndfile, "read_range", read_sample_range, 1);
+  rb_define_method(cSndfile, "close",  close, 0);
+
+  // SF_INFO accessors
+  rb_define_method(cSndfile, "frames", frames, 0);
+  rb_define_method(cSndfile, "samplerate", samplerate, 0);
+  rb_define_method(cSndfile, "filename", filename, 0);
+  rb_define_method(cSndfile, "channels", channels, 0);
+  rb_define_method(cSndfile, "format", format, 0);  
+
+  /*********************************************************
+    libxtract
+  **********************************************************/
+
+  mXtract = rb_define_module("Xtract");
+  rb_define_singleton_method(mXtract, "analyze", analyze, 2);
+  //  rb_define_singleton_method(mXtract, "feature_list", feature_list, 0);
+  
+  // Require no arguments
+  rb_define_const(mXtract, "MEAN",               INT2FIX(XTRACT_MEAN));
+  rb_define_const(mXtract, "SHARPNESS",          INT2FIX(XTRACT_SHARPNESS));
+  rb_define_const(mXtract, "RMS_AMPLITUDE",      INT2FIX(XTRACT_RMS_AMPLITUDE));
+  rb_define_const(mXtract, "SPECTRAL_CENTROID",  INT2FIX(XTRACT_SPECTRAL_CENTROID));
+  rb_define_const(mXtract, "POWER",              INT2FIX(XTRACT_POWER));
+  rb_define_const(mXtract, "ODD_EVEN_RATIO",     INT2FIX(XTRACT_ODD_EVEN_RATIO));
+  rb_define_const(mXtract, "NONZERO_COUNT",      INT2FIX(XTRACT_NONZERO_COUNT));
+  rb_define_const(mXtract, "LOUDNESS",           INT2FIX(XTRACT_LOUDNESS));
+  rb_define_const(mXtract, "IRREGULARITY_K",     INT2FIX(XTRACT_IRREGULARITY_K));
+  rb_define_const(mXtract, "IRREGULARITY_J",     INT2FIX(XTRACT_IRREGULARITY_J));
+  rb_define_const(mXtract, "FLATNESS",           INT2FIX(XTRACT_FLATNESS));
+  rb_define_const(mXtract, "ZCR",                INT2FIX(XTRACT_ZCR));
+
+
+  // Require .. ? arguments
+    /*
+  rb_define_const(mXtract, "VARIANCE",           INT2FIX(XTRACT_VARIANCE));
+  rb_define_const(mXtract, "STANDARD_DEVIATION", INT2FIX(XTRACT_STANDARD_DEVIATION));
+  rb_define_const(mXtract, "AVERAGE_DEVIATION",  INT2FIX(XTRACT_AVERAGE_DEVIATION));
+  rb_define_const(mXtract, "SKEWNESS",           INT2FIX(XTRACT_SKEWNESS));
+  rb_define_const(mXtract, "KURTOSIS",           INT2FIX(XTRACT_KURTOSIS));
+    */
+
+
+  /*
+
+    XTRACT_KURTOSIS,
+    XTRACT_SPECTRAL_MEAN,
+    XTRACT_SPECTRAL_VARIANCE,
+    XTRACT_SPECTRAL_STANDARD_DEVIATION,
+    XTRACT_SPECTRAL_AVERAGE_DEVIATION,
+    XTRACT_SPECTRAL_SKEWNESS,
+    XTRACT_SPECTRAL_KURTOSIS,
+    XTRACT_IRREGULARITY_K,
+    XTRACT_IRREGULARITY_J,
+    XTRACT_TRISTIMULUS_1,
+    XTRACT_TRISTIMULUS_2,
+    XTRACT_TRISTIMULUS_3,
+    XTRACT_SMOOTHNESS,
+    XTRACT_SPREAD,
+    XTRACT_ROLLOFF,
+    XTRACT_FLATNESS,
+    XTRACT_TONALITY,
+    XTRACT_CREST,
+    XTRACT_NOISINESS,
+    XTRACT_SPECTRAL_INHARMONICITY,
+  */
+
+
+
+  
+
+      /*
+    XTRACT_SPECTRAL_SLOPE,
+    XTRACT_LOWEST_VALUE,
+    XTRACT_HIGHEST_VALUE,
+    XTRACT_SUM,
+    XTRACT_NONZERO_COUNT,
+    XTRACT_HPS,
+    XTRACT_F0,
+    XTRACT_FAILSAFE_F0,
+    XTRACT_FLUX,
+    XTRACT_ATTACK_TIME,
+    XTRACT_DECAY_TIME,
+    XTRACT_DELTA_FEATURE,
+    XTRACT_AUTOCORRELATION,
+    XTRACT_AMDF,
+    XTRACT_ASDF,
+    XTRACT_BARK_COEFFICIENTS,
+    XTRACT_PEAK_SPECTRUM,
+    XTRACT_SPECTRUM,
+    XTRACT_AUTOCORRELATION_FFT,
+    XTRACT_MFCC,
+    XTRACT_DCT,
+    XTRACT_HARMONIC_SPECTRUM
+  */
+
+}

data/lib/sndx.rb

@@ -0,0 +1,5 @@
+require 'lib/sndx/sndx'
+
+module Sndx
+  VERSION = "0.1.0"
+end

data/test/test_sndx.rb

@@ -0,0 +1,61 @@
+require "test/unit"
+
+require 'lib/sndx'
+
+class TestSndfile < Test::Unit::TestCase
+  def setup
+    @file = Sndfile.new("test/assets/48550__gusrikh__Hit_3.wav")
+  end
+
+  def teardown
+    @file.close
+  end
+
+  def test_open_file
+    assert_not_nil @file
+  end
+  
+  def test_frames
+    assert_equal 79332, @file.frames
+  end
+
+  def test_samplerate
+    assert_equal 44100, @file.samplerate
+  end
+
+  def test_channels
+    assert_equal 2, @file.channels
+  end
+
+  def test_format
+    assert_equal "Microsoft WAV 16 bit", @file.format
+  end
+
+  def test_read
+    sample_data.each_with_index do |data, i|
+      assert_equal [data, i], [@file.read(i), i]
+    end
+  end
+
+  def sample_data
+    [-0.00054931640625,
+     -0.000396728515625, 
+     -0.000396728515625,
+     -0.000396728515625, 
+     -0.00054931640625, 
+     -0.000701904296875, 
+     -0.000274658203125,
+     -0.000396728515625,
+     0.00054931640625,
+     -0.0001220703125]
+  end
+
+  def test_features_zero_args
+    [Xtract::MEAN, Xtract::SHARPNESS, Xtract::RMS_AMPLITUDE, Xtract::SPECTRAL_CENTROID,
+     Xtract::ODD_EVEN_RATIO, Xtract::NONZERO_COUNT, Xtract::LOUDNESS,
+     Xtract::IRREGULARITY_K, Xtract::IRREGULARITY_J, Xtract::FLATNESS, Xtract::ZCR].each do |analysis_code|
+      assert_not_equal nil, Xtract.analyze(analysis_code, @file)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: farleyknight-sndx
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Farley Knight
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-18 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: libsndfile + libXtract = Awesome audio analysis library
+email: farleyknight@gmail.com
+executables: []
+
+extensions: 
+- ext/sndx/extconf.rb
+extra_rdoc_files: 
+- README.txt
+files: 
+- Manifest.txt
+- README.txt
+- CHANGELOG.txt
+- Rakefile
+- lib/sndx.rb
+- test/test_sndx.rb
+- ext/sndx/sndx.c
+- ext/sndx/extconf.rb
+has_rdoc: false
+homepage: https://github.com/farleyknight/sndx
+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: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: libsndfile + libXtract = Awesome audio analysis library
+test_files: []
+