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 /* Valuators */
  51 #define NUM_VALUATORS 4
  52 #define VAL_X_VELOCITY "X Velocity"
  53 #define VAL_Y_VELOCITY "Y Velocity"
  54 #define VAL_ACCELERATION "Acceleration"
  55
  56 /**
  57  * Tuio device information, including list of current object
  58  */
  59 typedef struct _TuioDevice {
  60     lo_server server;
  61
  62     int fseq_new, fseq_old;
  63     int processed;
  64
  65     int num_subdev;
  66
  67     struct _Object *obj_list;
  68
  69     /* List of unused devices that can be allocated for use
  70      * with ObjectPtr. */
  71     struct _SubDevice *subdev_list;
  72
  73     /* Remaining variables are set by "Option" values */
  74     int tuio_port;
  75     int init_num_subdev;
  76     Bool post_button_events;
  77     int fseq_threshold; /* Maximum difference between consecutive fseq values
  78                            that will allow a packet to be dropped */
  79     Bool dynadd_subdev;
  80
  81 } TuioDeviceRec, *TuioDevicePtr;
  82
  83 /**
  84  * An "Object" can represent a tuio blob or cursor (/tuio/2Dcur or
  85  * /tuio/2Dblb
  86  */
  87 typedef struct _Object {
  88     struct _Object *next;
  89
  90     int id;
  91     float xpos, ypos;
  92     float xvel, yvel;
  93     int alive;
  94     struct _SubDevice *subdev;
  95
  96     /* Stores pending information about this object */
  97     struct {
  98         Bool alive;
  99         Bool set;
 100         Bool button;
 101         float xpos, ypos;
 102         float xvel, yvel;
 103     } pending;
 104 } ObjectRec, *ObjectPtr;
 105
 106 /**
 107  * Subdevices are special devices created at the creation of the first
 108  * tuio device (aka "core" device).  They are tuio devices but are only used
 109  * to route object movements through.
 110  */
 111 typedef struct _SubDevice {
 112     struct _SubDevice *next;
 113
 114     InputInfoPtr pInfo;
 115 } SubDeviceRec, *SubDevicePtr;
 116
 117 #endif
 118