voicevox_core.h

Go to the documentation of this file.

 
#ifndef VOICEVOX_CORE_INCLUDE_GUARD
#define VOICEVOX_CORE_INCLUDE_GUARD
 
/* Generated with cbindgen:0.28.0 */
 
#ifdef __cplusplus
#include <cstdint>
#else // __cplusplus
#include <stdbool.h>
#include <stdint.h>
#endif // __cplusplus
 
//#define VOICEVOX_LINK_ONNXRUNTIME
//#define VOICEVOX_LOAD_ONNXRUNTIME
 
#if !(defined(VOICEVOX_LINK_ONNXRUNTIME) || defined(VOICEVOX_LOAD_ONNXRUNTIME))
#error "either `VOICEVOX_LINK_ONNXRUNTIME` or `VOICEVOX_LOAD_ONNXRUNTIME` must be enabled"
#endif
 
#if defined(VOICEVOX_LINK_ONNXRUNTIME) && defined(VOICEVOX_LOAD_ONNXRUNTIME)
#error "`VOICEVOX_LINK_ONNXRUNTIME` or `VOICEVOX_LOAD_ONNXRUNTIME` cannot be enabled at the same time"
#endif
 
enum VoicevoxAccelerationMode
#ifdef __cplusplus
  : int32_t
#endif // __cplusplus
 {
  VOICEVOX_ACCELERATION_MODE_AUTO = 0,
  VOICEVOX_ACCELERATION_MODE_CPU = 1,
  VOICEVOX_ACCELERATION_MODE_GPU = 2,
};
#ifndef __cplusplus
typedef int32_t VoicevoxAccelerationMode;
#endif // __cplusplus
 
enum VoicevoxOnExistingVoiceModelId
#ifdef __cplusplus
  : int32_t
#endif // __cplusplus
 {
  VOICEVOX_ON_EXISTING_VOICE_MODEL_ID_ERROR = 0,
  VOICEVOX_ON_EXISTING_VOICE_MODEL_ID_RELOAD = 1,
  VOICEVOX_ON_EXISTING_VOICE_MODEL_ID_SKIP = 2,
};
#ifndef __cplusplus
typedef int32_t VoicevoxOnExistingVoiceModelId;
#endif // __cplusplus
 
enum VoicevoxResultCode
#ifdef __cplusplus
  : int32_t
#endif // __cplusplus
 {
  VOICEVOX_RESULT_OK = 0,
  VOICEVOX_RESULT_NOT_LOADED_OPENJTALK_DICT_ERROR = 1,
  VOICEVOX_RESULT_GET_SUPPORTED_DEVICES_ERROR = 3,
  VOICEVOX_RESULT_GPU_SUPPORT_ERROR = 4,
  VOICEVOX_RESULT_INIT_INFERENCE_RUNTIME_ERROR = 29,
  VOICEVOX_RESULT_STYLE_NOT_FOUND_ERROR = 6,
  VOICEVOX_RESULT_MODEL_NOT_FOUND_ERROR = 7,
  VOICEVOX_RESULT_RUN_MODEL_ERROR = 8,
  VOICEVOX_RESULT_ANALYZE_TEXT_ERROR = 11,
  VOICEVOX_RESULT_INVALID_UTF8_INPUT_ERROR = 12,
  VOICEVOX_RESULT_PARSE_KANA_ERROR = 13,
  VOICEVOX_RESULT_INVALID_AUDIO_QUERY_ERROR = 14,
  VOICEVOX_RESULT_INVALID_ACCENT_PHRASE_ERROR = 15,
  VOICEVOX_RESULT_OPEN_ZIP_FILE_ERROR = 16,
  VOICEVOX_RESULT_READ_ZIP_ENTRY_ERROR = 17,
  VOICEVOX_RESULT_INVALID_MODEL_FORMAT_ERROR = 28,
  VOICEVOX_RESULT_MODEL_ALREADY_LOADED_ERROR = 18,
  VOICEVOX_RESULT_STYLE_ALREADY_LOADED_ERROR = 26,
  VOICEVOX_RESULT_INVALID_MODEL_DATA_ERROR = 27,
  VOICEVOX_RESULT_LOAD_USER_DICT_ERROR = 20,
  VOICEVOX_RESULT_SAVE_USER_DICT_ERROR = 21,
  VOICEVOX_RESULT_USER_DICT_WORD_NOT_FOUND_ERROR = 22,
  VOICEVOX_RESULT_USE_USER_DICT_ERROR = 23,
  VOICEVOX_RESULT_INVALID_USER_DICT_WORD_ERROR = 24,
  VOICEVOX_RESULT_INVALID_UUID_ERROR = 25,
  VOICEVOX_RESULT_INVALID_MORA_ERROR = 30,
  VOICEVOX_RESULT_INVALID_SCORE_ERROR = 31,
  VOICEVOX_RESULT_INVALID_NOTE_ERROR = 32,
  VOICEVOX_RESULT_INVALID_FRAME_AUDIO_QUERY_ERROR = 33,
  VOICEVOX_RESULT_INVALID_FRAME_PHONEME_ERROR = 34,
  VOICEVOX_RESULT_INCOMPATIBLE_QUERIES_ERROR = 35,
};
#ifndef __cplusplus
typedef int32_t VoicevoxResultCode;
#endif // __cplusplus
 
