voicevox.rb 0.1.0

data/lib/voicevox/wrapper/audio_query.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+require "json"
+
+class Voicevox
+  #
+  # テキストからAudioQueryを生成します。
+  #
+  # @param [String] text 生成するAudioQueryのテキスト。
+  # @param [Voicevox::CharacterInfo, Voicevox::StyleInfo, Integer] speaker 話者、または話者のID。
+  # @param [Boolean] kana textをAquesTalkライクな記法として解釈するかどうか。デフォルトはfalse。
+  #
+  # @return [Voicevox::AudioQuery] 生成されたAudioQuery。
+  #
+  # @see Voicevox#synthesis
+  #
+  def audio_query(text, speaker, kana: false)
+    options = Voicevox::Core.voicevox_make_default_audio_query_options
+    options[:kana] = kana
+    speaker_id = speaker.is_a?(Integer) ? speaker : speaker.id
+    load_model speaker_id
+    return_ptr = FFI::MemoryPointer.new(:pointer)
+    Voicevox.process_result Voicevox::Core.voicevox_audio_query(
+                              text,
+                              speaker_id,
+                              options,
+                              return_ptr
+                            )
+    return_str_ptr = return_ptr.read_pointer
+    json = return_str_ptr.read_string
+    Voicevox::Core.voicevox_audio_query_json_free return_str_ptr
+
+    AudioQuery.new JSON.parse(json, symbolize_names: true)
+  end
+
+  #
+  # AudioQueryから音声を生成します。
+  #
+  # @param [AudioQuery] query AudioQuery。
+  # @param [Voicevox::CharacterInfo, Voicevox::StyleInfo, Integer] speaker 話者、または話者のID。
+  # @param [Boolran] enable_interrogative_upspeak 疑問文の調整を有効にするかどうか。デフォルトはtrue。
+  #
+  # @return [String] 生成された音声のwavデータ。
+  #
+  def synthesis(query, speaker, enable_interrogative_upspeak: true)
+    size_ptr = FFI::MemoryPointer.new(:int)
+    return_ptr = FFI::MemoryPointer.new(:pointer)
+    id = speaker.is_a?(Integer) ? speaker : speaker.id
+    load_model id
+    options = Voicevox::Core::VoicevoxSynthesisOptions.new
+    options[:enable_interrogative_upspeak] = enable_interrogative_upspeak
+    Voicevox.process_result(
+      Voicevox::Core.voicevox_synthesis(
+        query.to_json,
+        id,
+        options,
+        size_ptr,
+        return_ptr
+      )
+    )
+    data_ptr = return_ptr.read_pointer
+    size_ptr.free
+    data = data_ptr.read_string(size_ptr.read_int)
+    Voicevox::Core.voicevox_wav_free(data_ptr)
+    data
+  end
+
+  #
+  # 音声合成用のクエリ。
+  #
+  class AudioQuery
+    # @return [Array<AccentPhrase>] アクセント句のリスト。
+    attr_accessor :accent_phrases
+    # @return [Float] 全体の話速。
+    attr_accessor :speed_scale
+    # @return [Float] 全体の音高。
+    attr_accessor :pitch_scale
+    # @return [Float] 全体の抑揚。
+    attr_accessor :intonation_scale
+    # @return [Float] 全体の音量。
+    attr_accessor :volume_scale
+    # @return [Float] 音声の前の無音時間。
+    attr_accessor :pre_phoneme_length
+    # @return [Float] 音声の後の無音時間。
+    attr_accessor :post_phoneme_length
+    # @return [Integer] 音声データの出力サンプリングレート。
+    attr_accessor :output_sampling_rate
+    # @return [Boolean] 音声データをステレオ出力するか否か。
+    attr_accessor :output_stereo
+    # @return [String] AquesTalkライクな読み仮名。
+    attr_reader :kana
+
+    def initialize(query)
+      @accent_phrases = query[:accent_phrases].map { |ap| AccentPhrase.new ap }
+      @speed_scale = query[:speed_scale]
+      @pitch_scale = query[:pitch_scale]
+      @intonation_scale = query[:intonation_scale]
+      @volume_scale = query[:volume_scale]
+      @pre_phoneme_length = query[:pre_phoneme_length]
+      @post_phoneme_length = query[:post_phoneme_length]
+      @output_sampling_rate = query[:output_sampling_rate]
+      @output_stereo = query[:output_stereo]
+      @kana = query[:kana]
+    end
+
+    #
+    # AudioQueryをHashにします。
+    #
+    # @return [Hash]
+    #
+    def to_hash
+      {
+        accent_phrases: @accent_phrases.map(&:to_hash),
+        pitch_scale: @pitch_scale,
+        speed_scale: @speed_scale,
+        intonation_scale: @intonation_scale,
+        volume_scale: @volume_scale,
+        pre_phoneme_length: @pre_phoneme_length,
+        post_phoneme_length: @post_phoneme_length,
+        output_sampling_rate: @output_sampling_rate,
+        output_stereo: @output_stereo,
+        kana: @kana
+      }
+    end
+
+    #
+    # AudioQueryをjsonにします。
+    #
+    # @return [String]
+    #
+    def to_json(...)
+      to_hash.to_json(...)
+    end
+  end
+
+  #
+  # アクセント句ごとの情報。
+  #
+  class AccentPhrase
+    # @return [Array<Mora>] モーラのリスト。
+    attr_reader :moras
+    # @return [Integer] アクセント箇所。
+    attr_reader :accent
+    # @return [Mora, nil] 後ろに無音を付けるかどうか。
+    attr_reader :pause_mora
+    # @return [Boolean] 疑問系かどうか。
+    attr_reader :is_interrogative
+    alias interrogative? is_interrogative
+
+    def initialize(query)
+      @moras = query[:moras].map { |ap| Mora.new ap }
+      @accent = query[:accent]
+      @pause_mora = query[:pause_mora] && Mora.new(query[:pause_mora])
+      @is_interrogative = query[:is_interrogative]
+    end
+
+    #
+    # AccentPhraseをHashにします。
+    #
+    # @return [Hash]
+    #
+    def to_hash
+      {
+        moras: @moras.map(&:to_hash),
+        accent: @accent,
+        pause_mora: @pause_mora&.to_hash,
+        is_interrogative: @is_interrogative
+      }
+    end
+
+    #
+    # モーラ（子音＋母音）ごとの情報。
+    #
+    class Mora
+      # @return [String] 文字。
+      attr_reader :text
+      # @return [String] 子音の音素。
+      attr_reader :consonant
+      # @return [Float] 子音の音長。
+      attr_reader :consonant_length
+      # @return [String] 母音の音素。
+      attr_reader :vowel
+      # @return [Float] 母音の音長。
+      attr_reader :vowel_length
+      # @return [Float] 音高。
+      attr_reader :pitch
+
+      def initialize(query)
+        @text = query[:text]
+        @consonant = query[:consonant]
+        @consonant_length = query[:consonant_length]
+        @vowel = query[:vowel]
+        @vowel_length = query[:vowel_length]
+        @pitch = query[:pitch]
+      end
+
+      #
+      # MoraをHashにします。
+      #
+      # @return [Hash]
+      #
+      def to_hash
+        {
+          text: @text,
+          consonant: @consonant,
+          consonant_length: @consonant_length,
+          vowel: @vowel,
+          vowel_length: @vowel_length,
+          pitch: @pitch
+        }
+      end
+    end
+  end
+end

