ispeech 1.0.1

data/lib/ispeech/voice.rb

@@ -0,0 +1,121 @@
+require 'set'
+
+module Ispeech
+  class Voice
+    attr_reader :languages, :speaker, :gender, :quality
+
+    def initialize(speaker, gender, *languages)
+      @speaker = speaker
+      @gender = gender
+      @quality = QUALITY_HIGH
+
+      @languages = Set.new
+      languages.each { |lang| @languages.add(lang) }
+    end
+
+    def id
+      "#{speaker.downcase}"
+    end
+
+    def language
+      languages.first
+    end
+
+    def low_quality!
+      @quality = QUALITY_LOW
+    end
+
+    def high_quality!
+      @quality = QUALITY_HIGH
+    end
+
+    def self.override_map(override_voice_map = {})
+      current_map = self.map
+      override_voice_map.each do |language, voices|
+        language_sym = language.to_sym
+        if voices.nil?
+          # Remove voice directive.
+          current_map.delete(language_sym)
+        elsif voices.is_a?(String) || voices.is_a?(Symbol)
+          # Map voice directive.
+          current_map[language_sym] = self.map[voices]
+        elsif voices.is_a?(Hash)
+          # Replace/Override
+          if entry = self.map[language_sym]
+            new_entry = entry.dup
+          else
+            new_entry = Hash.new
+          end
+
+          voices.each do |gender, speakers|
+            if gender.is_a?(Symbol) && speakers.is_a?(Array)
+              new_entry[gender] = speakers
+            end
+          end
+          current_map[language_sym] = new_entry
+        end
+      end
+      @@map = current_map
+    end
+
+    def self.map
+      reset_map unless defined?(@@map)
+      @@map
+    end
+
+    def self.reset_map
+      @@map = Voices::PER_LANGUAGE.dup
+    end
+
+    def self.extract_from_options(options = {})
+      if speaker = options[:speaker]
+        named_voice(speaker)
+      else
+        language = options[:language] || :en
+        gender = options[:gender]
+        speakers_for_language = self.map[language]
+
+        speakers = case gender
+        when GENDER_FEMALE
+          speakers_for_language[GENDER_FEMALE]
+        when GENDER_MALE
+          speakers_for_language[GENDER_MALE]
+        else
+          speakers_for_language[GENDER_FEMALE] +
+            speakers_for_language[GENDER_MALE]
+        end
+
+        if speakers.empty?
+          nil
+        else
+          named_voice(speakers.sample)
+        end
+      end
+    end
+
+    def self.named_voice(speaker)
+      unless defined?(@@voices)
+        @@voices = Hash.new
+        self.map.each do |language, voices|
+          [GENDER_MALE, GENDER_FEMALE].each do |gender|
+            voices[gender].each do |name|
+              downcase_name = name.downcase.to_sym
+              if @@voices[downcase_name].nil?
+                @@voices[downcase_name] = Voice.new(name, gender, language.to_s)
+              else
+                @@voices[downcase_name].languages.add(language.to_s)
+              end
+            end
+          end
+        end
+      end
+
+      if info = @@voices[speaker.to_s.downcase.to_sym]
+        info
+      else
+        raise Error.new("Voice does not exist.")
+      end
+    end
+
+  end
+end

data/lib/ispeech/voice_service.rb

@@ -0,0 +1,65 @@
+require 'net/http'
+
+module Ispeech
+  class VoiceService
+
+    CLIENT_ENVIRONMENT = "RUBY_#{RUBY_VERSION}"
+
+    ERROR_MISSING_CONFIG = Error.new("VoiceService requires configuration.")
+
+    attr_reader :config
+
+    def initialize(config = Ispeech.config)
+      if config.is_a?(Ispeech::Config)
+        @config = config
+      else
+        raise ERROR_MISSING_CONFIG
+      end
+    end
+
+    def generate_sound(text, options = {})
+      voice = Voice.extract_from_options(options)
+
+      case options[:quality]
+      when :low
+        voice.low_quality!
+      when :high
+        voice.high_quality!
+      end
+
+      generate_with_voice(text, voice)
+    end
+
+    def generate_with_voice(text, voice)
+      params = {
+        # API Defaults:
+        # :bitrate => 48,
+        # :speed => 0,
+        # :startpadding => 0,
+        # :endpadding => 0,
+        # :pitch => 100,
+        # :format => 'mp3',
+        # :bitdepth => 16,
+        # :filename => 'rest'
+        :voice => voice.id,
+        :frequency => voice.quality,
+        :text => text,
+      }
+
+      with_action(:convert, params)
+    end
+
+    def with_action(action, params)
+      params[:action] = action
+      Response.new(post(params))
+    end
+
+    private
+
+    def post(params)
+      params[:apikey] = @config.api_key
+      Net::HTTP.post_form(@config.target_url, params)
+    end
+
+  end
+end

