StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
typedefs.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
53#include <StormByte/expected.hxx>
56#include <StormByte/safe/vector.hxx>
57
62namespace StormByte {
67 namespace Multimedia {
72 class Codec;
77 class Container;
82 class File;
87 class Stream;
88
97 public:
101 constexpr CodecRef() noexcept = default;
102
107 constexpr CodecRef(const Codec& codec) noexcept: m_codec(&codec) {}
108
113 constexpr CodecRef(const CodecRef& other) noexcept = default;
114
119 constexpr CodecRef(CodecRef&& other) noexcept = default;
120
124 ~CodecRef() noexcept = default;
125
131 constexpr CodecRef& operator=(const CodecRef& other) noexcept = default;
132
138 constexpr CodecRef& operator=(CodecRef&& other) noexcept = default;
139
144 constexpr explicit operator bool() const noexcept { return m_codec != nullptr; }
145
151 constexpr const Codec& get() const noexcept { return *m_codec; }
152
158 constexpr operator const Codec&() const noexcept { return get(); }
159
160 private:
161 const Codec* m_codec = nullptr;
162 };
163
172 public:
176 constexpr ContainerRef() noexcept = default;
177
182 constexpr ContainerRef(const Container& container) noexcept: m_container(&container) {}
183
188 constexpr ContainerRef(const ContainerRef& other) noexcept = default;
189
194 constexpr ContainerRef(ContainerRef&& other) noexcept = default;
195
199 ~ContainerRef() noexcept = default;
200
206 constexpr ContainerRef& operator=(const ContainerRef& other) noexcept = default;
207
213 constexpr ContainerRef& operator=(ContainerRef&& other) noexcept = default;
214
219 constexpr explicit operator bool() const noexcept { return m_container != nullptr; }
220
226 constexpr const Container& get() const noexcept { return *m_container; }
227
233 constexpr operator const Container&() const noexcept { return get(); }
234
235 private:
236 const Container* m_container = nullptr;
237 };
238 }
239}
240
246
252
257namespace StormByte {
262 namespace Multimedia {
263
270 namespace Pipeline {
275 class Transcoder;
276 }
277
285
293
299
305
313
321 }
322}
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
Trivial borrowed codec handle; never owns or deletes the codec.
Definition typedefs.hxx:96
constexpr CodecRef() noexcept=default
Constructs an empty handle.
constexpr const Codec & get() const noexcept
Gets the borrowed codec, preserving reference_wrapper syntax.
Definition typedefs.hxx:151
constexpr CodecRef(CodecRef &&other) noexcept=default
Copies the borrowed pointer without clearing the source.
~CodecRef() noexcept=default
Destroys the handle, not its codec.
constexpr CodecRef(const CodecRef &other) noexcept=default
Copies the borrowed pointer.
Immutable codec identity owned by Registry.
Definition codec.hxx:94
Trivial borrowed container handle; never owns or deletes the container.
Definition typedefs.hxx:171
constexpr ContainerRef(const ContainerRef &other) noexcept=default
Copies the borrowed pointer.
~ContainerRef() noexcept=default
Destroys the handle, not its container.
constexpr ContainerRef() noexcept=default
Constructs an empty handle.
constexpr const Container & get() const noexcept
Gets the borrowed container, preserving reference_wrapper syntax.
Definition typedefs.hxx:226
constexpr ContainerRef(ContainerRef &&other) noexcept=default
Copies the borrowed pointer without clearing the source.
Immutable container identity owned by StormByte::Multimedia::Registry.
Definition container.hxx:84
Read-only consultation snapshot of a media source.
Definition file.hxx:135
Public media stream snapshot.
Definition stream.hxx:86
Thrown when Transcode::Open or a configuration call fails.
Definition exception.hxx:402
Coordinator behind StormByte::Multimedia::Pipeline::Transcoder.
Multimedia module of the StormByte suite.
Pipeline Demux / decode / filter / encode / mux types.
Multimedia module of the StormByte suite.
Safe::Vector< CodecRef > CodecRefs
Safe-owned list of borrowed codecs, not codec ownership.
Definition typedefs.hxx:312
StormByte::Expected< ContainerRef, ContainerNotFoundException > ExpectedContainer
Result of FindContainer.
Definition typedefs.hxx:292
StormByte::Expected< CodecRef, CodecNotFoundException > ExpectedCodec
Result of FindCodec.
Definition typedefs.hxx:284
StormByte::Expected< File, FileOpenException > ExpectedFile
Result of OpenFile.
Definition typedefs.hxx:298
StormByte::Expected< Safe::Unique< Pipeline::Transcoder >, TranscodeException > ExpectedTranscoder
Result of Transcoder::Open.
Definition typedefs.hxx:304
Safe::Vector< ContainerRef > ContainerRefs
Safe-owned list of borrowed containers, not container ownership.
Definition typedefs.hxx:320
Root namespace of the StormByte C++ suite.
std::conditional_t< Type::Reference< T >, std::expected< std::reference_wrapper< std::remove_reference_t< T > >, Safe::Shared< E > >, std::expected< T, Safe::Shared< E > > > Expected
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition visibility.h:61