Displace.h

Go to the documentation of this file.

 
// Copyright (c) 2008-2026 OpenShot Studios, LLC
//
// SPDX-License-Identifier: LGPL-3.0-or-later
 
#ifndef OPENSHOT_DISPLACE_EFFECT_H
#define OPENSHOT_DISPLACE_EFFECT_H
 
#include "../EffectBase.h"
 
#include "../Frame.h"
#include "../Json.h"
#include "../KeyFrame.h"
 
#include <memory>
#include <string>
 
namespace openshot
{
    // Forward declaration
    class ReaderBase;
 
    class Displace : public EffectBase
    {
    private:
        ReaderBase* map_reader = nullptr; 
        std::shared_ptr<QImage> cached_single_map_image; 
        int cached_single_map_width = 0; 
        int cached_single_map_height = 0; 
 
        void init_effect_details();
 
        std::shared_ptr<QImage> GetMapImage(std::shared_ptr<QImage> target_image, int64_t frame_number);
 
    public:
        bool replace_image; 
        bool invert;    
        Keyframe strength;  
        Keyframe horizontal;    
        Keyframe vertical;  
        Keyframe brightness;    
        Keyframe contrast;  
 
        Displace();
 
        Displace(ReaderBase *map_reader, Keyframe map_strength, Keyframe map_horizontal,
                 Keyframe map_vertical, Keyframe map_brightness, Keyframe map_contrast);
 
        std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) override { return GetFrame(std::make_shared<openshot::Frame>(), frame_number); }
 
        std::shared_ptr<openshot::Frame> GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
 
        // Get and Set JSON methods
        std::string Json() const override; 
        void SetJson(const std::string value) override; 
        Json::Value JsonValue() const override; 
        void SetJsonValue(const Json::Value root) override; 
 
        std::string PropertiesJSON(int64_t requested_frame) const override;
 
        ReaderBase* Reader() { return map_reader; };
 
        void Reader(ReaderBase *new_reader);
 
        ~Displace() override;
    };
 
}
 
#endif