ssim.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/logger/log.hxx>
#include <StormByte/multimedia/ffmpeg/AVFrame.hxx>
#include <StormByte/multimedia/pipeline/filters/ffmpeg.hxx>
#include <StormByte/multimedia/pipeline/filters/report.hxx>
#include <StormByte/multimedia/visibility.h>
 
#include <cstdint>
#include <deque>
#include <map>
#include <memory>
#include <optional>
#include <string>

namespace StormByte::Multimedia::Pipeline::Filter::Video {
    class STORMBYTE_MULTIMEDIA_PUBLIC SSIM: public Filter::Analytics {
        public:
            explicit SSIM(std::shared_ptr<StormByte::Logger::Log> log) noexcept;

            SSIM(const SSIM& other) = delete;

            SSIM(SSIM&& other) noexcept = delete;

            ~SSIM() noexcept override;

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

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

            enum StormByte::Multimedia::Type Media() const noexcept override;

            std::size_t InputCeiling() const noexcept override {
                return Ceiling;
            }

            void Clean() noexcept override;

            void Setup() noexcept override;

            void Process(const Pipeline::Frame& frame) noexcept override;

            void Eof() noexcept override;

            class Filter::Report Report() const noexcept override;
 
        private:
            struct Plane {
                double sum = 0.0;           
                unsigned frames = 0;        
            };

            struct Lane {
                std::deque<StormByte::Multimedia::FFmpeg::AVFrame> ref;     
                std::deque<StormByte::Multimedia::FFmpeg::AVFrame> dist;    
                int width = 0;                                              
                int height = 0;                                             
                int bpc = 0;                                                
                unsigned scored = 0;                                        
                std::size_t peakRef = 0;                                    
                std::size_t peakDist = 0;                                   
                Plane y;                                                    
                Plane u;                                                    
                Plane v;                                                    
                std::optional<double> mean;                                 
                std::optional<double> min;                                  
                bool failed = false;                                        
            };

            void Drain(Lane& lane) noexcept;

            void Score(Lane& lane,
                const StormByte::Multimedia::FFmpeg::AVFrame& ref,
                const StormByte::Multimedia::FFmpeg::AVFrame& dist) noexcept;

            void DropParked(Lane& lane) noexcept;

            void DropAll() noexcept;
 
            static constexpr std::size_t Ceiling = 512; 
            static constexpr int Window = 8;            
            std::map<int, Lane> m_lanes;                
    };
}