ssmd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6818a5bb8c25e44cf95522fe1a5d0852a9114c9d
+  data.tar.gz: ca1ff40b6e7a5f51900ceea642771b959bcdb41b
+SHA512:
+  metadata.gz: 9e6ff09b5251da93e455a8731ccf624881abf4e52da4c18369c6bd55d413d059f2e7c77f8aec7070e7d530f1c27cab76a65d73534f70c196d9773070070251f8
+  data.tar.gz: 4c8e7b110e9e48ac65e3e957cb4b2b30535fa6e5811503f24ff62b3355003001168f969caa33a9288b9f3b6570c24bdace187eea0008c9fd2939342701b614f6

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at machisuji@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ssmd.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Markus Kahl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# SSMD
+
+[![Build Status](https://travis-ci.org/machisuji/ssmd.svg?branch=master)](https://travis-ci.org/machisuji/ssmd)
+
+Speech Synthesis Markdown (SSMD) is an lightweight alternative syntax for [SSML](https://www.w3.org/TR/speech-synthesis/).
+This repository contains both the reference implementation of the SSMD-to-SSML conversion tool (`ssmd`) as well
+as the [specification](SPECIFICATION.md) of the language.
+
+## Requirements
+
+The tools and executable specification provided in this repository require **Ruby 2.3.4** or better.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ssmd'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ssmd
+
+## Usage
+
+```ruby
+require 'ssmd'
+
+ssmd = "hello *SSMD*!"
+ssmd = SSMD.to_ssml ssmd
+
+puts ssmd
+# Output: <speak>hello <emphasis>SSMD</emphasis>!</speak>
+```
+
+**Note:**
+
+This version is still under development. So far only the following conversions
+described in the specification are implemented:
+
+* Text
+* Emphasis
+* Mark
+* Language
+* Phoneme
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Tests
+
+Run `rake spec` to run the tests against a given executable.
+
+This implementation and any other can be tested against the SSMD specification.
+Said specification is extracted from `SPECIFICATION.md`.
+It runs each SSMD snippet through the tested tool and compares it to the output of
+the following SSML snippet. If they match the test passes.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/machisuji/ssmd. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/SPECIFICATION.md

@@ -0,0 +1,333 @@
+# SSMD Specification
+
+Here we specify how Speech Synthesis Markdown (SSMD) works.
+
+## Syntax
+
+SSMD is mapped to SSML using the following rules.
+
+* [Text](#text)
+* [Emphasis](#emphasis)
+* [Break](#break)
+* [Language](#language)
+* [Mark](#mark)
+* [Paragraph](#paragraph)
+* [Phoneme](#phoneme)
+* [Prosody](#prosody)
+* [Say-as](#say-as)
+* [Substitution](#substitution)
+* [Extensions](#extensions)
+
+***
+
+### Text
+
+Any text written is implicitly wrapped in a `<speak>` root element.
+This will be omitted in the rest of the examples shown in this section.
+
+SSMD:
+```
+text
+```
+
+SSML:
+```html
+<speak>text</speak>
+```
+
+***
+
+### Emphasis
+
+SSMD:
+```
+*word*
+```
+
+SSML:
+```html
+<emphasis>word</emphasis>
+```
+
+***
+
+### Break
+
+Pauses can be indicated by using `...`. Several modifications to the duration are allowed as shown below.
+
+SSMD:
+```
+Hello ...      world    (default: x-strong break like after a paragraph)
+Hello - ...0   world    (skip break when there would otherwise be one like after this dash)
+Hello ...c     world    (medium break like after a comma)
+Hello ...s     world    (strong break like after a sentence)
+Hello ...p     world    (extra string break like after a paragraph)
+Hello ...5s    world    (5 second break (max 10s))
+Hello ...100ms world    (100 millisecond break (max 10000ms))
+Hello ...100   world    (100 millisecond break (max 10000ms))
+```
+
+SSML:
+```html
+Hello <break strength="x-strong"/> world
+Hello - <break strength="none"/> world
+Hello <break strength="medium"/> world
+Hello <break strength="strong"/> world
+Hello <break strength="x-strong"/> world
+Hello <break time="5s"/> world
+Hello <break time="100ms"/> world
+Hello <break time="100ms"/> world
+```
+
+***
+
+### Language
+
+Text passages can be annotated with ISO 639-1 language codes as shown below.
+SSML expects a full code including a country. While you can provide those too
+SSMD will use a sensible default in case where this is omitted.
+As can be seen in the first example where `en` defaults to `en-US` and
+`de` defaults to `de-DE`.
+
+SSMD:
+```
+Ich sah [Guardians of the Galaxy](en) im Kino.
+Ich sah [Guardians of the Galaxy](en-GB) im Kino.
+I saw ["Die Häschenschule"](de) in the cinema.
+```
+
+SSML:
+```html
+Ich sah <lang xml:lang="en-US">Guardians of the Galaxy</lang> im Kino.
+Ich sah <lang xml:lang="en-GB">Guardians of the Galaxy</lang> im Kino.
+I saw <lang xml:lang="de-DE">"Die Häschenschule"</lang> in the cinema.
+```
+
+***
+
+### Mark
+
+Sections of text can be tagged using marks. They do not effect the synthesis but
+can be returned by SSML processing engines as meta information and to emit
+events during processing based on these marks.
+
+SSMD:
+```
+I always wanted a @animal cat as a pet.
+```
+
+SSML:
+```html
+I always wanted a <mark name="animal"/> cat as a pet.
+```
+
+***
+
+### Paragraph
+
+Empty lines indicate a paragraph.
+
+SSMD:
+```
+First prepare the ingredients.
+Don't forget to wash them first.
+
+Lastly mix them all together.
+```
+
+SSML:
+```html
+<p>First prepare the ingredients. Don't forget to wash them first.</p>
+<p>Lastly mix them all together.</p>
+```
+
+***
+
+### Phoneme
+
+Sometimes the speech synthesis engine needs to be told how exactly to pronounce a word.
+This can be done via phonemes. While SSML supports IPA, SSMD uses [X-SAMPA](https://en.wikipedia.org/wiki/X-SAMPA) by default.
+
+SSMD:
+```
+The German word ["dich"](ph: dIC) does not sound like dick.
+```
+
+SSML:
+```html
+The German word <phoneme alphabet="ipa" ph="dɪç">"dich"</phoneme> does not sound like dick.
+```
+
+***
+
+### Prosody
+
+The prosody or rythm depends the volume, rate and pitch of the delivered text.
+
+Each of those values can be defined by a number between 1 and 5 where those mean:
+
+| number | volume | rate | pitch |
+| ------ | ------ | ---- | ----- |
+| 0 | silent |        |        |
+| 1 | x-soft | x-slow | x-low  |
+| 2 | soft   | slow   | low    |
+| 3 | medium | medium | medium |
+| 4 | loud   | fast   | high   |
+| 5 | x-loud | x-fast | x-high |
+
+SSMD:
+```
+Volume:
+
+~silent~
+--extra soft--
+-soft-
+medium
++loud+ or LOUD
+++extra loud++
+
+Rate:
+
+<<extra slow<<
+<slow<
+medium
+>fast>
+>>extra fast>>
+
+Pitch:
+
+__extra low__
+_low_
+medium
+^high^
+^^extra high^^
+
+++>>^^extra loud, fast and high^^>>++ or
+[extra loud, fast, and high](vrp: 555) or
+[extra loud, fast, and high](v: 5, r: 5, p: 5)
+```
+
+SSML:
+```html
+Volume:
+
+<prosody volume="silent">silent</prosody>
+<prosody volume="x-soft">extra soft</prosody>
+<prosody volume="soft">soft</prosody>
+medium
+<prosody volume="loud">loud</prosody> or <prosody volume="loud">loud</prosody>
+<prosody volume="x-loud">extra loud</prosody>
+
+Rate:
+
+<prosody rate="x-slow">extra slow</prosody>
+<prosody rate="slow">slow</prosody>
+medium
+<prosody rate="fast">fast</prosody>
+<prosody rate="x-fast">extra fast</prosody>
+
+Pitch:
+
+<prosody pitch="x-low">extra low</prosody>
+<prosody pitch="low">low</prosody>
+medium
+<prosody pitch="high">high</prosody>
+<prosody pitch="x-high">extra high</prosody>
+
+<prosody volume="x-loud" rate="x-fast" pitch="x-high">extra loud, fast and high</prosody> or
+<prosody volume="x-loud" rate="x-fast" pitch="x-high">extra loud, fast and high</prosody> or
+<prosody volume="x-loud" rate="x-fast" pitch="x-high">extra loud, fast and high</prosody>
+```
+
+The shortcuts are listed first. While they can be combined, sometimes it's easier and shorter to just use
+the explizit form shown in the last 2 lines. All of them can be nested, too.
+Moreover changes in volume (`[louder](v: +10dB)`) and pitch (`[lower](p: -4%)`) can also be given explicitly in relative values.
+
+***
+
+### Say-as
+
+You can give the speech sythesis engine hints as to what it's supposed to read using `as`.
+
+Possible values:
+
+* character - spell out each single character, e.g. for KGB
+* number - cardinal number, e.g. 100
+* ordinal - ordinal number, e.g. 1st
+* digits - spell out each single digit, e.g. 123 as 1 - 2 - 3
+* fraction - pronounce number as fraction, e.g. 3/4 as three quarters
+* unit - e.g. 1meter
+* date - read content as a date, must provide format
+* time - duration in minutes and seconds
+* address - read as part of an address
+* telephone - read content as a telephone number
+* expletive - beeps out the content
+
+SSMD:
+```
+Today on [29.12.2017](as: date, format: "dd.mm.yyyy") my
+telephone number is [+49 123456](as: telephone).
+You can't say [fuck](as: expletive) on television.
+```
+
+SSML:
+```html
+Today on <say-as interpret-as="date" format="dd.mm.yyyy">29.12.2017</say-as> my
+telephone number is <say-as interpret-as="telephone">+49 123456</say-as>.
+You can't say <say-as interpret-as="expletive">fuck</say-as> on television.
+```
+
+***
+
+### Substitution
+
+Allows to substitute the pronuciation of a word, such as an acronym, with an alias.
+
+SSMD:
+```
+I'd like to drink some [H2O](sub: water) now.
+```
+
+SSML:
+```html
+I'd like to drink some <sub alias="water">H2O</sub> now.
+```
+
+***
+
+### Extensions
+
+It must be possible to extend SSML with constructs specific to certain speech synthesis engines.
+Registered extensions must have a unique name. They can take parameters.
+For instance let's a assume we registered Amazon Polly's whisper effect in some hypothetical SSMD
+library API.
+
+```ruby
+SSMD.register "whisper", "amazon:effect", name: "whispered"
+```
+
+SSMD:
+```
+If he [whispers](ext: whisper), he lies.
+```
+
+SSML:
+```html
+If he <amazon:effect name="whispered">whispers</amazon:effect>, he lies.
+```
+
+***
+
+### Nesting and duplicate annotations
+
+Formats can be nested. Duplicate annotations of the same type are ignored.
+
+SSMD:
+```
+Der Film [Guardians of the *Galaxy*](en-GB, de, fr-FR) ist ganz [okay](en-US).
+```
+
+SSML:
+```html
+Der Film <lang xml:lang="en-GB">Guardians of the <emphasis>Galaxy</emphasis></lang> ist ganz <lang xml:lang="en-US">okay</lang>.
+```

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ssmd"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ssmd.rb

@@ -0,0 +1,14 @@
+require "ssmd/version"
+require "ssmd/converter"
+
+module SSMD
+  module_function
+
+  def to_ssml(ssmd)
+    Converter.new(ssmd).convert
+  end
+
+  def root_dir
+    Gem::Specification.find_by_name("ssmd").gem_dir
+  end
+end

data/lib/ssmd/annotations.rb

@@ -0,0 +1,7 @@
+module SSMD::Annotations
+
+end
+
+require 'ssmd/annotations/annotation'
+require 'ssmd/annotations/language_annotation'
+require 'ssmd/annotations/phoneme_annotation'

data/lib/ssmd/annotations/annotation.rb

@@ -0,0 +1,29 @@
+module SSMD::Annotations
+  class Annotation
+    class << self
+      def try(text)
+        match = /\A#{regex}\Z/.match text
+
+        if match
+          new *match.captures
+        end
+      end
+
+      def regex
+        raise "subclass responsibility"
+      end
+    end
+
+    def initialize
+      raise "implement expecting one argumnt for each capture group in the regex"
+    end
+
+    def wrap(text)
+      raise "wrap given text in resulting SSML element"
+    end
+
+    def combine(annotation)
+      raise "combine this annotation with the given annotation of the same type"
+    end
+  end
+end

data/lib/ssmd/annotations/language_annotation.rb

@@ -0,0 +1,37 @@
+require_relative 'annotation'
+
+module SSMD::Annotations
+  class LanguageAnnotation < Annotation
+    attr_reader :language
+
+    def self.regex
+      /([a-z]{2}(?:-[A-Z]{2})?)/
+    end
+
+    def initialize(language)
+      @language = complete_language language
+    end
+
+    def wrap(text)
+      "<lang xml:lang=\"#{language}\">#{text}</lang>"
+    end
+
+    def combine(annotation)
+      self # discard further language annotations
+    end
+
+    def complete_language(language)
+      if language.size == 2
+        language_completion_table[language] || "#{language}-#{language.upcase}"
+      else
+        language
+      end
+    end
+
+    def language_completion_table
+      {
+        "en" => "en-US"
+      }
+    end
+  end
+end

data/lib/ssmd/annotations/phoneme_annotation.rb

@@ -0,0 +1,44 @@
+require_relative 'annotation'
+
+require 'pathname'
+
+module SSMD::Annotations
+  class PhonemeAnnotation < Annotation
+    attr_reader :x_sampa, :ipa
+
+    def self.regex
+      /ph: ?(.+)/
+    end
+
+    def initialize(x_sampa)
+      @x_sampa = x_sampa
+      @ipa = x_sampa_to_ipa x_sampa
+    end
+
+    def wrap(text)
+      "<phoneme alphabet=\"ipa\" ph=\"#{ipa}\">#{text}</phoneme>"
+    end
+
+    def combine(annotation)
+      self # discard further phoneme annotations
+    end
+
+    def x_sampa_to_ipa(input)
+      x_sampa_to_ipa_table.inject(input) do |text, (x_sampa, ipa)|
+        text.gsub x_sampa, ipa
+      end
+    end
+
+    def x_sampa_to_ipa_table
+      @table ||= begin
+        lines = File.read(x_sampa_to_ipa_table_file_path).lines
+
+        lines.map { |line| line.split(" ") }
+      end
+    end
+
+    def x_sampa_to_ipa_table_file_path
+      Pathname(SSMD.root_dir).join("lib/ssmd/annotations/xsampa_to_ipa_table.txt")
+    end
+  end
+end

data/lib/ssmd/annotations/xsampa_to_ipa_table.txt

@@ -0,0 +1,174 @@
+a a
+b b
+b_< ɓ
+c c
+d d
+d` ɖ
+d_< ɗ
+e e
+f f
+g ɡ
+g_< ɠ
+h h
+h\ ɦ
+i i
+j j
+j\ ʝ
+k k
+l l
+l` ɭ
+l\ ɺ
+m m
+n n
+n` ɳ
+o o
+p p
+p\ ɸ
+q q
+r r
+r` ɽ
+r\ ɹ
+r\` ɻ
+s s
+s` ʂ
+s\ ɕ
+t t
+t` ʈ
+u u
+v v
+v\ ʋ
+P ʋ
+w w
+x x
+x\ ɧ
+y y
+z z
+z` ʐ
+z\ ʑ
+A ɑ
+B β
+B\ ʙ
+C ç
+D ð
+E ɛ
+F ɱ
+G ɣ
+G\ ɢ
+G\_< ʛ
+H ɥ
+H\ ʜ
+I ɪ
+I\ ɪ̈
+I\ ɨ̞
+J ɲ
+J\ ɟ
+J\_< ʄ
+K ɬ
+K\ ɮ
+L ʎ
+L\ ʟ
+M ɯ
+M\ ɰ
+N ŋ
+N\ ɴ
+O ɔ
+O\ ʘ
+P ʋ
+v\ ʋ
+Q ɒ
+R ʁ
+R\ ʀ
+S ʃ
+T θ
+U ʊ
+U\ ʊ̈
+U\ ʉ̞
+V ʌ
+W ʍ
+X χ
+X\ ħ
+Y ʏ
+Z ʒ
+. .
+" ˈ
+% ˌ
+' ʲ
+_j ʲ
+: ː
+:\ ˑ
+@ ə
+@\ ɘ
+{ æ
+} ʉ
+1 ɨ
+2 ø
+3 ɜ
+3\ ɞ
+4 ɾ
+5 ɫ
+6 ɐ
+7 ɤ
+8 ɵ
+9 œ
+& ɶ
+? ʔ
+?\ ʕ
+<\ ʢ
+>\ ʡ
+^ ꜛ
+! ꜜ
+!\ ǃ
+| |
+|\ ǀ
+|| ‖
+|\|\ ǁ
+=\ ǂ
+-\ ‿
+_" ̈
+_+ ̟
+_- ̠
+_/ ̌
+_0 ̥
+= ̩
+_= ̩
+_> ʼ
+_?\ ˤ
+_\ ̂
+_^ ̯
+_} ̚
+` ˞
+~ ̃
+_~ ̃
+_A ̘
+_a ̺
+_B ̏
+_B_L ᷅
+_c ̜
+_d ̪
+_e ̴
+_F ̂
+_G ˠ
+_H ́
+_H_T ᷄
+_h ʰ
+_j ʲ
+' ʲ
+_k ̰
+_L ̀
+_l ˡ
+_M ̄
+_m ̻
+_N ̼
+_n ⁿ
+_O ̹
+_o ̞
+_q ̙
+_R ̌
+_R_F ᷈
+_r ̝
+_T ̋
+_t ̤
+_v ̬
+_w ʷ
+_X ̆
+_x ̽

data/lib/ssmd/converter.rb

@@ -0,0 +1,35 @@
+require 'ssmd/processors'
+
+module SSMD
+  class Converter
+    attr_reader :input
+
+    def initialize(input)
+      @input = input
+    end
+
+    def convert
+      result = processors.inject(input) do |text, processor|
+        process processor.new, text
+      end
+
+      "<speak>#{result.strip}</speak>"
+    end
+
+    def processors
+      p = SSMD::Processors
+
+      [
+        p::EmphasisProcessor, p::AnnotationProcessor, p::MarkProcessor
+      ]
+    end
+
+    def process(processor, input)
+      if processor.matches? input
+        process processor, processor.substitute(input)
+      else
+        input
+      end
+    end
+  end
+end

data/lib/ssmd/processors.rb

@@ -0,0 +1,8 @@
+module SSMD::Processors
+
+end
+
+require 'ssmd/processors/processor'
+require 'ssmd/processors/annotation_processor'
+require 'ssmd/processors/emphasis_processor'
+require 'ssmd/processors/mark_processor'

data/lib/ssmd/processors/annotation_processor.rb

@@ -0,0 +1,86 @@
+require_relative 'processor'
+
+require 'ssmd/annotations'
+
+module SSMD::Processors
+  class AnnotationProcessor < Processor
+    attr_reader :text, :annotations
+
+    def result
+      @text, annotations_text = match.captures
+
+      if annotations_text
+        @annotations = combine_annotations parse_annotations(annotations_text)
+
+        @annotations.inject(text) do |text, a|
+          a.wrap(text)
+        end
+      end
+    end
+
+    def self.annotations
+      a = SSMD::Annotations
+
+      [a::LanguageAnnotation, a::PhonemeAnnotation]
+    end
+
+    def ok?
+      !@text.nil? && Array(@annotations).size > 0
+    end
+
+    def error?
+      !ok?
+    end
+
+    private
+
+    def parse_annotations(text)
+      text.split(/, ?/).flat_map do |annotation_text|
+        annotation = find_annotation annotation_text
+
+        if annotation.nil?
+          @warnings.push "Unknown annotation: #{text}"
+        end
+
+        [annotation].compact
+      end
+    end
+
+    def find_annotation(text)
+      self.class.annotations.lazy
+        .map { |a| a.try text }
+        .find { |a| !a.nil? }
+    end
+
+    def combine_annotations(annotations)
+      annotations
+        .group_by { |a| a.class }
+        .values
+        .map { |as| as.reduce { |a, b| a.combine b } }
+    end
+
+    ##
+    # Matches explicitly annotated sections.
+    # For example:
+    #
+    #     [Guardians of the Galaxy](en-GB, v: +4dB, p: -3%)
+    def regex
+      %r{
+        \[                              # opening text
+          ([^\]]+)                      # annotated text
+        \]                              # closing text
+        \(                              # opening annotations
+          ((?:
+            (?:
+              #{annotations_regex}
+            )(?:,\s?)?
+          )+)
+        \)                              # closing annotations
+      }x
+    end
+
+    def annotations_regex
+      self.class.annotations.map(&:regex).join("|")
+    end
+  end
+end

data/lib/ssmd/processors/emphasis_processor.rb

@@ -0,0 +1,15 @@
+require_relative 'processor'
+
+module SSMD::Processors
+  class EmphasisProcessor < Processor
+    def result
+      text = match.captures.first
+
+      "<emphasis>#{text}</emphasis>"
+    end
+
+    def regex
+      /\*([^\*]+)\*/
+    end
+  end
+end

data/lib/ssmd/processors/mark_processor.rb

@@ -0,0 +1,15 @@
+require_relative 'processor'
+
+module SSMD::Processors
+  class MarkProcessor < Processor
+    def result
+      text = match.captures.first
+
+      "<mark name=\"#{text}\"/>"
+    end
+
+    def regex
+      /@(\w+)/
+    end
+  end
+end

data/lib/ssmd/processors/processor.rb

@@ -0,0 +1,29 @@
+module SSMD::Processors
+  class Processor
+    attr_reader :match
+
+    def matches?(input)
+      @match = regex.match input
+
+      !match.nil?
+    end
+
+    def substitute(input)
+      if match
+        match.pre_match + result + match.post_match
+      end
+    end
+
+    def result
+      raise "subclass responsibility"
+    end
+
+    def regex
+      raise "subclass responsibility"
+    end
+
+    def warnings
+      @warnings ||= []
+    end
+  end
+end

data/lib/ssmd/version.rb

@@ -0,0 +1,3 @@
+module SSMD
+  VERSION = "0.1.0"
+end

data/ssmd.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ssmd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ssmd"
+  spec.version       = SSMD::VERSION
+  spec.authors       = ["Markus Kahl"]
+  spec.email         = ["machisuji@gmail.com"]
+
+  spec.summary       = %q{
+    Speech Synthesis Markdown (SSMD) is an lightweight alternative syntax for SSML
+    and the corresponding tool converting SSMD to SSML.
+  }
+  spec.homepage      = "https://github.com/machisuji/ssmd"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10.4"
+  spec.add_development_dependency "pry-byebug", "~> 3.4", ">= 3.4.2"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: ssmd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Markus Kahl
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+description: 
+email:
+- machisuji@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- SPECIFICATION.md
+- bin/console
+- bin/setup
+- lib/ssmd.rb
+- lib/ssmd/annotations.rb
+- lib/ssmd/annotations/annotation.rb
+- lib/ssmd/annotations/language_annotation.rb
+- lib/ssmd/annotations/phoneme_annotation.rb
+- lib/ssmd/annotations/xsampa_to_ipa_table.txt
+- lib/ssmd/converter.rb
+- lib/ssmd/processors.rb
+- lib/ssmd/processors/annotation_processor.rb
+- lib/ssmd/processors/emphasis_processor.rb
+- lib/ssmd/processors/mark_processor.rb
+- lib/ssmd/processors/processor.rb
+- lib/ssmd/version.rb
+- ssmd.gemspec
+homepage: https://github.com/machisuji/ssmd
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Speech Synthesis Markdown (SSMD) is an lightweight alternative syntax for
+  SSML and the corresponding tool converting SSMD to SSML.
+test_files: []