OpenShot Library | libopenshot  0.2.5
Shift.h
Go to the documentation of this file.
1 /**
2  * @file
3  * @brief Header file for 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_SHIFT_EFFECT_H
32 #define OPENSHOT_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 Shift : public EffectBase
54  {
55  private:
56  /// Init effect settings
57  void init_effect_details();
58 
59 
60  public:
61  Keyframe x; ///< Shift the X coordinates (left or right)
62  Keyframe y; ///< Shift the Y coordinates (up or down)
63 
64  /// Blank constructor, useful when using Json to load the effect properties
65  Shift();
66 
67  /// Default constructor, which takes 2 curve. The curves will shift the pixels up, down, left, or right
68  ///
69  /// @param x The curve to adjust the x shift (between -1 and 1, percentage)
70  /// @param y The curve to adjust the y shift (between -1 and 1, percentage)
72 
73  /// @brief This method is required for all derived classes of EffectBase, and returns a
74  /// modified openshot::Frame object
75  ///
76  /// The frame object is passed into this method, and a frame_number is passed in which
77  /// tells the effect which settings to use from its keyframes (starting at 1).
78  ///
79  /// @returns The modified openshot::Frame object
80  /// @param frame The frame object that needs the effect applied to it
81  /// @param frame_number The frame number (starting at 1) of the effect on the timeline.
82  std::shared_ptr<Frame> GetFrame(std::shared_ptr<Frame> frame, int64_t frame_number);
83 
84  /// Get and Set JSON methods
85  std::string Json() const override; ///< Generate JSON string of this object
86  void SetJson(const std::string value); ///< Load JSON string into this object
87  Json::Value JsonValue() const override; ///< Generate Json::Value for this object
88  void SetJsonValue(const Json::Value root); ///< Load Json::Value into this object
89 
90  /// Get all properties for a specific frame (perfect for a UI to display the current state
91  /// of all properties at any time)
92  std::string PropertiesJSON(int64_t requested_frame) const override;
93  };
94 
95 }
96 
97 #endif
openshot::EffectBase
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:66
openshot::Shift::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: Shift.cpp:64
openshot
This namespace is the default namespace for all code in the openshot library.
Definition: AudioBufferSource.h:38
openshot::Shift::Json
std::string Json() const override
Get and Set JSON methods.
Definition: Shift.cpp:136
openshot::Shift::Shift
Shift()
Blank constructor, useful when using Json to load the effect properties.
Definition: Shift.cpp:36
openshot::Shift::JsonValue
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Shift.cpp:143
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::Shift
This class shifts the pixels of an image up, down, left, or right, and can be animated with openshot:...
Definition: Shift.h:53
openshot::Shift::PropertiesJSON
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Shift.cpp:186
openshot::Shift::SetJson
void SetJson(const std::string value)
Load JSON string into this object.
Definition: Shift.cpp:156
openshot::Shift::x
Keyframe x
Shift the X coordinates (left or right)
Definition: Shift.h:61
openshot::Shift::SetJsonValue
void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
Definition: Shift.cpp:173
openshot::Shift::y
Keyframe y
Shift the Y coordinates (up or down)
Definition: Shift.h:62