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 <glibmm/miscutils.h>
33 #include <pbd/pthread_utils.h>
34 #include <pbd/file_utils.h>
35 #include <pbd/failed_constructor.h>
37 #include "ardour/amp.h"
38 #include "ardour/session.h"
39 #include "ardour/route.h"
40 #include "ardour/audio_track.h"
41 #include "ardour/midi_track.h"
42 #include "ardour/dB.h"
43 #include "ardour/filesystem_paths.h"
44 #include "ardour/panner.h"
45 #include "ardour/plugin.h"
46 #include "ardour/send.h"
49 #include "osc_controllable.h"
50 #include "osc_route_observer.h"
53 using namespace ARDOUR;
57 #include "pbd/abstract_ui.cc" // instantiate template
59 OSC* OSC::_instance = 0;
62 static void error_callback(int num, const char *m, const char *path)
64 fprintf(stderr, "liblo server error %d in path %s: %s\n", num, path, m);
67 static void error_callback(int, const char *, const char *)
73 OSC::OSC (Session& s, uint32_t port)
74 : ControlProtocol (s, "OSC")
75 , AbstractUI<OSCUIRequest> ("osc")
82 _namespace_root = "/ardour";
83 _send_route_changes = true;
89 // "Application Hooks"
91 session->Exported.connect (*this, MISSING_INVALIDATOR, boost::bind (&OSC::session_exported, this, _1, _2), this);
101 OSC::do_request (OSCUIRequest* req)
103 if (req->type == CallSlot) {
105 call_slot (MISSING_INVALIDATOR, req->the_slot);
107 } else if (req->type == Quit) {
114 OSC::set_active (bool yn)
124 OSC::get_active () const
126 return _osc_server != 0;
130 OSC::set_feedback (bool yn)
132 _send_route_changes = yn;
137 OSC::get_feedback () const
139 return _send_route_changes;
148 /* already started */
152 for (int j=0; j < 20; ++j) {
153 snprintf(tmpstr, sizeof(tmpstr), "%d", _port);
155 //if ((_osc_server = lo_server_new_with_proto (tmpstr, LO_TCP, error_callback))) {
159 if ((_osc_server = lo_server_new (tmpstr, error_callback))) {
164 cerr << "can't get osc at port: " << _port << endl;
174 #ifdef ARDOUR_OSC_UNIX_SERVER
176 // APPEARS sluggish for now
178 // attempt to create unix socket server too
180 snprintf(tmpstr, sizeof(tmpstr), "/tmp/sooperlooper_XXXXXX");
181 int fd = mkstemp(tmpstr);
187 _osc_unix_server = lo_server_new (tmpstr, error_callback);
189 if (_osc_unix_server) {
190 _osc_unix_socket_path = tmpstr;
195 PBD::info << "OSC @ " << get_server_url () << endmsg;
197 std::string url_file;
199 if (find_file_in_search_path (ardour_config_search_path(), "osc_url", url_file)) {
201 _osc_url_file = url_file;
203 urlfile.open(_osc_url_file.c_str(), ios::trunc);
206 urlfile << get_server_url () << endl;
209 cerr << "Couldn't write '" << _osc_url_file << "'" <<endl;
213 register_callbacks();
215 // lo_server_thread_add_method(_sthread, NULL, NULL, OSC::_dummy_handler, this);
217 /* startup the event loop thread */
227 pthread_set_name (X_("OSC"));
229 if (_osc_unix_server) {
230 Glib::RefPtr<IOSource> src = IOSource::create (lo_server_get_socket_fd (_osc_unix_server), IO_IN|IO_HUP|IO_ERR);
231 src->connect (sigc::bind (sigc::mem_fun (*this, &OSC::osc_input_handler), _osc_unix_server));
232 src->attach (_main_loop->get_context());
233 local_server = src->gobj();
234 g_source_ref (local_server);
238 Glib::RefPtr<IOSource> src = IOSource::create (lo_server_get_socket_fd (_osc_server), IO_IN|IO_HUP|IO_ERR);
239 src->connect (sigc::bind (sigc::mem_fun (*this, &OSC::osc_input_handler), _osc_server));
240 src->attach (_main_loop->get_context());
241 remote_server = src->gobj();
242 g_source_ref (remote_server);
245 PBD::notify_gui_about_thread_creation (X_("gui"), pthread_self(), X_("OSC"), 2048);
246 SessionEvent::create_per_thread_pool (X_("OSC"), 128);
255 g_source_destroy (local_server);
256 g_source_unref (local_server);
261 g_source_destroy (remote_server);
262 g_source_unref (remote_server);
269 int fd = lo_server_get_socket_fd(_osc_server);
273 lo_server_free (_osc_server);
277 if (_osc_unix_server) {
278 int fd = lo_server_get_socket_fd(_osc_unix_server);
282 lo_server_free (_osc_unix_server);
283 _osc_unix_server = 0;
286 if (!_osc_unix_socket_path.empty()) {
287 unlink (_osc_unix_socket_path.c_str());
290 if (!_osc_url_file.empty() ) {
291 unlink (_osc_url_file.c_str() );
294 // Delete any active route observers
295 for (RouteObservers::iterator x = route_observers.begin(); x != route_observers.end();) {
297 OSCRouteObserver* rc;
299 if ((rc = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
301 x = route_observers.erase (x);
311 OSC::register_callbacks()
316 srvs[0] = _osc_server;
317 srvs[1] = _osc_unix_server;
319 for (size_t i = 0; i < 2; ++i) {
327 /* this is a special catchall handler */
329 lo_server_add_method (serv, 0, 0, _catchall, this);
331 #define REGISTER_CALLBACK(serv,path,types, function) lo_server_add_method (serv, path, types, OSC::_ ## function, this)
333 REGISTER_CALLBACK (serv, "/routes/list", "", routes_list);
334 REGISTER_CALLBACK (serv, "/ardour/add_marker", "", add_marker);
335 REGISTER_CALLBACK (serv, "/ardour/access_action", "s", access_action);
336 REGISTER_CALLBACK (serv, "/ardour/loop_toggle", "", loop_toggle);
337 REGISTER_CALLBACK (serv, "/ardour/goto_start", "", goto_start);
338 REGISTER_CALLBACK (serv, "/ardour/goto_end", "", goto_end);
339 REGISTER_CALLBACK (serv, "/ardour/rewind", "", rewind);
340 REGISTER_CALLBACK (serv, "/ardour/ffwd", "", ffwd);
341 REGISTER_CALLBACK (serv, "/ardour/transport_stop", "", transport_stop);
342 REGISTER_CALLBACK (serv, "/ardour/transport_play", "", transport_play);
343 REGISTER_CALLBACK (serv, "/ardour/transport_frame", "", transport_frame);
344 REGISTER_CALLBACK (serv, "/ardour/set_transport_speed", "f", set_transport_speed);
345 REGISTER_CALLBACK (serv, "/ardour/locate", "ii", locate);
346 REGISTER_CALLBACK (serv, "/ardour/save_state", "", save_state);
347 REGISTER_CALLBACK (serv, "/ardour/prev_marker", "", prev_marker);
348 REGISTER_CALLBACK (serv, "/ardour/next_marker", "", next_marker);
349 REGISTER_CALLBACK (serv, "/ardour/undo", "", undo);
350 REGISTER_CALLBACK (serv, "/ardour/redo", "", redo);
351 REGISTER_CALLBACK (serv, "/ardour/toggle_punch_in", "", toggle_punch_in);
352 REGISTER_CALLBACK (serv, "/ardour/toggle_punch_out", "", toggle_punch_out);
353 REGISTER_CALLBACK (serv, "/ardour/rec_enable_toggle", "", rec_enable_toggle);
354 REGISTER_CALLBACK (serv, "/ardour/toggle_all_rec_enables", "", toggle_all_rec_enables);
356 REGISTER_CALLBACK (serv, "/ardour/routes/mute", "ii", route_mute);
357 REGISTER_CALLBACK (serv, "/ardour/routes/solo", "ii", route_solo);
358 REGISTER_CALLBACK (serv, "/ardour/routes/recenable", "ii", route_recenable);
359 REGISTER_CALLBACK (serv, "/ardour/routes/gainabs", "if", route_set_gain_abs);
360 REGISTER_CALLBACK (serv, "/ardour/routes/gaindB", "if", route_set_gain_dB);
361 REGISTER_CALLBACK (serv, "/ardour/routes/pan_stereo_position", "if", route_set_pan_stereo_position);
362 REGISTER_CALLBACK (serv, "/ardour/routes/pan_stereo_width", "if", route_set_pan_stereo_width);
363 REGISTER_CALLBACK (serv, "/ardour/routes/plugin/parameter", "iiif", route_plugin_parameter);
364 REGISTER_CALLBACK (serv, "/ardour/routes/plugin/parameter/print", "iii", route_plugin_parameter_print);
365 REGISTER_CALLBACK (serv, "/ardour/routes/send/gainabs", "iif", route_set_send_gain_abs);
366 REGISTER_CALLBACK (serv, "/ardour/routes/send/gaindB", "iif", route_set_send_gain_dB);
368 /* still not-really-standardized query interface */
369 //REGISTER_CALLBACK (serv, "/ardour/*/#current_value", "", current_value);
370 //REGISTER_CALLBACK (serv, "/ardour/set", "", set);
372 // un/register_update args= s:ctrl s:returl s:retpath
373 //lo_server_add_method(serv, "/register_update", "sss", OSC::global_register_update_handler, this);
374 //lo_server_add_method(serv, "/unregister_update", "sss", OSC::global_unregister_update_handler, this);
375 //lo_server_add_method(serv, "/register_auto_update", "siss", OSC::global_register_auto_update_handler, this);
376 //lo_server_add_method(serv, "/unregister_auto_update", "sss", OSC::_global_unregister_auto_update_handler, this);
382 OSC::osc_input_handler (IOCondition ioc, lo_server srv)
389 lo_server_recv (srv);
396 OSC::get_server_url()
402 urlstr = lo_server_get_url (_osc_server);
411 OSC::get_unix_server_url()
416 if (_osc_unix_server) {
417 urlstr = lo_server_get_url (_osc_unix_server);
426 OSC::listen_to_route (boost::shared_ptr<Route> route, lo_address addr)
428 /* avoid duplicate listens */
430 for (RouteObservers::iterator x = route_observers.begin(); x != route_observers.end(); ++x) {
432 OSCRouteObserver* ro;
434 if ((ro = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
436 int res = strcmp(lo_address_get_hostname(ro->address()), lo_address_get_hostname(addr));
438 if (ro->route() == route && res == 0) {
444 OSCRouteObserver* o = new OSCRouteObserver (route, addr);
445 route_observers.push_back (o);
447 route->DropReferences.connect (*this, MISSING_INVALIDATOR, boost::bind (&OSC::drop_route, this, boost::weak_ptr<Route> (route)), this);
451 OSC::drop_route (boost::weak_ptr<Route> wr)
453 boost::shared_ptr<Route> r = wr.lock ();
459 for (RouteObservers::iterator x = route_observers.begin(); x != route_observers.end();) {
461 OSCRouteObserver* rc;
463 if ((rc = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
465 if (rc->route() == r) {
467 x = route_observers.erase (x);
478 OSC::end_listen (boost::shared_ptr<Route> r, lo_address addr)
480 RouteObservers::iterator x;
482 // Remove the route observers
483 for (x = route_observers.begin(); x != route_observers.end();) {
485 OSCRouteObserver* ro;
487 if ((ro = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
489 int res = strcmp(lo_address_get_hostname(ro->address()), lo_address_get_hostname(addr));
491 if (ro->route() == r && res == 0) {
493 x = route_observers.erase (x);
506 OSC::current_value_query (const char* path, size_t len, lo_arg **argv, int argc, lo_message msg)
510 subpath = (char*) malloc (len-15+1);
511 memcpy (subpath, path, len-15);
512 subpath[len-15] = '\0';
514 send_current_value (subpath, argv, argc, msg);
520 OSC::send_current_value (const char* path, lo_arg** argv, int argc, lo_message msg)
526 lo_message reply = lo_message_new ();
527 boost::shared_ptr<Route> r;
530 lo_message_add_string (reply, path);
533 lo_message_add_string (reply, "bad syntax");
536 r = session->route_by_remote_id (id);
539 lo_message_add_string (reply, "not found");
542 if (strcmp (path, "/routes/state") == 0) {
544 if (boost::dynamic_pointer_cast<AudioTrack>(r)) {
545 lo_message_add_string (reply, "AT");
546 } else if (boost::dynamic_pointer_cast<MidiTrack>(r)) {
547 lo_message_add_string (reply, "MT");
549 lo_message_add_string (reply, "B");
552 lo_message_add_string (reply, r->name().c_str());
553 lo_message_add_int32 (reply, r->n_inputs().n_audio());
554 lo_message_add_int32 (reply, r->n_outputs().n_audio());
555 lo_message_add_int32 (reply, r->muted());
556 lo_message_add_int32 (reply, r->soloed());
558 } else if (strcmp (path, "/routes/mute") == 0) {
560 lo_message_add_int32 (reply, (float) r->muted());
562 } else if (strcmp (path, "/routes/solo") == 0) {
564 lo_message_add_int32 (reply, r->soloed());
569 lo_send_message (lo_message_get_source (msg), "#reply", reply);
570 lo_message_free (reply);
574 OSC::_catchall (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data)
576 return ((OSC*)user_data)->catchall (path, types, argv, argc, data);
580 OSC::catchall (const char *path, const char* /*types*/, lo_arg **argv, int argc, lo_message msg)
583 int ret = 1; /* unhandled */
585 //cerr << "Received a message, path = " << path << " types = \""
586 // << (types ? types : "NULL") << '"' << endl;
588 /* 15 for /#current_value plus 2 for /<path> */
592 if (len >= 17 && !strcmp (&path[len-15], "/#current_value")) {
593 current_value_query (path, len, argv, argc, msg);
596 } else if (strcmp (path, "/routes/listen") == 0) {
598 cerr << "set up listener\n";
600 lo_message reply = lo_message_new ();
603 lo_message_add_string (reply, "syntax error");
605 for (int n = 0; n < argc; ++n) {
607 boost::shared_ptr<Route> r = session->route_by_remote_id (argv[n]->i);
610 lo_message_add_string (reply, "not found");
611 cerr << "no such route\n";
614 cerr << "add listener\n";
615 listen_to_route (r, lo_message_get_source (msg));
616 lo_message_add_int32 (reply, argv[n]->i);
621 lo_send_message (lo_message_get_source (msg), "#reply", reply);
622 lo_message_free (reply);
626 } else if (strcmp (path, "/routes/ignore") == 0) {
628 for (int n = 0; n < argc; ++n) {
630 boost::shared_ptr<Route> r = session->route_by_remote_id (argv[n]->i);
633 end_listen (r, lo_message_get_source (msg));
649 // "Application Hook" Handlers //
651 OSC::session_loaded (Session& s)
653 lo_address listener = lo_address_new (NULL, "7770");
654 lo_send (listener, "/session/loaded", "ss", s.path().c_str(), s.name().c_str());
658 OSC::session_exported (std::string path, std::string name)
660 lo_address listener = lo_address_new (NULL, "7770");
661 lo_send (listener, "/session/exported", "ss", path.c_str(), name.c_str());
664 // end "Application Hook" Handlers //
669 OSC::current_value (const char */*path*/, const char */*types*/, lo_arg **/*argv*/, int /*argc*/, void */*data*/, void* /*user_data*/)
674 if (argc < 3 || types == 0 || strlen (types) < 3 || types[0] != 's' || types[1] != 's' || types[2] != s) {
678 const char *returl = argv[1]->s;
679 lo_address addr = find_or_cache_addr (returl);
681 const char *retpath = argv[2]->s;
684 if (strcmp (argv[0]->s, "transport_frame") == 0) {
687 lo_send (addr, retpath, "i", session->transport_frame());
690 } else if (strcmp (argv[0]->s, "transport_speed") == 0) {
693 lo_send (addr, retpath, "i", session->transport_frame());
696 } else if (strcmp (argv[0]->s, "transport_locked") == 0) {
699 lo_send (addr, retpath, "i", session->transport_frame());
702 } else if (strcmp (argv[0]->s, "punch_in") == 0) {
705 lo_send (addr, retpath, "i", session->transport_frame());
708 } else if (strcmp (argv[0]->s, "punch_out") == 0) {
711 lo_send (addr, retpath, "i", session->transport_frame());
714 } else if (strcmp (argv[0]->s, "rec_enable") == 0) {
717 lo_send (addr, retpath, "i", session->transport_frame());
729 OSC::routes_list (lo_message msg)
731 for (int n = 0; n < (int) session->nroutes(); ++n) {
733 boost::shared_ptr<Route> r = session->route_by_remote_id (n);
737 lo_message reply = lo_message_new ();
739 if (boost::dynamic_pointer_cast<AudioTrack>(r)) {
740 lo_message_add_string (reply, "AT");
741 } else if (boost::dynamic_pointer_cast<MidiTrack>(r)) {
742 lo_message_add_string (reply, "MT");
744 lo_message_add_string (reply, "B");
747 lo_message_add_string (reply, r->name().c_str());
748 lo_message_add_int32 (reply, r->n_inputs().n_audio());
749 lo_message_add_int32 (reply, r->n_outputs().n_audio());
750 lo_message_add_int32 (reply, r->muted());
751 lo_message_add_int32 (reply, r->soloed());
752 lo_message_add_int32 (reply, r->remote_control_id());
754 if (boost::dynamic_pointer_cast<AudioTrack>(r)
755 || boost::dynamic_pointer_cast<MidiTrack>(r)) {
757 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track>(r);
758 lo_message_add_int32 (reply, t->record_enabled());
761 //Automatically listen to routes listed
762 listen_to_route(r, lo_message_get_source (msg));
764 lo_send_message (lo_message_get_source (msg), "#reply", reply);
765 lo_message_free (reply);
769 // Send end of listing message
770 lo_message reply = lo_message_new ();
772 lo_message_add_string (reply, "end_route_list");
773 lo_message_add_int64 (reply, session->frame_rate());
774 lo_message_add_int64 (reply, session->current_end_frame());
776 lo_send_message (lo_message_get_source (msg), "#reply", reply);
778 lo_message_free (reply);
782 OSC::transport_frame (lo_message msg)
784 framepos_t pos = session->transport_frame ();
786 lo_message reply = lo_message_new ();
787 lo_message_add_int64 (reply, pos);
789 lo_send_message (lo_message_get_source (msg), "/ardour/transport_frame", reply);
791 lo_message_free (reply);
795 OSC::route_mute (int rid, int yn)
797 if (!session) return -1;
799 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
802 r->set_mute (yn, this);
809 OSC::route_solo (int rid, int yn)
811 if (!session) return -1;
813 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
816 r->set_solo (yn, this);
823 OSC::route_recenable (int rid, int yn)
825 if (!session) return -1;
827 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
830 r->set_record_enabled (yn, this);
837 OSC::route_set_gain_abs (int rid, float level)
839 if (!session) return -1;
841 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
844 r->set_gain (level, this);
851 OSC::route_set_gain_dB (int rid, float dB)
853 if (!session) return -1;
855 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
858 r->set_gain (dB_to_coefficient (dB), this);
865 OSC::route_set_pan_stereo_position (int rid, float pos)
867 if (!session) return -1;
869 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
872 boost::shared_ptr<Panner> panner = r->panner();
874 panner->set_position (pos);
883 OSC::route_set_pan_stereo_width (int rid, float pos)
885 if (!session) return -1;
887 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
890 boost::shared_ptr<Panner> panner = r->panner();
892 panner->set_width (pos);
901 OSC::route_set_send_gain_abs (int rid, int sid, float val)
907 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
913 /* revert to zero-based counting */
919 boost::shared_ptr<Processor> p = r->nth_send (sid);
922 boost::shared_ptr<Send> s = boost::dynamic_pointer_cast<Send>(p);
923 boost::shared_ptr<Amp> a = s->amp();
926 a->set_gain (val, this);
933 OSC::route_set_send_gain_dB (int rid, int sid, float val)
939 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
945 /* revert to zero-based counting */
951 boost::shared_ptr<Processor> p = r->nth_send (sid);
954 boost::shared_ptr<Send> s = boost::dynamic_pointer_cast<Send>(p);
955 boost::shared_ptr<Amp> a = s->amp();
958 a->set_gain (dB_to_coefficient (val), this);
965 OSC::route_plugin_parameter (int rid, int piid, int par, float val)
971 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
977 boost::shared_ptr<Processor> redi=r->nth_processor (piid);
983 boost::shared_ptr<PluginInsert> pi;
985 if (!(pi = boost::dynamic_pointer_cast<PluginInsert>(redi))) {
989 boost::shared_ptr<ARDOUR::Plugin> pip = pi->plugin();
992 uint32_t controlid = pip->nth_parameter (par,ok);
998 Plugin::ParameterDescriptor pd;
999 pi->plugin()->get_parameter_descriptor (controlid,pd);
1001 if (val >= pd.lower && val < pd.upper) {
1003 boost::shared_ptr<AutomationControl> c = pi->automation_control (Evoral::Parameter(PluginAutomation, 0, controlid));;
1004 cerr << "parameter:" << redi->describe_parameter(controlid) << " val:" << val << "\n";
1012 OSC::route_plugin_parameter_print (int rid, int piid, int par)
1018 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
1024 boost::shared_ptr<Processor> redi=r->nth_processor (piid);
1030 boost::shared_ptr<PluginInsert> pi;
1032 if (!(pi = boost::dynamic_pointer_cast<PluginInsert>(redi))) {
1036 boost::shared_ptr<ARDOUR::Plugin> pip = pi->plugin();
1039 uint32_t controlid = pip->nth_parameter (par,ok);
1045 Plugin::ParameterDescriptor pd;
1047 if (pi->plugin()->get_parameter_descriptor (controlid, pd) == 0) {
1048 boost::shared_ptr<AutomationControl> c = pi->automation_control (Evoral::Parameter(PluginAutomation, 0, controlid));
1050 cerr << "parameter: " << redi->describe_parameter(controlid) << "\n";
1051 cerr << "current value: " << c->get_value ();
1052 cerr << "lower value: " << pd.lower << "\n";
1053 cerr << "upper value: " << pd.upper << "\n";
1062 XMLNode* node = new XMLNode ("Protocol");
1064 node->add_property (X_("name"), "Open Sound Control (OSC)");
1065 node->add_property (X_("feedback"), _send_route_changes ? "1" : "0");
1071 OSC::set_state (const XMLNode&, int /*version*/)