Added support for Date() conversion to timecode and adding Date()

Author: Dimitri Tarassenko

README.md

@@ -1,10 +1,14 @@
 # timecode.js
 
-This is a javascript module for manipulating SMPTE timecode.
+This is a JavaScript module for manipulating SMPTE timecodes.
 
 It is primarily based on [pytimecode](http://code.google.com/p/pytimecode/).
 
-Theoretically it supports 60, 59.94, 50, 30, 29.97, 25, 24, 23.98 frame rates as well as milliseconds, although only 29.97 (drop and non-drop) and 23.98 have been tested.  Timecodes can be created from a number representing the frame count or a string in the form "hh:mm:ss:ff".
+Theoretically it supports 60, 59.94, 50, 30, 29.97, 25, 24, 23.98 frame rates as well as milliseconds, although only 29.97 (drop and non-drop) and 23.98 have been tested.  Timecodes can be created from: 
+
+- a number representing the frame count
+- a string in the form "hh:mm:ss:ff"
+- a Date() object (year, months and day part are ignored)
 
 ## Usage
 
@@ -15,7 +19,13 @@ Theoretically it supports 60, 59.94, 50, 30, 29.97, 25, 24, 23.98 frame rates as
     > tc.toString();
     '01:02:03:04'
 
+    > var d = new Date();
+    > var tc2 = timecode.init({framerate: "29.97", timecode: d, drop_frame:true});
+    > tc2.add( new Date(0,0,0,0,1,30) );
+    > tc2.toString();
+    '17:31:57;22'
+
 ## Testing
 
     $ npm install -g nodeunit
-    $ nodeunit test
+    $ npm test

lib/timecode.js

@@ -46,6 +46,10 @@ var Timecode = {
 			this.frame_count = timecode;
 			this.frameNumberToTimecode();
 		}
+		else if (timecode instanceof Date) {
+			this.frame_count = this.dateToFrameNumber(timecode);
+			this.frameNumberToTimecode();
+		}
 		else {
 			// throw an error
 		}
@@ -104,8 +108,8 @@ var Timecode = {
 		var timecode, i, frame_count;
 		for (i = 0; i < timecodes.length; i += 1) {
 			timecode = timecodes[i];
-			// if a string or number is given, convert it to a timecode
-			if ((typeof timecode === "string") || (typeof timecode === "number")) {
+			// if a string, number or Date is given, convert it to a timecode
+			if ((typeof timecode === "string") || (typeof timecode === "number") || (timecode instanceof Date)) {
 				timecode = Timecode.init({
 					framerate: this.framerate,
 					timecode: timecode,
@@ -195,6 +199,17 @@ var Timecode = {
 			total_minutes = (hours * 60) + minutes,
 			frame_number = ((hour_frames * hours) + (minute_frames * minutes) + (this.int_framerate * seconds) + frames) - (drop_frames * (total_minutes - Math.floor(total_minutes / 10)));
 		return frame_number;
+	},
+
+	/**
+	 * Converts the hour, minute, second, millisecond part of Date() object to the number of
+	 * frames using the current framerate
+	 * @param dt {Date}
+	 * @returns {number}
+	 */
+	dateToFrameNumber: function(dt) {
+		var midnight = new Date( dt.getFullYear(), dt.getMonth(), dt.getDate(),0,0,0 );
+		return Math.floor(((dt-midnight)/1000)*this.framerate);
 	}
 };
 

package.json

@@ -1,9 +1,9 @@
 {
   "name": "timecode",
-  "description": "A javascript module for manipulating SMPTE tiemcode.",
+  "description": "A JavaScript module for manipulating SMPTE timecodes",
   "homepage": "https://github.com/reidransom/timecode.js",
   "main": "./lib/timecode.js",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "author": {
     "name": "Reid Ransom",
     "email": "reid@reidransom.com",
@@ -17,6 +17,9 @@
     "type": "git",
     "url": "https://github.com/reidransom/timecode.js.git"
   },
+  "scripts": {
+    "test": "nodeunit"
+  },
   "devDependencies": {
     "nodeunit": "*"
   }

test/test-timecode.js

@@ -148,6 +148,29 @@ exports["Timecode"] = function(test) {
     //console.log(tc.frameNumberToDropFrameTimecode(108000));
     //console.log(tc.dropFrameTimecodeToFrameNumber([1, 0, 3, 18]));
 
+    // Tests for Date() object features.
+    var d = new Date(0,0,0,0,8,30,200);
+    tcd = timecode.init({
+        framerate: "29.97",
+        timecode: d,
+        drop_frame: true
+    });
+    test.equal("00:08:30;06", tcd.toString());
+    tcd = timecode.init({
+        framerate: "29.97",
+        timecode: new Date(0,0,0,0,8,0,0),
+        drop_frame: true
+    });
+    test.equal("00:07:59;29", tcd.toString());
+    tcd = timecode.init({
+        framerate: "29.97",
+        timecode: new Date(0,0,0,0,8,0,30),
+        drop_frame: true
+    });
+    test.equal("00:08:00;02", tcd.toString());
+    tcd.add(new Date(0,0,0,0,0,60));
+    test.equal("00:09:00;02", tcd.toString());
+    
     test.done();