2 Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
4 This file is part of libdcp.
6 libdcp is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 libdcp is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with libdcp. If not, see <http://www.gnu.org/licenses/>.
19 In addition, as a special exception, the copyright holders give
20 permission to link the code of portions of this program with the
21 OpenSSL library under certain conditions as described in each
22 individual source file, and distribute linked combinations
25 You must obey the GNU General Public License in all respects
26 for all of the code used other than OpenSSL. If you modify
27 file(s) with this exception, you may extend this exception to your
28 version of the file(s), but you are not obligated to do so. If you
29 do not wish to do so, delete this exception statement from your
30 version. If you delete this exception statement from all source
31 files in the program, then also delete it here.
34 /** @file src/dcp_time.cc
38 #include "raw_convert.h"
40 #include "exceptions.h"
41 #include "compose.hpp"
42 #include "dcp_assert.h"
43 #include <boost/algorithm/string.hpp>
44 #include <boost/optional.hpp>
50 using namespace boost;
53 Time::Time (int frame, double frames_per_second, int tcr_)
55 set (double (frame) / frames_per_second, tcr_);
58 /** Construct a Time from a number of seconds and a timecode rate.
60 * @param seconds A number of seconds.
61 * @param tcr_ Timecode rate.
63 Time::Time (double seconds, int tcr_)
68 /** Construct a Time with specified timecode rate and using the supplied
71 * @param seconds A number of seconds.
72 * @param tcr_ Timecode rate to use.
75 Time::set (double seconds, int tcr_)
80 e = int (round ((seconds - s) * tcr));
97 /** @param time String of the form
98 * HH:MM:SS:EE for SMPTE
99 * HH:MM:SS:E[E[E]] or HH:MM:SS.s[s[s]] for Interop
100 * where HH are hours, MM minutes, SS seconds, EE editable units and
103 * @param tcr_ Timecode rate if this is a SMPTE time, otherwise empty for an Interop time.
105 Time::Time (string time, optional<int> tcr_)
108 split (b, time, is_any_of (":"));
110 if (b.size() < 3 || b[0].empty() || b[1].empty() || b[0].length() > 2 || b[1].length() > 2) {
111 boost::throw_exception (ReadError (String::compose ("unrecognised time specification %1", time)));
117 /* HH:MM:SS.s[s[s]] */
119 split (bs, b[2], is_any_of ("."));
120 if (bs.size() != 2) {
121 boost::throw_exception (ReadError (String::compose ("unrecognised time specification %1", time)));
124 h = raw_convert<int> (b[0]);
125 m = raw_convert<int> (b[1]);
126 if (bs[0].empty() || bs[0].length() > 2) {
127 boost::throw_exception (ReadError (String::compose ("unrecognised time specification %1; %2 has bad length", time, bs[0])));
129 s = raw_convert<int> (bs[0]);
130 if (bs[1].empty() || bs[1].length() > 3) {
131 boost::throw_exception (ReadError (String::compose ("unrecognised time specification %1; %2 has bad length", time, bs[1])));
133 e = raw_convert<int> (bs[1]);
135 } else if (b.size() == 4) {
137 h = raw_convert<int> (b[0]);
138 m = raw_convert<int> (b[1]);
139 if (b[2].empty() || b[2].length() > 2) {
140 boost::throw_exception (ReadError (String::compose ("unrecognised time specification %1; %2 has bad length", time, b[2])));
142 s = raw_convert<int> (b[2]);
143 if (b[3].empty() || b[3].length() > 3) {
144 boost::throw_exception (ReadError (String::compose ("unrecognised time specification %1; %2 has bad length", time, b[3])));
146 e = raw_convert<int> (b[3]);
149 boost::throw_exception (ReadError (String::compose ("unrecognised time specification %1", time)));
153 /* SMPTE: HH:MM:SS:EE */
154 split (b, time, is_any_of (":"));
156 boost::throw_exception (ReadError (String::compose ("unrecognised time specification %1; does not have 4 parts", time)));
159 h = raw_convert<int> (b[0]);
160 m = raw_convert<int> (b[1]);
161 if (b[2].empty() || b[2].length() > 2) {
162 boost::throw_exception (ReadError (String::compose ("unrecognised time specification %1; %2 has bad length", time, b[2])));
164 s = raw_convert<int> (b[2]);
165 if (b[3].empty() || b[3].length() > 2) {
166 boost::throw_exception (ReadError (String::compose ("unrecognised time specification %1; %2 has bad length", time, b[3])));
168 e = raw_convert<int> (b[3]);
174 dcp::operator== (Time const & a, Time const & b)
176 return (a.h == b.h && a.m == b.m && a.s == b.s && (a.e * b.tcr) == (b.e * a.tcr));
180 dcp::operator!= (Time const & a, Time const & b)
186 dcp::operator<= (Time const & a, Time const & b)
188 return a < b || a == b;
192 dcp::operator>= (Time const & a, Time const & b)
194 return a > b || a == b;
198 dcp::operator< (Time const & a, Time const & b)
212 return (a.e * b.tcr) < (b.e * a.tcr);
216 dcp::operator> (Time const & a, Time const & b)
230 return (a.e * b.tcr) > (b.e * a.tcr);
234 dcp::operator<< (ostream& s, Time const & t)
236 s << t.h << ":" << t.m << ":" << t.s << "." << t.e;
241 dcp::operator+ (Time a, Time b)
245 /* Make sure we have a common tcr */
246 if (a.tcr != b.tcr) {
249 r.tcr = a.tcr * b.tcr;
278 dcp::operator- (Time a, Time b)
282 /* Make sure we have a common tcr */
283 if (a.tcr != b.tcr) {
286 r.tcr = a.tcr * b.tcr;
315 dcp::operator/ (Time a, Time const & b)
317 int64_t const at = a.h * 3600 + a.m * 60 + a.s * float (a.e) / a.tcr;
318 int64_t const bt = b.h * 3600 + b.m * 60 + b.s * float (b.e) / b.tcr;
319 return float (at) / bt;
322 /** @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) */
324 Time::as_string (Standard standard) const
328 if (standard == Standard::SMPTE) {
329 snprintf (buffer, sizeof(buffer), "%02d:%02d:%02d:%02d", h, m, s, e);
331 snprintf (buffer, sizeof(buffer), "%02d:%02d:%02d:%03d", h, m, s, e);
337 /** @param tcr_ Timecode rate with which the return value should be counted.
338 * @return the total number of editable units that this time consists of at the specified timecode rate, rounded up
339 * to the nearest editable unit. For example, as_editable_units (24) returns the total time in frames at 24fps.
342 Time::as_editable_units (int tcr_) const
344 return ceil (int64_t(e) * double (tcr_) / tcr) + int64_t(s) * tcr_ + int64_t(m) * 60 * tcr_ + int64_t(h) * 60 * 60 * tcr_;
347 /** @return the total number of seconds that this time consists of */
349 Time::as_seconds () const
351 return h * 3600 + m * 60 + s + double(e) / tcr;
354 /** @param tcr_ New timecode rate.
355 * @return A new Time which is this time at the spcified new timecode rate.
358 Time::rebase (int tcr_) const
360 long int e_ = lrintf (float (e) * tcr_ / tcr);
377 return Time (h_, m_, s_, e_, tcr_);