Ruby による文書の音声合成
短い文書なら、Ruby でテキストを抽出し、Google Cloud Text-to-Speech に単一のリクエストで送信できます。以下の例では、選択したテキストをプレビューし、読み上げ音声を新しい MP3 ファイルに保存します。入力には UTF-8 のプレーンテキストと HTML を使用でき、ソースは 1 MiB、抽出したテキストは 5,000 バイトが上限です。
Google Cloud Text-to-Speech のセットアップ
Ruby と Bundler がインストールされた GNU/Linux を使用します。この手順は Ruby 4.0.7、Bundler 4.0.23、GNU coreutils の timeout で検証しています。結果を確認するには、ローカルの MP3 プレーヤーが必要です。Ruby ダウンロードページから、保守されている Ruby リリースを使用してください。以下のタイムアウトコマンドは GNU coreutils に依存するため、macOS や Windows ではそのまま使用できません。
課金と Text-to-Speech API が有効な Google Cloud プロジェクトと、その API を使用できる認証情報も必要です。音声合成を実行する前に、Google のプロジェクトのセットアップと Application Default Credentials ガイドに従って準備してください。コードは ADC を使用しますが、ログインやクラウド設定の変更は行いません。文書のテキストは Google に送信され、リクエストには料金が発生する場合があります。まずは機密情報を含まないサンプルテキストで試してください。
空の作業ディレクトリを新規作成し、そこで Bash ターミナルを開いて、次の内容を Gemfile として保存してください。gem の取得元を明示すると、Bundler が依存関係をダウンロードできます。
source 'https://rubygems.org'
gem 'google-cloud-text_to_speech', '2.2.1'
gem 'nokogiri', '1.19.4'
このプロジェクト内にインストールし、生成された Gemfile.lock をコードとともに保管してください。
bundle config set --local path vendor/bundle &&
bundle install --gemfile ./Gemfile
基本的な文書読み上げスクリプト
このクラスを document_narrator.rb として保存してください。検証はクライアントの作成前に行うため、テキストのプレビューや、既存の出力先を拒否する処理にはクラウドの認証情報は不要です。抽出したテキストには空白以外の文字が必要で、Google のコンテンツ上限の 5,000 バイト以内に収める必要があります。たとえば、é を 2,501 個並べると、文字数は 5,000 未満でも、この上限を超えます。
require 'google/cloud/text_to_speech'
require 'nokogiri'
require 'tempfile'
class DocumentNarrator
class InputError < StandardError; end
def initialize(client: nil)
@client = client
end
def extract_text(file_path)
raise DocumentNarrator::InputError, 'Input must be a regular file' unless File.file?(file_path)
source = File.binread(file_path, 1024 * 1024 + 1)
raise DocumentNarrator::InputError, 'Source exceeds 1 MiB' if source.bytesize > 1024 * 1024
source.force_encoding(Encoding::UTF_8)
raise DocumentNarrator::InputError, 'Source must be valid UTF-8' unless source.valid_encoding?
text = case File.extname(file_path).downcase
when '.txt'
source
when '.html', '.htm'
begin
doc = Nokogiri::HTML5(source, nil, 'UTF-8', max_tree_depth: 400, max_attributes: 400)
rescue ArgumentError
raise InputError, 'HTML nesting or attribute limit exceeded; prepare a .txt file'
end
doc.css('script, style, template, noscript').remove
doc.at_css('body').xpath('.//text()').map(&:text).join(' ').strip
else
raise DocumentNarrator::InputError, 'Use a .txt, .html, or .htm input'
end
raise DocumentNarrator::InputError, 'Extracted text is empty' if text.strip.empty?
raise DocumentNarrator::InputError, 'Extracted text exceeds 5,000 bytes' if text.bytesize > 5000
text
end
def narrate_file(input_path, output_path, language_code: 'en-US')
text = extract_text(input_path)
if File.exist?(output_path) || File.symlink?(output_path)
raise DocumentNarrator::InputError, 'Output must not exist; choose a new filename'
end
Tempfile.create(['.narration-', '.mp3'], File.dirname(output_path)) do |file|
file.binmode
client = @client || Google::Cloud::TextToSpeech.text_to_speech
response = client.synthesize_speech(
input: { text: text },
voice: { language_code: language_code, ssml_gender: :FEMALE },
audio_config: { audio_encoding: :MP3 }
)
raise IOError, 'Synthesis returned empty audio' if response.audio_content.empty?
file.write(response.audio_content)
file.flush
# A hard link publishes the complete candidate without replacing another writer's file.
File.link(file.path, output_path)
end
end
end
HTML からの抽出では、文書内の順序で本文テキストを読み取り、テキストノード間にスペースを挿入し、script、style、template、noscript の各要素を削除します。CSS のレンダリング、すべての非表示属性への対応、ブラウザーのアクセシブルな読み上げ順序の再現は行いません。また、インライン要素をまたぐ単語が分割される場合もあります。結果をプレビューし、この順序が適さない場合はプレーンテキスト版を用意してください。HTML パーサーでは、DOM ツリーの深さも 400、要素ごとの属性数も 400 に制限しています。PDF やワープロ文書には別途テキスト抽出処理が必要で、このスクリプトの対象外です。
高度な機能とエラー処理
このエントリーポイントをクラスと同じディレクトリに narrate.rb として保存してください。シェルが POSIX ロケールを使用している場合も、ファイル名は有効な UTF-8 である必要があります。区切り文字 -- は、音声合成の引数とプレビューモードを区別し、ハイフンで始まるファイル名も使用できるようにします。
require_relative 'document_narrator'
begin
args = ARGV.map { |arg| arg.dup.force_encoding(Encoding::UTF_8) }
raise DocumentNarrator::InputError, 'Arguments must be valid UTF-8' unless args.all?(&:valid_encoding?)
mode = args.shift
narrator = DocumentNarrator.new
if mode == '--preview' && args.length == 1
puts narrator.extract_text(args[0])
elsif mode == '--' && (2..3).cover?(args.length)
narrator.narrate_file(args[0], args[1], language_code: args[2] || 'en-US')
puts 'Narration saved'
else
raise DocumentNarrator::InputError, 'Usage: narrate.rb --preview INPUT | -- INPUT NEW_OUTPUT [LANGUAGE]'
end
rescue DocumentNarrator::InputError => error
warn error.message
exit 1
rescue StandardError
warn 'Narration failed. Check file permissions, credentials, API access, and your connection.'
exit 1
end
次の短い例を含む document.html を作成してください。
<!doctype html>
<html lang="en">
<head><title>Not spoken</title></head>
<body><p>The copper robot carries a yellow umbrella.</p><script>Not spoken either.</script></body>
</html>
有料のリクエストを送信する前にプレビューしてください。
bundle exec ruby narrate.rb --preview document.html
プレビューには、前後の空白を除き、次の文だけが含まれるはずです。
The copper robot carries a yellow umbrella.
次に音声を合成します。
timeout --signal=TERM --kill-after=2s 60s \
bundle exec ruby narrate.rb -- document.html narration.mp3 en-US
この設定では、Ruby の起動、認証情報の読み込みまたは OAuth の更新、音声合成を含む、コマンド全体の制限時間を 60 秒にしています。GNU の timeout は、応答しないプロセスを強制終了する前に、さらに二秒待ちます。プロバイダーがリクエストを受信していても、タイムアウトは失敗です。再試行する前に出力先を確認してください。強制終了すると、.narration- 一時ファイルが残る場合があります。
読み上げ音声の確認と失敗への対処
成功すると、コマンドは Narration saved と表示し、narration.mp3 を作成します。そのファイルを MP3 プレーヤーで開き、プレビューと照合しながら最後まで聴いてください。空でない、または再生できる MP3 というだけでは、正しいテキストが読み上げられたとは判断できません。音声の言語設定は文書を翻訳するものではありません。テキストに合う言語コードを使用してください。
出力先の親ディレクトリは、あらかじめ存在し、ハードリンクをサポートしている必要があります。既存のファイルやシンボリックリンクは拒否されます。また、合成中に別のプロセスがそのパスを作成した場合も、出力の確定に失敗します。プロバイダー側で失敗しても、既存の出力先は変更されません。二回目の音声を作成するには、別の出力先を選んでください。このスクリプトに上書きオプションはありません。
入力エラーでは、どの検証に失敗したかが報告されます。ソースが 1 MiB を超える場合や、抽出したテキストが 5,000 バイトを超える場合は、黙って切り詰めるのではなく、より小さい文書を用意してください。HTML の入れ子や属性が原因で拒否された場合は、プレーンテキスト版を用意してください。一般的な失敗の場合は、まずプレビューを試し、次にファイルシステムの権限と、選択したプロジェクトの ADC、課金、API アクセス、ネットワーク接続を確認してください。音声合成の診断情報には、プロバイダーのエラー詳細や文書のテキストを含めません。長い読み上げ音声には、分割と結合を行う別のワークフローが必要です。この例では、意図的に単一の同期リクエストを行います。
