OSC debugging, allow to log incoming & unhandled messages
[ardour.git] / libs / surfaces / osc / osc.h
index d0bc509f173c7f0161caa17a260e2823d5f80606..9c96d5f5938c5b1ad4033efe943a93ccb926a5e3 100644 (file)
@@ -1,20 +1,20 @@
 /*
  * Copyright (C) 2006-2009 Paul Davis
- *  
+ *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
- *  
+ *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
- *  
+ *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
- *  
+ *
  */
 
 #ifndef ardour_osc_h
 
 #include <lo/lo.h>
 
-#include <sigc++/sigc++.h>
+#include <glibmm/main.h>
 
-#include <ardour/types.h>
-#include <ardour/session.h>
-#include <control_protocol/control_protocol.h>
+#define ABSTRACT_UI_EXPORTS
+#include "pbd/abstract_ui.h"
+
+#include "ardour/types.h"
+#include "control_protocol/control_protocol.h"
 
 class OSCControllable;
+class OSCRouteObserver;
 
 namespace ARDOUR {
 class Session;
 class Route;
 }
-       
-class OSC : public ARDOUR::ControlProtocol
+
+/* this is mostly a placeholder because I suspect that at some
+   point we will want to add more members to accomodate
+   certain types of requests to the OSC UI
+*/
+
+namespace ArdourSurface {
+
+struct OSCUIRequest : public BaseUI::BaseRequestObject {
+  public:
+       OSCUIRequest () {}
+       ~OSCUIRequest() {}
+};
+
+class OSC : public ARDOUR::ControlProtocol, public AbstractUI<OSCUIRequest>
 {
   public:
        OSC (ARDOUR::Session&, uint32_t port);
        virtual ~OSC();
 
+       static OSC* instance() { return _instance; }
+
        XMLNode& get_state ();
        int set_state (const XMLNode&, int version);
 
+       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);
@@ -61,6 +83,27 @@ class OSC : public ARDOUR::ControlProtocol
        int start ();
        int stop ();
 
+       static void* request_factory (uint32_t);
+
+       enum OSCDebugMode {
+               Off,
+               Unhandled,
+               All
+       };
+
+       std::string get_server_url ();
+       void set_debug_mode (OSCDebugMode m) { _debugmode = m; }
+       OSCDebugMode get_debug_mode () { return _debugmode; }
+
+  protected:
+        void thread_init ();
+       void do_request (OSCUIRequest*);
+
+       GSource* local_server;
+       GSource* remote_server;
+
+       bool osc_input_handler (Glib::IOCondition, lo_server);
+
   private:
        uint32_t _port;
        volatile bool _ok;
@@ -71,42 +114,60 @@ class OSC : public ARDOUR::ControlProtocol
        std::string _osc_url_file;
        std::string _namespace_root;
        bool _send_route_changes;
-       pthread_t _osc_thread;
-       int _request_pipe[2];
-
-       static void * _osc_receiver(void * arg);
-       void osc_receiver();
-       void send(); // This should accept an OSC payload
-
-       bool init_osc_thread ();
-       void terminate_osc_thread ();
-       void poke_osc_thread ();
+       OSCDebugMode _debugmode;
 
        void register_callbacks ();
 
        void route_added (ARDOUR::RouteList&);
-               
+
        // Handlers for "Application Hook" signals
        void session_loaded (ARDOUR::Session&);
        void session_exported (std::string, std::string);
 
        // end "Application Hook" handles
 
-       std::string get_server_url ();
        std::string get_unix_server_url ();
 
        void send_current_value (const char* path, lo_arg** argv, int argc, lo_message msg);
        void current_value_query (const char* path, size_t len, lo_arg **argv, int argc, lo_message msg);
+
+       int current_value (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data);
+
        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 current_value (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data);
+       void routes_list (lo_message msg);
+       void transport_frame (lo_message msg);
+       void transport_speed (lo_message msg);
+       void record_enabled (lo_message msg);
+
+#define OSC_DEBUG \
+       if (_debugmode == All) { \
+               PBD::info << "OSC: " << path << " " << types << endmsg; \
+       }
+
+#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 **, int, void *data) { \
+               OSC_DEBUG;              \
+               name (data);            \
+               return 0;               \
+       }
+
+       PATH_CALLBACK_MSG(routes_list);
+       PATH_CALLBACK_MSG(transport_frame);
+       PATH_CALLBACK_MSG(transport_speed);
+       PATH_CALLBACK_MSG(record_enabled);
 
 #define PATH_CALLBACK(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 *, const char *, lo_arg **, int, void *) { \
