plant-sirens 0.3.0 → 0.4.0

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/examples/features.rb

@@ -0,0 +1,61 @@
+require 'rubygems'
+require 'sirens'
+include Sirens
+
+# Open the sound.
+s = Sound.new
+s.frameLength = 0.04
+s.hopLength = 0.02
+s.open('sounds/whistle4.wav')
+
+# Create the feature objects.
+l = Loudness.new
+ts = TemporalSparsity.new
+ss = SpectralSparsity.new
+sc = SpectralCentroid.new
+ti = TransientIndex.new
+h = Harmonicity.new
+
+# Set feature history size for all features.
+[l, ts, ss, sc, ti, h].each do |f|
+  f.maxHistorySize = s.frames - 1
+end
+
+# Set spectrum size and sample rate for relevant spectral features.
+[sc, ti, h].each do |f| 
+  f.spectrumSize = s.spectrumSize
+  f.sampleRate = s.sampleRate
+end
+
+# Set other feature-specific parameters.
+ts.windowSize = 50
+ti.filters = 30
+ti.mels = 15
+h.absThreshold = 1
+h.threshold = 0.1
+h.searchRegionLength = 5
+h.maxPeaks = 3
+h.lpfCoefficient = 0.7
+
+# Create a feature set to hold all the features.
+features = FeatureSet.new
+
+[l, ts].each do |f|
+  features.addSampleFeature f
+end
+
+[ss, sc, ti, h].each do |f|
+  features.addSpectralFeature f
+end
+
+s.features = features
+
+# Extract feature histories.
+s.extractFeatures
+s.close
+
+# Print the feature histories.
+[l, ts, ss, sc, ti, h].each do |f|
+	f.history.each {|value| print value, ','}
+	print "\n"
+end

data/examples/retrieval.rb

@@ -0,0 +1,89 @@
+require 'rubygems'
+require 'sirens'
+require 'matrix'
+
+#---------#
+# Helpers #
+#---------#
+
+# Why Matrix isn't built with this is beyond me.
+class Matrix
+  def []=(i,j,x)
+    @rows[i][j] = x
+  end
+end
+
+# Normalize a log-likelihood similarity matrix to be a scaled distance matrix.
+def normalize_affinity(matrix)
+  ones = Matrix.row_vector(Array.new(matrix.row_size) {1})
+  diag = Matrix.column_vector(Array.new(matrix.row_size) {|i| matrix[i, i]})
+  
+  (diag * ones) + (ones.transpose * diag.transpose) - matrix - matrix.transpose
+end
+
+#--------#
+# Script #
+#--------#
+
+files = ['sounds/whistle1.wav', 'sounds/whistle2.wav', 'sounds/whistle3.wav', 'sounds/whistle4.wav']
+comparators = []
+
+# Create the sound object, which will be reused to open and extract features from each sound.
+s = Sirens::Sound.new
+s.frameLength = 0.04
+s.hopLength = 0.02
+
+# For each sound, open it, extract its features, and create a comparator for it.
+files.each do |filename|
+  # Open the sound.
+  s.open(filename)
+  
+  # Create the feature objects.
+  l = Sirens::Loudness.new
+  ts = Sirens::TemporalSparsity.new
+  ss = Sirens::SpectralSparsity.new
+  sc = Sirens::SpectralCentroid.new
+  ti = Sirens::TransientIndex.new
+  h = Sirens::Harmonicity.new
+  
+  # Set feature history size for all features.
+  [l, ts, ss, sc, ti, h].each do |f|
+    f.maxHistorySize = s.frames - 1
+  end
+  
+  # Set spectrum size and sample rate for relevant spectral features.
+  [sc, ti, h].each do |f| 
+    f.spectrumSize = s.spectrumSize
+    f.sampleRate = s.sampleRate
+  end
+  
+  # Create a feature set to hold all the features.
+  features = Sirens::FeatureSet.new
+  
+  [l, ts].each do |f|
+    features.addSampleFeature f
+  end
+  
+  [ss, sc, ti, h].each do |f|
+    features.addSpectralFeature f
+  end
+  
+  s.features = features
+  
+  # Extract feature histories.
+  s.extractFeatures
+  s.close
+  
+  # Make the retrieval model.
+  comparators.push Sirens::SoundComparator.new
+  comparators.last.features = features
+end
+
+# Compute log-likelihood similarity matrix.
+log_likelihood = Matrix.rows(Array.new(comparators.size) {|i| Array.new(comparators.size) {|j| comparators[i].compare(comparators[j])}})
+
+# Compute log-scale normalized distance matrix.
+affinity = normalize_affinity log_likelihood
+
+# Print results.
+puts log_likelihood, affinity

