CriAtomAsr API

データ構造
struct	CriAtomAsrConfigTag
	ASR初期化用コンフィグ構造体ASR（Atom Sound Renderer）の動作仕様を指定するための構造体です。 criAtomAsr_Initialize 関数の引数に指定します。 [詳解]

マクロ定義
#define	criAtomMeter_SetDefaultConfigForLoudnessMeter(p_config)
	ラウドネスメーター機能コンフィグ構造体にデフォルト値をセット [詳解]
#define	criAtomMeter_SetDefaultConfigForTruePeakMeter(p_config)
	トゥルーピークメーター機能コンフィグ構造体にデフォルト値をセット [詳解]
#define	criAtomExAsrRack_SetDefaultConfig(p_config)
	CriAtomAsrConfigへのデフォルトパラメーターをセット [詳解]
#define	criAtomExAsrRackSpatialChannel_SetDefaultConfig(p_config)
	CriAtomExAsrRackSpatialChannelConfigへのデフォルトパラメーターをセット [詳解]
#define	criAtomExAsrRackSpatialAmbisonics_SetDefaultConfig(p_config)
	CriAtomExAsrRackSpatialAmbisonicsConfigへのデフォルトパラメーターをセット [詳解]
#define	criAtomExAsrRackSpatialObject_SetDefaultConfig(p_config)
	CriAtomExAsrRackSpatialObjectConfigへのデフォルトパラメーターをセット [詳解]
#define	criAtomAsr_SetDefaultConfig(p_config)
	CriAtomAsrConfigへのデフォルトパラメーターをセット [詳解]
#define	criAtomPlayer_SetDefaultConfig_ASR(p_config)
	CriAtomPlayerConfig_ASRへのデフォルトパラメーターのセット [詳解]

型定義
typedef struct CriAtomAsrConfigTag	CriAtomAsrConfig
	ASR初期化用コンフィグ構造体ASR（Atom Sound Renderer）の動作仕様を指定するための構造体です。 criAtomAsr_Initialize 関数の引数に指定します。 [詳解]

関数
CriSint32	criAtomAsr_CalculateWorkSize (const CriAtomAsrConfig *config)
	ASR初期化用ワーク領域サイズの計算 [詳解]
void	criAtomAsr_Initialize (const CriAtomAsrConfig *config, void *work, CriSint32 work_size)
	ASRの初期化 [詳解]
void	criAtomAsr_Finalize (void)
	ASRの終了 [詳解]

詳解

マクロ定義詳解

criAtomMeter_SetDefaultConfigForLoudnessMeter

#define criAtomMeter_SetDefaultConfigForLoudnessMeter

(

p_config

)

値:

{\
    (p_config)->short_term_time = 3;\
    (p_config)->integrated_time = 600;\
}

ラウドネスメーター機能コンフィグ構造体にデフォルト値をセット

説明:

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

参照

criAtomMeter_AttachLoudnessMeter, CriAtomLoudnessMeterConfig

criAtomMeter_SetDefaultConfigForTruePeakMeter

#define criAtomMeter_SetDefaultConfigForTruePeakMeter

(

p_config

)

値:

{\
    (p_config)->sample_clipping = CRI_TRUE;\
    (p_config)->interval = 50;\
    (p_config)->hold_time = 1000; \
}

トゥルーピークメーター機能コンフィグ構造体にデフォルト値をセット

説明:

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

参照

criAtomMeter_AttachTruePeakMeter, CriAtomTruePeakMeterConfig

criAtomExAsrRack_SetDefaultConfig

#define criAtomExAsrRack_SetDefaultConfig

(

p_config

)

値:

{\
    (p_config)->server_frequency = 60.0f;\
    (p_config)->num_buses = CRIATOMEXASR_DEFAULT_NUM_BUSES; \
    (p_config)->output_channels = CRIATOM_DEFAULT_OUTPUT_CHANNELS;\
    (p_config)->speaker_mapping = CRIATOM_SPEAKER_MAPPING_AUTO;\
    (p_config)->output_sampling_rate = CRIATOM_DEFAULT_OUTPUT_SAMPLING_RATE;\
    (p_config)->sound_renderer_type = CRIATOM_SOUND_RENDERER_NATIVE;\
    (p_config)->output_rack_id = 0;\
    (p_config)->context = NULL;\
}

CriAtomAsrConfigへのデフォルトパラメーターをセット

引数

[out]

p_config

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

説明:

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

参照

CriAtomAsrConfig

criAtomExAsrRackSpatialChannel_SetDefaultConfig

#define criAtomExAsrRackSpatialChannel_SetDefaultConfig

(

p_config

)

値:

{\
    (p_config)->context = NULL;\
}

CriAtomExAsrRackSpatialChannelConfigへのデフォルトパラメーターをセット

引数

[out]

p_config

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

説明:

ChannelBasedAudio再生用ASRラック拡張コンフィグ構造体（ CriAtomExAsrRackSpatialChannelConfig ）に、 デフォルトの値をセットします。

参照

CriAtomExAsrRackSpatialChannelConfig

criAtomExAsrRackSpatialAmbisonics_SetDefaultConfig

#define criAtomExAsrRackSpatialAmbisonics_SetDefaultConfig

(

p_config

)

値:

{\
    (p_config)->context = NULL;\
}

CriAtomExAsrRackSpatialAmbisonicsConfigへのデフォルトパラメーターをセット

