flite 0.0.3.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a39cd40e7679ec33aa61c41dcb4c9146b1afd25
-  data.tar.gz: e5f23ffecf1a6a4bf3c27ad119d1a6b4c4dd0c79
+  metadata.gz: 7a1d5627fba26b34d2417f52876bdab6272624f8
+  data.tar.gz: fddcf4371388ef8258db15dc0a0aa2b8828924a3
 SHA512:
-  metadata.gz: 8f279489cb2d69a669d3320ee824a92a8be04201dead4e867b436a0bae4e568ca80324fc381189077d11e9df229d7f9f6b65668bdfcdd991a44ab3178877fa4b
-  data.tar.gz: f5714b9e110424e31ad7d7a2a456d0fb1f334ee46b7b181364a628768aceb3f8ca16a79b719829e9994ecd18d2cb8b6842eed4c5d754751fa0963ac115c1e928
+  metadata.gz: 81961b439859672eec7b978c8e893a911e3ae44e68257debd20597cbbf8bddec898929541acc1b0d3496609f36941546fea049ea3e06a74253fa50265792a89c
+  data.tar.gz: 03370c926ff39c8fd461c8093bff07a8dafdcccd8934ce2e9895aa0466090681e019843912c2ba5328857218ebe18d790c7633df0fb9b0d7287fef1fbbce2cb3

data/README.md

@@ -1,6 +1,6 @@
-# ruby-flite
+# Ruby Flite
 
