flite4r 1.0.0 → 1.0.1

data/.document

@@ -0,0 +1,3 @@
+README.rb
+ext/flite4r.c
+test/flite_test.rb

data/README

@@ -2,7 +2,7 @@
 
 Flite4r is a small library to allows speech synthesis via Edinburgh University's flite library.
 
-Version :: 1.0.0
+Version :: 1.0.1
 
 = Links
 
@@ -13,26 +13,23 @@ Version :: 1.0.0
 == Installation
 
 Flite4r has only been tested on Ubuntu GNU/Linux 7.04 and 7.10. It requires that the flite1-dev and libflite1 packages
-are already installed. On Ubunut you can install with the following commands.
+are already installed. On Ubuntu you can install with the following commands.
 
  $ sudo apt-get install flite1-dev
  $ gem install flite4r
 
 == Simple Example
 
-The only method the flite4r provides is an extension to the String class with "to_speech".
+Flite4r only provides two methods as extensions to the String class: "to_speech" and "to_speech_file".
 
-Here's the complete example:
+Here's an example:
 
   require 'rubygems'
   require 'flite4r'
-  require 'test/unit'
 
-  class TestFlite < Test::Unit::TestCase
-    def test_to_speech
-      "It's working!".to_speech
-    end
-  end
+  "It's working!".to_speech
+
+  "I am saved as a wav file".to_speech_file("myfile.wav")
 
 == License and Warranty
 
@@ -40,7 +37,7 @@ Copyright (C) 2007 by Geoff Jacobsen <geoffjacobsen@gmail.com>
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
+the Free Software Foundation; either version 3 of the License, or
 (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,
@@ -52,6 +49,10 @@ You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
+= Credits
+
+Hubert Łępicki: to_speech_file method
+
 = Other stuff
 
 Author::   Geoff Jacobsen <geoffjacobsen@gmail.com>

data/README.rb

@@ -0,0 +1 @@
+# :include:README

data/ext/flite4r.c

@@ -1,4 +1,4 @@
-/**
+/*
    Copyright (C) 2007 by Geoff Jacobsen <geoffjacobsen@gmail.com>
 
    This program is free software; you can redistribute it and/or modify
@@ -24,13 +24,36 @@ static cst_voice *v;
 
 cst_voice *register_cmu_us_kal();
 
-static VALUE flite4r_to_speech(VALUE self) {
+/* :call-seq:
+ *   "hello word".to_speech -> "hello world"
+ *
+ * Audibly read the string.
+ */
+static VALUE flite4r_to_speech(VALUE self)
+{
   flite_text_to_speech(StringValuePtr(self),v,"play");
 
   return self;
 }
 
-void Init_flite4r() {
+/* :call-seq:
+ *   "save speech as wav file".to_speech_file("myfile.wav") -> creates wav file "myfile.wav"
+ *
+ * Output speech to a wav file.
+ */
+static VALUE flite4r_to_speech_file(VALUE self, VALUE filename) {
+  flite_text_to_speech(StringValuePtr(self),v,StringValuePtr(filename));
+
+  return self;
+}
+
+
+
+/*
+ * Extend String class so that strings can be spoken.
+ */
+void Init_flite4r()
+{
   flite_init();
 
   v = register_cmu_us_kal();
@@ -38,4 +61,5 @@ void Init_flite4r() {
   cFlite = rb_define_class("String", rb_cObject);
 
   rb_define_method(cFlite, "to_speech", flite4r_to_speech, 0);
+  rb_define_method(cFlite, "to_speech_file", flite4r_to_speech_file, 1);
 }

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: flite4r
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
-date: 2008-01-23 00:00:00 +13:00
+  version: 1.0.1
+date: 2008-03-05 00:00:00 +13:00
 summary: ruby interface to the flite text to speech simulator.
 require_paths: 
 - lib
@@ -30,6 +30,8 @@ authors:
 - Geoff Jacobsen
 files: 
 - ext/flite4r.c
+- .document
+- README.rb
 - README
 - COPYING
 test_files: []
@@ -37,6 +39,8 @@ test_files: []
 rdoc_options: []
 
 extra_rdoc_files: 
+- .document
+- README.rb
 - README
 - COPYING
 executables: []