Core/Tts

AITalk SDK 音声合成ライブラリの「テキスト処理や音声合成を行う合成機能」を利用するためのインターフェース [詳解]

Core/Tts 連携図

型定義
typedef struct AITalk_Core_AIKanaContainer	AITalk_Core_AIKanaContainer
	AIKanaContainer クラスの型
typedef int32_t	AITalk_Core_TtsId
	Tts クラスのメンバー種別 (AITalk_Core_TtsIdEnum) の型
typedef int32_t	AITalk_Core_Tts_AutoBookmarkModeId
	自動ブックマークモード種別 (AITalk_Core_Tts_AutoBookmarkModeIdEnum) の型
typedef struct AITalk_Core_Tts	AITalk_Core_Tts
	Tts クラスの型 [詳解]
typedef AITalkReturnCode(*	AITalk_Core_TtsOutCallback) (void *user_data, AITalk_Core_TtsOutEventId event_id, void *data)
	音声合成処理のコールバック関数の型
typedef int32_t	AITalk_Core_Tts_MergeProsodyLevel
	韻律交換・韻律混合の混合レベル (AITalk_Core_Tts_MergeProsodyLevelEnum) の型

列挙型
enum	AITalk_Core_TtsIdEnum {   AITalk_Core_TtsId_LanguageDictionary = 1, AITalk_Core_TtsId_VoiceDictionary = 2, AITalk_Core_TtsId_VoiceDictionaryLicense = 3, AITalk_Core_TtsId_TtsParameter = 4,   AITalk_Core_TtsId_InputEncoding = 5, AITalk_Core_TtsId_TypeOfInput = 6, AITalk_Core_TtsId_TagTokenBegin = 100, AITalk_Core_TtsId_TagTokenEnd = 101,   AITalk_Core_TtsId_AutoBookmarkMode = 201, AITalk_Core_TtsId_AutoBookmarkMarkPrefix = 202, AITalk_Core_TtsId_BookmarkMarkerMode = 301, AITalk_Core_TtsId_LipsyncMarkerMode = 302,   AITalk_Core_TtsId_AccentMarkerMode = 303, AITalk_Core_TtsId_PhraseMarkerMode = 304, AITalk_Core_TtsId_PresetSet = 401, AITalk_Core_TtsId_Uid = 402 }
	Tts クラスのメンバー種別 [詳解]
enum	AITalk_Core_Tts_AutoBookmarkModeIdEnum { AITalk_Core_Tts_AutoBookmarkModeId_None = 1, AITalk_Core_Tts_AutoBookmarkModeId_Sentence = 2, AITalk_Core_Tts_AutoBookmarkModeId_HighLight = 3 }
	自動ブックマークモード種別 [詳解]
enum	AITalk_Core_Tts_MergeProsodyLevelEnum { AITalk_Core_Tts_MergeProsodyLevel_1 = 1, AITalk_Core_Tts_MergeProsodyLevel_2 = 2 }
	韻律交換・韻律混合の混合レベル [詳解]

関数
AITalkReturnCode	AITalk_Core_AIKanaContainer_getAIKana (AITalk_Core_AIKanaContainer *ptr, const char **text, size_t *const size)
	AI かなをテキスト形式で取得する [詳解]
AITalkReturnCode	AITalk_Core_AIKanaContainer_delete (AITalk_Core_AIKanaContainer *ptr)
	AIKanaContainer クラスのインスタンスを削除する [詳解]
AITalkReturnCode	AITalk_Core_Tts_new (AITalk_Core_Tts **ptrptr)
	Tts クラスのインスタンスを生成する。 [詳解]
AITalkReturnCode	AITalk_Core_Tts_delete (AITalk_Core_Tts *ptr)
	Tts クラスのインスタンスを削除する。 [詳解]
AITalkReturnCode	AITalk_Core_Tts_duplicate (AITalk_Core_Tts **ptrptr, AITalk_Core_Tts *ptr)
	Tts クラスのインスタンスを複製する。 [詳解]
