touch.h

Go to the documentation of this file.

/*
 * This file is part of the Ultibo project, https://ultibo.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2026 Garry Wood <garry@softoz.com.au>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#ifndef _ULTIBO_TOUCH_H
#define _ULTIBO_TOUCH_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "ultibo/globaltypes.h"
#include "ultibo/globalconst.h"
#include "ultibo/devices.h"

#define TOUCH_NAME_PREFIX   "Touch" 

#define TOUCH_TYPE_NONE 0
#define TOUCH_TYPE_RESISTIVE    1
#define TOUCH_TYPE_CAPACITIVE   2
 
#define TOUCH_TYPE_MAX  2

#define TOUCH_STATE_DISABLED    0
#define TOUCH_STATE_ENABLED 1
 
#define TOUCH_STATE_MAX 1

#define TOUCH_FLAG_NONE 0x00000000
#define TOUCH_FLAG_NON_BLOCK    0x00000001 
#define TOUCH_FLAG_PEEK_BUFFER  0x00000002 
#define TOUCH_FLAG_MOUSE_DATA   0x00000004 
#define TOUCH_FLAG_MULTI_POINT  0x00000008 
#define TOUCH_FLAG_PRESSURE 0x00000010 
#define TOUCH_FLAG_SWAP_XY  0x00000020 
#define TOUCH_FLAG_INVERT_X 0x00000040 
#define TOUCH_FLAG_INVERT_Y 0x00000080 
#define TOUCH_FLAG_SWAP_MAX_XY  0x00000100 
#define TOUCH_FLAG_RELEASE_TIMER    0x00000200 

#define TOUCH_FLAG_MASK TOUCH_FLAG_NON_BLOCK | TOUCH_FLAG_MOUSE_DATA | TOUCH_FLAG_MULTI_POINT | TOUCH_FLAG_PRESSURE | TOUCH_FLAG_SWAP_XY | TOUCH_FLAG_INVERT_X | TOUCH_FLAG_INVERT_Y | TOUCH_FLAG_SWAP_MAX_XY | TOUCH_FLAG_RELEASE_TIMER

#define TOUCH_CONTROL_GET_FLAG  1 
#define TOUCH_CONTROL_SET_FLAG  2 
#define TOUCH_CONTROL_CLEAR_FLAG    3 
#define TOUCH_CONTROL_FLUSH_BUFFER  4 
#define TOUCH_CONTROL_GET_WIDTH 5 
#define TOUCH_CONTROL_GET_HEIGHT    6 
#define TOUCH_CONTROL_GET_MAX_X 7 
#define TOUCH_CONTROL_GET_MAX_Y 8 
#define TOUCH_CONTROL_GET_MAX_Z 9 
#define TOUCH_CONTROL_GET_MAX_POINTS    10 
#define TOUCH_CONTROL_GET_ROTATION  11 
#define TOUCH_CONTROL_SET_ROTATION  12 
#define TOUCH_CONTROL_GET_CALLBACK  13 
#define TOUCH_CONTROL_SET_CALLBACK  14 

#define TOUCH_BUFFER_SIZE   1024

#define TOUCH_FINGER    0x00000001 

#define TOUCH_ID_UNKNOWN    (uint16_t)-1

#define TOUCH_X_UNKNOWN -1

#define TOUCH_Y_UNKNOWN -1

#define TOUCH_Z_UNKNOWN -1

#define TOUCH_ROTATION_0    FRAMEBUFFER_ROTATION_0 
#define TOUCH_ROTATION_90   FRAMEBUFFER_ROTATION_90 
#define TOUCH_ROTATION_180  FRAMEBUFFER_ROTATION_180 
#define TOUCH_ROTATION_270  FRAMEBUFFER_ROTATION_270 

typedef struct _TOUCH_DATA TOUCH_DATA;
struct _TOUCH_DATA
{
    uint32_t info; 
    uint16_t pointid; 
    int16_t positionx; 
    int16_t positiony; 
    int16_t positionz; 
    uint16_t touchwidth; 
    uint16_t touchheight; 
    void *parameter; 
};

typedef struct _TOUCH_BUFFER TOUCH_BUFFER;
struct _TOUCH_BUFFER
{
    SEMAPHORE_HANDLE wait; 
    uint32_t start; 
    uint32_t count; 
    TOUCH_DATA buffer[TOUCH_BUFFER_SIZE];
};

typedef struct _TOUCH_PROPERTIES TOUCH_PROPERTIES;
struct _TOUCH_PROPERTIES
{
    uint32_t flags; 
    uint32_t width; 
    uint32_t height; 
    uint32_t rotation; 
    uint32_t maxx; 
    uint32_t maxy; 
    uint32_t maxz; 
    uint32_t maxwidth; 
    uint32_t maxheight; 
    uint32_t maxpoints; 
};

typedef struct _TOUCH_DEVICE TOUCH_DEVICE;

typedef uint32_t STDCALL (*touch_event_cb)(TOUCH_DEVICE *touch, TOUCH_DATA *data);

typedef uint32_t STDCALL (*touch_enumerate_cb)(TOUCH_DEVICE *touch, void *data);
typedef uint32_t STDCALL (*touch_notification_cb)(DEVICE *device, void *data, uint32_t notification);

typedef uint32_t STDCALL (*touch_device_start_proc)(TOUCH_DEVICE *touch);
typedef uint32_t STDCALL (*touch_device_stop_proc)(TOUCH_DEVICE *touch);
 
typedef uint32_t STDCALL (*touch_device_peek_proc)(TOUCH_DEVICE *touch);
typedef uint32_t STDCALL (*touch_device_read_proc)(TOUCH_DEVICE *touch, void *buffer, uint32_t size, uint32_t flags, uint32_t *count);
typedef uint32_t STDCALL (*touch_device_write_proc)(TOUCH_DEVICE *touch, void *buffer, uint32_t size, uint32_t count);
typedef uint32_t STDCALL (*touch_device_flush_proc)(TOUCH_DEVICE *touch);
typedef uint32_t STDCALL (*touch_device_update_proc)(TOUCH_DEVICE *touch);
typedef uint32_t STDCALL (*touch_device_control_proc)(TOUCH_DEVICE *touch, int request, size_t argument1, size_t *argument2);
 
typedef uint32_t STDCALL (*touch_device_get_properties_proc)(TOUCH_DEVICE *touch, TOUCH_PROPERTIES *properties);
 
struct _TOUCH_DEVICE
{
    // Device Properties
    DEVICE device; 
    // Touch Properties
    uint32_t touchid; 
    uint32_t touchstate; 
    touch_device_start_proc devicestart; 
    touch_device_stop_proc devicestop; 
    touch_device_peek_proc devicepeek; 
    touch_device_read_proc deviceread; 
    touch_device_write_proc devicewrite; 
    touch_device_flush_proc deviceflush; 
    touch_device_update_proc deviceupdate; 
    touch_device_control_proc devicecontrol; 
    touch_device_get_properties_proc devicegetproperties; 
    // Driver Properties
    MUTEX_HANDLE lock; 
    touch_event_cb event; 
    void *parameter; 
    TOUCH_BUFFER buffer; 
    TOUCH_PROPERTIES properties; 
    // Statistics Properties
    uint32_t receivecount;
    uint32_t receiveerrors;
    uint32_t bufferoverruns;
    // Internal Properties
    TOUCH_DEVICE *prev; 
    TOUCH_DEVICE *next; 
};


uint32_t STDCALL touch_device_start(TOUCH_DEVICE *touch);

uint32_t STDCALL touch_device_stop(TOUCH_DEVICE *touch);

uint32_t STDCALL touch_device_peek(TOUCH_DEVICE *touch);

uint32_t STDCALL touch_device_read(TOUCH_DEVICE *touch, void *buffer, uint32_t size, uint32_t flags, uint32_t *count);

uint32_t STDCALL touch_device_write(TOUCH_DEVICE *touch, void *buffer, uint32_t size, uint32_t count);

uint32_t STDCALL touch_device_flush(TOUCH_DEVICE *touch);

uint32_t STDCALL touch_device_update(TOUCH_DEVICE *touch);

uint32_t STDCALL touch_device_control(TOUCH_DEVICE *touch, int request, size_t argument1, size_t *argument2);

uint32_t STDCALL touch_device_properties(TOUCH_DEVICE *touch, TOUCH_PROPERTIES *properties);

uint32_t STDCALL touch_device_get_properties(TOUCH_DEVICE *touch, TOUCH_PROPERTIES *properties);

TOUCH_DEVICE * STDCALL touch_device_create(void);

TOUCH_DEVICE * STDCALL touch_device_create_ex(uint32_t size);

uint32_t STDCALL touch_device_destroy(TOUCH_DEVICE *touch);

uint32_t STDCALL touch_device_register(TOUCH_DEVICE *touch);

uint32_t STDCALL touch_device_deregister(TOUCH_DEVICE *touch);

TOUCH_DEVICE * STDCALL touch_device_find(uint32_t touchid);

TOUCH_DEVICE * STDCALL touch_device_find_by_name(const char *name);

TOUCH_DEVICE * STDCALL touch_device_find_by_description(const char *description);

uint32_t STDCALL touch_device_enumerate(touch_enumerate_cb callback, void *data);

uint32_t STDCALL touch_device_notification(TOUCH_DEVICE *touch, touch_notification_cb callback, void *data, uint32_t notification, uint32_t flags);


uint32_t STDCALL touch_get_count(void);

TOUCH_DEVICE * STDCALL touch_device_get_default(void);

uint32_t STDCALL touch_device_set_default(TOUCH_DEVICE *touch);

TOUCH_DEVICE * STDCALL touch_device_check(TOUCH_DEVICE *touch);

uint32_t STDCALL touch_device_type_to_string(uint32_t touchtype, char *string, uint32_t len);

uint32_t STDCALL touch_device_state_to_string(uint32_t touchstate, char *string, uint32_t len);

uint32_t STDCALL touch_device_rotation_to_string(uint32_t rotation, char *string, uint32_t len);

uint32_t STDCALL touch_device_resolve_rotation(uint32_t rotation);

uint32_t STDCALL touch_device_set_callback(TOUCH_DEVICE *touch, touch_event_cb event, void *parameter);

uint32_t STDCALL touch_insert_data(TOUCH_DEVICE *touch, TOUCH_DATA *data, BOOL signal);
 
#ifdef __cplusplus
}
#endif
 
#endif // _ULTIBO_TOUCH_H