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 #define MIN_SUBDEVICES 1
  35 #define MAX_SUBDEVICES 20
  36 #define DEFAULT_PORT 3333
  37
  38 /**
  39  * Tuio device information, including list of current object
  40  */
  41 typedef struct _TuioDevice {
  42     lo_server server;
  43
  44     int fseq_new, fseq_old;
  45     int processed;
  46
  47     int tuio_port;
  48     int num_subdev;
  49
  50     struct _Object *obj_list;
  51
  52     /* List of unused devices that can be allocated for use
  53      * by ObjectPtr. */
  54     struct _ObjectDev *unused_device_list;
  55
  56 } TuioDeviceRec, *TuioDevicePtr;
  57
  58 /**
  59  * An "Object" can represent a tuio blob or cursor (/tuio/2Dcur or
  60  * /tuio/blob
  61  */
  62 typedef struct _Object {
  63     int id;
  64     float x, y;
  65     int alive;
  66     struct _ObjectDev *objdev;
  67
  68     /* Stores pending information about this object */
  69     struct {
  70         Bool alive;
  71         Bool set;
  72         float x, y;
  73     } pending;
  74
  75     struct _Object *next;
  76
  77 } ObjectRec, *ObjectPtr;
  78
  79 /**
  80  * Object devices are special devices created at the creation of the first
  81  * tuio device (aka "core device).  They are tuio devices but are only used
  82  * to route object movements through.
  83  */
  84 typedef struct _ObjectDev {
  85     InputInfoPtr pInfo;
  86     struct _ObjectDev *next;
  87 } ObjectDevRec, *ObjectDevPtr;
  88
  89 #endif
  90