win32-loquendo 1.0.1-x86-mingw32

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Njc2MWYzOWJlYzhjNGQ4MGVmMjlkZDM1NzMyOTBlYzI5ZGJmZjYwNg==
+  data.tar.gz: !binary |-
+    YjYyM2Q2MWVmOWE5ZGU2MzA2MDUzNjBhYTg5YjNmMTY0ZjdlOTIzZQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NDhiZTUyM2U4OTg5NWU4NmEzNDU0MjA4NmJjMDYwNWY2NTcxNjJlYTFlYjI4
+    ODU5NTdlOTE1ZDMzZGRkNzY2MzU2ZGRmZjllM2VmNjdkMzMxNmJlNWE5MDUw
+    YjQ0NjE3OTVkYTZmMjg0YWFjMGI3Mzc5MzVlM2M3OGEzOGIzMGU=
+  data.tar.gz: !binary |-
+    NDgxMDBiMDM5YzdlZmIzNWY2ODFkOWU3MWFlZGRhNzE4M2Q1YzBiOTA2NTU2
+    NmM4Y2ZjYTQ2Y2ExYjg3NjdkY2ZmNGM4MWE0YzhiZmRiNzllNzBhZjNmNjQ0
+    ZTNhYmNkYWRmNWQxYTI0ZTRmMDFhOThhZTNlYjEyM2U0M2FmZjc=

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/.yardopts

