AudioBuffer
#include <icy/av/audiobuffer.h>
struct AudioBufferDefined in src/av/include/icy/av/audiobuffer.h:31
Public Attributes
| Return | Name | Description |
|---|---|---|
AVAudioFifo * | fifo | Underlying FFmpeg audio FIFO handle. |
fifo
AVAudioFifo * fifoDefined in src/av/include/icy/av/audiobuffer.h:71
Underlying FFmpeg audio FIFO handle.
Public Methods
| Return | Name | Description |
|---|---|---|
AudioBuffer | ||
~AudioBuffer noexcept | ||
AudioBuffer | Deleted constructor. | |
AudioBuffer & | operator= | Deleted assignment operator. |
AudioBuffer | Deleted constructor. | |
AudioBuffer & | operator= | Deleted assignment operator. |
void | alloc | Allocate the audio FIFO buffer. |
void | reset | Discard all samples currently held in the FIFO without freeing the buffer. |
void | close | Free the underlying AVAudioFifo buffer. |
void | write | Write samples into the FIFO buffer. |
bool | read | Read samples from the FIFO buffer. |
int | available const | Return the number of samples per channel currently available in the FIFO. |
AudioBuffer
AudioBuffer()Defined in src/av/include/icy/av/audiobuffer.h:33
~AudioBuffer
noexcept
~AudioBuffer() noexceptDefined in src/av/include/icy/av/audiobuffer.h:34
AudioBuffer
AudioBuffer(const AudioBuffer &) = deleteDefined in src/av/include/icy/av/audiobuffer.h:36
Deleted constructor.
operator=
AudioBuffer & operator=(const AudioBuffer &) = deleteDefined in src/av/include/icy/av/audiobuffer.h:37
Deleted assignment operator.
AudioBuffer
AudioBuffer(AudioBuffer &&) = deleteDefined in src/av/include/icy/av/audiobuffer.h:38
Deleted constructor.
operator=
AudioBuffer & operator=(AudioBuffer &&) = deleteDefined in src/av/include/icy/av/audiobuffer.h:39
Deleted assignment operator.
alloc
void alloc(const std::string & sampleFmt, int channels, int numSamples = 1024)Defined in src/av/include/icy/av/audiobuffer.h:46
Allocate the audio FIFO buffer.
Parameters
| Parameter | Type | Description |
|---|---|---|
sampleFmt | const std::string & | The sample format name (e.g. "s16", "fltp"). |
channels | int | The number of audio channels. |
numSamples | int | The initial buffer capacity in samples per channel. |
reset
void reset()Defined in src/av/include/icy/av/audiobuffer.h:49
Discard all samples currently held in the FIFO without freeing the buffer.
close
void close()Defined in src/av/include/icy/av/audiobuffer.h:52
Free the underlying AVAudioFifo buffer.
write
void write(void ** samples, int numSamples)Defined in src/av/include/icy/av/audiobuffer.h:58
Write samples into the FIFO buffer.
Parameters
| Parameter | Type | Description |
|---|---|---|
samples | void ** | Array of per-channel sample buffers. |
numSamples | int | The number of samples per channel to write. |
read
bool read(void ** samples, int numSamples)Defined in src/av/include/icy/av/audiobuffer.h:65
Read samples from the FIFO buffer.
Returns
True if enough samples were available.
Parameters
| Parameter | Type | Description |
|---|---|---|
samples | void ** | Array of per-channel sample buffers to fill. |
numSamples | int | The number of samples per channel to read. |
available
const
int available() constDefined in src/av/include/icy/av/audiobuffer.h:69
Return the number of samples per channel currently available in the FIFO.
Returns
The number of available samples, or zero if the buffer is not allocated.