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;
170 #ifdef ARDOUR_OSC_UNIX_SERVER
172 // APPEARS sluggish for now
174 // attempt to create unix socket server too
176 snprintf(tmpstr, sizeof(tmpstr), "/tmp/sooperlooper_XXXXXX");
177 int fd = mkstemp(tmpstr);
183 _osc_unix_server = lo_server_new (tmpstr, error_callback);
185 if (_osc_unix_server) {
186 _osc_unix_socket_path = tmpstr;
191 PBD::info << "OSC @ " << get_server_url () << endmsg;
193 std::string url_file;
195 if (find_file_in_search_path (ardour_config_search_path(), "osc_url", url_file)) {
197 _osc_url_file = url_file;
199 urlfile.open(_osc_url_file.c_str(), ios::trunc);
202 urlfile << get_server_url () << endl;
205 cerr << "Couldn't write '" << _osc_url_file << "'" <<endl;
209 register_callbacks();
211 // lo_server_thread_add_method(_sthread, NULL, NULL, OSC::_dummy_handler, this);
213 /* startup the event loop thread */
223 pthread_set_name (X_("OSC"));
225 if (_osc_unix_server) {
226 Glib::RefPtr<IOSource> src = IOSource::create (lo_server_get_socket_fd (_osc_unix_server), IO_IN|IO_HUP|IO_ERR);
227 src->connect (sigc::bind (sigc::mem_fun (*this, &OSC::osc_input_handler), _osc_unix_server));
228 src->attach (_main_loop->get_context());
229 local_server = src->gobj();
230 g_source_ref (local_server);
234 Glib::RefPtr<IOSource> src = IOSource::create (lo_server_get_socket_fd (_osc_server), IO_IN|IO_HUP|IO_ERR);
235 src->connect (sigc::bind (sigc::mem_fun (*this, &OSC::osc_input_handler), _osc_server));
236 src->attach (_main_loop->get_context());
237 remote_server = src->gobj();
238 g_source_ref (remote_server);
241 PBD::notify_gui_about_thread_creation (X_("gui"), pthread_self(), X_("OSC"), 2048);
242 SessionEvent::create_per_thread_pool (X_("OSC"), 128);
251 g_source_destroy (local_server);
252 g_source_unref (local_server);
257 g_source_destroy (remote_server);
258 g_source_unref (remote_server);
265 int fd = lo_server_get_socket_fd(_osc_server);
269 lo_server_free (_osc_server);
273 if (_osc_unix_server) {
274 int fd = lo_server_get_socket_fd(_osc_unix_server);
278 lo_server_free (_osc_unix_server);
279 _osc_unix_server = 0;
282 if (!_osc_unix_socket_path.empty()) {
283 unlink (_osc_unix_socket_path.c_str());
286 if (!_osc_url_file.empty() ) {
287 unlink (_osc_url_file.c_str() );
290 // Delete any active route observers
291 for (RouteObservers::iterator x = route_observers.begin(); x != route_observers.end();) {
293 OSCRouteObserver* rc;
295 if ((rc = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
297 x = route_observers.erase (x);
307 OSC::register_callbacks()
312 srvs[0] = _osc_server;
313 srvs[1] = _osc_unix_server;
315 for (size_t i = 0; i < 2; ++i) {
323 /* this is a special catchall handler */
325 lo_server_add_method (serv, 0, 0, _catchall, this);
327 #define REGISTER_CALLBACK(serv,path,types, function) lo_server_add_method (serv, path, types, OSC::_ ## function, this)
329 REGISTER_CALLBACK (serv, "/routes/list", "", routes_list);
330 REGISTER_CALLBACK (serv, "/ardour/add_marker", "", add_marker);
331 REGISTER_CALLBACK (serv, "/ardour/access_action", "s", access_action);
332 REGISTER_CALLBACK (serv, "/ardour/loop_toggle", "", loop_toggle);
333 REGISTER_CALLBACK (serv, "/ardour/goto_start", "", goto_start);
334 REGISTER_CALLBACK (serv, "/ardour/goto_end", "", goto_end);
335 REGISTER_CALLBACK (serv, "/ardour/rewind", "", rewind);
336 REGISTER_CALLBACK (serv, "/ardour/ffwd", "", ffwd);
337 REGISTER_CALLBACK (serv, "/ardour/transport_stop", "", transport_stop);
338 REGISTER_CALLBACK (serv, "/ardour/transport_play", "", transport_play);
339 REGISTER_CALLBACK (serv, "/ardour/transport_frame", "", transport_frame);
340 REGISTER_CALLBACK (serv, "/ardour/set_transport_speed", "f", set_transport_speed);
341 REGISTER_CALLBACK (serv, "/ardour/locate", "ii", locate);
342 REGISTER_CALLBACK (serv, "/ardour/save_state", "", save_state);
343 REGISTER_CALLBACK (serv, "/ardour/prev_marker", "", prev_marker);
344 REGISTER_CALLBACK (serv, "/ardour/next_marker", "", next_marker);
345 REGISTER_CALLBACK (serv, "/ardour/undo", "", undo);
346 REGISTER_CALLBACK (serv, "/ardour/redo", "", redo);
347 REGISTER_CALLBACK (serv, "/ardour/toggle_punch_in", "", toggle_punch_in);
348 REGISTER_CALLBACK (serv, "/ardour/toggle_punch_out", "", toggle_punch_out);
349 REGISTER_CALLBACK (serv, "/ardour/rec_enable_toggle", "", rec_enable_toggle);
350 REGISTER_CALLBACK (serv, "/ardour/toggle_all_rec_enables", "", toggle_all_rec_enables);
352 REGISTER_CALLBACK (serv, "/ardour/routes/mute", "ii", route_mute);
353 REGISTER_CALLBACK (serv, "/ardour/routes/solo", "ii", route_solo);
354 REGISTER_CALLBACK (serv, "/ardour/routes/recenable", "ii", route_recenable);
355 REGISTER_CALLBACK (serv, "/ardour/routes/gainabs", "if", route_set_gain_abs);
356 REGISTER_CALLBACK (serv, "/ardour/routes/gaindB", "if", route_set_gain_dB);
357 REGISTER_CALLBACK (serv, "/ardour/routes/pan_stereo_position", "if", route_set_pan_stereo_position);
358 REGISTER_CALLBACK (serv, "/ardour/routes/pan_stereo_width", "if", route_set_pan_stereo_width);
359 REGISTER_CALLBACK (serv, "/ardour/routes/plugin/parameter", "iiif", route_plugin_parameter);
360 REGISTER_CALLBACK (serv, "/ardour/routes/plugin/parameter/print", "iii", route_plugin_parameter_print);
361 REGISTER_CALLBACK (serv, "/ardour/routes/send/gainabs", "iif", route_set_send_gain_abs);
362 REGISTER_CALLBACK (serv, "/ardour/routes/send/gaindB", "iif", route_set_send_gain_dB);
364 /* still not-really-standardized query interface */
365 //REGISTER_CALLBACK (serv, "/ardour/*/#current_value", "", current_value);
366 //REGISTER_CALLBACK (serv, "/ardour/set", "", set);
368 // un/register_update args= s:ctrl s:returl s:retpath
369 //lo_server_add_method(serv, "/register_update", "sss", OSC::global_register_update_handler, this);
370 //lo_server_add_method(serv, "/unregister_update", "sss", OSC::global_unregister_update_handler, this);
371 //lo_server_add_method(serv, "/register_auto_update", "siss", OSC::global_register_auto_update_handler, this);
372 //lo_server_add_method(serv, "/unregister_auto_update", "sss", OSC::_global_unregister_auto_update_handler, this);
378 OSC::osc_input_handler (IOCondition ioc, lo_server srv)
385 lo_server_recv (srv);
392 OSC::get_server_url()
398 urlstr = lo_server_get_url (_osc_server);
407 OSC::get_unix_server_url()
412 if (_osc_unix_server) {
413 urlstr = lo_server_get_url (_osc_unix_server);
422 OSC::listen_to_route (boost::shared_ptr<Route> route, lo_address addr)
424 /* avoid duplicate listens */
426 for (RouteObservers::iterator x = route_observers.begin(); x != route_observers.end(); ++x) {
428 OSCRouteObserver* ro;
430 if ((ro = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
432 int res = strcmp(lo_address_get_hostname(ro->address()), lo_address_get_hostname(addr));
434 if (ro->route() == route && res == 0) {
440 OSCRouteObserver* o = new OSCRouteObserver (route, addr);
441 route_observers.push_back (o);
443 route->DropReferences.connect (*this, MISSING_INVALIDATOR, boost::bind (&OSC::drop_route, this, boost::weak_ptr<Route> (route)), this);
447 OSC::drop_route (boost::weak_ptr<Route> wr)
449 boost::shared_ptr<Route> r = wr.lock ();
455 for (RouteObservers::iterator x = route_observers.begin(); x != route_observers.end();) {
457 OSCRouteObserver* rc;
459 if ((rc = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
461 if (rc->route() == r) {
463 x = route_observers.erase (x);
474 OSC::end_listen (boost::shared_ptr<Route> r, lo_address addr)
476 RouteObservers::iterator x;
478 // Remove the route observers
479 for (x = route_observers.begin(); x != route_observers.end();) {
481 OSCRouteObserver* ro;
483 if ((ro = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
485 int res = strcmp(lo_address_get_hostname(ro->address()), lo_address_get_hostname(addr));
487 if (ro->route() == r && res == 0) {
489 x = route_observers.erase (x);
502 OSC::current_value_query (const char* path, size_t len, lo_arg **argv, int argc, lo_message msg)
506 subpath = (char*) malloc (len-15+1);
507 memcpy (subpath, path, len-15);
508 subpath[len-15] = '\0';
510 send_current_value (subpath, argv, argc, msg);
516 OSC::send_current_value (const char* path, lo_arg** argv, int argc, lo_message msg)
522 lo_message reply = lo_message_new ();
523 boost::shared_ptr<Route> r;
526 lo_message_add_string (reply, path);
529 lo_message_add_string (reply, "bad syntax");
532 r = session->route_by_remote_id (id);
535 lo_message_add_string (reply, "not found");
538 if (strcmp (path, "/routes/state") == 0) {
540 if (boost::dynamic_pointer_cast<AudioTrack>(r)) {
541 lo_message_add_string (reply, "AT");
542 } else if (boost::dynamic_pointer_cast<MidiTrack>(r)) {
543 lo_message_add_string (reply, "MT");
545 lo_message_add_string (reply, "B");
548 lo_message_add_string (reply, r->name().c_str());
549 lo_message_add_int32 (reply, r->n_inputs().n_audio());
550 lo_message_add_int32 (reply, r->n_outputs().n_audio());
551 lo_message_add_int32 (reply, r->muted());
552 lo_message_add_int32 (reply, r->soloed());
554 } else if (strcmp (path, "/routes/mute") == 0) {
556 lo_message_add_int32 (reply, (float) r->muted());
558 } else if (strcmp (path, "/routes/solo") == 0) {
560 lo_message_add_int32 (reply, r->soloed());
565 lo_send_message (lo_message_get_source (msg), "#reply", reply);
566 lo_message_free (reply);
570 OSC::_catchall (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data)
572 return ((OSC*)user_data)->catchall (path, types, argv, argc, data);
576 OSC::catchall (const char *path, const char* /*types*/, lo_arg **argv, int argc, lo_message msg)
579 int ret = 1; /* unhandled */
581 //cerr << "Received a message, path = " << path << " types = \""
582 // << (types ? types : "NULL") << '"' << endl;
584 /* 15 for /#current_value plus 2 for /<path> */
588 if (len >= 17 && !strcmp (&path[len-15], "/#current_value")) {
589 current_value_query (path, len, argv, argc, msg);
592 } else if (strcmp (path, "/routes/listen") == 0) {
594 cerr << "set up listener\n";
596 lo_message reply = lo_message_new ();
599 lo_message_add_string (reply, "syntax error");
601 for (int n = 0; n < argc; ++n) {
603 boost::shared_ptr<Route> r = session->route_by_remote_id (argv[n]->i);
606 lo_message_add_string (reply, "not found");
607 cerr << "no such route\n";
610 cerr << "add listener\n";
611 listen_to_route (r, lo_message_get_source (msg));
612 lo_message_add_int32 (reply, argv[n]->i);
617 lo_send_message (lo_message_get_source (msg), "#reply", reply);
618 lo_message_free (reply);
622 } else if (strcmp (path, "/routes/ignore") == 0) {
624 for (int n = 0; n < argc; ++n) {
626 boost::shared_ptr<Route> r = session->route_by_remote_id (argv[n]->i);
629 end_listen (r, lo_message_get_source (msg));
645 // "Application Hook" Handlers //
647 OSC::session_loaded (Session& s)
649 lo_address listener = lo_address_new (NULL, "7770");
650 lo_send (listener, "/session/loaded", "ss", s.path().c_str(), s.name().c_str());
654 OSC::session_exported (std::string path, std::string name)
656 lo_address listener = lo_address_new (NULL, "7770");
657 lo_send (listener, "/session/exported", "ss", path.c_str(), name.c_str());
660 // end "Application Hook" Handlers //
665 OSC::current_value (const char */*path*/, const char */*types*/, lo_arg **/*argv*/, int /*argc*/, void */*data*/, void* /*user_data*/)
670 if (argc < 3 || types == 0 || strlen (types) < 3 || types[0] != 's' || types[1] != 's' || types[2] != s) {
674 const char *returl = argv[1]->s;
675 lo_address addr = find_or_cache_addr (returl);
677 const char *retpath = argv[2]->s;
680 if (strcmp (argv[0]->s, "transport_frame") == 0) {
683 lo_send (addr, retpath, "i", session->transport_frame());
686 } else if (strcmp (argv[0]->s, "transport_speed") == 0) {
689 lo_send (addr, retpath, "i", session->transport_frame());
692 } else if (strcmp (argv[0]->s, "transport_locked") == 0) {
695 lo_send (addr, retpath, "i", session->transport_frame());
698 } else if (strcmp (argv[0]->s, "punch_in") == 0) {
701 lo_send (addr, retpath, "i", session->transport_frame());
704 } else if (strcmp (argv[0]->s, "punch_out") == 0) {
707 lo_send (addr, retpath, "i", session->transport_frame());
710 } else if (strcmp (argv[0]->s, "rec_enable") == 0) {
713 lo_send (addr, retpath, "i", session->transport_frame());
725 OSC::routes_list (lo_message msg)
727 for (int n = 0; n < (int) session->nroutes(); ++n) {
729 boost::shared_ptr<Route> r = session->route_by_remote_id (n);
733 lo_message reply = lo_message_new ();
735 if (boost::dynamic_pointer_cast<AudioTrack>(r)) {
736 lo_message_add_string (reply, "AT");
737 } else if (boost::dynamic_pointer_cast<MidiTrack>(r)) {
738 lo_message_add_string (reply, "MT");
740 lo_message_add_string (reply, "B");
743 lo_message_add_string (reply, r->name().c_str());
744 lo_message_add_int32 (reply, r->n_inputs().n_audio());
745 lo_message_add_int32 (reply, r->n_outputs().n_audio());
746 lo_message_add_int32 (reply, r->muted());
747 lo_message_add_int32 (reply, r->soloed());
748 lo_message_add_int32 (reply, r->remote_control_id());
750 if (boost::dynamic_pointer_cast<AudioTrack>(r)
751 || boost::dynamic_pointer_cast<MidiTrack>(r)) {
753 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track>(r);
754 lo_message_add_int32 (reply, t->record_enabled());
757 //Automatically listen to routes listed
758 listen_to_route(r, lo_message_get_source (msg));
760 lo_send_message (lo_message_get_source (msg), "#reply", reply);
761 lo_message_free (reply);
765 // Send end of listing message
766 lo_message reply = lo_message_new ();
768 lo_message_add_string (reply, "end_route_list");
769 lo_message_add_int64 (reply, session->frame_rate());
770 lo_message_add_int64 (reply, session->current_end_frame());
772 lo_send_message (lo_message_get_source (msg), "#reply", reply);
774 lo_message_free (reply);
778 OSC::transport_frame (lo_message msg)
780 framepos_t pos = session->transport_frame ();
782 lo_message reply = lo_message_new ();
783 lo_message_add_int64 (reply, pos);
785 lo_send_message (lo_message_get_source (msg), "/ardour/transport_frame", reply);
787 lo_message_free (reply);
791 OSC::route_mute (int rid, int yn)
793 if (!session) return -1;
795 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
798 r->set_mute (yn, this);
805 OSC::route_solo (int rid, int yn)
807 if (!session) return -1;
809 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
812 r->set_solo (yn, this);
819 OSC::route_recenable (int rid, int yn)
821 if (!session) return -1;
823 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
826 r->set_record_enabled (yn, this);
833 OSC::route_set_gain_abs (int rid, float level)
835 if (!session) return -1;
837 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
840 r->set_gain (level, this);
847 OSC::route_set_gain_dB (int rid, float dB)
849 if (!session) return -1;
851 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
854 r->set_gain (dB_to_coefficient (dB), this);
861 OSC::route_set_pan_stereo_position (int rid, float pos)
863 if (!session) return -1;
865 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
868 boost::shared_ptr<Panner> panner = r->panner();
870 panner->set_position (pos);
879 OSC::route_set_pan_stereo_width (int rid, float pos)
881 if (!session) return -1;
883 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
886 boost::shared_ptr<Panner> panner = r->panner();
888 panner->set_width (pos);
897 OSC::route_set_send_gain_abs (int rid, int sid, float val)
903 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
909 /* revert to zero-based counting */
915 boost::shared_ptr<Processor> p = r->nth_send (sid);
918 boost::shared_ptr<Send> s = boost::dynamic_pointer_cast<Send>(p);
919 boost::shared_ptr<Amp> a = s->amp();
922 a->set_gain (val, this);
929 OSC::route_set_send_gain_dB (int rid, int sid, float val)
935 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
941 /* revert to zero-based counting */
947 boost::shared_ptr<Processor> p = r->nth_send (sid);
950 boost::shared_ptr<Send> s = boost::dynamic_pointer_cast<Send>(p);
951 boost::shared_ptr<Amp> a = s->amp();
954 a->set_gain (dB_to_coefficient (val), this);
961 OSC::route_plugin_parameter (int rid, int piid, int par, float val)
967 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
973 boost::shared_ptr<Processor> redi=r->nth_processor (piid);
979 boost::shared_ptr<PluginInsert> pi;
981 if (!(pi = boost::dynamic_pointer_cast<PluginInsert>(redi))) {
985 boost::shared_ptr<ARDOUR::Plugin> pip = pi->plugin();
988 uint32_t controlid = pip->nth_parameter (par,ok);
994 Plugin::ParameterDescriptor pd;
995 pi->plugin()->get_parameter_descriptor (controlid,pd);
997 if (val >= pd.lower && val < pd.upper) {
999 boost::shared_ptr<AutomationControl> c = pi->automation_control (Evoral::Parameter(PluginAutomation, 0, controlid));;
1000 cerr << "parameter:" << redi->describe_parameter(controlid) << " val:" << val << "\n";
1008 OSC::route_plugin_parameter_print (int rid, int piid, int par)
1014 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
1020 boost::shared_ptr<Processor> redi=r->nth_processor (piid);
1026 boost::shared_ptr<PluginInsert> pi;
1028 if (!(pi = boost::dynamic_pointer_cast<PluginInsert>(redi))) {
1032 boost::shared_ptr<ARDOUR::Plugin> pip = pi->plugin();
1035 uint32_t controlid = pip->nth_parameter (par,ok);
1041 Plugin::ParameterDescriptor pd;
1043 if (pi->plugin()->get_parameter_descriptor (controlid, pd) == 0) {
1044 boost::shared_ptr<AutomationControl> c = pi->automation_control (Evoral::Parameter(PluginAutomation, 0, controlid));
1046 cerr << "parameter: " << redi->describe_parameter(controlid) << "\n";
1047 cerr << "current value: " << c->get_value ();
1048 cerr << "lower value: " << pd.lower << "\n";
1049 cerr << "upper value: " << pd.upper << "\n";
1058 XMLNode* node = new XMLNode ("Protocol");
1060 node->add_property (X_("name"), "Open Sound Control (OSC)");
1061 node->add_property (X_("feedback"), _send_route_changes ? "1" : "0");
1067 OSC::set_state (const XMLNode&, int /*version*/)