ruby_speech 0.1.0

data/assets/synthesis.xsd

@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xsd:schema targetNamespace="http://www.w3.org/2001/10/synthesis"
+xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+xmlns="http://www.w3.org/2001/10/synthesis" elementFormDefault="qualified">
+  <xsd:annotation>
+  <xsd:documentation>SSML 1.0 Schema (20040615)</xsd:documentation>
+  </xsd:annotation>
+  <xsd:annotation>
+  <xsd:documentation>Copyright 1998-2004 W3C (MIT, ERCIM, Keio),
+  All Rights Reserved. Permission to use, copy, modify and
+  distribute the SSML schema and its accompanying documentation
+  for any purpose and without fee is hereby granted in
+  perpetuity, provided that the above copyright notice and this
+  paragraph appear in all copies.  The copyright holders make no
+  representation about the suitability of the schema for any purpose.
+  It is provided "as is" without expressed or implied warranty.
+  </xsd:documentation>
+  </xsd:annotation>
+
+  <xsd:import namespace="http://www.w3.org/XML/1998/namespace"
+              schemaLocation="xml.xsd"/>
+   <xsd:redefine schemaLocation="synthesis-core.xsd">
+
+    <xsd:annotation>
+        <xsd:documentation>restriction: version and attributes on speak mandatory</xsd:documentation>
+    </xsd:annotation>
+        <xsd:complexType name="speak" mixed="true">
+            <xsd:complexContent>
+                <xsd:restriction base="speak">
+    <xsd:group ref="speak.class"/>
+    <xsd:attribute name="version" type="version.datatype"  use="required"/>
+    <xsd:attribute ref="xml:lang" use="required"/>
+    </xsd:restriction>
+            </xsd:complexContent>
+        </xsd:complexType>
+
+    <xsd:annotation>
+        <xsd:documentation>restriction: src attribute on audio is mandatory</xsd:documentation>
+    </xsd:annotation>
+        <xsd:complexType name="audio" mixed="true">
+            <xsd:complexContent>
+                <xsd:restriction base="audio">
+    <xsd:group ref="descAndSentenceAndStructure.class"/>
+    <xsd:attribute name="src" type="xsd:anyURI" use="required"/>
+    </xsd:restriction>
+            </xsd:complexContent>
+        </xsd:complexType>
+
+
+    <xsd:annotation>
+        <xsd:documentation>restriction: name attribute on mark is mandatory</xsd:documentation>
+    </xsd:annotation>
+        <xsd:complexType name="mark">
+            <xsd:complexContent>
+                <xsd:restriction base="mark">
+    <xsd:attribute name="name" type="xsd:token" use="required"/>
+    </xsd:restriction>
+            </xsd:complexContent>
+  </xsd:complexType>
+
+    </xsd:redefine>
+
+</xsd:schema>

data/assets/xml.xsd