data/lib/voicevox/wrapper/info.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require "json"
+
+class Voicevox
+  # サポートされているデバイスを表すStruct。
+  SupportedDevices = Struct.new(:cpu, :cuda, :dml, keyword_init: true)
+
+  # キャラクターの情報を表すStruct。
+  CharacterInfo =
+    Struct.new(:name, :styles, :speaker_uuid, :version, keyword_init: true) do
+      #
+      # キャラクターの最初のスタイルのIDを返します。
+      # @note ほとんどの場合はノーマルになります。
+      #
+      # @return [Integer] スタイルのID。
+      #
+      def id
+        styles[0].id
+      end
+
+      #
+      # キャラクターのスタイルが全てロードされているかを返します。
+      #
+      # @return [Boolean] 全てロードされている場合はtrue、そうでない場合はfalse。
+      #
+      def loaded?
+        styles.map(&:loaded?).all?
+      end
+
+      #
+      # キャラクターのスタイルを全てロードします。
+      #
+      # @return [void]
+      #
+      def load
+        Voicevox.initialize_required
+        styles.map(&:load)
+      end
+    end
+  StyleInfo =
+    Struct.new(:name, :id, keyword_init: true) do
+      #
+      # スタイルがロードされているかを返します。
+      #
+      # @return [Boolean] ロードされている場合はtrue、そうでない場合はfalse。
+      #
+      def loaded?
+        Voicevox::Core.is_model_loaded(id)
+      end
+
+      #
+      # スタイルをロードします。
+      #
+      # @return [void]
+      #
+      def load
+        Voicevox.initialize_required
+        Voicevox.process_result Voicevox::Core.voicevox_load_model(id)
+      end
+    end
+
+  class << self
+    #
+    # サポートしているデバイスを取得します。
+    #
+    # @return [Voicevox::SupportedDevices] サポートしているデバイス。
+    #
+    def supported_devices
+      SupportedDevices.new(
+        **JSON.parse(Voicevox::Core.voicevox_get_supported_devices_json)
+      )
+    end
+
+    #
+    # キャラクターの一覧を取得します。
+    #
+    # @return [Array<CharacterInfo>] キャラクターの一覧。
+    #
+    def characters
+      JSON
+        .parse(Voicevox::Core.voicevox_get_metas_json)
+        .map do |meta|
+          CharacterInfo.new(
+            **{
+              **meta,
+              "styles" => meta["styles"].map { |style| StyleInfo.new(**style) }
+            }
+          )
+        end
+    end
+
+    #
+    # GPUをサポートしているかを返します。
+    #
+    # @note CUDA、またはDirectMLが使える場合にtrueを返します。
+    #
+    # @return [Boolean] GPUをサポートしているかどうか。
+    #
+    def gpu_supported?
+      Voicevox.supported_devices.cuda || Voicevox.supported_devices.dml
+    end
+
+    #
+    # コアのバージョンを取得します。
+    #
+    # @return [String] コアのバージョン。
+    #
+    def core_version
+      Voicevox::Core.voicevox_get_version
+    end
+  end
+end

