StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
AVChannelLayout.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
55#include <StormByte/safe/string.hxx>
56
57#include <cstdint>
58
63namespace StormByte {
68 namespace Multimedia {
73 namespace FFmpeg {
77 struct Convert;
78
82 class AVCodecParameters;
83
87 class AVDecoder;
88
92 class AVEncoder;
93
97 class AVFrame;
98
102 class Swr;
103
112 public:
116 AVChannelLayout() noexcept;
117
122 explicit AVChannelLayout(int channels) noexcept;
123
128 AVChannelLayout(const AVChannelLayout& other) noexcept;
129
135
139 ~AVChannelLayout() noexcept;
140
146 AVChannelLayout& operator=(const AVChannelLayout& other) noexcept;
147
153 AVChannelLayout& operator=(AVChannelLayout&& other) noexcept;
154
160 static AVChannelLayout Default(int channels) noexcept;
161
166 explicit operator bool() const noexcept;
167
172 int NbChannels() const noexcept;
173
178 std::uint64_t Mask() const noexcept;
179
184 int Order() const noexcept;
185
190 Safe::String Describe() const;
191
197 bool operator==(const AVChannelLayout& other) const noexcept;
198
204 bool operator!=(const AVChannelLayout& other) const noexcept;
205
206 private:
210 friend struct Convert;
211
215 friend class AVCodecParameters;
216
220 friend class AVDecoder;
221
225 friend class AVEncoder;
226
230 friend class AVFrame;
231
235 friend class Swr;
236
237 ::AVChannelLayout* m_raw = nullptr;
238
242 void Ensure() noexcept;
243
247 void Free() noexcept;
248
253 const ::AVChannelLayout* Get() const noexcept;
254
259 ::AVChannelLayout* Get() noexcept;
260 };
261 }
262 }
263}
264
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
int Order() const noexcept
AVChannelOrder as int.
static AVChannelLayout Default(int channels) noexcept
Default layout for channels.
friend class AVCodecParameters
Allows codec parameters to access the C layout.
Definition AVChannelLayout.hxx:215
std::uint64_t Mask() const noexcept
Native bitmask (u.mask) when order is native.
int NbChannels() const noexcept
Channel count (nb_channels).
Safe::String Describe() const
FFmpeg layout name (av_channel_layout_describe).
friend struct Convert
Allows the conversion bridge to access the C layout.
Definition AVChannelLayout.hxx:210
friend class Swr
Allows the audio resampler to access the C layout.
Definition AVChannelLayout.hxx:235
friend class AVEncoder
Allows the encoder to access the C layout.
Definition AVChannelLayout.hxx:225
friend class AVDecoder
Allows the decoder to access the C layout.
Definition AVChannelLayout.hxx:220
friend class AVFrame
Allows frames to access the C layout.
Definition AVChannelLayout.hxx:230
RAII owner of a libav AVFrame.
Definition AVFrame.hxx:161
Incomplete FFmpeg types for RAII headers.
Multimedia module of the StormByte suite.
Private RAII wrappers over libav*.
Multimedia module of the StormByte suite.
Root namespace of the StormByte C++ suite.
STL namespace.
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition visibility.h:61