libs/evoral/evoral/TimeConverter.hpp

   1 /* This file is part of Evoral.
   2  * Copyright (C) 2009 Dave 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 namespace Evoral {
  23
  24 /** A bidirectional converter between two different time units.
  25  *
  26  * Think of the conversion method names as if they are written in-between
  27  * the two template parameters (i.e. "A <name> B").
  28  */
  29 template<typename A, typename B>
  30 class TimeConverter {
  31 public:
  32         TimeConverter (B ob = 0) : _origin_b (ob) {}
  33         virtual ~TimeConverter() {}
  34
  35         /** Convert A time to B time (A to B) */
  36         virtual B to(A a) const = 0;
  37
  38         /** Convert B time to A time (A from B) */
  39         virtual A from(B b) const = 0;
  40
  41         B origin_b () const {
  42                 return _origin_b;
  43         }
  44
  45         void set_origin_b (B o) {
  46                 _origin_b = o;
  47         }
  48
  49 protected:
  50         B _origin_b;
  51 };
  52
  53
  54 /** A stub TimeConverter that simple statically casts between types. */
  55 template<typename A, typename B>
  56 class IdentityConverter : public TimeConverter<A,B> {
  57         B to(A a)   const { return static_cast<B>(a); }
  58         A from(B b) const { return static_cast<A>(b); }
  59 };
  60
  61
  62 } // namespace Evoral
  63
  64 #endif // EVORAL_TIME_CONVERTER_HPP