data/examples/segmentation.rb

@@ -6,7 +6,7 @@ include Sirens
 s = Sound.new
 s.frameLength = 0.04
 s.hopLength = 0.02
-s.open('sound.wav')
+s.open('sounds/whistle4.wav')
 
 # Initialize features.
 l = Loudness.new
@@ -44,7 +44,7 @@ sc.segmentationParameters.pLagMinus = 0.075
 ss = SpectralSparsity.new
 ss.maxHistorySize = s.frames
 ss.max = 0.6509
-ss.min = 1.0 / 1024.0
+ss.min = 0
 ss.segmentationParameters.alpha = 0.05
 ss.segmentationParameters.r = 0.0196
 ss.segmentationParameters.cStayOff = 0.001833506
@@ -56,33 +56,37 @@ ss.segmentationParameters.cStayOn = 0.009296018
 ss.segmentationParameters.pLagPlus = 0.75
 ss.segmentationParameters.pLagMinus = 0.75
 
+# Create a feature set to hold the features.
 features = FeatureSet.new
-features.sampleFeatures = [l]
-features.spectralFeatures =[sc, ss]
+features.addSampleFeature l
+features.addSpectralFeature sc
+features.addSpectralFeature ss
+s.features = features
 
 # Extract features.
 before = Time.now
 
-s.features = features
 s.extractFeatures
 s.close
 
 elapsed = Time.now - before
 puts "Feature extraction took #{elapsed} seconds."
 
-# Segment sound.
+# Initialize a segmenter.
 segmenter = Segmenter.new
+segmenter.features = features
 segmenter.pNew = 0.00000000001
 segmenter.pOff = 0.00000000001
-segmenter.beams = 20
 
+# Segment sound.
 before = Time.now
 
-segments = segmenter.segment(features)
+segmenter.segment
 
 elapsed = Time.now - before
 puts "Segmentation took #{elapsed} seconds."
 
-segments.each do |start, duration|
-  puts "%d-%d" % [start, start + duration]
+# Print segments.
+segmenter.segments.each do |start, stop|
+  puts "%d-%d" % [start, stop]
 end

data/ext/sirens/sirens.cpp

@@ -1,3 +1,30 @@
+/*
+ * Copyright (c) 2009 Brandon Mechtley
+ * 
+ * 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.
+ */
+
+// Make sure to include Sirens before Rice so that there aren't conflicts between uBLAS and Rice.
+#include "sirens/Sirens.h"
+using namespace Sirens;
+
 #include "rice/Class.hpp"
 #include "rice/Array.hpp"
 #include "rice/String.hpp"
@@ -5,17 +32,14 @@
 #include "rice/Constructor.hpp"
 using namespace Rice;
 
-#include "sirens/Sirens.h"
-using namespace Sirens;
-
 /*---------------------*
  * Rice class wrappers *
  *---------------------*/
 
 // All of this is just so that we can wrap getSegmentationParameters() to avoid putting the returned pointer in the garbage collector. 
 // Rice requires that we wrap every descendent of Feature. For whatever reason, it won't support things like 
