pxplain.h

#include "EXPORT.h"

pxplain.hのインクルード依存関係図

このグラフは、どのファイルから直接、間接的にインクルードされているかを示しています。


関数

EXPORT int __stdcall pxplain_Ready (int channel_num, int sample_per_second, int bit_per_sample, int buffer_milisecond, int use_directsound)
 pxtone 生成
EXPORT int __stdcall pxplain_Reset (int channel_num, int sample_per_second, int bit_per_sample, int buffer_milisecond, int use_directsound)
 pxtone 再設定
EXPORT const char *__stdcall pxplain_GetLastError (void)
 ラストエラー文字列取得
EXPORT int __stdcall pxplain_CopyLastError (char *destination, int size)
 ラストエラー文字列コピー
EXPORT int __stdcall pxplain_GetChannelNum (void)
 チャンネル数取得
EXPORT int __stdcall pxplain_GetSamplePerSecond (void)
 サンプルレート取得
EXPORT int __stdcall pxplain_GetBitPerSample (void)
 サンプル量子化数取得
EXPORT int __stdcall pxplain_GetSamplePerBuffer (void)
 バッファごとのサンプル数取得
EXPORT int __stdcall pxplain_Release (void)
 pxtone 開放
EXPORT int __stdcall pxplain_Tune_Load (const char *filepath)
 ファイルから曲を読み込み
EXPORT int __stdcall pxplain_Tune_Release (void)
 曲開放
EXPORT int __stdcall pxplain_Tune_Start (int start_sample, int fadein_milisecond)
 曲再生
EXPORT int __stdcall pxplain_Tune_Fadeout (int fadeout_milisecond)
 フェードアウトスイッチを入れて現在再生サンプルを取得
EXPORT void __stdcall pxplain_Tune_SetVolume (int volume_percentage)
 曲のボリュームを設定
EXPORT int __stdcall pxplain_Tune_Stop (void)
 曲を停止して現在再生サンプルを取得
EXPORT int __stdcall pxplain_Tune_IsStreaming (void)
 再生中かどうか
EXPORT void __stdcall pxplain_Tune_SetLoop (int enable_loop)
 ループ再生の切り替え
EXPORT int __stdcall pxplain_Tune_GetBeatNum (void)
 曲の拍子数取得
EXPORT int __stdcall pxplain_Tune_GetBeatTempoPercentage (void)
 曲の拍子テンポ取得
EXPORT int __stdcall pxplain_Tune_GetBeatClock (void)
 曲の拍子時間取得
EXPORT int __stdcall pxplain_Tune_GetMeasNum (void)
 曲の小節数取得
EXPORT int __stdcall pxplain_Tune_GetRepeatMeas (void)
 リピート小節を取得
EXPORT int __stdcall pxplain_Tune_GetPlayMeas (void)
 有効演奏小節を取得
EXPORT const char *__stdcall pxplain_Tune_GetName (void)
 曲名を取得
EXPORT int __stdcall pxplain_Tune_CopyName (char *destination, int size)
 曲名コピー
EXPORT const char *__stdcall pxplain_Tune_GetComment (void)
 曲のコメントを取得
EXPORT int __stdcall pxplain_Tune_CopyComment (char *destination, int size)
 曲のコメントコピー
EXPORT int __stdcall pxplain_Tune_GetPlayClock (void)
 再生時間を取得
EXPORT int __stdcall pxplain_Noise_Create (const char *name, int channel_num, int sample_per_second, int bit_per_sample)
 サウンド生成
EXPORT int __stdcall pxplain_Noise_Play (int noise_id, int priority, int play_loop)
 サウンド再生
EXPORT int __stdcall pxplain_Noise_Stop (int noise_id)
 サウンド停止
EXPORT int __stdcall pxplain_Noise_Release (int noise_id)
 サウンド開放

関数

EXPORT int __stdcall pxplain_CopyLastError ( char *  destination,
int  size 
)

ラストエラー文字列コピー

ラストエラー文字列を指定格納先にコピーします。 文字列を返す dll の関数は、言語によって制約などがあることがあります。 その場合は呼び出す側の言語でバッファを確保し、そこに文字列を書き込む このタイプの関数が有効な場合もあります。

引数:
destination 文字列格納先
size 文字列バッファのサイズ (0 を渡すと十分なサイズであると解釈し、文字列を全部コピーします)
戻り値:
文字列が格納先に全部収まったかどうか

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_GetBitPerSample ( void   ) 

サンプル量子化数取得

サンプルの量子化数を取得します。

戻り値:
サンプルの量子化数

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_GetChannelNum ( void   ) 

チャンネル数取得

チャンネル数を取得します。

戻り値:
チャンネル数

関数の呼び出しグラフ:

