aboutsummaryrefslogtreecommitdiff
path: root/hid.c
diff options
context:
space:
mode:
Diffstat (limited to 'hid.c')
-rw-r--r--hid.c351
1 files changed, 351 insertions, 0 deletions
diff --git a/hid.c b/hid.c
new file mode 100644
index 0000000..d5248f7
--- /dev/null
+++ b/hid.c
@@ -0,0 +1,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);
+}
+