OpenShot Library | libopenshot  0.2.6
Distortion.h
Go to the documentation of this file.
1 /**
2  * @file
3  * @brief Header file for Distortion audio effect class
4  * @author
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_DISTORTION_AUDIO_EFFECT_H
32 #define OPENSHOT_DISTORTION_AUDIO_EFFECT_H
33 #define _USE_MATH_DEFINES
34 
35 #include "../EffectBase.h"
36 
37 #include "../Frame.h"
38 #include "../Json.h"
39 #include "../KeyFrame.h"
40 #include "../Enums.h"
41 
42 #include <memory>
43 #include <string>
44 #include <math.h>
45 // #include <OpenShotAudio.h>
46 
47 
48 namespace openshot
49 {
50 
51  /**
52  * @brief This class adds a distortion into the audio
53  *
54  */
55  class Distortion : public EffectBase
56  {
57  private:
58  /// Init effect settings
59  void init_effect_details();
60 
61  public:
66 
67  /// Blank constructor, useful when using Json to load the effect properties
68  Distortion();
69 
70  /// Default constructor
71  ///
72  /// @param new_level The audio default distortion level (between 1 and 100)
73  Distortion(openshot::DistortionType new_distortion_type, Keyframe new_input_gain, Keyframe new_output_gain, Keyframe new_tone);
74 
75  /// @brief This method is required for all derived classes of ClipBase, and returns a
76  /// new openshot::Frame object. All Clip keyframes and effects are resolved into
77  /// pixels.
78  ///
79  /// @returns A new openshot::Frame object
80  /// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline.
81  std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) override {
82  return GetFrame(std::make_shared<openshot::Frame>(), frame_number);
83  }
84 
85  /// @brief This method is required for all derived classes of ClipBase, and returns a
86  /// modified openshot::Frame object
87  ///
88  /// The frame object is passed into this method and used as a starting point (pixels and audio).
89  /// All Clip keyframes and effects are resolved into pixels.
90  ///
91  /// @returns The modified openshot::Frame object
92  /// @param frame The frame object that needs the clip or effect applied to it
93  /// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline.
94  std::shared_ptr<openshot::Frame> GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
95 
96  // Get and Set JSON methods
97  std::string Json() const override; ///< Generate JSON string of this object
98  void SetJson(const std::string value) override; ///< Load JSON string into this object
99  Json::Value JsonValue() const override; ///< Generate Json::Value for this object
100  void SetJsonValue(const Json::Value root) override; ///< Load Json::Value into this object
101 
102  /// Get all properties for a specific frame (perfect for a UI to display the current state
103  /// of all properties at any time)
104  std::string PropertiesJSON(int64_t requested_frame) const override;
105 
106  class Filter : public juce::IIRFilter
107  {
108  public:
109  void updateCoefficients(const double discrete_frequency, const double gain);
110  };
111 
112  juce::OwnedArray<Filter> filters;
113 
114  void updateFilters(int64_t frame_number);
115  };
116 
117 }
118 
119 #endif
openshot::DistortionType distortion_type
Definition: Distortion.h:62
juce::OwnedArray< Filter > filters
Definition: Distortion.h:112
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:70
This class adds a distortion into the audio.
Definition: Distortion.h:55
std::string Json() const override
Generate JSON string of this object.
Definition: Distortion.cpp:163
void updateFilters(int64_t frame_number)
Definition: Distortion.cpp:153
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition: Distortion.cpp:216
Keyframe output_gain
Definition: Distortion.h:64
void SetJson(const std::string value) override
Load JSON string into this object.
Definition: Distortion.cpp:199
DistortionType
This enumeration determines the distortion type of Distortion Effect.
Definition: Enums.h:86
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: Distortion.h:81
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:46
Distortion()
Blank constructor, useful when using Json to load the effect properties.
Definition: Distortion.cpp:37
void updateCoefficients(const double discrete_frequency, const double gain)
Definition: Distortion.cpp:169
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Distortion.cpp:236
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Distortion.cpp:184
A Keyframe is a collection of Point instances, which is used to vary a number or property over time...
Definition: KeyFrame.h:72