aboutsummaryrefslogtreecommitdiff
path: root/hid.c
blob: d5248f7d069b803685e99907ffd2d03c98b03057 (plain)
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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
/* ---------------------------------------------------------------------------- */
/*                                                                              */
/* 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.  */
/*                                                                              */
/* Based on PureData by Miller Puckette and others.                             */
/*                                                                              */
/* ---------------------------------------------------------------------------- */


#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <ctype.h>

#ifdef __APPLE__
#include <sys/errno.h>
#include <sysexits.h>
#include <mach/mach.h>
#include <mach/mach_error.h>
#include <IOKit/IOKitLib.h>
#include <IOKit/IOCFPlugIn.h>
#include <IOKit/hid/IOHIDLib.h>
#include <IOKit/hid/IOHIDKeys.h>
#include <IOKit/hid/IOHIDUsageTables.h>
#include <CoreFoundation/CoreFoundation.h>
#include <Carbon/Carbon.h>

#ifndef __APPLE_CC__
#include "Carbon_Include.h"
#endif

#include <HID_Utilities.h>
#endif

#include "linuxhid.h"
#include "input_arrays.h"

static char *version = "$Revision: 1.1 $";

/*------------------------------------------------------------------------------
 *  CLASS DEF
 */
static t_class *hid_class;

typedef struct _hid {
  t_object            x_obj;
  t_int               x_fd;
  t_symbol            *x_devname;
  t_clock             *x_clock;
  int                 x_read_ok;
  int                 x_started;
  int                 x_delay;
#ifdef __gnu_linux__
  struct input_event  x_input_event; 
#elif defined (__APPLE__)
  IOHIDEventStruct event;
#endif
  t_outlet            *x_input_event_time_outlet;
  t_outlet            *x_input_event_type_outlet;
  t_outlet            *x_input_event_code_outlet;
  t_outlet            *x_input_event_value_outlet;
}t_hid;

/*------------------------------------------------------------------------------
 * IMPLEMENTATION                    
 */

void hid_stop(t_hid* x) {
  DEBUG(post("hid_stop"););
  
  if (x->x_fd >= 0 && x->x_started) { 
	  clock_unset(x->x_clock);
	  post("hid: polling stopped");
	  x->x_started = 0;
  }
}

static int hid_close(t_hid *x) {
	DEBUG(post("hid_close"););

/* just to be safe, stop it first */
	hid_stop(x);

   if (x->x_fd <0) return 0;
   close (x->x_fd);
	post ("[hid] closed %s",x->x_devname->s_name);
	
   return 1;
}

static int hid_open(t_hid *x, t_symbol *s) {
  int eventType, eventCode, buttons, rel_axes, abs_axes, ff;
#ifdef __gnu_linux__
  unsigned long bitmask[EV_MAX][NBITS(KEY_MAX)];
#endif
  char devicename[256] = "Unknown";
  DEBUG(post("hid_open");)

  hid_close(x);

  /* set obj device name to parameter 
   * otherwise set to default
   */  
  if (s != &s_)
    x->x_devname = s;
  
#ifdef __gnu_linux__
  /* open device */
  if (x->x_devname) {
	  /* open the device read-only, non-exclusive */
	  x->x_fd = open (x->x_devname->s_name, O_RDONLY | O_NONBLOCK);
	  /* test if device open */
	  if (x->x_fd < 0 ) { 
		  post("[hid] open %s failed",x->x_devname->s_name);
		  x->x_fd = -1;
		  return 0;
	  }
  } else return 1;
  
  /* read input_events from the HID_DEVICE stream 
   * It seems that is just there to flush the event input buffer?
   */
  while (read (x->x_fd, &(x->x_input_event), sizeof(struct input_event)) > -1);
  
  /* get name of device */
  ioctl(x->x_fd, EVIOCGNAME(sizeof(devicename)), devicename);
  post ("Configuring %s on %s",devicename,x->x_devname->s_name);

  /* get bitmask representing supported events (axes, buttons, etc.) */
  memset(bitmask, 0, sizeof(bitmask));
  ioctl(x->x_fd, EVIOCGBIT(0, EV_MAX), bitmask[0]);
  post("\nSupported events:");
    
  rel_axes = 0;
  abs_axes = 0;
  buttons = 0;
  ff = 0;
    
  /* cycle through all possible event types */
  for (eventType = 0; eventType < EV_MAX; eventType++) {
    if (test_bit(eventType, bitmask[0])) {
      post(" %s (type %d) ", events[eventType] ? events[eventType] : "?", eventType);
      //	post("Event type %d",eventType);

      /* get bitmask representing supported button types */
      ioctl(x->x_fd, EVIOCGBIT(eventType, KEY_MAX), bitmask[eventType]);

      /* cycle through all possible event codes (axes, keys, etc.) 
       * testing to see which are supported  
       */
      for (eventCode = 0; eventCode < KEY_MAX; eventCode++) 
	if (test_bit(eventCode, bitmask[eventType])) {
	  post("    Event code %d (%s)", eventCode, names[eventType] ? (names[eventType][eventCode] ? names[eventType][eventCode] : "?") : "?");

	  switch(eventType) {
// the API changed at some point...
#ifdef EV_RST
	  case EV_RST:
	    break;
#else 
	  case EV_SYN:
	    break;
#endif
	  case EV_KEY:
	    buttons++;
	    break;
	  case EV_REL:
	    rel_axes++;
	    break;
	  case EV_ABS:
	    abs_axes++;
	    break;
	  case EV_MSC:
	    break;
	  case EV_LED:
	    break;
	  case EV_SND:
	    break;
	  case EV_REP:
	    break;
	  case EV_FF:
	    ff++;
	    break;
	  }
	}
    }        
  }
    
  post ("\nUsing %d relative axes, %d absolute axes, and %d buttons.", rel_axes, abs_axes, buttons);
  if (ff > 0) post ("Detected %d force feedback types",ff);
  post ("\nWARNING * WARNING * WARNING * WARNING * WARNING * WARNING * WARNING");
  post ("This object is under development!  The interface could change at anytime!");
  post ("As I write cross-platform versions, the interface might have to change.");
  post ("WARNING * WARNING * WARNING * WARNING * WARNING * WARNING * WARNING\n");
#endif
  
  return 1;
}

