peripheral.h

/*
 *  Copyright (C) 2014-2018 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#ifndef C_API_ADDONINSTANCE_PERIPHERAL_H
#define C_API_ADDONINSTANCE_PERIPHERAL_H

#include "../addon_base.h"

/* 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 /* __cplusplus */

  //============================================================================
  typedef enum PERIPHERAL_ERROR
  {
    PERIPHERAL_NO_ERROR = 0,

    PERIPHERAL_ERROR_UNKNOWN = -1,

    PERIPHERAL_ERROR_FAILED = -2,

    PERIPHERAL_ERROR_INVALID_PARAMETERS = -3,

    PERIPHERAL_ERROR_NOT_IMPLEMENTED = -4,

    PERIPHERAL_ERROR_NOT_CONNECTED = -5,

    PERIPHERAL_ERROR_CONNECTION_FAILED = -6,
  } PERIPHERAL_ERROR;
  //----------------------------------------------------------------------------

  // @name Peripheral types
  //{

  //============================================================================
  typedef enum PERIPHERAL_TYPE
  {
    PERIPHERAL_TYPE_UNKNOWN,

    PERIPHERAL_TYPE_JOYSTICK,

    PERIPHERAL_TYPE_KEYBOARD,

    PERIPHERAL_TYPE_MOUSE,
  } PERIPHERAL_TYPE;
  //----------------------------------------------------------------------------

  typedef struct PERIPHERAL_INFO
  {
    PERIPHERAL_TYPE type; 
    char* name; 
    uint16_t vendor_id; 
    uint16_t product_id; 
    unsigned int index; 
  } ATTR_PACKED PERIPHERAL_INFO;

  typedef struct PERIPHERAL_CAPABILITIES
  {
    bool provides_joysticks; 
    bool provides_joystick_rumble;
    bool provides_joystick_power_off;
    bool provides_buttonmaps; 
  } ATTR_PACKED PERIPHERAL_CAPABILITIES;

  //}

  // @name Event types
  //{

  //============================================================================
  typedef enum PERIPHERAL_EVENT_TYPE
  {
    PERIPHERAL_EVENT_TYPE_NONE,

    PERIPHERAL_EVENT_TYPE_DRIVER_BUTTON,

    PERIPHERAL_EVENT_TYPE_DRIVER_HAT,

    PERIPHERAL_EVENT_TYPE_DRIVER_AXIS,

    PERIPHERAL_EVENT_TYPE_SET_MOTOR,
  } PERIPHERAL_EVENT_TYPE;
  //----------------------------------------------------------------------------

  //============================================================================
  typedef enum JOYSTICK_STATE_BUTTON
  {
    JOYSTICK_STATE_BUTTON_UNPRESSED = 0x0,

    JOYSTICK_STATE_BUTTON_PRESSED = 0x1,
  } JOYSTICK_STATE_BUTTON;
  //----------------------------------------------------------------------------

  //============================================================================
  typedef enum JOYSTICK_STATE_HAT
  {
    JOYSTICK_STATE_HAT_UNPRESSED = 0x0,

    JOYSTICK_STATE_HAT_LEFT = 0x1,

    JOYSTICK_STATE_HAT_RIGHT = 0x2,

    JOYSTICK_STATE_HAT_UP = 0x4,

    JOYSTICK_STATE_HAT_DOWN = 0x8,

    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;
  //----------------------------------------------------------------------------

  //============================================================================
  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;
  } ATTR_PACKED PERIPHERAL_EVENT;

  //}

  // @name Joystick types
  //{

  typedef struct JOYSTICK_INFO
  {
    PERIPHERAL_INFO peripheral; 
    char* provider; 
    int requested_port; 
    unsigned int button_count; 
    unsigned int hat_count; 
    unsigned int axis_count; 
    unsigned int motor_count; 
    bool supports_poweroff; 
  } ATTR_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_KEY,

    JOYSTICK_DRIVER_PRIMITIVE_TYPE_MOUSE_BUTTON,

    JOYSTICK_DRIVER_PRIMITIVE_TYPE_RELPOINTER_DIRECTION,
  } JOYSTICK_DRIVER_PRIMITIVE_TYPE;
  //----------------------------------------------------------------------------

  typedef struct JOYSTICK_DRIVER_BUTTON
  {
    int index;
  } ATTR_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;
  } ATTR_PACKED JOYSTICK_DRIVER_HAT;

  //============================================================================
  typedef enum JOYSTICK_DRIVER_SEMIAXIS_DIRECTION
  {
    JOYSTICK_DRIVER_SEMIAXIS_NEGATIVE = -1,

    JOYSTICK_DRIVER_SEMIAXIS_UNKNOWN = 0,

    JOYSTICK_DRIVER_SEMIAXIS_POSITIVE = 1,
  } JOYSTICK_DRIVER_SEMIAXIS_DIRECTION;
  //----------------------------------------------------------------------------

  typedef struct JOYSTICK_DRIVER_SEMIAXIS
  {
    int index;
    int center;
    JOYSTICK_DRIVER_SEMIAXIS_DIRECTION direction;
    unsigned int range;
  } ATTR_PACKED JOYSTICK_DRIVER_SEMIAXIS;

  typedef struct JOYSTICK_DRIVER_MOTOR
  {
    int index;
  } ATTR_PACKED JOYSTICK_DRIVER_MOTOR;

  typedef struct JOYSTICK_DRIVER_KEY
  {
    char keycode[16];
  } ATTR_PACKED JOYSTICK_DRIVER_KEY;

  //============================================================================
  typedef enum JOYSTICK_DRIVER_MOUSE_INDEX
  {
    JOYSTICK_DRIVER_MOUSE_INDEX_UNKNOWN,

    JOYSTICK_DRIVER_MOUSE_INDEX_LEFT,

    JOYSTICK_DRIVER_MOUSE_INDEX_RIGHT,

    JOYSTICK_DRIVER_MOUSE_INDEX_MIDDLE,

    JOYSTICK_DRIVER_MOUSE_INDEX_BUTTON4,

    JOYSTICK_DRIVER_MOUSE_INDEX_BUTTON5,

    JOYSTICK_DRIVER_MOUSE_INDEX_WHEEL_UP,

    JOYSTICK_DRIVER_MOUSE_INDEX_WHEEL_DOWN,

    JOYSTICK_DRIVER_MOUSE_INDEX_HORIZ_WHEEL_LEFT,

    JOYSTICK_DRIVER_MOUSE_INDEX_HORIZ_WHEEL_RIGHT,
  } JOYSTICK_DRIVER_MOUSE_INDEX;
  //----------------------------------------------------------------------------

  typedef struct JOYSTICK_DRIVER_MOUSE_BUTTON
  {
    JOYSTICK_DRIVER_MOUSE_INDEX button;
  } ATTR_PACKED JOYSTICK_DRIVER_MOUSE_BUTTON;

  //============================================================================
  typedef enum JOYSTICK_DRIVER_RELPOINTER_DIRECTION
  {
    JOYSTICK_DRIVER_RELPOINTER_UNKNOWN,

    JOYSTICK_DRIVER_RELPOINTER_LEFT,

    JOYSTICK_DRIVER_RELPOINTER_RIGHT,

    JOYSTICK_DRIVER_RELPOINTER_UP,

    JOYSTICK_DRIVER_RELPOINTER_DOWN,
  } JOYSTICK_DRIVER_RELPOINTER_DIRECTION;
  //----------------------------------------------------------------------------

  typedef struct JOYSTICK_DRIVER_RELPOINTER
  {
    JOYSTICK_DRIVER_RELPOINTER_DIRECTION direction;
  } ATTR_PACKED JOYSTICK_DRIVER_RELPOINTER;

  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;
      struct JOYSTICK_DRIVER_KEY key;
      struct JOYSTICK_DRIVER_MOUSE_BUTTON mouse;
      struct JOYSTICK_DRIVER_RELPOINTER relpointer;
    };
  } ATTR_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_RELPOINTER,

    JOYSTICK_FEATURE_TYPE_ABSPOINTER,

    JOYSTICK_FEATURE_TYPE_WHEEL,

    JOYSTICK_FEATURE_TYPE_THROTTLE,

    JOYSTICK_FEATURE_TYPE_KEY,
  } JOYSTICK_FEATURE_TYPE;
  //----------------------------------------------------------------------------

  //============================================================================
  typedef enum JOYSTICK_FEATURE_PRIMITIVE
  {
    JOYSTICK_SCALAR_PRIMITIVE = 0,

    JOYSTICK_ANALOG_STICK_UP = 0,
    JOYSTICK_ANALOG_STICK_DOWN = 1,
    JOYSTICK_ANALOG_STICK_RIGHT = 2,
    JOYSTICK_ANALOG_STICK_LEFT = 3,

    JOYSTICK_ACCELEROMETER_POSITIVE_X = 0,
    JOYSTICK_ACCELEROMETER_POSITIVE_Y = 1,
    JOYSTICK_ACCELEROMETER_POSITIVE_Z = 2,

    JOYSTICK_MOTOR_PRIMITIVE = 0,

    JOYSTICK_WHEEL_LEFT = 0,
    JOYSTICK_WHEEL_RIGHT = 1,

    JOYSTICK_THROTTLE_UP = 0,
    JOYSTICK_THROTTLE_DOWN = 1,

    JOYSTICK_KEY_PRIMITIVE = 0,

    JOYSTICK_MOUSE_BUTTON = 0,

    JOYSTICK_RELPOINTER_UP = 0,
    JOYSTICK_RELPOINTER_DOWN = 1,
    JOYSTICK_RELPOINTER_RIGHT = 2,
    JOYSTICK_RELPOINTER_LEFT = 3,

    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];
  } ATTR_PACKED JOYSTICK_FEATURE;
  //}

  typedef struct AddonProps_Peripheral
  {
    const char* user_path; 
    const char* addon_path; 
  } ATTR_PACKED AddonProps_Peripheral;

  struct AddonInstance_Peripheral;

  typedef struct AddonToKodiFuncTable_Peripheral
  {
    KODI_HANDLE kodiInstance;

    void (*trigger_scan)(void* kodiInstance);

    void (*refresh_button_maps)(void* kodiInstance,
                                const char* device_name,
                                const char* controller_id);

    unsigned int (*feature_count)(void* kodiInstance,
                                  const char* controller_id,
                                  JOYSTICK_FEATURE_TYPE type);

    JOYSTICK_FEATURE_TYPE(*feature_type)
    (void* kodiInstance, const char* controller_id, const char* feature_name);
  } AddonToKodiFuncTable_Peripheral;


  typedef struct KodiToAddonFuncTable_Peripheral
  {
    KODI_HANDLE addonInstance;

    void(__cdecl* get_capabilities)(const struct AddonInstance_Peripheral* addonInstance,
                                    struct PERIPHERAL_CAPABILITIES* capabilities);

    PERIPHERAL_ERROR(__cdecl* perform_device_scan)
    (const struct AddonInstance_Peripheral* addonInstance,
     unsigned int* peripheral_count,
     struct PERIPHERAL_INFO** scan_results);

    void(__cdecl* free_scan_results)(const struct AddonInstance_Peripheral* addonInstance,
                                     unsigned int peripheral_count,
                                     struct PERIPHERAL_INFO* scan_results);

    PERIPHERAL_ERROR(__cdecl* get_events)
    (const struct AddonInstance_Peripheral* addonInstance,
     unsigned int* event_count,
     struct PERIPHERAL_EVENT** events);

    void(__cdecl* free_events)(const struct AddonInstance_Peripheral* addonInstance,
                               unsigned int event_count,
                               struct PERIPHERAL_EVENT* events);

    bool(__cdecl* send_event)(const struct AddonInstance_Peripheral* addonInstance,
                              const struct PERIPHERAL_EVENT* event);

    PERIPHERAL_ERROR(__cdecl* get_joystick_info)
    (const struct AddonInstance_Peripheral* addonInstance,
     unsigned int index,
     struct JOYSTICK_INFO* info);

    void(__cdecl* free_joystick_info)(const struct AddonInstance_Peripheral* addonInstance,
                                      struct JOYSTICK_INFO* info);

    PERIPHERAL_ERROR(__cdecl* get_appearance)
    (const struct AddonInstance_Peripheral* addonInstance,
     const struct JOYSTICK_INFO* joystick,
     char* buffer,
     unsigned int bufferSize);

    PERIPHERAL_ERROR(__cdecl* set_appearance)
    (const struct AddonInstance_Peripheral* addonInstance,
     const struct JOYSTICK_INFO* joystick,
     const char* controller_id);

    PERIPHERAL_ERROR(__cdecl* get_features)
    (const struct AddonInstance_Peripheral* addonInstance,
     const struct JOYSTICK_INFO* joystick,
     const char* controller_id,
     unsigned int* feature_count,
     struct JOYSTICK_FEATURE** features);

    void(__cdecl* free_features)(const struct AddonInstance_Peripheral* addonInstance,
                                 unsigned int feature_count,
                                 struct JOYSTICK_FEATURE* features);

    PERIPHERAL_ERROR(__cdecl* map_features)
    (const struct AddonInstance_Peripheral* addonInstance,
     const struct JOYSTICK_INFO* joystick,
     const char* controller_id,
     unsigned int feature_count,
     const struct JOYSTICK_FEATURE* features);

    PERIPHERAL_ERROR(__cdecl* get_ignored_primitives)
    (const struct AddonInstance_Peripheral* addonInstance,
     const struct JOYSTICK_INFO* joystick,
     unsigned int* feature_count,
     struct JOYSTICK_DRIVER_PRIMITIVE** primitives);

    void(__cdecl* free_primitives)(const struct AddonInstance_Peripheral* addonInstance,
                                   unsigned int,
                                   struct JOYSTICK_DRIVER_PRIMITIVE* primitives);

    PERIPHERAL_ERROR(__cdecl* set_ignored_primitives)
    (const struct AddonInstance_Peripheral* addonInstance,
     const struct JOYSTICK_INFO* joystick,
     unsigned int primitive_count,
     const struct JOYSTICK_DRIVER_PRIMITIVE* primitives);

    void(__cdecl* save_button_map)(const struct AddonInstance_Peripheral* addonInstance,
                                   const struct JOYSTICK_INFO* joystick);

    void(__cdecl* revert_button_map)(const struct AddonInstance_Peripheral* addonInstance,
                                     const struct JOYSTICK_INFO* joystick);

    void(__cdecl* reset_button_map)(const struct AddonInstance_Peripheral* addonInstance,
                                    const struct JOYSTICK_INFO* joystick,
                                    const char* controller_id);

    void(__cdecl* power_off_joystick)(const struct AddonInstance_Peripheral* addonInstance,
                                      unsigned int index);
  } KodiToAddonFuncTable_Peripheral;

  typedef struct AddonInstance_Peripheral
  {
    struct AddonProps_Peripheral* props;
    struct AddonToKodiFuncTable_Peripheral* toKodi;
    struct KodiToAddonFuncTable_Peripheral* toAddon;
  } AddonInstance_Peripheral;

#ifdef __cplusplus
} /* extern "C" */
#endif /* __cplusplus */

#endif /* !C_API_ADDONINSTANCE_PERIPHERAL_H */