step.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/buffer/sink.hxx>
#include <StormByte/logger/log.hxx>
#include <StormByte/multimedia/pipeline/item.hxx>
#include <StormByte/multimedia/pipeline/plan.hxx>
#include <StormByte/multimedia/pipeline/typedefs.hxx>
#include <StormByte/multimedia/visibility.h>
 
#include <condition_variable>
#include <cstddef>
#include <cstdint>
#include <limits>
#include <memory>
#include <mutex>
#include <optional>
#include <string>
#include <string_view>
 
namespace StormByte::Multimedia::Backend::Pipeline {
    class Host;
    class Pipe;
    class Pumper;
    class Worker;
}

namespace StormByte::Multimedia::Pipeline {
    class Decoder;
    class Demuxer;
    class Encoder;
    class Muxer;
    class Remuxer;
    class Route;
    class Filters;
    class Step;

    STORMBYTE_MULTIMEDIA_PUBLIC class Step& operator>>(Step& from, Step& to) noexcept;

    class STORMBYTE_MULTIMEDIA_PUBLIC Step {
        friend class Demuxer;
        friend class Muxer;
        friend class Remuxer;
        friend class Route;
        friend class Filters;
        friend Decoder& operator>>(Demuxer& demuxer, Decoder& decoder) noexcept;
        friend Demuxer& operator>>(class Plan&& plan, Demuxer& demuxer) noexcept;
        friend Encoder& operator>>(Encoder& encoder, Muxer& muxer) noexcept;
        friend Muxer& operator>>(Demuxer& demuxer, Muxer& muxer) noexcept;
        friend Remuxer& operator>>(Demuxer& demuxer, Remuxer& remuxer) noexcept;
        friend Remuxer& operator>>(Remuxer& remuxer, Muxer& muxer) noexcept;
        friend Step& operator>>(Step& from, Step& to) noexcept;
 
        public:
 
            Step(const Step& other) = delete;
            Step(Step&& other) noexcept = delete;

            virtual ~Step() noexcept;
 
            Step& operator=(const Step& other) = delete;
            Step& operator=(Step&& other) noexcept = delete;



            std::condition_variable& Wake() noexcept;



            inline const std::shared_ptr<class Plan>& Plan() const noexcept {
                return m_plan;
            }



            inline const Kinds& Receives() const noexcept {
                return m_receives;
            }

            inline const Kinds& Produces() const noexcept {
                return m_produces;
            }

            State Status() const noexcept;

            virtual bool Ready() const noexcept;

            void Stop() noexcept;

            virtual std::size_t InputCeiling() const noexcept;



            bool Failed() const noexcept;

            const std::optional<std::string>& Error() const noexcept;

            void Fail(std::string reason) noexcept;

 
        protected:


            Step(std::shared_ptr<StormByte::Logger::Log> log,
                enum Producer name,
                Kinds receives, Kinds produces) noexcept;



            void Emit(Item::PointerType item) noexcept;

            Item::PointerType CloneItem(const Item& item) const noexcept;

            virtual void Wait() noexcept;

            virtual bool WakeNow() const noexcept;

            virtual void AfterWait() noexcept;

            void Launch() noexcept;

            void Halt() noexcept;

            class Join final {
                public:
                    explicit Join(Step& step) noexcept: m_step(step) {}
                    Join(const Join&) = delete;
                    Join(Join&&) noexcept = delete;
                    ~Join() noexcept {
                        m_step.Halt();
                    }
                    Join& operator=(const Join&) = delete;
                    Join& operator=(Join&&) noexcept = delete;
 
                private:
                    Step& m_step;
            };

            bool Stopping() const noexcept;

            void RecordWork(std::int64_t microseconds) noexcept;

            std::int64_t LastWork() const noexcept;

            void DumpWork() noexcept;

            Backend::Pipeline::Host& Face() noexcept;

            void Mount(std::unique_ptr<Backend::Pipeline::Pumper> pumper,
                std::unique_ptr<Backend::Pipeline::Worker> worker) noexcept;



            virtual std::string Label() const noexcept;

            virtual void Log(StormByte::Logger::Level level, std::string_view message) noexcept;

 
            std::shared_ptr<StormByte::Logger::Log> m_log;      
            enum Producer m_name;                               
            Kinds m_receives;                                   
            Kinds m_produces;                                   
 
        private:
            std::condition_variable m_wake;                     
            std::unique_ptr<Backend::Pipeline::Pipe> m_pipe;    
 
        protected:
            Backend::Pipeline::Pipe& pipe() noexcept;

            const Backend::Pipeline::Pipe& pipe() const noexcept;
 
        private:
            class Surface;

            void CloseHoppers() noexcept;
 
            std::unique_ptr<Surface> m_surface;                     
            std::unique_ptr<Backend::Pipeline::Pumper> m_pumper;    
            std::shared_ptr<class Plan> m_plan;                     
            std::mutex m_wait;                                      
            std::optional<std::string> m_error;                     
            bool m_exhausted;                                       
            std::uint64_t m_workN;                                  
            std::int64_t m_workMin;                                 
            std::int64_t m_workMax;                                 
            std::int64_t m_lastWork;                                
    };
}