OpenShot Library | libopenshot 0.2.7
Noise.h
Go to the documentation of this file.
1/**
2 * @file
3 * @brief Header file for Noise 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_NOISE_AUDIO_EFFECT_H
32#define OPENSHOT_NOISE_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 noise into the audio
51 *
52 */
53 class Noise : public EffectBase
54 {
55 private:
56 /// Init effect settings
57 void init_effect_details();
58
59 public:
60 Keyframe level; ///< Noise level keyframe. The amount of noise inserted on the audio.
61
62 /// Blank constructor, useful when using Json to load the effect properties
63 Noise();
64
65 /// Default constructor
66 ///
67 /// @param new_level The audio default noise level (between 1 and 100)
68 Noise(Keyframe new_level);
69
70 /// @brief This method is required for all derived classes of ClipBase, and returns a
71 /// new openshot::Frame object. All Clip keyframes and effects are resolved into
72 /// pixels.
73 ///
74 /// @returns A new openshot::Frame object
75 /// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline.
76 std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) override {
77 return GetFrame(std::make_shared<openshot::Frame>(), frame_number);
78 }
79
80 /// @brief This method is required for all derived classes of ClipBase, and returns a
81 /// modified openshot::Frame object
82 ///
83 /// The frame object is passed into this method and used as a starting point (pixels and audio).
84 /// All Clip keyframes and effects are resolved into pixels.
85 ///
86 /// @returns The modified openshot::Frame object
87 /// @param frame The frame object that needs the clip or effect applied to it
88 /// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline.
89 std::shared_ptr<openshot::Frame> GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
90
91 // Get and Set JSON methods
92 std::string Json() const override; ///< Generate JSON string of this object
93 void SetJson(const std::string value) override; ///< Load JSON string into this object
94 Json::Value JsonValue() const override; ///< Generate Json::Value for this object
95 void SetJsonValue(const Json::Value root) override; ///< Load Json::Value into this object
96
97 /// Get all properties for a specific frame (perfect for a UI to display the current state
98 /// of all properties at any time)
99 std::string PropertiesJSON(int64_t requested_frame) const override;
100 };
101
102}
103
104#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
This class adds a noise into the audio.
Definition: Noise.h:54
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: Noise.h:76
void SetJson(const std::string value) override
Load JSON string into this object.
Definition: Noise.cpp:106
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Noise.cpp:94
std::string Json() const override
Generate JSON string of this object.
Definition: Noise.cpp:87
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Noise.cpp:134
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition: Noise.cpp:123
Noise()
Blank constructor, useful when using Json to load the effect properties.
Definition: Noise.cpp:37
Keyframe level
Noise level keyframe. The amount of noise inserted on the audio.
Definition: Noise.h:60
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:47