StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
downmix.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/logger/log.hxx>
58#include <StormByte/safe/pointers.hxx>
59#include <StormByte/safe/string.hxx>
60
61#include <memory>
62#include <string_view>
63
104 public:
112
117 Downmix(const Downmix& other) = delete;
118
123 Downmix(Downmix&& other) noexcept = delete;
124
128 ~Downmix() noexcept override;
129
135 Downmix& operator=(const Downmix& other) = delete;
136
142 Downmix& operator=(Downmix&& other) noexcept = delete;
143
148 enum StormByte::Multimedia::Type Media() const noexcept override;
149
153 void Clean() noexcept override;
154
158 void Setup() noexcept override;
159
164 void Process(const Pipeline::Frame& frame) noexcept override;
165
169 void Eof() noexcept override;
170
171 private:
177 std::string_view LayoutName() const noexcept;
178
183 Safe::String AformatChain() const;
184
189 Safe::String PanChain() const;
190
197 bool EnsureGraph(const StormByte::Multimedia::FFmpeg::AVFrame& src,
198 std::string_view chain);
199
200 Property::ChannelLayout m_target;
201 StormByte::Safe::Unique<StormByte::Multimedia::FFmpeg::AVFilterGraph> m_graph;
202 bool m_pan = false;
203 };
204}
205
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
~Downmix() noexcept override
Drops the cached graph.
void Setup() noexcept override
Resets the graph before the first frame.
Downmix(Safe::Shared< StormByte::Logger::Log > log, Property::ChannelLayout target)
Downmix toward target.
void Process(const Pipeline::Frame &frame) noexcept override
Pushes one audio frame through aformat/pan and Save.
void Clean() noexcept override
Drops the cached graph.
void Eof() noexcept override
Drains frames still held by the graph, if any.
Downmix(const Downmix &other)=delete
Copy is not allowed.
enum StormByte::Multimedia::Type Media() const noexcept override
Media this filter handles.
Downmix(Downmix &&other) noexcept=delete
Move is not allowed.
FFmpeg(const FFmpeg &other)=delete
Copy is not allowed.
const StormByte::Multimedia::FFmpeg::AVFrame & AVFrame() const noexcept
Borrowed RAII handle of the current frame.
One-pass filter that mutates decoded frames.
Definition ffmpeg.hxx:844
One decoded access unit.
Definition frame.hxx:103
Multimedia module of the StormByte suite.
Pipeline Demux / decode / filter / encode / mux types.
Media property value types.
ChannelLayout
Curated speaker layouts.
Definition channel_layout.hxx:74
Root namespace of the StormByte C++ suite.
STL namespace.
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition visibility.h:61