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

What an encoder actually opened. More...

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

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

Public Member Functions

PointerType Clone () const override
 Deep copy.
PointerType Move () override
 Move into a new pointer.
virtual StormByte::Safe::String ToString () const
 Human-readable line for logs.
Lifecycle
 TrackSettled ()
 Empty settled row.
 TrackSettled (const TrackSettled &other)
 Copy constructor.
 TrackSettled (TrackSettled &&other)
 Move constructor.
virtual ~TrackSettled () noexcept override
 Destructor.
TrackSettled & operator= (const TrackSettled &other)
 Copy assignment.
TrackSettled & operator= (TrackSettled &&other) noexcept
 Move assignment.
Public Member Functions inherited from StormByte::Safe::Clonable< TrackSettled, StormByte::Safe::Unique< TrackSettled > >
constexpr Clonable ()=default
constexpr Clonable & operator= (const Clonable &)=default
virtual constexpr ~Clonable () noexcept=default

Public Attributes

int In = -1
 Origin stream or attachment slot.
int Out = -1
 Index in Plan::Tracks after Add.
Type Kind = Type::Unknown
 Media kind.
const Codec * Source = nullptr
 Borrowed registry origin codec.
const Codec * Destination = nullptr
 Borrowed opened encoder codec, or null for remux.
StormByte::Safe::Optional< StormByte::Safe::String > Implementation
 Opened encoder implementation pin.
StormByte::Safe::Optional< double > Crf
 CRF/CQ actually used.
StormByte::Safe::Optional< std::int64_t > BitRate
 Bitrate actually used.
StormByte::Safe::Optional< std::int64_t > MaxBitRate
 VBV bitrate actually used.
StormByte::Safe::Optional< StormByte::Safe::String > Preset
 Preset actually used.
StormByte::Safe::Optional< StormByte::Safe::String > Tune
 Tune actually used.
StormByte::Safe::Map< StormByte::Safe::String, StormByte::Safe::String > FineTune
 Vendor options actually used.
StormByte::Safe::Optional< int > SampleFormat
 Encoder AVSampleFormat.
StormByte::Safe::Optional< int > SourceChannels
 Decoded channel count.
StormByte::Safe::Optional< int > EncoderChannels
 Encoder channel count.
StormByte::Safe::Optional< int > FrameSize
 Encoder frame size.
StormByte::Safe::Optional< int > SampleRate
 Samples per second.

Additional Inherited Members

Public Types inherited from StormByte::Safe::Clonable< TrackSettled, StormByte::Safe::Unique< TrackSettled > >
typedef SmartPointer PointerType
Static Public Member Functions inherited from StormByte::Safe::Clonable< TrackSettled, StormByte::Safe::Unique< TrackSettled > >
static PointerType MakePointer (Args &&... args)

Detailed Description

What an encoder actually opened.

Not intention.

Plan / Track are the request. This type is filled after Encoder is open and passed to Transcoder::OnSettled. Derive it and return the type from Transcoder::EmptySettled to carry extra fields.

Constructor & Destructor Documentation

◆ TrackSettled() [1/3]

StormByte::Multimedia::Pipeline::TrackSettled::TrackSettled ( )

Empty settled row.

◆ TrackSettled() [2/3]

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

Copy constructor.

Parameters
otherSource row.

◆ TrackSettled() [3/3]

StormByte::Multimedia::Pipeline::TrackSettled::TrackSettled ( TrackSettled && other)

Move constructor.

Parameters
otherRow to take.

◆ ~TrackSettled()

virtual StormByte::Multimedia::Pipeline::TrackSettled::~TrackSettled ( )
overridevirtualnoexcept

Destructor.

Member Function Documentation

◆ Clone()

PointerType StormByte::Multimedia::Pipeline::TrackSettled::Clone ( ) const
overridevirtual

Deep copy.

Returns
Owning pointer to a new row of the same dynamic type.
Note
Derived rows must override in their provider module and use Unique<TrackSettled>::MakePointer<Derived> for the exact payload.

Implements StormByte::Safe::Clonable< TrackSettled, StormByte::Safe::Unique< TrackSettled > >.

◆ Move()

PointerType StormByte::Multimedia::Pipeline::TrackSettled::Move ( )
overridevirtual

Move into a new pointer.

Returns
Owning pointer to the moved row.
Note
Derived rows must override in their provider module to avoid slicing.

Implements StormByte::Safe::Clonable< TrackSettled, StormByte::Safe::Unique< TrackSettled > >.

◆ operator=() [1/2]

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

Copy assignment.

Parameters
otherSource row.
Returns
*this.

◆ operator=() [2/2]

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

Move assignment.

Parameters
otherSource row.
Returns
*this.

◆ ToString()

virtual StormByte::Safe::String StormByte::Multimedia::Pipeline::TrackSettled::ToString ( ) const
virtual

Human-readable line for logs.

Returns
One or more lines, no trailing newline required.

Member Data Documentation

◆ BitRate

StormByte::Safe::Optional<std::int64_t> StormByte::Multimedia::Pipeline::TrackSettled::BitRate

Bitrate actually used.

◆ Crf

StormByte::Safe::Optional<double> StormByte::Multimedia::Pipeline::TrackSettled::Crf

CRF/CQ actually used.

◆ Destination

const Codec* StormByte::Multimedia::Pipeline::TrackSettled::Destination = nullptr

Borrowed opened encoder codec, or null for remux.

◆ EncoderChannels

StormByte::Safe::Optional<int> StormByte::Multimedia::Pipeline::TrackSettled::EncoderChannels

Encoder channel count.

◆ FineTune

StormByte::Safe::Map<StormByte::Safe::String, StormByte::Safe::String> StormByte::Multimedia::Pipeline::TrackSettled::FineTune

Vendor options actually used.

◆ FrameSize

StormByte::Safe::Optional<int> StormByte::Multimedia::Pipeline::TrackSettled::FrameSize

Encoder frame size.

◆ Implementation

StormByte::Safe::Optional<StormByte::Safe::String> StormByte::Multimedia::Pipeline::TrackSettled::Implementation

Opened encoder implementation pin.

◆ In

int StormByte::Multimedia::Pipeline::TrackSettled::In = -1

Origin stream or attachment slot.

◆ Kind

Type StormByte::Multimedia::Pipeline::TrackSettled::Kind = Type::Unknown

Media kind.

◆ MaxBitRate

StormByte::Safe::Optional<std::int64_t> StormByte::Multimedia::Pipeline::TrackSettled::MaxBitRate

VBV bitrate actually used.

◆ Out

int StormByte::Multimedia::Pipeline::TrackSettled::Out = -1

Index in Plan::Tracks after Add.

◆ Preset

StormByte::Safe::Optional<StormByte::Safe::String> StormByte::Multimedia::Pipeline::TrackSettled::Preset

Preset actually used.

◆ SampleFormat

StormByte::Safe::Optional<int> StormByte::Multimedia::Pipeline::TrackSettled::SampleFormat

Encoder AVSampleFormat.

◆ SampleRate

StormByte::Safe::Optional<int> StormByte::Multimedia::Pipeline::TrackSettled::SampleRate

Samples per second.

◆ Source

const Codec* StormByte::Multimedia::Pipeline::TrackSettled::Source = nullptr

Borrowed registry origin codec.

◆ SourceChannels

StormByte::Safe::Optional<int> StormByte::Multimedia::Pipeline::TrackSettled::SourceChannels

Decoded channel count.

◆ Tune

StormByte::Safe::Optional<StormByte::Safe::String> StormByte::Multimedia::Pipeline::TrackSettled::Tune

Tune actually used.


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