OpenShot Library | libopenshot  0.1.9
Brightness.h
Go to the documentation of this file.
1 /**
2  * @file
3  * @brief Header file for Brightness 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_BRIGHTNESS_EFFECT_H
29 #define OPENSHOT_BRIGHTNESS_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 "../Color.h"
40 #include "../Exceptions.h"
41 #include "../Json.h"
42 #include "../KeyFrame.h"
43 #include "../ReaderBase.h"
44 #include "../FFmpegReader.h"
45 #include "../QtImageReader.h"
46 #include "../ChunkReader.h"
47 
48 using namespace std;
49 
50 namespace openshot
51 {
52 
53  /**
54  * @brief This class adjusts the brightness and contrast of an image, and can be animated
55  * with openshot::Keyframe curves over time.
56  *
57  * Adjusting the brightness and contrast over time can create many different powerful effects.
58  */
59  class Brightness : public EffectBase
60  {
61  private:
62  /// Constrain a color value from 0 to 255
63  int constrain(int color_value);
64 
65  /// Init effect settings
66  void init_effect_details();
67 
68  public:
69  Keyframe brightness; ///< Brightness keyframe. A constant value here will prevent animation.
70  Keyframe contrast; ///< Contrast keyframe.
71 
72  /// Blank constructor, useful when using Json to load the effect properties
73  Brightness();
74 
75  /// Default constructor, which takes 2 curves. The curves adjust the brightness and
76  // contrast of a frame's image.
77  ///
78  /// @param new_brightness The curve to adjust the brightness (between 100 and -100)
79  /// @param new_contrast The curve to adjust the contrast (3 is typical, 20 is a lot, 0 is invalid)
80  Brightness(Keyframe new_brightness, Keyframe new_contrast);
81 
82  /// @brief This method is required for all derived classes of EffectBase, and returns a
83  /// modified openshot::Frame object
84  ///
85  /// The frame object is passed into this method, and a frame_number is passed in which
86  /// tells the effect which settings to use from it's keyframes (starting at 1).
87  ///
88  /// @returns The modified openshot::Frame object
89  /// @param frame The frame object that needs the effect applied to it
90  /// @param frame_number The frame number (starting at 1) of the effect on the timeline.
91  std::shared_ptr<Frame> GetFrame(std::shared_ptr<Frame> frame, int64_t frame_number);
92 
93  /// Get and Set JSON methods
94  string Json(); ///< Generate JSON string of this object
95  void SetJson(string value); ///< Load JSON string into this object
96  Json::Value JsonValue(); ///< Generate Json::JsonValue for this object
97  void SetJsonValue(Json::Value root); ///< Load Json::JsonValue into this object
98 
99  /// Get all properties for a specific frame (perfect for a UI to display the current state
100  /// of all properties at any time)
101  string PropertiesJSON(int64_t requested_frame);
102  };
103 
104 }
105 
106 #endif
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:66
Keyframe contrast
Contrast keyframe.
Definition: Brightness.h:70
Keyframe brightness
Brightness keyframe. A constant value here will prevent animation.
Definition: Brightness.h:69
This class adjusts the brightness and contrast of an image, and can be animated with openshot::Keyfra...
Definition: Brightness.h:59
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