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.
31 #include <glib/gstdio.h>
32 #include <glibmm/miscutils.h>
34 #include <pbd/pthread_utils.h>
35 #include <pbd/file_utils.h>
36 #include <pbd/failed_constructor.h>
38 #include "ardour/amp.h"
39 #include "ardour/session.h"
40 #include "ardour/route.h"
41 #include "ardour/audio_track.h"
42 #include "ardour/midi_track.h"
43 #include "ardour/dB.h"
44 #include "ardour/filesystem_paths.h"
45 #include "ardour/panner.h"
46 #include "ardour/plugin.h"
47 #include "ardour/send.h"
50 #include "osc_controllable.h"
51 #include "osc_route_observer.h"
54 using namespace ARDOUR;
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, "OSC")
76 , AbstractUI<OSCUIRequest> ("osc")
83 _namespace_root = "/ardour";
84 _send_route_changes = true;
90 // "Application Hooks"
92 session->Exported.connect (*this, MISSING_INVALIDATOR, boost::bind (&OSC::session_exported, this, _1, _2), this);
102 OSC::do_request (OSCUIRequest* req)
104 if (req->type == CallSlot) {
106 call_slot (MISSING_INVALIDATOR, req->the_slot);
108 } else if (req->type == Quit) {
115 OSC::set_active (bool yn)
125 OSC::get_active () const
127 return _osc_server != 0;
131 OSC::set_feedback (bool yn)
133 _send_route_changes = yn;
138 OSC::get_feedback () const
140 return _send_route_changes;
149 /* already started */
153 for (int j=0; j < 20; ++j) {
154 snprintf(tmpstr, sizeof(tmpstr), "%d", _port);
156 //if ((_osc_server = lo_server_new_with_proto (tmpstr, LO_TCP, error_callback))) {
160 if ((_osc_server = lo_server_new (tmpstr, error_callback))) {
165 cerr << "can't get osc at port: " << _port << endl;
175 #ifdef ARDOUR_OSC_UNIX_SERVER
177 // APPEARS sluggish for now
179 // attempt to create unix socket server too
181 snprintf(tmpstr, sizeof(tmpstr), "/tmp/sooperlooper_XXXXXX");
182 int fd = mkstemp(tmpstr);
188 _osc_unix_server = lo_server_new (tmpstr, error_callback);
190 if (_osc_unix_server) {
191 _osc_unix_socket_path = tmpstr;
196 PBD::info << "OSC @ " << get_server_url () << endmsg;
198 std::string url_file;
200 if (find_file_in_search_path (ardour_config_search_path(), "osc_url", url_file)) {
202 _osc_url_file = url_file;
204 urlfile.open(_osc_url_file.c_str(), ios::trunc);
207 urlfile << get_server_url () << endl;
210 cerr << "Couldn't write '" << _osc_url_file << "'" <<endl;
214 register_callbacks();
216 // lo_server_thread_add_method(_sthread, NULL, NULL, OSC::_dummy_handler, this);
218 /* startup the event loop thread */
228 pthread_set_name (X_("OSC"));
230 if (_osc_unix_server) {
231 Glib::RefPtr<IOSource> src = IOSource::create (lo_server_get_socket_fd (_osc_unix_server), IO_IN|IO_HUP|IO_ERR);
232 src->connect (sigc::bind (sigc::mem_fun (*this, &OSC::osc_input_handler), _osc_unix_server));
233 src->attach (_main_loop->get_context());
234 local_server = src->gobj();
235 g_source_ref (local_server);
239 Glib::RefPtr<IOSource> src = IOSource::create (lo_server_get_socket_fd (_osc_server), IO_IN|IO_HUP|IO_ERR);
240 src->connect (sigc::bind (sigc::mem_fun (*this, &OSC::osc_input_handler), _osc_server));
241 src->attach (_main_loop->get_context());
242 remote_server = src->gobj();
243 g_source_ref (remote_server);
246 PBD::notify_gui_about_thread_creation (X_("gui"), pthread_self(), X_("OSC"), 2048);
247 SessionEvent::create_per_thread_pool (X_("OSC"), 128);
256 g_source_destroy (local_server);
257 g_source_unref (local_server);
262 g_source_destroy (remote_server);
263 g_source_unref (remote_server);
270 int fd = lo_server_get_socket_fd(_osc_server);
274 lo_server_free (_osc_server);
278 if (_osc_unix_server) {
279 int fd = lo_server_get_socket_fd(_osc_unix_server);
283 lo_server_free (_osc_unix_server);
284 _osc_unix_server = 0;
287 if (!_osc_unix_socket_path.empty()) {
288 ::g_unlink (_osc_unix_socket_path.c_str());
291 if (!_osc_url_file.empty() ) {
292 ::g_unlink (_osc_url_file.c_str() );
295 // Delete any active route observers
296 for (RouteObservers::iterator x = route_observers.begin(); x != route_observers.end();) {
298 OSCRouteObserver* rc;
300 if ((rc = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
302 x = route_observers.erase (x);
312 OSC::register_callbacks()
317 srvs[0] = _osc_server;
318 srvs[1] = _osc_unix_server;
320 for (size_t i = 0; i < 2; ++i) {
328 /* this is a special catchall handler */
330 lo_server_add_method (serv, 0, 0, _catchall, this);
332 #define REGISTER_CALLBACK(serv,path,types, function) lo_server_add_method (serv, path, types, OSC::_ ## function, this)
334 REGISTER_CALLBACK (serv, "/routes/list", "", routes_list);
335 REGISTER_CALLBACK (serv, "/ardour/add_marker", "", add_marker);
336 REGISTER_CALLBACK (serv, "/ardour/access_action", "s", access_action);
337 REGISTER_CALLBACK (serv, "/ardour/loop_toggle", "", loop_toggle);
338 REGISTER_CALLBACK (serv, "/ardour/goto_start", "", goto_start);
339 REGISTER_CALLBACK (serv, "/ardour/goto_end", "", goto_end);
340 REGISTER_CALLBACK (serv, "/ardour/rewind", "", rewind);
341 REGISTER_CALLBACK (serv, "/ardour/ffwd", "", ffwd);
342 REGISTER_CALLBACK (serv, "/ardour/transport_stop", "", transport_stop);
343 REGISTER_CALLBACK (serv, "/ardour/transport_play", "", transport_play);
344 REGISTER_CALLBACK (serv, "/ardour/transport_frame", "", transport_frame);
345 REGISTER_CALLBACK (serv, "/ardour/set_transport_speed", "f", set_transport_speed);
346 REGISTER_CALLBACK (serv, "/ardour/locate", "ii", locate);
347 REGISTER_CALLBACK (serv, "/ardour/save_state", "", save_state);
348 REGISTER_CALLBACK (serv, "/ardour/prev_marker", "", prev_marker);
349 REGISTER_CALLBACK (serv, "/ardour/next_marker", "", next_marker);
350 REGISTER_CALLBACK (serv, "/ardour/undo", "", undo);
351 REGISTER_CALLBACK (serv, "/ardour/redo", "", redo);
352 REGISTER_CALLBACK (serv, "/ardour/toggle_punch_in", "", toggle_punch_in);
353 REGISTER_CALLBACK (serv, "/ardour/toggle_punch_out", "", toggle_punch_out);
354 REGISTER_CALLBACK (serv, "/ardour/rec_enable_toggle", "", rec_enable_toggle);
355 REGISTER_CALLBACK (serv, "/ardour/toggle_all_rec_enables", "", toggle_all_rec_enables);
357 REGISTER_CALLBACK (serv, "/ardour/routes/mute", "ii", route_mute);
358 REGISTER_CALLBACK (serv, "/ardour/routes/solo", "ii", route_solo);
359 REGISTER_CALLBACK (serv, "/ardour/routes/recenable", "ii", route_recenable);
360 REGISTER_CALLBACK (serv, "/ardour/routes/gainabs", "if", route_set_gain_abs);
361 REGISTER_CALLBACK (serv, "/ardour/routes/gaindB", "if", route_set_gain_dB);
362 REGISTER_CALLBACK (serv, "/ardour/routes/pan_stereo_position", "if", route_set_pan_stereo_position);
363 REGISTER_CALLBACK (serv, "/ardour/routes/pan_stereo_width", "if", route_set_pan_stereo_width);
364 REGISTER_CALLBACK (serv, "/ardour/routes/plugin/parameter", "iiif", route_plugin_parameter);
365 REGISTER_CALLBACK (serv, "/ardour/routes/plugin/parameter/print", "iii", route_plugin_parameter_print);
366 REGISTER_CALLBACK (serv, "/ardour/routes/send/gainabs", "iif", route_set_send_gain_abs);
367 REGISTER_CALLBACK (serv, "/ardour/routes/send/gaindB", "iif", route_set_send_gain_dB);
369 /* still not-really-standardized query interface */
370 //REGISTER_CALLBACK (serv, "/ardour/*/#current_value", "", current_value);
371 //REGISTER_CALLBACK (serv, "/ardour/set", "", set);
373 // un/register_update args= s:ctrl s:returl s:retpath
374 //lo_server_add_method(serv, "/register_update", "sss", OSC::global_register_update_handler, this);
375 //lo_server_add_method(serv, "/unregister_update", "sss", OSC::global_unregister_update_handler, this);
376 //lo_server_add_method(serv, "/register_auto_update", "siss", OSC::global_register_auto_update_handler, this);
377 //lo_server_add_method(serv, "/unregister_auto_update", "sss", OSC::_global_unregister_auto_update_handler, this);
383 OSC::osc_input_handler (IOCondition ioc, lo_server srv)
390 lo_server_recv (srv);
397 OSC::get_server_url()
403 urlstr = lo_server_get_url (_osc_server);
412 OSC::get_unix_server_url()
417 if (_osc_unix_server) {
418 urlstr = lo_server_get_url (_osc_unix_server);
427 OSC::listen_to_route (boost::shared_ptr<Route> route, lo_address addr)
429 /* avoid duplicate listens */
431 for (RouteObservers::iterator x = route_observers.begin(); x != route_observers.end(); ++x) {
433 OSCRouteObserver* ro;
435 if ((ro = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
437 int res = strcmp(lo_address_get_hostname(ro->address()), lo_address_get_hostname(addr));
439 if (ro->route() == route && res == 0) {
445 OSCRouteObserver* o = new OSCRouteObserver (route, addr);
446 route_observers.push_back (o);
448 route->DropReferences.connect (*this, MISSING_INVALIDATOR, boost::bind (&OSC::drop_route, this, boost::weak_ptr<Route> (route)), this);
452 OSC::drop_route (boost::weak_ptr<Route> wr)
454 boost::shared_ptr<Route> r = wr.lock ();
460 for (RouteObservers::iterator x = route_observers.begin(); x != route_observers.end();) {
462 OSCRouteObserver* rc;
464 if ((rc = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
466 if (rc->route() == r) {
468 x = route_observers.erase (x);
479 OSC::end_listen (boost::shared_ptr<Route> r, lo_address addr)
481 RouteObservers::iterator x;
483 // Remove the route observers
484 for (x = route_observers.begin(); x != route_observers.end();) {
486 OSCRouteObserver* ro;
488 if ((ro = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
490 int res = strcmp(lo_address_get_hostname(ro->address()), lo_address_get_hostname(addr));
492 if (ro->route() == r && res == 0) {
494 x = route_observers.erase (x);
507 OSC::current_value_query (const char* path, size_t len, lo_arg **argv, int argc, lo_message msg)
511 subpath = (char*) malloc (len-15+1);
512 memcpy (subpath, path, len-15);
513 subpath[len-15] = '\0';
515 send_current_value (subpath, argv, argc, msg);
521 OSC::send_current_value (const char* path, lo_arg** argv, int argc, lo_message msg)
527 lo_message reply = lo_message_new ();
528 boost::shared_ptr<Route> r;
531 lo_message_add_string (reply, path);
534 lo_message_add_string (reply, "bad syntax");
537 r = session->route_by_remote_id (id);
540 lo_message_add_string (reply, "not found");
543 if (strcmp (path, "/routes/state") == 0) {
545 if (boost::dynamic_pointer_cast<AudioTrack>(r)) {
546 lo_message_add_string (reply, "AT");
547 } else if (boost::dynamic_pointer_cast<MidiTrack>(r)) {
548 lo_message_add_string (reply, "MT");
550 lo_message_add_string (reply, "B");
553 lo_message_add_string (reply, r->name().c_str());
554 lo_message_add_int32 (reply, r->n_inputs().n_audio());
555 lo_message_add_int32 (reply, r->n_outputs().n_audio());
556 lo_message_add_int32 (reply, r->muted());
557 lo_message_add_int32 (reply, r->soloed());
559 } else if (strcmp (path, "/routes/mute") == 0) {
561 lo_message_add_int32 (reply, (float) r->muted());
563 } else if (strcmp (path, "/routes/solo") == 0) {
565 lo_message_add_int32 (reply, r->soloed());
570 lo_send_message (lo_message_get_source (msg), "#reply", reply);
571 lo_message_free (reply);
575 OSC::_catchall (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data)
577 return ((OSC*)user_data)->catchall (path, types, argv, argc, data);
581 OSC::catchall (const char *path, const char* /*types*/, lo_arg **argv, int argc, lo_message msg)
584 int ret = 1; /* unhandled */
586 //cerr << "Received a message, path = " << path << " types = \""
587 // << (types ? types : "NULL") << '"' << endl;
589 /* 15 for /#current_value plus 2 for /<path> */
593 if (len >= 17 && !strcmp (&path[len-15], "/#current_value")) {
594 current_value_query (path, len, argv, argc, msg);
597 } else if (strcmp (path, "/routes/listen") == 0) {
599 cerr << "set up listener\n";
601 lo_message reply = lo_message_new ();
604 lo_message_add_string (reply, "syntax error");
606 for (int n = 0; n < argc; ++n) {
608 boost::shared_ptr<Route> r = session->route_by_remote_id (argv[n]->i);
611 lo_message_add_string (reply, "not found");
612 cerr << "no such route\n";
615 cerr << "add listener\n";
616 listen_to_route (r, lo_message_get_source (msg));
617 lo_message_add_int32 (reply, argv[n]->i);
622 lo_send_message (lo_message_get_source (msg), "#reply", reply);
623 lo_message_free (reply);
627 } else if (strcmp (path, "/routes/ignore") == 0) {
629 for (int n = 0; n < argc; ++n) {
631 boost::shared_ptr<Route> r = session->route_by_remote_id (argv[n]->i);
634 end_listen (r, lo_message_get_source (msg));
650 // "Application Hook" Handlers //
652 OSC::session_loaded (Session& s)
654 lo_address listener = lo_address_new (NULL, "7770");
655 lo_send (listener, "/session/loaded", "ss", s.path().c_str(), s.name().c_str());
659 OSC::session_exported (std::string path, std::string name)
661 lo_address listener = lo_address_new (NULL, "7770");
662 lo_send (listener, "/session/exported", "ss", path.c_str(), name.c_str());
665 // end "Application Hook" Handlers //
670 OSC::current_value (const char */*path*/, const char */*types*/, lo_arg **/*argv*/, int /*argc*/, void */*data*/, void* /*user_data*/)
675 if (argc < 3 || types == 0 || strlen (types) < 3 || types[0] != 's' || types[1] != 's' || types[2] != s) {
679 const char *returl = argv[1]->s;
680 lo_address addr = find_or_cache_addr (returl);
682 const char *retpath = argv[2]->s;
685 if (strcmp (argv[0]->s, "transport_frame") == 0) {
688 lo_send (addr, retpath, "i", session->transport_frame());
691 } else if (strcmp (argv[0]->s, "transport_speed") == 0) {
694 lo_send (addr, retpath, "i", session->transport_frame());
697 } else if (strcmp (argv[0]->s, "transport_locked") == 0) {
700 lo_send (addr, retpath, "i", session->transport_frame());
703 } else if (strcmp (argv[0]->s, "punch_in") == 0) {
706 lo_send (addr, retpath, "i", session->transport_frame());
709 } else if (strcmp (argv[0]->s, "punch_out") == 0) {
712 lo_send (addr, retpath, "i", session->transport_frame());
715 } else if (strcmp (argv[0]->s, "rec_enable") == 0) {
718 lo_send (addr, retpath, "i", session->transport_frame());
730 OSC::routes_list (lo_message msg)
732 for (int n = 0; n < (int) session->nroutes(); ++n) {
734 boost::shared_ptr<Route> r = session->route_by_remote_id (n);
738 lo_message reply = lo_message_new ();
740 if (boost::dynamic_pointer_cast<AudioTrack>(r)) {
741 lo_message_add_string (reply, "AT");
742 } else if (boost::dynamic_pointer_cast<MidiTrack>(r)) {
743 lo_message_add_string (reply, "MT");
745 lo_message_add_string (reply, "B");
748 lo_message_add_string (reply, r->name().c_str());
749 lo_message_add_int32 (reply, r->n_inputs().n_audio());
750 lo_message_add_int32 (reply, r->n_outputs().n_audio());
751 lo_message_add_int32 (reply, r->muted());
752 lo_message_add_int32 (reply, r->soloed());
753 lo_message_add_int32 (reply, r->remote_control_id());
755 if (boost::dynamic_pointer_cast<AudioTrack>(r)
756 || boost::dynamic_pointer_cast<MidiTrack>(r)) {
758 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track>(r);
759 lo_message_add_int32 (reply, t->record_enabled());
762 //Automatically listen to routes listed
763 listen_to_route(r, lo_message_get_source (msg));
765 lo_send_message (lo_message_get_source (msg), "#reply", reply);
766 lo_message_free (reply);
770 // Send end of listing message
771 lo_message reply = lo_message_new ();
773 lo_message_add_string (reply, "end_route_list");
774 lo_message_add_int64 (reply, session->frame_rate());
775 lo_message_add_int64 (reply, session->current_end_frame());
777 lo_send_message (lo_message_get_source (msg), "#reply", reply);
779 lo_message_free (reply);
783 OSC::transport_frame (lo_message msg)
785 framepos_t pos = session->transport_frame ();
787 lo_message reply = lo_message_new ();
788 lo_message_add_int64 (reply, pos);
790 lo_send_message (lo_message_get_source (msg), "/ardour/transport_frame", reply);
792 lo_message_free (reply);
796 OSC::route_mute (int rid, int yn)
798 if (!session) return -1;
800 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
803 r->set_mute (yn, this);
810 OSC::route_solo (int rid, int yn)
812 if (!session) return -1;
814 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
817 r->set_solo (yn, this);
824 OSC::route_recenable (int rid, int yn)
826 if (!session) return -1;
828 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
831 r->set_record_enabled (yn, this);
838 OSC::route_set_gain_abs (int rid, float level)
840 if (!session) return -1;
842 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
845 r->set_gain (level, this);
852 OSC::route_set_gain_dB (int rid, float dB)
854 if (!session) return -1;
856 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
859 r->set_gain (dB_to_coefficient (dB), this);
866 OSC::route_set_pan_stereo_position (int rid, float pos)
868 if (!session) return -1;
870 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
873 boost::shared_ptr<Panner> panner = r->panner();
875 panner->set_position (pos);
884 OSC::route_set_pan_stereo_width (int rid, float pos)
886 if (!session) return -1;
888 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
891 boost::shared_ptr<Panner> panner = r->panner();
893 panner->set_width (pos);
902 OSC::route_set_send_gain_abs (int rid, int sid, float val)
908 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
914 /* revert to zero-based counting */
920 boost::shared_ptr<Processor> p = r->nth_send (sid);
923 boost::shared_ptr<Send> s = boost::dynamic_pointer_cast<Send>(p);
924 boost::shared_ptr<Amp> a = s->amp();
927 a->set_gain (val, this);
934 OSC::route_set_send_gain_dB (int rid, int sid, float val)
940 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
946 /* revert to zero-based counting */
952 boost::shared_ptr<Processor> p = r->nth_send (sid);
955 boost::shared_ptr<Send> s = boost::dynamic_pointer_cast<Send>(p);
956 boost::shared_ptr<Amp> a = s->amp();
959 a->set_gain (dB_to_coefficient (val), this);
966 OSC::route_plugin_parameter (int rid, int piid, int par, float val)
972 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
978 boost::shared_ptr<Processor> redi=r->nth_processor (piid);
984 boost::shared_ptr<PluginInsert> pi;
986 if (!(pi = boost::dynamic_pointer_cast<PluginInsert>(redi))) {
990 boost::shared_ptr<ARDOUR::Plugin> pip = pi->plugin();
993 uint32_t controlid = pip->nth_parameter (par,ok);
999 Plugin::ParameterDescriptor pd;
1000 pi->plugin()->get_parameter_descriptor (controlid,pd);
1002 if (val >= pd.lower && val < pd.upper) {
1004 boost::shared_ptr<AutomationControl> c = pi->automation_control (Evoral::Parameter(PluginAutomation, 0, controlid));;
1005 cerr << "parameter:" << redi->describe_parameter(controlid) << " val:" << val << "\n";
1013 OSC::route_plugin_parameter_print (int rid, int piid, int par)
1019 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
1025 boost::shared_ptr<Processor> redi=r->nth_processor (piid);
1031 boost::shared_ptr<PluginInsert> pi;
1033 if (!(pi = boost::dynamic_pointer_cast<PluginInsert>(redi))) {
1037 boost::shared_ptr<ARDOUR::Plugin> pip = pi->plugin();
1040 uint32_t controlid = pip->nth_parameter (par,ok);
1046 Plugin::ParameterDescriptor pd;
1048 if (pi->plugin()->get_parameter_descriptor (controlid, pd) == 0) {
1049 boost::shared_ptr<AutomationControl> c = pi->automation_control (Evoral::Parameter(PluginAutomation, 0, controlid));
1051 cerr << "parameter: " << redi->describe_parameter(controlid) << "\n";
1052 cerr << "current value: " << c->get_value ();
1053 cerr << "lower value: " << pd.lower << "\n";
1054 cerr << "upper value: " << pd.upper << "\n";
1063 XMLNode* node = new XMLNode ("Protocol");
1065 node->add_property (X_("name"), "Open Sound Control (OSC)");
1066 node->add_property (X_("feedback"), _send_route_changes ? "1" : "0");
1072 OSC::set_state (const XMLNode&, int /*version*/)