encoder.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/fifo.hxx>
#include <StormByte/logger/log.hxx>
#include <StormByte/multimedia/codec.hxx>
#include <StormByte/multimedia/features.hxx>
#include <StormByte/multimedia/pipeline/packet.hxx>
#include <StormByte/multimedia/pipeline/side_data.hxx>
#include <StormByte/multimedia/pipeline/step.hxx>
#include <StormByte/multimedia/property/duration.hxx>
#include <StormByte/multimedia/visibility.h>
 
#include <cstddef>
#include <cstdint>
#include <map>
#include <memory>
#include <optional>
#include <string>
#include <vector>

namespace StormByte::Multimedia::Backend::Pipeline {
    class Encoder;  
    class Packet;   
}
 
namespace StormByte::Multimedia::Backend::Pipeline::Detail::Worker {
    class Encode;
}

namespace StormByte::Multimedia::Pipeline {
    class Encoder;
    class Frame;
    class Muxer;

    class STORMBYTE_MULTIMEDIA_PUBLIC Encoder final: public Step {
        friend class Backend::Pipeline::Encoder;
        friend class Backend::Pipeline::Detail::Worker::Encode;
        friend class Muxer;
 
        public:

            Encoder(std::shared_ptr<StormByte::Logger::Log> log,
                int output_index, const Codec& codec) noexcept;

            Encoder(const Encoder& other) = delete;

            Encoder(Encoder&& other) noexcept = delete;

            ~Encoder() noexcept override;

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

            Encoder& operator=(Encoder&& 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 Codec& Destination() const noexcept {
                return *m_codec;
            }

            bool Opened() const noexcept;

            std::optional<int> AudioChannels() const noexcept;

            std::optional<int> AudioSampleRate() const noexcept;

            std::optional<int> AudioFrameSize() const noexcept;

            std::optional<int> AudioSampleFormat() const noexcept;



            inline const std::string& EncoderTag() const noexcept {
                return m_encoderTag;
            }



            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;
            }



            inline void CRF(int value) noexcept {
                m_crf = value;
            }

            inline const std::optional<int>& CRF() const noexcept {
                return m_crf;
            }

            inline void BitRate(std::int64_t bits_per_second) noexcept {
                m_bitRate = bits_per_second;
            }

            inline const std::optional<std::int64_t>& BitRate() const noexcept {
                return m_bitRate;
            }

            inline void MaxBitRate(std::int64_t bits_per_second) noexcept {
                m_maxBitRate = bits_per_second;
            }

            inline const std::optional<std::int64_t>& MaxBitRate() const noexcept {
                return m_maxBitRate;
            }

            void Preset(std::string name) noexcept;

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

            void Tune(std::string name) noexcept;

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



            inline const std::map<std::string, std::string>& FineTune() const noexcept {
                return m_fineTune;
            }

            inline void FineTune(std::map<std::string, std::string> options) noexcept {
                m_fineTune = std::move(options);
            }

 
        private:
 
            using Step::Log;

            std::string Label() const noexcept override;


            Packet::PointerType Wrap(
                enum StormByte::Multimedia::Type type, int index,
                StormByte::Buffer::FIFO payload,
                std::optional<Property::Duration> pts,
                std::optional<Property::Duration> dts,
                std::optional<Property::Duration> duration,
                bool keyFrame,
                std::vector<SideData> attachments,
                std::unique_ptr<Backend::Pipeline::Packet> backend) noexcept;

            bool MuxBindStream(void* avStream) noexcept;

            void* FrameHandle(Frame& frame) noexcept;

            const void* FrameHandle(const Frame& frame) noexcept;

            void Emit(Packet::PointerType packet) noexcept;
 
            int m_index;                                                        
            const Codec* m_codec;                                           
            std::string m_encoderTag;                                       
            std::optional<std::string> m_implementation;                    
            Features m_require;                                             
            Features m_capabilities;                                        
            std::optional<int> m_crf;                                       
            std::optional<std::int64_t> m_bitRate;                          
            std::optional<std::int64_t> m_maxBitRate;                       
            std::optional<std::string> m_preset;                            
            std::optional<std::string> m_tune;                              
            std::map<std::string, std::string> m_fineTune;                  
            std::unique_ptr<Backend::Pipeline::Encoder> m_backend;          
            std::optional<std::uint64_t> m_serial;                          
            std::uint64_t m_part;                                           
            Join m_join{*this};                                             
    };
}