StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
side_data.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/buffer/fifo.hxx>
55#include <StormByte/safe/optional.hxx>
56#include <StormByte/safe/string.hxx>
57#include <StormByte/type_traits/safe.hxx>
58
65namespace StormByte {
72 namespace Multimedia {
79 namespace Pipeline {
105
115 public:
121
129
139
145 SideData(const SideData& other);
146
151 SideData(SideData&& other) noexcept;
152
156 ~SideData() noexcept;
157
164 SideData& operator=(const SideData& other);
165
171 SideData& operator=(SideData&& other) noexcept;
172
177 SideDataKind Kind() const noexcept;
178
183 const StormByte::Safe::Optional<StormByte::Safe::String>& Name() const noexcept;
184
189 const StormByte::Buffer::FIFO& Payload() const noexcept;
190
195 StormByte::Buffer::FIFO& Payload() noexcept;
196
197 private:
198 SideDataKind m_kind = SideDataKind::Other;
199 StormByte::Safe::Optional<StormByte::Safe::String> m_name;
200 StormByte::Buffer::FIFO m_payload;
201 };
202 }
203 }
204}
205
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
SideData(SideDataKind kind, StormByte::Buffer::FIFO payload)
Known kind plus payload.
SideDataKind Kind() const noexcept
Kind.
SideData(const SideData &other)
Copy constructor.
SideData(SideData &&other) noexcept
Move constructor.
SideData(StormByte::Safe::String name, StormByte::Buffer::FIFO payload)
Other kind plus FFmpeg name and payload.
SideData()
Empty unnamed blob of kind Other for Safe value storage.
const StormByte::Safe::Optional< StormByte::Safe::String > & Name() const noexcept
libav name when Kind is Other.
const StormByte::Buffer::FIFO & Payload() const noexcept
Raw payload.
Multimedia module of the StormByte suite.
Pipeline Demux / decode / filter / encode / mux types.
Typed item queues provided by StormByte-Buffer.
Demux / decode / filter / encode / mux types.
SideDataKind
Known libav side-data kinds on a Frame or Packet.
Definition side_data.hxx:87
@ S12MTimecode
SMPTE ST 12-1 timecode.
Definition side_data.hxx:96
@ Spherical
Spherical mapping.
Definition side_data.hxx:97
@ IccProfile
ICC profile.
Definition side_data.hxx:95
@ MasteringDisplay
Mastering display metadata.
Definition side_data.hxx:88
@ AmbientViewing
Ambient viewing environment.
Definition side_data.hxx:102
@ ContentLight
MaxCLL / MaxFALL.
Definition side_data.hxx:89
@ A53CC
CEA-708 / A53 captions.
Definition side_data.hxx:92
@ Stereo3D
Stereo 3D.
Definition side_data.hxx:93
@ Other
Unknown kind; Name() is set.
Definition side_data.hxx:103
@ DolbyVision
Dolby Vision metadata.
Definition side_data.hxx:101
@ DisplayMatrix
Display matrix.
Definition side_data.hxx:94
@ HdrPlus
HDR10+ dynamic metadata.
Definition side_data.hxx:90
@ DolbyVisionRpu
Dolby Vision RPU.
Definition side_data.hxx:100
@ FilmGrain
Film grain parameters.
Definition side_data.hxx:99
@ SeiUnregistered
Unregistered SEI.
Definition side_data.hxx:98
@ HdrVivid
HDR Vivid dynamic metadata.
Definition side_data.hxx:91
Multimedia module of the StormByte suite.
Root namespace of the StormByte C++ suite.
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition visibility.h:61