freetts 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+# emacs
+*~
+\#*\#
+
+# Ruby / Rubygems
+*.gem
+

data/.rvmrc.example

@@ -0,0 +1 @@
+rvm --create jruby-X.Y.Z@freetts

data/README.md

@@ -0,0 +1,67 @@
+# Integration Exercise: Java Library Wrapper
+
+## Exercise Summary
+
+- You should create a gem using JRuby that wraps an existing Java library.
+- Your gem should work with a Java library that doesn't already have
+  a good wrapper.
+- You should make the API for your library look and feel like Ruby, not Java.
+
+
+## A JRuby wrapper for FreeTTS
+FreeTTS is a speech synthesis system written entirely in the JavaTM programming
+language. It is based upon Flite: a small run-time speech synthesis engine
+developed at Carnegie Mellon University. Flite is derived from the Festival 
+Speech Synthesis System from the University of Edinburgh and the FestVox project
+from Carnegie Mellon University.
+
+This wrapper exposes the most essential functionality required for processing
+text-to-speech requests.
+
+
+### Sample Code
+It's easy enough to pass a String to FreeTTS:
+
+```ruby
+require "lib/freetts"
+
+FreeTTS.speak "hello world"
+```
+
+With a little bit of manipulation, FreeTTS can read the news to you:
+
+```ruby
+require "uri"
+require "rss"
+require "lib/freetts"
+
+uri = URI.parse("http://feeds.feedburner.com/RubyInside")
+feed_items = RSS::Parser.parse(uri.read, false).items.first(5)
+feed_items.each do |item|
+  puts item.title.content
+  FreeTTS.speak item.title.content
+end
+```
+
+You can change the currently selected voice and make modifications that
+will affect pitch, rate of speech, and so on.
+
+```ruby
+voice = FreeTTS::Voice.for_name("alan")
+voice.pitch *= 1.25
+voice.rate += 20
+```
+
+Feel free to run any of the sample programs in the `examples/` directory
+to see the library in action.
+
+```bash
+examples/hello_world.rb
+examples/rss_reader.rb
+examples/voice_play.rb
+```
+
+
+## Future Enhancements
+- An adapter for plugging IO objects directly into the speech synthesizer
+- Whack out a gem version of the library

data/examples/hello_world.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env jruby
+
+require "lib/freetts"
+
+FreeTTS.speak("hello world")

data/examples/rss_reader.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env jruby
+
+
+$:.unshift File.join(File.dirname(__FILE__), "../lib")
+require "uri"
+require "rss"
+require "freetts"
+
+
+feed_url = "http://feeds.feedburner.com/RailsInside"
+
+uri = URI.parse(feed_url)
+
+feed_items = RSS::Parser.parse(uri.read, false).items.first(5)
+
+feed_items.each do |item|
+  title = item.title.content
+  puts title
+  FreeTTS.speak(title)
+end

data/examples/voice_play.rb

