1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
/*
Copyright (C) 2016 Paul Davis
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#ifndef __libardour_stripable_h__
#define __libardour_stripable_h__
#include <stdint.h>
#include <string>
#include <boost/utility.hpp>
#include <boost/shared_ptr.hpp>
#include "pbd/signals.h"
#include "ardour/presentation_info.h"
#include "ardour/session_object.h"
#include "ardour/libardour_visibility.h"
namespace ARDOUR {
class AutomationControl;
class GainControl;
class PeakMeter;
class SoloControl;
class MuteControl;
class PhaseControl;
class SoloIsolateControl;
class SoloSafeControl;
class MonitorControl;
class MonitorProcessor;
class RecordEnableControl;
class RecordSafeControl;
/* This is a virtual base class for any object that needs to be potentially
* represented by a control-centric user interface using the general model of a
* mixing console "strip" - a collection of controls that determine the state
* and behaviour of the object.
*/
class LIBARDOUR_API Stripable : public SessionObject {
public:
Stripable (Session& session, std::string const & name, PresentationInfo const &);
virtual ~Stripable () {}
/* XXX
midi on/off
*/
bool is_auditioner() const { return _presentation_info.flags() & PresentationInfo::Auditioner; }
bool is_master() const { return _presentation_info.flags() & PresentationInfo::MasterOut; }
bool is_monitor() const { return _presentation_info.flags() & PresentationInfo::MonitorOut; }
int set_state (XMLNode const&, int);
bool is_hidden() const { return _presentation_info.flags() & PresentationInfo::Hidden; }
bool is_selected() const { return _presentation_info.flags() & PresentationInfo::Selected; }
PresentationInfo const & presentation_info () const { return _presentation_info; }
PresentationInfo& presentation_info () { return _presentation_info; }
PresentationInfo* presentation_info_ptr () { return &_presentation_info; }
/* set just the order */
void set_presentation_order (PresentationInfo::order_t, bool notify_class_listeners = true);
struct PresentationOrderSorter {
bool operator() (boost::shared_ptr<Stripable> a, boost::shared_ptr<Stripable> b) {
return a->presentation_info().order() < b->presentation_info().order();
}
};
/* gui's call this for their own purposes. */
PBD::Signal2<void,std::string,void*> gui_changed;
/***************************************************************
* Pure interface begins here
***************************************************************/
virtual boost::shared_ptr<PeakMeter> peak_meter() = 0;
virtual boost::shared_ptr<const PeakMeter> peak_meter() const = 0;
virtual boost::shared_ptr<GainControl> gain_control() const = 0;
virtual boost::shared_ptr<SoloControl> solo_control() const = 0;
virtual boost::shared_ptr<SoloIsolateControl> solo_isolate_control() const = 0;
virtual boost::shared_ptr<SoloSafeControl> solo_safe_control() const = 0;
virtual boost::shared_ptr<MuteControl> mute_control() const = 0;
virtual boost::shared_ptr<PhaseControl> phase_control() const = 0;
virtual boost::shared_ptr<GainControl> trim_control() const = 0;
virtual boost::shared_ptr<MonitorControl> monitoring_control() const = 0;
virtual boost::shared_ptr<AutomationControl> rec_enable_control() const { return boost::shared_ptr<AutomationControl>(); }
virtual boost::shared_ptr<AutomationControl> rec_safe_control() const { return boost::shared_ptr<AutomationControl>(); }
/* "well-known" controls for panning. Any or all of these may return
* null.
*/
virtual boost::shared_ptr<AutomationControl> pan_azimuth_control() const = 0;
virtual boost::shared_ptr<AutomationControl> pan_elevation_control() const = 0;
virtual boost::shared_ptr<AutomationControl> pan_width_control() const = 0;
virtual boost::shared_ptr<AutomationControl> pan_frontback_control() const = 0;
virtual boost::shared_ptr<AutomationControl> pan_lfe_control() const = 0;
/* "well-known" controls for an EQ in this route. Any or all may
* be null. eq_band_cnt() must return 0 if there is no EQ present.
* Passing an @param band value >= eq_band_cnt() will guarantee the
* return of a null ptr (or an empty string for eq_band_name()).
*/
virtual uint32_t eq_band_cnt () const = 0;
virtual std::string eq_band_name (uint32_t) const = 0;
virtual boost::shared_ptr<AutomationControl> eq_gain_controllable (uint32_t band) const = 0;
virtual boost::shared_ptr<AutomationControl> eq_freq_controllable (uint32_t band) const = 0;
virtual boost::shared_ptr<AutomationControl> eq_q_controllable (uint32_t band) const = 0;
virtual boost::shared_ptr<AutomationControl> eq_shape_controllable (uint32_t band) const = 0;
virtual boost::shared_ptr<AutomationControl> eq_enable_controllable () const = 0;
virtual boost::shared_ptr<AutomationControl> eq_hpf_controllable () const = 0;
/* "well-known" controls for a compressor in this route. Any or all may
* be null.
*/
virtual boost::shared_ptr<AutomationControl> comp_enable_controllable () const = 0;
virtual boost::shared_ptr<AutomationControl> comp_threshold_controllable () const = 0;
virtual boost::shared_ptr<AutomationControl> comp_speed_controllable () const = 0;
virtual boost::shared_ptr<AutomationControl> comp_mode_controllable () const = 0;
virtual boost::shared_ptr<AutomationControl> comp_makeup_controllable () const = 0;
virtual boost::shared_ptr<AutomationControl> comp_redux_controllable () const = 0;
/* @param mode must be supplied by the comp_mode_controllable(). All other values
* result in undefined behaviour
*/
virtual std::string comp_mode_name (uint32_t mode) const = 0;
/* @param mode - as for comp mode name. This returns the name for the
* parameter/control accessed via comp_speed_controllable(), which can
* be mode dependent.
*/
virtual std::string comp_speed_name (uint32_t mode) const = 0;
/* "well-known" controls for sends to well-known busses in this route. Any or all may
* be null.
*
* In Mixbus, these are the sends that connect to the mixbusses.
* In Ardour, these are user-created sends that connect to user-created
* Aux busses.
*/
virtual boost::shared_ptr<AutomationControl> send_level_controllable (uint32_t n) const = 0;
virtual boost::shared_ptr<AutomationControl> send_enable_controllable (uint32_t n) const = 0;
/* for the same value of @param n, this returns the name of the send
* associated with the pair of controllables returned by the above two methods.
*/
virtual std::string send_name (uint32_t n) const = 0;
/* well known control that enables/disables sending to the master bus.
*
* In Ardour, this returns null.
* In Mixbus, it will return a suitable control, or null depending on
* the route.
*/
virtual boost::shared_ptr<AutomationControl> master_send_enable_controllable () const = 0;
virtual bool muted_by_others_soloing () const = 0;
virtual boost::shared_ptr<MonitorProcessor> monitor_control() const = 0;
protected:
PresentationInfo _presentation_info;
};
}
#endif /* __libardour_stripable_h__ */
|