data/lib/voicevox/wrapper/manager.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require "etc"
+require "objspace"
+
+class Voicevox
+  @initialized = false
+  # @return [:cpu, :gpu] ハードウェアアクセラレーションモード。
+  attr_reader :acceleration_mode
+  # @return [Integer] スレッド数。
+  attr_reader :cpu_num_threads
+  # @return [Boolean] 起動時に全てのモデルを読み込むかどうか。
+  attr_reader :load_all_models
+
+  #
+  # GPUモードで動作しているかどうか。
+  #
+  # @return [Boolean] GPUモードで動作している場合はtrue、そうでない場合はfalse。
+  #
+  def gpu?
+    @acceleration_mode == :gpu
+  end
+
+  #
+  # CPUモードで動作しているかどうか。
+  #
+  # @return [Boolean] CPUモードで動作している場合はtrue、そうでない場合はfalse。
+  #
+  def cpu?
+    @acceleration_mode == :cpu
+  end
+
+  #
+  # Voicevoxのコアを初期化します。
+  #
+  # @param [String] openjtalk_dict_path OpenJTalkの辞書へのパス。
+  # @param [:cpu, :gpu, :auto] acceleration_mode ハードウェアアクセラレーションモード。:autoを指定するとコア側で自動的に決定されます。
+  # @param [Integer] cpu_num_threads スレッド数。省略する、または0を渡すとコア側で自動的に決定されます。
+  # @param [Boolean] load_all_models 全てのモデルを読み込むかどうか。省略するとfalseになります。
+  #
+  def initialize(
+    openjtalk_dict_path,
+    acceleration_mode: :auto,
+    cpu_num_threads: nil,
+    load_all_models: false
+  )
+    acceleration_mode_enum =
+      {
+        auto: :voicevox_acceleration_mode_auto,
+        gpu: :voicevox_acceleration_mode_gpu,
+        cpu: :voicevox_acceleration_mode_cpu
+      }.fetch(acceleration_mode) do
+        raise ArgumentError, "無効なacceleration_mode: #{acceleration_mode}"
+      end
+    @cpu_num_threads = cpu_num_threads || 0
+    @load_all_models = load_all_models
+    @openjtalk_dict_path = openjtalk_dict_path
+    options = Voicevox::Core.voicevox_make_default_initialize_options
+    options[:acceleration_mode] = acceleration_mode_enum
+    options[:cpu_num_threads] = @cpu_num_threads
+    options[:load_all_models] = @load_all_models
+    options[:openjtalk_dict_path] = FFI::MemoryPointer.from_string(
+      openjtalk_dict_path
+    )
+
+    Voicevox.process_result Voicevox::Core.voicevox_initialize(options)
+    @acceleration_mode = Voicevox::Core.voicevox_is_gpu_mode ? :gpu : :cpu
+    at_exit { Voicevox::Core.voicevox_finalize } unless self.class.initialized
+    self.class.initialized = true
+  end
+
+  #
+  # Voicevoxのコアをファイナライズします。
+  #
+  def finalize
+    Voicevox::Core.voicevox_finalize
+    self.class.initialized = false
+  end
+
+  #
+  # 話者のモデルを読み込みます。
+  #
+  # @param [Voicevox::CharacterInfo, Voicevox::StyleInfo, Integer] speaker 話者、または話者のID。
+  #
+  def load_model(speaker)
+    id = speaker.is_a?(Integer) ? speaker : speaker.id
+
+    Voicevox.process_result Voicevox::Core.voicevox_load_model(id)
+  end
+
+  #
+  # モデルが読み込まれているかどうかを返します。
+  #
+  # @param [Voicevox::CharacterInfo, Voicevox::StyleInfo, Integer] speaker 話者、または話者のID。
+  #
+  # @return [Boolean] 読み込まれているかどうか。
+  #
+  def model_loaded?(speaker)
+    id = speaker.is_a?(Integer) ? speaker : speaker.id
+
+    Voicevox::Core.voicevox_is_model_loaded(id)
+  end
+
+  #
+  # voicevox_ttsを使って音声を生成します。
+  #
+  # @param [String] text 生成する音声のテキスト。
+  # @param [Voicevox::CharacterInfo, Voicevox::StyleInfo, Integer] speaker 話者、または話者のID。
+  # @param [Boolean] kana textをAquesTalkライクな記法として解釈するかどうか。デフォルトはfalse。
+  # @param [Boolran] enable_interrogative_upspeak 疑問文の調整を有効にするかどうか。デフォルトはtrue。
+  #
+  # @return [String] 生成された音声のwavデータ。
+  #
+  def tts(text, speaker, kana: false, enable_interrogative_upspeak: true)
+    size_ptr = FFI::MemoryPointer.new(:int)
+    return_ptr = FFI::MemoryPointer.new(:pointer)
+    id = speaker.is_a?(Integer) ? speaker : speaker.id
+    load_model id
+    options = Voicevox::Core.voicevox_make_default_tts_options
+    options[:kana] = kana
+    options[:enable_interrogative_upspeak] = enable_interrogative_upspeak
+    Voicevox.process_result(
+      Voicevox::Core.voicevox_tts(text, id, options, size_ptr, return_ptr)
+    )
+    data_ptr = return_ptr.read_pointer
+    data = data_ptr.read_string(size_ptr.read_int)
+    size_ptr.free
+    Voicevox::Core.voicevox_wav_free(data_ptr)
+    data
+  end
+
+  class << self
+    attr_accessor :initialized
+
+    alias initialized? initialized
+  end
+end

