Read-only description of one encoder implementation of a codec.
More...
#include <StormByte/multimedia/encoder_info.hxx>
|
| class | Codec |
| | Codec builds descriptions from the encoder tables.
|
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.
◆ 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
-
◆ EncoderInfo() [3/3]
| StormByte::Multimedia::EncoderInfo::EncoderInfo |
( |
EncoderInfo && | other | ) |
|
|
constexprdefaultnoexcept |
Move constructor.
- Parameters
-
◆ ~EncoderInfo()
| StormByte::Multimedia::EncoderInfo::~EncoderInfo |
( |
| ) |
|
|
defaultnoexcept |
◆ Description()
| std::string_view StormByte::Multimedia::EncoderInfo::Description |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Human description.
- Returns
- Description.
◆ Features()
◆ GenericOptions()
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
-
- 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]
Copy assignment.
- Parameters
-
- Returns
- This object.
◆ operator=() [2/2]
Move assignment.
- Parameters
-
- Returns
- This object.
◆ Option()
Describes an FFmpeg option of this implementation.
- Parameters
-
| name | Private 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()
Resolves a numeric option value to an FFmpeg named choice.
- Parameters
-
| name | Private or generic codec option name. |
| value | Integer 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()
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
-
- Returns
- true when the matching setter is valid for this implementation.
◆ Codec
Codec builds descriptions from the encoder tables.
The documentation for this class was generated from the following file: