/usr/include/kodi/kodi_peripheral_types.h is in kodi-addons-dev 2:17.1+dfsg1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 | /*
* Copyright (C) 2014-2016 Team Kodi
* http://kodi.tv
*
* This Program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, or (at your option)
* any later version.
*
* This Program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this Program; see the file COPYING. If not, see
* <http://www.gnu.org/licenses/>.
*
*/
#ifndef __PERIPHERAL_TYPES_H__
#define __PERIPHERAL_TYPES_H__
#ifdef TARGET_WINDOWS
#include <windows.h>
#else
#ifndef __cdecl
#define __cdecl
#endif
#ifndef __declspec
#define __declspec(X)
#endif
#endif
#include <stdint.h>
#undef ATTRIBUTE_PACKED
#undef PRAGMA_PACK_BEGIN
#undef PRAGMA_PACK_END
#if defined(__GNUC__)
#if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 95)
#define ATTRIBUTE_PACKED __attribute__ ((packed))
#define PRAGMA_PACK 0
#endif
#endif
#if !defined(ATTRIBUTE_PACKED)
#define ATTRIBUTE_PACKED
#define PRAGMA_PACK 1
#endif
/* current Peripheral API version */
#define PERIPHERAL_API_VERSION "1.3.1"
/* min. Peripheral API version */
#define PERIPHERAL_MIN_API_VERSION "1.3.1"
/* indicates a joystick has no preference for port number */
#define NO_PORT_REQUESTED (-1)
/* joystick's driver button/hat/axis index is unknown */
#define DRIVER_INDEX_UNKNOWN (-1)
#ifdef __cplusplus
extern "C"
{
#endif
/// @name Peripheral types
///{
typedef enum PERIPHERAL_ERROR
{
PERIPHERAL_NO_ERROR = 0, // no error occurred
PERIPHERAL_ERROR_UNKNOWN = -1, // an unknown error occurred
PERIPHERAL_ERROR_FAILED = -2, // the command failed
PERIPHERAL_ERROR_INVALID_PARAMETERS = -3, // the parameters of the method are invalid for this operation
PERIPHERAL_ERROR_NOT_IMPLEMENTED = -4, // the method that the frontend called is not implemented
PERIPHERAL_ERROR_NOT_CONNECTED = -5, // no peripherals are connected
PERIPHERAL_ERROR_CONNECTION_FAILED = -6, // peripherals are connected, but command was interrupted
} PERIPHERAL_ERROR;
typedef enum PERIPHERAL_TYPE
{
PERIPHERAL_TYPE_UNKNOWN,
PERIPHERAL_TYPE_JOYSTICK,
} PERIPHERAL_TYPE;
typedef struct PERIPHERAL_INFO
{
PERIPHERAL_TYPE type; /*!< @brief type of peripheral */
char* name; /*!< @brief name of peripheral */
uint16_t vendor_id; /*!< @brief vendor ID of peripheral, 0x0000 if unknown */
uint16_t product_id; /*!< @brief product ID of peripheral, 0x0000 if unknown */
unsigned int index; /*!< @brief the order in which the add-on identified this peripheral */
} ATTRIBUTE_PACKED PERIPHERAL_INFO;
/*!
* @brief Properties passed to the Create() method of an add-on.
*/
typedef struct PERIPHERAL_PROPERTIES
{
const char* user_path; /*!< @brief path to the user profile */
const char* addon_path; /*!< @brief path to this add-on */
} ATTRIBUTE_PACKED PERIPHERAL_PROPERTIES;
/*!
* @brief Peripheral add-on capabilities.
* If a capability is set to true, then the corresponding methods from
* kodi_peripheral_dll.h need to be implemented.
*/
typedef struct PERIPHERAL_CAPABILITIES
{
bool provides_joysticks; /*!< @brief true if the add-on provides joysticks */
bool provides_joystick_rumble;
bool provides_joystick_power_off;
bool provides_buttonmaps; /*!< @brief true if the add-on provides button maps */
} ATTRIBUTE_PACKED PERIPHERAL_CAPABILITIES;
///}
/// @name Event types
///{
typedef enum PERIPHERAL_EVENT_TYPE
{
PERIPHERAL_EVENT_TYPE_NONE, /*!< @brief unknown event */
PERIPHERAL_EVENT_TYPE_DRIVER_BUTTON, /*!< @brief state changed for joystick driver button */
PERIPHERAL_EVENT_TYPE_DRIVER_HAT, /*!< @brief state changed for joystick driver hat */
PERIPHERAL_EVENT_TYPE_DRIVER_AXIS, /*!< @brief state changed for joystick driver axis */
PERIPHERAL_EVENT_TYPE_SET_MOTOR, /*!< @brief set the state for joystick rumble motor */
} PERIPHERAL_EVENT_TYPE;
typedef enum JOYSTICK_STATE_BUTTON
{
JOYSTICK_STATE_BUTTON_UNPRESSED = 0x0, /*!< @brief button is released */
JOYSTICK_STATE_BUTTON_PRESSED = 0x1, /*!< @brief button is pressed */
} JOYSTICK_STATE_BUTTON;
typedef enum JOYSTICK_STATE_HAT
{
JOYSTICK_STATE_HAT_UNPRESSED = 0x0, /*!< @brief no directions are pressed */
JOYSTICK_STATE_HAT_LEFT = 0x1, /*!< @brief only left is pressed */
JOYSTICK_STATE_HAT_RIGHT = 0x2, /*!< @brief only right is pressed */
JOYSTICK_STATE_HAT_UP = 0x4, /*!< @brief only up is pressed */
JOYSTICK_STATE_HAT_DOWN = 0x8, /*!< @brief only down is pressed */
JOYSTICK_STATE_HAT_LEFT_UP = JOYSTICK_STATE_HAT_LEFT | JOYSTICK_STATE_HAT_UP,
JOYSTICK_STATE_HAT_LEFT_DOWN = JOYSTICK_STATE_HAT_LEFT | JOYSTICK_STATE_HAT_DOWN,
JOYSTICK_STATE_HAT_RIGHT_UP = JOYSTICK_STATE_HAT_RIGHT | JOYSTICK_STATE_HAT_UP,
JOYSTICK_STATE_HAT_RIGHT_DOWN = JOYSTICK_STATE_HAT_RIGHT | JOYSTICK_STATE_HAT_DOWN,
} JOYSTICK_STATE_HAT;
/*!
* @brief value in the closed interval [-1.0, 1.0]
*
* The axis state uses the XInput coordinate system:
* - Negative values signify down or to the left
* - Positive values signify up or to the right
*/
typedef float JOYSTICK_STATE_AXIS;
typedef float JOYSTICK_STATE_MOTOR;
typedef struct PERIPHERAL_EVENT
{
unsigned int peripheral_index;
PERIPHERAL_EVENT_TYPE type;
unsigned int driver_index;
JOYSTICK_STATE_BUTTON driver_button_state;
JOYSTICK_STATE_HAT driver_hat_state;
JOYSTICK_STATE_AXIS driver_axis_state;
JOYSTICK_STATE_MOTOR motor_state;
} ATTRIBUTE_PACKED PERIPHERAL_EVENT;
///}
/// @name Joystick types
///{
typedef struct JOYSTICK_INFO
{
PERIPHERAL_INFO peripheral; /*!< @brief peripheral info for this joystick */
char* provider; /*!< @brief name of the driver or interface providing the joystick */
int requested_port; /*!< @brief requested port number (such as for 360 controllers), or NO_PORT_REQUESTED */
unsigned int button_count; /*!< @brief number of buttons reported by the driver */
unsigned int hat_count; /*!< @brief number of hats reported by the driver */
unsigned int axis_count; /*!< @brief number of axes reported by the driver */
unsigned int motor_count; /*!< @brief number of motors reported by the driver */
bool supports_poweroff; /*!< @brief whether the joystick supports being powered off */
} ATTRIBUTE_PACKED JOYSTICK_INFO;
typedef enum JOYSTICK_DRIVER_PRIMITIVE_TYPE
{
JOYSTICK_DRIVER_PRIMITIVE_TYPE_UNKNOWN,
JOYSTICK_DRIVER_PRIMITIVE_TYPE_BUTTON,
JOYSTICK_DRIVER_PRIMITIVE_TYPE_HAT_DIRECTION,
JOYSTICK_DRIVER_PRIMITIVE_TYPE_SEMIAXIS,
JOYSTICK_DRIVER_PRIMITIVE_TYPE_MOTOR,
} JOYSTICK_DRIVER_PRIMITIVE_TYPE;
typedef struct JOYSTICK_DRIVER_BUTTON
{
int index;
} ATTRIBUTE_PACKED JOYSTICK_DRIVER_BUTTON;
typedef enum JOYSTICK_DRIVER_HAT_DIRECTION
{
JOYSTICK_DRIVER_HAT_UNKNOWN,
JOYSTICK_DRIVER_HAT_LEFT,
JOYSTICK_DRIVER_HAT_RIGHT,
JOYSTICK_DRIVER_HAT_UP,
JOYSTICK_DRIVER_HAT_DOWN,
} JOYSTICK_DRIVER_HAT_DIRECTION;
typedef struct JOYSTICK_DRIVER_HAT
{
int index;
JOYSTICK_DRIVER_HAT_DIRECTION direction;
} ATTRIBUTE_PACKED JOYSTICK_DRIVER_HAT;
typedef enum JOYSTICK_DRIVER_SEMIAXIS_DIRECTION
{
JOYSTICK_DRIVER_SEMIAXIS_NEGATIVE = -1, /*!< @brief negative half of the axis */
JOYSTICK_DRIVER_SEMIAXIS_UNKNOWN = 0, /*!< @brief unknown direction */
JOYSTICK_DRIVER_SEMIAXIS_POSITIVE = 1, /*!< @brief positive half of the axis */
} JOYSTICK_DRIVER_SEMIAXIS_DIRECTION;
typedef struct JOYSTICK_DRIVER_SEMIAXIS
{
int index;
int center;
JOYSTICK_DRIVER_SEMIAXIS_DIRECTION direction;
unsigned int range;
} ATTRIBUTE_PACKED JOYSTICK_DRIVER_SEMIAXIS;
typedef struct JOYSTICK_DRIVER_MOTOR
{
int index;
} ATTRIBUTE_PACKED JOYSTICK_DRIVER_MOTOR;
typedef struct JOYSTICK_DRIVER_PRIMITIVE
{
JOYSTICK_DRIVER_PRIMITIVE_TYPE type;
union
{
struct JOYSTICK_DRIVER_BUTTON button;
struct JOYSTICK_DRIVER_HAT hat;
struct JOYSTICK_DRIVER_SEMIAXIS semiaxis;
struct JOYSTICK_DRIVER_MOTOR motor;
};
} ATTRIBUTE_PACKED JOYSTICK_DRIVER_PRIMITIVE;
typedef enum JOYSTICK_FEATURE_TYPE
{
JOYSTICK_FEATURE_TYPE_UNKNOWN,
JOYSTICK_FEATURE_TYPE_SCALAR,
JOYSTICK_FEATURE_TYPE_ANALOG_STICK,
JOYSTICK_FEATURE_TYPE_ACCELEROMETER,
JOYSTICK_FEATURE_TYPE_MOTOR,
} JOYSTICK_FEATURE_TYPE;
typedef enum JOYSTICK_FEATURE_PRIMITIVE
{
// Scalar feature
JOYSTICK_SCALAR_PRIMITIVE = 0,
// Analog stick
JOYSTICK_ANALOG_STICK_UP = 0,
JOYSTICK_ANALOG_STICK_DOWN = 1,
JOYSTICK_ANALOG_STICK_RIGHT = 2,
JOYSTICK_ANALOG_STICK_LEFT = 3,
// Accelerometer
JOYSTICK_ACCELEROMETER_POSITIVE_X = 0,
JOYSTICK_ACCELEROMETER_POSITIVE_Y = 1,
JOYSTICK_ACCELEROMETER_POSITIVE_Z = 2,
// Motor
JOYSTICK_MOTOR_PRIMITIVE = 0,
// Maximum number of primitives
JOYSTICK_PRIMITIVE_MAX = 4,
} JOYSTICK_FEATURE_PRIMITIVE;
typedef struct JOYSTICK_FEATURE
{
char* name;
JOYSTICK_FEATURE_TYPE type;
struct JOYSTICK_DRIVER_PRIMITIVE primitives[JOYSTICK_PRIMITIVE_MAX];
} ATTRIBUTE_PACKED JOYSTICK_FEATURE;
///}
//! @todo Mouse, light gun, multitouch
/*!
* @brief Structure to transfer the methods from kodi_peripheral_dll.h to the frontend
*/
typedef struct PeripheralAddon
{
const char* (__cdecl* GetPeripheralAPIVersion)(void);
const char* (__cdecl* GetMinimumPeripheralAPIVersion)(void);
PERIPHERAL_ERROR (__cdecl* GetAddonCapabilities)(PERIPHERAL_CAPABILITIES*);
PERIPHERAL_ERROR (__cdecl* PerformDeviceScan)(unsigned int*, PERIPHERAL_INFO**);
void (__cdecl* FreeScanResults)(unsigned int, PERIPHERAL_INFO*);
PERIPHERAL_ERROR (__cdecl* GetEvents)(unsigned int*, PERIPHERAL_EVENT**);
void (__cdecl* FreeEvents)(unsigned int, PERIPHERAL_EVENT*);
bool (__cdecl* SendEvent)(const PERIPHERAL_EVENT*);
/// @name Joystick operations
///{
PERIPHERAL_ERROR (__cdecl* GetJoystickInfo)(unsigned int, JOYSTICK_INFO*);
void (__cdecl* FreeJoystickInfo)(JOYSTICK_INFO*);
PERIPHERAL_ERROR (__cdecl* GetFeatures)(const JOYSTICK_INFO*, const char*, unsigned int*, JOYSTICK_FEATURE**);
void (__cdecl* FreeFeatures)(unsigned int, JOYSTICK_FEATURE*);
PERIPHERAL_ERROR (__cdecl* MapFeatures)(const JOYSTICK_INFO*, const char*, unsigned int, const JOYSTICK_FEATURE*);
PERIPHERAL_ERROR (__cdecl* GetIgnoredPrimitives)(const JOYSTICK_INFO*, unsigned int*, JOYSTICK_DRIVER_PRIMITIVE**);
void (__cdecl* FreePrimitives)(unsigned int, JOYSTICK_DRIVER_PRIMITIVE*);
PERIPHERAL_ERROR (__cdecl* SetIgnoredPrimitives)(const JOYSTICK_INFO*, unsigned int, const JOYSTICK_DRIVER_PRIMITIVE*);
void (__cdecl* SaveButtonMap)(const JOYSTICK_INFO*);
void (__cdecl* RevertButtonMap)(const JOYSTICK_INFO*);
void (__cdecl* ResetButtonMap)(const JOYSTICK_INFO*, const char*);
void (__cdecl* PowerOffJoystick)(unsigned int);
///}
} PeripheralAddon;
#ifdef __cplusplus
}
#endif
#endif // __PERIPHERAL_TYPES_H__
|