OpenShot Library | libopenshot 0.2.7
Blur.h
Go to the documentation of this file.
1/**
2 * @file
3 * @brief Header file for Blur effect class
4 * @author Jonathan Thomas <jonathan@openshot.org>
5 *
6 * @ref License
7 */
8
9/* LICENSE
10 *
11 * Copyright (c) 2008-2019 OpenShot Studios, LLC
12 * <http://www.openshotstudios.com/>. This file is part of
13 * OpenShot Library (libopenshot), an open-source project dedicated to
14 * delivering high quality video editing and animation solutions to the
15 * world. For more information visit <http://www.openshot.org/>.
16 *
17 * OpenShot Library (libopenshot) is free software: you can redistribute it
18 * and/or modify it under the terms of the GNU Lesser General Public License
19 * as published by the Free Software Foundation, either version 3 of the
20 * License, or (at your option) any later version.
21 *
22 * OpenShot Library (libopenshot) is distributed in the hope that it will be
23 * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU Lesser General Public License for more details.
26 *
27 * You should have received a copy of the GNU Lesser General Public License
28 * along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
29 */
30
31#ifndef OPENSHOT_BLUR_EFFECT_H
32#define OPENSHOT_BLUR_EFFECT_H
33
34#include "../EffectBase.h"
35
36#include "../Frame.h"
37#include "../Json.h"
38#include "../KeyFrame.h"
39
40#include <memory>
41#include <string>
42
43namespace openshot
44{
45
46 /**
47 * @brief This class adjusts the blur of an image, and can be animated
48 * with openshot::Keyframe curves over time.
49 *
50 * Adjusting the blur of an image over time can create many different powerful effects. To achieve a
51 * box blur effect, use identical horizontal and vertical blur values. To achieve a Gaussian blur,
52 * use 3 iterations, a sigma of 3.0, and a radius between 3 and X (depending on how much blur you want).
53 */
54 class Blur : public EffectBase
55 {
56 private:
57 /// Init effect settings
58 void init_effect_details();
59
60 // Internal blur methods (inspired and credited to http://blog.ivank.net/fastest-gaussian-blur.html)
61 void boxBlurH(unsigned char *scl, unsigned char *tcl, int w, int h, int r);
62 void boxBlurT(unsigned char *scl, unsigned char *tcl, int w, int h, int r);
63
64
65 public:
66 Keyframe horizontal_radius; ///< Horizontal blur radius keyframe. The size of the horizontal blur operation in pixels.
67 Keyframe vertical_radius; ///< Vertical blur radius keyframe. The size of the vertical blur operation in pixels.
68 Keyframe sigma; ///< Sigma keyframe. The amount of spread in the blur operation. Should be larger than radius.
69 Keyframe iterations; ///< Iterations keyframe. The # of blur iterations per pixel. 3 iterations = Gaussian.
70
71 /// Blank constructor, useful when using Json to load the effect properties
72 Blur();
73
74 /// Default constructor, which takes 1 curve. The curve adjusts the blur radius
75 /// of a frame's image.
76 ///
77 /// @param new_horizontal_radius The curve to adjust the horizontal blur radius (between 0 and 100, rounded to int)
78 /// @param new_vertical_radius The curve to adjust the vertical blur radius (between 0 and 100, rounded to int)
79 /// @param new_sigma The curve to adjust the sigma amount (the size of the blur brush (between 0 and 100), float values accepted)
80 /// @param new_iterations The curve to adjust the # of iterations (between 1 and 100)
81 Blur(Keyframe new_horizontal_radius, Keyframe new_vertical_radius, Keyframe new_sigma, Keyframe new_iterations);
82
83 /// @brief This method is required for all derived classes of ClipBase, and returns a
84 /// new openshot::Frame object. All Clip keyframes and effects are resolved into
85 /// pixels.
86 ///
87 /// @returns A new openshot::Frame object
88 /// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline.
89 std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) override { return GetFrame(std::make_shared<openshot::Frame>(), frame_number); }
90
91 /// @brief This method is required for all derived classes of ClipBase, and returns a
92 /// modified openshot::Frame object
93 ///
94 /// The frame object is passed into this method and used as a starting point (pixels and audio).
95 /// All Clip keyframes and effects are resolved into pixels.
96 ///
97 /// @returns The modified openshot::Frame object
98 /// @param frame The frame object that needs the clip or effect applied to it
99 /// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline.
100 std::shared_ptr<openshot::Frame> GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
101
102 // Get and Set JSON methods
103 std::string Json() const override; ///< Generate JSON string of this object
104 void SetJson(const std::string value) override; ///< Load JSON string into this object
105 Json::Value JsonValue() const override; ///< Generate Json::Value for this object
106 void SetJsonValue(const Json::Value root) override; ///< Load Json::Value into this object
107
108 /// Get all properties for a specific frame (perfect for a UI to display the current state
109 /// of all properties at any time)
110 std::string PropertiesJSON(int64_t requested_frame) const override;
111 };
112
113}
114
115#endif
This class adjusts the blur of an image, and can be animated with openshot::Keyframe curves over time...
Definition: Blur.h:55
Keyframe vertical_radius
Vertical blur radius keyframe. The size of the vertical blur operation in pixels.
Definition: Blur.h:67
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:89
std::string Json() const override
Generate JSON string of this object.
Definition: Blur.cpp:173
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Blur.cpp:180
Blur()
Blank constructor, useful when using Json to load the effect properties.
Definition: Blur.cpp:37
Keyframe iterations
Iterations keyframe. The # of blur iterations per pixel. 3 iterations = Gaussian.
Definition: Blur.h:69
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Blur.cpp:229
void SetJson(const std::string value) override
Load JSON string into this object.
Definition: Blur.cpp:195
Keyframe sigma
Sigma keyframe. The amount of spread in the blur operation. Should be larger than radius.
Definition: Blur.h:68
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition: Blur.cpp:212
Keyframe horizontal_radius
Horizontal blur radius keyframe. The size of the horizontal blur operation in pixels.
Definition: Blur.h:66
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:71
A Keyframe is a collection of Point instances, which is used to vary a number or property over time.
Definition: KeyFrame.h:72
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:47