StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
item.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
58#include <cstdint>
59
70 class Frame;
71
75 class Packet;
76
80 class Pipe;
81}
82
87namespace StormByte {
92 namespace Multimedia {
99 namespace Pipeline {
103 class Decoder;
104
108 class Demuxer;
109
113 class Encoder;
114
118 class Frame;
119
123 class Muxer;
124
128 class Packet;
129
133 class Step;
134
141 namespace Filter {
145 class FFmpeg;
146 }
147
160 public:
165
170
174 virtual ~Item() noexcept = default;
175
179
184
189 Kind Kind() const noexcept {
190 return m_kind;
191 }
192
197 enum StormByte::Multimedia::Type Type() const noexcept {
198 return m_type;
199 }
200
205 int Track() const noexcept {
206 return m_track;
207 }
208
213 enum Producer Producer() const noexcept {
214 return m_producer;
215 }
216
220
221 protected:
226
231 Item(const Item& other) noexcept = default;
232
237 Item(Item&& other) noexcept = default;
238
244 Item& operator=(const Item& other) noexcept = default;
245
251 Item& operator=(Item&& other) noexcept = default;
252
256
257 private:
261 friend class Backend::Pipeline::Frame;
262
266 friend class Backend::Pipeline::Packet;
267
271 friend class Backend::Pipeline::Pipe;
272
276 friend class Decoder;
277
281 friend class Demuxer;
282
286 friend class Encoder;
287
291 friend class Filter::FFmpeg;
292
296 friend class Frame;
297
301 friend class Muxer;
302
306 friend class Packet;
307
311 friend class Step;
312
320 Item(int track, enum StormByte::Multimedia::Type type, enum Kind kind, enum Producer producer) noexcept
321 : m_track(track), m_type(type), m_kind(kind), m_producer(producer) {}
322
323 int m_track;
324 enum StormByte::Multimedia::Type m_type;
325 enum Kind m_kind;
326 enum Producer m_producer;
327 };
328 }
329 }
330}
331
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
Decodes packets of one origin track into frames.
Definition decoder.hxx:148
Reads interleaved compressed packets from the Plan reader.
Definition demuxer.hxx:148
Encodes frames of one output track into packets.
Definition encoder.hxx:145
Abstract base for every StormByte Multimedia filter.
Definition ffmpeg.hxx:261
One decoded access unit.
Definition frame.hxx:103
Facade shared by Frame and Packet.
Definition item.hxx:159
virtual ~Item() noexcept=default
Destructor.
enum Producer Producer() const noexcept
Stage that created this unit.
Definition item.hxx:213
Item & operator=(const Item &other) noexcept=default
Copy assignment.
friend class Backend::Pipeline::Frame
Allows the decoded-AU holder to access item identity.
Definition item.hxx:261
enum StormByte::Multimedia::Type Type() const noexcept
Media of this access unit.
Definition item.hxx:197
friend class Decoder
Allows the decoder to access item identity.
Definition item.hxx:276
Item(Item &&other) noexcept=default
Move constructor.
friend class Encoder
Allows the encoder to access item identity.
Definition item.hxx:286
friend class Backend::Pipeline::Packet
Allows the compressed-AU holder to access item identity.
Definition item.hxx:266
int Track() const noexcept
Origin track index.
Definition item.hxx:205
friend class Demuxer
Allows the demuxer to access item identity.
Definition item.hxx:281
Kind Kind() const noexcept
Whether this unit is a frame or a packet.
Definition item.hxx:189
Item(const Item &other) noexcept=default
Copy constructor.
friend class Muxer
Allows the muxer to access item identity.
Definition item.hxx:301
friend class Step
Allows pipeline stages to access item identity.
Definition item.hxx:311
Item & operator=(Item &&other) noexcept=default
Move assignment.
Writes interleaved packets to the Plan writer.
Definition muxer.hxx:217
One compressed access unit.
Definition packet.hxx:102
A pipeline stage that receives and emits media items.
Definition step.hxx:196
Producer
Named stage of the tube.
Definition typedefs.hxx:136
Kind
Whether an Item is a decoded frame or a compressed packet.
Definition typedefs.hxx:109
@ Frame
Decoded StormByte::Multimedia::Pipeline::Frame.
Definition typedefs.hxx:111
Multimedia-owned pipeline stages and unit holders.
Frame and packet steps attached to a job or a raw pipeline.
Demux / decode / filter / encode / mux types.
@ Packet
Packet filter (Filter::Packet and derived).
Definition telemetry.hxx:409
@ Pipe
Buffer::Sink hopper owned by its consumer stage.
Definition telemetry.hxx:429
Multimedia module of the StormByte suite.
Type
Kind of media stream or codec.
Definition type.hxx:72
Root namespace of the StormByte C++ suite.
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition visibility.h:61