{                                                           \
    criAtomEx_SetDefaultConfig(&(p_config)->atom_ex);       \
    criAtomExAsr_SetDefaultConfig(&(p_config)->asr);        \
    criAtomExHcaMx_SetDefaultConfig(&(p_config)->hca_mx);   \
}

ライブラリ初期化用コンフィグ構造体にデフォルト値をセット

引数:

[out]

p_config

初期化用コンフィグ構造体へのポインタ

説明:

criAtomEx_InitializeForUserPcmOutput 関数に設定するコンフィグ構造体 （ CriAtomExConfigForUserPcmOutput ）に、デフォルトの値をセットします。

参照:

CriAtomExConfigForUserPcmOutput

バーチャルボイス数の設定可能上限

説明:

バーチャルボイスの設定可能上限値です。 CriAtomExConfig::max_virtual_voices の値は、この値以下に設定する必要があります。

参照:

CriAtomExConfig

ユーザアロケータの登録

引数:

[in]	p_malloc_func	メモリ確保関数
[in]	p_free_func	メモリ解放関数
[in]	p_obj	ユーザ指定オブジェクト

説明:

CRI Atom ライブラリにメモリアロケータ（メモリの確保／解放関数）を登録します。
本マクロでアロケータを登録すると、Atomライブラリがワーク領域を必要とするタイミングで、 ユーザが登録したメモリ確保／解放処理が呼び出されることになります。
その結果、ワーク領域を必要とする関数（ criAtomExPlayer_Create 関数等）に対し、 個別にワーク領域をセットする処理を省略することが可能になります。
（ワーク領域に NULL ポインタ、ワーク領域サイズに 0 バイトを指定した場合でも、 アロケータからの動的メモリ確保によりライブラリが問題なく動作するようになります。）

注意:

メモリ確保／解放関数のポインタに NULL を指定することで、 アロケータの登録を解除することも可能です。
ただし、未解放のメモリ領域が残っている状態で登録を解除すると、 エラーコールバックが返され、登録の解除に失敗します。
（引き続き登録済みのアロケータが呼び出されることになります。）

本マクロは内部的に criAtom_SetUserAllocator マクロや criAtom_SetUserMallocFunction 関数、 criAtom_SetUserFreeFunction 関数を呼び出します。
本関数とこれらの API を併用しないようご注意ください。
（本関数の呼び出しにより、上記 API にセットした内容が上書きされます。）

また、登録されたメモリアロケータ関数はマルスレッドモード時に複数のスレッドからコール されることがあります。従って、メモリアロケート処理がスレッドセーフでない場合は独自に メモリアロケート処理を排他制御する必要があります。

{\
    (p_config)->thread_model = CRIATOMEX_THREAD_MODEL_MULTI;\
    (p_config)->server_frequency = 60.0f;\
    (p_config)->parameter_update_interval = 1;\
    (p_config)->enable_atom_sound_disabled_mode = CRI_FALSE;\
    (p_config)->max_virtual_voices = 16;\
    (p_config)->max_parameter_blocks = 1024;\
    (p_config)->max_voice_limit_groups = 16;\
    (p_config)->max_categories = 16;\
    (p_config)->max_aisacs = 8;\
    (p_config)->categories_per_playback = 4;\
    (p_config)->max_sequences = (p_config)->max_virtual_voices;\
    (p_config)->max_tracks = (p_config)->max_virtual_voices * 2;\
    (p_config)->max_track_items = (p_config)->max_virtual_voices * 2;\
    (p_config)->max_aisac_auto_modulations = 0;\
    (p_config)->max_pitch = 2400.0f;\
    (p_config)->max_faders = 4;\
    (p_config)->coordinate_system = CRIATOMEX_COORDINATE_SYSTEM_LEFT_HANDED;\
    (p_config)->rng_if = NULL;\
    (p_config)->fs_config = NULL;\
    (p_config)->acf_info = NULL;\
    (p_config)->context = NULL;\
    (p_config)->version = CRI_ATOM_VERSION;\
    (p_config)->version_ex = CRIATOMEX_VERSION;\
}

ライブラリ初期化用コンフィグ構造体にデフォルト値をセット

引数:

[out]

p_config

初期化用コンフィグ構造体へのポインタ

説明:

criAtomEx_Initialize 関数に設定するコンフィグ構造体（ CriAtomExConfig ）に、 デフォルトの値をセットします。

参照:

CriAtomExConfig

パフォーマンスモニタ機能の追加

説明:

パフォーマンス計測機能を追加し、パフォーマンス計測処理を開始します。
本関数を実行後、 criAtomEx_GetPerformanceInfo 関数を実行することで、 サーバ処理の負荷や、サーバ処理の実行間隔等、ライブラリのパフォーマンス情報を 取得することが可能です。

参照:

criAtomEx_GetPerformanceInfo, criAtomEx_DetachPerformanceMonitor

例:

    // パフォーマンス情報取得用構造体
    CriAtomExPerformanceInfo info;

    // ライブラリの初期化
    criAtomEx_Initialize(…);

    // パフォーマンスモニタ機能の追加
    criAtomEx_AttachPerformanceMonitor();

    // パフォーマンスモニタのリセット
    criAtomEx_ResetPerformanceMonitor();

    // パフォーマンス計測区間
    …

    // パフォーマンス情報の取得
    criAtomEx_GetPerformanceInfo(&info);

    // 計測結果の表示
    printf(
        "Max CPU Load            : %d (us)\n"   \
        "Average CPU Load        : %d (us)\n"   \
        "Max Server Interval     : %d (us)\n"   \
        "Average Server Interval : %d (us)\n",
        info.max_server_time, info.average_server_time,
        info.max_server_interval, info.average_server_interval
    );

パフォーマンスモニタ機能の削除

説明:

パフォーマンス計測処理を終了し、パフォーマンス計測機能を削除します。

注意:

本関数は完了復帰型の関数です。
本関数を実行すると、しばらくの間Atomライブラリのサーバ処理がブロックされます。
音声再生中に本関数を実行すると、音途切れ等の不具合が発生する可能性があるため、 本関数の呼び出しはシーンの切り替わり等、負荷変動を許容できるタイミングで行ってください。

パフォーマンスモニタのリセット

説明:

現在までの計測結果を破棄します。
パフォーマンスモニタは、 criAtomEx_AttachPerformanceMonitor 関数実行直後 からパフォーマンス情報の取得を開始し、計測結果を累積します。
以前の計測結果を以降の計測結果に含めたくない場合には、 本関数を実行し、累積された計測結果を一旦破棄する必要があります。

パフォーマンス情報の取得

説明:

パフォーマンス情報を取得します。
本関数は、 criAtomEx_AttachPerformanceMonitor 関数実行後から criAtomEx_DetachPerformanceMonitor 関数を実行するまでの間、利用可能です。

参照:

criAtomEx_AttachPerformanceMonitor, criAtomEx_DetachPerformanceMonitor

チャンネルマッピングパターンの指定

引数:

[in]	nch	マッピングパターンを変更するチャンネル数
[in]	type	マッピングパターン

説明:

音声データの各チャンネルと出力スピーカーの対応付けを変更します。
例えば、5ch音声データを再生した場合、デフォルト状態では各チャンネルが L, R, C, Ls, Rs の順で出力されます。
これに対し、::criAtomEx_SetChannelMapping(5, 1); を実行した場合、 5ch音声データの各チャンネルが L, R, LFE, Ls, Rs の順で出力されるようになります。

備考:

現状、本関数は5ch音声データのマッピングパターン変更にしか対応していません。

ADXデータのビットレート計算

引数:

[in]	num_channels	データのチャンネル数
[in]	sampling_rate	データのサンプリングレート

戻り値:

CriSint32 ビットレート[bps]

説明:

ADXデータのビットレートを計算します。
計算に失敗すると本関数は-1を返します。
計算に失敗した理由については、エラーコールバックのメッセージで確認可能です。

HCAデータのビットレート計算

引数:

[in]	num_channels	データのチャンネル数
[in]	sampling_rate	データのサンプリングレート
[in]	quality	データのエンコード品質

戻り値:

CriSint32 ビットレート[bps]

説明:

HCAデータのビットレートを計算します。
計算に失敗すると本関数は-1を返します。
計算に失敗した理由については、エラーコールバックのメッセージで確認可能です。

備考:

qualityにはCRI Atom CraftまたはCRI Atom Encoderで設定したエンコード品質を指定します。

HCA-MXデータのビットレート計算

引数:

[in]	num_channels	データのチャンネル数
[in]	sampling_rate	データのサンプリングレート
[in]	quality	データのエンコード品質

戻り値:

CriSint32 ビットレート[bps]

説明:

HCA-MXデータのビットレートを計算します。
計算に失敗すると本関数は-1を返します。
計算に失敗した理由については、エラーコールバックのメッセージで確認可能です。

備考:

qualityにはCRI Atom CraftまたはCRI Atom Encoderで設定したエンコード品質を指定します。

Waveデータのビットレート計算

引数:

[in]	num_channels	データのチャンネル数
[in]	sampling_rate	データのサンプリングレート
[in]	num_bits	サンプル当たりのビット数

戻り値:

CriSint32 ビットレート[bps]

説明:

Waveデータのビットレートを計算します。
計算に失敗すると本関数は-1を返します。
計算に失敗した理由については、エラーコールバックのメッセージで確認可能です。

AIFFデータのビットレート計算

引数:

[in]	num_channels	データのチャンネル数
[in]	sampling_rate	データのサンプリングレート
[in]	num_bits	サンプル当たりのビット数

戻り値:

CriSint32 ビットレート[bps]

説明:

AIFFデータのビットレートを計算します。
計算に失敗すると本関数は-1を返します。
計算に失敗した理由については、エラーコールバックのメッセージで確認可能です。

ストリーミング情報の取得

引数:

[out]

streaming_info

ストリーミング情報保存先のポインタ

戻り値:

CRI_TRUE	値を取得できた
CRI_FALSE	値を取得できなかった

説明:

CRI Atomライブラリのストリーミング管理モジュールからストリーミング情報を取得します。
本関数は、呼び出された時点のストリーミング情報を streaming_info に保存します。

注意:

Atomサーバ内の処理と一部排他制御しているため、 優先度逆転によりAtomサーバを止めてしまわないように注意してください。
一部のプラットフォームでは、ストリーミング情報を取得できません。
本関数の戻り値を確認してください。
エラーが原因でストリーミング情報を取得できなかった場合については、
エラーコールバックが発生していないかを確認してください。

参照:

CriExAtomStreamingInfo

ファイルI/Oの空き時間を使ったストリーミング読み込みを行うかどうか

引数:

[in]

flag

CRI_TRUE=ファイルI/Oの空き時間を使って読み込む

戻り値:

CRI_TRUE	正常に処理が完了
CRI_FALSE	エラーが発生

説明:

CRI Atomライブラリのストリーミング管理モジュールに対して、
ファイルI/Oの空き時間を使ってストリーミング読み込みを行うかどうかを設定します。
CRI_TRUEを設定すると、CRI Atomライブラリのストリーミング管理モジュールは ファイルI/Oの空き時間を使って、空きバッファに対してデータを余分に読み込みます。
CRI_FALSEを設定すると、CRI Atomライブラリのストリーミング管理モジュールは ファイルI/Oの空き時間を使わなくなり、余分なストリーミング読み込みを行わなくなります。
デフォルトではCRI_TRUEを設定した状態です。

備考：

ファイルI/Oの空き時間を使い、空きバッファに対してデータを余分に読み込んでおくことで、 シークの発生頻度を減らす事ができ、総合的なファイルI/Oの効率が向上します。
一方、通常ファイルのロード処理は、ストリーミングの読み込みよりも優先度が低いため、 空きバッファが大きすぎると通常ファイルのロード処理を大幅に遅延させてしまいます。

注意:

Atomサーバ内の処理と一部排他制御しているため、 優先度逆転によりAtomサーバを止めてしまわないように注意してください。

メモリ確保関数

説明:

アロケータ登録時に使用するメモリ確保関数の型です。

参照:

criAtomEx_SetUserAllocator

メモリ解放関数

説明:

アロケータ登録時に使用するメモリ解放関数の型です。

参照:

criAtomEx_SetUserAllocator

スレッドモデル

説明:

