plant / sirens-ruby

Branches (1)
- master ✓
Tags (0)

Ruby gem that implements Sirens, a library for segmentation, indexing, and retrieval of environmental and natural sounds — Read more

This URL has Read+Write access

version bump and inclusion of estimate results

plant (author)

Mon Nov 30 16:00:42 -0800 2009

commit 8e828671adbede42d2727b7cb9e5ae393c953996
tree 7433a597fca98a03a173985c001f4aba87b19aed
parent 740b3ee7e1d91db76237afb9ed73254146728fc7

sirens-ruby /

name	age	history message
LICENSE	Tue May 19 22:35:45 -0700 2009	Initial commit to soundwalk-api. [plant]
README.markdown	Mon Sep 07 20:55:31 -0700 2009	simpler install instructions [plant]
Rakefile	Mon Aug 24 14:38:25 -0700 2009	version bump [plant]
VERSION	Sat Nov 28 14:57:30 -0800 2009	Version bump to 0.5.0 [plant]
examples/	Sat Nov 28 14:59:36 -0800 2009	update to reflect change in sirens: simplified ... [plant]
ext/	Mon Nov 30 16:00:42 -0800 2009	version bump and inclusion of estimate results [plant]
sirens.gemspec	Mon Nov 30 16:00:42 -0800 2009	version bump and inclusion of estimate results [plant]

README.markdown

sirens-ruby

sirens-ruby is a ruby extension for Sirens, a library for segmentation, indexing, and retrieval of environmental and natural sounds. Sirens is currently under development and is only ready to use for feature extraction and segmentation. Please check back for updates on retrieval and indexing.

Requirements

To install sirens-ruby, it is necessary to have these two libraries:

Additionally, sirens-ruby has the following gem dependencies, which RubyGems should take care of:

Installation

To install sirens-ruby, type:

gem sources -a http://gems.github.com
sudo gem install plant-sirens

If you are using OSX, Rice has some issues with building in some environments. To fix this, you need to specify which architecture (Intel or PowerPC) to use when you install the gem, e.g.:

sudo bash
ARCHFLAGS="-arch i386" gem install plant-sirens -- --build-flags

replacing i386 with ppc if you are using a PowerPC machine.

Local installation

If you do not have root access, you may have some problems, as the Rice gem uses a nonstandard installation procedure that attempts to install the library in a path outside where the gem is installed. There may be an easier workaround for this by passing some options to rubygems, but the only solution I've found so far is to install Rice manually from source before installing sirens-ruby. If you are installing on OSX, please see this ticket for tips on installing from source.

FFTW and libsndfile can both be installed locally by changing the prefix path in their configure steps, e.g.

./configure --prefix=$HOME

Sirens can be installed similarly:

scons install --prefix=$HOME

After installing Rice from source, if you have not installed it as a gem, you may have troubles with gem dependencies when installing sirens-ruby. To get around this, you can ignore gem dependencies:

gem --ignore-dependencies install plant-sirens

If you have any problems with this process, please submit an issue and I'll try to help as soon as possible.

Usage

RDoc documentation and a full tutorial is to come, but for now, you can check out some example code in the examples/ directory to get an idea of how the extension works.