OSC: catch bad commands on /cue/* created crash on exit
[ardour.git] / libs / surfaces / osc / osc_global_observer.cc
1 /*
2     Copyright (C) 2009 Paul Davis
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 #include "boost/lambda/lambda.hpp"
21
22 #include "pbd/control_math.h"
23
24 #include "ardour/amp.h"
25 #include "ardour/session.h"
26 #include "ardour/dB.h"
27 #include "ardour/meter.h"
28 #include "ardour/monitor_processor.h"
29
30 #include "osc.h"
31 #include "osc_global_observer.h"
32
33 #include "pbd/i18n.h"
34
35 using namespace std;
36 using namespace PBD;
37 using namespace ARDOUR;
38 using namespace ArdourSurface;
39
40 OSCGlobalObserver::OSCGlobalObserver (OSC& o, Session& s, ArdourSurface::OSC::OSCSurface* su)
41         : _osc (o)
42         ,sur (su)
43         ,_init (true)
44         ,_last_master_gain (0.0)
45         ,_last_master_trim (0.0)
46         ,_last_monitor_gain (0.0)
47         ,last_punchin (4)
48         ,last_punchout (4)
49         ,last_click (4)
50 {
51         addr = lo_address_new_from_url  (sur->remote_url.c_str());
52         session = &s;
53         gainmode = sur->gainmode;
54         feedback = sur->feedback;
55         _last_sample = -1;
56         if (feedback[4]) {
57
58                 // connect to all the things we want to send feed back from
59
60                 /*
61                 *       Master (todo)
62                 *               Pan width
63                 */
64
65                 // Master channel first
66                 _osc.text_message (X_("/master/name"), "Master", addr);
67                 boost::shared_ptr<Stripable> strip = session->master_out();
68
69                 boost::shared_ptr<Controllable> mute_controllable = boost::dynamic_pointer_cast<Controllable>(strip->mute_control());
70                 mute_controllable->Changed.connect (strip_connections, MISSING_INVALIDATOR, boost::bind (&OSCGlobalObserver::send_change_message, this, X_("/master/mute"), strip->mute_control()), OSC::instance());
71                 send_change_message ("/master/mute", strip->mute_control());
72
73                 boost::shared_ptr<Controllable> trim_controllable = boost::dynamic_pointer_cast<Controllable>(strip->trim_control());
74                 trim_controllable->Changed.connect (strip_connections, MISSING_INVALIDATOR, boost::bind (&OSCGlobalObserver::send_trim_message, this, X_("/master/trimdB"), strip->trim_control()), OSC::instance());
75                 send_trim_message ("/master/trimdB", strip->trim_control());
76
77                 boost::shared_ptr<Controllable> pan_controllable = boost::dynamic_pointer_cast<Controllable>(strip->pan_azimuth_control());
78                 if (pan_controllable) {
79                         pan_controllable->Changed.connect (strip_connections, MISSING_INVALIDATOR, boost::bind (&OSCGlobalObserver::send_change_message, this, X_("/master/pan_stereo_position"), strip->pan_azimuth_control()), OSC::instance());
80                         send_change_message ("/master/pan_stereo_position", strip->pan_azimuth_control());
81                 }
82
83                 boost::shared_ptr<Controllable> gain_controllable = boost::dynamic_pointer_cast<Controllable>(strip->gain_control());
84                 gain_controllable->Changed.connect (strip_connections, MISSING_INVALIDATOR, boost::bind (&OSCGlobalObserver::send_gain_message, this, X_("/master/"), strip->gain_control()), OSC::instance());
85                 send_gain_message ("/master/", strip->gain_control());
86
87                 // monitor stuff next
88                 strip = session->monitor_out();
89                 if (strip) {
90                         _osc.text_message (X_("/monitor/name"), "Monitor", addr);
91
92                         boost::shared_ptr<Controllable> mon_mute_cont = strip->monitor_control()->cut_control();
93                         mon_mute_cont->Changed.connect (strip_connections, MISSING_INVALIDATOR, boost::bind (&OSCGlobalObserver::send_change_message, this, X_("/monitor/mute"), mon_mute_cont), OSC::instance());
94                         send_change_message ("/monitor/mute", mon_mute_cont);
95
96                         boost::shared_ptr<Controllable> mon_dim_cont = strip->monitor_control()->dim_control();
97                         mon_dim_cont->Changed.connect (strip_connections, MISSING_INVALIDATOR, boost::bind (&OSCGlobalObserver::send_change_message, this, X_("/monitor/dim"), mon_dim_cont), OSC::instance());
98                         send_change_message ("/monitor/dim", mon_dim_cont);
99
100                         boost::shared_ptr<Controllable> mon_mono_cont = strip->monitor_control()->mono_control();
101                         mon_mono_cont->Changed.connect (strip_connections, MISSING_INVALIDATOR, boost::bind (&OSCGlobalObserver::send_change_message, this, X_("/monitor/mono"), mon_mono_cont), OSC::instance());
102                         send_change_message ("/monitor/mono", mon_mono_cont);
103
104                         gain_controllable = boost::dynamic_pointer_cast<Controllable>(strip->gain_control());
105                                 gain_controllable->Changed.connect (strip_connections, MISSING_INVALIDATOR, boost::bind (&OSCGlobalObserver::send_gain_message, this, X_("/monitor/"), strip->gain_control()), OSC::instance());
106                                 send_gain_message ("/monitor/", strip->gain_control());
107                 }
108
109                 //Transport feedback
110                 session->TransportStateChange.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&OSCGlobalObserver::send_transport_state_changed, this), OSC::instance());
111                 send_transport_state_changed ();
112                 session->TransportLooped.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&OSCGlobalObserver::send_transport_state_changed, this), OSC::instance());
113                 session->RecordStateChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&OSCGlobalObserver::send_record_state_changed, this), OSC::instance());
114                 send_record_state_changed ();
115
116                 // session feedback
117                 session->StateSaved.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&OSCGlobalObserver::session_name, this, X_("/session_name"), _1), OSC::instance());
118                 session_name (X_("/session_name"), session->snap_name());
119                 session->SoloActive.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&OSCGlobalObserver::solo_active, this, _1), OSC::instance());
120                 solo_active (session->soloing() || session->listening());
121
122                 boost::shared_ptr<Controllable> click_controllable = boost::dynamic_pointer_cast<Controllable>(session->click_gain()->gain_control());
123                 click_controllable->Changed.connect (strip_connections, MISSING_INVALIDATOR, boost::bind (&OSCGlobalObserver::send_change_message, this, X_("/click/level"), click_controllable), OSC::instance());
124                 send_change_message ("/click/level", click_controllable);
125
126                 extra_check ();
127
128                 /*
129                 *       Maybe (many) more
130                 */
131         }
132         _init = false;
133 }
134
135 OSCGlobalObserver::~OSCGlobalObserver ()
136 {
137         _init = true;
138
139         // need to add general zero everything messages
140         strip_connections.drop_connections ();
141         session_connections.drop_connections ();
142
143         lo_address_free (addr);
144 }
145
146 void
147 OSCGlobalObserver::clear_observer ()
148 {
149         strip_connections.drop_connections ();
150         session_connections.drop_connections ();
151         _osc.text_message (X_("/master/name"), " ", addr);
152         _osc.text_message (X_("/monitor/name"), " ", addr);
153         _osc.text_message (X_("/session_name"), " ", addr);
154         if (feedback[6]) { // timecode enabled
155                 _osc.text_message (X_("/position/smpte"), " ", addr);
156         }
157         if (feedback[5]) { // Bar beat enabled
158                 _osc.text_message (X_("/position/bbt"), " ", addr);
159         }
160         if (feedback[11]) { // minutes/seconds enabled
161                 _osc.text_message (X_("/position/time"), " ", addr);
162         }
163         if (feedback[10]) { // samples
164                 _osc.text_message (X_("/position/samples"), " ", addr);
165         }
166         if (feedback[3]) { //heart beat enabled
167                 _osc.float_message (X_("/heartbeat"), 0.0, addr);
168         }
169         if (feedback[7] || feedback[8]) { // meters enabled
170                 float meter = 0;
171                 if (feedback[7] && !gainmode) {
172                         meter = -193;
173                 }
174                 _osc.float_message (X_("/master/meter"), meter, addr);
175         }
176         if (feedback[9]) {
177                 _osc.float_message (X_("/master/signal"), 0, addr);
178         }
179         _osc.float_message ("/master/fader", 0, addr);
180         _osc.float_message ("/monitor/fader", 0, addr);
181         _osc.float_message ("/master/gain", -193, addr);
182         _osc.float_message ("/monitor/gain", -193, addr);
183         _osc.float_message (X_("/master/trimdB"), 0, addr);
184         _osc.float_message ("/master/mute", 0, addr);
185         _osc.float_message ("/master/pan_stereo_position", 0.5, addr);
186         _osc.float_message ("/monitor/mute", 0, addr);
187         _osc.float_message ("/monitor/dim", 0, addr);
188         _osc.float_message ("/monitor/mono", 0, addr);
189         _osc.float_message (X_("/loop_toggle"), 0, addr);
190         _osc.float_message (X_("/transport_play"), 0, addr);
191         _osc.float_message (X_("/transport_stop"), 0, addr);
192         _osc.float_message (X_("/toggle_roll"), 0, addr);
193         _osc.float_message (X_("/rewind"), 0, addr);
194         _osc.float_message (X_("/ffwd"), 0, addr);
195         _osc.float_message (X_("/record_tally"), 0, addr);
196         _osc.float_message (X_("/rec_enable_toggle"), 0, addr);
197         _osc.float_message (X_("/cancel_all_solos"), 0, addr);
198         _osc.float_message (X_("/toggle_punch_out"), 0, addr);
199         _osc.float_message (X_("/toggle_punch_in"), 0, addr);
200         _osc.float_message (X_("/toggle_click"), 0, addr);
201         _osc.float_message (X_("/click/level"), 0, addr);
202
203
204 }
205
206 void
207 OSCGlobalObserver::tick ()
208 {
209         if (_init) {
210                 return;
211         }
212         samplepos_t now_sample = session->transport_sample();
213         if (now_sample != _last_sample) {
214                 if (feedback[6]) { // timecode enabled
215                         Timecode::Time timecode;
216                         session->timecode_time (now_sample, timecode);
217
218                         // Timecode mode: Hours/Minutes/Seconds/Samples
219                         ostringstream os;
220                         os << setw(2) << setfill('0') << timecode.hours;
221                         os << ':';
222                         os << setw(2) << setfill('0') << timecode.minutes;
223                         os << ':';
224                         os << setw(2) << setfill('0') << timecode.seconds;
225                         os << ':';
226                         os << setw(2) << setfill('0') << timecode.frames;
227
228                         _osc.text_message ("/position/smpte", os.str(), addr);
229                 }
230                 if (feedback[5]) { // Bar beat enabled
231                         Timecode::BBT_Time bbt_time;
232
233                         session->bbt_time (now_sample, bbt_time);
234
235                         // semantics:  BBB/bb/tttt
236                         ostringstream os;
237
238                         os << setw(3) << setfill('0') << bbt_time.bars;
239                         os << '|';
240                         os << setw(2) << setfill('0') << bbt_time.beats;
241                         os << '|';
242                         os << setw(4) << setfill('0') << bbt_time.ticks;
243
244                         _osc.text_message ("/position/bbt", os.str(), addr);
245                 }
246                 if (feedback[11]) { // minutes/seconds enabled
247                         samplepos_t left = now_sample;
248                         int hrs = (int) floor (left / (session->sample_rate() * 60.0f * 60.0f));
249                         left -= (samplecnt_t) floor (hrs * session->sample_rate() * 60.0f * 60.0f);
250                         int mins = (int) floor (left / (session->sample_rate() * 60.0f));
251                         left -= (samplecnt_t) floor (mins * session->sample_rate() * 60.0f);
252                         int secs = (int) floor (left / (float) session->sample_rate());
253                         left -= (samplecnt_t) floor ((double)(secs * session->sample_rate()));
254                         int millisecs = floor (left * 1000.0 / (float) session->sample_rate());
255
256                         // Min/sec mode: Hours/Minutes/Seconds/msec
257                         ostringstream os;
258                         os << setw(2) << setfill('0') << hrs;
259                         os << ':';
260                         os << setw(2) << setfill('0') << mins;
261                         os << ':';
262                         os << setw(2) << setfill('0') << secs;
263                         os << '.';
264                         os << setw(3) << setfill('0') << millisecs;
265
266                         _osc.text_message ("/position/time", os.str(), addr);
267                 }
268                 if (feedback[10]) { // samples
269                         ostringstream os;
270                         os << now_sample;
271                         _osc.text_message ("/position/samples", os.str(), addr);
272                 }
273                 _last_sample = now_sample;
274         }
275         if (feedback[3]) { //heart beat enabled
276                 if (_heartbeat == 10) {
277                         _osc.float_message (X_("/heartbeat"), 1.0, addr);
278                 }
279                 if (!_heartbeat) {
280                         _osc.float_message (X_("/heartbeat"), 0.0, addr);
281                 }
282                 _heartbeat++;
283                 if (_heartbeat > 20) _heartbeat = 0;
284         }
285         if (feedback[7] || feedback[8] || feedback[9]) { // meters enabled
286                 // the only meter here is master
287                 float now_meter = session->master_out()->peak_meter()->meter_level(0, MeterMCP);
288                 if (now_meter < -94) now_meter = -193;
289                 if (_last_meter != now_meter) {
290                         if (feedback[7] || feedback[8]) {
291                                 if (gainmode && feedback[7]) {
292                                         // change from db to 0-1
293                                         _osc.float_message (X_("/master/meter"), ((now_meter + 94) / 100), addr);
294                                 } else if ((!gainmode) && feedback[7]) {
295                                         _osc.float_message (X_("/master/meter"), now_meter, addr);
296                                 } else if (feedback[8]) {
297                                         uint32_t ledlvl = (uint32_t)(((now_meter + 54) / 3.75)-1);
298                                         uint32_t ledbits = ~(0xfff<<ledlvl);
299                                         _osc.float_message (X_("/master/meter"), ledbits, addr);
300                                 }
301                         }
302                         if (feedback[9]) {
303                                 float signal;
304                                 if (now_meter < -40) {
305                                         signal = 0;
306                                 } else {
307                                         signal = 1;
308                                 }
309                                 _osc.float_message (X_("/master/signal"), signal, addr);
310                         }
311                 }
312                 _last_meter = now_meter;
313
314         }
315         if (feedback[4]) {
316                 if (master_timeout) {
317                         if (master_timeout == 1) {
318                                 _osc.text_message (X_("/master/name"), "Master", addr);
319                         }
320                         master_timeout--;
321                 }
322                 if (monitor_timeout) {
323                         if (monitor_timeout == 1) {
324                                 _osc.text_message (X_("/monitor/name"), "Monitor", addr);
325                         }
326                         monitor_timeout--;
327                 }
328                 extra_check ();
329         }
330 }
331
332 void
333 OSCGlobalObserver::send_change_message (string path, boost::shared_ptr<Controllable> controllable)
334 {
335         float val = controllable->get_value();
336         _osc.float_message (path, (float) controllable->internal_to_interface (val), addr);
337 }
338
339 void
340 OSCGlobalObserver::session_name (string path, string name)
341 {
342         _osc.text_message (path, name, addr);
343 }
344
345 void
346 OSCGlobalObserver::send_gain_message (string path, boost::shared_ptr<Controllable> controllable)
347 {
348         bool ismaster = false;
349         if (path.find("master") != std::string::npos) {
350                 ismaster = true;
351                 if (_last_master_gain != controllable->get_value()) {
352                         _last_master_gain = controllable->get_value();
353                 } else {
354                         return;
355                 }
356         } else {
357                 if (_last_monitor_gain != controllable->get_value()) {
358                         _last_monitor_gain = controllable->get_value();
359                 } else {
360                         return;
361                 }
362         }
363         if (gainmode) {
364                 _osc.float_message (string_compose ("%1fader", path), controllable->internal_to_interface (controllable->get_value()), addr);
365                 _osc.text_message (string_compose ("%1name", path), string_compose ("%1%2%3", std::fixed, std::setprecision(2), accurate_coefficient_to_dB (controllable->get_value())), addr);
366                 if (ismaster) {
367                         master_timeout = 8;
368                 } else {
369                         monitor_timeout = 8;
370                 }
371
372         } else {
373                 if (controllable->get_value() < 1e-15) {
374                         _osc.float_message (string_compose ("%1gain",path), -200, addr);
375                 } else {
376                         _osc.float_message (string_compose ("%1gain",path), accurate_coefficient_to_dB (controllable->get_value()), addr);
377                 }
378         }
379 }
380
381 void
382 OSCGlobalObserver::send_trim_message (string path, boost::shared_ptr<Controllable> controllable)
383 {
384         if (_last_master_trim != controllable->get_value()) {
385                 _last_master_trim = controllable->get_value();
386         } else {
387                 return;
388         }
389         _osc.float_message (X_("/master/trimdB"), (float) accurate_coefficient_to_dB (controllable->get_value()), addr);
390 }
391
392
393 void
394 OSCGlobalObserver::send_transport_state_changed()
395 {
396         _osc.float_message (X_("/loop_toggle"), session->get_play_loop(), addr);
397         _osc.float_message (X_("/transport_play"), session->transport_speed() == 1.0, addr);
398         _osc.float_message (X_("/toggle_roll"), session->transport_speed() == 1.0, addr);
399         _osc.float_message (X_("/transport_stop"), session->transport_stopped(), addr);
400         _osc.float_message (X_("/rewind"), session->transport_speed() < 0.0, addr);
401         _osc.float_message (X_("/ffwd"), (session->transport_speed() != 1.0 && session->transport_speed() > 0.0), addr);
402 }
403
404 void
405 OSCGlobalObserver::send_record_state_changed ()
406 {
407         _osc.float_message (X_("/rec_enable_toggle"), (int)session->get_record_enabled (), addr);
408
409         if (session->have_rec_enabled_track ()) {
410                 _osc.float_message (X_("/record_tally"), 1, addr);
411         } else {
412                 _osc.float_message (X_("/record_tally"), 0, addr);
413         }
414 }
415
416 void
417 OSCGlobalObserver::solo_active (bool active)
418 {
419         _osc.float_message (X_("/cancel_all_solos"), (float) active, addr);
420 }
421
422 void
423 OSCGlobalObserver::extra_check ()
424 {
425         if (last_punchin != session->config.get_punch_in()) {
426                 last_punchin = session->config.get_punch_in();
427                 _osc.float_message (X_("/toggle_punch_in"), last_punchin, addr);
428         }
429         if (last_punchout != session->config.get_punch_out()) {
430                 last_punchout = session->config.get_punch_out();
431                 _osc.float_message (X_("/toggle_punch_out"), last_punchout, addr);
432         }
433         if (last_click != Config->get_clicking()) {
434                 last_click = Config->get_clicking();
435                 _osc.float_message (X_("/toggle_click"), last_click, addr);
436         }
437 }
438