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         int start ();
  91         int stop ();
  92
  93         static void* request_factory (uint32_t);
  94
  95         enum OSCDebugMode {
  96                 Off,
  97                 Unhandled,
  98                 All
  99         };
 100
 101         enum JogMode {
 102                 JOG,
 103                 NUDGE,
 104                 SCRUB,
 105                 SHUTTLE,
 106                 MARKER,
 107                 SCROLL,
 108                 TRACK,
 109                 BANK
 110         };
 111
 112         typedef std::vector<boost::shared_ptr<ARDOUR::Stripable> > Sorted;
 113         Sorted get_sorted_stripables(std::bitset<32> types, bool cue);
 114         typedef std::map<boost::shared_ptr<ARDOUR::AutomationControl>, uint32_t> FakeTouchMap;
 115         FakeTouchMap _touch_timeout;
 116
 117 // keep a surface's global setup by remote server url
 118         struct OSCSurface {
 119         public:
 120                 std::string remote_url;         // the url these setting belong to
 121                 bool no_clear;                          // don't send osc clear messages on strip change
 122                 JogMode jogmode;                        // current jogmode
 123                 uint32_t bank;                          // current bank
 124                 uint32_t bank_size;                     // size of banks for this surface
 125                 int plug_page;                          // current plugin page
 126                 uint32_t plug_page_size;        // plugin page size (number of controls)
 127                 int plugin_id;                  // id of current plugin
 128                 std::vector<int> plug_params; // vector to store ports that are controls
 129                 std::vector<int> plugins;       // stores allowable plugins with index (work around MB strip PIs)
 130                 int send_page;                          // current send page
 131                 uint32_t send_page_size;        // send page size in channels
 132                 PBD::ScopedConnection proc_connection; // for processor signal monitoring
 133                 std::bitset<32> strip_types;// what strip types are a part of this bank
 134                 uint32_t nstrips;                       // how many strips are there for strip_types
 135                 std::bitset<32> feedback;       // What is fed back? strips/meters/timecode/bar_beat/global
 136                 int gainmode;                           // what kind of faders do we have Gain db or position 0 to 1?
 137                 uint32_t expand;                        // Used by /select/select
 138                 bool expand_enable;                     // use expand instead of select
 139                 OSCSelectObserver* sel_obs;     // So we can sync select feedback with selected channel
 140                 Sorted strips;                          // list of stripables for this surface
 141                 bool cue;                                       // is this a cue surface
 142                 uint32_t aux;                           // aux index for this cue surface
 143                 Sorted sends;                           // list of sends for cue aux
 144         };
 145                 /*
 146                  * feedback bits:
 147                  * [0] - Strips - buttons
 148                  * [1] - Strips - variables (pots/faders)
 149                  * [2] - Strips - Send SSID as path extension
 150                  * [3] - Send heart beat to surface
 151                  * [4] - Send feedback for master/global buttons/variables
 152                  * [5] - Send Bar and Beat
 153                  * [6] - Send Time code
 154                  * [7] - Send metering as dB or positional depending on gainmode
 155                  * [8] - Send metering as 16 bits (led strip)
 156                  * [9] - Send signal present (signal greater than -20dB)
 157                  * [10] - Send Playhead position as samples
 158                  * [11] - Send Playhead position as minutes seconds
 159                  * [12] - Send Playhead position like primary/secondary GUI clocks
 160                  * [13] - Send well known feedback (for /select/command
 161                  * [14] - use OSC 1.0 only (#reply -> /reply)
 162                  */
 163
 164
 165 // storage for  each surface's settings
 166         typedef std::vector<OSCSurface> Surface;
 167         Surface _surface;
 168
 169         std::string get_server_url ();
 170         void set_debug_mode (OSCDebugMode m) { _debugmode = m; }
 171         OSCDebugMode get_debug_mode () { return _debugmode; }
 172         int get_portmode() { return address_only; }
 173         void set_portmode (int pm) { address_only = pm; }
 174         int get_banksize () { return default_banksize; }
 175         void set_banksize (int bs) {default_banksize = bs; }
 176         int get_gainmode() { return default_gainmode; }
 177         void set_gainmode (int gm) { default_gainmode = gm; }
 178         int get_defaultstrip() { return default_strip; }
 179         void set_defaultstrip (int st) { default_strip = st; }
 180         int get_defaultfeedback() { return default_feedback; }
 181         void set_defaultfeedback (int fb) { default_feedback = fb; }
 182         int get_send_size() { return default_send_size; }
 183         void set_send_size (int ss) { default_send_size = ss; }
 184         int get_plugin_size() { return default_plugin_size; }
 185         void set_plugin_size (int ps) { default_plugin_size = ps; }
 186         void clear_devices ();
 187         void gui_changed ();
 188         std::string get_remote_port () { return remote_port; }
 189         void set_remote_port (std::string pt) { remote_port = pt; }
 190
 191   protected:
 192         void thread_init ();
 193         void do_request (OSCUIRequest*);
 194
 195         GSource* local_server;
 196         GSource* remote_server;
 197
 198         bool osc_input_handler (Glib::IOCondition, lo_server);
 199
 200   private:
 201         uint32_t _port;
 202         volatile bool _ok;
 203         volatile bool _shutdown;
 204         lo_server _osc_server;
 205         lo_server _osc_unix_server;
 206         std::string _osc_unix_socket_path;
 207         std::string _osc_url_file;
 208         OSCDebugMode _debugmode;
 209         bool address_only;
 210         std::string remote_port;
 211         uint32_t default_banksize;
 212         uint32_t default_strip;
 213         uint32_t default_feedback;
 214         uint32_t default_gainmode;
 215         uint32_t default_send_size;
 216         uint32_t default_plugin_size;
 217         bool tick;
 218         bool bank_dirty;
 219         float scrub_speed;              // Current scrub speed
 220         double scrub_place;             // place of play head at latest jog/scrub wheel tick
 221         int64_t scrub_time;             // when did the wheel move last?
 222         bool global_init;
 223         boost::shared_ptr<ARDOUR::Stripable> _select;   // which stripable out of /surface/stripables is gui selected
 224
 225         void register_callbacks ();
 226
 227         void route_added (ARDOUR::RouteList&);
 228
 229         // Handlers for "Application Hook" signals
 230         void session_loaded (ARDOUR::Session&);
 231         void session_exported (std::string, std::string);
 232
 233         // end "Application Hook" handles
 234
 235         std::string get_unix_server_url ();
 236         lo_address get_address (lo_message msg);
 237         OSCSurface * get_surface (lo_address addr);
 238         int check_surface (lo_message msg);
 239         uint32_t get_sid (boost::shared_ptr<ARDOUR::Stripable> strip, lo_address addr);
 240         boost::shared_ptr<ARDOUR::Stripable> get_strip (uint32_t ssid, lo_address addr);
 241         void global_feedback (std::bitset<32> feedback, lo_address addr, uint32_t gainmode);
 242
 243         void send_current_value (const char* path, lo_arg** argv, int argc, lo_message msg);
 244         void current_value_query (const char* path, size_t len, lo_arg **argv, int argc, lo_message msg);
 245
 246         int current_value (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data);
 247
 248         int catchall (const char *path, const char *types, lo_arg **argv, int argc, void *data);
 249         static int _catchall (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data);
 250
 251         int set_automation (const char *path, const char* types, lo_arg **argv, int argc, lo_message msg);
 252         int touch_detect (const char *path, const char* types, lo_arg **argv, int argc, lo_message msg);
 253         int fake_touch (boost::shared_ptr<ARDOUR::AutomationControl> ctrl);
 254
 255         int route_get_sends (lo_message msg);
 256         int route_get_receives(lo_message msg);
 257         void routes_list (lo_message msg);
 258         void transport_frame (lo_message msg);
 259         void transport_speed (lo_message msg);
 260         void record_enabled (lo_message msg);
 261
 262         // cue
 263         Sorted cue_get_sorted_stripables(boost::shared_ptr<ARDOUR::Stripable> aux, uint32_t id, lo_message msg);
 264         int cue_parse (const char *path, const char* types, lo_arg **argv, int argc, lo_message msg);
 265         int cue_set (uint32_t aux, lo_message msg);
 266         int _cue_set (uint32_t aux, lo_address addr);
 267         int cue_next (lo_message msg);
 268         int cue_previous (lo_message msg);
 269         int cue_send_fader (uint32_t id, float position, lo_message msg);
 270         int cue_send_enable (uint32_t id, float state, lo_message msg);
 271         int cue_aux_fader (float position, lo_message msg);
 272         int cue_aux_mute (float state, lo_message msg);
 273         void cue_set_aux (uint32_t aux, lo_message msg);
 274         int cue_float_message (std::string, float value, lo_address addr);
 275         int text_message (std::string path, std::string val, lo_address addr);
 276         boost::shared_ptr<ARDOUR::Send> cue_get_send (uint32_t id, lo_address addr);
 277         // end cue
 278
 279         int select_plugin_parameter (const char *path, const char* types, lo_arg **argv, int argc, lo_message msg);
 280         int surface_parse (const char *path, const char* types, lo_arg **argv, int argc, lo_message msg);
 281
 282 #define OSC_DEBUG \
 283         if (_debugmode == All) { \
 284                 debugmsg (dgettext(PACKAGE, "OSC"), path, types, argv, argc); \
 285         }
 286
 287 #define PATH_CALLBACK_MSG(name) \
 288         static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
 289                 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
 290         } \
 291         int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
 292                 OSC_DEBUG; \
 293                 if (argc > 0 && !strcmp (types, "f") && argv[0]->f != 1.0) { return 0; } \
 294                 name (data); \
 295                 return 0; \
 296         }
 297
 298         PATH_CALLBACK_MSG(route_get_sends);
 299         PATH_CALLBACK_MSG(route_get_receives);
 300         PATH_CALLBACK_MSG(routes_list);
 301         PATH_CALLBACK_MSG(transport_frame);
 302         PATH_CALLBACK_MSG(transport_speed);
 303         PATH_CALLBACK_MSG(record_enabled);
 304         PATH_CALLBACK_MSG(refresh_surface);
 305         PATH_CALLBACK_MSG(bank_up);
 306         PATH_CALLBACK_MSG(bank_down);
 307
 308 #define PATH_CALLBACK(name) \
 309         static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
 310                 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
 311         } \
 312         int cb_ ## name (const char *path, const char *types, lo_arg ** argv, int argc, void *data) { \
 313                 OSC_DEBUG; \
 314                 check_surface (data); \
 315                 if (argc > 0 && !strcmp (types, "f") && argv[0]->f != 1.0) { return 0; } \
 316                 name (); \
 317                 return 0; \
 318         }
 319
 320         PATH_CALLBACK(add_marker);
 321         PATH_CALLBACK(loop_toggle);
 322         PATH_CALLBACK(goto_start);
 323         PATH_CALLBACK(goto_end);
 324         PATH_CALLBACK(rewind);
 325         PATH_CALLBACK(ffwd);
 326         PATH_CALLBACK(transport_stop);
 327         PATH_CALLBACK(transport_play);
 328         PATH_CALLBACK(save_state);
 329         PATH_CALLBACK(prev_marker);
 330         PATH_CALLBACK(next_marker);
 331         PATH_CALLBACK(undo);
 332         PATH_CALLBACK(redo);
 333         PATH_CALLBACK(toggle_punch_in);
 334         PATH_CALLBACK(toggle_punch_out);
 335         PATH_CALLBACK(rec_enable_toggle);
 336         PATH_CALLBACK(toggle_all_rec_enables);
 337         PATH_CALLBACK(all_tracks_rec_in);
 338         PATH_CALLBACK(all_tracks_rec_out);
 339         PATH_CALLBACK(cancel_all_solos);
 340         PATH_CALLBACK(remove_marker_at_playhead);
 341         PATH_CALLBACK(mark_in);
 342         PATH_CALLBACK(mark_out);
 343         PATH_CALLBACK(toggle_click);
 344         PATH_CALLBACK(midi_panic);
 345         PATH_CALLBACK(toggle_roll);
 346         PATH_CALLBACK(stop_forget);
 347         PATH_CALLBACK(set_punch_range);
 348         PATH_CALLBACK(set_loop_range);
 349         PATH_CALLBACK(set_session_range);
 350         PATH_CALLBACK(toggle_monitor_mute);
 351         PATH_CALLBACK(toggle_monitor_dim);
 352         PATH_CALLBACK(toggle_monitor_mono);
 353         PATH_CALLBACK(quick_snapshot_stay);
 354         PATH_CALLBACK(quick_snapshot_switch);
 355         PATH_CALLBACK(fit_1_track);
 356         PATH_CALLBACK(fit_2_tracks);
 357         PATH_CALLBACK(fit_4_tracks);
 358         PATH_CALLBACK(fit_8_tracks);
 359         PATH_CALLBACK(fit_16_tracks);
 360         PATH_CALLBACK(fit_32_tracks);
 361         PATH_CALLBACK(fit_all_tracks);
 362         PATH_CALLBACK(zoom_100_ms);
 363         PATH_CALLBACK(zoom_1_sec);
 364         PATH_CALLBACK(zoom_10_sec);
 365         PATH_CALLBACK(zoom_1_min);
 366         PATH_CALLBACK(zoom_5_min);
 367         PATH_CALLBACK(zoom_10_min);
 368         PATH_CALLBACK(zoom_to_session);
 369         PATH_CALLBACK(temporal_zoom_in);
 370         PATH_CALLBACK(temporal_zoom_out);
 371         PATH_CALLBACK(scroll_up_1_track);
 372         PATH_CALLBACK(scroll_dn_1_track);
 373         PATH_CALLBACK(scroll_up_1_page);
 374         PATH_CALLBACK(scroll_dn_1_page);
 375
 376 #define PATH_CALLBACK1(name,type,optional) \
 377         static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
 378                 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
 379         } \
 380         int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
 381                 OSC_DEBUG; \
 382                 check_surface (data); \
 383                 if (argc > 0) { \
 384                         name (optional argv[0]->type); \
 385                 } \
 386                 return 0; \
 387         }
 388
 389         PATH_CALLBACK1(set_transport_speed,f,);
 390         PATH_CALLBACK1(access_action,s,&);
 391
 392         PATH_CALLBACK1(jump_by_bars,f,);
 393         PATH_CALLBACK1(jump_by_seconds,f,);
 394         PATH_CALLBACK1(master_set_gain,f,);
 395         PATH_CALLBACK1(master_set_fader,f,);
 396         PATH_CALLBACK1(master_set_trim,f,);
 397         PATH_CALLBACK1(master_set_mute,i,);
 398         PATH_CALLBACK1(monitor_set_gain,f,);
 399         PATH_CALLBACK1(monitor_set_fader,f,);
 400         PATH_CALLBACK1(monitor_set_mute,i,);
 401         PATH_CALLBACK1(monitor_set_dim,i,);
 402         PATH_CALLBACK1(monitor_set_mono,i,);
 403
 404 #define PATH_CALLBACK1_MSG(name,arg1type) \
 405         static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
 406                 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
 407         } \
 408         int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
 409                 OSC_DEBUG; \
 410                 if (argc > 0) { \
 411                         name (argv[0]->arg1type, data); \
 412                 } \
 413                 return 0; \
 414         }
 415
 416         // pan position needs message info to send feedback
 417         PATH_CALLBACK1_MSG(master_set_pan_stereo_position,f);
 418
 419         PATH_CALLBACK1_MSG(scrub,f);
 420         PATH_CALLBACK1_MSG(jog,f);
 421         PATH_CALLBACK1_MSG(jog_mode,f);
 422         PATH_CALLBACK1_MSG(sel_recenable,i);
 423         PATH_CALLBACK1_MSG(sel_recsafe,i);
 424         PATH_CALLBACK1_MSG(sel_mute,i);
 425         PATH_CALLBACK1_MSG(sel_solo,i);
 426         PATH_CALLBACK1_MSG(sel_solo_iso,i);
 427         PATH_CALLBACK1_MSG(sel_solo_safe,i);
 428         PATH_CALLBACK1_MSG(sel_monitor_input,i);
 429         PATH_CALLBACK1_MSG(sel_monitor_disk,i);
 430         PATH_CALLBACK1_MSG(sel_phase,i);
 431         PATH_CALLBACK1_MSG(sel_gain,f);
 432         PATH_CALLBACK1_MSG(sel_fader,f);
 433         PATH_CALLBACK1_MSG(sel_trim,f);
 434         PATH_CALLBACK1_MSG(sel_pan_position,f);
 435         PATH_CALLBACK1_MSG(sel_pan_width,f);
 436         PATH_CALLBACK1_MSG(sel_pan_elevation,f);
 437         PATH_CALLBACK1_MSG(sel_pan_frontback,f);
 438         PATH_CALLBACK1_MSG(sel_pan_lfe,f);
 439         PATH_CALLBACK1_MSG(sel_send_page,f);
 440         PATH_CALLBACK1_MSG(sel_plug_page,f);
 441         PATH_CALLBACK1_MSG(sel_plugin,f);
 442         PATH_CALLBACK1_MSG(sel_comp_enable,f);
 443         PATH_CALLBACK1_MSG(sel_comp_threshold,f);
 444         PATH_CALLBACK1_MSG(sel_comp_speed,f);
 445         PATH_CALLBACK1_MSG(sel_comp_mode,f);
 446         PATH_CALLBACK1_MSG(sel_comp_makeup,f);
 447         PATH_CALLBACK1_MSG(sel_eq_enable,f);
 448         PATH_CALLBACK1_MSG(sel_eq_hpf_freq,f);
 449         PATH_CALLBACK1_MSG(sel_eq_hpf_enable,f);
 450         PATH_CALLBACK1_MSG(sel_eq_hpf_slope,f);
 451         PATH_CALLBACK1_MSG(sel_eq_lpf_freq,f);
 452         PATH_CALLBACK1_MSG(sel_eq_lpf_enable,f);
 453         PATH_CALLBACK1_MSG(sel_eq_lpf_slope,f);
 454         PATH_CALLBACK1_MSG(sel_expand,i);
 455
 456 #define PATH_CALLBACK2(name,arg1type,arg2type) \
 457         static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
 458                 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
 459         } \
 460         int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
 461                 OSC_DEBUG; \
 462                 check_surface (data); \
 463                 if (argc > 1) { \
 464                         name (argv[0]->arg1type, argv[1]->arg2type); \
 465                 } \
 466                 return 0; \
 467         }
 468
 469 #define PATH_CALLBACK2_MSG(name,arg1type,arg2type) \
 470         static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
 471                 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
 472         } \
 473         int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
 474                 OSC_DEBUG; \
 475                 if (argc > 1) { \
 476                         name (argv[0]->arg1type, argv[1]->arg2type, data); \
 477                 } \
 478                 return 0; \
 479         }
 480
 481 #define PATH_CALLBACK2_MSG_s(name,arg1type,arg2type) \
 482         static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
 483                 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
 484         } \
 485         int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
 486                 OSC_DEBUG; \
 487                 if (argc > 1) { \
 488                         name (argv[0]->arg1type, &argv[1]->arg2type, data); \
 489                 } \
 490                 return 0; \
 491         }
 492
 493 #define PATH_CALLBACK3(name,arg1type,arg2type,arg3type) \
 494         static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
 495                 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
 496         } \
 497         int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
 498                 OSC_DEBUG; \
 499                 if (argc > 1) { \
 500                         name (argv[0]->arg1type, argv[1]->arg2type,argv[2]->arg3type, data); \
 501                 } \
 502                 return 0; \
 503         }
 504
 505 #define PATH_CALLBACK4(name,arg1type,arg2type,arg3type,arg4type) \
 506         static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
 507                 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
 508         } \
 509         int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
 510                 OSC_DEBUG; \
 511                 if (argc > 1) { \
 512                         name (argv[0]->arg1type, argv[1]->arg2type,argv[2]->arg3type,argv[3]->arg4type, data); \
 513                 } \
 514                 return 0; \
 515         }
 516
 517         PATH_CALLBACK2_MSG(sel_sendgain,i,f);
 518         PATH_CALLBACK2_MSG(sel_sendfader,i,f);
 519         PATH_CALLBACK2_MSG(sel_sendenable,i,f);
 520         PATH_CALLBACK2_MSG(sel_eq_gain,i,f);
 521         PATH_CALLBACK2_MSG(sel_eq_freq,i,f);
 522         PATH_CALLBACK2_MSG(sel_eq_q,i,f);
 523         PATH_CALLBACK2_MSG(sel_eq_shape,i,f);
 524
 525         PATH_CALLBACK2(locate,i,i);
 526         PATH_CALLBACK2(loop_location,i,i);
 527         PATH_CALLBACK2_MSG_s(route_rename,i,s);
 528         PATH_CALLBACK2_MSG(route_mute,i,i);
 529         PATH_CALLBACK2_MSG(route_solo,i,i);
 530         PATH_CALLBACK2_MSG(route_solo_iso,i,i);
 531         PATH_CALLBACK2_MSG(route_solo_safe,i,i);
 532         PATH_CALLBACK2_MSG(route_recenable,i,i);
 533         PATH_CALLBACK2_MSG(route_recsafe,i,i);
 534         PATH_CALLBACK2_MSG(route_monitor_input,i,i);
 535         PATH_CALLBACK2_MSG(route_monitor_disk,i,i);
 536         PATH_CALLBACK2_MSG(strip_phase,i,i);
 537         PATH_CALLBACK2_MSG(strip_expand,i,i);
 538         PATH_CALLBACK2_MSG(strip_gui_select,i,i);
 539         PATH_CALLBACK2_MSG(route_set_gain_dB,i,f);
 540         PATH_CALLBACK2_MSG(route_set_gain_fader,i,f);
 541         PATH_CALLBACK2_MSG(route_set_trim_dB,i,f);
 542         PATH_CALLBACK2_MSG(route_set_pan_stereo_position,i,f);
 543         PATH_CALLBACK2_MSG(route_set_pan_stereo_width,i,f);
 544         PATH_CALLBACK3(route_set_send_gain_dB,i,i,f);
 545         PATH_CALLBACK3(route_set_send_fader,i,i,f);
 546         PATH_CALLBACK3(route_set_send_enable,i,i,f);
 547         PATH_CALLBACK4(route_plugin_parameter,i,i,i,f);
 548         PATH_CALLBACK3(route_plugin_parameter_print,i,i,i);
 549         PATH_CALLBACK2_MSG(route_plugin_activate,i,i);
 550         PATH_CALLBACK2_MSG(route_plugin_deactivate,i,i);
 551         PATH_CALLBACK1_MSG(route_plugin_list,i);
 552         PATH_CALLBACK2_MSG(route_plugin_descriptor,i,i);
 553         PATH_CALLBACK2_MSG(route_plugin_reset,i,i);
 554
 555         int route_rename (int rid, char *s, lo_message msg);
 556         int route_mute (int rid, int yn, lo_message msg);
 557         int route_solo (int rid, int yn, lo_message msg);
 558         int route_solo_iso (int rid, int yn, lo_message msg);
 559         int route_solo_safe (int rid, int yn, lo_message msg);
 560         int route_recenable (int rid, int yn, lo_message msg);
 561         int route_recsafe (int ssid, int yn, lo_message msg);
 562         int route_monitor_input (int rid, int yn, lo_message msg);
 563         int route_monitor_disk (int rid, int yn, lo_message msg);
 564         int strip_phase (int rid, int yn, lo_message msg);
 565         int strip_expand (int rid, int yn, lo_message msg);
 566         int _strip_select (boost::shared_ptr<ARDOUR::Stripable> s, lo_address addr);
 567         int strip_gui_select (int rid, int yn, lo_message msg);
 568         int route_set_gain_abs (int rid, float level, lo_message msg);
 569         int route_set_gain_dB (int rid, float dB, lo_message msg);
 570         int route_set_gain_fader (int rid, float pos, lo_message msg);
 571         int strip_db_delta (int ssid, float delta, lo_message msg);
 572         int route_set_trim_abs (int rid, float level, lo_message msg);
 573         int route_set_trim_dB (int rid, float dB, lo_message msg);
 574         int route_set_pan_stereo_position (int rid, float left_right_fraction, lo_message msg);
 575         int route_set_pan_stereo_width (int rid, float percent, lo_message msg);
 576         int route_set_send_gain_dB (int rid, int sid, float val, lo_message msg);
 577         int route_set_send_fader (int rid, int sid, float val, lo_message msg);
 578         int route_set_send_enable (int rid, int sid, float val, lo_message msg);
 579         int route_plugin_parameter (int rid, int piid,int par, float val, lo_message msg);
 580         int route_plugin_parameter_print (int rid, int piid,int par, lo_message msg);
 581         int route_plugin_activate (int rid, int piid, lo_message msg);
 582         int route_plugin_deactivate (int rid, int piid, lo_message msg);
 583         int route_plugin_list(int ssid, lo_message msg);
 584         int route_plugin_descriptor(int ssid, int piid, lo_message msg);
 585         int route_plugin_reset(int ssid, int piid, lo_message msg);
 586
 587         //banking functions
 588         int set_bank (uint32_t bank_start, lo_message msg);
 589         int _set_bank (uint32_t bank_start, lo_address addr);
 590         int bank_up (lo_message msg);
 591         int bank_down (lo_message msg);
 592         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);
 593         int set_surface_bank_size (uint32_t bs, lo_message msg);
 594         int set_surface_strip_types (uint32_t st, lo_message msg);
 595         int set_surface_feedback (uint32_t fb, lo_message msg);
 596         int set_surface_gainmode (uint32_t gm, lo_message msg);
 597         int refresh_surface (lo_message msg);
 598         int sel_send_pagesize (uint32_t size, lo_message msg);
 599         int sel_send_page (int page, lo_message msg);
 600         int sel_plug_pagesize (uint32_t size, lo_message msg);
 601         int sel_plug_page (int page, lo_message msg);
 602         int sel_plugin (int delta, lo_message msg);
 603         int _sel_plugin (int id, lo_address addr);
 604         void processor_changed (lo_address addr);
 605
 606         int scrub (float delta, lo_message msg);
 607         int jog (float delta, lo_message msg);
 608         int jog_mode (float mode, lo_message msg);
 609         int master_set_gain (float dB);
 610         int master_set_fader (float position);
 611         int master_set_trim (float dB);
 612         int master_set_pan_stereo_position (float position, lo_message msg);
 613         int master_set_mute (uint32_t state);
 614         int monitor_set_gain (float dB);
 615         int monitor_set_fader (float position);
 616         int monitor_set_mute (uint32_t state);
 617         int monitor_set_dim (uint32_t state);
 618         int monitor_set_mono (uint32_t state);
 619         int sel_recenable (uint32_t state, lo_message msg);
 620         int sel_recsafe (uint32_t state, lo_message msg);
 621         int sel_mute (uint32_t state, lo_message msg);
 622         int sel_solo (uint32_t state, lo_message msg);
 623         int sel_solo_iso (uint32_t state, lo_message msg);
 624         int sel_solo_safe (uint32_t state, lo_message msg);
 625         int sel_monitor_input (uint32_t state, lo_message msg);
 626         int sel_monitor_disk (uint32_t state, lo_message msg);
 627         int sel_phase (uint32_t state, lo_message msg);
 628         int sel_gain (float state, lo_message msg);
 629         int sel_fader (float state, lo_message msg);
 630         int sel_trim (float val, lo_message msg);
 631         int sel_pan_position (float val, lo_message msg);
 632         int sel_pan_width (float val, lo_message msg);
 633         int sel_sendgain (int id, float dB, lo_message msg);
 634         int sel_sendfader (int id, float pos, lo_message msg);
 635         int sel_sendenable (int id, float pos, lo_message msg);
 636         int sel_expand (uint32_t state, lo_message msg);
 637         int sel_pan_elevation (float val, lo_message msg);
 638         int sel_pan_frontback (float val, lo_message msg);
 639         int sel_pan_lfe (float val, lo_message msg);
 640         int sel_comp_enable (float val, lo_message msg);
 641         int sel_comp_threshold (float val, lo_message msg);
 642         int sel_comp_speed (float val, lo_message msg);
 643         int sel_comp_mode (float val, lo_message msg);
 644         int sel_comp_makeup (float val, lo_message msg);
 645         int sel_eq_enable (float val, lo_message msg);
 646         int sel_eq_hpf_freq (float val, lo_message msg);
 647         int sel_eq_hpf_enable (float val, lo_message msg);
 648         int sel_eq_hpf_slope (float val, lo_message msg);
 649         int sel_eq_lpf_freq (float val, lo_message msg);
 650         int sel_eq_lpf_enable (float val, lo_message msg);
 651         int sel_eq_lpf_slope (float val, lo_message msg);
 652         int sel_eq_gain (int id, float val, lo_message msg);
 653         int sel_eq_freq (int id, float val, lo_message msg);
 654         int sel_eq_q (int id, float val, lo_message msg);
 655         int sel_eq_shape (int id, float val, lo_message msg);
 656
 657         void listen_to_route (boost::shared_ptr<ARDOUR::Stripable>, lo_address);
 658         void end_listen (boost::shared_ptr<ARDOUR::Stripable>, lo_address);
 659         void drop_route (boost::weak_ptr<ARDOUR::Stripable>);
 660         void route_lost (boost::weak_ptr<ARDOUR::Stripable>);
 661         void gui_selection_changed (void);
 662
 663         void route_name_changed (const PBD::PropertyChange&, boost::weak_ptr<ARDOUR::Route> r, lo_address addr);
 664         void recalcbanks ();
 665         void _recalcbanks ();
 666         void notify_routes_added (ARDOUR::RouteList &);
 667         void notify_vca_added (ARDOUR::VCAList &);
 668
 669         int cancel_all_solos ();
 670         bool periodic (void);
 671         sigc::connection periodic_connection;
 672         PBD::ScopedConnectionList session_connections;
 673         PBD::ScopedConnectionList cueobserver_connections;
 674
 675         int route_send_fail (std::string path, uint32_t ssid, float val, lo_address addr);
 676         int sel_send_fail (std::string path, uint32_t id, float val, lo_address addr);
 677         int sel_fail (std::string path, float val, lo_address addr);
 678
 679         typedef std::list<OSCRouteObserver*> RouteObservers;
 680
 681         RouteObservers route_observers;
 682
 683         typedef std::list<OSCGlobalObserver*> GlobalObservers;
 684         GlobalObservers global_observers;
 685
 686         typedef std::list<OSCCueObserver*> CueObservers;
 687         CueObservers cue_observers;
 688
 689         void debugmsg (const char *prefix, const char *path, const char* types, lo_arg **argv, int argc);
 690
 691         static OSC* _instance;
 692
 693         mutable void *gui;
 694         void build_gui ();
 695 };
 696
 697 } // namespace
 698
 699 #endif // ardour_osc_h