StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
decoder_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
54#include <StormByte/type_traits/safe.hxx>
55
56#include <string_view>
57
62namespace StormByte {
67 namespace Multimedia {
72 class Codec;
73
83 public:
87 constexpr DecoderInfo() noexcept = default;
88
93 constexpr DecoderInfo(const DecoderInfo& other) noexcept = default;
94
99 constexpr DecoderInfo(DecoderInfo&& other) noexcept = default;
100
104 ~DecoderInfo() noexcept = default;
105
111 constexpr DecoderInfo& operator=(const DecoderInfo& other) noexcept = default;
112
118 constexpr DecoderInfo& operator=(DecoderInfo&& other) noexcept = default;
119
124 constexpr std::string_view Name() const noexcept { return m_name; }
125
130 constexpr std::string_view Description() const noexcept { return m_description; }
131
136 constexpr const StormByte::Multimedia::Features& Features() const noexcept { return m_features; }
137
138 private:
142 friend class Codec;
143
144 std::string_view m_name;
145 std::string_view m_description;
147 };
148 }
149}
150
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
Immutable codec identity owned by Registry.
Definition codec.hxx:94
Read-only description of one decoder implementation of a codec.
Definition decoder_info.hxx:82
constexpr const StormByte::Multimedia::Features & Features() const noexcept
Known decoder capabilities from Multimedia's implementation tables.
Definition decoder_info.hxx:136
constexpr DecoderInfo() noexcept=default
Constructs an empty description.
friend class Codec
Codec constructs implementation descriptions.
Definition decoder_info.hxx:142
constexpr std::string_view Description() const noexcept
Human description.
Definition decoder_info.hxx:130
constexpr std::string_view Name() const noexcept
FFmpeg implementation name usable as a decoder pin.
Definition decoder_info.hxx:124
Bitmask of Feature flags.
Definition features.hxx:77
Multimedia module of the StormByte suite.
Root namespace of the StormByte C++ suite.
STL namespace.
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition visibility.h:61