Rename libmusictime libtimecode (consistent with already used namespace "Timecode").

Move BBT_Time to libtimecode.


git-svn-id: svn://localhost/ardour2/branches/3.0@8271 d708f5d6-7413-0410-9779-e7cbd77b26cf

4 files changed, 635 insertions, 0 deletions

diff --git a/libs/timecode/src/time.cc b/libs/timecode/src/time.cc
new file mode 100644
index 0000000000..c87662a18c
--- /dev/null
+++ b/libs/timecode/src/time.cc
@@ -0,0 +1,435 @@
+/*
+	Copyright (C) 2006 Paul Davis
+	
+	This program 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 2 of the License, or
+	(at your option) any later version.
+	
+	This program 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 General Public License
+	for more details.
+	
+	You should have received a copy of the GNU General Public License along
+	with this program; if not, write to the Free Software Foundation, Inc.,
+	675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+#define Timecode_IS_AROUND_ZERO( sm ) (!(sm).frames && !(sm).seconds && !(sm).minutes && !(sm).hours)
+#define Timecode_IS_ZERO( sm ) (!(sm).frames && !(sm).seconds && !(sm).minutes && !(sm).hours && !(sm.subframes))
+
+#include <math.h>
+
+#include "timecode/time.h"
+
+namespace Timecode {
+
+float Time::default_rate = 30.0;
+
+
+/** Increment @a timecode by exactly one frame (keep subframes value).
+ * Realtime safe.
+ * @return true if seconds wrap.
+ */
+Wrap
+increment( Time& timecode, uint32_t subframes_per_frame )
+{
+	Wrap wrap = NONE;
+
+	if (timecode.negative) {
+		if (Timecode_IS_AROUND_ZERO(timecode) && timecode.subframes) {
+			// We have a zero transition involving only subframes
+			timecode.subframes = subframes_per_frame - timecode.subframes;
+			timecode.negative = false;
+			return SECONDS;
+		}
+    
+		timecode.negative = false;
+		wrap = decrement( timecode, subframes_per_frame );
+		if (!Timecode_IS_ZERO( timecode )) {
+			timecode.negative = true;
+		}
+		return wrap;
+	}
+
+	switch ((int)ceil(timecode.rate)) {
+	case 24:
+		if (timecode.frames == 23) {
+			timecode.frames = 0;
+			wrap = SECONDS;
+		}
+		break;
+	case 25:
+		if (timecode.frames == 24) {
+			timecode.frames = 0;
+			wrap = SECONDS;
+		}
+		break;
+	case 30:
+	        if (timecode.drop) {
+		       if (timecode.frames == 29) {
+			      if ( ((timecode.minutes + 1) % 10) && (timecode.seconds == 59) ) {
+				     timecode.frames = 2;
+			      }
+			      else {
+				     timecode.frames = 0;
+			      }
+			      wrap = SECONDS;
+		       }
+		} else {
+
+		       if (timecode.frames == 29) {
+			      timecode.frames = 0;
+			      wrap = SECONDS;
+		       }
+		}
+		break;
+	case 60:
+	        if (timecode.frames == 59) {
+		        timecode.frames = 0;
+			wrap = SECONDS;
+		}
+		break;
+	}
+  
+	if (wrap == SECONDS) {
+		if (timecode.seconds == 59) {
+			timecode.seconds = 0;
+			wrap = MINUTES;
+			if (timecode.minutes == 59) {
+				timecode.minutes = 0;
+				wrap = HOURS;
+				timecode.hours++;
+			} else {
+				timecode.minutes++;
+			}
+		} else {
+			timecode.seconds++;
+		}
+	} else {
+		timecode.frames++;
+	}
+  
+	return wrap;
+}
+
+
+/** Decrement @a timecode by exactly one frame (keep subframes value)
+ * Realtime safe.
+ * @return true if seconds wrap. */
+Wrap
+decrement( Time& timecode, uint32_t subframes_per_frame )
+{
+	Wrap wrap = NONE;
+  
+  
+	if (timecode.negative || Timecode_IS_ZERO(timecode)) {
+		timecode.negative = false;
+		wrap = increment( timecode, subframes_per_frame );
+		timecode.negative = true;
+		return wrap;
+	} else if (Timecode_IS_AROUND_ZERO(timecode) && timecode.subframes) {
+		// We have a zero transition involving only subframes
+		timecode.subframes = subframes_per_frame - timecode.subframes;
+		timecode.negative = true;
+		return SECONDS;
+	}
+  
+	switch ((int)ceil(timecode.rate)) {
+	case 24:
+		if (timecode.frames == 0) {
+			timecode.frames = 23;
+			wrap = SECONDS;
+		}
+		break;
+	case 25:
+		if (timecode.frames == 0) {
+			timecode.frames = 24;
+			wrap = SECONDS;
+		}
+		break;
+	case 30:
+	        if (timecode.drop) {
+		        if ((timecode.minutes % 10) && (timecode.seconds == 0)) {
+			        if (timecode.frames <= 2) {
+				        timecode.frames = 29;
+					wrap = SECONDS;
+				}
+			} else if (timecode.frames == 0) {
+			        timecode.frames = 29;
+				wrap = SECONDS;
+			}
+			
+		} else {
+		        if (timecode.frames == 0) {
+			        timecode.frames = 29;
+				wrap = SECONDS;
+			}
+		}
+		break;
+	case 60:
+	        if (timecode.frames == 0) {
+		        timecode.frames = 59;
+			wrap = SECONDS;
+		}
+		break;
+	}
+  
+	if (wrap == SECONDS) {
+		if (timecode.seconds == 0) {
+			timecode.seconds = 59;
+			wrap = MINUTES;
+			if (timecode.minutes == 0) {
+				timecode.minutes = 59;
+				wrap = HOURS;
+				timecode.hours--;
+			}
+			else {
+				timecode.minutes--;
+			}
+		} else {
+			timecode.seconds--;
+		}
+	} else {
+		timecode.frames--;
+	}
+  
+	if (Timecode_IS_ZERO( timecode )) {
+		timecode.negative = false;
+	}
+  
+	return wrap;
+}
+
+
+/** Go to lowest absolute subframe value in this frame (set to 0 :-) ) */
+void
+frames_floor( Time& timecode )
+{
+	timecode.subframes = 0;
+	if (Timecode_IS_ZERO(timecode)) {
+		timecode.negative = false;
+	}
+}
+
+
+/** Increment @a timecode by one subframe */
+Wrap
+increment_subframes( Time& timecode, uint32_t subframes_per_frame )
+{
+	Wrap wrap = NONE;
+  
+	if (timecode.negative) {
+		timecode.negative = false;
+		wrap = decrement_subframes( timecode, subframes_per_frame );
+		if (!Timecode_IS_ZERO(timecode)) {
+			timecode.negative = true;
+		}
+		return wrap;
+	}
+  
+	timecode.subframes++;
+	if (timecode.subframes >= subframes_per_frame) {
+		timecode.subframes = 0;
+		increment( timecode, subframes_per_frame );
+		return FRAMES;
+	}
+	return NONE;
+}
+
+
+/** Decrement @a timecode by one subframe */
+Wrap
+decrement_subframes( Time& timecode, uint32_t subframes_per_frame )
+{
+	Wrap wrap = NONE;
+  
+	if (timecode.negative) {
+		timecode.negative = false;
+		wrap = increment_subframes( timecode, subframes_per_frame );
+		timecode.negative = true;
+		return wrap;
+	}
+  
+	if (timecode.subframes <= 0) {
+		timecode.subframes = 0;
+		if (Timecode_IS_ZERO(timecode)) {
+			timecode.negative = true;
+			timecode.subframes = 1;
+			return FRAMES;
+		} else {
+			decrement( timecode, subframes_per_frame );
+			timecode.subframes = 79;
+			return FRAMES;
+		}
+	} else {
+		timecode.subframes--;
+		if (Timecode_IS_ZERO(timecode)) {
+			timecode.negative = false;
+		}
+		return NONE;
+	}
+}
+
+
+/** Go to next whole second (frames == 0 or frames == 2) */
+Wrap
+increment_seconds( Time& timecode, uint32_t subframes_per_frame )
+{
+	Wrap wrap = NONE;
+  
+	// Clear subframes
+	frames_floor( timecode );
+  
+	if (timecode.negative) {
+		// Wrap second if on second boundary
+		wrap = increment(timecode, subframes_per_frame);
+		// Go to lowest absolute frame value
+		seconds_floor( timecode );
+		if (Timecode_IS_ZERO(timecode)) {
+			timecode.negative = false;
+		}
+	} else {
+		// Go to highest possible frame in this second
+	  switch ((int)ceil(timecode.rate)) {
+		case 24:
+			timecode.frames = 23;
+			break;
+		case 25:
+			timecode.frames = 24;
+			break;
+		case 30:
+			timecode.frames = 29;
+			break;
+		case 60:
+			timecode.frames = 59;
+			break;
+		}
+    
+		// Increment by one frame
+		wrap = increment( timecode, subframes_per_frame );
+	}
+  
+	return wrap;
+}
+
+
+/** Go to lowest (absolute) frame value in this second
+ * Doesn't care about positive/negative */
+void
+seconds_floor( Time& timecode )
+{
+	// Clear subframes
+	frames_floor( timecode );
+  
+	// Go to lowest possible frame in this second
+	switch ((int)ceil(timecode.rate)) {
+	case 24:
+	case 25:
+	case 30:
+	case 60:
+	        if (!(timecode.drop)) {
+		        timecode.frames = 0;
+		} else {
+
+		        if ((timecode.minutes % 10) && (timecode.seconds == 0)) {
+			        timecode.frames = 2;
+			} else {
+			        timecode.frames = 0;
+			}
+		}
+		break;
+	}
+  
+	if (Timecode_IS_ZERO(timecode)) {
+		timecode.negative = false;
+	}
+}
+
+
+/** Go to next whole minute (seconds == 0, frames == 0 or frames == 2) */
+Wrap
+increment_minutes( Time& timecode, uint32_t subframes_per_frame )
+{
+	Wrap wrap = NONE;
+  
+	// Clear subframes
+	frames_floor( timecode );
+  
+	if (timecode.negative) {
+		// Wrap if on minute boundary
+		wrap = increment_seconds( timecode, subframes_per_frame );
+		// Go to lowest possible value in this minute
+		minutes_floor( timecode );
+	} else {
+		// Go to highest possible second
+		timecode.seconds = 59;
+		// Wrap minute by incrementing second
+		wrap = increment_seconds( timecode, subframes_per_frame );
+	}
+  
+	return wrap;
+}
+
+
+/** Go to lowest absolute value in this minute */
+void
+minutes_floor( Time& timecode )
+{
+	// Go to lowest possible second
+	timecode.seconds = 0;
+	// Go to lowest possible frame
+	seconds_floor( timecode );
+
+	if (Timecode_IS_ZERO(timecode)) {
+		timecode.negative = false;
+	}
+}
+
+
+/** Go to next whole hour (minute = 0, second = 0, frame = 0) */
+Wrap
+increment_hours( Time& timecode, uint32_t subframes_per_frame )
+{
+	Wrap wrap = NONE;
+  
+	// Clear subframes
+	frames_floor(timecode);
+  
+	if (timecode.negative) {
+		// Wrap if on hour boundary
+		wrap = increment_minutes( timecode, subframes_per_frame );
+		// Go to lowest possible value in this hour
+		hours_floor( timecode );
+	} else {
+		timecode.minutes = 59;
+		wrap = increment_minutes( timecode, subframes_per_frame );
+	}
+  
+	return wrap;
+}
+
+
+/** Go to lowest absolute value in this hour */
+void
+hours_floor( Time& timecode )
+{
+	timecode.minutes = 0;
+	timecode.seconds = 0;
+	timecode.frames = 0;
+	timecode.subframes = 0;
+  
+	if (Timecode_IS_ZERO(timecode)) {
+		timecode.negative = false;
+	}
+}
+
+
+} // namespace Timecode
+
+std::ostream& 
+operator<<(std::ostream& ostr, const Timecode::Time& t) 
+{
+	return t.print (ostr);
+}
diff --git a/libs/timecode/timecode/bbt_time.h b/libs/timecode/timecode/bbt_time.h
new file mode 100644
index 0000000000..5dda3bfcbf
--- /dev/null
+++ b/libs/timecode/timecode/bbt_time.h
@@ -0,0 +1,72 @@
+/*
+    Copyright (C) 2002-2009 Paul Davis
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program 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 General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+*/
+
+#ifndef __timecode_bbt_time_h__
+#define __timecode_bbt_time_h__
+
+#include <ostream>
+#include <stdint.h>
+#include <iomanip>
+
+namespace Timecode {
+
+/** Bar, Beat, Tick Time (i.e. Tempo-Based Time) */
+struct BBT_Time {
+	uint32_t bars;
+	uint32_t beats;
+	uint32_t ticks;
+	
+	BBT_Time ()
+		: bars (1), beats (1), ticks (0) {}
+	
+	BBT_Time (uint32_t ba, uint32_t be, uint32_t t)
+		: bars (ba), beats (be), ticks (t) {}
+	
+	bool operator< (const BBT_Time& other) const {
+		return bars < other.bars ||
+			(bars == other.bars && beats < other.beats) ||
+			(bars == other.bars && beats == other.beats && ticks < other.ticks);
+	}
+	
+	bool operator== (const BBT_Time& other) const {
+		return bars == other.bars && beats == other.beats && ticks == other.ticks;
+	}
+};
+	
+}
+
+inline std::ostream&
+operator<< (std::ostream& o, const Timecode::BBT_Time& bbt)
+{
+	o << bbt.bars << '|' << bbt.beats << '|' << bbt.ticks;
+	return o;
+}
+
+inline std::ostream&
+print_padded (std::ostream& o, const Timecode::BBT_Time& bbt)
+{
+	o << std::setfill ('0') << std::right
+	  << std::setw (3) << bbt.bars << "|"
+	  << std::setw (2) << bbt.beats << "|"
+	  << std::setw (4) << bbt.ticks;
+
+	return o;
+}
+
+#endif /* __timecode_bbt_time_h__ */
diff --git a/libs/timecode/timecode/time.h b/libs/timecode/timecode/time.h
new file mode 100644
index 0000000000..6b04b70cc3
--- /dev/null
+++ b/libs/timecode/timecode/time.h
@@ -0,0 +1,82 @@
+/*
+	Copyright (C) 2006 Paul Davis
+	
+	This program 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 2 of the License, or
+	(at your option) any later version.
+	
+	This program 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 General Public License
+	for more details.
+	
+	You should have received a copy of the GNU General Public License along
+	with this program; if not, write to the Free Software Foundation, Inc.,
+	675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+#ifndef __ardour_timecode_h__
+#define __ardour_timecode_h__
+
+#include <ostream>
+#include <inttypes.h>
+
+namespace Timecode {
+
+enum Wrap {
+	NONE = 0,
+	FRAMES,
+	SECONDS,
+	MINUTES,
+	HOURS
+};
+
+struct Time {
+	bool       negative;
+	uint32_t   hours;
+	uint32_t   minutes;
+	uint32_t   seconds;
+	uint32_t   frames;        ///< Timecode frames (not audio samples)
+	uint32_t   subframes;     ///< Typically unused
+	float      rate;          ///< Frame rate of this Time
+	static float default_rate;///< Rate to use for default constructor
+	bool       drop;          ///< Whether this Time uses dropframe Timecode
+
+	Time(float a_rate = default_rate) {
+		negative = false;
+		hours = 0;
+		minutes = 0;
+		seconds = 0;
+		frames = 0;
+		subframes = 0;
+		rate = a_rate;
+	}
+
+        std::ostream& print (std::ostream& ostr) const {
+		if (negative) {
+			ostr << '-';
+		}
+		ostr << hours << ':' << minutes << ':' << seconds << ':' << frames << '.' << subframes << " @" << rate << (drop ? " drop" : " nondrop");
+		return ostr;
+	}
+
+};
+
+Wrap increment( Time& timecode, uint32_t );
+Wrap decrement( Time& timecode, uint32_t );
+Wrap increment_subframes( Time& timecode, uint32_t );
+Wrap decrement_subframes( Time& timecode, uint32_t );
+Wrap increment_seconds( Time& timecode, uint32_t );
+Wrap increment_minutes( Time& timecode, uint32_t );
+Wrap increment_hours( Time& timecode, uint32_t );
+void frames_floor( Time& timecode );
+void seconds_floor( Time& timecode );
+void minutes_floor( Time& timecode );
+void hours_floor( Time& timecode );
+
+} // namespace Timecode
+
+std::ostream& operator<<(std::ostream& ostr, const Timecode::Time& t);
+
+#endif  // __ardour_timecode_h__
diff --git a/libs/timecode/wscript b/libs/timecode/wscript
new file mode 100644
index 0000000000..efdc814053
--- /dev/null
+++ b/libs/timecode/wscript
@@ -0,0 +1,46 @@
+#!/usr/bin/env python
+import autowaf
+import Options
+import os
+
+# Version of this package (even if built as a child)
+TIMECODE_VERSION = '0.0.0'
+
+# Library version (UNIX style major, minor, micro)
+# major increment <=> incompatible changes
+# minor increment <=> compatible changes (additions)
+# micro increment <=> no interface changes
+# Version history:
+#   0.0.0 = 0,0,0
+TIMECODE_LIB_VERSION = '0.0.0'
+
+# Variables for 'waf dist'
+APPNAME = 'timecode'
+VERSION = TIMECODE_VERSION
+
+# Mandatory variables
+srcdir = '.'
+blddir = 'build'
+
+def set_options(opt):
+	autowaf.set_options(opt)
+
+def configure(conf):
+	autowaf.configure(conf)
+
+	conf.check_tool('compiler_cxx')
+
+def build(bld):
+	# Library
+	obj = bld.new_task_gen('cxx', 'shlib')
+	obj.source         = 'src/time.cc'
+	obj.export_incdirs = ['.']
+	obj.includes       = ['.', './src']
+	obj.name           = 'libtimecode'
+	obj.target         = 'timecode'
+	obj.vnum           = TIMECODE_LIB_VERSION
+	obj.install_path   = os.path.join(bld.env['LIBDIR'], 'ardour3')
+
+def shutdown():
+	autowaf.shutdown()
+