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

Video-track encoding intention, or Remux without a codec. More...

#include <StormByte/multimedia/pipeline/config/video.hxx>

Inheritance diagram for StormByte::Multimedia::Pipeline::Config::Video:
Collaboration diagram for StormByte::Multimedia::Pipeline::Config::Video:

Public Member Functions

PointerType Clone () const override
 Deep copy.
PointerType Move () override
 Move into a new pointer.
Lifecycle
 Video ()
 Empty video config (Remux until Codec is set).
 Video (const Video &other)
 Copy constructor.
 Video (Video &&other)
 Move constructor.
virtual ~Video () noexcept override
 Destructor.
Video & operator= (const Video &other)
 Copy assignment.
Video & operator= (Video &&other) noexcept
 Move assignment.
Encode
const StormByte::Multimedia::Codec * Codec () const noexcept
 Destination codec.
void Codec (const StormByte::Multimedia::Codec &codec) noexcept
 Sets the destination codec (Encode).
const StormByte::Safe::Optional< double > & CRF () const noexcept
 CRF/CQ.
void CRF (double value)
 Sets CRF/CQ and clears BitRate.
const StormByte::Safe::Optional< std::int64_t > & BitRate () const noexcept
 Target bitrate.
void BitRate (std::int64_t bits_per_second)
 Sets target bitrate and clears CRF.
const StormByte::Safe::Optional< std::int64_t > & MaxBitRate () const noexcept
 VBV ceiling.
void MaxBitRate (std::int64_t bits_per_second)
 Sets VBV ceiling.
const StormByte::Safe::Optional< StormByte::Safe::String > & Preset () const noexcept
 Encoder preset.
void Preset (StormByte::Safe::String name)
 Sets the preset.
const StormByte::Safe::Optional< StormByte::Safe::String > & Tune () const noexcept
 Content tune.
void Tune (StormByte::Safe::String name)
 Sets the tune.
const StormByte::Safe::Map< StormByte::Safe::String, StormByte::Safe::String > & FineTune () const noexcept
 Vendor leftovers.
void FineTune (StormByte::Safe::Map< StormByte::Safe::String, StormByte::Safe::String > options) noexcept
 Replaces the vendor dict.
Public Member Functions inherited from StormByte::Multimedia::Pipeline::Config::Base
 Base (const Base &other)
 Copy constructor.
 Base (Base &&other) noexcept
 Move constructor.
virtual ~Base () noexcept override
 Destructor.
Base & operator= (const Base &other)
 Copy assignment.
Base & operator= (Base &&other) noexcept
 Move assignment.
constexpr enum StormByte::Multimedia::Type Type () const noexcept
 Media stamped by the leaf constructor.
const StormByte::Safe::Optional< StormByte::Safe::String > & Language () const noexcept
 Language override.
void Language (StormByte::Safe::String language)
 Sets the language override.
void RemoveLanguage ()
 Writes the track without a language tag, even if the source has one.
const StormByte::Safe::Optional< StormByte::Safe::String > & Title () const noexcept
 Title override.
void Title (StormByte::Safe::String title)
 Sets the title override.
void RemoveTitle ()
 Writes the track without a title, even if the source has one.
const StormByte::Safe::Optional< bool > & Default () const noexcept
 Default-disposition override.
void Default (StormByte::Safe::Optional< bool > value) noexcept
 Sets or clears the default-disposition override.
const StormByte::Safe::Optional< bool > & Forced () const noexcept
 Forced-disposition override.
void Forced (StormByte::Safe::Optional< bool > value) noexcept
 Sets or clears the forced-disposition override.
const struct Implementation & Implementation () const noexcept
 Decoder / encoder pins.
void Implementation (struct Implementation implementation) noexcept
 Replaces both pins.
Public Member Functions inherited from StormByte::Safe::Clonable< Base, StormByte::Safe::Unique< Base > >
constexpr Clonable ()=default
constexpr Clonable & operator= (const Clonable &)=default
virtual constexpr ~Clonable () noexcept=default

Additional Inherited Members

Public Types inherited from StormByte::Safe::Clonable< Base, StormByte::Safe::Unique< Base > >
typedef SmartPointer PointerType
Static Public Member Functions inherited from StormByte::Safe::Clonable< Base, StormByte::Safe::Unique< Base > >
static PointerType MakePointer (Args &&... args)
Protected Member Functions inherited from StormByte::Multimedia::Pipeline::Config::Base
 Base (enum StormByte::Multimedia::Type type)
 Empty overrides; media fixed for the leaf lifetime.

Detailed Description

Video-track encoding intention, or Remux without a codec.

Note
Boundary use requires compatible C++ ABIs and loaded providers. Codec registry storage must outlive this config and its copies. Further derived providers must use safe fields and override Clone, Move and lifecycle operations locally without slicing their type. Optional arrow access is a read-only full-expression snapshot; const map iteration returns entry copies, not node references.

Constructor & Destructor Documentation

◆ Video() [1/3]

