progress.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/visibility.h>
 
#include <cstdint>
#include <memory>
#include <optional>
#include <string>

namespace StormByte::Multimedia::Pipeline {
    class Demuxer;
    class Filters;
    class Muxer;

    class STORMBYTE_MULTIMEDIA_PUBLIC Progress {
        friend class Demuxer;
        friend class Filters;
        friend class Muxer;
 
        public:
            using Pointer = std::shared_ptr<const Progress>;

            Progress() noexcept = default;

            Progress(const Progress& other) = delete;

            Progress(Progress&& other) noexcept = delete;

            ~Progress() noexcept = default;

            Progress& operator=(const Progress& other) = delete;

            Progress& operator=(Progress&& other) noexcept = delete;

            std::optional<double> Measure() const noexcept;

            std::optional<double> Analytics() const noexcept;

            bool HasMeasure() const noexcept;

            bool HasAnalytics() const noexcept;

            bool MeasureComplete() const noexcept;

            bool AnalyticsComplete() const noexcept;

            double All() const noexcept;

            operator std::string() const noexcept;
 
        private:
            void HasMeasure(bool on) noexcept;

            void HasAnalytics(bool on) noexcept;

            void SetDurationNs(std::int64_t ns) noexcept;

            void SetMeasureNs(std::int64_t ns) noexcept;

            void SetPassNs(std::int64_t ns) noexcept;

            void SetAnalyticsNs(std::int64_t ns) noexcept;

            void MeasureDone() noexcept;

            void PassDone() noexcept;

            void MuxDone() noexcept;

            void AnalyticsDone() noexcept;

            static double Axis(std::int64_t pos, std::int64_t dur) noexcept;
 
            bool m_hasMeasure = false;          
            bool m_hasAnalytics = false;        
            bool m_measureDone = false;         
            bool m_passDone = false;            
            bool m_muxDone = false;             
            bool m_analyticsDone = false;       
            std::int64_t m_durationNs = 0;      
            std::int64_t m_measureNs = 0;       
            std::int64_t m_passNs = 0;          
            std::int64_t m_analyticsNs = 0;     
            std::int64_t m_analyticsAtMux = 0;  
            mutable double m_all = 0.0;         
    };
}