festivaltts4r 0.1.1 → 0.2.0

data/lib/festivaltts4r.rb

@@ -1 +1,2 @@
+# Include festivaltts4r lib subdirectory files.
 Dir[File.join(File.dirname(__FILE__), 'festivaltts4r/**/*.rb')].sort.each { |lib| require lib }

data/lib/festivaltts4r/festival4r.rb

@@ -1,21 +1,88 @@
 #
 # Ruby Interface to festival tts system
-# 
+#
+# Requires festivaltts and lame.
+# Must be run in a UNIX environment.
+#
+# You can found more information in my english blog http://spejman-on-rails.blogspot.com 
+# or in the spanish one http://spejman.blogspot.com 
+#
+# Work done by Sergio Espeja (http://www.sergioespeja.com) and Mike Mondragon (http://blog.mondragon.cc)
+#
+# It is free software, and may be redistributed under GPL license.
+# Copyright (c) 2007 Sergio Espeja
+
 
 class String
   
-  def to_speech(params={})
-  
+  # Outputs the speech generated with festival tts and the string itself.
+  # Can handle these options:
+  # - text --> speech given text instead of the string itself.
+  # - language --> speech language desired (festival voices for given languages are required )  
+  # - festival --> alternative festival program and options besides 'festival --tts'
+
+  def to_speech(params={})  
     text = params[:text] || self
+    festival = params[:festival] || "festival --tts"
     language = "--language " + params[:language] if params[:language]
-    system("echo \"#{text.to_s}\" | festival --tts #{language}")
+
+    cmd = "echo \"#{text.to_s}\" | #{festival} #{language} 2>&1"
+
+    self.class.execute cmd
+
   end
   
+  # Creates a file with name "filename" and with the generated with festival tts, the string itself and lame.
+  # Can handle one options:
+  # - text --> speech given text instead of the string itself.  
+  # - text2wave - alternative text2wave program and options besides 'text2wave'
+  # - lame - alternative lame command other than 'lame --alt-preset cbr 16 -a --resample 11 --lowpass 5 --athtype 2 -X3 -'
   def to_mp3(filename, params={})
-
     text = params[:text] || self
+    text2wave = params[:text2wave] || "text2wave"
+    # athtype not on all LAMEs, i.e. --athtype 2 
+    lame = params[:lame] || "lame --alt-preset cbr 16 -a --resample 11 --lowpass 5 -X3 -"
     raise "to_mp3 language option still not implemented" if params[:language]
-    system("echo \"#{text.to_s}\" | text2wave | lame --alt-preset cbr 16 -a --resample 11 --lowpass 5 --athtype 2 -X3 - > #{filename} 2> /dev/null")
+    cmd = "echo \"#{text.to_s}\" | #{text2wave} | #{lame} > #{filename} 2>&1"
+
+    self.class.execute cmd
+  end
+
+  def self.execute(cmd)
+    begin
+      out = IO.popen(cmd)
+      Process.wait
+      e = $?.exitstatus
+    rescue StandardError => err
+      raise FestivalError.new(err)
+    else
+      raise FestivalSystemError.new("0 not returned:\n#{cmd}\n#{out.readlines}"
+        ) unless e.eql?(0)
+    end
   end
   
-end
+end
+
+##
+# A generic application error wrapper for festivaltts4r
+
+class FestivalError < RuntimeError
+
+  ##
+  # The original exception
+
+  attr_accessor :original_exception
+
+  ##
+  # Creates a new FestivalError with +message+ and +original_exception+
+
+  def initialize(e)
+    exception = e.class == String ? StandardError.new(e) : e
+    @original_exception = exception
+    message = "festivaltts4r error: #{exception.message} (#{exception.class})"
+    super message
+  end
+
+end
+
+class FestivalSystemError < FestivalError; end

data/lib/festivaltts4r/version.rb

@@ -1,8 +1,8 @@
 module Festivaltts4r #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 1
-    TINY  = 1
+    MINOR = 2
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/festivaltts4r_test.rb

@@ -1,11 +1,62 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
+require 'tempfile'
 
 class Festivaltts4rTest < Test::Unit::TestCase
 
   def setup
+    @mp3 = Tempfile.new('fake.mp3')
   end
-  
-  def test_truth
-    assert true
+
+  def teardown
+    @mp3.unlink
+  end
+
+  def test_string_execute
+    assert_raises(FestivalSystemError) do
+      String.execute '/bin/false'
+    end
+
+    assert_nothing_raised do
+      String.execute '/bin/true'
+    end
+  end
+
+  def test_to_speech
+    assert_raises(FestivalSystemError) do
+      params = {:festival => '/bin/not-a-real-program'}
+      "hello world".to_speech(params)
+    end
+
+    assert_raises(FestivalSystemError) do
+      params = {:festival => '/bin/false'}
+      "hello world".to_speech(params)
+    end
+
+    assert_nothing_raised do
+      params = {:festival => '/bin/true'}
+      "hello world".to_speech(params)
+    end
+  end
+
+  def test_to_mp3
+    assert_raises(FestivalSystemError) do
+      params = {:lame => '/bin/false'}
+      "hello world".to_mp3(@mp3.path, params)
+    end
+
+    assert_nothing_raised do
+      params = {:text2wave => '/bin/true'}
+      params = {:lame => '/bin/true'}
+      "hello world".to_mp3(@mp3.path, params)
+    end
+  end
+
+  def test_to_mp3_really_creates_a_file
+    if system('which text2wave') && system('which lame')
+      assert_equal 0, @mp3.size
+      "hello world".to_mp3(@mp3.path, params={})
+      assert_equal true, File.exists?(@mp3)
+      assert @mp3.size > 0
+    end
   end
 end

metadata

@@ -1,33 +1,37 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
-specification_version: 1
 name: festivaltts4r
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
-date: 2007-05-30 00:00:00 +02:00
-summary: "Text-to-speech for Ruby using festivaltts. Provides two new methods for String: to_speech and to_mp3. Requires festivaltts and lame."
-require_paths: 
-- lib
-email: sergio.espeja@gmail.com
-homepage: http://festivaltts4r.rubyforge.org
-rubyforge_project: festivaltts4r
-description: "Text-to-speech for Ruby using festivaltts. Provides two new methods for String: to_speech and to_mp3. Requires festivaltts and lame."
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
-platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
+  version: 0.2.0
+platform: ""
 authors: 
 - Sergio Espeja
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2007-12-18 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
+description: "Text-to-speech for Ruby using festivaltts. Provides two new methods for String: to_speech and to_mp3. Requires festivaltts and lame."
+email: sergio.espeja@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG.txt
+- History.txt
+- Manifest.txt
+- README.txt
 files: 
 - CHANGELOG.txt
 - History.txt
@@ -40,29 +44,32 @@ files:
 - setup.rb
 - test/festivaltts4r_test.rb
 - test/test_helper.rb
-test_files: 
-- test/festivaltts4r_test.rb
+has_rdoc: true
+homepage: http://festivaltts4r.rubyforge.org
+post_install_message: 
 rdoc_options: 
 - --main
 - README.txt
-extra_rdoc_files: 
-- CHANGELOG.txt
-- History.txt
-- Manifest.txt
-- README.txt
-executables: []
-
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.2.1
-    version: 
+rubyforge_project: festivaltts4r
+rubygems_version: 0.9.5
+signing_key: 
+specification_version: 2
+summary: "Text-to-speech for Ruby using festivaltts. Provides two new methods for String: to_speech and to_mp3. Requires festivaltts and lame."
+test_files: 
+- test/festivaltts4r_test.rb