1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
|
/* --------------------------------------------------------------------------*/
/* */
/* MacOS X object to use HIDs (Human Interface Devices) */
/* Written by Hans-Christoph Steiner <hans@at.or.at> */
/* */
/* Copyright (c) 2004 Hans-Christoph Steiner */
/* */
/* 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. */
/* */
/* See file LICENSE for further informations on licensing terms. */
/* */
/* 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. */
/* */
/* --------------------------------------------------------------------------*/
#include "hid.h"
/*------------------------------------------------------------------------------
* LOCAL DEFINES
*/
#define DEBUG(x)
//#define DEBUG(x) x
static t_class *hid_class;
/*------------------------------------------------------------------------------
* FUNCTION PROTOTYPES
*/
void hid_start(t_hid *x, t_float f);
void hid_stop(t_hid *x);
t_int hid_open(t_hid *x, t_float f);
t_int hid_close(t_hid *x);
t_int hid_read(t_hid *x,int fd);
static void hid_float(t_hid* x, t_floatarg f);
/*------------------------------------------------------------------------------
* SUPPORT FUNCTIONS
*/
void hid_output_event(t_hid *x, char *type, char *code, t_float value)
{
t_atom event_data[3];
SETSYMBOL(event_data, gensym(type)); /* type */
SETSYMBOL(event_data + 1, gensym(code)); /* code */
SETFLOAT(event_data + 2, value); /* value */
outlet_anything(x->x_data_outlet,atom_gensym(event_data),2,event_data+1);
}
void hid_set_from_float(t_hid *x, t_floatarg f)
{
/* values greater than 1 set the polling delay time */
/* 1 and 0 for start/stop so you can use a [tgl] */
if (f > 1)
{
x->x_delay = (t_int)f;
hid_start(x,f);
}
else if (f == 1)
{
if (! x->x_started)
hid_start(x,f);
}
else if (f == 0)
{
hid_stop(x);
}
}
/*------------------------------------------------------------------------------
* IMPLEMENTATION
*/
/* stop polling the device */
void hid_stop(t_hid* x)
{
DEBUG(post("hid_stop"););
if (x->x_started)
{
clock_unset(x->x_clock);
DEBUG(post("[hid] polling stopped"););
x->x_started = 0;
}
}
/* close the device */
t_int hid_close(t_hid *x)
{
DEBUG(post("hid_close"););
/* just to be safe, stop it first */
hid_stop(x);
if(! hid_close_device(x))
{
post("[hid] closed device %d",x->x_device_number);
x->x_device_open = 0;
return (0);
}
return (1);
}
/* hid_open behavoir
* current state action
* ---------------------------------------
* closed / same device open
* open / same device no action
* closed / different device open
* open / different device close open
*/
t_int hid_open(t_hid *x, t_float f)
{
DEBUG(post("hid_open"););
/* store running state to be restored after the device has been opened */
t_int started = x->x_started;
/* only close the device if its different than the current and open */
if ( (f != x->x_device_number) && (x->x_device_open) )
hid_close(x);
if (f > 0)
x->x_device_number = f;
else
x->x_device_number = 0;
/* if device is open still, that means the same device is trying to be opened,
* therefore ignore the redundant open request. To reopen the same device,
* send a [close( msg, then an [open( msg. */
if (! x->x_device_open)
{
if (hid_open_device(x,x->x_device_number))
{
error("[hid] can not open device %d",x->x_device_number);
return (1);
}
else
{
x->x_device_open = 1;
}
}
/* restore the polling state so that when I [tgl] is used to start/stop [hid],
* the [tgl]'s state will continue to accurately reflect [hid]'s state */
if(started)
hid_set_from_float(x,x->x_delay);
return (0);
}
t_int hid_read(t_hid *x,int fd)
{
// DEBUG(post("hid_read"););
hid_get_events(x);
if (x->x_started)
{
clock_delay(x->x_clock, x->x_delay);
}
// TODO: why is this 1?
return 1;
}
void hid_start(t_hid* x, t_float f)
{
DEBUG(post("hid_start"););
/* if the user sets the delay less than one, ignore */
if( f >= 1 )
x->x_delay = (t_int)f;
if(!x->x_device_open)
hid_open(x,x->x_device_number);
if(!x->x_started)
{
clock_delay(x->x_clock, x->x_delay);
DEBUG(post("[hid] polling started"););
x->x_started = 1;
}
}
static void hid_float(t_hid* x, t_floatarg f)
{
DEBUG(post("hid_float"););
hid_set_from_float(x,f);
}
/* setup functions */
static void hid_free(t_hid* x)
{
DEBUG(post("hid_free"););
hid_close(x);
clock_free(x->x_clock);
hid_instance_count--;
hid_platform_specific_free(x);
}
/* create a new instance of this class */
static void *hid_new(t_float f)
{
t_hid *x = (t_hid *)pd_new(hid_class);
DEBUG(post("hid_new"););
/* only display the version when the first instance is loaded */
if(!hid_instance_count)
post("[hid] %d.%d, written by Hans-Christoph Steiner <hans@eds.org>",
HID_MAJOR_VERSION, HID_MINOR_VERSION);
#if !defined(__linux__) && !defined(__APPLE__)
error(" !! WARNING !! WARNING !! WARNING !! WARNING !! WARNING !! WARNING !!");
error(" This is a dummy, since this object only works GNU/Linux and MacOS X!");
error(" !! WARNING !! WARNING !! WARNING !! WARNING !! WARNING !! WARNING !!");
#endif
/* init vars */
x->x_has_ff = 0;
x->x_device_open = 0;
x->x_started = 0;
x->x_delay = DEFAULT_DELAY;
x->x_clock = clock_new(x, (t_method)hid_read);
/* create anything outlet used for HID data */
x->x_data_outlet = outlet_new(&x->x_obj, 0);
x->x_device_name_outlet = outlet_new(&x->x_obj, 0);
/* find and report the list of devices */
hid_build_device_list(x);
/* Open the device and save settings. If there is an error, return the object
* anyway, so that the inlets and outlets are created, thus not breaking the
* patch. */
if (hid_open(x,f))
error("[hid] device %d did not open",(t_int)f);
hid_instance_count++;
return (x);
}
void hid_setup(void)
{
DEBUG(post("hid_setup"););
hid_class = class_new(gensym("hid"),
(t_newmethod)hid_new,
(t_method)hid_free,
sizeof(t_hid),
CLASS_DEFAULT,
A_DEFFLOAT,0);
/* add inlet datatype methods */
class_addfloat(hid_class,(t_method) hid_float);
class_addbang(hid_class,(t_method) hid_read);
/* add inlet message methods */
class_addmethod(hid_class,(t_method) hid_build_device_list,gensym("refresh"),0);
class_addmethod(hid_class,(t_method) hid_print,gensym("print"),0);
class_addmethod(hid_class,(t_method) hid_open,gensym("open"),A_DEFFLOAT,0);
class_addmethod(hid_class,(t_method) hid_close,gensym("close"),0);
class_addmethod(hid_class,(t_method) hid_start,gensym("start"),A_DEFFLOAT,0);
class_addmethod(hid_class,(t_method) hid_start,gensym("poll"),A_DEFFLOAT,0);
class_addmethod(hid_class,(t_method) hid_stop,gensym("stop"),0);
class_addmethod(hid_class,(t_method) hid_stop,gensym("nopoll"),0);
/* force feedback messages */
class_addmethod(hid_class,(t_method) hid_ff_autocenter,
gensym("ff_autocenter"),A_DEFFLOAT,0);
class_addmethod(hid_class,(t_method) hid_ff_gain,gensym("ff_gain"),A_DEFFLOAT,0);
class_addmethod(hid_class,(t_method) hid_ff_motors,gensym("ff_motors"),A_DEFFLOAT,0);
class_addmethod(hid_class,(t_method) hid_ff_continue,gensym("ff_continue"),0);
class_addmethod(hid_class,(t_method) hid_ff_pause,gensym("ff_pause"),0);
class_addmethod(hid_class,(t_method) hid_ff_reset,gensym("ff_reset"),0);
class_addmethod(hid_class,(t_method) hid_ff_stopall,gensym("ff_stopall"),0);
/* ff tests */
class_addmethod(hid_class,(t_method) hid_ff_fftest,gensym("fftest"),A_DEFFLOAT,0);
class_addmethod(hid_class,(t_method) hid_ff_print,gensym("ff_print"),0);
}
|
