OSC: Add fake timeout based touch
[ardour.git] / libs / surfaces / osc / osc.h
index a30d84ee043ac8c897ae13782582e6288ef9ad62..3d53eef9440680fb8c23262d47501be4b018a39d 100644 (file)
@@ -37,6 +37,7 @@
 #include "pbd/abstract_ui.h"
 
 #include "ardour/types.h"
+#include "ardour/send.h"
 #include "control_protocol/control_protocol.h"
 
 #include "pbd/i18n.h"
@@ -45,6 +46,7 @@ class OSCControllable;
 class OSCRouteObserver;
 class OSCGlobalObserver;
 class OSCSelectObserver;
+class OSCCueObserver;
 
 namespace ARDOUR {
 class Session;
@@ -75,15 +77,14 @@ class OSC : public ARDOUR::ControlProtocol, public AbstractUI<OSCUIRequest>
        XMLNode& get_state ();
        int set_state (const XMLNode&, int version);
 
+       void stripable_selection_changed () {}
+
        bool has_editor () const { return true; }
        void* get_gui () const;
        void  tear_down_gui ();
 
        int set_active (bool yn);
        bool get_active () const;
-       int set_feedback (bool yn);
-       bool get_feedback () const;
-
 
        int start ();
        int stop ();
@@ -96,13 +97,28 @@ class OSC : public ARDOUR::ControlProtocol, public AbstractUI<OSCUIRequest>
                All
        };
 
+       enum JogMode {
+               JOG,
+               NUDGE,
+               SCRUB,
+               SHUTTLE,
+               MARKER,
+               SCROLL,
+               TRACK,
+               BANK
+       };
+
        typedef std::vector<boost::shared_ptr<ARDOUR::Stripable> > Sorted;
-       Sorted get_sorted_stripables(std::bitset<32> types);
+       Sorted get_sorted_stripables(std::bitset<32> types, bool cue);
+       typedef std::map<boost::shared_ptr<ARDOUR::AutomationControl>, uint32_t> FakeTouchMap;
+       FakeTouchMap _touch_timeout;
 
 // keep a surface's global setup by remote server url
        struct OSCSurface {
        public:
                std::string remote_url;         // the url these setting belong to
+               bool no_clear;                          // don't send osc clear messages on strip change
+               JogMode jogmode;                        // current jogmode
                uint32_t bank;                          // current bank
                uint32_t bank_size;                     // size of banks for this surface
                std::bitset<32> strip_types;// what strip types are a part of this bank
@@ -113,6 +129,9 @@ class OSC : public ARDOUR::ControlProtocol, public AbstractUI<OSCUIRequest>
                bool expand_enable;                     // use expand instead of select
                OSCSelectObserver* sel_obs;     // So we can sync select feedback with selected channel
                Sorted strips;                          // list of stripables for this surface
+               bool cue;                                       // is this a cue surface
+               uint32_t aux;                           // aux index for this cue surface
+               Sorted sends;                           // list of sends for cue aux
        };
                /*
                 * feedback bits:
@@ -129,6 +148,7 @@ class OSC : public ARDOUR::ControlProtocol, public AbstractUI<OSCUIRequest>
                 * [10] - Send Playhead position as samples
                 * [11] - Send Playhead position as minutes seconds
                 * [12] - Send Playhead position like primary/secondary GUI clocks
+                * [13] - Send well known feedback (for /select/command
                 */
 
 
@@ -139,6 +159,20 @@ class OSC : public ARDOUR::ControlProtocol, public AbstractUI<OSCUIRequest>
        std::string get_server_url ();
        void set_debug_mode (OSCDebugMode m) { _debugmode = m; }
        OSCDebugMode get_debug_mode () { return _debugmode; }
