OpenShot Library | libopenshot  0.3.1
ParametricEQ.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_PARAMETRIC_EQ_AUDIO_EFFECT_H
14 #define OPENSHOT_PARAMETRIC_EQ_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 
29 namespace openshot
30 {
31  class Frame;
32 
37  class ParametricEQ : public EffectBase
38  {
39  private:
41  void init_effect_details();
42 
43  public:
49 
51  ParametricEQ();
52 
54  ParametricEQ(openshot::FilterType filter_type, Keyframe frequency,
55  Keyframe gain, Keyframe q_factor);
56 
57  std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) override {
58  return GetFrame(std::make_shared<openshot::Frame>(), frame_number);
59  }
60 
61  std::shared_ptr<openshot::Frame>
62  GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
63 
64  // Get and Set JSON methods
65  std::string Json() const override;
66  void SetJson(const std::string value) override;
67  Json::Value JsonValue() const override;
68  void SetJsonValue(const Json::Value root) override;
69 
70  std::string PropertiesJSON(int64_t requested_frame) const override;
71 
72  class Filter : public juce::IIRFilter
73  {
74  public:
75  void updateCoefficients (const double discrete_frequency,
76  const double q_factor,
77  const double gain,
78  const int filter_type);
79  };
80 
81  juce::OwnedArray<Filter> filters;
82 
83  void updateFilters(int64_t frame_number, double sample_rate);
84  };
85 
86 }
87 
88 #endif
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:52
void updateFilters(int64_t frame_number, double sample_rate)
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
void SetJson(const std::string value) override
Load JSON string into this object.
FilterType
This enumeration determines the filter type of ParametricEQ Effect.
Definition: Enums.h:79
Header file for the Keyframe class.
std::string PropertiesJSON(int64_t requested_frame) const override
Json::Value JsonValue() const override
Generate Json::Value for this object.
Header file for JSON class.
juce::OwnedArray< Filter > filters
Definition: ParametricEQ.h:81
ParametricEQ()
Blank constructor, useful when using Json to load the effect properties.
Header file for TextReader class.
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:28
Header file for EffectBase class.
This class adds a equalization into the audio.
Definition: ParametricEQ.h:37
openshot::FilterType filter_type
Definition: ParametricEQ.h:44
A Keyframe is a collection of Point instances, which is used to vary a number or property over time...
Definition: KeyFrame.h:53
std::string Json() const override
Generate JSON string of 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...
Definition: ParametricEQ.h:57
void updateCoefficients(const double discrete_frequency, const double q_factor, const double gain, const int filter_type)