OpenShot Library | libopenshot  0.2.7
Whisperization.h
Go to the documentation of this file.
1 /**
2  * @file
3  * @brief Header file for whisperization 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_WHISPERIZATION_AUDIO_EFFECT_H
32 #define OPENSHOT_WHISPERIZATION_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 #include "STFT.h"
42 
43 #include <memory>
44 #include <string>
45 #include <math.h>
46 #include <cmath>
47 
48 
49 namespace openshot
50 {
51 
52  /**
53  * @brief This class adds a whisperization effect into the audio
54  *
55  */
56  class Whisperization : public EffectBase
57  {
58  private:
59  /// Init effect settings
60  void init_effect_details();
61 
62  public:
66 
67  /// Blank constructor, useful when using Json to load the effect properties
69 
70  /// Default constructor
71  ///
72  /// @param new_level The audio default Whisperization level (between 1 and 100)
73  Whisperization(openshot::FFTSize new_fft_size, openshot::HopSize new_hop_size, openshot::WindowType new_window_type);
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 
107  class WhisperizationEffect : public STFT
108  {
109  public:
111 
112  private:
113  void modification(const int channel) override;
114 
115  Whisperization &parent;
116  };
117 
118  juce::CriticalSection lock;
120  std::unique_ptr<juce::dsp::FFT> fft;
121  };
122 
123 }
124 
125 #endif
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:71
This class adds a whisperization effect into the audio.
std::unique_ptr< juce::dsp::FFT > fft
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Whisperization()
Blank constructor, useful when using Json to load the effect properties.
std::string Json() const override
Generate JSON string of this object.
openshot::WindowType window_type
juce::CriticalSection lock
WhisperizationEffect stft
Json::Value JsonValue() const override
Generate Json::Value for this object.
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...
std::string PropertiesJSON(int64_t requested_frame) const override
void SetJson(const std::string value) override
Load JSON string into this object.
openshot::FFTSize fft_size
openshot::HopSize hop_size
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:47
FFTSize
This enumeration determines the FFT size.
Definition: Enums.h:109
HopSize
This enumeration determines the hop size.
Definition: Enums.h:122
WindowType
This enumeration determines the window type.
Definition: Enums.h:129