+       int get_portmode() { return address_only; }
+       void set_portmode (int pm) { address_only = pm; }
+       int get_banksize () { return default_banksize; }
+       void set_banksize (int bs) {default_banksize = bs; }
+       int get_gainmode() { return default_gainmode; }
+       void set_gainmode (int gm) { default_gainmode = gm; }
+       int get_defaultstrip() { return default_strip; }
+       void set_defaultstrip (int st) { default_strip = st; }
+       int get_defaultfeedback() { return default_feedback; }
+       void set_defaultfeedback (int fb) { default_feedback = fb; }
+       void clear_devices ();
+       void gui_changed ();
+       std::string get_remote_port () { return remote_port; }
+       void set_remote_port (std::string pt) { remote_port = pt; }
 
   protected:
         void thread_init ();
@@ -157,10 +191,18 @@ class OSC : public ARDOUR::ControlProtocol, public AbstractUI<OSCUIRequest>
        lo_server _osc_unix_server;
        std::string _osc_unix_socket_path;
        std::string _osc_url_file;
-       bool _send_route_changes;
        OSCDebugMode _debugmode;
+       bool address_only;
+       std::string remote_port;
+       uint32_t default_banksize;
+       uint32_t default_strip;
+       uint32_t default_feedback;
+       uint32_t default_gainmode;
        bool tick;
        bool bank_dirty;
+       float scrub_speed;              // Current scrub speed
+       double scrub_place;             // place of play head at latest jog/scrub wheel tick
+       int64_t scrub_time;             // when did the wheel move last?
        bool global_init;
        boost::shared_ptr<ARDOUR::Stripable> _select;   // which stripable out of /surface/stripables is gui selected
 
@@ -175,7 +217,9 @@ class OSC : public ARDOUR::ControlProtocol, public AbstractUI<OSCUIRequest>
        // end "Application Hook" handles
 
        std::string get_unix_server_url ();
+       lo_address get_address (lo_message msg);
        OSCSurface * get_surface (lo_address addr);
+       int check_surface (lo_message msg);
        uint32_t get_sid (boost::shared_ptr<ARDOUR::Stripable> strip, lo_address addr);
        boost::shared_ptr<ARDOUR::Stripable> get_strip (uint32_t ssid, lo_address addr);
        void global_feedback (std::bitset<32> feedback, lo_address addr, uint32_t gainmode);
@@ -188,40 +232,67 @@ class OSC : public ARDOUR::ControlProtocol, public AbstractUI<OSCUIRequest>
        int catchall (const char *path, const char *types, lo_arg **argv, int argc, void *data);
        static int _catchall (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data);
 
+       int set_automation (const char *path, lo_arg **argv, int argc, lo_message msg);
+       int touch_detect (const char *path, lo_arg **argv, int argc, lo_message msg);
+       int fake_touch (boost::shared_ptr<ARDOUR::AutomationControl> ctrl);
+
+       int route_get_sends (lo_message msg);
+       int route_get_receives(lo_message msg);
        void routes_list (lo_message msg);
        void transport_frame (lo_message msg);
        void transport_speed (lo_message msg);
        void record_enabled (lo_message msg);
 
+       // cue
+       Sorted cue_get_sorted_stripables(boost::shared_ptr<ARDOUR::Stripable> aux, uint32_t id, lo_message msg);
+       int cue_parse (const char *path, const char* types, lo_arg **argv, int argc, lo_message msg);
+       int cue_set (uint32_t aux, lo_message msg);
+       int _cue_set (uint32_t aux, lo_address addr);
+       int cue_next (lo_message msg);
+       int cue_previous (lo_message msg);
+       int cue_send_fader (uint32_t id, float position, lo_message msg);
+       int cue_send_enable (uint32_t id, float state, lo_message msg);
+       int cue_aux_fader (float position, lo_message msg);
+       int cue_aux_mute (float state, lo_message msg);
+       void cue_set_aux (uint32_t aux, lo_message msg);
+       int cue_float_message (std::string, float value, lo_address addr);
+       int text_message (std::string path, std::string val, lo_address addr);
+       boost::shared_ptr<ARDOUR::Send> cue_get_send (uint32_t id, lo_address addr);
+       // end cue
+
 #define OSC_DEBUG \
        if (_debugmode == All) { \
                debugmsg (dgettext(PACKAGE, "OSC"), path, types, argv, argc); \
        }
 
-#define PATH_CALLBACK_MSG(name)                                        \
-        static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
+#define PATH_CALLBACK_MSG(name) \
+       static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
                return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
