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/session.h"
38 #include "ardour/route.h"
39 #include "ardour/audio_track.h"
40 #include "ardour/midi_track.h"
41 #include "ardour/dB.h"
42 #include "ardour/filesystem_paths.h"
43 #include "ardour/panner.h"
44 #include "ardour/plugin.h"
47 #include "osc_controllable.h"
48 #include "osc_route_observer.h"
51 using namespace ARDOUR;
55 #include "pbd/abstract_ui.cc" // instantiate template
57 OSC* OSC::_instance = 0;
60 static void error_callback(int num, const char *m, const char *path)
62 fprintf(stderr, "liblo server error %d in path %s: %s\n", num, path, m);
65 static void error_callback(int, const char *, const char *)
71 OSC::OSC (Session& s, uint32_t port)
72 : ControlProtocol (s, "OSC")
73 , AbstractUI<OSCUIRequest> ("osc")
80 _namespace_root = "/ardour";
81 _send_route_changes = true;
87 // "Application Hooks"
89 session->Exported.connect (*this, MISSING_INVALIDATOR, boost::bind (&OSC::session_exported, this, _1, _2), this);
99 OSC::do_request (OSCUIRequest* req)
101 if (req->type == CallSlot) {
103 call_slot (MISSING_INVALIDATOR, req->the_slot);
105 } else if (req->type == Quit) {
112 OSC::set_active (bool yn)
122 OSC::get_active () const
124 return _osc_server != 0;
128 OSC::set_feedback (bool yn)
130 _send_route_changes = yn;
135 OSC::get_feedback () const
137 return _send_route_changes;
146 /* already started */
150 for (int j=0; j < 20; ++j) {
151 snprintf(tmpstr, sizeof(tmpstr), "%d", _port);
153 //if ((_osc_server = lo_server_new_with_proto (tmpstr, LO_TCP, error_callback))) {
157 if ((_osc_server = lo_server_new (tmpstr, error_callback))) {
162 cerr << "can't get osc at port: " << _port << endl;
168 #ifdef ARDOUR_OSC_UNIX_SERVER
170 // APPEARS sluggish for now
172 // attempt to create unix socket server too
174 snprintf(tmpstr, sizeof(tmpstr), "/tmp/sooperlooper_XXXXXX");
175 int fd = mkstemp(tmpstr);
181 _osc_unix_server = lo_server_new (tmpstr, error_callback);
183 if (_osc_unix_server) {
184 _osc_unix_socket_path = tmpstr;
189 PBD::info << "OSC @ " << get_server_url () << endmsg;
191 std::string url_file;
193 if (find_file_in_search_path (ardour_config_search_path(), "osc_url", url_file)) {
195 _osc_url_file = url_file;
197 urlfile.open(_osc_url_file.c_str(), ios::trunc);
200 urlfile << get_server_url () << endl;
203 cerr << "Couldn't write '" << _osc_url_file << "'" <<endl;
207 register_callbacks();
209 // lo_server_thread_add_method(_sthread, NULL, NULL, OSC::_dummy_handler, this);
211 /* startup the event loop thread */
221 pthread_set_name (X_("OSC"));
223 if (_osc_unix_server) {
224 Glib::RefPtr<IOSource> src = IOSource::create (lo_server_get_socket_fd (_osc_unix_server), IO_IN|IO_HUP|IO_ERR);
225 src->connect (sigc::bind (sigc::mem_fun (*this, &OSC::osc_input_handler), _osc_unix_server));
226 src->attach (_main_loop->get_context());
227 local_server = src->gobj();
228 g_source_ref (local_server);
232 Glib::RefPtr<IOSource> src = IOSource::create (lo_server_get_socket_fd (_osc_server), IO_IN|IO_HUP|IO_ERR);
233 src->connect (sigc::bind (sigc::mem_fun (*this, &OSC::osc_input_handler), _osc_server));
234 src->attach (_main_loop->get_context());
235 remote_server = src->gobj();
236 g_source_ref (remote_server);
239 PBD::notify_gui_about_thread_creation (X_("gui"), pthread_self(), X_("OSC"), 2048);
240 SessionEvent::create_per_thread_pool (X_("OSC"), 128);
249 g_source_destroy (local_server);
250 g_source_unref (local_server);
255 g_source_destroy (remote_server);
256 g_source_unref (remote_server);
263 int fd = lo_server_get_socket_fd(_osc_server);
267 lo_server_free (_osc_server);
271 if (_osc_unix_server) {
272 int fd = lo_server_get_socket_fd(_osc_unix_server);
276 lo_server_free (_osc_unix_server);
277 _osc_unix_server = 0;
280 if (!_osc_unix_socket_path.empty()) {
281 unlink (_osc_unix_socket_path.c_str());
284 if (!_osc_url_file.empty() ) {
285 unlink (_osc_url_file.c_str() );
288 // Delete any active route observers
289 for (RouteObservers::iterator x = route_observers.begin(); x != route_observers.end();) {
291 OSCRouteObserver* rc;
293 if ((rc = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
295 x = route_observers.erase (x);
305 OSC::register_callbacks()
310 srvs[0] = _osc_server;
311 srvs[1] = _osc_unix_server;
313 for (size_t i = 0; i < 2; ++i) {
321 /* this is a special catchall handler */
323 lo_server_add_method (serv, 0, 0, _catchall, this);
325 #define REGISTER_CALLBACK(serv,path,types, function) lo_server_add_method (serv, path, types, OSC::_ ## function, this)
327 REGISTER_CALLBACK (serv, "/routes/list", "", routes_list);
328 REGISTER_CALLBACK (serv, "/ardour/add_marker", "", add_marker);
329 REGISTER_CALLBACK (serv, "/ardour/access_action", "s", access_action);
330 REGISTER_CALLBACK (serv, "/ardour/loop_toggle", "", loop_toggle);
331 REGISTER_CALLBACK (serv, "/ardour/goto_start", "", goto_start);
332 REGISTER_CALLBACK (serv, "/ardour/goto_end", "", goto_end);
333 REGISTER_CALLBACK (serv, "/ardour/rewind", "", rewind);
334 REGISTER_CALLBACK (serv, "/ardour/ffwd", "", ffwd);
335 REGISTER_CALLBACK (serv, "/ardour/transport_stop", "", transport_stop);
336 REGISTER_CALLBACK (serv, "/ardour/transport_play", "", transport_play);
337 REGISTER_CALLBACK (serv, "/ardour/transport_frame", "", transport_frame);
338 REGISTER_CALLBACK (serv, "/ardour/set_transport_speed", "f", set_transport_speed);
339 REGISTER_CALLBACK (serv, "/ardour/locate", "ii", locate);
340 REGISTER_CALLBACK (serv, "/ardour/save_state", "", save_state);
341 REGISTER_CALLBACK (serv, "/ardour/prev_marker", "", prev_marker);
342 REGISTER_CALLBACK (serv, "/ardour/next_marker", "", next_marker);
343 REGISTER_CALLBACK (serv, "/ardour/undo", "", undo);
344 REGISTER_CALLBACK (serv, "/ardour/redo", "", redo);
345 REGISTER_CALLBACK (serv, "/ardour/toggle_punch_in", "", toggle_punch_in);
346 REGISTER_CALLBACK (serv, "/ardour/toggle_punch_out", "", toggle_punch_out);
347 REGISTER_CALLBACK (serv, "/ardour/rec_enable_toggle", "", rec_enable_toggle);
348 REGISTER_CALLBACK (serv, "/ardour/toggle_all_rec_enables", "", toggle_all_rec_enables);
350 REGISTER_CALLBACK (serv, "/ardour/routes/mute", "ii", route_mute);
351 REGISTER_CALLBACK (serv, "/ardour/routes/solo", "ii", route_solo);
352 REGISTER_CALLBACK (serv, "/ardour/routes/recenable", "ii", route_recenable);
353 REGISTER_CALLBACK (serv, "/ardour/routes/gainabs", "if", route_set_gain_abs);
354 REGISTER_CALLBACK (serv, "/ardour/routes/gaindB", "if", route_set_gain_dB);
355 REGISTER_CALLBACK (serv, "/ardour/routes/pan_stereo_position", "if", route_set_pan_stereo_position);
356 REGISTER_CALLBACK (serv, "/ardour/routes/pan_stereo_width", "if", route_set_pan_stereo_width);
357 REGISTER_CALLBACK (serv, "/ardour/routes/plugin/parameter", "iiif", route_plugin_parameter);
358 REGISTER_CALLBACK (serv, "/ardour/routes/plugin/parameter/print", "iii", route_plugin_parameter_print);
362 /* still not-really-standardized query interface */
363 //REGISTER_CALLBACK (serv, "/ardour/*/#current_value", "", current_value);
364 //REGISTER_CALLBACK (serv, "/ardour/set", "", set);
366 // un/register_update args= s:ctrl s:returl s:retpath
367 //lo_server_add_method(serv, "/register_update", "sss", OSC::global_register_update_handler, this);
368 //lo_server_add_method(serv, "/unregister_update", "sss", OSC::global_unregister_update_handler, this);
369 //lo_server_add_method(serv, "/register_auto_update", "siss", OSC::global_register_auto_update_handler, this);
370 //lo_server_add_method(serv, "/unregister_auto_update", "sss", OSC::_global_unregister_auto_update_handler, this);
376 OSC::osc_input_handler (IOCondition ioc, lo_server srv)
383 lo_server_recv (srv);
390 OSC::get_server_url()
396 urlstr = lo_server_get_url (_osc_server);
405 OSC::get_unix_server_url()
410 if (_osc_unix_server) {
411 urlstr = lo_server_get_url (_osc_unix_server);
420 OSC::listen_to_route (boost::shared_ptr<Route> route, lo_address addr)
422 /* avoid duplicate listens */
424 for (RouteObservers::iterator x = route_observers.begin(); x != route_observers.end(); ++x) {
426 OSCRouteObserver* ro;
428 if ((ro = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
430 int res = strcmp(lo_address_get_hostname(ro->address()), lo_address_get_hostname(addr));
432 if (ro->route() == route && res == 0) {
438 OSCRouteObserver* o = new OSCRouteObserver (route, addr);
439 route_observers.push_back (o);
441 route->DropReferences.connect (*this, MISSING_INVALIDATOR, boost::bind (&OSC::drop_route, this, boost::weak_ptr<Route> (route)), this);
445 OSC::drop_route (boost::weak_ptr<Route> wr)
447 boost::shared_ptr<Route> r = wr.lock ();
453 for (RouteObservers::iterator x = route_observers.begin(); x != route_observers.end();) {
455 OSCRouteObserver* rc;
457 if ((rc = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
459 if (rc->route() == r) {
461 x = route_observers.erase (x);
472 OSC::end_listen (boost::shared_ptr<Route> r, lo_address addr)
474 RouteObservers::iterator x;
476 // Remove the route observers
477 for (x = route_observers.begin(); x != route_observers.end();) {
479 OSCRouteObserver* ro;
481 if ((ro = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
483 int res = strcmp(lo_address_get_hostname(ro->address()), lo_address_get_hostname(addr));
485 if (ro->route() == r && res == 0) {
487 x = route_observers.erase (x);
500 OSC::current_value_query (const char* path, size_t len, lo_arg **argv, int argc, lo_message msg)
504 subpath = (char*) malloc (len-15+1);
505 memcpy (subpath, path, len-15);
506 subpath[len-15] = '\0';
508 send_current_value (subpath, argv, argc, msg);
514 OSC::send_current_value (const char* path, lo_arg** argv, int argc, lo_message msg)
520 lo_message reply = lo_message_new ();
521 boost::shared_ptr<Route> r;
524 lo_message_add_string (reply, path);
527 lo_message_add_string (reply, "bad syntax");
530 r = session->route_by_remote_id (id);
533 lo_message_add_string (reply, "not found");
536 if (strcmp (path, "/routes/state") == 0) {
538 if (boost::dynamic_pointer_cast<AudioTrack>(r)) {
539 lo_message_add_string (reply, "AT");
540 } else if (boost::dynamic_pointer_cast<MidiTrack>(r)) {
541 lo_message_add_string (reply, "MT");
543 lo_message_add_string (reply, "B");
546 lo_message_add_string (reply, r->name().c_str());
547 lo_message_add_int32 (reply, r->n_inputs().n_audio());
548 lo_message_add_int32 (reply, r->n_outputs().n_audio());
549 lo_message_add_int32 (reply, r->muted());
550 lo_message_add_int32 (reply, r->soloed());
552 } else if (strcmp (path, "/routes/mute") == 0) {
554 lo_message_add_int32 (reply, (float) r->muted());
556 } else if (strcmp (path, "/routes/solo") == 0) {
558 lo_message_add_int32 (reply, r->soloed());
563 lo_send_message (lo_message_get_source (msg), "#reply", reply);
564 lo_message_free (reply);
568 OSC::_catchall (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data)
570 return ((OSC*)user_data)->catchall (path, types, argv, argc, data);
574 OSC::catchall (const char *path, const char* /*types*/, lo_arg **argv, int argc, lo_message msg)
577 int ret = 1; /* unhandled */
579 //cerr << "Received a message, path = " << path << " types = \""
580 // << (types ? types : "NULL") << '"' << endl;
582 /* 15 for /#current_value plus 2 for /<path> */
586 if (len >= 17 && !strcmp (&path[len-15], "/#current_value")) {
587 current_value_query (path, len, argv, argc, msg);
590 } else if (strcmp (path, "/routes/listen") == 0) {
592 cerr << "set up listener\n";
594 lo_message reply = lo_message_new ();
597 lo_message_add_string (reply, "syntax error");
599 for (int n = 0; n < argc; ++n) {
601 boost::shared_ptr<Route> r = session->route_by_remote_id (argv[n]->i);
604 lo_message_add_string (reply, "not found");
605 cerr << "no such route\n";
608 cerr << "add listener\n";
609 listen_to_route (r, lo_message_get_source (msg));
610 lo_message_add_int32 (reply, argv[n]->i);
615 lo_send_message (lo_message_get_source (msg), "#reply", reply);
616 lo_message_free (reply);
620 } else if (strcmp (path, "/routes/ignore") == 0) {
622 for (int n = 0; n < argc; ++n) {
624 boost::shared_ptr<Route> r = session->route_by_remote_id (argv[n]->i);
627 end_listen (r, lo_message_get_source (msg));
643 // "Application Hook" Handlers //
645 OSC::session_loaded (Session& s)
647 lo_address listener = lo_address_new (NULL, "7770");
648 lo_send (listener, "/session/loaded", "ss", s.path().c_str(), s.name().c_str());
652 OSC::session_exported (std::string path, std::string name)
654 lo_address listener = lo_address_new (NULL, "7770");
655 lo_send (listener, "/session/exported", "ss", path.c_str(), name.c_str());
658 // end "Application Hook" Handlers //
663 OSC::current_value (const char */*path*/, const char */*types*/, lo_arg **/*argv*/, int /*argc*/, void */*data*/, void* /*user_data*/)
668 if (argc < 3 || types == 0 || strlen (types) < 3 || types[0] != 's' || types[1] != 's' || types[2] != s) {
672 const char *returl = argv[1]->s;
673 lo_address addr = find_or_cache_addr (returl);
675 const char *retpath = argv[2]->s;
678 if (strcmp (argv[0]->s, "transport_frame") == 0) {
681 lo_send (addr, retpath, "i", session->transport_frame());
684 } else if (strcmp (argv[0]->s, "transport_speed") == 0) {
687 lo_send (addr, retpath, "i", session->transport_frame());
690 } else if (strcmp (argv[0]->s, "transport_locked") == 0) {
693 lo_send (addr, retpath, "i", session->transport_frame());
696 } else if (strcmp (argv[0]->s, "punch_in") == 0) {
699 lo_send (addr, retpath, "i", session->transport_frame());
702 } else if (strcmp (argv[0]->s, "punch_out") == 0) {
705 lo_send (addr, retpath, "i", session->transport_frame());
708 } else if (strcmp (argv[0]->s, "rec_enable") == 0) {
711 lo_send (addr, retpath, "i", session->transport_frame());
723 OSC::routes_list (lo_message msg)
725 for (int n = 0; n < (int) session->nroutes(); ++n) {
727 boost::shared_ptr<Route> r = session->route_by_remote_id (n);
731 lo_message reply = lo_message_new ();
733 if (boost::dynamic_pointer_cast<AudioTrack>(r)) {
734 lo_message_add_string (reply, "AT");
735 } else if (boost::dynamic_pointer_cast<MidiTrack>(r)) {
736 lo_message_add_string (reply, "MT");
738 lo_message_add_string (reply, "B");
741 lo_message_add_string (reply, r->name().c_str());
742 lo_message_add_int32 (reply, r->n_inputs().n_audio());
743 lo_message_add_int32 (reply, r->n_outputs().n_audio());
744 lo_message_add_int32 (reply, r->muted());
745 lo_message_add_int32 (reply, r->soloed());
746 lo_message_add_int32 (reply, r->remote_control_id());
748 if (boost::dynamic_pointer_cast<AudioTrack>(r)
749 || boost::dynamic_pointer_cast<MidiTrack>(r)) {
751 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track>(r);
752 lo_message_add_int32 (reply, t->record_enabled());
755 //Automatically listen to routes listed
756 listen_to_route(r, lo_message_get_source (msg));
758 lo_send_message (lo_message_get_source (msg), "#reply", reply);
759 lo_message_free (reply);
763 // Send end of listing message
764 lo_message reply = lo_message_new ();
766 lo_message_add_string (reply, "end_route_list");
767 lo_message_add_int64 (reply, session->frame_rate());
768 lo_message_add_int64 (reply, session->current_end_frame());
770 lo_send_message (lo_message_get_source (msg), "#reply", reply);
772 lo_message_free (reply);
776 OSC::transport_frame (lo_message msg)
778 framepos_t pos = session->transport_frame ();
780 lo_message reply = lo_message_new ();
781 lo_message_add_int64 (reply, pos);
783 lo_send_message (lo_message_get_source (msg), "/ardour/transport_frame", reply);
785 lo_message_free (reply);
789 OSC::route_mute (int rid, int yn)
791 if (!session) return -1;
793 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
796 r->set_mute (yn, this);
803 OSC::route_solo (int rid, int yn)
805 if (!session) return -1;
807 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
810 r->set_solo (yn, this);
817 OSC::route_recenable (int rid, int yn)
819 if (!session) return -1;
821 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
824 r->set_record_enabled (yn, this);
831 OSC::route_set_gain_abs (int rid, float level)
833 if (!session) return -1;
835 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
838 r->set_gain (level, this);
845 OSC::route_set_gain_dB (int rid, float dB)
847 if (!session) return -1;
849 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
852 r->set_gain (dB_to_coefficient (dB), this);
859 OSC::route_set_pan_stereo_position (int rid, float pos)
861 if (!session) return -1;
863 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
866 boost::shared_ptr<Panner> panner = r->panner();
868 panner->set_position (pos);
877 OSC::route_set_pan_stereo_width (int rid, float pos)
879 if (!session) return -1;
881 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
884 boost::shared_ptr<Panner> panner = r->panner();
886 panner->set_width (pos);
895 OSC::route_plugin_parameter (int rid, int piid, int par, float val)
901 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
907 boost::shared_ptr<Processor> redi=r->nth_processor (piid);
913 boost::shared_ptr<PluginInsert> pi;
915 if (!(pi = boost::dynamic_pointer_cast<PluginInsert>(redi))) {
919 boost::shared_ptr<ARDOUR::Plugin> pip = pi->plugin();
922 uint32_t controlid = pip->nth_parameter (par,ok);
928 Plugin::ParameterDescriptor pd;
929 pi->plugin()->get_parameter_descriptor (controlid,pd);
931 if (val >= pd.lower && val < pd.upper) {
933 boost::shared_ptr<AutomationControl> c = pi->automation_control (Evoral::Parameter(PluginAutomation, 0, controlid));;
934 cerr << "parameter:" << redi->describe_parameter(controlid) << " val:" << val << "\n";
942 OSC::route_plugin_parameter_print (int rid, int piid, int par)
948 boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
954 boost::shared_ptr<Processor> redi=r->nth_processor (piid);
960 boost::shared_ptr<PluginInsert> pi;
962 if (!(pi = boost::dynamic_pointer_cast<PluginInsert>(redi))) {
966 boost::shared_ptr<ARDOUR::Plugin> pip = pi->plugin();
969 uint32_t controlid = pip->nth_parameter (par,ok);
975 Plugin::ParameterDescriptor pd;
977 if (pi->plugin()->get_parameter_descriptor (controlid, pd) == 0) {
978 boost::shared_ptr<AutomationControl> c = pi->automation_control (Evoral::Parameter(PluginAutomation, 0, controlid));
980 cerr << "parameter: " << redi->describe_parameter(controlid) << "\n";
981 cerr << "current value: " << c->get_value ();
982 cerr << "lower value: " << pd.lower << "\n";
983 cerr << "upper value: " << pd.upper << "\n";
992 return *(new XMLNode ("OSC"));
996 OSC::set_state (const XMLNode&, int /*version*/)