@@ -0,0 +1,133 @@
+#!/usr/bin/env jruby
+
+$:.unshift File.join(File.dirname(__FILE__), "..")
+require "lib/freetts"
+
+
+# A summary of the available commands
+HELP_MESSAGE = "Enter one of the following commands:\n" +
+               "  v         select a voice\n" +
+               "  i         view information for currently selected voice\n" +
+               "  c         change a setting for currently selected voice\n" +
+               "  s         speak a phrase\n" +
+               "  h/?       view this help message\n" +
+               "  q/x       quit"
+
+
+# Display a summary of the available commands.
+def display_help_message
+  puts HELP_MESSAGE
+end
+
+
+# Prompt the user to enter a command and return his input.
+def prompt_for_input(prompt_string="Command")
+  $stdout.write("#{ prompt_string }:>> ")
+  $stdin.gets.chomp
+end
+
+
+# Allow the user to select a new current_voice from a list of options.
+def select_voice
+  voices = FreeTTS::Voice.all
+  options_with_indices = voices.each_with_index.map { |v, i| "(#{ i }) #{ v }" }
+  puts "Select a voice by entering the appropriate number:"
+  puts "  #{ options_with_indices.join("   ") }"
+
+  user_input = prompt_for_input("Selection")
+
+  if user_input =~ /\A\d+\Z/ and
+     (selected_name = voices[user_input.to_i] rescue nil)
+    FreeTTS.current_voice = FreeTTS::Voice.for_name(selected_name)
+    puts "Voice \"#{ selected_name }\" has been selected."
+  else
+    puts "Sorry, but that is not a valid selection."
+  end
+end
+
+
+# Display attribute values for the currently selected voice.
+def show_voice_info
+  attributes  = %w(age description domain duration_stretch gender locale)
+  attributes += %w(organization pitch pitch_range pitch_shift rate style volume)
+
+  voice = FreeTTS.current_voice
+  puts "Current settings for voice \"#{ voice.name } \":"
+  attributes.each do |attribute|
+    puts "  #{ attribute.ljust(20) }#{ voice.send(attribute.to_sym) }"
+  end
+end
+
+# Change an attribute for the currently selected voice.
+def change_voice_setting
+  update_attributes  = %w( duration_stretch pitch pitch_range pitch_shift )
+  update_attributes += %w( rate volume )
+
+  options_with_indices = update_attributes.each_with_index.
+                                           map { |v, i| "(#{ i }) #{ v }" }
+  puts "Select an attribute to update by entering the appropriate number:"
+  puts "  #{ options_with_indices.join("   ") }"
+
+  user_input = prompt_for_input("Selection")
+
+  if user_input =~ /\A\d+\Z/ and 
+     (0..update_attributes.size).include?(user_input.to_i)
+    selected_attribute = update_attributes[user_input.to_i]
+    current_value = FreeTTS.current_voice.send(selected_attribute.to_sym)
+
+    user_input = prompt_for_input("New value (current: #{ current_value })")
+
+    #begin
+      new_value = Float(user_input)
+      FreeTTS.current_voice.send((selected_attribute + "=").to_sym, new_value)
+      puts "Set \"selected_attribute\" to value #{ new_value }"
+    #rescue Exception => e
+      #puts e
+      #puts "Illegal argument: requested value may be out of range for this attribute"
+    #end
+  else
+    puts "Sorry, but that is not a valid selection."
+  end
+end
+
+# Prompt the user to enter text to speak, and pass it to FreeTTS.
+def prompt_for_speakable
+  puts "Enter text to be spoken:>> "
+  user_input = $stdin.gets.chomp
+  FreeTTS.speak(user_input)
+end
+
+
+def unknown_command(command)
+  puts "Sorry, I don't know how to '#{ command }'."
+end
+
+
+display_help_message
+
+loop do
+  entered_command = prompt_for_input
+
+  case entered_command.downcase.chars.to_a[0]
+  when "v"
+    select_voice
+  when "i"
+    show_voice_info
+  when "c"
+    change_voice_setting
+  when "s"
+    prompt_for_speakable
+  when "h", "?"
+    display_help_message
+  when "q", "x"
+    break
+  else
+    unknown_command(entered_command)
+  end
+end
+
+
+
+
+
+

data/lib/freetts.rb

@@ -0,0 +1,18 @@
+$:.unshift(File.dirname(__FILE__))
+
+require "java"
+require "vendor/freetts.jar"
+
+require "freetts/voice"
+require "freetts/version"
+
+
+module FreeTTS
+  @current_voice = Voice.for_name(Voice::DEFAULT_NAME)
+  class << self; attr_accessor :current_voice; end
+
+
+  def self.speak(speakable)
+    self.current_voice.speak(speakable)
+  end
+end

data/lib/freetts/version.rb

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

data/lib/freetts/voice.rb

@@ -0,0 +1,47 @@
+module FreeTTS
+  class Voice
+    DEFAULT_NAME = "kevin16"
+
+    @voice_manager = com.sun.speech.freetts.VoiceManager.get_instance
+    class << self; attr_reader :voice_manager; end
+
+
+    def initialize(voice)
+      @voice_impl = voice
+    end
+
+    def speak(saying)
+      @voice_impl.speak(saying)
+    end
+
+    def method_missing(method, *args, &block)
+      method = method.to_s
+      java_method_name = case method
+      when /\A(.*)=\Z/
+        "set_#{ $1 }"
+      when /\A(.*)\Z/
+        "get_#{ $1 }"
+      end
+
+      if java_method_name and @voice_impl.respond_to?(java_method_name.to_sym)
+        return @voice_impl.send(java_method_name.to_sym, *args)
+      else
+        error_message = "undefined method #{ method } for #{ self }:Voice"
+        raise NoMethodError.new(error_message)
+      end
+    end
+
+    def self.all
+      voice_manager.get_voices.map { |voice| voice.get_name }
+    end
+
+    def self.for_name(voice_name)
+      if voice = voice_manager.get_voice(voice_name)
+        voice.allocate
+        Voice.new(voice)
+      else
+        raise "no voice found for name \"#{ voice_name }\""
+      end
+    end
+  end
+end

data/test/freetts_test.rb