-// &SpectralCentroid::getSampleRate (the parent classº in the class definition for RiceSpectralCentroid, so it's necessary to provide
-// delegate functions for every parameter.
+// &SpectralCentroid::getSampleRate (the parent class) in the class definition for RiceSpectralCentroid, so it's necessary to wrap
+// every accessor.
 
 class RiceFeature : public Feature {
 public:
@@ -26,7 +50,13 @@ public:
 
 class RiceLoudness : public Loudness, public RiceFeature {};
 class RiceSpectralSparsity : public SpectralSparsity, public RiceFeature {};
-class RiceTemporalSparsity : public TemporalSparsity, public RiceFeature {};
+
+class RiceTemporalSparsity : public TemporalSparsity, public RiceFeature {
+public:
+	void setWindowSize(int value) {TemporalSparsity::setWindowSize(value);}
+	int getWindowSize() {return TemporalSparsity::getWindowSize();}
+};
+
 class RiceSpectralCentroid : public SpectralCentroid, public RiceFeature {
 public:
 	void setSpectrumSize(int value) {SpectralCentroid::setSpectrumSize(value);}
@@ -120,7 +150,7 @@ vector<int> from_ruby<vector<int> >(Object x) {
 	return values;
 }
 
-// 2D double vector
+// 2D double vector.
 template <>
 Object to_ruby<vector<double> >(vector<double> const & x) {
 	return Array(x.begin(), x.end());
@@ -152,6 +182,33 @@ vector<vector<double> > from_ruby<vector<vector<double> > >(Object x) {
 	return matrix;
 }
 
+// 2D int vector.
+template <>
+Object to_ruby<vector<vector<int> > >(vector<vector<int> > const & x) {
+	return Array(x.begin(), x.end());
+}
+
+template <>
+vector<vector<int> > from_ruby<vector<vector<int> > >(Object x) {
+	vector<vector<int> > matrix;
+	
+	Array ruby_matrix(x);
+	
+	for (unsigned int i = 0; i < ruby_matrix.size(); i++) {
+		vector<int> row;
+		Array ruby_row(ruby_matrix[i]);
+		
+		for (unsigned int j = 0; j < ruby_row.size(); j++) {
+			int* value = (int*)(ruby_row[j].value());
+			row.push_back(*value);
+		}
+		
+		matrix.push_back(row);
+	}
+	
+	return matrix;
+}
+
 /*------------------------*
  * Rice class definitions *
  *------------------------*/
@@ -188,11 +245,12 @@ extern "C" void Init_sirens() {
 	Data_Type<FeatureSet> rb_cFeatureSet = 
 		define_class_under<FeatureSet>(rb_mSirens, "FeatureSet")
 		.define_constructor(Constructor<FeatureSet>())
+		.define_method("addSampleFeature", &FeatureSet::addSampleFeature)
+		.define_method("addSpectralFeature", &FeatureSet::addSpectralFeature)
 		.define_method("sampleFeatures", &FeatureSet::getSampleFeatures)
-		.define_method("sampleFeatures=", &FeatureSet::setSampleFeatures)
 		.define_method("spectralFeatures", &FeatureSet::getSpectralFeatures)
-		.define_method("spectralFeatures=", &FeatureSet::setSpectralFeatures)
-		.define_method("features", &FeatureSet::getFeatures);
+		.define_method("features", &FeatureSet::getFeatures)
+		.define_method("minHistorySize", &FeatureSet::getMinHistorySize);
 		
 	Data_Type<SegmentationParameters> rb_cSegmentationParameters = 
 		define_class_under<SegmentationParameters>(rb_mSirens, "SegmentationParameters")
@@ -220,14 +278,24 @@ extern "C" void Init_sirens() {
 	Data_Type<Segmenter> rb_cSegmenter = 
 		define_class_under<Segmenter>(rb_mSirens, "Segmenter")
 		.define_constructor(Constructor<Segmenter>())
+		.define_method("features=", &Segmenter::setFeatures)
+		.define_method("features", &Segmenter::getFeatures)
 		.define_method("pNew", &Segmenter::getPNew)
 		.define_method("pNew=", &Segmenter::setPNew)
 		.define_method("pOff", &Segmenter::getPOff)
 		.define_method("pOff=", &Segmenter::setPOff)
 		.define_method("segments", &Segmenter::getSegments)
 		.define_method("modes", &Segmenter::getModes)
-		.define_method("segment", &Segmenter::getSegments);
-		
+		.define_method("segment", &Segmenter::segment);
+	
+	Data_Type<SoundComparator> rb_cSoundComparator = 
+		define_class_under<SoundComparator>(rb_mSirens, "SoundComparator")
+		.define_constructor(Constructor<SoundComparator>())
+		.define_method("features=", &SoundComparator::setFeatures)
+		.define_method("features", &SoundComparator::getFeatures)
+		.define_method("compare", &SoundComparator::compare)
+		.define_method("initializeModel", &SoundComparator::initialize);
+	
 	/* 	
 		FeatureBase is an unused base class that implements Feature. Feature is the
 	 	actual class that implements RiceFeature, the wrapper Feature class that 
@@ -237,7 +305,7 @@ extern "C" void Init_sirens() {
 	Data_Type<Feature> rb_cFeature = 
 		define_class_under<Feature>(rb_mSirens, "FeatureBase")
 		.define_constructor(Constructor<Feature>())
-		.define_method("to_s", &Feature::toString)
+		.define_method("featureName", &Feature::toString)
 		.define_method("history", &Feature::getHistory)
 		.define_method("history[]", &Feature::getHistoryFrame)
 		.define_method("maxHistorySize", &Feature::getMaxHistorySize)

data/sirens.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sirens}
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brandon Mechtley"]
-  s.date = %q{2009-08-25}
+  s.date = %q{2009-09-01}
   s.description = %q{Ruby gem that implements Sirens, a library for segmentation, indexing, and retrieval of environmental and natural sounds.}
   s.email = %q{bmechtley+github@gmail.com}
   s.extensions = ["ext/sirens/extconf.rb"]
@@ -19,9 +19,13 @@ Gem::Specification.new do |s|
      "README.markdown",
      "Rakefile",
      "VERSION",
+     "examples/features.rb",
+     "examples/retrieval.rb",
      "examples/segmentation.rb",
-     "examples/sound.wav",
-     "examples/three_features.rb",
+     "examples/sounds/whistle1.wav",
+     "examples/sounds/whistle2.wav",
+     "examples/sounds/whistle3.wav",
+     "examples/sounds/whistle4.wav",
      "ext/sirens/extconf.rb",
      "ext/sirens/extconf.rb",
      "ext/sirens/sirens.cpp",
@@ -34,8 +38,9 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.3}
   s.summary = %q{Ruby gem that for the Sirens library.}
   s.test_files = [
-    "examples/segmentation.rb",
-     "examples/three_features.rb"
+    "examples/features.rb",
+     "examples/retrieval.rb",
+     "examples/segmentation.rb"
   ]
 
   if s.respond_to? :specification_version then

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: plant-sirens
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Brandon Mechtley
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-25 00:00:00 -07:00
+date: 2009-09-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -36,15 +36,18 @@ files:
 - README.markdown
 - Rakefile
 - VERSION
+- examples/features.rb
+- examples/retrieval.rb
 - examples/segmentation.rb
-- examples/sound.wav
-- examples/three_features.rb
+- examples/sounds/whistle1.wav
+- examples/sounds/whistle2.wav
+- examples/sounds/whistle3.wav
+- examples/sounds/whistle4.wav
 - ext/sirens/extconf.rb
 - ext/sirens/sirens.cpp
 - sirens.gemspec
 has_rdoc: false
 homepage: http://github.com/plant/sirens-ruby
-licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -65,10 +68,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
 summary: Ruby gem that for the Sirens library.
 test_files: 
+- examples/features.rb
+- examples/retrieval.rb
 - examples/segmentation.rb
-- examples/three_features.rb

data/examples/three_features.rb

@@ -1,27 +0,0 @@
-require 'rubygems'
-require 'sirens'
-include Sirens
-
-s = Sound.new
-s.frameLength = 0.04
-s.hopLength = 0.02
-s.open('sound.wav')
-l = Loudness.new
-ss = SpectralSparsity.new
-ts = TemporalSparsity.new
-
-[l, ss, ts].each do |f|
-  f.maxHistorySize = s.frames
-end
-
-s.sampleFeatures = [l, ts]
-s.spectralFeatures = [ss]
-
-s.extractFeatures
-
-s.close
-
-[l, ss, ts].each do |f|
-	f.history.each {|value| print value, ','}
-	print "\n"
-end