libs/surfaces/control_protocol/control_protocol/control_protocol.h

   1 /*
   2     Copyright (C) 2006 Paul Davis
   3
   4     This program is free software; you can redistribute it
   5     and/or modify it under the terms of the GNU Lesser
   6     General Public License as published by the Free Software
   7     Foundation; either version 2 of the License, or (at your
   8     option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 #ifndef ardour_control_protocols_h
  22 #define ardour_control_protocols_h
  23
  24 #include <string>
  25 #include <vector>
  26 #include <list>
  27 #include <boost/shared_ptr.hpp>
  28 #include "pbd/stateful.h"
  29 #include "pbd/signals.h"
  30 #include "control_protocol/basic_ui.h"
  31
  32 namespace ARDOUR {
  33
  34 class Route;
  35 class Session;
  36 class Bundle;
  37
  38 class ControlProtocol : virtual public sigc::trackable, public PBD::Stateful, public PBD::ScopedConnectionList, public BasicUI {
  39   public:
  40         ControlProtocol (Session&, std::string name, PBD::EventLoop* event_loop);
  41         virtual ~ControlProtocol();
  42
  43         std::string name() const { return _name; }
  44
  45         virtual int set_active (bool yn) = 0;
  46         bool get_active() const { return _active; }
  47
  48         virtual int set_feedback (bool /*yn*/) { return 0; }
  49         virtual bool get_feedback () const { return false; }
  50
  51         virtual void route_list_changed () {}
  52
  53         PBD::Signal0<void> ActiveChanged;
  54
  55         /* signals that a control protocol can emit and other (presumably graphical)
  56            user interfaces can respond to
  57         */
  58
  59         static PBD::Signal0<void> ZoomToSession;
  60         static PBD::Signal0<void> ZoomIn;
  61         static PBD::Signal0<void> ZoomOut;
  62         static PBD::Signal0<void> Enter;
  63         static PBD::Signal0<void> Undo;
  64         static PBD::Signal0<void> Redo;
  65         static PBD::Signal1<void,float> ScrollTimeline;
  66         static PBD::Signal1<void,uint32_t> SelectByRID;
  67
  68         /* the model here is as follows:
  69
  70            we imagine most control surfaces being able to control
  71            from 1 to N tracks at a time, with a session that may
  72            contain 1 to M tracks, where M may be smaller, larger or
  73            equal to N.
  74
  75            the control surface has a fixed set of physical controllers
  76            which can potentially be mapped onto different tracks/busses
  77            via some mechanism.
  78
  79            therefore, the control protocol object maintains
  80            a table that reflects the current mapping between
  81            the controls and route object.
  82         */
  83
  84         void set_route_table_size (uint32_t size);
  85         void set_route_table (uint32_t table_index, boost::shared_ptr<ARDOUR::Route>);
  86         bool set_route_table (uint32_t table_index, uint32_t remote_control_id);
  87
  88         void route_set_rec_enable (uint32_t table_index, bool yn);
  89         bool route_get_rec_enable (uint32_t table_index);
  90
  91         float route_get_gain (uint32_t table_index);
  92         void route_set_gain (uint32_t table_index, float);
  93         float route_get_effective_gain (uint32_t table_index);
  94
  95         float route_get_peak_input_power (uint32_t table_index, uint32_t which_input);
  96
  97         bool route_get_muted (uint32_t table_index);
  98         void route_set_muted (uint32_t table_index, bool);
  99
 100         bool route_get_soloed (uint32_t table_index);
 101         void route_set_soloed (uint32_t table_index, bool);
 102
 103         std::string route_get_name (uint32_t table_index);
 104
 105         virtual std::list<boost::shared_ptr<ARDOUR::Bundle> > bundles ();
 106
 107         virtual bool  has_editor () const { return false; }
 108         virtual void* get_gui() const { return 0; }
 109         virtual void  tear_down_gui() { }
 110
 111   protected:
 112         PBD::EventLoop* _event_loop;
 113         bool _own_event_loop;
 114         std::vector<boost::shared_ptr<ARDOUR::Route> > route_table;
 115         std::string _name;
 116         bool _active;
 117
 118         void add_strip (std::list<boost::shared_ptr<ARDOUR::Route> >&);
 119
 120         void next_track (uint32_t initial_id);
 121         void prev_track (uint32_t initial_id);
 122
 123   private:
 124         ControlProtocol (const ControlProtocol&); /* noncopyable */
 125 };
 126
 127 extern "C" {
 128         struct ControlProtocolDescriptor {
 129             const char* name;      /* descriptive */
 130             const char* id;        /* unique and version-specific */
 131             void*       ptr;       /* protocol can store a value here */
 132             void*       module;    /* not for public access */
 133             int         mandatory; /* if non-zero, always load and do not make optional */
 134             bool        supports_feedback; /* if true, protocol has toggleable feedback mechanism */
 135             bool             (*probe)(ControlProtocolDescriptor*);
 136             ControlProtocol* (*initialize)(ControlProtocolDescriptor*,Session*);
 137             void             (*destroy)(ControlProtocolDescriptor*,ControlProtocol*);
 138
 139         };
 140 }
 141
 142 }
 143
 144 #endif // ardour_control_protocols_h