src/dcp_time.h

   1 /*
   2     Copyright (C) 2012-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/dcp_time.h
  21  *  @brief Time class.
  22  */
  23
  24 #ifndef LIBDCP_TIME_H
  25 #define LIBDCP_TIME_H
  26
  27 #include <stdint.h>
  28 #include <string>
  29 #include <iostream>
  30
  31 namespace dcp {
  32
  33 /** @class Time
  34  *  @brief A representation of time within a DCP.
  35  */
  36
  37 class Time
  38 {
  39 public:
  40         Time () : h (0), m (0), s (0), e (0), tcr (1) {}
  41
  42         /** Construct a Time from a frame index (starting from 0),
  43          *  a frames per second count and a timecode rate.
  44          */
  45         Time (int frame, int frames_per_second, int tcr);
  46
  47         /** Construct a Time from hours, minutes, seconds, editable units and a timecode rate.
  48          *  @param h_ Hours.
  49          *  @param m_ Minutes.
  50          *  @param s_ Seconds.
  51          *  @param e_ Editable units (where 1 editable unit is 1 / tcr_ seconds)
  52          *  @param tcr_ Timecode rate; i.e. number of editable units per second.
  53          */
  54         Time (int h_, int m_, int s_, int e_, int tcr_)
  55                 : h (h_)
  56                 , m (m_)
  57                 , s (s_)
  58                 , e (e_)
  59                 , tcr (tcr_)
  60         {}
  61
  62         Time (double seconds);
  63
  64         Time (std::string time, int tcr);
  65
  66         int h; ///<   hours
  67         int m; ///<   minutes
  68         int s; ///<   seconds
  69         int e; ///<   editable units (where 1 editable unit is 1 / tcr_ seconds)
  70         int tcr; ///< timecode rate: the number of editable units per second.
  71
  72         std::string to_string () const;
  73         double to_seconds () const;
  74         int64_t to_editable_units (int tcr_) const;
  75         Time rebase (int tcr_) const;
  76
  77 private:
  78         void set (double seconds, int tcr);
  79 };
  80
  81 extern bool operator== (Time const & a, Time const & b);
  82 extern bool operator!= (Time const & a, Time const & b);
  83 extern bool operator<= (Time const & a, Time const & b);
  84 extern bool operator< (Time const & a, Time const & b);
  85 extern bool operator> (Time const & a, Time const & b);
  86 extern bool operator>= (Time const & a, Time const & b);
  87 extern std::ostream & operator<< (std::ostream & s, Time const & t);
  88 extern Time operator+ (Time a, Time b);
  89 extern Time operator- (Time a, Time b);
  90 extern float operator/ (Time a, Time const & b);
  91
  92 }
  93
  94 #endif