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         TimePair () {}
  36
  37         TimePair (FrameTime t)
  38                 : _frame (t)
  39         {}
  40
  41         TimePair (MetricTime t)
  42                 : _metric (t)
  43         {}
  44
  45         void set_frame (FrameTime t) {
  46                 _frame = t;
  47                 _metric = boost::optional<MetricTime> ();
  48         }
  49
  50         void set_metric (MetricTime t) {
  51                 _metric = t;
  52                 _frame = boost::optional<FrameTime> ();
  53         }
  54
  55         boost::optional<FrameTime> frame () const {
  56                 return _frame;
  57         }
  58
  59         boost::optional<MetricTime> metric () const {
  60                 return _metric;
  61         }
  62
  63         FrameTime  frame  (float fps) const;
  64         MetricTime metric (float fps) const;
  65
  66         void add (FrameTime t, float fps);
  67         void scale (float f, float fps);
  68
  69         bool operator== (TimePair const & other) const;
  70
  71 private:
  72         boost::optional<FrameTime> _frame;
  73         boost::optional<MetricTime> _metric;
  74 };
  75
  76 std::ostream& operator<< (std::ostream & s, TimePair const &);
  77
  78 }
  79
  80 #endif