OpenShot Library | libopenshot  0.1.9
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  * @section LICENSE
7  *
8  * Copyright (c) 2008-2014 OpenShot Studios, LLC
9  * <http://www.openshotstudios.com/>. This file is part of
10  * OpenShot Library (libopenshot), an open-source project dedicated to
11  * delivering high quality video editing and animation solutions to the
12  * world. For more information visit <http://www.openshot.org/>.
13  *
14  * OpenShot Library (libopenshot) is free software: you can redistribute it
15  * and/or modify it under the terms of the GNU Lesser General Public License
16  * as published by the Free Software Foundation, either version 3 of the
17  * License, or (at your option) any later version.
18  *
19  * OpenShot Library (libopenshot) is distributed in the hope that it will be
20  * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22  * GNU Lesser General Public License for more details.
23  *
24  * You should have received a copy of the GNU Lesser General Public License
25  * along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
26  */
27 
28 #ifndef OPENSHOT_BLUR_EFFECT_H
29 #define OPENSHOT_BLUR_EFFECT_H
30 
31 #include "../EffectBase.h"
32 
33 #include <cmath>
34 #include <ctime>
35 #include <iostream>
36 #include <omp.h>
37 #include <stdio.h>
38 #include <memory>
39 #include <QRect>
40 #include "../Color.h"
41 #include "../Exceptions.h"
42 #include "../Json.h"
43 #include "../KeyFrame.h"
44 #include "../ReaderBase.h"
45 #include "../FFmpegReader.h"
46 #include "../QtImageReader.h"
47 #include "../ChunkReader.h"
48 
49 using namespace std;
50 
51 namespace openshot
52 {
53 
54  /**
55  * @brief This class adjusts the blur of an image, and can be animated
56  * with openshot::Keyframe curves over time.
57  *
58  * Adjusting the blur of an image over time can create many different powerful effects. To achieve a
59  * box blur effect, use identical horizontal and vertical blur values. To achieve a Gaussian blur,
60  * use 3 iterations, a sigma of 3.0, and a radius between 3 and X (depending on how much blur you want).
61  */
62  class Blur : public EffectBase
63  {
64  private:
65  /// Init effect settings
66  void init_effect_details();
67 
68  /// Internal blur methods (inspired and credited to http://blog.ivank.net/fastest-gaussian-blur.html)
69  int* initBoxes(float sigma, int n);
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 it's 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  string Json(); ///< Generate JSON string of this object
105  void SetJson(string value); ///< Load JSON string into this object
106  Json::Value JsonValue(); ///< Generate Json::JsonValue for this object
107  void SetJsonValue(Json::Value root); ///< Load Json::JsonValue 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  string PropertiesJSON(int64_t requested_frame);
112  };
113 
114 }
115 
116 #endif
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:66
This class adjusts the blur of an image, and can be animated with openshot::Keyframe curves over time...
Definition: Blur.h:62
Keyframe iterations
Iterations keyframe. The # of blur iterations per pixel. 3 iterations = Gaussian. ...
Definition: Blur.h:78
Keyframe vertical_radius
Vertical blur radius keyframe. The size of the vertical blur operation in pixels. ...
Definition: Blur.h:76
This namespace is the default namespace for all code in the openshot library.
A Keyframe is a collection of Point instances, which is used to vary a number or property over time...
Definition: KeyFrame.h:64
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