nCine::AudioReaderXmp class

Audio reader for tracker module formats, backed by libxmp.

Lightweight alternative to AudioReaderMpt for slow platforms (e.g. Amiga). The whole module is loaded into memory, so rendering needs no file I/O.

Base classes

class IAudioReader
Interface for an audio reader.

Constructors, destructors, conversion operators

AudioReaderXmp(std::unique_ptr<Death::IO::Stream> fileHandle, std::int32_t frequency)
~AudioReaderXmp()
AudioReaderXmp(const AudioReaderXmp&) deleted

Public functions

auto operator=(const AudioReaderXmp&) -> AudioReaderXmp& deleted
auto Read(void* buffer, std::int32_t bufferSize) const -> std::int32_t override
Decodes audio data into the specified buffer.
void Rewind() const override
Rewinds the reader back to the beginning.
void SetLooping(bool value) override
Enables native stream looping if the format supports it.

Function documentation

std::int32_t nCine::AudioReaderXmp::Read(void* buffer, std::int32_t bufferSize) const override

Decodes audio data into the specified buffer.

Parameters
buffer Destination buffer
bufferSize Buffer size in bytes
Returns Number of bytes actually written