stream.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/bitmask.hxx>
#include <StormByte/multimedia/visibility.h>
 
#include <cstdint>
#include <optional>
#include <string>
 
namespace StormByte::Multimedia {
    class File;
 
    class Stream;
}
 
namespace StormByte::Multimedia::Detail {
    class Probe;
}
 
namespace StormByte::Multimedia::Metadata {
    class Stream;
 
    enum class STORMBYTE_MULTIMEDIA_PUBLIC DispositionFlag: std::uint16_t {
        None                = 0,        
        Default             = 1 << 0,   
        Dub                 = 1 << 1,   
        Original            = 1 << 2,   
        Comment             = 1 << 3,   
        Lyrics              = 1 << 4,   
        Karaoke             = 1 << 5,   
        Forced              = 1 << 6,   
        HearingImpaired     = 1 << 7,   
        VisualImpaired      = 1 << 8,   
        AttachedPicture     = 1 << 9    
    };
 
    class STORMBYTE_MULTIMEDIA_PUBLIC Disposition: public StormByte::Bitmask<Disposition, DispositionFlag> {
        public:
            constexpr Disposition(const Disposition& disposition) noexcept = default;
 
            constexpr Disposition(Disposition&& disposition) noexcept = default;
 
            constexpr ~Disposition() noexcept = default;
 
            constexpr Disposition& operator=(const Disposition& disposition) noexcept = default;
 
            constexpr Disposition& operator=(Disposition&& disposition) noexcept = default;
 
        private:
            friend class Stream;
            friend class StormByte::Multimedia::File;
            friend class StormByte::Multimedia::Detail::Probe;
            friend class StormByte::Bitmask<Disposition, DispositionFlag>;
 
            constexpr Disposition() noexcept
            : StormByte::Bitmask<Disposition, DispositionFlag>() {}
 
            constexpr Disposition(DispositionFlag flag) noexcept
            : StormByte::Bitmask<Disposition, DispositionFlag>(flag) {}
    };
 
    class STORMBYTE_MULTIMEDIA_PUBLIC Stream {
        public:
            Stream(const Stream&) = default;
 
            Stream(Stream&&) noexcept = default;
 
            ~Stream() = default;
 
            Stream& operator=(const Stream&) = default;
 
            Stream& operator=(Stream&&) noexcept = default;
 
            const std::optional<std::string>& Title() const noexcept;
 
            const std::optional<std::string>& Language() const noexcept;
 
            std::optional<std::uint64_t> BitRate() const noexcept;
 
            class Disposition Disposition() const noexcept;
 
        private:
            friend class StormByte::Multimedia::File;
            friend class StormByte::Multimedia::Stream;
            friend class StormByte::Multimedia::Detail::Probe;
 
            std::optional<std::string> m_title;     
            std::optional<std::string> m_language;      
            std::optional<std::uint64_t> m_bitRate;     
            class Disposition m_disposition;        
 
            Stream() noexcept = default;
 
            void Title(std::string title) noexcept;
 
            void Language(std::string language) noexcept;
 
            void BitRate(std::uint64_t bitRate) noexcept;
 
            void Disposition(class Disposition disposition) noexcept;
    };
}