BASS_Encode_StartPCMFile

Sets up a PCM/WAVE/AIFF encoder on a channel, writing the output to a file.

HENCODE BASS_Encode_StartPCMFile(
    DWORD handle,
    DWORD flags,
    char *filename
);

Parameters

handle

The channel handle... a HSTREAM, HMUSIC, or HRECORD.

flags

A combination of these flags.

BASS_ENCODE_NOHEAD	Do not write any headers.
BASS_ENCODE_AIFF	Write an AIFF header instead of a WAVE header. This flag is ignored if the BASS_ENCODE_NOHEAD is used.
BASS_ENCODE_RF64	Write an RF64 header instead of a standard RIFF header, allowing more than 4GB of sample data. This flag is ignored if the BASS_ENCODE_NOHEAD or BASS_ENCODE_AIFF flags are used.
BASS_ENCODE_WFEXT	Write the sample format information in WAVEFORMATEXTENSIBLE form instead of WAVEFORMATEX form. This flag is ignored if the BASS_ENCODE_NOHEAD or BASS_ENCODE_AIFF flags are used.
BASS_ENCODE_BIGEND	Write big-endian sample data, else little-endian. This flag is ignored unless the BASS_ENCODE_NOHEAD flag is used.
BASS_ENCODE_FP_8BIT, BASS_ENCODE_FP_16BIT, BASS_ENCODE_FP_24BIT, BASS_ENCODE_FP_32BIT	Convert floating-point sample data to 8/16/24/32 bit integer. These flags are ignored if the channel is not floating-point and the BASS_CONFIG_FLOATDSP option is not enabled.
BASS_ENCODE_FP_AUTO	Convert floating-point sample data back to the channel's format (8/16 bit integer) if the data is only floating-point due to the BASS_CONFIG_FLOATDSP option being enabled.
BASS_ENCODE_DITHER	Apply dither (TPDF) when converting floating-point sample data to integer.
BASS_ENCODE_QUEUE	Queue data to write asynchronously. This prevents the data source (DSP system or BASS_Encode_Write call) getting blocked by the writing, and can improve performance through multithreading, but if data is queued more quickly than the encoder can process it then that could result in lost data.
BASS_ENCODE_QUEUE_WAIT	This is the same as BASS_ENCODE_QUEUE except that it will wait for space in the queue rather than drop data (so the data source may get blocked).
BASS_ENCODE_LIMIT	Limit the processing rate to real-time speed, by introducing a delay when the rate is too high. With BASS 2.4.6 or above, this flag is ignored when the encoder is fed in a playback buffer update cycle (including BASS_Update and BASS_ChannelUpdate calls), to avoid possibly causing playback buffer underruns.
BASS_ENCODE_PAUSE	Start the encoder in a paused state.
BASS_ENCODE_AUTOFREE	Automatically free the encoder when the source channel is freed. If it has queued data, the encoder will be freed asynchronously once that has been processed.

filename

The output filename.

Return value

The encoder handle is returned if the encoder is successfully started, else 0 is returned. Use BASS_ErrorGetCode to get the error code.

Error codes

BASS_ERROR_HANDLE	handle is not valid.
BASS_ERROR_CREATE	The file could not be created.
BASS_ERROR_MEM	There is insufficient memory.
BASS_ERROR_UNKNOWN	Some other mystery problem!

Remarks

This function is identical to BASS_Encode_StartPCM, except that it writes the data to a file instead of a callback function.

Example

Start writing a channel to a WAV file (output.wav).