Class AudioDecoderBase

src/audio_decoder_base.h:37–287

* The AudioDecoder class provides an abstraction over the decoding of * common audio formats. * This is the base class containing shared logic. * See AudioDecoder for sample based decoding and AudioDecoderMidi for * Midi event based decoding. */

 * Midi event based decoding.
 */
class AudioDecoderBase {
public:
	/**
	 * Takes a linear volume and converts it to a logarithmic used by
	 * RPG_RT (Direct Sound).
	 * Do not use this for Midi, is already logarithmic by design.
	 *
	 * @param volume linear volume
	 * @return logarithmic volume
	 */
	static float AdjustVolume(float volume);

	virtual ~AudioDecoderBase() = default;

	/** Sample format */
	enum class Format {
		S8,
		U8,
		S16,
		U16,
		S32,
		U32,
		F32
	};

	/**
	 * Writes 'size' bytes in the specified buffer. The data matches the format
	 * reported by GetFormat.
	 * When size is is smaller then the amount of written bytes or an error occurs
	 * the remaining buffer space is cleared.
	 *
	 * @param buffer Output buffer
	 * @param size Size of the buffer in bytes
	 * @return Number of bytes written to the buffer or -1 on error
	 */
	int Decode(uint8_t* buffer, int size);

	/**
	 * Decodes the whole audio sample. The data matches the format reported by
	 * GetFormat.
	 *
	 * @return output buffer
	 */
	std::vector<uint8_t> DecodeAll();

	/**
	 * Rewinds the audio stream to the beginning.
	 */
	void Rewind();

	/**
	 * Gets if the audio stream will loop when the stream finishes.
	 *
	 * @return if looping
	 */
	virtual bool GetLooping() const;

	/**