OpenShot Library | libopenshot  0.2.5
Hue.h
Go to the documentation of this file.
1 /**
2  * @file
3  * @brief Header file for Hue 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_HUE_EFFECT_H
32 #define OPENSHOT_HUE_EFFECT_H
33 
34 #include "../EffectBase.h"
35 
36 #include <cmath>
37 #include <stdio.h>
38 #include <memory>
39 #include "../Json.h"
40 #include "../KeyFrame.h"
41 
42 
43 namespace openshot
44 {
45 
46  /**
47  * @brief This class shifts the hue of an image, and can be animated with openshot::Keyframe curves over time.
48  *
49  * Shifting hue can adjust the colors in an image towards red, blue, green, or anywhere in between. Animating hue
50  * can create some fun and interesting effects, but can also be used to change the mood of a scene, etc...
51  */
52  class Hue : public EffectBase
53  {
54  private:
55  /// Init effect settings
56  void init_effect_details();
57 
58 
59  public:
60  Keyframe hue; ///< Shift the hue coordinates (left or right)
61 
62  /// Blank constructor, useful when using Json to load the effect properties
63  Hue();
64 
65  /// Default constructor, which takes 1 curve. The curves will shift the hue of the image.
66  ///
67  /// @param hue The curve to adjust the hue shift (between 0 and 1)
68  Hue(Keyframe hue);
69 
70  /// @brief This method is required for all derived classes of EffectBase, and returns a
71  /// modified openshot::Frame object
72  ///
73  /// The frame object is passed into this method, and a frame_number is passed in which
74  /// tells the effect which settings to use from its keyframes (starting at 1).
75  ///
76  /// @returns The modified openshot::Frame object
77  /// @param frame The frame object that needs the effect applied to it
78  /// @param frame_number The frame number (starting at 1) of the effect on the timeline.
79  std::shared_ptr<Frame> GetFrame(std::shared_ptr<Frame> frame, int64_t frame_number);
80 
81  /// Get and Set JSON methods
82  std::string Json() const override; ///< Generate JSON string of this object
83  void SetJson(const std::string value); ///< Load JSON string into this object
84  Json::Value JsonValue() const override; ///< Generate Json::Value for this object
85  void SetJsonValue(const Json::Value root); ///< Load Json::Value into this object
86 
87  /// Get all properties for a specific frame (perfect for a UI to display the current state
88  /// of all properties at any time)
89  std::string PropertiesJSON(int64_t requested_frame) const override;
90  };
91 
92 }
93 
94 #endif
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:67
This class shifts the hue of an image, and can be animated with openshot::Keyframe curves over time.
Definition: Hue.h:53
Keyframe hue
Shift the hue coordinates (left or right)
Definition: Hue.h:60
void SetJson(const std::string value)
Load JSON string into this object.
Definition: Hue.cpp:124
void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
Definition: Hue.cpp:141
Hue()
Blank constructor, useful when using Json to load the effect properties.
Definition: Hue.cpp:36
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Hue.cpp:152
std::string Json() const override
Get and Set JSON methods.
Definition: Hue.cpp:105
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: Hue.cpp:64
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Hue.cpp:112
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.