From 1d1a608a5cc4352d6884a141024258285b423e7f Mon Sep 17 00:00:00 2001
From: Jonathan Thomas <jonathan@openshot.org>
Date: Tue, 17 Feb 2015 00:21:57 -0600
Subject: [PATCH] Added GetColorHex() function to the openshot::Color class,
 which returns a Hex string of a color at any frame number. Added new "hash"
 and "changed" properties to the openshot::Clip Properties JSON method, to
 help a UI determine if something has changed in the property values. Lastly,
 added new unit tests for both classes.

---
 include/Clip.h           |   1 +
 include/Color.h          |   6 +-
 src/Clip.cpp             |  19 +++++++
 src/Color.cpp            |  10 ++++
 src/examples/Example.cpp |   1 -
 tests/Clip_Tests.cpp     | 115 +++++++++++++++++++++++++++++++++++++++
 tests/Color_Tests.cpp    |  20 +++++++
 7 files changed, 170 insertions(+), 2 deletions(-)

diff --git a/include/Clip.h b/include/Clip.h
index 29194bb3..bd44cda1 100644
--- a/include/Clip.h
+++ b/include/Clip.h
@@ -91,6 +91,7 @@ namespace openshot {
 	class Clip : public ClipBase {
 	private:
 		bool waveform; ///< Should a waveform be used instead of the clip's image
+		string previous_properties; ///< This string contains the previous JSON properties
 
 		// Audio resampler (if time mapping)
 		AudioResampler *resampler;
diff --git a/include/Color.h b/include/Color.h
index faeb21a6..00d420f0 100644
--- a/include/Color.h
+++ b/include/Color.h
@@ -29,13 +29,14 @@
 #define OPENSHOT_COLOR_H
 
 #include "KeyFrame.h"
+#include <QtGui/QColor>
 
 namespace openshot {
 
 	/**
 	 * @brief This struct represents a color (used on the timeline and clips)
 	 *
-	 * Colors are represented by 4 curves, representing red, green, and blue.  The curves
+	 * Colors are represented by 3 curves, representing red, green, and blue.  The curves
 	 * can be used to animate colors over time.
 	 */
 	struct Color{
@@ -43,6 +44,9 @@ namespace openshot {
 		Keyframe green; ///<Curve representing the green value (0 - 65536)
 		Keyframe blue; ///<Curve representing the red blue (0 - 65536)
 
+		/// Get the HEX value of a color at a specific frame
+		string GetColorHex(int frame_number);
+
 		/// Get and Set JSON methods
 		string Json(); ///< Generate JSON string of this object
 		Json::Value JsonValue(); ///< Generate Json::JsonValue for this object
diff --git a/src/Clip.cpp b/src/Clip.cpp
index a28c870d..e902ddef 100644
--- a/src/Clip.cpp
+++ b/src/Clip.cpp
@@ -41,6 +41,7 @@ void Clip::init_settings()
 	scale = SCALE_FIT;
 	anchor = ANCHOR_CANVAS;
 	waveform = false;
+	previous_properties = "";
 
 	// Init scale curves
 	scale_x = Keyframe(1.0);
@@ -552,6 +553,24 @@ string Clip::PropertiesJSON(int requested_frame) {
 	root["volume"] = add_property_json("Volume", volume.GetValue(requested_frame), "float", "", volume.Contains(requested_point), volume.GetLength(), 0.0, 1.0, false);
 	root["time"] = add_property_json("Time", time.GetValue(requested_frame), "float", "", time.Contains(requested_point), time.GetLength(), 0.0, 1000 * 60 * 30, false);
 
+	// Keep track of settings string
+	stringstream properties;
+	properties << 0.0f << Position() << Layer() << Start() << End() << Duration() << gravity << scale << anchor << waveform <<
+			location_x.GetValue(requested_frame) << location_y.GetValue(requested_frame) << scale_x.GetValue(requested_frame) <<
+			scale_y.GetValue(requested_frame) << alpha.GetValue(requested_frame) << rotation.GetValue(requested_frame) <<
+			volume.GetValue(requested_frame) << time.GetValue(requested_frame);
+
+	// Have they changed since the previous call?
+	bool changed = false;
+	if (properties.str() != previous_properties) {
+		changed = true;
+		previous_properties = properties.str();
+	}
+
+	// Mark JSON as changed
+	root["changed"] = add_property_json("changed", changed, "bool", "", false, 0, 0, 1, false);
+	root["hash"] = add_property_json("hash", 0.0, "string", properties.str(), false, 0, 0, 1, false);
+
 	// Return formatted string
 	return root.toStyledString();
 }
diff --git a/src/Color.cpp b/src/Color.cpp
index b2b8403f..2fe0d0bf 100644
--- a/src/Color.cpp
+++ b/src/Color.cpp
@@ -29,6 +29,16 @@
 
 using namespace openshot;
 
+// Get the HEX value of a color at a specific frame
+string Color::GetColorHex(int frame_number) {
+
+	int r = red.GetInt(frame_number);
+	int g = green.GetInt(frame_number);
+	int b = blue.GetInt(frame_number);
+
+	return QColor( r,g,b ).name().toStdString();
+}
+
 // Generate JSON string of this object
 string Color::Json() {
 
diff --git a/src/examples/Example.cpp b/src/examples/Example.cpp
index 530ad661..d6da32df 100644
--- a/src/examples/Example.cpp
+++ b/src/examples/Example.cpp
@@ -42,7 +42,6 @@ using namespace tr1;
 
 int main(int argc, char* argv[])
 {
-
 	// Reader
 	FFmpegReader r9("/home/jonathan/Videos/sintel-1024-surround.mp4");
 	r9.Open();
diff --git a/tests/Clip_Tests.cpp b/tests/Clip_Tests.cpp
index 4b9133df..7f90bc9f 100644
--- a/tests/Clip_Tests.cpp
+++ b/tests/Clip_Tests.cpp
@@ -88,3 +88,118 @@ TEST(Clip_Basic_Gettings_and_Setters)
 	CHECK_CLOSE(3.5f, c1.Start(), 0.00001);
 	CHECK_CLOSE(10.5f, c1.End(), 0.00001);
 }
+
+TEST(Clip_Properties)
+{
+	// Create a empty clip
+	Clip c1;
+
+	// Change some properties
+	c1.Layer(1);
+	c1.Position(5.0);
+	c1.Start(3.5);
+	c1.End(10.5);
+	c1.alpha.AddPoint(1, 1.0);
+	c1.alpha.AddPoint(500, 0.0);
+
+	// Get properties JSON string at frame 1
+	string properties = c1.PropertiesJSON(1);
+
+	// Parse JSON string into JSON objects
+	Json::Value root;
+	Json::Reader reader;
+	bool success = reader.parse( properties, root );
+	if (!success)
+		// Raise exception
+		throw InvalidJSON("JSON could not be parsed (or is invalid)", "");
+
+	try
+	{
+		// Check for specific things
+		CHECK_CLOSE(1.0f, root["alpha"]["value"].asDouble(), 0.00001);
+		CHECK_EQUAL(true, root["alpha"]["keyframe"].asBool());
+		CHECK_EQUAL(true, root["changed"].asBool());
+
+	}
+	catch (exception e)
+	{
+		// Error parsing JSON (or missing keys)
+		throw InvalidJSON("JSON is invalid (missing keys or invalid data types)", "");
+	}
+
+
+	// Get properties JSON string at frame 250
+	properties = c1.PropertiesJSON(250);
+
+	// Parse JSON string into JSON objects
+	root.clear();
+	success = reader.parse( properties, root );
+	if (!success)
+		// Raise exception
+		throw InvalidJSON("JSON could not be parsed (or is invalid)", "");
+
+	try
+	{
+		// Check for specific things
+		CHECK_CLOSE(0.5f, root["alpha"]["value"].asDouble(), 0.001);
+		CHECK_EQUAL(false, root["alpha"]["keyframe"].asBool());
+		CHECK_EQUAL(true, root["changed"].asBool());
+
+	}
+	catch (exception e)
+	{
+		// Error parsing JSON (or missing keys)
+		throw InvalidJSON("JSON is invalid (missing keys or invalid data types)", "");
+	}
+
+
+	// Get properties JSON string at frame 250 (again)
+	properties = c1.PropertiesJSON(250); // again
+
+	// Parse JSON string into JSON objects
+	root.clear();
+	success = reader.parse( properties, root );
+	if (!success)
+		// Raise exception
+		throw InvalidJSON("JSON could not be parsed (or is invalid)", "");
+
+	try
+	{
+		// Check for specific things
+		CHECK_EQUAL(false, root["alpha"]["keyframe"].asBool());
+		CHECK_EQUAL(false, root["changed"].asBool());
+
+	}
+	catch (exception e)
+	{
+		// Error parsing JSON (or missing keys)
+		throw InvalidJSON("JSON is invalid (missing keys or invalid data types)", "");
+	}
+
+
+	// Get properties JSON string at frame 500
+	properties = c1.PropertiesJSON(500);
+
+	// Parse JSON string into JSON objects
+	root.clear();
+	success = reader.parse( properties, root );
+	if (!success)
+		// Raise exception
+		throw InvalidJSON("JSON could not be parsed (or is invalid)", "");
+
+	try
+	{
+		// Check for specific things
+		CHECK_CLOSE(0.0f, root["alpha"]["value"].asDouble(), 0.00001);
+		CHECK_EQUAL(true, root["alpha"]["keyframe"].asBool());
+		CHECK_EQUAL(true, root["changed"].asBool());
+
+	}
+	catch (exception e)
+	{
+		// Error parsing JSON (or missing keys)
+		throw InvalidJSON("JSON is invalid (missing keys or invalid data types)", "");
+	}
+
+}
+
diff --git a/tests/Color_Tests.cpp b/tests/Color_Tests.cpp
index ae0178e4..31ae59ff 100644
--- a/tests/Color_Tests.cpp
+++ b/tests/Color_Tests.cpp
@@ -61,3 +61,23 @@ TEST(Color_Animate_Colors)
 	CHECK_CLOSE(8504, c1.green.GetInt(500), 0.01);
 	CHECK_CLOSE(3002, c1.blue.GetInt(500), 0.01);
 }
+
+TEST(Color_HEX_Value)
+{
+	// Color
+	openshot::Color c;
+	c.red = openshot::Keyframe(0);
+	c.red.AddPoint(100, 255);
+	c.green = openshot::Keyframe(0);
+	c.green.AddPoint(100, 255);
+	c.blue = openshot::Keyframe(0);
+	c.blue.AddPoint(100, 255);
+
+	CHECK_EQUAL("#000000", c.GetColorHex(1));
+	CHECK_EQUAL("#818181", c.GetColorHex(50));
+	CHECK_EQUAL("#ffffff", c.GetColorHex(100));
+
+}
+
+
+