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

Fluent handle for one origin stream in this job. More...

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

Public Member Functions

Track & Remux () noexcept
 Remux this track (no destination codec).
Track & Codec (const Codec &codec) noexcept
 Encodes this track to codec.
Track & Implementation (StormByte::Safe::String name)
 Pins an FFmpeg encoder name.
Track & Implementation (ImplementationSide side, StormByte::Safe::String name)
 Pins an FFmpeg implementation for either side of an encoded track.
Track & Acceleration (DecodeAcceleration acceleration)
 Selects hardware or software decoding for this video track.
Track & CRF (double value)
 Sets CRF/CQ.
Track & BitRate (std::int64_t bits_per_second)
 Sets target bitrate.
Track & MaxBitRate (std::int64_t bits_per_second)
 Sets VBV / max bitrate.
Track & Preset (StormByte::Safe::String name)
 Sets encoder preset.
Track & Tune (StormByte::Safe::String name)
 Sets encoder tune.
Track & FineTune (StormByte::Safe::Map< StormByte::Safe::String, StormByte::Safe::String > options)
 Replaces vendor leftovers.
Track & Language (StormByte::Safe::String language)
 Overrides stream language.
Track & RemoveLanguage ()
 Writes this track without a language tag.
Track & Title (StormByte::Safe::String title)
 Overrides stream title.
Track & RemoveTitle ()
 Writes this track without a title.
template<typename FilterType, typename... Args>
Track & Filter (Args &&... args)
 Appends a Process, Packet or Analytics filter to this track.
Lifecycle
 Track (const Track &other) noexcept=default
 Copy constructor.
 Track (Track &&other) noexcept=default
 Move constructor.
 ~Track () noexcept=default
 Destructor.
Track & operator= (const Track &other) noexcept=default
 Copy assignment.
Track & operator= (Track &&other) noexcept=default
 Move assignment.

Friends

class Transcoder
 Parent job that constructs mapped track handles.

Detailed Description

Fluent handle for one origin stream in this job.

Writes the matching Config leaf. Mux order is the order of Add on this job, not a field here. Call before Run.

Constructor & Destructor Documentation

◆ Track() [1/2]

StormByte::Multimedia::Pipeline::Transcoder::Track::Track ( const Track & other)
defaultnoexcept

Copy constructor.

Parameters
otherSource handle.

◆ Track() [2/2]

StormByte::Multimedia::Pipeline::Transcoder::Track::Track ( Track && other)
defaultnoexcept

Move constructor.

Parameters
otherHandle to take.

◆ ~Track()

StormByte::Multimedia::Pipeline::Transcoder::Track::~Track ( )
defaultnoexcept

Destructor.

Member Function Documentation

◆ Acceleration()

Track & StormByte::Multimedia::Pipeline::Transcoder::Track::Acceleration ( DecodeAcceleration acceleration)

Selects hardware or software decoding for this video track.

Parameters
accelerationDecoder acceleration policy.
Returns
*this.

◆ BitRate()

Track & StormByte::Multimedia::Pipeline::Transcoder::Track::BitRate ( std::int64_t bits_per_second)

Sets target bitrate.

Clears CRF.

Parameters
bits_per_secondBits per second.
Returns
*this.

◆ Codec()

Track & StormByte::Multimedia::Pipeline::Transcoder::Track::Codec ( const Codec & codec)
noexcept

Encodes this track to codec.

Parameters
codecDestination registry codec.
Returns
*this.

◆ CRF()

Track & StormByte::Multimedia::Pipeline::Transcoder::Track::CRF ( double value)

Sets CRF/CQ.

Clears BitRate.

Parameters
valueQuality value.
Returns
*this.

◆ Filter()

template<typename FilterType, typename... Args>
Track & StormByte::Multimedia::Pipeline::Transcoder::Track::Filter ( Args &&... args)
inline

Appends a Process, Packet or Analytics filter to this track.

Template Parameters
FilterTypeChild of Filter::Process, Filter::Packet or Filter::Analytics.
ArgsFilter constructor argument types.
Parameters
argsConstructor arguments, forwarded.
Returns
*this.

Call before Transcoder::Run. Frame filters on a remux track Fail the stretch. Global analytics attach on Transcoder::Filter. Both are allowed; there is no dedup.

◆ FineTune()

Track & StormByte::Multimedia::Pipeline::Transcoder::Track::FineTune ( StormByte::Safe::Map< StormByte::Safe::String, StormByte::Safe::String > options)

Replaces vendor leftovers.

Pass individual keys. For encoders with a packed private option (EncoderSetting::Params, e.g. x265-params), keys are packed into it; passing the packed option itself fails. Unknown keys fail the job when the encoder opens.

Parameters
optionsKey / value map.
Returns
*this.

◆ Implementation() [1/2]

Track & StormByte::Multimedia::Pipeline::Transcoder::Track::Implementation ( ImplementationSide side,
StormByte::Safe::String name )

Pins an FFmpeg implementation for either side of an encoded track.

Parameters
sideSource decoder or destination encoder.
nameImplementation name; empty selects the default.
Returns
*this.

◆ Implementation() [2/2]

Track & StormByte::Multimedia::Pipeline::Transcoder::Track::Implementation ( StormByte::Safe::String name)

Pins an FFmpeg encoder name.

Parameters
nameTable name.
Returns
*this.

◆ Language()

Track & StormByte::Multimedia::Pipeline::Transcoder::Track::Language ( StormByte::Safe::String language)

Overrides stream language.

Parameters
languageISO tag. Empty clears the override and keeps the source tag.
Returns
*this.

◆ MaxBitRate()

Track & StormByte::Multimedia::Pipeline::Transcoder::Track::MaxBitRate ( std::int64_t bits_per_second)

Sets VBV / max bitrate.

Parameters
bits_per_secondBits per second.
Returns
*this.

◆ operator=() [1/2]

Track & StormByte::Multimedia::Pipeline::Transcoder::Track::operator= ( const Track & other)
defaultnoexcept

Copy assignment.

Parameters
otherSource handle.
Returns
*this.

◆ operator=() [2/2]

Track & StormByte::Multimedia::Pipeline::Transcoder::Track::operator= ( Track && other)
defaultnoexcept

Move assignment.

Parameters
otherHandle to take.
Returns
*this.

◆ Preset()

Track & StormByte::Multimedia::Pipeline::Transcoder::Track::Preset ( StormByte::Safe::String name)

Sets encoder preset.

Parameters
namePreset name.
Returns
*this.

◆ RemoveLanguage()

Track & StormByte::Multimedia::Pipeline::Transcoder::Track::RemoveLanguage ( )

Writes this track without a language tag.

Containers whose language field is mandatory store their undefined value.

Returns
*this.

◆ RemoveTitle()

Track & StormByte::Multimedia::Pipeline::Transcoder::Track::RemoveTitle ( )

Writes this track without a title.

Returns
*this.

◆ Remux()

Track & StormByte::Multimedia::Pipeline::Transcoder::Track::Remux ( )
noexcept

Remux this track (no destination codec).

Returns
*this.

◆ Title()

Track & StormByte::Multimedia::Pipeline::Transcoder::Track::Title ( StormByte::Safe::String title)

Overrides stream title.

Parameters
titleTitle text. Empty clears the override and keeps the source title.
Returns
*this.

◆ Tune()

Track & StormByte::Multimedia::Pipeline::Transcoder::Track::Tune ( StormByte::Safe::String name)

Sets encoder tune.

Parameters
nameTune name.
Returns
*this.

◆ Transcoder

friend class Transcoder
friend

Parent job that constructs mapped track handles.


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