diarize-ruby 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dafc97802993d69707c60a493e72101e1932606b
-  data.tar.gz: acb88c8eb0763d173ee517822b3ed914b5ec3fe9
+  metadata.gz: fea2a948f5ae15b922bf1911df35c3bdfb24b5f3
+  data.tar.gz: ff9da8967f4f5b9692669c677833fe449154fa18
 SHA512:
-  metadata.gz: 4fa5cce850d478dd15b313eedff3c891083cd8f9026bc682d429bba7fc1c516a0c34cd30fca76f1c4ea681ba9d056c636218669637ba4ba005308b9c4b6daaa7
-  data.tar.gz: 2bf3b289e0ecf7cd74008ce8b163f1ce475e265cca930a68ee6bd4a2bea7007ec4e77c2675da65a8af08224ed0054d7a084cd10b488336565b65c5f0dd18aea0
+  metadata.gz: 42de27a42610a7c04409f04d56d2b124eed8fa0418843516701c1cb18092ed4fe05aa1fee015d2019438443fa7c016b10fc51391bcfb7d99c1bdab28f8cb514d
+  data.tar.gz: cdf8c7a4e935db59c4b3a678c56e0b18e9be41f906583d939e86feb596f62847905b5c6a766575108bf7be973661e1a3b6e56b16ee754a37e69d9073f36d4c83

data/AUTHORS

@@ -5,8 +5,7 @@ British Broadcasting Corporation
 
 - Yves Raimond <yves.raimond at bbc.co.uk>
 
-
 Other
 -----
 
-- Juergen Fesslmeier <jfesslmeier@gmail.com>
+- Juergen Fesslmeier <jfesslmeier at gmail dot com>

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## [v0.3.1] - 2016-11-08
+
+- Fixed README and examples
+- First round to fix audio playback
+- Move LIUM jar into bin folder
+- Use `DIARIZE_RUBY_RJB_LOAD_PATH` env variable for alternative loading
+
+## [v0.3.0] - 2016-11-08
+
+- Pushed first version of v0.3.0 to rubygems.org

data/README.md

@@ -1,25 +1,26 @@
 # diarize-ruby
 
-This library provides an easy-to-use toolkit for speaker
-segmentation (diarization) and identification from audio.
+This library provides an easy-to-use toolkit for speaker segmentation (diarization) and identification from audio.
 
