base.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/type.hxx>
#include <StormByte/multimedia/visibility.h>
 
#include <optional>
#include <string>
#include <utility>
 
namespace StormByte::Multimedia::Pipeline::Config {
    struct STORMBYTE_MULTIMEDIA_PUBLIC Implementation {
        std::optional<std::string> Decoder; 
        std::optional<std::string> Encoder; 
    };
 
    class STORMBYTE_MULTIMEDIA_PUBLIC Base:
        public StormByte::Clonable<Base, std::unique_ptr<Base>> {
        public:
            Base(const Base& other) noexcept = default;
 
            Base(Base&& other) noexcept = default;
 
            virtual ~Base() noexcept override = default;
 
            Base& operator=(const Base& other) noexcept = default;
 
            Base& operator=(Base&& other) noexcept = default;
 
            inline constexpr enum StormByte::Multimedia::Type Type() const noexcept {
                return m_type;
            }
 
            inline const std::optional<std::string>& Language() const noexcept {
                return m_language;
            }
 
            void Language(std::string language) noexcept;
 
            inline const std::optional<std::string>& Title() const noexcept {
                return m_title;
            }
 
            void Title(std::string title) noexcept;
 
            inline const std::optional<bool>& Default() const noexcept {
                return m_default;
            }
 
            inline void Default(std::optional<bool> value) noexcept {
                m_default = value;
            }
 
            inline const std::optional<bool>& Forced() const noexcept {
                return m_forced;
            }
 
            inline void Forced(std::optional<bool> value) noexcept {
                m_forced = value;
            }
 
            inline const struct Implementation& Implementation() const noexcept {
                return m_implementation;
            }
 
            inline void Implementation(struct Implementation implementation) noexcept {
                m_implementation = std::move(implementation);
            }
 
        protected:
            explicit constexpr Base(enum StormByte::Multimedia::Type type) noexcept
            : m_type(type) {}
 
        private:
            enum StormByte::Multimedia::Type m_type;    
            std::optional<std::string> m_language;      
            std::optional<std::string> m_title;         
            std::optional<bool> m_default;              
            std::optional<bool> m_forced;               
            struct Implementation m_implementation;     
    };
}