StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
upmix.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
97 public:
105
110 Upmix(const Upmix& other) = delete;
111
116 Upmix(Upmix&& other) noexcept = delete;
117
121 ~Upmix() noexcept override;
122
128 Upmix& operator=(const Upmix& other) = delete;
129
135 Upmix& operator=(Upmix&& other) noexcept = delete;
136
141 enum StormByte::Multimedia::Type Media() const noexcept override;
142
146 void Clean() noexcept override;
147
151 void Setup() noexcept override;
152
157 void Process(const Pipeline::Frame& frame) noexcept override;
158
162 void Eof() noexcept override;
163
164 private:
168 enum class Mode: std::uint8_t {
169 None,
170 Surround,
171 Aformat,
172 Pan
173 };
174
180 std::string_view LayoutName() const noexcept;
181
186 bool TargetHasLfe() const noexcept;
187
193 Safe::String SurroundChain(const StormByte::Multimedia::FFmpeg::AVFrame& src) const;
194
199 Safe::String AformatChain() const;
200
205 Safe::String PanChain() const;
206
213 bool EnsureGraph(const StormByte::Multimedia::FFmpeg::AVFrame& src,
214 std::string_view chain);
215
216 Property::ChannelLayout m_target;
217 StormByte::Safe::Unique<StormByte::Multimedia::FFmpeg::AVFilterGraph> m_graph;
218 Mode m_mode = Mode::None;
219 };
220}
221
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
Upmix(Safe::Shared< StormByte::Logger::Log > log, Property::ChannelLayout target)
Upmix toward target.
void Setup() noexcept override
Resets the graph before the first frame.
void Eof() noexcept override
Drains frames still held by the graph, if any.
void Clean() noexcept override
Drops the cached graph.
Upmix(const Upmix &other)=delete
Copy is not allowed.
Upmix(Upmix &&other) noexcept=delete
Move is not allowed.
~Upmix() noexcept override
Drops the cached graph.
void Process(const Pipeline::Frame &frame) noexcept override
Pushes one audio frame through surround/aformat/pan and Save.
enum StormByte::Multimedia::Type Media() const noexcept override
Media this filter handles.
Abstract base for every StormByte Multimedia filter.
Definition ffmpeg.hxx:261
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
@ None
No flags.
Definition feature.hxx:83
Root namespace of the StormByte C++ suite.
STL namespace.
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition visibility.h:61