OpenShot Library | libopenshot 0.2.7
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 * @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_BRIGHTNESS_EFFECT_H
32#define OPENSHOT_BRIGHTNESS_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 brightness and contrast of an image, and can be animated
48 * with openshot::Keyframe curves over time.
49 *
50 * Adjusting the brightness and contrast over time can create many different powerful effects.
51 */
52 class Brightness : public EffectBase
53 {
54 private:
55 /// Init effect settings
56 void init_effect_details();
57
58 public:
59 Keyframe brightness; ///< Brightness keyframe. A constant value here will prevent animation.
60 Keyframe contrast; ///< Contrast keyframe.
61
62 /// Blank constructor, useful when using Json to load the effect properties
63 Brightness();
64
65 /// Default constructor, which takes 2 curves. The curves adjust the brightness and
66 // contrast of a frame's image.
67 ///
68 /// @param new_brightness The curve to adjust the brightness (from -1 to +1, 0 is default/"off")
69 /// @param new_contrast The curve to adjust the contrast (3 is typical, 20 is a lot, 100 is max. 0 is invalid)
70 Brightness(Keyframe new_brightness, Keyframe new_contrast);
71
72 /// @brief This method is required for all derived classes of ClipBase, and returns a
73 /// new openshot::Frame object. All Clip keyframes and effects are resolved into
74 /// pixels.
75 ///
76 /// @returns A new openshot::Frame object
77 /// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline.
78 std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) override { return GetFrame(std::make_shared<openshot::Frame>(), frame_number); }
79
80 /// @brief This method is required for all derived classes of ClipBase, and returns a
81 /// modified openshot::Frame object
82 ///
83 /// The frame object is passed into this method and used as a starting point (pixels and audio).
84 /// All Clip keyframes and effects are resolved into pixels.
85 ///
86 /// @returns The modified openshot::Frame object
87 /// @param frame The frame object that needs the clip or effect applied to it
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(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
90
91 // Get and Set JSON methods
92 std::string Json() const override; ///< Generate JSON string of this object
93 void SetJson(const std::string value) override; ///< Load JSON string into this object
94 Json::Value JsonValue() const override; ///< Generate Json::Value for this object
95 void SetJsonValue(const Json::Value root) override; ///< Load Json::Value into this object
96
97 /// Get all properties for a specific frame (perfect for a UI to display the current state
98 /// of all properties at any time)
99 std::string PropertiesJSON(int64_t requested_frame) const override;
100 };
101
102}
103
104#endif
This class adjusts the brightness and contrast of an image, and can be animated with openshot::Keyfra...
Definition: Brightness.h:53
Keyframe brightness
Brightness keyframe. A constant value here will prevent animation.
Definition: Brightness.h:59
std::string Json() const override
Generate JSON string of this object.
Definition: Brightness.cpp:101
Keyframe contrast
Contrast keyframe.
Definition: Brightness.h:60
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: Brightness.h:78
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition: Brightness.cpp:138
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Brightness.cpp:108
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Brightness.cpp:151
Brightness()
Blank constructor, useful when using Json to load the effect properties.
Definition: Brightness.cpp:37
void SetJson(const std::string value) override
Load JSON string into this object.
Definition: Brightness.cpp:121
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