StormByte::Multimedia::Pipeline::Config::Video::Video ( )

Empty video config (Remux until Codec is set).

◆ Video() [2/3]

StormByte::Multimedia::Pipeline::Config::Video::Video ( const Video & other)

Copy constructor.

Parameters
otherSource config.

◆ Video() [3/3]

StormByte::Multimedia::Pipeline::Config::Video::Video ( Video && other)

Move constructor.

Parameters
otherConfig to take.

◆ ~Video()

virtual StormByte::Multimedia::Pipeline::Config::Video::~Video ( )
overridevirtualnoexcept

Destructor.

Member Function Documentation

◆ BitRate() [1/2]

const StormByte::Safe::Optional< std::int64_t > & StormByte::Multimedia::Pipeline::Config::Video::BitRate ( ) const
inlinenoexcept

Target bitrate.

Returns
Bits per second, or empty.

◆ BitRate() [2/2]

void StormByte::Multimedia::Pipeline::Config::Video::BitRate ( std::int64_t bits_per_second)

Sets target bitrate and clears CRF.

Parameters
bits_per_secondBits per second.

◆ Clone()

PointerType StormByte::Multimedia::Pipeline::Config::Video::Clone ( ) const
overridevirtual

Deep copy.

Returns
Owning pointer to a new Video.

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

◆ Codec() [1/2]

const StormByte::Multimedia::Codec * StormByte::Multimedia::Pipeline::Config::Video::Codec ( ) const
inlinenoexcept

Destination codec.

Returns
Registry codec, or nullptr if this track is Remux.

◆ Codec() [2/2]

void StormByte::Multimedia::Pipeline::Config::Video::Codec ( const StormByte::Multimedia::Codec & codec)
inlinenoexcept

Sets the destination codec (Encode).

Parameters
codecRegistry codec. Must be video at Plan validation.

◆ CRF() [1/2]

const StormByte::Safe::Optional< double > & StormByte::Multimedia::Pipeline::Config::Video::CRF ( ) const
inlinenoexcept

CRF/CQ.

Incompatible with BitRate.

Returns
Value, or empty.

◆ CRF() [2/2]

void StormByte::Multimedia::Pipeline::Config::Video::CRF ( double value)

Sets CRF/CQ and clears BitRate.

Parameters
valueQuality value.

◆ FineTune() [1/2]

const StormByte::Safe::Map< StormByte::Safe::String, StormByte::Safe::String > & StormByte::Multimedia::Pipeline::Config::Video::FineTune ( ) const
inlinenoexcept

Vendor leftovers.

Not CRF / preset / tune / bufsize.

Returns
Key/value map.

◆ FineTune() [2/2]

void StormByte::Multimedia::Pipeline::Config::Video::FineTune ( StormByte::Safe::Map< StormByte::Safe::String, StormByte::Safe::String > options)
noexcept

Replaces the vendor dict.

Parameters
optionsKey/value pairs.

◆ MaxBitRate() [1/2]

const StormByte::Safe::Optional< std::int64_t > & StormByte::Multimedia::Pipeline::Config::Video::MaxBitRate ( ) const
inlinenoexcept

VBV ceiling.

Returns
Bits per second, or empty.

◆ MaxBitRate() [2/2]

void StormByte::Multimedia::Pipeline::Config::Video::MaxBitRate ( std::int64_t bits_per_second)

Sets VBV ceiling.

bufsize is derived by the encoder.

Parameters
bits_per_secondMax bitrate.

◆ Move()

PointerType StormByte::Multimedia::Pipeline::Config::Video::Move ( )
overridevirtual

Move into a new pointer.

Returns
Owning pointer to the moved Video.

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

◆ operator=() [1/2]

Video & StormByte::Multimedia::Pipeline::Config::Video::operator= ( const Video & other)

Copy assignment.

Parameters
otherSource config.
Returns
*this.

◆ operator=() [2/2]

Video & StormByte::Multimedia::Pipeline::Config::Video::operator= ( Video && other)
noexcept

Move assignment.

Parameters
otherConfig to take.
Returns
*this.

◆ Preset() [1/2]

const StormByte::Safe::Optional< StormByte::Safe::String > & StormByte::Multimedia::Pipeline::Config::Video::Preset ( ) const
inlinenoexcept

Encoder preset.

Returns
Name, or empty.

◆ Preset() [2/2]

void StormByte::Multimedia::Pipeline::Config::Video::Preset ( StormByte::Safe::String name)

Sets the preset.

Empty clears it.

Parameters
namePreset name (medium, p4, …).

◆ Tune() [1/2]

const StormByte::Safe::Optional< StormByte::Safe::String > & StormByte::Multimedia::Pipeline::Config::Video::Tune ( ) const
inlinenoexcept

Content tune.

Returns
Name, or empty.

◆ Tune() [2/2]

void StormByte::Multimedia::Pipeline::Config::Video::Tune ( StormByte::Safe::String name)

Sets the tune.

Empty clears it.

Parameters
nameTune name (animation, film, …).

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