AITalkReturnCode	AITalk_Core_Tts_copy (AITalk_Core_Tts *dst_ptr, AITalk_Core_Tts *src_ptr)
	Tts クラスのインスタンスをコピーする。 [詳解]
AITalkReturnCode	AITalk_Core_Tts_putKeyValue (AITalk_Core_Tts *ptr, const AITalk_Core_TtsId id, const char *key, const AITalkMixedType value)
	Tts クラスのインスタンスに値を設定する。 [詳解]
AITalkReturnCode	AITalk_Core_Tts_getKeyValue (AITalk_Core_Tts *ptr, const AITalk_Core_TtsId id, const char *key, AITalkMixedType *value)
	Tts クラスのインスタンスから値を取得する。 [詳解]
AITalkReturnCode	AITalk_Core_Tts_getKeyList (AITalk_Core_Tts *ptr, const AITalk_Core_TtsId id, const char *const **keyList, size_t *size)
	Tts クラスのインスタンスから値を取得する。 [詳解]
AITalkReturnCode	AITalk_Core_Tts_selectDefaultKey (AITalk_Core_Tts *ptr, const AITalk_Core_TtsId id, const char *key)
	TTS クラスのデフォルト値をキーで指定する [詳解]
AITalkReturnCode	AITalk_Core_Tts_getDefaultKey (AITalk_Core_Tts *ptr, const AITalk_Core_TtsId id, const char **key)
	TTS クラスのデフォルト値のキーを取得する [詳解]
AITalkReturnCode	AITalk_Core_Tts_hasKey (AITalk_Core_Tts *ptr, const AITalk_Core_TtsId id, const char *key)
	TTS クラスのキーの登録有無を確認する [詳解]
AITalkReturnCode	AITalk_Core_Tts_deleteKey (AITalk_Core_Tts *ptr, const AITalk_Core_TtsId id, const char *key)
	TTS クラスのキーの登録を削除する [詳解]
AITalkReturnCode	AITalk_Core_Tts_isBusy (AITalk_Core_Tts *ptr)
	Tts クラスのインスタンスのリソースが利用されているか確認する。 [詳解]
AITalkReturnCode	AITalk_Core_Tts_run (AITalk_Core_Tts *ptr, const char *input, AITalk_Core_TtsOutCallback callback, void *user_data)
	Tts クラスのインスタンスで音声合成処理を開始する。 [詳解]
AITalkReturnCode	AITalk_Core_Tts_generateAIKanaContainer (AITalk_Core_Tts *ptr, AITalk_Core_AIKanaContainer **ptrptr, const char *text, AITalk_TextEncodingsId encoding)
	テキスト形式の通常文を AI かなに変換する。 [詳解]
AITalkReturnCode	AITalk_Core_Tts_generateMergedVoiceDictionary (AITalk_Core_Tts *ptr, const char *new_key, const char *base_key, const char *additional_key, AITalk_Core_Tts_MergeProsodyLevel level)
	韻律交換した音声辞書を作成する。 [詳解]

詳解

AITalk SDK 音声合成ライブラリの「テキスト処理や音声合成を行う合成機能」を利用するためのインターフェース

型定義詳解

AITalk_Core_Tts

typedef struct AITalk_Core_Tts AITalk_Core_Tts

Tts クラスの型

音声合成処理を行うためのクラス。

列挙型詳解

AITalk_Core_Tts_AutoBookmarkModeIdEnum

enum AITalk_Core_Tts_AutoBookmarkModeIdEnum

自動ブックマークモード種別

列挙値
AITalk_Core_Tts_AutoBookmarkModeId_None	無効
AITalk_Core_Tts_AutoBookmarkModeId_Sentence	文単位
AITalk_Core_Tts_AutoBookmarkModeId_HighLight	ハイライト単位

AITalk_Core_Tts_MergeProsodyLevelEnum

enum AITalk_Core_Tts_MergeProsodyLevelEnum

韻律交換・韻律混合の混合レベル