data/lib/voicevox/wrapper/utils.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "etc"
+
+class Voicevox
+  class << self
+    #
+    # Voicevoxが初期化されていなかったらエラーを出す。
+    #
+    def initialize_required
+      raise Voicevox::Error, "Voicevoxが初期化されていません" unless Voicevox.initialized?
+    end
+
+    #
+    # voicevox_result_codeに対応するエラーをraiseします。
+    #
+    # @param [Symbol] result voicevox_result_code。
+    #
+    def process_result(result)
+      return if result == :voicevox_result_succeed
+      raise "#{result}はSymbolではありません" unless result.is_a?(Symbol)
+
+      raise Voicevox::CoreError.from_code(result)
+    end
+
+    #
+    # 製品版Voicevoxのパスを返します。
+    #
+    # @return [String] Voicevoxへの絶対パス。
+    # @return [nil] Voicevoxが見付からなかった場合。zip版やLinux版ではnilを返します。
+    #
+    def voicevox_path
+      paths =
+        if Gem.win_platform?
+          [File.join(ENV.fetch("LOCALAPPDATA", ""), "Programs", "VOICEVOX")]
+        else
+          [
+            "/Applications/VOICEVOX",
+            "/Users/#{Etc.getlogin}/Library/Application Support/VOICEVOX"
+          ]
+        end
+      paths.find { |path| Dir.exist?(path) }
+    end
+  end
+end

