file.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/buffer/consumer.hxx>
#include <StormByte/multimedia/attachment.hxx>
#include <StormByte/multimedia/container.hxx>
#include <StormByte/multimedia/metadata/file.hxx>
#include <StormByte/multimedia/property/duration.hxx>
#include <StormByte/multimedia/stream.hxx>
#include <StormByte/multimedia/typedefs.hxx>
 
#include <chrono>
#include <filesystem>
#include <memory>
#include <optional>

namespace StormByte::Multimedia {
    class Origin;

    namespace Pipeline {
        class Demuxer;
    }

    class STORMBYTE_MULTIMEDIA_PUBLIC File {
        friend class Pipeline::Demuxer;
 
        public:
            File(const File&) = delete;

            File(File&&) noexcept;

            ~File() noexcept;

            File& operator=(const File&) = delete;

            File& operator=(File&&) = delete;

            const std::filesystem::path& Path() const noexcept;

            const class Container& Container() const noexcept { return m_container; }

            const Multimedia::Streams& Streams() const noexcept { return m_streams; }

            const Multimedia::Attachments& Attachments() const noexcept;

            const Metadata::File& Metadata() const noexcept { return m_metadata; }

            const std::optional<Property::Duration>& Duration() const noexcept;

            static ExpectedFile Open(const std::filesystem::path& path) noexcept;

            static ExpectedFile Open(const std::filesystem::path& path,
                std::chrono::nanoseconds duration) noexcept;

            static ExpectedFile Open(StormByte::Buffer::Consumer consumer) noexcept;

            static ExpectedFile Open(StormByte::Buffer::Consumer consumer,
                std::chrono::nanoseconds duration) noexcept;
 
        private:
            std::unique_ptr<Origin> m_origin;                   
            const class Container& m_container;                 
            mutable Multimedia::Streams m_streams;              
            Multimedia::Attachments m_attachments;              
            Metadata::File m_metadata;                      
            mutable std::optional<Property::Duration> m_duration;           
            mutable bool m_durationResolved;                    

            File(std::unique_ptr<Origin> origin, const class Container& container,
                Multimedia::Streams streams, Multimedia::Attachments attachments, Metadata::File metadata,
                std::optional<Property::Duration> duration, bool durationResolved) noexcept;

            static ExpectedFile Open(std::unique_ptr<Origin> origin,
                std::optional<std::chrono::nanoseconds> duration) noexcept;

            void ResolveDuration() const noexcept;
    };
}