OpenShot Library | libopenshot 0.2.7
Echo.h
Go to the documentation of this file.
1/**
2 * @file
3 * @brief Header file for Echo 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_ECHO_AUDIO_EFFECT_H
32#define OPENSHOT_ECHO_AUDIO_EFFECT_H
33
34#include "../EffectBase.h"
35
36#include "../Frame.h"
37#include "../Json.h"
38#include "../KeyFrame.h"
39
40#include <memory>
41#include <string>
42#include <random>
43#include <math.h>
44
45
46namespace openshot
47{
48
49 /**
50 * @brief This class adds a echo into the audio
51 *
52 */
53 class Echo : public EffectBase
54 {
55 private:
56 /// Init effect settings
57 void init_effect_details();
58
59 public:
63
64 juce::AudioSampleBuffer echo_buffer;
69
70 /// Blank constructor, useful when using Json to load the effect properties
71 Echo();
72
73 /// Default constructor
74 Echo(Keyframe new_echo_time, Keyframe new_feedback, Keyframe new_mix);
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 void setup(std::shared_ptr<openshot::Frame> frame);
87
88 /// @brief This method is required for all derived classes of ClipBase, and returns a
89 /// modified openshot::Frame object
90 ///
91 /// The frame object is passed into this method and used as a starting point (pixels and audio).
92 /// All Clip keyframes and effects are resolved into pixels.
93 ///
94 /// @returns The modified openshot::Frame object
95 /// @param frame The frame object that needs the clip or effect applied to it
96 /// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline.
97 std::shared_ptr<openshot::Frame> GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
98
99 // Get and Set JSON methods
100 std::string Json() const override; ///< Generate JSON string of this object
101 void SetJson(const std::string value) override; ///< Load JSON string into this object
102 Json::Value JsonValue() const override; ///< Generate Json::Value for this object
103 void SetJsonValue(const Json::Value root) override; ///< Load Json::Value into this object
104
105 /// Get all properties for a specific frame (perfect for a UI to display the current state
106 /// of all properties at any time)
107 std::string PropertiesJSON(int64_t requested_frame) const override;
108 };
109
110}
111
112#endif
This class adds a echo into the audio.
Definition: Echo.h:54
Keyframe mix
Definition: Echo.h:62
void SetJson(const std::string value) override
Load JSON string into this object.
Definition: Echo.cpp:151
int echo_buffer_channels
Definition: Echo.h:66
Keyframe echo_time
Definition: Echo.h:60
std::string Json() const override
Generate JSON string of this object.
Definition: Echo.cpp:130
int echo_write_position
Definition: Echo.h:67
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition: Echo.cpp:168
juce::AudioSampleBuffer echo_buffer
Definition: Echo.h:64
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: Echo.h:82
bool initialized
Definition: Echo.h:68
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Echo.cpp:137
Echo()
Blank constructor, useful when using Json to load the effect properties.
Definition: Echo.cpp:37
int echo_buffer_samples
Definition: Echo.h:65
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Echo.cpp:183
void setup(std::shared_ptr< openshot::Frame > frame)
Definition: Echo.cpp:65
Keyframe feedback
Definition: Echo.h:61
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
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:47