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