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 namespace ArdourSurface {
55 struct OSCUIRequest : public BaseUI::BaseRequestObject {
61 class OSC : public ARDOUR::ControlProtocol, public AbstractUI<OSCUIRequest>
64 OSC (ARDOUR::Session&, uint32_t port);
67 static OSC* instance() { return _instance; }
69 XMLNode& get_state ();
70 int set_state (const XMLNode&, int version);
72 int set_active (bool yn);
73 bool get_active () const;
74 int set_feedback (bool yn);
75 bool get_feedback () const;
77 void set_namespace_root (std::string);
84 void do_request (OSCUIRequest*);
86 GSource* local_server;
87 GSource* remote_server;
89 bool osc_input_handler (Glib::IOCondition, lo_server);
94 volatile bool _shutdown;
95 lo_server _osc_server;
96 lo_server _osc_unix_server;
97 std::string _osc_unix_socket_path;
98 std::string _osc_url_file;
99 std::string _namespace_root;
100 bool _send_route_changes;
102 void register_callbacks ();
104 void route_added (ARDOUR::RouteList&);
106 // Handlers for "Application Hook" signals
107 void session_loaded (ARDOUR::Session&);
108 void session_exported (std::string, std::string);
110 // end "Application Hook" handles
112 std::string get_server_url ();
113 std::string get_unix_server_url ();
115 void send_current_value (const char* path, lo_arg** argv, int argc, lo_message msg);
116 void current_value_query (const char* path, size_t len, lo_arg **argv, int argc, lo_message msg);
118 int current_value (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data);
120 int catchall (const char *path, const char *types, lo_arg **argv, int argc, void *data);
121 static int _catchall (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data);
123 void routes_list (lo_message msg);
124 void transport_frame(lo_message msg);
125 void transport_speed(lo_message msg);
126 void record_enabled(lo_message msg);
128 #define PATH_CALLBACK_MSG(name) \
129 static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
130 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
132 int cb_ ## name (const char *, const char *, lo_arg **, int, void *data) { \
137 PATH_CALLBACK_MSG(routes_list);
138 PATH_CALLBACK_MSG(transport_frame);
139 PATH_CALLBACK_MSG(transport_speed);
140 PATH_CALLBACK_MSG(record_enabled);
142 #define PATH_CALLBACK(name) \
143 static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
144 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
146 int cb_ ## name (const char *, const char *, lo_arg **, int, void *) { \
151 PATH_CALLBACK(add_marker);
152 PATH_CALLBACK(loop_toggle);
153 PATH_CALLBACK(goto_start);
154 PATH_CALLBACK(goto_end);
155 PATH_CALLBACK(rewind);
157 PATH_CALLBACK(transport_stop);
158 PATH_CALLBACK(transport_play);
159 PATH_CALLBACK(save_state);
160 PATH_CALLBACK(prev_marker);
161 PATH_CALLBACK(next_marker);
164 PATH_CALLBACK(toggle_punch_in);
165 PATH_CALLBACK(toggle_punch_out);
166 PATH_CALLBACK(rec_enable_toggle);
167 PATH_CALLBACK(toggle_all_rec_enables);
169 #define PATH_CALLBACK1(name,type,optional) \
170 static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
171 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
173 int cb_ ## name (const char *, const char *, lo_arg **argv, int argc, void *) { \
175 name (optional argv[0]->type); \
180 PATH_CALLBACK1(set_transport_speed,f,);
181 PATH_CALLBACK1(access_action,s,&);
183 #define PATH_CALLBACK2(name,arg1type,arg2type) \
184 static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
185 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
187 int cb_ ## name (const char *, const char *, lo_arg **argv, int argc, void *) { \
189 name (argv[0]->arg1type, argv[1]->arg2type); \
194 #define PATH_CALLBACK3(name,arg1type,arg2type,arg3type) \
195 static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
196 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
198 int cb_ ## name (const char *, const char *, lo_arg **argv, int argc, void *) { \
200 name (argv[0]->arg1type, argv[1]->arg2type,argv[2]->arg3type); \
205 #define PATH_CALLBACK4(name,arg1type,arg2type,arg3type,arg4type) \
206 static int _ ## name (const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { \
207 return static_cast<OSC*>(user_data)->cb_ ## name (path, types, argv, argc, data); \
209 int cb_ ## name (const char *, const char *, lo_arg **argv, int argc, void *) { \
211 name (argv[0]->arg1type, argv[1]->arg2type,argv[2]->arg3type,argv[3]->arg4type); \
216 PATH_CALLBACK2(locate,i,i);
217 PATH_CALLBACK2(loop_location,i,i);
218 PATH_CALLBACK2(route_mute,i,i);
219 PATH_CALLBACK2(route_solo,i,i);
220 PATH_CALLBACK2(route_recenable,i,i);
221 PATH_CALLBACK2(route_set_gain_abs,i,f);
222 PATH_CALLBACK2(route_set_gain_dB,i,f);
223 PATH_CALLBACK2(route_set_trim_abs,i,f);
224 PATH_CALLBACK2(route_set_trim_dB,i,f);
225 PATH_CALLBACK2(route_set_pan_stereo_position,i,f);
226 PATH_CALLBACK2(route_set_pan_stereo_width,i,f);
227 PATH_CALLBACK3(route_set_send_gain_abs,i,i,f);
228 PATH_CALLBACK3(route_set_send_gain_dB,i,i,f);
229 PATH_CALLBACK4(route_plugin_parameter,i,i,i,f);
230 PATH_CALLBACK3(route_plugin_parameter_print,i,i,i);
232 int route_mute (int rid, int yn);
233 int route_solo (int rid, int yn);
234 int route_recenable (int rid, int yn);
235 int route_set_gain_abs (int rid, float level);
236 int route_set_gain_dB (int rid, float dB);
237 int route_set_trim_abs (int rid, float level);
238 int route_set_trim_dB (int rid, float dB);
239 int route_set_pan_stereo_position (int rid, float left_right_fraction);
240 int route_set_pan_stereo_width (int rid, float percent);
241 int route_set_send_gain_abs (int rid, int sid, float val);
242 int route_set_send_gain_dB (int rid, int sid, float val);
243 int route_plugin_parameter (int rid, int piid,int par, float val);
244 int route_plugin_parameter_print (int rid, int piid,int par);
246 void listen_to_route (boost::shared_ptr<ARDOUR::Route>, lo_address);
247 void end_listen (boost::shared_ptr<ARDOUR::Route>, lo_address);
248 void drop_route (boost::weak_ptr<ARDOUR::Route>);
250 void route_name_changed (const PBD::PropertyChange&, boost::weak_ptr<ARDOUR::Route> r, lo_address addr);
252 void update_clock ();
255 typedef std::list<OSCRouteObserver*> RouteObservers;
257 RouteObservers route_observers;
259 static OSC* _instance;
264 #endif // ardour_osc_h