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