voicevox.rb 0.1.0

data/sig/voicevox/core.rbs

@@ -0,0 +1,126 @@
+module Voicevox::Core
+  extend FFI::Library
+
+  type voicevox_result_code =
+    :voicevox_result_succeed
+    | :voicevox_result_not_loaded_openjtalk_dict
+    | :voicevox_result_failed_load_model
+    | :voicevox_result_failed_get_supported_devices
+    | :voicevox_result_cant_gpu_support
+    | :voicevox_result_failed_load_metas
+    | :voicevox_result_uninitialized_status
+    | :voicevox_result_invalid_speaker_id
+    | :voicevox_result_invalid_model_index
+    | :voicevox_result_inference_failed
+    | :voicevox_result_failed_extract_full_context_label
+    | :voicevox_result_invalid_utf8_input
+    | :voicevox_result_failed_parse_kana
+    | :voicevox_result_invalid_audio_query
+
+  type voicevox_acceleration_mode =
+    :voicevox_acceleration_mode_auto
+    | :voicevox_acceleration_mode_cpu
+    | :voicevox_acceleration_mode_gpu
+
+  class VoicevoxInitializeOptions < FFI::Struct
+    attr_accessor acceleration_mode: voicevox_acceleration_mode
+    attr_accessor cpu_num_threads: Integer
+    attr_accessor load_all_models: bool
+    attr_accessor openjtalk_dict_path: String
+  end
+
+  class VoicevoxAudioQueryOptions < FFI::Struct
+    attr_accessor kana: bool
+  end
+
+  class VoicevoxSynthesisOptions < FFI::Struct
+    attr_accessor enable_interrogative_upspeak: bool
+  end
+
+  class VoicevoxTtsOptions < FFI::Struct
+    attr_accessor kana: bool
+    attr_accessor enable_interrogative_upspeak: bool
+  end
+
+  def self?.voicevox_make_default_initialize_options: -> Voicevox::VoicevoxInitializeOptions
+
+  def self?.voicevox_initialize: (
+    VoicevoxInitializeOptions options
+  ) -> voicevox_result_code
+
+  def self?.voicevox_load_model: (Integer speaker_id) -> bool
+
+  def self?.voicevox_is_gpu_mode: -> bool
+
+  def self?.voicevox_is_model_loaded: (Integer speaker_id) -> bool
+
+  def self?.voicevox_finalize: -> void
+
+  def self?.voicevox_get_metas_json: -> String
+
+  def self?.voicevox_get_supported_devices_json: -> String
+
+  def self?.voicevox_last_error_message: -> String
+
+  def self?.voicevox_predict_duration: (
+    Integer length,
+    FFI::Pointer phoneme_list,
+    FFI::Pointer speaker_id,
+    FFI::Pointer output
+  ) -> bool
+
+  def self?.voicevox_predict_intonation: (
+    Integer length,
+    FFI::Pointer vowel_phoneme_list,
+    FFI::Pointer consonant_phoneme_list,
+    FFI::Pointer start_accent_list,
+    FFI::Pointer end_accent_list,
+    FFI::Pointer start_accent_phrase_list,
+    FFI::Pointer end_accent_phrase_list,
+    Integer speaker_id,
+    FFI::Pointer output
+  ) -> bool
+
+  def self?.voicevox_decode: (
+    Integer length,
+    Integer phoneme_size,
+    FFI::Pointer f0,
+    FFI::Pointer phoneme,
+    Integer speaker_id,
+    FFI::Pointer output
+  ) -> bool
+
+  def self?.voicevox_make_default_audio_query_options: -> Voicevox::VoicevoxAudioQueryOptions
+
+  def self?.voicevox_audio_query: (
+    String text,
+    Integer speaker_id,
+    VoicevoxAudioQueryOptions options,
+    FFI::Pointer output
+  ) -> voicevox_result_code
+
+  def self?.voicevox_synthesis: (
+    String audio_query_json,
+    Integer speaker_id,
+    VoicevoxSynthesisOptions options,
+    FFI::Pointer output_wav_size,
+    FFI::Pointer output_wav
+  ) -> voicevox_result_code
+
+  def self?.voicevox_make_default_tts_options: -> Voicevox::VoicevoxTtsOptions
+
+  def self?.voicevox_tts: (
+    String text,
+    String speaker_id,
+    VoicevoxTtsOptions options,
+    FFI::Pointer output_binary_size,
+    FFI::Pointer output_wav
+  ) -> voicevox_result_code
+
+  def self?.voicevox_audio_query_json_free: (FFI::Pointer wav) -> void
+  def self?.voicevox_wav_free: (FFI::Pointer wav) -> void
+
+  def self?.voicevox_error_result_to_message: (
+    voicevox_result_code result_code
+  ) -> String
+end

data/sig/voicevox/error.rbs

