audio.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/multimedia/codec.hxx>
#include <StormByte/multimedia/pipeline/config/base.hxx>
#include <StormByte/multimedia/visibility.h>
 
#include <cstdint>
#include <map>
#include <optional>
#include <string>
#include <utility>
 
namespace StormByte::Multimedia::Pipeline::Config {
    class STORMBYTE_MULTIMEDIA_PUBLIC Audio: public Base {
        public:
            constexpr Audio() noexcept
            : Base(StormByte::Multimedia::Type::Audio), m_codec(nullptr) {}
 
            Audio(const Audio& other) noexcept = default;
 
            Audio(Audio&& other) noexcept = default;
 
            virtual ~Audio() noexcept override = default;
 
            Audio& operator=(const Audio& other) noexcept = default;
 
            Audio& operator=(Audio&& other) noexcept = default;
 
            inline PointerType Clone() const override {
                return MakePointer<Audio>(*this);
            }
 
            inline PointerType Move() override {
                return MakePointer<Audio>(std::move(*this));
            }
 
            inline const StormByte::Multimedia::Codec* Codec() const noexcept {
                return m_codec;
            }
 
            inline void Codec(const StormByte::Multimedia::Codec& codec) noexcept {
                m_codec = &codec;
            }
 
            inline const std::optional<std::int64_t>& BitRate() const noexcept {
                return m_bitRate;
            }
 
            inline void BitRate(std::int64_t bits_per_second) noexcept {
                m_bitRate = bits_per_second;
            }
 
            inline const std::optional<std::int64_t>& MaxBitRate() const noexcept {
                return m_maxBitRate;
            }
 
            inline void MaxBitRate(std::int64_t bits_per_second) noexcept {
                m_maxBitRate = bits_per_second;
            }
 
            inline const std::optional<std::string>& Preset() const noexcept {
                return m_preset;
            }
 
            void Preset(std::string name) noexcept;
 
            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:
            const StormByte::Multimedia::Codec* m_codec;            
            std::optional<std::int64_t> m_bitRate;                  
            std::optional<std::int64_t> m_maxBitRate;               
            std::optional<std::string> m_preset;                    
            std::map<std::string, std::string> m_fineTune;          
    };
}