enum VoicevoxUserDictWordType
#ifdef __cplusplus
  : int32_t
#endif // __cplusplus
 {
  VOICEVOX_USER_DICT_WORD_TYPE_PROPER_NOUN = 0,
  VOICEVOX_USER_DICT_WORD_TYPE_COMMON_NOUN = 1,
  VOICEVOX_USER_DICT_WORD_TYPE_VERB = 2,
  VOICEVOX_USER_DICT_WORD_TYPE_ADJECTIVE = 3,
  VOICEVOX_USER_DICT_WORD_TYPE_SUFFIX = 4,
};
#ifndef __cplusplus
typedef int32_t VoicevoxUserDictWordType;
#endif // __cplusplus
 
typedef struct OpenJtalkRc OpenJtalkRc;
 
typedef struct VoicevoxAudioFeature VoicevoxAudioFeature;
 
typedef struct VoicevoxOnnxruntime VoicevoxOnnxruntime;
 
typedef struct VoicevoxSynthesizer VoicevoxSynthesizer;
 
typedef struct VoicevoxUserDict VoicevoxUserDict;
 
typedef struct VoicevoxVoiceModelFile VoicevoxVoiceModelFile;
 
#if defined(VOICEVOX_LOAD_ONNXRUNTIME)
typedef struct VoicevoxLoadOnnxruntimeOptions {
  const char *filename;
} VoicevoxLoadOnnxruntimeOptions;
#endif
 
typedef struct VoicevoxInitializeOptions {
  VoicevoxAccelerationMode acceleration_mode;
  uint16_t cpu_num_threads;
} VoicevoxInitializeOptions;
 
typedef struct VoicevoxLoadVoiceModelOptions {
  VoicevoxOnExistingVoiceModelId on_existing;
} VoicevoxLoadVoiceModelOptions;
 
typedef const uint8_t (*VoicevoxVoiceModelId)[16];
 
typedef uint32_t VoicevoxStyleId;
 
typedef struct VoicevoxSynthesisOptions {
  bool enable_interrogative_upspeak;
} VoicevoxSynthesisOptions;
 
typedef struct VoicevoxTtsOptions {
  bool enable_interrogative_upspeak;
} VoicevoxTtsOptions;
 
typedef struct VoicevoxUserDictWord {
  const char *surface;
  const char *pronunciation;
  uintptr_t accent_type;
  VoicevoxUserDictWordType word_type;
  uint8_t priority;
} VoicevoxUserDictWord;
 
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
 
#ifdef _WIN32
__declspec(dllimport)
#endif
uint32_t voicevox_get_onnxruntime_lib_min_required_minor_version(void);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
uint32_t voicevox_get_onnxruntime_lib_max_supported_minor_version(void);
 
#if defined(VOICEVOX_LOAD_ONNXRUNTIME)
#ifdef _WIN32
__declspec(dllimport)
#endif
const char *voicevox_get_onnxruntime_lib_recommended_versioned_filename(void);
#endif
 
#if defined(VOICEVOX_LOAD_ONNXRUNTIME)
#ifdef _WIN32
__declspec(dllimport)
#endif
const char *voicevox_get_onnxruntime_lib_recommended_unversioned_filename(void);
#endif
 
#if defined(VOICEVOX_LOAD_ONNXRUNTIME)
#ifdef _WIN32
__declspec(dllimport)
#endif
struct VoicevoxLoadOnnxruntimeOptions voicevox_make_default_load_onnxruntime_options(void);
#endif
 
#ifdef _WIN32
__declspec(dllimport)
#endif
const struct VoicevoxOnnxruntime *voicevox_onnxruntime_get(void);
 
#if defined(VOICEVOX_LOAD_ONNXRUNTIME)
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_onnxruntime_load_once(struct VoicevoxLoadOnnxruntimeOptions options,
                                                  const struct VoicevoxOnnxruntime **out_onnxruntime);
#endif
 
#if defined(VOICEVOX_LINK_ONNXRUNTIME)
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_onnxruntime_init_once(const struct VoicevoxOnnxruntime **out_onnxruntime);
#endif
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_open_jtalk_rc_new(const char *open_jtalk_dic_dir,
                                              struct OpenJtalkRc **out_open_jtalk);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_open_jtalk_rc_use_user_dict(const struct OpenJtalkRc *open_jtalk,
                                                        const struct VoicevoxUserDict *user_dict);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_open_jtalk_rc_analyze(const struct OpenJtalkRc *open_jtalk,
                                                  const char *text,
                                                  char **output_accent_phrases_json);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
