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

One side-data blob attached to a Frame or Packet. More...

#include <StormByte/multimedia/pipeline/side_data.hxx>

Public Member Functions

 SideData ()
 Empty unnamed blob of kind Other for Safe value storage.
 SideData (SideDataKind kind, StormByte::Buffer::FIFO payload)
 Known kind plus payload.
 SideData (StormByte::Safe::String name, StormByte::Buffer::FIFO payload)
 Other kind plus FFmpeg name and payload.
 SideData (const SideData &other)
 Copy constructor.
 SideData (SideData &&other) noexcept
 Move constructor.
 ~SideData () noexcept
 Destructor.
SideData & operator= (const SideData &other)
 Copy assignment.
SideData & operator= (SideData &&other) noexcept
 Move assignment.
SideDataKind Kind () const noexcept
 Kind.
const StormByte::Safe::Optional< StormByte::Safe::String > & Name () const noexcept
 libav name when Kind is Other.
const StormByte::Buffer::FIFO & Payload () const noexcept
 Raw payload.
StormByte::Buffer::FIFO & Payload () noexcept
 Raw payload (mutable).

Detailed Description

One side-data blob attached to a Frame or Packet.

Copies duplicate the side-data bytes independently of the original.

Constructor & Destructor Documentation

◆ SideData() [1/5]

StormByte::Multimedia::Pipeline::SideData::SideData ( )

Empty unnamed blob of kind Other for Safe value storage.

Exceptions
StormByte::ExceptionIf safe optional storage cannot be allocated.

◆ SideData() [2/5]

StormByte::Multimedia::Pipeline::SideData::SideData ( SideDataKind kind,
StormByte::Buffer::FIFO payload )

Known kind plus payload.

Parameters
kindSide-data kind.
payloadRaw bytes.
Exceptions
StormByte::ExceptionIf safe optional storage cannot be allocated.

◆ SideData() [3/5]

StormByte::Multimedia::Pipeline::SideData::SideData ( StormByte::Safe::String name,
StormByte::Buffer::FIFO payload )

Other kind plus FFmpeg name and payload.

Parameters
namelibav side-data name.
payloadRaw bytes.

Sets Kind to SideDataKind::Other.

Exceptions
StormByte::ExceptionIf optional storage cannot be allocated.

◆ SideData() [4/5]

StormByte::Multimedia::Pipeline::SideData::SideData ( const SideData & other)

Copy constructor.

Parameters
otherSource blob.
Exceptions
StormByte::ExceptionIf safe metadata storage cannot be copied.

◆ SideData() [5/5]

StormByte::Multimedia::Pipeline::SideData::SideData ( SideData && other)
noexcept

Move constructor.

Parameters
otherBlob to take.

◆ ~SideData()

StormByte::Multimedia::Pipeline::SideData::~SideData ( )
noexcept

Destructor.

Member Function Documentation

◆ Kind()

SideDataKind StormByte::Multimedia::Pipeline::SideData::Kind ( ) const
noexcept

Kind.

Returns
Kind.

◆ Name()

const StormByte::Safe::Optional< StormByte::Safe::String > & StormByte::Multimedia::Pipeline::SideData::Name ( ) const
noexcept

libav name when Kind is Other.

Returns
Borrowed name, or empty; valid until this blob is modified or destroyed.

◆ operator=() [1/2]

SideData & StormByte::Multimedia::Pipeline::SideData::operator= ( const SideData & other)

Copy assignment.

Parameters
otherSource blob.
Returns
*this.
Exceptions
StormByte::ExceptionIf safe metadata storage cannot be copied.

◆ operator=() [2/2]

SideData & StormByte::Multimedia::Pipeline::SideData::operator= ( SideData && other)
noexcept

Move assignment.

Parameters
otherBlob to take.
Returns
*this.

◆ Payload() [1/2]

const StormByte::Buffer::FIFO & StormByte::Multimedia::Pipeline::SideData::Payload ( ) const
noexcept

Raw payload.

Returns
FIFO.

◆ Payload() [2/2]

StormByte::Buffer::FIFO & StormByte::Multimedia::Pipeline::SideData::Payload ( )
noexcept

Raw payload (mutable).

Returns
FIFO.

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