@@ -0,0 +1,53 @@
+class Voicevox
+  class Error < StandardError
+  end
+
+  class CoreError < Error
+    attr_reader code: Voicevox::Core::voicevox_result_code
+
+    attr_reader self.code: Voicevox::Core::voicevox_result_code
+
+    def initialize: -> void
+
+    def self.from_code: (Voicevox::Core::voicevox_result_code code) -> CoreError
+
+    class NotLoadedOpenjtalkDict < Voicevox::CoreError
+    end
+
+    class FailedLoadModel < Voicevox::CoreError
+    end
+
+    class FailedGetSupportedDevices < Voicevox::CoreError
+    end
+
+    class CantGpuSupport < Voicevox::CoreError
+    end
+
+    class FailedLoadMetas < Voicevox::CoreError
+    end
+
+    class UninitializedStatus < Voicevox::CoreError
+    end
+
+    class InvalidSpeakerId < Voicevox::CoreError
+    end
+
+    class InvalidModelIndex < Voicevox::CoreError
+    end
+
+    class InferenceFailed < Voicevox::CoreError
+    end
+
+    class FailedExtractFullContextLabel < Voicevox::CoreError
+    end
+
+    class InvalidUtf8Input < Voicevox::CoreError
+    end
+
+    class FailedParseKana < Voicevox::CoreError
+    end
+
+    class InvalidAudioQuery < Voicevox::CoreError
+    end
+  end
+end

data/sig/voicevox/wrapper/info.rbs

@@ -0,0 +1,26 @@
+class Voicevox
+  def self.supported_devices: -> Voicevox::SupportedDevices
+  def self.characters: -> Array[Voicevox::CharacterInfo]
+
+  class SupportedDevices < Struct[bool]
+    attr_accessor cpu: bool
+    attr_accessor cuda: bool
+    attr_accessor dml: bool
+  end
+
+  class CharacterInfo < Struct[untyped]
+    attr_accessor name: String
+    attr_accessor styles: Array[Voicevox::StyleInfo]
+    attr_accessor speaker_uuid: String
+    attr_accessor version: String
+  end
+
+  class StyleInfo < Struct[untyped]
+    attr_accessor name: String
+    attr_accessor id: Integer
+  end
+
+  def self.gpu_supported?: -> bool
+
+  def self.core_version: -> String
+end

data/sig/voicevox/wrapper/manager.rbs

@@ -0,0 +1,31 @@
+class Voicevox
+  attr_reader use_gpu: bool
+  attr_reader threads: Integer
+  attr_reader load_all_models: bool
+
+  alias gpu? use_gpu
+
+  def initialize: (
+    String openjtalk_dict_path,
+    ?use_gpu: :auto | bool,
+    ?threads: Integer?,
+    ?load_all_models: bool
+  ) -> void
+
+  def finalize: -> void
+
+  def load_openjtalk_dict: (String path) -> void
+
+  type speaker = Voicevox::CharacterInfo | Voicevox::StyleInfo | Integer
+
+  def load_model: (speaker speaker) -> void
+  def model_loaded?: (speaker speaker) -> bool
+
+  def tts: (String text, speaker speaker) -> String
+  def tts_from_kana: (String text, speaker speaker) -> String
+  alias aquestalk_tts tts_from_kana
+
+  attr_accessor self.initialized: bool
+
+  alias self.initialized? self.initialized
+end

data/sig/voicevox/wrapper/utils.rbs

@@ -0,0 +1,9 @@
+class Voicevox
+  def self.initialize_required: -> void
+
+  def self.failed: -> void
+
+  def process_result: (Voicevox::Core::voicevox_result_code) -> void
+
+  def voicevox_path: -> String?
+end

data/sig/voicevox.rbs

@@ -0,0 +1,3 @@
+class Voicevox
+  VERSION: String
+end

data/voicevox.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "lib/voicevox/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "voicevox.rb"
+  spec.version = Voicevox::VERSION
+  spec.authors = ["sevenc-nanashi"]
+  spec.email = ["sevenc7c@sevenc7c.com"]
+
+  spec.summary = "Unofficial wrapper for voicevox_core"
+  spec.homepage = "https://github.com/sevenc-nanashi/voicevox.rb"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files =
+    Dir.chdir(__dir__) do
+      `git ls-files -z`.split("\x0")
+        .reject do |f|
+          (f == __FILE__) ||
+            f.match(
+              %r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)}
+            )
+        end
+    end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency("ffi", "~> 1.15")
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: voicevox.rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sevenc-nanashi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+description:
+email:
+- sevenc7c@sevenc7c.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- Steepfile
+- examples/cli.rb
+- examples/outputs/.gitkeep
+- examples/repl_core.rb
+- examples/repl_wrapper.rb
+- lib/voicevox.rb
+- lib/voicevox/core.rb
+- lib/voicevox/error.rb
+- lib/voicevox/version.rb
+- lib/voicevox/wrapper/audio_query.rb
+- lib/voicevox/wrapper/info.rb
+- lib/voicevox/wrapper/manager.rb
+- lib/voicevox/wrapper/utils.rb
+- rbs_collection.lock.yaml
+- rbs_collection.yaml
+- sig/ffi.rbs
+- sig/voicevox.rbs
+- sig/voicevox/core.rbs
+- sig/voicevox/error.rbs
+- sig/voicevox/wrapper/info.rbs
+- sig/voicevox/wrapper/manager.rbs
+- sig/voicevox/wrapper/utils.rbs
+- voicevox.gemspec
+homepage: https://github.com/sevenc-nanashi/voicevox.rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sevenc-nanashi/voicevox.rb
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Unofficial wrapper for voicevox_core
+test_files: []