@@ -0,0 +1,287 @@
+<?xml version='1.0'?>
+<?xml-stylesheet href="../2008/09/xsd.xsl" type="text/xsl"?>
+<xs:schema targetNamespace="http://www.w3.org/XML/1998/namespace" 
+  xmlns:xs="http://www.w3.org/2001/XMLSchema" 
+  xmlns   ="http://www.w3.org/1999/xhtml"
+  xml:lang="en">
+
+ <xs:annotation>
+  <xs:documentation>
+   <div>
+    <h1>About the XML namespace</h1>
+
+    <div class="bodytext">
+     <p>
+      This schema document describes the XML namespace, in a form
+      suitable for import by other schema documents.
+     </p>
+     <p>
+      See <a href="http://www.w3.org/XML/1998/namespace.html">
+      http://www.w3.org/XML/1998/namespace.html</a> and
+      <a href="http://www.w3.org/TR/REC-xml">
+      http://www.w3.org/TR/REC-xml</a> for information 
+      about this namespace.
+     </p>
+     <p>
+      Note that local names in this namespace are intended to be
+      defined only by the World Wide Web Consortium or its subgroups.
+      The names currently defined in this namespace are listed below.
+      They should not be used with conflicting semantics by any Working
+      Group, specification, or document instance.
+     </p>
+     <p>   
+      See further below in this document for more information about <a
+      href="#usage">how to refer to this schema document from your own
+      XSD schema documents</a> and about <a href="#nsversioning">the
+      namespace-versioning policy governing this schema document</a>.
+     </p>
+    </div>
+   </div>
+  </xs:documentation>
+ </xs:annotation>
+
+ <xs:attribute name="lang">
+  <xs:annotation>
+   <xs:documentation>
+    <div>
+     
+      <h3>lang (as an attribute name)</h3>
+      <p>
+       denotes an attribute whose value
+       is a language code for the natural language of the content of
+       any element; its value is inherited.  This name is reserved
+       by virtue of its definition in the XML specification.</p>
+     
+    </div>
+    <div>
+     <h4>Notes</h4>
+     <p>
+      Attempting to install the relevant ISO 2- and 3-letter
+      codes as the enumerated possible values is probably never
+      going to be a realistic possibility.  
+     </p>
+     <p>
+      See BCP 47 at <a href="http://www.rfc-editor.org/rfc/bcp/bcp47.txt">
+       http://www.rfc-editor.org/rfc/bcp/bcp47.txt</a>
+      and the IANA language subtag registry at
+      <a href="http://www.iana.org/assignments/language-subtag-registry">
+       http://www.iana.org/assignments/language-subtag-registry</a>
+      for further information.
+     </p>
+     <p>
+      The union allows for the 'un-declaration' of xml:lang with
+      the empty string.
+     </p>
+    </div>
+   </xs:documentation>
+  </xs:annotation>
+  <xs:simpleType>
+   <xs:union memberTypes="xs:language">
+    <xs:simpleType>    
+     <xs:restriction base="xs:string">
+      <xs:enumeration value=""/>
+     </xs:restriction>
+    </xs:simpleType>
+   </xs:union>
+  </xs:simpleType>
+ </xs:attribute>
+
+ <xs:attribute name="space">
+  <xs:annotation>
+   <xs:documentation>
+    <div>
+     
+      <h3>space (as an attribute name)</h3>
+      <p>
+       denotes an attribute whose
+       value is a keyword indicating what whitespace processing
+       discipline is intended for the content of the element; its
+       value is inherited.  This name is reserved by virtue of its
+       definition in the XML specification.</p>
+     
+    </div>
+   </xs:documentation>
+  </xs:annotation>
+  <xs:simpleType>
+   <xs:restriction base="xs:NCName">
+    <xs:enumeration value="default"/>
+    <xs:enumeration value="preserve"/>
+   </xs:restriction>
+  </xs:simpleType>
+ </xs:attribute>
+ 
+ <xs:attribute name="base" type="xs:anyURI"> <xs:annotation>
+   <xs:documentation>
+    <div>
+     
+      <h3>base (as an attribute name)</h3>
+      <p>
+       denotes an attribute whose value
+       provides a URI to be used as the base for interpreting any
+       relative URIs in the scope of the element on which it
+       appears; its value is inherited.  This name is reserved
+       by virtue of its definition in the XML Base specification.</p>
+     
+     <p>
+      See <a
+      href="http://www.w3.org/TR/xmlbase/">http://www.w3.org/TR/xmlbase/</a>
+      for information about this attribute.
+     </p>
+    </div>
+   </xs:documentation>
+  </xs:annotation>
+ </xs:attribute>
+ 
+ <xs:attribute name="id" type="xs:ID">
+  <xs:annotation>
+   <xs:documentation>
+    <div>
+     
+      <h3>id (as an attribute name)</h3> 
+      <p>
+       denotes an attribute whose value
+       should be interpreted as if declared to be of type ID.
+       This name is reserved by virtue of its definition in the
+       xml:id specification.</p>
+     
+     <p>
+      See <a
+      href="http://www.w3.org/TR/xml-id/">http://www.w3.org/TR/xml-id/</a>
+      for information about this attribute.
+     </p>
+    </div>
+   </xs:documentation>
+  </xs:annotation>
+ </xs:attribute>
+
+ <xs:attributeGroup name="specialAttrs">
+  <xs:attribute ref="xml:base"/>
+  <xs:attribute ref="xml:lang"/>
+  <xs:attribute ref="xml:space"/>
+  <xs:attribute ref="xml:id"/>
+ </xs:attributeGroup>
+
+ <xs:annotation>
+  <xs:documentation>
+   <div>
+   
+    <h3>Father (in any context at all)</h3> 
+
+    <div class="bodytext">
+     <p>
+      denotes Jon Bosak, the chair of 
+      the original XML Working Group.  This name is reserved by 
+      the following decision of the W3C XML Plenary and 
+      XML Coordination groups:
+     </p>
+     <blockquote>
+       <p>
+	In appreciation for his vision, leadership and
+	dedication the W3C XML Plenary on this 10th day of
+	February, 2000, reserves for Jon Bosak in perpetuity
+	the XML name "xml:Father".
+       </p>
+     </blockquote>
+    </div>
+   </div>
+  </xs:documentation>
+ </xs:annotation>
+
+ <xs:annotation>
+  <xs:documentation>
+   <div xml:id="usage" id="usage">
+    <h2><a name="usage">About this schema document</a></h2>
+
+    <div class="bodytext">
+     <p>
+      This schema defines attributes and an attribute group suitable
+      for use by schemas wishing to allow <code>xml:base</code>,
+      <code>xml:lang</code>, <code>xml:space</code> or
+      <code>xml:id</code> attributes on elements they define.
+     </p>
+     <p>
+      To enable this, such a schema must import this schema for
+      the XML namespace, e.g. as follows:
+     </p>
+     <pre>
+          &lt;schema . . .>
+           . . .
+           &lt;import namespace="http://www.w3.org/XML/1998/namespace"
+                      schemaLocation="http://www.w3.org/2001/xml.xsd"/>
+     </pre>
+     <p>
+      or
+     </p>
+     <pre>
+           &lt;import namespace="http://www.w3.org/XML/1998/namespace"
+                      schemaLocation="http://www.w3.org/2009/01/xml.xsd"/>
+     </pre>
+     <p>
+      Subsequently, qualified reference to any of the attributes or the
+      group defined below will have the desired effect, e.g.
+     </p>
+     <pre>
+          &lt;type . . .>
+           . . .
+           &lt;attributeGroup ref="xml:specialAttrs"/>
+     </pre>
+     <p>
+      will define a type which will schema-validate an instance element
+      with any of those attributes.
+     </p>
+    </div>
+   </div>
+  </xs:documentation>
+ </xs:annotation>
+
+ <xs:annotation>
+  <xs:documentation>
+   <div id="nsversioning" xml:id="nsversioning">
+    <h2><a name="nsversioning">Versioning policy for this schema document</a></h2>
+    <div class="bodytext">
+     <p>
+      In keeping with the XML Schema WG's standard versioning
+      policy, this schema document will persist at
+      <a href="http://www.w3.org/2009/01/xml.xsd">
+       http://www.w3.org/2009/01/xml.xsd</a>.
+     </p>
+     <p>
+      At the date of issue it can also be found at
+      <a href="http://www.w3.org/2001/xml.xsd">
+       http://www.w3.org/2001/xml.xsd</a>.
+     </p>
+     <p>
+      The schema document at that URI may however change in the future,
+      in order to remain compatible with the latest version of XML
+      Schema itself, or with the XML namespace itself.  In other words,
+      if the XML Schema or XML namespaces change, the version of this
+      document at <a href="http://www.w3.org/2001/xml.xsd">
+       http://www.w3.org/2001/xml.xsd 
+      </a> 
+      will change accordingly; the version at 
+      <a href="http://www.w3.org/2009/01/xml.xsd">
+       http://www.w3.org/2009/01/xml.xsd 
+      </a> 
+      will not change.
+     </p>
+     <p>
+      Previous dated (and unchanging) versions of this schema 
+      document are at:
+     </p>
+     <ul>
+      <li><a href="http://www.w3.org/2009/01/xml.xsd">
+	http://www.w3.org/2009/01/xml.xsd</a></li>
+      <li><a href="http://www.w3.org/2007/08/xml.xsd">
+	http://www.w3.org/2007/08/xml.xsd</a></li>
+      <li><a href="http://www.w3.org/2004/10/xml.xsd">
+	http://www.w3.org/2004/10/xml.xsd</a></li>
+      <li><a href="http://www.w3.org/2001/03/xml.xsd">
+	http://www.w3.org/2001/03/xml.xsd</a></li>
+     </ul>
+    </div>
+   </div>
+  </xs:documentation>
+ </xs:annotation>
+
+</xs:schema>
+

