DxLib解剖学LoadSoundMemとLoadBGM

LOADSOUND_GPARAM

まず引数経由でフラグを渡すための構造体定義が存在します。

// ファイルからサウンドハンドルを作成する処理に必要なグローバルデータを纏めたもの
struct LOADSOUND_GPARAM
{
	int							NotInitSoundMemDelete ;					// InitSoundMem で削除しないかどうかのフラグ( TRUE:InitSoundMemでは削除しない  FALSE:InitSoundMemで削除する )
	int							Create3DSoundFlag ;						// 3Dサウンドを作成するかどうかのフラグ( TRUE:３Ｄサウンドを作成する  FALSE:３Ｄサウンドを作成しない )
	int							CreateSoundDataType ;					// 作成するサウンドデータのデータタイプ
	int							CreateSoundPitchRateEnable ;			// 作成するサウンドデータのピッチレートが有効かどうか
	float						CreateSoundPitchRate ;					// 作成するサウンドデータのピッチレート
	int							CreateSoundTimeStretchRateEnable ;		// 作成するサウンドデータのタイムストレッチレートが有効かどうか
	float						CreateSoundTimeStretchRate ;			// 作成するサウンドデータのタイムストレッチレート
	int							CreateSoundLoopStartTimePosition ;		// 作成するサウンドデータのループ範囲の先端( ミリ秒 )
	int							CreateSoundLoopStartSamplePosition ;	// 作成するサウンドデータのループ範囲の先端( サンプル )
	int							CreateSoundLoopEndTimePosition ;		// 作成するサウンドデータのループ範囲の終端( ミリ秒 )
	int							CreateSoundLoopEndSamplePosition ;		// 作成するサウンドデータのループ範囲の終端( サンプル )
	int							DisableReadSoundFunctionMask ;			// 使用しない読み込み処理のマスク
#ifndef DX_NON_OGGVORBIS
	int							OggVorbisBitDepth ;						// ＯｇｇＶｏｒｂｉｓ使用時のビット深度(1:8bit 2:16bit)
	int							OggVorbisFromTheoraFile ;				// Ogg Theora ファイル中の Vorbis データを参照するかどうかのフラグ( TRUE:Theora ファイル中の Vorbis データを参照する )
#endif
} ;

SOUNDSYSTEMDATA

DxLib内部でのフラフの保管につかうグローバル変数として

// サウンドシステムデータ
SOUNDSYSTEMDATA SoundSysData ;

があります。SOUNDSYSTEMDATAは

// サウンドシステム用データ構造体
struct SOUNDSYSTEMDATA
{
	int							InitializeFlag ;				// 初期化フラグ

	DWORD						OutputChannels ;				// 出力チャンネル数
	DWORD						OutputSmaplesPerSec ;			// 出力サンプリングレート

	int							_3DSoundOneMetreEnable ;		// _3DSoundOneMetre が有効かどうか( TRUE:有効  FALSE:無効 )
	float						_3DSoundOneMetre ;				// ３Ｄサウンド処理用の１メートル
	_3DSOUNDINFO				ListenerInfo ;					// ３Ｄサウンドのリスナーの情報
	VECTOR						ListenerSideDirection ;			// ３Ｄサウンドのリスナーの横方向

	HANDLELIST					_3DSoundListFirst ;				// ３Ｄサウンドハンドルリストの先頭
	HANDLELIST					_3DSoundListLast ;				// ３Ｄサウンドハンドルリストの終端
	DX_CRITICAL_SECTION			_3DSoundListCriticalSection ;	// ３Ｄサウンドリストアクセス時用クリティカルセクション

	HANDLELIST					StreamSoundListFirst ;			// ストリームサウンドハンドルリストの先頭
	HANDLELIST					StreamSoundListLast ;			// ストリームサウンドハンドルリストの終端
	DX_CRITICAL_SECTION			StreamSoundListCriticalSection ;// ストリームサウンドハンドルリストアクセス時用クリティカルセクション

	HANDLELIST					SoftSoundPlayerListFirst ;		// ソフトウエアで扱う波形データのプレイヤーのハンドルリストの先頭
	HANDLELIST					SoftSoundPlayerListLast ;		// ソフトウエアで扱う波形データのプレイヤーのハンドルリストの終端

	HANDLELIST					PlayFinishDeleteSoundListFirst ; // 再生終了時に削除するサウンドハンドルリストの先頭
	HANDLELIST					PlayFinishDeleteSoundListLast ;	 // 再生終了時に削除するサウンドハンドルリストの終端

