1 /*
2   Simple DirectMedia Layer
3   Copyright (C) 1997-2020 Sam Lantinga <slouken@libsdl.org>
4 
5   This software is provided 'as-is', without any express or implied
6   warranty.  In no event will the authors be held liable for any damages
7   arising from the use of this software.
8 
9   Permission is granted to anyone to use this software for any purpose,
10   including commercial applications, and to alter it and redistribute it
11   freely, subject to the following restrictions:
12 
13   1. The origin of this software must not be misrepresented; you must not
14      claim that you wrote the original software. If you use this software
15      in a product, an acknowledgment in the product documentation would be
16      appreciated but is not required.
17   2. Altered source versions must be plainly marked as such, and must not be
18      misrepresented as being the original software.
19   3. This notice may not be removed or altered from any source distribution.
20 */
21 #include "../SDL_internal.h"
22 
23 #ifndef SDL_sysjoystick_h_
24 #define SDL_sysjoystick_h_
25 
26 /* This is the system specific header for the SDL joystick API */
27 
28 #include "SDL_joystick.h"
29 #include "SDL_joystick_c.h"
30 
31 /* The SDL joystick structure */
32 typedef struct _SDL_JoystickAxisInfo
33 {
34     Sint16 initial_value;       /* Initial axis state */
35     Sint16 value;               /* Current axis state */
36     Sint16 zero;                /* Zero point on the axis (-32768 for triggers) */
37     SDL_bool has_initial_value; /* Whether we've seen a value on the axis yet */
38     SDL_bool has_second_value;  /* Whether we've seen a second value on the axis yet */
39     SDL_bool sent_initial_value; /* Whether we've sent the initial axis value */
40 } SDL_JoystickAxisInfo;
41 
42 struct _SDL_Joystick
43 {
44     SDL_JoystickID instance_id; /* Device instance, monotonically increasing from 0 */
45     char *name;                 /* Joystick name - system dependent */
46     SDL_JoystickGUID guid;      /* Joystick guid */
47 
48     int naxes;                  /* Number of axis controls on the joystick */
49     SDL_JoystickAxisInfo *axes;
50 
51     int nhats;                  /* Number of hats on the joystick */
52     Uint8 *hats;                /* Current hat states */
53 
54     int nballs;                 /* Number of trackballs on the joystick */
55     struct balldelta {
56         int dx;
57         int dy;
58     } *balls;                   /* Current ball motion deltas */
59 
60     int nbuttons;               /* Number of buttons on the joystick */
61     Uint8 *buttons;             /* Current button states */
62 
63     Uint16 low_frequency_rumble;
64     Uint16 high_frequency_rumble;
65     Uint32 rumble_expiration;
66 
67     SDL_bool attached;
68     SDL_bool is_game_controller;
69     SDL_bool delayed_guide_button; /* SDL_TRUE if this device has the guide button event delayed */
70     SDL_JoystickPowerLevel epowerlevel; /* power level of this joystick, SDL_JOYSTICK_POWER_UNKNOWN if not supported */
71     struct _SDL_JoystickDriver *driver;
72 
73     struct joystick_hwdata *hwdata;     /* Driver dependent information */
74 
75     int ref_count;              /* Reference count for multiple opens */
76 
77     struct _SDL_Joystick *next; /* pointer to next joystick we have allocated */
78 };
79 
80 /* Device bus definitions */
81 #define SDL_HARDWARE_BUS_USB        0x03
82 #define SDL_HARDWARE_BUS_BLUETOOTH  0x05
83 
84 /* Macro to combine a USB vendor ID and product ID into a single Uint32 value */
85 #define MAKE_VIDPID(VID, PID)   (((Uint32)(VID))<<16|(PID))
86 
87 typedef struct _SDL_JoystickDriver
88 {
89     /* Function to scan the system for joysticks.
90      * Joystick 0 should be the system default joystick.
91      * This function should return 0, or -1 on an unrecoverable error.
92      */
93     int (*Init)(void);
94 
95     /* Function to return the number of joystick devices plugged in right now */
96     int (*GetCount)(void);
97 
98     /* Function to cause any queued joystick insertions to be processed */
99     void (*Detect)(void);
100 
101     /* Function to get the device-dependent name of a joystick */
102     const char *(*GetDeviceName)(int device_index);
103 
104     /* Function to get the player index of a joystick */
105     int (*GetDevicePlayerIndex)(int device_index);
106 
107     /* Function to get the player index of a joystick */
108     void (*SetDevicePlayerIndex)(int device_index, int player_index);
109 
110     /* Function to return the stable GUID for a plugged in device */
111     SDL_JoystickGUID (*GetDeviceGUID)(int device_index);
112 
113     /* Function to get the current instance id of the joystick located at device_index */
114     SDL_JoystickID (*GetDeviceInstanceID)(int device_index);
115 
116     /* Function to open a joystick for use.
117        The joystick to open is specified by the device index.
118        This should fill the nbuttons and naxes fields of the joystick structure.
119        It returns 0, or -1 if there is an error.
120      */
121     int (*Open)(SDL_Joystick * joystick, int device_index);
122 
123     /* Rumble functionality */
124     int (*Rumble)(SDL_Joystick * joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble);
125 
126     /* Function to update the state of a joystick - called as a device poll.
127      * This function shouldn't update the joystick structure directly,
128      * but instead should call SDL_PrivateJoystick*() to deliver events
129      * and update joystick device state.
130      */
131     void (*Update)(SDL_Joystick * joystick);
132 
133     /* Function to close a joystick after use */
134     void (*Close)(SDL_Joystick * joystick);
135 
136     /* Function to perform any system-specific joystick related cleanup */
137     void (*Quit)(void);
138 
139     /* Function to get the autodetected controller mapping; returns false if there isn't any. */
140     SDL_bool (*GetGamepadMapping)(int device_index, SDL_GamepadMapping * out);
141 
142 } SDL_JoystickDriver;
143 
144 /* Windows and Mac OSX has a limit of MAX_DWORD / 1000, Linux kernel has a limit of 0xFFFF */
145 #define SDL_MAX_RUMBLE_DURATION_MS  0xFFFF
146 
147 /* The available joystick drivers */
148 extern SDL_JoystickDriver SDL_ANDROID_JoystickDriver;
149 extern SDL_JoystickDriver SDL_BSD_JoystickDriver;
150 extern SDL_JoystickDriver SDL_DARWIN_JoystickDriver;
151 extern SDL_JoystickDriver SDL_DUMMY_JoystickDriver;
152 extern SDL_JoystickDriver SDL_EMSCRIPTEN_JoystickDriver;
153 extern SDL_JoystickDriver SDL_HAIKU_JoystickDriver;
154 extern SDL_JoystickDriver SDL_HIDAPI_JoystickDriver;
155 extern SDL_JoystickDriver SDL_RAWINPUT_JoystickDriver;
156 extern SDL_JoystickDriver SDL_IOS_JoystickDriver;
157 extern SDL_JoystickDriver SDL_LINUX_JoystickDriver;
158 extern SDL_JoystickDriver SDL_VIRTUAL_JoystickDriver;
159 extern SDL_JoystickDriver SDL_WGI_JoystickDriver;
160 extern SDL_JoystickDriver SDL_WINDOWS_JoystickDriver;
161 extern SDL_JoystickDriver SDL_AliOS_JoystickDriver;
162 
163 #endif /* SDL_sysjoystick_h_ */
164 
165 /* vi: set ts=4 sw=4 expandtab: */
166