Atomライブラリがどのようなスレッドモデルで動作するかを表します。
ライブラリ初期化時（ criAtomEx_Initialize 関数 ）に CriAtomExConfig 構造体にて指定します。

参照:

criAtomEx_Initialize, CriAtomExConfig

座標系

説明:

Atomライブラリが3Dポジション計算を行う際、どの座標系を使用するかを表します。
ライブラリ初期化時（ criAtomEx_Initialize 関数 ）に CriAtomExConfig 構造体にて指定します。

参照:

criAtomEx_Initialize, CriAtomExConfig

ACF指定タイプ

説明:

Atomライブラリの初期化処理内でACF登録を行う際の、ACF情報の指定タイプを表します。
ライブラリ初期化時（ criAtomEx_Initialize 関数 ）に CriAtomExConfig 構造体の ::CriAtomExAcfRegistrationInfoにて指定します。

参照:

criAtomEx_Initialize, CriAtomExConfig, CriAtomExAcfRegistrationInfo

ACF位置情報

説明:

Atomライブラリの初期化処理内でACF登録を行う際の、ACFデータの指定情報です。
ライブラリ初期化時（ criAtomEx_Initialize 関数 ）に CriAtomExConfig 構造体のacf_infoメンバに設定します。

備考

データ指定のタイプによって、設定すべき情報が異なります。
適切なtypeを設定し、共用体infoの中の対応構造体に設定を行ってください。

 CriAtomExConfig config;
 CriAtomExAcfLocationInfo acf_info;

 criAtomEx_SetDefaultConfig(&config);

 acf_info.type = CRIATOMEX_ACF_LOCATION_INFO_TYPE_NAME;
 acf_info.name.binder = NULL;
 acf_info.name.path = "sounddata/project.scf";

 config.acf_info = &acf_info;

 criAtomEx_Initialize(&config);

参照:

criAtomEx_Initialize, CriAtomExConfig

Atomライブラリ初期化用コンフィグ構造体CRI Atomライブラリの動作仕様を指定するための構造体です。
criAtomEx_Initialize 関数の引数に指定します。

CRI Atomライブラリは、初期化時に本構造体で指定された設定に応じて、内部リソースを 必要なだけ確保します。
ライブラリが必要とするワーク領域のサイズは、本構造体で指定されたパラメータに応じて 変化します。

備考:

デフォルト設定を使用する場合、 criAtomEx_SetDefaultConfig マクロで構造体にデフォルト パラメータをセットした後、 criAtomEx_Initialize 関数に構造体を指定してください。

注意:

将来的にメンバが増える可能性があるため、 criAtomEx_SetDefaultConfig マクロを使用しない 場合には、使用前に必ず構造体をゼロクリアしてください。
（構造体のメンバに不定値が入らないようご注意ください。）

参照:

criAtomEx_Initialize, criAtomEx_SetDefaultConfig

パフォーマンス情報

説明:

パフォーマンス情報を取得するための構造体です。
criAtomEx_GetPerformanceInfo 関数で利用します。

参照:

criAtomEx_GetPerformanceInfo

波形データID

説明:

波形データIDは、ユーザがオーサリングツール上でAWBコンテンツに対して割り当てた一意のIDです。
波形データIDをプログラム中で保持する際には、本変数型を用いて値を取り扱う必要があります。

参照:

criAtomExPlayer_SetWaveId

振動ID

説明:

振動IDをプログラム中で保持する際には、本変数型を用いて値を取り扱う必要があります。

フォーマット種別

説明:

AtomExプレーヤで再生する音声のフォーマットを指定するためのデータ型です。
criAtomExPlayer_SetFormat 関数で利用します。

参照:

criAtomExPlayer_SetFormat

音声データフォーマット情報

説明:

音声データのフォーマット情報です。

備考:

メモリ上に配置された音声データについては、 criAtomEx_AnalyzeAudioHeader 関数を実行することで音声データのフォーマット情報を取得可能です。
再生中の音声データのフォーマットについては criAtomExPlayback_GetFormatInfo 関数で取得可能です。

参照:

criAtomEx_AnalyzeAudioHeader, criAtomExPlayback_GetFormatInfo

ポーズ解除対象

説明:

ポーズを解除する対象を指定するためのデータ型です。
criAtomExPlayer_Resume 関数、および criAtomExPlayback_Resume 関数の引数として使用します。

参照:

criAtomExPlayer_Resume, criAtomExPlayback_Resume

バイクアッドフィルタのタイプ

説明:

バイクアッドフィルタのタイプを指定するためのデータ型です。
criAtomExPlayer_SetBiquadFilterParameters 関数で利用します。

参照:

criAtomExPlayer_SetBiquadFilterParameters

無音時処理モード

説明:

無音時処理モードを指定するためのデータ型です。
criAtomExPlayer_SetSilentMode 関数で利用します。
無音となったかどうかは、以下のいずれかが値が0になったかどうかで判断します。

• ボリューム
• 3Dパンニングの演算結果によるボリューム
• 3Dポジショニングの演算結果によるボリューム

注意:

センドレベルや2Dパンの設定値では無音と判断されない点にご注意ください。

参照:

criAtomExPlayer_SetSilentMode

パンタイプ

説明:

どのようにして定位計算を行うかを指定するためのデータ型です。
criAtomExPlayer_SetPanType 関数で利用します。

参照:

criAtomExPlayer_SetPanType

パンニング時の出力スピーカータイプ

説明:

定位計算を行う際、出力としてどのスピーカーを使用するかを表します。
criAtomExPlayer_ChangeDefaultPanSpeakerType 関数、::criAtomExPlayer_SetPanSpeakerType 関数で利用します。

備考:

ステレオスピーカーのプラットフォームでは、どれを選んだとしても最終的にはステレオにダウンミックスされます。

参照:

criAtomExPlayer_SetPanSpeakerType

パンニング時の角度タイプ

説明:

マルチチャンネル素材の定位計算を行う際、各入力チャンネルをどのような角度として扱うかを表します。
criAtomExPlayer_SetPanAngleType 関数で利用します。

参照:

criAtomExPlayer_SetPanAngleType

出力スピーカーの並び順

説明:

各チャンネルの添字と出力スピーカーの対応関係を表します。
criAtomEx_SetSpeakerAngleArray 関数で利用します。

参照:

criAtomEx_SetSpeakerAngleArray CRIATOMEX_SPEAKER_SYSTEM_SURROUND_5_1 CRIATOMEX_SPEAKER_SYSTEM_SURROUND_7_1

ブロックインデックス

説明:

ブロックインデックスは、ブロックシーケンス内のブロックのオフセットを示す番号です。
（先頭のブロックが0番、その次のブロックが1番…というふうに、ブロックに 順番に割り当てられる番号です。）
ブロックインデックスをプログラム中で保持する際には、本変数型を用いて値を取り扱う必要があります。

参照:

criAtomExPlayer_SetFirstBlockIndex, criAtomExPlayback_SetNextBlockIndex, criAtomExPlayback_GetCurrentBlockIndex

ゲーム変数ID

説明:

ゲーム変数IDは、ユーザがオーサリングツール上で ACF 内のゲーム変数に対して割り当てたIDです。
ゲーム変数IDをプログラム中で保持する際には、本変数型を用いて値を取り扱う必要があります。

参照:

criAtomEx_GetGameVariableById, criAtomEx_SetGameVariableById

ゲーム変数情報取得用構造体

説明:

ゲーム変数情報を取得するための構造体です。
CriAtomExGameVariableInfo 関数に引数として渡します。

参照:

criAtomEx_GetGameVariableInfo

ストリーミング情報

説明:

criAtomEx_GetStreamingInfo 関数で取得した時点でのストリーミングの状況です。

参照:

criAtomEx_GetStreamingInfo

文字コード

説明:

文字コード（文字符号化方式）を表します。

各種リソースの使用状況

説明:

各種リソースの使用状況を表わす構造体です。

プレーヤコールバック関数型

引数:

[in]	obj	ユーザ指定オブジェクト
[in]	player	AtomExプレーヤ

説明:

プレーヤの列挙に使用する、コールバック関数の型です。
criAtomExPlayer_EnumeratePlayers 関数に本関数型のコールバック関数を登録することで、 アプリケーション中で作成したプレーヤをコールバックで受け取ることが可能となります。

注意:

引数で渡されたAtomExプレーヤを破棄してはいけません。
（アクセス違反やハングアップ等の重篤な不具合が発生する恐れがあります。）

本コールバック関数内で長時間処理をブロックすると、音切れ等の問題が発生しますので、 ご注意ください。

参照:

criAtomExPlayer_EnumeratePlayers

ボイスイベント

説明:

ボイスイベントの種別を示す値です。
ボイスイベントコールバックに引数として渡されます。

参照:

CriAtomExVoiceEventCbFunc, criAtomEx_SetVoiceEventCallback

ボイスの詳細情報

説明:

ボイスイベント発生時のボイスの詳細情報を保持した構造体です。
ボイスイベントコールバックに引数として渡されます。

参照:

CriAtomExVoiceEventCbFunc, criAtomEx_SetVoiceEventCallback

ボイスイベントコールバック関数型

引数:

[in]	obj	ユーザ指定オブジェクト
[in]	voice_event	発生イベント
[in]	request	発音要求の詳細情報
[in]	removed	停止ボイスの詳細情報
[in]	removed_in_group	グループ内停止ボイスの詳細情報

説明:

ボイスイベントの通知に使用される、コールバック関数の型です。
criAtomEx_SetVoiceEventCallback 関数に本関数型のコールバック関数を登録することで、 ボイスイベント発生時にコールバックを受け取ることが可能となります。

コールバック関数の第3〜5引数（request、removed、removed_in_group）に入る値は、 ボイスイベントの種別（第2引数のvoice_eventの値）により以下のように変わります。

(1) CRIATOMEX_VOICE_EVENT_ALLOCATE時
第3引数requestに、ボイスを取得した発音リクエストの情報が入ります。
第4引数、第5引数にはNULLが入ります。

(2) CRIATOMEX_VOICE_EVENT_ALLOCATE_AND_REMOVE時
第3引数requestに、ボイスを取得した発音リクエストの情報が入ります。
第4引数removedには、ボイスを奪い取られ、発音が停止した再生の情報が入ります。
第5引数にはNULLが入ります。

(3) CRIATOMEX_VOICE_EVENT_ALLOCATE_AND_REMOVE_IN_GROUP時
第3引数requestに、ボイスを取得した発音リクエストの情報が入ります。
第4引数にはNULLが入ります。
第5引数removed_in_groupには、ボイスを奪い取られ、発音が停止した再生の情報が入ります。

(4) CRIATOMEX_VOICE_EVENT_ALOOCATE_AND_REMOVE_TWO時
第3引数requestに、ボイスを取得した発音リクエストの情報が入ります。
第4引数removedには、ボイスを奪い取られ、発音が停止した再生の情報が入ります。
第5引数removed_in_groupには、グループ内の発音数調整により、停止された再生の情報が入ります。

(5) CRIATOMEX_VOICE_EVENT_REJECT時
第3引数requestに、ボイスの取得が棄却された発音リクエストの情報が入ります。
第4引数、第5引数にはNULLが入ります。

(6) CRIATOMEX_VOICE_EVENT_REJECT_BY_GROUP_LIMIT時
第3引数requestに、ボイスの取得が棄却された発音リクエストの情報が入ります。
第4引数、第5引数にはNULLが入ります。

(7) CRIATOMEX_VOICE_EVENT_REMOVE時
第4引数removedに、再生が終了または停止したボイスの情報が入ります。
第3引数、第5引数にはNULLが入ります。

注意:

本コールバックでは、ボイス単位のリミット制御 （ボイスプライオリティに基づいた波形単位のプライオリティ制御） に関する情報のみが取得可能です。
ボイス取得前にキューリミット制御で発音が棄却された場合、 本コールバックにCRIATOMEX_VOICE_EVENT_REJECT等の情報は返されません。
（カテゴリキュープライオリティによる制御に関する情報は、現状取得できません。）

ボイスイベントコールバック時点では、 request->atom_player には再生すべき音声データがまだセットされていません。
そのため、再生する音声データの情報等については、 atom_player に問い合わせず、 CriAtomExVoiceInfoDetail 構造体のメンバ値を使用してください。

本コールバック関数内で長時間処理をブロックすると、音切れ等の問題が発生しますので、 ご注意ください。