	HANDLELIST					Play3DSoundListFirst ;			// 再生している３Ｄサウンドリストの先頭
	HANDLELIST					Play3DSoundListLast ;			// 再生している３Ｄサウンドリストの終端
	DX_CRITICAL_SECTION			Play3DSoundListCriticalSection ;// 再生している３Ｄサウンドリストアクセス時用クリティカルセクション

	int							PlayWavSoundHandle ;			// PlayWav関数で鳴らされているWAVEデータのハンドル

	int							Create3DSoundFlag ;				// 3Dサウンドを作成するかどうかのフラグ( TRUE:３Ｄサウンドを作成する  FALSE:３Ｄサウンドを作成しない )
	int							OldVolumeTypeFlag ;				// Ver3.10c以前の音量計算式を使用するかどうかのフラグ( TRUE:古い計算式を使用する  FALSE:新しい計算式を使用する )
	int							SoundMode ;						// 再生形式

	int							MaxVolume ;						// 最大音量

	int							EnableSoundCaptureFlag ;		// サウンドキャプチャを前提とした動作をする
#ifndef DX_NON_SAVEFUNCTION
	int							SoundCaptureFlag ;				// サウンドキャプチャを実行している最中かどうかのフラグ(TRUE:最中 FASLE:違う)
	int							SoundCaptureSample ;			// キャプチャしたサンプルの数(44.1KHz換算)
	DWORD_PTR					SoundCaptureFileHandle ;		// キャプチャしたサウンドを保存しているファイル
#endif // DX_NON_SAVEFUNCTION

	int							CreateSoundDataType ;					// 作成するサウンドデータのデータタイプ
	int							CreateSoundPitchRateEnable ;			// 作成するサウンドデータのピッチレートが有効かどうか
	float						CreateSoundPitchRate ;					// 作成するサウンドデータのピッチレート
	float						CreateSoundPitchRate_Cents ;			// 作成するサウンドデータのピッチレート( セント単位 )
	int							CreateSoundTimeStretchRateEnable ;		// 作成するサウンドデータのタイムストレッチレートが有効かどうか
	float						CreateSoundTimeStretchRate ;			// 作成するサウンドデータのタイムストレッチレート
	int							CreateSoundLoopStartTimePosition ;		// 作成するサウンドデータのループ範囲の先端( ミリ秒 )
	int							CreateSoundLoopStartSamplePosition ;	// 作成するサウンドデータのループ範囲の先端( サンプル )
	int							CreateSoundLoopEndTimePosition ;		// 作成するサウンドデータのループ範囲の終端( ミリ秒 )
	int							CreateSoundLoopEndSamplePosition ;		// 作成するサウンドデータのループ範囲の終端( サンプル )
	int							DisableReadSoundFunctionMask ;			// 使用しない読み込み処理のマスク
#ifndef DX_NON_OGGVORBIS
	int							OggVorbisBitDepth ;				// ＯｇｇＶｏｒｂｉｓ使用時のビット深度(1:8bit 2:16bit)
	int							OggVorbisFromTheoraFile ;		// Ogg Theora ファイル中の Vorbis データを参照するかどうかのフラグ( TRUE:Theora ファイル中の Vorbis データを参照する )
#endif

#ifndef DX_NON_BEEP
	int							BeepFrequency ;									// 再生するBEEP音の周波数
	int							BeepPlay ;										// BEEPを再生中かどうか
	int							BeepSoundBufferUseIndex ;						// 使用するBEEP音再生用のサウンドバッファ
	SOUND_BEEP_BUFFERDATA		BeepSoundBuffer[ SOUND_BEEPSOUNDBUFFER_NUM ] ;	// BEEP音用のサウンドバッファ関連情報
#endif

	short						SinTable[ SOUND_SINTABLE_DIV ] ;	// サインテーブル

	SOUNDSYSTEMDATA_PF			PF ;							// 環境依存情報
} ;

のように定義されています。

CreateSoundDataType

で大事なのはCreateSoundDataTypeです。これが取りうる値は

DX_SOUNDDATATYPE_MEMNOPRESS

圧縮された全データは再生が始まる前にサウンドメモリにすべて展開され、格納される。

DX_SOUNDDATATYPE_MEMPRESS

圧縮された全データはシステムメモリに格納され、再生する部分だけ逐次展開しながらサウンドメモリに格納する(鳴らし終わると展開したデータは破棄されるので何度も展開処理が行われる)

DX_SOUNDDATATYPE_FILE

