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