StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Multimedia::FFmpeg::AVPacket Class Reference

RAII owner of a libav AVPacket. More...

#include <StormByte/multimedia/ffmpeg/AVPacket.hxx>

Inheritance diagram for StormByte::Multimedia::FFmpeg::AVPacket:
Collaboration diagram for StormByte::Multimedia::FFmpeg::AVPacket:

Public Member Functions

 AVPacket () noexcept
 Allocates an empty packet.
 AVPacket (const AVPacket &other) noexcept
 Copy.
 AVPacket (AVPacket &&other) noexcept=default
 Move constructor.
 ~AVPacket () noexcept override
 Destructor.
AVPacket & operator= (const AVPacket &other) noexcept
 Copy assignment.
AVPacket & operator= (AVPacket &&other) noexcept=default
 Move assignment.
FFmpeg::AVPacket Ref () const noexcept
 New packet referencing the same data (av_packet_ref).
void Unref () noexcept
 Unreferences packet data (av_packet_unref).
bool Load (const std::uint8_t *data, int size, int stream_index, bool key_frame) noexcept
 Replaces payload for avcodec_send_packet.
void Timestamps (std::int64_t pts, std::int64_t dts, std::int64_t duration) noexcept
 Sets timestamps in stream time base.
int StreamIndex () const noexcept
 Packet stream index.
std::int64_t Pts () const noexcept
 Presentation timestamp in stream time base.
std::int64_t Dts () const noexcept
 Decode timestamp in stream time base.
std::int64_t Duration () const noexcept
 Packet duration in stream time base.
int Flags () const noexcept
 Packet flags (AV_PKT_FLAG_*).
const std::uint8_t * Data () const noexcept
 Compressed payload pointer.
int Size () const noexcept
 Compressed payload size in bytes.
std::int64_t Position () const noexcept
 Byte position of this packet in its input source.
 operator bool () const noexcept
 Whether a packet struct is owned.
int SideDataCount () const noexcept
 Number of side-data entries.
int SideDataType (int index) const noexcept
 Side-data type at index.
const std::uint8_t * SideData (int index, int &size) const noexcept
 Side-data payload at index.
void Reset (::AVPacket *raw) noexcept
 Adopts raw.
Public Member Functions inherited from StormByte::Multimedia::FFmpeg::AVPointer<::AVPacket >
constexpr AVPointer () noexcept=delete
 Default constructor (deleted).
virtual ~AVPointer () noexcept=default
 Destructor.
constexpr AVPointer & operator= (const AVPointer &) noexcept=delete
 Copy assignment (deleted).

Friends

class AVBSF
 Allows bitstream filters to access the raw packet.
class AVDecoder
 Allows the decoder to access the raw packet.
class AVEncoder
 Allows the encoder to access the raw packet.
class AVFormatContext
 Allows the format context to access the raw packet.
class StormByte::Multimedia::Backend::Pipeline::Packet
 Allows the backend packet holder to access the raw packet.
class StormByte::Multimedia::Pipeline::Filter::FFmpeg
 Allows the filter base to access the raw packet.

Additional Inherited Members

Protected Member Functions inherited from StormByte::Multimedia::FFmpeg::AVPointer<::AVPacket >
constexpr const std::decay_t< ::AVPacket > * Get () const noexcept
 Const view of the raw FFmpeg pointer.
constexpr std::decay_t< ::AVPacket > * Detach () noexcept
 Yields the raw pointer and leaves this wrapper empty.
Protected Attributes inherited from StormByte::Multimedia::FFmpeg::AVPointer<::AVPacket >
std::decay_t< ::AVPacket > * m_ptr
 FFmpeg pointer; concrete wrapper defines ownership.

Detailed Description

RAII owner of a libav AVPacket.

Copy and StormByte::Multimedia::FFmpeg::AVPacket::Ref share compressed buffers (av_packet_ref). They are not a deep copy of payload. Each wrapper still owns its own AVPacket struct. Get() and Detach() are not public.

Constructor & Destructor Documentation

◆ AVPacket() [1/3]

StormByte::Multimedia::FFmpeg::AVPacket::AVPacket ( )
noexcept

Allocates an empty packet.

◆ AVPacket() [2/3]

StormByte::Multimedia::FFmpeg::AVPacket::AVPacket ( const AVPacket & other)
noexcept

Copy.

New struct; payload buffers are referenced (av_packet_ref).

Parameters
otherSource packet.

Not a deep copy of compressed bytes.

◆ AVPacket() [3/3]

StormByte::Multimedia::FFmpeg::AVPacket::AVPacket ( AVPacket && other)
defaultnoexcept

Move constructor.

Transfers the libav pointer.

Parameters
otherSource packet; left empty.

◆ ~AVPacket()

StormByte::Multimedia::FFmpeg::AVPacket::~AVPacket ( )
overridenoexcept

Destructor.

Unreferences buffers and frees the struct.

Member Function Documentation

◆ Data()

const std::uint8_t * StormByte::Multimedia::FFmpeg::AVPacket::Data ( ) const
noexcept

Compressed payload pointer.

Returns
data, or nullptr if empty.

