src/lib/dcpomatic_time.h

   1 /*
   2     Copyright (C) 2014-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file  src/lib/dcpomatic_time.h
  21  *  @brief Types to describe time.
  22  */
  23
  24 #ifndef DCPOMATIC_TIME_H
  25 #define DCPOMATIC_TIME_H
  26
  27 #include "frame_rate_change.h"
  28 #include "safe_stringstream.h"
  29 #include "dcpomatic_assert.h"
  30 #include <stdint.h>
  31 #include <cmath>
  32 #include <ostream>
  33 #include <iomanip>
  34
  35 class dcpomatic_round_up_test;
  36
  37 /** A time in seconds, expressed as a number scaled up by Time::HZ.  We want two different
  38  *  versions of this class, ContentTime and DCPTime, and we want it to be impossible to
  39  *  convert implicitly between the two.  Hence there's this template hack.  I'm not
  40  *  sure if it's the best way to do it.
  41  *
  42  *  S is the name of `this' class and O is its opposite (see the typedefs below).
  43  */
  44 template <class S, class O>
  45 class Time
  46 {
  47 public:
  48         Time ()
  49                 : _t (0)
  50         {}
  51
  52         typedef int64_t Type;
  53
  54         explicit Time (Type t)
  55                 : _t (t)
  56         {}
  57
  58         explicit Time (Type n, Type d)
  59                 : _t (n * HZ / d)
  60         {}
  61
  62         /* Explicit conversion from type O */
  63         Time (Time<O, S> d, FrameRateChange f);
  64
  65         Type get () const {
  66                 return _t;
  67         }
  68
  69         bool operator< (Time<S, O> const & o) const {
  70                 return _t < o._t;
  71         }
  72
  73         bool operator<= (Time<S, O> const & o) const {
  74                 return _t <= o._t;
  75         }
  76
  77         bool operator== (Time<S, O> const & o) const {
  78                 return _t == o._t;
  79         }
  80
  81         bool operator!= (Time<S, O> const & o) const {
  82                 return _t != o._t;
  83         }
  84
  85         bool operator>= (Time<S, O> const & o) const {
  86                 return _t >= o._t;
  87         }
  88
  89         bool operator> (Time<S, O> const & o) const {
  90                 return _t > o._t;
  91         }
  92
  93         Time<S, O> operator+ (Time<S, O> const & o) const {
  94                 return Time<S, O> (_t + o._t);
  95         }
  96
  97         Time<S, O> & operator+= (Time<S, O> const & o) {
  98                 _t += o._t;
  99                 return *this;
 100         }
 101
 102         Time<S, O> operator- () const {
 103                 return Time<S, O> (-_t);
 104         }
 105
 106         Time<S, O> operator- (Time<S, O> const & o) const {
 107                 return Time<S, O> (_t - o._t);
 108         }
 109
 110         Time<S, O> & operator-= (Time<S, O> const & o) {
 111                 _t -= o._t;
 112                 return *this;
 113         }
 114
 115         /** Round up to the nearest sampling interval
 116          *  at some sampling rate.
 117          *  @param r Sampling rate.
 118          */
 119         Time<S, O> round_up (float r) const {
 120                 Type const n = llrintf (HZ / r);
 121                 Type const a = _t + n - 1;
 122                 return Time<S, O> (a - (a % n));
 123         }
 124
 125         double seconds () const {
 126                 return double (_t) / HZ;
 127         }
 128
 129         Time<S, O> abs () const {
 130                 return Time<S, O> (std::abs (_t));
 131         }
 132
 133         template <typename T>
 134         int64_t frames_round (T r) const {
 135                 return llrint (_t * r / HZ);
 136         }
 137
 138         template <typename T>
 139         int64_t frames_floor (T r) const {
 140                 return floor (_t * r / HZ);
 141         }
 142
 143         template <typename T>
 144         int64_t frames_ceil (T r) const {
 145                 return ceil (_t * r / HZ);
 146         }
 147
 148         /** @param r Frames per second */
 149         template <typename T>
 150         void split (T r, int& h, int& m, int& s, int& f) const
 151         {
 152                 /* Do this calculation with frames so that we can round
 153                    to a frame boundary at the start rather than the end.
 154                 */
 155                 int64_t ff = frames_round (r);
 156
 157                 h = ff / (3600 * r);
 158                 ff -= h * 3600 * r;
 159                 m = ff / (60 * r);
 160                 ff -= m * 60 * r;
 161                 s = ff / r;
 162                 ff -= s * r;
 163
 164                 f = static_cast<int> (ff);
 165         }
 166
 167         template <typename T>
 168         std::string timecode (T r) const {
 169                 int h;
 170                 int m;
 171                 int s;
 172                 int f;
 173                 split (r, h, m, s, f);
 174
 175                 SafeStringStream o;
 176                 o.width (2);
 177                 o.fill ('0');
 178                 o << std::setw(2) << std::setfill('0') << h << ":"
 179                   << std::setw(2) << std::setfill('0') << m << ":"
 180                   << std::setw(2) << std::setfill('0') << s << ":"
 181                   << std::setw(2) << std::setfill('0') << f;
 182                 return o.str ();
 183         }
 184
 185
 186         static Time<S, O> from_seconds (double s) {
 187                 return Time<S, O> (llrint (s * HZ));
 188         }
 189
 190         template <class T>
 191         static Time<S, O> from_frames (int64_t f, T r) {
 192                 DCPOMATIC_ASSERT (r > 0);
 193                 return Time<S, O> (f * HZ / r);
 194         }
 195
 196         static Time<S, O> delta () {
 197                 return Time<S, O> (1);
 198         }
 199
 200         static Time<S, O> min () {
 201                 return Time<S, O> (-INT64_MAX);
 202         }
 203
 204         static Time<S, O> max () {
 205                 return Time<S, O> (INT64_MAX);
 206         }
 207
 208 private:
 209         friend struct dcptime_round_up_test;
 210
 211         Type _t;
 212         static const int HZ = 96000;
 213 };
 214
 215 class ContentTimeDifferentiator {};
 216 class DCPTimeDifferentiator {};
 217
 218 /* Specializations for the two allowed explicit conversions */
 219
 220 template<>
 221 Time<ContentTimeDifferentiator, DCPTimeDifferentiator>::Time (Time<DCPTimeDifferentiator, ContentTimeDifferentiator> d, FrameRateChange f);
 222
 223 template<>
 224 Time<DCPTimeDifferentiator, ContentTimeDifferentiator>::Time (Time<ContentTimeDifferentiator, DCPTimeDifferentiator> d, FrameRateChange f);
 225
 226 /** Time relative to the start or position of a piece of content in its native frame rate */
 227 typedef Time<ContentTimeDifferentiator, DCPTimeDifferentiator> ContentTime;
 228 /** Time relative to the start of the output DCP in its frame rate */
 229 typedef Time<DCPTimeDifferentiator, ContentTimeDifferentiator> DCPTime;
 230
 231 class ContentTimePeriod
 232 {
 233 public:
 234         ContentTimePeriod () {}
 235
 236         ContentTimePeriod (ContentTime f, ContentTime t)
 237                 : from (f)
 238                 , to (t)
 239         {}
 240
 241         ContentTime from;
 242         ContentTime to;
 243
 244         ContentTimePeriod operator+ (ContentTime const & o) const {
 245                 return ContentTimePeriod (from + o, to + o);
 246         }
 247
 248         bool overlaps (ContentTimePeriod const & o) const;
 249         bool contains (ContentTime const & o) const;
 250
 251         bool operator== (ContentTimePeriod const & o) const {
 252                 return from == o.from && to == o.to;
 253         }
 254 };
 255
 256 DCPTime min (DCPTime a, DCPTime b);
 257 DCPTime max (DCPTime a, DCPTime b);
 258 ContentTime min (ContentTime a, ContentTime b);
 259 ContentTime max (ContentTime a, ContentTime b);
 260 std::ostream& operator<< (std::ostream& s, ContentTime t);
 261 std::ostream& operator<< (std::ostream& s, DCPTime t);
 262
 263 #endif