static int hid_read(t_hid *x,int fd) 
{
	if (x->x_fd < 0) return 0;

#ifdef __gnu_linux__
	while (read (x->x_fd, &(x->x_input_event), sizeof(struct input_event)) > -1) {
		outlet_float (x->x_input_event_value_outlet, (int)x->x_input_event.value);
		outlet_float (x->x_input_event_code_outlet, x->x_input_event.code);
		outlet_float (x->x_input_event_type_outlet, x->x_input_event.type);
		/* input_event.time is a timeval struct from <sys/time.h> */
		/*   outlet_float (x->x_input_event_time_outlet, x->x_input_event.time); */
	}
#else defined (__APPLE__)
	pRecDevice pCurrentHIDDevice = GetSetCurrentDevice (gWindow);
	pRecElement pCurrentHIDElement = GetSetCurrentElement (gWindow);
	
	// if we have a good device and element which is not a collecion
	if (pCurrentHIDDevice && pCurrentHIDElement && (pCurrentHIDElement->type != kIOHIDElementTypeCollection))
	{
		SInt32 value = HIDGetElementValue (pCurrentHIDDevice, pCurrentHIDElement);
		SInt32 valueCal = HIDCalibrateValue (value, pCurrentHIDElement);
		SInt32 valueScale = HIDScaleValue (valueCal, pCurrentHIDElement);
	 }
#endif
  
	if (x->x_started) 
	{
		clock_delay(x->x_clock, x->x_delay);
	}

	return 1;    
}

/* Actions */
static void hid_float(t_hid* x) {
    DEBUG(post("hid_float");)
   
}

void hid_delay(t_hid* x, t_float f)  {
	DEBUG(post("hid_DELAY %f",f);)
		
/*	if the user sets the delay less than zero, reset to default */
	if ( f > 0 ) {	
		x->x_delay = (int)f;
	} else {
		x->x_delay = DEFAULT_DELAY;
	}
}

void hid_start(t_hid* x) {
	DEBUG(post("hid_start"););
  
   if (x->x_fd >= 0 && !x->x_started) {
		clock_delay(x->x_clock, DEFAULT_DELAY);
		post("hid: polling started");
		x->x_started = 1;
	} else {
		post("You need to set a input device (i.e /dev/input/event0)");
	}
}

/* setup functions */
static void hid_free(t_hid* x) {
  DEBUG(post("hid_free");)
    
  if (x->x_fd < 0) return;

  hid_stop(x);
  clock_free(x->x_clock);
  close (x->x_fd);
}

static void *hid_new(t_symbol *s) {
  int i;
  t_hid *x = (t_hid *)pd_new(hid_class);

  DEBUG(post("hid_new");)

  post("[hid] %s, written by Hans-Christoph Steiner <hans@eds.org>",version);  
#ifndef __linux__
	post("    !! WARNING !! WARNING !! WARNING !! WARNING !! WARNING !! WARNING !!");
	post("     This is a dummy, since this object only works with a Linux kernel!");
	post("    !! WARNING !! WARNING !! WARNING !! WARNING !! WARNING !! WARNING !!");
#endif

  /* init vars */
  x->x_fd = -1;
  x->x_read_ok = 1;
  x->x_started = 0;
  x->x_delay = DEFAULT_DELAY;
  x->x_devname = gensym(HID_DEVICE);

  x->x_clock = clock_new(x, (t_method)hid_read);
  
  /* create outlets for each axis */
  x->x_input_event_time_outlet = outlet_new(&x->x_obj, &s_float);
  x->x_input_event_type_outlet = outlet_new(&x->x_obj, &s_float);
  x->x_input_event_code_outlet = outlet_new(&x->x_obj, &s_float);
  x->x_input_event_value_outlet = outlet_new(&x->x_obj, &s_float);
  
  /* set to the value from the object argument, if that exists */
  if (s != &s_)
	  x->x_devname = s;
  
  /* Open the device and save settings */
  
  if (!hid_open(x,s)) return x;
  
  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),0,A_DEFSYM,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_delay,gensym("delay"),A_DEFFLOAT,0);
  class_addmethod(hid_class,(t_method) hid_open,gensym("open"),A_DEFSYM,0);
  class_addmethod(hid_class,(t_method) hid_close,gensym("close"),0);
  class_addmethod(hid_class,(t_method) hid_start,gensym("start"),0);
  class_addmethod(hid_class,(t_method) hid_start,gensym("poll"),0);
  class_addmethod(hid_class,(t_method) hid_stop,gensym("stop"),0);
  class_addmethod(hid_class,(t_method) hid_stop,gensym("nopoll"),0);
}