◆ Dts()

std::int64_t StormByte::Multimedia::FFmpeg::AVPacket::Dts ( ) const
noexcept

Decode timestamp in stream time base.

Returns
DTS, or AV_NOPTS_VALUE.

◆ Duration()

std::int64_t StormByte::Multimedia::FFmpeg::AVPacket::Duration ( ) const
noexcept

Packet duration in stream time base.

Returns
Duration ticks, or 0.

◆ Flags()

int StormByte::Multimedia::FFmpeg::AVPacket::Flags ( ) const
noexcept

Packet flags (AV_PKT_FLAG_*).

Returns
Flags, or 0 if empty.

◆ Load()

bool StormByte::Multimedia::FFmpeg::AVPacket::Load ( const std::uint8_t * data,
int size,
int stream_index,
bool key_frame )
noexcept

Replaces payload for avcodec_send_packet.

Parameters
dataCompressed bytes.
sizeByte count.
stream_indexStream index.
key_frameSets AV_PKT_FLAG_KEY when true.
Returns
false if allocation failed.

◆ operator bool()

StormByte::Multimedia::FFmpeg::AVPacket::operator bool ( ) const
explicitnoexcept

Whether a packet struct is owned.

Returns
true if the wrapper holds a packet.

◆ operator=() [1/2]

AVPacket & StormByte::Multimedia::FFmpeg::AVPacket::operator= ( AVPacket && other)
defaultnoexcept

Move assignment.

Frees *this, then takes other.

Parameters
otherSource packet; left empty.
Returns
*this.

◆ operator=() [2/2]

AVPacket & StormByte::Multimedia::FFmpeg::AVPacket::operator= ( const AVPacket & other)
noexcept

Copy assignment.

Same as the copy constructor.

Parameters
otherSource packet.
Returns
*this.

◆ Position()

std::int64_t StormByte::Multimedia::FFmpeg::AVPacket::Position ( ) const
noexcept

Byte position of this packet in its input source.

Returns
Source offset, or -1 when unavailable.

◆ Pts()

std::int64_t StormByte::Multimedia::FFmpeg::AVPacket::Pts ( ) const
noexcept

Presentation timestamp in stream time base.

Returns
PTS, or AV_NOPTS_VALUE.

◆ Ref()

FFmpeg::AVPacket StormByte::Multimedia::FFmpeg::AVPacket::Ref ( ) const
noexcept

New packet referencing the same data (av_packet_ref).

Returns
Referenced packet.

Same as the copy constructor.

◆ Reset()

void StormByte::Multimedia::FFmpeg::AVPacket::Reset ( ::AVPacket * raw)
noexcept

Adopts raw.

Previous packet is freed.

Parameters
rawlibav packet, or nullptr.

◆ SideData()

const std::uint8_t * StormByte::Multimedia::FFmpeg::AVPacket::SideData ( int index,
int & size ) const
noexcept

Side-data payload at index.

Parameters
indexEntry index.
sizeSet to payload size on success.
Returns
Pointer, or nullptr.

◆ SideDataCount()

int StormByte::Multimedia::FFmpeg::AVPacket::SideDataCount ( ) const
noexcept

Number of side-data entries.

Returns
Count, or 0.

◆ SideDataType()

int StormByte::Multimedia::FFmpeg::AVPacket::SideDataType ( int index) const
noexcept

Side-data type at index.

Parameters
indexEntry index.
Returns
AVPacketSideDataType as int, or -1.

◆ Size()

int StormByte::Multimedia::FFmpeg::AVPacket::Size ( ) const
noexcept

Compressed payload size in bytes.

Returns
size, or 0 if empty.

◆ StreamIndex()

int StormByte::Multimedia::FFmpeg::AVPacket::StreamIndex ( ) const
noexcept

Packet stream index.

Returns
stream_index, or -1 if empty.

◆ Timestamps()

void StormByte::Multimedia::FFmpeg::AVPacket::Timestamps ( std::int64_t pts,
std::int64_t dts,
std::int64_t duration )
noexcept

Sets timestamps in stream time base.

Parameters
ptsPresentation timestamp, or AV_NOPTS_VALUE.
dtsDecode timestamp, or AV_NOPTS_VALUE.
durationDuration ticks, or 0.

◆ Unref()

void StormByte::Multimedia::FFmpeg::AVPacket::Unref ( )
noexcept

Unreferences packet data (av_packet_unref).

◆ AVBSF

friend class AVBSF
friend

Allows bitstream filters to access the raw packet.

◆ AVDecoder

friend class AVDecoder
friend

Allows the decoder to access the raw packet.

◆ AVEncoder

friend class AVEncoder
friend

Allows the encoder to access the raw packet.

◆ AVFormatContext

friend class AVFormatContext
friend

Allows the format context to access the raw packet.

◆ StormByte::Multimedia::Backend::Pipeline::Packet

friend class StormByte::Multimedia::Backend::Pipeline::Packet
friend

Allows the backend packet holder to access the raw packet.

◆ StormByte::Multimedia::Pipeline::Filter::FFmpeg

Allows the filter base to access the raw packet.


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