StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
AVPointer.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/type_traits.hxx>
56
61namespace StormByte {
66 namespace Multimedia {
71 namespace FFmpeg {
91 template<typename AVType>
93 public:
100 constexpr AVPointer() noexcept = delete;
101
105 constexpr AVPointer(const AVPointer&) noexcept = delete;
106
111 constexpr AVPointer(AVPointer&& other) noexcept
112 : m_ptr(other.m_ptr) {
113 other.m_ptr = nullptr;
114 }
115
119 virtual ~AVPointer() noexcept = default;
120
125 constexpr AVPointer& operator=(const AVPointer&) noexcept = delete;
126
132 constexpr AVPointer& operator=(AVPointer&& other) noexcept {
133 if (this != &other) {
134 Free();
135 m_ptr = other.m_ptr;
136 other.m_ptr = nullptr;
137 }
138 return *this;
139 }
140
141 protected:
142 std::decay_t<AVType>* m_ptr = nullptr;
143
151 constexpr const std::decay_t<AVType>* Get() const noexcept {
152 return m_ptr;
153 }
154
159 constexpr std::decay_t<AVType>* Get() noexcept {
160 return m_ptr;
161 }
162
172 constexpr std::decay_t<AVType>* Detach() noexcept {
173 auto* ptr = m_ptr;
174 m_ptr = nullptr;
175 return ptr;
176 }
177
182 explicit constexpr AVPointer(std::decay_t<AVType>* ptr) noexcept
183 : m_ptr(ptr) {}
184
191 virtual void Free() noexcept = 0;
192 };
193 }
194 }
195}
196
204STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Multimedia::FFmpeg::AVPointer<::AVAudioFifo>);
205
210STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Multimedia::FFmpeg::AVPointer<::AVBSFContext>);
211
216STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Multimedia::FFmpeg::AVPointer<::AVCodecContext>);
217
222STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Multimedia::FFmpeg::AVPointer<::AVCodecParameters>);
223
228STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Multimedia::FFmpeg::AVPointer<::AVDictionary>);
229
234STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Multimedia::FFmpeg::AVPointer<::AVFilterGraph>);
235
240STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Multimedia::FFmpeg::AVPointer<::AVFormatContext>);
241
246STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Multimedia::FFmpeg::AVPointer<::AVFrame>);
247
252STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Multimedia::FFmpeg::AVPointer<::AVPacket>);
253
258STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Multimedia::FFmpeg::AVPointer<::SwrContext>);
259
264STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Multimedia::FFmpeg::AVPointer<::SwsContext>);
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
constexpr const std::decay_t< AVType > * Get() const noexcept
Const view of the raw FFmpeg pointer.
Definition AVPointer.hxx:151
constexpr std::decay_t< AVType > * Get() noexcept
Mutable view of the raw FFmpeg pointer.
Definition AVPointer.hxx:159
virtual ~AVPointer() noexcept=default
Destructor.
constexpr AVPointer() noexcept=delete
Default constructor (deleted).
virtual void Free() noexcept=0
Releases the underlying resource.
constexpr std::decay_t< AVType > * Detach() noexcept
Yields the raw pointer and leaves this wrapper empty.
Definition AVPointer.hxx:172
constexpr AVPointer(std::decay_t< AVType > *ptr) noexcept
Adopts ptr.
Definition AVPointer.hxx:182
std::decay_t< AVType > * m_ptr
FFmpeg pointer; concrete wrapper defines ownership.
Definition AVPointer.hxx:142
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.
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition visibility.h:61