libs/ardour/ardour/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 __libardour_controllable_descriptor_h__
  20 #define __libardour_controllable_descriptor_h__
  21
  22 #include <vector>
  23 #include <string>
  24 #include <stdint.h>
  25
  26 #include "ardour/libardour_visibility.h"
  27
  28 namespace ARDOUR {
  29
  30 class LIBARDOUR_API ControllableDescriptor {
  31 public:
  32     enum TopLevelType {
  33             PresentationOrderRoute,
  34             PresentationOrderVCA,
  35             NamedRoute,
  36             SelectionCount,
  37     };
  38
  39     enum SubType {
  40             Gain,
  41             Trim,
  42             Solo,
  43             Mute,
  44             Recenable,
  45             PanDirection,
  46             PanWidth,
  47             PanElevation,
  48             Balance,
  49             SendGain,
  50             PluginParameter
  51     };
  52
  53     ControllableDescriptor ()
  54             : _top_level_type (PresentationOrderRoute)
  55             , _subtype (Gain)
  56             , _banked (false)
  57             , _bank_offset (0)
  58     {}
  59
  60     int set (const std::string&);
  61
  62     /* it is only valid to call top_level_name() if top_level_type() returns
  63        NamedRoute
  64     */
  65
  66     TopLevelType top_level_type() const { return _top_level_type; }
  67     const std::string& top_level_name() const { return _top_level_name; }
  68
  69     SubType subtype() const { return _subtype; }
  70
  71     uint32_t presentation_order() const;
  72     uint32_t selection_id() const;
  73     uint32_t target (uint32_t n) const;
  74     bool banked() const { return _banked; }
  75
  76     void set_bank_offset (uint32_t o) { _bank_offset = o; }
  77
  78 private:
  79     TopLevelType          _top_level_type;
  80     SubType               _subtype;
  81     std::string           _top_level_name;
  82     union {
  83             uint32_t  _presentation_order;
  84             uint32_t  _selection_id;
  85     };
  86     std::vector<uint32_t> _target;
  87     uint32_t              _banked;
  88     uint32_t              _bank_offset;
  89 };
  90
  91 }
  92
  93 #endif /* __libardour_controllable_descriptor_h__ */