StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
denoise.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/map.hxx>
59#include <StormByte/safe/optional.hxx>
60#include <StormByte/safe/pointers.hxx>
61#include <StormByte/safe/string.hxx>
62#include <StormByte/safe/vector.hxx>
63
74 public:
75 double rmsDb = 0.0;
76 double crest = 0.0;
77 double zcr = 0.0;
78 double hp = 0.0;
79 };
80}
81
83
125 public:
132 Safe::Optional<double> nr = {});
133
138 Denoise(const Denoise& other) = delete;
139
144 Denoise(Denoise&& other) noexcept = delete;
145
149 ~Denoise() noexcept override;
150
156 Denoise& operator=(const Denoise& other) = delete;
157
163 Denoise& operator=(Denoise&& other) noexcept = delete;
164
169 enum StormByte::Multimedia::Type Media() const noexcept override;
170
174 void Clean() noexcept override;
175
179 void Setup() noexcept override;
180
185 void Measure(const Pipeline::Frame& frame) noexcept override;
186
191 void Process(const Pipeline::Frame& frame) noexcept override;
192
196 void Eof() noexcept override;
197
202 class Filter::Report Report() const override;
203
204 private:
209 using Candidate = Detail::DenoiseCandidate;
210
215 void Ingest(const StormByte::Multimedia::FFmpeg::AVFrame& src);
216
220 void EmitWindow();
221
225 void Vote();
226
231 Safe::String Chain() const;
232
233 Safe::Optional<double> m_nrIn;
234 StormByte::Safe::Vector<float> m_acc;
235 StormByte::Safe::Vector<Candidate> m_cand;
236 int m_rate;
237 int m_win;
238 unsigned m_frames;
239 bool m_voted;
240 bool m_skip;
241 double m_nf;
242 double m_nr;
243 int m_matches;
244 StormByte::Safe::Unique<StormByte::Multimedia::FFmpeg::AVFilterGraph> m_graph;
245 };
246}
247
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
enum StormByte::Multimedia::Type Media() const noexcept override
Media this filter handles.
void Clean() noexcept override
Drops candidates, vote and graph.
class Filter::Report Report() const override
Vote result and afftdn knobs.
void Process(const Pipeline::Frame &frame) noexcept override
Second pass: afftdn with the voted floor, or no-op.
void Measure(const Pipeline::Frame &frame) noexcept override
First pass: collect room-tone candidates.
Denoise(const Denoise &other)=delete
Copy construction is disabled.
~Denoise() noexcept override
Releases measurement storage and the graph in Multimedia.
void Setup() noexcept override
Resets per-pass accumulators.
void Eof() noexcept override
Closes the vote (measure) or flushes the graph (process).
Denoise(Safe::Shared< StormByte::Logger::Log > log, Safe::Optional< double > nr={})
Automatic room-tone denoise.
Denoise(Denoise &&other) noexcept=delete
Move construction is disabled.
friend class StormByte::Multimedia::Backend::Pipeline::Detail::Worker::Filter
Definition ffmpeg.hxx:264
const StormByte::Multimedia::FFmpeg::AVFrame & AVFrame() const noexcept
Borrowed RAII handle of the current frame.
Process that measures the origin before it rewrites.
Definition ffmpeg.hxx:902
friend class FFmpeg
Definition ffmpeg.hxx:904
One decoded access unit.
Definition frame.hxx:103
Multimedia module of the StormByte suite.
Pipeline Demux / decode / filter / encode / mux types.
Provider-internal audio filter state types.
Root namespace of the StormByte C++ suite.
Room-tone signature used by the Denoise vote.
Definition denoise.hxx:73
double crest
Peak-to-RMS ratio.
Definition denoise.hxx:76
double zcr
Zero-crossing ratio.
Definition denoise.hxx:77
double hp
High-pass energy ratio.
Definition denoise.hxx:78
double rmsDb
Window RMS in dB.
Definition denoise.hxx:75
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition visibility.h:61