列挙値
AITalk_Core_Tts_MergeProsodyLevel_1	混合レベル 1 すべての韻律は差し替えず、ピッチなどはベースの話者のままにします。 たとえば、男性話者をベースに女性話者の韻律を混ぜたときに、ピッチは男性話者のものになります。
AITalk_Core_Tts_MergeProsodyLevel_2	混合レベル 2 すべての韻律を差し替えます。

AITalk_Core_TtsIdEnum

enum AITalk_Core_TtsIdEnum

Tts クラスのメンバー種別

列挙値
AITalk_Core_TtsId_LanguageDictionary	言語辞書
AITalk_Core_TtsId_VoiceDictionary	音声辞書
AITalk_Core_TtsId_VoiceDictionaryLicense	音声辞書ライセンスのパス
AITalk_Core_TtsId_TtsParameter	TtsParameter クラス
AITalk_Core_TtsId_InputEncoding	入力文のエンコード
AITalk_Core_TtsId_TypeOfInput	入力文のテキスト種別 (通常の日本語文・AI 中間言語など)
AITalk_Core_TtsId_TagTokenBegin	開始タグ
AITalk_Core_TtsId_TagTokenEnd	終了タグ
AITalk_Core_TtsId_AutoBookmarkMode	自動ブックマークモード
AITalk_Core_TtsId_AutoBookmarkMarkPrefix	自動ブックマークプレフィックス文字列
AITalk_Core_TtsId_BookmarkMarkerMode	ブックマークマーカーの通知モード
AITalk_Core_TtsId_LipsyncMarkerMode	リップシンクマーカーの通知モード
AITalk_Core_TtsId_AccentMarkerMode	アクセント句マーカーの通知モード
AITalk_Core_TtsId_PhraseMarkerMode	フレーズマーカーの通知モード
AITalk_Core_TtsId_PresetSet	話者プリセット
AITalk_Core_TtsId_Uid	ユーザー ID

関数詳解

AITalk_Core_AIKanaContainer_delete()

AITalkReturnCode AITalk_Core_AIKanaContainer_delete

(

AITalk_Core_AIKanaContainer *

ptr

)

AIKanaContainer クラスのインスタンスを削除する

引数

[in]

ptr

AIKanaContainer クラスのインスタンスを指すポインタ。

戻り値

成功すると 0 を返す。失敗するとエラー値を返す。

AITalk_Core_AIKanaContainer_getAIKana()

AITalkReturnCode AITalk_Core_AIKanaContainer_getAIKana	(	AITalk_Core_AIKanaContainer *	ptr,
		const char **	text,
		size_t *const	size
	)

AI かなをテキスト形式で取得する

引数

[in]	ptr	AIKanaContainer クラスのインスタンスを指すポインタ。
[out]	text	テキスト形式の AI かな
[out]	size	AI かな (text) のバイト数

戻り値

成功すると 0 を返す。失敗するとエラー値を返す。

AITalk_Core_Tts_copy()

AITalkReturnCode AITalk_Core_Tts_copy	(	AITalk_Core_Tts *	dst_ptr,
		AITalk_Core_Tts *	src_ptr
	)

Tts クラスのインスタンスをコピーする。

引数

[in]	dst_ptr	コピー先の Tts クラスのインスタンスを指すポインタ。
[in]	src_ptr	コピー元の Tts クラスのインスタンスを指すポインタ。

戻り値

成功すると 0 を返す。失敗するとエラー値を返す。

AITalk_Core_Tts_delete()

AITalkReturnCode AITalk_Core_Tts_delete

(

AITalk_Core_Tts *

ptr

)

Tts クラスのインスタンスを削除する。

引数

[in]

ptr

Tts クラスのインスタンスを指すポインタ。

戻り値

成功すると 0 を返す。失敗するとエラー値を返す。

AITalk_Core_Tts_deleteKey()

AITalkReturnCode AITalk_Core_Tts_deleteKey	(	AITalk_Core_Tts *	ptr,
		const AITalk_Core_TtsId	id,
		const char *	key
	)

TTS クラスのキーの登録を削除する

引数

[in]	ptr	TTS クラスのインスタンスを指すポインタ
[in]	id	TTS クラスのメンバー種別。指定可能な種別は AITalk_Core_TtsId を参照
[in]	key	登録から削除するリソースのキー

