OSC: Feedback was not making it to surface
[ardour.git] / libs / surfaces / osc / osc.h
1 /*
2  * Copyright (C) 2006-2009 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 #ifndef ardour_osc_h
21 #define ardour_osc_h
22
23 #include <string>
24 #include <vector>
25 #include <bitset>
26
27 #include <sys/time.h>
28 #include <pthread.h>
29
30 #include <boost/shared_ptr.hpp>
31
32 #include <lo/lo.h>
33
34 #include <glibmm/main.h>
35
36 #define ABSTRACT_UI_EXPORTS
37 #include "pbd/abstract_ui.h"
38
39 #include "ardour/types.h"
40 #include "ardour/send.h"
41 #include "ardour/plugin.h"
42 #include "control_protocol/control_protocol.h"
43
44 #include "pbd/i18n.h"
45
46 class OSCControllable;
47 class OSCRouteObserver;
48 class OSCGlobalObserver;
49 class OSCSelectObserver;
50 class OSCCueObserver;
51
52 namespace ARDOUR {
53 class Session;
54 class Route;
55 }
56
57 /* this is mostly a placeholder because I suspect that at some
58    point we will want to add more members to accomodate
59    certain types of requests to the OSC UI
60 */
61
62 namespace ArdourSurface {
63
64 struct OSCUIRequest : public BaseUI::BaseRequestObject {
65   public:
66         OSCUIRequest () {}
67         ~OSCUIRequest() {}
68 };
69
70 class OSC : public ARDOUR::ControlProtocol, public AbstractUI<OSCUIRequest>
71 {
72   public:
73         OSC (ARDOUR::Session&, uint32_t port);
74         virtual ~OSC();
75
76         static OSC* instance() { return _instance; }
77
78         XMLNode& get_state ();
79         int set_state (const XMLNode&, int version);
80
81         void stripable_selection_changed () {}
82
83         bool has_editor () const { return true; }
84         void* get_gui () const;
85         void  tear_down_gui ();
86
87         int set_active (bool yn);
88         bool get_active () const;
89
90         // generic osc send
91         Glib::Threads::Mutex _lo_lock;
92         int float_message (std::string, float value, lo_address addr);
93         int int_message (std::string, int value, lo_address addr);
94         int text_message (std::string path, std::string val, lo_address addr);
95         int float_message_with_id (std::string, uint32_t ssid, float value, bool in_line, lo_address addr);
96         int int_message_with_id (std::string, uint32_t ssid, int value, bool in_line, lo_address addr);
97         int text_message_with_id (std::string path, uint32_t ssid, std::string val, bool in_line, lo_address addr);
98
99         int send_group_list (lo_address addr);
100
101         int start ();
102         int stop ();
103
104         static void* request_factory (uint32_t);
105
106         enum OSCDebugMode {
107                 Off,
108                 Unhandled,
109                 All
110         };
111
112         enum OSCTempMode {
113                 TempOff = 0,
114                 GroupOnly = 1,
115                 VCAOnly = 2,
116                 BusOnly = 3
117         };
118
119         typedef std::vector<boost::shared_ptr<ARDOUR::Stripable> > Sorted;
120         Sorted get_sorted_stripables(std::bitset<32> types, bool cue, uint32_t custom, Sorted my_list);
121         typedef std::map<boost::shared_ptr<ARDOUR::AutomationControl>, uint32_t> FakeTouchMap;
122         FakeTouchMap _touch_timeout;
123
124 // keep a surface's global setup by remote server url
125         struct OSCSurface {
126         public:
127                 //global
128                 std::string remote_url;         // the url these setting belong to
129                 bool no_clear;                          // don't send osc clear messages on strip change
130                 uint32_t jogmode;                       // current jogmode
131                 OSCGlobalObserver* global_obs;  // pointer to this surface's global observer
132                 uint32_t nstrips;                       // how many strips are there for strip_types
133                 std::bitset<32> feedback;       // What is fed back? strips/meters/timecode/bar_beat/global
134                 int gainmode;                           // what kind of faders do we have Gain db or position 0 to 1?
135                 PBD::Controllable::GroupControlDisposition usegroup;    // current group disposition
136                 Sorted custom_strips;           // a sorted list of user selected strips
137                 uint32_t custom_mode;           // use custom strip list
138                 OSCTempMode temp_mode;          // use temp strip list
139                 Sorted temp_strips;                     // temp strip list for grouponly, vcaonly, auxonly
140                 Sorted strips;                          // list of stripables for this surface
141                 // strips
142                 uint32_t bank;                          // current bank
143                 uint32_t bank_size;                     // size of banks for this surface
144                 std::vector<OSCRouteObserver*> observers;       // route observers for this surface
145                 std::bitset<32> strip_types;// what strip types are a part of this bank
146                 //select
147                 OSCSelectObserver* sel_obs;     // So we can sync select feedback with selected channel
148                 uint32_t expand;                        // Used by /select/select
149                 bool expand_enable;                     // use expand instead of select
150                 boost::shared_ptr<ARDOUR::Stripable> expand_strip; // stripable this surface uses for expand
151                 boost::shared_ptr<ARDOUR::Stripable> select; // stripable this surface uses as selected
152                 int plug_page;                          // current plugin page
153                 uint32_t plug_page_size;        // plugin page size (number of controls)
154                 int plugin_id;                  // id of current plugin
155                 std::vector<int> plug_params; // vector to store ports that are controls
156                 std::vector<int> plugins;       // stores allowable plugins with index (work around MB strip PIs)
157                 int send_page;                          // current send page
158                 uint32_t send_page_size;        // send page size in channels
159                 uint32_t nsends;                        // number of sends select has
160                 PBD::ScopedConnection proc_connection; // for processor signal monitoring
161                 // cue
162                 bool cue;                                       // is this a cue surface
163                 uint32_t aux;                           // aux index for this cue surface
164                 Sorted sends;                           // list of sends for cue aux
165                 OSCCueObserver* cue_obs;        // pointer to this surface's cue observer
166                 uint32_t linkset;                       // ID of a set of surfaces used as one
167                 uint32_t linkid;                        // ID of this surface within a linkset
168         };
169                 /*
170                  * feedback bits:
171                  * [0] - Strips - buttons
172                  * [1] - Strips - variables (pots/faders)
173                  * [2] - Strips - Send SSID as path extension
174                  * [3] - Send heart beat to surface
175                  * [4] - Send feedback for master/global buttons/variables
176                  * [5] - Send Bar and Beat
177                  * [6] - Send Time code
178                  * [7] - Send metering as dB or positional depending on gainmode
179                  * [8] - Send metering as 16 bits (led strip)
180                  * [9] - Send signal present (signal greater than -20dB)
181                  * [10] - Send Playhead position as samples
182                  * [11] - Send Playhead position as minutes seconds
183                  * [12] - Send Playhead position like primary/secondary GUI clocks
184                  * [13] - Send well known feedback (for /select/command
185                  * [14] - use OSC 1.0 only (#reply -> /reply)
186                  *
187                  * Strip_type bits:
188                  * [0] - Audio Tracks
189                  * [1] - Midi Tracks
190                  * [2] - Audio Bus
191                  * [3] - Midi Bus
192                  * [4] - VCAs
193                  * [5] - master
194                  * [6] - Monitor
195                  * [7] - Aux Bus
196                  * [8] - Selected
197                  * [9] - Hidden
198                  * [10] - Use Groups
199                  * [11] - Global Expand
200                  */
201
202 // storage for  each surface's settings
203         mutable Glib::Threads::Mutex surfaces_lock;
204         typedef std::vector<OSCSurface> Surface;
205         Surface _surface;
206
207 // linked surfaces
208         struct LinkSet {
209         public:
210                 std::vector<std::string> urls;  //urls of linked surfaces
211                 uint32_t banksize;                              // linkset banksize
212                 uint32_t bank;                                  // linkset current bank
213                 bool autobank;                                  // banksize is derived from total
214                 uint32_t not_ready;                             // number of 1st device, 0 = ready
215                 Sorted custom_strips;                   // a sorted list of user selected strips
216                 uint32_t custom_mode;                   // use custom strip list
217                 OSCTempMode temp_mode;                  // use custom strip list
218                 Sorted temp_strips;                             // temp strip list for grouponly, vcaonly, auxonly
219                 std::bitset<32> strip_types;    // strip_types for this linkset
220                 Sorted strips;                                  // list of valid strips in order for this set
221         };
222
223         std::map<uint32_t, LinkSet> link_sets;
224          // list of linksets
225
226         struct PortAdd {
227         public:
228                 std::string host;
229                 std::string port;
230         };
231
232         std::vector<PortAdd> _ports;
233
234 // GUI calls
235         std::string get_server_url ();
236         void set_debug_mode (OSCDebugMode m) { _debugmode = m; }
237         OSCDebugMode get_debug_mode () { return _debugmode; }
238         int get_portmode() { return address_only; }
239         void set_portmode (int pm) { address_only = pm; }
240         int get_banksize () { return default_banksize; }
241         void set_banksize (int bs) {default_banksize = bs; }
242         int get_gainmode() { return default_gainmode; }
243         void set_gainmode (int gm) { default_gainmode = gm; }
244         int get_defaultstrip() { return default_strip; }
245         void set_defaultstrip (int st) { default_strip = st; }
246         int get_defaultfeedback() { return default_feedback; }
247         void set_defaultfeedback (int fb) { default_feedback = fb; }
248         int get_send_size() { return default_send_size; }
249         void set_send_size (int ss) { default_send_size = ss; }
250         int get_plugin_size() { return default_plugin_size; }
251         void set_plugin_size (int ps) { default_plugin_size = ps; }
252         void clear_devices ();
253         void gui_changed ();
254         void get_surfaces ();
255         std::string get_remote_port () { return remote_port; }
256         void set_remote_port (std::string pt) { remote_port = pt; }
257
258   protected:
259         void thread_init ();
260         void do_request (OSCUIRequest*);
261
262         GSource* local_server;
263         GSource* remote_server;
264
265         bool osc_input_handler (Glib::IOCondition, lo_server);
266
267   private:
268         uint32_t _port;
269         volatile bool _ok;
270         volatile bool _shutdown;
271         lo_server _osc_server;
272         lo_server _osc_unix_server;
273         std::string _osc_unix_socket_path;
274         std::string _osc_url_file;
275         OSCDebugMode _debugmode;
276         bool address_only;
277         std::string remote_port;
278         uint32_t default_banksize;
279         uint32_t default_strip;
280         uint32_t default_feedback;
281         uint32_t default_gainmode;
282         uint32_t default_send_size;
283         uint32_t default_plugin_size;
284         bool tick;
285         bool bank_dirty;
286         bool observer_busy;
287         float scrub_speed;              // Current scrub speed
288         double scrub_place;             // place of play head at latest jog/scrub wheel tick
289         int64_t scrub_time;             // when did the wheel move last?
290         bool global_init;
291         boost::shared_ptr<ARDOUR::Stripable> _select;   // which stripable out of /surface/stripables is gui selected
292
293         void register_callbacks ();
294
295         void route_added (ARDOUR::RouteList&);
296
297         // Handlers for "Application Hook" signals
298         void session_loaded (ARDOUR::Session&);
299         void session_exported (std::string, std::string);
300
301         // end "Application Hook" handles
302
303         std::string get_unix_server_url ();
304         lo_address get_address (lo_message msg);
305         std::string get_port (std::string host);
306         OSCSurface * get_surface (lo_address addr, bool quiet = false);
307         int check_surface (lo_message msg);
308         uint32_t get_sid (boost::shared_ptr<ARDOUR::Stripable> strip, lo_address addr);
309         boost::shared_ptr<ARDOUR::Stripable> get_strip (uint32_t ssid, lo_address addr);
310         void global_feedback (OSCSurface* sur);
311         void strip_feedback (OSCSurface* sur, bool new_bank_size);
312         void surface_destroy (OSCSurface* sur);
313         uint32_t bank_limits_check (uint32_t bank, uint32_t size, uint32_t total);
314         void bank_leds (OSCSurface* sur);
315
316         void send_current_value (const char* path, lo_arg** argv, int argc, lo_message msg);
317         void current_value_query (const char* path, size_t len, lo_arg **argv, int argc, lo_message msg);
318
319         int current_value (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data);
320
321         int catchall (const char *path, const char *types, lo_arg **argv, int argc, void *data);
322         static int _catchall (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data);
323
324         int set_automation (const char *path, const char* types, lo_arg **argv, int argc, lo_message msg);
325         int touch_detect (const char *path, const char* types, lo_arg **argv, int argc, lo_message msg);
326         int fake_touch (boost::shared_ptr<ARDOUR::AutomationControl> ctrl);
327
328         int route_get_sends (lo_message msg);
329         int route_get_receives(lo_message msg);
330         void routes_list (lo_message msg);
331         int group_list (lo_message msg);
332         void surface_list (lo_message msg);
333         void transport_sample (lo_message msg);
334         void transport_speed (lo_message msg);
335         void record_enabled (lo_message msg);
336
337         // cue
338         Sorted cue_get_sorted_stripables(boost::shared_ptr<ARDOUR::Stripable> aux, uint32_t id, lo_message msg);
339         int cue_parse (const char *path, const char* types, lo_arg **argv, int argc, lo_message msg);
340         int cue_set (uint32_t aux, lo_message msg);
341         int _cue_set (uint32_t aux, lo_address addr);
342         int cue_next (lo_message msg);
343         int cue_previous (lo_message msg);
344         int cue_send_fader (uint32_t id, float position, lo_message msg);
345         int cue_send_enable (uint32_t id, float state, lo_message msg);
346         int cue_aux_fader (float position, lo_message msg);
347         int cue_aux_mute (float state, lo_message msg);
348         void cue_set_aux (uint32_t aux, lo_message msg);
349         boost::shared_ptr<ARDOUR::Send> cue_get_send (uint32_t id, lo_address addr);
350         // end cue
351
352         // link
353         LinkSet * get_linkset (uint32_t set, lo_address addr);
354         int parse_link (const char *path, const char* types, lo_arg **argv, int argc, lo_message msg);
355         int link_check (uint32_t linkset);
356         int set_link (uint32_t set, uint32_t id, lo_address addr);
357         void surface_link_state (LinkSet * set);
358         void link_strip_types (uint32_t linkset, uint32_t striptypes);
359
360 #define OSC_DEBUG \
361         if (_debugmode == All) { \
362                 debugmsg (dgettext(PACKAGE, "OSC"), path, types, argv, argc); \
363         }
364
365 #define PATH_CALLBACK_MSG(name) \
366         static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
367                 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
368         } \
369         int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
370                 OSC_DEBUG; \
371                 if (argc > 0 && !strcmp (types, "f") && argv[0]->f != 1.0) { return 0; } \
372                 name (data); \
373                 return 0; \
374         }
375
376         PATH_CALLBACK_MSG(route_get_sends);
377         PATH_CALLBACK_MSG(route_get_receives);
378         PATH_CALLBACK_MSG(routes_list);
379         PATH_CALLBACK_MSG(group_list);
380         PATH_CALLBACK_MSG(sel_bus_only);
381         PATH_CALLBACK_MSG(sel_previous);
382         PATH_CALLBACK_MSG(sel_next);
383         PATH_CALLBACK_MSG(surface_list);
384         PATH_CALLBACK_MSG(transport_sample);
385         PATH_CALLBACK_MSG(transport_speed);
386         PATH_CALLBACK_MSG(record_enabled);
387         PATH_CALLBACK_MSG(refresh_surface);
388         PATH_CALLBACK_MSG(bank_up);
389         PATH_CALLBACK_MSG(bank_down);
390         PATH_CALLBACK_MSG(master_select);
391         PATH_CALLBACK_MSG(custom_clear);
392
393 #define PATH_CALLBACK(name) \
394         static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
395                 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
396         } \
397         int cb_ ## name (const char *path, const char *types, lo_arg ** argv, int argc, void *data) { \
398                 OSC_DEBUG; \
399                 check_surface (data); \
400                 if (argc > 0 && !strcmp (types, "f") && argv[0]->f != 1.0) { return 0; } \
401                 name (); \
402                 return 0; \
403         }
404
405         PATH_CALLBACK(add_marker);
406         PATH_CALLBACK(loop_toggle);
407         PATH_CALLBACK(goto_start);
408         PATH_CALLBACK(goto_end);
409         PATH_CALLBACK(rewind);
410         PATH_CALLBACK(ffwd);
411         PATH_CALLBACK(transport_stop);
412         PATH_CALLBACK(transport_play);
413         PATH_CALLBACK(save_state);
414         PATH_CALLBACK(prev_marker);
415         PATH_CALLBACK(next_marker);
416         PATH_CALLBACK(undo);
417         PATH_CALLBACK(redo);
418         PATH_CALLBACK(toggle_punch_in);
419         PATH_CALLBACK(toggle_punch_out);
420         PATH_CALLBACK(rec_enable_toggle);
421         PATH_CALLBACK(toggle_all_rec_enables);
422         PATH_CALLBACK(all_tracks_rec_in);
423         PATH_CALLBACK(all_tracks_rec_out);
424         PATH_CALLBACK(cancel_all_solos);
425         PATH_CALLBACK(remove_marker_at_playhead);
426         PATH_CALLBACK(mark_in);
427         PATH_CALLBACK(mark_out);
428         PATH_CALLBACK(toggle_click);
429         PATH_CALLBACK(midi_panic);
430         PATH_CALLBACK(toggle_roll);
431         PATH_CALLBACK(stop_forget);
432         PATH_CALLBACK(set_punch_range);
433         PATH_CALLBACK(set_loop_range);
434         PATH_CALLBACK(set_session_range);
435         PATH_CALLBACK(toggle_monitor_mute);
436         PATH_CALLBACK(toggle_monitor_dim);
437         PATH_CALLBACK(toggle_monitor_mono);
438         PATH_CALLBACK(quick_snapshot_stay);
439         PATH_CALLBACK(quick_snapshot_switch);
440         PATH_CALLBACK(fit_1_track);
441         PATH_CALLBACK(fit_2_tracks);
442         PATH_CALLBACK(fit_4_tracks);
443         PATH_CALLBACK(fit_8_tracks);
444         PATH_CALLBACK(fit_16_tracks);
445         PATH_CALLBACK(fit_32_tracks);
446         PATH_CALLBACK(fit_all_tracks);
447         PATH_CALLBACK(zoom_100_ms);
448         PATH_CALLBACK(zoom_1_sec);
449         PATH_CALLBACK(zoom_10_sec);
450         PATH_CALLBACK(zoom_1_min);
451         PATH_CALLBACK(zoom_5_min);
452         PATH_CALLBACK(zoom_10_min);
453         PATH_CALLBACK(zoom_to_session);
454         PATH_CALLBACK(temporal_zoom_in);
455         PATH_CALLBACK(temporal_zoom_out);
456         PATH_CALLBACK(scroll_up_1_track);
457         PATH_CALLBACK(scroll_dn_1_track);
458         PATH_CALLBACK(scroll_up_1_page);
459         PATH_CALLBACK(scroll_dn_1_page);
460
461 #define PATH_CALLBACK1(name,type,optional) \
462         static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
463                 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
464         } \
465         int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
466                 OSC_DEBUG; \
467                 check_surface (data); \
468                 if (argc > 0) { \
469                         name (optional argv[0]->type); \
470                 } \
471                 return 0; \
472         }
473
474         PATH_CALLBACK1(set_transport_speed,f,);
475         PATH_CALLBACK1(access_action,s,&);
476
477         PATH_CALLBACK1(jump_by_bars,f,);
478         PATH_CALLBACK1(jump_by_seconds,f,);
479         PATH_CALLBACK1(master_set_gain,f,);
480         PATH_CALLBACK1(master_set_fader,f,);
481         PATH_CALLBACK1(master_delta_gain,f,);
482         PATH_CALLBACK1(master_set_trim,f,);
483         PATH_CALLBACK1(master_set_mute,i,);
484         PATH_CALLBACK1(monitor_set_gain,f,);
485         PATH_CALLBACK1(monitor_set_fader,f,);
486         PATH_CALLBACK1(monitor_delta_gain,f,);
487         PATH_CALLBACK1(monitor_set_mute,i,);
488         PATH_CALLBACK1(monitor_set_dim,i,);
489         PATH_CALLBACK1(monitor_set_mono,i,);
490         PATH_CALLBACK1(click_level,f,);
491
492 #define PATH_CALLBACK1_MSG(name,arg1type) \
493         static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
494                 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
495         } \
496         int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
497                 OSC_DEBUG; \
498                 if (argc > 0) { \
499                         name (argv[0]->arg1type, data); \
500                 } \
501                 return 0; \
502         }
503
504 #define PATH_CALLBACK1_MSG_s(name,arg1type) \
505         static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
506                 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
507         } \
508         int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
509                 OSC_DEBUG; \
510                 if (argc > 0) { \
511                         name (&argv[0]->arg1type, data); \
512                 } \
513                 return 0; \
514         }
515
516         // pan position needs message info to send feedback
517         PATH_CALLBACK1_MSG(master_set_pan_stereo_position,f);
518
519         PATH_CALLBACK1_MSG(scrub,f);
520         PATH_CALLBACK1_MSG(jog,f);
521         PATH_CALLBACK1_MSG(jog_mode,f);
522         PATH_CALLBACK1_MSG(bank_delta,f);
523         PATH_CALLBACK1_MSG(use_group,f);
524         PATH_CALLBACK1_MSG_s(name_session,s);
525         PATH_CALLBACK1_MSG_s(sel_rename,s);
526         PATH_CALLBACK1_MSG_s(sel_comment,s);
527         PATH_CALLBACK1_MSG(sel_recenable,i);
528         PATH_CALLBACK1_MSG(sel_recsafe,i);
529         PATH_CALLBACK1_MSG(sel_mute,i);
530         PATH_CALLBACK1_MSG(sel_master_send_enable,i);
531         PATH_CALLBACK1_MSG(sel_solo,i);
532         PATH_CALLBACK1_MSG(sel_solo_iso,i);
533         PATH_CALLBACK1_MSG(sel_solo_safe,i);
534         PATH_CALLBACK1_MSG(sel_monitor_input,i);
535         PATH_CALLBACK1_MSG(sel_monitor_disk,i);
536         PATH_CALLBACK1_MSG(sel_phase,i);
537         PATH_CALLBACK1_MSG(sel_gain,f);
538         PATH_CALLBACK1_MSG(sel_fader,f);
539         PATH_CALLBACK1_MSG(sel_dB_delta,f);
540         PATH_CALLBACK1_MSG(sel_trim,f);
541         PATH_CALLBACK1_MSG(sel_hide,i);
542         PATH_CALLBACK1_MSG(sel_pan_position,f);
543         PATH_CALLBACK1_MSG(sel_pan_width,f);
544         PATH_CALLBACK1_MSG(sel_pan_elevation,f);
545         PATH_CALLBACK1_MSG(sel_pan_frontback,f);
546         PATH_CALLBACK1_MSG(sel_pan_lfe,f);
547         PATH_CALLBACK1_MSG(sel_send_page,f);
548         PATH_CALLBACK1_MSG(sel_plug_page,f);
549         PATH_CALLBACK1_MSG(sel_plugin,f);
550         PATH_CALLBACK1_MSG(sel_plugin_activate,f);
551         PATH_CALLBACK1_MSG(sel_comp_enable,f);
552         PATH_CALLBACK1_MSG(sel_comp_threshold,f);
553         PATH_CALLBACK1_MSG(sel_comp_speed,f);
554         PATH_CALLBACK1_MSG(sel_comp_mode,f);
555         PATH_CALLBACK1_MSG(sel_comp_makeup,f);
556         PATH_CALLBACK1_MSG(sel_eq_enable,f);
557         PATH_CALLBACK1_MSG(sel_eq_hpf_freq,f);
558         PATH_CALLBACK1_MSG(sel_eq_hpf_enable,f);
559         PATH_CALLBACK1_MSG(sel_eq_hpf_slope,f);
560         PATH_CALLBACK1_MSG(sel_eq_lpf_freq,f);
561         PATH_CALLBACK1_MSG(sel_eq_lpf_enable,f);
562         PATH_CALLBACK1_MSG(sel_eq_lpf_slope,f);
563         PATH_CALLBACK1_MSG(sel_expand,i);
564         PATH_CALLBACK1_MSG(custom_mode,f);
565
566 #define PATH_CALLBACK2(name,arg1type,arg2type) \
567         static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
568                 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
569         } \
570         int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
571                 OSC_DEBUG; \
572                 check_surface (data); \
573                 if (argc > 1) { \
574                         name (argv[0]->arg1type, argv[1]->arg2type); \
575                 } \
576                 return 0; \
577         }
578
579 #define PATH_CALLBACK2_MSG(name,arg1type,arg2type) \
580         static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
581                 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
582         } \
583         int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
584                 OSC_DEBUG; \
585                 if (argc > 1) { \
586                         name (argv[0]->arg1type, argv[1]->arg2type, data); \
587                 } \
588                 return 0; \
589         }
590
591 #define PATH_CALLBACK2_MSG_s(name,arg1type,arg2type) \
592         static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
593                 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
594         } \
595         int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
596                 OSC_DEBUG; \
597                 if (argc > 1) { \
598                         name (argv[0]->arg1type, &argv[1]->arg2type, data); \
599                 } \
600                 return 0; \
601         }
602
603 #define PATH_CALLBACK3(name,arg1type,arg2type,arg3type) \
604         static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
605                 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
606         } \
607         int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
608                 OSC_DEBUG; \
609                 if (argc > 1) { \
610                         name (argv[0]->arg1type, argv[1]->arg2type,argv[2]->arg3type, data); \
611                 } \
612                 return 0; \
613         }
614
615 #define PATH_CALLBACK4(name,arg1type,arg2type,arg3type,arg4type) \
616         static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
617                 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
618         } \
619         int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
620                 OSC_DEBUG; \
621                 if (argc > 1) { \
622                         name (argv[0]->arg1type, argv[1]->arg2type,argv[2]->arg3type,argv[3]->arg4type, data); \
623                 } \
624                 return 0; \
625         }
626
627         PATH_CALLBACK2_MSG(sel_sendgain,i,f);
628         PATH_CALLBACK2_MSG(sel_sendfader,i,f);
629         PATH_CALLBACK2_MSG(sel_sendenable,i,f);
630         PATH_CALLBACK2_MSG(sel_eq_gain,i,f);
631         PATH_CALLBACK2_MSG(sel_eq_freq,i,f);
632         PATH_CALLBACK2_MSG(sel_eq_q,i,f);
633         PATH_CALLBACK2_MSG(sel_eq_shape,i,f);
634
635         PATH_CALLBACK2(locate,i,i);
636         PATH_CALLBACK2(loop_location,i,i);
637         PATH_CALLBACK2_MSG_s(route_rename,i,s);
638         PATH_CALLBACK2_MSG_s(strip_group,i,s);
639         PATH_CALLBACK2_MSG(route_mute,i,i);
640         PATH_CALLBACK2_MSG(route_solo,i,i);
641         PATH_CALLBACK2_MSG(route_solo_iso,i,i);
642         PATH_CALLBACK2_MSG(route_solo_safe,i,i);
643         PATH_CALLBACK2_MSG(route_recenable,i,i);
644         PATH_CALLBACK2_MSG(route_recsafe,i,i);
645         PATH_CALLBACK2_MSG(route_monitor_input,i,i);
646         PATH_CALLBACK2_MSG(route_monitor_disk,i,i);
647         PATH_CALLBACK2_MSG(strip_phase,i,i);
648         PATH_CALLBACK2_MSG(strip_expand,i,i);
649         PATH_CALLBACK2_MSG(strip_hide,i,i);
650         PATH_CALLBACK2_MSG(strip_gui_select,i,i);
651         PATH_CALLBACK2_MSG(route_set_gain_dB,i,f);
652         PATH_CALLBACK2_MSG(route_set_gain_fader,i,f);
653         PATH_CALLBACK2_MSG(strip_db_delta,i,f);
654         PATH_CALLBACK2_MSG(route_set_trim_dB,i,f);
655         PATH_CALLBACK2_MSG(route_set_pan_stereo_position,i,f);
656         PATH_CALLBACK2_MSG(route_set_pan_stereo_width,i,f);
657         PATH_CALLBACK3(route_set_send_gain_dB,i,i,f);
658         PATH_CALLBACK3(route_set_send_fader,i,i,f);
659         PATH_CALLBACK3(route_set_send_enable,i,i,f);
660         PATH_CALLBACK4(route_plugin_parameter,i,i,i,f);
661         PATH_CALLBACK3(route_plugin_parameter_print,i,i,i);
662         PATH_CALLBACK2_MSG(route_plugin_activate,i,i);
663         PATH_CALLBACK2_MSG(route_plugin_deactivate,i,i);
664         PATH_CALLBACK1_MSG(route_plugin_list,i);
665         PATH_CALLBACK2_MSG(route_plugin_descriptor,i,i);
666         PATH_CALLBACK2_MSG(route_plugin_reset,i,i);
667
668         int route_rename (int rid, char *s, lo_message msg);
669         int strip_group (int ssid, char *g, lo_message msg);
670         int strip_select_group (boost::shared_ptr<ARDOUR::Stripable> s, char *g);
671         int route_mute (int rid, int yn, lo_message msg);
672         int route_solo (int rid, int yn, lo_message msg);
673         int route_solo_iso (int rid, int yn, lo_message msg);
674         int route_solo_safe (int rid, int yn, lo_message msg);
675         int route_recenable (int rid, int yn, lo_message msg);
676         int route_recsafe (int ssid, int yn, lo_message msg);
677         int route_monitor_input (int rid, int yn, lo_message msg);
678         int route_monitor_disk (int rid, int yn, lo_message msg);
679         int strip_phase (int rid, int yn, lo_message msg);
680         int strip_expand (int rid, int yn, lo_message msg);
681         int strip_hide (int ssid, int yn, lo_message msg);
682         int _strip_select (boost::shared_ptr<ARDOUR::Stripable> s, lo_address addr);
683         int strip_gui_select (int rid, int yn, lo_message msg);
684         int route_set_gain_dB (int rid, float dB, lo_message msg);
685         int route_set_gain_fader (int rid, float pos, lo_message msg);
686         int strip_db_delta (int ssid, float delta, lo_message msg);
687         int route_set_trim_abs (int rid, float level, lo_message msg);
688         int route_set_trim_dB (int rid, float dB, lo_message msg);
689         int route_set_pan_stereo_position (int rid, float left_right_fraction, lo_message msg);
690         int route_set_pan_stereo_width (int rid, float percent, lo_message msg);
691         int route_set_send_gain_dB (int rid, int sid, float val, lo_message msg);
692         int route_set_send_fader (int rid, int sid, float val, lo_message msg);
693         int route_set_send_enable (int rid, int sid, float val, lo_message msg);
694         int route_plugin_parameter (int rid, int piid,int par, float val, lo_message msg);
695         int route_plugin_parameter_print (int rid, int piid,int par, lo_message msg);
696         int route_plugin_activate (int rid, int piid, lo_message msg);
697         int route_plugin_deactivate (int rid, int piid, lo_message msg);
698         int route_plugin_list(int ssid, lo_message msg);
699         int route_plugin_descriptor(int ssid, int piid, lo_message msg);
700         int route_plugin_reset(int ssid, int piid, lo_message msg);
701
702         //banking functions
703         int set_bank (uint32_t bank_start, lo_message msg);
704         int _set_bank (uint32_t bank_start, lo_address addr);
705         int bank_up (lo_message msg);
706         int bank_delta (float delta, lo_message msg);
707         int use_group (float value, lo_message msg);
708         int bank_down (lo_message msg);
709         // surface set up
710         int surface_parse (const char *path, const char* types, lo_arg **argv, int argc, lo_message msg);
711         int set_surface (uint32_t b_size, uint32_t strips, uint32_t fb, uint32_t gmode, uint32_t se_size, uint32_t pi_size, lo_message msg);
712         int set_surface_bank_size (uint32_t bs, lo_message msg);
713         int set_surface_strip_types (uint32_t st, lo_message msg);
714         int set_surface_feedback (uint32_t fb, lo_message msg);
715         int set_surface_gainmode (uint32_t gm, lo_message msg);
716         int set_surface_port (uint32_t po, lo_message msg);
717         int refresh_surface (lo_message msg);
718         int custom_clear (lo_message msg);
719         int custom_mode (float state, lo_message msg);
720         int _custom_mode (uint32_t state, lo_address addr);
721         int name_session (char *n, lo_message msg);
722         // select
723         int sel_send_pagesize (uint32_t size, lo_message msg);
724         int sel_send_page (int page, lo_message msg);
725         int sel_plug_pagesize (uint32_t size, lo_message msg);
726         int sel_plug_page (int page, lo_message msg);
727         int sel_plugin (int delta, lo_message msg);
728         int _sel_plugin (int id, lo_address addr);
729         int sel_plugin_activate (float state, lo_message msg);
730         int select_plugin_parameter (const char *path, const char* types, lo_arg **argv, int argc, lo_message msg);
731         void processor_changed (std::string remote_url);
732
733         int scrub (float delta, lo_message msg);
734         int jog (float delta, lo_message msg);
735         int jog_mode (float mode, lo_message msg);
736         int set_marker (const char* types, lo_arg **argv, int argc, lo_message msg);
737         int click_level (float position);
738         int master_set_gain (float dB);
739         int master_set_fader (float position);
740         int master_delta_gain (float delta);
741         int master_set_trim (float dB);
742         int master_set_pan_stereo_position (float position, lo_message msg);
743         int master_set_mute (uint32_t state);
744         int master_select (lo_message msg);
745         int monitor_set_gain (float dB);
746         int monitor_set_fader (float position);
747         int monitor_delta_gain (float delta);
748         int monitor_set_mute (uint32_t state);
749         int monitor_set_dim (uint32_t state);
750         int monitor_set_mono (uint32_t state);
751         int sel_group (char *g, lo_message msg);
752         int sel_rename (char *n, lo_message msg);
753         int sel_comment (char *c, lo_message msg);
754         int sel_recenable (uint32_t state, lo_message msg);
755         int sel_recsafe (uint32_t state, lo_message msg);
756         int sel_mute (uint32_t state, lo_message msg);
757         int sel_solo (uint32_t state, lo_message msg);
758         int sel_solo_iso (uint32_t state, lo_message msg);
759         int sel_solo_safe (uint32_t state, lo_message msg);
760         int sel_monitor_input (uint32_t state, lo_message msg);
761         int sel_monitor_disk (uint32_t state, lo_message msg);
762         int sel_phase (uint32_t state, lo_message msg);
763         int sel_gain (float state, lo_message msg);
764         int sel_fader (float state, lo_message msg);
765         int sel_dB_delta (float delta, lo_message msg);
766         int sel_trim (float val, lo_message msg);
767         int sel_hide (uint32_t state, lo_message msg);
768         int sel_bus_only (lo_message msg);
769         int _sel_bus_only (lo_address addr);
770         int sel_previous (lo_message msg);
771         int sel_next (lo_message msg);
772         int sel_delta (int delta, lo_message msg);
773         boost::shared_ptr<ARDOUR::Send> get_send (boost::shared_ptr<ARDOUR::Stripable> st, lo_address addr);
774         int sel_pan_position (float val, lo_message msg);
775         int sel_pan_width (float val, lo_message msg);
776         int sel_sendgain (int id, float dB, lo_message msg);
777         int sel_sendfader (int id, float pos, lo_message msg);
778         int sel_sendenable (int id, float pos, lo_message msg);
779         int sel_master_send_enable (int state, lo_message msg);
780         int sel_expand (uint32_t state, lo_message msg);
781         int sel_pan_elevation (float val, lo_message msg);
782         int sel_pan_frontback (float val, lo_message msg);
783         int sel_pan_lfe (float val, lo_message msg);
784         int sel_comp_enable (float val, lo_message msg);
785         int sel_comp_threshold (float val, lo_message msg);
786         int sel_comp_speed (float val, lo_message msg);
787         int sel_comp_mode (float val, lo_message msg);
788         int sel_comp_makeup (float val, lo_message msg);
789         int sel_eq_enable (float val, lo_message msg);
790         int sel_eq_hpf_freq (float val, lo_message msg);
791         int sel_eq_hpf_enable (float val, lo_message msg);
792         int sel_eq_hpf_slope (float val, lo_message msg);
793         int sel_eq_lpf_freq (float val, lo_message msg);
794         int sel_eq_lpf_enable (float val, lo_message msg);
795         int sel_eq_lpf_slope (float val, lo_message msg);
796         int sel_eq_gain (int id, float val, lo_message msg);
797         int sel_eq_freq (int id, float val, lo_message msg);
798         int sel_eq_q (int id, float val, lo_message msg);
799         int sel_eq_shape (int id, float val, lo_message msg);
800         int parse_sel_group (const char *path, const char* types, lo_arg **argv, int argc, lo_message msg);
801         int parse_sel_vca (const char *path, const char* types, lo_arg **argv, int argc, lo_message msg);
802         boost::shared_ptr<ARDOUR::VCA> get_vca_by_name (std::string vname);
803
804         void listen_to_route (boost::shared_ptr<ARDOUR::Stripable>, lo_address);
805
806         void route_name_changed (const PBD::PropertyChange&, boost::weak_ptr<ARDOUR::Route> r, lo_address addr);
807         void recalcbanks ();
808         void _recalcbanks ();
809         void notify_routes_added (ARDOUR::RouteList &);
810         void notify_vca_added (ARDOUR::VCAList &);
811
812         int cancel_all_solos ();
813         bool periodic (void);
814         sigc::connection periodic_connection;
815         PBD::ScopedConnectionList session_connections;
816
817         void debugmsg (const char *prefix, const char *path, const char* types, lo_arg **argv, int argc);
818
819         static OSC* _instance;
820
821         mutable void *gui;
822         void build_gui ();
823 };
824
825 } // namespace
826
827 #endif // ardour_osc_h