-        } \
-        int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
-               OSC_DEBUG;              \
+       } \
+       int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
+               OSC_DEBUG; \
                if (argc > 0 && !strcmp (types, "f") && argv[0]->f != 1.0) { return 0; } \
-               name (data);            \
-               return 0;               \
+               name (data); \
+               return 0; \
        }
 
+       PATH_CALLBACK_MSG(route_get_sends);
+       PATH_CALLBACK_MSG(route_get_receives);
        PATH_CALLBACK_MSG(routes_list);
        PATH_CALLBACK_MSG(transport_frame);
        PATH_CALLBACK_MSG(transport_speed);
        PATH_CALLBACK_MSG(record_enabled);
+       PATH_CALLBACK_MSG(refresh_surface);
        PATH_CALLBACK_MSG(bank_up);
        PATH_CALLBACK_MSG(bank_down);
 
 #define PATH_CALLBACK(name) \
-        static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
+       static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
                return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
-        } \
-        int cb_ ## name (const char *path, const char *types, lo_arg ** argv, int argc, void *) { \
-               OSC_DEBUG;              \
+       } \
+       int cb_ ## name (const char *path, const char *types, lo_arg ** argv, int argc, void *data) { \
+               OSC_DEBUG; \
+               check_surface (data); \
                if (argc > 0 && !strcmp (types, "f") && argv[0]->f != 1.0) { return 0; } \
                name (); \
                return 0; \
@@ -283,16 +354,17 @@ class OSC : public ARDOUR::ControlProtocol, public AbstractUI<OSCUIRequest>
        PATH_CALLBACK(scroll_up_1_page);
        PATH_CALLBACK(scroll_dn_1_page);
 
-#define PATH_CALLBACK1(name,type,optional)                                     \
-        static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
+#define PATH_CALLBACK1(name,type,optional) \
+       static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
                return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
-        } \
-        int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *) { \
-               OSC_DEBUG;              \
-                if (argc > 0) {                                                \
-                       name (optional argv[0]->type);          \
-                }                                                      \
-               return 0;                                               \
+       } \
+       int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
+               OSC_DEBUG; \
+               check_surface (data); \
+               if (argc > 0) { \
+                       name (optional argv[0]->type); \
+               } \
+               return 0; \
        }
 
        PATH_CALLBACK1(set_transport_speed,f,);
@@ -306,22 +378,28 @@ class OSC : public ARDOUR::ControlProtocol, public AbstractUI<OSCUIRequest>
        PATH_CALLBACK1(master_set_mute,i,);
        PATH_CALLBACK1(monitor_set_gain,f,);
        PATH_CALLBACK1(monitor_set_fader,f,);
+       PATH_CALLBACK1(monitor_set_mute,i,);
+       PATH_CALLBACK1(monitor_set_dim,i,);
+       PATH_CALLBACK1(monitor_set_mono,i,);
 
-#define PATH_CALLBACK1_MSG(name,arg1type)                      \
-        static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
+#define PATH_CALLBACK1_MSG(name,arg1type) \
+       static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
                return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
-        } \
-        int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
-               OSC_DEBUG;              \
-                if (argc > 0) {                                                \
+       } \
+       int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
+               OSC_DEBUG; \
+               if (argc > 0) { \
                        name (argv[0]->arg1type, data); \
-                }                                                      \
-               return 0;                                               \
+               } \
+               return 0; \
        }
 
        // pan position needs message info to send feedback
        PATH_CALLBACK1_MSG(master_set_pan_stereo_position,f);
 
+       PATH_CALLBACK1_MSG(scrub,f);
+       PATH_CALLBACK1_MSG(jog,f);
+       PATH_CALLBACK1_MSG(jog_mode,f);
        PATH_CALLBACK1_MSG(set_surface_bank_size,i);
        PATH_CALLBACK1_MSG(set_surface_strip_types,i);
        PATH_CALLBACK1_MSG(set_surface_feedback,i);
@@ -352,53 +430,66 @@ class OSC : public ARDOUR::ControlProtocol, public AbstractUI<OSCUIRequest>
        PATH_CALLBACK1_MSG(sel_eq_hpf,f);
        PATH_CALLBACK1_MSG(sel_expand,i);
 
