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

Read-only description of one encoder implementation of a codec. More...

#include <StormByte/multimedia/encoder_info.hxx>

Public Member Functions

constexpr EncoderInfo () noexcept=default
 Constructs an empty description.
constexpr EncoderInfo (const EncoderInfo &other) noexcept=default
 Copy constructor.
constexpr EncoderInfo (EncoderInfo &&other) noexcept=default
 Move constructor.
 ~EncoderInfo () noexcept=default
 Destructor.
constexpr EncoderInfo & operator= (const EncoderInfo &other) noexcept=default
 Copy assignment.
constexpr EncoderInfo & operator= (EncoderInfo &&other) noexcept=default
 Move assignment.
constexpr std::string_view Name () const noexcept
 FFmpeg implementation name, usable as an encoder pin.
constexpr std::string_view Description () const noexcept
 Human description.
constexpr bool Hardware () const noexcept
 Whether the registered implementation is hardware-only.
constexpr const StormByte::Multimedia::Features & Features () const noexcept
 Features this implementation preserves or offers.
constexpr bool Supports (EncoderSetting setting) const noexcept
 Tests whether a setting is accepted.
constexpr std::string_view Key (EncoderSetting setting) const noexcept
 Native FFmpeg option behind a setting.
StormByte::Safe::Optional< EncoderOption > Option (std::string_view name) const
 Describes an FFmpeg option of this implementation.
StormByte::Safe::Optional< StormByte::Safe::String > OptionChoice (std::string_view name, std::string_view value) const
 Resolves a numeric option value to an FFmpeg named choice.
StormByte::Safe::Vector< EncoderOption > PrivateOptions () const
 Enumerates encoder-specific FFmpeg options applicable to encoding.
StormByte::Safe::Vector< EncoderOption > GenericOptions () const
 Enumerates generic FFmpeg codec options applicable to this encoder.

Friends

class Codec
 Codec builds descriptions from the encoder tables.

Detailed Description

Read-only description of one encoder implementation of a codec.

Obtained from Codec::Encoders(). Describes which settings the implementation accepts and the native option behind each of them. Names are process-lifetime literals owned by Multimedia.

Constructor & Destructor Documentation

◆ EncoderInfo() [1/3]

StormByte::Multimedia::EncoderInfo::EncoderInfo ( )
constexprdefaultnoexcept

Constructs an empty description.

◆ EncoderInfo() [2/3]

StormByte::Multimedia::EncoderInfo::EncoderInfo ( const EncoderInfo & other)
constexprdefaultnoexcept

Copy constructor.

Parameters
otherSource description.

◆ EncoderInfo() [3/3]

StormByte::Multimedia::EncoderInfo::EncoderInfo ( EncoderInfo && other)
constexprdefaultnoexcept

Move constructor.

Parameters
otherSource description.

◆ ~EncoderInfo()

StormByte::Multimedia::EncoderInfo::~EncoderInfo ( )
defaultnoexcept

Destructor.

Member Function Documentation

◆ Description()

std::string_view StormByte::Multimedia::EncoderInfo::Description ( ) const
inlineconstexprnoexcept

Human description.

Returns
Description.

◆ Features()

const StormByte::Multimedia::Features & StormByte::Multimedia::EncoderInfo::Features ( ) const
inlineconstexprnoexcept

Features this implementation preserves or offers.

Returns
Feature set.

◆ GenericOptions()

StormByte::Safe::Vector< EncoderOption > StormByte::Multimedia::EncoderInfo::GenericOptions ( ) const

Enumerates generic FFmpeg codec options applicable to this encoder.

Returns
Owned descriptions, excluding names shadowed by private options.
Note
This reports FFmpeg metadata, not whether a particular pipeline configuration permits or uses every option.

◆ Hardware()

bool StormByte::Multimedia::EncoderInfo::Hardware ( ) const
inlineconstexprnoexcept

Whether the registered implementation is hardware-only.

Returns
true when existing implementation feature metadata marks it as hardware-accelerated.

Software encoders with optional hardware configurations are not classified as hardware-only.

◆ Key()

std::string_view StormByte::Multimedia::EncoderInfo::Key ( EncoderSetting setting) const
inlineconstexprnoexcept

Native FFmpeg option behind a setting.

Parameters
settingSetting to query.
Returns
Option name (crf, cq, qp, global_quality, b, x265-params, ...), or empty when unsupported.
Note
Audio CRF on global_quality takes the encoder's native quality scale (libvorbis -1..10, libmp3lame 0..9); Multimedia applies the qscale conversion.

◆ Name()

std::string_view StormByte::Multimedia::EncoderInfo::Name ( ) const
inlineconstexprnoexcept

FFmpeg implementation name, usable as an encoder pin.

Returns
Name, or empty for an empty description.

◆ operator=() [1/2]

EncoderInfo & StormByte::Multimedia::EncoderInfo::operator= ( const EncoderInfo & other)
constexprdefaultnoexcept

Copy assignment.

Parameters
otherSource description.
Returns
This object.

◆ operator=() [2/2]

EncoderInfo & StormByte::Multimedia::EncoderInfo::operator= ( EncoderInfo && other)
constexprdefaultnoexcept

Move assignment.

Parameters
otherSource description.
Returns
This object.

◆ Option()

StormByte::Safe::Optional< EncoderOption > StormByte::Multimedia::EncoderInfo::Option ( std::string_view name) const

Describes an FFmpeg option of this implementation.

Parameters
namePrivate or generic codec option name.
Returns
Description, or empty when the option or encoder does not exist.
Note
Packed parameters (inside x265-params, ...) are not FFmpeg options.

◆ OptionChoice()

StormByte::Safe::Optional< StormByte::Safe::String > StormByte::Multimedia::EncoderInfo::OptionChoice ( std::string_view name,
std::string_view value ) const

Resolves a numeric option value to an FFmpeg named choice.

Parameters
namePrivate or generic codec option name.
valueInteger value as text.
Returns
First matching choice, or empty when no choice is known.
Note
Flags, non-integer options and packed library parameters are not resolved.

◆ PrivateOptions()

StormByte::Safe::Vector< EncoderOption > StormByte::Multimedia::EncoderInfo::PrivateOptions ( ) const

Enumerates encoder-specific FFmpeg options applicable to encoding.

Returns
Owned descriptions; empty for an empty or unavailable encoder.
Note
Packed dictionary options are returned as single FFmpeg options; their library-specific keys are not enumerated.

◆ Supports()

bool StormByte::Multimedia::EncoderInfo::Supports ( EncoderSetting setting) const
inlineconstexprnoexcept

Tests whether a setting is accepted.

Parameters
settingSetting to test.
Returns
true when the matching setter is valid for this implementation.

◆ Codec

friend class Codec
friend

Codec builds descriptions from the encoder tables.


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