StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
base.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#include <StormByte/safe/clonable.hxx>
57#include <StormByte/safe/optional.hxx>
58#include <StormByte/safe/string.hxx>
59
60#include <utility>
61
124
143 public:
148
153 Base(const Base& other);
154
159 Base(Base&& other) noexcept;
160
164 virtual ~Base() noexcept override;
165
171 Base& operator=(const Base& other);
172
178 Base& operator=(Base&& other) noexcept;
179
183
188
193 inline constexpr enum StormByte::Multimedia::Type Type() const noexcept {
194 return m_type;
195 }
196
200
205
211 return m_language;
212 }
213
219
225
231 return m_title;
232 }
233
239
244
249 inline const StormByte::Safe::Optional<bool>& Default() const noexcept {
250 return m_default;
251 }
252
257 inline void Default(StormByte::Safe::Optional<bool> value) noexcept {
258 m_default = std::move(value);
259 }
260
265 inline const StormByte::Safe::Optional<bool>& Forced() const noexcept {
266 return m_forced;
267 }
268
273 inline void Forced(StormByte::Safe::Optional<bool> value) noexcept {
274 m_forced = std::move(value);
275 }
276
280
285
290 inline const struct Implementation& Implementation() const noexcept {
291 return m_implementation;
292 }
293
298 inline void Implementation(struct Implementation implementation) noexcept {
299 m_implementation = std::move(implementation);
300 }
301
305
306 protected:
312
313 private:
314 enum StormByte::Multimedia::Type m_type;
319 struct Implementation m_implementation;
320 };
321}
322
327
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
Common destination-stream identity.
Definition base.hxx:142
const StormByte::Safe::Optional< bool > & Default() const noexcept
Default-disposition override.
Definition base.hxx:249
Base(enum StormByte::Multimedia::Type type)
Empty overrides; media fixed for the leaf lifetime.
void Title(StormByte::Safe::String title)
Sets the title override.
void Implementation(struct Implementation implementation) noexcept
Replaces both pins.
Definition base.hxx:298
void Forced(StormByte::Safe::Optional< bool > value) noexcept
Sets or clears the forced-disposition override.
Definition base.hxx:273
const struct Implementation & Implementation() const noexcept
Decoder / encoder pins.
Definition base.hxx:290
void RemoveTitle()
Writes the track without a title, even if the source has one.
const StormByte::Safe::Optional< StormByte::Safe::String > & Language() const noexcept
Language override.
Definition base.hxx:210
Base(const Base &other)
Copy constructor.
virtual ~Base() noexcept override
Destructor.
void RemoveLanguage()
Writes the track without a language tag, even if the source has one.
const StormByte::Safe::Optional< StormByte::Safe::String > & Title() const noexcept
Title override.
Definition base.hxx:230
void Default(StormByte::Safe::Optional< bool > value) noexcept
Sets or clears the default-disposition override.
Definition base.hxx:257
void Language(StormByte::Safe::String language)
Sets the language override.
const StormByte::Safe::Optional< bool > & Forced() const noexcept
Forced-disposition override.
Definition base.hxx:265
Base(Base &&other) noexcept
Move constructor.
Multimedia module of the StormByte suite.
Per-track intention stored by Plan.
Type
Kind of media stream or codec.
Definition type.hxx:72
DecodeAcceleration
Selects whether video decoders may use an available FFmpeg hardware backend.
Definition decode_policy.hxx:43
Root namespace of the StormByte C++ suite.
Optional decoder / encoder names for this track.
Definition base.hxx:83
Implementation()
Constructs empty decoder and encoder pins in Multimedia.
Implementation(Implementation &&other) noexcept
Transfers both pins without copying their storage.
~Implementation() noexcept
Releases both pins through their creator callbacks.
Implementation(const Implementation &other)
Copies both pins in Multimedia.
StormByte::Multimedia::DecodeAcceleration Acceleration
Video decoder acceleration; independent of the encoder.
Definition base.hxx:122
StormByte::Safe::Optional< StormByte::Safe::String > Decoder
Decode pin; empty = default.
Definition base.hxx:120
StormByte::Safe::Optional< StormByte::Safe::String > Encoder
Encode pin; empty = default.
Definition base.hxx:121
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition visibility.h:61