+        int cb_ ## name (const char *path, const char *types, lo_arg ** argv, int argc, void *) { \
+               OSC_DEBUG;              \
+               if (argc > 0 && !strcmp (types, "f") && argv[0]->f != 1.0) { return 0; } \
                name (); \
                return 0; \
        }
@@ -133,7 +194,8 @@ class OSC : public ARDOUR::ControlProtocol
         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 *, const char *, lo_arg **argv, int argc, void *) { \
+        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);          \
                 }                                                      \
@@ -147,32 +209,86 @@ class OSC : public ARDOUR::ControlProtocol
         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 *, const char *, lo_arg **argv, int argc, void *) { \
+        int cb_ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *) { \
+               OSC_DEBUG;              \
                 if (argc > 1) {                                                \
                        name (argv[0]->arg1type, argv[1]->arg2type); \
                 }                                                      \
                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 *) { \
+               OSC_DEBUG;              \
+                if (argc > 1) {                                                \
+                 name (argv[0]->arg1type, argv[1]->arg2type,argv[2]->arg3type); \
+                }                                                      \
+               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 *) { \
+               OSC_DEBUG;              \
+                if (argc > 1) {                                                \
+                 name (argv[0]->arg1type, argv[1]->arg2type,argv[2]->arg3type,argv[3]->arg4type); \
+                }                                                      \
+               return 0;                                               \
+       }
+
+        PATH_CALLBACK2(locate,i,i);
+        PATH_CALLBACK2(loop_location,i,i);
        PATH_CALLBACK2(route_mute,i,i);
        PATH_CALLBACK2(route_solo,i,i);
        PATH_CALLBACK2(route_recenable,i,i);
        PATH_CALLBACK2(route_set_gain_abs,i,f);
        PATH_CALLBACK2(route_set_gain_dB,i,f);
+       PATH_CALLBACK2(route_set_trim_abs,i,f);
+       PATH_CALLBACK2(route_set_trim_dB,i,f);
+       PATH_CALLBACK2(route_set_pan_stereo_position,i,f);
+       PATH_CALLBACK2(route_set_pan_stereo_width,i,f);
+        PATH_CALLBACK3(route_set_send_gain_abs,i,i,f);
+        PATH_CALLBACK3(route_set_send_gain_dB,i,i,f);
+        PATH_CALLBACK4(route_plugin_parameter,i,i,i,f);
+        PATH_CALLBACK3(route_plugin_parameter_print,i,i,i);
 
        int route_mute (int rid, int yn);
        int route_solo (int rid, int yn);
        int route_recenable (int rid, int yn);
        int route_set_gain_abs (int rid, float level);
        int route_set_gain_dB (int rid, float dB);
+       int route_set_trim_abs (int rid, float level);
+       int route_set_trim_dB (int rid, float dB);
+       int route_set_pan_stereo_position (int rid, float left_right_fraction);
+       int route_set_pan_stereo_width (int rid, float percent);
+       int route_set_send_gain_abs (int rid, int sid, float val);
+       int route_set_send_gain_dB (int rid, int sid, float val);
+       int route_plugin_parameter (int rid, int piid,int par, float val);
+       int route_plugin_parameter_print (int rid, int piid,int par);
 
        void listen_to_route (boost::shared_ptr<ARDOUR::Route>, lo_address);
        void end_listen (boost::shared_ptr<ARDOUR::Route>, lo_address);
        void drop_route (boost::weak_ptr<ARDOUR::Route>);
 
-       typedef std::list<OSCControllable*> Controllables;
+       void route_name_changed (const PBD::PropertyChange&, boost::weak_ptr<ARDOUR::Route> r, lo_address addr);
 
-       Controllables controllables;
+       void update_clock ();
+
+       typedef std::list<OSCRouteObserver*> RouteObservers;
+
+       RouteObservers route_observers;
+
+       static OSC* _instance;
+
+       mutable void *gui;
+       void build_gui ();
 };
 
+} // namespace
+
 #endif // ardour_osc_h