AV module
PlanarAudioPacket
Audio packet for planar formats.
PlanarAudioPacket
#include <icy/av/packet.h>struct PlanarAudioPacketDefined in src/av/include/icy/av/packet.h:197
Inherits:
AudioPacket
Audio packet for planar formats.
Parameters
dataArray of per-plane sample buffers (one per channel).channelsThe number of audio channels.numSamplesThe number of samples per channel.sampleFmtThe sample format name (e.g. "fltp").timeThe timestamp in microseconds.
List of all members
| Name | Kind | Owner |
|---|---|---|
buffer | variable | Declared here |
linesize | variable | Declared here |
channels | variable | Declared here |
sampleFmt | variable | Declared here |
owns_buffer | variable | Declared here |
PlanarAudioPacket | function | Declared here |
PlanarAudioPacket | function | Declared here |
~PlanarAudioPacket | function | Declared here |
clone | function | Declared here |
className | function | Declared here |
numSamples | variable | Inherited from AudioPacket |
avpacket | variable | Inherited from AudioPacket |
AudioPacket | function | Inherited from AudioPacket |
~AudioPacket | function | Inherited from AudioPacket |
clone | function | Inherited from AudioPacket |
samples | function | Inherited from AudioPacket |
className | function | Inherited from AudioPacket |
time | variable | Inherited from MediaPacket |
MediaPacket | function | Inherited from MediaPacket |
MediaPacket | function | Inherited from MediaPacket |
MediaPacket | function | Inherited from MediaPacket |
~MediaPacket | function | Inherited from MediaPacket |
clone | function | Inherited from MediaPacket |
className | function | Inherited from MediaPacket |
RawPacket | function | Inherited from RawPacket |
RawPacket | function | Inherited from RawPacket |
RawPacket | function | Inherited from RawPacket |
~RawPacket | function | Inherited from RawPacket |
clone | function | Inherited from RawPacket |
copyData | function | Inherited from RawPacket |
read | function | Inherited from RawPacket |
write | function | Inherited from RawPacket |
data | function | Inherited from RawPacket |
size | function | Inherited from RawPacket |
className | function | Inherited from RawPacket |
ownsBuffer | function | Inherited from RawPacket |
_data | variable | Inherited from RawPacket |
_size | variable | Inherited from RawPacket |
_owned | variable | Inherited from RawPacket |
operator<< | friend | Inherited from IPacket |
opaque | variable | Inherited from IPacket |
info | variable | Inherited from IPacket |
flags | variable | Inherited from IPacket |
IPacket | function | Inherited from IPacket |
IPacket | function | Inherited from IPacket |
operator= | function | Inherited from IPacket |
clone | function | Inherited from IPacket |
~IPacket | function | Inherited from IPacket |
read | function | Inherited from IPacket |
write | function | Inherited from IPacket |
size | function | Inherited from IPacket |
hasData | function | Inherited from IPacket |
data | function | Inherited from IPacket |
constData | function | Inherited from IPacket |
className | function | Inherited from IPacket |
print | function | Inherited from IPacket |
Inherited from AudioPacket
| Kind | Name | Description |
|---|---|---|
variable | numSamples | Number of audio samples per channel. |
variable | avpacket | Non-owning pointer to the encoded AVPacket from FFmpeg. Set by AudioEncoder, read by MultiplexEncoder. |
function | AudioPacket inline | Construct an audio packet with an interleaved sample buffer. |
function | ~AudioPacket virtual | Defaulted destructor. |
function | clone virtual const inline override | |
function | samples virtual const inline | |
function | className virtual const inline override | Returns the class name of this packet type for logging and diagnostics. |
Inherited from MediaPacket
| Kind | Name | Description |
|---|---|---|
variable | time | Presentation timestamp in microseconds. |
function | MediaPacket inline | Construct with a non-owning or owning mutable buffer. |
function | MediaPacket inline | Construct with const data (copied, owning). |
function | MediaPacket inline | Copy constructor. |
function | ~MediaPacket virtual | Defaulted destructor. |
function | clone virtual const inline override | |
function | className virtual const inline override | Returns the class name of this packet type for logging and diagnostics. |
Inherited from RawPacket
| Kind | Name | Description |
|---|---|---|
function | RawPacket inline | Construct with borrowed (non-owning) buffer. |
function | RawPacket inline | Construct with const data (copied, owning). |
function | RawPacket inline | Copy constructor (always copies data). |
function | ~RawPacket virtual | Defaulted destructor. |
function | clone virtual const inline override | |
function | copyData virtual inline | Copies data into an internally owned buffer, replacing any prior content. |
function | read virtual inline override | Reads from the buffer by copying its contents into an owned buffer. |
function | write virtual const inline override | Appends the packet data to the given output buffer. |
function | data virtual const inline override | |
function | size virtual const inline override | |
function | className virtual const inline override | Returns the class name of this packet type for logging and diagnostics. |
function | ownsBuffer const inline | |
variable | _data | |
variable | _size | |
variable | _owned |
Inherited from IPacket
| Kind | Name | Description |
|---|---|---|
friend | operator<< inline | Stream insertion operator; delegates to print(). |
variable | opaque | Optional type-safe context data. Use std::any_cast to retrieve. Lifetime of the stored value is tied to the packet's lifetime. |
variable | info | Optional extra information about the packet. |
variable | flags | Provides basic information about the packet. |
function | IPacket inline | |
function | IPacket inline | Copy constructor; clones the info object if present. |
function | operator= inline | Copy assignment; clones the info object if present. |
function | clone virtual const | Returns a heap-allocated deep copy of this packet. |
function | ~IPacket virtual | Defaulted destructor. |
function | read virtual | Read/parse to the packet from the given input buffer. The number of bytes read is returned. |
function | write virtual const | Copy/generate to the packet given output buffer. The number of bytes written can be obtained from the buffer. |
function | size virtual const inline | The size of the packet in bytes. |
function | hasData virtual const inline | Returns true if the packet has a non-null data pointer. |
function | data virtual const inline | The packet data pointer for buffered packets. |
function | constData virtual const inline | The const packet data pointer for buffered packets. |
function | className virtual const | Returns the class name of this packet type for logging and diagnostics. |
function | print virtual const inline | Prints a human-readable representation to the given stream. |
Public Attributes
| Return | Name | Description |
|---|---|---|
uint8_t * | buffer | |
int | linesize | |
int | channels | |
std::string | sampleFmt | |
bool | owns_buffer |
buffer
uint8_t * buffer = {nullptr}Defined in src/av/include/icy/av/packet.h:199
linesize
int linesize = 0Defined in src/av/include/icy/av/packet.h:200
channels
int channels = 0Defined in src/av/include/icy/av/packet.h:201
sampleFmt
std::string sampleFmtDefined in src/av/include/icy/av/packet.h:202
owns_buffer
bool owns_buffer = falseDefined in src/av/include/icy/av/packet.h:203
Public Methods
| Return | Name | Description |
|---|---|---|
PlanarAudioPacket | Construct a planar audio packet, copying the plane pointers (not the sample data). | |
PlanarAudioPacket | Copy constructor. Performs a deep copy of the owned buffer if owns_buffer is set. | |
std::unique_ptr< IPacket > | clone virtual const inline override | |
const char * | className virtual const inline override | Returns the class name of this packet type for logging and diagnostics. |
PlanarAudioPacket
PlanarAudioPacket(uint8_t * data, int channels = 0, size_t numSamples = 0, const std::string & sampleFmt = "", int64_t time = 0)Defined in src/av/include/icy/av/packet.h:211
Construct a planar audio packet, copying the plane pointers (not the sample data).
Parameters
dataArray of up to 4 per-channel sample buffers.channelsNumber of audio channels.numSamplesNumber of samples per channel.sampleFmtThe sample format string (e.g. "fltp").timePresentation timestamp in microseconds.
PlanarAudioPacket
PlanarAudioPacket(const PlanarAudioPacket & r)Defined in src/av/include/icy/av/packet.h:215
Copy constructor. Performs a deep copy of the owned buffer if owns_buffer is set.
clone
virtual const inline override
virtual inline std::unique_ptr< IPacket > clone() const overrideDefined in src/av/include/icy/av/packet.h:219
Returns
A heap-allocated deep copy of this packet.
Reimplements
className
virtual const inline override
virtual inline const char * className() const overrideDefined in src/av/include/icy/av/packet.h:221
Returns the class name of this packet type for logging and diagnostics.
