StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
container.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
56
57#include <string_view>
58
63namespace StormByte {
68 namespace Multimedia {
73 class Registry;
74
85 public:
90 Container(const Container& other) noexcept = delete;
91
96 Container(Container&& other) noexcept;
97
101 ~Container() noexcept;
102
108 Container& operator=(const Container& other) noexcept = delete;
109
115 Container& operator=(Container&& other) noexcept;
116
122 bool operator==(const Container& other) const noexcept;
123
129 bool operator!=(const Container& other) const noexcept;
130
135 constexpr std::string_view Name() const noexcept { return m_name; }
136
141 constexpr std::string_view Description() const noexcept { return m_description; }
142
147 constexpr std::string_view Extension() const noexcept { return m_extension; }
148
154 bool HasAccess(Access access) const noexcept;
155
162 bool Allows(const CodecRefs& codecs) const noexcept;
163
169 bool Stores(Metadata::FileTag tag) const noexcept;
170
176 bool Stores(Metadata::StreamTag tag) const noexcept;
177
184 bool SharedTitle() const noexcept;
185
186 private:
190 friend class Registry;
191
192 std::string_view m_name;
193 std::string_view m_description;
194 std::string_view m_extension;
195 Access m_access;
196 CodecRefs m_allowed;
197 unsigned short m_file_tags = 0;
198 unsigned char m_stream_tags = 0;
199 bool m_shared_title = false;
200
208 Container(std::string_view name, std::string_view description, std::string_view extension, Access access);
209 };
210 }
211}
212
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
Bitmask of Operation flags for a codec.
Definition type.hxx:114
bool Stores(Metadata::FileTag tag) const noexcept
Whether files written in this container keep file tag tag.
~Container() noexcept
Destroys the compatibility list in the multimedia provider.
bool HasAccess(Access access) const noexcept
Tests Read/Write flags.
bool Allows(const CodecRefs &codecs) const noexcept
Whether every codec in codecs is allowed in this container.
Container(const Container &other) noexcept=delete
Copy is disabled; instances are unique in the registry.
constexpr std::string_view Description() const noexcept
Human description.
Definition container.hxx:141
bool Stores(Metadata::StreamTag tag) const noexcept
Whether files written in this container keep per-track tag tag.
bool SharedTitle() const noexcept
Whether the file title and the track titles share one field.
friend class Registry
Registry creates identities and resolves compatibility handles.
Definition container.hxx:190
constexpr std::string_view Name() const noexcept
StormByte container name.
Definition container.hxx:135
Container(Container &&other) noexcept
Moves the compatibility list in the multimedia provider.
constexpr std::string_view Extension() const noexcept
Default file extension without a leading dot.
Definition container.hxx:147
Process-wide catalog of codecs and containers.
Definition registry.hxx:115
Multimedia module of the StormByte suite.
FileTag
File-level tag that a job can keep, replace or remove.
Definition tag.hxx:75
StreamTag
Per-track tag that a job can keep, replace or remove.
Definition tag.hxx:98
Multimedia module of the StormByte suite.
Safe::Vector< CodecRef > CodecRefs
Safe-owned list of borrowed codecs, not codec ownership.
Definition typedefs.hxx:312
Root namespace of the StormByte C++ suite.
STL namespace.
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition visibility.h:61