OpenShot Library | libopenshot  0.2.5
ColorShift.h
Go to the documentation of this file.
1 /**
2  * @file
3  * @brief Header file for Color Shift 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_COLOR_SHIFT_EFFECT_H
32 #define OPENSHOT_COLOR_SHIFT_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 pixels of an image up, down, left, or right, and can be animated
48  * with openshot::Keyframe curves over time.
49  *
50  * Shifting pixels can be used in many interesting ways, especially when animating the movement of the pixels.
51  * The pixels wrap around the image (the pixels drop off one side and appear on the other side of the image).
52  */
53  class ColorShift : public EffectBase
54  {
55  private:
56  /// Init effect settings
57  void init_effect_details();
58 
59  public:
60  Keyframe red_x; ///< Shift the Red X coordinates (left or right)
61  Keyframe red_y; ///< Shift the Red Y coordinates (up or down)
62  Keyframe green_x; ///< Shift the Green X coordinates (left or right)
63  Keyframe green_y; ///< Shift the Green Y coordinates (up or down)
64  Keyframe blue_x; ///< Shift the Blue X coordinates (left or right)
65  Keyframe blue_y; ///< Shift the Blue Y coordinates (up or down)
66  Keyframe alpha_x; ///< Shift the Alpha X coordinates (left or right)
67  Keyframe alpha_y; ///< Shift the Alpha Y coordinates (up or down)
68 
69  /// Blank constructor, useful when using Json to load the effect properties
70  ColorShift();
71 
72  /// Default constructor, which takes 8 curves. The curves will shift the RGBA pixels up, down, left, or right
73  ///
74  /// @param red_x The curve to adjust the Red x shift (between -1 and 1, percentage)
75  /// @param red_y The curve to adjust the Red y shift (between -1 and 1, percentage)
76  /// @param green_x The curve to adjust the Green x shift (between -1 and 1, percentage)
77  /// @param green_y The curve to adjust the Green y shift (between -1 and 1, percentage)
78  /// @param blue_x The curve to adjust the Blue x shift (between -1 and 1, percentage)
79  /// @param blue_y The curve to adjust the Blue y shift (between -1 and 1, percentage)
80  /// @param alpha_x The curve to adjust the Alpha x shift (between -1 and 1, percentage)
81  /// @param alpha_y The curve to adjust the Alpha y shift (between -1 and 1, percentage)
83 
84  /// @brief This method is required for all derived classes of EffectBase, and returns a
85  /// modified openshot::Frame object
86  ///
87  /// The frame object is passed into this method, and a frame_number is passed in which
88  /// tells the effect which settings to use from its keyframes (starting at 1).
89  ///
90  /// @returns The modified openshot::Frame object
91  /// @param frame The frame object that needs the effect applied to it
92  /// @param frame_number The frame number (starting at 1) of the effect on the timeline.
93  std::shared_ptr<Frame> GetFrame(std::shared_ptr<Frame> frame, int64_t frame_number);
94 
95  /// Get and Set JSON methods
96  std::string Json() const override; ///< Generate JSON string of this object
97  void SetJson(const std::string value); ///< Load JSON string into this object
98  Json::Value JsonValue() const override; ///< Generate Json::Value for this object
99  void SetJsonValue(const Json::Value root); ///< Load Json::Value into this object
100 
101  /// Get all properties for a specific frame (perfect for a UI to display the current state
102  /// of all properties at any time)
103  std::string PropertiesJSON(int64_t requested_frame) const override;
104  };
105 
106 }
107 
108 #endif
openshot::ColorShift::alpha_y
Keyframe alpha_y
Shift the Alpha Y coordinates (up or down)
Definition: ColorShift.h:67
openshot::ColorShift::red_x
Keyframe red_x
Shift the Red X coordinates (left or right)
Definition: ColorShift.h:60
openshot::EffectBase
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:66
openshot
This namespace is the default namespace for all code in the openshot library.
Definition: AudioBufferSource.h:38
openshot::ColorShift::ColorShift
ColorShift()
Blank constructor, useful when using Json to load the effect properties.
Definition: ColorShift.cpp:36
openshot::ColorShift::green_x
Keyframe green_x
Shift the Green X coordinates (left or right)
Definition: ColorShift.h:62
openshot::ColorShift::SetJsonValue
void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
Definition: ColorShift.cpp:238
openshot::ColorShift::blue_x
Keyframe blue_x
Shift the Blue X coordinates (left or right)
Definition: ColorShift.h:64
openshot::ColorShift::PropertiesJSON
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: ColorShift.cpp:263
openshot::ColorShift::alpha_x
Keyframe alpha_x
Shift the Alpha X coordinates (left or right)
Definition: ColorShift.h:66
openshot::ColorShift::red_y
Keyframe red_y
Shift the Red Y coordinates (up or down)
Definition: ColorShift.h:61
openshot::ColorShift::green_y
Keyframe green_y
Shift the Green Y coordinates (up or down)
Definition: ColorShift.h:63
openshot::Keyframe
A Keyframe is a collection of Point instances, which is used to vary a number or property over time.
Definition: KeyFrame.h:64
openshot::ColorShift::GetFrame
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: ColorShift.cpp:65
openshot::ColorShift::JsonValue
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: ColorShift.cpp:202
openshot::ColorShift::Json
std::string Json() const override
Get and Set JSON methods.
Definition: ColorShift.cpp:195
openshot::ColorShift
This class shifts the pixels of an image up, down, left, or right, and can be animated with openshot:...
Definition: ColorShift.h:53
openshot::ColorShift::SetJson
void SetJson(const std::string value)
Load JSON string into this object.
Definition: ColorShift.cpp:221
openshot::ColorShift::blue_y
Keyframe blue_y
Shift the Blue Y coordinates (up or down)
Definition: ColorShift.h:65