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

Facade shared by Frame and Packet. More...

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

Inheritance diagram for StormByte::Multimedia::Pipeline::Item:
Collaboration diagram for StormByte::Multimedia::Pipeline::Item:

Public Member Functions

Identity
Kind Kind () const noexcept
 Whether this unit is a frame or a packet.
enum StormByte::Multimedia::Type Type () const noexcept
 Media of this access unit.
int Track () const noexcept
 Origin track index.
enum Producer Producer () const noexcept
 Stage that created this unit.

Friends

class Backend::Pipeline::Frame
 Allows the decoded-AU holder to access item identity.
class Backend::Pipeline::Packet
 Allows the compressed-AU holder to access item identity.
class Backend::Pipeline::Pipe
 Allows hoppers to clone items internally.
class Decoder
 Allows the decoder to access item identity.
class Demuxer
 Allows the demuxer to access item identity.
class Encoder
 Allows the encoder to access item identity.
class Filter::FFmpeg
 Allows the filter base to access item identity.
class Frame
 Allows the frame facade to construct its item base.
class Muxer
 Allows the muxer to access item identity.
class Packet
 Allows the packet facade to construct its item base.
class Step
 Allows pipeline stages to access item identity.

Lifecycle

virtual ~Item () noexcept=default
 Destructor.
 Item (const Item &other) noexcept=default
 Copy constructor.
 Item (Item &&other) noexcept=default
 Move constructor.
Item & operator= (const Item &other) noexcept=default
 Copy assignment.
Item & operator= (Item &&other) noexcept=default
 Move assignment.

Additional Inherited Members

Protected Types inherited from StormByte::Safe::Clonable< Item >
typedef SmartPointer PointerType
Protected Member Functions inherited from StormByte::Safe::Clonable< Item >
constexpr Clonable ()=default
constexpr Clonable & operator= (const Clonable &)=default
virtual constexpr ~Clonable () noexcept=default
virtual PointerType Clone () const =0
virtual PointerType Move ()=0
Static Protected Member Functions inherited from StormByte::Safe::Clonable< Item >
static PointerType MakePointer (Args &&... args)

Detailed Description

Facade shared by Frame and Packet.

Clone (via StormByte::Safe::Clonable) returns a new StormByte::Safe::Shared and shares media buffers. It is not a deep copy of planes or packet payload. Move relocates the unit.

Constructor & Destructor Documentation

◆ ~Item()

virtual StormByte::Multimedia::Pipeline::Item::~Item ( )
virtualdefaultnoexcept

Destructor.

◆ Item() [1/2]

StormByte::Multimedia::Pipeline::Item::Item ( const Item & other)
protecteddefaultnoexcept

Copy constructor.

Identity fields only; media lives on Frame / Packet.

Parameters
otherSource item.

◆ Item() [2/2]

StormByte::Multimedia::Pipeline::Item::Item ( Item && other)
protecteddefaultnoexcept

Move constructor.

Parameters
otherItem to take.

Member Function Documentation

◆ Kind()

Kind StormByte::Multimedia::Pipeline::Item::Kind ( ) const
inlinenoexcept

Whether this unit is a frame or a packet.

Returns
Kind::Frame or Kind::Packet.

◆ operator=() [1/2]

Item & StormByte::Multimedia::Pipeline::Item::operator= ( const Item & other)
protecteddefaultnoexcept

Copy assignment.

Identity fields only; media lives on Frame / Packet.

Parameters
otherSource item.
Returns
*this.

◆ operator=() [2/2]

Item & StormByte::Multimedia::Pipeline::Item::operator= ( Item && other)
protecteddefaultnoexcept

Move assignment.

Parameters
otherItem to take.
Returns
*this.

◆ Producer()

enum Producer StormByte::Multimedia::Pipeline::Item::Producer ( ) const
inlinenoexcept

Stage that created this unit.

Returns
Producer associated with this unit.

◆ Track()

int StormByte::Multimedia::Pipeline::Item::Track ( ) const
inlinenoexcept

Origin track index.

Returns
Input container stream index. -1 on the empty sentinel.

◆ Type()

enum StormByte::Multimedia::Type StormByte::Multimedia::Pipeline::Item::Type ( ) const
inlinenoexcept

Media of this access unit.

Returns
Video, Audio, Subtitle, or Unknown on the empty sentinel.

◆ Backend::Pipeline::Frame

friend class Backend::Pipeline::Frame
friend

Allows the decoded-AU holder to access item identity.

◆ Backend::Pipeline::Packet

friend class Backend::Pipeline::Packet
friend

Allows the compressed-AU holder to access item identity.

◆ Backend::Pipeline::Pipe

friend class Backend::Pipeline::Pipe
friend

Allows hoppers to clone items internally.

◆ Decoder

friend class Decoder
friend

Allows the decoder to access item identity.

◆ Demuxer

friend class Demuxer
friend

Allows the demuxer to access item identity.

◆ Encoder

friend class Encoder
friend

Allows the encoder to access item identity.

◆ Filter::FFmpeg

friend class Filter::FFmpeg
friend

Allows the filter base to access item identity.

◆ Frame

friend class Frame
friend

Allows the frame facade to construct its item base.

◆ Muxer

friend class Muxer
friend

Allows the muxer to access item identity.

◆ Packet

friend class Packet
friend

Allows the packet facade to construct its item base.

◆ Step

friend class Step
friend

Allows pipeline stages to access item identity.


The documentation for this class was generated from the following file:
  • lib/public/StormByte/multimedia/pipeline/item.hxx