参照:

criAtomEx_SetVoiceEventCallback, CriAtomExVoiceEvent, CriAtomExVoiceInfoDetail

ボイス情報コールバック関数型

引数:

[in]	obj	ユーザ指定オブジェクト
[in]	voice_info	ボイスの詳細情報

説明:

ボイス情報の通知に使用される、コールバック関数の型です。
criAtomEx_EnumerateVoiceInfos 関数に本関数型のコールバック関数を登録することで、 再生中のボイスの情報をコールバックで受け取ることが可能となります。

注意:

本コールバック関数内で長時間処理をブロックすると、音切れ等の問題が発生しますので、 ご注意ください。

参照:

criAtomEx_EnumerateVoiceInfos, CriAtomExVoiceInfoDetail

ボイス停止情報取得用構造体

説明:

ボイス停止情報を取得するための構造体です。
CriAtomExMonitoringVoiceStopCbFunc 関数型の引数として渡されます。

参照:

CriAtomExMonitoringVoiceStopCbFunc

キューリンクコールバック

説明:

引数:

[in]	obj	ユーザ指定オブジェクト
[in]	info	キューリンク情報

戻り値:

未使用 AtomExライブラリのキューリンクコールバック関数型です。
コールバック関数の登録には criAtomEx_SetCueLinkCallback 関数を使用します。
登録したコールバック関数は、ライブラリ内でキューリンクが処理されるタイミングで実行されます。
そのため、ライブラリ処理への割り込みを考慮しないAPIを実行した場合、 エラーが発生したり、デッドロックが発生する可能性があります。
基本的に、コールバック関数内ではAtomライブラリAPIを使用しないでください。
本コールバック関数内で長時間処理をブロックすると、音切れ等の問題が発生しますので、 ご注意ください。

参照:

criAtomEx_SetCueLinkCallback

プレイバックキャンセルタイプ

説明:

プレイバックキャンセルの種別を示す値です。

参照:

CriAtomExPlaybackCancelInfo, criAtomEx_SetPlaybackCancelCallback

プレイバックキャンセルコールバック

説明:

引数:

[in]	obj	ユーザ指定オブジェクト
[in]	info	プレイバックキャンセル情報

戻り値:

未使用 AtomExライブラリのプレイバックキャンセルコールバック関数型です。
コールバック関数の登録には criAtomEx_SetPlaybackCancelCallback 関数を使用します。
登録したコールバック関数は、ライブラリ内で再生開始処理がキャンセルされるタイミングで実行されます。
そのため、ライブラリ処理への割り込みを考慮しないAPIを実行した場合、 エラーが発生したり、デッドロックが発生する可能性があります。
基本的に、コールバック関数内ではAtomライブラリAPIを使用しないでください。
本コールバック関数内で長時間処理をブロックすると、音切れ等の問題が発生しますので、 ご注意ください。

参照:

criAtomEx_SetPlaybackCancelCallback

トラックトランジションバイセレクタコールバック

説明:

引数:

[in]	obj	ユーザ指定オブジェクト
[in]	info	トラックトランジションバイセレクタ情報

戻り値:

未使用 AtomExライブラリのトラックトランジションバイセレクタコールバック関数型です。
コールバック関数の登録には criAtomEx_SetTrackTransitionBySelectorCallback 関数を使用します。
登録したコールバック関数は、ライブラリ内でトランジション処理が開始されるタイミングで実行されます。
そのため、ライブラリ処理への割り込みを考慮しないAPIを実行した場合、 エラーが発生したり、デッドロックが発生する可能性があります。
基本的に、コールバック関数内ではAtomライブラリAPIを使用しないでください。
本コールバック関数内で長時間処理をブロックすると、音切れ等の問題が発生しますので、 ご注意ください。

参照:

criAtomEx_SetTrackTransitionBySelectorCallback

スレッドモデル

説明:

Atomライブラリがどのようなスレッドモデルで動作するかを表します。
ライブラリ初期化時（ criAtomEx_Initialize 関数 ）に CriAtomExConfig 構造体にて指定します。

参照:

criAtomEx_Initialize, CriAtomExConfig

列挙型の値:

CRIATOMEX_THREAD_MODEL_MULTI	マルチスレッド 説明: ライブラリは内部でスレッドを作成し、マルチスレッドにて動作します。 スレッドは criAtomEx_Initialize 関数呼び出し時に作成されます。 ライブラリのサーバ処理は、作成されたスレッド上で定期的に実行されます。
CRIATOMEX_THREAD_MODEL_MULTI_USER_DRIVEN	マルチスレッド（ユーザ駆動式） 説明: ライブラリは内部でスレッドを作成し、マルチスレッドにて動作します。 スレッドは criAtomEx_Initialize 関数呼び出し時に作成されます。 サーバ処理自体は作成されたスレッド上で実行されますが、 CRIATOMEX_THREAD_MODEL_MULTI とは異なり、自動的には実行されません。 ユーザは criAtomEx_ExecuteMain 関数で明示的にサーバ処理を駆動する必要があります。 （ criAtomEx_ExecuteMain 関数を実行すると、スレッドが起動し、サーバ処理が実行されます。）
CRIATOMEX_THREAD_MODEL_USER_MULTI	ユーザマルチスレッド 説明: ライブラリ内部ではスレッドを作成しませんが、ユーザが独自に作成したスレッド からサーバ処理関数を呼び出せるよう、内部の排他制御は行います。 サーバ処理は criAtomEx_ExecuteMain 関数内で同期実行されます。
CRIATOMEX_THREAD_MODEL_SINGLE	シングルスレッド 説明: ライブラリ内部でスレッドを作成しません。また、内部の排他制御も行いません。 サーバ処理は criAtomEx_ExecuteMain 関数内で同期実行されます。 注意: このモデルを選択した場合、各APIとサーバ処理関数とを同一スレッドから呼び出すようにしてください。

座標系

説明:

Atomライブラリが3Dポジション計算を行う際、どの座標系を使用するかを表します。
ライブラリ初期化時（ criAtomEx_Initialize 関数 ）に CriAtomExConfig 構造体にて指定します。

参照:

criAtomEx_Initialize, CriAtomExConfig

列挙型の値:

CRIATOMEX_COORDINATE_SYSTEM_LEFT_HANDED	左手座標系 説明: xの正方向が右、yの正方向が上、zの正方向が奥となるような、左手デカルト座標系です。
CRIATOMEX_COORDINATE_SYSTEM_RIGHT_HANDED	右手座標系 説明: xの正方向が右、yの正方向が上、zの正方向が手前となるような、右手デカルト座標系です。

ACF指定タイプ

説明:

Atomライブラリの初期化処理内でACF登録を行う際の、ACF情報の指定タイプを表します。
ライブラリ初期化時（ criAtomEx_Initialize 関数 ）に CriAtomExConfig 構造体の ::CriAtomExAcfRegistrationInfoにて指定します。

参照:

criAtomEx_Initialize, CriAtomExConfig, CriAtomExAcfRegistrationInfo

列挙型の値:

CRIATOMEX_ACF_LOCATION_INFO_TYPE_NONE	未設定
CRIATOMEX_ACF_LOCATION_INFO_TYPE_NAME	ファイル名
CRIATOMEX_ACF_LOCATION_INFO_TYPE_ID	コンテンツID
CRIATOMEX_ACF_LOCATION_INFO_TYPE_DATA	オンメモリデータ

ポーズ解除対象

説明:

ポーズを解除する対象を指定するためのデータ型です。
criAtomExPlayer_Resume 関数、および criAtomExPlayback_Resume 関数の引数として使用します。

参照:

criAtomExPlayer_Resume, criAtomExPlayback_Resume

列挙型の値:

CRIATOMEX_RESUME_ALL_PLAYBACK	一時停止方法に関係なく再生を再開
CRIATOMEX_RESUME_PAUSED_PLAYBACK	Pause 関数でポーズをかけた音声のみ再生を再開
CRIATOMEX_RESUME_PREPARED_PLAYBACK	Prepare 関数で再生準備を指示した音声の再生を開始

バイクアッドフィルタのタイプ

説明:

バイクアッドフィルタのタイプを指定するためのデータ型です。
criAtomExPlayer_SetBiquadFilterParameters 関数で利用します。

参照:

criAtomExPlayer_SetBiquadFilterParameters

列挙型の値:

CRIATOMEX_BIQUAD_FILTER_TYPE_OFF	フィルタ無効
CRIATOMEX_BIQUAD_FILTER_TYPE_LOWPASS	ローパスフィルタ
CRIATOMEX_BIQUAD_FILTER_TYPE_HIGHPASS	ハイパスフィルタ
CRIATOMEX_BIQUAD_FILTER_TYPE_NOTCH	ノッチフィルタ
CRIATOMEX_BIQUAD_FILTER_TYPE_LOWSHELF	ローシェルフフィルタ
CRIATOMEX_BIQUAD_FILTER_TYPE_HIGHSHELF	ハイシェルフフィルタ
CRIATOMEX_BIQUAD_FILTER_TYPE_PEAKING	ピーキングフフィルタ

無音時処理モード

説明:

無音時処理モードを指定するためのデータ型です。
criAtomExPlayer_SetSilentMode 関数で利用します。
無音となったかどうかは、以下のいずれかが値が0になったかどうかで判断します。

• ボリューム
• 3Dパンニングの演算結果によるボリューム
• 3Dポジショニングの演算結果によるボリューム

注意:

センドレベルや2Dパンの設定値では無音と判断されない点にご注意ください。

参照:

criAtomExPlayer_SetSilentMode

列挙型の値:

CRIATOMEX_SILENT_MODE_NORMAL	何もしない 説明: 無音となっても特別な処理は行いません。（デフォルト値）
CRIATOMEX_SILENT_MODE_STOP	停止する 説明: 無音となった際は自動的に停止します。
CRIATOMEX_SILENT_MODE_VIRTUAL	バーチャル化する 説明: 無音となった際は自動的にバーチャル化します。
CRIATOMEX_SILENT_MODE_VIRTUAL_RETRIGGER	再発音型でバーチャル化する 説明: 無音となった際は自動的に再発音型でバーチャル化します。

パンタイプ

説明:

どのようにして定位計算を行うかを指定するためのデータ型です。
criAtomExPlayer_SetPanType 関数で利用します。

参照:

criAtomExPlayer_SetPanType

列挙型の値:

CRIATOMEX_PAN_TYPE_PAN3D	パン3D 説明: パン3Dで定位を計算します。
CRIATOMEX_PAN_TYPE_3D_POS	3Dポジショニング 説明: 3Dポジショニングで定位を計算します。
CRIATOMEX_PAN_TYPE_AUTO	自動 説明: AtomExプレーヤに3D音源／3Dリスナーが設定されている場合は3Dポジショニングで、 設定されていない場合はパン3Dで、それぞれ定位を計算します。

パンニング時の出力スピーカータイプ

説明:

定位計算を行う際、出力としてどのスピーカーを使用するかを表します。
criAtomExPlayer_ChangeDefaultPanSpeakerType 関数、::criAtomExPlayer_SetPanSpeakerType 関数で利用します。

備考:

ステレオスピーカーのプラットフォームでは、どれを選んだとしても最終的にはステレオにダウンミックスされます。

参照:

criAtomExPlayer_SetPanSpeakerType

列挙型の値:

CRIATOMEX_PAN_SPEAKER_TYPE_4CH	4chパンニング 説明: L, R, Ls, Rsを使用してパンニングを行います。
CRIATOMEX_PAN_SPEAKER_TYPE_5CH	5chパンニング 説明: L, R, C, Ls, Rsを使用してパンニングを行います。
CRIATOMEX_PAN_SPEAKER_TYPE_6CH	6chパンニング 説明: L, R, Ls, Rs, Lsb, Rsbを使用してパンニングを行います。
CRIATOMEX_PAN_SPEAKER_TYPE_7CH	7chパンニング 説明: L, R, C, Ls, Rs, Lsb, Rsbを使用してパンニングを行います。

パンニング時の角度タイプ

説明:

マルチチャンネル素材の定位計算を行う際、各入力チャンネルをどのような角度として扱うかを表します。
criAtomExPlayer_SetPanAngleType 関数で利用します。

参照:

criAtomExPlayer_SetPanAngleType

列挙型の値:

CRIATOMEX_PAN_ANGLE_TYPE_OFFSET	オフセット 説明: 設定されているパン3D角度を中心として、スピーカーの配置を元にしたオフセット値を各チャンネル毎に加えて、 それぞれの入力チャンネルで個別にパンニング計算を行います。 例えばステレオ素材でパン3D角度を0度と設定した場合、Lチャンネルは-30度となりそのままLスピーカーから出力され、 Rチャンネルは+30度となりそのままRスピーカーから出力されます。 またパン3D角度を+30度と設定した場合、Lチャンネルは0度、Rチャンネルは60度の位置に定位しているものとして、 パンニング計算が行われます。
CRIATOMEX_PAN_ANGLE_TYPE_FIX	固定 説明: 入力チャンネル数に応じて、各チャンネルが該当スピーカー位置に固定して存在しているものとして、 各スピーカー間のバランスを計算するような形でパンニング計算を行います。 例えばステレオ素材でパン3D角度を0度と設定した場合、LチャンネルはLスピーカーから約0.7倍で出力され、 Rチャンネルはスピーカーから約0.7倍で出力されます。 またパン3D角度を+30度と設定した場合、Lチャンネルはまったく出力されず、RチャンネルはRスピーカーからそのまま出力されます。 備考: この挙動はCRI Audioの頃のパン3Dと同等です。 どのスピーカーにどのチャンネルを割り当てるかは、::criAtomExPlayer_SetDrySendLevel 関数で設定するドライセンドレベルでの扱いと同様です。 参照: criAtomExPlayer_SetDrySendLevel
CRIATOMEX_PAN_ANGLE_TYPE_AMBIENCE_MIX	環境音ミックス 説明: 特殊なパン角度タイプです。使用しないでください。
CRIATOMEX_PAN_ANGLE_TYPE_AMBIENCE_STRAIGHT	環境音直線補間 説明: 特殊なパン角度タイプです。使用しないでください。

文字コード

説明:

文字コード（文字符号化方式）を表します。

列挙型の値:

CRIATOMEX_CHARACTER_ENCODING_UTF8	UTF-8
CRIATOMEX_CHARACTER_ENCODING_SJIS	Shift_JIS

ボイスイベント

説明:

ボイスイベントの種別を示す値です。
ボイスイベントコールバックに引数として渡されます。

参照:

CriAtomExVoiceEventCbFunc, criAtomEx_SetVoiceEventCallback

列挙型の値:

CRIATOMEX_VOICE_EVENT_ALLOCATE	ボイスの新規確保 説明: ボイスプールから空きボイスが取得され、新規に発音が開始されたことを示す値です。
CRIATOMEX_VOICE_EVENT_ALLOCATE_AND_REMOVE	ボイスの奪い取り 説明: 再生中のボイスが奪い取られたことを示す値です。 再生中のボイスが1つ停止され、そのボイスが別の音声の再生に再利用されました。 停止される波形データと新規に再生する波形データは、 異なるボイスリミットグループに所属しています。 （どちらか一方、もしくは両方の波形データがボイスリミットグループに所属していない場合も、 ボイスの奪い取り発生時に本イベントが発生します。）
CRIATOMEX_VOICE_EVENT_ALLOCATE_AND_REMOVE_IN_GROUP	グループ内でのボイスの奪い取り 説明: 再生中のボイスが奪い取られたことを示す値です。 再生中のボイスが1つ停止され、そのボイスが別の音声の再生に再利用されました。 CRIATOMEX_VOICE_EVENT_ALLOCATE_AND_REMOVE と異なり、 停止される波形データと新規に再生する波形データとが、 同一のボイスリミットグループに所属する場合に本イベントが発生します。
CRIATOMEX_VOICE_EVENT_ALOOCATE_AND_REMOVE_TWO	ボイスの奪い取りとボイス数の調整 説明: 再生中のボイスが奪い取られ、さらにボイス数の調整が行われたことを示す値です。 2つのボイスが停止され、そのうち1つのボイスが別の音声の再生に再利用されます。 （停止されただけのボイスは、空きボイスとしてボイスプールに戻されます。） 音声データの再生要件を満たすボイスを奪い取った結果、グループ内のボイス数があふれ、 グループ内でボイス数を調整した場合に本イベントが発生します。 備考: このケースは、ボイスリミットグループ上限数分のHCAデータを再生中に、 同一ボイスリミットグループに所属するADXデータを再生した場合等に発生します。 ADXデータを再生するため、グループ外のADXボイスを停止した結果、 HCAデータとADXデータの合計数がボイスリミットグループ上限を超えた場合、 低プライオリティのHCAデータがさらに1つ停止される形になります。 （1つの発音リクエストに対し、2つの音声が停止する形になります。）
CRIATOMEX_VOICE_EVENT_REJECT	発音要求の棄却 説明: 再生しようとした波形データのプライオリティが、 全ボイス中で最も低かった場合（他のボイスを奪い取れなかった場合）に、 本イベントが発生します。
CRIATOMEX_VOICE_EVENT_REJECT_BY_GROUP_LIMIT	グループ内での発音要求の棄却 説明: 再生しようとした波形データのプライオリティが、 所属するグループ内で最も低かった場合（グループ内の他のボイスを奪い取れなかった場合）に、 本イベントが発生します。
CRIATOMEX_VOICE_EVENT_REMOVE	ボイスの停止 説明: 再生完了や再生停止要求により、ボイスが停止された場合に本イベントが発生します。 停止されたボイスは、空きボイスとしてボイスプールに戻されます。

キューリンクコールバックタイプ

列挙型の値:

CRIATOMEX_CUELINK_TYPE_STATIC	静的リンク
CRIATOMEX_CUELINK_TYPE_DYNAMIC	動的リンク

プレイバックキャンセルタイプ

説明:

プレイバックキャンセルの種別を示す値です。

参照:

CriAtomExPlaybackCancelInfo, criAtomEx_SetPlaybackCancelCallback

列挙型の値:

CRIATOMEX_PLAYBACK_CANCEL_TYPE_CUE_LIMIT	キューリミット 説明: キューリミットによる発音キャンセル。
CRIATOMEX_PLAYBACK_CANCEL_TYPE_CATEGORY_CUE_LIMIT	カテゴリキューリミット 説明: カテゴリキューリミットによる発音キャンセル。
CRIATOMEX_PLAYBACK_CANCEL_TYPE_PROBABILITY	プライオリティ 説明: プライオリティによる発音キャンセル。
CRIATOMEX_PLAYBACK_CANCEL_TYPE_STOP_BY_CUE_LIMIT	キューリミット 説明: キューリミットによる発音停止。
CRIATOMEX_PLAYBACK_CANCEL_TYPE_SWITCH	スイッチ 説明: スイッチによる発音キャンセル。

ユーザPCM出力方式用ワーク領域サイズ計算

引数:

[in]

config

初期化用コンフィグ構造体

戻り値:

CriSint32 ワーク領域サイズ

説明:

ユーザPCM出力方式でライブラリを初期化するために必要な、 ワーク領域のサイズを取得します。

備考:

ライブラリが必要とするワーク領域のサイズは、ライブラリ初期化用コンフィグ 構造体（ CriAtomExConfigForUserPcmOutput ）の内容によって変化します。

引数 config の情報は、関数内でのみ参照されます。
関数を抜けた後は参照されませんので、関数実行後に config の領域を解放しても 問題ありません。

注意:

本関数は criAtomEx_InitializeForUserPcmOutput 関数を使用して ライブラリを初期化する場合に使用します。
criAtomEx_Initialize 関数を使用する場合には、本関数ではなく criAtomEx_CalculateWorkSize 関数を使用してワーク領域サイズを計算してください。

参照:

CriAtomExConfigForUserPcmOutput, criAtomEx_InitializeForUserPcmOutput

ユーザPCM出力用ライブラリ初期化

引数:

[in]	config	初期化用コンフィグ構造体
[in]	work	ワーク領域
[in]	work_size	ワーク領域サイズ

説明:

ユーザPCM出力モードでライブラリを初期化します。

本関数を使用して初期化処理を行った場合、Atomライブラリは音声出力を行いません。
ユーザは criAtomExAsr_GetPcmDataFloat32 関数を使用してライブラリから定期的にPCMデータを取得し、 アプリケーション側で音声出力を行う必要があります。

注意:

本関数と以下の関数は併用できません。

• criAtom_Initialize
• criAtomAsr_Initialize
• criAtomHcaMx_Initialize
• criAtom_Initialize_PC

参照:

CriAtomExConfigForUserPcmOutput, criAtomEx_FinalizeForUserPcmOutput, criAtomExAsr_GetPcmDataFloat32, criAtomEx_CalculateWorkSizeForUserPcmOutput

ユーザPCM出力用ライブラリ終了処理

説明:

ユーザPCM出力モードで初期化されたライブラリに対し、終了処理を行います。

注意:

本関数は criAtomEx_InitializeForUserPcmOutput 関数を使用してライブラリを初期化した場合に使用します。
criAtomEx_Initialize 関数を使用した場合には、本関数ではなく criAtomEx_Finalize 関数を使用して終了処理を行ってください。

参照:

criAtomEx_InitializeForUserPcmOutput

ライブラリ初期化用ワーク領域サイズの計算

引数:

[in]

config

初期化用コンフィグ構造体

戻り値:

CriSint32 ワーク領域サイズ

戻り値:

0以上	正常に処理が完了
-1	エラーが発生

説明:

ライブラリを使用するために必要な、ワーク領域のサイズを取得します。

ワーク領域サイズの計算に失敗すると、本関数は -1 を返します。
ワーク領域サイズの計算に失敗した理由については、エラーコールバックのメッセージで確認可能です。

備考:

ライブラリが必要とするワーク領域のサイズは、ライブラリ初期化用コンフィグ 構造体（ CriAtomExConfig ）の内容によって変化します。

引数にNULLを指定した場合、デフォルト設定 （ criAtomEx_SetDefaultConfig 適用時と同じパラメータ）で ワーク領域サイズを計算します。
引数 config の情報は、関数内でのみ参照されます。
関数を抜けた後は参照されませんので、関数実行後に config の領域を解放しても 問題ありません。

注意:

CriAtomExConfig 構造体のacf_infoメンバに値を設定している場合、本関数は失敗し-1を返します。
初期化処理内でACFデータの登録を行う場合は、本関数値を使用したメモリ確保ではなくADX2システムによる メモリアロケータを使用したメモリ確保処理が必要になります。

参照:

CriAtomExConfig, criAtomEx_Initialize

ライブラリの初期化

引数:

[in]	config	初期化用コンフィグ構造体
[in]	work	ワーク領域
[in]	work_size	ワーク領域サイズ

戻り値:

CriBool 初期化できたかどうか？（できた：CRI_TRUE／できない：CRI_FALSE）

説明:

ライブラリを初期化します。
ライブラリの機能を利用するには、必ずこの関数を実行する必要があります。
（ライブラリの機能は、本関数を実行後、 criAtomEx_Finalize 関数を実行するまでの間、 利用可能です。）

ライブラリを初期化する際には、ライブラリが内部で利用するためのメモリ領域（ワーク領域） を確保する必要があります。
ワーク領域を確保する方法には、以下の2通りの方法があります。
(a) User Allocator方式：メモリの確保／解放に、ユーザが用意した関数を使用する方法。
(b) Fixed Memory方式：必要なメモリ領域を直接ライブラリに渡す方法。

CriAtomExConfig 構造体のacf_infoメンバを使用すると初期化処理内でACFデータの登録が行えます。
初期化処理内でのACFデータ登録を行う場合は、User Allocator方式でメモリ領域を確保する必要があります。

User Allocator方式を用いる場合、ユーザはライブラリにメモリ確保関数を登録しておきます。
workにNULL、work_sizeに0を指定して本関数を呼び出すことで、 ライブラリは登録済みのメモリ確保関数を使用して必要なメモリを自動的に確保します。
ユーザがワーク領域を用意する必要はありません。
初期化時に確保されたメモリは、終了処理時（ criAtomEx_Finalize 関数実行時）に解放されます。

