StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
stream.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/bitmask.hxx>
55#include <StormByte/safe/optional.hxx>
56#include <StormByte/safe/string.hxx>
57
58#include <cstdint>
59
64namespace StormByte {
69 namespace Multimedia {
74 class File;
75
80 class Stream;
81
86 namespace Detail {
91 class Probe;
92 }
93
98 namespace Metadata {
103 class Stream;
104
110 None = 0,
111 Default = 1 << 0,
112 Dub = 1 << 1,
113 Original = 1 << 2,
114 Comment = 1 << 3,
115 Lyrics = 1 << 4,
116 Karaoke = 1 << 5,
117 Forced = 1 << 6,
119 VisualImpaired = 1 << 8,
121 };
122
127 class STORMBYTE_MULTIMEDIA_PUBLIC Disposition: public StormByte::Bitmask<Disposition, DispositionFlag> {
128 public:
133 Disposition(const Disposition& disposition) noexcept;
134
139 Disposition(Disposition&& disposition) noexcept;
140
144 ~Disposition() noexcept override;
145
151 Disposition& operator=(const Disposition& disposition) noexcept;
152
158 Disposition& operator=(Disposition&& disposition) noexcept;
159
160 private:
161 friend class Stream;
162 friend class StormByte::Multimedia::File;
165
169 Disposition() noexcept;
170
175 Disposition(DispositionFlag flag) noexcept;
176 };
177 }
178 }
179}
180
182
187namespace StormByte {
192 namespace Multimedia {
197 namespace Metadata {
198
204 public:
209 Stream(const Stream& other);
210
215 Stream(Stream&& other) noexcept;
216
220 ~Stream() noexcept;
221
227 Stream& operator=(const Stream& other);
228
234 Stream& operator=(Stream&& other) noexcept;
235
240 const Safe::Optional<Safe::String>& Title() const noexcept;
241
246 const Safe::Optional<Safe::String>& Language() const noexcept;
247
252 Safe::Optional<std::uint64_t> BitRate() const;
253
258 class Disposition Disposition() const noexcept;
259
260 private:
261 friend class StormByte::Multimedia::File;
264
265 Safe::Optional<Safe::String> m_title;
266
267 Safe::Optional<Safe::String> m_language;
268
269 Safe::Optional<std::uint64_t> m_bitRate;
270
271 class Disposition m_disposition;
272
276 Stream();
277
282 void Title(Safe::String title);
283
288 void Language(Safe::String language);
289
294 void BitRate(std::uint64_t bitRate);
295
300 void Disposition(class Disposition disposition) noexcept;
301 };
302 }
303 }
304}
305
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
Private metadata probe.
Read-only consultation snapshot of a media source.
Definition file.hxx:135
Disposition(const Disposition &disposition) noexcept
Copy constructor.
~Disposition() noexcept override
Destructor.
friend class StormByte::Multimedia::Detail::Probe
Definition stream.hxx:163
Disposition(Disposition &&disposition) noexcept
Move constructor.
friend class StormByte::Multimedia::File
Definition stream.hxx:162
friend class Stream
Definition stream.hxx:161
Stream(const Stream &other)
Copy constructor.
friend class StormByte::Multimedia::Detail::Probe
Definition stream.hxx:263
friend class StormByte::Multimedia::File
Definition stream.hxx:261
const Safe::Optional< Safe::String > & Title() const noexcept
Stream title.
const Safe::Optional< Safe::String > & Language() const noexcept
Language code (usually ISO 639).
friend class StormByte::Multimedia::Stream
Definition stream.hxx:262
class Disposition Disposition() const noexcept
Disposition flags.
Safe::Optional< std::uint64_t > BitRate() const
Stream bitrate in bits per second.
Stream(Stream &&other) noexcept
Move constructor.
Public media stream snapshot.
Definition stream.hxx:86
Multimedia module of the StormByte suite.
Private multimedia implementation helpers.
DispositionFlag
Per-stream disposition bits (FFmpeg AV_DISPOSITION_* subset).
Definition stream.hxx:109
@ Dub
Dubbed audio.
Definition stream.hxx:112
@ Original
Original language.
Definition stream.hxx:113
@ Comment
Commentary.
Definition stream.hxx:114
@ HearingImpaired
Hearing-impaired content.
Definition stream.hxx:118
@ VisualImpaired
Visually impaired content.
Definition stream.hxx:119
@ None
No flags.
Definition stream.hxx:110
@ Default
Default playback stream.
Definition stream.hxx:111
@ Lyrics
Lyrics.
Definition stream.hxx:115
@ AttachedPicture
Cover or attached picture.
Definition stream.hxx:120
@ Karaoke
Karaoke.
Definition stream.hxx:116
@ Forced
Forced subtitles.
Definition stream.hxx:117
Multimedia module of the StormByte suite.
Root namespace of the StormByte C++ suite.
STL namespace.
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition visibility.h:61