spInputPlugin Class Reference

A class to handle plugin-based input from an audio file. More...

#include <sp/spInputPlugin.h>

Inheritance diagram for spInputPlugin:

Collaboration diagram for spInputPlugin:

Related Symbols
(Note that these are not member symbols.)
long	spReadPlugin (spPlugin *plugin, void *data, long length)
long	spReadPluginInByte (spPlugin *plugin, void *data, long data_size)
long	spReadPluginDoubleWeighted (spPlugin *plugin, double *data, long length, double weight)
long	spReadPluginDouble (spPlugin *plugin, double *data, long length)
spBool	spSeekPlugin (spPlugin *plugin, spLong pos)
spLong	spGetPluginTotalLength (spPlugin *plugin)
Related Symbols inherited from 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)

Detailed Description

A class to handle plugin-based input from an audio file.

Actually, spInputPlugin is not a class. You can handle this by using spPlugin type typedefed by typedef struct _spPlugin spPlugin;.

See also

I/O by Plugin , spOutputPlugin

Friends And Related Symbol Documentation

spReadPlugin()

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

related

Read data from a file by using a plugin. The difference from spReadPluginInByte() is how to specify the size of data.

Parameters

[in]	plugin	spPlugin pointer obtained by spOpenFilePlugin() .
[out]	data	Data buffer to hold read data. The type of data depends on bits/sample of data; short for 8/16 bits, long for 24/32 bits, and double for 64 bits.
[in]	length	The length of data . Note that this length is not identical to duration in points.

Returns

Read length. This value is the same as length if successful.

spReadPluginInByte()

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

related

Read data from a file by using a plugin. The difference from spReadPlugin() is how to specify the size of data.

Parameters

[in]	plugin	spPlugin pointer obtained by spOpenFilePlugin() .
[out]	data	Data buffer to hold read data. The type of data depends on bits/sample of data; short for 8/16 bits, long for 24/32 bits, and double for 64 bits.
[in]	data_size	The size of data in bytes.

Returns

Read size in bytes. This value is the same as data_size if successful.

spReadPluginDoubleWeighted()

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

related

Read data from a file by using a plugin. The value of the data must be basically from -1 to 1 inclusive. The difference from spReadPluginInByte() is how to specify the size of data.

Parameters

[in]	plugin	spPlugin pointer obtained by spOpenFilePlugin() .
[out]	data	Data buffer to hold read data. The type of data depends on bits/sample of data; short for 8/16 bits, long for 24/32 bits, and double for 64 bits.
[in]	length	The length of data . Note that this length is not identical to duration in points.
[in]	weight	This value is multiplied to the data after reading.

Returns

Read length. This value is the same as length if successful.

spReadPluginDouble()

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

related

Read data from a file by using a plugin. The value of the data must be basically from -1 to 1 inclusive. The difference from spReadPluginInByte() is how to specify the size of data.

Parameters

[in]	plugin	spPlugin pointer obtained by spOpenFilePlugin() .
[out]	data	Data buffer to hold read data. The type of data depends on bits/sample of data; short for 8/16 bits, long for 24/32 bits, and double for 64 bits.
[in]	length	The length of data . Note that this length is not identical to duration in points.

Returns

Read length. This value is the same as length if successful.

spSeekPlugin()

spBool spSeekPlugin ( spPlugin * plugin, spLong pos )

related

Move the position pointer to the specified position.

Parameters

[in]	plugin	spPlugin pointer obtained by spOpenFilePlugin() .
[in]	pos	Offset time in points.

Return values

SP_TRUE	Success
SP_FALSE	Failure

spGetPluginTotalLength()

spLong spGetPluginTotalLength ( spPlugin * plugin )

related

Get the total duration of the file by using a plugin. Note that the function call for some file formats returns always 0.

Parameters

[in]

plugin

spPlugin pointer obtained by spOpenFilePlugin() .

Returns

The total duration in points of the file.