Fixed Memory方式を用いる場合、ワーク領域として別途確保済みのメモリ領域を本関数に 設定する必要があります。
ワーク領域のサイズは criAtomEx_CalculateWorkSize 関数で取得可能です。
初期化処理の前に criAtomEx_CalculateWorkSize 関数で取得したサイズ分のメモリを予め 確保しておき、本関数に設定してください。
尚、Fixed Memory方式を用いた場合、ワーク領域はライブラリの終了処理（ criAtomEx_Finalize 関数） を行なうまでの間、ライブラリ内で利用され続けます。
ライブラリの終了処理を行なう前に、ワーク領域のメモリを解放しないでください。

例:

【User Allocator方式によるライブラリの初期化】
User Allocator方式を用いる場合、ライブラリの初期化／終了の手順は以下の以下の通りです。

1. 初期化処理実行前に、 criAtomEx_SetUserAllocator 関数を用いてメモリ確保／解放関数を登録する。
   
2. 初期化用コンフィグ構造体にパラメータをセットする。
   
3. criAtomEx_Initialize 関数で初期化処理を行う。
   （workにはNULL、work_sizeには0を指定する。）
   
4. アプリケーション終了時に criAtomEx_Finalize 関数で終了処理を行なう。
   

具体的なコードは以下のとおりです。

 // 独自のメモリ確保関数
 void *user_malloc(void *obj, CriUint32 size)
 {
    void *mem;

    // メモリの確保
    mem = malloc(size);

    return (mem);
 }

 // 独自のメモリ解放関数を用意
 void user_free(void *obj, void *mem)
 {
    // メモリの解放
    free(mem);

    return;
 }

 main()
 {
    CriAtomExConfig config; // ライブラリ初期化用コンフィグ構造体
        :
    // 独自のメモリアロケータを登録
    criAtomEx_SetUserAllocator(user_malloc, user_free, NULL);

    // ライブラリ初期化用コンフィグ構造体にデフォルト値をセット
    criAtomEx_SetDefaultConfig(&config);

    // ライブラリの初期化
    // ワーク領域にはNULLと0を指定する。
    // →必要なメモリは、登録したメモリ確保関数を使って確保される。
    criAtomEx_Initialize(&config, NULL, 0);
        :
    // アプリケーションのメイン処理
        :
    // アプリケーションを終了する際に終了処理を行う
    // →初期化時に確保されたメモリは、登録したメモリ解放関数を使って解放される。
    criAtomEx_Finalize();
        :
 }

【Fixed Memory方式によるライブラリの初期化】
Fixed Memory方式を用いる場合、ライブラリの初期化／終了の手順は以下の以下の通りです。

1. 初期化用コンフィグ構造体にパラメータをセットする。
   
2. ライブラリの初期化に必要なワーク領域のサイズを、 criAtomEx_CalculateWorkSize 関数を使って計算する。
   
3. ワーク領域サイズ分のメモリを確保する。
   
4. criAtomEx_Initialize 関数で初期化処理を行う。
   （workには確保したメモリのアドレスを、work_sizeにはワーク領域のサイズを指定する。）
   
5. アプリケーション終了時に criAtomEx_Finalize 関数で終了処理を行なう。
   
6. ワーク領域のメモリを解放する。
   

具体的なコードは以下のとおりです。

 main()
 {
    CriAtomExConfig config; // ライブラリ初期化用コンフィグ構造体
    void *work;             // ワーク領域アドレス
    CriSint32 work_size;    // ワーク領域サイズ
        :
    // ライブラリ初期化用コンフィグ構造体にデフォルト値をセット
    criAtomEx_SetDefaultConfig(&config);

    // ライブラリの初期化に必要なワーク領域のサイズを計算
    work_size = criAtomEx_CalculateWorkSize(&config);

    // ワーク領域用にメモリを確保
    work = malloc((size_t)work_size);

    // ライブラリの初期化
    // →確保済みのワーク領域を指定する。
    criAtomEx_Initialize(&config, NULL, 0);
        :
    // アプリケーションのメイン処理
    // →この間、確保したメモリは保持し続ける。
        :
    // アプリケーションを終了する際に終了処理を行う
    criAtomEx_Finalize();

    // 必要なくなったワーク領域を解放する
    free(work);
        :
 }

備考:

ライブラリが必要とするワーク領域のサイズは、初期化用コンフィグ構造体の内容に応じて 変化します。
また、必要なワーク領域のサイズは、プラットフォームによっても異なります。
引数 config の情報は、関数内でのみ参照されます。
関数を抜けた後は参照されませんので、関数実行後に config の領域を解放しても 問題ありません。

注意:

現状、ストリーム再生を行うかどうかに関係なく、 Atom ライブラリは必ず CRI File System ライブラリの機能を使用します。
そのため、CRI File Systemライブラリの初期化が行われていない場合、 Atom ライブラリは初期化処理時に内部で CRI File System ライブラリの初期化を行います。

Atom ライブラリが内部で CRI File System ライブラリを初期化する場合、 CRI File System の初期化パラメータとして、 CriAtomExConfig 構造体の fs_config パラメータを使用します。
fs_config が NULL の場合、 Atom ライブラリはデフォルトパラメータ（ criFs_SetDefaultConfig マクロの設定値）で CRI File System ライブラリを初期化します。

尚、本関数を実行する時点で、既に CRI File System ライブラリが初期化済みである場合、 本関数内では CRI File System ライブラリの初期化は行われません。

本関数を実行後、必ず対になる criAtomEx_Finalize 関数を実行してください。
また、 criAtomEx_Finalize 関数を実行するまでは、本関数を再度実行しないでください。

参照:

CriAtomExConfig, criAtomEx_Finalize, criAtomEx_SetUserAllocator, criAtomEx_CalculateWorkSize

ライブラリの終了

説明:

ライブラリを終了します。

注意:

criAtomEx_Initialize 関数実行前に本関数を実行することはできません。

参照:

criAtomEx_Initialize

ライブラリ初期化状態の取得

戻り値:

CriBool 初期化中かどうか

戻り値:

CRI_FALSE	未初期化状態
CRI_TRUE	初期化済み

説明:

ライブラリが既に初期化されているかどうかをチェックします。

参照:

criAtomEx_Initialize, criAtomEx_Finalize

サーバ処理の実行

説明:

CRI Atomライブラリの内部状態を更新します。
アプリケーションは、この関数を定期的に実行する必要があります。

サーバ処理を実行すべき回数は、ライブラリ初期化時のパラメータに依存します。
ライブラリ初期化時にスレッドモデルを CRIATOMEX_THREAD_MODEL_MULTI に設定した場合、 リアルタイム性の要求される処理は全てCRI Atomライブラリ内で定期的に自動実行されるため、 本関数の呼び出し頻度は少なくても問題は発生しません。
（最低でも毎秒1回程度実行されていれば、音切れ等の問題が発生することはありません。）
ライブラリ初期化時にスレッドモデルを CRIATOMEX_THREAD_MODEL_SINGLE や CRIATOMEX_THREAD_MODEL_USER_MULTI に設定した場合、ファイルの読み込み管理や、 データのデコード、音声の出力等、音声再生に必要な処理のほぼ全てが本関数内で実行されます。
また、音声再生処理に同期して、CRI File Systemライブラリのファイルアクセスとデータ展開処理を実行します。
そのため、ライブラリ初期化時に指定したサーバ処理の実行頻度（ CriAtomExConfig 構造体の server_frequency ）を下回る頻度で本関数を実行した場合や、 大きいデータの読み込み、圧縮ファイルの読み込み等を行う場合、 音切れ等の問題が発生する可能性があるので注意してください。

備考:

ライブラリ初期化時にスレッドモデルを CRIATOMEX_THREAD_MODEL_MULTI に設定した場合でも、 本関数を実行する必要があります。
（スレッドモデルを CRIATOMEX_THREAD_MODEL_MULTI の場合、ステータス更新等、ごく一部の 処理のみを行うため、本関数内で長時間処理がブロックされることはありません。）
CRI File Systemライブラリのサーバ処理は、CRI Atomライブラリ内部で実行されます。
そのため、本関数を実行している場合、アプリケーション側で別途CRI File Systemライブラリ のサーバ処理を呼び出す必要はありません。

ユーザーマルチスレッド用サーバ処理の実行

説明:

CRI Atomライブラリのみを更新します。
スレッドモデルが::CRIATOMEX_THREAD_MODEL_USER_MULTIの場合、 アプリケーションは、この関数を定期的に実行する必要があります。

ファイルの読み込み管理や、データのデコード、音声の出力等、 音声再生に必要な処理のほぼ全てが本関数内で実行されます。
そのため、ライブラリ初期化時に指定したサーバ処理の実行頻度（ CriAtomExConfig 構造体の server_frequency ）を下回る頻度で本関数を実行した場合、音切れ等の問題が発生する可能性 があります。
また、本関数は::criAtomEx_ExecuteMain 関数と異なり、CRI File Systemライブラリのサーバ処理を実行しません。
アプリケーションが必要なサーバ処理を正しい順序で実行してください。

備考:

CRIATOMEX_THREAD_MODEL_SINGLE に設定した場合、サーバ処理の排他制御が行われないので、 複数のスレッドから呼び出さないようにしてください。

参照:

criAtomEx_ExecuteMain

サーバ処理の割り込みを防止

説明:

サーバ処理の割り込み抑止します。
本関数実行後、::criAtomEx_Unlock 関数実行までの間、サーバ処理の動作が抑止されます。
複数のAPIを同一オーディオフレーム内で確実に実行したい場合には、本関数でサーバ処理の 割り込みを防止し、それらの関数を実行してください。

例:

    ：
 // サーバ処理の割り込みを防止
 criAtomEx_Lock();

 // 複数の音声を同時に再生開始
 criAtomExPlayer_Start(player1);
 criAtomExPlayer_Start(player2);
 criAtomExPlayer_Start(player3);
 criAtomExPlayer_Start(player4);

 // サーバ処理の割り込み防止を解除
 criAtomEx_Unlock();
    ：

注意:

上記の例のように、複数のプレーヤで同時に再生をスタートする場合でも、 ストリーム再生時は同時に発音が開始されるとは限りません。
（バッファリングに伴う再生遅延があるため。）

本関数実行後、長時間::criAtomEx_Unlock 関数を呼ばない場合、音声再生が途切れる恐れがあります。
サーバ処理の割り込みを防止する区間は、最小限に抑える必要があります。

参照:

criAtomEx_Unlock

サーバ処理の割り込み防止を解除

説明:

criAtomEx_Lock 関数による、サーバ処理の割り込み防止を解除します。

参照:

criAtomEx_Lock

時刻の取得

戻り値:

CriUint64 時刻（マイクロ秒単位）

説明:

Atomライブラリ内のマスタタイマから時刻を取得します。

参照:

criAtomEx_ResetTimer

タイマのリセット

説明:

Atomライブラリ内のマスタタイマの時刻をリセットします。

備考:

本関数は criAtomEx_GetTimeMicro 関数が返す値に対してのみ影響します。
本関数を実行しても、AtomExプレーヤの再生時刻がクリアされることはありません。

参照:

criAtomEx_ResetTimer

タイマのポーズ

引数:

[in]

sw

CRI_TRUE=タイマ一時停止、CRI_FALSE=タイマ再開

説明:

Atomライブラリ内のマスタタイマを一時停止／再開します。
マスタタイマを一時停止すると、シーケンス時刻が進行しなくなります。

備考:

本関数は アプリケーションが休止したり一時停止するようなプラットフォームにおいて、
休止中や一時停止中でもタイマが進行してしまうプラットフォーム向けの機能です。
アプリケーションが休止状態や一時停止状態に遷移する前に
本関数でマスタタイマを一時停止しておくことで、休止中のシーケンスの進行を止める事ができます。

注意:

本関数で一時停止する対象はあくまでAtomライブラリ内のマスタタイマです。
本関数では発音中のボイス等を一時停止できません。 本関数で設定したポーズフラグは、CRI Atomサーバ処理が実行されたタイミングで反映されます。
即座に同期をとる必要がある場合は、::criAtomEx_ExecuteAudioProcess 関数を呼び出す事で同期をとることができます。
ただし、::criAtomEx_ExecuteAudioProcessを呼び出したスレッドでオーディオ処理が実行されるため、 そのCPU負荷を許容できるかに注意してください。

参照:

criAtomEx_ResetTimer

ワーク領域サイズ計算用コンフィグ構造体の設定

引数:

[in]

config

初期化用コンフィグ構造体