void voicevox_open_jtalk_rc_delete(struct OpenJtalkRc *open_jtalk);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
struct VoicevoxInitializeOptions voicevox_make_default_initialize_options(void);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
const char *voicevox_get_version(void);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_audio_query_create_from_accent_phrases(const char *accent_phrases_json,
                                                                   char **output_audio_query_json);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_audio_query_validate(const char *audio_query_json);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_accent_phrase_validate(const char *accent_phrase_json);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_mora_validate(const char *mora_json);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_score_validate(const char *score_json);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_note_validate(const char *note_json);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_frame_audio_query_validate(const char *frame_audio_query_json);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_frame_phoneme_validate(const char *frame_phoneme_json);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_ensure_compatible(const char *score_json,
                                              const char *frame_audio_query_json);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
void voicevox_wav_from_s16le(uintptr_t pcm_length,
                             const uint8_t *pcm,
                             uint32_t sampling_rate,
                             bool is_stereo,
                             uintptr_t *output_wav_length,
                             uint8_t **output_wav);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_voice_model_file_open(const char *path,
                                                  struct VoicevoxVoiceModelFile **out_model);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
void voicevox_voice_model_file_id(const struct VoicevoxVoiceModelFile *model,
                                  uint8_t (*output_voice_model_id)[16]);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
char *voicevox_voice_model_file_create_metas_json(const struct VoicevoxVoiceModelFile *model);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
void voicevox_voice_model_file_delete(struct VoicevoxVoiceModelFile *model);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_synthesizer_new(const struct VoicevoxOnnxruntime *onnxruntime,
                                            const struct OpenJtalkRc *open_jtalk,
                                            struct VoicevoxInitializeOptions options,
                                            struct VoicevoxSynthesizer **out_synthesizer);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
void voicevox_synthesizer_delete(struct VoicevoxSynthesizer *synthesizer);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
struct VoicevoxLoadVoiceModelOptions voicevox_make_default_load_voice_model_options(void);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_synthesizer_load_voice_model(const struct VoicevoxSynthesizer *synthesizer,
                                                         const struct VoicevoxVoiceModelFile *model,
                                                         struct VoicevoxLoadVoiceModelOptions options);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_synthesizer_unload_voice_model(const struct VoicevoxSynthesizer *synthesizer,
                                                           VoicevoxVoiceModelId model_id);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
const struct VoicevoxOnnxruntime *voicevox_synthesizer_get_onnxruntime(const struct VoicevoxSynthesizer *synthesizer);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
bool voicevox_synthesizer_is_gpu_mode(const struct VoicevoxSynthesizer *synthesizer);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
bool voicevox_synthesizer_is_loaded_voice_model(const struct VoicevoxSynthesizer *synthesizer,
                                                VoicevoxVoiceModelId model_id);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
char *voicevox_synthesizer_create_metas_json(const struct VoicevoxSynthesizer *synthesizer);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_onnxruntime_create_supported_devices_json(const struct VoicevoxOnnxruntime *onnxruntime,
                                                                      char **output_supported_devices_json);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_synthesizer_create_audio_query_from_kana(const struct VoicevoxSynthesizer *synthesizer,
                                                                     const char *kana,
                                                                     VoicevoxStyleId style_id,
                                                                     char **output_audio_query_json);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_synthesizer_create_audio_query(const struct VoicevoxSynthesizer *synthesizer,
                                                           const char *text,
                                                           VoicevoxStyleId style_id,
                                                           char **output_audio_query_json);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_synthesizer_create_accent_phrases_from_kana(const struct VoicevoxSynthesizer *synthesizer,
                                                                        const char *kana,
                                                                        VoicevoxStyleId style_id,
                                                                        char **output_accent_phrases_json);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_synthesizer_create_accent_phrases(const struct VoicevoxSynthesizer *synthesizer,
                                                              const char *text,
                                                              VoicevoxStyleId style_id,
                                                              char **output_accent_phrases_json);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_synthesizer_replace_mora_data(const struct VoicevoxSynthesizer *synthesizer,
                                                          const char *accent_phrases_json,
                                                          VoicevoxStyleId style_id,
                                                          char **output_accent_phrases_json);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_synthesizer_replace_phoneme_length(const struct VoicevoxSynthesizer *synthesizer,
                                                               const char *accent_phrases_json,
                                                               VoicevoxStyleId style_id,
                                                               char **output_accent_phrases_json);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_synthesizer_replace_mora_pitch(const struct VoicevoxSynthesizer *synthesizer,
                                                           const char *accent_phrases_json,
                                                           VoicevoxStyleId style_id,
                                                           char **output_accent_phrases_json);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
