src/tuio.h

   1 /*
   2  * Copyright (c) 2009 Ryan Huffman
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a copy
   5  * of this software and associated documentation files (the "Software"), to deal
   6  * in the Software without restriction, including without limitation the rights
   7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8  * copies of the Software, and to permit persons to whom the Software is
   9  * furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in
  12  * all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  20  * THE SOFTWARE.
  21  *
  22  * Authors:
  23  *      Ryan Huffman (ryanhuffman@gmail.com)
  24  */
  25
  26 #ifndef TUIO_H
  27 #define TUIO_H
  28
  29 #include <X11/extensions/XI.h>
  30 #include <xf86Xinput.h>
  31 #include <lo/lo.h>
  32 #include <hal/libhal.h>
  33
  34 #ifndef Bool
  35 #define Bool int
  36 #endif
  37 #ifndef True
  38 #define True 1
  39 #endif
  40 #ifndef False
  41 #define False 0
  42 #endif
  43
  44 #define MIN_SUBDEVICES 0 /* min/max subdevices */
  45 #define MAX_SUBDEVICES 20
  46 #define DEFAULT_SUBDEVICES 5
  47
  48 #define DEFAULT_PORT 3333 /* Default UDP port to listen on */
  49
  50 /**
  51  * Tuio device information, including list of current object
  52  */
  53 typedef struct _TuioDevice {
  54     lo_server server;
  55
  56     int fseq_new, fseq_old;
  57     int processed;
  58
  59     int tuio_port;
  60     int num_subdev;
  61     Bool post_button_events;
  62     int fseq_threshold; /* Maximum difference between consecutive fseq values
  63                            that will allow a packet to be dropped */
  64
  65     struct _Object *obj_list;
  66
  67     /* List of unused devices that can be allocated for use
  68      * with ObjectPtr. */
  69     struct _SubDevice *subdev_list;
  70
  71 } TuioDeviceRec, *TuioDevicePtr;
  72
  73 /**
  74  * An "Object" can represent a tuio blob or cursor (/tuio/2Dcur or
  75  * /tuio/blob
  76  */
  77 typedef struct _Object {
  78     struct _Object *next;
  79
  80     int id;
  81     float x, y;
  82     int alive;
  83     struct _SubDevice *subdev;
  84
  85     /* Stores pending information about this object */
  86     struct {
  87         Bool alive;
  88         Bool set;
  89         Bool button;
  90         float x, y;
  91     } pending;
  92 } ObjectRec, *ObjectPtr;
  93
  94 /**
  95  * Subdevices are special devices created at the creation of the first
  96  * tuio device (aka "core" device).  They are tuio devices but are only used
  97  * to route object movements through.
  98  */
  99 typedef struct _SubDevice {
 100     struct _SubDevice *next;
 101
 102     InputInfoPtr pInfo;
 103 } SubDeviceRec, *SubDevicePtr;
 104
 105 #endif
 106