spInputPlugin クラス

プラグインを用いたファイルからの入力を扱うためのクラスです． [詳解]

#include <sp/spInputPlugin.h>

spInputPlugin の継承関係図

spInputPlugin 連携図

関連関数
（これらはメソッドではありません）
long	spReadPlugin (spPlugin *plugin, void *data, long length)
long	spReadPluginInByte (spPlugin *plugin, void *data, long data_size)
long	spReadPluginDouble (spPlugin *plugin, double *data, long length)
long	spReadPluginDoubleWeighted (spPlugin *plugin, double *data, long length, double weight)
spBool	spSeekPlugin (spPlugin *plugin, spLong pos)
spLong	spGetPluginTotalLength (spPlugin *plugin)
基底クラス spOutputPlugin に属する継承関連関数
long	spWritePlugin (spPlugin *plugin, void *data, long length)
long	spWritePluginInByte (spPlugin *plugin, void *data, long data_size)
long	spWritePluginDoubleWeighted (spPlugin *plugin, double *data, long length, double weight)
long	spWritePluginDouble (spPlugin *plugin, double *data, long length)
char *	xspFindRelatedPluginFile (const char *plugin_name)
char *	xspFindSuitablePluginFileWithPriority (spPluginDeviceType device_type, const char *filename, const char *mode, int *current_priority)
char *	xspFindSuitablePluginFile (spPluginDeviceType device_type, const char *filename, const char *mode)
spPlugin *	spOpenFilePlugin (const char *plugin_name, const char *filename, const char *mode, spPluginDeviceType device_type, spWaveInfo *wave_info, spSongInfo *song_info, spPluginOpenCallback call_func, void *call_data, spPluginError *error)
spPlugin *	spOpenFilePluginAuto (const char *plugin_name, const char *filename, const char *mode, spPluginDeviceType device_type, spWaveInfo *wave_info, spSongInfo *song_info, spPluginOpenCallback call_func, void *call_data, spPluginError *error)
spPlugin *	spOpenFilePluginArg (const char *plugin_name, const char *filename, const char *mode, spPluginDeviceType device_type, spWaveInfo *wave_info, spSongInfo *song_info, int argc, char **argv, spPluginError *error)
spPlugin *	spOpenFilePluginArgAuto (const char *plugin_name, const char *filename, const char *mode, spPluginDeviceType device_type, spWaveInfo *wave_info, spSongInfo *song_info, int argc, char **argv, spPluginError *error)
spBool	spCloseFilePlugin (spPlugin *plugin)

詳解

プラグインを用いたファイルからの入力を扱うためのクラスです．

実際には，クラスではなく， typedef struct _spPlugin spPlugin; により定義された spPlugin 型を用いて処理を行います．

参照

プラグインによる入出力 , spOutputPlugin

フレンドと関連関数の詳解

spReadPlugin()

long spReadPlugin ( spPlugin * plugin, void * data, long length )

related

プラグインを用いてファイルからデータを読み込みます． spReadPluginInByte() とはデータの長さの与え方が異なるだけです．

引数

[in]	plugin	spOpenFilePlugin() で得られた spPlugin 型へのポインタを指定します．
[out]	data	読み込みデータを保持するバッファです．ファイルの量子化ビット数に応じて型が変わります． 8・16ビットであればshort型，24・32ビットであればlong型，64ビットであればdouble型になります．
[in]	length	読み込むポイント数です（継続時間長をポイント単位にしたものではありません）． 例えば，ステレオデータの場合であれば，読み込む継続時間長をポイント単位にしたものの2倍の値です．

戻り値

読み込まれたポイント数が返ります．正常に読み込めた場合は引数の length と同じ値になります．

spReadPluginInByte()

long spReadPluginInByte ( spPlugin * plugin, void * data, long data_size )

related

プラグインを用いてファイルからデータを読み込みます． spReadPlugin() とはデータの長さの与え方が異なるだけです．

引数

[in]	plugin	spOpenFilePlugin() で得られた spPlugin 型へのポインタを指定します．
[out]	data	読み込みデータを保持するバッファです．ファイルの量子化ビット数に応じて型が変わります． 8・16ビットであればshort型，24・32ビットであればlong型，64ビットであればdouble型になります．
[in]	data_size	読み込むバイト数です．

戻り値

読み込まれたバイト数が返ります．正常に読み込めた場合は引数のdata_size と同じ値になります．

spReadPluginDouble()

long spReadPluginDouble ( spPlugin * plugin, double * data, long length )

related

プラグインを用いてファイルからデータを読み込みます．取り得る値の範囲は，原則として-1〜1です．

引数

[in]	plugin	spOpenFilePlugin() で得られた spPlugin 型へのポインタを指定します．
[out]	data	読み込みデータを保持するバッファです．
[in]	length	読み込むポイント数です（継続時間長をポイント単位にしたものではありません）． 例えば，ステレオデータの場合であれば，読み込む継続時間長をポイント単位にしたものの2倍の値です．

戻り値

読み込まれたポイント数が返ります．正常に読み込めた場合は引数の length と同じ値になります．

spReadPluginDoubleWeighted()

long spReadPluginDoubleWeighted ( spPlugin * plugin, double * data, long length, double weight )

related

プラグインを用いてファイルからデータを読み込みます．取り得る値の範囲は，原則として-1〜1です．

引数

[in]	plugin	spOpenFilePlugin() で得られた spPlugin 型へのポインタを指定します．
[out]	data	読み込みデータを保持するバッファです．
[in]	length	読み込むポイント数です（継続時間長をポイント単位にしたものではありません）． 例えば，ステレオデータの場合であれば，読み込む継続時間長をポイント単位にしたものの2倍の値です．
[in]	weight	読み込み後にデータの振幅値を何倍するかを指定します．

戻り値

読み込まれたポイント数が返ります．正常に読み込めた場合は引数の length と同じ値になります．

spSeekPlugin()

spBool spSeekPlugin ( spPlugin * plugin, spLong pos )

related

データの読み出し位置を移動します． この関数が終了した後に spReadPlugin() 等の読み込み関数を呼び出すと，この関数で指定した時刻から読み込みがスタートします．

引数

[in]	plugin	spOpenFilePlugin() で得られた spPlugin 型へのポインタを指定します．
[in]	pos	時刻をポイント単位にしたものを指定します．

戻り値

SP_TRUE	成功
SP_FALSE	失敗

spGetPluginTotalLength()

spLong spGetPluginTotalLength ( spPlugin * plugin )

related

信号の継続時間長を取得します． ファイル形式によっては常に0が返ることがあります．

引数

[in]

plugin

spOpenFilePlugin() で得られた spPlugin 型へのポインタを指定します．

戻り値

信号の継続時間長がポイント単位で返ります．