struct VoicevoxSynthesisOptions voicevox_make_default_synthesis_options(void);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_synthesizer_synthesis(const struct VoicevoxSynthesizer *synthesizer,
                                                  const char *audio_query_json,
                                                  VoicevoxStyleId style_id,
                                                  struct VoicevoxSynthesisOptions options,
                                                  uintptr_t *output_wav_length,
                                                  uint8_t **output_wav);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_synthesizer_create_audio_feature(const struct VoicevoxSynthesizer *synthesizer,
                                                             const char *audio_query_json,
                                                             VoicevoxStyleId style_id,
                                                             struct VoicevoxSynthesisOptions options,
                                                             struct VoicevoxAudioFeature **out_audio_feature);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
uintptr_t voicevox_audio_feature_frame_length(const struct VoicevoxAudioFeature *audio_feature);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_synthesizer_render(const struct VoicevoxSynthesizer *synthesizer,
                                               const struct VoicevoxAudioFeature *audio_feature,
                                               uintptr_t start_inclusive,
                                               uintptr_t end_exclusive,
                                               uintptr_t *output_pcm_length,
                                               uint8_t **output_pcm);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
void voicevox_audio_feature_delete(struct VoicevoxAudioFeature *audio_feature);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
struct VoicevoxTtsOptions voicevox_make_default_tts_options(void);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_synthesizer_tts_from_kana(const struct VoicevoxSynthesizer *synthesizer,
                                                      const char *kana,
                                                      VoicevoxStyleId style_id,
                                                      struct VoicevoxTtsOptions options,
                                                      uintptr_t *output_wav_length,
                                                      uint8_t **output_wav);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_synthesizer_tts(const struct VoicevoxSynthesizer *synthesizer,
                                            const char *text,
                                            VoicevoxStyleId style_id,
                                            struct VoicevoxTtsOptions options,
                                            uintptr_t *output_wav_length,
                                            uint8_t **output_wav);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_synthesizer_create_sing_frame_audio_query(const struct VoicevoxSynthesizer *synthesizer,
                                                                      const char *score_json,
                                                                      VoicevoxStyleId style_id,
                                                                      char **output_frame_audio_query_json);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_synthesizer_create_sing_frame_f0(const struct VoicevoxSynthesizer *synthesizer,
                                                             const char *score_json,
                                                             const char *frame_audio_query_json,
                                                             VoicevoxStyleId style_id,
                                                             char **output_f0_json);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_synthesizer_create_sing_frame_volume(const struct VoicevoxSynthesizer *synthesizer,
                                                                 const char *score_json,
                                                                 const char *frame_audio_query_json,
                                                                 VoicevoxStyleId style_id,
                                                                 char **output_volume_json);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_synthesizer_frame_synthesis(const struct VoicevoxSynthesizer *synthesizer,
                                                        const char *frame_audio_query_json,
                                                        VoicevoxStyleId style_id,
                                                        uintptr_t *output_wav_length,
                                                        uint8_t **output_wav);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
void voicevox_json_free(char *json);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
void voicevox_wav_free(uint8_t *wav);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
const char *voicevox_error_result_to_message(VoicevoxResultCode result_code);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
struct VoicevoxUserDictWord voicevox_user_dict_word_make(const char *surface,
                                                         const char *pronunciation,
                                                         uintptr_t accent_type);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
struct VoicevoxUserDict *voicevox_user_dict_new(void);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_user_dict_load(const struct VoicevoxUserDict *user_dict,
                                           const char *dict_path);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_user_dict_add_word(const struct VoicevoxUserDict *user_dict,
                                               const struct VoicevoxUserDictWord *word,
                                               uint8_t (*output_word_uuid)[16]);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_user_dict_update_word(const struct VoicevoxUserDict *user_dict,
                                                  const uint8_t (*word_uuid)[16],
                                                  const struct VoicevoxUserDictWord *word);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_user_dict_remove_word(const struct VoicevoxUserDict *user_dict,
                                                  const uint8_t (*word_uuid)[16]);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_user_dict_to_json(const struct VoicevoxUserDict *user_dict,
                                              char **output_json);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_user_dict_import(const struct VoicevoxUserDict *user_dict,
                                             const struct VoicevoxUserDict *other_dict);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
VoicevoxResultCode voicevox_user_dict_save(const struct VoicevoxUserDict *user_dict,
                                           const char *path);
 
#ifdef _WIN32
__declspec(dllimport)
#endif
void voicevox_user_dict_delete(struct VoicevoxUserDict *user_dict);
 
#ifdef __cplusplus
}  // extern "C"
#endif  // __cplusplus
 
#endif  /* VOICEVOX_CORE_INCLUDE_GUARD */