StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
codec.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
57#include <StormByte/safe/optional.hxx>
58#include <StormByte/type_traits/safe.hxx>
59
60#include <string_view>
61
66namespace StormByte {
71 namespace Multimedia {
76 class Registry;
77
87
95 public:
100 Codec(const Codec& other) noexcept = delete;
101
106 Codec(Codec&& other) noexcept;
107
111 ~Codec() noexcept;
112
118 Codec& operator=(const Codec& other) noexcept = delete;
119
125 Codec& operator=(Codec&& other) noexcept;
126
132 bool operator==(const Codec& other) const noexcept;
133
139 bool operator!=(const Codec& other) const noexcept;
140
145 constexpr enum Type Type() const noexcept { return m_type; }
146
151 constexpr std::string_view Name() const noexcept { return m_name; }
152
157 constexpr std::string_view Description() const noexcept { return m_description; }
158
166
172 bool HasAccess(Access access) const noexcept;
173
185 bool HasAccess(Access access, const Features& need) const noexcept;
186
196 StormByte::Safe::Vector<EncoderInfo> Encoders(const Features& need = {}) const;
197
215
216 private:
220 friend class Registry;
221
222 enum Type m_type;
223 std::string_view m_name;
224 std::string_view m_description;
225 Access m_access;
226
234 Codec(enum Type type, std::string_view name, std::string_view description, Access access);
235 };
236 }
237}
238
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
Bitmask of Operation flags for a codec.
Definition type.hxx:114
Immutable codec identity owned by Registry.
Definition codec.hxx:94
StormByte::Safe::Vector< EncoderInfo > Encoders(const Features &need={}) const
Lists the available encoder implementations for this codec.
Codec(Codec &&other) noexcept
Move constructor executed by the multimedia provider.
StormByte::Safe::Vector< DecoderInfo > Decoders(const Features &need={}) const
Lists decoder implementations usable by this codec's backend.
Codec(const Codec &other) noexcept=delete
Copy is disabled; instances are unique in the registry.
constexpr std::string_view Name() const noexcept
StormByte codec name.
Definition codec.hxx:151
StormByte::Safe::Optional< enum SubtitleKind > SubtitleKind() const noexcept
Classifies subtitle content independently of codec availability.
~Codec() noexcept
Destroy the identity in the multimedia provider.
bool HasAccess(Access access) const noexcept
Tests Read/Write flags.
friend class Registry
Registry creates codec identities from static tables.
Definition codec.hxx:220
constexpr std::string_view Description() const noexcept
Human description.
Definition codec.hxx:157
Read-only description of one encoder implementation of a codec.
Definition encoder_info.hxx:160
Bitmask of Feature flags.
Definition features.hxx:77
Process-wide catalog of codecs and containers.
Definition registry.hxx:115
Multimedia module of the StormByte suite.
SubtitleKind
Semantic subtitle representation, not its on-disk encoding.
Definition codec.hxx:82
@ Bitmap
Image-based cues.
Definition codec.hxx:85
@ Unknown
Subtitle without a reliable representation classification.
Definition codec.hxx:83
@ Text
Text-based cues, including binary-packed text formats.
Definition codec.hxx:84
Root namespace of the StormByte C++ suite.
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition visibility.h:61