libs/evoral/evoral/TimeConverter.hpp

   1 /* This file is part of Evoral.
   2  * Copyright (C) 2009 David Robillard <http://drobilla.net>
   3  * Copyright (C) 2009 Paul Davis
   4  *
   5  * Evoral is free software; you can redistribute it and/or modify it under the
   6  * terms of the GNU General Public License as published by the Free Software
   7  * Foundation; either version 2 of the License, or (at your option) any later
   8  * version.
   9  *
  10  * Evoral is distributed in the hope that it will be useful, but WITHOUT ANY
  11  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  12  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  17  */
  18
  19 #ifndef EVORAL_TIME_CONVERTER_HPP
  20 #define EVORAL_TIME_CONVERTER_HPP
  21
  22 #include "evoral/visibility.h"
  23
  24 namespace Evoral {
  25
  26 /** A bidirectional converter between two different time units.
  27  *
  28  * Think of the conversion method names as if they are written in-between
  29  * the two template parameters (i.e. "A <name> B").
  30  *
  31  * _origin_b should be the origin for conversion in the units of B.
  32  * That is, there is some point in time _origin_b, such that:
  33  *
  34  *    to()   converts a time _origin_b + a into an offset from _origin_b in units of B.
  35  *    from() converts a time _origin_b + b into an offset from _origin_b in units of A.
  36  */
  37 template<typename A, typename B>
  38 class LIBEVORAL_TEMPLATE_API TimeConverter {
  39 public:
  40         TimeConverter () : _origin_b (0) {}
  41         TimeConverter (B ob) : _origin_b (ob) {}
  42         virtual ~TimeConverter();
  43
  44         /** Convert A time to B time (A to B) */
  45         virtual B to(A a) const = 0;
  46
  47         /** Convert B time to A time (A from B) */
  48         virtual A from(B b) const = 0;
  49
  50         B origin_b () const {
  51                 return _origin_b;
  52         }
  53
  54         void set_origin_b (B o) {
  55                 _origin_b = o;
  56         }
  57
  58 protected:
  59         B _origin_b;
  60 };
  61
  62
  63 /** A stub TimeConverter that simple statically casts between types.
  64  *  _origin_b has no bearing here, as there is no time conversion
  65  *  going on.
  66  */
  67 template<typename A, typename B>
  68 class LIBEVORAL_TEMPLATE_API IdentityConverter : public TimeConverter<A,B> {
  69   public:
  70         IdentityConverter() {}
  71
  72         B to(A a)   const;
  73         A from(B b) const;
  74 };
  75
  76
  77 } // namespace Evoral
  78
  79 #endif // EVORAL_TIME_CONVERTER_HPP