Added Delay and Echo effects

src/CMakeLists.txt

@@ -133,6 +133,8 @@ set(EFFECTS_SOURCES
   effects/Wave.cpp
   audio_effects/STFT.cpp
   audio_effects/Noise.cpp
+  audio_effects/Delay.cpp
+  audio_effects/Echo.cpp
   audio_effects/Distortion.cpp
   audio_effects/ParametricEQ.cpp
   audio_effects/Compressor.cpp

src/EffectInfo.cpp

@@ -91,6 +91,12 @@ EffectBase* EffectInfo::CreateEffect(std::string effect_type) {
 	else if(effect_type == "Noise")
 		return new Noise();
 
+	else if(effect_type == "Delay")
+		return new Delay();
+
+	else if(effect_type == "Echo")
+		return new Echo();
+
 	else if(effect_type == "Distortion")
 		return new Distortion();
 
@@ -147,6 +153,8 @@ Json::Value EffectInfo::JsonValue() {
 	root.append(Wave().JsonInfo());
 	/* Audio */
 	root.append(Noise().JsonInfo());
+	root.append(Delay().JsonInfo());
+	root.append(Echo().JsonInfo());
 	root.append(Distortion().JsonInfo());
 	root.append(ParametricEQ().JsonInfo());
 	root.append(Compressor().JsonInfo());

src/Effects.h

@@ -50,6 +50,8 @@
 
 /* Audio Effects */
 #include "audio_effects/Noise.h"
+#include "audio_effects/Delay.h"
+#include "audio_effects/Echo.h"
 #include "audio_effects/Distortion.h"
 #include "audio_effects/ParametricEQ.h"
 #include "audio_effects/Compressor.h"

src/audio_effects/Compressor.cpp

@@ -74,7 +74,7 @@ std::shared_ptr<openshot::Frame> Compressor::GetFrame(std::shared_ptr<openshot::
     const int num_samples = frame->audio->getNumSamples();
 
     mixed_down_input.setSize(1, num_samples);
-	inverse_sample_rate = 1.0f / frame->SampleRate(); //(float)getSampleRate();
+	inverse_sample_rate = 1.0f / frame->SampleRate();
     inverseE = 1.0f / M_E;
 
 	if ((bool)bypass.GetValue(frame_number))

src/audio_effects/Delay.cpp

@@ -0,0 +1,190 @@
+/**
+ * @file
+ * @brief Source file for Delay audio effect class
+ * @author 
+ *
+ * @ref License
+ */
+
+/* LICENSE
+ *
+ * Copyright (c) 2008-2019 OpenShot Studios, LLC
+ * <http://www.openshotstudios.com/>. This file is part of
+ * OpenShot Library (libopenshot), an open-source project dedicated to
+ * delivering high quality video editing and animation solutions to the
+ * world. For more information visit <http://www.openshot.org/>.
+ *
+ * OpenShot Library (libopenshot) is free software: you can redistribute it
+ * and/or modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * OpenShot Library (libopenshot) is distributed in the hope that it will be
+ * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "Delay.h"
+#include "Exceptions.h"
+
+using namespace openshot;
+
+/// Blank constructor, useful when using Json to load the effect properties
+Delay::Delay() : delay_time(1) {
+	// Init effect properties
+	init_effect_details();
+}
+
+// Default constructor
+Delay::Delay(Keyframe new_delay_time) : delay_time(new_delay_time)
+{
+	// Init effect properties
+	init_effect_details();
+}
+
+// Init effect settings
+void Delay::init_effect_details()
+{
+	/// Initialize the values of the EffectInfo struct.
+	InitEffectInfo();
+
+	/// Set the effect info
+	info.class_name = "Delay";
+	info.name = "Delay";
+	info.description = "Adjust the synchronism between the audio and video track.";
+	info.has_audio = true;
+	info.has_video = false;
+	initialized = false;
+}
+
+void Delay::setup(std::shared_ptr<openshot::Frame> frame)
+{
+	if (!initialized)
+	{
+		const float max_delay_time = 5;
+		delay_buffer_samples = (int)(max_delay_time * (float)frame->SampleRate()) + 1;
+
+		if (delay_buffer_samples < 1)
+			delay_buffer_samples = 1;
+
+		delay_buffer_channels = frame->audio->getNumChannels();
+		delay_buffer.setSize(delay_buffer_channels, delay_buffer_samples);
+		delay_buffer.clear();
+		delay_write_position = 0;
+		initialized = true;
+	}
+}
+
+// This method is required for all derived classes of EffectBase, and returns a
+// modified openshot::Frame object
+std::shared_ptr<openshot::Frame> Delay::GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number)
+{
+	const float delay_time_value = (float)delay_time.GetValue(frame_number)*(float)frame->SampleRate();
+	int local_write_position;
+
+	setup(frame);
+
+	for (int channel = 0; channel < frame->audio->getNumChannels(); channel++)
+	{
+		float *channel_data = frame->audio->getWritePointer(channel);
+        float *delay_data = delay_buffer.getWritePointer(channel);
+        local_write_position = delay_write_position;
+
+		for (auto sample = 0; sample < frame->audio->getNumSamples(); ++sample)
+		{
+			const float in = (float)(channel_data[sample]);
+            float out = 0.0f;
+
+            float read_position = fmodf((float)local_write_position - delay_time_value + (float)delay_buffer_samples, delay_buffer_samples);
+            int local_read_position = floorf(read_position);
+
+            if (local_read_position != local_write_position) 
+			{
+                float fraction = read_position - (float)local_read_position;
+                float delayed1 = delay_data[(local_read_position + 0)];
+                float delayed2 = delay_data[(local_read_position + 1) % delay_buffer_samples];
+                out = (float)(delayed1 + fraction * (delayed2 - delayed1));
+
+                channel_data[sample] = in + (out - in);
+				delay_data[local_write_position] = in;
+            }
+
+            if (++local_write_position >= delay_buffer_samples)
+                local_write_position -= delay_buffer_samples;
+		}
+	}
+
+    delay_write_position = local_write_position;
+
+	// return the modified frame
+	return frame;
+}
+
+// Generate JSON string of this object
+std::string Delay::Json() const {
+
+	// Return formatted string
+	return JsonValue().toStyledString();
+}
+
+// Generate Json::Value for this object
+Json::Value Delay::JsonValue() const {
+
+	// Create root json object
+	Json::Value root = EffectBase::JsonValue(); // get parent properties
+	root["type"] = info.class_name;
+	root["delay_time"] = delay_time.JsonValue();
+
+	// return JsonValue
+	return root;
+}
+
+// Load JSON string into this object
+void Delay::SetJson(const std::string value) {
+
+	// Parse JSON string into JSON objects
+	try
+	{
+		const Json::Value root = openshot::stringToJson(value);
+		// Set all values that match
+		SetJsonValue(root);
+	}
+	catch (const std::exception& e)
+	{
+		// Error parsing JSON (or missing keys)
+		throw InvalidJSON("JSON is invalid (missing keys or invalid data types)");
+	}
+}
+
+// Load Json::Value into this object
+void Delay::SetJsonValue(const Json::Value root) {
+
+	// Set parent data
+	EffectBase::SetJsonValue(root);
+
+	// Set data from Json (if key is found)
+	if (!root["delay_time"].isNull())
+		delay_time.SetJsonValue(root["delay_time"]);
+}
+
+// Get all properties for a specific frame
+std::string Delay::PropertiesJSON(int64_t requested_frame) const {
+
+	// Generate JSON properties list
+	Json::Value root;
+	root["id"] = add_property_json("ID", 0.0, "string", Id(), NULL, -1, -1, true, requested_frame);
+	root["layer"] = add_property_json("Track", Layer(), "int", "", NULL, 0, 20, false, requested_frame);
+	root["start"] = add_property_json("Start", Start(), "float", "", NULL, 0, 1000 * 60 * 30, false, requested_frame);
+	root["end"] = add_property_json("End", End(), "float", "", NULL, 0, 1000 * 60 * 30, false, requested_frame);
+	root["duration"] = add_property_json("Duration", Duration(), "float", "", NULL, 0, 1000 * 60 * 30, true, requested_frame);
+
+	// Keyframes
+	root["delay_time"] = add_property_json("Delay Time", delay_time.GetValue(requested_frame), "float", "", &delay_time, 0, 5, false, requested_frame);
+
+	// Return formatted string
+	return root.toStyledString();
+}

src/audio_effects/Delay.h

@@ -0,0 +1,110 @@
+/**
+ * @file
+ * @brief Header file for Delay audio effect class
+ * @author 
+ *
+ * @ref License
+ */
+
+/* LICENSE
+ *
+ * Copyright (c) 2008-2019 OpenShot Studios, LLC
+ * <http://www.openshotstudios.com/>. This file is part of
+ * OpenShot Library (libopenshot), an open-source project dedicated to
+ * delivering high quality video editing and animation solutions to the
+ * world. For more information visit <http://www.openshot.org/>.
+ *
+ * OpenShot Library (libopenshot) is free software: you can redistribute it
+ * and/or modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * OpenShot Library (libopenshot) is distributed in the hope that it will be
+ * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef OPENSHOT_DELAY_AUDIO_EFFECT_H
+#define OPENSHOT_DELAY_AUDIO_EFFECT_H
+
+#include "../EffectBase.h"
+
+#include "../Frame.h"
+#include "../Json.h"
+#include "../KeyFrame.h"
+
+#include <memory>
+#include <string>
+#include <random>
+#include <math.h>
+
+
+namespace openshot
+{
+
+	/**
+	 * @brief This class adds a delay into the audio
+	 *
+	 */
+	class Delay : public EffectBase
+	{
+	private:
+		/// Init effect settings
+		void init_effect_details();
+
+	public:
+		Keyframe delay_time;	
+
+		juce::AudioSampleBuffer delay_buffer;
+		int delay_buffer_samples;
+		int delay_buffer_channels;
+		int delay_write_position;
+		bool initialized;
+
+		/// Blank constructor, useful when using Json to load the effect properties
+		Delay();
+
+		/// Default constructor
+		Delay(Keyframe new_delay_time);
+
+		/// @brief This method is required for all derived classes of ClipBase, and returns a
+		/// new openshot::Frame object. All Clip keyframes and effects are resolved into
+		/// pixels.
+		///
+		/// @returns A new openshot::Frame object
+		/// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline.
+		std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) override { 
+			return GetFrame(std::make_shared<openshot::Frame>(), frame_number); 
+		}
+
+		void setup(std::shared_ptr<openshot::Frame> frame);
+
+		/// @brief This method is required for all derived classes of ClipBase, and returns a
+		/// modified openshot::Frame object
+		///
+		/// The frame object is passed into this method and used as a starting point (pixels and audio).
+		/// All Clip keyframes and effects are resolved into pixels.
+		///
+		/// @returns The modified openshot::Frame object
+		/// @param frame The frame object that needs the clip or effect applied to it
+		/// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline.
+		std::shared_ptr<openshot::Frame> GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
+
+		// Get and Set JSON methods
+		std::string Json() const override; ///< Generate JSON string of this object
+		void SetJson(const std::string value) override; ///< Load JSON string into this object
+		Json::Value JsonValue() const override; ///< Generate Json::Value for this object
+		void SetJsonValue(const Json::Value root) override; ///< Load Json::Value into this object
+
+		/// Get all properties for a specific frame (perfect for a UI to display the current state
+		/// of all properties at any time)
+		std::string PropertiesJSON(int64_t requested_frame) const override;
+	};
+
+}
+
+#endif

src/audio_effects/Distortion.h

@@ -49,7 +49,7 @@ namespace openshot
 {
 
 	/**
-	 * @brief This class adds a noise into the audio
+	 * @brief This class adds a distortion into the audio
 	 *
 	 */
 	class Distortion : public EffectBase