圧縮されたデータの再生する部分だけファイルから逐次読み込み展開され、サウンドメモリに格納される(鳴らし終わると展開したデータは破棄されるので何度も展開処理が行われる)

の3つです。まあDX_SOUNDDATATYPE_MEMNOPRESS_PLUSというのもあるんですが、
後述するNS_SetCreateSoundDataType関数内にDX_SOUNDDATATYPE_MEMNOPRESSに強制置換するコードと現在使えないというコメントがありまして・・・

DX_SOUNDDATATYPE_MEMPRESSはストリーム形式と呼んでいるようです。

SOUND

これとは別に、サウンドハンドルと紐付けられた情報を格納するための構造体が存在します。

// サウンドデータ
struct SOUND
{
	HANDLEINFO					HandleInfo ;											// ハンドル共通情報

	HANDLELIST					_3DSoundList ;											// ３Ｄサウンドリスト処理用構造体
	int							Is3DSound ;												// ３Ｄサウンドかどうか( TRUE:３Ｄサウンド  FALSE:非３Ｄサウンド )
	int							AddPlay3DSoundList ;									// Play3DSoundList がリストに追加されているかどうか( TRUE:追加されている  FALSE:追加されていない )
	HANDLELIST					Play3DSoundList ;										// 再生中の３Ｄサウンドのリスト処理用構造体

	int							PlayFinishDeleteFlag ;									// サウンドの再生が終了したら削除するかどうか( TRUE:削除する  FALSE:削除しない )
	HANDLELIST					PlayFinishDeleteSoundList ;								// サウンドの再生が終了したら削除するサウンドのリスト処理用構造体

	int							NotInitSoundMemDelete ;									// InitSoundMem で削除しないかどうかのフラグ( TRUE:InitSoundMemでは削除しない  FALSE:InitSoundMemで削除する )

//	char						FilePath[ 256 ] ;										// ディレクトリ
//	char						SoundName[ 256 ] ;										// サウンドファイルネーム

	int							ValidBufferNum ;										// 有効なバッファの数
	int							BufferPlayStateBackupFlagValid[ MAX_SOUNDBUFFER_NUM ] ;	// BufferPlayStateBackupFlag が有効かどうかのフラグ( TRUE:有効  FALSE:無効 )
	int							BufferPlayStateBackupFlag[ MAX_SOUNDBUFFER_NUM ] ;		// サウンドバッファを一時停止するときの再生状態フラグ
	SOUNDBUFFER					Buffer[ MAX_SOUNDBUFFER_NUM ] ;							// サウンドバッファ
	WAVEFORMATEX				BufferFormat ;											// サウンドバッファのフォーマット

	int							Type ;													// サウンドのタイプ
	int							PlayType ;												// 再生タイプ

	STREAMPLAYDATA				Stream ;												// ストリーム風サウンドプレイ用データ
	NORMALPLAYDATA				Normal ;												// ノーマルサウンドプレイ用データ

	int							PresetReverbParam ;										// ３Ｄサウンド時に設定するプリセットリバーブパラメータ番号( DX_REVERB_PRESET_DEFAULT 等 )
	SOUND3D_REVERB_PARAM		ReverbParam ;											// ３Ｄサウンド時に設定するリバーブパラメータ( PresetReverbParam が -1 の際に使用 )

	int							BaseVolume[ SOUNDBUFFER_MAX_CHANNEL_NUM ] ;				// 基本ボリューム( -1:デフォルト )
	int							BasePan ;												// 基本パン( -1:デフォルト )
	int							BaseFrequency ;											// 基本再生周波数( -1:デフォルト )
	VECTOR						Base3DPosition ;										// 基本再生位置
	float						Base3DRadius ;											// 基本聞こえる距離
	VECTOR						Base3DVelocity ;										// 基本音の速度
	int							PitchRateEnable ;										// ピッチレートが有効化どうか( TRUE:有効  FALSE:無効 )
	float						PitchRate ;												// ピッチレート