-#define PATH_CALLBACK2(name,arg1type,arg2type)                 \
-        static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
+#define PATH_CALLBACK2(name,arg1type,arg2type) \
+       static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
                return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
-        } \
-        int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *) { \
-               OSC_DEBUG;              \
-                if (argc > 1) {                                                \
+       } \
+       int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
+               OSC_DEBUG; \
+               check_surface (data); \
+               if (argc > 1) { \
                        name (argv[0]->arg1type, argv[1]->arg2type); \
-                }                                                      \
-               return 0;                                               \
+               } \
+               return 0; \
        }
 
-#define PATH_CALLBACK2_MSG(name,arg1type,arg2type)                     \
-        static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
+#define PATH_CALLBACK2_MSG(name,arg1type,arg2type) \
+       static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
                return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
-        } \
-        int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
-               OSC_DEBUG;              \
-                if (argc > 1) {                                                \
+       } \
+       int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
+               OSC_DEBUG; \
+               if (argc > 1) { \
                        name (argv[0]->arg1type, argv[1]->arg2type, data); \
-                }                                                      \
-               return 0;                                               \
+               } \
+               return 0; \
        }
 
-#define PATH_CALLBACK3(name,arg1type,arg2type,arg3type)                \
-        static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
-               return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
-        } \
-        int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
-               OSC_DEBUG;              \
-                if (argc > 1) {                                                \
-                 name (argv[0]->arg1type, argv[1]->arg2type,argv[2]->arg3type, data); \
-                }                                                      \
-               return 0;                                               \
-       }
-
-#define PATH_CALLBACK4(name,arg1type,arg2type,arg3type,arg4type)               \
-        static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
-               return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
-        } \
-        int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
-               OSC_DEBUG;              \
-                if (argc > 1) {                                                \
-                 name (argv[0]->arg1type, argv[1]->arg2type,argv[2]->arg3type,argv[3]->arg4type, data); \
-                }                                                      \
-               return 0;                                               \
-       }
+#define PATH_CALLBACK2_MSG_s(name,arg1type,arg2type) \
+       static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
+               return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
+       } \
+       int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
+               OSC_DEBUG; \
+               if (argc > 1) { \
+                       name (argv[0]->arg1type, &argv[1]->arg2type, data); \
+               } \
+               return 0; \
+       }
+
+#define PATH_CALLBACK3(name,arg1type,arg2type,arg3type) \
+       static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
+               return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
+       } \
+       int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
+               OSC_DEBUG; \
+               if (argc > 1) { \
+                       name (argv[0]->arg1type, argv[1]->arg2type,argv[2]->arg3type, data); \
+               } \
+               return 0; \
+       }
+
+#define PATH_CALLBACK4(name,arg1type,arg2type,arg3type,arg4type) \
+       static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
+               return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
+       } \
+       int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data) { \
+               OSC_DEBUG; \
+               if (argc > 1) { \
+                       name (argv[0]->arg1type, argv[1]->arg2type,argv[2]->arg3type,argv[3]->arg4type, data); \
+               } \
+               return 0; \
+       }
 
        PATH_CALLBACK2_MSG(sel_sendgain,i,f);
        PATH_CALLBACK2_MSG(sel_sendfader,i,f);
@@ -411,6 +502,7 @@ class OSC : public ARDOUR::ControlProtocol, public AbstractUI<OSCUIRequest>
        PATH_CALLBACK4(set_surface,i,i,i,i);
        PATH_CALLBACK2(locate,i,i);
        PATH_CALLBACK2(loop_location,i,i);
+       PATH_CALLBACK2_MSG_s(route_rename,i,s);
        PATH_CALLBACK2_MSG(route_mute,i,i);
        PATH_CALLBACK2_MSG(route_solo,i,i);
        PATH_CALLBACK2_MSG(route_solo_iso,i,i);
@@ -432,7 +524,13 @@ class OSC : public ARDOUR::ControlProtocol, public AbstractUI<OSCUIRequest>
        PATH_CALLBACK3(route_set_send_enable,i,i,f);
        PATH_CALLBACK4(route_plugin_parameter,i,i,i,f);
        PATH_CALLBACK3(route_plugin_parameter_print,i,i,i);
+       PATH_CALLBACK2_MSG(route_plugin_activate,i,i);
+       PATH_CALLBACK2_MSG(route_plugin_deactivate,i,i);
+       PATH_CALLBACK1_MSG(route_plugin_list,i);
+       PATH_CALLBACK2_MSG(route_plugin_descriptor,i,i);
+       PATH_CALLBACK2_MSG(route_plugin_reset,i,i);
 
+       int route_rename (int rid, char *s, lo_message msg);
        int route_mute (int rid, int yn, lo_message msg);
        int route_solo (int rid, int yn, lo_message msg);
        int route_solo_iso (int rid, int yn, lo_message msg);
@@ -457,6 +555,11 @@ class OSC : public ARDOUR::ControlProtocol, public AbstractUI<OSCUIRequest>
        int route_set_send_enable (int rid, int sid, float val, lo_message msg);
        int route_plugin_parameter (int rid, int piid,int par, float val, lo_message msg);
        int route_plugin_parameter_print (int rid, int piid,int par, lo_message msg);
+       int route_plugin_activate (int rid, int piid, lo_message msg);
+       int route_plugin_deactivate (int rid, int piid, lo_message msg);
+       int route_plugin_list(int ssid, lo_message msg);
+       int route_plugin_descriptor(int ssid, int piid, lo_message msg);
+       int route_plugin_reset(int ssid, int piid, lo_message msg);
 
        //banking functions
        int set_bank (uint32_t bank_start, lo_message msg);
@@ -468,7 +571,11 @@ class OSC : public ARDOUR::ControlProtocol, public AbstractUI<OSCUIRequest>
        int set_surface_strip_types (uint32_t st, lo_message msg);
        int set_surface_feedback (uint32_t fb, lo_message msg);
        int set_surface_gainmode (uint32_t gm, lo_message msg);
+       int refresh_surface (lo_message msg);
 
+       int scrub (float delta, lo_message msg);
+       int jog (float delta, lo_message msg);
+       int jog_mode (float mode, lo_message msg);
        int master_set_gain (float dB);
        int master_set_fader (float position);
        int master_set_trim (float dB);
@@ -476,6 +583,9 @@ class OSC : public ARDOUR::ControlProtocol, public AbstractUI<OSCUIRequest>
        int master_set_mute (uint32_t state);
        int monitor_set_gain (float dB);
        int monitor_set_fader (float position);
+       int monitor_set_mute (uint32_t state);
+       int monitor_set_dim (uint32_t state);
+       int monitor_set_mono (uint32_t state);
        int sel_recenable (uint32_t state, lo_message msg);
        int sel_recsafe (uint32_t state, lo_message msg);
        int sel_mute (uint32_t state, lo_message msg);
@@ -521,11 +631,11 @@ class OSC : public ARDOUR::ControlProtocol, public AbstractUI<OSCUIRequest>
        void notify_routes_added (ARDOUR::RouteList &);
        void notify_vca_added (ARDOUR::VCAList &);
 
-       void update_clock ();
        int cancel_all_solos ();
        bool periodic (void);
        sigc::connection periodic_connection;
        PBD::ScopedConnectionList session_connections;
+       PBD::ScopedConnectionList cueobserver_connections;
 
        int route_send_fail (std::string path, uint32_t ssid, float val, lo_address addr);
        int sel_send_fail (std::string path, uint32_t id, float val, lo_address addr);
@@ -538,6 +648,9 @@ class OSC : public ARDOUR::ControlProtocol, public AbstractUI<OSCUIRequest>
        typedef std::list<OSCGlobalObserver*> GlobalObservers;
        GlobalObservers global_observers;
 
+       typedef std::list<OSCCueObserver*> CueObservers;
+       CueObservers cue_observers;
+
        void debugmsg (const char *prefix, const char *path, const char* types, lo_arg **argv, int argc);
 
        static OSC* _instance;