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