説明:

ワーク領域サイズの計算用に、ライブラリ初期化用コンフィグ構造体 （ CriAtomExConfig 構造体）を仮登録します。

ACFの登録やボイスプールの作成に必要なワーク領域のサイズは、 ライブラリ初期化時（ criAtomEx_Initialize 関数実行時） に設定する構造体のパラメータによって変化します。
そのため、通常はACFの登録やボイスプールの作成に必要なワーク領域サイズを計算する前に、 ライブラリを初期化する必要があります。
本関数を使用してライブラリ初期化用コンフィグ構造体を登録した場合、 ACFの登録やボイスプールの作成に必要なワーク領域のサイズを、 初期化処理なしに計算可能になります。

本関数を実行することで、以下の処理が初期化処理なしに実行可能となります。

• criAtomEx_CalculateWorkSizeForRegisterAcfData 関数
• ボイスプール作成用ワーク領域サイズの計算
  （ criAtomExVoicePool_CalculateWorkSizeForStandardVoicePool 関数等）

備考:

引数（ config ）に NULL を指定した場合、デフォルト設定 （ criAtomEx_SetDefaultConfig 適用時と同じパラメータ）で ワーク領域サイズを計算します。

現状、本関数で一旦コンフィグ構造体を設定すると、 設定前の状態（未初期化状態でのワーク領域サイズ計算をエラーとする動作） に戻すことができなくなります。
（関数を再度実行してパラメータを上書きすることは可能です。）

注意:

本関数で登録した初期化用コンフィグ構造体は、 ライブラリ未初期化状態でのワーク領域サイズ計算にしか使用されません。
ライブラリ初期化後には本関数に設定したパラメータではなく、 初期化時に指定されたパラメータがワーク領域サイズの計算に使用されます。
（本関数で登録する構造体のパラメータと、 ライブラリの初期化に使用する構造体のパラメータが異なる場合、 ワーク領域サイズが不足し、ハンドルの作成に失敗する恐れがあります。）

criAtomEx_RegisterAcfFile 関数や criAtomExAcb_LoadAcbFile 関数等、 ワーク領域計算時にファイルアクセスが必要になる API については、 本関数を実行した場合でもワーク領域サイズの計算が行えません。
（ワーク領域サイズを計算するためにはライブラリを初期化する必要が あります。）

例:

    CriAtomExConfig atomex_config;

    // ライブラリ初期化用コンフィグ構造体にデフォルト値を設定
    criAtomEx_SetDefaultConfig(&atomex_config);

    // ライブラリ初期化用ワーク領域サイズの計算
    lib_work_size = criAtomEx_CalculateWorkSize(&atomex_config);

    // サブモジュールのワーク領域サイズ計算用にパラメータを仮登録
    criAtomEx_SetConfigForWorkSizeCalculation(&atomex_config);

    // サブモジュールのワーク領域サイズを計算
    acf_work_size = criAtomEx_CalculateWorkSizeForRegisterAcfData(acf_data, acf_data_size);
    vp_work_size = criAtomExVoicePool_CalculateWorkSizeForStandardVoicePool(NULL);
        ：

参照:

criAtomEx_CalculateWorkSizeForRegisterAcfData, criAtomExVoicePool_CalculateWorkSizeForStandardVoicePool

オンメモリACFデータの登録に必要なワーク領域サイズの計算

引数:

[in]	acf_data	ACFデータアドレス
[in]	acf_data_size	ACFデータサイズ

戻り値:

CriSint32 ワーク領域サイズ

戻り値:

0以上	正常に処理が完了
-1	エラーが発生

説明:

criAtomEx_RegisterAcfData 関数の実行に必要なワーク領域サイズを計算します。
criAtomEx_SetUserAllocator マクロによるアロケータ登録を行わずに criAtomEx_RegisterAcfData 関数でACF情報を登録する際には、 本関数が返すサイズ分のメモリをワーク領域として渡す必要があります。

ワーク領域サイズの計算に失敗すると、本関数は -1 を返します。
ワーク領域サイズの計算に失敗した理由については、エラーコールバックのメッセージで確認可能です。

注意:

ワーク領域のサイズはライブラリ初期化時（ criAtomEx_Initialize 関数実行時） に指定したパラメータによって変化します。
そのため、本関数を実行する前に、ライブラリを初期化しておく必要があります。

参照:

criAtomEx_RegisterAcfData

オンメモリACFデータの登録

引数:

[in]	acf_data	ACFデータアドレス
[in]	acf_data_size	ACFデータサイズ
[in]	work	ワーク領域
[in]	work_size	ワーク領域サイズ

説明:

メモリ上に配置されたACFデータをライブラリに取り込みます。
ACF情報の登録に必要なワーク領域のサイズは、 criAtomEx_CalculateWorkSizeForRegisterAcfData 関数で計算します。

備考:

criAtomEx_SetUserAllocator マクロを使用してアロケータを登録済みの場合、 本関数にワーク領域を指定する必要はありません。
（ work に NULL 、 work_size に 0 を指定することで、登録済みのアロケータ から必要なワーク領域サイズ分のメモリが動的に確保されます。）

注意:

本関数を実行する前に、ライブラリを初期化しておく必要があります。

本関数は、関数実行時に再生中の音声をすべて停止します。
また、プレーヤに設定した以下のACFに関連するパラメータを全てリセットします。

1. AISAC
2. AISACコントロール値
3. カテゴリ
4. セレクタラベル
5. バスセンド

本関数にセットしたデータ領域とワーク領域は、 criAtomEx_UnregisterAcf 関数を実行するまでの間、 アプリケーションで保持する必要があります。
（ criAtomEx_UnregisterAcf 関数実行前に、ワーク領域のメモリを解放しないでください。） また、データ領域の一部はワークとして使用されます。

参照:

criAtomEx_UnregisterAcf

ACFファイルの登録に必要なワーク領域サイズの計算

引数:

[in]	binder	バインダハンドル
[in]	path	ファイルパス

戻り値:

CriSint32 ワーク領域サイズ

戻り値:

0以上	正常に処理が完了
-1	エラーが発生

説明:

criAtomEx_RegisterAcfFile 関数の実行に必要なワーク領域サイズを計算します。
本関数は、 criAtomEx_SetUserAllocator マクロによるアロケータ登録の有無によって 計算に使用する要素が異なります。

• アロケータ登録時：ACFファイルを一時的に読み込み、ACF内に記録されているカテゴリ数、 再生単位でのカテゴリ参照数、REACT数を使用したサイズ計算が行われます。
  
• アロケータ未登録時：ライブラリ初期化時に指定した CriAtomExConfig 構造体の max_categoriesメンバ、categories_per_playbackメンバを使用したサイズ計算が行われます。
  
  ワーク領域サイズの計算に失敗すると、本関数は -1 を返します。
  ワーク領域サイズの計算に失敗した理由については、エラーコールバックのメッセージで確認可能です。
  

備考：

データがCPKにパックされていない場合、引数binderにはNULLを指定してください。

注意:

本関数を実行する前に、ライブラリを初期化しておく必要があります。

参照:

criAtomEx_RegisterAcfFile

ACFファイルの登録に必要なワーク領域サイズの計算（CPKコンテンツID指定）

引数:

[in]	binder	バインダハンドル
[in]	id	CPKコンテンツID

戻り値:

CriSint32 ワーク領域サイズ

戻り値:

0以上	正常に処理が完了
-1	エラーが発生

説明:

criAtomEx_RegisterAcfFileById 関数の実行に必要なワーク領域サイズを計算します。
ファイルパスの代わりにCPKコンテンツIDを指定する点を除けば、 criAtomEx_CalculateWorkSizeForRegisterAcfFile 関数と機能は同じです。

備考：

データがCPKにパックされていない場合、引数binderにはNULLを指定してください。

参照:

criAtomEx_CalculateWorkSizeForRegisterAcfFile, criAtomEx_RegisterAcfFileById

ACFファイルの登録

引数:

[in]	binder	バインダハンドル
[in]	path	ファイルパス
[in]	work	ワーク領域
[in]	work_size	ワーク領域サイズ

戻り値:

CriBool ファイル読み込み結果

説明:

ACFファイルをロードし、ライブラリに取り込みます。
criAtomEx_SetUserAllocator マクロを使用してアロケータを登録済みの場合、 本関数にワーク領域を指定する必要はありません。
（ work に NULL 、 work_size に 0 を指定することで、登録済みのアロケータ から必要なワーク領域サイズ分のメモリが動的に確保されます。） ワーク領域を指定して本関数を使用する場合、 criAtomEx_CalculateWorkSizeForRegisterAcfFile 関数 を使用してワークサイズを計算してください。

ACFファイルの登録に成功すると、本関数は戻り値として CRI_TRUE を返します。
リードエラー等によりACFファイルの読み込みに失敗した場合、本関数は戻り値として CRI_FALSE を返します。

備考:

データがCPKにパックされていない場合、引数binderにはNULLを指定してください。

注意:

本関数を実行する前に、ライブラリを初期化しておく必要があります。

本関数は、関数実行時に再生中の音声をすべて停止します。
また、プレーヤに設定した以下のACFに関連するパラメータを全てリセットします。

1. AISAC
2. AISACコントロール値
3. カテゴリ
4. セレクタラベル
5. バスセンド

本関数は、関数実行開始時に criFsLoader_Create 関数でローダを確保し、 終了時に criFsLoader_Destroy 関数でローダを破棄します。
本関数を実行する際には、空きローダハンドルが１つ以上ある状態になるよう、 ローダ数を調整してください。

criAtomEx_SetUserAllocator マクロによるアロケータ登録を行わずに criAtomEx_CalculateWorkSizeForRegisterAcfFile 関数によって計算したワークサイズ分の ワーク領域を指定した本関数の呼び出しでCRI_FALSEが返された場合、ワーク領域不足が要因 の可能性があります。
ライブラリ初期化時に指定する CriAtomExConfig 構造体の以下のメンバの設定値 が適切であるか確認してください。

• max_categories：ACF内のカテゴリ数、REACT数と同値以上
  
• categories_per_playback：ACF内の再生単位でのカテゴリ参照数と同値以上
  
  本関数にセットしたワーク領域は、 criAtomEx_UnregisterAcf 関数を実行するまでの間、 アプリケーションで保持する必要があります。
  （ criAtomEx_UnregisterAcf 関数実行前に、ワーク領域のメモリを解放しないでください。）

参照:

criAtomEx_UnregisterAcf

ACFファイルの登録（CPKコンテンツID指定）

引数:

[in]	binder	バインダハンドル
[in]	id	CPKコンテンツID
[in]	work	ワーク領域
[in]	work_size	ワーク領域サイズ

戻り値:

CriBool ファイル読み込み結果

説明:

ACFファイルをロードし、ライブラリに取り込みます。
ファイルパスの代わりにCPKコンテンツIDを指定する点を除けば、 criAtomEx_RegisterAcfFile 関数と機能は同じです。

備考：

データがCPKにパックされていない場合、引数binderにはNULLを指定してください。

注意:

本関数は、関数実行時に再生中の音声をすべて停止します。
また、プレーヤに設定したパラメータを全てリセットします。

参照:

criAtomEx_RegisterAcfFile

ACFの登録解除

説明:

ACF情報の登録を解除します。

注意:

本関数は、関数実行時に再生中の音声をすべて停止します。
また、プレーヤに設定したパラメータを全てリセットします。
（ACFファイルが登録されてない際に、音声再生中に本関数を実行した場合は音声は停止されません） criAtomEx_RegisterAcfFile 関数実行前に本関数を実行することはできません。

参照:

criAtomEx_RegisterAcfData, criAtomEx_RegisterAcfFile, criAtomEx_RegisterAcfFileById

オンメモリACFのバージョン取得

引数:

[in]	acf_data	ACFデータアドレス
[in]	acf_data_size	ACFデータサイズ
[out]	flag	レジスト可能フラグ

戻り値:

CriUint32 ACFフォーマットバージョン

説明:

メモリ上に配置されたACFデータのフォーマットバージョンを取得します。
また、flag引数にレジスト可能なバージョンかどうかをBool値で返します。

ACFファイルのバージョン取得

引数:

[in]	binder	バインダハンドル
[in]	path	ファイルパス
[in]	work	ワーク領域
[in]	work_size	ワーク領域サイズ
[out]	flag	レジスト可能フラグ