戻り値

成功すると 0 を返す。失敗するとエラー値を返す。

AITalk_Core_Tts_duplicate()

AITalkReturnCode AITalk_Core_Tts_duplicate	(	AITalk_Core_Tts **	ptrptr,
		AITalk_Core_Tts *	ptr
	)

Tts クラスのインスタンスを複製する。

引数

[in]	ptrptr	複製する Tts クラスのインスタンスを指すポインタ。失敗時は nullptr。
[in]	ptr	複製元となる Tts クラスのインスタンスを指すポインタ。

戻り値

成功すると 0 を返す。失敗するとエラー値を返す。

AITalk_Core_Tts_generateAIKanaContainer()

AITalkReturnCode AITalk_Core_Tts_generateAIKanaContainer	(	AITalk_Core_Tts *	ptr,
		AITalk_Core_AIKanaContainer **	ptrptr,
		const char *	text,
		AITalk_TextEncodingsId	encoding
	)

テキスト形式の通常文を AI かなに変換する。

引数

[out]	ptrptr	AIKanaContainer クラスのインスタンスを指すポインタ。失敗時は nullptr。
[in]	ptr	Tts クラスのインスタンスを指すポインタ。
[in]	text	AI かなに変換したい通常文。
[in]	encoding	文字エンコーディング種別。 入力する通常文・出力される AI かなの両方とも同じ文字エンコーディングになります。

戻り値

成功すると 0 を返す。失敗するとエラー値を返す。

AITalk_Core_Tts_generateMergedVoiceDictionary()

AITalkReturnCode AITalk_Core_Tts_generateMergedVoiceDictionary	(	AITalk_Core_Tts *	ptr,
		const char *	new_key,
		const char *	base_key,
		const char *	additional_key,
		AITalk_Core_Tts_MergeProsodyLevel	level
	)

韻律交換した音声辞書を作成する。

「従来型波形接続音声合成」の音声辞書のみ対応しています。

引数

[in]	ptr	Tts クラスのインスタンスを指すポインタ。
[in]	new_key	新しく作成されるキー
[in]	base_key	ベースの音声辞書を示すキー
[in]	additional_key	韻律を混ぜる音声辞書のキー
[in]	level	混合レベル

戻り値

成功すると 0 を返す。失敗するとエラー値を返す。

AITalk_Core_Tts_getDefaultKey()

AITalkReturnCode AITalk_Core_Tts_getDefaultKey	(	AITalk_Core_Tts *	ptr,
		const AITalk_Core_TtsId	id,
		const char **	key
	)

TTS クラスのデフォルト値のキーを取得する

引数

[in]	ptr	TTS クラスのインスタンスを指すポインタ
[in]	id	TTS クラスのメンバー種別。指定可能な種別は AITalk_Core_TtsId を参照
[out]	key	取得したキー

戻り値

キーを取得できた場合 AITalkReturnCode_Ok を返す。 1 つもキーが登録されていない場合 AITalkReturnCode_NotInitializedError を返す。

AITalk_Core_Tts_getKeyList()

AITalkReturnCode AITalk_Core_Tts_getKeyList	(	AITalk_Core_Tts *	ptr,
		const AITalk_Core_TtsId	id,
		const char *const **	keyList,
		size_t *	size
	)

Tts クラスのインスタンスから値を取得する。

引数

[in]	ptr	Tts クラスのインスタンスを指すポインタ
[in]	id	Tts クラスのメンバー種別。指定可能な種別は AITalk_Core_TtsId を参照
[out]	keyList	キー一覧
[out]	size	キー配列の長さ

戻り値

成功すると 0 を返す。失敗するとエラー値を返す。

AITalk_Core_Tts_getKeyValue()

AITalkReturnCode AITalk_Core_Tts_getKeyValue	(	AITalk_Core_Tts *	ptr,
		const AITalk_Core_TtsId	id,
		const char *	key,
		AITalkMixedType *	value
	)

Tts クラスのインスタンスから値を取得する。

キーを必要としない設定種別でこの関数を利用すると key は無視される。

