libs/evoral/evoral/TypeMap.hpp

   1 /* This file is part of Evoral.
   2  * Copyright (C) 2008 David Robillard <http://drobilla.net>
   3  * Copyright (C) 2000-2008 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_TYPE_MAP_HPP
  20 #define EVORAL_TYPE_MAP_HPP
  21
  22 #include <stdint.h>
  23
  24 #include <string>
  25
  26 #include "evoral/visibility.h"
  27
  28 namespace Evoral {
  29
  30 class Parameter;
  31 class ParameterDescriptor;
  32
  33 /** The applications passes one of these which provide the implementation
  34  * with required information about event types in an opaque, type neutral way
  35  */
  36 class /*LIBEVORAL_API*/ TypeMap {
  37 public:
  38         virtual ~TypeMap() {}
  39
  40         /** Return true iff the type is a MIDI event.
  41          * The contents of the event will be used for specific ID
  42          */
  43         virtual bool type_is_midi(uint32_t type) const = 0;
  44
  45         /** Return the MIDI type (ie status byte with channel 0) for a
  46          * parameter, or 0 if parameter can not be expressed as a MIDI event
  47          */
  48         virtual uint8_t parameter_midi_type(const Parameter& param) const = 0;
  49
  50         /** The type ID for a MIDI event with the given status byte
  51          */
  52         virtual uint32_t midi_event_type(uint8_t status) const = 0;
  53
  54         /** Return the description of a parameter. */
  55         virtual const ParameterDescriptor& descriptor(const Parameter& param) const = 0;
  56
  57         virtual std::string to_symbol(const Parameter& param) const = 0;
  58 };
  59
  60 } // namespace Evoral
  61
  62 #endif // EVORAL_TYPE_MAP_HPP