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 #include "ardour/types.h"
  28
  29 namespace ARDOUR {
  30
  31 class LIBARDOUR_API ControllableDescriptor {
  32 public:
  33     enum TopLevelType {
  34             PresentationOrderRoute,
  35             PresentationOrderTrack,
  36             PresentationOrderBus,
  37             PresentationOrderVCA,
  38             NamedRoute,
  39             SelectionCount,
  40     };
  41
  42     ControllableDescriptor ()
  43             : _top_level_type (PresentationOrderRoute)
  44             , _subtype (GainAutomation)
  45             , _banked (false)
  46             , _bank_offset (0)
  47     {}
  48
  49     int set (const std::string&);
  50
  51     /* it is only valid to call top_level_name() if top_level_type() returns
  52        NamedRoute
  53     */
  54
  55     TopLevelType top_level_type() const { return _top_level_type; }
  56     const std::string& top_level_name() const { return _top_level_name; }
  57
  58     AutomationType subtype() const { return _subtype; }
  59
  60     uint32_t presentation_order() const;
  61     uint32_t selection_id() const;
  62     uint32_t target (uint32_t n) const;
  63     bool banked() const { return _banked; }
  64
  65     void set_bank_offset (uint32_t o) { _bank_offset = o; }
  66
  67 private:
  68     TopLevelType          _top_level_type;
  69     AutomationType        _subtype;
  70     std::string           _top_level_name;
  71     union {
  72             uint32_t  _presentation_order;
  73             uint32_t  _selection_id;
  74     };
  75     std::vector<uint32_t> _target;
  76     uint32_t              _banked;
  77     uint32_t              _bank_offset;
  78 };
  79
  80 }
  81
  82 #endif /* __libardour_controllable_descriptor_h__ */