SDL  2.0
SDL_androidvideo.c
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2019 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 #if SDL_VIDEO_DRIVER_ANDROID
24 
25 /* Android SDL video driver implementation */
26 
27 #include "SDL_video.h"
28 #include "SDL_mouse.h"
29 #include "SDL_hints.h"
30 #include "../SDL_sysvideo.h"
31 #include "../SDL_pixels_c.h"
32 #include "../../events/SDL_events_c.h"
33 #include "../../events/SDL_windowevents_c.h"
34 
35 #include "SDL_androidvideo.h"
36 #include "SDL_androidgl.h"
37 #include "SDL_androidclipboard.h"
38 #include "SDL_androidevents.h"
39 #include "SDL_androidkeyboard.h"
40 #include "SDL_androidmouse.h"
41 #include "SDL_androidtouch.h"
42 #include "SDL_androidwindow.h"
43 #include "SDL_androidvulkan.h"
44 
45 #define ANDROID_VID_DRIVER_NAME "Android"
46 
47 /* Initialization/Query functions */
48 static int Android_VideoInit(_THIS);
49 static void Android_VideoQuit(_THIS);
50 int Android_GetDisplayDPI(_THIS, SDL_VideoDisplay *display, float *ddpi, float *hdpi, float *vdpi);
51 
52 #include "../SDL_egl_c.h"
53 #define Android_GLES_GetProcAddress SDL_EGL_GetProcAddress
54 #define Android_GLES_UnloadLibrary SDL_EGL_UnloadLibrary
55 #define Android_GLES_SetSwapInterval SDL_EGL_SetSwapInterval
56 #define Android_GLES_GetSwapInterval SDL_EGL_GetSwapInterval
57 #define Android_GLES_DeleteContext SDL_EGL_DeleteContext
58 
59 /* Android driver bootstrap functions */
60 
61 
62 /* These are filled in with real values in Android_SetScreenResolution on init (before SDL_main()) */
63 int Android_SurfaceWidth = 0;
64 int Android_SurfaceHeight = 0;
65 static int Android_DeviceWidth = 0;
66 static int Android_DeviceHeight = 0;
67 static Uint32 Android_ScreenFormat = SDL_PIXELFORMAT_UNKNOWN;
68 static int Android_ScreenRate = 0;
69 SDL_sem *Android_PauseSem = NULL;
70 SDL_sem *Android_ResumeSem = NULL;
72 
73 static int
74 Android_Available(void)
75 {
76  return 1;
77 }
78 
79 static void
80 Android_SuspendScreenSaver(_THIS)
81 {
83 }
84 
85 static void
86 Android_DeleteDevice(SDL_VideoDevice *device)
87 {
88  SDL_free(device->driverdata);
89  SDL_free(device);
90 }
91 
92 static SDL_VideoDevice *
93 Android_CreateDevice(int devindex)
94 {
97  SDL_bool block_on_pause;
98 
99  /* Initialize all variables that we clean on shutdown */
100  device = (SDL_VideoDevice *) SDL_calloc(1, sizeof(SDL_VideoDevice));
101  if (!device) {
102  SDL_OutOfMemory();
103  return NULL;
104  }
105 
106  data = (SDL_VideoData *) SDL_calloc(1, sizeof(SDL_VideoData));
107  if (!data) {
108  SDL_OutOfMemory();
109  SDL_free(device);
110  return NULL;
111  }
112 
113  device->driverdata = data;
114 
115  /* Set the function pointers */
116  device->VideoInit = Android_VideoInit;
117  device->VideoQuit = Android_VideoQuit;
119  if (block_on_pause) {
121  } else {
123  }
124 
125  device->GetDisplayDPI = Android_GetDisplayDPI;
126 
133 
134  device->free = Android_DeleteDevice;
135 
136  /* GL pointers */
138  device->GL_GetProcAddress = Android_GLES_GetProcAddress;
139  device->GL_UnloadLibrary = Android_GLES_UnloadLibrary;
142  device->GL_SetSwapInterval = Android_GLES_SetSwapInterval;
143  device->GL_GetSwapInterval = Android_GLES_GetSwapInterval;
145  device->GL_DeleteContext = Android_GLES_DeleteContext;
146 
147 #if SDL_VIDEO_VULKAN
148  device->Vulkan_LoadLibrary = Android_Vulkan_LoadLibrary;
149  device->Vulkan_UnloadLibrary = Android_Vulkan_UnloadLibrary;
150  device->Vulkan_GetInstanceExtensions = Android_Vulkan_GetInstanceExtensions;
151  device->Vulkan_CreateSurface = Android_Vulkan_CreateSurface;
152 #endif
153 
154  /* Screensaver */
155  device->SuspendScreenSaver = Android_SuspendScreenSaver;
156 
157  /* Text input */
161 
162  /* Screen keyboard */
165 
166  /* Clipboard */
170 
171  return device;
172 }
173 
175  ANDROID_VID_DRIVER_NAME, "SDL Android video driver",
176  Android_Available, Android_CreateDevice
177 };
178 
179 
180 int
181 Android_VideoInit(_THIS)
182 {
183  SDL_VideoData *videodata = (SDL_VideoData *)_this->driverdata;
184  int display_index;
185  SDL_VideoDisplay *display;
187 
188  videodata->isPaused = SDL_FALSE;
189  videodata->isPausing = SDL_FALSE;
190 
191  mode.format = Android_ScreenFormat;
192  mode.w = Android_DeviceWidth;
193  mode.h = Android_DeviceHeight;
194  mode.refresh_rate = Android_ScreenRate;
195  mode.driverdata = NULL;
196 
197  display_index = SDL_AddBasicVideoDisplay(&mode);
198  if (display_index < 0) {
199  return -1;
200  }
201  display = SDL_GetDisplay(display_index);
202  display->orientation = Android_JNI_GetDisplayOrientation();
203 
205 
207 
209 
211 
212  /* We're done! */
213  return 0;
214 }
215 
216 void
217 Android_VideoQuit(_THIS)
218 {
221 }
222 
223 int
224 Android_GetDisplayDPI(_THIS, SDL_VideoDisplay *display, float *ddpi, float *hdpi, float *vdpi)
225 {
226  return Android_JNI_GetDisplayDPI(ddpi, hdpi, vdpi);
227 }
228 
229 void
230 Android_SetScreenResolution(int surfaceWidth, int surfaceHeight, int deviceWidth, int deviceHeight, Uint32 format, float rate)
231 {
232  Android_SurfaceWidth = surfaceWidth;
233  Android_SurfaceHeight = surfaceHeight;
234  Android_DeviceWidth = deviceWidth;
235  Android_DeviceHeight = deviceHeight;
236  Android_ScreenFormat = format;
237  Android_ScreenRate = (int)rate;
238 }
239 
241 {
242  /*
243  Update the resolution of the desktop mode, so that the window
244  can be properly resized. The screen resolution change can for
245  example happen when the Activity enters or exits immersive mode,
246  which can happen after VideoInit().
247  */
249  if (device && device->num_displays > 0)
250  {
251  SDL_VideoDisplay *display = &device->displays[0];
252  display->desktop_mode.format = Android_ScreenFormat;
253  display->desktop_mode.w = Android_DeviceWidth;
254  display->desktop_mode.h = Android_DeviceHeight;
255  display->desktop_mode.refresh_rate = Android_ScreenRate;
256  }
257 
258  if (window) {
259  /* Force the current mode to match the resize otherwise the SDL_WINDOWEVENT_RESTORED event
260  * will fall back to the old mode */
261  SDL_VideoDisplay *display = SDL_GetDisplayForWindow(window);
262  display->display_modes[0].format = Android_ScreenFormat;
263  display->display_modes[0].w = Android_DeviceWidth;
264  display->display_modes[0].h = Android_DeviceHeight;
265  display->display_modes[0].refresh_rate = Android_ScreenRate;
266  display->current_mode = display->display_modes[0];
267 
269  }
270 }
271 
272 #endif /* SDL_VIDEO_DRIVER_ANDROID */
273 
274 /* vi: set ts=4 sw=4 expandtab: */
int(* Vulkan_LoadLibrary)(_THIS, const char *path)
Definition: SDL_sysvideo.h:271
int Android_GLES_SwapWindow(_THIS, SDL_Window *window)
int Android_JNI_GetDisplayDPI(float *ddpi, float *xdpi, float *ydpi)
int(* GetDisplayDPI)(_THIS, SDL_VideoDisplay *display, float *ddpi, float *hdpi, float *vdpi)
Definition: SDL_sysvideo.h:192
int Android_GLES_LoadLibrary(_THIS, const char *path)
void Android_SendResize(SDL_Window *window)
void Android_DestroyWindow(_THIS, SDL_Window *window)
SDL_bool Android_HasScreenKeyboardSupport(_THIS)
void Android_QuitMouse(void)
SDL_bool(* IsScreenKeyboardShown)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:295
int Android_SurfaceWidth
char * Android_GetClipboardText(_THIS)
void(* free)(_THIS)
Definition: SDL_sysvideo.h:394
int SDL_AddBasicVideoDisplay(const SDL_DisplayMode *desktop_mode)
Definition: SDL_video.c:589
void Android_InitMouse(void)
int(* GL_SetSwapInterval)(_THIS, int interval)
Definition: SDL_sysvideo.h:261
The structure that defines a display mode.
Definition: SDL_video.h:53
void(* StartTextInput)(_THIS)
Definition: SDL_sysvideo.h:287
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: SDL_opengl.h:1974
int SDL_SendWindowEvent(SDL_Window *window, Uint8 windowevent, int data1, int data2)
void Android_InitKeyboard(void)
void Android_InitTouch(void)
void Android_PumpEvents_Blocking(_THIS)
int(* GL_LoadLibrary)(_THIS, const char *path)
Definition: SDL_sysvideo.h:255
#define SDL_GetHintBoolean
void Android_SetWindowFullscreen(_THIS, SDL_Window *window, SDL_VideoDisplay *display, SDL_bool fullscreen)
SDL_sem * Android_PauseSem
static SDL_VideoDevice * _this
Definition: SDL_video.c:118
GLint GLint GLsizei GLsizei GLsizei GLint GLenum format
Definition: SDL_opengl.h:1572
static SDL_AudioDeviceID device
Definition: loopwave.c:37
void Android_PumpEvents_NonBlocking(_THIS)
SDL_GLContext Android_GLES_CreateContext(_THIS, SDL_Window *window)
void(* SetTextInputRect)(_THIS, SDL_Rect *rect)
Definition: SDL_sysvideo.h:289
SDL_bool(* Vulkan_GetInstanceExtensions)(_THIS, SDL_Window *window, unsigned *count, const char **names)
Definition: SDL_sysvideo.h:273
VideoBootStrap Android_bootstrap
SDL_VideoDisplay * SDL_GetDisplay(int displayIndex)
Definition: SDL_video.c:1021
SDL_bool(* GetWindowWMInfo)(_THIS, SDL_Window *window, struct SDL_SysWMinfo *info)
Definition: SDL_sysvideo.h:248
int Android_SetClipboardText(_THIS, const char *text)
SDL_GLContext(* GL_CreateContext)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:258
SDL_bool(* Vulkan_CreateSurface)(_THIS, SDL_Window *window, VkInstance instance, VkSurfaceKHR *surface)
Definition: SDL_sysvideo.h:274
#define _THIS
int(* GL_MakeCurrent)(_THIS, SDL_Window *window, SDL_GLContext context)
Definition: SDL_sysvideo.h:259
#define SDL_free
SDL_mutex * Android_ActivityMutex
void(* Vulkan_UnloadLibrary)(_THIS)
Definition: SDL_sysvideo.h:272
SDL_DisplayMode * display_modes
Definition: SDL_sysvideo.h:130
SDL_DisplayMode current_mode
Definition: SDL_sysvideo.h:132
GLenum mode
SDL_VideoDisplay * displays
Definition: SDL_sysvideo.h:316
void(* DestroyWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:235
void(* StopTextInput)(_THIS)
Definition: SDL_sysvideo.h:288
void Android_StartTextInput(_THIS)
void Android_JNI_SuspendScreenSaver(SDL_bool suspend)
int Android_SurfaceHeight
SDL_bool(* HasScreenKeyboardSupport)(_THIS)
Definition: SDL_sysvideo.h:292
#define SDL_HINT_ANDROID_BLOCK_ON_PAUSE
A variable to control whether the event loop will block itself when the app is paused.
Definition: SDL_hints.h:885
void Android_SetTextInputRect(_THIS, SDL_Rect *rect)
void(* GL_UnloadLibrary)(_THIS)
Definition: SDL_sysvideo.h:257
#define NULL
Definition: begin_code.h:167
int(* CreateSDLWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:211
#define SDL_OutOfMemory()
Definition: SDL_error.h:52
SDL_bool
Definition: SDL_stdinc.h:161
void Android_MinimizeWindow(_THIS, SDL_Window *window)
SDL_DisplayMode desktop_mode
Definition: SDL_sysvideo.h:131
void Android_SetWindowTitle(_THIS, SDL_Window *window)
void(* VideoQuit)(_THIS)
Definition: SDL_sysvideo.h:167
#define SDL_calloc
SDL_sem * Android_ResumeSem
SDL_VideoDisplay * SDL_GetDisplayForWindow(SDL_Window *window)
Definition: SDL_video.c:1089
EGLSurface EGLNativeWindowType * window
Definition: eglext.h:1025
int(* GL_SwapWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:263
The type used to identify a window.
Definition: SDL_sysvideo.h:73
SDL_DisplayOrientation Android_JNI_GetDisplayOrientation(void)
int Android_CreateWindow(_THIS, SDL_Window *window)
uint32_t Uint32
Definition: SDL_stdinc.h:203
void(* MinimizeWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:227
void Android_StopTextInput(_THIS)
SDL_bool Android_GetWindowWMInfo(_THIS, SDL_Window *window, struct SDL_SysWMinfo *info)
SDL_bool(* HasClipboardText)(_THIS)
Definition: SDL_sysvideo.h:300
SDL_bool SDL_AddDisplayMode(SDL_VideoDisplay *display, const SDL_DisplayMode *mode)
Definition: SDL_video.c:751
SDL_VideoDevice * SDL_GetVideoDevice(void)
Definition: SDL_video.c:583
int(* VideoInit)(_THIS)
Definition: SDL_sysvideo.h:161
SDL_bool suspend_screensaver
Definition: SDL_sysvideo.h:314
void(* SetWindowFullscreen)(_THIS, SDL_Window *window, SDL_VideoDisplay *display, SDL_bool fullscreen)
Definition: SDL_sysvideo.h:231
void(* GL_DeleteContext)(_THIS, SDL_GLContext context)
Definition: SDL_sysvideo.h:264
char *(* GetClipboardText)(_THIS)
Definition: SDL_sysvideo.h:299
void Android_SetScreenResolution(int surfaceWidth, int surfaceHeight, int deviceWidth, int deviceHeight, Uint32 format, float rate)
Uint32 format
Definition: SDL_video.h:55
void(* SetWindowTitle)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:213
int(* GL_GetSwapInterval)(_THIS)
Definition: SDL_sysvideo.h:262
int(* SetClipboardText)(_THIS, const char *text)
Definition: SDL_sysvideo.h:298
SDL_bool Android_HasClipboardText(_THIS)
void(* SuspendScreenSaver)(_THIS)
Definition: SDL_sysvideo.h:284
SDL_bool Android_IsScreenKeyboardShown(_THIS, SDL_Window *window)
void *(* GL_GetProcAddress)(_THIS, const char *proc)
Definition: SDL_sysvideo.h:256
void Android_QuitTouch(void)
void(* PumpEvents)(_THIS)
Definition: SDL_sysvideo.h:281
int Android_GLES_MakeCurrent(_THIS, SDL_Window *window, SDL_GLContext context)