	BYTE						ValidNextPlayVolume[ SOUNDBUFFER_MAX_CHANNEL_NUM ] ;	// NextPlayVolume が有効かどうか( 1:有効 0:無効 )
	BYTE						ValidNextPlayPan ;										// NextPlayPan が有効かどうか( 1:有効 0:無効 )
	BYTE						ValidNextPlayFrequency ;								// NextPlayFrequency が有効かどうか( 1:有効 0:無効 )
	BYTE						ValidNextPlay3DPosition ;								// NextPlay3DPosition が有効かどうか( 1:有効 0:無効 )
	BYTE						ValidNextPlay3DRadius ;									// NextPlay3DRadius が有効かどうか( 1:有効 0:無効 )
	BYTE						ValidNextPlay3DVelocity ;								// NextPlay3DVelocity が有効かどうか( 1:有効 0:無効 )
	int							NextPlayVolume[ SOUNDBUFFER_MAX_CHANNEL_NUM ] ;			// 次に鳴らす音のボリューム
	int							NextPlayPan ;											// 次に鳴らす音のパン
	int							NextPlayFrequency ;										// 次に鳴らす音の周波数
	VECTOR						NextPlay3DPosition ;									// 次に鳴らす音の位置
	float						NextPlay3DRadius ;										// 次に鳴らす音の聞こえる距離
	VECTOR						NextPlay3DVelocity ;									// 次に鳴らす音の移動速度
} ;

SOUNDTYPE

で、大事なのがTypeです。これに入る値は、

DX_SOUNDTYPE_NORMAL

ノーマルサウンド形式

DX_SOUNDTYPE_STREAMSTYLE

ストリーム風サウンド形式

となります。

DX_SOUNDDATATYPE_MEMNOPRESSの場合

				// 丸々メモリに読み込む
				if( StreamFullRead( Stream, &SrcBuffer, &SrcSize ) < 0 )

まずはファイルからメモリー上に読み込みます

				res = SoundConvertFast( &ConvData, &Format, &PlayData->FileImage, &PlayData->FileImageSize ) ;

次にこれをWAVE形式に変換・展開していきます。ただし無圧縮ＰＣＭの場合はSoundConvertFast関数内部で純粋なコピーが行われます。

			// ＷＡＶＥファイルをでっち上げる
			if( CreateWaveFileImage( &WaveImage, &WaveSize,
								 &Format, sizeof( WAVEFORMATEX ),
								 PlayData->FileImage, PlayData->FileImageSize ) < 0 )
				goto ERR ;

			// 展開されたデータをストリームとして再度開く
			PlayData->MemStream.DataPoint = MemStreamOpen( WaveImage, ( size_t )WaveSize ) ;
			PlayData->MemStream.ReadShred = *GetMemStreamDataShredStruct() ;
			SetupSoundConvert( &PlayData->ConvData, &PlayData->MemStream, GParam->DisableReadSoundFunctionMask
#ifndef DX_NON_OGGVORBIS
				,GParam->OggVorbisBitDepth, GParam->OggVorbisFromTheoraFile
#endif
			) ;

			// メモリアドレスの入れ替え
			DXFREE( PlayData->FileImage ) ;
			PlayData->FileImage = WaveImage ;
			PlayData->FileImageSize = WaveSize ;

最後に変換したデータをサウンドハンドルに紐付けられた領域に登録します。

つまり、

圧縮された全データは再生が始まる前にサウンドメモリにすべて展開され、格納される。

のとおり実装されていることが確認できました。

DX_SOUNDDATATYPE_MEMPRESSの場合

			// 丸々メモリに読み込む
			if( StreamFullRead( Stream, &PlayData->FileImage, &PlayData->FileImageSize ) < 0 )

まずはファイルからメモリー上に読み込みます

			// 展開されたデータをストリームとして再度開く
			PlayData->MemStream.DataPoint = MemStreamOpen( PlayData->FileImage, ( size_t )PlayData->FileImageSize ) ;
			PlayData->MemStream.ReadShred = *GetMemStreamDataShredStruct() ;
			if( SetupSoundConvert( &PlayData->ConvData, &PlayData->MemStream, GParam->DisableReadSoundFunctionMask
#ifndef DX_NON_OGGVORBIS
									,GParam->OggVorbisBitDepth, GParam->OggVorbisFromTheoraFile
#endif
									) < 0 )

読み込んだデータをサウンドハンドルに紐付けられた領域に登録します。

この段階では

圧縮された全データはシステムメモリに格納され、再生する部分だけ逐次展開しながらサウンドメモリに格納する(鳴らし終わると展開したデータは破棄されるので何度も展開処理が行われる)

は確かめられていません。

DX_SOUNDDATATYPE_FILEの場合

			if( SetupSoundConvert( &PlayData->ConvData, Stream, GParam->DisableReadSoundFunctionMask
#ifndef DX_NON_OGGVORBIS
									,GParam->OggVorbisBitDepth, GParam->OggVorbisFromTheoraFile
#endif
								) < 0 )

ファイルストリームをサウンドハンドルに紐付けられた領域に登録します。

