RubySpeech

RubySpeech is a library for constructing and parsing Text to Speech (TTS) and Automatic Speech Recognition (ASR) documents such as SSML and GRXML. The primary use case is for construction of these documents to be processed by TTS and ASR engines.

Installation

gem install ruby_speech

Library

RubySpeech provides a DSL for constructing SSML documents like so:

require 'ruby_speech'

speak = RubySpeech::SSML.draw do
  voice gender: :male, name: 'fred' do
    string "Hi, I'm Fred. The time is currently "
    say_as interpret_as: 'date', format: 'dmy' do
      "01/02/1960"
    end
  end
end

speak.to_s

becomes:

<speak xmlns="http://www.w3.org/2001/10/synthesis" version="1.0" xml:lang="en-US">
  <voice gender="male" name="fred">
    Hi, I'm Fred. The time is currently <say-as format="dmy" interpret-as="date">01/02/1960</say-as>
  </voice>
</speak>

Once your Speak is fully prepared and you're ready to send it off for processing, you must call to_doc on it to add the XML header:

<?xml version="1.0"?>
<speak xmlns="http://www.w3.org/2001/10/synthesis" version="1.0" xml:lang="en-US">
  <voice gender="male" name="fred">
    Hi, I'm Fred. The time is currently <say-as format="dmy" interpret-as="date">01/02/1960</say-as>
  </voice>
</speak>

You may also then need to call to_s.

Contruct a GRXML (SRGS) document like this:

require 'ruby_speech'

grammy = RubySpeech::GRXML.draw do
  self.mode = 'dtmf'
  self.root = 'digits'
  rule id: 'digits' do
    one_of do
      0.upto(9) {|d| item { d.to_s } }
    end
  end

  rule id: 'pin', scope: 'public' do
    one_of do
      item do
        item repeat: '4' do
          ruleref uri: '#digit'
        end
        "#"
      end
      item do
        "* 9"
      end
    end
  end
end

grammy.to_s

which becomes

<grammar xmlns="http://www.w3.org/2001/06/grammar" version="1.0" xml:lang="en-US" mode="dtmf" root="digits">
  <rule id="digits">
    <one-of>
      <item>0</item>
      <item>1</item>
      <item>2</item>
      <item>3</item>
      <item>4</item>
      <item>5</item>
      <item>6</item>
      <item>7</item>
      <item>8</item>
      <item>9</item>
    </one-of>
  </rule>
  <rule id="pin" scope="public">
    <one-of>
      <item><item repeat="4"><ruleref uri="#digit"/></item>#</item>
      <item>* 9</item>
    </one-of>
  </rule>
</grammar>

Check out the YARD documentation for more

Features:

SSML

• Document construction
• <voice/>
• <prosody/>
• <emphasis/>
• <say-as/>
• <break/>
• <audio/>

GRXML

• Document construction
• <item/>
• <one-of/>
• <rule/>
• <ruleref/>
• <tag/>
• <token/>

TODO:

SSML

Document Structure

• <p/> and <s/>
• <phoneme/>
• <sub/>
• <lexicon/>
• <meta/> and <metadata/>

Misc

• <mark/>
• <desc/>

GRXML

• <meta/> and <metadata/>
• <example/>
• <lexicon/>

Links:

• Source
• Documentation
• Bug Tracker

Note on Patches/Pull Requests

• Fork the project.
• Make your feature addition or bug fix.
• Add tests for it. This is important so I don't break it in a future version unintentionally.
• Commit, do not mess with rakefile, version, or history.
  • If you want to have your own version, that is fine but bump version in a commit by itself so I can ignore when I pull
• Send me a pull request. Bonus points for topic branches.

Copyright

Copyright (c) 2011 Ben Langfeld. MIT licence (see LICENSE for details).