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::Signal1
<void,float> ScrollTimeline
;
64 static PBD::Signal1
<void,uint32_t> SelectByRID
;
66 /* the model here is as follows:
68 we imagine most control surfaces being able to control
69 from 1 to N tracks at a time, with a session that may
70 contain 1 to M tracks, where M may be smaller, larger or
73 the control surface has a fixed set of physical controllers
74 which can potentially be mapped onto different tracks/busses
77 therefore, the control protocol object maintains
78 a table that reflects the current mapping between
79 the controls and route object.
82 void set_route_table_size (uint32_t size
);
83 void set_route_table (uint32_t table_index
, boost::shared_ptr
<ARDOUR::Route
>);
84 bool set_route_table (uint32_t table_index
, uint32_t remote_control_id
);
86 void route_set_rec_enable (uint32_t table_index
, bool yn
);
87 bool route_get_rec_enable (uint32_t table_index
);
89 float route_get_gain (uint32_t table_index
);
90 void route_set_gain (uint32_t table_index
, float);
91 float route_get_effective_gain (uint32_t table_index
);
93 float route_get_peak_input_power (uint32_t table_index
, uint32_t which_input
);
95 bool route_get_muted (uint32_t table_index
);
96 void route_set_muted (uint32_t table_index
, bool);
98 bool route_get_soloed (uint32_t table_index
);
99 void route_set_soloed (uint32_t table_index
, bool);
101 std::string
route_get_name (uint32_t table_index
);
103 virtual std::list
<boost::shared_ptr
<ARDOUR::Bundle
> > bundles ();
105 virtual bool has_editor () const { return false; }
106 virtual void* get_gui() const { return 0; }
107 virtual void tear_down_gui() { }
110 PBD::EventLoop
* _event_loop
;
111 bool _own_event_loop
;
112 std::vector
<boost::shared_ptr
<ARDOUR::Route
> > route_table
;
116 void add_strip (std::list
<boost::shared_ptr
<ARDOUR::Route
> >&);
118 void next_track (uint32_t initial_id
);
119 void prev_track (uint32_t initial_id
);
122 ControlProtocol (const ControlProtocol
&); /* noncopyable */
126 struct ControlProtocolDescriptor
{
127 const char* name
; /* descriptive */
128 const char* id
; /* unique and version-specific */
129 void* ptr
; /* protocol can store a value here */
130 void* module
; /* not for public access */
131 int mandatory
; /* if non-zero, always load and do not make optional */
132 bool supports_feedback
; /* if true, protocol has toggleable feedback mechanism */
133 bool (*probe
)(ControlProtocolDescriptor
*);
134 ControlProtocol
* (*initialize
)(ControlProtocolDescriptor
*,Session
*);
135 void (*destroy
)(ControlProtocolDescriptor
*,ControlProtocol
*);
142 #endif // ardour_control_protocols_h