この段階では

圧縮されたデータの再生する部分だけファイルから逐次読み込み展開され、サウンドメモリに格納される(鳴らし終わると展開したデータは破棄されるので何度も展開処理が行われる)

は確かめられていません。

サウンドバッファの作成

このswitch文のあと、サウンドバッファの作成処理があります。

		// サウンドバッファを共有するかどうかで処理を分岐
		if( UniSound == NULL )
		{
			DWORD BufferSec ;

			// サウンドバッファを作成
			BufferSec = StreamDataType == DX_SOUNDDATATYPE_FILE ? STS_BUFSEC_FILE : STS_BUFSEC ;
			CreateSoundBuffer(
				&Sound->BufferFormat,
				SOUNDSIZE( BufferSec * Sound->BufferFormat.nAvgBytesPerSec / STS_DIVNUM, Sound->BufferFormat.nBlockAlign ),
				DX_SOUNDTYPE_STREAMSTYLE, 1, SoundHandle, -1, ASyncThread
			) ;
			Sound->Stream.SoundBufferSize = SOUNDSIZE( BufferSec * Sound->BufferFormat.nAvgBytesPerSec / STS_DIVNUM, Sound->BufferFormat.nBlockAlign ) ;
			Sound->BaseFrequency          = ( int )Sound->BufferFormat.nSamplesPerSec ;
//			Sound->PitchRateEnable        = GParam->CreateSoundPitchRateEnable ;
//			Sound->PitchRate              = GParam->CreateSoundPitchRate ;

			// 共有情報をセット
			Sound->Stream.BufferBorrowSoundHandle = -1 ;
		}

SoundBuffer_CycleProcess_PF()

extern int SoundBuffer_CycleProcess_PF( SOUNDBUFFER *Buffer )
{
	if( SoundSysData.PF.EnableXAudioFlag )
	{
		int NowCount ;
		int Time ;

		if( Buffer->PF.XA2SubmixVoice == NULL )
		{
			return -1 ;
		}

		if( Buffer->StopTimeState == 0 )
		{
			return -1 ;
		}

		if( Buffer->State == TRUE )
		{
			return 0 ;
		}

SoundBuffer_CycleProcess_PFという関数内で見られています。trueのとき、つまり再生中のとき0を返すんですね。

ProcessPlay3DSoundMemAll()

SoundBuffer_CycleProcess_PF関数はSoundBuffer_CycleProcess関数を介して呼ばれていますが、ProcessPlay3DSoundMemAll関数から呼ばれます。

// ３Ｄサウンドを再生しているサウンドハンドルに対する処理を行う
extern int ProcessPlay3DSoundMemAll( void )
{
	HANDLELIST *List ;
	SOUND *Sound ;
	int i ;
	int Valid ;

	if( CheckSoundSystem_Initialize_PF() == FALSE )
	{
		return -1 ;
	}

	// クリティカルセクションの取得
	CRITICALSECTION_LOCK( &SoundSysData.Play3DSoundListCriticalSection ) ;

LOOPSTART:
	for( List = SoundSysData.Play3DSoundListFirst.Next ; List->Next != NULL ; List = List->Next )
	{
		Sound = ( SOUND * )List->Data ;

		Valid = FALSE ;
		for( i = 0 ; i < Sound->ValidBufferNum ; i ++ )
		{
			if( Sound->Buffer[ i ].Valid == 0 )
			{
				continue ;
			}

			if( SoundBuffer_CycleProcess( &Sound->Buffer[ i ] ) == 0 )
			{
				Valid = TRUE ;
			}
		}

		if( Valid == FALSE )
		{
			Sound->AddPlay3DSoundList = FALSE ;
			SubHandleList( &Sound->Play3DSoundList ) ;
			goto LOOPSTART ;
		}
	}

	// クリティカルセクションの解放
	CriticalSection_Unlock( &SoundSysData.Play3DSoundListCriticalSection ) ;

	// 終了
	return 0 ;
}

SoundBuffer_CycleProcessが0を返すとき、つまり再生中のとき、Validはtrueになり、650行目のif文の処理が実行されます。

SubHandleList関数が呼ばれ、Listの要素が削除され、その後、なんとまさかのgoto文でループをやり直します。

ところでSoundSysData.Play3DSoundListFirst.Nextというリストの要素のメンバーであるDataの中にあるPlay3DSoundListを操作しているわけですが、これは一体何でしょうか？その2つのリストは同じものなのでしょうか？

また、なんでループをやり直すのでしょうか？