filters.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/multimedia/pipeline/filters/ffmpeg.hxx>
#include <StormByte/multimedia/pipeline/filters/report.hxx>
#include <StormByte/multimedia/pipeline/progress.hxx>
#include <StormByte/multimedia/pipeline/step.hxx>
#include <StormByte/multimedia/visibility.h>
 
#include <cstddef>
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
#include <utility>
#include <vector>
 
namespace StormByte::Multimedia::Backend::Pipeline {
    class Transcoder;
}

namespace StormByte::Multimedia::Pipeline {
    class Decoder;
    class Demuxer;
    class Route;

    class STORMBYTE_MULTIMEDIA_PUBLIC Filters {
        friend class Decoder;
        friend class Demuxer;
        friend class Filter::FFmpeg;
        friend class Filter::ProcessTwoPasses;
        friend class StormByte::Multimedia::Backend::Pipeline::Transcoder;
 
        public:
            class Handle;

            Filters() noexcept;

            Filters(const Filters&) = delete;

            Filters(Filters&&) noexcept = delete;

            ~Filters() noexcept;

            Filters& operator=(const Filters&) = delete;

            Filters& operator=(Filters&&) noexcept = delete;

            Handle Between(std::shared_ptr<Step> origin,
                std::shared_ptr<Step> destination) noexcept;

            Filters& Add(std::shared_ptr<Filter::FFmpeg> filter) noexcept;

            template<typename T, typename... Args>
            Filters& Add(Args&&... args) noexcept {
                return Add(std::shared_ptr<Filter::FFmpeg>(
                    std::make_shared<T>(std::forward<Args>(args)...)));
            }

            void Close() noexcept;

            bool Idle() const noexcept;

            std::vector<std::pair<std::string, Filter::Report>> Reports() const noexcept;

            class STORMBYTE_MULTIMEDIA_PUBLIC Handle {
                public:
                    Handle& Add(std::shared_ptr<Filter::FFmpeg> filter) noexcept;

                    template<typename T, typename... Args>
                    Handle& Add(Args&&... args) noexcept {
                        return Add(std::shared_ptr<Filter::FFmpeg>(
                            std::make_shared<T>(std::forward<Args>(args)...)));
                    }
 
                private:
                    friend class Filters;

                    Handle(Filters& owner, std::size_t index) noexcept;
 
                    Filters* m_owner;       
                    std::size_t m_index;    
            };
 
        private:
            bool Measuring() const noexcept;

            bool MeasureReadyToFinish() const noexcept;

            void CloseMeasureSource() noexcept;

            void OnMeasureDrained(int track) noexcept;

            void OnMeasureFilterDrained() noexcept;

            void MaybeFinishMeasure() noexcept;

            void FinishMeasure() noexcept;

            void BindClock() noexcept;

            void ClockAnalytics() noexcept;

            void NoteAnalytics(std::int64_t ns) noexcept;

            void NoteMeasure(std::int64_t ns) noexcept;

            struct Stretch {
                std::shared_ptr<Step> Origin;           
                std::shared_ptr<Step> Destination;      
                int Track = -1;                         
                std::unique_ptr<Route> Lane;            
                std::optional<int> Scope;               
            };

            struct Attached {
                std::shared_ptr<Filter::FFmpeg> Filter; 
                std::optional<int> Track;               
            };
 
            std::vector<Stretch> m_stretches;           
            std::vector<Attached> m_globals;            
            std::vector<Attached> m_reports;            
            std::vector<int> m_measureTracks;           
            std::vector<int> m_measureDrained;          
            std::size_t m_measureFilterCount = 0;       
            std::size_t m_measureFiltersDrained = 0;    
            bool m_measuring = false;                   
            bool m_hasAnalytics = false;                
            std::shared_ptr<class Progress> m_progress; 
    };
}