Force specification of timecode rate when creating a Time from seconds.
[libdcp.git] / src / dcp_time.cc
index 5376b9724e08a9f7ddef6907ec7fd05cd4edf0c4..4e7ab6f2fa0cac106c840dbebc45ed093e1a34b2 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2015 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
  *  @brief Time class.
  */
 
+#include "raw_convert.h"
 #include "dcp_time.h"
 #include "exceptions.h"
 #include <boost/algorithm/string.hpp>
-#include <boost/lexical_cast.hpp>
 #include <iostream>
 #include <vector>
 #include <cmath>
@@ -33,61 +33,70 @@ using namespace std;
 using namespace boost;
 using namespace dcp;
 
-Time::Time (int frame, int frames_per_second)
-       : h (0)
-       , m (0)
-       , s (0)
-       , t (0)
+Time::Time (int frame, int frames_per_second, int tcr_)
 {
-       set (double (frame) / frames_per_second);
+       set (double (frame) / frames_per_second, tcr_);
 }
 
-Time::Time (int64_t ticks)
+/** Construct a Time from a number of seconds and a timecode rate.
+ *
+ *  @param seconds A number of seconds.
+ *  @param tcr_ Timecode rate.
+ */
+Time::Time (double seconds, int tcr_)
 {
-       h = ticks / (60 * 60 * 250);
-       ticks -= int64_t (h) * 60 * 60 * 250;
-       m = ticks / (60 * 250);
-       ticks -= int64_t (m) * 60 * 250;
-       s = ticks / 250;
-       ticks -= int64_t (s) * 250;
-       t = ticks;
+       set (seconds, tcr_);
 }
 
+/** Construct a Time with specified timecode rate and using the supplied
+ *  number of seconds.
+ *
+ *  @param seconds A number of seconds.
+ *  @param tcr_ Timecode rate to use.
+ */
 void
