2 Copyright (C) 2014-2018 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic 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 DCP-o-matic 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 DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 /** @file src/lib/dcpomatic_time.h
22 * @brief Types to describe time.
25 #ifndef DCPOMATIC_TIME_H
26 #define DCPOMATIC_TIME_H
28 #include "frame_rate_change.h"
29 #include "dcpomatic_assert.h"
30 #include <boost/optional.hpp>
31 #include <boost/foreach.hpp>
38 /** A time in seconds, expressed as a number scaled up by Time::HZ. We want two different
39 * versions of this class, ContentTime and DCPTime, and we want it to be impossible to
40 * convert implicitly between the two. Hence there's this template hack. I'm not
41 * sure if it's the best way to do it.
43 * S is the name of `this' class and O is its opposite (see the typedefs below).
45 template <class S, class O>
55 explicit Time (Type t)
59 explicit Time (Type n, Type d)
63 /* Explicit conversion from type O */
64 Time (Time<O, S> d, FrameRateChange f);
70 bool operator< (Time<S, O> const & o) const {
74 bool operator<= (Time<S, O> const & o) const {
78 bool operator== (Time<S, O> const & o) const {
82 bool operator!= (Time<S, O> const & o) const {
86 bool operator>= (Time<S, O> const & o) const {
90 bool operator> (Time<S, O> const & o) const {
94 Time<S, O> operator+ (Time<S, O> const & o) const {
95 return Time<S, O> (_t + o._t);
98 Time<S, O> & operator+= (Time<S, O> const & o) {
103 Time<S, O> operator- () const {
104 return Time<S, O> (-_t);
107 Time<S, O> operator- (Time<S, O> const & o) const {
108 return Time<S, O> (_t - o._t);
111 Time<S, O> & operator-= (Time<S, O> const & o) {
116 Time<S, O> operator/ (int o) const {
117 return Time<S, O> (_t / o);
120 /** Round up to the nearest sampling interval
121 * at some sampling rate.
122 * @param r Sampling rate.
124 Time<S, O> ceil (double r) const {
125 return Time<S, O> (llrint (HZ * frames_ceil(r) / r));
128 Time<S, O> floor (double r) const {
129 return Time<S, O> (llrint (HZ * frames_floor(r) / r));
132 Time<S, O> round (double r) const {
133 return Time<S, O> (llrint (HZ * frames_round(r) / r));
136 double seconds () const {
137 return double (_t) / HZ;
140 Time<S, O> abs () const {
141 return Time<S, O> (std::abs (_t));
144 template <typename T>
145 int64_t frames_round (T r) const {
146 /* We must cast to double here otherwise if T is integer
147 the calculation will round down before we get the chance
150 return llrint (_t * double(r) / HZ);
153 template <typename T>
154 int64_t frames_floor (T r) const {
155 return ::floor (_t * r / HZ);
158 template <typename T>
159 int64_t frames_ceil (T r) const {
160 /* We must cast to double here otherwise if T is integer
161 the calculation will round down before we get the chance
164 return ::ceil (_t * double(r) / HZ);
167 /** Split a time into hours, minutes, seconds and frames.
168 * @param r Frames per second.
169 * @param h Returned hours.
170 * @param m Returned minutes.
171 * @param s Returned seconds.
172 * @param f Returned frames.
174 template <typename T>
175 void split (T r, int& h, int& m, int& s, int& f) const
177 /* Do this calculation with frames so that we can round
178 to a frame boundary at the start rather than the end.
180 int64_t ff = frames_round (r);
189 f = static_cast<int> (ff);
192 template <typename T>
193 std::string timecode (T r) const {
198 split (r, h, m, s, f);
201 snprintf (buffer, sizeof (buffer), "%02d:%02d:%02d:%02d", h, m, s, f);
206 static Time<S, O> from_seconds (double s) {
207 return Time<S, O> (llrint (s * HZ));
211 static Time<S, O> from_frames (int64_t f, T r) {
212 DCPOMATIC_ASSERT (r > 0);
213 return Time<S, O> (f * HZ / r);
216 static Time<S, O> delta () {
217 return Time<S, O> (1);
220 static Time<S, O> min () {
221 return Time<S, O> (-INT64_MAX);
224 static Time<S, O> max () {
225 return Time<S, O> (INT64_MAX);
228 static const int HZ = 96000;
231 friend struct dcpomatic_time_ceil_test;
232 friend struct dcpomatic_time_floor_test;
237 class ContentTimeDifferentiator {};
238 class DCPTimeDifferentiator {};
240 /* Specializations for the two allowed explicit conversions */
243 Time<ContentTimeDifferentiator, DCPTimeDifferentiator>::Time (Time<DCPTimeDifferentiator, ContentTimeDifferentiator> d, FrameRateChange f);
246 Time<DCPTimeDifferentiator, ContentTimeDifferentiator>::Time (Time<ContentTimeDifferentiator, DCPTimeDifferentiator> d, FrameRateChange f);
248 /** Time relative to the start or position of a piece of content in its native frame rate */
249 typedef Time<ContentTimeDifferentiator, DCPTimeDifferentiator> ContentTime;
250 /** Time relative to the start of the output DCP in its frame rate */
251 typedef Time<DCPTimeDifferentiator, ContentTimeDifferentiator> DCPTime;
259 TimePeriod (T f, T t)
264 /** start time of sampling interval that the period is from */
266 /** start time of next sampling interval after the period */
269 T duration () const {
273 TimePeriod<T> operator+ (T const & o) const {
274 return TimePeriod<T> (from + o, to + o);
277 boost::optional<TimePeriod<T> > overlap (TimePeriod<T> const & other) const {
278 T const max_from = std::max (from, other.from);
279 T const min_to = std::min (to, other.to);
281 if (max_from >= min_to) {
282 return boost::optional<TimePeriod<T> > ();
285 return TimePeriod<T> (max_from, min_to);
288 bool contains (T const & other) const {
289 return (from <= other && other < to);
292 bool operator< (TimePeriod<T> const & o) const {
293 if (from != o.from) {
294 return from < o.from;
299 bool operator== (TimePeriod<T> const & other) const {
300 return from == other.from && to == other.to;
303 bool operator!= (TimePeriod<T> const & other) const {
304 return !(*this == other);
308 /** @param A Period which is subtracted from.
309 * @param B Periods to subtract from `A', must be in ascending order of start time and must not overlap.
312 std::list<TimePeriod<T> > subtract (TimePeriod<T> A, std::list<TimePeriod<T> > const & B)
314 std::list<TimePeriod<T> > result;
315 result.push_back (A);
317 BOOST_FOREACH (TimePeriod<T> i, B) {
318 std::list<TimePeriod<T> > new_result;
319 BOOST_FOREACH (TimePeriod<T> j, result) {
320 boost::optional<TimePeriod<T> > ov = i.overlap (j);
323 /* A contains all of B */
324 if (i.from != j.from) {
325 new_result.push_back (TimePeriod<T> (j.from, i.from));
328 new_result.push_back (TimePeriod<T> (i.to, j.to));
330 } else if (*ov == j) {
331 /* B contains all of A */
332 } else if (i.from < j.from) {
333 /* B overlaps start of A */
334 new_result.push_back (TimePeriod<T> (i.to, j.to));
335 } else if (i.to > j.to) {
336 /* B overlaps end of A */
337 new_result.push_back (TimePeriod<T> (j.from, i.from));
340 new_result.push_back (j);
349 typedef TimePeriod<ContentTime> ContentTimePeriod;
350 typedef TimePeriod<DCPTime> DCPTimePeriod;
352 DCPTime min (DCPTime a, DCPTime b);
353 DCPTime max (DCPTime a, DCPTime b);
354 ContentTime min (ContentTime a, ContentTime b);
355 ContentTime max (ContentTime a, ContentTime b);
356 std::string to_string (ContentTime t);
357 std::string to_string (DCPTime t);
358 std::string to_string (DCPTimePeriod p);