@@ -0,0 +1,19 @@
+$:.unshift File.join(File.dirname(__FILE__), "../lib")
+
+require "freetts"
+require "test/unit"
+
+
+class FreeTTSTest < Test::Unit::TestCase
+  def test_setting_current_voice
+    start_voice = FreeTTS.current_voice
+    all_voices = FreeTTS::Voice.all
+
+    new_voice_name = all_voices.reject { |name| name == start_voice.name }.first
+    FreeTTS.current_voice = FreeTTS::Voice.for_name(new_voice_name)
+    new_voice = FreeTTS.current_voice
+
+    assert_not_nil(new_voice)
+    assert_equal(new_voice_name, new_voice.name)
+  end
+end

data/test/voice_test.rb

@@ -0,0 +1,64 @@
+$:.unshift File.join(File.dirname(__FILE__), "../lib")
+
+require "freetts"
+require "test/unit"
+
+
+class VoiceTest < Test::Unit::TestCase
+  def valid_voice
+    FreeTTS.current_voice
+  end
+
+  # Calling valid accessor methods should result in a successful invocation.
+  def test_valid_accessor_methods
+    valid_accessors = %w( description gender locale pitch rate style )
+    valid_accessors.each do |method|
+      assert_nothing_raised do
+        valid_voice.send(method.to_sym)
+      end
+    end
+  end
+
+  # Calling unknown accessor methods should raise a NoMethodException.
+  def test_invalid_accessor_methods
+    invalid_accessors = %w( something voice wallaby wombat parakeet )
+    invalid_accessors.each do |method|
+      assert_raises(NoMethodError) do
+        valid_voice.send(method.to_sym)
+      end
+    end
+  end
+
+  # A request for all voices should get an array of names.
+  def test_fetch_voices
+    voice_names = FreeTTS::Voice.all
+    assert_instance_of(Array, voice_names)
+
+    voice_names.each do |voice_name|
+      assert_instance_of(String, voice_name)
+    end
+  end
+
+  # Requesting an available voice by name should return the relevant voice.
+  def test_fetch_any_single_valid_voice
+    voice_names = FreeTTS::Voice.all
+
+    voice_names.each do |voice_name|
+      assert_nothing_raised do
+        voice = FreeTTS::Voice.for_name(voice_name)
+        assert_instance_of(FreeTTS::Voice, voice)
+        assert_equal(voice_name, voice.name)
+      end
+    end
+  end
+
+  # Attempting to fetch a non-existent voice should raise an exception.
+  def test_cannot_fetch_fake_voices
+    fake_voices = ["Ed McMahon", "Casey Kasem", "Rick Dees", "Frank Sinatra"]
+    fake_voices.each do |voice_name|
+      assert_raises(RuntimeError) do
+        FreeTTS::Voice.for_name(voice_name)
+      end
+    end
+  end
+end

data/vendor/voices.txt

@@ -0,0 +1,13 @@
+# This file lists the voice directories avialable to FreeTTs.
+# To get the name of a voice directory from a voice jar file,
+# type "java -jar voicefile.jar".
+#
+# Entries should look like:
+#com.sun.speech.freetts.en.us.cmu_time_awb.AlanVoiceDirectory
+#com.sun.speech.freetts.en.us.cmu_us_kal.KevinVoiceDirectory
+
+com.sun.speech.freetts.en.us.cmu_time_awb.AlanVoiceDirectory
+com.sun.speech.freetts.en.us.cmu_us_kal.KevinVoiceDirectory
+
+# Uncomment to allow MBROLA voices:
+#de.dfki.lt.freetts.en.us.MbrolaVoiceDirectory

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: freetts
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris kottom
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2011-09-19 00:00:00.000000000 +02:00
+default_executable:
+dependencies: []
+description: FreeTTS provides a simple wrapper around the Java library of the same name in order to expose a voice synthesis API.
+email: chris@chriskottom.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc.example
+- README.md
+- examples/hello_world.rb
+- examples/rss_reader.rb
+- examples/voice_play.rb
+- lib/freetts.rb
+- lib/freetts/version.rb
+- lib/freetts/voice.rb
+- test/freetts_test.rb
+- test/voice_test.rb
+- vendor/cmu_time_awb.jar
+- vendor/cmu_us_kal.jar
+- vendor/cmudict04.jar
+- vendor/cmulex.jar
+- vendor/cmutimelex.jar
+- vendor/en_us.jar
+- vendor/freetts.jar
+- vendor/voices.txt
+has_rdoc: true
+homepage: ''
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: freetts
+rubygems_version: 1.5.1
+signing_key:
+specification_version: 3
+summary: A voice synthesizer in JRuby
+test_files: []
+...