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.
30 #include <glib/gstdio.h>
31 #include <glibmm/miscutils.h>
33 #include <pbd/convert.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/plugin_insert.h"
48 #include "ardour/send.h"
51 #include "osc_controllable.h"
52 #include "osc_route_observer.h"
55 using namespace ARDOUR;
59 #include "pbd/abstract_ui.cc" // instantiate template
61 OSC* OSC::_instance = 0;
64 static void error_callback(int num, const char *m, const char *path)
66 fprintf(stderr, "liblo server error %d in path %s: %s\n", num, path, m);
69 static void error_callback(int, const char *, const char *)
75 OSC::OSC (Session& s, uint32_t port)
76 : ControlProtocol (s, X_("Open Sound Control (OSC)"))
77 , AbstractUI<OSCUIRequest> ("osc")
84 , _osc_unix_server (0)
85 , _namespace_root ("/ardour")
86 , _send_route_changes (true)
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)
116 if (yn != active()) {
130 return ControlProtocol::set_active (yn);
134 OSC::get_active () const
136 return _osc_server != 0;
140 OSC::set_feedback (bool yn)
142 _send_route_changes = yn;
147 OSC::get_feedback () const
149 return _send_route_changes;
158 /* already started */
162 for (int j=0; j < 20; ++j) {
163 snprintf(tmpstr, sizeof(tmpstr), "%d", _port);
165 //if ((_osc_server = lo_server_new_with_proto (tmpstr, LO_TCP, error_callback))) {
169 if ((_osc_server = lo_server_new (tmpstr, error_callback))) {
174 cerr << "can't get osc at port: " << _port << endl;
184 #ifdef ARDOUR_OSC_UNIX_SERVER
186 // APPEARS sluggish for now
188 // attempt to create unix socket server too
190 snprintf(tmpstr, sizeof(tmpstr), "/tmp/sooperlooper_XXXXXX");
191 int fd = mkstemp(tmpstr);
197 _osc_unix_server = lo_server_new (tmpstr, error_callback);
199 if (_osc_unix_server) {
200 _osc_unix_socket_path = tmpstr;
205 PBD::info << "OSC @ " << get_server_url () << endmsg;
207 std::string url_file;
209 if (find_file (ardour_config_search_path(), "osc_url", url_file)) {
211 _osc_url_file = url_file;
213 urlfile.open(_osc_url_file.c_str(), ios::trunc);
216 urlfile << get_server_url () << endl;
219 cerr << "Couldn't write '" << _osc_url_file << "'" <<endl;
223 register_callbacks();
225 // lo_server_thread_add_method(_sthread, NULL, NULL, OSC::_dummy_handler, this);
227 /* startup the event loop thread */
237 pthread_set_name (X_("OSC"));
239 if (_osc_unix_server) {
240 Glib::RefPtr<IOSource> src = IOSource::create (lo_server_get_socket_fd (_osc_unix_server), IO_IN|IO_HUP|IO_ERR);
241 src->connect (sigc::bind (sigc::mem_fun (*this, &OSC::osc_input_handler), _osc_unix_server));
242 src->attach (_main_loop->get_context());
243 local_server = src->gobj();
244 g_source_ref (local_server);
248 Glib::RefPtr<IOSource> src = IOSource::create (lo_server_get_socket_fd (_osc_server), IO_IN|IO_HUP|IO_ERR);
249 src->connect (sigc::bind (sigc::mem_fun (*this, &OSC::osc_input_handler), _osc_server));
250 src->attach (_main_loop->get_context());
251 remote_server = src->gobj();
252 g_source_ref (remote_server);
255 PBD::notify_gui_about_thread_creation (X_("gui"), pthread_self(), X_("OSC"), 2048);
256 SessionEvent::create_per_thread_pool (X_("OSC"), 128);
265 g_source_destroy (local_server);
266 g_source_unref (local_server);
271 g_source_destroy (remote_server);
272 g_source_unref (remote_server);
279 int fd = lo_server_get_socket_fd(_osc_server);
283 lo_server_free (_osc_server);
287 if (_osc_unix_server) {
288 int fd = lo_server_get_socket_fd(_osc_unix_server);
292 lo_server_free (_osc_unix_server);
293 _osc_unix_server = 0;
296 if (!_osc_unix_socket_path.empty()) {
297 ::g_unlink (_osc_unix_socket_path.c_str());
300 if (!_osc_url_file.empty() ) {
301 ::g_unlink (_osc_url_file.c_str() );
304 // Delete any active route observers
305 for (RouteObservers::iterator x = route_observers.begin(); x != route_observers.end();) {
307 OSCRouteObserver* rc;
309 if ((rc = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
311 x = route_observers.erase (x);
321 OSC::register_callbacks()
326 srvs[0] = _osc_server;
327 srvs[1] = _osc_unix_server;
329 for (size_t i = 0; i < 2; ++i) {
337 /* this is a special catchall handler */
339 lo_server_add_method (serv, 0, 0, _catchall, this);
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/goto_start", "", goto_start);
348 REGISTER_CALLBACK (serv, "/ardour/goto_end", "", goto_end);
349 REGISTER_CALLBACK (serv, "/ardour/rewind", "", rewind);
350 REGISTER_CALLBACK (serv, "/ardour/ffwd", "", ffwd);
351 REGISTER_CALLBACK (serv, "/ardour/transport_stop", "", transport_stop);
352 REGISTER_CALLBACK (serv, "/ardour/transport_play", "", transport_play);
353 REGISTER_CALLBACK (serv, "/ardour/transport_frame", "", transport_frame);
354 REGISTER_CALLBACK (serv, "/ardour/set_transport_speed", "f", set_transport_speed);
355 REGISTER_CALLBACK (serv, "/ardour/locate", "ii", locate);
356 REGISTER_CALLBACK (serv, "/ardour/save_state", "", save_state);
357 REGISTER_CALLBACK (serv, "/ardour/prev_marker", "", prev_marker);
358 REGISTER_CALLBACK (serv, "/ardour/next_marker", "", next_marker);
359 REGISTER_CALLBACK (serv, "/ardour/undo", "", undo);
360 REGISTER_CALLBACK (serv, "/ardour/redo", "", redo);
361 REGISTER_CALLBACK (serv, "/ardour/toggle_punch_in", "", toggle_punch_in);
362 REGISTER_CALLBACK (serv, "/ardour/toggle_punch_out", "", toggle_punch_out);
363 REGISTER_CALLBACK (serv, "/ardour/rec_enable_toggle", "", rec_enable_toggle);
364 REGISTER_CALLBACK (serv, "/ardour/toggle_all_rec_enables", "", toggle_all_rec_enables);
366 REGISTER_CALLBACK (serv, "/ardour/routes/mute", "ii", route_mute);
367 REGISTER_CALLBACK (serv, "/ardour/routes/solo", "ii", route_solo);
368 REGISTER_CALLBACK (serv, "/ardour/routes/recenable", "ii", route_recenable);
369 REGISTER_CALLBACK (serv, "/ardour/routes/gainabs", "if", route_set_gain_abs);
370 REGISTER_CALLBACK (serv, "/ardour/routes/gaindB", "if", route_set_gain_dB);
371 REGISTER_CALLBACK (serv, "/ardour/routes/pan_stereo_position", "if", route_set_pan_stereo_position);
372 REGISTER_CALLBACK (serv, "/ardour/routes/pan_stereo_width", "if", route_set_pan_stereo_width);
373 REGISTER_CALLBACK (serv, "/ardour/routes/plugin/parameter", "iiif", route_plugin_parameter);
374 REGISTER_CALLBACK (serv, "/ardour/routes/plugin/parameter/print", "iii", route_plugin_parameter_print);
375 REGISTER_CALLBACK (serv, "/ardour/routes/send/gainabs", "iif", route_set_send_gain_abs);
376 REGISTER_CALLBACK (serv, "/ardour/routes/send/gaindB", "iif", route_set_send_gain_dB);
378 /* still not-really-standardized query interface */
379 //REGISTER_CALLBACK (serv, "/ardour/*/#current_value", "", current_value);
380 //REGISTER_CALLBACK (serv, "/ardour/set", "", set);
382 // un/register_update args= s:ctrl s:returl s:retpath
383 //lo_server_add_method(serv, "/register_update", "sss", OSC::global_register_update_handler, this);
384 //lo_server_add_method(serv, "/unregister_update", "sss", OSC::global_unregister_update_handler, this);
385 //lo_server_add_method(serv, "/register_auto_update", "siss", OSC::global_register_auto_update_handler, this);
386 //lo_server_add_method(serv, "/unregister_auto_update", "sss", OSC::_global_unregister_auto_update_handler, this);
392 OSC::osc_input_handler (IOCondition ioc, lo_server srv)
399 lo_server_recv (srv);
406 OSC::get_server_url()
412 urlstr = lo_server_get_url (_osc_server);
421 OSC::get_unix_server_url()
426 if (_osc_unix_server) {
427 urlstr = lo_server_get_url (_osc_unix_server);
436 OSC::listen_to_route (boost::shared_ptr<Route> route, lo_address addr)
438 /* avoid duplicate listens */
440 for (RouteObservers::iterator x = route_observers.begin(); x != route_observers.end(); ++x) {
442 OSCRouteObserver* ro;
444 if ((ro = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
446 int res = strcmp(lo_address_get_hostname(ro->address()), lo_address_get_hostname(addr));
448 if (ro->route() == route && res == 0) {
454 OSCRouteObserver* o = new OSCRouteObserver (route, addr);
455 route_observers.push_back (o);
457 route->DropReferences.connect (*this, MISSING_INVALIDATOR, boost::bind (&OSC::drop_route, this, boost::weak_ptr<Route> (route)), this);
461 OSC::drop_route (boost::weak_ptr<Route> wr)
463 boost::shared_ptr<Route> r = wr.lock ();
469 for (RouteObservers::iterator x = route_observers.begin(); x != route_observers.end();) {
471 OSCRouteObserver* rc;
473 if ((rc = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
475 if (rc->route() == r) {
477 x = route_observers.erase (x);
488 OSC::end_listen (boost::shared_ptr<Route> r, lo_address addr)
490 RouteObservers::iterator x;
492 // Remove the route observers
493 for (x = route_observers.begin(); x != route_observers.end();) {
495 OSCRouteObserver* ro;
497 if ((ro = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
499 int res = strcmp(lo_address_get_hostname(ro->address()), lo_address_get_hostname(addr));
501 if (ro->route() == r && res == 0) {
503 x = route_observers.erase (x);
516 OSC::current_value_query (const char* path, size_t len, lo_arg **argv, int argc, lo_message msg)
520 subpath = (char*) malloc (len-15+1);
521 memcpy (subpath, path, len-15);
522 subpath[len-15] = '\0';
524 send_current_value (subpath, argv, argc, msg);
530 OSC::send_current_value (const char* path, lo_arg** argv, int argc, lo_message msg)
536 lo_message reply = lo_message_new ();
537 boost::shared_ptr<Route> r;
540 lo_message_add_string (reply, path);
543 lo_message_add_string (reply, "bad syntax");
546 r = session->route_by_remote_id (id);
549 lo_message_add_string (reply, "not found");
552 if (strcmp (path, "/routes/state") == 0) {
554 if (boost::dynamic_pointer_cast<AudioTrack>(r)) {
555 lo_message_add_string (reply, "AT");
556 } else if (boost::dynamic_pointer_cast<MidiTrack>(r)) {
557 lo_message_add_string (reply, "MT");
559 lo_message_add_string (reply, "B");
562 lo_message_add_string (reply, r->name().c_str());
563 lo_message_add_int32 (reply, r->n_inputs().n_audio());
564 lo_message_add_int32 (reply, r->n_outputs().n_audio());
565 lo_message_add_int32 (reply, r->muted());
566 lo_message_add_int32 (reply, r->soloed());
568 } else if (strcmp (path, "/routes/mute") == 0) {
570 lo_message_add_int32 (reply, (float) r->muted());
572 } else if (strcmp (path, "/routes/solo") == 0) {
574 lo_message_add_int32 (reply, r->soloed());
579 lo_send_message (lo_message_get_source (msg), "#reply", reply);
580 lo_message_free (reply);
584 OSC::_catchall (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data)
586 return ((OSC*)user_data)->catchall (path, types, argv, argc, data);
590 OSC::catchall (const char *path, const char* /*types*/, lo_arg **argv, int argc, lo_message msg)
593 int ret = 1; /* unhandled */
595 //cerr << "Received a message, path = " << path << " types = \""
596 // << (types ? types : "NULL") << '"' << endl;
598 /* 15 for /#current_value plus 2 for /<path> */
602 if (len >= 17 && !strcmp (&path[len-15], "/#current_value")) {
603 current_value_query (path, len, argv, argc, msg);
606 } else if (strcmp (path, "/routes/listen") == 0) {
608 cerr << "set up listener\n";
610 lo_message reply = lo_message_new ();
613 lo_message_add_string (reply, "syntax error");
615 for (int n = 0; n < argc; ++n) {
617 boost::shared_ptr<Route> r = session->route_by_remote_id (argv[n]->i);
620 lo_message_add_string (reply, "not found");
621 cerr << "no such route\n";
624 cerr << "add listener\n";
625 listen_to_route (r, lo_message_get_source (msg));
626 lo_message_add_int32 (reply, argv[n]->i);
631 lo_send_message (lo_message_get_source (msg), "#reply", reply);
632 lo_message_free (reply);
636 } else if (strcmp (path, "/routes/ignore") == 0) {
638 for (int n = 0; n < argc; ++n) {
640 boost::shared_ptr<Route> r = session->route_by_remote_id (argv[n]->i);
643 end_listen (r, lo_message_get_source (msg));
659 // "Application Hook" Handlers //
661 OSC::session_loaded (Session& s)
663 lo_address listener = lo_address_new (NULL, "7770");
664 lo_send (listener, "/session/loaded", "ss", s.path().c_str(), s.name().c_str());
668 OSC::session_exported (std::string path, std::string name)
670 lo_address listener = lo_address_new (NULL, "7770");
671 lo_send (listener, "/session/exported", "ss", path.c_str(), name.c_str());
674 // end "Application Hook" Handlers //
679 OSC::current_value (const char */*path*/, const char */*types*/, lo_arg **/*argv*/, int /*argc*/, void */*data*/, void* /*user_data*/)
684 if (argc < 3 || types == 0 || strlen (types) < 3 || types[0] != 's' || types[1] != 's' || types[2] != s) {
688 const char *returl = argv[1]->s;
689 lo_address addr = find_or_cache_addr (returl);
691 const char *retpath = argv[2]->s;
694 if (strcmp (argv[0]->s, "transport_frame") == 0) {
697 lo_send (addr, retpath, "i", session->transport_frame());
700 } else if (strcmp (argv[0]->s, "transport_speed") == 0) {
703 lo_send (addr, retpath, "i", session->transport_frame());
706 } else if (strcmp (argv[0]->s, "transport_locked") == 0) {
709 lo_send (addr, retpath, "i", session->transport_frame());
712 } else if (strcmp (argv[0]->s, "punch_in") == 0) {
715 lo_send (addr, retpath, "i", session->transport_frame());
718 } else if (strcmp (argv[0]->s, "punch_out") == 0) {
721 lo_send (addr, retpath, "i", session->transport_frame());
724 } else if (strcmp (argv[0]->s, "rec_enable") == 0) {
727 lo_send (addr, retpath, "i", session->transport_frame());
739 OSC::routes_list (lo_message msg)
741 for (int n = 0; n < (int) session->nroutes(); ++n) {
743 boost::shared_ptr<Route> r = session->route_by_remote_id (n);
747 lo_message reply = lo_message_new ();
749 if (boost::dynamic_pointer_cast<AudioTrack>(r)) {
750 lo_message_add_string (reply, "AT");
751 } else if (boost::dynamic_pointer_cast<MidiTrack>(r)) {
752 lo_message_add_string (reply, "MT");
754 lo_message_add_string (reply, "B");
757 lo_message_add_string (reply, r->name().c_str());
758 lo_message_add_int32 (reply, r->n_inputs().n_audio());
759 lo_message_add_int32 (reply, r->n_outputs().n_audio());
760 lo_message_add_int32 (reply, r->muted());
761 lo_message_add_int32 (reply, r->soloed());
762 lo_message_add_int32 (reply, r->remote_control_id());
764 if (boost::dynamic_pointer_cast<AudioTrack>(r)
765 || boost::dynamic_pointer_cast<MidiTrack>(r)) {
767 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track>(r);
768 lo_message_add_int32 (reply, t->record_enabled());
771 //Automatically listen to routes listed
772 listen_to_route(r, lo_message_get_source (msg));
774 lo_send_message (lo_message_get_source (msg), "#reply", reply);
775 lo_message_free (reply);
779 // Send end of listing message
780 lo_message reply = lo_message_new ();
782 lo_message_add_string (reply, "end_route_list");
783 lo_message_add_int64 (reply, session->frame_rate());
784 lo_message_add_int64 (reply, session->current_end_frame());
786 lo_send_message (lo_message_get_source (msg), "#reply", reply);
788 lo_message_free (reply);
792 OSC::transport_frame (lo_message msg)
794 framepos_t pos = session->transport_frame ();
796 lo_message reply = lo_message_new ();
797 lo_message_add_int64 (reply, pos);
799 lo_send_message (lo_message_get_source (msg), "/ardour/transport_frame", reply);
801 lo_message_free (reply);
805 OSC::route_mute (int rid, int yn)
807 if (!session) return -1;
809 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
812 r->set_mute (yn, this);
819 OSC::route_solo (int rid, int yn)
821 if (!session) return -1;
823 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
826 r->set_solo (yn, this);
833 OSC::route_recenable (int rid, int yn)
835 if (!session) return -1;
837 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
840 r->set_record_enabled (yn, this);
847 OSC::route_set_gain_abs (int rid, float level)
849 if (!session) return -1;
851 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
854 r->set_gain (level, this);
861 OSC::route_set_gain_dB (int rid, float dB)
863 if (!session) return -1;
865 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
868 r->set_gain (dB_to_coefficient (dB), this);
875 OSC::route_set_pan_stereo_position (int rid, float pos)
877 if (!session) return -1;
879 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
882 boost::shared_ptr<Panner> panner = r->panner();
884 panner->set_position (pos);
893 OSC::route_set_pan_stereo_width (int rid, float pos)
895 if (!session) return -1;
897 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
900 boost::shared_ptr<Panner> panner = r->panner();
902 panner->set_width (pos);
911 OSC::route_set_send_gain_abs (int rid, int sid, float val)
917 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
923 /* revert to zero-based counting */
929 boost::shared_ptr<Processor> p = r->nth_send (sid);
932 boost::shared_ptr<Send> s = boost::dynamic_pointer_cast<Send>(p);
933 boost::shared_ptr<Amp> a = s->amp();
936 a->set_gain (val, this);
943 OSC::route_set_send_gain_dB (int rid, int sid, float val)
949 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
955 /* revert to zero-based counting */
961 boost::shared_ptr<Processor> p = r->nth_send (sid);
964 boost::shared_ptr<Send> s = boost::dynamic_pointer_cast<Send>(p);
965 boost::shared_ptr<Amp> a = s->amp();
968 a->set_gain (dB_to_coefficient (val), this);
975 OSC::route_plugin_parameter (int rid, int piid, int par, float val)
981 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
987 boost::shared_ptr<Processor> redi=r->nth_processor (piid);
993 boost::shared_ptr<PluginInsert> pi;
995 if (!(pi = boost::dynamic_pointer_cast<PluginInsert>(redi))) {
999 boost::shared_ptr<ARDOUR::Plugin> pip = pi->plugin();
1002 uint32_t controlid = pip->nth_parameter (par,ok);
1008 ParameterDescriptor pd;
1009 pi->plugin()->get_parameter_descriptor (controlid,pd);
1011 if (val >= pd.lower && val < pd.upper) {
1013 boost::shared_ptr<AutomationControl> c = pi->automation_control (Evoral::Parameter(PluginAutomation, 0, controlid));;
1014 cerr << "parameter:" << redi->describe_parameter(controlid) << " val:" << val << "\n";
1022 OSC::route_plugin_parameter_print (int rid, int piid, int par)
1028 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
1034 boost::shared_ptr<Processor> redi=r->nth_processor (piid);
1040 boost::shared_ptr<PluginInsert> pi;
1042 if (!(pi = boost::dynamic_pointer_cast<PluginInsert>(redi))) {
1046 boost::shared_ptr<ARDOUR::Plugin> pip = pi->plugin();
1049 uint32_t controlid = pip->nth_parameter (par,ok);
1055 ParameterDescriptor pd;
1057 if (pi->plugin()->get_parameter_descriptor (controlid, pd) == 0) {
1058 boost::shared_ptr<AutomationControl> c = pi->automation_control (Evoral::Parameter(PluginAutomation, 0, controlid));
1060 cerr << "parameter: " << redi->describe_parameter(controlid) << "\n";
1061 cerr << "current value: " << c->get_value ();
1062 cerr << "lower value: " << pd.lower << "\n";
1063 cerr << "upper value: " << pd.upper << "\n";
1072 XMLNode& node (ControlProtocol::get_state());
1074 node.add_property (X_("feedback"), _send_route_changes ? "1" : "0");
1079 OSC::set_state (const XMLNode& node, int /*version*/)
1081 const XMLProperty* prop = node.property (X_("feedback"));
1084 if (PBD::string_is_affirmative (prop->value())) {
1085 _send_route_changes = true;
1087 _send_route_changes = false;
1090 /* leave it alone */