rist 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 37cde15cbc2351d914b250f95813ac49250218a2
+  data.tar.gz: e72797409c6a9970d18a428a6a0701f7faae5cc2
+SHA512:
+  metadata.gz: 625e3e9c074673589d9d8dc0c6af9e9403bc3d1711749749a00117740ec0924dfab0bbd32bdc142d1592f51e84bd63122e34a2e135bf158fff384a749c2aee35
+  data.tar.gz: 73c5b2866f0d8cedcb791cd568fac5212de3549dc00472945b7bf14414d9a641c8599e112105915466d71f91331f9d8020644e6f1702ffb3024a89ccdae07be1

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Zhi-Qiang Lei
+
+MIT License
+
+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/README.md

@@ -0,0 +1,43 @@
+# Rist
+
+Rist (Ruby Intelligent System Tools) is a tool set to build Intelligent System.
+
+## Installation
+
+*Warning: OpenAL and Pocketsphinx (> 0.8) are prerequisite.*
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rist'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rist
+
+## Usage
+
+### Transcriber
+
+Transcriber captures audio using OpenAL and turns the audio into text using [Pocketsphinx](http://cmusphinx.sourceforge.net/).
+
+```ruby
+transcriber = Rist::Transcriber.new logfn: "/dev/null"
+
+transcriber.transcribe do |utterance|
+  puts utterance
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/siegfried/rist/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/ext/transcriber/extconf.rb

@@ -0,0 +1,22 @@
+require 'mkmf'
+
+unless find_header 'AL/al.h', '/usr/local/include', '/usr/include'
+  abort 'cannot find OpenAL, please install it.'
+end
+unless find_header 'AL/alc.h', '/usr/local/include', '/usr/include'
+  abort 'cannot find OpenAL, please install it.'
+end
+unless find_header 'pocketsphinx/pocketsphinx_export.h', '/usr/local/include', '/opt/include', '/usr/include'
+  abort 'cannot find pocketsphinx, please install it.'
+end
+unless find_header 'sphinxbase/sphinxbase_export.h', '/usr/local/include', '/opt/include', '/usr/include'
+  abort 'cannot find sphinxbase, please install it.'
+end
+find_header 'pocketsphinx_export.h', '/usr/local/include/pocketsphinx', '/opt/include/pocketsphinx', '/usr/include/pocketsphinx'
+find_header 'sphinxbase_export.h', '/usr/local/include/sphinxbase', '/opt/include/sphinxbase', '/usr/include/sphinxbase'
+
+find_library 'pocketsphinx', 'ps_init', '/usr/local/lib', '/opt/lib', '/usr/lib'
+find_library 'sphinxbase', 'cmd_ln_init', '/usr/local/lib', '/opt/lib', '/usr/lib'
+find_library 'openal', 'alcCaptureOpenDevice'
+
+create_makefile 'transcriber/transcriber'

data/ext/transcriber/transcriber.c

@@ -0,0 +1,145 @@
+#include <ruby.h>
+#include <AL/al.h>
+#include <AL/alc.h>
+#include <pocketsphinx.h>
+
+static const arg_t cont_args_def[] = {
+    POCKETSPHINX_OPTIONS,
+    /* Argument file. */
+    {"-argfile",
+     ARG_STRING,
+     NULL,
+     "Argument file giving extra arguments."},
+    CMDLN_EMPTY_OPTION
+};
+
+typedef struct {
+    ps_decoder_t * decoder;
+} Transcriber;
+
+static VALUE rb_mRist,
+             rb_cTranscriber;
+
+static void transcriber_deallocate(Transcriber * transcriber) {
+    ps_free(transcriber -> decoder);
+    xfree(transcriber);
+}
+
+static VALUE transcriber_allocate(VALUE self) {
+    Transcriber * transcriber;
+    return Data_Make_Struct(self, Transcriber, 0, transcriber_deallocate, transcriber);
+}
+
+static VALUE transcriber_initialize_pocketsphinx(VALUE self, VALUE arguments) {
+    Transcriber * transcriber;
+    char ** argv;
+    cmd_ln_t * config;
+    int i, argc;
+
+    argc = RARRAY_LEN(arguments);
+    argv = ALLOC_N(char *, argc);
+    for (i = 0; i < argc; i++) {
+        argv[i] = RSTRING_PTR(rb_ary_entry(arguments, i));
+    }
+    config = cmd_ln_parse_r(NULL, cont_args_def, argc, argv, TRUE);
+    xfree(argv);
+
+    if (config == NULL)
+        rb_raise(rb_eArgError, "bad configuration");
+    ps_default_search_args(config);
+
+    Data_Get_Struct(self, Transcriber, transcriber);
+    if ((transcriber -> decoder = ps_init(config)) == NULL) {
+        cmd_ln_free_r(config);
+        rb_raise(rb_eRuntimeError, "failed to initialize pocketsphinx");
+    }
+
+    return self;
+}
+
+static void close_raise(ALCdevice * device, VALUE error, const char * message) {
+    alcCaptureCloseDevice(device);
+    rb_raise(error, "%s\n", message);
+}
+
+static int32 al_read(ALCdevice * device, int16 * buffer, int32 max) {
+    ALCint number;
+
+    alcGetIntegerv(device, ALC_CAPTURE_SAMPLES, sizeof(number), &number);
+    if (number >= 0) {
+        number = (number < max ? number : max);
+        alcCaptureSamples(device, buffer, number);
+    }
+
+    return number;
+}
+
+/* Transcribe speech continuously.
+ *
+ * for block { |utterance| ... }
+ * @yield [utterance] do whatever you want to do with the utterance transcribed
+ *
+ * @yieldparam [String] utterance the utterance transcribed
+ */
+static VALUE transcriber_transcribe(VALUE self)
+{
+    ALCdevice * device;
+    ALCuint frequency;
+    Transcriber * transcriber;
+    cmd_ln_t *config;
+    const char * hyp;
+    const char * uttid;
+    int16 adbuf[4096];
+    int32 k;
+    ps_decoder_t * ps;
+    uint8 utt_started, in_speech;
+
+    Data_Get_Struct(self, Transcriber, transcriber);
+    ps = transcriber -> decoder;
+    config = ps_get_config(ps);
+    frequency = cmd_ln_float32_r(config, "-samprate");
+
+    device = alcCaptureOpenDevice(NULL, frequency, AL_FORMAT_MONO16, frequency * 10);
+    if (device == NULL)
+        rb_raise(rb_eRuntimeError, "failed to open audio device");
+    alcCaptureStart(device);
+
+    if (ps_start_utt(ps, NULL) < 0)
+        close_raise(device, rb_eRuntimeError, "failed to start utterance");
+    utt_started = FALSE;
+
+    /* Indicate listening for next utterance */
+    for (;;) {
+        if ((k = al_read(device, adbuf, 4096)) < 0)
+            close_raise(device, rb_eRuntimeError, "failed to read audio");
+        rb_funcall(self, rb_intern("sleep"), 1, rb_float_new(0.1));
+        ps_process_raw(ps, adbuf, k, FALSE, FALSE);
+        in_speech = ps_get_in_speech(ps);
+        if (in_speech && !utt_started) {
+            utt_started = TRUE;
+        }
+        if (!in_speech && utt_started) {
+            //speech -> silence transition, 
+            //time to start new utterance
+            ps_end_utt(ps);
+            hyp = ps_get_hyp(ps, NULL, &uttid);
+
+            // yield result
+            rb_yield(rb_str_new2(hyp));
+
+            if (ps_start_utt(ps, NULL) < 0)
+                close_raise(device, rb_eRuntimeError, "failed to start utterance");
+            /* Indicate listening for next utterance */
+            utt_started = FALSE;
+        }
+    }
+    alcCaptureCloseDevice(device);
+}
+
+void Init_transcriber() {
+    rb_mRist = rb_define_module("Rist");
+    rb_cTranscriber = rb_define_class_under(rb_mRist, "Transcriber", rb_cObject);
+    rb_define_alloc_func(rb_cTranscriber, transcriber_allocate);
+    rb_define_private_method(rb_cTranscriber, "initialize_pocketsphinx", transcriber_initialize_pocketsphinx, 1);
+    rb_define_method(rb_cTranscriber, "transcribe", transcriber_transcribe, 0);
+}

data/lib/rist/transcriber.rb

@@ -0,0 +1,11 @@
+require 'transcriber/transcriber'
+
+class Rist::Transcriber
+
+  # @param [Hash] options the options to initialize a transcriber identical to Pocketsphinx arguments
+  def initialize(options = {})
+    arguments = options.inject([]) { |result, (key, value)| result + ["-#{key.to_s}", value.to_s] }
+    initialize_pocketsphinx(arguments);
+  end
+
+end

data/lib/rist/version.rb

@@ -0,0 +1,3 @@
+module Rist
+  VERSION = "0.0.1"
+end

data/lib/rist.rb

@@ -0,0 +1,6 @@
+require 'rist/transcriber'
+require 'rist/version'
+
+module Rist
+  # Your code goes here...
+end

data/rist.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rist/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rist"
+  spec.version       = Rist::VERSION
+  spec.authors       = ["Zhi-Qiang Lei"]
+  spec.email         = ["zhiqiang.lei@gmail.com"]
+  spec.summary       = %q{Ruby Intelligent System Tools}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0") - Dir['{examples,spec}/**/*'] - %w{.gitignore Gemfile Rakefile}
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.extensions    = %w{ext/transcriber/extconf.rb}
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "factory_girl", "~> 4.0"
+  spec.add_development_dependency "rake-compiler"
+  spec.add_development_dependency "coveralls"
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: rist
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Zhi-Qiang Lei
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- zhiqiang.lei@gmail.com
+executables: []
+extensions:
+- ext/transcriber/extconf.rb
+extra_rdoc_files: []
+files:
+- ".rspec"
+- LICENSE.txt
+- README.md
+- ext/transcriber/extconf.rb
+- ext/transcriber/transcriber.c
+- lib/rist.rb
+- lib/rist/transcriber.rb
+- lib/rist/version.rb
+- rist.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby Intelligent System Tools
+test_files: []