google_speech 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in google_speech.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 The Public Radio Exchange, www.prx.org
+
+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,37 @@
+# GoogleSpeech
+
+This is a gem to call the google speech api.
+
+The gem expects pcm wav audio.
+
+It returns JSON including confidence values, and timing (acts as amkind of transcription alignment).
+
+It uses excon for the http communication, sox (http://sox.sourceforge.net/) for audio conversion and splitting, and the related soxi executable to get audio file info/length.
+
+Inspired by https://github.com/taf2/speech2text
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'google_speech'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install google_speech
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/google_speech.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'google_speech/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "google_speech"
+  gem.version       = GoogleSpeech::VERSION
+  gem.authors       = ["Andrew Kuklewicz"]
+  gem.email         = ["andrew@prx.org"]
+  gem.description   = %q{This is a gem to call the google speech api.}
+  gem.summary       = %q{This is a gem to call the google speech api.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "excon"
+
+  gem.add_development_dependency "rake"
+end

data/lib/google_speech.rb

@@ -0,0 +1,203 @@
+require 'rubygems'
+require 'google_speech/version'
+
+require 'excon'
+
+require 'tempfile'
+require 'open3'
+require 'logger'
+require 'cgi'
+require 'json'
+
+module GoogleSpeech
+
+  SOX_ERROR_RE       = /error:/
+
+  class Transcriber
+    attr_accessor :original_file, :options, :results
+
+    def initialize(original_file, options=nil)
+      @original_file = original_file
+      @options = {:language=>'en-US', :chunk_duration=>8, :overlap=>1, :max_results=>2}.merge(options || {})
+      @results = []
+    end
+
+    def transcribe
+      ChunkFactory.new(@original_file, options[:chunk_duration], options[:overlap]).each{|chunk|
+        result = chunk.to_hash
+        transcript = transcribe_data(chunk.data)
+        result[:text] = transcript['hypotheses'].first['utterance']
+        result[:confidence] = transcript['hypotheses'].first['confidence']
+        @results << result
+        puts "\n#{result[:start_time]} - #{result[:start_time].to_i + result[:duration].to_i}: #{(result[:confidence].to_f * 100).to_i}%: #{result[:text]}"
+        sleep(1)
+      }
+      @results
+    end
+
+    def transcribe_data(data)
+      params = {
+        :scheme   => 'https',
+        :host     => 'www.google.com',
+        :port     => 443,
+        :path     => "/speech-api/v1/recognize",
+        :query    => "xjerr=1&client=google_speech&lang=#{options[:language]}&maxresults=#{options[:max_results].to_i}",
+        :body     => data,
+        :method   => 'POST',
+        :headers  => {
+          'Content-Type'   => 'audio/x-flac; rate=16000',
+          'Content-Length' => data.bytesize,
+          'User-Agent'     => "google_speech"
+        }
+      }
+      retry_max = options[:retry_max] ? [options[:retry_max].to_i, 1].max : 3
+      retry_count = 0
+      result = nil
+      url = "#{params[:scheme]}://#{params[:host]}:#{params[:port]}#{params[:path]}"
+      while(!result && retry_count < retry_max)
+        connection = Excon.new(url)
+        response = connection.request(params)
+        if response.status.to_s.start_with?('2')
+          result = JSON.parse(response.body)          
+        else
+          sleep(1)
+          retry_count += 1
+        end
+      end
+
+      result
+    end
+
+  end
+
+  # break wav audio into short files
+  class ChunkFactory
+    attr_accessor :original_file, :chunk_duration, :overlap
+
+    def initialize(original_file, chunk_duration=8, overlap=1)
+      @chunk_duration    = chunk_duration.to_i
+      @original_file     = original_file
+      @overlap           = overlap
+      @original_duration = GoogleSpeech::Utility.audio_file_duration(@original_file.path).to_i
+    end
+
+    # return temp file for each chunk
+    def each
+      pos = 0
+      while(pos < @original_duration) do
+        chunk = Chunk.new(@original_file, @original_duration, pos, (@chunk_duration + @overlap))
+        yield chunk
+        pos = pos + [chunk.duration, @chunk_duration].min
+      end
+    end
+  end
+
+  class Chunk
+    attr_accessor :original_file, :original_duration, :start_time, :duration, :chunk_file
+
+    def initialize(original_file, original_duration, start_time, duration)
+      @original_file = original_file
+      @original_duration = original_duration.to_i
+      @start_time = start_time.to_i
+      @duration = [duration.to_i, (@original_duration - @start_time)].min
+      @chunk_file = Tempfile.new([File.basename(@original_file), '.flac'])
+      # puts "@chunk_file: #{@chunk_file.path}"
+      Utility.trim_to_flac(@original_file.path, @duration, @chunk_file.path, @start_time, @duration)
+    end
+
+    def to_hash
+      {
+        :start_time => @start_time,
+        :duration => @duration
+      }
+    end
+
+    def data
+      @data ||= @chunk_file.read
+    end
+  end
+
+  # send each to google api
+
+  class Utility
+    class <<self
+
+      def audio_file_duration(path)
+        check_local_file(path)
+
+        soxi_duration, err = run_command("soxi -V0 -D #{path}", :nice=>false, :echo_return=>false)
+        duration = soxi_duration.chomp.to_f
+        duration
+      end
+
+      def trim_to_flac(wav_path, duration, flac_path, start, length)
+        check_local_file(wav_path)
+
+        command = "sox -t wav '#{wav_path}' -t flac '#{flac_path}' trim #{start.to_i} #{length.to_i} rate 16k"
+        out, err = run_command(command)
+        response = out + err
+        response.split("\n").each{ |l| raise("trim_to_flac: error cmd: '#{command}'\nout: '#{response}'") if l =~ SOX_ERROR_RE }
+      end
+
+      # Pass the command to run, and various options
+      # :timeout - seconds to wait for command to complete, defaults to 2 hours
+      # :echo_return - gets the return value via appended '; echo $?', true by default
+      # :nice - call with nice -19 by default, set to false to stop, or integer to set different level
+      def run_command(command, options={})
+        timeout = options[:timeout] || 7200
+        
+        # default to adding a nice 19 if nothing specified
+        nice = if options.key?(:nice)
+          !options[:nice] ? '' : "nice -n #{options[:nice].to_i} "
+        else
+          'nice -n 19 '
+        end
+        
+        echo_return = (options.key?(:echo_return) && !options[:echo_return]) ? '' : '; echo $?'
+        
+        cmd = "#{nice}#{command}#{echo_return}"
+        
+        # logger.debug "run_command:  #{cmd}"
+        begin
+          result = Timeout::timeout(timeout) {
+            Open3::popen3(cmd) do |i,o,e|
+              out_str = ""
+              err_str = ""
+              i.close # important!
+              o.sync = true
+              e.sync = true
+              o.each{|line|
+                out_str << line
+                line.chomp!
+                # logger.debug "stdout:    #{line}"
+              }
+              e.each { |line| 
+                err_str << line
+                line.chomp!
+                # logger.debug "stderr:    #{line}"
+              }
+              return out_str, err_str
+            end
+          }
+        rescue Timeout::Error => toe
+          # logger.debug "run_command:Timeout Error - running command, took longer than #{timeout} seconds to execute: '#{cmd}'"
+          raise toe
+        end
+      end
+
+      def check_local_file(file_path)
+        raise "File missing or 0 length: #{file_path}" unless (File.size?(file_path).to_i > 0)
+      end
+
+      def logger
+        @logger ||= Logger.new(STDOUT)
+      end
+
+      def logger=(l)
+        @logger = l
+      end
+
+    end    
+  end
+
+end

data/lib/google_speech/version.rb

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

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: google_speech
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Kuklewicz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This is a gem to call the google speech api.
+email:
+- andrew@prx.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- google_speech.gemspec
+- lib/google_speech.rb
+- lib/google_speech/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: This is a gem to call the google speech api.
+test_files: []
+has_rdoc: