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