StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
AVFilterGraph.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
57#include <StormByte/safe/string.hxx>
58
59#include <cstdint>
60#include <string_view>
61
66namespace StormByte {
71 namespace Multimedia {
76 namespace FFmpeg {
80 class AVFrame;
81
111 class STORMBYTE_MULTIMEDIA_PUBLIC AVFilterGraph: public AVPointer<::AVFilterGraph> {
112 public:
117 AVFilterGraph(AVFilterGraph&& other) noexcept;
118
122 ~AVFilterGraph() noexcept override;
123
129 AVFilterGraph& operator=(AVFilterGraph&& other) noexcept;
130
134 AVFilterGraph(const AVFilterGraph&) = delete;
135
139 AVFilterGraph& operator=(const AVFilterGraph&) = delete;
140
145 explicit operator bool() const noexcept;
146
155 static AVFilterGraph Open(const AVFrame& src, std::string_view graph);
156
164 static AVFilterGraph Open(const AVFrame& src, std::string_view graph, AVRational frameRate);
165
172 bool Ensure(const AVFrame& src, std::string_view graph);
173
181 bool Ensure(const AVFrame& src, std::string_view graph, AVRational frameRate);
182
187 AVRational FrameRate() const noexcept;
188
193 int OperationError() const noexcept;
194
201 bool Filter(const AVFrame& src, AVFrame& dst) const noexcept;
202
208 bool Receive(AVFrame& dst) const noexcept;
209
218 bool Flush(AVFrame& dst) noexcept;
219
220 private:
225 explicit AVFilterGraph(::AVFilterGraph* graph) noexcept;
226
230 AVFilterGraph() = delete;
231
235 void Free() noexcept override;
236
240 using AVPointer<::AVFilterGraph>::Get;
241
242 ::AVFilterContext* m_src = nullptr;
243 ::AVFilterContext* m_sink = nullptr;
244 int m_w = 0;
245 int m_h = 0;
246 int m_fmt = 0;
247 int m_rate = 0;
248 int m_ch = 0;
249 std::uint64_t m_mask = 0;
250 StormByte::Safe::String m_graph;
251 bool m_closed = false;
252 mutable std::int64_t m_endPts = INT64_MIN;
253 AVRational m_timeBase{0, 1};
254 AVRational m_frameRate{0, 1};
255 mutable int m_operationError = 0;
256 };
257
259
262 extern template class STORMBYTE_MULTIMEDIA_PUBLIC AVPointer<::AVFilterGraph>;
264 }
265 }
266}
267
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
RAII AVFilterGraph with a single video or audio in/out.
Definition AVFilterGraph.hxx:111
bool Flush(AVFrame &dst) noexcept
Closes the source once and pulls one flushed frame into dst.
AVFilterGraph(AVFilterGraph &&other) noexcept
Move constructor.
bool Filter(const AVFrame &src, AVFrame &dst) const noexcept
Pushes src and pulls into dst (KEEP_REF on the source).
bool Receive(AVFrame &dst) const noexcept
Pulls another available output without closing the source.
static AVFilterGraph Open(const AVFrame &src, std::string_view graph)
Builds a graph for src.
int OperationError() const noexcept
FFmpeg error from the last failed filter operation.
bool Ensure(const AVFrame &src, std::string_view graph)
Rebuilds if geometry, format, layout or chain changed.
~AVFilterGraph() noexcept override
Destructor.
AVRational FrameRate() const noexcept
Nominal video cadence negotiated at the sink.
RAII owner of a libav AVFrame.
Definition AVFrame.hxx:161
constexpr const std::decay_t< ::AVFilterGraph > * Get() const noexcept
Definition AVPointer.hxx:151
Pair {num, den} matching libavutil AVRational.
Definition av_rational.hxx:85
Incomplete FFmpeg types for RAII headers.
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