pocketsphinx-ruby 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0129cb6b05e984d481f79c27fd085cb119eb195f
-  data.tar.gz: 9a6e6c3750992d6a1d3c7b8d80005b03e7d01b5c
+  metadata.gz: 3b38998dd59c577300db4b63bfda52e037c49409
+  data.tar.gz: 82dd10ee0f739d6459013513ae986d6e60124dfd
 SHA512:
-  metadata.gz: ef774d606a2c53df8c88e42fb9593cada5347993feb0bf7b044362faf8b5ba28cc8728674732125bef1cd7b7cc78ee8a9ed81d092c4d08b626758e6d93929754
-  data.tar.gz: 656a27d5578fc665116afaa1b63a76ae81e7616cf6f1af49fa65dffca6f01a5e9e5941df2a6b6e9ac825c48e9b9854e77d70cf0eae4b4011b24a5fed3baa4dc1
+  metadata.gz: d11e77f70106d9beaab587e7c8372dc217a9e511e7058e6d4f0a55fb4ce040b5ad50ef203a9755324ebaccc6fe919919eb04e5bb4770a290413b9990cecbfec6
+  data.tar.gz: fbea33173c9c8bdca4458c2dcb1f88e5643be169d8a54f4ed3baf593677f790d754e0f58a1c37ca527cbfeeeb9c0b19b28461afe417da509c2073543c33522ee

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+**v0.2.0 - 03/03/15**
+
+* Updated to latest Pocketsphinx API interface
+
+
 **v0.1.1 - 29/10/14**
 
 * Allow logging to be disabled

data/README.md

@@ -139,14 +139,14 @@ puts decoder.hypothesis # => "go forward ten years"
 
 ### Keyword Spotting
 
