OpenShot Library | libopenshot  0.2.5
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 <cmath>
37 #include <ctime>
38 #include <iostream>
39 #include <omp.h>
40 #include <stdio.h>
41 #include <memory>
42 #include <QRect>
43 #include "../Color.h"
44 #include "../Exceptions.h"
45 #include "../Json.h"
46 #include "../KeyFrame.h"
47 #include "../ReaderBase.h"
48 #include "../FFmpegReader.h"
49 #include "../QtImageReader.h"
50 #include "../ChunkReader.h"
51 
52 namespace openshot
53 {
54 
55  /**
56  * @brief This class adjusts the blur of an image, and can be animated
57  * with openshot::Keyframe curves over time.
58  *
59  * Adjusting the blur of an image over time can create many different powerful effects. To achieve a
60  * box blur effect, use identical horizontal and vertical blur values. To achieve a Gaussian blur,
61  * use 3 iterations, a sigma of 3.0, and a radius between 3 and X (depending on how much blur you want).
62  */
63  class Blur : public EffectBase
64  {
65  private:
66  /// Init effect settings
67  void init_effect_details();
68 
69  /// Internal blur methods (inspired and credited to http://blog.ivank.net/fastest-gaussian-blur.html)
70  void boxBlurH(unsigned char *scl, unsigned char *tcl, int w, int h, int r);
71  void boxBlurT(unsigned char *scl, unsigned char *tcl, int w, int h, int r);
72 
73 
74  public:
75  Keyframe horizontal_radius; ///< Horizontal blur radius keyframe. The size of the horizontal blur operation in pixels.
76  Keyframe vertical_radius; ///< Vertical blur radius keyframe. The size of the vertical blur operation in pixels.
77  Keyframe sigma; ///< Sigma keyframe. The amount of spread in the blur operation. Should be larger than radius.
78  Keyframe iterations; ///< Iterations keyframe. The # of blur iterations per pixel. 3 iterations = Gaussian.
79 
80  /// Blank constructor, useful when using Json to load the effect properties
81  Blur();
82 
83  /// Default constructor, which takes 1 curve. The curve adjusts the blur radius
84  /// of a frame's image.
85  ///
86  /// @param new_horizontal_radius The curve to adjust the horizontal blur radius (between 0 and 100, rounded to int)
87  /// @param new_vertical_radius The curve to adjust the vertical blur radius (between 0 and 100, rounded to int)
88  /// @param new_sigma The curve to adjust the sigma amount (the size of the blur brush (between 0 and 100), float values accepted)
89  /// @param new_iterations The curve to adjust the # of iterations (between 1 and 100)
90  Blur(Keyframe new_horizontal_radius, Keyframe new_vertical_radius, Keyframe new_sigma, Keyframe new_iterations);
91 
92  /// @brief This method is required for all derived classes of EffectBase, and returns a
93  /// modified openshot::Frame object
94  ///
95  /// The frame object is passed into this method, and a frame_number is passed in which
96  /// tells the effect which settings to use from its keyframes (starting at 1).
97  ///
98  /// @returns The modified openshot::Frame object
99  /// @param frame The frame object that needs the effect applied to it
100  /// @param frame_number The frame number (starting at 1) of the effect on the timeline.
101  std::shared_ptr<Frame> GetFrame(std::shared_ptr<Frame> frame, int64_t frame_number);
102 
103  /// Get and Set JSON methods
104  std::string Json() const override; ///< Generate JSON string of this object
105  void SetJson(const std::string value); ///< Load JSON string into this object
106  Json::Value JsonValue() const override; ///< Generate Json::Value for this object
107  void SetJsonValue(const Json::Value root); ///< Load Json::Value into this object
108 
109  /// Get all properties for a specific frame (perfect for a UI to display the current state
110  /// of all properties at any time)
111  std::string PropertiesJSON(int64_t requested_frame) const override;
112  };
113 
114 }
115 
116 #endif
This class adjusts the blur of an image, and can be animated with openshot::Keyframe curves over time...
Definition: Blur.h:64
Keyframe vertical_radius
Vertical blur radius keyframe. The size of the vertical blur operation in pixels.
Definition: Blur.h:76
void SetJson(const std::string value)
Load JSON string into this object.
Definition: Blur.cpp:194
void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
Definition: Blur.cpp:211
std::string Json() const override
Get and Set JSON methods.
Definition: Blur.cpp:172
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Blur.cpp:179
Blur()
Blank constructor, useful when using Json to load the effect properties.
Definition: Blur.cpp:36
std::shared_ptr< Frame > GetFrame(std::shared_ptr< Frame > frame, int64_t frame_number)
This method is required for all derived classes of EffectBase, and returns a modified openshot::Frame...
Definition: Blur.cpp:66
Keyframe iterations
Iterations keyframe. The # of blur iterations per pixel. 3 iterations = Gaussian.
Definition: Blur.h:78
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Blur.cpp:228
Keyframe sigma
Sigma keyframe. The amount of spread in the blur operation. Should be larger than radius.
Definition: Blur.h:77
Keyframe horizontal_radius
Horizontal blur radius keyframe. The size of the horizontal blur operation in pixels.
Definition: Blur.h:75
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:67
A Keyframe is a collection of Point instances, which is used to vary a number or property over time.
Definition: KeyFrame.h:64
This namespace is the default namespace for all code in the openshot library.