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/multimedia/codec.hxx>
#include <StormByte/multimedia/metadata/stream.hxx>
#include <StormByte/multimedia/property/audio.hxx>
#include <StormByte/multimedia/property/duration.hxx>
#include <StormByte/multimedia/property/video.hxx>
 
#include <optional>
#include <variant>
 
namespace StormByte::Multimedia {
    class File;
 
    class STORMBYTE_MULTIMEDIA_PUBLIC Stream {
        public:
            using Properties = std::variant<std::monostate, Property::Video, Property::Audio>;
 
            Stream(const Stream&) = default;
 
            Stream(Stream&&) = default;
 
            ~Stream() = default;
 
            Stream& operator=(const Stream&) = delete;
 
            Stream& operator=(Stream&&) = delete;
 
            int Index() const noexcept { return m_index; }
 
            const class Codec& Codec() const noexcept { return m_codec; }
 
            Type Type() const noexcept { return m_codec.Type(); }
 
            const Metadata::Stream& Metadata() const noexcept { return m_metadata; }
 
            const std::optional<Property::Duration>& Duration() const noexcept { return m_duration; }
 
            const Property::Video* Video() const noexcept {
                return std::get_if<Property::Video>(&m_properties);
            }
 
            const Property::Audio* Audio() const noexcept {
                return std::get_if<Property::Audio>(&m_properties);
            }
 
        private:
            friend class File;
 
            int m_index;                                            
            const class Codec& m_codec;                             
            Metadata::Stream m_metadata;                            
            mutable std::optional<Property::Duration> m_duration;   
            Properties m_properties;                                
 
            Stream(int index, const class Codec& codec, Metadata::Stream metadata,
                std::optional<Property::Duration> duration, Properties properties) noexcept
            : m_index(index), m_codec(codec), m_metadata(std::move(metadata)),
            m_duration(std::move(duration)), m_properties(std::move(properties)) {}
    };
}