cleanup up cleanup at session destruction; clarify the meaning of 3 signals (DropRefe...
[ardour.git] / libs / surfaces / osc / osc.cc
1 /*
2  * Copyright (C) 2006 Paul Davis
3  *  
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.
8  *  
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.
13  *  
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.
17  *  
18  */
19
20 #include <iostream>
21 #include <fstream>
22 #include <cstdio>
23 #include <cstdlib>
24 #include <cerrno>
25 #include <algorithm>
26
27 #include <sys/poll.h>
28 #include <unistd.h>
29 #include <fcntl.h>
30
31 #include <glibmm/miscutils.h>
32 #include <boost/signals2.hpp>
33
34 #include <pbd/pthread_utils.h>
35 #include <pbd/file_utils.h>
36 #include <pbd/filesystem.h>
37 #include <pbd/failed_constructor.h>
38
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
46 #include "osc.h"
47 #include "osc_controllable.h"
48 #include "i18n.h"
49
50 using namespace ARDOUR;
51 using namespace std;
52 using namespace Glib;
53
54 #include "pbd/abstract_ui.cc" // instantiate template
55
56 #define ui_bind(f, ...) boost::protect (boost::bind (f, __VA_ARGS__))
57
58 OSC* OSC::_instance = 0;
59
60 #ifdef DEBUG
61 static void error_callback(int num, const char *m, const char *path)
62 {
63         fprintf(stderr, "liblo server error %d in path %s: %s\n", num, path, m);
64 }
65 #else
66 static void error_callback(int, const char *, const char *)
67 {
68
69 }
70 #endif
71
72 OSC::OSC (Session& s, uint32_t port)
73         : ControlProtocol (s, "OSC", this)
74         , AbstractUI<OSCUIRequest> ("osc")
75         , _port(port)
76 {
77         _instance = this;
78         _shutdown = false;
79         _osc_server = 0;
80         _osc_unix_server = 0;
81         _namespace_root = "/ardour";
82         _send_route_changes = true;
83
84         /* glibmm hack */
85         local_server = 0;
86         remote_server = 0;
87
88         // "Application Hooks"
89         session_loaded (s);
90         session->Exported.connect (*this, ui_bind (&OSC::session_exported, this, _1, _2), this);
91 }
92
93 OSC::~OSC()
94 {
95         stop ();
96         _instance = 0;
97 }
98
99 void
100 OSC::do_request (OSCUIRequest* req)
101 {
102         if (req->type == CallSlot) {
103
104                 call_slot (req->the_slot);
105
106         } else if (req->type == Quit) {
107
108                 stop ();
109         }
110 }
111
112 int
113 OSC::set_active (bool yn)
114 {
115         if (yn) {
116                 return start ();
117         } else {
118                 return stop ();
119         }
120 }
121
122 bool
123 OSC::get_active () const
124 {
125         return _osc_server != 0;
126 }
127
128 int 
129 OSC::set_feedback (bool yn)
130 {
131         _send_route_changes = yn;
132         return 0;
133 }
134
135 bool
136 OSC::get_feedback () const
137 {
138         return _send_route_changes;
139 }
140
141 int
142 OSC::start ()
143 {
144         char tmpstr[255];
145
146         if (_osc_server) {
147                 /* already started */
148                 return 0;
149         }
150         
151         for (int j=0; j < 20; ++j) {
152                 snprintf(tmpstr, sizeof(tmpstr), "%d", _port);
153                 
154                 if ((_osc_server = lo_server_new (tmpstr, error_callback))) {
155                         break;
156                 }
157 #ifdef DEBUG            
158                 cerr << "can't get osc at port: " << _port << endl;
159 #endif
160                 _port++;
161                 continue;
162         }
163         
164 #ifdef ARDOUR_OSC_UNIX_SERVER
165         
166         // APPEARS sluggish for now
167         
168         // attempt to create unix socket server too
169         
170         snprintf(tmpstr, sizeof(tmpstr), "/tmp/sooperlooper_XXXXXX");
171         int fd = mkstemp(tmpstr);
172         
173         if (fd >= 0 ) {
174                 unlink (tmpstr);
175                 close (fd);
176                 
177                 _osc_unix_server = lo_server_new (tmpstr, error_callback);
178                 
179                 if (_osc_unix_server) {
180                         _osc_unix_socket_path = tmpstr;
181                 }
182         }
183 #endif
184         
185         cerr << "OSC @ " << get_server_url () << endl;
186
187         PBD::sys::path url_file;
188
189         if (find_file_in_search_path (ardour_search_path() + system_config_search_path(),
190                                       "osc_url", url_file)) {
191                 _osc_url_file = url_file.to_string();
192                 ofstream urlfile;
193                 urlfile.open(_osc_url_file.c_str(), ios::trunc);
194                 if ( urlfile )
195                 {
196                         urlfile << get_server_url () << endl;
197                         urlfile.close();
198                 }
199                 else
200                 {  
201                         cerr << "Couldn't write '" <<  _osc_url_file << "'" <<endl;
202                 }
203         }
204         
205         register_callbacks();
206         
207         // lo_server_thread_add_method(_sthread, NULL, NULL, OSC::_dummy_handler, this);
208
209         /* startup the event loop thread */
210
211         BaseUI::run ();
212
213         return 0;
214 }
215
216 void
217 OSC::thread_init ()
218 {
219         if (_osc_unix_server) {
220                 Glib::RefPtr<IOSource> src = IOSource::create (lo_server_get_socket_fd (_osc_unix_server), IO_IN|IO_HUP|IO_ERR);
221                 src->connect (sigc::bind (sigc::mem_fun (*this, &OSC::osc_input_handler), _osc_unix_server));
222                 src->attach (_main_loop->get_context());
223                 local_server = src->gobj();
224                 g_source_ref (local_server);
225         }
226
227         if (_osc_server) {
228                 Glib::RefPtr<IOSource> src  = IOSource::create (lo_server_get_socket_fd (_osc_server), IO_IN|IO_HUP|IO_ERR);
229                 src->connect (sigc::bind (sigc::mem_fun (*this, &OSC::osc_input_handler), _osc_server));
230                 src->attach (_main_loop->get_context());
231                 remote_server = src->gobj();
232                 g_source_ref (remote_server);
233         }
234 }
235
236 int
237 OSC::stop ()
238 {       
239         /* stop main loop */
240
241         if (local_server) {
242                 g_source_destroy (local_server);
243                 g_source_unref (local_server);
244                 local_server = 0;
245         }
246
247         if (remote_server) {
248                 g_source_destroy (remote_server);
249                 g_source_unref (remote_server);
250                 remote_server = 0;
251         }
252
253         BaseUI::quit ();
254
255         if (_osc_server) {
256                 int fd = lo_server_get_socket_fd(_osc_server);
257                 if (fd >=0) {
258                         close(fd);
259                 }
260                 lo_server_free (_osc_server);
261                 _osc_server = 0;
262         }
263
264         if (_osc_unix_server) {
265                 int fd = lo_server_get_socket_fd(_osc_unix_server);
266                 if (fd >=0) {
267                         close(fd);
268                 }
269                 lo_server_free (_osc_unix_server);
270                 _osc_unix_server = 0;
271         }
272         
273         if (!_osc_unix_socket_path.empty()) {
274                 unlink (_osc_unix_socket_path.c_str());
275         }
276         
277         if (!_osc_url_file.empty() ) {
278                 unlink (_osc_url_file.c_str() );
279         }
280
281         return 0;
282 }
283
284 void
285 OSC::register_callbacks()
286 {
287         lo_server srvs[2];
288         lo_server serv;
289
290         srvs[0] = _osc_server;
291         srvs[1] = _osc_unix_server;
292         
293         for (size_t i = 0; i < 2; ++i) {
294
295                 if (!srvs[i]) {
296                         continue;
297                 }
298
299                 serv = srvs[i];
300                 
301                 /* this is a special catchall handler */
302                 
303                 lo_server_add_method (serv, 0, 0, _catchall, this);
304
305 #define REGISTER_CALLBACK(serv,path,types, function) lo_server_add_method (serv, path, types, OSC::_ ## function, this)
306                 
307                 REGISTER_CALLBACK (serv, "/ardour/add_marker", "", add_marker);
308                 REGISTER_CALLBACK (serv, "/ardour/access_action", "s", access_action);
309                 REGISTER_CALLBACK (serv, "/ardour/loop_toggle", "", loop_toggle);
310                 REGISTER_CALLBACK (serv, "/ardour/goto_start", "", goto_start);
311                 REGISTER_CALLBACK (serv, "/ardour/goto_end", "", goto_end);
312                 REGISTER_CALLBACK (serv, "/ardour/rewind", "", rewind);
313                 REGISTER_CALLBACK (serv, "/ardour/ffwd", "", ffwd);
314                 REGISTER_CALLBACK (serv, "/ardour/transport_stop", "", transport_stop);
315                 REGISTER_CALLBACK (serv, "/ardour/transport_play", "", transport_play);
316                 REGISTER_CALLBACK (serv, "/ardour/set_transport_speed", "f", set_transport_speed);
317                 REGISTER_CALLBACK (serv, "/ardour/save_state", "", save_state);
318                 REGISTER_CALLBACK (serv, "/ardour/prev_marker", "", prev_marker);
319                 REGISTER_CALLBACK (serv, "/ardour/next_marker", "", next_marker);
320                 REGISTER_CALLBACK (serv, "/ardour/undo", "", undo);
321                 REGISTER_CALLBACK (serv, "/ardour/redo", "", redo);
322                 REGISTER_CALLBACK (serv, "/ardour/toggle_punch_in", "", toggle_punch_in);
323                 REGISTER_CALLBACK (serv, "/ardour/toggle_punch_out", "", toggle_punch_out);
324                 REGISTER_CALLBACK (serv, "/ardour/rec_enable_toggle", "", rec_enable_toggle);
325                 REGISTER_CALLBACK (serv, "/ardour/toggle_all_rec_enables", "", toggle_all_rec_enables);
326
327                 REGISTER_CALLBACK (serv, "/ardour/routes/mute", "ii", route_mute);
328                 REGISTER_CALLBACK (serv, "/ardour/routes/solo", "ii", route_solo);
329                 REGISTER_CALLBACK (serv, "/ardour/routes/recenable", "ii", route_recenable);
330                 REGISTER_CALLBACK (serv, "/ardour/routes/gainabs", "if", route_set_gain_abs);
331                 REGISTER_CALLBACK (serv, "/ardour/routes/gaindB", "if", route_set_gain_dB);
332
333                 
334 #if 0
335                 /* still not-really-standardized query interface */
336                 REGISTER_CALLBACK (serv, "/ardour/*/#current_value", "", current_value);
337                 REGISTER_CALLBACK (serv, "/ardour/set", "", set);
338 #endif
339
340 #if 0
341                 // un/register_update args= s:ctrl s:returl s:retpath
342                 lo_server_add_method(serv, "/register_update", "sss", OSC::global_register_update_handler, this);
343                 lo_server_add_method(serv, "/unregister_update", "sss", OSC::global_unregister_update_handler, this);
344                 lo_server_add_method(serv, "/register_auto_update", "siss", OSC::global_register_auto_update_handler, this);
345                 lo_server_add_method(serv, "/unregister_auto_update", "sss", OSC::_global_unregister_auto_update_handler, this);
346 #endif
347         }
348 }
349
350 bool
351 OSC::osc_input_handler (IOCondition ioc, lo_server srv)
352 {
353         if (ioc & ~IO_IN) {
354                 return false;
355         }
356
357         if (ioc & IO_IN) {
358                 lo_server_recv (srv);
359         }
360
361         return true;
362 }
363
364 std::string
365 OSC::get_server_url()
366 {
367         string url;
368         char * urlstr;
369
370         if (_osc_server) {
371                 urlstr = lo_server_get_url (_osc_server);
372                 url = urlstr;
373                 free (urlstr);
374         }
375         
376         return url;
377 }
378
379 std::string
380 OSC::get_unix_server_url()
381 {
382         string url;
383         char * urlstr;
384
385         if (_osc_unix_server) {
386                 urlstr = lo_server_get_url (_osc_unix_server);
387                 url = urlstr;
388                 free (urlstr);
389         }
390         
391         return url;
392 }
393
394
395 void
396 OSC::current_value_query (const char* path, size_t len, lo_arg **argv, int argc, lo_message msg)
397 {
398         char* subpath;
399         
400         subpath = (char*) malloc (len-15+1);
401         memcpy (subpath, path, len-15);
402         subpath[len-15] = '\0';
403         
404         send_current_value (subpath, argv, argc, msg);
405         
406         free (subpath);
407 }
408
409 void
410 OSC::send_current_value (const char* path, lo_arg** argv, int argc, lo_message msg)
411 {
412         if (!session) {
413                 return;
414         }
415
416         lo_message reply = lo_message_new ();
417         boost::shared_ptr<Route> r;
418         int id;
419
420         lo_message_add_string (reply, path);
421         
422         if (argc == 0) {
423                 lo_message_add_string (reply, "bad syntax");
424         } else {
425                 id = argv[0]->i;
426                 r = session->route_by_remote_id (id);
427
428                 if (!r) {
429                         lo_message_add_string (reply, "not found");
430                 } else {
431
432                         if (strcmp (path, "/routes/state") == 0) {
433                                 
434                                 if (boost::dynamic_pointer_cast<AudioTrack>(r)) {
435                                         lo_message_add_string (reply, "AT");
436                                 } else if (boost::dynamic_pointer_cast<MidiTrack>(r)) {
437                                         lo_message_add_string (reply, "MT");
438                                 } else {
439                                         lo_message_add_string (reply, "B");
440                                 }
441                                 
442                                 lo_message_add_string (reply, r->name().c_str());
443                                 lo_message_add_int32 (reply, r->n_inputs().n_audio());
444                                 lo_message_add_int32 (reply, r->n_outputs().n_audio());
445                                 lo_message_add_int32 (reply, r->muted());
446                                 lo_message_add_int32 (reply, r->soloed());
447                                 
448                         } else if (strcmp (path, "/routes/mute") == 0) {
449                                 
450                                 lo_message_add_int32 (reply, (float) r->muted());
451                                 
452                         } else if (strcmp (path, "/routes/solo") == 0) {
453                                 
454                                 lo_message_add_int32 (reply, r->soloed());
455                         }
456                 }
457         }
458
459         lo_send_message (lo_message_get_source (msg), "#reply", reply);
460         lo_message_free (reply);
461 }
462         
463 int
464 OSC::_catchall (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) 
465 {
466         return ((OSC*)user_data)->catchall (path, types, argv, argc, data);
467 }
468
469 int
470 OSC::catchall (const char *path, const char *types, lo_arg **argv, int argc, lo_message msg) 
471 {
472         size_t len;
473         int ret = 1; /* unhandled */
474
475         cerr << "Received a message, path = " << path << " types = \"" 
476              << (types ? types : "NULL") << '"' << endl;
477
478         /* 15 for /#current_value plus 2 for /<path> */
479
480         len = strlen (path);
481
482         if (len >= 17 && !strcmp (&path[len-15], "/#current_value")) {
483                 current_value_query (path, len, argv, argc, msg);
484                 ret = 0;
485
486         } else if (strcmp (path, "/routes/listen") == 0) {
487                 
488                 cerr << "set up listener\n";
489
490                 lo_message reply = lo_message_new ();
491
492                 if (argc <= 0) {
493                         lo_message_add_string (reply, "syntax error");
494                 } else {
495                         for (int n = 0; n < argc; ++n) {
496
497                                 boost::shared_ptr<Route> r = session->route_by_remote_id (argv[n]->i);
498                                 
499                                 if (!r) {
500                                         lo_message_add_string (reply, "not found");
501                                         cerr << "no such route\n";
502                                         break;
503                                 } else {                        
504                                         cerr << "add listener\n";
505                                         listen_to_route (r, lo_message_get_source (msg));
506                                         lo_message_add_int32 (reply, argv[n]->i);
507                                 }
508                         }
509                 }
510
511                 lo_send_message (lo_message_get_source (msg), "#reply", reply);
512                 lo_message_free (reply);
513
514         } else if (strcmp (path, "/routes/ignore") == 0) {
515
516                 for (int n = 0; n < argc; ++n) {
517
518                         boost::shared_ptr<Route> r = session->route_by_remote_id (argv[n]->i);
519                         
520                         if (r) {
521                                 end_listen (r, lo_message_get_source (msg));
522                         }
523                 }
524         }
525
526         return ret;
527 }
528
529 void
530 OSC::listen_to_route (boost::shared_ptr<Route> route, lo_address addr)
531 {
532         Controllables::iterator x;
533         bool route_exists = false;
534
535         cerr << "listen to route\n";
536
537         /* avoid duplicate listens */
538         
539         for (x = controllables.begin(); x != controllables.end(); ++x) {
540                 
541                 OSCRouteControllable* rc;
542
543                 if ((rc = dynamic_cast<OSCRouteControllable*>(*x)) != 0) {
544                         
545                         if (rc->route() == route) {
546                                 route_exists = true;
547                                 
548                                 /* XXX NEED lo_address_equal() */
549                                 
550                                 if (rc->address() == addr) {
551                                         return;
552                                 }
553                         }
554                 }
555         }
556
557         cerr << "listener binding to signals\n";
558
559         OSCControllable* c;
560         string path;
561
562         path = X_("/route/solo");
563         c = new OSCRouteControllable (addr, path, route->solo_control(), route);
564         controllables.push_back (c);
565
566         path = X_("/route/mute");
567         c = new OSCRouteControllable (addr, path, route->mute_control(), route);
568         controllables.push_back (c);
569
570         path = X_("/route/gain");
571         c = new OSCRouteControllable (addr, path, route->gain_control(), route);
572         controllables.push_back (c);
573
574         cerr << "Now have " << controllables.size() << " controllables\n";
575
576         /* if there is no existing controllable related to this route, make sure we clean up
577            if it is ever deleted.
578         */
579         
580         if (!route_exists) {
581                 route->DropReferences.connect (*this, boost::bind (&OSC::drop_route, this, boost::weak_ptr<Route> (route)), this);
582         }
583 }
584
585 void
586 OSC::drop_route (boost::weak_ptr<Route> wr)
587 {
588         boost::shared_ptr<Route> r = wr.lock ();
589
590         if (!r) {
591                 return;
592         }
593
594         for (Controllables::iterator x = controllables.begin(); x != controllables.end();) {
595
596                 OSCRouteControllable* rc;
597                 
598                 if ((rc = dynamic_cast<OSCRouteControllable*>(*x)) != 0) {
599                         if (rc->route() == r) {
600                                 delete *x;
601                                 x = controllables.erase (x);
602                         } else {
603                                 ++x;
604                         }
605                 } else {
606                         ++x;
607                 }
608         }
609 }
610
611 void
612 OSC::end_listen (boost::shared_ptr<Route> r, lo_address addr)
613 {
614         Controllables::iterator x;
615
616         for (x = controllables.begin(); x != controllables.end(); ++x) {
617
618                 OSCRouteControllable* rc;
619                 
620                 if ((rc = dynamic_cast<OSCRouteControllable*>(*x)) != 0) {
621
622                         /* XXX NEED lo_address_equal () */
623
624                         if (rc->route() == r && rc->address() == addr) {
625                                 controllables.erase (x);
626                                 return;
627                         }
628                 }
629         }
630 }
631
632 // "Application Hook" Handlers //
633 void
634 OSC::session_loaded( Session& s ) {
635         lo_address listener = lo_address_new( NULL, "7770" );
636         lo_send( listener, "/session/loaded", "ss", s.path().c_str(), s.name().c_str() );
637 }
638
639 void
640 OSC::session_exported( std::string path, std::string name ) {
641         lo_address listener = lo_address_new( NULL, "7770" );
642         lo_send( listener, "/session/exported", "ss", path.c_str(), name.c_str() );
643 }
644
645 // end "Application Hook" Handlers //
646
647 /* path callbacks */
648
649 int 
650 OSC::current_value (const char */*path*/, const char */*types*/, lo_arg **/*argv*/, int /*argc*/, void */*data*/, void* /*user_data*/) 
651
652 #if 0
653         const char* returl;
654
655         if (argc < 3 || types == 0 || strlen (types) < 3 || types[0] != 's' || types[1] != 's' || types[2] != s) {
656                 return 1;
657         }
658
659         const char *returl = argv[1]->s;
660         lo_address addr = find_or_cache_addr (returl);
661
662         const char *retpath = argv[2]->s;
663
664         
665         if (strcmp (argv[0]->s, "transport_frame") == 0) {
666
667                 if (session) {
668                         lo_send (addr, retpath, "i", session->transport_frame());
669                 }
670
671         } else if (strcmp (argv[0]->s, "transport_speed") == 0) {
672                 
673                 if (session) {
674                         lo_send (addr, retpath, "i", session->transport_frame());
675                 }
676                 
677         } else if (strcmp (argv[0]->s, "transport_locked") == 0) {
678                 
679                 if (session) {
680                         lo_send (addr, retpath, "i", session->transport_frame());
681                 }
682                 
683         } else if (strcmp (argv[0]->s, "punch_in") == 0) {
684                 
685                 if (session) {
686                         lo_send (addr, retpath, "i", session->transport_frame());
687                 }
688                 
689         } else if (strcmp (argv[0]->s, "punch_out") == 0) {
690
691                 if (session) {
692                         lo_send (addr, retpath, "i", session->transport_frame());
693                 }
694                 
695         } else if (strcmp (argv[0]->s, "rec_enable") == 0) {
696                         
697                 if (session) {
698                         lo_send (addr, retpath, "i", session->transport_frame());
699                 }
700
701         } else {
702
703                 /* error */
704         }
705 #endif
706         return 0;
707 }
708
709 int
710 OSC::route_mute (int rid, int yn)
711 {
712         if (!session) return -1;
713
714         boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
715
716         if (r) {
717                 r->set_mute (yn, this);
718         }
719         return 0;
720 }
721
722 int
723 OSC::route_solo (int rid, int yn)
724 {
725         if (!session) return -1;
726
727         boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
728
729         if (r) {
730                 r->set_solo (yn, this);
731         }
732         return 0;
733 }
734
735 int
736 OSC::route_recenable (int rid, int yn)
737 {
738         if (!session) return -1;
739
740         boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
741
742         if (r) {
743                 r->set_record_enable (yn, this);
744         }
745         return 0;
746 }
747
748 int
749 OSC::route_set_gain_abs (int rid, float level)
750 {
751         if (!session) return -1;
752
753         boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
754
755         if (r) {
756                 r->set_gain (level, this);
757         }
758
759         return 0;
760 }
761
762 int
763 OSC::route_set_gain_dB (int rid, float dB)
764 {
765         if (!session) return -1;
766
767         boost::shared_ptr<Route> r = session->route_by_remote_id (rid);
768
769         if (r) {
770                 r->set_gain (dB_to_coefficient (dB), this);
771         }
772         
773         return 0;
774 }
775
776 XMLNode& 
777 OSC::get_state () 
778 {
779         return *(new XMLNode ("OSC"));
780 }
781                 
782 int 
783 OSC::set_state (const XMLNode&, int /*version*/)
784 {
785         return 0;
786 }