data/lib/ispeech/voices/default.rb

@@ -0,0 +1,42 @@
+module Ispeech
+  module Voices
+    PER_LANGUAGE = {
+      :ar      =>  {:female=>[], :male=>["arabicmale"]},
+      :ca      =>  {:female=>["eurcatalanfemale"], :male=>[]},
+      :cs      =>  {:female=>["eurczechfemale"], :male=>[]},
+      :da      =>  {:female=>["eurdanishfemale"], :male=>[]},
+      :de      =>  {:female=>["eurgermanfemale"], :male=>["eurgermanmale"]},
+      :el      =>  {:female=>["eurgreekfemale"], :male=>[]},
+      :en      =>  {:female=>["usenglishfemale", "caenglishfemale", "ukenglishfemale", "auenglishfemale"], :male=>["usenglishmale", "ukenglishmale"]},
+      :en_AU   =>  {:female=>["auenglishfemale"], :male=>[]},
+      :en_CA   =>  {:female=>["caenglishfemale"], :male=>[]},
+      :en_GB   =>  {:female=>[], :male=>["ukenglishmale"]},
+      :en_UK   =>  {:female=>["ukenglishfemale"], :male=>[]},
+      :en_US   =>  {:female=>["usenglishfemale"], :male=>[]},
+      :es      =>  {:female=>["eurspanishfemale", "usspanishfemale"], :male=>["usspanishmale", "eurspanishmale"]},
+      :es_ES   =>  {:female=>["eurspanishfemale"], :male=>["eurspanishmale"]},
+      :es_MX   =>  {:female=>[], :male=>["usspanishmale"]},
+      :fi      =>  {:female=>["eurfinnishfemale"], :male=>[]},
+      :fr      =>  {:female=>["cafrenchfemale", "eurfrenchfemale"], :male=>["cafrenchmale", "eurfrenchmale"]},
+      :fr_CA   =>  {:female=>["cafrenchfemale"], :male=>["cafrenchmale"]},
+      :fr_FR   =>  {:female=>["eurfrenchfemale"], :male=>["eurfrenchmale"]},
+      :hu      =>  {:female=>["huhungarianfemale"], :male=>[]},
+      :it      =>  {:female=>["euritalianfemale"], :male=>["euritalianmale"]},
+      :ja      =>  {:female=>["jpjapanesefemale"], :male=>["jpjapanesemale"]},
+      :ko      =>  {:female=>["krkoreanfemale"], :male=>["krkoreanmale"]},
+      :ko_KR   =>  {:female=>[], :male=>["krkoreanmale"]},
+      :nl      =>  {:female=>["eurdutchfemale"], :male=>[]},
+      :no      =>  {:female=>["eurnorwegianfemale"], :male=>[]},
+      :pl      =>  {:female=>["eurpolishfemale"], :male=>[]},
+      :pt      =>  {:female=>["brportuguesefemale", "eurportuguesefemale"], :male=>["eurportuguesemale"]},
+      :pt_BR   =>  {:female=>["brportuguesefemale"], :male=>[]},
+      :pt_PT   =>  {:female=>["eurportuguesefemale"], :male=>["eurportuguesemale"]},
+      :ru      =>  {:female=>["rurussianfemale"], :male=>["rurussianmale"]},
+      :sv      =>  {:female=>["swswedishfemale"], :male=>[]},
+      :tr      =>  {:female=>["eurturkishfemale"], :male=>["eurturkishmale"]},
+      :zh      =>  {:female=>["hkchinesefemale", "twchinesefemale", "chchinesefemale"], :male=>["chchinesemale"]},
+      :zh_HK   =>  {:female=>["hkchinesefemale", "chchinesefemale"], :male=>[]},
+      :zh_TW   =>  {:female=>["twchinesefemale"], :male=>[]}
+    }
+  end
+end

data/script/create_voices.rb