戻り値:

CriUint2 ACFフォーマットバージョン

説明:

ACFファイルをロードし、ACFデータのフォーマットバージョンを取得します。
ACF情報の登録に必要なワーク領域のサイズは、 criAtomEx_CalculateWorkSizeForRegisterAcfFile 関数で計算します。

ACFファイルフォーマットバージョンを元にflag引数にレジスト可能なバージョンかどうかをBool値で返します。

備考:

criAtomEx_SetUserAllocator マクロを使用してアロケータを登録済みの場合、 本関数にワーク領域を指定する必要はありません。
（ work に NULL 、 work_size に 0 を指定することで、登録済みのアロケータ から必要なワーク領域サイズ分のメモリが動的に確保されます。）
データがCPKにパックされていない場合、引数binderにはNULLを指定してください。

注意:

本関数は、関数実行開始時に criFsLoader_Create 関数でローダを確保し、 終了時に criFsLoader_Destroy 関数でローダを破棄します。
本関数を実行する際には、空きローダハンドルが１つ以上ある状態になるよう、 ローダ数を調整してください。

本関数にセットしたワーク領域は、 アプリケーションで保持する必要はありません。
（ロードしたデータは関数終了時に解放されます。）

ACFファイルのバージョン取得（CPKコンテンツID指定）

引数:

[in]	binder	バインダハンドル
[in]	id	CPKコンテンツID
[in]	work	ワーク領域
[in]	work_size	ワーク領域サイズ
[out]	flag	レジスト可能フラグ

戻り値:

CriUint2 ACFフォーマットバージョン

説明:

ACFファイルをロードし、ACFデータのフォーマットバージョンを取得します。
ファイルパスの代わりにCPKコンテンツIDを指定する点を除けば、 criAtomEx_GetAcfVersionFromFile 関数と機能は同じです。

備考：

データがCPKにパックされていない場合、引数binderにはNULLを指定してください。

参照:

criAtomEx_GetAcfVersionFromFile

レジスト可能バージョン情報取得

引数:

[out]	version_low	レジスト可能下位バージョン
[out]	version_high	レジスト可能上位バージョン

説明:

レジスト可能なACFのバージョン情報を取得します。
上位バージョンはライブラリビルド時点での情報のため、この値より上位のACFでも レジスト可能な場合もあります。

オーディオヘッダの解析

引数:

[in]	buffer	オーディオデータを格納したバッファ
[in]	buffer_size	オーディオデータを格納したバッファのサイズ
[out]	info	フォーマット情報

戻り値:

CriBool フォーマット情報が取得できたかどうか？（取得できた：CRI_TRUE／取得できない：CRI_FALSE）

説明:

メモリにロードされた音声データのフォーマットを解析します。
解析に成功すると、本関数は CRI_TRUE を返し、音声データのフォーマット情報を 第3引数（ info ）に格納します。
解析に失敗した場合、本関数は CRI_FALSE を返します。

備考:

本関数の第1引数（ buffer ）には、オーディオデータのヘッダ領域 （音声ファイルの先頭部分をロードしたもの）を格納しておく必要があります。
音声データの途中部分をセットした場合や、ヘッダ前に余計なデータが付加されている場合、 ヘッダの途中までしか格納されていない場合には、本関数はフォーマットの解析に失敗します。
ADXデータやHCAデータについては、音声ファイルの先頭から2048バイト分の領域をセットすれば、 フォーマットの解析に失敗することはありません。

注意:

現状、本関数はADXデータとHCAデータの解析にしか対応していません。
HCA-MXデータについては解析は可能ですが、ヘッダ情報からはHCAデータなのか HCA-MXデータなのかは区別できないため、フォーマット種別として CRIATOMEX_FORMAT_HCA が返されます。

乱数種の設定

引数:

[in]

seed

乱数種

説明:

CRI Atomライブラリ全体で共有する疑似乱数生成器に乱数種を設定します。
乱数種を設定することにより、各種ランダム再生処理に再現性を持たせることができます。
AtomExプレーヤごとに再現性を持たせたい場合は、::criAtomExPlayer_SetRandomSeed 関数を使用してください。

参照:

criAtomExPlayer_SetRandomSeed

DSPバス設定のアタッチ用ワークサイズの計算

引数:

[in]

setting

DSPバス設定の名前

戻り値:

CriSint32 必要ワーク領域サイズ

戻り値:

0以上	正常に処理が完了
-1	エラーが発生

説明:

DSPバス設定からDSPバスを構築するのに必要なワーク領域サイズを計算します。
本関数を実行するには、あらかじめACF情報を登録しておく必要があります

ワーク領域サイズの計算に失敗すると、本関数は -1 を返します。
ワーク領域サイズの計算に失敗した理由については、エラーコールバックのメッセージで確認可能です。

備考:

DSPバス設定のアタッチに必要なワークメモリのサイズは、CRI Atom Craftで作成した DSPバス設定の内容によって変化します。

参照:

criAtomEx_AttachDspBusSetting, criAtomEx_RegisterAcfData, criAtomEx_RegisterAcfFile, criAtomEx_RegisterAcfFileById

DSPバス設定のアタッチ用ワークサイズの計算

引数:

[in]	acf_data	ACFデータ
[in]	acf_buffer_size	ACFデータサイズ
[in]	setting_name	DSPバス設定の名前

戻り値:

CriSint32 必要ワーク領域サイズ

説明:

DSPバス設定からDSPバスを構築するのに必要なワーク領域サイズを計算します。
::criAtomExAsr_CalculateWorkSizeForDspBusSetting 関数と違い、 ACF情報を登録する前でも本関数は実行可能です。
（ただし、ACFデータを事前にメモリにロードし、 criAtomExAsr_SetConfigForWorkSizeCalculation 関数でASR初期化用コンフィグ構造体を仮登録しておく必要があります。）

ワーク領域サイズの計算に失敗すると、本関数は -1 を返します。
ワーク領域サイズの計算に失敗した理由については、 エラーコールバックのメッセージで確認可能です。

備考:

DSPバス設定のアタッチに必要なワークメモリのサイズは、CRI Atom Craftで作成した DSPバス設定の内容によって変化します。

注意:

ハードウェアDSPを使用するプラットフォーム（ASRを使用しないプラットフォーム）では、 本関数でワーク領域サイズを取得することができない可能性があります。
（本関数実行時にエラーコールバックが発生したり、負値が返される可能性があります。）
本関数が動作しないプラットフォームについては、 ライブラリの初期化後に criAtomEx_CalculateWorkSizeForDspBusSetting 関数を使用して必要なワーク領域サイズを計算してください。

参照:

criAtomEx_AttachDspBusSetting, criAtomEx_RegisterAcfData, criAtomEx_RegisterAcfFile, criAtomEx_RegisterAcfFileById, criAtomExAsr_SetConfigForWorkSizeCalculation, criAtomEx_CalculateWorkSizeForDspBusSetting

DSPバス設定のアタッチ

引数:

[in]	setting	DSPバス設定の名前
[in]	work	ワーク領域
[in]	work_size	ワーク領域サイズ

説明:

DSPバス設定からDSPバスを構築してサウンドレンダラにアタッチします。
本関数を実行するには、あらかじめACF情報を登録しておく必要があります。

        ：
    // ACFファイルの読み込みと登録
    criAtomEx_RegisterAcfFile(NULL, "Sample.acf", NULL, 0);

    // DSPバス設定の適用
    criAtomEx_AttachDspBusSetting("DspBusSetting_0", NULL, 0);
        ：

備考:

DSPバス設定のアタッチに必要なワークメモリのサイズは、 CRI Atom Craftで作成したDSPバス設定の内容によって変化します。

注意:

本関数は完了復帰型の関数です。
本関数を実行すると、しばらくの間Atomライブラリのサーバ処理がブロックされます。
音声再生中に本関数を実行すると、音途切れ等の不具合が発生する可能性があるため、 本関数の呼び出しはシーンの切り替わり等、負荷変動を許容できるタイミングで行ってください。

参照:

criAtomEx_DetachDspBusSetting, criAtomEx_RegisterAcfData, criAtomEx_RegisterAcfFile, criAtomEx_RegisterAcfFileById

DSPバス設定のデタッチ

説明:

DSPバス設定をデタッチします。
criAtomEx_SetUserAllocator マクロを使用してアロケータを登録済みの場合、 DSPバス設定アタッチ時に確保されたメモリ領域が解放されます。
（DSPバス設定アタッチ時にワーク領域を渡した場合、本関数実行後であれば ワーク領域を解放可能です。）

注意:

本関数は完了復帰型の関数です。
本関数を実行すると、しばらくの間Atomライブラリのサーバ処理がブロックされます。
音声再生中に本関数を実行すると、音途切れ等の不具合が発生する可能性があるため、 本関数の呼び出しはシーンの切り替わり等、負荷変動を許容できるタイミングで行ってください。

参照:

criAtomEx_AttachDspBusSetting

DSPバススナップショットの適用

引数:

[in]	snapshot_name	スナップショット名
[in]	time_ms	時間（ミリ秒）

説明:

DSPバススナップショットを適用します。
本関数を呼び出すと、スナップショットで設定したパラメータに time_ms 掛けて変化します。

参照:

criAtomEx_AttachDspBusSetting

適用中のDSPバススナップショット名の取得

戻り値:

const CriChar8* スナップショット名文字列へのポインタ。 スナップショットが適用されていない場合や取得に失敗した場合はCRI_NULLが返ります。

説明:

適用中のDSPバススナップショット名を取得します。 スナップショットが適用されていない場合はCRI_NULLが返ります。

参照:

criAtomEx_ApplyDspBusSnapshot

キューリンクコールコールバック関数の登録

引数:

[in]	func	キューリンクコールバック関数
[in]	obj	ユーザ指定オブジェクト

説明:

キュー再生時にキューリンクを処理した際に、キューリンク情報を受け取るコールバック関数を登録します。

注意:

登録されたコールバック関数は、ライブラリ内でキューリンクを処理したタイミングで実行されます。
そのため、ライブラリ処理への割り込みを考慮しないAPIを実行した場合、 エラーが発生したり、デッドロックが発生する可能性があります。
基本的に、コールバック関数内ではAtomライブラリAPIを使用しないでください。
本コールバック関数内で長時間処理をブロックすると、音切れ等の問題が発生しますので、 ご注意ください。

コールバック関数は1つしか登録できません。
登録操作を複数回行った場合、既に登録済みのコールバック関数が、 後から登録したコールバック関数により上書きされてしまいます。

funcにNULLを指定するとことで登録済み関数の登録解除が行えます。

参照:

CriAtomExCueLinkCbFunc

5.1chスピーカー角度の設定

引数:

[in]	angle_l	フロントレフトスピーカーの角度
[in]	angle_r	フロントライトスピーカーの角度
[in]	angle_sl	サラウンドレフトスピーカーの角度
[in]	angle_sr	サラウンドレフトスピーカーの角度

説明:

パン3Dや3Dポジショニングの計算時に使用する、出力スピーカーの角度（配置）を設定します。
角度は、正面方向を0度として-180度から180度の間で設定してください。

注意:

本関数は5.1ch向けのパンスピーカータイプ (4CH または 5CH) にのみ影響します。
7.1ch向けのパンスピーカータイプ (6CH または 7CH) のスピーカー角度を変更する場合は、::criAtomEx_SetSpeakerAngleArray 関数を使用してください。

設定するスピーカー角度は、angle_sl < angle_l < angle_r < angle_sr の順となるような配置にする必要があります。
例：

 criAtomEx_SetSpeakerAngles(-45.0f, 45.0f, -135.0f, 135.0f);

参照:

criAtomEx_SetSpeakerAngleArray

スピーカー角度の設定

引数:

[in]	speaker_system	出力スピーカーの並び順
[in]	angle_array	出力スピーカーの角度配列

説明:

パン3Dや3Dポジショニングの計算時に使用する、出力スピーカーの角度（配置）を設定します。
角度は、正面方向を0度として-180度から180度の間で設定してください。
角度配列は、出力スピーカーの並び順のスピーカー数以上の要素数の配列を指定してください。
角度配列に NULL を指定すると、出力スピーカーの並び順に合わせて、デフォルトの角度を設定します。

注意:

