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
  25 #include <sys/time.h>
  26 #include <pthread.h>
  27
  28 #include <boost/shared_ptr.hpp>
  29
  30 #include <lo/lo.h>
  31
  32 #include <glibmm/main.h>
  33
  34 #define ABSTRACT_UI_EXPORTS
  35 #include "pbd/abstract_ui.h"
  36
  37 #include "ardour/types.h"
  38 #include "control_protocol/control_protocol.h"
  39
  40 #include "i18n.h"
  41
  42 class OSCControllable;
  43 class OSCRouteObserver;
  44
  45 namespace ARDOUR {
  46 class Session;
  47 class Route;
  48 }
  49
  50 /* this is mostly a placeholder because I suspect that at some
  51    point we will want to add more members to accomodate
  52    certain types of requests to the OSC UI
  53 */
  54
  55 namespace ArdourSurface {
  56
  57 struct OSCUIRequest : public BaseUI::BaseRequestObject {
  58   public:
  59         OSCUIRequest () {}
  60         ~OSCUIRequest() {}
  61 };
  62
  63 class OSC : public ARDOUR::ControlProtocol, public AbstractUI<OSCUIRequest>
  64 {
  65   public:
  66         OSC (ARDOUR::Session&, uint32_t port);
  67         virtual ~OSC();
  68
  69         static OSC* instance() { return _instance; }
  70
  71         XMLNode& get_state ();
  72         int set_state (const XMLNode&, int version);
  73
  74         bool has_editor () const { return true; }
  75         void* get_gui () const;
  76         void  tear_down_gui ();
  77
  78         int set_active (bool yn);
  79         bool get_active () const;
  80         int set_feedback (bool yn);
  81         bool get_feedback () const;
  82
  83
  84         int start ();
  85         int stop ();
  86
  87         static void* request_factory (uint32_t);
  88
  89         enum OSCDebugMode {
  90                 Off,
  91                 Unhandled,
  92                 All
  93         };
  94
  95         std::string get_server_url ();
  96         void set_debug_mode (OSCDebugMode m) { _debugmode = m; }
  97         OSCDebugMode get_debug_mode () { return _debugmode; }
  98
  99   protected:
 100         void thread_init ();
 101         void do_request (OSCUIRequest*);
 102
 103         GSource* local_server;
 104         GSource* remote_server;
 105
 106         bool osc_input_handler (Glib::IOCondition, lo_server);
 107
 108   private:
 109         uint32_t _port;
 110         volatile bool _ok;
 111         volatile bool _shutdown;
 112         lo_server _osc_server;
 113         lo_server _osc_unix_server;
 114         std::string _osc_unix_socket_path;
 115         std::string _osc_url_file;
 116         bool _send_route_changes;
 117         OSCDebugMode _debugmode;
 118
 119         void register_callbacks ();
 120
 121         void route_added (ARDOUR::RouteList&);
 122
 123         // Handlers for "Application Hook" signals
 124         void session_loaded (ARDOUR::Session&);
 125         void session_exported (std::string, std::string);
 126
 127         // end "Application Hook" handles
 128
 129         std::string get_unix_server_url ();
 130
 131         void send_current_value (const char* path, lo_arg** argv, int argc, lo_message msg);
 132         void current_value_query (const char* path, size_t len, lo_arg **argv, int argc, lo_message msg);
 133
 134         int current_value (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data);
 135
 136         int catchall (const char *path, const char *types, lo_arg **argv, int argc, void *data);
 137         static int _catchall (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data);
 138
 139         void routes_list (lo_message msg);
 140         void transport_frame (lo_message msg);
 141         void transport_speed (lo_message msg);
 142         void record_enabled (lo_message msg);
 143
 144 #define OSC_DEBUG \
 145         if (_debugmode == All) { \
 146                 debugmsg (dgettext(PACKAGE, "OSC"), path, types, argv, argc); \
 147         }
 148
 149 #define PATH_CALLBACK_MSG(name)                                 \
 150         static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
 151                 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
 152         } \
 153         int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
 154                 OSC_DEBUG;              \
 155                 name (data);            \
 156                 return 0;               \
 157         }
 158
 159         PATH_CALLBACK_MSG(routes_list);
 160         PATH_CALLBACK_MSG(transport_frame);
 161         PATH_CALLBACK_MSG(transport_speed);
 162         PATH_CALLBACK_MSG(record_enabled);
 163
 164 #define PATH_CALLBACK(name) \
 165         static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
 166                 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
 167         } \
 168         int cb_ ## name (const char *path, const char *types, lo_arg ** argv, int argc, void *) { \
 169                 OSC_DEBUG;              \
 170                 if (argc > 0 && !strcmp (types, "f") && argv[0]->f != 1.0) { return 0; } \
 171                 name (); \
 172                 return 0; \
 173         }
 174
 175         PATH_CALLBACK(add_marker);
 176         PATH_CALLBACK(loop_toggle);
 177         PATH_CALLBACK(goto_start);
 178         PATH_CALLBACK(goto_end);
 179         PATH_CALLBACK(rewind);
 180         PATH_CALLBACK(ffwd);
 181         PATH_CALLBACK(transport_stop);
 182         PATH_CALLBACK(transport_play);
 183         PATH_CALLBACK(save_state);
 184         PATH_CALLBACK(prev_marker);
 185         PATH_CALLBACK(next_marker);
 186         PATH_CALLBACK(undo);
 187         PATH_CALLBACK(redo);
 188         PATH_CALLBACK(toggle_punch_in);
 189         PATH_CALLBACK(toggle_punch_out);
 190         PATH_CALLBACK(rec_enable_toggle);
 191         PATH_CALLBACK(toggle_all_rec_enables);
 192         PATH_CALLBACK(all_tracks_rec_in);
 193         PATH_CALLBACK(all_tracks_rec_out);
 194         PATH_CALLBACK(remove_marker_at_playhead);
 195         PATH_CALLBACK(mark_in);
 196         PATH_CALLBACK(mark_out);
 197         PATH_CALLBACK(toggle_click);
 198         PATH_CALLBACK(midi_panic);
 199         PATH_CALLBACK(toggle_roll);
 200         PATH_CALLBACK(stop_forget);
 201         PATH_CALLBACK(set_punch_range);
 202         PATH_CALLBACK(set_loop_range);
 203         PATH_CALLBACK(set_session_range);
 204         PATH_CALLBACK(toggle_monitor_mute);
 205         PATH_CALLBACK(toggle_monitor_dim);
 206         PATH_CALLBACK(toggle_monitor_mono);
 207         PATH_CALLBACK(quick_snapshot_stay);
 208         PATH_CALLBACK(quick_snapshot_switch);
 209         PATH_CALLBACK(fit_1_track);
 210         PATH_CALLBACK(fit_2_tracks);
 211         PATH_CALLBACK(fit_4_tracks);
 212         PATH_CALLBACK(fit_8_tracks);
 213         PATH_CALLBACK(fit_16_tracks);
 214         PATH_CALLBACK(fit_32_tracks);
 215         PATH_CALLBACK(fit_all_tracks);
 216         PATH_CALLBACK(zoom_100_ms);
 217         PATH_CALLBACK(zoom_1_sec);
 218         PATH_CALLBACK(zoom_10_sec);
 219         PATH_CALLBACK(zoom_1_min);
 220         PATH_CALLBACK(zoom_5_min);
 221         PATH_CALLBACK(zoom_10_min);
 222         PATH_CALLBACK(zoom_to_session);
 223         PATH_CALLBACK(temporal_zoom_in);
 224         PATH_CALLBACK(temporal_zoom_out);
 225         PATH_CALLBACK(scroll_up_1_track);
 226         PATH_CALLBACK(scroll_dn_1_track);
 227         PATH_CALLBACK(scroll_up_1_page);
 228         PATH_CALLBACK(scroll_dn_1_page);
 229
 230 #define PATH_CALLBACK1(name,type,optional)                                      \
 231         static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
 232                 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
 233         } \
 234         int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *) { \
 235                 OSC_DEBUG;              \
 236                 if (argc > 0) {                                         \
 237                         name (optional argv[0]->type);          \
 238                 }                                                       \
 239                 return 0;                                               \
 240         }
 241
 242         PATH_CALLBACK1(set_transport_speed,f,);
 243         PATH_CALLBACK1(access_action,s,&);
 244
 245         PATH_CALLBACK1(jump_by_bars,f,);
 246         PATH_CALLBACK1(jump_by_seconds,f,);
 247
 248 #define PATH_CALLBACK2(name,arg1type,arg2type)                  \
 249         static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
 250                 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
 251         } \
 252         int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *) { \
 253                 OSC_DEBUG;              \
 254                 if (argc > 1) {                                         \
 255                         name (argv[0]->arg1type, argv[1]->arg2type); \
 256                 }                                                       \
 257                 return 0;                                               \
 258         }
 259
 260 #define PATH_CALLBACK3(name,arg1type,arg2type,arg3type)                \
 261         static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
 262                return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
 263         } \
 264         int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *) { \
 265                 OSC_DEBUG;              \
 266                 if (argc > 1) {                                                \
 267                  name (argv[0]->arg1type, argv[1]->arg2type,argv[2]->arg3type); \
 268                 }                                                      \
 269                return 0;                                               \
 270        }
 271
 272 #define PATH_CALLBACK4(name,arg1type,arg2type,arg3type,arg4type)               \
 273         static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
 274                return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
 275         } \
 276         int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *) { \
 277                 OSC_DEBUG;              \
 278                 if (argc > 1) {                                                \
 279                  name (argv[0]->arg1type, argv[1]->arg2type,argv[2]->arg3type,argv[3]->arg4type); \
 280                 }                                                      \
 281                return 0;                                               \
 282        }
 283
 284         PATH_CALLBACK2(locate,i,i);
 285         PATH_CALLBACK2(loop_location,i,i);
 286         PATH_CALLBACK2(route_mute,i,i);
 287         PATH_CALLBACK2(route_solo,i,i);
 288         PATH_CALLBACK2(route_recenable,i,i);
 289         PATH_CALLBACK2(route_set_gain_abs,i,f);
 290         PATH_CALLBACK2(route_set_gain_dB,i,f);
 291         PATH_CALLBACK2(route_set_gain_fader,i,f);
 292         PATH_CALLBACK2(route_set_trim_abs,i,f);
 293         PATH_CALLBACK2(route_set_trim_dB,i,f);
 294         PATH_CALLBACK2(route_set_pan_stereo_position,i,f);
 295         PATH_CALLBACK2(route_set_pan_stereo_width,i,f);
 296         PATH_CALLBACK3(route_set_send_gain_abs,i,i,f);
 297         PATH_CALLBACK3(route_set_send_gain_dB,i,i,f);
 298         PATH_CALLBACK4(route_plugin_parameter,i,i,i,f);
 299         PATH_CALLBACK3(route_plugin_parameter_print,i,i,i);
 300
 301         int route_mute (int rid, int yn);
 302         int route_solo (int rid, int yn);
 303         int route_recenable (int rid, int yn);
 304         int route_set_gain_abs (int rid, float level);
 305         int route_set_gain_dB (int rid, float dB);
 306         int route_set_gain_fader (int rid, float pos);
 307         int route_set_trim_abs (int rid, float level);
 308         int route_set_trim_dB (int rid, float dB);
 309         int route_set_pan_stereo_position (int rid, float left_right_fraction);
 310         int route_set_pan_stereo_width (int rid, float percent);
 311         int route_set_send_gain_abs (int rid, int sid, float val);
 312         int route_set_send_gain_dB (int rid, int sid, float val);
 313         int route_plugin_parameter (int rid, int piid,int par, float val);
 314         int route_plugin_parameter_print (int rid, int piid,int par);
 315
 316         void listen_to_route (boost::shared_ptr<ARDOUR::Route>, lo_address);
 317         void end_listen (boost::shared_ptr<ARDOUR::Route>, lo_address);
 318         void drop_route (boost::weak_ptr<ARDOUR::Route>);
 319
 320         void route_name_changed (const PBD::PropertyChange&, boost::weak_ptr<ARDOUR::Route> r, lo_address addr);
 321
 322         void update_clock ();
 323
 324         typedef std::list<OSCRouteObserver*> RouteObservers;
 325
 326         RouteObservers route_observers;
 327         void debugmsg (const char *prefix, const char *path, const char* types, lo_arg **argv, int argc);
 328
 329         static OSC* _instance;
 330
 331         mutable void *gui;
 332         void build_gui ();
 333 };
 334
 335 } // namespace
 336
 337 #endif // ardour_osc_h