@@ -0,0 +1,8 @@
+--readme          README.md
+--default-return  ""
+--title           "Win32-Loquendo Documentation"
+--hide-void-return
+--no-private
+-
+LICENSE.txt
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jonas Tingeborn
+
+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,78 @@
+# Win32::Loquendo
+
+Ruby interface to the Loquendo speech synthesis (text to speech / TTS) program.
+
+This gem only runs on Microsoft Windows as it relies both on the Win32 API as 
+well as the DLL files used by the Loquendo distribution. For that reason it 
+has been name spaced in the win32 module to make it abundantly clear which
+platform it supports.
+
+## Prerequisites
+
+* Must have Loquendo installed on the machine in order to use this gem.
+* ruby ffi library, will be installed automatically through rubygems
+
+## Installation
+
+    $ gem install win32-loquendo
+
+## Usage
+
+Basic example showing the three types of use
+
+    require 'win32/loquendo'
+
+    reader = Win32::Loquendo::Reader.new()
+
+    reader.say("Say it aloud")  # Send the text to the sound card
+
+    reader.say("Give me the data") do |data|
+      # do stuff with the string of PCM WAVE bytes
+    end
+
+    reader.write("audio.wav", "Save the spoken text to a file")
+
+Customize how the text is spoken
+
+    reader = Win32::Loquendo::Reader.new({
+      :sample_rate => 32000,       # Pick a sample rate in Hz
+      :channels    => 2,           # Stereo or mono (1 or 2 audio channels)
+      :voice       => "Elizabeth"  # Specify the default voice to use
+    })                             
+    
+    reader.say "Hi, this is Elizabeth speaking"  # Speak with the default voice.
+    reader.say "and this is Simon", "Simon"      # Override the default voice
+                                                 # for this utterance.
+
+    reader.voices.each do |name|              # List installed voices that can 
+      reader.say "My name is #{name}", name   # be used for speaking.
+    end
+      
+Note that you can customize a lot on the fly regarding how Loquendo speaks, by
+simply adding commands as part of the text being spoken. For example:
+
+* Trigger whatever pre-programmed demo phrase the voice used was shipped with.
+
+        reader.say("\\demosentence and I'm speaking through ruby win32-loquendo")
+   
+* Provide proper pronunciation for words using [X-SAMPA][*]
+
+        reader.say("Hello, or in Finnish; \SAMPA=;('t_de4ve)", "Dave")
+
+Finally you can launch speech prompts in parallel, overlapping to the degree 
+you'd like by running reader instances in separate threads. This example
+generates something eerily similar to Google's audio captchas, using 10 
+overlapping voices.
+
+    (0...40).to_a.shuffle.each_slice(4).map{|a| a.join(" ") }.map{|s|
+      Thread.new { Win32::Loquendo::Reader.new.say(s) }
+    }.each {|t|
+      t.join
+    }
+
+A note of caution: Only ever interact with a reader from one and the same thread.
+If used from different threads it will cause undefined behavior (errors, 
+hangs, crashes), since the library interact with C-code over FFI and such 
+interactions are not thread safe.
+
+[*]: http://en.wikipedia.org/wiki/X-SAMPA   

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "yard"
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/*/*.rb']
+end

data/lib/win32/loquendo.rb

@@ -0,0 +1,189 @@
+require 'ffi'
+require 'win32/registry'
+require 'tempfile'
+
+module Win32
+  module Loquendo
+
+    ###
+    # Reads text out loud or to file using the Loquendo TTS engine.
+    class Reader
+
+      ###
+      # @param [Hash] opts options to be used as default configuration.
+      # @option opts [Integer] :sample_rate (32000) in Hz.
+      # @option opts [Integer] :channels (2) denotes Stereo or mono, 2 or 1 channel.
+      # @option opts [String]  :voice (Elisabeth) default voice to use unless
+      #                              overridden when calling {#say} or {#write}.
+      def initialize(opts={})
+        @opts = {
+          :sample_rate => 32000,
+          :channels    => 2,
+          :voice       => "Elizabeth"
+        }.merge(opts)
+        @speaking = false
+
+        # Sanity checking of input parameters
+        unless @opts[:sample_rate].kind_of?(Integer) && @opts[:sample_rate] > 0
+          raise LoquendoException, ":sample_rate must be an integer and larger than zero, but %s was specified" % @opts[:sample_rate].to_s
+        end
+        unless [1,2].include?( @opts[:channels] )
+          raise LoquendoException, "audio :channels must be either 1 or 2, but %s was specified" % @opts[:channels].to_s
+        end
+
+        # Instantiate the TTS reader
+        ptr = FFI::MemoryPointer.new :pointer
+
+        unless LoqTTS7.ttsNewReader(ptr,nil) == 0
+          LoqTTS7.ttsDeleteSession(nil)
+          raise LoquendoException, "Failed to create TTS reader"
+        end
+        @reader_ptr = ptr.read_pointer
+        @reader_ptr.freeze
+
+        # Register a callback for speaking so we know when speeches end, since
+        # we're interacting with the TTS engine asynchronously in order to avoid
+        # blocking the entire main thread while speaking is going on.
+        @callback = FFI::Function.new(:void, [:uint, :int, :pointer, :pointer]) do |speech_id, event, *ignore|
+          if event == 1
+            @speaking = false
+            info "End of speech ##{speech_id}"
+          end
+        end
+
+        unless LoqTTS7.ttsSetCallback(@reader_ptr, @callback, nil, 0) == 0
+          raise LoquendoException, "Failed to register TTS reading callback"
+        end
+
+      end # init
+
+      ###
+      # Writes +text+ spoken with +voice+ to +filename+.
+      # @param [String] filename to write the PCM WAV data to.
+      # @param [String,#read] text to be rendered to audio.
+      # @param [String] voice defaults to whatever voice was
+      #   specified during the creation of the Reader object.
+      def write(filename, text, voice = @opts[:voice])
+        device = "LTTS7AudioFile"
+        load_voice(voice)
+        unless LoqTTS7.ttsSetAudio(@reader_ptr, device, filename, @opts[:sample_rate], 0, @opts[:channels], nil) == 0
+          raise LoquendoException, "Failed to prepare writing audio to file via #{device} library"
+        end
+        render_speech(text, device)
+      end
+
+      ###
+      # Speaks the provided +text+ using +voice+ through the sound card.
+      # If a block is provided, the spoken WAVE-data is handed as a string of
+      # bytes to the block instead of being sent to the sound card.
+      # @param [String,#read] text to be spoken.
+      # @param [String] voice uses whatever voice wasspecified during the
+      #   creation of the Reader object unless overridden.
+      def say(text, voice = @opts[:voice])
+        if block_given?
+          data = nil
+          Dir.mktmpdir("loquendo_audio") do |dir|
+            file = File.join(dir,"spoken_text.wav")
+            write(file, text, voice)
+            data = open(file,'rb'){|f| f.read }
+          end
+          yield data
+        else
+          say_aloud(text, voice)
+        end
+      end
+
+      ###
+      # @return [Array<String>] a list of the installed voices, that can be
+      #                         used for speaking.
+      def voices
+        buff = FFI::MemoryPointer.new(:string, 1024)
+        unless LoqTTS7.ttsQuery(nil, 1, "Id", nil, buff, buff.size, false, false) == 0
+          raise LoquendoException, "Failed to query voices"
+        end
+        buff.read_string.split(";")
+      end
+
+      private #################################################################
+
+      def say_aloud(text, voice = @opts[:voice])
+        device = "LTTS7AudioBoard"
+        load_voice(voice)
+        unless LoqTTS7.ttsSetAudio(@reader_ptr, device, nil, @opts[:sample_rate], 0, @opts[:channels], nil) == 0
+          raise LoquendoException, "Failed to prepare playing audio via #{device} library"
+        end
+        render_speech(text, device)
+      end
+
+      def render_speech(text, device)
+        text = text.read if text.respond_to? :read
+        unless LoqTTS7.ttsRead(@reader_ptr, text, true, false, 0) == 0
+          raise LoquendoException, "Failed to playing audio via #{device} library"
+        end
+        @speaking = true  # simulate synchronous behavior without making the program
+        while @speaking   # "soft-block" for the speaking duration
+          sleep(0.01)
+        end
+      end
+
+      def load_voice(voice)
+        unless LoqTTS7.ttsLoadPersona(@reader_ptr, voice, nil, nil) == 0
+          LoqTTS7.ttsDeleteSession(nil)
+          raise LoquendoException, "Failed to load voice '#{voice}'"
+        end
+      end
+
+      def info(msg)
+        puts msg if $VERBOSE
+      end
+
+    end # Reader
+
+    # Custom exception used for this library
+    class LoquendoException < Exception
+    end
+
+    ###########################################################################
+    private ###################################################################
+
+    # Locate the installation path of the program and its DLLs
+    [ [ Win32::Registry::HKEY_LOCAL_MACHINE, "SOFTWARE\\Loquendo\\LTTS7\\Engine" ],
+      [ Win32::Registry::HKEY_CURRENT_USER,  "SOFTWARE\\Loquendo\\LTTS7\\Engine" ]
+    ].each do |base,key|
+      begin
+        base.open(key) do |reg|
+          DLL_PATH ||= reg['DataPath']
+        end
+      rescue Win32::Registry::Error
+      end
+    end
+
+    raise LoquendoException, "Failed to find Loquendo TTS engine. Is the program installed?" unless defined?(DLL_PATH)
+
+    # @private
+    module LoqTTS7
+      extend FFI::Library
+      ffi_lib "#{DLL_PATH}bin\\LoqTTS7"
+      #                                     reader      ?
+      attach_function :ttsNewReader,     [ :pointer, :pointer ], :int
+      #                                     reader    voice   language    ?
+      attach_function :ttsLoadPersona,   [ :pointer, :string, :string, :string ], :int
+      #                                     session
+      attach_function :ttsDeleteSession, [ :pointer ], :int
+      #                                     reader   device   filename samplr   ?    chan     ?
+      attach_function :ttsSetAudio,      [ :pointer, :string, :string, :uint, :int,  :int, :pointer ], :int
+      #                                     reader    text     async    ?       ?
+      attach_function :ttsRead,          [ :pointer, :string, :bool,  :bool,  :ulong ], :int
+      #                                      nil      1     atts     nil      resbuff  cbuff   false  false
+      attach_function :ttsQuery,         [ :pointer, :int, :string, :string, :pointer, :uint,  :bool, :bool ], :int
+      #                                     reader   callback     nil     0
+      attach_function :ttsSetCallback,   [ :pointer, :pointer, :pointer, :int ], :int
+      #
+      attach_function :ttsGetErrorMessage, [ :int ], :string
+      #                                     reader
+      #attach_function :ttsStop,          [ :pointer ], :int  # Causes nasty hang in Ruby, probably GIL related..
+    end
+
+  end # Loquendo
+
+end #Win32

data/lib/win32/loquendo/version.rb

@@ -0,0 +1,5 @@
+module Win32
+  module Loquendo
+    VERSION = "1.0.1"
+  end
+end

data/win32-loquendo.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'win32/loquendo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "win32-loquendo"
+  spec.version       = Win32::Loquendo::VERSION
+  spec.platform      = Gem::Platform::CURRENT
+  spec.authors       = ["Jonas Tingeborn"]
+  spec.email         = ["tinjon@gmail.com"]
+  spec.description   = %q{Ruby for the Win32 API of Loquendo speech synthesis programs}
+  spec.summary       = %q{Ruby API for Loquendo speech synthesis}
+  spec.homepage      = "https://github.com/jojje/win32-loquendo"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.add_dependency "ffi"
+
+  spec.rdoc_options += ['-m', 'README.md', '-x', 'lib/win32/(?!loquendo.rb).*',
+                       'lib/win32/loquendo.rb', 'LICENSE', 'README.md']
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "yard"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: win32-loquendo
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: x86-mingw32
+authors:
+- Jonas Tingeborn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: yard
+  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: Ruby for the Win32 API of Loquendo speech synthesis programs
+email:
+- tinjon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .yardopts
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/win32/loquendo.rb
+- lib/win32/loquendo/version.rb
+- win32-loquendo.gemspec
+homepage: https://github.com/jojje/win32-loquendo
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- -m
+- README.md
+- -x
+- lib/win32/(?!loquendo.rb).*
+- lib/win32/loquendo.rb
+- LICENSE
+- README.md
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Ruby API for Loquendo speech synthesis
+test_files: []
+has_rdoc: