OpenShot Library | libopenshot 1.1.1
Blur.h
Go to the documentation of this file.
1
9// Copyright (c) 2008-2019 OpenShot Studios, LLC
10//
11// SPDX-License-Identifier: LGPL-3.0-or-later
12
13#ifndef OPENSHOT_BLUR_EFFECT_H
14#define OPENSHOT_BLUR_EFFECT_H
15
16#include "../EffectBase.h"
17
18#include "../Frame.h"
19#include "../Json.h"
20#include "../KeyFrame.h"
21
22#include <memory>
23#include <string>
24
25namespace openshot
26{
30 };
31
40 class Blur : public EffectBase
41 {
42 private:
44 void init_effect_details();
45
46 // Internal blur methods (inspired and credited to http://blog.ivank.net/fastest-gaussian-blur.html)
47 void boxBlurH(unsigned char *scl, unsigned char *tcl, int w, int h, int r);
48 void boxBlurT(unsigned char *scl, unsigned char *tcl, int w, int h, int r);
49
50 protected:
51 bool UseCustomMaskBlend(int64_t frame_number) const override;
52 void ApplyCustomMaskBlend(std::shared_ptr<QImage> original_image, std::shared_ptr<QImage> effected_image,
53 std::shared_ptr<QImage> mask_image, int64_t frame_number) const override;
54
55 public:
65
67 Blur();
68
76 Blur(Keyframe new_horizontal_radius, Keyframe new_vertical_radius, Keyframe new_sigma, Keyframe new_iterations);
77
88 Blur(Keyframe new_horizontal_radius, Keyframe new_vertical_radius, Keyframe new_sigma, Keyframe new_iterations,
89 Keyframe new_left, Keyframe new_top, Keyframe new_right, Keyframe new_bottom);
90
97 std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) override { return GetFrame(std::make_shared<openshot::Frame>(), frame_number); }
98
108 std::shared_ptr<openshot::Frame> GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
109
110 // Get and Set JSON methods
111 std::string Json() const override;
112 void SetJson(const std::string value) override;
113 Json::Value JsonValue() const override;
114 void SetJsonValue(const Json::Value root) override;
115
118 std::string PropertiesJSON(int64_t requested_frame) const override;
119 };
120
121}
122
123#endif
This class adjusts the blur of an image, and can be animated with openshot::Keyframe curves over time...
Definition: Blur.h:41
Keyframe bottom
Size of bottom margin.
Definition: Blur.h:63
Keyframe vertical_radius
Vertical blur radius keyframe. The size of the vertical blur operation in pixels.
Definition: Blur.h:57
std::shared_ptr< openshot::Frame > GetFrame(int64_t frame_number) override
This method is required for all derived classes of ClipBase, and returns a new openshot::Frame object...
Definition: Blur.h:97
Keyframe left
Size of left margin.
Definition: Blur.h:60
Keyframe top
Size of top margin.
Definition: Blur.h:61
void ApplyCustomMaskBlend(std::shared_ptr< QImage > original_image, std::shared_ptr< QImage > effected_image, std::shared_ptr< QImage > mask_image, int64_t frame_number) const override
Optional override for effects with custom mask implementation.
Definition: Blur.cpp:160
int mask_mode
How to apply common masks to blur (post-blend or drive-amount).
Definition: Blur.h:64
bool UseCustomMaskBlend(int64_t frame_number) const override
Optional override for effects that need custom mask behavior.
Definition: Blur.cpp:155
std::string Json() const override
Generate JSON string of this object.
Definition: Blur.cpp:264
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Blur.cpp:271
Blur()
Blank constructor, useful when using Json to load the effect properties.
Definition: Blur.cpp:36
Keyframe iterations
Iterations keyframe. The # of blur iterations per pixel. 3 iterations = Gaussian.
Definition: Blur.h:59
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Blur.cpp:335
void SetJson(const std::string value) override
Load JSON string into this object.
Definition: Blur.cpp:291
Keyframe sigma
Sigma keyframe. The amount of spread in the blur operation. Should be larger than radius.
Definition: Blur.h:58
Keyframe right
Size of right margin.
Definition: Blur.h:62
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition: Blur.cpp:308
Keyframe horizontal_radius
Horizontal blur radius keyframe. The size of the horizontal blur operation in pixels.
Definition: Blur.h:56
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:57
A Keyframe is a collection of Point instances, which is used to vary a number or property over time.
Definition: KeyFrame.h:53
This namespace is the default namespace for all code in the openshot library.
Definition: AnimatedCurve.h:24
BlurMaskMode
Definition: Blur.h:27
@ BLUR_MASK_DRIVE_AMOUNT
Definition: Blur.h:29
@ BLUR_MASK_POST_BLEND
Definition: Blur.h:28