watermark.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/generic.hxx>
#include <StormByte/logger/log.hxx>
#include <StormByte/multimedia/ffmpeg/AVFrame.hxx>
#include <StormByte/multimedia/ffmpeg/Sws.hxx>
#include <StormByte/multimedia/pipeline/filters/ffmpeg.hxx>
#include <StormByte/multimedia/property/point.hxx>
#include <StormByte/multimedia/type.hxx>
#include <StormByte/multimedia/visibility.h>
 
#include <cstdint>
#include <filesystem>
#include <memory>
#include <optional>
#include <string_view>

namespace StormByte::Multimedia::Pipeline::Filter::Video {
    enum class STORMBYTE_MULTIMEDIA_PUBLIC Anchor {
        TopLeft,
        TopCenter,
        TopRight,
        CenterLeft,
        Center,
        CenterRight,
        BottomLeft,
        BottomCenter,
        BottomRight
    };

    class STORMBYTE_MULTIMEDIA_PUBLIC Watermark: public Process {
        public:

            Watermark(std::shared_ptr<StormByte::Logger::Log> log,
                const std::filesystem::path& logo, Anchor anchor,
                unsigned opacity = 100, int margin = 0) noexcept;

            Watermark(std::shared_ptr<StormByte::Logger::Log> log,
                const std::filesystem::path& logo,
                StormByte::Multimedia::Property::Point position,
                unsigned opacity = 100) noexcept;

            Watermark(const Watermark& other) = delete;

            Watermark(Watermark&& other) noexcept = delete;

            ~Watermark() noexcept override;

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

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



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

 
        protected:

            void Clean() noexcept override;

            void Setup() noexcept override;

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

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

 
        private:
            static constexpr std::uint8_t ProbeMax = 200;   

            void DisableLogo(std::string_view why) noexcept;

            bool LoadFile() noexcept;

            bool DecodeLogo() noexcept;

            const StormByte::Multimedia::FFmpeg::AVFrame* Luma(
                const StormByte::Multimedia::FFmpeg::AVFrame& src) noexcept;

            bool ProbeBars(const StormByte::Multimedia::FFmpeg::AVFrame& src) noexcept;

            void Paint() noexcept;

            void DropScale() noexcept;
 
            std::filesystem::path m_path;                                   
            std::optional<Anchor> m_anchor;                                 
            std::optional<StormByte::Multimedia::Property::Point> m_point;  
            unsigned m_opacity;                                             
            int m_margin;                                                   
            StormByte::Buffer::DataType m_bytes;                            
            int m_logoWidth;                                                
            int m_logoHeight;                                               
            StormByte::Buffer::DataType m_rgba;                             
            bool m_loaded;                                                  
            bool m_decoded;                                                 
            bool m_released;                                                
            int m_barTop;                                                   
            int m_barBottom;                                                
            int m_barLeft;                                                  
            int m_barRight;                                                 
            int m_stable;                                                   
            int m_lumaW;                                                    
            int m_lumaH;                                                    
            int m_lumaFmt;                                                  
            std::unique_ptr<StormByte::Multimedia::FFmpeg::Sws> m_swsLuma;  
            std::unique_ptr<StormByte::Multimedia::FFmpeg::AVFrame> m_luma; 
    };
}