kc3-lang/SDL/src/joystick/hidapi/SDL_hidapi_xbox360w.c

• Show log

  Commit

• Hash : fa2063fb
  Author :
  Date : 2022-09-22T23:42:25
  

  Improved detection of third party PS4 and PS5 controllers

Download

• src/joystick/hidapi/SDL_hidapi_xbox360w.c

• /*
    Simple DirectMedia Layer
    Copyright (C) 1997-2022 Sam Lantinga <slouken@libsdl.org>
  
    This software is provided 'as-is', without any express or implied
    warranty.  In no event will the authors be held liable for any damages
    arising from the use of this software.
  
    Permission is granted to anyone to use this software for any purpose,
    including commercial applications, and to alter it and redistribute it
    freely, subject to the following restrictions:
  
    1. The origin of this software must not be misrepresented; you must not
       claim that you wrote the original software. If you use this software
       in a product, an acknowledgment in the product documentation would be
       appreciated but is not required.
    2. Altered source versions must be plainly marked as such, and must not be
       misrepresented as being the original software.
    3. This notice may not be removed or altered from any source distribution.
  */
  #include "../../SDL_internal.h"
  
  #ifdef SDL_JOYSTICK_HIDAPI
  
  #include "SDL_events.h"
  #include "SDL_timer.h"
  #include "SDL_joystick.h"
  #include "SDL_gamecontroller.h"
  #include "../../SDL_hints_c.h"
  #include "../SDL_sysjoystick.h"
  #include "SDL_hidapijoystick_c.h"
  #include "SDL_hidapi_rumble.h"
  
  
  #ifdef SDL_JOYSTICK_HIDAPI_XBOX360
  
  /* Define this if you want to log all packets from the controller */
  /*#define DEBUG_XBOX_PROTOCOL*/
  
  
  typedef struct {
      SDL_HIDAPI_Device *device;
      SDL_bool connected;
      int player_index;
      SDL_bool player_lights;
      Uint8 last_state[USB_PACKET_LENGTH];
  } SDL_DriverXbox360W_Context;
  
  
  static void
  HIDAPI_DriverXbox360W_RegisterHints(SDL_HintCallback callback, void *userdata)
  {
      SDL_AddHintCallback(SDL_HINT_JOYSTICK_HIDAPI_XBOX, callback, userdata);
      SDL_AddHintCallback(SDL_HINT_JOYSTICK_HIDAPI_XBOX_360, callback, userdata);
      SDL_AddHintCallback(SDL_HINT_JOYSTICK_HIDAPI_XBOX_360_WIRELESS, callback, userdata);
  }
  
  static void
  HIDAPI_DriverXbox360W_UnregisterHints(SDL_HintCallback callback, void *userdata)
  {
      SDL_DelHintCallback(SDL_HINT_JOYSTICK_HIDAPI_XBOX, callback, userdata);
      SDL_DelHintCallback(SDL_HINT_JOYSTICK_HIDAPI_XBOX_360, callback, userdata);
      SDL_DelHintCallback(SDL_HINT_JOYSTICK_HIDAPI_XBOX_360_WIRELESS, callback, userdata);
  }
  
  static SDL_bool
  HIDAPI_DriverXbox360W_IsEnabled(void)
  {
      return SDL_GetHintBoolean(SDL_HINT_JOYSTICK_HIDAPI_XBOX_360_WIRELESS,
                 SDL_GetHintBoolean(SDL_HINT_JOYSTICK_HIDAPI_XBOX_360,
                     SDL_GetHintBoolean(SDL_HINT_JOYSTICK_HIDAPI_XBOX,
                         SDL_GetHintBoolean(SDL_HINT_JOYSTICK_HIDAPI,
                             SDL_HIDAPI_DEFAULT))));
  }
  
  static SDL_bool
  HIDAPI_DriverXbox360W_IsSupportedDevice(SDL_HIDAPI_Device *device, const char *name, SDL_GameControllerType type, Uint16 vendor_id, Uint16 product_id, Uint16 version, int interface_number, int interface_class, int interface_subclass, int interface_protocol)
  {
      const int XB360W_IFACE_PROTOCOL = 129; /* Wireless */
  
      if ((vendor_id == USB_VENDOR_MICROSOFT && (product_id == 0x0291 || product_id == 0x02a9 || product_id == 0x0719) && interface_protocol == 0) ||
          (type == SDL_CONTROLLER_TYPE_XBOX360 && interface_protocol == XB360W_IFACE_PROTOCOL)) {
          return SDL_TRUE;
      }
      return SDL_FALSE;
  }
  
  static SDL_bool SetSlotLED(SDL_hid_device *dev, Uint8 slot, SDL_bool on)
  {
      const SDL_bool blink = SDL_FALSE;
      Uint8 mode = on ? ((blink ? 0x02 : 0x06) + slot) : 0;
      Uint8 led_packet[] = { 0x00, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
  
      led_packet[3] = 0x40 + (mode % 0x0e);
      if (SDL_hid_write(dev, led_packet, sizeof(led_packet)) != sizeof(led_packet)) {
          return SDL_FALSE;
      }
      return SDL_TRUE;
  }
  
  static void UpdateSlotLED(SDL_DriverXbox360W_Context *ctx)
  {
      if (ctx->player_lights && ctx->player_lights >= 0) {
          SetSlotLED(ctx->device->dev, (ctx->player_index % 4), SDL_TRUE);
      } else {
          SetSlotLED(ctx->device->dev, 0, SDL_FALSE);
      }
  }
  
  static void SDLCALL SDL_PlayerLEDHintChanged(void *userdata, const char *name, const char *oldValue, const char *hint)
  {
      SDL_DriverXbox360W_Context *ctx = (SDL_DriverXbox360W_Context *)userdata;
      SDL_bool player_lights = SDL_GetStringBoolean(hint, SDL_TRUE);
  
      if (player_lights != ctx->player_lights) {
          ctx->player_lights = player_lights;
  
          UpdateSlotLED(ctx);
      }
  }
  
  static void
  UpdatePowerLevel(SDL_Joystick *joystick, Uint8 level)
  {
      float normalized_level = (float)level / 255.0f;
  
      if (normalized_level <= 0.05f) {
          SDL_PrivateJoystickBatteryLevel(joystick, SDL_JOYSTICK_POWER_EMPTY);
      } else if (normalized_level <= 0.20f) {
          SDL_PrivateJoystickBatteryLevel(joystick, SDL_JOYSTICK_POWER_LOW);
      } else if (normalized_level <= 0.70f) {
          SDL_PrivateJoystickBatteryLevel(joystick, SDL_JOYSTICK_POWER_MEDIUM);
      } else {
          SDL_PrivateJoystickBatteryLevel(joystick, SDL_JOYSTICK_POWER_FULL);
      }
  }
  
  static SDL_bool
  HIDAPI_DriverXbox360W_InitDevice(SDL_HIDAPI_Device *device)
  {
      SDL_DriverXbox360W_Context *ctx;
  
      /* Requests controller presence information from the wireless dongle */
      const Uint8 init_packet[] = { 0x08, 0x00, 0x0F, 0xC0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
  
      HIDAPI_SetDeviceName(device, "Xbox 360 Wireless Controller");
  
      ctx = (SDL_DriverXbox360W_Context *)SDL_calloc(1, sizeof(*ctx));
      if (!ctx) {
          SDL_OutOfMemory();
          return SDL_FALSE;
      }
      ctx->device = device;
  
      device->context = ctx;
  
      if (SDL_hid_write(device->dev, init_packet, sizeof(init_packet)) != sizeof(init_packet)) {
          SDL_SetError("Couldn't write init packet");
          return SDL_FALSE;
      }
  
      device->type = SDL_CONTROLLER_TYPE_XBOX360;
  
      return SDL_TRUE;
  }
  
  static int
  HIDAPI_DriverXbox360W_GetDevicePlayerIndex(SDL_HIDAPI_Device *device, SDL_JoystickID instance_id)
  {
      return -1;
  }
  
  static void
  HIDAPI_DriverXbox360W_SetDevicePlayerIndex(SDL_HIDAPI_Device *device, SDL_JoystickID instance_id, int player_index)
  {
      SDL_DriverXbox360W_Context *ctx = (SDL_DriverXbox360W_Context *)device->context;
  
      if (!ctx) {
          return;
      }
  
      ctx->player_index = player_index;
  
      UpdateSlotLED(ctx);
  }
  
  static SDL_bool
  HIDAPI_DriverXbox360W_OpenJoystick(SDL_HIDAPI_Device *device, SDL_Joystick *joystick)
  {
      SDL_DriverXbox360W_Context *ctx = (SDL_DriverXbox360W_Context *)device->context;
  
      SDL_zeroa(ctx->last_state);
  
      /* Initialize player index (needed for setting LEDs) */
      ctx->player_index = SDL_JoystickGetPlayerIndex(joystick);
      ctx->player_lights = SDL_GetHintBoolean(SDL_HINT_JOYSTICK_HIDAPI_XBOX_360_PLAYER_LED, SDL_TRUE);
      UpdateSlotLED(ctx);
  
      SDL_AddHintCallback(SDL_HINT_JOYSTICK_HIDAPI_XBOX_360_PLAYER_LED,
                          SDL_PlayerLEDHintChanged, ctx);
  
      /* Initialize the joystick capabilities */
      joystick->nbuttons = 15;
      joystick->naxes = SDL_CONTROLLER_AXIS_MAX;
      joystick->epowerlevel = SDL_JOYSTICK_POWER_UNKNOWN;
  
      return SDL_TRUE;
  }
  
  static int
  HIDAPI_DriverXbox360W_RumbleJoystick(SDL_HIDAPI_Device *device, SDL_Joystick *joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble)
  {
      Uint8 rumble_packet[] = { 0x00, 0x01, 0x0f, 0xc0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
  
      rumble_packet[5] = (low_frequency_rumble >> 8);
      rumble_packet[6] = (high_frequency_rumble >> 8);
  
      if (SDL_HIDAPI_SendRumble(device, rumble_packet, sizeof(rumble_packet)) != sizeof(rumble_packet)) {
          return SDL_SetError("Couldn't send rumble packet");
      }
      return 0;
  }
  
  static int
  HIDAPI_DriverXbox360W_RumbleJoystickTriggers(SDL_HIDAPI_Device *device, SDL_Joystick *joystick, Uint16 left_rumble, Uint16 right_rumble)
  {
      return SDL_Unsupported();
  }
  
  static Uint32
  HIDAPI_DriverXbox360W_GetJoystickCapabilities(SDL_HIDAPI_Device *device, SDL_Joystick *joystick)
  {
      /* Doesn't have an RGB LED, so don't return SDL_JOYCAP_LED here */
      return SDL_JOYCAP_RUMBLE;
  }
  
  static int
  HIDAPI_DriverXbox360W_SetJoystickLED(SDL_HIDAPI_Device *device, SDL_Joystick *joystick, Uint8 red, Uint8 green, Uint8 blue)
  {
      return SDL_Unsupported();
  }
  
  static int
  HIDAPI_DriverXbox360W_SendJoystickEffect(SDL_HIDAPI_Device *device, SDL_Joystick *joystick, const void *data, int size)
  {
      return SDL_Unsupported();
  }
  
  static int
  HIDAPI_DriverXbox360W_SetJoystickSensorsEnabled(SDL_HIDAPI_Device *device, SDL_Joystick *joystick, SDL_bool enabled)
  {
      return SDL_Unsupported();
  }
  
  static void
  HIDAPI_DriverXbox360W_HandleStatePacket(SDL_Joystick *joystick, SDL_hid_device *dev, SDL_DriverXbox360W_Context *ctx, Uint8 *data, int size)
  {
      Sint16 axis;
      const SDL_bool invert_y_axes = SDL_TRUE;
  
      if (ctx->last_state[2] != data[2]) {
          SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_DPAD_UP, (data[2] & 0x01) ? SDL_PRESSED : SDL_RELEASED);
          SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_DPAD_DOWN, (data[2] & 0x02) ? SDL_PRESSED : SDL_RELEASED);
          SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_DPAD_LEFT, (data[2] & 0x04) ? SDL_PRESSED : SDL_RELEASED);
          SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_DPAD_RIGHT, (data[2] & 0x08) ? SDL_PRESSED : SDL_RELEASED);
          SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_START, (data[2] & 0x10) ? SDL_PRESSED : SDL_RELEASED);
          SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_BACK, (data[2] & 0x20) ? SDL_PRESSED : SDL_RELEASED);
          SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_LEFTSTICK, (data[2] & 0x40) ? SDL_PRESSED : SDL_RELEASED);
          SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_RIGHTSTICK, (data[2] & 0x80) ? SDL_PRESSED : SDL_RELEASED);
      }
  
      if (ctx->last_state[3] != data[3]) {
          SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_LEFTSHOULDER, (data[3] & 0x01) ? SDL_PRESSED : SDL_RELEASED);
          SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_RIGHTSHOULDER, (data[3] & 0x02) ? SDL_PRESSED : SDL_RELEASED);
          SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_GUIDE, (data[3] & 0x04) ? SDL_PRESSED : SDL_RELEASED);
          SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_A, (data[3] & 0x10) ? SDL_PRESSED : SDL_RELEASED);
          SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_B, (data[3] & 0x20) ? SDL_PRESSED : SDL_RELEASED);
          SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_X, (data[3] & 0x40) ? SDL_PRESSED : SDL_RELEASED);
          SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_Y, (data[3] & 0x80) ? SDL_PRESSED : SDL_RELEASED);
      }
  
      axis = ((int)data[4] * 257) - 32768;
      SDL_PrivateJoystickAxis(joystick, SDL_CONTROLLER_AXIS_TRIGGERLEFT, axis);
      axis = ((int)data[5] * 257) - 32768;
      SDL_PrivateJoystickAxis(joystick, SDL_CONTROLLER_AXIS_TRIGGERRIGHT, axis);
      axis = SDL_SwapLE16(*(Sint16*)(&data[6]));
      SDL_PrivateJoystickAxis(joystick, SDL_CONTROLLER_AXIS_LEFTX, axis);
      axis = SDL_SwapLE16(*(Sint16*)(&data[8]));
      if (invert_y_axes) {
          axis = ~axis;
      }
      SDL_PrivateJoystickAxis(joystick, SDL_CONTROLLER_AXIS_LEFTY, axis);
      axis = SDL_SwapLE16(*(Sint16*)(&data[10]));
      SDL_PrivateJoystickAxis(joystick, SDL_CONTROLLER_AXIS_RIGHTX, axis);
      axis = SDL_SwapLE16(*(Sint16*)(&data[12]));
      if (invert_y_axes) {
          axis = ~axis;
      }
      SDL_PrivateJoystickAxis(joystick, SDL_CONTROLLER_AXIS_RIGHTY, axis);
  
      SDL_memcpy(ctx->last_state, data, SDL_min(size, sizeof(ctx->last_state)));
  }
  
  static SDL_bool
  HIDAPI_DriverXbox360W_UpdateDevice(SDL_HIDAPI_Device *device)
  {
      SDL_DriverXbox360W_Context *ctx = (SDL_DriverXbox360W_Context *)device->context;
      SDL_Joystick *joystick = NULL;
      Uint8 data[USB_PACKET_LENGTH];
      int size;
  
      if (device->num_joysticks > 0) {
          joystick = SDL_JoystickFromInstanceID(device->joysticks[0]);
      }
  
      while ((size = SDL_hid_read_timeout(device->dev, data, sizeof(data), 0)) > 0) {
  #ifdef DEBUG_XBOX_PROTOCOL
          HIDAPI_DumpPacket("Xbox 360 wireless packet: size = %d", data, size);
  #endif
          if (size == 2 && data[0] == 0x08) {
              SDL_bool connected = (data[1] & 0x80) ? SDL_TRUE : SDL_FALSE;
  #ifdef DEBUG_JOYSTICK
              SDL_Log("Connected = %s\n", connected ? "TRUE" : "FALSE");
  #endif
              if (connected != ctx->connected) {
                  ctx->connected = connected;
  
                  if (connected) {
                      SDL_JoystickID joystickID;
  
                      HIDAPI_JoystickConnected(device, &joystickID);
  
                  } else if (device->num_joysticks > 0) {
                      HIDAPI_JoystickDisconnected(device, device->joysticks[0]);
                  }
              }
          } else if (size == 29 && data[0] == 0x00 && data[1] == 0x0f && data[2] == 0x00 && data[3] == 0xf0) {
              /* Serial number is data[7-13] */
  #ifdef DEBUG_JOYSTICK
              SDL_Log("Battery status (initial): %d\n", data[17]);
  #endif
              if (joystick) {
                  UpdatePowerLevel(joystick, data[17]);
              }
          } else if (size == 29 && data[0] == 0x00 && data[1] == 0x00 && data[2] == 0x00 && data[3] == 0x13) {
  #ifdef DEBUG_JOYSTICK
              SDL_Log("Battery status: %d\n", data[4]);
  #endif
              if (joystick) {
                  UpdatePowerLevel(joystick, data[4]);
              }
          } else if (size == 29 && data[0] == 0x00 && (data[1] & 0x01) == 0x01) {
              if (joystick) {
                  HIDAPI_DriverXbox360W_HandleStatePacket(joystick, device->dev, ctx, data+4, size-4);
              }
          }
      }
  
      if (size < 0 && device->num_joysticks > 0) {
          /* Read error, device is disconnected */
          HIDAPI_JoystickDisconnected(device, device->joysticks[0]);
      }
      return (size >= 0);
  }
  
  static void
  HIDAPI_DriverXbox360W_CloseJoystick(SDL_HIDAPI_Device *device, SDL_Joystick *joystick)
  {
      SDL_DriverXbox360W_Context *ctx = (SDL_DriverXbox360W_Context *)device->context;
  
      SDL_DelHintCallback(SDL_HINT_JOYSTICK_HIDAPI_XBOX_360_PLAYER_LED,
                          SDL_PlayerLEDHintChanged, ctx);
  }
  
  static void
  HIDAPI_DriverXbox360W_FreeDevice(SDL_HIDAPI_Device *device)
  {
  }
  
  SDL_HIDAPI_DeviceDriver SDL_HIDAPI_DriverXbox360W =
  {
      SDL_HINT_JOYSTICK_HIDAPI_XBOX_360_WIRELESS,
      SDL_TRUE,
      HIDAPI_DriverXbox360W_RegisterHints,
      HIDAPI_DriverXbox360W_UnregisterHints,
      HIDAPI_DriverXbox360W_IsEnabled,
      HIDAPI_DriverXbox360W_IsSupportedDevice,
      HIDAPI_DriverXbox360W_InitDevice,
      HIDAPI_DriverXbox360W_GetDevicePlayerIndex,
      HIDAPI_DriverXbox360W_SetDevicePlayerIndex,
      HIDAPI_DriverXbox360W_UpdateDevice,
      HIDAPI_DriverXbox360W_OpenJoystick,
      HIDAPI_DriverXbox360W_RumbleJoystick,
      HIDAPI_DriverXbox360W_RumbleJoystickTriggers,
      HIDAPI_DriverXbox360W_GetJoystickCapabilities,
      HIDAPI_DriverXbox360W_SetJoystickLED,
      HIDAPI_DriverXbox360W_SendJoystickEffect,
      HIDAPI_DriverXbox360W_SetJoystickSensorsEnabled,
      HIDAPI_DriverXbox360W_CloseJoystick,
      HIDAPI_DriverXbox360W_FreeDevice,
  };
  
  #endif /* SDL_JOYSTICK_HIDAPI_XBOX360 */
  
  #endif /* SDL_JOYSTICK_HIDAPI */
  
  /* vi: set ts=4 sw=4 expandtab: */
  

Download