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