EXPORT const char* __stdcall pxplain_GetLastError ( void   ) 

ラストエラー文字列取得

ラストエラー文字列を取得します。

戻り値:
ラストエラー文字列

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_GetSamplePerBuffer ( void   ) 

バッファごとのサンプル数取得

バッファごとのサンプル数を取得します。 秒間サンプル数 * バッファ時間 (秒) と同じ値になるはずです。

戻り値:
バッファごとのサンプル数

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_GetSamplePerSecond ( void   ) 

サンプルレート取得

秒間サンプル数を取得します。

戻り値:
秒間サンプル数

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_Noise_Create ( const char *  name,
int  channel_num,
int  sample_per_second,
int  bit_per_sample 
)

サウンド生成

ピストンノイズヘルパを生成します。 これは PXTONENOISEBUFFER を生成するのではなく、 すぐに再生可能な再生バッファを生成してその ID を返します。 pxtone.dll のエラー時は 0, pxeasy.dll のエラー時は -1 を返します。 ピストンコラージュが DirectSound を利用しない形で生成するとこの関数は使えません。

引数:
name リソース・ファイル名
channel_num チャンネル数 (stereo: 1, mono: 2)
sample_per_second 秒間サンプル数 (Hz : 44100, 22050, 11025)
bit_per_sample サンプルの量子化数 (bit : 8, 16)
戻り値:
ピストンノイズヘルパ ID (0: pxtone.dll error, -1: pxeasy.dll error)

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_Noise_Play ( int  noise_id,
int  priority,
int  play_loop 
)

サウンド再生

ピストンノイズヘルパを再生します。

引数:
noise_id ピストンノイズヘルパ ID
priority 再生優先度
play_loop ループ再生の有無
戻り値:
処理結果 (-1: pxeasy.dll error, 0: pxtone.dll error, 1: success)

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_Noise_Release ( int  noise_id  ) 

サウンド開放

ピストンノイズヘルパを開放します。

引数:
noise_id ピストンノイズヘルパ ID
戻り値:
処理結果 (-1: pxeasy.dll error, 0: pxtone.dll error, 1: success)

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_Noise_Stop ( int  noise_id  ) 

サウンド停止

ピストンノイズヘルパを停止します。

引数:
noise_id ピストンノイズヘルパ ID
戻り値:
処理結果 (-1: pxeasy.dll error, 0: pxtone.dll error, 1: success)

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_Ready ( int  channel_num,
int  sample_per_second,
int  bit_per_sample,
int  buffer_milisecond,
int  use_directsound 
)

pxtone 生成

pxtone を生成します。 この関数で生成された場合は pxplain_Reset, pxplain_Release で開放するようにして下さい。

引数:
channel_num チャンネル数 (stereo: 1, mono: 2)
sample_per_second 秒間サンプル数 (Hz : 44100, 22050, 11025)
bit_per_sample サンプルの量子化数 (bit : 8, 16)
buffer_second バッファ時間 (milisecond : 100 推奨)
use_directsound DirectSound を使うかどうか
戻り値:
処理結果 (-1: pxeasy.dll error, 0: pxtone.dll error, 1: success)

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_Release ( void   ) 

pxtone 開放

pxplain_Ready で生成された場合のみこれを呼び出して開放して下さい。 この開放処理は pxplain_Noise_Create で生成された音声を全て開放します。

戻り値:
処理結果

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_Reset ( int  channel_num,
int  sample_per_second,
int  bit_per_sample,
int  buffer_milisecond,
int  use_directsound 
)

pxtone 再設定

pxtone を再設定します。 pxplain_Ready で生成された場合のみこれを呼び出して再設定して下さい。 この再設定処理は pxplain_Noise_Create で生成された音声を全て開放します。

引数:
channel_num チャンネル数 (stereo: 1, mono: 2)
sample_per_second 秒間サンプル数 (Hz : 44100, 22050, 11025)
bit_per_sample サンプルの量子化数 (bit : 8, 16)
buffer_second バッファ時間 (milisecond : 100 推奨)
use_directsound DirectSound を使うかどうか
戻り値:
処理結果 (-1: pxeasy.dll error, 0: pxtone.dll error, 1: success)

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_Tune_CopyComment ( char *  destination,
int  size 
)

曲のコメントコピー

コメント文字列を指定格納先にコピーします。 コメントが何もない場合は空文字列をコピーして返します。

引数:
destination 文字列格納先
size 文字列バッファのサイズ (0 を渡すと十分なサイズであると解釈し、文字列を全部コピーします)
戻り値:
文字列が格納先に全部収まったかどうか

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_Tune_CopyName ( char *  destination,
int  size 
)

曲名コピー

曲名文字列を指定格納先にコピーします。

