StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
encoder_info.hxx
Go to the documentation of this file.
1/*
2 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
3 *
4 * This file is part of StormByte-Multimedia.
5 *
6 * StormByte-Multimedia original source is dual-licensed:
7 *
8 * 1. GNU Lesser General Public License v3.0 (or later)
9 * You may redistribute and/or modify this file under the terms of the
10 * GNU Lesser General Public License as published by the Free Software
11 * Foundation, either version 3 of the License, or (at your option)
12 * any later version.
13 *
14 * 2. Commercial license
15 * Alternatively, this file may be used under the terms of a commercial
16 * license agreement with the copyright holder
17 * (David C. Manuelda <StormByte@gmail.com>).
18 *
19 * Both licenses apply only to original StormByte-Multimedia source in this
20 * file. Third-party components — including FFmpeg and embedded trained data —
21 * remain under their own licenses and are not covered by the commercial grant.
22 *
23 * A written StormByte commercial agreement may license this original source
24 * on terms other than the LGPL, including specific use, distribution or
25 * linking arrangements such as static linking, as stated in that agreement.
26 * It does not grant rights to dependencies or waive their license conditions.
27 * Enabling WITH_GPL or WITH_NONFREE may include components with separate
28 * obligations for modification, linking (static or dynamic), redistribution
29 * or works that incorporate them. The person modifying, linking, packaging or
30 * distributing the resulting work is responsible for determining and meeting
31 * all applicable requirements, including any needed patent permissions.
32 * A StormByte commercial agreement does not provide those rights for GPL or
33 * nonfree components.
34 *
35 * Neither license grants any patent rights. Any patent licenses required
36 * to use this software or third-party components must be obtained separately
37 * from the patent holders.
38 *
39 * StormByte-Multimedia is distributed in the hope that it will be useful,
40 * but WITHOUT ANY WARRANTY; without even the implied warranty of
41 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
42 * GNU Lesser General Public License for more details.
43 *
44 * You should have received a copy of the GNU Lesser General Public License
45 * version 3 along with StormByte-Multimedia. If not, see
46 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
47 *
48 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
49 */
50
51#pragma once
52
55#include <StormByte/safe/optional.hxx>
56#include <StormByte/safe/string.hxx>
57#include <StormByte/safe/vector.hxx>
58#include <StormByte/type_traits/safe.hxx>
59
60#include <array>
61#include <cstddef>
62#include <string_view>
63
64namespace StormByte::Multimedia {
65 class Codec;
66
84
96
107
113
118 EncoderOption(EncoderOption&& other) noexcept;
119
123 ~EncoderOption() noexcept;
124
130 EncoderOption& operator=(const EncoderOption& other);
131
137 EncoderOption& operator=(EncoderOption&& other) noexcept;
138
139 StormByte::Safe::String Name;
140 StormByte::Safe::String Help;
142 double Minimum;
143 double Maximum;
145 StormByte::Safe::Vector<StormByte::Safe::String> Choices;
146 };
147}
148
150
151namespace StormByte::Multimedia {
161 public:
165 constexpr EncoderInfo() noexcept = default;
166
171 constexpr EncoderInfo(const EncoderInfo& other) noexcept = default;
172
177 constexpr EncoderInfo(EncoderInfo&& other) noexcept = default;
178
182 ~EncoderInfo() noexcept = default;
183
189 constexpr EncoderInfo& operator=(const EncoderInfo& other) noexcept = default;
190
196 constexpr EncoderInfo& operator=(EncoderInfo&& other) noexcept = default;
197
202 constexpr std::string_view Name() const noexcept { return m_name; }
203
208 constexpr std::string_view Description() const noexcept { return m_description; }
209
218 constexpr bool Hardware() const noexcept {
220 }
221
226 constexpr const StormByte::Multimedia::Features& Features() const noexcept { return m_features; }
227
233 constexpr bool Supports(EncoderSetting setting) const noexcept {
234 return !Key(setting).empty();
235 }
236
245 constexpr std::string_view Key(EncoderSetting setting) const noexcept {
246 const auto index = static_cast<std::size_t>(setting);
247 return index < m_keys.size() ? m_keys[index] : std::string_view{};
248 }
249
257
265 StormByte::Safe::Optional<StormByte::Safe::String> OptionChoice(std::string_view name, std::string_view value) const;
266
274
282
283 private:
287 friend class Codec;
288
289 std::string_view m_name;
290 std::string_view m_description;
292 std::array<std::string_view, 6> m_keys{};
293 };
294}
295
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
Immutable codec identity owned by Registry.
Definition codec.hxx:94
Read-only description of one encoder implementation of a codec.
Definition encoder_info.hxx:160
constexpr const StormByte::Multimedia::Features & Features() const noexcept
Features this implementation preserves or offers.
Definition encoder_info.hxx:226
constexpr std::string_view Key(EncoderSetting setting) const noexcept
Native FFmpeg option behind a setting.
Definition encoder_info.hxx:245
StormByte::Safe::Vector< EncoderOption > PrivateOptions() const
Enumerates encoder-specific FFmpeg options applicable to encoding.
constexpr bool Supports(EncoderSetting setting) const noexcept
Tests whether a setting is accepted.
Definition encoder_info.hxx:233
StormByte::Safe::Vector< EncoderOption > GenericOptions() const
Enumerates generic FFmpeg codec options applicable to this encoder.
constexpr std::string_view Description() const noexcept
Human description.
Definition encoder_info.hxx:208
constexpr EncoderInfo() noexcept=default
Constructs an empty description.
friend class Codec
Codec builds descriptions from the encoder tables.
Definition encoder_info.hxx:287
constexpr std::string_view Name() const noexcept
FFmpeg implementation name, usable as an encoder pin.
Definition encoder_info.hxx:202
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::Optional< EncoderOption > Option(std::string_view name) const
Describes an FFmpeg option of this implementation.
constexpr bool Hardware() const noexcept
Whether the registered implementation is hardware-only.
Definition encoder_info.hxx:218
Bitmask of Feature flags.
Definition features.hxx:77
Multimedia module of the StormByte suite.
Multimedia module of the StormByte suite.
EncoderSetting
Rate and style settings an encoder implementation may accept.
Definition encoder_info.hxx:75
@ MaxBitRate
VBV / maximum bitrate.
Definition encoder_info.hxx:78
@ Params
Packed vendor parameters (x265-params, ...).
Definition encoder_info.hxx:81
@ Preset
Speed / efficiency preset.
Definition encoder_info.hxx:79
@ Tune
Content tuning.
Definition encoder_info.hxx:80
@ BitRate
Target bitrate.
Definition encoder_info.hxx:77
@ CRF
Constant quality (CRF, CQ, QP, global_quality or audio qscale).
Definition encoder_info.hxx:76
EncoderOptionType
Value type of an FFmpeg encoder option.
Definition encoder_info.hxx:89
@ Float
Floating point value.
Definition encoder_info.hxx:91
@ String
Free text.
Definition encoder_info.hxx:93
@ Boolean
Boolean value.
Definition encoder_info.hxx:92
@ Other
Any other FFmpeg type (dictionary, rational, size, ...).
Definition encoder_info.hxx:94
@ Integer
Integer value.
Definition encoder_info.hxx:90
@ HardwareAcceleration
Hardware decode or encode.
Definition feature.hxx:88
Root namespace of the StormByte C++ suite.
STL namespace.
double Minimum
Lowest numeric value FFmpeg accepts.
Definition encoder_info.hxx:142
EncoderOption(const EncoderOption &other)
Copies a description in Multimedia.
double Maximum
Highest numeric value FFmpeg accepts.
Definition encoder_info.hxx:143
StormByte::Safe::String Default
FFmpeg default as text; empty when unknown.
Definition encoder_info.hxx:144
EncoderOption()
Constructs an empty description in Multimedia.
StormByte::Safe::String Name
FFmpeg option name.
Definition encoder_info.hxx:139
StormByte::Safe::String Help
FFmpeg help text (English).
Definition encoder_info.hxx:140
EncoderOption(EncoderOption &&other) noexcept
Transfers a description.
~EncoderOption() noexcept
Releases the description through its creator callbacks.
StormByte::Safe::Vector< StormByte::Safe::String > Choices
Named constants accepted as values.
Definition encoder_info.hxx:145
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition visibility.h:61