34dbb7006e68e325d70c8ee4ba48a3df0af5a6eb
[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 <cstdio>
21 #include <cstdlib>
22 #include <cerrno>
23 #include <algorithm>
24
25 #include <unistd.h>
26 #include <fcntl.h>
27
28 #include "pbd/gstdio_compat.h"
29 #include <glibmm.h>
30
31 #include <pbd/convert.h>
32 #include <pbd/pthread_utils.h>
33 #include <pbd/file_utils.h>
34 #include <pbd/failed_constructor.h>
35
36 #include "ardour/amp.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/monitor_control.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/plugin_insert.h"
47 #include "ardour/presentation_info.h"
48 #include "ardour/send.h"
49 #include "ardour/phase_control.h"
50 #include "ardour/solo_isolate_control.h"
51 #include "ardour/solo_safe_control.h"
52 #include "ardour/vca_manager.h"
53
54 #include "osc_select_observer.h"
55 #include "osc.h"
56 #include "osc_controllable.h"
57 #include "osc_route_observer.h"
58 #include "osc_global_observer.h"
59 #include "i18n.h"
60
61 using namespace ARDOUR;
62 using namespace std;
63 using namespace Glib;
64 using namespace ArdourSurface;
65
66 #include "pbd/abstract_ui.cc" // instantiate template
67
68 OSC* OSC::_instance = 0;
69
70 #ifdef DEBUG
71 static void error_callback(int num, const char *m, const char *path)
72 {
73         fprintf(stderr, "liblo server error %d in path %s: %s\n", num, path, m);
74 }
75 #else
76 static void error_callback(int, const char *, const char *)
77 {
78
79 }
80 #endif
81
82 OSC::OSC (Session& s, uint32_t port)
83         : ControlProtocol (s, X_("Open Sound Control (OSC)"))
84         , AbstractUI<OSCUIRequest> (name())
85         , local_server (0)
86         , remote_server (0)
87         , _port(port)
88         , _ok (true)
89         , _shutdown (false)
90         , _osc_server (0)
91         , _osc_unix_server (0)
92         , _send_route_changes (true)
93         , _debugmode (Off)
94         , tick (true)
95         , bank_dirty (false)
96         , gui (0)
97 {
98         _instance = this;
99
100         session->Exported.connect (*this, MISSING_INVALIDATOR, boost::bind (&OSC::session_exported, this, _1, _2), this);
101 }
102
103 OSC::~OSC()
104 {
105         stop ();
106         _instance = 0;
107 }
108
109 void*
110 OSC::request_factory (uint32_t num_requests)
111 {
112         /* AbstractUI<T>::request_buffer_factory() is a template method only
113            instantiated in this source module. To provide something visible for
114            use in the interface/descriptor, we have this static method that is
115            template-free.
116         */
117         return request_buffer_factory (num_requests);
118 }
119
120 void
121 OSC::do_request (OSCUIRequest* req)
122 {
123         if (req->type == CallSlot) {
124
125                 call_slot (MISSING_INVALIDATOR, req->the_slot);
126
127         } else if (req->type == Quit) {
128
129                 stop ();
130         }
131 }
132
133 int
134 OSC::set_active (bool yn)
135 {
136         if (yn != active()) {
137
138                 if (yn) {
139                         if (start ()) {
140                                 return -1;
141                         }
142                 } else {
143                         if (stop ()) {
144                                 return -1;
145                         }
146                 }
147
148         }
149
150         return ControlProtocol::set_active (yn);
151 }
152
153 bool
154 OSC::get_active () const
155 {
156         return _osc_server != 0;
157 }
158
159 int
160 OSC::set_feedback (bool yn)
161 {
162         _send_route_changes = yn;
163         return 0;
164 }
165
166 bool
167 OSC::get_feedback () const
168 {
169         return _send_route_changes;
170 }
171
172 int
173 OSC::start ()
174 {
175         char tmpstr[255];
176
177         if (_osc_server) {
178                 /* already started */
179                 return 0;
180         }
181
182         for (int j=0; j < 20; ++j) {
183                 snprintf(tmpstr, sizeof(tmpstr), "%d", _port);
184
185                 //if ((_osc_server = lo_server_new_with_proto (tmpstr, LO_TCP, error_callback))) {
186                 //      break;
187                 //}
188
189                 if ((_osc_server = lo_server_new (tmpstr, error_callback))) {
190                         break;
191                 }
192
193 #ifdef DEBUG
194                 cerr << "can't get osc at port: " << _port << endl;
195 #endif
196                 _port++;
197                 continue;
198         }
199
200         if (!_osc_server) {
201                 return 1;
202         }
203
204 #ifdef ARDOUR_OSC_UNIX_SERVER
205
206         // APPEARS sluggish for now
207
208         // attempt to create unix socket server too
209
210         snprintf(tmpstr, sizeof(tmpstr), "/tmp/sooperlooper_XXXXXX");
211         int fd = mkstemp(tmpstr);
212
213         if (fd >= 0 ) {
214                 ::g_unlink (tmpstr);
215                 close (fd);
216
217                 _osc_unix_server = lo_server_new (tmpstr, error_callback);
218
219                 if (_osc_unix_server) {
220                         _osc_unix_socket_path = tmpstr;
221                 }
222         }
223 #endif
224
225         PBD::info << "OSC @ " << get_server_url () << endmsg;
226
227         std::string url_file;
228
229         if (find_file (ardour_config_search_path(), "osc_url", url_file)) {
230                 _osc_url_file = url_file;
231                 if (g_file_set_contents (_osc_url_file.c_str(), get_server_url().c_str(), -1, NULL)) {
232                         cerr << "Couldn't write '" <<  _osc_url_file << "'" <<endl;
233                 }
234         }
235
236         register_callbacks();
237
238         session_loaded (*session);
239
240         // lo_server_thread_add_method(_sthread, NULL, NULL, OSC::_dummy_handler, this);
241
242         /* startup the event loop thread */
243
244         BaseUI::run ();
245
246         // start timers for metering, timecode and heartbeat.
247         // timecode and metering run at 100
248         Glib::RefPtr<Glib::TimeoutSource> periodic_timeout = Glib::TimeoutSource::create (100); // milliseconds
249         periodic_connection = periodic_timeout->connect (sigc::mem_fun (*this, &OSC::periodic));
250         periodic_timeout->attach (main_loop()->get_context());
251
252         // catch GUI select changes for GUI_select mode
253         StripableSelectionChanged.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&OSC::gui_selection_changed, this, _1), this);
254
255         // catch track reordering
256         // receive routes added
257         session->RouteAdded.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&OSC::notify_routes_added, this, _1), this);
258         // receive VCAs added
259         session->vca_manager().VCAAdded.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&OSC::notify_vca_added, this, _1), this);
260         // order changed
261         PresentationInfo::Change.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&OSC::recalcbanks, this), this);
262
263
264         return 0;
265 }
266
267 void
268 OSC::thread_init ()
269 {
270         pthread_set_name (event_loop_name().c_str());
271
272         if (_osc_unix_server) {
273                 Glib::RefPtr<IOSource> src = IOSource::create (lo_server_get_socket_fd (_osc_unix_server), IO_IN|IO_HUP|IO_ERR);
274                 src->connect (sigc::bind (sigc::mem_fun (*this, &OSC::osc_input_handler), _osc_unix_server));
275                 src->attach (_main_loop->get_context());
276                 local_server = src->gobj();
277                 g_source_ref (local_server);
278         }
279
280         if (_osc_server) {
281 #ifdef PLATFORM_WINDOWS
282                 Glib::RefPtr<IOChannel> chan = Glib::IOChannel::create_from_win32_socket (lo_server_get_socket_fd (_osc_server));
283                 Glib::RefPtr<IOSource> src  = IOSource::create (chan, IO_IN|IO_HUP|IO_ERR);
284 #else
285                 Glib::RefPtr<IOSource> src  = IOSource::create (lo_server_get_socket_fd (_osc_server), IO_IN|IO_HUP|IO_ERR);
286 #endif
287                 src->connect (sigc::bind (sigc::mem_fun (*this, &OSC::osc_input_handler), _osc_server));
288                 src->attach (_main_loop->get_context());
289                 remote_server = src->gobj();
290                 g_source_ref (remote_server);
291         }
292
293         PBD::notify_event_loops_about_thread_creation (pthread_self(), event_loop_name(), 2048);
294         SessionEvent::create_per_thread_pool (event_loop_name(), 128);
295 }
296
297 int
298 OSC::stop ()
299 {
300         /* stop main loop */
301
302         if (local_server) {
303                 g_source_destroy (local_server);
304                 g_source_unref (local_server);
305                 local_server = 0;
306         }
307
308         if (remote_server) {
309                 g_source_destroy (remote_server);
310                 g_source_unref (remote_server);
311                 remote_server = 0;
312         }
313
314         BaseUI::quit ();
315
316         if (_osc_server) {
317                 lo_server_free (_osc_server);
318                 _osc_server = 0;
319         }
320
321         if (_osc_unix_server) {
322                 lo_server_free (_osc_unix_server);
323                 _osc_unix_server = 0;
324         }
325
326         if (!_osc_unix_socket_path.empty()) {
327                 ::g_unlink (_osc_unix_socket_path.c_str());
328         }
329
330         if (!_osc_url_file.empty() ) {
331                 ::g_unlink (_osc_url_file.c_str() );
332         }
333
334         periodic_connection.disconnect ();
335         session_connections.drop_connections ();
336         // Delete any active route observers
337         for (RouteObservers::iterator x = route_observers.begin(); x != route_observers.end();) {
338
339                 OSCRouteObserver* rc;
340
341                 if ((rc = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
342                         delete *x;
343                         x = route_observers.erase (x);
344                 } else {
345                         ++x;
346                 }
347         }
348 // Should maybe do global_observers too
349         for (GlobalObservers::iterator x = global_observers.begin(); x != global_observers.end();) {
350
351                 OSCGlobalObserver* gc;
352
353                 if ((gc = dynamic_cast<OSCGlobalObserver*>(*x)) != 0) {
354                         delete *x;
355                         x = global_observers.erase (x);
356                 } else {
357                         ++x;
358                 }
359         }
360 // delete select observers
361         for (uint32_t it = 0; it < _surface.size(); ++it) {
362                 OSCSurface* sur = &_surface[it];
363                 OSCSelectObserver* so;
364                 if ((so = dynamic_cast<OSCSelectObserver*>(sur->sel_obs)) != 0) {
365                         delete so;
366                 }
367         }
368
369         return 0;
370 }
371
372 void
373 OSC::register_callbacks()
374 {
375         lo_server srvs[2];
376         lo_server serv;
377
378         srvs[0] = _osc_server;
379         srvs[1] = _osc_unix_server;
380
381         for (size_t i = 0; i < 2; ++i) {
382
383                 if (!srvs[i]) {
384                         continue;
385                 }
386
387                 serv = srvs[i];
388
389
390 #define REGISTER_CALLBACK(serv,path,types, function) lo_server_add_method (serv, path, types, OSC::_ ## function, this)
391
392                 // Some controls have optional "f" for feedback or touchosc
393                 // http://hexler.net/docs/touchosc-controls-reference
394
395                 REGISTER_CALLBACK (serv, "/set_surface", "iiii", set_surface);
396                 REGISTER_CALLBACK (serv, "/set_surface/feedback", "i", set_surface_feedback);
397                 REGISTER_CALLBACK (serv, "/set_surface/bank_size", "i", set_surface_bank_size);
398                 REGISTER_CALLBACK (serv, "/set_surface/gainmode", "i", set_surface_gainmode);
399                 REGISTER_CALLBACK (serv, "/set_surface/strip_types", "i", set_surface_strip_types);
400                 REGISTER_CALLBACK (serv, "/strip/list", "", routes_list);
401                 REGISTER_CALLBACK (serv, "/add_marker", "", add_marker);
402                 REGISTER_CALLBACK (serv, "/add_marker", "f", add_marker);
403                 REGISTER_CALLBACK (serv, "/access_action", "s", access_action);
404                 REGISTER_CALLBACK (serv, "/loop_toggle", "", loop_toggle);
405                 REGISTER_CALLBACK (serv, "/loop_toggle", "f", loop_toggle);
406                 REGISTER_CALLBACK (serv, "/loop_location", "ii", loop_location);
407                 REGISTER_CALLBACK (serv, "/goto_start", "", goto_start);
408                 REGISTER_CALLBACK (serv, "/goto_start", "f", goto_start);
409                 REGISTER_CALLBACK (serv, "/goto_end", "", goto_end);
410                 REGISTER_CALLBACK (serv, "/goto_end", "f", goto_end);
411                 REGISTER_CALLBACK (serv, "/rewind", "", rewind);
412                 REGISTER_CALLBACK (serv, "/rewind", "f", rewind);
413                 REGISTER_CALLBACK (serv, "/ffwd", "", ffwd);
414                 REGISTER_CALLBACK (serv, "/ffwd", "f", ffwd);
415                 REGISTER_CALLBACK (serv, "/transport_stop", "", transport_stop);
416                 REGISTER_CALLBACK (serv, "/transport_stop", "f", transport_stop);
417                 REGISTER_CALLBACK (serv, "/transport_play", "", transport_play);
418                 REGISTER_CALLBACK (serv, "/transport_play", "f", transport_play);
419                 REGISTER_CALLBACK (serv, "/transport_frame", "", transport_frame);
420                 REGISTER_CALLBACK (serv, "/transport_speed", "", transport_speed);
421                 REGISTER_CALLBACK (serv, "/record_enabled", "", record_enabled);
422                 REGISTER_CALLBACK (serv, "/set_transport_speed", "f", set_transport_speed);
423                 // locate ii is position and bool roll
424                 REGISTER_CALLBACK (serv, "/locate", "ii", locate);
425                 REGISTER_CALLBACK (serv, "/save_state", "", save_state);
426                 REGISTER_CALLBACK (serv, "/save_state", "f", save_state);
427                 REGISTER_CALLBACK (serv, "/prev_marker", "", prev_marker);
428                 REGISTER_CALLBACK (serv, "/prev_marker", "f", prev_marker);
429                 REGISTER_CALLBACK (serv, "/next_marker", "", next_marker);
430                 REGISTER_CALLBACK (serv, "/next_marker", "f", next_marker);
431                 REGISTER_CALLBACK (serv, "/undo", "", undo);
432                 REGISTER_CALLBACK (serv, "/undo", "f", undo);
433                 REGISTER_CALLBACK (serv, "/redo", "", redo);
434                 REGISTER_CALLBACK (serv, "/redo", "f", redo);
435                 REGISTER_CALLBACK (serv, "/toggle_punch_in", "", toggle_punch_in);
436                 REGISTER_CALLBACK (serv, "/toggle_punch_in", "f", toggle_punch_in);
437                 REGISTER_CALLBACK (serv, "/toggle_punch_out", "", toggle_punch_out);
438                 REGISTER_CALLBACK (serv, "/toggle_punch_out", "f", toggle_punch_out);
439                 REGISTER_CALLBACK (serv, "/rec_enable_toggle", "", rec_enable_toggle);
440                 REGISTER_CALLBACK (serv, "/rec_enable_toggle", "f", rec_enable_toggle);
441                 REGISTER_CALLBACK (serv, "/toggle_all_rec_enables", "", toggle_all_rec_enables);
442                 REGISTER_CALLBACK (serv, "/toggle_all_rec_enables", "f", toggle_all_rec_enables);
443                 REGISTER_CALLBACK (serv, "/all_tracks_rec_in", "f", all_tracks_rec_in);
444                 REGISTER_CALLBACK (serv, "/all_tracks_rec_out", "f", all_tracks_rec_out);
445                 REGISTER_CALLBACK (serv, "/remove_marker", "", remove_marker_at_playhead);
446                 REGISTER_CALLBACK (serv, "/remove_marker", "f", remove_marker_at_playhead);
447                 REGISTER_CALLBACK (serv, "/jump_bars", "f", jump_by_bars);
448                 REGISTER_CALLBACK (serv, "/jump_seconds", "f", jump_by_seconds);
449                 REGISTER_CALLBACK (serv, "/mark_in", "", mark_in);
450                 REGISTER_CALLBACK (serv, "/mark_in", "f", mark_in);
451                 REGISTER_CALLBACK (serv, "/mark_out", "", mark_out);
452                 REGISTER_CALLBACK (serv, "/mark_out", "f", mark_out);
453                 REGISTER_CALLBACK (serv, "/toggle_click", "", toggle_click);
454                 REGISTER_CALLBACK (serv, "/toggle_click", "f", toggle_click);
455                 REGISTER_CALLBACK (serv, "/midi_panic", "", midi_panic);
456                 REGISTER_CALLBACK (serv, "/midi_panic", "f", midi_panic);
457                 REGISTER_CALLBACK (serv, "/toggle_roll", "", toggle_roll);
458                 REGISTER_CALLBACK (serv, "/toggle_roll", "f", toggle_roll);
459                 REGISTER_CALLBACK (serv, "/stop_forget", "", stop_forget);
460                 REGISTER_CALLBACK (serv, "/stop_forget", "f", stop_forget);
461                 REGISTER_CALLBACK (serv, "/set_punch_range", "", set_punch_range);
462                 REGISTER_CALLBACK (serv, "/set_punch_range", "f", set_punch_range);
463                 REGISTER_CALLBACK (serv, "/set_loop_range", "", set_loop_range);
464                 REGISTER_CALLBACK (serv, "/set_loop_range", "f", set_loop_range);
465                 REGISTER_CALLBACK (serv, "/set_session_range", "", set_session_range);
466                 REGISTER_CALLBACK (serv, "/set_session_range", "f", set_session_range);
467                 // /toggle_monitor_* not working (comented out)
468                 REGISTER_CALLBACK (serv, "/toggle_monitor_mute", "", toggle_monitor_mute);
469                 REGISTER_CALLBACK (serv, "/toggle_monitor_mute", "f", toggle_monitor_mute);
470                 REGISTER_CALLBACK (serv, "/toggle_monitor_dim", "", toggle_monitor_dim);
471                 REGISTER_CALLBACK (serv, "/toggle_monitor_dim", "f", toggle_monitor_dim);
472                 REGISTER_CALLBACK (serv, "/toggle_monitor_mono", "", toggle_monitor_mono);
473                 REGISTER_CALLBACK (serv, "/toggle_monitor_mono", "f", toggle_monitor_mono);
474                 REGISTER_CALLBACK (serv, "/quick_snapshot_switch", "", quick_snapshot_switch);
475                 REGISTER_CALLBACK (serv, "/quick_snapshot_switch", "f", quick_snapshot_switch);
476                 REGISTER_CALLBACK (serv, "/quick_snapshot_stay", "", quick_snapshot_stay);
477                 REGISTER_CALLBACK (serv, "/quick_snapshot_stay", "f", quick_snapshot_stay);
478                 REGISTER_CALLBACK (serv, "/fit_1_track", "", fit_1_track);
479                 REGISTER_CALLBACK (serv, "/fit_1_track", "f", fit_1_track);
480                 REGISTER_CALLBACK (serv, "/fit_2_tracks", "", fit_2_tracks);
481                 REGISTER_CALLBACK (serv, "/fit_2_tracks", "f", fit_2_tracks);
482                 REGISTER_CALLBACK (serv, "/fit_4_tracks", "", fit_4_tracks);
483                 REGISTER_CALLBACK (serv, "/fit_4_tracks", "f", fit_4_tracks);
484                 REGISTER_CALLBACK (serv, "/fit_8_tracks", "", fit_8_tracks);
485                 REGISTER_CALLBACK (serv, "/fit_8_tracks", "f", fit_8_tracks);
486                 REGISTER_CALLBACK (serv, "/fit_16_tracks", "", fit_16_tracks);
487                 REGISTER_CALLBACK (serv, "/fit_16_tracks", "f", fit_16_tracks);
488                 REGISTER_CALLBACK (serv, "/fit_32_tracks", "", fit_32_tracks);
489                 REGISTER_CALLBACK (serv, "/fit_32_tracks", "f", fit_32_tracks);
490                 REGISTER_CALLBACK (serv, "/fit_all_tracks", "", fit_all_tracks);
491                 REGISTER_CALLBACK (serv, "/fit_all_tracks", "f", fit_all_tracks);
492                 REGISTER_CALLBACK (serv, "/zoom_100_ms", "", zoom_100_ms);
493                 REGISTER_CALLBACK (serv, "/zoom_100_ms", "f", zoom_100_ms);
494                 REGISTER_CALLBACK (serv, "/zoom_1_sec", "", zoom_1_sec);
495                 REGISTER_CALLBACK (serv, "/zoom_1_sec", "f", zoom_1_sec);
496                 REGISTER_CALLBACK (serv, "/zoom_10_sec", "", zoom_10_sec);
497                 REGISTER_CALLBACK (serv, "/zoom_10_sec", "f", zoom_10_sec);
498                 REGISTER_CALLBACK (serv, "/zoom_1_min", "", zoom_1_min);
499                 REGISTER_CALLBACK (serv, "/zoom_1_min", "f", zoom_1_min);
500                 REGISTER_CALLBACK (serv, "/zoom_5_min", "", zoom_5_min);
501                 REGISTER_CALLBACK (serv, "/zoom_5_min", "f", zoom_5_min);
502                 REGISTER_CALLBACK (serv, "/zoom_10_min", "", zoom_10_min);
503                 REGISTER_CALLBACK (serv, "/zoom_10_min", "f", zoom_10_min);
504                 REGISTER_CALLBACK (serv, "/zoom_to_session", "", zoom_to_session);
505                 REGISTER_CALLBACK (serv, "/zoom_to_session", "f", zoom_to_session);
506                 REGISTER_CALLBACK (serv, "/temporal_zoom_in", "f", temporal_zoom_in);
507                 REGISTER_CALLBACK (serv, "/temporal_zoom_in", "", temporal_zoom_in);
508                 REGISTER_CALLBACK (serv, "/temporal_zoom_out", "", temporal_zoom_out);
509                 REGISTER_CALLBACK (serv, "/temporal_zoom_out", "f", temporal_zoom_out);
510                 REGISTER_CALLBACK (serv, "/scroll_up_1_track", "f", scroll_up_1_track);
511                 REGISTER_CALLBACK (serv, "/scroll_up_1_track", "", scroll_up_1_track);
512                 REGISTER_CALLBACK (serv, "/scroll_dn_1_track", "f", scroll_dn_1_track);
513                 REGISTER_CALLBACK (serv, "/scroll_dn_1_track", "", scroll_dn_1_track);
514                 REGISTER_CALLBACK (serv, "/scroll_up_1_page", "f", scroll_up_1_page);
515                 REGISTER_CALLBACK (serv, "/scroll_up_1_page", "", scroll_up_1_page);
516                 REGISTER_CALLBACK (serv, "/scroll_dn_1_page", "f", scroll_dn_1_page);
517                 REGISTER_CALLBACK (serv, "/scroll_dn_1_page", "", scroll_dn_1_page);
518                 REGISTER_CALLBACK (serv, "/bank_up", "", bank_up);
519                 REGISTER_CALLBACK (serv, "/bank_up", "f", bank_up);
520                 REGISTER_CALLBACK (serv, "/bank_down", "", bank_down);
521                 REGISTER_CALLBACK (serv, "/bank_down", "f", bank_down);
522
523                 // controls for "special" strips
524                 REGISTER_CALLBACK (serv, "/master/gain", "f", master_set_gain);
525                 REGISTER_CALLBACK (serv, "/master/fader", "i", master_set_fader);
526                 REGISTER_CALLBACK (serv, "/master/mute", "i", master_set_mute);
527                 REGISTER_CALLBACK (serv, "/master/trimdB", "f", master_set_trim);
528                 REGISTER_CALLBACK (serv, "/master/pan_stereo_position", "f", master_set_pan_stereo_position);
529                 REGISTER_CALLBACK (serv, "/monitor/gain", "f", monitor_set_gain);
530                 REGISTER_CALLBACK (serv, "/monitor/fader", "i", monitor_set_fader);
531
532                 // Controls for the Selected strip
533                 REGISTER_CALLBACK (serv, "/select/recenable", "i", sel_recenable);
534                 REGISTER_CALLBACK (serv, "/select/record_safe", "i", sel_recsafe);
535                 REGISTER_CALLBACK (serv, "/select/mute", "i", sel_mute);
536                 REGISTER_CALLBACK (serv, "/select/solo", "i", sel_solo);
537                 REGISTER_CALLBACK (serv, "/select/solo_iso", "i", sel_solo_iso);
538                 REGISTER_CALLBACK (serv, "/select/solo_safe", "i", sel_solo_safe);
539                 REGISTER_CALLBACK (serv, "/select/monitor_input", "i", sel_monitor_input);
540                 REGISTER_CALLBACK (serv, "/select/monitor_disk", "i", sel_monitor_disk);
541                 REGISTER_CALLBACK (serv, "/select/polarity", "i", sel_phase);
542                 REGISTER_CALLBACK (serv, "/select/gain", "f", sel_gain);
543                 REGISTER_CALLBACK (serv, "/select/fader", "f", sel_fader);
544                 REGISTER_CALLBACK (serv, "/select/trimdB", "f", sel_trim);
545                 REGISTER_CALLBACK (serv, "/select/pan_stereo_position", "f", sel_pan_position);
546                 REGISTER_CALLBACK (serv, "/select/pan_stereo_width", "f", sel_pan_width);
547                 REGISTER_CALLBACK (serv, "/select/send_gain", "if", sel_sendgain);
548                 REGISTER_CALLBACK (serv, "/select/send_fader", "if", sel_sendfader);
549                 REGISTER_CALLBACK (serv, "/select/send_enable", "if", sel_sendenable);
550
551                 /* These commands require the route index in addition to the arg; TouchOSC (et al) can't use these  */ 
552                 REGISTER_CALLBACK (serv, "/strip/mute", "ii", route_mute);
553                 REGISTER_CALLBACK (serv, "/strip/solo", "ii", route_solo);
554                 REGISTER_CALLBACK (serv, "/strip/solo_iso", "ii", route_solo_iso);
555                 REGISTER_CALLBACK (serv, "/strip/solo_safe", "ii", route_solo_safe);
556                 REGISTER_CALLBACK (serv, "/strip/recenable", "ii", route_recenable);
557                 REGISTER_CALLBACK (serv, "/strip/record_safe", "ii", route_recsafe);
558                 REGISTER_CALLBACK (serv, "/strip/monitor_input", "ii", route_monitor_input);
559                 REGISTER_CALLBACK (serv, "/strip/monitor_disk", "ii", route_monitor_disk);
560                 REGISTER_CALLBACK (serv, "/strip/select", "ii", strip_select);
561                 REGISTER_CALLBACK (serv, "/strip/gui_select", "ii", strip_gui_select);
562                 REGISTER_CALLBACK (serv, "/strip/polarity", "ii", strip_phase);
563                 REGISTER_CALLBACK (serv, "/strip/gain", "if", route_set_gain_dB);
564                 REGISTER_CALLBACK (serv, "/strip/fader", "if", route_set_gain_fader);
565                 REGISTER_CALLBACK (serv, "/strip/trimdB", "if", route_set_trim_dB);
566                 REGISTER_CALLBACK (serv, "/strip/pan_stereo_position", "if", route_set_pan_stereo_position);
567                 REGISTER_CALLBACK (serv, "/strip/pan_stereo_width", "if", route_set_pan_stereo_width);
568                 REGISTER_CALLBACK (serv, "/strip/plugin/parameter", "iiif", route_plugin_parameter);
569                 // prints to cerr only
570                 REGISTER_CALLBACK (serv, "/strip/plugin/parameter/print", "iii", route_plugin_parameter_print);
571                 REGISTER_CALLBACK (serv, "/strip/send/gainabs", "iif", route_set_send_gain_abs);
572                 REGISTER_CALLBACK (serv, "/strip/send/gain", "iif", route_set_send_gain_dB);
573                 REGISTER_CALLBACK (serv, "/strip/send/fader", "iif", route_set_send_fader);
574                 REGISTER_CALLBACK (serv, "/strip/send/enable", "iif", route_set_send_enable);
575
576                 /* still not-really-standardized query interface */
577                 //REGISTER_CALLBACK (serv, "/ardour/*/#current_value", "", current_value);
578                 //REGISTER_CALLBACK (serv, "/ardour/set", "", set);
579
580                 // un/register_update args= s:ctrl s:returl s:retpath
581                 //lo_server_add_method(serv, "/register_update", "sss", OSC::global_register_update_handler, this);
582                 //lo_server_add_method(serv, "/unregister_update", "sss", OSC::global_unregister_update_handler, this);
583                 //lo_server_add_method(serv, "/register_auto_update", "siss", OSC::global_register_auto_update_handler, this);
584                 //lo_server_add_method(serv, "/unregister_auto_update", "sss", OSC::_global_unregister_auto_update_handler, this);
585
586                 /* this is a special catchall handler,
587                  * register at the end so this is only called if no
588                  * other handler matches (used for debug) */
589                 lo_server_add_method (serv, 0, 0, _catchall, this);
590         }
591 }
592
593 bool
594 OSC::osc_input_handler (IOCondition ioc, lo_server srv)
595 {
596         if (ioc & ~IO_IN) {
597                 return false;
598         }
599
600         if (ioc & IO_IN) {
601                 lo_server_recv (srv);
602         }
603
604         return true;
605 }
606
607 std::string
608 OSC::get_server_url()
609 {
610         string url;
611         char * urlstr;
612
613         if (_osc_server) {
614                 urlstr = lo_server_get_url (_osc_server);
615                 url = urlstr;
616                 free (urlstr);
617         }
618
619         return url;
620 }
621
622 std::string
623 OSC::get_unix_server_url()
624 {
625         string url;
626         char * urlstr;
627
628         if (_osc_unix_server) {
629                 urlstr = lo_server_get_url (_osc_unix_server);
630                 url = urlstr;
631                 free (urlstr);
632         }
633
634         return url;
635 }
636
637 void
638 OSC::listen_to_route (boost::shared_ptr<Stripable> strip, lo_address addr)
639 {
640         if (!strip) {
641                 return;
642         }
643         /* avoid duplicate listens */
644
645         for (RouteObservers::iterator x = route_observers.begin(); x != route_observers.end(); ++x) {
646
647                 OSCRouteObserver* ro;
648
649                 if ((ro = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
650
651                         int res = strcmp(lo_address_get_url(ro->address()), lo_address_get_url(addr));
652
653                         if (ro->strip() == strip && res == 0) {
654                                 return;
655                         }
656                 }
657         }
658
659         OSCSurface *s = get_surface(addr);
660         uint32_t ssid = get_sid (strip, addr);
661         OSCRouteObserver* o = new OSCRouteObserver (strip, addr, ssid, s->gainmode, s->feedback);
662         route_observers.push_back (o);
663
664         strip->DropReferences.connect (*this, MISSING_INVALIDATOR, boost::bind (&OSC::route_lost, this, boost::weak_ptr<Stripable> (strip)), this);
665 }
666
667 void
668 OSC::route_lost (boost::weak_ptr<Stripable> wr)
669 {
670         tick = false;
671         drop_route (wr);
672         bank_dirty = true;
673 }
674
675 void
676 OSC::drop_route (boost::weak_ptr<Stripable> wr)
677 {
678         boost::shared_ptr<Stripable> r = wr.lock ();
679
680         if (!r) {
681                 return;
682         }
683
684         for (RouteObservers::iterator x = route_observers.begin(); x != route_observers.end();) {
685
686                 OSCRouteObserver* rc;
687
688                 if ((rc = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
689
690                         if (rc->strip() == r) {
691                                 delete *x;
692                                 x = route_observers.erase (x);
693                         } else {
694                                 ++x;
695                         }
696                 } else {
697                         ++x;
698                 }
699         }
700 }
701
702 void
703 OSC::end_listen (boost::shared_ptr<Stripable> r, lo_address addr)
704 {
705         RouteObservers::iterator x;
706
707         // Remove the route observers
708         for (x = route_observers.begin(); x != route_observers.end();) {
709
710                 OSCRouteObserver* ro;
711
712                 if ((ro = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
713
714                         int res = strcmp(lo_address_get_url(ro->address()), lo_address_get_url(addr));
715
716                         if (ro->strip() == r && res == 0) {
717                                 delete *x;
718                                 x = route_observers.erase (x);
719                         }
720                         else {
721                                 ++x;
722                         }
723                 }
724                 else {
725                         ++x;
726                 }
727         }
728 }
729
730 void
731 OSC::current_value_query (const char* path, size_t len, lo_arg **argv, int argc, lo_message msg)
732 {
733         char* subpath;
734
735         subpath = (char*) malloc (len-15+1);
736         memcpy (subpath, path, len-15);
737         subpath[len-15] = '\0';
738
739         send_current_value (subpath, argv, argc, msg);
740
741         free (subpath);
742 }
743
744 void
745 OSC::send_current_value (const char* path, lo_arg** argv, int argc, lo_message msg)
746 {
747         if (!session) {
748                 return;
749         }
750
751         lo_message reply = lo_message_new ();
752         boost::shared_ptr<Route> r;
753         int id;
754
755         lo_message_add_string (reply, path);
756
757         if (argc == 0) {
758                 lo_message_add_string (reply, "bad syntax");
759         } else {
760                 id = argv[0]->i;
761                 r = session->get_remote_nth_route (id);
762
763                 if (!r) {
764                         lo_message_add_string (reply, "not found");
765                 } else {
766
767                         if (strcmp (path, "/strip/state") == 0) {
768
769                                 if (boost::dynamic_pointer_cast<AudioTrack>(r)) {
770                                         lo_message_add_string (reply, "AT");
771                                 } else if (boost::dynamic_pointer_cast<MidiTrack>(r)) {
772                                         lo_message_add_string (reply, "MT");
773                                 } else {
774                                         lo_message_add_string (reply, "B");
775                                 }
776
777                                 lo_message_add_string (reply, r->name().c_str());
778                                 lo_message_add_int32 (reply, r->n_inputs().n_audio());
779                                 lo_message_add_int32 (reply, r->n_outputs().n_audio());
780                                 lo_message_add_int32 (reply, r->muted());
781                                 lo_message_add_int32 (reply, r->soloed());
782
783                         } else if (strcmp (path, "/strip/mute") == 0) {
784
785                                 lo_message_add_int32 (reply, (float) r->muted());
786
787                         } else if (strcmp (path, "/strip/solo") == 0) {
788
789                                 lo_message_add_int32 (reply, r->soloed());
790                         }
791                 }
792         }
793
794         lo_send_message (lo_message_get_source (msg), "#reply", reply);
795         lo_message_free (reply);
796 }
797
798 int
799 OSC::_catchall (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data)
800 {
801         return ((OSC*)user_data)->catchall (path, types, argv, argc, data);
802 }
803
804 int
805 OSC::catchall (const char *path, const char* types, lo_arg **argv, int argc, lo_message msg)
806 {
807         size_t len;
808         int ret = 1; /* unhandled */
809
810         //cerr << "Received a message, path = " << path << " types = \""
811         //     << (types ? types : "NULL") << '"' << endl;
812
813         /* 15 for /#current_value plus 2 for /<path> */
814
815         len = strlen (path);
816
817         if (len >= 17 && !strcmp (&path[len-15], "/#current_value")) {
818                 current_value_query (path, len, argv, argc, msg);
819                 ret = 0;
820
821         } else if (strcmp (path, "/strip/listen") == 0) {
822
823                 cerr << "set up listener\n";
824
825                 lo_message reply = lo_message_new ();
826
827                 if (argc <= 0) {
828                         lo_message_add_string (reply, "syntax error");
829                 } else {
830                         for (int n = 0; n < argc; ++n) {
831
832                                 boost::shared_ptr<Route> r = session->get_remote_nth_route (argv[n]->i);
833
834                                 if (!r) {
835                                         lo_message_add_string (reply, "not found");
836                                         cerr << "no such route\n";
837                                         break;
838                                 } else {
839                                         cerr << "add listener\n";
840                                         listen_to_route (r, lo_message_get_source (msg));
841                                         lo_message_add_int32 (reply, argv[n]->i);
842                                 }
843                         }
844                 }
845
846                 lo_send_message (lo_message_get_source (msg), "#reply", reply);
847                 lo_message_free (reply);
848
849                 ret = 0;
850
851         } else if (strcmp (path, "/strip/ignore") == 0) {
852
853                 for (int n = 0; n < argc; ++n) {
854
855                         boost::shared_ptr<Route> r = session->get_remote_nth_route (argv[n]->i);
856
857                         if (r) {
858                                 end_listen (r, lo_message_get_source (msg));
859                         }
860                 }
861
862                 ret = 0;
863         } else if (argc == 1 && types[0] == 'f') { // single float -- probably TouchOSC
864                 if (!strncmp (path, "/strip/gain/", 12) && strlen (path) > 12) {
865                         // in dB
866                         int ssid = atoi (&path[12]);
867                         route_set_gain_dB (ssid, argv[0]->f, msg);
868                         ret = 0;
869                 }
870                 else if (!strncmp (path, "/strip/fader/", 13) && strlen (path) > 13) {
871                         // in fader position
872                         int ssid = atoi (&path[13]);
873                         route_set_gain_fader (ssid, argv[0]->f, msg);
874                         ret = 0;
875                 }
876                 else if (!strncmp (path, "/strip/trimdB/", 14) && strlen (path) > 14) {
877                         int ssid = atoi (&path[14]);
878                         route_set_trim_dB (ssid, argv[0]->f, msg);
879                         ret = 0;
880                 }
881                 else if (!strncmp (path, "/strip/mute/", 12) && strlen (path) > 12) {
882                         int ssid = atoi (&path[12]);
883                         route_mute (ssid, argv[0]->f == 1.0, msg);
884                         ret = 0;
885                 }
886                 else if (!strncmp (path, "/strip/solo/", 12) && strlen (path) > 12) {
887                         int ssid = atoi (&path[12]);
888                         route_solo (ssid, argv[0]->f == 1.0, msg);
889                         ret = 0;
890                 }
891                 else if (!strncmp (path, "/strip/monitor_input/", 21) && strlen (path) > 21) {
892                         int ssid = atoi (&path[21]);
893                         route_monitor_input (ssid, argv[0]->f == 1.0, msg);
894                         ret = 0;
895                 }
896                 else if (!strncmp (path, "/strip/monitor_disk/", 20) && strlen (path) > 20) {
897                         int ssid = atoi (&path[20]);
898                         route_monitor_disk (ssid, argv[0]->f == 1.0, msg);
899                         ret = 0;
900                 }
901                 else if (!strncmp (path, "/strip/recenable/", 17) && strlen (path) > 17) {
902                         int ssid = atoi (&path[17]);
903                         route_recenable (ssid, argv[0]->f == 1.0, msg);
904                         ret = 0;
905                 }
906                 else if (!strncmp (path, "/strip/record_safe/", 19) && strlen (path) > 19) {
907                         int ssid = atoi (&path[19]);
908                         route_recsafe (ssid, argv[0]->f == 1.0, msg);
909                         ret = 0;
910                 }
911                 else if (!strncmp (path, "/strip/select/", 14) && strlen (path) > 14) {
912                         int ssid = atoi (&path[14]);
913                         strip_select (ssid, argv[0]->f == 1.0, msg);
914                         ret = 0;
915                 }
916                 else if (!strncmp (path, "/strip/gui_select/", 18) && strlen (path) > 18) {
917                         int ssid = atoi (&path[18]);
918                         strip_gui_select (ssid, argv[0]->f == 1.0, msg);
919                         ret = 0;
920                 }
921                 else if (!strncmp (path, "/select/send_gain/", 18) && strlen (path) > 18) {
922                         int ssid = atoi (&path[18]);
923                         route_mute (ssid, argv[0]->f == 1.0, msg);
924                         ret = 0;
925                 }
926                 else if (!strncmp (path, "/select/send_fader/", 19) && strlen (path) > 19) {
927                         int ssid = atoi (&path[19]);
928                         route_solo (ssid, argv[0]->f == 1.0, msg);
929                         ret = 0;
930                 }
931         }
932
933         if ((ret && _debugmode == Unhandled)) {
934                 debugmsg (_("Unhandled OSC message"), path, types, argv, argc);
935         }
936
937         return ret;
938 }
939
940 void
941 OSC::debugmsg (const char *prefix, const char *path, const char* types, lo_arg **argv, int argc)
942 {
943         std::stringstream ss;
944         for (int i = 0; i < argc; ++i) {
945                 lo_type type = (lo_type)types[i];
946                         ss << " ";
947                 switch (type) {
948                         case LO_INT32:
949                                 ss << "i:" << argv[i]->i;
950                                 break;
951                         case LO_FLOAT:
952                                 ss << "f:" << argv[i]->f;
953                                 break;
954                         case LO_DOUBLE:
955                                 ss << "d:" << argv[i]->d;
956                                 break;
957                         case LO_STRING:
958                                 ss << "s:" << &argv[i]->s;
959                                 break;
960                         case LO_INT64:
961                                 ss << "h:" << argv[i]->h;
962                                 break;
963                         case LO_CHAR:
964                                 ss << "c:" << argv[i]->s;
965                                 break;
966                         case LO_TIMETAG:
967                                 ss << "<Timetag>";
968                                 break;
969                         case LO_BLOB:
970                                 ss << "<BLOB>";
971                                 break;
972                         case LO_TRUE:
973                                 ss << "#T";
974                                 break;
975                         case LO_FALSE:
976                                 ss << "#F";
977                                 break;
978                         case LO_NIL:
979                                 ss << "NIL";
980                                 break;
981                         case LO_INFINITUM:
982                                 ss << "#inf";
983                                 break;
984                         case LO_MIDI:
985                                 ss << "<MIDI>";
986                                 break;
987                         case LO_SYMBOL:
988                                 ss << "<SYMBOL>";
989                                 break;
990                         default:
991                                 ss << "< ?? >";
992                                 break;
993                 }
994         }
995         PBD::info << prefix << ": " << path << ss.str() << endmsg;
996 }
997
998 void
999 OSC::update_clock ()
1000 {
1001
1002 }
1003
1004 // "Application Hook" Handlers //
1005 void
1006 OSC::session_loaded (Session& s)
1007 {
1008 //      lo_address listener = lo_address_new (NULL, "7770");
1009 //      lo_send (listener, "/session/loaded", "ss", s.path().c_str(), s.name().c_str());
1010 }
1011
1012 void
1013 OSC::session_exported (std::string path, std::string name)
1014 {
1015         lo_address listener = lo_address_new (NULL, "7770");
1016         lo_send (listener, "/session/exported", "ss", path.c_str(), name.c_str());
1017         lo_address_free (listener);
1018 }
1019
1020 // end "Application Hook" Handlers //
1021
1022 /* path callbacks */
1023
1024 int
1025 OSC::current_value (const char */*path*/, const char */*types*/, lo_arg **/*argv*/, int /*argc*/, void */*data*/, void* /*user_data*/)
1026 {
1027 #if 0
1028         const char* returl;
1029
1030         if (argc < 3 || types == 0 || strlen (types) < 3 || types[0] != 's' || types[1] != 's' || types[2] != s) {
1031                 return 1;
1032         }
1033
1034         const char *returl = argv[1]->s;
1035         lo_address addr = find_or_cache_addr (returl);
1036
1037         const char *retpath = argv[2]->s;
1038
1039
1040         if (strcmp (argv[0]->s, "transport_frame") == 0) {
1041
1042                 if (session) {
1043                         lo_send (addr, retpath, "i", session->transport_frame());
1044                 }
1045
1046         } else if (strcmp (argv[0]->s, "transport_speed") == 0) {
1047
1048                 if (session) {
1049                         lo_send (addr, retpath, "i", session->transport_frame());
1050                 }
1051
1052         } else if (strcmp (argv[0]->s, "transport_locked") == 0) {
1053
1054                 if (session) {
1055                         lo_send (addr, retpath, "i", session->transport_frame());
1056                 }
1057
1058         } else if (strcmp (argv[0]->s, "punch_in") == 0) {
1059
1060                 if (session) {
1061                         lo_send (addr, retpath, "i", session->transport_frame());
1062                 }
1063
1064         } else if (strcmp (argv[0]->s, "punch_out") == 0) {
1065
1066                 if (session) {
1067                         lo_send (addr, retpath, "i", session->transport_frame());
1068                 }
1069
1070         } else if (strcmp (argv[0]->s, "rec_enable") == 0) {
1071
1072                 if (session) {
1073                         lo_send (addr, retpath, "i", session->transport_frame());
1074                 }
1075
1076         } else {
1077
1078                 /* error */
1079         }
1080 #endif
1081         return 0;
1082 }
1083
1084 void
1085 OSC::routes_list (lo_message msg)
1086 {
1087         if (!session) {
1088                 return;
1089         }
1090         for (int n = 0; n < (int) session->nroutes(); ++n) {
1091
1092                 boost::shared_ptr<Route> r = session->get_remote_nth_route (n);
1093
1094                 if (r) {
1095
1096                         lo_message reply = lo_message_new ();
1097
1098                         if (boost::dynamic_pointer_cast<AudioTrack>(r)) {
1099                                 lo_message_add_string (reply, "AT");
1100                         } else if (boost::dynamic_pointer_cast<MidiTrack>(r)) {
1101                                 lo_message_add_string (reply, "MT");
1102                         } else {
1103                                 lo_message_add_string (reply, "B");
1104                         }
1105
1106                         lo_message_add_string (reply, r->name().c_str());
1107                         lo_message_add_int32 (reply, r->n_inputs().n_audio());
1108                         lo_message_add_int32 (reply, r->n_outputs().n_audio());
1109                         lo_message_add_int32 (reply, r->muted());
1110                         lo_message_add_int32 (reply, r->soloed());
1111                         /* XXX Can only use order at this point */
1112                         //lo_message_add_int32 (reply, r->presentation_info().order());
1113                         // try this instead.
1114                         lo_message_add_int32 (reply, get_sid (r, lo_message_get_source (msg)));
1115
1116                         if (boost::dynamic_pointer_cast<AudioTrack>(r)
1117                                         || boost::dynamic_pointer_cast<MidiTrack>(r)) {
1118
1119                                 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track>(r);
1120                                 lo_message_add_int32 (reply, (int32_t) t->rec_enable_control()->get_value());
1121                         }
1122
1123                         //Automatically listen to routes listed
1124                         listen_to_route(r, lo_message_get_source (msg));
1125
1126                         lo_send_message (lo_message_get_source (msg), "#reply", reply);
1127                         lo_message_free (reply);
1128                 }
1129         }
1130
1131         // Send end of listing message
1132         lo_message reply = lo_message_new ();
1133
1134         lo_message_add_string (reply, "end_route_list");
1135         lo_message_add_int64 (reply, session->frame_rate());
1136         lo_message_add_int64 (reply, session->current_end_frame());
1137
1138         lo_send_message (lo_message_get_source (msg), "#reply", reply);
1139
1140         lo_message_free (reply);
1141 }
1142
1143 int
1144 OSC::set_surface (uint32_t b_size, uint32_t strips, uint32_t fb, uint32_t gm, lo_message msg)
1145 {
1146         OSCSurface *s = get_surface(lo_message_get_source (msg));
1147         s->bank_size = b_size;
1148         s->strip_types = strips;
1149         s->feedback = fb;
1150         s->gainmode = gm;
1151         // set bank and strip feedback
1152         set_bank(s->bank, msg);
1153
1154         global_feedback (s->feedback, msg, s->gainmode);
1155         return 0;
1156 }
1157
1158 int
1159 OSC::set_surface_bank_size (uint32_t bs, lo_message msg)
1160 {
1161         OSCSurface *s = get_surface(lo_message_get_source (msg));
1162         s->bank_size = bs;
1163
1164         // set bank and strip feedback
1165         set_bank(s->bank, msg);
1166         return 0;
1167 }
1168
1169 int
1170 OSC::set_surface_strip_types (uint32_t st, lo_message msg)
1171 {
1172         OSCSurface *s = get_surface(lo_message_get_source (msg));
1173         s->strip_types = st;
1174
1175         // set bank and strip feedback
1176         set_bank(s->bank, msg);
1177         return 0;
1178 }
1179
1180
1181 int
1182 OSC::set_surface_feedback (uint32_t fb, lo_message msg)
1183 {
1184         OSCSurface *s = get_surface(lo_message_get_source (msg));
1185         s->feedback = fb;
1186
1187         // set bank and strip feedback
1188         set_bank(s->bank, msg);
1189
1190         // Set global/master feedback
1191         global_feedback (s->feedback, msg, s->gainmode);
1192         return 0;
1193 }
1194
1195
1196 int
1197 OSC::set_surface_gainmode (uint32_t gm, lo_message msg)
1198 {
1199         OSCSurface *s = get_surface(lo_message_get_source (msg));
1200         s->gainmode = gm;
1201
1202         // set bank and strip feedback
1203         set_bank(s->bank, msg);
1204
1205         // Set global/master feedback
1206         global_feedback (s->feedback, msg, s->gainmode);
1207         return 0;
1208 }
1209
1210 OSC::OSCSurface *
1211 OSC::get_surface (lo_address addr)
1212 {
1213         string r_url;
1214         char * rurl;
1215         rurl = lo_address_get_url (addr);
1216         r_url = rurl;
1217         free (rurl);
1218         for (uint32_t it = 0; it < _surface.size(); ++it) {
1219                 //find setup for this server
1220                 if (!_surface[it].remote_url.find(r_url)){
1221                         return &_surface[it];
1222                 }
1223         }
1224         // No surface create one with default values
1225         OSCSurface s;
1226         s.remote_url = r_url;
1227         s.bank = 1;
1228         s.bank_size = 0; // need to find out how many strips there are
1229         s.strip_types = 31; // 31 is tracks, busses, and VCAs (no master/monitor)
1230         s.feedback = 0;
1231         s.gainmode = 0;
1232         s.sel_obs = 0;
1233         s.surface_sel = 0;
1234         s.strips = get_sorted_stripables(s.strip_types);
1235
1236         // I think the line below can be removed
1237         s.nstrips = s.strips.size();
1238         _surface.push_back (s);
1239
1240         return &_surface[_surface.size() - 1];
1241 }
1242
1243 // setup global feedback for a surface
1244 void
1245 OSC::global_feedback (bitset<32> feedback, lo_address msg, uint32_t gainmode)
1246 {
1247         // first destroy global observer for this surface
1248         GlobalObservers::iterator x;
1249
1250         for (x = global_observers.begin(); x != global_observers.end();) {
1251
1252                 OSCGlobalObserver* ro;
1253
1254                 if ((ro = dynamic_cast<OSCGlobalObserver*>(*x)) != 0) {
1255
1256                         int res = strcmp(lo_address_get_url(ro->address()), lo_address_get_url(lo_message_get_source (msg)));
1257
1258                         if (res == 0) {
1259                                 delete *x;
1260                                 x = global_observers.erase (x);
1261                         } else {
1262                                 ++x;
1263                         }
1264                 } else {
1265                         ++x;
1266                 }
1267         }
1268         if (feedback[4] || feedback[3] || feedback[5] || feedback[6]) {
1269                 // create a new Global Observer for this surface
1270                 //OSCSurface *s = get_surface (lo_message_get_source (msg));
1271                 OSCGlobalObserver* o = new OSCGlobalObserver (*session, lo_message_get_source (msg), gainmode, /*s->*/feedback);
1272                 global_observers.push_back (o);
1273         }
1274 }
1275
1276 void
1277 OSC::notify_routes_added (ARDOUR::RouteList &)
1278 {
1279         //recalcbanks();
1280 }
1281
1282 void
1283 OSC::notify_vca_added (ARDOUR::VCAList &)
1284 {
1285         //recalcbanks();
1286 }
1287
1288 void
1289 OSC::recalcbanks ()
1290 {
1291         tick = false;
1292         bank_dirty = true;
1293 }
1294
1295 void
1296 OSC::_recalcbanks ()
1297 {
1298         // do a set_bank for each surface we know about.
1299         for (uint32_t it = 0; it < _surface.size(); ++it) {
1300                 OSCSurface* sur = &_surface[it];
1301                 // find lo_address
1302                 lo_address addr = lo_address_new_from_url (sur->remote_url.c_str());
1303                 _set_bank (sur->bank, addr);
1304         }
1305 }
1306
1307 /*
1308  * This gets called not only when bank changes but also:
1309  *  - bank size change
1310  *  - feedback change
1311  *  - strip types changes
1312  *  - fadermode changes
1313  *  - stripable creation/deletion/flag
1314  *  - to refresh what is "displayed"
1315  * Basically any time the bank needs to be rebuilt
1316  */
1317 int
1318 OSC::set_bank (uint32_t bank_start, lo_message msg)
1319 {
1320         return _set_bank (bank_start, lo_message_get_source (msg));
1321 }
1322
1323 int
1324 OSC::_set_bank (uint32_t bank_start, lo_address addr)
1325 {
1326         if (!session) {
1327                 return -1;
1328         }
1329         // no nstripables yet
1330         if (!session->nroutes()) {
1331                 return -1;
1332         }
1333
1334         // reset local select
1335         _strip_select (0, addr);
1336
1337         // undo all listeners for this url
1338         StripableList stripables;
1339         session->get_stripables (stripables);
1340         for (StripableList::iterator it = stripables.begin(); it != stripables.end(); ++it) {
1341
1342                 boost::shared_ptr<Stripable> stp = *it;
1343                 if (stp) {
1344                         end_listen (stp, addr);
1345                 }
1346         }
1347
1348         OSCSurface *s = get_surface (addr);
1349         s->strips = get_sorted_stripables(s->strip_types);
1350         // I think the line below can be removed
1351         s->nstrips = s->strips.size();
1352
1353         uint32_t b_size;
1354         if (!s->bank_size) {
1355                 // no banking - bank includes all stripables
1356                 b_size = s->nstrips;
1357         } else {
1358                 b_size = s->bank_size;
1359         }
1360
1361         // Do limits checking - high end still not quite right
1362         if (bank_start < 1) bank_start = 1;
1363         if (b_size >= s->nstrips)  {
1364                 bank_start = 1;
1365         } else if (bank_start > ((s->nstrips - b_size) + 1)) {
1366                 bank_start = (uint32_t)((s->nstrips - b_size) + 1);
1367         }
1368         //save bank in case we have had to change it
1369         s->bank = bank_start;
1370
1371         if (s->feedback[0] || s->feedback[1]) {
1372
1373                 for (uint32_t n = bank_start; n < (min ((b_size + bank_start), s->nstrips + 1)); ++n) {
1374                         if (n <= s->strips.size()) {
1375                                 boost::shared_ptr<Stripable> stp = s->strips[n - 1];
1376
1377                                 if (stp) {
1378                                         listen_to_route(stp, addr);
1379                                         if (!s->feedback[10]) {
1380                                                 if (stp->is_selected()) {
1381                                                         _strip_select (n + 1 - s->bank_size , addr);
1382                                                 }
1383                                         }
1384                                 }
1385                         }
1386                 }
1387         }
1388         if (s->feedback[4]) {
1389                 lo_message reply;
1390                 reply = lo_message_new ();
1391                 if ((s->bank > (s->nstrips - s->bank_size)) || (s->nstrips < s->bank_size)) {
1392                         lo_message_add_int32 (reply, 0);
1393                 } else {
1394                         lo_message_add_int32 (reply, 1);
1395                 }
1396                 lo_send_message (addr, "/bank_up", reply);
1397                 lo_message_free (reply);
1398                 reply = lo_message_new ();
1399                 if (s->bank > 1) {
1400                         lo_message_add_int32 (reply, 1);
1401                 } else {
1402                         lo_message_add_int32 (reply, 0);
1403                 }
1404                 lo_send_message (addr, "/bank_down", reply);
1405                 lo_message_free (reply);
1406         }
1407         bank_dirty = false;
1408         tick = true;
1409         return 0;
1410 }
1411
1412 int
1413 OSC::bank_up (lo_message msg)
1414 {
1415         if (!session) {
1416                 return -1;
1417         }
1418         OSCSurface *s = get_surface(lo_message_get_source (msg));
1419         set_bank (s->bank + s->bank_size, msg);
1420         return 0;
1421 }
1422
1423 int
1424 OSC::bank_down (lo_message msg)
1425 {
1426         if (!session) {
1427                 return -1;
1428         }
1429         OSCSurface *s = get_surface(lo_message_get_source (msg));
1430         if (s->bank < s->bank_size) {
1431                 set_bank (1, msg);
1432         } else {
1433                 set_bank (s->bank - s->bank_size, msg);
1434         }
1435         return 0;
1436 }
1437
1438 uint32_t
1439 OSC::get_sid (boost::shared_ptr<ARDOUR::Stripable> strip, lo_address addr)
1440 {
1441         OSCSurface *s = get_surface(addr);
1442
1443         uint32_t b_size;
1444         if (!s->bank_size) {
1445                 // no banking
1446                 b_size = s->nstrips;
1447         } else {
1448                 b_size = s->bank_size;
1449         }
1450
1451         for (uint32_t n = s->bank; n < (min ((b_size + s->bank), s->nstrips + 1)); ++n) {
1452                 if (n <= s->strips.size()) {
1453                         if (strip == s->strips[n-1]) {
1454                                 return n - s->bank + 1;
1455                         }
1456                 }
1457         }
1458         // failsafe... should never get here.
1459         return 0;
1460 }
1461
1462 uint32_t
1463 OSC::get_rid (uint32_t ssid, lo_address addr)
1464 {
1465         OSCSurface *s = get_surface(addr);
1466         return ssid + s->bank - 2;
1467 }
1468
1469 boost::shared_ptr<ARDOUR::Stripable>
1470 OSC::get_strip (uint32_t ssid, lo_address addr)
1471 {
1472         OSCSurface *s = get_surface(addr);
1473         if ((ssid + s->bank - 2) < s->nstrips) {
1474                 return s->strips[ssid + s->bank - 2];
1475         }
1476         // guess it is out of range
1477         return boost::shared_ptr<ARDOUR::Stripable>();
1478 }
1479
1480 void
1481 OSC::transport_frame (lo_message msg)
1482 {
1483         if (!session) {
1484                 return;
1485         }
1486         framepos_t pos = session->transport_frame ();
1487
1488         lo_message reply = lo_message_new ();
1489         lo_message_add_int64 (reply, pos);
1490
1491         lo_send_message (lo_message_get_source (msg), "/transport_frame", reply);
1492
1493         lo_message_free (reply);
1494 }
1495
1496 void
1497 OSC::transport_speed (lo_message msg)
1498 {
1499         if (!session) {
1500                 return;
1501         }
1502         double ts = session->transport_speed ();
1503
1504         lo_message reply = lo_message_new ();
1505         lo_message_add_double (reply, ts);
1506
1507         lo_send_message (lo_message_get_source (msg), "/transport_speed", reply);
1508
1509         lo_message_free (reply);
1510 }
1511
1512 void
1513 OSC::record_enabled (lo_message msg)
1514 {
1515         if (!session) {
1516                 return;
1517         }
1518         int re = (int)session->get_record_enabled ();
1519
1520         lo_message reply = lo_message_new ();
1521         lo_message_add_int32 (reply, re);
1522
1523         lo_send_message (lo_message_get_source (msg), "/record_enabled", reply);
1524
1525         lo_message_free (reply);
1526 }
1527
1528 // master and monitor calls
1529 int
1530 OSC::master_set_gain (float dB)
1531 {
1532         if (!session) return -1;
1533         boost::shared_ptr<Stripable> s = session->master_out();
1534         if (s) {
1535                 if (dB < -192) {
1536                         s->gain_control()->set_value (0.0, PBD::Controllable::NoGroup);
1537                 } else {
1538                         s->gain_control()->set_value (dB_to_coefficient (dB), PBD::Controllable::NoGroup);
1539                 }
1540         }
1541         return 0;
1542 }
1543
1544 int
1545 OSC::master_set_fader (uint32_t position)
1546 {
1547         if (!session) return -1;
1548         boost::shared_ptr<Stripable> s = session->master_out();
1549         if (s) {
1550                 if ((position > 799.5) && (position < 800.5)) {
1551                         s->gain_control()->set_value (1.0, PBD::Controllable::NoGroup);
1552                 } else {
1553                         s->gain_control()->set_value (slider_position_to_gain_with_max (((float)position/1023), 2.0), PBD::Controllable::NoGroup);
1554                 }
1555         }
1556         return 0;
1557 }
1558
1559 int
1560 OSC::master_set_trim (float dB)
1561 {
1562         if (!session) return -1;
1563         boost::shared_ptr<Stripable> s = session->master_out();
1564
1565         if (s) {
1566                 s->trim_control()->set_value (dB_to_coefficient (dB), PBD::Controllable::NoGroup);
1567         }
1568
1569         return 0;
1570 }
1571
1572 int
1573 OSC::master_set_pan_stereo_position (float position, lo_message msg)
1574 {
1575         if (!session) return -1;
1576
1577         float endposition = .5;
1578         boost::shared_ptr<Stripable> s = session->master_out();
1579
1580         if (s) {
1581                 if (s->pan_azimuth_control()) {
1582                         s->pan_azimuth_control()->set_value (position, PBD::Controllable::NoGroup);
1583                         endposition = s->pan_azimuth_control()->get_value ();
1584                 }
1585         }
1586         OSCSurface *sur = get_surface(lo_message_get_source (msg));
1587
1588         if (sur->feedback[4]) {
1589                 lo_message reply = lo_message_new ();
1590                 lo_message_add_float (reply, endposition);
1591
1592                 lo_send_message (lo_message_get_source (msg), "/master/pan_stereo_position", reply);
1593                 lo_message_free (reply);
1594         }
1595
1596         return 0;
1597 }
1598
1599 int
1600 OSC::master_set_mute (uint32_t state)
1601 {
1602         if (!session) return -1;
1603
1604         boost::shared_ptr<Stripable> s = session->master_out();
1605
1606         if (s) {
1607                 s->mute_control()->set_value (state, PBD::Controllable::NoGroup);
1608         }
1609
1610         return 0;
1611 }
1612
1613 int
1614 OSC::monitor_set_gain (float dB)
1615 {
1616         if (!session) return -1;
1617         boost::shared_ptr<Stripable> s = session->monitor_out();
1618
1619         if (s) {
1620                 if (dB < -192) {
1621                         s->gain_control()->set_value (0.0, PBD::Controllable::NoGroup);
1622                 } else {
1623                         s->gain_control()->set_value (dB_to_coefficient (dB), PBD::Controllable::NoGroup);
1624                 }
1625         }
1626         return 0;
1627 }
1628
1629 int
1630 OSC::monitor_set_fader (uint32_t position)
1631 {
1632         if (!session) return -1;
1633         boost::shared_ptr<Stripable> s = session->monitor_out();
1634         if (s) {
1635                 if ((position > 799.5) && (position < 800.5)) {
1636                         s->gain_control()->set_value (1.0, PBD::Controllable::NoGroup);
1637                 } else {
1638                         s->gain_control()->set_value (slider_position_to_gain_with_max (((float)position/1023), 2.0), PBD::Controllable::NoGroup);
1639                 }
1640         }
1641         return 0;
1642 }
1643
1644 // strip calls
1645 int
1646 OSC::route_mute (int ssid, int yn, lo_message msg)
1647 {
1648         if (!session) return -1;
1649         boost::shared_ptr<Stripable> s = get_strip (ssid, lo_message_get_source (msg));
1650
1651         if (s) {
1652                 if (s->mute_control()) {
1653                         s->mute_control()->set_value (yn ? 1.0 : 0.0, PBD::Controllable::NoGroup);
1654                         return 0;
1655                 }
1656         }
1657
1658         return route_send_fail ("mute", ssid, 0, lo_message_get_source (msg));
1659 }
1660
1661 int
1662 OSC::sel_mute (uint32_t yn, lo_message msg)
1663 {
1664         OSCSurface *sur = get_surface(lo_message_get_source (msg));
1665         if (sur->surface_sel) {
1666                 return route_mute(sur->surface_sel, yn, msg);
1667         } else { 
1668                 return route_send_fail ("mute", 0, 0, lo_message_get_source (msg));
1669         }
1670 }
1671
1672 int
1673 OSC::route_solo (int ssid, int yn, lo_message msg)
1674 {
1675         if (!session) return -1;
1676         boost::shared_ptr<Stripable> s = get_strip (ssid, lo_message_get_source (msg));
1677
1678         if (s) {
1679                 if (s->solo_control()) {
1680                         s->solo_control()->set_value (yn ? 1.0 : 0.0, PBD::Controllable::NoGroup);
1681                         return 0;
1682                 }
1683         }
1684
1685         return route_send_fail ("solo", ssid, 0, lo_message_get_source (msg));
1686 }
1687
1688 int
1689 OSC::route_solo_iso (int ssid, int yn, lo_message msg)
1690 {
1691         if (!session) return -1;
1692         boost::shared_ptr<Stripable> s = get_strip (ssid, lo_message_get_source (msg));
1693
1694         if (s) {
1695                 if (s->solo_isolate_control()) {
1696                         s->solo_isolate_control()->set_value (yn ? 1.0 : 0.0, PBD::Controllable::NoGroup);
1697                         return 0;
1698                 }
1699         }
1700
1701         return route_send_fail ("solo_iso", ssid, 0, lo_message_get_source (msg));
1702 }
1703
1704 int
1705 OSC::route_solo_safe (int ssid, int yn, lo_message msg)
1706 {
1707         if (!session) return -1;
1708         boost::shared_ptr<Stripable> s = get_strip (ssid, lo_message_get_source (msg));
1709
1710         if (s) {
1711                 if (s->solo_safe_control()) {
1712                         s->solo_safe_control()->set_value (yn ? 1.0 : 0.0, PBD::Controllable::NoGroup);
1713                         return 0;
1714                 }
1715         }
1716
1717         return route_send_fail ("solo_safe", ssid, 0, lo_message_get_source (msg));
1718 }
1719
1720 int
1721 OSC::sel_solo (uint32_t yn, lo_message msg)
1722 {
1723         OSCSurface *sur = get_surface(lo_message_get_source (msg));
1724         if (sur->surface_sel) {
1725                 return route_solo(sur->surface_sel, yn, msg);
1726         } else { 
1727                 return route_send_fail ("solo", 0, 0, lo_message_get_source (msg));
1728         }
1729 }
1730
1731 int
1732 OSC::sel_solo_iso (uint32_t yn, lo_message msg)
1733 {
1734         OSCSurface *sur = get_surface(lo_message_get_source (msg));
1735         if (sur->surface_sel) {
1736                 return route_solo_iso(sur->surface_sel, yn, msg);
1737         } else { 
1738                 return route_send_fail ("solo_iso", 0, 0, lo_message_get_source (msg));
1739         }
1740 }
1741
1742 int
1743 OSC::sel_solo_safe (uint32_t yn, lo_message msg)
1744 {
1745         OSCSurface *sur = get_surface(lo_message_get_source (msg));
1746         if (sur->surface_sel) {
1747                 return route_solo_safe(sur->surface_sel, yn, msg);
1748         } else { 
1749                 return route_send_fail ("solo_safe", 0, 0, lo_message_get_source (msg));
1750         }
1751 }
1752
1753 int
1754 OSC::sel_recenable (uint32_t yn, lo_message msg)
1755 {
1756         OSCSurface *sur = get_surface(lo_message_get_source (msg));
1757         if (sur->surface_sel) {
1758                 return route_recenable(sur->surface_sel, yn, msg);
1759         } else { 
1760                 return route_send_fail ("recenable", 0, 0, lo_message_get_source (msg));
1761         }
1762 }
1763
1764 int
1765 OSC::route_recenable (int ssid, int yn, lo_message msg)
1766 {
1767         if (!session) return -1;
1768         boost::shared_ptr<Stripable> s = get_strip (ssid, lo_message_get_source (msg));
1769
1770         if (s) {
1771                 if (s->rec_enable_control()) {
1772                         s->rec_enable_control()->set_value (yn, PBD::Controllable::UseGroup);
1773                         if (s->rec_enable_control()->get_value()) {
1774                                 return 0;
1775                         }
1776                 }
1777         }
1778         return route_send_fail ("recenable", ssid, 0, lo_message_get_source (msg));
1779 }
1780
1781 int
1782 OSC::sel_recsafe (uint32_t yn, lo_message msg)
1783 {
1784         OSCSurface *sur = get_surface(lo_message_get_source (msg));
1785         if (sur->surface_sel) {
1786                 return route_recsafe(sur->surface_sel, yn, msg);
1787         } else { 
1788                 return route_send_fail ("record_safe", 0, 0, lo_message_get_source (msg));
1789         }
1790 }
1791
1792 int
1793 OSC::route_recsafe (int ssid, int yn, lo_message msg)
1794 {
1795         if (!session) return -1;
1796         boost::shared_ptr<Stripable> s = get_strip (ssid, lo_message_get_source (msg));
1797         if (s) {
1798                 if (s->rec_safe_control()) {
1799                         s->rec_safe_control()->set_value (yn, PBD::Controllable::UseGroup);
1800                         if (s->rec_safe_control()->get_value()) {
1801                                 return 0;
1802                         }
1803                 }
1804         }
1805         return route_send_fail ("record_safe", ssid, 0,lo_message_get_source (msg));
1806 }
1807
1808 int
1809 OSC::route_monitor_input (int ssid, int yn, lo_message msg)
1810 {
1811         if (!session) return -1;
1812         boost::shared_ptr<Stripable> s = get_strip (ssid, lo_message_get_source (msg));
1813
1814         if (s) {
1815                 boost::shared_ptr<Track> track = boost::dynamic_pointer_cast<Track> (s);
1816                 if (track) {
1817                         if (track->monitoring_control()) {
1818                                 track->monitoring_control()->set_value (yn ? 1.0 : 0.0, PBD::Controllable::NoGroup);
1819                                 return 0;
1820                         }
1821                 }
1822         }
1823
1824         return route_send_fail ("monitor_input", ssid, 0, lo_message_get_source (msg));
1825 }
1826
1827 int
1828 OSC::sel_monitor_input (uint32_t yn, lo_message msg)
1829 {
1830         OSCSurface *sur = get_surface(lo_message_get_source (msg));
1831         if (sur->surface_sel) {
1832                 return route_monitor_input(sur->surface_sel, yn, msg);
1833         } else { 
1834                 return route_send_fail ("monitor_input", 0, 0, lo_message_get_source (msg));
1835         }
1836 }
1837
1838 int
1839 OSC::route_monitor_disk (int ssid, int yn, lo_message msg)
1840 {
1841         if (!session) return -1;
1842         boost::shared_ptr<Stripable> s = get_strip (ssid, lo_message_get_source (msg));
1843
1844         if (s) {
1845                 boost::shared_ptr<Track> track = boost::dynamic_pointer_cast<Track> (s);
1846                 if (track) {
1847                         if (track->monitoring_control()) {
1848                                 track->monitoring_control()->set_value (yn ? 2.0 : 0.0, PBD::Controllable::NoGroup);
1849                                 return 0;
1850                         }
1851                 }
1852         }
1853
1854         return route_send_fail ("monitor_disk", ssid, 0, lo_message_get_source (msg));
1855 }
1856
1857 int
1858 OSC::sel_monitor_disk (uint32_t yn, lo_message msg)
1859 {
1860         OSCSurface *sur = get_surface(lo_message_get_source (msg));
1861         if (sur->surface_sel) {
1862                 return route_monitor_disk(sur->surface_sel, yn, msg);
1863         } else { 
1864                 return route_send_fail ("monitor_disk", 0, 0, lo_message_get_source (msg));
1865         }
1866 }
1867
1868
1869 int
1870 OSC::strip_phase (int ssid, int yn, lo_message msg)
1871 {
1872         if (!session) return -1;
1873         boost::shared_ptr<Stripable> s = get_strip (ssid, lo_message_get_source (msg));
1874
1875         if (s) {
1876                 if (s->phase_control()) {
1877                         s->phase_control()->set_value (yn ? 1.0 : 0.0, PBD::Controllable::NoGroup);
1878                         return 0;
1879                 }
1880         }
1881
1882         return route_send_fail ("polarity", ssid, 0, lo_message_get_source (msg));
1883 }
1884
1885 int
1886 OSC::sel_phase (uint32_t yn, lo_message msg)
1887 {
1888         OSCSurface *sur = get_surface(lo_message_get_source (msg));
1889         if (sur->surface_sel) {
1890                 return strip_phase(sur->surface_sel, yn, msg);
1891         } else { 
1892                 return route_send_fail ("polarity", 0, 0, lo_message_get_source (msg));
1893         }
1894 }
1895
1896 int
1897 OSC::strip_select (int ssid, int yn, lo_message msg)
1898 {
1899         //ignore button release
1900         if (!yn) return 0;
1901
1902         return _strip_select ( ssid, lo_message_get_source (msg));
1903 }
1904
1905 int
1906 OSC::_strip_select (int ssid, lo_address addr)
1907 {
1908         if (!session) {
1909                 route_send_fail ("select", ssid, 0, addr);
1910                 return -1;
1911         }
1912         OSCSurface *sur = get_surface(addr);
1913         if (sur->sel_obs) {
1914                 delete sur->sel_obs;
1915                 sur->sel_obs = 0;
1916         }
1917         sur->surface_sel = 0;
1918         boost::shared_ptr<Stripable> s;
1919         if (ssid){
1920                 s = get_strip (ssid, addr);
1921         }
1922         if (s) {
1923                 sur->surface_sel = ssid;
1924                 OSCSelectObserver* sel_fb = new OSCSelectObserver (s, addr, ssid, sur->gainmode, sur->feedback);
1925                 s->DropReferences.connect (*this, MISSING_INVALIDATOR, boost::bind (&OSC::recalcbanks, this), this);
1926                 sur->sel_obs = sel_fb;
1927         } else {
1928                 route_send_fail ("select", ssid, 0 , addr);
1929         }
1930         int b_s = sur->bank_size;
1931         if (!b_s) { // bank size 0 means we need to know how many strips there are.
1932                 b_s = sur->nstrips;
1933         }
1934         for (int i = 1;  i <= b_s; i++) {
1935                 string path = "select";
1936                 if (!sur->feedback[10]) {
1937                         path = "gui_select";
1938                 }
1939                 if (i==(int)sur->surface_sel) {
1940                         lo_message reply = lo_message_new ();
1941                         if (sur->feedback[2]) {
1942                                 ostringstream os;
1943                                 os << "/strip/" << path << "/" << ssid;
1944                                 path = os.str();
1945                         } else {
1946                                 ostringstream os;
1947                                 os << "/strip/" << path;
1948                                 path = os.str();
1949                                 lo_message_add_int32 (reply, ssid);
1950                         }
1951                                 lo_message_add_float (reply, (float) 1);
1952
1953                                 lo_send_message (addr, path.c_str(), reply);
1954                                 lo_message_free (reply);
1955                         } else {
1956                                 route_send_fail (path, i, 0, addr);
1957                         }
1958         }
1959
1960         return 0;
1961 }
1962
1963 int
1964 OSC::strip_gui_select (int ssid, int yn, lo_message msg)
1965 {
1966         //ignore button release
1967         if (!yn) return 0;
1968
1969         if (!session) {
1970                 route_send_fail ("gui_select", ssid, 0, lo_message_get_source (msg));
1971                 return -1;
1972         }
1973
1974         int rid = get_rid (ssid, lo_message_get_source (msg));
1975         boost::shared_ptr<Stripable> s = session->get_remote_nth_stripable (rid, PresentationInfo::Route);
1976         if (s) {
1977                 SetStripableSelection (rid);
1978         } else {
1979                 route_send_fail ("gui_select", ssid, 0, lo_message_get_source (msg));
1980         }
1981
1982         return 0;
1983 }
1984
1985 int
1986 OSC::route_set_gain_abs (int ssid, float level, lo_message msg)
1987 {
1988         if (!session) return -1;
1989         boost::shared_ptr<Stripable> s = get_strip (ssid, lo_message_get_source (msg));
1990         //boost::shared_ptr<Stripable> s = session->get_remote_nth_stripable (rid, PresentationInfo::Route);
1991
1992         if (s) {
1993                 if (s->gain_control()) {
1994                         s->gain_control()->set_value (level, PBD::Controllable::NoGroup);
1995                 } else {
1996                         return 1;
1997                 }
1998         } else {
1999                 return 1;
2000         }
2001
2002         return 0;
2003 }
2004
2005 int
2006 OSC::route_set_gain_dB (int ssid, float dB, lo_message msg)
2007 {
2008         if (!session) {
2009                 route_send_fail ("gain", ssid, -193, lo_message_get_source (msg));
2010                 return -1;
2011         }
2012         int ret;
2013         if (dB < -192) {
2014                 ret = route_set_gain_abs (ssid, 0.0, msg);
2015         } else {
2016                 ret = route_set_gain_abs (ssid, dB_to_coefficient (dB), msg);
2017         }
2018         if (ret != 0) {
2019                 return route_send_fail ("gain", ssid, -193, lo_message_get_source (msg));
2020         }
2021         return 0;
2022 }
2023
2024 int
2025 OSC::sel_gain (float val, lo_message msg)
2026 {
2027         OSCSurface *sur = get_surface(lo_message_get_source (msg));
2028         if (sur->surface_sel) {
2029                 return route_set_gain_dB(sur->surface_sel, val, msg);
2030         } else { 
2031                 return route_send_fail ("gain", 0, -193, lo_message_get_source (msg));
2032         }
2033 }
2034
2035 int
2036 OSC::route_set_gain_fader (int ssid, float pos, lo_message msg)
2037 {
2038         if (!session) {
2039                 route_send_fail ("fader", ssid, 0, lo_message_get_source (msg));
2040                 return -1;
2041         }
2042         int ret;
2043         if ((pos > 799.5) && (pos < 800.5)) {
2044                 ret = route_set_gain_abs (ssid, 1.0, msg);
2045         } else {
2046                 ret = route_set_gain_abs (ssid, slider_position_to_gain_with_max ((pos/1023), 2.0), msg);
2047         }
2048         if (ret != 0) {
2049                 return route_send_fail ("fader", ssid, 0, lo_message_get_source (msg));
2050         }
2051         return 0;
2052 }
2053
2054 int
2055 OSC::sel_fader (float val, lo_message msg)
2056 {
2057         OSCSurface *sur = get_surface(lo_message_get_source (msg));
2058         if (sur->surface_sel) {
2059                 return route_set_gain_fader(sur->surface_sel, val, msg);
2060         } else { 
2061                 return route_send_fail ("fader", 0, 0, lo_message_get_source (msg));
2062         }
2063 }
2064
2065 int
2066 OSC::route_set_trim_abs (int ssid, float level, lo_message msg)
2067 {
2068         if (!session) return -1;
2069         boost::shared_ptr<Stripable> s = get_strip (ssid, lo_message_get_source (msg));
2070
2071         if (s) {
2072                 if (s->trim_control()) {
2073                         s->trim_control()->set_value (level, PBD::Controllable::NoGroup);
2074                         return 0;
2075                 }
2076
2077         }
2078
2079         return -1;
2080 }
2081
2082 int
2083 OSC::route_set_trim_dB (int ssid, float dB, lo_message msg)
2084 {
2085         int ret;
2086         ret = route_set_trim_abs(ssid, dB_to_coefficient (dB), msg);
2087         if (ret != 0) {
2088                 return route_send_fail ("trimdB", ssid, 0, lo_message_get_source (msg));
2089         }
2090
2091 return 0;
2092 }
2093
2094 int
2095 OSC::sel_trim (float val, lo_message msg)
2096 {
2097         OSCSurface *sur = get_surface(lo_message_get_source (msg));
2098         if (sur->surface_sel) {
2099                 return route_set_trim_dB (sur->surface_sel, val, msg);
2100         } else { 
2101                 return route_send_fail ("trimdB", 0, 0, lo_message_get_source (msg));
2102         }
2103 }
2104
2105 int
2106 OSC::sel_pan_position (float val, lo_message msg)
2107 {
2108         OSCSurface *sur = get_surface(lo_message_get_source (msg));
2109         if (sur->surface_sel) {
2110                 return route_set_pan_stereo_position (sur->surface_sel, val, msg);
2111         } else { 
2112                 return route_send_fail ("pan_stereo_position", 0, 0.5, lo_message_get_source (msg));
2113         }
2114 }
2115
2116 int
2117 OSC::sel_pan_width (float val, lo_message msg)
2118 {
2119         OSCSurface *sur = get_surface(lo_message_get_source (msg));
2120         if (sur->surface_sel) {
2121                 return route_set_pan_stereo_width (sur->surface_sel, val, msg);
2122         } else { 
2123                 return route_send_fail ("pan_stereo_width", 0, 1, lo_message_get_source (msg));
2124         }
2125 }
2126
2127 int
2128 OSC::route_set_pan_stereo_position (int ssid, float pos, lo_message msg)
2129 {
2130         if (!session) return -1;
2131         boost::shared_ptr<Stripable> s = get_strip (ssid, lo_message_get_source (msg));
2132
2133         if (s) {
2134                 if(s->pan_azimuth_control()) {
2135                         s->pan_azimuth_control()->set_value (pos, PBD::Controllable::NoGroup);
2136                         return route_send_fail ("pan_stereo_position", ssid, s->pan_azimuth_control()->get_value (), lo_message_get_source (msg));
2137                 }
2138         }
2139
2140         return route_send_fail ("pan_stereo_position", ssid, 0.5, lo_message_get_source (msg));
2141 }
2142
2143 int
2144 OSC::route_set_pan_stereo_width (int ssid, float pos, lo_message msg)
2145 {
2146         if (!session) return -1;
2147         boost::shared_ptr<Stripable> s = get_strip (ssid, lo_message_get_source (msg));
2148
2149         if (s) {
2150                 if (s->pan_width_control()) {
2151                         s->pan_width_control()->set_value (pos, PBD::Controllable::NoGroup);
2152                         return 0;
2153                 }
2154         }
2155
2156         return route_send_fail ("pan_stereo_width", ssid, 1, lo_message_get_source (msg));
2157 }
2158
2159 int
2160 OSC::route_set_send_gain_abs (int ssid, int sid, float val, lo_message msg)
2161 {
2162         if (!session) {
2163                 return -1;
2164         }
2165         boost::shared_ptr<Stripable> s = get_strip (ssid, lo_message_get_source (msg));
2166
2167         if (!s) {
2168                 return -1;
2169         }
2170
2171         /* revert to zero-based counting */
2172
2173         if (sid > 0) {
2174                 --sid;
2175         }
2176
2177         if (s->send_level_controllable (sid)) {
2178                 s->send_level_controllable (sid)->set_value (val, PBD::Controllable::NoGroup);
2179                 return 0;
2180         }
2181
2182         return -1;
2183 }
2184
2185 int
2186 OSC::route_set_send_gain_dB (int ssid, int sid, float val, lo_message msg)
2187 {
2188         return route_set_send_gain_abs (ssid, sid, dB_to_coefficient (val), msg);
2189 }
2190
2191 int
2192 OSC::route_set_send_fader (int ssid, int sid, float pos, lo_message msg)
2193 {
2194         if (!session) {
2195                 return -1;
2196         }
2197         if ((pos > 799.5) && (pos < 800.5)) {
2198                 return route_set_send_gain_abs (ssid, sid, 1.0, msg);
2199         } else {
2200                 return route_set_send_gain_abs (ssid, sid, slider_position_to_gain_with_max ((pos/1023), 2.0), msg);
2201         }
2202 }
2203
2204 int
2205 OSC::sel_sendgain (int id, float val, lo_message msg)
2206 {
2207         OSCSurface *sur = get_surface(lo_message_get_source (msg));
2208         int ret;
2209         if (sur->surface_sel) {
2210                 ret = route_set_send_gain_dB(sur->surface_sel, id, val, msg);
2211         }
2212         if (!ret) {
2213                 return ret;
2214         }
2215         return sel_send_fail ("send_gain", id, -193, lo_message_get_source (msg));
2216 }
2217
2218 int
2219 OSC::sel_sendfader (int id, float val, lo_message msg)
2220 {
2221         OSCSurface *sur = get_surface(lo_message_get_source (msg));
2222         int ret;
2223         if (sur->surface_sel) {
2224                 ret = route_set_send_fader(sur->surface_sel, id, val, msg);
2225         }
2226         if (!ret) {
2227                 return ret;
2228         }
2229         return sel_send_fail ("send_gain", id, 0, lo_message_get_source (msg));
2230
2231 }
2232
2233 int
2234 OSC::route_set_send_enable (int ssid, int sid, float val, lo_message msg)
2235 {
2236         if (!session) {
2237                 return -1;
2238         }
2239         boost::shared_ptr<Stripable> s = get_strip (ssid, lo_message_get_source (msg));
2240
2241         if (s) {
2242
2243                 /* revert to zero-based counting */
2244
2245                 if (sid > 0) {
2246                         --sid;
2247                 }
2248
2249                 if (s->send_enable_controllable (sid)) {
2250                         s->send_enable_controllable (sid)->set_value (val, PBD::Controllable::NoGroup);
2251                         return 0;
2252                 }
2253
2254                 if (s->send_level_controllable (sid)) {
2255                         return 1;
2256                 }
2257
2258         }
2259
2260         return -1;
2261 }
2262
2263 int
2264 OSC::sel_sendenable (int id, float val, lo_message msg)
2265 {
2266         OSCSurface *sur = get_surface(lo_message_get_source (msg));
2267         int ret;
2268         if (sur->surface_sel) {
2269                 ret = route_set_send_enable(sur->surface_sel, id, val, msg);
2270         }
2271         switch (ret) {
2272                 case 0:
2273                         return ret;
2274                 case 1:
2275                         return sel_send_fail ("send_enable", id, 1, lo_message_get_source (msg));
2276                 default:
2277                         sel_send_fail ("send_enable", id, 0, lo_message_get_source (msg));
2278                         return -1;
2279         }
2280         return -1;
2281
2282
2283 }
2284
2285 int
2286 OSC::route_plugin_parameter (int ssid, int piid, int par, float val, lo_message msg)
2287 {
2288         if (!session)
2289                 return -1;
2290         boost::shared_ptr<Stripable> s = get_strip (ssid, lo_message_get_source (msg));
2291
2292         boost::shared_ptr<Route> r = boost::dynamic_pointer_cast<Route> (s);
2293
2294         if (!r) {
2295                 PBD::error << "OSC: Invalid Remote Control ID '" << ssid << "'" << endmsg;
2296                 return -1;
2297         }
2298
2299         boost::shared_ptr<Processor> redi=r->nth_plugin (piid);
2300
2301         if (!redi) {
2302                 PBD::error << "OSC: cannot find plugin # " << piid << " for RID '" << ssid << "'" << endmsg;
2303                 return -1;
2304         }
2305
2306         boost::shared_ptr<PluginInsert> pi;
2307
2308         if (!(pi = boost::dynamic_pointer_cast<PluginInsert>(redi))) {
2309                 PBD::error << "OSC: given processor # " << piid << " on RID '" << ssid << "' is not a Plugin." << endmsg;
2310                 return -1;
2311         }
2312
2313         boost::shared_ptr<ARDOUR::Plugin> pip = pi->plugin();
2314         bool ok=false;
2315
2316         uint32_t controlid = pip->nth_parameter (par,ok);
2317
2318         if (!ok) {
2319                 PBD::error << "OSC: Cannot find parameter # " << par <<  " for plugin # " << piid << " on RID '" << ssid << "'" << endmsg;
2320                 return -1;
2321         }
2322
2323         if (!pip->parameter_is_input(controlid)) {
2324                 PBD::error << "OSC: Parameter # " << par <<  " for plugin # " << piid << " on RID '" << ssid << "' is not a control input" << endmsg;
2325                 return -1;
2326         }
2327
2328         ParameterDescriptor pd;
2329         pi->plugin()->get_parameter_descriptor (controlid,pd);
2330
2331         if (val >= pd.lower && val <= pd.upper) {
2332
2333                 boost::shared_ptr<AutomationControl> c = pi->automation_control (Evoral::Parameter(PluginAutomation, 0, controlid));
2334                 // cerr << "parameter:" << redi->describe_parameter(controlid) << " val:" << val << "\n";
2335                 c->set_value (val, PBD::Controllable::NoGroup);
2336         } else {
2337                 PBD::warning << "OSC: Parameter # " << par <<  " for plugin # " << piid << " on RID '" << ssid << "' is out of range" << endmsg;
2338                 PBD::info << "OSC: Valid range min=" << pd.lower << " max=" << pd.upper << endmsg;
2339         }
2340
2341         return 0;
2342 }
2343
2344 //prints to cerr only
2345 int
2346 OSC::route_plugin_parameter_print (int ssid, int piid, int par, lo_message msg)
2347 {
2348         if (!session) {
2349                 return -1;
2350         }
2351         boost::shared_ptr<Stripable> s = get_strip (ssid, lo_message_get_source (msg));
2352
2353         boost::shared_ptr<Route> r = boost::dynamic_pointer_cast<Route> (s);
2354
2355         if (!r) {
2356                 return -1;
2357         }
2358
2359         boost::shared_ptr<Processor> redi=r->nth_processor (piid);
2360
2361         if (!redi) {
2362                 return -1;
2363         }
2364
2365         boost::shared_ptr<PluginInsert> pi;
2366
2367         if (!(pi = boost::dynamic_pointer_cast<PluginInsert>(redi))) {
2368                 return -1;
2369         }
2370
2371         boost::shared_ptr<ARDOUR::Plugin> pip = pi->plugin();
2372         bool ok=false;
2373
2374         uint32_t controlid = pip->nth_parameter (par,ok);
2375
2376         if (!ok) {
2377                 return -1;
2378         }
2379
2380         ParameterDescriptor pd;
2381
2382         if (pi->plugin()->get_parameter_descriptor (controlid, pd) == 0) {
2383                 boost::shared_ptr<AutomationControl> c = pi->automation_control (Evoral::Parameter(PluginAutomation, 0, controlid));
2384
2385                 cerr << "parameter:     " << redi->describe_parameter(controlid)  << "\n";
2386                 cerr << "current value: " << c->get_value ();
2387                 cerr << "lower value:   " << pd.lower << "\n";
2388                 cerr << "upper value:   " << pd.upper << "\n";
2389         }
2390
2391         return 0;
2392 }
2393
2394 void
2395 OSC::gui_selection_changed (StripableNotificationListPtr stripables)
2396 {
2397         boost::shared_ptr<Stripable> strip;
2398
2399         if (!stripables->empty()) {
2400                 strip = stripables->front().lock();
2401         }
2402         if (strip) {
2403                 for (uint32_t it = 0; it < _surface.size(); ++it) {
2404                         OSCSurface* sur = &_surface[it];
2405                         if(!sur->feedback[10]) {
2406                                 lo_address addr = lo_address_new_from_url (sur->remote_url.c_str());
2407                                 uint32_t sel_strip = get_sid (strip, addr);
2408                                 _strip_select (sel_strip, addr);
2409                         }
2410                 }
2411         }
2412
2413 }
2414
2415 // timer callbacks
2416 bool
2417 OSC::periodic (void)
2418 {
2419         if (!tick) {
2420                 Glib::usleep(100); // let flurry of signals subside
2421                 if (bank_dirty) {
2422                         _recalcbanks ();
2423                         bank_dirty = false;
2424                         tick = true;
2425                 }
2426         }
2427
2428         for (GlobalObservers::iterator x = global_observers.begin(); x != global_observers.end(); x++) {
2429
2430                 OSCGlobalObserver* go;
2431
2432                 if ((go = dynamic_cast<OSCGlobalObserver*>(*x)) != 0) {
2433                         go->tick();
2434                 }
2435         }
2436         for (RouteObservers::iterator x = route_observers.begin(); x != route_observers.end(); x++) {
2437
2438                 OSCRouteObserver* ro;
2439
2440                 if ((ro = dynamic_cast<OSCRouteObserver*>(*x)) != 0) {
2441                         ro->tick();
2442                 }
2443         }
2444         for (uint32_t it = 0; it < _surface.size(); it++) {
2445                 OSCSurface* sur = &_surface[it];
2446                 OSCSelectObserver* so;
2447                 if ((so = dynamic_cast<OSCSelectObserver*>(sur->sel_obs)) != 0) {
2448                         so->tick();
2449                 }
2450         }
2451         return true;
2452 }
2453
2454 int
2455 OSC::route_send_fail (string path, uint32_t ssid, float val, lo_address addr)
2456 {
2457         OSCSurface *sur = get_surface(addr);
2458
2459         ostringstream os;
2460         lo_message reply;
2461         if (ssid) {
2462                 reply = lo_message_new ();
2463                 if (sur->feedback[2]) {
2464                         os << "/strip/" << path << "/" << ssid;
2465                 } else {
2466                         os << "/strip/" << path;
2467                         lo_message_add_int32 (reply, ssid);
2468                 }
2469                 string str_pth = os.str();
2470                 lo_message_add_float (reply, (float) val);
2471
2472                 lo_send_message (addr, str_pth.c_str(), reply);
2473                 lo_message_free (reply);
2474         }
2475         if (sur->surface_sel == ssid) {
2476                 os.str("");
2477                 os << "/select/" << path;
2478                 string sel_pth = os.str();
2479                 reply = lo_message_new ();
2480                 lo_message_add_float (reply, (float) val);
2481                 lo_send_message (addr, sel_pth.c_str(), reply);
2482                 lo_message_free (reply);
2483         }
2484
2485         return 0;
2486 }
2487
2488 int
2489 OSC::sel_send_fail (string path, uint32_t id, float val, lo_address addr)
2490 {
2491         OSCSurface *sur = get_surface(addr);
2492
2493         ostringstream os;
2494         lo_message reply;
2495         reply = lo_message_new ();
2496         if (sur->feedback[2]) {
2497                 os << "/select/" << path << "/" << id;
2498         } else {
2499                 os << "/select/" << path;
2500                 lo_message_add_int32 (reply, id);
2501         }
2502         string str_pth = os.str();
2503         lo_message_add_float (reply, (float) val);
2504
2505         lo_send_message (addr, str_pth.c_str(), reply);
2506         lo_message_free (reply);
2507
2508         return 0;
2509 }
2510
2511 XMLNode&
2512 OSC::get_state ()
2513 {
2514         XMLNode& node (ControlProtocol::get_state());
2515         node.add_property("debugmode", (int) _debugmode); // TODO: enum2str
2516         return node;
2517 }
2518
2519 int
2520 OSC::set_state (const XMLNode& node, int version)
2521 {
2522         if (ControlProtocol::set_state (node, version)) {
2523                 return -1;
2524         }
2525         XMLProperty const * p = node.property (X_("debugmode"));
2526         if (p) {
2527                 _debugmode = OSCDebugMode (PBD::atoi(p->value ()));
2528         }
2529
2530         return 0;
2531 }
2532
2533 // predicate for sort call in get_sorted_stripables
2534 struct StripableByPresentationOrder
2535 {
2536         bool operator () (const boost::shared_ptr<Stripable> & a, const boost::shared_ptr<Stripable> & b) const
2537         {
2538                 return a->presentation_info().order() < b->presentation_info().order();
2539         }
2540
2541         bool operator () (const Stripable & a, const Stripable & b) const
2542         {
2543                 return a.presentation_info().order() < b.presentation_info().order();
2544         }
2545
2546         bool operator () (const Stripable * a, const Stripable * b) const
2547         {
2548                 return a->presentation_info().order() < b->presentation_info().order();
2549         }
2550 };
2551
2552 OSC::Sorted
2553 OSC::get_sorted_stripables(std::bitset<32> types)
2554 {
2555         Sorted sorted;
2556
2557         // fetch all stripables
2558         StripableList stripables;
2559
2560         session->get_stripables (stripables);
2561
2562         // Look for stripables that match bit in sur->strip_types
2563         for (StripableList::iterator it = stripables.begin(); it != stripables.end(); ++it) {
2564
2565                 boost::shared_ptr<Stripable> s = *it;
2566                 if ((!types[9]) && (s->presentation_info().flags() & PresentationInfo::Flag::Hidden)) {
2567                         // do nothing... skip it
2568                 } else {
2569
2570                         if (types[0] && (s->presentation_info().flags() & PresentationInfo::Flag::AudioTrack)) {
2571                                 sorted.push_back (s);
2572                         } else
2573                         if (types[1] && (s->presentation_info().flags() & PresentationInfo::Flag::MidiTrack)) {
2574                                 sorted.push_back (s);
2575                         } else
2576                         if (types[2] && (s->presentation_info().flags() & PresentationInfo::Flag::AudioBus)) {
2577                                 sorted.push_back (s);
2578                         } else
2579                         if (types[3] && (s->presentation_info().flags() & PresentationInfo::Flag::MidiBus)) {
2580                                 sorted.push_back (s);
2581                         } else
2582                         if (types[4] && (s->presentation_info().flags() & PresentationInfo::Flag::VCA)) {
2583                                 sorted.push_back (s);
2584                         } else
2585                         if (types[5] && (s->presentation_info().flags() & PresentationInfo::Flag::MasterOut)) {
2586                                 sorted.push_back (s);
2587                         } else
2588                         if (types[6] && (s->presentation_info().flags() & PresentationInfo::Flag::MonitorOut)) {
2589                                 sorted.push_back (s);
2590                         } else
2591                         if (types[8] && (s->presentation_info().flags() & PresentationInfo::Flag::Selected)) {
2592                                 sorted.push_back (s);
2593                         } else
2594                         if (types[9] && (s->presentation_info().flags() & PresentationInfo::Flag::Hidden)) {
2595                                 sorted.push_back (s);
2596                         }
2597                 }
2598         }
2599         sort (sorted.begin(), sorted.end(), StripableByPresentationOrder());
2600         return sorted;
2601 }
2602