-Ruby-flite is a small speech synthesis library for ruby using [CMU Flite](http://cmuflite.org).
+Ruby Flite is a small speech synthesis library for ruby using [CMU Flite](http://cmuflite.org).
 
 CMU Flite (festival-lite) is a small, fast run-time synthesis engine developed
 at CMU and primarily designed for small embedded machines and/or large
@@ -14,115 +14,140 @@ voices built using the [FestVox](http://festvox.org/) suite of voice building to
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'flite'
-```
-
-Install [CMU Flite](http://cmuflite.org):
+Install [CMU Flite](http://cmuflite.org) and (optionally) [LAME](http://lame.sourceforge.net/).
 
 ```shell
 # On ubuntu
 sudo apt-get install flite1-dev
+sudo apt-get install libmp3lame-dev # for mp3 support (optionally)
 
 # On redhat
-yum install flite flite-devel
+yum install flite-devel
+yum install libmp3lame-devel # for mp3 support (optionally)
 
 # On Windows
-# you have no need to install CMU Flite if you use the flite binary gem.
-# CMU Flite is statically linked.
+# You have no need to install CMU Flite and LAME if you use rubies distributed by
+# rubyinstaller.org. Binary gems for the rubies include them.
+
+# Others
+# You need to install them by yourself.
 ```
 
 And then execute:
 
-    $ bundle
-
-Or install it yourself as:
-
     $ gem install flite
 
-Ruby-flite tries to link with **all voices and languages**.
+Ruby Flite tries to link with **all voices and languages**.
 If you want to reduce dependent libraries, execute the followings
-instead of above commands.
-
-    $ bundle config --local build.flite --with-voices=kal --with-langs=eng
-    $ bundle
-
-Or install it yourself as:
+instead of above command.
 
     $ gem install flite -- --with-voices=kal --with-langs=eng
 
-## Simple Usage
+## Examples
 
 ```ruby
 require 'flite'
 
-# output to the speeker.
-"Hello World!".to_speech
+# Speak "Hello World!"
+"Hello World!".speak
 
-# save as a WAVE file
-"Hello World!".to_speech("hello_world.wave")
-
-# write to an I/O object if it responds to 'write'.
-File.open("hello_world.wave", "wb") do |f|
-  "Hello World!".to_speech(f)
-end
-```
-## Advanced Usage
-
-```ruby
-require 'flite'
+# Create a wav data and save as "hello_world.wav"
+File.binwrite("hello_world.wav", "Hello World!".to_speech)
 
-# array of builtin voice names.
-Flite.list_builtin_voices
+# Create a mp3 data and save as "hello_world.mp3"
+# This works if mp3 support is enabled.
+File.binwrite("hello_world.mp3", "Hello World!".to_speech(:mp3))
 
-# create a voice. 'slt' is a voice name.
-voice = Flite::Voice.new("slt")
-
-# output to the speeker.
-voice.speech("Hello World!")
-
-# save as a WAVE file
-voice.speech("Hello World!", "hello_world.wave")
-
-# write to an I/O object if it responds to 'write'.
-File.open("hello_world.wave", "wb") do |f|
-  voice.speech("Hello World!", f)
-end
-
-# Change the voice used for String#to_speech
+# Change the voice used for String#speak and String#to_speech
 Flite.default_voice = 'rms'
-```
 
-## Sample Application
+# Speak again
+"Hello World!".speak
+```
 
-* [saytime.rb](https://github.com/kubo/ruby-flite/blob/master/bin/saytime.rb)
+See:
+
+* http://www.rubydoc.info/gems/flite/Flite/Voice
+* http://www.rubydoc.info/gems/flite/String
+
+## Sample Applications
+
+### [saytime](https://github.com/kubo/ruby-flite/blob/master/bin/saytime) - talking clock
+
+This is inspired by [saytime - talking clock for SPARCstations](http://acme.com/software/saytime/).
+
+Example:
+
+> Talk the current time once:
+>
+> ```shell
+> saytime
+> ```
+>
+> Talk the current time forever:
+>
+> ```shell
+> saytime --loop
+> ```
+>
+> Talk the current time 5 times
+>
+> ```shell
+> saytime --loop 5
+> ```
+>
+> Talk the current time 5 times with 10 second intervals
+>
+> ```shell
+> saytime --loop 5 --interval 10
+> ```
+
+### [speaking-web-server](https://github.com/kubo/ruby-flite/blob/master/bin/speaking-web-server) - Web server replying synthesized speech
+
+Usage:
+
+> Start a web server:
+> 
+> ```shell
+> speaking-web-server
+> ```
+>
+> Open a browser and access:
+>
+>     http://HOSTNAME_OR_IP_ADDRESS:9080
+>     (Change HOSTNAME_OR_IP_ADDRESS.)
+>
+> Click 'Play' buttons.
 
 ## Restrictions
 
-* `String#to_speech(io_object)` and `Flite::Voice#speech(text, io_object)`
-  are not thread-safe. You need to create `Flite::Voice` objects for
-  each threads and use `Flite::Voice#speech`.
-
-* `String#to_speech("play")` and `Flite::Voice#speech(text, "play")`
-  don't save wave data to the specified file `play`. They output speech
-  data to the speaker instead.
-
-* `String#to_speech("stream")`, `String#to_speech("none")`,
-  `Flite::Voice#speech(text, "stream")` and `Flite::Voice#speech(text, "none")`
-  don't save wave data to the specified file `stream` or `none`. They
-  synthesize speech and discard the result.
+* Ruby process doesn't terminate while talking.
 
 * When an error occurs in CMU Flite, the error message is outputted to
   the standard error.
 
+* When a fatal error occurs in CMU Flite, the error message is outputted to
+  the standard error and the process is terminated. (CMU Flite calls `exit(-1)`...)
+
+## NEWS
+
+### 0.1.0
+
+Almost methods were changed. Especially {String#to_speech} returns WAV
+audio data instead of speaking. Use {String#speak} to speak a text.
+
 ## License
 
-* Ruby-flite itself is licensed under 2-clause BSD-style license.
-* CMU Flite is licensed under BSD-like license.
+* Ruby Flite is licensed under 2-clause BSD-style license.
+* CMU Flite bundled in Windows binary gems is licensed under BSD-like license.
   See http://www.festvox.org/flite/download.html
+* LAME bundled in Windows binary gems is licensed under LGPL.
+
+## Related Works
 
+* [flite4r](http://www.rubydoc.info/gems/flite4r/) - Flite for Ruby (GPL)
+* [FestivalTTS4r](https://github.com/spejman/festivaltts4r) - Festival Text-To-Speech for Ruby
+ 
 ## Contributing
 
 1. Fork it ( https://github.com/kubo/ruby-flite/fork )

data/bin/{saytime.rb → saytime}

@@ -1,5 +1,23 @@
 #! /usr/bin/env ruby
 #
+# saytime - talking clock
+#
+# Usage:
+#  # Talk the current time once
+#  saytime
+#
+#  # Talk the current time forever
+#  saytime --loop
+#
+#  # Talk the current time 5 times
+#  saytime --loop 5
+#
+#  # Talk the current time 5 times with 10 second intervals
+#  saytime --loop 5 --interval 10
+#
+#  # Talk the current time with 'slt' and 'awb' voices
+#  saytime --voices=slt,awb
+#
 require 'flite'
 require 'optparse'
 
@@ -40,7 +58,7 @@ def saytime(voice_name)
   puts "voice: #{voice_name}"
 
   voice = ($cached_voices[voice_name] ||= Flite::Voice.new(voice_name))
-  voice.speech(text)
+  voice.speak(text)
 end
 
 voices = []

data/bin/speaking-web-server

@@ -0,0 +1,121 @@
+#! /usr/bin/env ruby
+#
+# speaking-web-server - Web server replying synthesized speech
+#
+# Usage:
+#
+# 1. Start a Web server.
+#
+#    speaking-web-server
+#
+# 2. Access to the web server.
+#
+#    Open browser and access: http://HOSTNAME_OR_IP_ADDRESS:9080
+#    (Change HOSTNAME_OR_IP_ADDRESS.)
+#
+# 3. Click 'Play' buttons.
+#
+require 'webrick'
+require 'flite'
+
+def start_server(html_content)
+  srv = WEBrick::HTTPServer.new({:Port => 9080})
+
+  srv.mount_proc('/') do |req, res|
+    h = req.query
+    if h['text']
+      audio_type = if h['type'] == 'mp3'
+                     :mp3
+                   else
+                     :wav
+                   end
+      res['Content-type'] = "audio/#{audio_type}"
+      res['Content-Disposition'] = %Q{attachment; filename="audio.#{audio_type}"}
+
+      voice = Flite::Voice.new(h['voice'] || 'kal')
+      res.body = voice.to_speech(h['text'], audio_type)
+    else
+      res['Content-type'] = 'text/html'
+      res.body = html_content
+    end
+  end
+  trap("INT"){ srv.shutdown }
+  srv.start
+end
+
+html_content = <<EOS
+<html>
+<head>
+<title>Flite CGI</title>
+
+<script>
+audio_type = 'wav';
+
+function check_audio_type() {
+  var audio = new Audio;
+  if (audio.canPlayType('audio/wav') == '') {
+    if (#{Flite.supported_audio_types.include? :mp3} && audio.canPlayType('audio/mp3') != '') {
+      audio_type = 'mp3';
+    } else {
+      var text = document.getElementById('text');
+      text.disabled = true;
+      enable_buttons(false);
+      alert('Cannot play audio/wav in this browser.\\nUse Chrome, Firefox, Safari or Opera.');
+    }
+  }
+}
+
+function speak(voice) {
+  var text = document.getElementById('text');
+  if (text != '') {
+    var status = document.getElementById('status');
+    status.innerHTML = 'Playing'
+    enable_buttons(false);
+    var url = '/?voice=' + voice + '&type=' + audio_type + '&text=' + encodeURIComponent(text.value);
+    var audio = new Audio(url);
+    audio.onended = function() {
+      status.innerHTML = 'Finished'
+      enable_buttons(true);
+    };
+    audio.onabort = function() {
+      status.innerHTML = 'Abort'
+      enable_buttons(true);
+    };
+    audio.onerror = function() {
+      status.innerHTML = 'Error'
+      enable_buttons(true);
+    };
+    audio.play();
+  }
+}
+
+function enable_buttons(bval) {
+  var form = document.getElementById('speech_form');
+  var elements = form.elements;
+  for (var i = 0; i < elements.length; i++) {
+    var element = elements[i];
+    if (element.tagName == 'INPUT') {
+      element.disabled = !bval;
+    }
+  }
+}
+</script>
+
+</head>
+<body onLoad="check_audio_type();">
+
+<form id="speech_form">
+  <textarea id="text" name="text" cols=80 rows=4>Hello Flite World!</textarea>
+  <br />
+  <input type="button" value="Play(voice: kal)" onClick="speak('kal');">
+  <input type="button" value="Play(voice: kal16)" onClick="speak('kal16');">
+  <input type="button" value="Play(voice: awb)" onClick="speak('awb');">
+  <input type="button" value="Play(voice: rms)" onClick="speak('rms');">
+  <input type="button" value="Play(voice: slt)" onClick="speak('slt');">
+</form>
+Status: <span id="status" />
+</body>
+</html>
+EOS
+
+start_server(html_content)

data/ext/flite/extconf.rb

@@ -2,6 +2,8 @@ require "mkmf"
 
 dir_config('flite')
 
+libs_old = $libs
+
 unless have_library('flite', 'flite_init')
   saved_libs = $libs
   puts "checkign for audio libraries depended by flite ..."
@@ -74,17 +76,52 @@ EOS
   end
   f.write <<EOS
 
-const rbflite_builtin_voice_t rbflite_builtin_voice_list[] = {
+#undef ENTRY
+#ifdef RBFLITE_WIN32_BINARY_GEM
+static cst_voice *dummy;
+#define ENTRY(name, dll_name, func_name, var_name) {#name, func_name, &dummy, #dll_name, #func_name, #var_name}
+#else
+#define ENTRY(name, dll_name, func_name, var_name) {#name, func_name, &var_name}
+const
+#endif
+
+rbflite_builtin_voice_t rbflite_builtin_voice_list[] = {
 EOS
   voices.each do |v|
-    f.puts(%Q[    {"#{v[0]}", register_#{v[1]}, &#{v[2]}},])
+    f.puts("    ENTRY(#{v[0]}, flite_#{v[1]}.dll, register_#{v[1]}, #{v[2]}),")
   end
   f.write <<EOS
-    {NULL, NULL, NULL},
+    {NULL, },
 };
+
+#ifdef RBFLITE_WIN32_BINARY_GEM
+EOS
+  voices.each_with_index do |v, idx|
+    f.write <<EOS
+cst_voice *register_#{v[1]}(const char *voxdir)
+{
+    return rbfile_call_voice_register_func(&rbflite_builtin_voice_list[#{idx}], voxdir);
+}
+EOS
+  end
+  f.write <<EOS
+#endif
 EOS
 end
 
+if have_library('mp3lame')
+  have_header('lame.h') || have_header('lame/lame.h')
+end
+
 RUBY_VERSION =~ /(\d+).(\d+)/
 $defs << "-DInit_flite=Init_flite_#{$1}#{$2}0"
+
+$objs = ['rbflite.o', 'rbflite_builtin_voice_list.o']
+
+if with_config('win32-binary-gem')
+  $libs = libs_old
+  $defs << "-DRBFLITE_WIN32_BINARY_GEM"
+  $objs << 'win32_binary_gem.o'
+end
+
 create_makefile("flite_#{$1}#{$2}0")