Merge branch 'master' into 1.0

[libdcp.git] / src / dcp_time.h

diff --git a/src/dcp_time.h b/src/dcp_time.h
index 48560596dece8500e38654f6dafa29af0eb8d919..697ca230745b4cd46f53d65c5cad9a8e34484df0 100644 (file)
--- a/src/dcp_time.h
+++ b/src/dcp_time.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
 
     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
@@ -17,31 +17,71 @@
 
 */
 
+/** @file  src/dcp_time.h
+ *  @brief Time class.
+ */
+
 #ifndef LIBDCP_TIME_H
 #define LIBDCP_TIME_H
 
-namespace libdcp {
+#include <stdint.h>
+#include <string>
+#include <iostream>
+
+namespace dcp {
 
+/** @class Time
+ *  @brief A representation of time within a DCP.
+ */
+       
 class Time
 {
 public:
-       Time () : h (0), m (0), s (0), ms (0) {}
-       Time (int h_, int m_, int s_, int ms_)
+       Time () : h (0), m (0), s (0), t (0) {}
+
+       Time (int64_t ticks);
+
+       /** Construct a Time from a frame index (starting from 0)
+        *  and a frames per second count.
+        */
+       Time (int frame, int frames_per_second);
+
+       /** Construct a Time from hours, minutes, seconds and ticks.
+        *  @param h_ Hours.
+        *  @param m_ Minutes.
+        *  @param s_ Seconds.
+        *  @param t_ Ticks (where 1 tick is 4 milliseconds).
+        */
+       Time (int h_, int m_, int s_, int t_)
                : h (h_)
                , m (m_)
                , s (s_)
-               , ms (ms_)
+               , t (t_)
        {}
 
-       int h;
-       int m;
-       int s;
-       int ms;
+       Time (std::string time);
+
+       int h; ///< hours
+       int m; ///< minutes
+       int s; ///< seconds
+       int t; ///< `ticks', where 1 tick is 4 milliseconds
+
+       std::string to_string () const;
+       int64_t to_ticks () const;
+
+private:
+       void set (double);
 };
 
 extern bool operator== (Time const & a, Time const & b);
+extern bool operator!= (Time const & a, Time const & b);
 extern bool operator<= (Time const & a, Time const & b);
+extern bool operator< (Time const & a, Time const & b);
+extern bool operator> (Time const & a, Time const & b);
 extern std::ostream & operator<< (std::ostream & s, Time const & t);
+extern Time operator+ (Time a, Time const & b);        
+extern Time operator- (Time a, Time const & b);
+extern float operator/ (Time a, Time const & b);
 
 }