-Time::set (double ss)
+Time::set (double seconds, int tcr_)
 {
-       t = (int (round (ss * 1000)) % 1000) / 4;
-       s = floor (ss);
+       s = floor (seconds);
+       tcr = tcr_;
 
-       if (s > 60) {
+       e = int (round ((seconds - s) * tcr));
+
+       if (s >= 60) {
                m = s / 60;
                s -= m * 60;
+       } else {
+               m = 0;
        }
 
-       if (m > 60) {
+       if (m >= 60) {
                h = m / 60;
                m -= h * 60;
+       } else {
+               h = 0;
        }
 }
 
-Time::Time (string time)
+/** @param time String of the form HH:MM:SS:EE[E] */
+Time::Time (string time, int tcr_)
+       : tcr (tcr_)
 {
        vector<string> b;
        split (b, time, is_any_of (":"));
        if (b.size() != 4) {
                boost::throw_exception (DCPReadError ("unrecognised time specification"));
        }
-       
-       h = lexical_cast<int> (b[0]);
-       m = lexical_cast<int> (b[1]);
-       s = lexical_cast<int> (b[2]);
-       t = lexical_cast<int> (b[3]);
+
+       h = raw_convert<int> (b[0]);
+       m = raw_convert<int> (b[1]);
+       s = raw_convert<int> (b[2]);
+       e = raw_convert<int> (b[3]);
 }
 
 bool
 dcp::operator== (Time const & a, Time const & b)
 {
-       return (a.h == b.h && a.m == b.m && a.s == b.s && a.t == b.t);
+       return (a.h == b.h && a.m == b.m && a.s == b.s && (a.e * b.tcr) == (b.e * a.tcr));
 }
 
 bool
@@ -99,23 +108,13 @@ dcp::operator!= (Time const & a, Time const & b)
 bool
 dcp::operator<= (Time const & a, Time const & b)
 {
-       if (a.h != b.h) {
-               return a.h <= b.h;
-       }
-
-       if (a.m != b.m) {
-               return a.m <= b.m;
-       }
-
-       if (a.s != b.s) {
-               return a.s <= b.s;
-       }
-
-       if (a.t != b.t) {
-               return a.t <= b.t;
-       }
+       return a < b || a == b;
+}
 
-       return true;
+bool
+dcp::operator>= (Time const & a, Time const & b)
+{
+       return a > b || a == b;
 }
 
 bool
@@ -133,8 +132,8 @@ dcp::operator< (Time const & a, Time const & b)
                return a.s < b.s;
        }
 
-       if (a.t != b.t) {
-               return a.t < b.t;
+       if ((a.e * b.tcr) != (b.e * a.tcr)) {
+               return (a.e * b.tcr) < (b.e * a.tcr);
        }
 
        return true;
@@ -155,8 +154,8 @@ dcp::operator> (Time const & a, Time const & b)
                return a.s > b.s;
        }
 
-       if (a.t != b.t) {
-               return a.t > b.t;
+       if ((a.e * b.tcr) != (b.e * a.tcr)) {
+               return (a.e * b.tcr) > (b.e * a.tcr);
        }
 
        return true;
@@ -165,18 +164,27 @@ dcp::operator> (Time const & a, Time const & b)
 ostream &
 dcp::operator<< (ostream& s, Time const & t)
 {
-       s << t.h << ":" << t.m << ":" << t.s << "." << t.t;
+       s << t.h << ":" << t.m << ":" << t.s << "." << t.e;
        return s;
 }
 
 dcp::Time
-dcp::operator+ (Time a, Time const & b)
+dcp::operator+ (Time a, Time b)
 {
        Time r;
 
-       r.t = a.t + b.t;
-       if (r.t >= 250) {
-               r.t -= 250;
+       /* Make sure we have a common tcr */
+       if (a.tcr != b.tcr) {
+               a.e *= b.tcr;
+               b.e *= a.tcr;
+               r.tcr = a.tcr * b.tcr;
+       } else {
+               r.tcr = a.tcr;
+       }
+
+       r.e = a.e + b.e;
+       if (r.e >= r.tcr) {
+               r.e -= r.tcr;
                r.s++;
        }
 
@@ -198,13 +206,22 @@ dcp::operator+ (Time a, Time const & b)
 }
 
 dcp::Time
-dcp::operator- (Time a, Time const & b)
+dcp::operator- (Time a, Time b)
 {
        Time r;
 
-       r.t = a.t - b.t;
-       if (r.t < 0) {
-               r.t += 250;
+       /* Make sure we have a common tcr */
+       if (a.tcr != b.tcr) {
+               a.e *= b.tcr;
+               b.e *= a.tcr;
+               r.tcr = a.tcr * b.tcr;
+       } else {
+               r.tcr = a.tcr;
+       }
+
+       r.e = a.e - b.e;
+       if (r.e < 0) {
+               r.e += r.tcr;
                r.s--;
        }
 
@@ -228,24 +245,51 @@ dcp::operator- (Time a, Time const & b)
 float
 dcp::operator/ (Time a, Time const & b)
 {
-       int64_t const at = a.h * 3600 * 250 + a.m * 60 * 250 + a.s * 250 + a.t;
-       int64_t const bt = b.h * 3600 * 250 + b.m * 60 * 250 + b.s * 250 + b.t;
+       int64_t const at = a.h * 3600 + a.m * 60 + a.s * float (a.e) / a.tcr;
+       int64_t const bt = b.h * 3600 + b.m * 60 + b.s * float (b.e) / b.tcr;
        return float (at) / bt;
 }
 
-/** @return A string of the form h:m:s:t */
+/** @return A string of the form h:m:s:e padded as in 00:00:00:000 (for Interop) or 00:00:00:00 (for SMPTE) */
 string
-Time::to_string () const
+Time::as_string (Standard standard) const
 {
        stringstream str;
-       str << h << ":" << m << ":" << s << ":" << t;
+       str << setw(2) << setfill('0') << h << ":"
+           << setw(2) << setfill('0') << m << ":"
+           << setw(2) << setfill('0') << s << ":";
+
+       if (standard == SMPTE) {
+               str << setw(2) << setfill('0') << e;
+       } else {
+               str << setw(3) << setfill('0') << e;
+       }
+
        return str.str ();
 }
 
-/** @return This time in ticks */
+/** @param tcr_ Timecode rate with which the return value should be counted.
+ *  @return the total number of editable units that this time consists of at the specified timecode rate, rounded up
+ *  to the nearest editable unit. For example, as_editable_units (24) returns the total time in frames at 24fps.
+ */
 int64_t
-Time::to_ticks () const
+Time::as_editable_units (int tcr_) const
+{
+       return ceil (int64_t(e) * double (tcr_) / tcr) + int64_t(s) * tcr_ + int64_t(m) * 60 * tcr_ + int64_t(h) * 60 * 60 * tcr_;
+}
+
+/** @return the total number of seconds that this time consists of */
+double
+Time::as_seconds () const
 {
-       return int64_t(t) + int64_t(s) * 250 + int64_t(m) * 60 * 250 + int64_t(h) * 60 * 60 * 250;
+       return h * 3600 + m * 60 + s + double(e) / tcr;
 }
 
+/** @param tcr_ New timecode rate.
+ *  @return A new Time which is this time at the spcified new timecode rate.
+ */
+Time
+Time::rebase (int tcr_) const
+{
+       return Time (h, m, s, floor (float (e) * tcr_ / tcr), tcr_);
+}