src/lib/dcpomatic_time.h

   1 /*
   2     Copyright (C) 2014-2018 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   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.
  10
  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.
  15
  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/>.
  18
  19 */
  20
  21 /** @file  src/lib/dcpomatic_time.h
  22  *  @brief Types to describe time.
  23  */
  24
  25 #ifndef DCPOMATIC_TIME_H
  26 #define DCPOMATIC_TIME_H
  27
  28 #include "frame_rate_change.h"
  29 #include "dcpomatic_assert.h"
  30 #include <boost/optional.hpp>
  31 #include <boost/foreach.hpp>
  32 #include <stdint.h>
  33 #include <cmath>
  34 #include <ostream>
  35 #include <iomanip>
  36 #include <cstdio>
  37
  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.
  42  *
  43  *  S is the name of `this' class and O is its opposite (see the typedefs below).
  44  */
  45 template <class S, class O>
  46 class Time
  47 {
  48 public:
  49         Time ()
  50                 : _t (0)
  51         {}
  52
  53         typedef int64_t Type;
  54
  55         explicit Time (Type t)
  56                 : _t (t)
  57         {}
  58
  59         explicit Time (Type n, Type d)
  60                 : _t (n * HZ / d)
  61         {}
  62
  63         /* Explicit conversion from type O */
  64         Time (Time<O, S> d, FrameRateChange f);
  65
  66         Type get () const {
  67                 return _t;
  68         }
  69
  70         bool operator< (Time<S, O> const & o) const {
  71                 return _t < o._t;
  72         }
  73
  74         bool operator<= (Time<S, O> const & o) const {
  75                 return _t <= o._t;
  76         }
  77
  78         bool operator== (Time<S, O> const & o) const {
  79                 return _t == o._t;
  80         }
  81
  82         bool operator!= (Time<S, O> const & o) const {
  83                 return _t != o._t;
  84         }
  85
  86         bool operator>= (Time<S, O> const & o) const {
  87                 return _t >= o._t;
  88         }
  89
  90         bool operator> (Time<S, O> const & o) const {
  91                 return _t > o._t;
  92         }
  93
  94         Time<S, O> operator+ (Time<S, O> const & o) const {
  95                 return Time<S, O> (_t + o._t);
  96         }
  97
  98         Time<S, O> & operator+= (Time<S, O> const & o) {
  99                 _t += o._t;
 100                 return *this;
 101         }
 102
 103         Time<S, O> operator- () const {
 104                 return Time<S, O> (-_t);
 105         }
 106
 107         Time<S, O> operator- (Time<S, O> const & o) const {
 108                 return Time<S, O> (_t - o._t);
 109         }
 110
 111         Time<S, O> & operator-= (Time<S, O> const & o) {
 112                 _t -= o._t;
 113                 return *this;
 114         }
 115
 116         /** Round up to the nearest sampling interval
 117          *  at some sampling rate.
 118          *  @param r Sampling rate.
 119          */
 120         Time<S, O> ceil (double r) const {
 121                 return Time<S, O> (llrint (HZ * frames_ceil(r) / r));
 122         }
 123
 124         Time<S, O> floor (double r) const {
 125                 return Time<S, O> (llrint (HZ * frames_floor(r) / r));
 126         }
 127
 128         Time<S, O> round (double r) const {
 129                 return Time<S, O> (llrint (HZ * frames_round(r) / r));
 130         }
 131
 132         double seconds () const {
 133                 return double (_t) / HZ;
 134         }
 135
 136         Time<S, O> abs () const {
 137                 return Time<S, O> (std::abs (_t));
 138         }
 139
 140         template <typename T>
 141         int64_t frames_round (T r) const {
 142                 /* We must cast to double here otherwise if T is integer
 143                    the calculation will round down before we get the chance
 144                    to llrint().
 145                 */
 146                 return llrint (_t * double(r) / HZ);
 147         }
 148
 149         template <typename T>
 150         int64_t frames_floor (T r) const {
 151                 return ::floor (_t * r / HZ);
 152         }
 153
 154         template <typename T>
 155         int64_t frames_ceil (T r) const {
 156                 /* We must cast to double here otherwise if T is integer
 157                    the calculation will round down before we get the chance
 158                    to ceil().
 159                 */
 160                 return ::ceil (_t * double(r) / HZ);
 161         }
 162
 163         /** Split a time into hours, minutes, seconds and frames.
 164          *  @param r Frames per second.
 165          *  @param h Returned hours.
 166          *  @param m Returned minutes.
 167          *  @param s Returned seconds.
 168          *  @param f Returned frames.
 169          */
 170         template <typename T>
 171         void split (T r, int& h, int& m, int& s, int& f) const
 172         {
 173                 /* Do this calculation with frames so that we can round
 174                    to a frame boundary at the start rather than the end.
 175                 */
 176                 int64_t ff = frames_round (r);
 177
 178                 h = ff / (3600 * r);
 179                 ff -= h * 3600 * r;
 180                 m = ff / (60 * r);
 181                 ff -= m * 60 * r;
 182                 s = ff / r;
 183                 ff -= s * r;
 184
 185                 f = static_cast<int> (ff);
 186         }
 187
 188         template <typename T>
 189         std::string timecode (T r) const {
 190                 int h;
 191                 int m;
 192                 int s;
 193                 int f;
 194                 split (r, h, m, s, f);
 195
 196                 char buffer[128];
 197                 snprintf (buffer, sizeof (buffer), "%02d:%02d:%02d:%02d", h, m, s, f);
 198                 return buffer;
 199         }
 200
 201
 202         static Time<S, O> from_seconds (double s) {
 203                 return Time<S, O> (llrint (s * HZ));
 204         }
 205
 206         template <class T>
 207         static Time<S, O> from_frames (int64_t f, T r) {
 208                 DCPOMATIC_ASSERT (r > 0);
 209                 return Time<S, O> (f * HZ / r);
 210         }
 211
 212         static Time<S, O> delta () {
 213                 return Time<S, O> (1);
 214         }
 215
 216         static Time<S, O> min () {
 217                 return Time<S, O> (-INT64_MAX);
 218         }
 219
 220         static Time<S, O> max () {
 221                 return Time<S, O> (INT64_MAX);
 222         }
 223
 224 private:
 225         friend struct dcpomatic_time_ceil_test;
 226         friend struct dcpomatic_time_floor_test;
 227
 228         Type _t;
 229         static const int HZ = 96000;
 230 };
 231
 232 class ContentTimeDifferentiator {};
 233 class DCPTimeDifferentiator {};
 234
 235 /* Specializations for the two allowed explicit conversions */
 236
 237 template<>
 238 Time<ContentTimeDifferentiator, DCPTimeDifferentiator>::Time (Time<DCPTimeDifferentiator, ContentTimeDifferentiator> d, FrameRateChange f);
 239
 240 template<>
 241 Time<DCPTimeDifferentiator, ContentTimeDifferentiator>::Time (Time<ContentTimeDifferentiator, DCPTimeDifferentiator> d, FrameRateChange f);
 242
 243 /** Time relative to the start or position of a piece of content in its native frame rate */
 244 typedef Time<ContentTimeDifferentiator, DCPTimeDifferentiator> ContentTime;
 245 /** Time relative to the start of the output DCP in its frame rate */
 246 typedef Time<DCPTimeDifferentiator, ContentTimeDifferentiator> DCPTime;
 247
 248 template <class T>
 249 class TimePeriod
 250 {
 251 public:
 252         TimePeriod () {}
 253
 254         TimePeriod (T f, T t)
 255                 : from (f)
 256                 , to (t)
 257         {}
 258
 259         /** start time of sampling interval that the period is from */
 260         T from;
 261         /** start time of next sampling interval after the period */
 262         T to;
 263
 264         T duration () const {
 265                 return to - from;
 266         }
 267
 268         TimePeriod<T> operator+ (T const & o) const {
 269                 return TimePeriod<T> (from + o, to + o);
 270         }
 271
 272         boost::optional<TimePeriod<T> > overlap (TimePeriod<T> const & other) const {
 273                 T const max_from = std::max (from, other.from);
 274                 T const min_to = std::min (to, other.to);
 275
 276                 if (max_from >= min_to) {
 277                         return boost::optional<TimePeriod<T> > ();
 278                 }
 279
 280                 return TimePeriod<T> (max_from, min_to);
 281         }
 282
 283         bool contains (T const & other) const {
 284                 return (from <= other && other < to);
 285         }
 286
 287         bool operator< (TimePeriod<T> const & o) const {
 288                 if (from != o.from) {
 289                         return from < o.from;
 290                 }
 291                 return to < o.to;
 292         }
 293
 294         bool operator== (TimePeriod<T> const & other) const {
 295                 return from == other.from && to == other.to;
 296         }
 297
 298         bool operator!= (TimePeriod<T> const & other) const {
 299                 return !(*this == other);
 300         }
 301 };
 302
 303 /** @param A Period which is subtracted from.
 304  *  @param B Periods to subtract from `A', must be in ascending order of start time and must not overlap.
 305  */
 306 template <class T>
 307 std::list<TimePeriod<T> > subtract (TimePeriod<T> A, std::list<TimePeriod<T> > const & B)
 308 {
 309         std::list<TimePeriod<T> > result;
 310         result.push_back (A);
 311
 312         BOOST_FOREACH (TimePeriod<T> i, B) {
 313                 std::list<TimePeriod<T> > new_result;
 314                 BOOST_FOREACH (TimePeriod<T> j, result) {
 315                         boost::optional<TimePeriod<T> > ov = i.overlap (j);
 316                         if (ov) {
 317                                 if (*ov == i) {
 318                                         /* A contains all of B */
 319                                         if (i.from != j.from) {
 320                                                 new_result.push_back (TimePeriod<T> (j.from, i.from));
 321                                         }
 322                                         if (i.to != j.to) {
 323                                                 new_result.push_back (TimePeriod<T> (i.to, j.to));
 324                                         }
 325                                 } else if (*ov == j) {
 326                                         /* B contains all of A */
 327                                 } else if (i.from < j.from) {
 328                                         /* B overlaps start of A */
 329                                         new_result.push_back (TimePeriod<T> (i.to, j.to));
 330                                 } else if (i.to > j.to) {
 331                                         /* B overlaps end of A */
 332                                         new_result.push_back (TimePeriod<T> (j.from, i.from));
 333                                 }
 334                         } else {
 335                                 new_result.push_back (j);
 336                         }
 337                 }
 338                 result = new_result;
 339         }
 340
 341         return result;
 342 }
 343
 344 typedef TimePeriod<ContentTime> ContentTimePeriod;
 345 typedef TimePeriod<DCPTime> DCPTimePeriod;
 346
 347 DCPTime min (DCPTime a, DCPTime b);
 348 DCPTime max (DCPTime a, DCPTime b);
 349 ContentTime min (ContentTime a, ContentTime b);
 350 ContentTime max (ContentTime a, ContentTime b);
 351 std::string to_string (ContentTime t);
 352 std::string to_string (DCPTime t);
 353 std::string to_string (DCPTimePeriod p);
 354
 355 #endif