data/lib/voicevox.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "voicevox/core"
+require_relative "voicevox/version"
+require_relative "voicevox/error"
+require_relative "voicevox/wrapper/utils"
+require_relative "voicevox/wrapper/info"
+require_relative "voicevox/wrapper/manager"
+require_relative "voicevox/wrapper/audio_query"
+
+#
+# voicevox_coreのラッパー。
+#
+class Voicevox # rubocop:disable Lint/EmptyClass
+end

data/rbs_collection.lock.yaml

@@ -0,0 +1,100 @@
+---
+sources:
+- name: ruby/gem_rbs_collection
+  remote: https://github.com/ruby/gem_rbs_collection.git
+  revision: main
+  repo_dir: gems
+path: ".gem_rbs_collection"
+gems:
+- name: activesupport
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: e920cbaa517738b75f3b1e70223a0e51da80d5aa
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: ast
+  version: '2.4'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: e920cbaa517738b75f3b1e70223a0e51da80d5aa
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: i18n
+  version: '1.10'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: e920cbaa517738b75f3b1e70223a0e51da80d5aa
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: io-console
+  version: '0'
+  source:
+    type: stdlib
+- name: json
+  version: '0'
+  source:
+    type: stdlib
+- name: listen
+  version: '3.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: e920cbaa517738b75f3b1e70223a0e51da80d5aa
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: minitest
+  version: '0'
+  source:
+    type: stdlib
+- name: parallel
+  version: '1.20'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: e920cbaa517738b75f3b1e70223a0e51da80d5aa
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rainbow
+  version: '3.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: e920cbaa517738b75f3b1e70223a0e51da80d5aa
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: steep
+  version: 1.1.1
+  source:
+    type: rubygems
+- name: monitor
+  version: '0'
+  source:
+    type: stdlib
+- name: date
+  version: '0'
+  source:
+    type: stdlib
+- name: singleton
+  version: '0'
+  source:
+    type: stdlib
+- name: logger
+  version: '0'
+  source:
+    type: stdlib
+- name: mutex_m
+  version: '0'
+  source:
+    type: stdlib
+- name: time
+  version: '0'
+  source:
+    type: stdlib
+- name: pathname
+  version: '0'
+  source:
+    type: stdlib

data/rbs_collection.yaml

@@ -0,0 +1,15 @@
+# Download sources
+sources:
+  - name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+gems:
+  # Skip loading rbs gem's RBS.
+  # It's unnecessary if you don't use rbs as a library.
+  - name: rbs
+    ignore: true

data/sig/ffi.rbs

@@ -0,0 +1,16 @@
+module FFI
+  module Library
+    def ffi_lib: (Array[String] | String) -> void
+
+    def enum: (Symbol, Array[Symbol | Integer]) -> void
+
+    def attach_function: (Symbol, Array[Symbol], Symbol) -> void
+  end
+
+  class Pointer
+  end
+
+  class MemoryPointer < Pointer
+    def initialize: (Symbol `type`) -> void
+  end
+end