引数:
destination 文字列格納先
size 文字列バッファのサイズ (0 を渡すと十分なサイズであると解釈し、文字列を全部コピーします)
戻り値:
文字列が格納先に全部収まったかどうか

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_Tune_Fadeout ( int  fadeout_milisecond  ) 

フェードアウトスイッチを入れて現在再生サンプルを取得

フェードアウトスイッチを入れて現在再生サンプルを取得します。 指定した時間で曲はフェードアウトして停止します。 取得した再生サンプルは次回再生時に渡すと、その再生位置から再開します。

引数:
fadeout_milisecond フェードアウトする時間 (ミリ秒) return 再生サンプル

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_Tune_GetBeatClock ( void   ) 

曲の拍子時間取得

曲の拍子時間を取得します。

戻り値:
曲の拍子時間

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_Tune_GetBeatNum ( void   ) 

曲の拍子数取得

曲の拍子数を取得します。

戻り値:
曲の拍子数

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_Tune_GetBeatTempoPercentage ( void   ) 

曲の拍子テンポ取得

曲の拍子テンポを取得します。

戻り値:
曲の拍子テンポ (百分率)

関数の呼び出しグラフ:

EXPORT const char* __stdcall pxplain_Tune_GetComment ( void   ) 

曲のコメントを取得

現在読み込まれている曲のコメントを取得します。 コメントが何もない場合は NULL ではなく空文字列を返します。

戻り値:
曲のコメント

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_Tune_GetMeasNum ( void   ) 

曲の小節数取得

曲全体の小節数を取得します。

戻り値:
曲の小節数

関数の呼び出しグラフ:

EXPORT const char* __stdcall pxplain_Tune_GetName ( void   ) 

曲名を取得

現在読み込まれている曲の曲名を取得します。

戻り値:
曲名

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_Tune_GetPlayClock ( void   ) 

再生時間を取得

現在の再生クロックを取得します。 言語を越えてコールバック関数を渡すことは実質できないと思うので、 PXTONEPLAY_CALLBACK が取得する再生クロックはこの関数で取得できるようにしています。 ただし、pxplain_Ready でヘルパを生成していないと 0 を返します。

戻り値:
再生クロック数

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_Tune_GetPlayMeas ( void   ) 

有効演奏小節を取得

現在読み込まれている曲の有効演奏小節を取得します。 有効演奏小節は LAST イベントが設定されている小節です。 LAST が存在しない場合は最後の小節を返します。

戻り値:
有効演奏小節

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_Tune_GetRepeatMeas ( void   ) 

リピート小節を取得

現在読み込まれている曲のリピート小節を取得します。 リピート小節は REPEAT イベントが設定されている小節です。 ループ再生は REPEAT と LAST の間を再生し続けます。 REPEAT が存在しない場合は最初の小節 1 を返します。

戻り値:
リピート小節

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_Tune_IsStreaming ( void   ) 

再生中かどうか

現在再生中かどうかを取得します。

戻り値:
現在再生中かどうか

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_Tune_Load ( const char *  filepath  ) 

ファイルから曲を読み込み

ファイルから曲ファイルを読み込みます。 pxplain はリソースからの読み込みはできません。

引数:
filepath ファイルパス
戻り値:
処理の成否 (0: 失敗, 0以外: 成功)

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_Tune_Release ( void   ) 

曲開放

曲を開放開放します。

戻り値:
処理の成否 (0: 失敗, 0以外: 成功)

関数の呼び出しグラフ:

EXPORT void __stdcall pxplain_Tune_SetLoop ( int  enable_loop  ) 

ループ再生の切り替え

ループ再生を切り替えます。 デフォルトではループ再生が有効です。

引数:
enable_loop ループを有効にするかどうか

関数の呼び出しグラフ:

EXPORT void __stdcall pxplain_Tune_SetVolume ( int  volume_percentage  ) 

曲のボリュームを設定

曲のボリュームを設定します。

引数:
volume_percentage 音量 (0 - 100)

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_Tune_Start ( int  start_sample,
int  fadein_milisecond 
)

曲再生

曲を再生します。

引数:
start_sample 再生開始サンプル (pxplain_Tune_Stop などで手に入れられる値)
fadein_milisecond フェードインする時間 (ミリ秒)
戻り値:
処理の成否 (0: 失敗, 0以外: 成功)

関数の呼び出しグラフ:

EXPORT int __stdcall pxplain_Tune_Stop ( void   ) 

曲を停止して現在再生サンプルを取得

曲を停止して現在再生サンプルを取得します。 取得した再生サンプルは次回再生時に渡すと、その再生位置から再開します。

戻り値:
再生サンプル

関数の呼び出しグラフ:


Fri May 22 14:21:59 2009に生成されました。  doxygen 1.5.6