-This library is being used within the BBC R&D World Service
-archive prototype.
+This library was adopted from [diarize-jruby](https://github.com/bbc/diarize-jruby), being used within the BBC R&D World Service.
 
-See http://worldservice.prototyping.bbc.co.uk/programmes/X0403940 for
-an example.
+The main reason from deviating from the original library is to have a universal gem that works with either Ruby interpreter. It uses [Ruby Java Bridge](http://rjb.rubyforge.org) instead of [JRuby](http://jruby.org).
 
+Work to be done:
 
-## Speaker diarization
+* Universal gem that works on JRuby and various Ruby implementations (MRI) and versions
+* Use performant math packages tuned to either Ruby implementation
+* Add support for alternative diarization tools
+* Add CI tool
+
+## Speaker Diarization
 
 This library gives acccess to the algorithm developed by the LIUM
 for the ESTER 2 evaluation campaign and described in [Meigner2010].
 
-It wraps a binary JAR file compiled from
-http://lium3.univ-lemans.fr/diarization/doku.php/welcome.
-
+It wraps a binary JAR file compiled from [LIUM](http://lium3.univ-lemans.fr/diarization/doku.php/welcome).
 
-## Speaker identification
+## Speaker Identification
 
 This library also implements an algorithm for speaker identification
 based on the comparison of normalised speaker models, which can be
@@ -36,14 +37,24 @@ It also includes support for speaker supervectors [Campbell2006], which
 can be used in combination with our ruby-lsh library for fast speaker
 identification.
 
+## Install
+
+    $ bundle install
+
+Note: To make audio playback work with [Audio Playback](https://github.com/arirusso/audio-playback), you should install the following native libraries (homebrew):
+
+    brew install libffi
+    brew install portaudio
 
-## Example use
+If you are using a different version of LIUM than what is bundled in the `bin` folder, you can do so by setting an environment variable.
 
-    $ jruby -S gem install diarize-jruby
-    $ jruby -S irb
-    > require 'diarize'
-    > audio = Diarize::Audio.new URI('http://example.com/file.wav')
-    > audio = Diarize::Audio.new URI.join('file:///', '/Users/juergen/work/ruby/diarize-ruby/test/data/will-and-juergen.wav')
+    $ export DIARIZE_RUBY_RJB_LOAD_PATH=<path-to-LIUM-jar-file>
+
+## Examples
+
+    $ irb -I lib
+    > require "diarize"
+    > audio = Diarize::Audio.new URI.join('file:///', File.join(File.expand_path(File.dirname(__FILE__)), "test", "data", "will-and-juergen.wav"))
     > audio.analyze!
     > audio.segments
     > audio.speakers
@@ -55,7 +66,7 @@ identification.
     > audio.segments_by_speaker(speakers.first)[0].play
     > audio.segments_by_speaker(speakers.first)[1].play
     > ...
-    > speakers |= other_speakers
+    > speakers ||= other_speakers
     > Diarize::Speaker.match(speakers)
 
 
@@ -63,7 +74,6 @@ identification.
 
     $ rake
 
-
 ## References
 
 [Meigner2010] S. Meignier and T. Merlin, "LIUM SpkDiarization:
@@ -86,8 +96,7 @@ Proceedings of INTERSPEECH, 2005
 "Support vector machines using GMM supervectors for speaker verification",
 IEEE Signal Processing Letters, 2006, 13, 308-311
 
-
-## Licensing terms and authorship
+## License
 
 See 'LICENSE' and 'AUTHORS' files.
 
@@ -101,9 +110,8 @@ is licensed under the GNU General Public License version 2. See
 http://lium3.univ-lemans.fr/diarization/doku.php/licence for more
 information.
 
-
 ## Developer Resources
 
 * [Connecting Ruby to Java and vice versa](http://nofail.de/2010/04/ruby-in-java-java-in-ruby-jruby-or-ruby-java-bridge/)
 * [LIUM scripts](https://github.com/StevenLOL/LIUM/blob/master/ilp_diarization2.sh)
-* [Speaker Identification for the whole World Service Archive](http://www.bbc.co.uk/rd/blog/2014-01-speaker-identification-for-the-whole-world-service-archive)
+* [Speaker Identification for the whole World Service Archive](http://www.bbc.co.uk/rd/blog/2014-01-speaker-identification-for-the-whole-world-service-archive)

data/diarize-ruby.gemspec

@@ -24,8 +24,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "test-unit", "~> 3.0"
   spec.add_development_dependency "mocha", "~> 1.1"
   spec.add_development_dependency "webmock", "~> 2.1"
+  spec.add_development_dependency "byebug", "~> 9.0"
 
   spec.add_dependency "rjb", "~> 1.5"
   spec.add_dependency "to-rdf", "~> 0"
   spec.add_dependency "jblas-ruby", "~> 1.1"
+  spec.add_dependency "audio-playback"
 end

data/lib/diarize.rb

@@ -1,11 +1,12 @@
 require "rjb"
 
-RJB_LOAD_PATH = [File.join(File.expand_path(File.dirname(__FILE__)), 'diarize', 'LIUM_SpkDiarization-4.2.jar')].join(File::PATH_SEPARATOR)
+RJB_LOAD_PATH = [ENV.fetch('DIARIZE_RUBY_RJB_LOAD_PATH', File.join(File.expand_path('..', File.dirname(__FILE__)), 'bin', 'LIUM_SpkDiarization-4.2.jar'))].join(File::PATH_SEPARATOR)
 RJB_OPTIONS   = ['-Xms16m', '-Xmx1024m']
 
 Rjb::load(RJB_LOAD_PATH, RJB_OPTIONS)
 
 require "matrix"
+require "audio-playback"
 require "diarize/version"
 require "diarize/lium"
 require "diarize/audio"

data/lib/diarize/audio_player.rb

@@ -2,21 +2,19 @@ module Diarize
 
   class AudioPlayer
 
-    def play(file, start=0.0, duration=10.0)
-      java_file = java.io.File.new(file.path)
-      stream = javax.sound.sampled.AudioSystem.getAudioInputStream(java_file)
-      clip = javax.sound.sampled.AudioSystem.clip
-      clip.open(stream)
-      clip.setMicrosecondPosition(start * 1000000)
-      clip.start
-      begin
-        sleep(duration)
-      rescue Exception
-        $stderr.puts 'Stopping playback'
-      end
-      clip.stop
-      clip.close
-      stream.close
+    def play(file, options = {})
+      output = AudioPlayback::Device::Output.by_id(1) rescue nil
+      defaults = {
+        :channels      => [0, 1],
+        :latency       => 1,
+        :output_device => output,
+        :buffer_size   => 4048
+      }
+      options, stream = defaults.merge(options), nil
+      playback = AudioPlayback.play(file.path, options)
+      stream ||= playback.stream
+      stream.start
+      stream.block
     end
 
   end

data/lib/diarize/segment.rb

@@ -23,9 +23,9 @@ module Diarize
       Speaker.find_or_create(URI("#{@audio.base_uri}##{@speaker_id}"), @speaker_gender)
     end
 
-    def play
+    def play(options = {})
       player = AudioPlayer.new
-      player.play(@audio.file, start, duration)
+      player.play(@audio.file, options.merge({:start => start, :duration => duration}))
     end
 
     include ToRdf

data/lib/diarize/version.rb

@@ -1,3 +1,3 @@
 module Diarize
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diarize-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Yves Raimond
@@ -53,6 +53,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: rjb
   requirement: !ruby/object:Gem::Requirement
@@ -95,6 +109,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: audio-playback
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A library for Ruby wrapping the LIUM Speaker Diarization and including
   a few extra tools
 email:
@@ -107,13 +135,14 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - AUTHORS
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- bin/LIUM_SpkDiarization-4.2.jar
 - diarize-ruby.gemspec
 - lib/diarize.rb
-- lib/diarize/LIUM_SpkDiarization-4.2.jar
 - lib/diarize/audio.rb
 - lib/diarize/audio_player.rb
 - lib/diarize/lium.rb