frame.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/multimedia/pipeline/item.hxx>
#include <StormByte/multimedia/pipeline/side_data.hxx>
#include <StormByte/multimedia/property/audio.hxx>
#include <StormByte/multimedia/property/duration.hxx>
#include <StormByte/multimedia/property/video.hxx>
#include <StormByte/multimedia/visibility.h>
 
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
#include <vector>

namespace StormByte::Multimedia::Pipeline {
    class STORMBYTE_MULTIMEDIA_PUBLIC Frame: public Item {
        friend class Backend::Pipeline::Frame;
        friend class Decoder;
        friend class Encoder;
        friend class Filter::FFmpeg;
        friend Decoder& operator>>(Decoder& decoder, Frame& frame) noexcept;
        friend Frame& operator>>(Frame& frame, Encoder& encoder) noexcept;
 
        public:
            using PointerType = std::shared_ptr<Frame>;


            Frame() noexcept;

            Frame(int track, enum StormByte::Multimedia::Type type, enum Producer producer,
                StormByte::Buffer::FIFO payload,
                std::optional<Property::Duration> pts,
                std::optional<Property::Duration> duration,
                std::optional<Property::Video> video,
                std::vector<class SideData> attachments,
                std::optional<Property::Audio> audio,
                std::uint64_t serial,
                std::uint64_t part) noexcept;

            Frame(const Frame& other) noexcept;

            Frame(Frame&& other) noexcept;

            ~Frame() noexcept override;

            Frame& operator=(const Frame& other) noexcept;

            Frame& operator=(Frame&& other) noexcept;



            inline const std::optional<Property::Duration>& Pts() const noexcept {
                return m_pts;
            }

            inline const std::optional<Property::Duration>& Dts() const noexcept {
                return m_dts;
            }

            inline const std::optional<Property::Duration>& Duration() const noexcept {
                return m_duration;
            }

            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::uint64_t>& Serial() const noexcept {
                return m_serial;
            }

            inline std::uint64_t Part() const noexcept {
                return m_part;
            }



            inline const std::optional<Property::Video>& Video() const noexcept {
                return m_video;
            }

            inline const std::optional<Property::Audio>& Audio() const noexcept {
                return m_audio;
            }

            inline const std::vector<class SideData>& Attachments() const noexcept {
                return m_attachments;
            }



            StormByte::Buffer::FIFO& Payload() noexcept;

            inline const StormByte::Buffer::FIFO& Payload() const noexcept {
                return m_payload;
            }

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

            void BecomeEmpty() noexcept;

            Item::PointerType Clone() const override;

            Item::PointerType Move() override;
 
            StormByte::Buffer::FIFO m_payload;                          
            std::optional<Property::Duration> m_pts;                    
            std::optional<Property::Duration> m_dts;                    
            std::optional<Property::Duration> m_duration;               
            std::optional<Property::Video> m_video;                     
            std::optional<Property::Audio> m_audio;                     
            std::optional<std::string> m_language;                      
            std::optional<std::string> m_title;                         
            std::vector<class SideData> m_attachments;                  
            std::optional<std::uint64_t> m_serial;                      
            std::uint64_t m_part;                                       
            std::unique_ptr<Backend::Pipeline::Frame> m_backend;        
    };
}