denoise.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte-Multimedia.
 *
 * StormByte-Multimedia original source is dual-licensed:
 *
 * 1. GNU Lesser General Public License v3.0 (or later)
 *    You may redistribute and/or modify this file under the terms of the
 *    GNU Lesser General Public License as published by the Free Software
 *    Foundation, either version 3 of the License, or (at your option)
 *    any later version.
 *
 * 2. Commercial license
 *    Alternatively, this file may be used under the terms of a commercial
 *    license agreement with the copyright holder
 *    (David C. Manuelda <StormByte@gmail.com>).
 *
 * Both licenses apply only to original StormByte-Multimedia source in this
 * file. Third-party components — including FFmpeg and embedded trained data —
 * remain under their own licenses and are not covered by the commercial grant.
 *
 * Neither license grants any patent rights. Any patent licenses required
 * to use this software or third-party components must be obtained separately
 * from the patent holders.
 *
 * StormByte-Multimedia is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with StormByte-Multimedia. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
 */
 
#pragma once
 
#include <StormByte/logger/log.hxx>
#include <StormByte/multimedia/ffmpeg/AVFilterGraph.hxx>
#include <StormByte/multimedia/ffmpeg/AVFrame.hxx>
#include <StormByte/multimedia/pipeline/filters/ffmpeg.hxx>
#include <StormByte/multimedia/visibility.h>
 
#include <memory>
#include <optional>
#include <string>
#include <vector>

namespace StormByte::Multimedia::Pipeline::Filter::Audio {
    class STORMBYTE_MULTIMEDIA_PUBLIC Denoise: public Filter::ProcessTwoPasses {
        public:
            Denoise(std::shared_ptr<StormByte::Logger::Log> log,
                std::optional<double> nr = {}) noexcept;
 
            Denoise(const Denoise& other) = delete;
            Denoise(Denoise&& other) noexcept = delete;
            ~Denoise() noexcept override = default;
            Denoise& operator=(const Denoise& other) = delete;
            Denoise& operator=(Denoise&& other) noexcept = delete;

            enum StormByte::Multimedia::Type Media() const noexcept override;

            void Clean() noexcept override;

            void Setup() noexcept override;

            void Measure(const Pipeline::Frame& frame) noexcept override;

            void Process(const Pipeline::Frame& frame) noexcept override;

            void Eof() noexcept override;

            class Filter::Report Report() const noexcept override;
 
        private:
            struct Candidate {
                double rmsDb = 0.0;
                double crest = 0.0;
                double zcr = 0.0;
                double hp = 0.0;
            };

            void Ingest(const StormByte::Multimedia::FFmpeg::AVFrame& src) noexcept;

            void EmitWindow() noexcept;

            void Vote() noexcept;

            std::string Chain() const noexcept;
 
            std::optional<double> m_nrIn;
            std::vector<float> m_acc;
            std::vector<Candidate> m_cand;
            int m_rate;
            int m_win;
            unsigned m_frames;
            bool m_voted;
            bool m_skip;
            double m_nf;
            double m_nr;
            int m_matches;
            std::unique_ptr<StormByte::Multimedia::FFmpeg::AVFilterGraph> m_graph;
    };
}