@@ -0,0 +1,143 @@
+require 'net/http'
+require 'set'
+require 'fileutils'
+require 'json'
+require 'ispeech'
+include Ispeech::Scripts
+
+DEFAULT_VOICES_RUBY_FILE = File.join('lib', 'ispeech', 'voices', 'default.rb')
+VOICE_KEY_FIELDS = /voice-([^-\d]*)-?(\d+)-?\d*$/
+
+def save_uri_to_file_if_missing(filename)
+  if !File.exists?(filename)
+    FileUtils.mkdir_p(LOCAL_TEMP_DIR)
+    response = Ispeech.voice_service.with_action('information', :output => :json)
+    file = response.download_to_tempfile
+    FileUtils.mv(file.path, filename)
+  end
+end
+
+def convert_text_to_voices(text)
+  raw_voices = JSON.parse(text)
+  structured_voices = Hash.new { |h,k| h[k] = Hash.new}
+
+  raw_voices.each do |key,value|
+    if match = VOICE_KEY_FIELDS.match(key)
+      if match[1].empty?
+        structured_voices[match[2].to_i][:speaker] = value
+      else
+        structured_voices[match[2].to_i][match[1].to_sym] = value
+      end
+    else
+      if $VERBOSE
+        puts "Failed to parse: #{key}=#{value}"
+      end
+    end
+  end
+
+  voices = Array.new
+  structured_voices.each do |number, hash|
+    voices << {'language_locale' => hash[:locale], 'speaker' => hash[:speaker], 'gender' => hash[:gender]}
+  end
+
+  voices
+end
+
+def gender_code_to_symbol(gender)
+  case gender.downcase
+  when 'f','female'
+    Ispeech::Voice::GENDER_FEMALE
+  when 'm','male'
+    Ispeech::Voice::GENDER_MALE
+  else
+    raise "Unknown gender code: #{gender}"
+  end
+end
+
+def qualified_locale(locale)
+  split = locale.split('-') || locale.split('_')
+
+  if split.size > 1
+    "#{split.first}_#{split.last.upcase}"
+  else
+    split.first
+  end
+end
+
+def simple_language_code(locale)
+  locale.split('_').first
+end
+
+class Set
+  def inspect
+    self.to_a.inspect
+  end
+end
+
+def voice_array_to_voices_per_language(voices)
+  language_voices = Hash.new { |h,v| h[v] = { :female => Set.new, :male => Set.new } }
+
+  voices.each do |voice_hash|
+    gender = gender_code_to_symbol(voice_hash['gender'])
+    locale = qualified_locale(voice_hash['language_locale'])
+    simple_locale = simple_language_code(locale)
+
+    language_voices[locale][gender].add(voice_hash['speaker'])
+    language_voices[simple_locale][gender].add(voice_hash['speaker'])
+  end
+
+  # Clean up instance where specific locale is same as generic one.
+  language_voices.delete_if do |key,value|
+    simple_locale = simple_language_code(key)
+    if key != simple_locale && language_voices[simple_locale] == value
+      true
+    else
+      false
+    end
+  end
+
+  language_voices
+end
+
+def construct_class(voices_per_language)
+  text_hashes = voices_per_language.keys.sort.map do |key|
+    "".rjust(6) + ":" + key.to_s.ljust(8) + "=>".ljust(4) + voices_per_language[key].inspect
+  end
+
+  klass_text = <<-CLASS
+module Ispeech
+  module Voices
+    PER_LANGUAGE = {
+#{text_hashes.join(",\n")}
+    }
+  end
+end
+CLASS
+  klass_text
+end
+
+def write_klass(klass)
+  klass_dir = File.dirname(DEFAULT_VOICES_RUBY_FILE)
+
+  if !File.exist?(klass_dir)
+    FileUtils.mkdir_p(klass_dir)
+  end
+
+  File.open(DEFAULT_VOICES_RUBY_FILE, 'w') do |f|
+    f.write(klass)
+  end
+end
+
+def main
+  save_uri_to_file_if_missing(VOICES_ENUMERATOR_FILE)
+  voices = convert_text_to_voices(File.read(VOICES_ENUMERATOR_FILE))
+
+  voices_per_language = voice_array_to_voices_per_language(voices)
+  klass = construct_class(voices_per_language)
+  write_klass(klass)
+  puts "Done."
+end
+
+if $0 == __FILE__
+  main
+end

data/script/test_voices.rb

