OpenShot Library | libopenshot 0.2.7
ParametricEQ.h
Go to the documentation of this file.
1/**
2 * @file
3 * @brief Header file for Parametric EQ 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_PARAMETRIC_EQ_AUDIO_EFFECT_H
32#define OPENSHOT_PARAMETRIC_EQ_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
48namespace openshot
49{
50
51 /**
52 * @brief This class adds a equalization into the audio
53 *
54 */
55 class ParametricEQ : public EffectBase
56 {
57 private:
58 /// Init effect settings
59 void init_effect_details();
60
61 public:
67
68 /// Blank constructor, useful when using Json to load the effect properties
70
71 /// Default constructor
72 ///
73 /// @param new_level
74 ParametricEQ(openshot::FilterType new_filter_type, Keyframe new_frequency, Keyframe new_gain, Keyframe new_q_factor);
75
76 /// @brief This method is required for all derived classes of ClipBase, and returns a
77 /// new openshot::Frame object. All Clip keyframes and effects are resolved into
78 /// pixels.
79 ///
80 /// @returns A new openshot::Frame object
81 /// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline.
82 std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) override {
83 return GetFrame(std::make_shared<openshot::Frame>(), frame_number);
84 }
85
86 /// @brief This method is required for all derived classes of ClipBase, and returns a
87 /// modified openshot::Frame object
88 ///
89 /// The frame object is passed into this method and used as a starting point (pixels and audio).
90 /// All Clip keyframes and effects are resolved into pixels.
91 ///
92 /// @returns The modified openshot::Frame object
93 /// @param frame The frame object that needs the clip or effect applied to it
94 /// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline.
95 std::shared_ptr<openshot::Frame> GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
96
97 // Get and Set JSON methods
98 std::string Json() const override; ///< Generate JSON string of this object
99 void SetJson(const std::string value) override; ///< Load JSON string into this object
100 Json::Value JsonValue() const override; ///< Generate Json::Value for this object
101 void SetJsonValue(const Json::Value root) override; ///< Load Json::Value into this object
102
103 /// Get all properties for a specific frame (perfect for a UI to display the current state
104 /// of all properties at any time)
105 std::string PropertiesJSON(int64_t requested_frame) const override;
106
107 class Filter : public IIRFilter
108 {
109 public:
110 void updateCoefficients (const double discrete_frequency,
111 const double q_factor,
112 const double gain,
113 const int filter_type);
114 };
115
116 juce::OwnedArray<Filter> filters;
117
118 void updateFilters(int64_t frame_number, double sample_rate);
119 };
120
121}
122
123#endif
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:71
A Keyframe is a collection of Point instances, which is used to vary a number or property over time.
Definition: KeyFrame.h:72
void updateCoefficients(const double discrete_frequency, const double q_factor, const double gain, const int filter_type)
This class adds a equalization into the audio.
Definition: ParametricEQ.h:56
std::string PropertiesJSON(int64_t requested_frame) const override
void SetJson(const std::string value) override
Load JSON string into this object.
ParametricEQ()
Blank constructor, useful when using Json to load the effect properties.
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:82
std::string Json() const override
Generate JSON string of this object.
void updateFilters(int64_t frame_number, double sample_rate)
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Json::Value JsonValue() const override
Generate Json::Value for this object.
openshot::FilterType filter_type
Definition: ParametricEQ.h:62
juce::OwnedArray< Filter > filters
Definition: ParametricEQ.h:116
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:47
FilterType
This enumeration determines the filter type of ParametricEQ Effect.
Definition: Enums.h:97