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             Pan,
  41             Balance,
  42             SendGain,
  43             PluginParameter
  44     };
  45
  46     ControllableDescriptor ()
  47             : _top_level_type (RemoteControlID)
  48             , _subtype (Gain)
  49             , _rid (0)
  50             , _banked (false)
  51             , _bank_offset (0)
  52     {}
  53
  54     int set (const std::string&);
  55
  56     /* it is only valid to call top_level_name() if top_level_type() returns
  57        NamedRoute
  58     */
  59
  60     TopLevelType top_level_type() const { return _top_level_type; }
  61     const std::string& top_level_name() const { return _top_level_name; }
  62
  63     SubType subtype() const { return _subtype; }
  64
  65     uint32_t rid() const;
  66     uint32_t target (uint32_t n) const;
  67     bool banked() const { return _banked; }
  68
  69     void set_bank_offset (uint32_t o) { _bank_offset = o; }
  70
  71 private:
  72     TopLevelType          _top_level_type;
  73     SubType               _subtype;
  74     std::string           _top_level_name;
  75     uint32_t              _rid;
  76     std::vector<uint32_t> _target;
  77     uint32_t              _banked;
  78     uint32_t              _bank_offset;
  79 };
  80
  81 }
  82
  83 #endif /* __pbd_controllable_descriptor_h__ */