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
58#include <StormByte/safe/optional.hxx>
59#include <StormByte/safe/pair.hxx>
60#include <StormByte/safe/vector.hxx>
61
66namespace StormByte {
71 namespace Multimedia {
75 class File;
76
87 public:
95
101
107 Stream(const Stream& other);
108
113 Stream(Stream&& other) noexcept;
114
118 ~Stream() noexcept;
119
126 Stream& operator=(const Stream& other);
127
133 Stream& operator=(Stream&& other) noexcept;
134
139 int Index() const noexcept { return m_index; }
140
146 const class Codec& Codec() const;
147
152 Type Type() const noexcept;
153
158 const Metadata::Stream& Metadata() const noexcept { return m_metadata; }
159
168
174 const StormByte::Safe::Optional<Property::Video>& Video() const noexcept;
175
181 const StormByte::Safe::Optional<Property::Audio>& Audio() const noexcept;
182
183 private:
184 friend class File;
185
186 int m_index;
187 const class Codec* m_codec;
188 Metadata::Stream m_metadata;
189 mutable StormByte::Safe::Optional<Property::Duration> m_duration;
190 Properties m_properties;
191
200 Stream(int index, const class Codec& codec, Metadata::Stream metadata,
201 StormByte::Safe::Optional<Property::Duration> duration, Properties properties) noexcept;
202 };
203 }
204}
205
211
216namespace StormByte {
221 namespace Multimedia {
226 }
227}
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
Read-only consultation snapshot of a media source.
Definition file.hxx:135
Stream(Stream &&other) noexcept
Move constructor.
const Metadata::Stream & Metadata() const noexcept
Per-stream tags captured at Open.
Definition stream.hxx:158
Type Type() const noexcept
Media kind of the codec.
const StormByte::Safe::Optional< Property::Duration > & Duration() const noexcept
Stream duration.
Stream(const Stream &other)
Copy constructor.
friend class File
Definition stream.hxx:184
const class Codec & Codec() const
Codec of this stream.
const StormByte::Safe::Optional< Property::Audio > & Audio() const noexcept
Audio properties when this stream is audio.
Stream()
Constructs an empty stream snapshot.
~Stream() noexcept
Destructor.
StormByte::Safe::Pair< StormByte::Safe::Optional< Property::Video >, StormByte::Safe::Optional< Property::Audio > > Properties
Safe video and audio property snapshots, respectively.
Definition stream.hxx:92
const StormByte::Safe::Optional< Property::Video > & Video() const noexcept
Video properties when this stream is video.
int Index() const noexcept
Container stream index (avformat).
Definition stream.hxx:139
Multimedia module of the StormByte suite.
Media property value types.
Multimedia module of the StormByte suite.
StormByte::Safe::Vector< Stream > Streams
Ordered stream snapshots with creator-owned Safe storage.
Definition stream.hxx:225
Root namespace of the StormByte C++ suite.
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition visibility.h:61