SoundLoader_Opus Class Reference

Opus sound loader. More...

Inheritance diagram for SoundLoader_Opus:

Public Member Functions
bool	Load (SoundEntry &sound, bool new_format, std::vector< std::byte > &data) const override
	Load a sound from the file and offset in the given sound entry.
Public Member Functions inherited from SoundLoader
	SoundLoader (std::string_view name, std::string_view description, int priority)
Public Member Functions inherited from PriorityBaseProvider< SoundLoader >
constexpr	PriorityBaseProvider (std::string_view name, std::string_view description, int priority)
int	GetPriority () const
Public Member Functions inherited from BaseProvider< SoundLoader >
constexpr	BaseProvider (std::string_view name, std::string_view description)
std::string_view	GetName () const
std::string_view	GetDescription () const

Static Public Attributes
static constexpr uint16_t	OPUS_SAMPLE_RATE = 48000
	OpusFile always decodes at 48kHz.
static constexpr uint8_t	OPUS_SAMPLE_BITS = 16
	OpusFile op_read() uses 16 bits per sample.
static constexpr size_t	MIN_OPUS_FILE_SIZE = 57U
static constexpr size_t	DECODE_BUFFER_SAMPLES = 5760 * 2
static constexpr size_t	DECODE_BUFFER_BYTES = DECODE_BUFFER_SAMPLES * sizeof(opus_int16)

Static Private Attributes
static SoundLoader_Opus	instance {}

Additional Inherited Members
Protected Attributes inherited from PriorityBaseProvider< SoundLoader >
const int	priority
Protected Attributes inherited from BaseProvider< SoundLoader >
const std::string_view	name
const std::string_view	description

Detailed Description

Opus sound loader.

Definition at line 23 of file soundloader_opus.cpp.

Constructor & Destructor Documentation

SoundLoader_Opus()

SoundLoader_Opus::SoundLoader_Opus ( )

inline

Definition at line 25 of file soundloader_opus.cpp.

Member Function Documentation

Load()

bool SoundLoader_Opus::Load ( SoundEntry & sound, bool new_format, std::vector< std::byte > & data ) const

inlineoverridevirtual

Load a sound from the file and offset in the given sound entry.

It is up to the implementations to update the sound's channels, bits_per_sample and rate.

Parameters

	sound	The entry to load.
	new_format	Whether this is an old format soundset (with some buggy data), or the new format.
[out]	data	The vector to write the decoded sound data into.

Returns

true iff the entry was loaded correctly.

Implements SoundLoader.

Definition at line 38 of file soundloader_opus.cpp.

References Debug, RandomAccessFile::GetPos(), OPUS_SAMPLE_BITS, OPUS_SAMPLE_RATE, RandomAccessFile::ReadBlock(), and RandomAccessFile::SeekTo().

Field Documentation

DECODE_BUFFER_BYTES

size_t SoundLoader_Opus::DECODE_BUFFER_BYTES = DECODE_BUFFER_SAMPLES * sizeof(opus_int16)

staticconstexpr

Definition at line 36 of file soundloader_opus.cpp.

DECODE_BUFFER_SAMPLES

size_t SoundLoader_Opus::DECODE_BUFFER_SAMPLES = 5760 * 2

staticconstexpr

Definition at line 35 of file soundloader_opus.cpp.

instance

SoundLoader_Opus SoundLoader_Opus::instance {}

staticprivate

Definition at line 102 of file soundloader_opus.cpp.

MIN_OPUS_FILE_SIZE

size_t SoundLoader_Opus::MIN_OPUS_FILE_SIZE = 57U

staticconstexpr

Definition at line 31 of file soundloader_opus.cpp.

OPUS_SAMPLE_BITS

uint8_t SoundLoader_Opus::OPUS_SAMPLE_BITS = 16

staticconstexpr

OpusFile op_read() uses 16 bits per sample.

Definition at line 28 of file soundloader_opus.cpp.

Referenced by Load().

OPUS_SAMPLE_RATE

uint16_t SoundLoader_Opus::OPUS_SAMPLE_RATE = 48000

staticconstexpr

OpusFile always decodes at 48kHz.

Definition at line 27 of file soundloader_opus.cpp.

Referenced by Load().

---

The documentation for this class was generated from the following file:

• src/soundloader_opus.cpp