OpenShot Library | libopenshot 0.2.7
Noise.cpp
Go to the documentation of this file.
1/**
2 * @file
3 * @brief Source 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#include "Noise.h"
32#include "Exceptions.h"
33
34using namespace openshot;
35
36/// Blank constructor, useful when using Json to load the effect properties
37Noise::Noise() : level(30) {
38 // Init effect properties
39 init_effect_details();
40}
41
42// Default constructor
43Noise::Noise(Keyframe new_level) : level(new_level)
44{
45 // Init effect properties
46 init_effect_details();
47}
48
49// Init effect settings
50void Noise::init_effect_details()
51{
52 /// Initialize the values of the EffectInfo struct.
54
55 /// Set the effect info
56 info.class_name = "Noise";
57 info.name = "Noise";
58 info.description = "Random signal having equal intensity at different frequencies.";
59 info.has_audio = true;
60 info.has_video = false;
61}
62
63// This method is required for all derived classes of EffectBase, and returns a
64// modified openshot::Frame object
65std::shared_ptr<openshot::Frame> Noise::GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number)
66{
67 // Adding Noise
68 srand ( time(NULL) );
69 int noise = level.GetValue(frame_number);
70
71 for (int channel = 0; channel < frame->audio->getNumChannels(); channel++)
72 {
73 auto *buffer = frame->audio->getWritePointer(channel);
74
75 for (auto sample = 0; sample < frame->audio->getNumSamples(); ++sample)
76 {
77 buffer[sample] = buffer[sample]*(1 - (1+(float)noise)/100) + buffer[sample]*0.0001*(rand()%100+1)*noise;
78 }
79 }
80
81
82 // return the modified frame
83 return frame;
84}
85
86// Generate JSON string of this object
87std::string Noise::Json() const {
88
89 // Return formatted string
90 return JsonValue().toStyledString();
91}
92
93// Generate Json::Value for this object
94Json::Value Noise::JsonValue() const {
95
96 // Create root json object
97 Json::Value root = EffectBase::JsonValue(); // get parent properties
98 root["type"] = info.class_name;
99 root["level"] = level.JsonValue();
100
101 // return JsonValue
102 return root;
103}
104
105// Load JSON string into this object
106void Noise::SetJson(const std::string value) {
107
108 // Parse JSON string into JSON objects
109 try
110 {
111 const Json::Value root = openshot::stringToJson(value);
112 // Set all values that match
113 SetJsonValue(root);
114 }
115 catch (const std::exception& e)
116 {
117 // Error parsing JSON (or missing keys)
118 throw InvalidJSON("JSON is invalid (missing keys or invalid data types)");
119 }
120}
121
122// Load Json::Value into this object
123void Noise::SetJsonValue(const Json::Value root) {
124
125 // Set parent data
127
128 // Set data from Json (if key is found)
129 if (!root["level"].isNull())
130 level.SetJsonValue(root["level"]);
131}
132
133// Get all properties for a specific frame
134std::string Noise::PropertiesJSON(int64_t requested_frame) const {
135
136 // Generate JSON properties list
137 Json::Value root;
138 root["id"] = add_property_json("ID", 0.0, "string", Id(), NULL, -1, -1, true, requested_frame);
139 root["layer"] = add_property_json("Track", Layer(), "int", "", NULL, 0, 20, false, requested_frame);
140 root["start"] = add_property_json("Start", Start(), "float", "", NULL, 0, 1000 * 60 * 30, false, requested_frame);
141 root["end"] = add_property_json("End", End(), "float", "", NULL, 0, 1000 * 60 * 30, false, requested_frame);
142 root["duration"] = add_property_json("Duration", Duration(), "float", "", NULL, 0, 1000 * 60 * 30, true, requested_frame);
143
144 // Keyframes
145 root["level"] = add_property_json("Level", level.GetValue(requested_frame), "int", "", &level, 0, 100, false, requested_frame);
146
147 // Return formatted string
148 return root.toStyledString();
149}
Header file for all Exception classes.
Header file for Noise audio effect class.
float End() const
Get end position (in seconds) of clip (trim end of video)
Definition: ClipBase.h:111
float Start() const
Get start position (in seconds) of clip (trim start of video)
Definition: ClipBase.h:110
float Duration() const
Get the length of this clip (in seconds)
Definition: ClipBase.h:112
std::string Id() const
Get the Id of this clip object.
Definition: ClipBase.h:107
int Layer() const
Get layer of clip on timeline (lower number is covered by higher numbers)
Definition: ClipBase.h:109
Json::Value add_property_json(std::string name, float value, std::string type, std::string memo, const Keyframe *keyframe, float min_value, float max_value, bool readonly, int64_t requested_frame) const
Generate JSON for a property.
Definition: ClipBase.cpp:68
virtual Json::Value JsonValue() const
Generate Json::Value for this object.
Definition: EffectBase.cpp:92
virtual void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
Definition: EffectBase.cpp:127
EffectInfoStruct info
Information about the current effect.
Definition: EffectBase.h:87
Exception for invalid JSON.
Definition: Exceptions.h:206
A Keyframe is a collection of Point instances, which is used to vary a number or property over time.
Definition: KeyFrame.h:72
void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
Definition: KeyFrame.cpp:368
double GetValue(int64_t index) const
Get the value at a specific index.
Definition: KeyFrame.cpp:268
Json::Value JsonValue() const
Generate Json::Value for this object.
Definition: KeyFrame.cpp:335
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
const Json::Value stringToJson(const std::string value)
Definition: Json.cpp:34
bool has_video
Determines if this effect manipulates the image of a frame.
Definition: EffectBase.h:58
bool has_audio
Determines if this effect manipulates the audio of a frame.
Definition: EffectBase.h:59
std::string class_name
The class name of the effect.
Definition: EffectBase.h:54
std::string name
The name of the effect.
Definition: EffectBase.h:55
std::string description
The description of this effect and what it does.
Definition: EffectBase.h:56