route.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/decoder.hxx>
#include <StormByte/multimedia/pipeline/filters/ffmpeg.hxx>
#include <StormByte/multimedia/pipeline/filters/report.hxx>
#include <StormByte/multimedia/pipeline/step.hxx>
#include <StormByte/multimedia/visibility.h>
 
#include <memory>
#include <utility>
#include <vector>
 
namespace StormByte::Multimedia::Pipeline {
    class Filters;
 
    class STORMBYTE_MULTIMEDIA_PRIVATE Route {
        friend class Filters;
 
        public:
            Route(int track,
                std::shared_ptr<Step> origin,
                std::shared_ptr<Step> destination) noexcept;
 
            Route(const Route& other) = delete;
 
            Route(Route&& other) noexcept = delete;
 
            ~Route() noexcept;
 
            Route& operator=(const Route& other) = delete;
 
            Route& operator=(Route&& other) noexcept = delete;
 
            int Track() const noexcept;
 
            Route& Add(std::shared_ptr<Filter::FFmpeg> filter) noexcept;
 
            template<typename T, typename... Args>
            Route& Add(Args&&... args) noexcept {
                return Add(std::shared_ptr<Filter::FFmpeg>(
                    std::make_shared<T>(std::forward<Args>(args)...)));
            }
 
            bool Idle() const noexcept;
 
            std::vector<Filter::Report> Reports() const noexcept;
 
        private:
            void Close() noexcept;
 
            struct STORMBYTE_MULTIMEDIA_PRIVATE Lane {
                Filter::FFmpeg* FirstProcess = nullptr;
                Filter::FFmpeg* LastProcess = nullptr;
 
                Filter::FFmpeg* First() const noexcept {
                    return FirstProcess;
                }
 
                Filter::FFmpeg* Last() const noexcept {
                    return LastProcess;
                }
            };
 
            void Hook(Lane& lane, Filter::FFmpeg& filter) noexcept;
 
            void TapDecode(Step& origin, Filter::FFmpeg& analytics) noexcept;
 
            void TapEncode(Step& destination, Filter::FFmpeg& analytics) noexcept;
 
            void Observe(Filter::FFmpeg& analytics) noexcept;
 
            int m_track;                                                    
            std::shared_ptr<Step> m_origin;                                 
            std::shared_ptr<Step> m_destination;                                
            Lane m_frames;                                                  
            Lane m_packets;                                                 
            std::vector<std::shared_ptr<Filter::FFmpeg>> m_filters;         
            std::vector<Filter::FFmpeg*> m_analytics;                       
            std::vector<std::unique_ptr<Decoder>> m_looks;                  
    };
}