#include "EXPORT.h"
#include "Result.h"
マクロ定義 | |
#define | ResultFromPxtoneApiBoolean(succeeded) succeeded ? HELPER_SUCCESS : HELPER_PXTONE_ERROR |
型定義 | |
typedef int | NoiseId |
ピストンノイズヘルパ ID | |
typedef int | BOOL |
真偽値型 | |
関数 | |
EXPORT Result __stdcall | pxeasyHelper_Ready (long channel_num, long sample_per_second, long bit_per_sample, float buffer_second, BOOL use_directsound) |
ピストンコラージュヘルパ生成 | |
EXPORT Result __stdcall | pxeasyHelper_Reset (long channel_num, long sample_per_second, long bit_per_sample, float buffer_second, BOOL use_directsound) |
ピストンコラージュヘルパ再設定 | |
EXPORT Result __stdcall | pxeasyHelper_Release (void) |
ピストンコラージュヘルパ開放 | |
EXPORT BOOL __stdcall | pxeasyHelper_CopyLastError (char *destination, size_t size) |
ラストエラー文字列コピー | |
EXPORT BOOL __stdcall | pxeasyHelper_Tune_CopyName (char *destination, size_t size) |
曲名文字列コピー | |
EXPORT BOOL __stdcall | pxeasyHelper_Tune_CopyComment (char *destination, size_t size) |
コメント文字列コピー | |
EXPORT long __stdcall | pxeasyHelper_Tune_GetPlayClock (void) |
再生クロック取得 | |
EXPORT NoiseId __stdcall | pxeasyHelper_Noise_Create (const char *name, const char *type, long channel_num, long sample_per_second, long bit_per_sample) |
ピストンノイズヘルパ生成 | |
EXPORT Result __stdcall | pxeasyHelper_Noise_Play (NoiseId noise_id, unsigned long priority, BOOL play_loop) |
ピストンノイズヘルパ再生 | |
EXPORT Result __stdcall | pxeasyHelper_Noise_Stop (NoiseId noise_id) |
ピストンノイズヘルパ停止 | |
EXPORT Result __stdcall | pxeasyHelper_Noise_Release (NoiseId noise_id) |
ピストンノイズヘルパ開放 |
#define ResultFromPxtoneApiBoolean | ( | succeeded | ) | succeeded ? HELPER_SUCCESS : HELPER_PXTONE_ERROR |
typedef int BOOL |
真偽値型
typedef int NoiseId |
ピストンノイズヘルパ ID
EXPORT BOOL __stdcall pxeasyHelper_CopyLastError | ( | char * | destination, | |
size_t | size | |||
) |
ラストエラー文字列コピー
ラストエラー文字列を指定格納先にコピーします。 文字列を返す dll の関数は、言語によって制約などがあることがあります。 その場合は呼び出す側の言語でバッファを確保し、そこに文字列を書き込む このタイプの関数が有効な場合もあります。
destination | 文字列格納先 | |
size | 文字列バッファのサイズ (0 を渡すと十分なサイズであると解釈し、文字列を全部コピーします) |
EXPORT NoiseId __stdcall pxeasyHelper_Noise_Create | ( | const char * | name, | |
const char * | type, | |||
long | channel_num, | |||
long | sample_per_second, | |||
long | bit_per_sample | |||
) |
ピストンノイズヘルパ生成
ピストンノイズヘルパを生成します。 これは PXTONENOISEBUFFER を生成するのではなく、 すぐに再生可能な再生バッファを生成してその ID を返します。 pxtone.dll のエラー時は 0, pxeasy.dll のエラー時は -1 を返すのは Result と同様です。 ピストンコラージュが DirectSound を利用しない形で生成するとこの関数は使えません。
name | リソース・ファイル名 | |
type | リソースタイプ名 (ファイルの場合は NULL) | |
channel_num | チャンネル数 (stereo: 1, mono: 2) | |
sample_per_second | 秒間サンプル数 (Hz : 44100, 22050, 11025) | |
bit_per_sample | サンプルの量子化数 (bit : 8, 16) |
EXPORT Result __stdcall pxeasyHelper_Noise_Play | ( | NoiseId | noise_id, | |
unsigned long | priority, | |||
BOOL | play_loop | |||
) |
ピストンノイズヘルパ再生
ピストンノイズヘルパを再生します。
noise_id | ピストンノイズヘルパ ID | |
priority | 再生優先度 | |
play_loop | ループ再生の有無 |
ピストンノイズヘルパ開放
ピストンノイズヘルパを開放します。
noise_id | ピストンノイズヘルパ ID |
ピストンノイズヘルパ停止
ピストンノイズヘルパを停止します。
noise_id | ピストンノイズヘルパ ID |
EXPORT Result __stdcall pxeasyHelper_Ready | ( | long | channel_num, | |
long | sample_per_second, | |||
long | bit_per_sample, | |||
float | buffer_second, | |||
BOOL | use_directsound | |||
) |
ピストンコラージュヘルパ生成
ピストンコラージュヘルパを生成します。 ウィンドウとコールバックの指定は必要ありません。 ただし、ヘルパを生成したら必ず pxeasyHelper_Reset, pxeasyHelper_Release を使ってください。
channel_num | チャンネル数 (stereo: 1, mono: 2) | |
sample_per_second | 秒間サンプル数 (Hz : 44100, 22050, 11025) | |
bit_per_sample | サンプルの量子化数 (bit : 8, 16) | |
buffer_second | バッファ時間 (second : 0.1 推奨) | |
use_directsound | DirectSound を使うかどうか |
EXPORT Result __stdcall pxeasyHelper_Release | ( | void | ) |
ピストンコラージュヘルパ開放
ピストンコラージュヘルパを開放します。 pxeasyHelper_Ready でヘルパが生成された場合のみこれを呼び出して開放して下さい。 この開放処理は pxeasyHelper_Noise_Create で生成された音声を全て開放します。
EXPORT Result __stdcall pxeasyHelper_Reset | ( | long | channel_num, | |
long | sample_per_second, | |||
long | bit_per_sample, | |||
float | buffer_second, | |||
BOOL | use_directsound | |||
) |
ピストンコラージュヘルパ再設定
ピストンコラージュヘルパを再設定します。 pxeasyHelper_Ready でヘルパが生成された場合のみこれを呼び出して再設定して下さい。 この再設定処理は pxeasyHelper_Noise_Create で生成された音声を全て開放します。
channel_num | チャンネル数 (stereo: 1, mono: 2) | |
sample_per_second | 秒間サンプル数 (Hz : 44100, 22050, 11025) | |
bit_per_sample | サンプルの量子化数 (bit : 8, 16) | |
buffer_second | バッファ時間 (second : 0.1 推奨) | |
use_directsound | DirectSound を使うかどうか |
EXPORT BOOL __stdcall pxeasyHelper_Tune_CopyComment | ( | char * | destination, | |
size_t | size | |||
) |
コメント文字列コピー
コメント文字列を指定格納先にコピーします。 pxeasyHelper_CopyLastError と同様の目的の関数です。 pxeasy_GetComment はコメントがないと NULL を返しますが、 この関数は文字列をコピーして返します。
destination | 文字列格納先 | |
size | 文字列バッファのサイズ (0 を渡すと十分なサイズであると解釈し、文字列を全部コピーします) |
EXPORT BOOL __stdcall pxeasyHelper_Tune_CopyName | ( | char * | destination, | |
size_t | size | |||
) |
曲名文字列コピー
曲名文字列を指定格納先にコピーします。 pxeasyHelper_CopyLastError と同様の目的の関数です。
destination | 文字列格納先 | |
size | 文字列バッファのサイズ (0 を渡すと十分なサイズであると解釈し、文字列を全部コピーします) |
EXPORT long __stdcall pxeasyHelper_Tune_GetPlayClock | ( | void | ) |
再生クロック取得
現在の再生クロックを取得します。 言語を越えてコールバック関数を渡すことは実質できないと思うので、 PXTONEPLAY_CALLBACK が取得する再生クロックはこの関数で取得できるようにしています。 ただし、pxeasyHelper_Ready でヘルパを生成していないと 0 を返します。