BASS_OPUS_StreamCreateFile

Creates a sample stream from an Opus file.

HSTREAM BASS_OPUS_StreamCreateFile(
    BOOL mem,
    void *file,
    QWORD offset,
    QWORD length,
    DWORD flags
);

Parameters

mem

TRUE = stream the file from memory.

file

Filename (mem = FALSE) or a memory location (mem = TRUE).

offset

File offset to begin streaming from (only used if mem = FALSE).

length

Data length... 0 = use all data up to the end of the file (if mem = FALSE).

flags

A combination of these flags.

BASS_SAMPLE_FLOAT	Use 32-bit floating-point sample data. See Floating-point channels for info. If this flag is not specified, then the stream is 16-bit.
BASS_SAMPLE_3D	Enable 3D functionality. The stream must be mono. The SPEAKER flags cannot be used together with this flag.
BASS_SAMPLE_LOOP	Loop the file. This flag can be toggled at any time using BASS_ChannelFlags.
BASS_STREAM_PRESCAN	Pre-scan the file for seek points and accurate length reading in chained Opus files (has no effect on normal Opus files). This can significantly increase the time taken to create the stream, particularly with a large file and/or slow storage media.
BASS_STREAM_AUTOFREE	Automatically free the stream when playback ends.
BASS_STREAM_DECODE	Decode the sample data, without playing it. Use BASS_ChannelGetData to retrieve decoded sample data. The BASS_SAMPLE_3D, BASS_STREAM_AUTOFREE and SPEAKER flags cannot be used together with this flag.
BASS_SPEAKER_xxx	Speaker assignment flags. These flags have no effect when the stream is more than stereo.
BASS_ASYNCFILE	Read the file asynchronously. When enabled, the file is read and buffered in parallel with the decoding, to reduce the chances of the decoder being affected by I/O delays. This can be particularly useful with slow storage media and/or low latency output. The size of the file buffer is determined by the BASS_CONFIG_ASYNCFILE_BUFFER config option. This flag is ignored when streaming from memory (mem = TRUE).
BASS_UNICODE	file is in UTF-16 form. Otherwise it is ANSI on Windows and UTF-8 on other platforms.

Return value

If successful, the new stream's handle is returned, else 0 is returned. Use BASS_ErrorGetCode to get the error code.

Error codes

BASS_ERROR_INIT	BASS_Init has not been successfully called.
BASS_ERROR_NOTAVAIL	The BASS_STREAM_AUTOFREE flag cannot be combined with the BASS_STREAM_DECODE flag.
BASS_ERROR_ILLPARAM	The length must be specified when streaming from memory.
BASS_ERROR_FILEOPEN	The file could not be opened.
BASS_ERROR_FILEFORM	The file's format is not recognised/supported.
BASS_ERROR_FORMAT	The sample format is not supported.
BASS_ERROR_SPEAKER	The specified SPEAKER flags are invalid.
BASS_ERROR_MEM	There is insufficent memory.
BASS_ERROR_NO3D	Could not initialize 3D support.
BASS_ERROR_UNKNOWN	Some other mystery problem!

Remarks

Use BASS_ChannelGetInfo to retrieve information on the format of the stream. Opus always has a sample rate of 48000 Hz, but the source material may have had a different sample rate, which is available via the BASS_ATTRIB_OPUS_ORIGFREQ attribute. The playback length of the stream can be retrieved using BASS_ChannelGetLength.

The Opus file format is Ogg-based, so the standard BASS_TAG_OGG and BASS_TAG_VENDOR tag types apply to Opus too, via BASS_ChannelGetTags.

Chained Opus files containing multiple logical bitstreams are supported, but they will need to be scanned to get their length or to seek in them. That scanning will be done at stream creation or at the first BASS_ChannelGetLength or BASS_ChannelSetPosition call, depending on whether the BASS_CONFIG_OGG_PRESCAN option is enabled (or the BASS_STREAM_PRESCAN flag is used). The BASS_POS_OGG "mode" can be used with BASS_ChannelGetLength to get the number of bitstreams and with BASS_ChannelSetPosition to seek to a particular one. A BASS_SYNC_OGG_CHANGE sync can be set via BASS_ChannelSetSync to be informed of when a new bitstream begins during decoding/playback.

To stream a file from the internet, use BASS_OPUS_StreamCreateURL. To stream from other locations, see BASS_OPUS_StreamCreateFileUser.

Example

Create a stream of an Opus file.