Made all the "glutJoystickXXX" functions part of the freeglut extensions.
[freeglut] / src / freeglut_input_devices.c
1 /*
2  * freeglut_input_devices.c
3  *
4  * Handles miscellaneous input devices via direct serial-port access.
5  * Proper X11 XInput device support is not yet supported.
6  * Also lacks Mac support.
7  *
8  * Written by Joe Krahn <krahn@niehs.nih.gov> 2005
9  *
10  * Copyright (c) 2005 Stephen J. Baker. All Rights Reserved.
11  *
12  * Permission is hereby granted, free of charge, to any person obtaining a
13  * copy of this software and associated documentation files (the "Software"),
14  * to deal in the Software without restriction, including without limitation
15  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
16  * and/or sell copies of the Software, and to permit persons to whom the
17  * Software is furnished to do so, subject to the following conditions:
18  *
19  * The above copyright notice and this permission notice shall be included
20  * in all copies or substantial portions of the Software.
21  *
22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
23  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
25  * PAWEL W. OLSZTA OR STEPHEN J. BAKER BE LIABLE FOR ANY CLAIM, DAMAGES OR
26  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
27  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
28  * DEALINGS IN THE SOFTWARE.
29  */
30
31 #ifdef HAVE_CONFIG_H
32 #    include "config.h"
33 #endif
34
35 #include <GL/freeglut.h>
36 #include "freeglut_internal.h"
37
38 #if TARGET_HOST_UNIX_X11
39 #include <errno.h>
40 #include <sys/ioctl.h>
41 #include <sys/time.h>
42 #include <time.h>
43 #include <stdio.h>
44 #include <stdlib.h>
45 #include <unistd.h>
46 #include <string.h>
47 #include <termios.h>
48 #include <fcntl.h>
49 #include <sys/types.h>
50
51 typedef struct {
52    int fd;
53    struct termios termio, termio_save;
54 } SERIALPORT;
55
56 #elif TARGET_HOST_WIN32
57 #include <sys/types.h>
58 #include <winbase.h>
59 typedef struct {
60    HANDLE fh;
61    COMMTIMEOUTS timeouts_save;
62    DCB dcb_save;
63 } SERIALPORT;
64
65 #endif
66
67 /********************* Dialbox definitions ***********************/
68
69 #define DIAL_NUM_VALUATORS 8
70
71         /* dial parser state machine states */
72 #define DIAL_NEW                -1
73 #define DIAL_WHICH_DEVICE       0
74 #define DIAL_VALUE_HIGH         1
75 #define DIAL_VALUE_LOW          2
76
77         /* dial/button box commands */
78 #define DIAL_INITIALIZE                 0x20
79 #define DIAL_SET_LEDS                   0x75
80 #define DIAL_SET_TEXT                   0x61
81 #define DIAL_SET_AUTO_DIALS             0x50
82 #define DIAL_SET_AUTO_DELTA_DIALS       0x51
83 #define DIAL_SET_FILTER                 0x53
84 #define DIAL_SET_BUTTONS_MOM_TYPE       0x71
85 #define DIAL_SET_AUTO_MOM_BUTTONS       0x73
86 #define DIAL_SET_ALL_LEDS               0x4b
87 #define DIAL_CLEAR_ALL_LEDS             0x4c
88
89         /* dial/button box replies and events */
90 #define DIAL_INITIALIZED        0x20
91 #define DIAL_BASE               0x30
92 #define DIAL_DELTA_BASE         0x40
93 #define DIAL_PRESS_BASE         0xc0
94 #define DIAL_RELEASE_BASE       0xe0
95
96         /* macros to determine reply type */
97 #define IS_DIAL_EVENT(ch)       (((ch)>=DIAL_BASE)&&((ch)<DIAL_BASE+DIAL_NUM_VALUATORS))
98 #define IS_KEY_PRESS(ch)        (((ch)>=DIAL_PRESS_BASE)&&((ch)<DIAL_PRESS_BASE+DIAL_NUM_BUTTONS))
99 #define IS_KEY_RELEASE(ch)      (((ch)>=DIAL_RELEASE_BASE)&&((ch)<DIAL_RELEASE_BASE+DIAL_NUM_BUTTONS))
100 #define IS_INIT_EVENT(ch)       ((ch)==DIAL_INITIALIZED)
101
102 /*****************************************************************/
103
104 static SERIALPORT *serial_open ( const char *device );
105 static void serial_close ( SERIALPORT *port );
106 static int serial_getchar ( SERIALPORT *port );
107 static int serial_putchar ( SERIALPORT *port, unsigned char ch );
108 static void serial_flush ( SERIALPORT *port );
109
110 static void send_dial_event(int dial, int value);
111 static void poll_dials(int id);
112
113 /* local variables */
114 static SERIALPORT *dialbox_port=NULL;
115
116 /*****************************************************************/
117
118 /*
119  * Implementation for glutDeviceGet(GLUT_HAS_DIAL_AND_BUTTON_BOX)
120  */
121 int fgInputDeviceDetect( void )
122 {
123     fgInitialiseInputDevices ();
124
125     if ( !dialbox_port )
126         return 0;
127
128     if ( !fgState.InputDevsInitialised )
129         return 0;
130
131     return 1;
132 }
133
134 /*
135  * Try initializing the input device(s)
136  */
137 void fgInitialiseInputDevices ( void )
138 {
139     const char *dial_device=NULL;
140     if( !fgState.InputDevsInitialised )
141     {
142         dial_device = getenv ( "GLUT_DIALS_SERIAL" );
143 #if TARGET_HOST_WIN32
144         if (!dial_device){
145             static char devname[256];
146             DWORD size=sizeof(devname);
147             DWORD type = REG_SZ;
148             HKEY key;
149             if (RegOpenKeyA(HKEY_LOCAL_MACHINE,"SOFTWARE\\FreeGLUT",&key)==ERROR_SUCCESS) {
150                 if (RegQueryValueExA(key,"DialboxSerialPort",NULL,&type,(LPBYTE)devname,&size)==ERROR_SUCCESS){
151                     dial_device=devname;
152                 }
153                 RegCloseKey(key);
154             }
155         }
156 #endif
157         if ( !dial_device ) return;
158         if ( !( dialbox_port = serial_open ( dial_device ) ) ) return;
159         serial_putchar(dialbox_port,DIAL_INITIALIZE);
160         glutTimerFunc ( 10, poll_dials, 0 );
161         fgState.InputDevsInitialised = GL_TRUE;
162     }
163 }
164
165 /*
166  *
167  */
168 void fgInputDeviceClose( void )
169 {
170     if ( fgState.InputDevsInitialised )
171     {
172         serial_close ( dialbox_port );
173         dialbox_port = NULL;
174         fgState.InputDevsInitialised = GL_FALSE;
175     }
176 }
177
178 /********************************************************************/
179
180 /* Check all windows for dialbox callbacks */
181 static void fghcbEnumDialCallbacks ( SFG_Window *window, SFG_Enumerator *enumerator )
182 {
183     /* Built-in to INVOKE_WCB():  if window->Callbacks[CB_Dials] */
184     INVOKE_WCB ( *window,Dials, ( ((int*)enumerator->data)[0], ((int*)enumerator->data)[1]) );
185     fgEnumSubWindows ( window, fghcbEnumDialCallbacks, enumerator );
186 }
187
188 static void send_dial_event ( int num, int value )
189 {
190     SFG_Enumerator enumerator;
191     int data[2];
192     data[0] = num;
193     data[1] = value;
194     enumerator.found = GL_FALSE;
195     enumerator.data  =  data;
196     fgEnumWindows ( fghcbEnumDialCallbacks, &enumerator );
197 }
198
199 /********************************************************************/
200 static void poll_dials ( int id )
201 {
202     int data;
203     static int dial_state = DIAL_NEW;
204     static int dial_which;
205     static int dial_value;
206     static int dials[8] = { 0, 0, 0, 0, 0, 0, 0, 0 };
207
208     if ( !dialbox_port ) return;
209
210     while ( (data=serial_getchar(dialbox_port)) != EOF )
211     {
212         if ( ( dial_state > DIAL_WHICH_DEVICE ) || IS_DIAL_EVENT ( data ) )
213         {
214             switch ( dial_state )
215             {
216                 case DIAL_WHICH_DEVICE:
217                     dial_which = data - DIAL_BASE;
218                 dial_state++;
219                 break;
220             case DIAL_VALUE_HIGH:
221                 dial_value = ( data << 8 );
222                 dial_state++;
223                 break;
224             case DIAL_VALUE_LOW:
225                 dial_value |= data;
226                 if ( dial_value & 0x8000 ) dial_value -= 0x10000;
227                 dials[dial_which] = dial_value;
228                 send_dial_event ( dial_which + 1, dial_value * 360 / 256 );
229                 dial_state = DIAL_WHICH_DEVICE;
230                 break;
231             default:
232                 /* error: Impossible state value! */
233                 break;
234             }
235         }
236         else if ( data == DIAL_INITIALIZED )
237         {
238             fgState.InputDevsInitialised = GL_TRUE;
239             dial_state = DIAL_WHICH_DEVICE;
240             serial_putchar(dialbox_port,DIAL_SET_AUTO_DIALS);
241             serial_putchar(dialbox_port,0xff);
242             serial_putchar(dialbox_port,0xff);
243         }
244         else  /* Unknown data; try flushing. */
245             serial_flush(dialbox_port);
246     }
247
248     glutTimerFunc ( 2, poll_dials, 0 );
249 }
250
251
252 /******** OS Specific Serial I/O routines *******/
253 #if TARGET_HOST_UNIX_X11 /* ==> Linux/BSD/UNIX POSIX serial I/O */
254 static SERIALPORT *serial_open ( const char *device )
255 {
256     int fd;
257     struct termios termio;
258     SERIALPORT *port;
259
260     fd = open(device, O_RDWR | O_NONBLOCK );
261     if (fd <0) {
262         perror(device);
263         return NULL;
264     }
265
266     port = malloc(sizeof(SERIALPORT));
267     memset(port, 0, sizeof(SERIALPORT));
268     port->fd = fd;
269
270     /* save current port settings */
271     tcgetattr(fd,&port->termio_save);
272
273     memset(&termio, 0, sizeof(termio));
274     cfmakeraw(&termio);
275     termio.c_cflag = CS8 | CREAD | HUPCL ;
276     termio.c_iflag = IGNPAR | IGNBRK ;
277     termio.c_cc[VTIME]    = 0;   /* inter-character timer */
278     termio.c_cc[VMIN]     = 1;   /* block read until 1 chars received, when blocking I/O */
279
280     cfsetispeed(&termio, B9600);
281     cfsetospeed(&termio, B9600);
282     tcsetattr(fd,TCSANOW,&termio);
283
284     serial_flush(port);
285     return port;
286 }
287
288 static void serial_close(SERIALPORT *port)
289 {
290     if (port)
291     {
292         /* restore old port settings */
293         tcsetattr(port->fd,TCSANOW,&port->termio_save);
294         close(port->fd);
295         free(port);
296     }
297 }
298
299 static int serial_getchar(SERIALPORT *port)
300 {
301     unsigned char ch;
302     if (!port) return EOF;
303     if (read(port->fd,&ch,1)) return ch;
304     return EOF;
305 }
306
307 static int serial_putchar(SERIALPORT *port, unsigned char ch){
308     if (!port) return 0;
309     return write(port->fd,&ch,1);
310 }
311
312 static void serial_flush ( SERIALPORT *port )
313 {
314     tcflush ( port->fd, TCIOFLUSH );
315 }
316
317 #elif TARGET_HOST_WIN32
318
319 static SERIALPORT *serial_open(const char *device){
320     HANDLE fh;
321     DCB dcb={sizeof(DCB)};
322     COMMTIMEOUTS timeouts;
323     SERIALPORT *port;
324
325     fh = CreateFile(device,GENERIC_READ|GENERIC_WRITE,0,NULL,
326       OPEN_EXISTING,FILE_ATTRIBUTE_NORMAL,NULL);
327     if (!fh) return NULL;
328
329     port = malloc(sizeof(SERIALPORT));
330     ZeroMemory(port, sizeof(SERIALPORT));
331     port->fh = fh;
332
333     /* save current port settings */
334     GetCommState(fh,&port->dcb_save);
335     GetCommTimeouts(fh,&port->timeouts_save);
336
337     dcb.DCBlength=sizeof(DCB);
338     BuildCommDCB("96,n,8,1",&dcb);
339     SetCommState(fh,&dcb);
340
341     ZeroMemory(&timeouts,sizeof(timeouts));
342     timeouts.ReadTotalTimeoutConstant=1;
343     timeouts.WriteTotalTimeoutConstant=1;
344     SetCommTimeouts(fh,&timeouts);
345
346     serial_flush(port);
347
348     return port;
349 }
350
351 static void serial_close(SERIALPORT *port){
352     if (port){
353         /* restore old port settings */
354         SetCommState(port->fh,&port->dcb_save);
355         SetCommTimeouts(port->fh,&port->timeouts_save);
356         CloseHandle(port->fh);
357         free(port);
358     }
359 }
360
361 static int serial_getchar(SERIALPORT *port){
362     DWORD n;
363     unsigned char ch;
364     if (!port) return EOF;
365     if (!ReadFile(port->fh,&ch,1,&n,NULL)) return EOF;
366     if (n==1) return ch;
367     return EOF;
368 }
369
370 static int serial_putchar(SERIALPORT *port, unsigned char ch){
371     DWORD n;
372     if (!port) return 0;
373     return WriteFile(port->fh,&ch,1,&n,NULL);
374 }
375
376 static void serial_flush ( SERIALPORT *port )
377 {
378     FlushFileBuffers(port->fh);
379 }
380
381 #endif