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>
32 #include <boost/signals2.hpp>
34 #include <pbd/pthread_utils.h>
35 #include <pbd/file_utils.h>
36 #include <pbd/filesystem.h>
37 #include <pbd/failed_constructor.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"
49 #include "osc_controllable.h"
50 #include "osc_route_observer.h"
53 using namespace ARDOUR;
57 #include "pbd/abstract_ui.cc" // instantiate template
59 #define ui_bind(f, ...) boost::protect (boost::bind (f, __VA_ARGS__))
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, "OSC", this)
77 , AbstractUI<OSCUIRequest> ("osc")
84 _namespace_root = "/ardour";
85 _send_route_changes = true;
91 // "Application Hooks"
93 session->Exported.connect (*this, MISSING_INVALIDATOR, ui_bind (&OSC::session_exported, this, _1, _2), this);
103 OSC::do_request (OSCUIRequest* req)
105 if (req->type == CallSlot) {
107 call_slot (MISSING_INVALIDATOR, req->the_slot);
109 } else if (req->type == Quit) {
116 OSC::set_active (bool yn)
126 OSC::get_active () const
128 return _osc_server != 0;
132 OSC::set_feedback (bool yn)
134 _send_route_changes = yn;
139 OSC::get_feedback () const
141 return _send_route_changes;
150 /* already started */
154 for (int j=0; j < 20; ++j) {
155 snprintf(tmpstr, sizeof(tmpstr), "%d", _port);
157 //if ((_osc_server = lo_server_new_with_proto (tmpstr, LO_TCP, error_callback))) {
161 if ((_osc_server = lo_server_new (tmpstr, error_callback))) {
166 cerr << "can't get osc at port: " << _port << endl;
172 #ifdef ARDOUR_OSC_UNIX_SERVER
174 // APPEARS sluggish for now
176 // attempt to create unix socket server too
178 snprintf(tmpstr, sizeof(tmpstr), "/tmp/sooperlooper_XXXXXX");
179 int fd = mkstemp(tmpstr);
185 _osc_unix_server = lo_server_new (tmpstr, error_callback);
187 if (_osc_unix_server) {
188 _osc_unix_socket_path = tmpstr;
193 cerr << "OSC @ " << get_server_url () << endl;
195 PBD::sys::path url_file;
197 if (find_file_in_search_path (ardour_search_path() + system_config_search_path(),
198 "osc_url", url_file)) {
200 _osc_url_file = url_file.to_string();
202 urlfile.open(_osc_url_file.c_str(), ios::trunc);
205 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 char* c = new char[4];
228 strcpy (c, X_("OSC"));
229 pthread_set_name (c);
231 if (_osc_unix_server) {
232 Glib::RefPtr<IOSource> src = IOSource::create (lo_server_get_socket_fd (_osc_unix_server), IO_IN|IO_HUP|IO_ERR);
233 src->connect (sigc::bind (sigc::mem_fun (*this, &OSC::osc_input_handler), _osc_unix_server));
234 src->attach (_main_loop->get_context());
235 local_server = src->gobj();
236 g_source_ref (local_server);
240 Glib::RefPtr<IOSource> src = IOSource::create (lo_server_get_socket_fd (_osc_server), IO_IN|IO_HUP|IO_ERR);
241 src->connect (sigc::bind (sigc::mem_fun (*this, &OSC::osc_input_handler), _osc_server));
242 src->attach (_main_loop->get_context());
243 remote_server = src->gobj();
244 g_source_ref (remote_server);
247 PBD::notify_gui_about_thread_creation (X_("gui"), pthread_self(), X_("OSC"), 2048);
248 SessionEvent::create_per_thread_pool (X_("OSC"), 128);
257 g_source_destroy (local_server);
258 g_source_unref (local_server);
263 g_source_destroy (remote_server);
264 g_source_unref (remote_server);
271 int fd = lo_server_get_socket_fd(_osc_server);
275 lo_server_free (_osc_server);
279 if (_osc_unix_server) {
280 int fd = lo_server_get_socket_fd(_osc_unix_server);
284 lo_server_free (_osc_unix_server);
285 _osc_unix_server = 0;
288 if (!_osc_unix_socket_path.empty()) {
289 unlink (_osc_unix_socket_path.c_str());
292 if (!_osc_url_file.empty() ) {
293 unlink (_osc_url_file.c_str() );
300 OSC::register_callbacks()
305 srvs[0] = _osc_server;
306 srvs[1] = _osc_unix_server;
308 for (size_t i = 0; i < 2; ++i) {
316 /* this is a special catchall handler */
318 lo_server_add_method (serv, 0, 0, _catchall, this);
320 #define REGISTER_CALLBACK(serv,path,types, function) lo_server_add_method (serv, path, types, OSC::_ ## function, this)
322 REGISTER_CALLBACK (serv, "/ardour/add_marker", "", add_marker);
323 REGISTER_CALLBACK (serv, "/ardour/access_action", "s", access_action);
324 REGISTER_CALLBACK (serv, "/ardour/loop_toggle", "", loop_toggle);
325 REGISTER_CALLBACK (serv, "/ardour/goto_start", "", goto_start);
326 REGISTER_CALLBACK (serv, "/ardour/goto_end", "", goto_end);
327 REGISTER_CALLBACK (serv, "/ardour/rewind", "", rewind);
328 REGISTER_CALLBACK (serv, "/ardour/ffwd", "", ffwd);
329 REGISTER_CALLBACK (serv, "/ardour/transport_stop", "", transport_stop);
330 REGISTER_CALLBACK (serv, "/ardour/transport_play", "", transport_play);
331 //REGISTER_CALLBACK (serv, "/ardour/transport_frame", "", transport_frame);
332 REGISTER_CALLBACK (serv, "/ardour/set_transport_speed", "f", set_transport_speed);
333 REGISTER_CALLBACK (serv, "/ardour/locate", "ii", locate);
334 REGISTER_CALLBACK (serv, "/ardour/save_state", "", save_state);
335 REGISTER_CALLBACK (serv, "/ardour/prev_marker", "", prev_marker);
336 REGISTER_CALLBACK (serv, "/ardour/next_marker", "", next_marker);
337 REGISTER_CALLBACK (serv, "/ardour/undo", "", undo);
338 REGISTER_CALLBACK (serv, "/ardour/redo", "", redo);
339 REGISTER_CALLBACK (serv, "/ardour/toggle_punch_in", "", toggle_punch_in);
340 REGISTER_CALLBACK (serv, "/ardour/toggle_punch_out", "", toggle_punch_out);
341 REGISTER_CALLBACK (serv, "/ardour/rec_enable_toggle", "", rec_enable_toggle);
342 REGISTER_CALLBACK (serv, "/ardour/toggle_all_rec_enables", "", toggle_all_rec_enables);
344 REGISTER_CALLBACK (serv, "/ardour/routes/mute", "ii", route_mute);
345 REGISTER_CALLBACK (serv, "/ardour/routes/solo", "ii", route_solo);
346 REGISTER_CALLBACK (serv, "/ardour/routes/recenable", "ii", route_recenable);
347 REGISTER_CALLBACK (serv, "/ardour/routes/gainabs", "if", route_set_gain_abs);
348 REGISTER_CALLBACK (serv, "/ardour/routes/gaindB", "if", route_set_gain_dB);
349 REGISTER_CALLBACK (serv, "/ardour/routes/pan_stereo_position", "if", route_set_pan_stereo_position);
350 REGISTER_CALLBACK (serv, "/ardour/routes/pan_stereo_width", "if", route_set_pan_stereo_width);
351 REGISTER_CALLBACK (serv, "/ardour/routes/plugin/parameter", "iiif", route_plugin_parameter);
352 REGISTER_CALLBACK (serv, "/ardour/routes/plugin/parameter/print", "iii", route_plugin_parameter_print);
356 /* still not-really-standardized query interface */
357 //REGISTER_CALLBACK (serv, "/ardour/*/#current_value", "", current_value);
358 //REGISTER_CALLBACK (serv, "/ardour/set", "", set);
360 // un/register_update args= s:ctrl s:returl s:retpath
361 //lo_server_add_method(serv, "/register_update", "sss", OSC::global_register_update_handler, this);
362 //lo_server_add_method(serv, "/unregister_update", "sss", OSC::global_unregister_update_handler, this);
363 //lo_server_add_method(serv, "/register_auto_update", "siss", OSC::global_register_auto_update_handler, this);
364 //lo_server_add_method(serv, "/unregister_auto_update", "sss", OSC::_global_unregister_auto_update_handler, this);
370 OSC::osc_input_handler (IOCondition ioc, lo_server srv)
377 lo_server_recv (srv);
384 OSC::get_server_url()
390 urlstr = lo_server_get_url (_osc_server);
399 OSC::get_unix_server_url()
404 if (_osc_unix_server) {
405 urlstr = lo_server_get_url (_osc_unix_server);
415 OSC::current_value_query (const char* path, size_t len, lo_arg **argv, int argc, lo_message msg)
419 subpath = (char*) malloc (len-15+1);
420 memcpy (subpath, path, len-15);
421 subpath[len-15] = '\0';
423 send_current_value (subpath, argv, argc, msg);
429 OSC::send_current_value (const char* path, lo_arg** argv, int argc, lo_message msg)
435 lo_message reply = lo_message_new ();
436 boost::shared_ptr<Route> r;
439 lo_message_add_string (reply, path);
442 lo_message_add_string (reply, "bad syntax");
445 r = session->route_by_remote_id (id);
448 lo_message_add_string (reply, "not found");
451 if (strcmp (path, "/routes/state") == 0) {
453 if (boost::dynamic_pointer_cast<AudioTrack>(r)) {
454 lo_message_add_string (reply, "AT");
455 } else if (boost::dynamic_pointer_cast<MidiTrack>(r)) {
456 lo_message_add_string (reply, "MT");
458 lo_message_add_string (reply, "B");
461 lo_message_add_string (reply, r->name().c_str());
462 lo_message_add_int32 (reply, r->n_inputs().n_audio());
463 lo_message_add_int32 (reply, r->n_outputs().n_audio());
464 lo_message_add_int32 (reply, r->muted());
465 lo_message_add_int32 (reply, r->soloed());
467 } else if (strcmp (path, "/routes/mute") == 0) {
469 lo_message_add_int32 (reply, (float) r->muted());
471 } else if (strcmp (path, "/routes/solo") == 0) {
473 lo_message_add_int32 (reply, r->soloed());
478 lo_send_message (lo_message_get_source (msg), "#reply", reply);
479 lo_message_free (reply);
483 OSC::_catchall (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data)
485 return ((OSC*)user_data)->catchall (path, types, argv, argc, data);
489 OSC::catchall (const char *path, const char *types, lo_arg **argv, int argc, lo_message msg)
492 int ret = 1; /* unhandled */
494 //cerr << "Received a message, path = " << path << " types = \""
495 // << (types ? types : "NULL") << '"' << endl;
497 /* 15 for /#current_value plus 2 for /<path> */
501 if (len >= 17 && !strcmp (&path[len-15], "/#current_value")) {
502 current_value_query (path, len, argv, argc, msg);
504 } else if (strcmp (path, "/ardour/transport_frame") == 0) {
506 framepos_t pos = transport_frame ();
508 lo_message reply = lo_message_new ();
509 lo_message_add_int64 (reply, pos);
511 lo_send_message (lo_message_get_source (msg), "/ardour/transport_frame", reply);
513 lo_message_free (reply);
517 } else if (strcmp (path, "/routes/listen") == 0) {
519 cerr << "set up listener\n";
521 lo_message reply = lo_message_new ();
524 lo_message_add_string (reply, "syntax error");
526 for (int n = 0; n < argc; ++n) {
528 boost::shared_ptr<Route> r = session->route_by_remote_id (argv[n]->i);
531 lo_message_add_string (reply, "not found");
532 cerr << "no such route\n";
535 cerr << "add listener\n";
536 listen_to_route (r, lo_message_get_source (msg));
537 lo_message_add_int32 (reply, argv[n]->i);
542 lo_send_message (lo_message_get_source (msg), "#reply", reply);
543 lo_message_free (reply);
547 } else if (strcmp (path, "/routes/ignore") == 0) {
549 for (int n = 0; n < argc; ++n) {
551 boost::shared_ptr<Route> r = session->route_by_remote_id (argv[n]->i);
554 end_listen (r, lo_message_get_source (msg));
560 } else if (strcmp (path, "/routes/list") == 0) {
562 for (int n = 0; n < (int) session->nroutes(); ++n) {
564 boost::shared_ptr<Route> r = session->route_by_remote_id (n);
568 lo_message reply = lo_message_new ();
570 if (boost::dynamic_pointer_cast<AudioTrack>(r)) {
571 lo_message_add_string (reply, "AT");
572 } else if (boost::dynamic_pointer_cast<MidiTrack>(r)) {
573 lo_message_add_string (reply, "MT");
575 lo_message_add_string (reply, "B");
578 lo_message_add_string (reply, r->name().c_str());
579 lo_message_add_int32 (reply, r->n_inputs().n_audio());
580 lo_message_add_int32 (reply, r->n_outputs().n_audio());
581 lo_message_add_int32 (reply, r->muted());
582 lo_message_add_int32 (reply, r->soloed());
583 lo_message_add_int32 (reply, r->remote_control_id());
585 if (boost::dynamic_pointer_cast<AudioTrack>(r)
586 || boost::dynamic_pointer_cast<MidiTrack>(r)) {
588 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track>(r);
589 lo_message_add_int32 (reply, t->record_enabled());
592 lo_send_message (lo_message_get_source (msg), "#reply", reply);
593 lo_message_free (reply);
595 //Automatically listen to routes listed
596 listen_to_route(r, lo_message_get_source (msg));
600 // Send end of listing message
601 lo_message reply = lo_message_new ();
603 lo_message_add_string (reply, "end_route_list");
604 lo_message_add_int64 (reply, session->frame_rate());
605 lo_message_add_int64 (reply, session->current_end_frame());
607 lo_send_message (lo_message_get_source (msg), "#reply", reply);
609 lo_message_free (reply);
618 OSC::update_clock (){
623 OSC::listen_to_route (boost::shared_ptr<Route> route, lo_address addr)
625 Controllables::iterator x;
626 bool route_exists = false;
628 cerr << "listen to route\n";
630 /* avoid duplicate listens */
632 for (x = controllables.begin(); x != controllables.end(); ++x) {
634 OSCRouteControllable* rc;
636 if ((rc = dynamic_cast<OSCRouteControllable*>(*x)) != 0) {
638 if (rc->route() == route) {
641 /* XXX NEED lo_address_equal() */
642 int res = strcmp(lo_address_get_hostname(rc->address()), lo_address_get_hostname(addr));
645 cerr << "already listening to route" << endl;
652 cerr << "listener binding to signals\n";
657 if (boost::dynamic_pointer_cast<AudioTrack>(route) || boost::dynamic_pointer_cast<MidiTrack>(route)) {
659 boost::shared_ptr<Track> track = boost::dynamic_pointer_cast<Track>(route);
661 path = X_("/route/rec");
662 c = new OSCRouteControllable (addr, path, track->rec_enable_control(), track);
663 controllables.push_back (c);
666 path = X_("/route/solo");
667 c = new OSCRouteControllable (addr, path, route->solo_control(), route);
668 controllables.push_back (c);
670 path = X_("/route/mute");
671 c = new OSCRouteControllable (addr, path, route->mute_control(), route);
672 controllables.push_back (c);
674 path = X_("/route/gain");
675 c = new OSCRouteControllable (addr, path, route->gain_control(), route);
676 controllables.push_back (c);
678 cerr << "Now have " << controllables.size() << " controllables\n";
682 o = new OSCRouteObserver (addr, path, route);
683 observables.push_back (o);
685 /* if there is no existing controllable related to this route, make sure we clean up
686 if it is ever deleted.
690 route->DropReferences.connect (*this, MISSING_INVALIDATOR, boost::bind (&OSC::drop_route, this, boost::weak_ptr<Route> (route)), this);
695 OSC::drop_route (boost::weak_ptr<Route> wr)
697 boost::shared_ptr<Route> r = wr.lock ();
703 for (Controllables::iterator x = controllables.begin(); x != controllables.end();) {
705 OSCRouteControllable* rc;
707 if ((rc = dynamic_cast<OSCRouteControllable*>(*x)) != 0) {
708 if (rc->route() == r) {
710 x = controllables.erase (x);
721 OSC::end_listen (boost::shared_ptr<Route> r, lo_address addr)
723 Controllables::iterator x;
725 for (x = controllables.begin(); x != controllables.end();) {
727 OSCRouteControllable* rc;
729 if ((rc = dynamic_cast<OSCRouteControllable*>(*x)) != 0) {
731 /* XXX NEED lo_address_equal () */
732 if (rc->route() == r && (0 == strcmp(lo_address_get_hostname(rc->address()), lo_address_get_hostname(addr)))){
734 x = controllables.erase (x);
745 Observables::iterator z;
747 // Remove the route observers
748 for (z = observables.begin(); z != observables.end();) {
750 OSCRouteObserver* ro;
752 if ((ro = dynamic_cast<OSCRouteObserver*>(*z)) != 0) {
754 /* XXX NEED lo_address_equal () */
755 if (ro->route() == r){
757 z = observables.erase (z);
770 // "Application Hook" Handlers //
772 OSC::session_loaded( Session& s ) {
773 lo_address listener = lo_address_new( NULL, "7770" );
774 lo_send( listener, "/session/loaded", "ss", s.path().c_str(), s.name().c_str() );
778 OSC::session_exported( std::string path, std::string name ) {
779 lo_address listener = lo_address_new( NULL, "7770" );
780 lo_send( listener, "/session/exported", "ss", path.c_str(), name.c_str() );
783 // end "Application Hook" Handlers //
788 OSC::current_value (const char */*path*/, const char */*types*/, lo_arg **/*argv*/, int /*argc*/, void */*data*/, void* /*user_data*/)
793 if (argc < 3 || types == 0 || strlen (types) < 3 || types[0] != 's' || types[1] != 's' || types[2] != s) {
797 const char *returl = argv[1]->s;
798 lo_address addr = find_or_cache_addr (returl);
800 const char *retpath = argv[2]->s;
803 if (strcmp (argv[0]->s, "transport_frame") == 0) {
806 lo_send (addr, retpath, "i", session->transport_frame());
809 } else if (strcmp (argv[0]->s, "transport_speed") == 0) {
812 lo_send (addr, retpath, "i", session->transport_frame());
815 } else if (strcmp (argv[0]->s, "transport_locked") == 0) {
818 lo_send (addr, retpath, "i", session->transport_frame());
821 } else if (strcmp (argv[0]->s, "punch_in") == 0) {
824 lo_send (addr, retpath, "i", session->transport_frame());
827 } else if (strcmp (argv[0]->s, "punch_out") == 0) {
830 lo_send (addr, retpath, "i", session->transport_frame());
833 } else if (strcmp (argv[0]->s, "rec_enable") == 0) {
836 lo_send (addr, retpath, "i", session->transport_frame());
848 OSC::route_mute (int rid, int yn)
850 if (!session) return -1;
852 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
855 r->set_mute (yn, this);
861 OSC::route_solo (int rid, int yn)
863 if (!session) return -1;
865 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
868 r->set_solo (yn, this);
874 OSC::route_recenable (int rid, int yn)
876 if (!session) return -1;
878 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
881 r->set_record_enabled (yn, this);
887 OSC::route_set_gain_abs (int rid, float level)
889 if (!session) return -1;
891 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
894 r->set_gain (level, this);
901 OSC::route_set_gain_dB (int rid, float dB)
903 if (!session) return -1;
905 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
908 r->set_gain (dB_to_coefficient (dB), this);
915 OSC::route_set_pan_stereo_position (int rid, float pos)
917 if (!session) return -1;
919 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
922 boost::shared_ptr<Panner> panner = r->panner();
924 panner->set_stereo_position (pos);
933 OSC::route_set_pan_stereo_width (int rid, float pos)
935 if (!session) return -1;
937 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
940 boost::shared_ptr<Panner> panner = r->panner();
942 panner->set_stereo_width (pos);
951 OSC::route_plugin_parameter (int rid,int piid,int par, float val)
957 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
963 boost::shared_ptr<Processor> redi=r->nth_processor (piid);
969 boost::shared_ptr<PluginInsert> pi;
971 if (!(pi = boost::dynamic_pointer_cast<PluginInsert>(redi))) {
975 boost::shared_ptr<ARDOUR::Plugin> pip = pi->plugin();
978 uint32_t controlid = pip->nth_parameter (par,ok);
984 Plugin::ParameterDescriptor pd;
985 pi->plugin()->get_parameter_descriptor (controlid,pd);
987 if (val >= pd.lower && val < pd.upper) {
989 boost::shared_ptr<AutomationControl> c = pi->automation_control (Evoral::Parameter(PluginAutomation, 0, controlid));;
990 cerr << "parameter:" << redi->describe_parameter(controlid) << " val:" << val << "\n";
998 OSC::route_plugin_parameter_print (int rid,int piid,int par)
1004 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
1010 boost::shared_ptr<Processor> redi=r->nth_processor (piid);
1016 boost::shared_ptr<PluginInsert> pi;
1018 if (!(pi = boost::dynamic_pointer_cast<PluginInsert>(redi))) {
1021 boost::shared_ptr<ARDOUR::Plugin> pip=pi->plugin();
1024 uint32_t controlid = pip->nth_parameter (par,ok);
1030 Plugin::ParameterDescriptor pd;
1032 if (pi->plugin()->get_parameter_descriptor (controlid, pd) == 0) {
1033 boost::shared_ptr<AutomationControl> c = pi->automation_control (Evoral::Parameter(PluginAutomation, 0, controlid));
1035 cerr << "parameter: " << redi->describe_parameter(controlid) << "\n";
1036 cerr << "current value: " << c->get_value ();
1037 cerr << "lower value: " << pd.lower << "\n";
1038 cerr << "upper value: " << pd.upper << "\n";
1047 return *(new XMLNode ("OSC"));
1051 OSC::set_state (const XMLNode&, int /*version*/)