OpenShot Library | libopenshot  0.2.5
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 <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 distorts an image using a wave pattern
48  *
49  * Distoring an image with a wave can be used to simulate analog transmissions, and other effects, and each
50  * value of the wave computation can be animated with an openshot::Keyframe curves over time.
51  */
52  class Wave : public EffectBase
53  {
54  private:
55  //unsigned char *perm;
56 
57  /// Init effect settings
58  void init_effect_details();
59 
60  public:
61  Keyframe wavelength; ///< The length of the wave
62  Keyframe amplitude; ///< The height of the wave
63  Keyframe multiplier; ///< Amount to multiply the wave (make it bigger)
64  Keyframe shift_x; ///< Amount to shift X-axis
65  Keyframe speed_y; ///< Speed of the wave on the Y-axis
66 
67  /// Blank constructor, useful when using Json to load the effect properties
68  Wave();
69 
70  /// Default constructor, which takes 5 curves. The curves will distort the image.
71  ///
72  /// @param wavelength The curve to adjust the wavelength (0.0 to 3.0)
73  /// @param amplitude The curve to adjust the amplitude (0.0 to 5.0)
74  /// @param multiplier The curve to adjust the multiplier (0.0 to 1.0)
75  /// @param shift_x The curve to shift pixels along the x-axis (0 to 100)
76  /// @param speed_y The curve to adjust the vertical speed (0 to 10)
77  Wave(Keyframe wavelength, Keyframe amplitude, Keyframe multiplier, Keyframe shift_x, Keyframe speed_y);
78 
79  /// @brief This method is required for all derived classes of EffectBase, and returns a
80  /// modified openshot::Frame object
81  ///
82  /// The frame object is passed into this method, and a frame_number is passed in which
83  /// tells the effect which settings to use from its keyframes (starting at 1).
84  ///
85  /// @returns The modified openshot::Frame object
86  /// @param frame The frame object that needs the effect applied to it
87  /// @param frame_number The frame number (starting at 1) of the effect on the timeline.
88  std::shared_ptr<Frame> GetFrame(std::shared_ptr<Frame> frame, int64_t frame_number);
89 
90  /// Get and Set JSON methods
91  std::string Json() const override; ///< Generate JSON string of this object
92  void SetJson(const std::string value); ///< Load JSON string into this object
93  Json::Value JsonValue() const override; ///< Generate Json::Value for this object
94  void SetJsonValue(const Json::Value root); ///< Load Json::Value into this object
95 
96  /// Get all properties for a specific frame (perfect for a UI to display the current state
97  /// of all properties at any time)
98  std::string PropertiesJSON(int64_t requested_frame) const override;
99  };
100 
101 }
102 
103 #endif
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Wave.cpp:171
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:66
void SetJson(const std::string value)
Load JSON string into this object.
Definition: Wave.cpp:135
std::string Json() const override
Get and Set JSON methods.
Definition: Wave.cpp:112
Wave()
Blank constructor, useful when using Json to load the effect properties.
Definition: Wave.cpp:36
Keyframe wavelength
The length of the wave.
Definition: Wave.h:61
void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
Definition: Wave.cpp:152
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: Wave.cpp:66
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Wave.cpp:119
This namespace is the default namespace for all code in the openshot library.
Keyframe speed_y
Speed of the wave on the Y-axis.
Definition: Wave.h:65
This class distorts an image using a wave pattern.
Definition: Wave.h:52
Keyframe shift_x
Amount to shift X-axis.
Definition: Wave.h:64
Keyframe amplitude
The height of the wave.
Definition: Wave.h:62
A Keyframe is a collection of Point instances, which is used to vary a number or property over time...
Definition: KeyFrame.h:64
Keyframe multiplier
Amount to multiply the wave (make it bigger)
Definition: Wave.h:63