引数

[out]

p_config

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

説明:

Ambisonics再生用ASRラック拡張コンフィグ構造体（ CriAtomExAsrRackSpatialAmbisonicsConfig ）に、 デフォルトの値をセットします。

参照

CriAtomExAsrRackSpatialAmbisonicsConfig

criAtomExAsrRackSpatialObject_SetDefaultConfig

#define criAtomExAsrRackSpatialObject_SetDefaultConfig

(

p_config

)

値:

{\
    (p_config)->fallback_rack_id = CRIATOMEXASR_RACK_ILLEGAL_ID;\
    (p_config)->context = NULL;\
}

CriAtomExAsrRackSpatialObjectConfigへのデフォルトパラメーターをセット

引数

[out]

p_config

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

説明:

ObjectBasedAudio再生用ASRラック拡張コンフィグ構造体（ CriAtomExAsrRackSpatialObjectConfig ）に、 デフォルトの値をセットします。

参照

CriAtomExAsrRackSpatialObjectConfig

criAtomAsr_SetDefaultConfig

#define criAtomAsr_SetDefaultConfig

(

p_config

)

値:

{\
    (p_config)->server_frequency = 60.0f;\
    (p_config)->num_buses = CRIATOMEXASR_DEFAULT_NUM_BUSES; \
    (p_config)->output_channels = CRIATOM_DEFAULT_OUTPUT_CHANNELS;\
    (p_config)->speaker_mapping = CRIATOM_SPEAKER_MAPPING_AUTO;\
    (p_config)->output_sampling_rate = CRIATOM_DEFAULT_OUTPUT_SAMPLING_RATE;\
    (p_config)->sound_renderer_type = CRIATOM_SOUND_RENDERER_NATIVE;\
    (p_config)->context = NULL;\
    (p_config)->max_racks = 8;\
    (p_config)->ambisonics_order_type = CRIATOMAMBISONICS_ORDER_TYPE_NONE;\
}

CriAtomAsrConfigへのデフォルトパラメーターをセット

引数

[out]

p_config

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

説明:

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

参照

CriAtomAsrConfig

criAtomPlayer_SetDefaultConfig_ASR

#define criAtomPlayer_SetDefaultConfig_ASR

(

p_config

)

値:

{                                                                   \
    (p_config)->max_routes = CRIATOMEXASR_DEFAULT_NUM_ROUTES;       \
}

CriAtomPlayerConfig_ASRへのデフォルトパラメーターのセット

引数

[in]

p_config

プレーヤー作成用コンフィグ構造体へのポインタ

説明:

プレーヤーを作成する際に、動作仕様を指定するためのコンフィグ構造体 （ CriAtomPlayerConfig_ASR ）に、デフォルトの値をセットします。

参照

CriAtomPlayerConfig_ASR

型定義詳解

CriAtomAsrConfig

typedef struct CriAtomAsrConfigTag CriAtomAsrConfig

ASR初期化用コンフィグ構造体ASR（Atom Sound Renderer）の動作仕様を指定するための構造体です。
criAtomAsr_Initialize 関数の引数に指定します。

備考:

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

注意

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

参照

criAtomAsr_Initialize, criAtomAsr_SetDefaultConfig

関数詳解

criAtomAsr_CalculateWorkSize()

CriSint32 criAtomAsr_CalculateWorkSize

(

const CriAtomAsrConfig *

config

)

ASR初期化用ワーク領域サイズの計算

引数

[in]

config

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

説明:

ASR（Atom Sound Renderer）の初期化に必要なワーク領域のサイズを取得します。
criAtom_SetUserAllocator マクロによるアロケーター登録を行わずに criAtomAsr_Initialize 関数でASRの初期化を行う場合、 本関数で計算したサイズ分のメモリをワーク領域として渡す必要があります。

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

備考:

ASRの初期化に必要なワークメモリのサイズは、ASR初期化用コンフィグ 構造体（ CriAtomAsrConfig ）の内容によって変化します。

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

参照

criAtom_SetUserAllocator, criAtomAsr_Initialize

criAtomAsr_Initialize()

void criAtomAsr_Initialize	(	const CriAtomAsrConfig *	config,
		void *	work,
		CriSint32	work_size
	)

ASRの初期化

引数

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

説明:

ASR（Atom Sound Renderer）の初期化を行います。
本関数を実行することでASRが起動され、レンダリング結果の出力を開始します。

備考:

ASRの初期化に必要なワークメモリのサイズは、ASR初期化用コンフィグ 構造体（ CriAtomAsrConfig ）の内容によって変化します。

引数にNULLを指定した場合、デフォルト設定
（ criAtomAsr_SetDefaultConfig 適用時と同じパラメーター）で初期化処理を行います。

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

注意

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

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

参照

criAtom_SetUserAllocator, criAtomAsr_Finalize

criAtomAsr_Finalize()

void criAtomAsr_Finalize

(

void

)

ASRの終了

説明:

ASR（Atom Sound Renderer）の終了処理を行います。
本関数を実行することで、レンダリング結果の出力が停止されます。
criAtom_SetUserAllocator マクロを使用してアロケーターを登録済みの場合、 ASR初期化時に確保されたメモリ領域が解放されます。
（ASR初期化時にワーク領域を渡した場合、本関数実行後であれば ワーク領域を解放可能です。）

注意

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

参照

criAtom_SetUserAllocator, criAtomAsr_Initialize