src/time_pair.h

   1 /*
   2     Copyright (C) 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 #ifndef LIBSUB_TIME_PAIR_H
  21 #define LIBSUB_TIME_PAIR_H
  22
  23 #include "frame_time.h"
  24 #include "metric_time.h"
  25 #include <boost/optional.hpp>
  26
  27 namespace sub {
  28
  29 /** @class TimePair
  30  *  @brief A time, expressed either in metric (h:m:s:ms) or frames (h:m:s:f).
  31  */
  32 class TimePair
  33 {
  34 public:
  35         void set_frame (FrameTime t) {
  36                 _frame = t;
  37                 _metric = boost::optional<MetricTime> ();
  38         }
  39
  40         void set_metric (MetricTime t) {
  41                 _metric = t;
  42                 _frame = boost::optional<FrameTime> ();
  43         }
  44
  45         boost::optional<FrameTime> frame () const {
  46                 return _frame;
  47         }
  48
  49         boost::optional<MetricTime> metric () const {
  50                 return _metric;
  51         }
  52
  53         FrameTime  frame  (float frames_per_second) const;
  54         MetricTime metric (float frames_per_second) const;
  55
  56         bool operator== (TimePair const & other) const;
  57
  58 private:
  59         boost::optional<FrameTime> _frame;
  60         boost::optional<MetricTime> _metric;
  61 };
  62
  63 std::ostream& operator<< (std::ostream & s, TimePair const &);
  64
  65 }
  66
  67 #endif