-Keyword spotting is another feature that is not in the current stable (0.8) releases of Pocketsphinx, having been [merged into trunk](https://github.com/cmusphinx/pocketsphinx/commit/f562f9356cc7f1ade4941ebdde0c377642a023e3) early in 2014. In can be useful for detecting an activation keyword in a command and control application, while ignoring all other speech. Set up a recognizer as follows:
+Keyword spotting is another feature that is not in the current stable (0.8) releases of Pocketsphinx, having been [merged into trunk](https://github.com/cmusphinx/pocketsphinx/commit/f562f9356cc7f1ade4941ebdde0c377642a023e3) early in 2014. It can be useful for detecting an activation keyword in a command and control application, while ignoring all other speech. Set up a recognizer as follows:
 
 ```ruby
 configuration = Pocketsphinx::Configuration::KeywordSpotting.new('Okay computer')
 recognizer = Pocketsphinx::LiveSpeechRecognizer.new(configuration)
 ```
 
-The `KeywordSpotting` configuration accepts a second argument for adjusting the sensitivity of the keyword detection. Note that this is just a wrapper which sets the `keyphrase` and `kws_threshold` settings on the default configuration:
+The `KeywordSpotting` configuration accepts a second argument for adjusting the sensitivity of the keyword detection. Note that this is just a wrapper which sets the `keyphrase` and `kws_threshold` settings on the default configuration, and removes the language model:
 
 ```ruby
 Pocketsphinx::Configuration::KeywordSpotting.new('keyword', 2).changes
@@ -177,9 +177,19 @@ configuration = Pocketsphinx::Configuration::Grammar.new do
 end
 ```
 
+## Recognition Accuracy and Training
+
+See the CMU Sphinx resources on [training](http://cmusphinx.sourceforge.net/wiki/tutorialam) and [adapting](http://cmusphinx.sourceforge.net/wiki/tutorialadapt) acoustic models for more information.
+
+[Peter Grasch](http://grasch.net/), author of [Simon](https://simon.kde.org/), has also made a number of interesting posts on the [state of open source speech recognition](http://grasch.net/node/19), as wells as improving [language](http://grasch.net/node/20) and [acoustic](http://grasch.net/node/21) models.
+
+See [`sphinxtrain-ruby`](https://github.com/watsonbox/sphinxtrain-ruby) for an experimental toolkit for training/adapting CMU Sphinx acoustic models. Its main goal is to help with adapting existing acoustic models to a specific speaker/accent.
+
 
 ## Troubleshooting
 
+First and foremost, because this gem **depends on development versions** of CMU Sphinx packages, there will be times when errors are caused by API changes or bugs in those packages. Unfortunately until some up to date releases are made this is going to happen from time to time, so please do open an issue with as much detail as you have.
+
 This gem has been tested with a manual Pocketsphinx installation on Ubuntu 14.04 and a Homebrew Pocketsphinx installation on OSX 10.9.4 Mavericks. Take a look at the following common problems before opening an issue.
 
 **`attach_function': Function 'ps_default_search_args' not found in [libpocketsphinx.so] (FFI::NotFoundError)**

data/lib/pocketsphinx/api/pocketsphinx.rb

@@ -11,12 +11,12 @@ module Pocketsphinx
       attach_function :ps_reinit, [:decoder, :configuration], :int
       attach_function :ps_default_search_args, [:pointer], :void
       attach_function :ps_args, [], :pointer
-      attach_function :ps_decode_raw, [:decoder, :pointer, :string, :long], :int
+      attach_function :ps_decode_raw, [:decoder, :pointer, :long], :int
       attach_function :ps_process_raw, [:decoder, :pointer, :size_t, :int, :int], :int
-      attach_function :ps_start_utt, [:decoder, :string], :int
+      attach_function :ps_start_utt, [:decoder], :int
       attach_function :ps_end_utt, [:decoder], :int
       attach_function :ps_get_in_speech, [:decoder], :uint8
-      attach_function :ps_get_hyp, [:decoder, :pointer, :pointer], :string
+      attach_function :ps_get_hyp, [:decoder, :pointer], :string
       attach_function :ps_set_jsgf_string, [:decoder, :string, :string], :int
       attach_function :ps_unset_search, [:decoder, :string], :int
       attach_function :ps_get_search, [:decoder], :string

data/lib/pocketsphinx/decoder.rb

@@ -5,10 +5,10 @@ module Pocketsphinx
     include API::CallHelpers
 
     class Hypothesis < SimpleDelegator
-      attr_accessor :path_score, :utterance_id
+      attr_accessor :path_score
 
-      def initialize(string, path_score, utterance_id)
-        @path_score, @utterance_id = path_score, utterance_id
+      def initialize(string, path_score)
+        @path_score = path_score
         super(string)
       end
     end
@@ -80,10 +80,8 @@ module Pocketsphinx
     # This function should be called before any utterance data is passed
     # to the decoder.  It marks the start of a new utterance and
     # reinitializes internal data structures.
-    #
-    # @param [String] name String uniquely identifying this utterance. If nil, one will be created.
-    def start_utterance(name = nil)
-      api_call :ps_start_utt, ps_decoder, name
+    def start_utterance
+      api_call :ps_start_utt, ps_decoder
     end
 
     # End utterance processing
@@ -101,14 +99,12 @@ module Pocketsphinx
     # @return [Hypothesis] Hypothesis (behaves like a string)
     def hypothesis
       mp_path_score = FFI::MemoryPointer.new(:int32, 1)
-      mp_utterance_id = FFI::MemoryPointer.new(:pointer, 1)
 
-      hypothesis = ps_api.ps_get_hyp(ps_decoder, mp_path_score, mp_utterance_id)
+      hypothesis = ps_api.ps_get_hyp(ps_decoder, mp_path_score)
 
       hypothesis.nil? ? nil : Hypothesis.new(
         hypothesis,
-        mp_path_score.get_int32(0),
-        mp_utterance_id.read_pointer.read_string.force_encoding('UTF-8')
+        mp_path_score.get_int32(0)
       )
     end
 

data/lib/pocketsphinx/version.rb

@@ -1,3 +1,3 @@
 module Pocketsphinx
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/spec/configuration_spec.rb

@@ -65,7 +65,7 @@ describe Pocketsphinx::Configuration do
 
   describe '#setting_names' do
     it 'contains the names of all possible system settings' do
-      expect(subject.setting_names.count).to eq(117)
+      expect(subject.setting_names.count).to eq(112)
     end
   end
 
@@ -84,7 +84,7 @@ describe Pocketsphinx::Configuration do
     it 'gives details for all settings when no name is specified' do
       details = subject.details
 
-      expect(details.count).to eq(117)
+      expect(details.count).to eq(112)
       expect(details.first).to eq({
         name: "agc",
         type: :string,

data/spec/decoder_spec.rb

@@ -80,19 +80,19 @@ describe Pocketsphinx::Decoder do
     it 'calls libpocketsphinx' do
       expect(ps_api)
         .to receive(:ps_start_utt)
-        .with(subject.ps_decoder, "Utterance Name")
+        .with(subject.ps_decoder)
         .and_return(0)
 
-      subject.start_utterance("Utterance Name")
+      subject.start_utterance
     end
 
     it 'raises an exception on error' do
       expect(ps_api)
         .to receive(:ps_start_utt)
-        .with(subject.ps_decoder, "Utterance Name")
+        .with(subject.ps_decoder)
         .and_return(-1)
 
-      expect { subject.start_utterance("Utterance Name") }
+      expect { subject.start_utterance }
         .to raise_exception "Decoder#start_utterance failed with error code -1"
     end
   end
@@ -132,13 +132,11 @@ describe Pocketsphinx::Decoder do
   describe '#hypothesis' do
     it 'calls libpocketsphinx' do
       expect(ps_api)
-        .to receive(:ps_get_hyp) do |ps_decoder, mp_path_score, mp_utterance_id|
+        .to receive(:ps_get_hyp) do |ps_decoder, mp_path_score|
           expect(ps_decoder).to eq(subject.ps_decoder)
           expect(mp_path_score).to be_a(FFI::MemoryPointer)
-          expect(mp_utterance_id).to be_a(FFI::MemoryPointer)
 
           mp_path_score.put_int32(0, 20)
-          mp_utterance_id.write_pointer(FFI::MemoryPointer.from_string("Utterance"))
 
           "Hypothesis"
         end
@@ -147,7 +145,6 @@ describe Pocketsphinx::Decoder do
 
       expect(hypothesis).to eq("Hypothesis")
       expect(hypothesis.path_score).to eq(20)
-      expect(hypothesis.utterance_id).to eq("Utterance")
     end
   end
 

data/spec/integration/decoder_spec.rb

@@ -15,14 +15,12 @@ describe Pocketsphinx::Decoder do
       @decoder.ps_api = nil
       subject.decode File.open('spec/assets/audio/goforward.raw', 'rb')
 
-      # With the default configuration (no specific grammar), pocketsphinx doesn't actually
-      # get this quite right, but nonetheless this is the expected output
-      expect(subject.hypothesis).to eq("go forward ten years")
+      expect(subject.hypothesis).to eq("go forward ten meters")
     end
 
     it 'accepts a file path as well as a stream' do
       subject.decode 'spec/assets/audio/goforward.raw'
-      expect(subject.hypothesis).to eq("go forward ten years")
+      expect(subject.hypothesis).to eq("go forward ten meters")
     end
   end
 end

data/spec/integration/default_recognition_spec.rb

@@ -15,7 +15,7 @@ describe 'speech recognition with default configuration' do
   describe '#recognize' do
     it 'should decode speech in raw audio' do
       expect { |b| subject.recognize('spec/assets/audio/goforward.raw', 4096, &b) }.
-        to yield_with_args("go forward ten years")
+        to yield_with_args("go forward ten meters")
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pocketsphinx-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Howard Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-29 00:00:00.000000000 Z
+date: 2015-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi