OpenShot Library | libopenshot  0.2.7
Wave.h
Go to the documentation of this file.
1 /**
2  * @file
3  * @brief Header file for Wave 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_WAVE_EFFECT_H
32 #define OPENSHOT_WAVE_EFFECT_H
33 
34 #include "../EffectBase.h"
35 
36 #include "../Frame.h"
37 #include "../Json.h"
38 #include "../KeyFrame.h"
39 
40 #include <string>
41 #include <memory>
42 
43 
44 namespace openshot
45 {
46 
47  /**
48  * @brief This class distorts an image using a wave pattern
49  *
50  * Distoring an image with a wave can be used to simulate analog transmissions, and other effects, and each
51  * value of the wave computation can be animated with an openshot::Keyframe curves over time.
52  */
53  class Wave : public EffectBase
54  {
55  private:
56  //unsigned char *perm;
57 
58  /// Init effect settings
59  void init_effect_details();
60 
61  public:
62  Keyframe wavelength; ///< The length of the wave
63  Keyframe amplitude; ///< The height of the wave
64  Keyframe multiplier; ///< Amount to multiply the wave (make it bigger)
65  Keyframe shift_x; ///< Amount to shift X-axis
66  Keyframe speed_y; ///< Speed of the wave on the Y-axis
67 
68  /// Default constructor, useful when using Json to load the effect properties
69  Wave();
70 
71  /// Constructor which takes 5 curves. The curves will distort the image.
72  ///
73  /// @param wavelength The curve to adjust the wavelength (0.0 to 3.0)
74  /// @param amplitude The curve to adjust the amplitude (0.0 to 5.0)
75  /// @param multiplier The curve to adjust the multiplier (0.0 to 1.0)
76  /// @param shift_x The curve to shift pixels along the x-axis (0 to 100)
77  /// @param speed_y The curve to adjust the vertical speed (0 to 10)
78  Wave(Keyframe wavelength, Keyframe amplitude, Keyframe multiplier, Keyframe shift_x, Keyframe speed_y);
79 
80  /// @brief This method is required for all derived classes of ClipBase, and returns a
81  /// new openshot::Frame object. All Clip keyframes and effects are resolved into
82  /// pixels.
83  ///
84  /// @returns A new openshot::Frame object
85  /// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline.
86  std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) override { return GetFrame(std::make_shared<openshot::Frame>(), frame_number); }
87 
88  /// @brief This method is required for all derived classes of ClipBase, and returns a
89  /// modified openshot::Frame object
90  ///
91  /// The frame object is passed into this method and used as a starting point (pixels and audio).
92  /// All Clip keyframes and effects are resolved into pixels.
93  ///
94  /// @returns The modified openshot::Frame object
95  /// @param frame The frame object that needs the clip or effect applied to it
96  /// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline.
97  std::shared_ptr<openshot::Frame> GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
98 
99  // Get and Set JSON methods
100  std::string Json() const override; ///< Generate JSON string of this object
101  void SetJson(const std::string value) override; ///< Load JSON string into this object
102  Json::Value JsonValue() const override; ///< Generate Json::Value for this object
103  void SetJsonValue(const Json::Value root) override; ///< Load Json::Value into this object
104 
105  /// Get all properties for a specific frame (perfect for a UI to display the current state
106  /// of all properties at any time)
107  std::string PropertiesJSON(int64_t requested_frame) const override;
108  };
109 
110 }
111 
112 #endif
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Wave.cpp:172
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:70
std::string Json() const override
Generate JSON string of this object.
Definition: Wave.cpp:113
void SetJson(const std::string value) override
Load JSON string into this object.
Definition: Wave.cpp:136
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition: Wave.cpp:153
Wave()
Default constructor, useful when using Json to load the effect properties.
Definition: Wave.cpp:37
Keyframe wavelength
The length of the wave.
Definition: Wave.h:62
std::shared_ptr< openshot::Frame > GetFrame(int64_t frame_number) override
This method is required for all derived classes of ClipBase, and returns a new openshot::Frame object...
Definition: Wave.h:86
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Wave.cpp:120
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:46
Keyframe speed_y
Speed of the wave on the Y-axis.
Definition: Wave.h:66
This class distorts an image using a wave pattern.
Definition: Wave.h:53
Keyframe shift_x
Amount to shift X-axis.
Definition: Wave.h:65
Keyframe amplitude
The height of the wave.
Definition: Wave.h:63
A Keyframe is a collection of Point instances, which is used to vary a number or property over time...
Definition: KeyFrame.h:72
Keyframe multiplier
Amount to multiply the wave (make it bigger)
Definition: Wave.h:64