OpenShot Library | libopenshot  0.3.3
Distortion.h
Go to the documentation of this file.
1 
9 // Copyright (c) 2008-2019 OpenShot Studios, LLC
10 //
11 // SPDX-License-Identifier: LGPL-3.0-or-later
12 
13 #ifndef OPENSHOT_DISTORTION_AUDIO_EFFECT_H
14 #define OPENSHOT_DISTORTION_AUDIO_EFFECT_H
15 #define _USE_MATH_DEFINES
16 
17 #include "EffectBase.h"
18 
19 #include "Json.h"
20 #include "KeyFrame.h"
21 #include "Enums.h"
22 
23 #include <memory>
24 #include <string>
25 
26 #include <AppConfig.h>
27 #include <juce_audio_basics/juce_audio_basics.h>
28 #include <juce_dsp/juce_dsp.h>
29 
30 namespace openshot
31 {
32  class Frame;
37  class Distortion : public EffectBase
38  {
39  private:
41  void init_effect_details();
42 
43  public:
48 
50  Distortion();
51 
55 
56  std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) override {
57  return GetFrame(std::make_shared<openshot::Frame>(), frame_number);
58  }
59 
60  std::shared_ptr<openshot::Frame> GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
61 
62  // Get and Set JSON methods
63  std::string Json() const override;
64  void SetJson(const std::string value) override;
65  Json::Value JsonValue() const override;
66  void SetJsonValue(const Json::Value root) override;
67 
68  std::string PropertiesJSON(int64_t requested_frame) const override;
69 
70  class Filter : public juce::IIRFilter
71  {
72  public:
73  void updateCoefficients(const double discrete_frequency, const double gain);
74  };
75 
76  juce::OwnedArray<Filter> filters;
77 
78  void updateFilters(int64_t frame_number);
79  };
80 
81 }
82 
83 #endif
openshot::Distortion::SetJsonValue
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition: Distortion.cpp:196
openshot::EffectBase
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:53
openshot::Distortion::output_gain
Keyframe output_gain
Definition: Distortion.h:46
openshot::Distortion::updateFilters
void updateFilters(int64_t frame_number)
Definition: Distortion.cpp:133
openshot::Distortion::Filter
Definition: Distortion.h:70
openshot
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:28
openshot::Distortion::GetFrame
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:56
openshot::Distortion::SetJson
void SetJson(const std::string value) override
Load JSON string into this object.
Definition: Distortion.cpp:179
openshot::Distortion::Distortion
Distortion()
Default constructor.
Definition: Distortion.cpp:18
openshot::Distortion
This class adds a distortion into the audio.
Definition: Distortion.h:37
EffectBase.h
Header file for EffectBase class.
openshot::Distortion::JsonValue
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Distortion.cpp:164
openshot::Distortion::input_gain
Keyframe input_gain
Definition: Distortion.h:45
KeyFrame.h
Header file for the Keyframe class.
openshot::Distortion::PropertiesJSON
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Distortion.cpp:216
openshot::Distortion::distortion_type
openshot::DistortionType distortion_type
Definition: Distortion.h:44
openshot::Keyframe
A Keyframe is a collection of Point instances, which is used to vary a number or property over time.
Definition: KeyFrame.h:53
openshot::Distortion::filters
juce::OwnedArray< Filter > filters
Definition: Distortion.h:76
openshot::Distortion::tone
Keyframe tone
Definition: Distortion.h:47
Enums.h
Header file for TextReader class.
openshot::Distortion::Json
std::string Json() const override
Generate JSON string of this object.
Definition: Distortion.cpp:143
Json.h
Header file for JSON class.
openshot::Distortion::Filter::updateCoefficients
void updateCoefficients(const double discrete_frequency, const double gain)
Definition: Distortion.cpp:149
openshot::DistortionType
DistortionType
This enumeration determines the distortion type of Distortion Effect.
Definition: Enums.h:69