From e96bd5ba9897a3d3b461334f3a68cbfc78141f75 Mon Sep 17 00:00:00 2001
From: Jonathan Thomas <Jonathan.Oomph@gmail.com>
Date: Wed, 3 Oct 2012 01:55:24 -0500
Subject: [PATCH] Added the initial timeline and clip classes, with some of the
 initial curves and constructors.

---
 include/Clip.h     | 95 ++++++++++++++++++++++++++++++++++++++++++++++
 include/Fraction.h |  2 +-
 include/KeyFrame.h |  3 ++
 include/OpenShot.h |  2 +
 include/Point.h    |  3 ++
 include/Timeline.h | 45 ++++++++++++++++++++++
 src/CMakeLists.txt |  4 +-
 src/Clip.cpp       | 33 ++++++++++++++++
 src/KeyFrame.cpp   |  9 +++++
 src/Point.cpp      | 10 +++++
 src/Timeline.cpp   | 17 +++++++++
 src/openshot.i     |  4 ++
 12 files changed, 225 insertions(+), 2 deletions(-)
 create mode 100644 include/Clip.h
 create mode 100644 include/Timeline.h
 create mode 100644 src/Clip.cpp
 create mode 100644 src/Timeline.cpp

diff --git a/include/Clip.h b/include/Clip.h
new file mode 100644
index 00000000..0fe2d415
--- /dev/null
+++ b/include/Clip.h
@@ -0,0 +1,95 @@
+#ifndef OPENSHOT_CLIP_H
+#define OPENSHOT_CLIP_H
+
+/**
+ * \file
+ * \brief Header file for Clip class
+ * \author Copyright (c) 2011 Jonathan Thomas
+ */
+
+#include "KeyFrame.h"
+
+using namespace std;
+using namespace openshot;
+
+namespace openshot {
+
+	/**
+	 * This enumeration determines how clips are aligned to their parent container.
+	 */
+	enum GravityType
+	{
+		TOP_LEFT,
+		TOP,
+		TOP_RIGHT,
+		LEFT,
+		CENTER,
+		RIGHT,
+		BOTTOM_LEFT,
+		BOTTOM,
+		BOTTOM_RIGHT
+	};
+
+	/**
+	 * This enumeration determines how clips are scaled to fit their parent container.
+	 */
+	enum ScaleType
+	{
+		CROP,
+		FIT,
+		STRETCH,
+		NONE
+	};
+
+	/**
+	 * This enumeration determines what parent a clip should be aligned to.
+	 */
+	enum AnchorType
+	{
+		CANVAS,
+		VIEWPORT
+	};
+
+	/**
+	 * \brief This class represents a clip
+	 *
+	 * Each image, video, or audio file is represented on a layer as a clip.  A clip has many
+	 * properties that affect how it behaves on the timeline, such as its size, position,
+	 * transparency, rotation, speed, volume, etc...
+	 */
+	class Clip {
+	private:
+		float position; ///<The position of the timeline where this clip should start playing
+		int layer; ///<The layer this clip is on. Lower clips are covered up by higher clips.
+		float start; ///<The position in seconds to start playing (used to trim the beginning of a clip)
+		float end; ///<The position in seconds to end playing (used to trim the ending of a clip)
+
+		GravityType gravity; ///<The gravity of a clip determines where it snaps to it's parent
+		ScaleType scale; ///<The scale determines how a clip should be resized to fit it's parent
+		AnchorType anchor; ///<The anchor determines what parent a clip should snap to
+
+		// Scale and Location curves
+		Keyframe scale_x; ///<Curve representing the horizontal scaling (0 to 100)
+		Keyframe scale_y; ///<Curve representing the vertical scaling (0 to 100)
+		Keyframe location_x; ///<Curve representing the relative X position based on the gravity (-100 to 100)
+		Keyframe location_y; ///<Curve representing the relative Y position based on the gravity (-100 to 100)
+
+		// Alpha and Rotation curves
+		Keyframe alpha; ///<Curve representing the alpha or transparency (0 to 100)
+		Keyframe rotation; ///<Curve representing the rotation (0 to 360)
+
+		// Time and Volume curves
+		Keyframe time; ///<Curve representing the frames over time to play (used for speed and direction of video)
+		Keyframe volume; ///<Curve representing the volume (0 to 100)
+
+	public:
+
+		/// Default Constructor
+		Clip();
+
+	};
+
+
+}
+
+#endif
diff --git a/include/Fraction.h b/include/Fraction.h
index b18c1bb6..a5974cd7 100644
--- a/include/Fraction.h
+++ b/include/Fraction.h
@@ -10,7 +10,7 @@
 namespace openshot {
 
 	/**
-	 * \brief The class represents a fraction
+	 * \brief This class represents a fraction
 	 *
 	 * Fractions are often used in video editing to represent ratios and rates, for example:
 	 * pixel ratios, frames per second, timebase, and other common ratios.  Fractions are preferred
diff --git a/include/KeyFrame.h b/include/KeyFrame.h
index 6993ba57..787cdc44 100644
--- a/include/KeyFrame.h
+++ b/include/KeyFrame.h
@@ -70,6 +70,9 @@ namespace openshot {
 		/// Default constructor for the Keyframe class
 		Keyframe();
 
+		/// Constructor which sets the default point & coordinate at X=0
+		Keyframe(float value);
+
 		/// Add a new point on the key-frame.  Each point has a primary coordinate, a left handle, and a right handle.
 		void AddPoint(Point p);
 
diff --git a/include/OpenShot.h b/include/OpenShot.h
index 614d7258..01fcca27 100644
--- a/include/OpenShot.h
+++ b/include/OpenShot.h
@@ -28,6 +28,7 @@
 #include "AudioBufferSource.h"
 #include "AudioResampler.h"
 #include "Cache.h"
+#include "Clip.h"
 #include "Coordinate.h"
 #include "Exceptions.h"
 #include "FileReaderBase.h"
@@ -42,6 +43,7 @@
 #include "KeyFrame.h"
 #include "Player.h"
 #include "Point.h"
+#include "Timeline.h"
 
 
 #endif
diff --git a/include/Point.h b/include/Point.h
index 6e32a88b..d691907c 100644
--- a/include/Point.h
+++ b/include/Point.h
@@ -59,6 +59,9 @@ namespace openshot
 		Interpolation_Type interpolation;	///< This is the interpolation mode
 		Handle_Type handle_type; 			///< This is the handle mode
 
+		/// Constructor which creates a single coordinate at X=0
+		Point(float y);
+
 		/// Constructor which also creates a Point and sets the X and Y of the Point.
 		Point(float x, float y);
 
diff --git a/include/Timeline.h b/include/Timeline.h
new file mode 100644
index 00000000..cda127b3
--- /dev/null
+++ b/include/Timeline.h
@@ -0,0 +1,45 @@
+#ifndef OPENSHOT_TIMELINE_H
+#define OPENSHOT_TIMELINE_H
+
+/**
+ * \file
+ * \brief Header file for Timeline class
+ * \author Copyright (c) 2011 Jonathan Thomas
+ */
+
+#include "KeyFrame.h"
+
+using namespace std;
+using namespace openshot;
+
+namespace openshot {
+
+	/**
+	 * \brief This class represents a timeline
+	 *
+	 * The timeline is one of the most important features of a video editor, and controls all
+	 * aspects of how video, image, and audio clips are combined together, and how the final
+	 * video output will be rendered.  It has a collection of layers and clips, that arrange,
+	 * sequence, and generate the final video output.
+	 */
+	class Timeline {
+	private:
+		int canvas_width; ///<Width of the canvas
+		int canvas_height; ///<Height of the canvas
+
+		Keyframe viewport_scale; ///<Curve representing the scale of the viewport (0 to 100)
+		Keyframe viewport_x; ///<Curve representing the x coordinate for the viewport
+		Keyframe viewport_y; ///<Curve representing the y coordinate for the viewport
+
+	public:
+
+		/// Default Constructor for the timeline (which sets the canvas width and height)
+		Timeline(int width, int height);
+
+
+	};
+
+
+}
+
+#endif
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index 75bed08c..ee3b5109 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -43,6 +43,7 @@ add_library(openshot SHARED
 			AudioBufferSource.cpp
 			AudioResampler.cpp
 			Cache.cpp
+			Clip.cpp
 			Coordinate.cpp
 			FileReaderBase.cpp
 			FileWriterBase.cpp
@@ -55,7 +56,8 @@ add_library(openshot SHARED
 			KeyFrame.cpp
 			ImageReader.cpp
 			Player.cpp
-			Point.cpp)
+			Point.cpp
+			Timeline.cpp)
 			
 # Set SONAME and other library properties
 set_target_properties(openshot
diff --git a/src/Clip.cpp b/src/Clip.cpp
new file mode 100644
index 00000000..bf6c6cff
--- /dev/null
+++ b/src/Clip.cpp
@@ -0,0 +1,33 @@
+#include "../include/Clip.h"
+
+using namespace openshot;
+
+// Default Constructor for a clip
+Clip::Clip()
+{
+	// Init clip settings
+	position = 0.0;
+	layer = 0;
+	start = 0.0;
+	end = 0.0;
+	gravity = CENTER;
+	scale = FIT;
+	anchor = CANVAS;
+
+	// Init scale curves
+	scale_x = Keyframe(100.0);
+	scale_y = Keyframe(100.0);
+
+	// Init location curves
+	location_x = Keyframe(0.0);
+	location_y = Keyframe(0.0);
+
+	// Init alpha & rotation
+	alpha = Keyframe(100.0);
+	rotation = Keyframe(0.0);
+
+	// Init time & volume
+	time = Keyframe(0.0);
+	volume = Keyframe(100.0);
+
+}
diff --git a/src/KeyFrame.cpp b/src/KeyFrame.cpp
index cbaebf52..a9cafb2e 100644
--- a/src/KeyFrame.cpp
+++ b/src/KeyFrame.cpp
@@ -33,6 +33,15 @@ void Keyframe::ReorderPoints() {
 	}
 }
 
+// Constructor which sets the default point & coordinate at X=0
+Keyframe::Keyframe(float value) : Auto_Handle_Percentage(0.4f) {
+	// Init the factorial table, needed by bezier curves
+	CreateFactorialTable();
+
+	// Add initial point
+	AddPoint(Point(value));
+}
+
 /// Keyframe constructor
 Keyframe::Keyframe() : Auto_Handle_Percentage(0.4f) {
 	// Init the factorial table, needed by bezier curves
diff --git a/src/Point.cpp b/src/Point.cpp
index d49bb481..4111f791 100644
--- a/src/Point.cpp
+++ b/src/Point.cpp
@@ -9,6 +9,16 @@
 using namespace std;
 using namespace openshot;
 
+// Constructor which creates a single coordinate at X=0
+Point::Point(float y) :
+	interpolation(BEZIER), handle_type(AUTO) {
+	// set new coorinate
+	co = Coordinate(0, y);
+
+	// set handles
+	Initialize_Handles();
+}
+
 Point::Point(float x, float y) :
 	interpolation(BEZIER), handle_type(AUTO) {
 	// set new coorinate
diff --git a/src/Timeline.cpp b/src/Timeline.cpp
new file mode 100644
index 00000000..be3d185d
--- /dev/null
+++ b/src/Timeline.cpp
@@ -0,0 +1,17 @@
+#include "../include/Timeline.h"
+
+using namespace openshot;
+
+// Default Constructor for the timeline (which sets the canvas width and height)
+Timeline::Timeline(int width, int height)
+{
+	// Init canvas size
+	canvas_width = width;
+	canvas_height = height;
+
+	// Init viewport size (curve based, because it can be animated)
+	viewport_scale = Keyframe(100.0);
+	viewport_x = Keyframe(0.0);
+	viewport_y = Keyframe(0.0);
+
+}
diff --git a/src/openshot.i b/src/openshot.i
index 0d9eb44f..76c3fb52 100644
--- a/src/openshot.i
+++ b/src/openshot.i
@@ -6,6 +6,7 @@
 %{
 
 #include "../include/Cache.h"
+#include "../include/Clip.h"
 #include "../include/Coordinate.h"
 #include "../include/Exceptions.h"
 #include "../include/FileReaderBase.h"
@@ -20,6 +21,7 @@
 #include "../include/Player.h"
 #include "../include/Point.h"
 #include "../include/KeyFrame.h"
+#include "../include/Timeline.h"
 %}
 
 /* Use standard exception handling  */
@@ -89,6 +91,7 @@
 %}
 
 %include "../include/Cache.h"
+%include "../include/Clip.h"
 %include "../include/Coordinate.h"
 %include "../include/Exceptions.h"
 %include "../include/FileReaderBase.h"
@@ -103,6 +106,7 @@
 %include "../include/Player.h"
 %include "../include/Point.h"
 %include "../include/KeyFrame.h"
+%include "../include/Timeline.h"