FRONT LEFTとFRONT RIGHTの位置を入れ替えるような設定をした場合、意図しない挙動になる可能性があります。

補足:

LOW FREQUENCYの角度を変更しても、パン3Dや3Dポジショニングの計算結果は変化しません。
設定した角度は、各スピーカーシステムごとに独立して設定されます。

例：

 CriFloat32 angle_array[8] = {-30.0f, 30.0f, 0.0f, 0.0f, -90.0f, 90.0f, -150.0f, 150.0f}
 criAtomEx_SetSpeakerAngleArray(CRIATOMEX_SPEAKER_SYSTEM_SURROUND_7_1, angle_array);

参照:

criAtomEx_SetSpeakerAngles

バーチャルスピーカー角度の設定

引数:

[in]	speaker_system	バーチャルスピーカーの並び順
[in]	angle_array	バーチャルスピーカーの角度配列

説明:

バーチャルスピーカーにおけるパン3Dや3Dポジショニングの計算時に使用する、 出力スピーカーの角度（配置）を設定します。
本関数の操作は criAtomEx_SetSpeakerAngleArray 関数と同様なため、基本的な説明はそちらを参照して下さい。

注意:

本関数での設定は criAtomEx_ControlVirtualSpeakerSetting 関数にてバーチャルスピーカー設定を有効にしない限り、 設定したバーチャルスピーカー角度はパン3Dや3Dポジショニングの計算に反映されません。

参照:

criAtomEx_SetSpeakerAngleArray, criAtomEx_ControlVirtualSpeakerSetting

バーチャルスピーカー設定のON/OFF

引数:

[in]

sw

スイッチ（CRI_FALSE = 無効、CRI_TRUE = 有効）

説明:

パン3Dや3Dポジショニングの計算時にバーチャルスピーカーの設定を使用する機能のON/OFFを設定します。
この設定を有効にすると、マルチチャンネルサウンドは criAtomEx_SetVirtualSpeakerAngleArray 関数にて設定した バーチャルスピーカー角度からそれぞれ再生されます。

注意:

デフォルトの状態は「無効」になっています。
また、何かボイスを再生中に「有効」にした場合、パン3Dや3Dポジショニングの計算には即時反映されません。 次回ボイス再生時から反映されます。

参照:

criAtomEx_SetVirtualSpeakerAngleArray

ゲーム変数の総数の取得

戻り値:

CriSint32 ゲーム変数の総数

説明:

ACFファイル内に登録されているゲーム変数の総数を取得します。

注意:

本関数を実行する前に、ACFファイルを登録しておく必要があります。
ACFファイルが登録されていない場合、-1が返ります。

参照:

criAtomEx_GetGameVariableInfo

ゲーム変数情報の取得（インデックス指定）

引数:

[in]	index	ゲーム変数インデックス
[out]	info	ゲーム変数情報

戻り値:

CriBool 情報が取得できたかどうか？（取得できた：CRI_TRUE／取得できない：CRI_FALSE）

説明:

ゲーム変数インデックスからゲーム変数情報を取得します。
指定したインデックスのゲーム変数が存在しない場合、CRI_FALSEが返ります。

参照:

CriAtomExGameVariableInfo

ゲーム変数の取得

引数:

[in]

id

ゲーム変数ID

戻り値:

CriFloat32 ゲーム変数値

説明:

ACFファイル内に登録されているゲーム変数値を取得します。

注意:

本関数を実行する前に、ACFファイルを登録しておく必要があります。

ゲーム変数の取得

引数:

[in]

name

ゲーム変数名

戻り値:

CriFloat32 ゲーム変数値

説明:

ACFファイル内に登録されているゲーム変数を取得します。

注意:

本関数を実行する前に、ACFファイルを登録しておく必要があります。

ゲーム変数の設定

引数:

[in]	id	ゲーム変数ID
[in]	value	ゲーム変数値

説明:

ACFファイル内に登録されているゲーム変数に値を設定します。
設定可能な範囲は0.0f〜1.0fの間です。

注意:

本関数を実行する前に、ACFファイルを登録しておく必要があります。

ゲーム変数の設定

引数:

[in]	name	ゲーム変数名
[in]	value	ゲーム変数値

説明:

ACFファイル内に登録されているゲーム変数に値を設定します。
設定可能な範囲は0.0f〜1.0fの間です。

注意:

本関数を実行する前に、ACFファイルを登録しておく必要があります。

プレイバックキャンセルコールコールバック関数の登録

引数:

[in]	func	プレイバックキャンセルコールバック関数
[in]	obj	ユーザ指定オブジェクト

説明:

キュー再生時に再生開始処理のキャンセルが発生した際に、プレイバックキャンセル情報を受け取るコールバック関数を登録します。

注意:

登録されたコールバック関数は、ライブラリ内で再生開始処理がキャンセルされるタイミングで実行されます。
そのため、ライブラリ処理への割り込みを考慮しないAPIを実行した場合、 エラーが発生したり、デッドロックが発生する可能性があります。
基本的に、コールバック関数内ではAtomライブラリAPIを使用しないでください。
本コールバック関数内で長時間処理をブロックすると、音切れ等の問題が発生しますので、 ご注意ください。

コールバック関数は1つしか登録できません。
登録操作を複数回行った場合、既に登録済みのコールバック関数が、 後から登録したコールバック関数により上書きされてしまいます。

funcにNULLを指定するとことで登録済み関数の登録解除が行えます。

参照:

CriAtomExPlaybackCancelCbFunc

ACF整合性チェック機能のON/OFF.

引数:

[in]

sw

スイッチ（CRI_FALSE = チェック無効、CRI_TRUE = チェック有効）

説明:

ACBロード時のACFとの整合性チェック機能のON/OFFを設定します。

注意:

デフォルトの状態は「チェック有効」になっています。「チェック無効」に設定した場合に、 整合性が合わない組み合わせのデータを使用すると、本来目的とする効果が得られません。
また、「チェック無効」にした場合でも、音声処理実行時にACBから参照しているACF項目が 見つからないときには別途エラーコールバックが発生ます。

ACF整合性チェックエラーレベルの設定

引数:

[in]

level

エラーレベル

説明:

ACBロード時のACFとの整合性チェックで発生するエラーの通知レベルを設定します。
デフォルト状態での通知レベルは CRIERR_LEVEL_WARNING です。

トラックトランジションバイセレクタコールコールバック関数の登録

引数:

[in]	func	トラックトランジションバイセレクタコールバック関数
[in]	obj	ユーザ指定オブジェクト

説明:

トラックトランジションバイセレクタタイプキューの再生時にトランジション処理を行った際の情報を受け取るコールバック関数を登録します。

注意:

登録されたコールバック関数は、ライブラリ内でトランジション処理が開始されるタイミングで実行されます。
そのため、ライブラリ処理への割り込みを考慮しないAPIを実行した場合、 エラーが発生したり、デッドロックが発生する可能性があります。
基本的に、コールバック関数内ではAtomライブラリAPIを使用しないでください。
本コールバック関数内で長時間処理をブロックすると、音切れ等の問題が発生しますので、 ご注意ください。

コールバック関数は1つしか登録できません。
登録操作を複数回行った場合、既に登録済みのコールバック関数が、 後から登録したコールバック関数により上書きされてしまいます。

funcにNULLを指定するとことで登録済み関数の登録解除が行えます。

参照:

CriAtomExTrackTransitionBySelectorCbFunc

セレクタに対するグローバル参照ラベルの設定

引数:

[in]	selsector_name	セレクタ名
[in]	label_name	ラベル名

説明:

ACFファイル内に登録されているセレクタに対してグローバル参照されるラベルを設定します。

注意:

本関数を実行する前に、ACFファイルを登録しておく必要があります。

参照:

criAtomExAcf_SetGlobalLabelToSelectorByIndex

セレクタに対するグローバル参照ラベルの設定

引数:

[in]	selsector_index	セレクタインデックス
[in]	label_index	ラベルインデックス

説明:

ACFファイル内に登録されているセレクタに対してグローバル参照されるラベルを設定します。

注意:

本関数を実行する前に、ACFファイルを登録しておく必要があります。

参照:

criAtomExAcf_SetGlobalLabelToSelectorByName

プレーヤの列挙

引数:

[in]	func	プレーヤコールバック関数
[in]	obj	ユーザ指定オブジェクト

説明:

アプリケーション中で確保したプレーヤを列挙します。

本関数を実行すると、第 1 引数（ func ） でセットされたコールバック関数がAtomExプレーヤの数分だけ呼び出されます。
（AtomExプレーヤハンドルが、引数としてコールバック関数に渡されます。）

備考:

第 2 引数（ obj ）にセットした値は、コールバック関数の引数として渡されます。
コールバック関数のその他の引数については、 別途 CriAtomExPlayerCbFunc の説明をご参照ください。

funcにNULLを指定するとことで登録済み関数の登録解除が行えます。

参照:

CriAtomExVoiceInfoCbFunc

ボイスイベントコールバックの登録

引数:

[in]	func	ボイスイベントコールバック関数
[in]	obj	ユーザ指定オブジェクト

説明:

ボイスイベントコールバックを登録します。
本関数を使用してボイスイベントコールバックを登録することで、 ボイスイベント（ボイスの取得／解放／奪い取り）発生時の詳細情報 （再生／停止される音声データの詳細情報等）が取得可能です。

備考:

第 2 引数（ obj ）にセットした値は、コールバック関数の引数として渡されます。
コールバック関数のその他の引数については、 別途 CriAtomExVoiceEventCbFunc の説明をご参照ください。

funcにNULLを指定するとことで登録済み関数の登録解除が行えます。

注意:

本関数で登録したコールバックには、ボイス単位のリミット制御 （ボイスプライオリティに基づいた波形単位のプライオリティ制御） に関する情報のみが返されます。
（カテゴリキュープライオリティによる制御に関する情報は、現状取得できません。）

コールバック関数は1つしか登録できません。
登録操作を複数回行った場合、既に登録済みのコールバック関数が、 後から登録したコールバック関数により上書きされてしまいます。

参照:

CriAtomExVoiceEventCbFunc

ボイス情報の列挙

引数:

[in]	func	ボイス情報コールバック関数
[in]	obj	ユーザ指定オブジェクト

説明:

再生中のボイスの情報を列挙します。

本関数を実行すると、第 1 引数（ func ） でセットされたコールバック関数が再生中のボイスの数分だけ呼び出されます。
コールバック関数には、再生中のボイスに関する詳細情報が CriAtomExVoiceInfoDetail 構造体として渡されます。

備考:

第 2 引数（ obj ）にセットした値は、コールバック関数の引数として渡されます。
コールバック関数のその他の引数については、 別途 CriAtomExVoiceInfoCbFunc の説明をご参照ください。

funcにNULLを指定するとことで登録済み関数の登録解除が行えます。

注意:

本関数で登録したコールバックには、 発音可能なボイスリソースを持つボイスの情報だけが返されます。
（バーチャル化されたボイスの情報は返されません。）

参照:

CriAtomExVoiceInfoCbFunc

ボイス停止を監視するコールバック関数の登録

引数:

[in]	func	ボイス停止監視コールバック関数
[in]	obj	ユーザ指定オブジェクト

説明:

ボイスの停止を監視するコールバック関数の登録をします。

本関数を実行すると、第 1 引数（ func ） でセットされたコールバック関数が監視している再生ID内で発音しているボイスが停止する際に呼び出されます。
コールバック関数には、停止ボイスに関する情報が CriAtomExMonitoringVoiceStopInfo 構造体として渡されます。

備考:

第 2 引数（ obj ）にセットした値は、コールバック関数の引数として渡されます。
コールバック関数のその他の引数については、 別途 CriAtomExMonitoringVoiceStopCbFunc の説明をご参照ください。

参照:

CriAtomExMonitoringVoiceStopCbFunc

ボイス停止を監視する再生IDの登録

引数:

[in]

playback_id

ボイス停止を監視する再生ID

説明:

ボイスの停止を監視する再生IDを登録をします。

監視可能な再生IDは１つだけです。
既に再生IDが設定済みの状態で本関数を呼び出した場合は、監視再生ID情報が上書きされます。
監視を行うためには::criAtomEx_SetMonitoringVoiceStopCallback 関数で通知を行うためのコールバック関数を登録してください。

参照:

criAtomEx_SetMonitoringVoiceStopCallback