SDL  2.0
SDL_rpivideo.c
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2018 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 
22 #include "../../SDL_internal.h"
23 
24 #if SDL_VIDEO_DRIVER_RPI
25 
26 /* References
27  * http://elinux.org/RPi_VideoCore_APIs
28  * https://github.com/raspberrypi/firmware/blob/master/opt/vc/src/hello_pi/hello_triangle/triangle.c
29  * http://cgit.freedesktop.org/wayland/weston/tree/src/rpi-renderer.c
30  * http://cgit.freedesktop.org/wayland/weston/tree/src/compositor-rpi.c
31  */
32 
33 /* SDL internals */
34 #include "../SDL_sysvideo.h"
35 #include "SDL_version.h"
36 #include "SDL_syswm.h"
37 #include "SDL_loadso.h"
38 #include "SDL_events.h"
39 #include "../../events/SDL_mouse_c.h"
40 #include "../../events/SDL_keyboard_c.h"
41 #include "SDL_hints.h"
42 
43 #ifdef SDL_INPUT_LINUXEV
44 #include "../../core/linux/SDL_evdev.h"
45 #endif
46 
47 /* RPI declarations */
48 #include "SDL_rpivideo.h"
49 #include "SDL_rpievents_c.h"
50 #include "SDL_rpiopengles.h"
51 #include "SDL_rpimouse.h"
52 
53 static int
54 RPI_Available(void)
55 {
56  return 1;
57 }
58 
59 static void
60 RPI_Destroy(SDL_VideoDevice * device)
61 {
62  SDL_free(device->driverdata);
64 }
65 
66 static int
67 RPI_GetRefreshRate()
68 {
69  TV_DISPLAY_STATE_T tvstate;
70  if (vc_tv_get_display_state( &tvstate ) == 0) {
71  //The width/height parameters are in the same position in the union
72  //for HDMI and SDTV
73  HDMI_PROPERTY_PARAM_T property;
74  property.property = HDMI_PROPERTY_PIXEL_CLOCK_TYPE;
75  vc_tv_hdmi_get_property(&property);
76  return property.param1 == HDMI_PIXEL_CLOCK_TYPE_NTSC ?
77  tvstate.display.hdmi.frame_rate * (1000.0f/1001.0f) :
78  tvstate.display.hdmi.frame_rate;
79  }
80  return 60; /* Failed to get display state, default to 60 */
81 }
82 
83 static SDL_VideoDevice *
84 RPI_Create()
85 {
87  SDL_VideoData *phdata;
88 
89  /* Initialize SDL_VideoDevice structure */
91  if (device == NULL) {
93  return NULL;
94  }
95 
96  /* Initialize internal data */
97  phdata = (SDL_VideoData *) SDL_calloc(1, sizeof(SDL_VideoData));
98  if (phdata == NULL) {
100  SDL_free(device);
101  return NULL;
102  }
103 
104  device->driverdata = phdata;
105 
106  /* Setup amount of available displays */
107  device->num_displays = 0;
108 
109  /* Set device free function */
110  device->free = RPI_Destroy;
111 
112  /* Setup all functions which we can handle */
113  device->VideoInit = RPI_VideoInit;
114  device->VideoQuit = RPI_VideoQuit;
115  device->GetDisplayModes = RPI_GetDisplayModes;
116  device->SetDisplayMode = RPI_SetDisplayMode;
117  device->CreateSDLWindow = RPI_CreateWindow;
118  device->CreateSDLWindowFrom = RPI_CreateWindowFrom;
119  device->SetWindowTitle = RPI_SetWindowTitle;
120  device->SetWindowIcon = RPI_SetWindowIcon;
121  device->SetWindowPosition = RPI_SetWindowPosition;
122  device->SetWindowSize = RPI_SetWindowSize;
123  device->ShowWindow = RPI_ShowWindow;
124  device->HideWindow = RPI_HideWindow;
125  device->RaiseWindow = RPI_RaiseWindow;
126  device->MaximizeWindow = RPI_MaximizeWindow;
127  device->MinimizeWindow = RPI_MinimizeWindow;
128  device->RestoreWindow = RPI_RestoreWindow;
129  device->SetWindowGrab = RPI_SetWindowGrab;
130  device->DestroyWindow = RPI_DestroyWindow;
131 #if 0
132  device->GetWindowWMInfo = RPI_GetWindowWMInfo;
133 #endif
134  device->GL_LoadLibrary = RPI_GLES_LoadLibrary;
135  device->GL_GetProcAddress = RPI_GLES_GetProcAddress;
136  device->GL_UnloadLibrary = RPI_GLES_UnloadLibrary;
137  device->GL_CreateContext = RPI_GLES_CreateContext;
138  device->GL_MakeCurrent = RPI_GLES_MakeCurrent;
139  device->GL_SetSwapInterval = RPI_GLES_SetSwapInterval;
140  device->GL_GetSwapInterval = RPI_GLES_GetSwapInterval;
141  device->GL_SwapWindow = RPI_GLES_SwapWindow;
142  device->GL_DeleteContext = RPI_GLES_DeleteContext;
143  device->GL_DefaultProfileConfig = RPI_GLES_DefaultProfileConfig;
144 
145  device->PumpEvents = RPI_PumpEvents;
146 
147  return device;
148 }
149 
151  "RPI",
152  "RPI Video Driver",
153  RPI_Available,
154  RPI_Create
155 };
156 
157 /*****************************************************************************/
158 /* SDL Video and Display initialization/handling functions */
159 /*****************************************************************************/
160 int
162 {
163  SDL_VideoDisplay display;
164  SDL_DisplayMode current_mode;
166  uint32_t w,h;
167 
168  /* Initialize BCM Host */
169  bcm_host_init();
170 
171  SDL_zero(current_mode);
172 
173  if (graphics_get_display_size( 0, &w, &h) < 0) {
174  return -1;
175  }
176 
177  current_mode.w = w;
178  current_mode.h = h;
179  current_mode.refresh_rate = RPI_GetRefreshRate();
180  /* 32 bpp for default */
181  current_mode.format = SDL_PIXELFORMAT_ABGR8888;
182 
183  current_mode.driverdata = NULL;
184 
185  SDL_zero(display);
186  display.desktop_mode = current_mode;
187  display.current_mode = current_mode;
188 
189  /* Allocate display internal data */
191  if (data == NULL) {
192  return SDL_OutOfMemory();
193  }
194 
195  data->dispman_display = vc_dispmanx_display_open( 0 /* LCD */);
196 
197  display.driverdata = data;
198 
199  SDL_AddVideoDisplay(&display);
200 
201 #ifdef SDL_INPUT_LINUXEV
202  if (SDL_EVDEV_Init() < 0) {
203  return -1;
204  }
205 #endif
206 
208 
209  return 1;
210 }
211 
212 void
214 {
215 #ifdef SDL_INPUT_LINUXEV
216  SDL_EVDEV_Quit();
217 #endif
218 }
219 
220 void
222 {
223  /* Only one display mode available, the current one */
224  SDL_AddDisplayMode(display, &display->current_mode);
225 }
226 
227 int
229 {
230  return 0;
231 }
232 
233 static void
234 RPI_vsync_callback(DISPMANX_UPDATE_HANDLE_T u, void *data)
235 {
236  SDL_WindowData *wdata = ((SDL_WindowData *) data);
237 
239  SDL_CondSignal(wdata->vsync_cond);
241 }
242 
243 int
245 {
246  SDL_WindowData *wdata;
247  SDL_VideoDisplay *display;
248  SDL_DisplayData *displaydata;
249  VC_RECT_T dst_rect;
250  VC_RECT_T src_rect;
251  VC_DISPMANX_ALPHA_T dispman_alpha;
252  DISPMANX_UPDATE_HANDLE_T dispman_update;
254  const char *env;
255 
256  /* Disable alpha, otherwise the app looks composed with whatever dispman is showing (X11, console,etc) */
257  dispman_alpha.flags = DISPMANX_FLAGS_ALPHA_FIXED_ALL_PIXELS;
258  dispman_alpha.opacity = 0xFF;
259  dispman_alpha.mask = 0;
260 
261  /* Allocate window internal data */
262  wdata = (SDL_WindowData *) SDL_calloc(1, sizeof(SDL_WindowData));
263  if (wdata == NULL) {
264  return SDL_OutOfMemory();
265  }
266  display = SDL_GetDisplayForWindow(window);
267  displaydata = (SDL_DisplayData *) display->driverdata;
268 
269  /* Windows have one size for now */
270  window->w = display->desktop_mode.w;
271  window->h = display->desktop_mode.h;
272 
273  /* OpenGL ES is the law here, buddy */
274  window->flags |= SDL_WINDOW_OPENGL;
275 
276  /* Create a dispman element and associate a window to it */
277  dst_rect.x = 0;
278  dst_rect.y = 0;
279  dst_rect.width = window->w;
280  dst_rect.height = window->h;
281 
282  src_rect.x = 0;
283  src_rect.y = 0;
284  src_rect.width = window->w << 16;
285  src_rect.height = window->h << 16;
286 
288  if (env) {
289  layer = SDL_atoi(env);
290  }
291 
292  dispman_update = vc_dispmanx_update_start( 0 );
293  wdata->dispman_window.element = vc_dispmanx_element_add (dispman_update,
294  displaydata->dispman_display,
295  layer /* layer */,
296  &dst_rect,
297  0 /*src*/,
298  &src_rect,
299  DISPMANX_PROTECTION_NONE,
300  &dispman_alpha /*alpha*/,
301  0 /*clamp*/,
302  0 /*transform*/);
303  wdata->dispman_window.width = window->w;
304  wdata->dispman_window.height = window->h;
305  vc_dispmanx_update_submit_sync(dispman_update);
306 
307  if (!_this->egl_data) {
308  if (SDL_GL_LoadLibrary(NULL) < 0) {
309  return -1;
310  }
311  }
312  wdata->egl_surface = SDL_EGL_CreateSurface(_this, (NativeWindowType) &wdata->dispman_window);
313 
314  if (wdata->egl_surface == EGL_NO_SURFACE) {
315  return SDL_SetError("Could not create GLES window surface");
316  }
317 
318  /* Start generating vsync callbacks if necesary */
319  wdata->double_buffer = SDL_FALSE;
321  wdata->vsync_cond = SDL_CreateCond();
323  wdata->double_buffer = SDL_TRUE;
324  vc_dispmanx_vsync_callback(displaydata->dispman_display, RPI_vsync_callback, (void*)wdata);
325  }
326 
327  /* Setup driver data for this window */
328  window->driverdata = wdata;
329 
330  /* One window, it always has focus */
333 
334  /* Window has been successfully created */
335  return 0;
336 }
337 
338 void
340 {
341  SDL_WindowData *data = (SDL_WindowData *) window->driverdata;
343  SDL_DisplayData *displaydata = (SDL_DisplayData *) display->driverdata;
344 
345  if(data) {
346  if (data->double_buffer) {
347  /* Wait for vsync, and then stop vsync callbacks and destroy related stuff, if needed */
348  SDL_LockMutex(data->vsync_cond_mutex);
349  SDL_CondWait(data->vsync_cond, data->vsync_cond_mutex);
350  SDL_UnlockMutex(data->vsync_cond_mutex);
351 
352  vc_dispmanx_vsync_callback(displaydata->dispman_display, NULL, NULL);
353 
354  SDL_DestroyCond(data->vsync_cond);
355  SDL_DestroyMutex(data->vsync_cond_mutex);
356  }
357 
358 #if SDL_VIDEO_OPENGL_EGL
359  if (data->egl_surface != EGL_NO_SURFACE) {
360  SDL_EGL_DestroySurface(_this, data->egl_surface);
361  }
362 #endif
363  SDL_free(data);
364  window->driverdata = NULL;
365  }
366 }
367 
368 int
370 {
371  return -1;
372 }
373 
374 void
376 {
377 }
378 void
380 {
381 }
382 void
384 {
385 }
386 void
388 {
389 }
390 void
392 {
393 }
394 void
396 {
397 }
398 void
400 {
401 }
402 void
404 {
405 }
406 void
408 {
409 }
410 void
412 {
413 }
414 void
416 {
417 
418 }
419 
420 /*****************************************************************************/
421 /* SDL Window Manager function */
422 /*****************************************************************************/
423 #if 0
424 SDL_bool
426 {
427  if (info->version.major <= SDL_MAJOR_VERSION) {
428  return SDL_TRUE;
429  } else {
430  SDL_SetError("application not compiled with SDL %d.%d",
432  return SDL_FALSE;
433  }
434 
435  /* Failed to get window manager information */
436  return SDL_FALSE;
437 }
438 #endif
439 
440 #endif /* SDL_VIDEO_DRIVER_RPI */
441 
442 /* vi: set ts=4 sw=4 expandtab: */
SDL_zero
#define SDL_zero(x)
Definition: SDL_stdinc.h:416
RPI_HideWindow
void RPI_HideWindow(_THIS, SDL_Window *window)
RPI_SetWindowSize
void RPI_SetWindowSize(_THIS, SDL_Window *window)
RPI_RaiseWindow
void RPI_RaiseWindow(_THIS, SDL_Window *window)
SDL_DisplayMode::format
Uint32 format
Definition: SDL_video.h:55
SDL_events.h
SDL_WindowData::vsync_cond_mutex
SDL_mutex * vsync_cond_mutex
Definition: SDL_rpivideo.h:54
SDL_Surface
A collection of pixels used in software blitting.
Definition: SDL_surface.h:70
SDL_WindowData::vsync_cond
SDL_cond * vsync_cond
Definition: SDL_rpivideo.h:53
RPI_GLES_UnloadLibrary
void RPI_GLES_UnloadLibrary(_THIS)
SDL_LockMutex
#define SDL_LockMutex
Definition: SDL_dynapi_overrides.h:260
NULL
#define NULL
Definition: begin_code.h:164
layer
GLenum GLuint GLint GLint layer
Definition: SDL_opengl_glext.h:1186
mode
GLenum mode
Definition: SDL_opengl_glext.h:1122
NativeWindowType
EGLNativeWindowType NativeWindowType
Definition: eglplatform.h:112
SDL_SysWMinfo
Definition: SDL_syswm.h:195
SDL_RPI_VIDEOLAYER
#define SDL_RPI_VIDEOLAYER
Definition: SDL_rpivideo.h:59
SDL_WindowData
Definition: SDL_androidwindow.h:36
SDL_GetDisplayForWindow
SDL_VideoDisplay * SDL_GetDisplayForWindow(SDL_Window *window)
Definition: SDL_video.c:1092
RPI_GetDisplayModes
void RPI_GetDisplayModes(_THIS, SDL_VideoDisplay *display)
RPI_InitMouse
void RPI_InitMouse(_THIS)
SDL_rpivideo.h
SDL_WINDOW_OPENGL
@ SDL_WINDOW_OPENGL
Definition: SDL_video.h:101
RPI_GLES_SwapWindow
int RPI_GLES_SwapWindow(_THIS, SDL_Window *window)
SDL_CreateMutex
#define SDL_CreateMutex
Definition: SDL_dynapi_overrides.h:259
SDL_DestroyCond
#define SDL_DestroyCond
Definition: SDL_dynapi_overrides.h:272
SDL_CondSignal
#define SDL_CondSignal
Definition: SDL_dynapi_overrides.h:273
SDL_GL_LoadLibrary
#define SDL_GL_LoadLibrary
Definition: SDL_dynapi_overrides.h:553
SDL_SetKeyboardFocus
void SDL_SetKeyboardFocus(SDL_Window *window)
Definition: SDL_keyboard.c:630
RPI_GLES_MakeCurrent
int RPI_GLES_MakeCurrent(_THIS, SDL_Window *window, SDL_GLContext context)
RPI_SetWindowPosition
void RPI_SetWindowPosition(_THIS, SDL_Window *window)
SDL_VideoDisplay::desktop_mode
SDL_DisplayMode desktop_mode
Definition: SDL_sysvideo.h:131
SDL_GetHint
#define SDL_GetHint
Definition: SDL_dynapi_overrides.h:191
h
GLfloat GLfloat GLfloat GLfloat h
Definition: SDL_opengl_glext.h:1946
SDL_SetMouseFocus
void SDL_SetMouseFocus(SDL_Window *window)
Definition: SDL_mouse.c:177
RPI_DestroyWindow
void RPI_DestroyWindow(_THIS, SDL_Window *window)
SDL_DisplayMode::h
int h
Definition: SDL_video.h:57
data
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: SDL_opengl.h:1974
SDL_Window
The type used to identify a window.
Definition: SDL_sysvideo.h:74
SDL_DisplayMode
The structure that defines a display mode.
Definition: SDL_video.h:54
SDL_AddDisplayMode
SDL_bool SDL_AddDisplayMode(SDL_VideoDisplay *display, const SDL_DisplayMode *mode)
Definition: SDL_video.c:754
SDL_CondWait
#define SDL_CondWait
Definition: SDL_dynapi_overrides.h:275
RPI_MinimizeWindow
void RPI_MinimizeWindow(_THIS, SDL_Window *window)
SDL_WindowData::dispman_window
EGL_DISPMANX_WINDOW_T dispman_window
Definition: SDL_rpivideo.h:47
RPI_bootstrap
VideoBootStrap RPI_bootstrap
SDL_GetHintBoolean
#define SDL_GetHintBoolean
Definition: SDL_dynapi_overrides.h:608
RPI_PumpEvents
void RPI_PumpEvents(_THIS)
RPI_VideoQuit
void RPI_VideoQuit(_THIS)
_this
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
RPI_GLES_DeleteContext
void RPI_GLES_DeleteContext(_THIS, SDL_GLContext context)
SDL_MINOR_VERSION
#define SDL_MINOR_VERSION
Definition: SDL_version.h:61
RPI_GLES_SetSwapInterval
int RPI_GLES_SetSwapInterval(_THIS, int interval)
window
EGLSurface EGLNativeWindowType * window
Definition: eglext.h:1025
EGL_NO_SURFACE
#define EGL_NO_SURFACE
Definition: egl.h:100
SDL_free
#define SDL_free
Definition: SDL_dynapi_overrides.h:377
SDL_DisplayMode::refresh_rate
int refresh_rate
Definition: SDL_video.h:58
RPI_SetDisplayMode
int RPI_SetDisplayMode(_THIS, SDL_VideoDisplay *display, SDL_DisplayMode *mode)
_THIS
#define _THIS
Definition: SDL_alsa_audio.h:31
SDL_TRUE
@ SDL_TRUE
Definition: SDL_stdinc.h:164
SDL_DisplayData::dispman_display
DISPMANX_DISPLAY_HANDLE_T dispman_display
Definition: SDL_rpivideo.h:41
SDL_DisplayMode::w
int w
Definition: SDL_video.h:56
SDL_AddVideoDisplay
int SDL_AddVideoDisplay(const SDL_VideoDisplay *display)
Definition: SDL_video.c:606
SDL_VideoDisplay::driverdata
void * driverdata
Definition: SDL_sysvideo.h:139
SDL_DisplayData
Definition: SDL_cocoamodes.h:27
SDL_VideoDevice
Definition: SDL_sysvideo.h:149
SDL_OutOfMemory
#define SDL_OutOfMemory()
Definition: SDL_error.h:52
RPI_SetWindowIcon
void RPI_SetWindowIcon(_THIS, SDL_Window *window, SDL_Surface *icon)
RPI_RestoreWindow
void RPI_RestoreWindow(_THIS, SDL_Window *window)
SDL_CreateCond
#define SDL_CreateCond
Definition: SDL_dynapi_overrides.h:271
SDL_calloc
#define SDL_calloc
Definition: SDL_dynapi_overrides.h:375
SDL_atoi
#define SDL_atoi
Definition: SDL_dynapi_overrides.h:410
SDL_WindowData::double_buffer
SDL_bool double_buffer
Definition: SDL_kmsdrmvideo.h:68
uint32_t
unsigned int uint32_t
Definition: SDL_config_windows.h:63
RPI_GLES_LoadLibrary
int RPI_GLES_LoadLibrary(_THIS, const char *path)
SDL_SysWMinfo::version
SDL_version version
Definition: SDL_syswm.h:196
SDL_VideoDisplay
Definition: SDL_sysvideo.h:126
RPI_ShowWindow
void RPI_ShowWindow(_THIS, SDL_Window *window)
SDL_SetError
#define SDL_SetError
Definition: SDL_dynapi_overrides.h:30
RPI_CreateWindowFrom
int RPI_CreateWindowFrom(_THIS, SDL_Window *window, const void *data)
SDL_hints.h
SDL_HINT_RPI_VIDEO_LAYER
#define SDL_HINT_RPI_VIDEO_LAYER
Tell SDL which Dispmanx layer to use on a Raspberry PI.
Definition: SDL_hints.h:956
RPI_GLES_GetProcAddress
void * RPI_GLES_GetProcAddress(_THIS, const char *proc)
SDL_DestroyMutex
#define SDL_DestroyMutex
Definition: SDL_dynapi_overrides.h:263
SDL_HINT_VIDEO_DOUBLE_BUFFER
#define SDL_HINT_VIDEO_DOUBLE_BUFFER
Tell the video driver that we only want a double buffer.
Definition: SDL_hints.h:974
RPI_SetWindowGrab
void RPI_SetWindowGrab(_THIS, SDL_Window *window, SDL_bool grabbed)
RPI_VideoInit
int RPI_VideoInit(_THIS)
RPI_GetWindowWMInfo
SDL_bool RPI_GetWindowWMInfo(_THIS, SDL_Window *window, struct SDL_SysWMinfo *info)
SDL_rpiopengles.h
SDL_bool
SDL_bool
Definition: SDL_stdinc.h:162
RPI_SetWindowTitle
void RPI_SetWindowTitle(_THIS, SDL_Window *window)
SDL_rpimouse.h
SDL_DisplayMode::driverdata
void * driverdata
Definition: SDL_video.h:59
RPI_GLES_CreateContext
SDL_GLContext RPI_GLES_CreateContext(_THIS, SDL_Window *window)
SDL_FALSE
@ SDL_FALSE
Definition: SDL_stdinc.h:163
SDL_version.h
SDL_PIXELFORMAT_ABGR8888
@ SDL_PIXELFORMAT_ABGR8888
Definition: SDL_pixels.h:254
SDL_VideoDisplay::current_mode
SDL_DisplayMode current_mode
Definition: SDL_sysvideo.h:132
RPI_GLES_GetSwapInterval
int RPI_GLES_GetSwapInterval(_THIS)
SDL_UnlockMutex
#define SDL_UnlockMutex
Definition: SDL_dynapi_overrides.h:262
SDL_version::major
Uint8 major
Definition: SDL_version.h:53
VideoBootStrap
Definition: SDL_sysvideo.h:398
SDL_MAJOR_VERSION
#define SDL_MAJOR_VERSION
Definition: SDL_version.h:60
device
static SDL_AudioDeviceID device
Definition: loopwave.c:37
RPI_CreateWindow
int RPI_CreateWindow(_THIS, SDL_Window *window)
SDL_rpievents_c.h
SDL_WindowData::egl_surface
EGLSurface egl_surface
Definition: SDL_androidwindow.h:37
SDL_loadso.h
RPI_MaximizeWindow
void RPI_MaximizeWindow(_THIS, SDL_Window *window)
SDL_VideoData
Definition: SDL_androidvideo.h:36
SDL_syswm.h
w
GLubyte GLubyte GLubyte GLubyte w
Definition: SDL_opengl_glext.h:731