AV module
AudioPacket
Audio packet for interleaved formats.
AudioPacket
#include <icy/av/packet.h>struct AudioPacketDefined in src/av/include/icy/av/packet.h:154
Inherits:
MediaPacketSubclassed by:PlanarAudioPacket
Audio packet for interleaved formats.
List of all members
| Name | Kind | Owner |
|---|---|---|
numSamples | variable | Declared here |
avpacket | variable | Declared here |
AudioPacket | function | Declared here |
~AudioPacket | function | Declared here |
clone | function | Declared here |
samples | function | Declared here |
className | function | Declared here |
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 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 |
|---|---|---|
size_t | numSamples | Number of audio samples per channel. |
AVPacket * | avpacket | Non-owning pointer to the encoded AVPacket from FFmpeg. Set by AudioEncoder, read by MultiplexEncoder. |
numSamples
size_t numSamplesDefined in src/av/include/icy/av/packet.h:156
Number of audio samples per channel.
avpacket
AVPacket * avpacket = nullptrDefined in src/av/include/icy/av/packet.h:160
Non-owning pointer to the encoded AVPacket from FFmpeg. Set by AudioEncoder, read by MultiplexEncoder.
Public Methods
| Return | Name | Description |
|---|---|---|
AudioPacket inline | Construct an audio packet with an interleaved sample buffer. | |
std::unique_ptr< IPacket > | clone virtual const inline override | |
uint8_t * | samples virtual const inline | |
const char * | className virtual const inline override | Returns the class name of this packet type for logging and diagnostics. |
AudioPacket
inline
inline AudioPacket(uint8_t * data = nullptr, size_t size = 0, size_t numSamples = 0, int64_t time = 0)Defined in src/av/include/icy/av/packet.h:167
Construct an audio packet with an interleaved sample buffer.
Parameters
dataPointer to the interleaved sample buffer (may be null).sizeSize of the buffer in bytes.numSamplesNumber of samples per channel.timePresentation timestamp in microseconds.
clone
virtual const inline override
virtual inline std::unique_ptr< IPacket > clone() const overrideDefined in src/av/include/icy/av/packet.h:178
Returns
A heap-allocated copy of this packet.
Reimplements
Reimplemented by
samples
virtual const inline
virtual inline uint8_t * samples() constDefined in src/av/include/icy/av/packet.h:181
Returns
A pointer to the raw interleaved sample buffer.
className
virtual const inline override
virtual inline const char * className() const overrideDefined in src/av/include/icy/av/packet.h:186
Returns the class name of this packet type for logging and diagnostics.