引数

[in]	ptr	Tts クラスのインスタンスを指すポインタ
[in]	id	Tts クラスのメンバー種別。指定可能な種別は AITalk_Core_TtsId を参照
[in]	key	読み込み後に値を指定するためのキー
[out]	value	取得した値 インスタンスの値を取得するには、事前に Foo_new() を実行して得たポインタを渡す必要があります。

戻り値

成功すると 0 を返す。失敗するとエラー値を返す。

AITalk_Core_Tts_hasKey()

AITalkReturnCode AITalk_Core_Tts_hasKey	(	AITalk_Core_Tts *	ptr,
		const AITalk_Core_TtsId	id,
		const char *	key
	)

TTS クラスのキーの登録有無を確認する

引数

[in]	ptr	TTS クラスのインスタンスを指すポインタ
[in]	id	TTS クラスのメンバー種別。指定可能な種別は AITalk_Core_TtsId を参照
[in]	key	登録有無を確認するキー

戻り値

キーの登録を確認した場合 0 を返す。見つからなかった場合エラー値を返す。

AITalk_Core_Tts_isBusy()

AITalkReturnCode AITalk_Core_Tts_isBusy

(

AITalk_Core_Tts *

ptr

)

Tts クラスのインスタンスのリソースが利用されているか確認する。

引数

[in]

ptr

Tts クラスのインスタンスを指すポインタ

戻り値

利用中でない場合は AITalkReturnCode_Ok を返す。 利用中の場合は AITalkReturnCode_ResourceIsBusyError を返す。

AITalk_Core_Tts_new()

AITalkReturnCode AITalk_Core_Tts_new

(

AITalk_Core_Tts **

ptrptr

)

Tts クラスのインスタンスを生成する。

引数

[out]

ptrptr

Tts クラスのインスタンスを指すポインタ。失敗時は nullptr。

戻り値

成功すると 0 を返す。失敗するとエラー値を返す。

AITalk_Core_Tts_putKeyValue()

AITalkReturnCode AITalk_Core_Tts_putKeyValue	(	AITalk_Core_Tts *	ptr,
		const AITalk_Core_TtsId	id,
		const char *	key,
		const AITalkMixedType	value
	)

Tts クラスのインスタンスに値を設定する。

キーを必要としない設定種別でこの関数を利用すると key は無視される。 言語辞書・音声辞書・コールバック関数の設定は必須。

引数

[in]	ptr	Tts クラスのインスタンスを指すポインタ。
[in]	id	Tts クラスのメンバー種別。指定可能な種別は AITalk_Core_TtsId を参照
[in]	key	読み込み後に値を指定するためのキー
[in]	value	設定する値

戻り値

成功すると 0 を返す。失敗するとエラー値を返す。

AITalk_Core_Tts_run()

AITalkReturnCode AITalk_Core_Tts_run	(	AITalk_Core_Tts *	ptr,
		const char *	input,
		AITalk_Core_TtsOutCallback	callback,
		void *	user_data
	)

Tts クラスのインスタンスで音声合成処理を開始する。

引数

[in]	ptr	Tts クラスのインスタンスを指すポインタ
[in]	input	合成文言
[in]	callback	合成結果取得用コールバック関数
[in]	user_data	コールバック関数の第 1 引数として渡される任意データ

戻り値

成功すれば 0 を返す。失敗するとエラー値を返す。

AITalk_Core_Tts_selectDefaultKey()

AITalkReturnCode AITalk_Core_Tts_selectDefaultKey	(	AITalk_Core_Tts *	ptr,
		const AITalk_Core_TtsId	id,
		const char *	key
	)

TTS クラスのデフォルト値をキーで指定する

引数

[in]	ptr	TTS クラスのインスタンスを指すポインタ
[in]	id	TTS クラスのメンバー種別。指定可能な種別は AITalk_Core_TtsId を参照
[in]	key	設定するキー

戻り値

キーが指定できた場合 AITalkReturnCode_Ok を返す。 キーが見つからなかった場合 AITalkReturnCode_KeyNotFoundError を返す。