item.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/clonable.hxx>
#include <StormByte/multimedia/pipeline/typedefs.hxx>
#include <StormByte/multimedia/type.hxx>
#include <StormByte/multimedia/visibility.h>
 
#include <cstdint>
 
namespace StormByte::Multimedia::Backend::Pipeline {
    class Frame;    
    class Packet;   
    class Pipe;     
}
 
namespace StormByte::Multimedia::Pipeline {
    class Decoder;
    class Demuxer;
    class Encoder;
    class Frame;
    class Muxer;
    class Packet;
    class Step;
 
    namespace Filter {
        class FFmpeg;   
    }
 
    class STORMBYTE_MULTIMEDIA_PUBLIC Item: protected Clonable<Item, std::shared_ptr<Item>> {
        friend class Backend::Pipeline::Frame;
        friend class Backend::Pipeline::Packet;
        friend class Backend::Pipeline::Pipe;
        friend class Decoder;
        friend class Demuxer;
        friend class Encoder;
        friend class Filter::FFmpeg;
        friend class Frame;
        friend class Muxer;
        friend class Packet;
        friend class Step;
 
        public:
            using StormByte::Clonable<Item, std::shared_ptr<Item>>::PointerType;
            
            virtual ~Item() noexcept = default;
 
            Kind Kind() const noexcept {
                return m_kind;
            }
 
            enum StormByte::Multimedia::Type Type() const noexcept {
                return m_type;
            }
 
            int Track() const noexcept {
                return m_track;
            }
 
            enum Producer Producer() const noexcept {
                return m_producer;
            }
 
        protected:
            Item(const Item& other) noexcept = default;
 
            Item(Item&& other) noexcept = default;
 
            Item& operator=(const Item& other) noexcept = default;
 
            Item& operator=(Item&& other) noexcept = default;
 
        private:
            Item(int track, enum StormByte::Multimedia::Type type, enum Kind kind, enum Producer producer) noexcept
            : m_track(track), m_type(type), m_kind(kind), m_producer(producer) {}
 
            int m_track;                                    
            enum StormByte::Multimedia::Type m_type;        
            enum Kind m_kind;                               
            enum Producer m_producer;                       
    };
}