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