2 * Copyright (C) 2006-2009 Paul Davis
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.
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.
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.
28 #include <boost/shared_ptr.hpp>
32 #include <glibmm/main.h>
34 #define ABSTRACT_UI_EXPORTS
35 #include "pbd/abstract_ui.h"
37 #include "ardour/types.h"
38 #include "control_protocol/control_protocol.h"
40 class OSCControllable;
41 class OSCRouteObserver;
48 /* this is mostly a placeholder because I suspect that at some
49 point we will want to add more members to accomodate
50 certain types of requests to the OSC UI
53 struct OSCUIRequest : public BaseUI::BaseRequestObject {
59 class OSC : public ARDOUR::ControlProtocol, public AbstractUI<OSCUIRequest>
62 OSC (ARDOUR::Session&, uint32_t port);
65 static OSC* instance() { return _instance; }
67 XMLNode& get_state ();
68 int set_state (const XMLNode&, int version);
70 int set_active (bool yn);
71 bool get_active () const;
72 int set_feedback (bool yn);
73 bool get_feedback () const;
75 void set_namespace_root (std::string);
82 void do_request (OSCUIRequest*);
84 GSource* local_server;
85 GSource* remote_server;
87 bool osc_input_handler (Glib::IOCondition, lo_server);
92 volatile bool _shutdown;
93 lo_server _osc_server;
94 lo_server _osc_unix_server;
95 std::string _osc_unix_socket_path;
96 std::string _osc_url_file;
97 std::string _namespace_root;
98 bool _send_route_changes;
100 void register_callbacks ();
102 void route_added (ARDOUR::RouteList&);
104 // Handlers for "Application Hook" signals
105 void session_loaded (ARDOUR::Session&);
106 void session_exported (std::string, std::string);
108 // end "Application Hook" handles
110 std::string get_server_url ();
111 std::string get_unix_server_url ();
113 void send_current_value (const char* path, lo_arg** argv, int argc, lo_message msg);
114 void current_value_query (const char* path, size_t len, lo_arg **argv, int argc, lo_message msg);
116 int current_value (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data);
118 int catchall (const char *path, const char *types, lo_arg **argv, int argc, void *data);
119 static int _catchall (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data);
121 void routes_list (lo_message msg);
122 void transport_frame(lo_message msg);
124 #define PATH_CALLBACK_MSG(name) \
125 static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
126 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
128 int cb_ ## name (const char *, const char *, lo_arg **, int, void *data) { \
133 PATH_CALLBACK_MSG(routes_list);
134 PATH_CALLBACK_MSG(transport_frame);
136 #define PATH_CALLBACK(name) \
137 static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
138 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
140 int cb_ ## name (const char *, const char *, lo_arg **, int, void *) { \
145 PATH_CALLBACK(add_marker);
146 PATH_CALLBACK(loop_toggle);
147 PATH_CALLBACK(goto_start);
148 PATH_CALLBACK(goto_end);
149 PATH_CALLBACK(rewind);
151 PATH_CALLBACK(transport_stop);
152 PATH_CALLBACK(transport_play);
153 PATH_CALLBACK(save_state);
154 PATH_CALLBACK(prev_marker);
155 PATH_CALLBACK(next_marker);
158 PATH_CALLBACK(toggle_punch_in);
159 PATH_CALLBACK(toggle_punch_out);
160 PATH_CALLBACK(rec_enable_toggle);
161 PATH_CALLBACK(toggle_all_rec_enables);
163 #define PATH_CALLBACK1(name,type,optional) \
164 static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
165 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
167 int cb_ ## name (const char *, const char *, lo_arg **argv, int argc, void *) { \
169 name (optional argv[0]->type); \
174 PATH_CALLBACK1(set_transport_speed,f,);
175 PATH_CALLBACK1(access_action,s,&);
177 #define PATH_CALLBACK2(name,arg1type,arg2type) \
178 static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
179 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
181 int cb_ ## name (const char *, const char *, lo_arg **argv, int argc, void *) { \
183 name (argv[0]->arg1type, argv[1]->arg2type); \
188 #define PATH_CALLBACK3(name,arg1type,arg2type,arg3type) \
189 static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
190 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
192 int cb_ ## name (const char *, const char *, lo_arg **argv, int argc, void *) { \
194 name (argv[0]->arg1type, argv[1]->arg2type,argv[2]->arg3type); \
199 #define PATH_CALLBACK4(name,arg1type,arg2type,arg3type,arg4type) \
200 static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
201 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
203 int cb_ ## name (const char *, const char *, lo_arg **argv, int argc, void *) { \
205 name (argv[0]->arg1type, argv[1]->arg2type,argv[2]->arg3type,argv[3]->arg4type); \
210 PATH_CALLBACK2(locate,i,i);
211 PATH_CALLBACK2(route_mute,i,i);
212 PATH_CALLBACK2(route_solo,i,i);
213 PATH_CALLBACK2(route_recenable,i,i);
214 PATH_CALLBACK2(route_set_gain_abs,i,f);
215 PATH_CALLBACK2(route_set_gain_dB,i,f);
216 PATH_CALLBACK2(route_set_pan_stereo_position,i,f);
217 PATH_CALLBACK2(route_set_pan_stereo_width,i,f);
218 PATH_CALLBACK3(route_set_send_gain_abs,i,i,f);
219 PATH_CALLBACK3(route_set_send_gain_dB,i,i,f);
220 PATH_CALLBACK4(route_plugin_parameter,i,i,i,f);
221 PATH_CALLBACK3(route_plugin_parameter_print,i,i,i);
223 int route_mute (int rid, int yn);
224 int route_solo (int rid, int yn);
225 int route_recenable (int rid, int yn);
226 int route_set_gain_abs (int rid, float level);
227 int route_set_gain_dB (int rid, float dB);
228 int route_set_pan_stereo_position (int rid, float left_right_fraction);
229 int route_set_pan_stereo_width (int rid, float percent);
230 int route_set_send_gain_abs (int rid, int sid, float val);
231 int route_set_send_gain_dB (int rid, int sid, float val);
232 int route_plugin_parameter (int rid, int piid,int par, float val);
233 int route_plugin_parameter_print (int rid, int piid,int par);
235 void listen_to_route (boost::shared_ptr<ARDOUR::Route>, lo_address);
236 void end_listen (boost::shared_ptr<ARDOUR::Route>, lo_address);
237 void drop_route (boost::weak_ptr<ARDOUR::Route>);
239 void route_name_changed (const PBD::PropertyChange&, boost::weak_ptr<ARDOUR::Route> r, lo_address addr);
241 void update_clock ();
244 typedef std::list<OSCRouteObserver*> RouteObservers;
246 RouteObservers route_observers;
248 static OSC* _instance;
251 #endif // ardour_osc_h