plan.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/container.hxx>
#include <StormByte/multimedia/file.hxx>
#include <StormByte/multimedia/pipeline/track.hxx>
#include <StormByte/multimedia/pipeline/typedefs.hxx>
#include <StormByte/multimedia/visibility.h>
 
#include <filesystem>
#include <memory>
#include <utility>
 
namespace StormByte::Multimedia::Pipeline {
    class Demuxer;
 
    class STORMBYTE_MULTIMEDIA_PUBLIC Plan {
        public:
            Plan(File&& source, const Container& container, std::filesystem::path destination) noexcept;
 
            Plan(const Plan&) = delete;
            Plan& operator=(const Plan&) = delete;
 
            Plan(Plan&& other) noexcept = default;
 
            virtual ~Plan() noexcept = default;
 
            Plan& operator=(Plan&& other) noexcept = default;
 
            std::unique_ptr<Plan> Clone() const = delete;
 
            inline std::unique_ptr<Plan> Move() {
                return std::make_unique<Plan>(std::move(*this));
            }
 
            inline const File& Source() const noexcept {
                return *m_source;
            }
 
            inline const Container& Container() const noexcept {
                return *m_container;
            }
 
            inline const std::filesystem::path& Destination() const noexcept {
                return m_destination;
            }
 
            inline const class Tracks& Tracks() const noexcept {
                return m_tracks;
            }
 
            inline void add(const Track& track) {
                m_tracks.add(track);
            }
 
            inline void add(Track&& track) {
                m_tracks.add(std::move(track));
            }
 
            virtual CheckResult Check() const;
 
        private:
            std::unique_ptr<File> m_source;             
            const class Container* m_container;         
            std::filesystem::path m_destination;        
            class Tracks m_tracks;                      
    };
 
    STORMBYTE_MULTIMEDIA_PUBLIC Demuxer& operator>>(Plan&& plan, Demuxer& demuxer) noexcept;
}