libs/pbd/pbd/controllable_descriptor.h

   1 /*
   2     Copyright (C) 2009 Paul Davis
   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 #ifndef __pbd_controllable_descriptor_h__
  20 #define __pbd_controllable_descriptor_h__
  21
  22 #include <vector>
  23 #include <string>
  24 #include <stdint.h>
  25
  26 namespace PBD {
  27
  28 class ControllableDescriptor {
  29 public:
  30     enum TopLevelType {
  31             RemoteControlID,
  32             NamedRoute
  33     };
  34
  35     enum SubType {
  36             Gain,
  37             Solo,
  38             Mute,
  39             Recenable,
  40             PanDirection,
  41             PanWidth,
  42             PanElevation,
  43             Balance,
  44             SendGain,
  45             PluginParameter
  46     };
  47
  48     ControllableDescriptor ()
  49             : _top_level_type (RemoteControlID)
  50             , _subtype (Gain)
  51             , _rid (0)
  52             , _banked (false)
  53             , _bank_offset (0)
  54     {}
  55
  56     int set (const std::string&);
  57
  58     /* it is only valid to call top_level_name() if top_level_type() returns
  59        NamedRoute
  60     */
  61
  62     TopLevelType top_level_type() const { return _top_level_type; }
  63     const std::string& top_level_name() const { return _top_level_name; }
  64
  65     SubType subtype() const { return _subtype; }
  66
  67     uint32_t rid() const;
  68     uint32_t target (uint32_t n) const;
  69     bool banked() const { return _banked; }
  70
  71     void set_bank_offset (uint32_t o) { _bank_offset = o; }
  72
  73 private:
  74     TopLevelType          _top_level_type;
  75     SubType               _subtype;
  76     std::string           _top_level_name;
  77     uint32_t              _rid;
  78     std::vector<uint32_t> _target;
  79     uint32_t              _banked;
  80     uint32_t              _bank_offset;
  81 };
  82
  83 }
  84
  85 #endif /* __pbd_controllable_descriptor_h__ */