src/dcp_time.h

   1 /*
   2     Copyright (C) 2012-2014 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), t (0) {}
  41
  42         Time (int64_t ticks);
  43
  44         /** Construct a Time from a frame index (starting from 0)
  45          *  and a frames per second count.
  46          */
  47         Time (int frame, int frames_per_second);
  48
  49         /** Construct a Time from hours, minutes, seconds and ticks.
  50          *  @param h_ Hours.
  51          *  @param m_ Minutes.
  52          *  @param s_ Seconds.
  53          *  @param t_ Ticks (where 1 tick is 4 milliseconds).
  54          */
  55         Time (int h_, int m_, int s_, int t_)
  56                 : h (h_)
  57                 , m (m_)
  58                 , s (s_)
  59                 , t (t_)
  60         {}
  61
  62         Time (std::string time);
  63
  64         int h; ///< hours
  65         int m; ///< minutes
  66         int s; ///< seconds
  67         int t; ///< `ticks', where 1 tick is 4 milliseconds
  68
  69         std::string to_string () const;
  70         int64_t to_ticks () const;
  71
  72 private:
  73         void set (double);
  74 };
  75
  76 extern bool operator== (Time const & a, Time const & b);
  77 extern bool operator!= (Time const & a, Time const & b);
  78 extern bool operator<= (Time const & a, Time const & b);
  79 extern bool operator< (Time const & a, Time const & b);
  80 extern bool operator> (Time const & a, Time const & b);
  81 extern std::ostream & operator<< (std::ostream & s, Time const & t);
  82 extern Time operator+ (Time a, Time const & b);
  83 extern Time operator- (Time a, Time const & b);
  84 extern float operator/ (Time a, Time const & b);
  85
  86 }
  87
  88 #endif