decoder.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/bitmask.hxx>
#include <StormByte/logger/log.hxx>
#include <StormByte/multimedia/features.hxx>
#include <StormByte/multimedia/pipeline/step.hxx>
#include <StormByte/multimedia/property/duration.hxx>
#include <StormByte/multimedia/visibility.h>
 
#include <atomic>
#include <cstddef>
#include <cstdint>
#include <memory>
#include <optional>
#include <string>

namespace StormByte::Multimedia::Backend::Pipeline {
    class Decoder;
    class Frame;
}
 
namespace StormByte::Multimedia::Backend::Pipeline::Detail::Worker {
    class Decode;
}

namespace StormByte::Multimedia::Pipeline {
    class Decoder;
    class Demuxer;
    class Filters;
    class Frame;
    class Packet;
    class Route;

    enum class DecoderFlag: std::uint8_t {
        HeuristicsHDR10 = 1u << 0
    };

    class STORMBYTE_MULTIMEDIA_PUBLIC DecoderFlags: public StormByte::Bitmask<DecoderFlags, DecoderFlag> {
        public:
            using Bitmask::Bitmask;
    };

    inline const DecoderFlags Heuristics{DecoderFlag::HeuristicsHDR10};

    STORMBYTE_MULTIMEDIA_PUBLIC Decoder& operator>>(Demuxer& demuxer, Decoder& decoder) noexcept;

    class STORMBYTE_MULTIMEDIA_PUBLIC Decoder final: public Step {
        friend class Backend::Pipeline::Decoder;
        friend class Backend::Pipeline::Detail::Worker::Decode;
        friend class Demuxer;
        friend class Filters;
        friend class Route;
        friend Decoder& operator>>(Demuxer& demuxer, Decoder& decoder) noexcept;
 
        public:

            explicit Decoder(std::shared_ptr<StormByte::Logger::Log> log,
                int track, DecoderFlags flags = DecoderFlags{}) noexcept;

            Decoder(const Decoder& other) = delete;

            Decoder(Decoder&& other) noexcept = delete;

            ~Decoder() noexcept override;

            Decoder& operator=(const Decoder& other) = delete;

            Decoder& operator=(Decoder&& other) noexcept = delete;

            explicit operator bool() const noexcept;



            inline int Index() const noexcept {
                return m_index;
            }

            std::size_t InputCeiling() const noexcept override;

            inline const DecoderFlags& Flags() const noexcept {
                return m_flags;
            }

            inline void Flags(DecoderFlags flags) noexcept {
                m_flags = flags;
            }

            inline const std::optional<std::string>& Language() const noexcept {
                return m_language;
            }

            inline const std::optional<std::string>& Title() const noexcept {
                return m_title;
            }



            inline const std::optional<std::string>& Implementation() const noexcept {
                return m_implementation;
            }

            void Implementation(std::string name) noexcept;

            inline const Features& Require() const noexcept {
                return m_require;
            }

            inline void Require(Features features) noexcept {
                m_require = features;
            }

            inline const Features& Capabilities() const noexcept {
                return m_capabilities;
            }

 
        private:
            struct EncodeLook {};

            struct RemuxLook {};

            struct SourceLook {};

            Decoder(std::shared_ptr<StormByte::Logger::Log> log,
                int track, EncodeLook tag) noexcept;

            Decoder(std::shared_ptr<StormByte::Logger::Log> log,
                int track, RemuxLook tag) noexcept;

            Decoder(std::shared_ptr<StormByte::Logger::Log> log,
                int track, SourceLook tag) noexcept;
 
            using Step::Log;

            std::string Label() const noexcept override;

            void Bind(std::unique_ptr<Backend::Pipeline::Decoder> backend) noexcept;

            std::unique_ptr<Backend::Pipeline::Decoder> OpenOrigin() noexcept;

            void Stamp(std::optional<std::string> language, std::optional<std::string> title) noexcept;

            void AttachOrigin(Demuxer& demuxer) noexcept;

            void MeasureSourceClosed() noexcept;

            void DrainMeasure() noexcept;

            bool ResetAfterMeasure() noexcept;

            void Attach(Frame& frame, std::unique_ptr<Backend::Pipeline::Frame> backend) noexcept;

            void CloseCue(Frame& frame, Property::Duration duration) noexcept;

            void StampLineage(Frame& frame) noexcept;

            bool OpenLook(const Packet& packet) noexcept;

            void StampLook(Frame& frame) noexcept;

            void BindAnalytics(Filters& filters) noexcept;

            bool WakeNow() const noexcept override;

            void AfterWait() noexcept override;
 
            int m_index;                                            
            DecoderFlags m_flags;                                   
            std::optional<std::string> m_language;                  
            std::optional<std::string> m_title;                     
            std::optional<std::string> m_implementation;            
            Features m_require;                                     
            Features m_capabilities;                                
            Demuxer* m_origin = nullptr;                            
            Filters* m_analytics = nullptr;                         
            std::unique_ptr<Backend::Pipeline::Decoder> m_backend;  
            std::optional<std::uint64_t> m_serial;                  
            std::uint64_t m_part;                                   
            std::optional<Property::Duration> m_inDts;              
            bool m_look = false;                                    
            std::optional<Producer> m_lookStamp;                    
            std::atomic<bool> m_measureClosed{false};               
            std::atomic<bool> m_measureDrained{false};              
            Join m_join{*this};                                     
    };
}