2 Copyright (C) 2006 Paul Davis
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.
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.
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.
21 #ifndef ardour_control_protocols_h
22 #define ardour_control_protocols_h
27 #include <boost/shared_ptr.hpp>
28 #include "pbd/stateful.h"
29 #include "pbd/signals.h"
30 #include "control_protocol/basic_ui.h"
38 class ControlProtocol : virtual public sigc::trackable, public PBD::Stateful, public PBD::ScopedConnectionList, public BasicUI {
40 ControlProtocol (Session&, std::string name, PBD::EventLoop* event_loop);
41 virtual ~ControlProtocol();
43 std::string name() const { return _name; }
45 virtual int set_active (bool yn) = 0;
46 bool get_active() const { return _active; }
48 virtual int set_feedback (bool /*yn*/) { return 0; }
49 virtual bool get_feedback () const { return false; }
51 virtual void route_list_changed () {}
53 PBD::Signal0<void> ActiveChanged;
55 /* signals that a control protocol can emit and other (presumably graphical)
56 user interfaces can respond to
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 static PBD::Signal0<void> UnselectTrack;
68 static PBD::Signal1<void,uint32_t> GotoView;
69 static PBD::Signal0<void> CloseDialog;
70 static PBD::Signal0<void> VerticalZoomInAll;
71 static PBD::Signal0<void> VerticalZoomOutAll;
72 static PBD::Signal0<void> VerticalZoomInSelected;
73 static PBD::Signal0<void> VerticalZoomOutSelected;
75 /* the model here is as follows:
77 we imagine most control surfaces being able to control
78 from 1 to N tracks at a time, with a session that may
79 contain 1 to M tracks, where M may be smaller, larger or
82 the control surface has a fixed set of physical controllers
83 which can potentially be mapped onto different tracks/busses
86 therefore, the control protocol object maintains
87 a table that reflects the current mapping between
88 the controls and route object.
91 void set_route_table_size (uint32_t size);
92 void set_route_table (uint32_t table_index, boost::shared_ptr<ARDOUR::Route>);
93 bool set_route_table (uint32_t table_index, uint32_t remote_control_id);
95 void route_set_rec_enable (uint32_t table_index, bool yn);
96 bool route_get_rec_enable (uint32_t table_index);
98 float route_get_gain (uint32_t table_index);
99 void route_set_gain (uint32_t table_index, float);
100 float route_get_effective_gain (uint32_t table_index);
102 float route_get_peak_input_power (uint32_t table_index, uint32_t which_input);
104 bool route_get_muted (uint32_t table_index);
105 void route_set_muted (uint32_t table_index, bool);
107 bool route_get_soloed (uint32_t table_index);
108 void route_set_soloed (uint32_t table_index, bool);
110 std::string route_get_name (uint32_t table_index);
112 virtual std::list<boost::shared_ptr<ARDOUR::Bundle> > bundles ();
114 virtual bool has_editor () const { return false; }
115 virtual void* get_gui() const { return 0; }
116 virtual void tear_down_gui() { }
119 PBD::EventLoop* _event_loop;
120 bool _own_event_loop;
121 std::vector<boost::shared_ptr<ARDOUR::Route> > route_table;
125 void add_strip (std::list<boost::shared_ptr<ARDOUR::Route> >&);
127 void next_track (uint32_t initial_id);
128 void prev_track (uint32_t initial_id);
131 ControlProtocol (const ControlProtocol&); /* noncopyable */
135 struct ControlProtocolDescriptor {
136 const char* name; /* descriptive */
137 const char* id; /* unique and version-specific */
138 void* ptr; /* protocol can store a value here */
139 void* module; /* not for public access */
140 int mandatory; /* if non-zero, always load and do not make optional */
141 bool supports_feedback; /* if true, protocol has toggleable feedback mechanism */
142 bool (*probe)(ControlProtocolDescriptor*);
143 ControlProtocol* (*initialize)(ControlProtocolDescriptor*,Session*);
144 void (*destroy)(ControlProtocolDescriptor*,ControlProtocol*);
151 #endif // ardour_control_protocols_h