src/dcp_time.h

   1 /*
   2     Copyright (C) 2012 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 A representation of time within a DCP.
  22  */
  23
  24 #ifndef LIBDCP_TIME_H
  25 #define LIBDCP_TIME_H
  26
  27 namespace libdcp {
  28
  29 /** @class Time
  30  *  @brief A representation of time within a DCP.
  31  */
  32
  33 class Time
  34 {
  35 public:
  36         Time () : h (0), m (0), s (0), t (0) {}
  37
  38         /** Construct a Time from a frame index (starting from 0)
  39          *  and a frames per second count.
  40          */
  41         Time (int frame, int frames_per_second);
  42
  43         /** Construct a Time from hours, minutes, seconds and ticks.
  44          *  @param h_ Hours.
  45          *  @param m_ Minutes.
  46          *  @param s_ Seconds.
  47          *  @param t_ Ticks (where 1 tick is 4 milliseconds).
  48          */
  49         Time (int h_, int m_, int s_, int t_)
  50                 : h (h_)
  51                 , m (m_)
  52                 , s (s_)
  53                 , t (t_)
  54         {}
  55
  56         Time (std::string time);
  57
  58         int h; ///< hours
  59         int m; ///< minutes
  60         int s; ///< seconds
  61         int t; ///< `ticks', where 1 tick is 4 milliseconds
  62
  63         std::string to_string () const;
  64         int64_t to_ticks () const;
  65
  66 private:
  67         void set (double);
  68 };
  69
  70 extern bool operator== (Time const & a, Time const & b);
  71 extern bool operator!= (Time const & a, Time const & b);
  72 extern bool operator<= (Time const & a, Time const & b);
  73 extern bool operator< (Time const & a, Time const & b);
  74 extern bool operator> (Time const & a, Time const & b);
  75 extern std::ostream & operator<< (std::ostream & s, Time const & t);
  76 extern Time operator+ (Time a, Time const & b);
  77 extern Time operator- (Time a, Time const & b);
  78 extern float operator/ (Time a, Time const & b);
  79
  80 }
  81
  82 #endif