2 * Copyright (C) 2006 Paul Davis
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.
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.
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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
28 #include "pbd/gstdio_compat.h"
29 #include <glibmm/miscutils.h>
31 #include <pbd/convert.h>
32 #include <pbd/pthread_utils.h>
33 #include <pbd/file_utils.h>
34 #include <pbd/failed_constructor.h>
36 #include "ardour/amp.h"
37 #include "ardour/session.h"
38 #include "ardour/route.h"
39 #include "ardour/audio_track.h"
40 #include "ardour/midi_track.h"
41 #include "ardour/dB.h"
42 #include "ardour/filesystem_paths.h"
43 #include "ardour/panner.h"
44 #include "ardour/plugin.h"
45 #include "ardour/plugin_insert.h"
46 #include "ardour/send.h"
49 #include "osc_controllable.h"
50 #include "osc_route_observer.h"
53 using namespace ARDOUR;
56 using namespace ArdourSurface;
58 #include "pbd/abstract_ui.cc" // instantiate template
60 OSC* OSC::_instance = 0;
63 static void error_callback(int num, const char *m, const char *path)
65 fprintf(stderr, "liblo server error %d in path %s: %s\n", num, path, m);
68 static void error_callback(int, const char *, const char *)
74 OSC::OSC (Session& s, uint32_t port)
75 : ControlProtocol (s, X_("Open Sound Control (OSC)"))
76 , AbstractUI<OSCUIRequest> (name())
83 , _osc_unix_server (0)
84 , _namespace_root ("/ardour")
85 , _send_route_changes (true)
91 session->Exported.connect (*this, MISSING_INVALIDATOR, boost::bind (&OSC::session_exported, this, _1, _2), this);
101 OSC::request_factory (uint32_t num_requests)
103 /* AbstractUI<T>::request_buffer_factory() is a template method only
104 instantiated in this source module. To provide something visible for
105 use in the interface/descriptor, we have this static method that is
108 return request_buffer_factory (num_requests);
112 OSC::do_request (OSCUIRequest* req)
114 if (req->type == CallSlot) {
116 call_slot (MISSING_INVALIDATOR, req->the_slot);
118 } else if (req->type == Quit) {
125 OSC::set_active (bool yn)
127 if (yn != active()) {
141 return ControlProtocol::set_active (yn);
145 OSC::get_active () const
147 return _osc_server != 0;
151 OSC::set_feedback (bool yn)
153 _send_route_changes = yn;
158 OSC::get_feedback () const
160 return _send_route_changes;
169 /* already started */
173 for (int j=0; j < 20; ++j) {
174 snprintf(tmpstr, sizeof(tmpstr), "%d", _port);
176 //if ((_osc_server = lo_server_new_with_proto (tmpstr, LO_TCP, error_callback))) {
180 if ((_osc_server = lo_server_new (tmpstr, error_callback))) {
185 cerr << "can't get osc at port: " << _port << endl;
195 #ifdef ARDOUR_OSC_UNIX_SERVER
197 // APPEARS sluggish for now
199 // attempt to create unix socket server too
201 snprintf(tmpstr, sizeof(tmpstr), "/tmp/sooperlooper_XXXXXX");
202 int fd = mkstemp(tmpstr);
208 _osc_unix_server = lo_server_new (tmpstr, error_callback);
210 if (_osc_unix_server) {
211 _osc_unix_socket_path = tmpstr;
216 PBD::info << "OSC @ " << get_server_url () << endmsg;
218 std::string url_file;
220 if (find_file (ardour_config_search_path(), "osc_url", url_file)) {
221 _osc_url_file = url_file;
222 if (g_file_set_contents (_osc_url_file.c_str(), get_server_url().c_str(), -1, NULL)) {
223 cerr << "Couldn't write '" << _osc_url_file << "'" <<endl;
227 register_callbacks();
229 session_loaded (*session);
231 // lo_server_thread_add_method(_sthread, NULL, NULL, OSC::_dummy_handler, this);
233 /* startup the event loop thread */
243 pthread_set_name (event_loop_name().c_str());
245 if (_osc_unix_server) {
246 Glib::RefPtr<IOSource> src = IOSource::create (lo_server_get_socket_fd (_osc_unix_server), IO_IN|IO_HUP|IO_ERR);
247 src->connect (sigc::bind (sigc::mem_fun (*this, &OSC::osc_input_handler), _osc_unix_server));
248 src->attach (_main_loop->get_context());
249 local_server = src->gobj();
250 g_source_ref (local_server);
254 #ifdef PLATFORM_WINDOWS
255 Glib::RefPtr<IOChannel> chan = Glib::IOChannel::create_from_win32_socket (lo_server_get_socket_fd (_osc_server));
256 Glib::RefPtr<IOSource> src = IOSource::create (chan, IO_IN|IO_HUP|IO_ERR);
258 Glib::RefPtr<IOSource> src = IOSource::create (lo_server_get_socket_fd (_osc_server), IO_IN|IO_HUP|IO_ERR);
260 src->connect (sigc::bind (sigc::mem_fun (*this, &OSC::osc_input_handler), _osc_server));
261 src->attach (_main_loop->get_context());
262 remote_server = src->gobj();
263 g_source_ref (remote_server);
266 PBD::notify_event_loops_about_thread_creation (pthread_self(), event_loop_name(), 2048);
267 SessionEvent::create_per_thread_pool (event_loop_name(), 128);
276 g_source_destroy (local_server);
277 g_source_unref (local_server);
282 g_source_destroy (remote_server);
283 g_source_unref (remote_server);
290 lo_server_free (_osc_server);
294 if (_osc_unix_server) {
295 lo_server_free (_osc_unix_server);
296 _osc_unix_server = 0;
299 if (!_osc_unix_socket_path.empty()) {
300 ::g_unlink (_osc_unix_socket_path.c_str());
303 if (!_osc_url_file.empty() ) {
304 ::g_unlink (_osc_url_file.c_str() );
307 // Delete any active route observers
308 for (RouteObservers::iterator x = route_observers.begin(); x != route_observers.end();) {
310 OSCRouteObserver* rc;
312 if ((rc = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
314 x = route_observers.erase (x);
324 OSC::register_callbacks()
329 srvs[0] = _osc_server;
330 srvs[1] = _osc_unix_server;
332 for (size_t i = 0; i < 2; ++i) {
341 #define REGISTER_CALLBACK(serv,path,types, function) lo_server_add_method (serv, path, types, OSC::_ ## function, this)
343 REGISTER_CALLBACK (serv, "/routes/list", "", routes_list);
344 REGISTER_CALLBACK (serv, "/ardour/add_marker", "", add_marker);
345 REGISTER_CALLBACK (serv, "/ardour/access_action", "s", access_action);
346 REGISTER_CALLBACK (serv, "/ardour/loop_toggle", "", loop_toggle);
347 REGISTER_CALLBACK (serv, "/ardour/loop_location", "ii", loop_location);
348 REGISTER_CALLBACK (serv, "/ardour/goto_start", "", goto_start);
349 REGISTER_CALLBACK (serv, "/ardour/goto_end", "", goto_end);
350 REGISTER_CALLBACK (serv, "/ardour/rewind", "", rewind);
351 REGISTER_CALLBACK (serv, "/ardour/ffwd", "", ffwd);
352 REGISTER_CALLBACK (serv, "/ardour/transport_stop", "", transport_stop);
353 REGISTER_CALLBACK (serv, "/ardour/transport_play", "", transport_play);
354 REGISTER_CALLBACK (serv, "/ardour/transport_frame", "", transport_frame);
355 REGISTER_CALLBACK (serv, "/ardour/transport_speed", "", transport_speed);
356 REGISTER_CALLBACK (serv, "/ardour/record_enabled", "", record_enabled);
357 REGISTER_CALLBACK (serv, "/ardour/set_transport_speed", "f", set_transport_speed);
358 REGISTER_CALLBACK (serv, "/ardour/locate", "ii", locate);
359 REGISTER_CALLBACK (serv, "/ardour/save_state", "", save_state);
360 REGISTER_CALLBACK (serv, "/ardour/prev_marker", "", prev_marker);
361 REGISTER_CALLBACK (serv, "/ardour/next_marker", "", next_marker);
362 REGISTER_CALLBACK (serv, "/ardour/undo", "", undo);
363 REGISTER_CALLBACK (serv, "/ardour/redo", "", redo);
364 REGISTER_CALLBACK (serv, "/ardour/toggle_punch_in", "", toggle_punch_in);
365 REGISTER_CALLBACK (serv, "/ardour/toggle_punch_out", "", toggle_punch_out);
366 REGISTER_CALLBACK (serv, "/ardour/rec_enable_toggle", "", rec_enable_toggle);
367 REGISTER_CALLBACK (serv, "/ardour/toggle_all_rec_enables", "", toggle_all_rec_enables);
368 REGISTER_CALLBACK (serv, "/ardour/all_tracks_rec_in", "f", all_tracks_rec_in);
369 REGISTER_CALLBACK (serv, "/ardour/all_tracks_rec_out", "f", all_tracks_rec_out);
370 REGISTER_CALLBACK (serv, "/ardour/remove_marker", "", remove_marker_at_playhead);
371 REGISTER_CALLBACK (serv, "/ardour/jump_bars", "f", jump_by_bars);
372 REGISTER_CALLBACK (serv, "/ardour/jump_seconds", "f", jump_by_seconds);
373 REGISTER_CALLBACK (serv, "/ardour/mark_in", "", mark_in);
374 REGISTER_CALLBACK (serv, "/ardour/mark_out", "", mark_out);
375 REGISTER_CALLBACK (serv, "/ardour/toggle_click", "", toggle_click);
376 REGISTER_CALLBACK (serv, "/ardour/midi_panic", "", midi_panic);
377 REGISTER_CALLBACK (serv, "/ardour/toggle_roll", "", toggle_roll);
378 REGISTER_CALLBACK (serv, "/ardour/stop_forget", "", stop_forget);
379 REGISTER_CALLBACK (serv, "/ardour/set_punch_range", "", set_punch_range);
380 REGISTER_CALLBACK (serv, "/ardour/set_loop_range", "", set_loop_range);
381 REGISTER_CALLBACK (serv, "/ardour/set_session_range", "", set_session_range);
382 REGISTER_CALLBACK (serv, "/ardour/toggle_monitor_mute", "", toggle_monitor_mute);
383 REGISTER_CALLBACK (serv, "/ardour/toggle_monitor_dim", "", toggle_monitor_dim);
384 REGISTER_CALLBACK (serv, "/ardour/toggle_monitor_mono", "", toggle_monitor_mono);
385 REGISTER_CALLBACK (serv, "/ardour/quick_snapshot_switch", "", quick_snapshot_switch);
386 REGISTER_CALLBACK (serv, "/ardour/quick_snapshot_stay", "", quick_snapshot_stay);
387 REGISTER_CALLBACK (serv, "/ardour/fit_1_track", "", fit_1_track);
388 REGISTER_CALLBACK (serv, "/ardour/fit_2_tracks", "", fit_2_tracks);
389 REGISTER_CALLBACK (serv, "/ardour/fit_4_tracks", "", fit_4_tracks);
390 REGISTER_CALLBACK (serv, "/ardour/fit_8_tracks", "", fit_8_tracks);
391 REGISTER_CALLBACK (serv, "/ardour/fit_16_tracks", "", fit_16_tracks);
392 REGISTER_CALLBACK (serv, "/ardour/fit_32_tracks", "", fit_32_tracks);
393 REGISTER_CALLBACK (serv, "/ardour/fit_all_tracks", "", fit_all_tracks);
394 REGISTER_CALLBACK (serv, "/ardour/zoom_100_ms", "", zoom_100_ms);
395 REGISTER_CALLBACK (serv, "/ardour/zoom_1_sec", "", zoom_1_sec);
396 REGISTER_CALLBACK (serv, "/ardour/zoom_10_sec", "", zoom_10_sec);
397 REGISTER_CALLBACK (serv, "/ardour/zoom_1_min", "", zoom_1_min);
398 REGISTER_CALLBACK (serv, "/ardour/zoom_5_min", "", zoom_5_min);
399 REGISTER_CALLBACK (serv, "/ardour/zoom_10_min", "", zoom_10_min);
400 REGISTER_CALLBACK (serv, "/ardour/zoom_to_session", "", zoom_to_session);
401 REGISTER_CALLBACK (serv, "/ardour/temporal_zoom_in", "f", temporal_zoom_in);
402 REGISTER_CALLBACK (serv, "/ardour/temporal_zoom_out", "f", temporal_zoom_out);
403 REGISTER_CALLBACK (serv, "/ardour/scroll_up_1_track", "f", scroll_up_1_track);
404 REGISTER_CALLBACK (serv, "/ardour/scroll_dn_1_track", "f", scroll_dn_1_track);
405 REGISTER_CALLBACK (serv, "/ardour/scroll_up_1_page", "f", scroll_up_1_page);
406 REGISTER_CALLBACK (serv, "/ardour/scroll_dn_1_page", "f", scroll_dn_1_page);
410 * NOTE: these messages are provided for (arguably broken) apps
411 * that MUST send float args ( TouchOSC and Lemur ).
412 * Normally these ardour transport messages don't require an argument,
413 * so we're providing redundant calls with vestigial "float" args.
415 * These controls are active on 1.0 only (to prevent duplicate action on
416 * press "/button 1", and release "/button 0")
417 * http://hexler.net/docs/touchosc-controls-reference
419 REGISTER_CALLBACK (serv, "/ardour/pushbutton/loop_toggle", "f", loop_toggle);
420 REGISTER_CALLBACK (serv, "/ardour/pushbutton/add_marker", "f", add_marker);
421 REGISTER_CALLBACK (serv, "/ardour/pushbutton/goto_start", "f", goto_start);
422 REGISTER_CALLBACK (serv, "/ardour/pushbutton/goto_end", "f", goto_end);
423 REGISTER_CALLBACK (serv, "/ardour/pushbutton/rewind", "f", rewind);
424 REGISTER_CALLBACK (serv, "/ardour/pushbutton/ffwd", "f", ffwd);
425 REGISTER_CALLBACK (serv, "/ardour/pushbutton/transport_stop", "f", transport_stop);
426 REGISTER_CALLBACK (serv, "/ardour/pushbutton/transport_play", "f", transport_play);
427 REGISTER_CALLBACK (serv, "/ardour/pushbutton/save_state", "f", save_state);
428 REGISTER_CALLBACK (serv, "/ardour/pushbutton/prev_marker", "f", prev_marker);
429 REGISTER_CALLBACK (serv, "/ardour/pushbutton/next_marker", "f", next_marker);
430 REGISTER_CALLBACK (serv, "/ardour/pushbutton/undo", "f", undo);
431 REGISTER_CALLBACK (serv, "/ardour/pushbutton/redo", "f", redo);
432 REGISTER_CALLBACK (serv, "/ardour/pushbutton/toggle_punch_in", "f", toggle_punch_in);
433 REGISTER_CALLBACK (serv, "/ardour/pushbutton/toggle_punch_out", "f", toggle_punch_out);
434 REGISTER_CALLBACK (serv, "/ardour/pushbutton/rec_enable_toggle", "f", rec_enable_toggle);
435 REGISTER_CALLBACK (serv, "/ardour/pushbutton/toggle_all_rec_enables", "f", toggle_all_rec_enables);
436 REGISTER_CALLBACK (serv, "/ardour/pushbutton/all_tracks_rec_in", "f", all_tracks_rec_in);
437 REGISTER_CALLBACK (serv, "/ardour/pushbutton/all_tracks_rec_out", "f", all_tracks_rec_out);
438 REGISTER_CALLBACK (serv, "/ardour/pushbutton/remove_marker", "f", remove_marker_at_playhead);
439 REGISTER_CALLBACK (serv, "/ardour/pushbutton/mark_in", "f", mark_in);
440 REGISTER_CALLBACK (serv, "/ardour/pushbutton/mark_out", "f", mark_out);
441 REGISTER_CALLBACK (serv, "/ardour/pushbutton/toggle_click", "f", toggle_click);
442 REGISTER_CALLBACK (serv, "/ardour/pushbutton/midi_panic", "f", midi_panic);
443 REGISTER_CALLBACK (serv, "/ardour/pushbutton/toggle_roll", "f", toggle_roll);
444 REGISTER_CALLBACK (serv, "/ardour/pushbutton/stop_forget", "f", stop_forget);
445 REGISTER_CALLBACK (serv, "/ardour/pushbutton/set_punch_range", "f", set_punch_range);
446 REGISTER_CALLBACK (serv, "/ardour/pushbutton/set_loop_range", "f", set_loop_range);
447 REGISTER_CALLBACK (serv, "/ardour/pushbutton/set_session_range", "f", set_session_range);
448 REGISTER_CALLBACK (serv, "/ardour/pushbutton/toggle_monitor_mute", "f", toggle_monitor_mute);
449 REGISTER_CALLBACK (serv, "/ardour/pushbutton/toggle_monitor_dim", "f", toggle_monitor_dim);
450 REGISTER_CALLBACK (serv, "/ardour/pushbutton/toggle_monitor_mono", "f", toggle_monitor_mono);
451 REGISTER_CALLBACK (serv, "/ardour/pushbutton/quick_snapshot_switch", "f", quick_snapshot_switch);
452 REGISTER_CALLBACK (serv, "/ardour/pushbutton/quick_snapshot_stay", "f", quick_snapshot_stay);
453 REGISTER_CALLBACK (serv, "/ardour/pushbutton/fit_1_track", "f", fit_1_track);
454 REGISTER_CALLBACK (serv, "/ardour/pushbutton/fit_2_tracks", "f", fit_2_tracks);
455 REGISTER_CALLBACK (serv, "/ardour/pushbutton/fit_4_tracks", "f", fit_4_tracks);
456 REGISTER_CALLBACK (serv, "/ardour/pushbutton/fit_8_tracks", "f", fit_8_tracks);
457 REGISTER_CALLBACK (serv, "/ardour/pushbutton/fit_16_tracks", "f", fit_16_tracks);
458 REGISTER_CALLBACK (serv, "/ardour/pushbutton/fit_32_tracks", "f", fit_32_tracks);
459 REGISTER_CALLBACK (serv, "/ardour/pushbutton/fit_all_tracks", "f", fit_all_tracks);
460 REGISTER_CALLBACK (serv, "/ardour/pushbutton/zoom_100_ms", "f", zoom_100_ms);
461 REGISTER_CALLBACK (serv, "/ardour/pushbutton/zoom_1_sec", "f", zoom_1_sec);
462 REGISTER_CALLBACK (serv, "/ardour/pushbutton/zoom_10_sec", "f", zoom_10_sec);
463 REGISTER_CALLBACK (serv, "/ardour/pushbutton/zoom_1_min", "f", zoom_1_min);
464 REGISTER_CALLBACK (serv, "/ardour/pushbutton/zoom_5_min", "f", zoom_5_min);
465 REGISTER_CALLBACK (serv, "/ardour/pushbutton/zoom_10_min", "f", zoom_10_min);
466 REGISTER_CALLBACK (serv, "/ardour/pushbutton/zoom_to_session", "f", zoom_to_session);
467 REGISTER_CALLBACK (serv, "/ardour/pushbutton/temporal_zoom_in", "f", temporal_zoom_in);
468 REGISTER_CALLBACK (serv, "/ardour/pushbutton/temporal_zoom_out", "f", temporal_zoom_out);
469 REGISTER_CALLBACK (serv, "/ardour/pushbutton/scroll_up_1_track", "f", scroll_up_1_track);
470 REGISTER_CALLBACK (serv, "/ardour/pushbutton/scroll_dn_1_track", "f", scroll_dn_1_track);
471 REGISTER_CALLBACK (serv, "/ardour/pushbutton/scroll_up_1_page", "f", scroll_up_1_page);
472 REGISTER_CALLBACK (serv, "/ardour/pushbutton/scroll_dn_1_page", "f", scroll_dn_1_page);
474 /* These commands require the route index in addition to the arg; TouchOSC (et al) can't use these */
475 REGISTER_CALLBACK (serv, "/ardour/routes/mute", "ii", route_mute);
476 REGISTER_CALLBACK (serv, "/ardour/routes/solo", "ii", route_solo);
477 REGISTER_CALLBACK (serv, "/ardour/routes/recenable", "ii", route_recenable);
478 REGISTER_CALLBACK (serv, "/ardour/routes/gainabs", "if", route_set_gain_abs);
479 REGISTER_CALLBACK (serv, "/ardour/routes/gaindB", "if", route_set_gain_dB);
480 REGISTER_CALLBACK (serv, "/ardour/routes/gainVCA", "if", route_set_gain_VCA);
481 REGISTER_CALLBACK (serv, "/ardour/routes/trimabs", "if", route_set_trim_abs);
482 REGISTER_CALLBACK (serv, "/ardour/routes/trimdB", "if", route_set_trim_dB);
483 REGISTER_CALLBACK (serv, "/ardour/routes/pan_stereo_position", "if", route_set_pan_stereo_position);
484 REGISTER_CALLBACK (serv, "/ardour/routes/pan_stereo_width", "if", route_set_pan_stereo_width);
485 REGISTER_CALLBACK (serv, "/ardour/routes/plugin/parameter", "iiif", route_plugin_parameter);
486 REGISTER_CALLBACK (serv, "/ardour/routes/plugin/parameter/print", "iii", route_plugin_parameter_print);
487 REGISTER_CALLBACK (serv, "/ardour/routes/send/gainabs", "iif", route_set_send_gain_abs);
488 REGISTER_CALLBACK (serv, "/ardour/routes/send/gaindB", "iif", route_set_send_gain_dB);
490 /* still not-really-standardized query interface */
491 //REGISTER_CALLBACK (serv, "/ardour/*/#current_value", "", current_value);
492 //REGISTER_CALLBACK (serv, "/ardour/set", "", set);
494 // un/register_update args= s:ctrl s:returl s:retpath
495 //lo_server_add_method(serv, "/register_update", "sss", OSC::global_register_update_handler, this);
496 //lo_server_add_method(serv, "/unregister_update", "sss", OSC::global_unregister_update_handler, this);
497 //lo_server_add_method(serv, "/register_auto_update", "siss", OSC::global_register_auto_update_handler, this);
498 //lo_server_add_method(serv, "/unregister_auto_update", "sss", OSC::_global_unregister_auto_update_handler, this);
500 /* this is a special catchall handler,
501 * register at the end so this is only called if no
502 * other handler matches (used for debug) */
503 lo_server_add_method (serv, 0, 0, _catchall, this);
508 OSC::osc_input_handler (IOCondition ioc, lo_server srv)
515 lo_server_recv (srv);
522 OSC::get_server_url()
528 urlstr = lo_server_get_url (_osc_server);
537 OSC::get_unix_server_url()
542 if (_osc_unix_server) {
543 urlstr = lo_server_get_url (_osc_unix_server);
552 OSC::listen_to_route (boost::shared_ptr<Route> route, lo_address addr)
554 /* avoid duplicate listens */
556 for (RouteObservers::iterator x = route_observers.begin(); x != route_observers.end(); ++x) {
558 OSCRouteObserver* ro;
560 if ((ro = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
562 int res = strcmp(lo_address_get_hostname(ro->address()), lo_address_get_hostname(addr));
564 if (ro->route() == route && res == 0) {
570 OSCRouteObserver* o = new OSCRouteObserver (route, addr);
571 route_observers.push_back (o);
573 route->DropReferences.connect (*this, MISSING_INVALIDATOR, boost::bind (&OSC::drop_route, this, boost::weak_ptr<Route> (route)), this);
577 OSC::drop_route (boost::weak_ptr<Route> wr)
579 boost::shared_ptr<Route> r = wr.lock ();
585 for (RouteObservers::iterator x = route_observers.begin(); x != route_observers.end();) {
587 OSCRouteObserver* rc;
589 if ((rc = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
591 if (rc->route() == r) {
593 x = route_observers.erase (x);
604 OSC::end_listen (boost::shared_ptr<Route> r, lo_address addr)
606 RouteObservers::iterator x;
608 // Remove the route observers
609 for (x = route_observers.begin(); x != route_observers.end();) {
611 OSCRouteObserver* ro;
613 if ((ro = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
615 int res = strcmp(lo_address_get_hostname(ro->address()), lo_address_get_hostname(addr));
617 if (ro->route() == r && res == 0) {
619 x = route_observers.erase (x);
632 OSC::current_value_query (const char* path, size_t len, lo_arg **argv, int argc, lo_message msg)
636 subpath = (char*) malloc (len-15+1);
637 memcpy (subpath, path, len-15);
638 subpath[len-15] = '\0';
640 send_current_value (subpath, argv, argc, msg);
646 OSC::send_current_value (const char* path, lo_arg** argv, int argc, lo_message msg)
652 lo_message reply = lo_message_new ();
653 boost::shared_ptr<Route> r;
656 lo_message_add_string (reply, path);
659 lo_message_add_string (reply, "bad syntax");
662 r = session->route_by_remote_id (id);
665 lo_message_add_string (reply, "not found");
668 if (strcmp (path, "/routes/state") == 0) {
670 if (boost::dynamic_pointer_cast<AudioTrack>(r)) {
671 lo_message_add_string (reply, "AT");
672 } else if (boost::dynamic_pointer_cast<MidiTrack>(r)) {
673 lo_message_add_string (reply, "MT");
675 lo_message_add_string (reply, "B");
678 lo_message_add_string (reply, r->name().c_str());
679 lo_message_add_int32 (reply, r->n_inputs().n_audio());
680 lo_message_add_int32 (reply, r->n_outputs().n_audio());
681 lo_message_add_int32 (reply, r->muted());
682 lo_message_add_int32 (reply, r->soloed());
684 } else if (strcmp (path, "/routes/mute") == 0) {
686 lo_message_add_int32 (reply, (float) r->muted());
688 } else if (strcmp (path, "/routes/solo") == 0) {
690 lo_message_add_int32 (reply, r->soloed());
695 lo_send_message (lo_message_get_source (msg), "#reply", reply);
696 lo_message_free (reply);
700 OSC::_catchall (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data)
702 return ((OSC*)user_data)->catchall (path, types, argv, argc, data);
706 OSC::catchall (const char *path, const char* types, lo_arg **argv, int argc, lo_message msg)
709 int ret = 1; /* unhandled */
711 //cerr << "Received a message, path = " << path << " types = \""
712 // << (types ? types : "NULL") << '"' << endl;
714 /* 15 for /#current_value plus 2 for /<path> */
718 if (len >= 17 && !strcmp (&path[len-15], "/#current_value")) {
719 current_value_query (path, len, argv, argc, msg);
722 } else if (strcmp (path, "/routes/listen") == 0) {
724 cerr << "set up listener\n";
726 lo_message reply = lo_message_new ();
729 lo_message_add_string (reply, "syntax error");
731 for (int n = 0; n < argc; ++n) {
733 boost::shared_ptr<Route> r = session->route_by_remote_id (argv[n]->i);
736 lo_message_add_string (reply, "not found");
737 cerr << "no such route\n";
740 cerr << "add listener\n";
741 listen_to_route (r, lo_message_get_source (msg));
742 lo_message_add_int32 (reply, argv[n]->i);
747 lo_send_message (lo_message_get_source (msg), "#reply", reply);
748 lo_message_free (reply);
752 } else if (strcmp (path, "/routes/ignore") == 0) {
754 for (int n = 0; n < argc; ++n) {
756 boost::shared_ptr<Route> r = session->route_by_remote_id (argv[n]->i);
759 end_listen (r, lo_message_get_source (msg));
764 } else if (argc == 1 && types[0] == 'f') { // single float -- probably TouchOSC
765 if (!strncmp (path, "/ardour/routes/gainabs/", 23) && strlen (path) > 23) {
766 int rid = atoi (&path[23]);
767 // use some power-scale mapping??
768 route_set_gain_abs (rid, argv[0]->f);
771 else if (!strncmp (path, "/ardour/routes/trimabs/", 23) && strlen (path) > 23) {
772 int rid = atoi (&path[23]);
774 route_set_trim_abs (rid, argv[0]->f);
777 else if (!strncmp (path, "/ardour/routes/mute/", 20) && strlen (path) > 20) {
778 int rid = atoi (&path[20]);
779 route_mute (rid, argv[0]->f == 1.0);
782 else if (!strncmp (path, "/ardour/routes/solo/", 20) && strlen (path) > 20) {
783 int rid = atoi (&path[20]);
784 route_solo (rid, argv[0]->f == 1.0);
787 else if (!strncmp (path, "/ardour/routes/recenable/", 25) && strlen (path) > 25) {
788 int rid = atoi (&path[25]);
789 route_recenable (rid, argv[0]->f == 1.0);
794 if ((ret && _debugmode == Unhandled)) {
795 debugmsg (_("Unhandled OSC message"), path, types, argv, argc);
802 OSC::debugmsg (const char *prefix, const char *path, const char* types, lo_arg **argv, int argc)
804 std::stringstream ss;
805 for (int i = 0; i < argc; ++i) {
806 lo_type type = (lo_type)types[i];
810 ss << "i:" << argv[i]->i;
813 ss << "f:" << argv[i]->f;
816 ss << "d:" << argv[i]->d;
819 ss << "s:" << &argv[i]->s;
822 ss << "h:" << argv[i]->h;
825 ss << "c:" << argv[i]->s;
856 PBD::info << prefix << ": " << path << ss.str() << endmsg;
865 // "Application Hook" Handlers //
867 OSC::session_loaded (Session& s)
869 // lo_address listener = lo_address_new (NULL, "7770");
870 // lo_send (listener, "/session/loaded", "ss", s.path().c_str(), s.name().c_str());
874 OSC::session_exported (std::string path, std::string name)
876 lo_address listener = lo_address_new (NULL, "7770");
877 lo_send (listener, "/session/exported", "ss", path.c_str(), name.c_str());
878 lo_address_free (listener);
881 // end "Application Hook" Handlers //
886 OSC::current_value (const char */*path*/, const char */*types*/, lo_arg **/*argv*/, int /*argc*/, void */*data*/, void* /*user_data*/)
891 if (argc < 3 || types == 0 || strlen (types) < 3 || types[0] != 's' || types[1] != 's' || types[2] != s) {
895 const char *returl = argv[1]->s;
896 lo_address addr = find_or_cache_addr (returl);
898 const char *retpath = argv[2]->s;
901 if (strcmp (argv[0]->s, "transport_frame") == 0) {
904 lo_send (addr, retpath, "i", session->transport_frame());
907 } else if (strcmp (argv[0]->s, "transport_speed") == 0) {
910 lo_send (addr, retpath, "i", session->transport_frame());
913 } else if (strcmp (argv[0]->s, "transport_locked") == 0) {
916 lo_send (addr, retpath, "i", session->transport_frame());
919 } else if (strcmp (argv[0]->s, "punch_in") == 0) {
922 lo_send (addr, retpath, "i", session->transport_frame());
925 } else if (strcmp (argv[0]->s, "punch_out") == 0) {
928 lo_send (addr, retpath, "i", session->transport_frame());
931 } else if (strcmp (argv[0]->s, "rec_enable") == 0) {
934 lo_send (addr, retpath, "i", session->transport_frame());
946 OSC::routes_list (lo_message msg)
951 for (int n = 0; n < (int) session->nroutes(); ++n) {
953 boost::shared_ptr<Route> r = session->route_by_remote_id (n);
957 lo_message reply = lo_message_new ();
959 if (boost::dynamic_pointer_cast<AudioTrack>(r)) {
960 lo_message_add_string (reply, "AT");
961 } else if (boost::dynamic_pointer_cast<MidiTrack>(r)) {
962 lo_message_add_string (reply, "MT");
964 lo_message_add_string (reply, "B");
967 lo_message_add_string (reply, r->name().c_str());
968 lo_message_add_int32 (reply, r->n_inputs().n_audio());
969 lo_message_add_int32 (reply, r->n_outputs().n_audio());
970 lo_message_add_int32 (reply, r->muted());
971 lo_message_add_int32 (reply, r->soloed());
972 lo_message_add_int32 (reply, r->remote_control_id());
974 if (boost::dynamic_pointer_cast<AudioTrack>(r)
975 || boost::dynamic_pointer_cast<MidiTrack>(r)) {
977 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track>(r);
978 lo_message_add_int32 (reply, t->record_enabled());
981 //Automatically listen to routes listed
982 listen_to_route(r, lo_message_get_source (msg));
984 lo_send_message (lo_message_get_source (msg), "#reply", reply);
985 lo_message_free (reply);
989 // Send end of listing message
990 lo_message reply = lo_message_new ();
992 lo_message_add_string (reply, "end_route_list");
993 lo_message_add_int64 (reply, session->frame_rate());
994 lo_message_add_int64 (reply, session->current_end_frame());
996 lo_send_message (lo_message_get_source (msg), "#reply", reply);
998 lo_message_free (reply);
1002 OSC::transport_frame (lo_message msg)
1007 framepos_t pos = session->transport_frame ();
1009 lo_message reply = lo_message_new ();
1010 lo_message_add_int64 (reply, pos);
1012 lo_send_message (lo_message_get_source (msg), "/ardour/transport_frame", reply);
1014 lo_message_free (reply);
1018 OSC::transport_speed (lo_message msg)
1023 double ts = session->transport_speed ();
1025 lo_message reply = lo_message_new ();
1026 lo_message_add_double (reply, ts);
1028 lo_send_message (lo_message_get_source (msg), "/ardour/transport_speed", reply);
1030 lo_message_free (reply);
1034 OSC::record_enabled (lo_message msg)
1039 int re = (int)session->get_record_enabled ();
1041 lo_message reply = lo_message_new ();
1042 lo_message_add_int32 (reply, re);
1044 lo_send_message (lo_message_get_source (msg), "/ardour/record_enabled", reply);
1046 lo_message_free (reply);
1051 OSC::route_mute (int rid, int yn)
1053 if (!session) return -1;
1055 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
1058 r->set_mute (yn, PBD::Controllable::NoGroup);
1065 OSC::route_solo (int rid, int yn)
1067 if (!session) return -1;
1069 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
1072 boost::shared_ptr<RouteList> rl (new RouteList);
1074 session->set_solo (rl, yn, Session::rt_cleanup, PBD::Controllable::NoGroup);
1081 OSC::route_recenable (int rid, int yn)
1083 if (!session) return -1;
1085 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
1088 r->set_record_enabled (yn, PBD::Controllable::NoGroup);
1095 OSC::route_set_gain_abs (int rid, float level)
1097 if (!session) return -1;
1099 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
1102 r->set_gain (level, PBD::Controllable::NoGroup);
1109 OSC::route_set_gain_dB (int rid, float dB)
1112 return route_set_gain_abs (rid, 0.0);
1114 return route_set_gain_abs (rid, dB_to_coefficient (dB));
1118 OSC::route_set_gain_VCA (int rid, float pos)
1120 return route_set_gain_abs (rid, slider_position_to_gain_with_max (pos, 2.0));
1125 OSC::route_set_trim_abs (int rid, float level)
1127 if (!session) return -1;
1129 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
1132 r->set_trim (level, PBD::Controllable::NoGroup);
1139 OSC::route_set_trim_dB (int rid, float dB)
1141 return route_set_trim_abs(rid, dB_to_coefficient (dB));
1146 OSC::route_set_pan_stereo_position (int rid, float pos)
1148 if (!session) return -1;
1150 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
1153 boost::shared_ptr<Panner> panner = r->panner();
1155 panner->set_position (pos);
1164 OSC::route_set_pan_stereo_width (int rid, float pos)
1166 if (!session) return -1;
1168 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
1171 boost::shared_ptr<Panner> panner = r->panner();
1173 panner->set_width (pos);
1182 OSC::route_set_send_gain_abs (int rid, int sid, float val)
1188 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
1194 /* revert to zero-based counting */
1200 boost::shared_ptr<Processor> p = r->nth_send (sid);
1203 boost::shared_ptr<Send> s = boost::dynamic_pointer_cast<Send>(p);
1204 boost::shared_ptr<Amp> a = s->amp();
1207 a->gain_control()->set_value (val, PBD::Controllable::NoGroup);
1214 OSC::route_set_send_gain_dB (int rid, int sid, float val)
1220 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
1226 /* revert to zero-based counting */
1232 boost::shared_ptr<Processor> p = r->nth_send (sid);
1235 boost::shared_ptr<Send> s = boost::dynamic_pointer_cast<Send>(p);
1236 boost::shared_ptr<Amp> a = s->amp();
1239 a->gain_control()->set_value (dB_to_coefficient (val), PBD::Controllable::NoGroup);
1246 OSC::route_plugin_parameter (int rid, int piid, int par, float val)
1251 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
1254 PBD::error << "OSC: Invalid Remote Control ID '" << rid << "'" << endmsg;
1258 boost::shared_ptr<Processor> redi=r->nth_plugin (piid);
1261 PBD::error << "OSC: cannot find plugin # " << piid << " for RID '" << rid << "'" << endmsg;
1265 boost::shared_ptr<PluginInsert> pi;
1267 if (!(pi = boost::dynamic_pointer_cast<PluginInsert>(redi))) {
1268 PBD::error << "OSC: given processor # " << piid << " on RID '" << rid << "' is not a Plugin." << endmsg;
1272 boost::shared_ptr<ARDOUR::Plugin> pip = pi->plugin();
1275 uint32_t controlid = pip->nth_parameter (par,ok);
1278 PBD::error << "OSC: Cannot find parameter # " << par << " for plugin # " << piid << " on RID '" << rid << "'" << endmsg;
1282 if (!pip->parameter_is_input(controlid)) {
1283 PBD::error << "OSC: Parameter # " << par << " for plugin # " << piid << " on RID '" << rid << "' is not a control input" << endmsg;
1287 ParameterDescriptor pd;
1288 pi->plugin()->get_parameter_descriptor (controlid,pd);
1290 if (val >= pd.lower && val < pd.upper) {
1292 boost::shared_ptr<AutomationControl> c = pi->automation_control (Evoral::Parameter(PluginAutomation, 0, controlid));
1293 // cerr << "parameter:" << redi->describe_parameter(controlid) << " val:" << val << "\n";
1294 c->set_value (val, PBD::Controllable::NoGroup);
1296 PBD::warning << "OSC: Parameter # " << par << " for plugin # " << piid << " on RID '" << rid << "' is out of range" << endmsg;
1297 PBD::info << "OSC: Valid range min=" << pd.lower << " max=" << pd.upper << endmsg;
1304 OSC::route_plugin_parameter_print (int rid, int piid, int par)
1310 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
1316 boost::shared_ptr<Processor> redi=r->nth_processor (piid);
1322 boost::shared_ptr<PluginInsert> pi;
1324 if (!(pi = boost::dynamic_pointer_cast<PluginInsert>(redi))) {
1328 boost::shared_ptr<ARDOUR::Plugin> pip = pi->plugin();
1331 uint32_t controlid = pip->nth_parameter (par,ok);
1337 ParameterDescriptor pd;
1339 if (pi->plugin()->get_parameter_descriptor (controlid, pd) == 0) {
1340 boost::shared_ptr<AutomationControl> c = pi->automation_control (Evoral::Parameter(PluginAutomation, 0, controlid));
1342 cerr << "parameter: " << redi->describe_parameter(controlid) << "\n";
1343 cerr << "current value: " << c->get_value ();
1344 cerr << "lower value: " << pd.lower << "\n";
1345 cerr << "upper value: " << pd.upper << "\n";
1354 XMLNode& node (ControlProtocol::get_state());
1355 node.add_property("debugmode", (int) _debugmode); // TODO: enum2str
1360 OSC::set_state (const XMLNode& node, int version)
1362 if (ControlProtocol::set_state (node, version)) {
1365 XMLProperty const * p = node.property (X_("debugmode"));
1367 _debugmode = OSCDebugMode (PBD::atoi(p->value ()));