fix up file renaming code a little bit
[ArdourMidi.git] / libs / ardour / monitor_processor.cc
blob6faf46a64de858f069d0a069c6092bb4a3c65f62
1 #include "pbd/convert.h"
2 #include "pbd/error.h"
3 #include "pbd/xml++.h"
5 #include "ardour/amp.h"
6 #include "ardour/dB.h"
7 #include "ardour/debug.h"
8 #include "ardour/audio_buffer.h"
9 #include "ardour/monitor_processor.h"
10 #include "ardour/session.h"
12 #include "i18n.h"
14 using namespace ARDOUR;
15 using namespace PBD;
16 using namespace std;
18 /* specialize for bool because of set_value() semantics */
20 namespace ARDOUR {
21 template<> void MPControl<bool>::set_value (float v) {
22 bool newval = fabs (v) >= 0.5;
23 if (newval != _value) {
24 _value = newval;
25 Changed(); /* EMIT SIGNAL */
30 MonitorProcessor::MonitorProcessor (Session& s)
31 : Processor (s, X_("MonitorOut"))
32 , solo_cnt (0)
34 , _dim_all_ptr (new MPControl<bool> (false, _("monitor dim"), Controllable::Toggle))
35 , _cut_all_ptr (new MPControl<bool> (false, _("monitor cut"), Controllable::Toggle))
36 , _mono_ptr (new MPControl<bool> (false, _("monitor mono"), Controllable::Toggle))
37 , _dim_level_ptr (new MPControl<volatile gain_t>
38 (0.2, _("monitor mono"), Controllable::Flag (0), 0.0f, 1.0f))
39 , _solo_boost_level_ptr (new MPControl<volatile gain_t>
40 (1.0, _("monitor mono"), Controllable::Flag (0), 1.0f, 3.0f))
42 , _dim_all_control (_dim_all_ptr)
43 , _cut_all_control (_cut_all_ptr)
44 , _mono_control (_mono_ptr)
45 , _dim_level_control (_dim_level_ptr)
46 , _solo_boost_level_control (_solo_boost_level_ptr)
48 , _dim_all (*_dim_all_ptr)
49 , _cut_all (*_cut_all_ptr)
50 , _mono (*_mono_ptr)
51 , _dim_level (*_dim_level_ptr)
52 , _solo_boost_level (*_solo_boost_level_ptr)
57 MonitorProcessor::~MonitorProcessor ()
59 allocate_channels (0);
62 void
63 MonitorProcessor::allocate_channels (uint32_t size)
65 while (_channels.size() > size) {
66 if (_channels.back()->soloed) {
67 if (solo_cnt > 0) {
68 --solo_cnt;
71 ChannelRecord* cr = _channels.back();
72 _channels.pop_back();
73 delete cr;
76 uint32_t n = _channels.size() + 1;
78 while (_channels.size() < size) {
79 _channels.push_back (new ChannelRecord (n));
83 int
84 MonitorProcessor::set_state (const XMLNode& node, int version)
86 int ret = Processor::set_state (node, version);
88 if (ret != 0) {
89 return ret;
92 const XMLProperty* prop;
94 if ((prop = node.property (X_("type"))) == 0) {
95 error << string_compose (X_("programming error: %1"), X_("MonitorProcessor XML settings have no type information"))
96 << endmsg;
97 return -1;
100 if (prop->value() != X_("monitor")) {
101 error << string_compose (X_("programming error: %1"), X_("MonitorProcessor given unknown XML settings"))
102 << endmsg;
103 return -1;
106 if ((prop = node.property (X_("channels"))) == 0) {
107 error << string_compose (X_("programming error: %1"), X_("MonitorProcessor XML settings are missing a channel cnt"))
108 << endmsg;
109 return -1;
112 allocate_channels (atoi (prop->value()));
114 if ((prop = node.property (X_("dim-level"))) != 0) {
115 gain_t val = atof (prop->value());
116 _dim_level = val;
119 if ((prop = node.property (X_("solo-boost-level"))) != 0) {
120 gain_t val = atof (prop->value());
121 _solo_boost_level = val;
124 if ((prop = node.property (X_("cut-all"))) != 0) {
125 bool val = string_is_affirmative (prop->value());
126 _cut_all = val;
128 if ((prop = node.property (X_("dim-all"))) != 0) {
129 bool val = string_is_affirmative (prop->value());
130 _dim_all = val;
132 if ((prop = node.property (X_("mono"))) != 0) {
133 bool val = string_is_affirmative (prop->value());
134 _mono = val;
137 for (XMLNodeList::const_iterator i = node.children().begin(); i != node.children().end(); ++i) {
139 if ((*i)->name() == X_("Channel")) {
140 if ((prop = (*i)->property (X_("id"))) == 0) {
141 error << string_compose (X_("programming error: %1"), X_("MonitorProcessor XML settings are missing an ID"))
142 << endmsg;
143 return -1;
146 uint32_t chn;
148 if (sscanf (prop->value().c_str(), "%u", &chn) != 1) {
149 error << string_compose (X_("programming error: %1"), X_("MonitorProcessor XML settings has an unreadable channel ID"))
150 << endmsg;
151 return -1;
154 if (chn >= _channels.size()) {
155 error << string_compose (X_("programming error: %1"), X_("MonitorProcessor XML settings has an illegal channel count"))
156 << endmsg;
157 return -1;
159 ChannelRecord& cr (*_channels[chn]);
161 if ((prop = (*i)->property ("cut")) != 0) {
162 if (string_is_affirmative (prop->value())){
163 cr.cut = 0.0f;
164 } else {
165 cr.cut = 1.0f;
169 if ((prop = (*i)->property ("dim")) != 0) {
170 bool val = string_is_affirmative (prop->value());
171 cr.dim = val;
174 if ((prop = (*i)->property ("invert")) != 0) {
175 if (string_is_affirmative (prop->value())) {
176 cr.polarity = -1.0f;
177 } else {
178 cr.polarity = 1.0f;
182 if ((prop = (*i)->property ("solo")) != 0) {
183 bool val = string_is_affirmative (prop->value());
184 cr.soloed = val;
189 /* reset solo cnt */
191 solo_cnt = 0;
193 for (vector<ChannelRecord*>::const_iterator x = _channels.begin(); x != _channels.end(); ++x) {
194 if ((*x)->soloed) {
195 solo_cnt++;
199 return 0;
202 XMLNode&
203 MonitorProcessor::state (bool full)
205 XMLNode& node (Processor::state (full));
206 char buf[64];
208 /* this replaces any existing "type" property */
210 node.add_property (X_("type"), X_("monitor"));
212 snprintf (buf, sizeof(buf), "%.12g", _dim_level.val());
213 node.add_property (X_("dim-level"), buf);
215 snprintf (buf, sizeof(buf), "%.12g", _solo_boost_level.val());
216 node.add_property (X_("solo-boost-level"), buf);
218 node.add_property (X_("cut-all"), (_cut_all ? "yes" : "no"));
219 node.add_property (X_("dim-all"), (_dim_all ? "yes" : "no"));
220 node.add_property (X_("mono"), (_mono ? "yes" : "no"));
222 uint32_t limit = _channels.size();
224 snprintf (buf, sizeof (buf), "%u", limit);
225 node.add_property (X_("channels"), buf);
227 XMLNode* chn_node;
228 uint32_t chn = 0;
230 for (vector<ChannelRecord*>::const_iterator x = _channels.begin(); x != _channels.end(); ++x, ++chn) {
231 chn_node = new XMLNode (X_("Channel"));
233 snprintf (buf, sizeof (buf), "%u", chn);
234 chn_node->add_property ("id", buf);
236 chn_node->add_property (X_("cut"), (*x)->cut == 1.0f ? "no" : "yes");
237 chn_node->add_property (X_("invert"), (*x)->polarity == 1.0f ? "no" : "yes");
238 chn_node->add_property (X_("dim"), (*x)->dim ? "yes" : "no");
239 chn_node->add_property (X_("solo"), (*x)->soloed ? "yes" : "no");
241 node.add_child_nocopy (*chn_node);
244 return node;
247 void
248 MonitorProcessor::run (BufferSet& bufs, sframes_t /*start_frame*/, sframes_t /*end_frame*/, nframes_t nframes, bool /*result_required*/)
250 uint32_t chn = 0;
251 gain_t target_gain;
252 gain_t dim_level_this_time = _dim_level;
253 gain_t global_cut = (_cut_all ? 0.0f : 1.0f);
254 gain_t global_dim = (_dim_all ? dim_level_this_time : 1.0f);
255 gain_t solo_boost;
257 if (_session.listening() || _session.soloing()) {
258 solo_boost = _solo_boost_level;
259 } else {
260 solo_boost = 1.0;
263 for (BufferSet::audio_iterator b = bufs.audio_begin(); b != bufs.audio_end(); ++b) {
265 /* don't double-scale by both track dim and global dim coefficients */
267 gain_t dim_level = (global_dim == 1.0 ? (_channels[chn]->dim ? dim_level_this_time : 1.0) : 1.0);
269 if (_channels[chn]->soloed) {
270 target_gain = _channels[chn]->polarity * _channels[chn]->cut * dim_level * global_cut * global_dim * solo_boost;
271 } else {
272 if (solo_cnt == 0) {
273 target_gain = _channels[chn]->polarity * _channels[chn]->cut * dim_level * global_cut * global_dim * solo_boost;
274 } else {
275 target_gain = 0.0;
279 DEBUG_TRACE (DEBUG::Monitor,
280 string_compose("channel %1 SB %12 sb %2 gc %3 gd %4 cd %5 dl %6 cp %7 cc %8 cs %9 sc %10 TG %11\n",
281 chn,
282 solo_boost,
283 global_cut,
284 global_dim,
285 _channels[chn]->dim,
286 dim_level,
287 _channels[chn]->polarity,
288 _channels[chn]->cut,
289 _channels[chn]->soloed,
290 solo_cnt,
291 target_gain,
292 (float) _solo_boost_level.val()
295 if (target_gain != _channels[chn]->current_gain || target_gain != 1.0f) {
297 Amp::apply_gain (*b, nframes, _channels[chn]->current_gain, target_gain);
298 _channels[chn]->current_gain = target_gain;
301 ++chn;
304 if (_mono) {
305 DEBUG_TRACE (DEBUG::Monitor, "mono-izing\n");
307 /* chn is now the number of channels, use as a scaling factor when mixing
309 gain_t scale = 1.0/chn;
310 BufferSet::audio_iterator b = bufs.audio_begin();
311 AudioBuffer& ab (*b);
312 Sample* buf = ab.data();
314 /* scale the first channel */
316 for (nframes_t n = 0; n < nframes; ++n) {
317 buf[n] *= scale;
320 /* add every other channel into the first channel's buffer */
322 ++b;
323 for (; b != bufs.audio_end(); ++b) {
324 AudioBuffer& ob (*b);
325 Sample* obuf = ob.data ();
326 for (nframes_t n = 0; n < nframes; ++n) {
327 buf[n] += obuf[n] * scale;
331 /* copy the first channel to every other channel's buffer */
333 b = bufs.audio_begin();
334 ++b;
335 for (; b != bufs.audio_end(); ++b) {
336 AudioBuffer& ob (*b);
337 Sample* obuf = ob.data ();
338 memcpy (obuf, buf, sizeof (Sample) * nframes);
343 bool
344 MonitorProcessor::configure_io (ChanCount in, ChanCount out)
346 allocate_channels (in.n_audio());
347 return Processor::configure_io (in, out);
350 bool
351 MonitorProcessor::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
353 return in == out;
356 void
357 MonitorProcessor::set_polarity (uint32_t chn, bool invert)
359 if (invert) {
360 _channels[chn]->polarity = -1.0f;
361 } else {
362 _channels[chn]->polarity = 1.0f;
366 void
367 MonitorProcessor::set_dim (uint32_t chn, bool yn)
369 _channels[chn]->dim = yn;
372 void
373 MonitorProcessor::set_cut (uint32_t chn, bool yn)
375 if (yn) {
376 _channels[chn]->cut = 0.0f;
377 } else {
378 _channels[chn]->cut = 1.0f;
382 void
383 MonitorProcessor::set_solo (uint32_t chn, bool solo)
385 if (solo != _channels[chn]->soloed) {
386 _channels[chn]->soloed = solo;
388 if (solo) {
389 solo_cnt++;
390 } else {
391 if (solo_cnt > 0) {
392 solo_cnt--;
398 void
399 MonitorProcessor::set_mono (bool yn)
401 _mono = yn;
404 void
405 MonitorProcessor::set_cut_all (bool yn)
407 _cut_all = yn;
410 void
411 MonitorProcessor::set_dim_all (bool yn)
413 _dim_all = yn;
416 bool
417 MonitorProcessor::display_to_user () const
419 return false;
422 void
423 MonitorProcessor::set_dim_level (gain_t val)
425 _dim_level = val;
428 void
429 MonitorProcessor::set_solo_boost_level (gain_t val)
431 _solo_boost_level = val;
434 bool
435 MonitorProcessor::soloed (uint32_t chn) const
437 return _channels[chn]->soloed;
441 bool
442 MonitorProcessor::inverted (uint32_t chn) const
444 return _channels[chn]->polarity < 0.0f;
448 bool
449 MonitorProcessor::cut (uint32_t chn) const
451 return _channels[chn]->cut == 0.0f;
454 bool
455 MonitorProcessor::dimmed (uint32_t chn) const
457 return _channels[chn]->dim;
460 bool
461 MonitorProcessor::mono () const
463 return _mono;
466 bool
467 MonitorProcessor::dim_all () const
469 return _dim_all;
472 bool
473 MonitorProcessor::cut_all () const
475 return _cut_all;
478 boost::shared_ptr<Controllable>
479 MonitorProcessor::channel_cut_control (uint32_t chn) const
481 if (chn < _channels.size()) {
482 return _channels[chn]->cut_control;
484 return boost::shared_ptr<Controllable>();
487 boost::shared_ptr<Controllable>
488 MonitorProcessor::channel_dim_control (uint32_t chn) const
490 if (chn < _channels.size()) {
491 return _channels[chn]->dim_control;
493 return boost::shared_ptr<Controllable>();
496 boost::shared_ptr<Controllable>
497 MonitorProcessor::channel_polarity_control (uint32_t chn) const
499 if (chn < _channels.size()) {
500 return _channels[chn]->polarity_control;
502 return boost::shared_ptr<Controllable>();
505 boost::shared_ptr<Controllable>
506 MonitorProcessor::channel_solo_control (uint32_t chn) const
508 if (chn < _channels.size()) {
509 return _channels[chn]->soloed_control;
511 return boost::shared_ptr<Controllable>();
514 MonitorProcessor::ChannelRecord::ChannelRecord (uint32_t chn)
515 : current_gain (1.0)
516 , cut_ptr (new MPControl<gain_t> (1.0, string_compose (_("cut control %1"), chn), PBD::Controllable::GainLike))
517 , dim_ptr (new MPControl<bool> (false, string_compose (_("dim control"), chn), PBD::Controllable::Toggle))
518 , polarity_ptr (new MPControl<gain_t> (1.0, string_compose (_("polarity control"), chn), PBD::Controllable::Toggle))
519 , soloed_ptr (new MPControl<bool> (false, string_compose (_("solo control"), chn), PBD::Controllable::Toggle))
521 , cut_control (cut_ptr)
522 , dim_control (dim_ptr)
523 , polarity_control (polarity_ptr)
524 , soloed_control (soloed_ptr)
526 , cut (*cut_ptr)
527 , dim (*dim_ptr)
528 , polarity (*polarity_ptr)
529 , soloed (*soloed_ptr)