@@ -0,0 +1,87 @@
+# Encoding: UTF-8
+require 'ispeech'
+include Ispeech::Scripts
+
+trap("SIGINT") do
+  puts "Stopping..."
+  @interrupted = true
+end
+
+TEST_VOICES_DIR = File.join(LOCAL_TEMP_DIR, 'voices')
+
+SAMPLE_SENTENCES = {
+  :ar      =>  "اسمي {name} وأنا أتكلم يمكن.", # Arabic (Saudi Arabia)
+  :ca      =>  "El meu nom és {name} i que pot parlar.", # Catalan (Spain)
+  :cs      =>  "Mé jméno je {name} a mohu mluvit.", # Czech
+  :da      =>  "Mit navn er {name}, og jeg kan tale.", # Danish
+  :de      =>  "Mein Name ist {name}, und ich kann sprechen.", # German
+  :el      =>  "Το όνομά μου είναι {name}, και μπορώ να μιλήσω.", # Greek
+  :en      =>  "My name is {name} and I can talk.", # English
+  :en_AU   =>  "Hi, I live in Australia and I can speak English", # English (AU)
+  :en_CA   =>  "Hi, I live in Canda and I speak English", # English (CA)
+  :en_GB   =>  "Hi, I live in Great Britain and I speak English.", # English (Great Britain)
+  :en_IN   =>  "Hi, I live in India and I can speak English", # English (India)
+  :en_UK   =>  "Hi, I live in the United Kingdom and I can speak English", # English (UK)
+  :en_US   =>  "Hi, I live in the United States and I speak English", # English (US)
+  :es      =>  "Mi nombre es {name}, y puede hablar.", # Spanish
+  :es_ES   =>  "Mi nombre es {name} y vivo en España.", # Spanish (Spain)
+  :es_MX   =>  "Hola, vivo en Mexicon y puedo hablar español", # Spanish (Mexico)
+  :es_US   =>  "Mi nombre es {name} y yo vivimos en Estados Unidos.", # Spanish (US?)
+  :fi      =>  "Nimeni on {name}, ja voin puhua.", # Finnish
+  :fr      =>  "Mon nom est {name}, et je peux parler.", # French
+  :fr_BE   =>  "Mon nom est {name} et je vis en Belgique.", # French (Belgium)
+  :fr_CA   =>  "Mon nom est {name} et je vis au Canada.", # French (Canada)
+  :fr_FR   =>  "Mon nom est {name} et je vis en France.", # French (French)
+  :gb      =>  "Mitt namn är {name} och jag bor i Gotenburg.", # Gotenburg (Swedish), should be sv_SV_gotenburg ?
+  :hu      =>  "Szia, Magyarországon élek, és én is beszélek magyarul", # Hungarian
+  :it      =>  "Il mio nome è {name}, e posso parlare.", # Italian
+  :ja      =>  "こんにちは、私は日本に住んでいます。日本語話せます。", # Japanese
+  :ko      =>  "안녕하세요, 저는 한국에 살고있는 나는 한국어를 쓸 수 있습니다", # Korean
+  :ko_KR   =>  "안녕하세요, 저는 한국에 살고있는 나는 한국어를 쓸 수 있습니다", # Korean
+  :nl      =>  "Mijn naam is {name}, en ik spreek kan.", # Dutch
+  :nl_BE   =>  "Mijn naam is {name} en ik woon in België.", # Dutch (Belgium)
+  :nl_NL   =>  "Mijn naam is {name} en ik woon in Nederland.", # Dutch (Netherlands)
+  :no      =>  "Mitt navn er {name}, og jeg kan snakke.", # Norwegian
+  :pl      =>  "Nazywam się {name}, i mogę mówić.", # Polish
+  :pt      =>  "Meu nome é {name}, e eu posso falar.", # Portuguese
+  :pt_BR   =>  "Meu nome é {name} e eu vivo no Brasil.", # Portuguese (Brazil)
+  :pt_PT   =>  "Meu nome é {name} e eu vivo em Portugal.", # Portuguese (Portugal)
+  :ru      =>  "Меня зовут {name}, и я могу сказать.", # Russia
+  :sc      =>  "Mitt namn är {name} och jag bor i Scania.", # Scanian (Sweden), should be sv_SE_scania
+  :sv      =>  "Mitt namn är {name}, och jag kan tala.", # Swedish
+  :sv_FI   =>  "Mitt namn är {name} och jag bor i Finland.", # Swedish (Finland)
+  :sv_SE   =>  "Mitt namn är {name} och jag bor i Sverige.", # Swedish (Sweden)
+  :tr      =>  "Benim adım {name} ve konuşamıyorum.", # Turkish
+  :zh      =>  "嗨，我住在中国，我能讲普通话", # Chinese (Mainland)
+  :zh_HK   =>  "您好，我住在香港，我可以讲广东话", # Chinese (Hong Kong)
+  :zh_TW   =>  "您好，我住在台灣，我可以講普通話", # Chinese (Taiwan)
+}
+
+service = Ispeech::VoiceService.new(Ispeech.config)
+FileUtils.mkdir_p(TEST_VOICES_DIR)
+
+Ispeech::Voices::PER_LANGUAGE.each do |language, voice_gender|
+  voice_gender.each do |gender, speakers|
+    speakers.each do |speaker|
+      begin
+        if text = SAMPLE_SENTENCES[language.to_sym]
+          text = text.gsub('{name}', 'Job')
+          destination_file = File.join(TEST_VOICES_DIR, "#{language}_#{speaker}.mp3")
+          if !File.exists?(destination_file)
+            response = service.generate_sound(text, :speaker => speaker)
+            mp3_file = response.download_to_tempfile
+            FileUtils.cp(mp3_file.path, destination_file)
+            mp3_file.close!
+            puts "Generated: #{text}"
+          end
+        else
+          puts "No text for: #{speaker} in #{language}"
+        end
+      rescue => err
+        puts "FAILED WITH: #{language}, #{gender}, #{speakers.inspect}, #{speaker}\nReason: #{err.message}"
+      end
+
+      exit 0 if @interrupted
+    end
+  end
+end