data/lib/ruby_speech.rb

@@ -0,0 +1,15 @@
+%w{
+  active_support/dependencies/autoload
+  active_support/core_ext/object/blank
+  active_support/core_ext/numeric/time
+  niceogiri
+}.each { |f| require f }
+
+module RubySpeech
+  extend ActiveSupport::Autoload
+
+  autoload :Version
+
+  autoload :SSML
+  autoload :XML
+end

data/lib/ruby_speech/ssml.rb

@@ -0,0 +1,24 @@
+module RubySpeech
+  module SSML
+    extend ActiveSupport::Autoload
+
+    autoload :Break
+    autoload :Element
+    autoload :Emphasis
+    autoload :Prosody
+    autoload :SayAs
+    autoload :Speak
+    autoload :Voice
+
+    InvalidChildError = Class.new StandardError
+
+    def self.draw(&block)
+      Nokogiri::XML::Document.new.tap do |doc|
+        doc << Speak.new.tap do |speak|
+          block_return = speak.instance_eval(&block) if block_given?
+          speak << block_return if block_return.is_a?(String)
+        end
+      end.to_s
+    end
+  end # SSML
+end # RubySpeech

data/lib/ruby_speech/ssml/break.rb

@@ -0,0 +1,71 @@
+module RubySpeech
+  module SSML
+    ##
+    # The break element is an empty element that controls the pausing or other prosodic boundaries between words. The use of the break element between any pair of words is optional. If the element is not present between words, the synthesis processor is expected to automatically determine a break based on the linguistic context. In practice, the break element is most often used to override the typical automatic behavior of a synthesis processor.
+    #
+    # http://www.w3.org/TR/speech-synthesis/#S3.2.3
+    #
+    class Break < Element
+
+      VALID_STRENGTHS = [:none, :'x-weak', :weak, :medium, :strong, :'x-strong'].freeze
+
+      ##
+      # Create a new SSML break element
+      #
+      # @param [Hash] atts Key-value pairs of options mapping to setter methods
+      #
+      # @return [Break] an element for use in an SSML document
+      #
+      def self.new(atts = {}, &block)
+        super 'break', atts, &block
+      end
+
+      ##
+      # This attribute is used to indicate the strength of the prosodic break in the speech output. The value "none" indicates that no prosodic break boundary should be outputted, which can be used to prevent a prosodic break which the processor would otherwise produce. The other values indicate monotonically non-decreasing (conceptually increasing) break strength between words. The stronger boundaries are typically accompanied by pauses. "x-weak" and "x-strong" are mnemonics for "extra weak" and "extra strong", respectively.
+      #
+      # @return [Symbol]
+      #
+      def strength
+        read_attr :strength, :to_sym
+      end
+
+      ##
+      # @param [Symbol] the strength. Must be one of VALID_STRENGTHS
+      #
+      # @raises ArgumentError if s is not one of VALID_STRENGTHS
+      #
+      def strength=(s)
+        raise ArgumentError, "You must specify a valid strength (#{VALID_STRENGTHS.map(&:inspect).join ', '})" unless VALID_STRENGTHS.include? s
+        write_attr :strength, s
+      end
+
+      ##
+      # Indicates the duration of a pause to be inserted in the output in seconds or milliseconds. It follows the time value format from the Cascading Style Sheets Level 2 Recommendation [CSS2], e.g. "250ms", "3s".
+      #
+      # @return [Float]
+      #
+      def time
+        read_attr :time, :to_f
+      end
+
+      ##
+      # @param [Numeric] t the time as a positive value in seconds
+      #
+      # @raises ArgumentError if t is nota positive numeric value
+      #
+      def time=(t)
+        raise ArgumentError, "You must specify a valid time (positive float value in seconds)" unless t.is_a?(Numeric) && t >= 0
+        write_attr :time, "#{t}s"
+      end
+
+      def <<(*args)
+        raise InvalidChildError, "A Break cannot contain children"
+        super
+      end
+
+      def eql?(o)
+        super o, :strength, :time
+      end
+    end # Break
+  end # SSML
+end # RubySpeech