1 /*****************************************************************************
2 * sdl.c: SDL video output display method
3 *****************************************************************************
4 * Copyright (C) 1998-2009 the VideoLAN team
7 * Authors: Samuel Hocevar <sam@zoy.org>
8 * Pierre Baillet <oct@zoy.org>
9 * Arnaud de Bossoreille de Ribou <bozo@via.ecp.fr>
10 * Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25 *****************************************************************************/
27 /*****************************************************************************
29 *****************************************************************************/
34 #include <vlc_common.h>
35 #include <vlc_plugin.h>
36 #include <vlc_vout_display.h>
37 #include <vlc_picture_pool.h>
43 #if !defined(WIN32) && !defined(__OS2__)
44 # ifdef X_DISPLAY_MISSING
45 # error Xlib required due to XInitThreads
47 # include <vlc_xlib.h>
50 /*****************************************************************************
52 *****************************************************************************/
53 static int Open (vlc_object_t *);
54 static void Close(vlc_object_t *);
56 #define CHROMA_TEXT N_("SDL chroma format")
57 #define CHROMA_LONGTEXT N_(\
58 "Force the SDL renderer to use a specific chroma format instead of " \
59 "trying to improve performances by using the most efficient one.")
63 set_category(CAT_VIDEO)
64 set_subcategory(SUBCAT_VIDEO_VOUT)
65 set_description(N_("Simple DirectMedia Layer video output"))
66 set_capability("vout display", 70)
68 add_string("sdl-chroma", NULL, CHROMA_TEXT, CHROMA_LONGTEXT, true)
69 add_obsolete_string("sdl-video-driver") /* obsolete since 1.1.0 */
70 set_callbacks(Open, Close)
71 #if defined(__i386__) || defined(__x86_64__)
72 /* On i386, SDL is linked against svgalib */
73 cannot_unload_broken_library()
78 /*****************************************************************************
80 *****************************************************************************/
81 static picture_pool_t *Pool (vout_display_t *, unsigned);
82 static void PictureDisplay(vout_display_t *, picture_t *, subpicture_t *);
83 static int Control(vout_display_t *, int, va_list);
84 static void Manage(vout_display_t *);
87 static int ConvertKey(SDLKey);
90 static vlc_mutex_t sdl_lock = VLC_STATIC_MUTEX;
93 struct vout_display_sys_t {
94 vout_display_place_t place;
98 uint32_t display_flags;
100 unsigned int desktop_width;
101 unsigned int desktop_height;
104 SDL_Overlay *overlay;
108 picture_pool_t *pool;
112 * This function initializes SDL vout method.
114 static int Open(vlc_object_t *object)
116 vout_display_t *vd = (vout_display_t *)object;
117 vout_display_sys_t *sys;
119 #if !defined(WIN32) && !defined(__OS2__)
120 if (!vlc_xlib_init (object))
124 /* XXX: check for conflicts with the SDL audio output */
125 vlc_mutex_lock(&sdl_lock);
127 /* Check if SDL video module has been initialized */
128 if (SDL_WasInit(SDL_INIT_VIDEO) != 0) {
129 vlc_mutex_unlock(&sdl_lock);
133 vd->sys = sys = calloc(1, sizeof(*sys));
135 vlc_mutex_unlock(&sdl_lock);
140 int sdl_flags = SDL_INIT_VIDEO;
142 /* Win32 SDL implementation doesn't support SDL_INIT_EVENTTHREAD yet*/
143 sdl_flags |= SDL_INIT_EVENTTHREAD;
145 /* In debug mode you may want vlc to dump a core instead of staying stuck */
146 sdl_flags |= SDL_INIT_NOPARACHUTE;
148 /* Initialize library */
149 if (SDL_Init(sdl_flags) < 0) {
150 vlc_mutex_unlock(&sdl_lock);
152 msg_Err(vd, "cannot initialize SDL (%s)", SDL_GetError());
156 vlc_mutex_unlock(&sdl_lock);
158 /* Translate keys into unicode */
159 SDL_EnableUNICODE(1);
161 /* Get the desktop resolution */
162 /* FIXME: SDL has a problem with virtual desktop */
163 sys->desktop_width = SDL_GetVideoInfo()->current_w;
164 sys->desktop_height = SDL_GetVideoInfo()->current_h;
167 video_format_t fmt = vd->fmt;
170 vout_display_info_t info = vd->info;
172 /* Set main window's size */
175 if (vd->cfg->is_fullscreen) {
176 display_width = sys->desktop_width;
177 display_height = sys->desktop_height;
179 display_width = vd->cfg->display.width;
180 display_height = vd->cfg->display.height;
183 /* Initialize flags and cursor */
184 sys->display_flags = SDL_ANYFORMAT | SDL_HWPALETTE | SDL_HWSURFACE | SDL_DOUBLEBUF;
185 sys->display_flags |= vd->cfg->is_fullscreen ? SDL_FULLSCREEN : SDL_RESIZABLE;
187 sys->display_bpp = SDL_VideoModeOK(display_width, display_height,
188 16, sys->display_flags);
189 if (sys->display_bpp == 0) {
190 msg_Err(vd, "no video mode available");
193 vout_display_DeleteWindow(vd, NULL);
195 sys->display = SDL_SetVideoMode(display_width, display_height,
196 sys->display_bpp, sys->display_flags);
198 msg_Err(vd, "cannot set video mode");
202 /* We keep the surface locked forever */
203 SDL_LockSurface(sys->display);
206 vlc_fourcc_t forced_chroma = 0;
207 char *psz_chroma = var_InheritString(vd, "sdl-chroma");
209 forced_chroma = vlc_fourcc_GetCodecFromString(VIDEO_ES, psz_chroma);
211 msg_Dbg(vd, "Forcing chroma to 0x%.8x (%4.4s)",
212 forced_chroma, (const char*)&forced_chroma);
216 /* Try to open an overlay if requested */
218 const bool is_overlay = var_InheritBool(vd, "overlay");
225 { VLC_CODEC_YV12, SDL_YV12_OVERLAY },
226 { VLC_CODEC_I420, SDL_IYUV_OVERLAY },
227 { VLC_CODEC_YUYV, SDL_YUY2_OVERLAY },
228 { VLC_CODEC_UYVY, SDL_UYVY_OVERLAY },
229 { VLC_CODEC_YVYU, SDL_YVYU_OVERLAY },
233 const vlc_fourcc_t forced_chromas[] = {
236 const vlc_fourcc_t *fallback_chromas =
237 vlc_fourcc_GetYUVFallback(fmt.i_chroma);
238 const vlc_fourcc_t *chromas = forced_chroma ? forced_chromas : fallback_chromas;
240 for (int pass = forced_chroma ? 1 : 0; pass < 2 && !sys->overlay; pass++) {
241 for (int i = 0; chromas[i] != 0; i++) {
242 const vlc_fourcc_t vlc = chromas[i];
245 for (int j = 0; vlc_to_sdl[j].vlc != 0 && !sdl; j++) {
246 if (vlc_to_sdl[j].vlc == vlc)
247 sdl = vlc_to_sdl[j].sdl;
252 sys->overlay = SDL_CreateYUVOverlay(fmt.i_width, fmt.i_height,
254 if (sys->overlay && !sys->overlay->hw_overlay && pass == 0) {
255 /* Ignore non hardware overlay surface in first pass */
256 SDL_FreeYUVOverlay(sys->overlay);
260 /* We keep the surface locked forever */
261 SDL_LockYUVOverlay(sys->overlay);
264 sys->is_uv_swapped = vlc_fourcc_AreUVPlanesSwapped(fmt.i_chroma,
266 if (sys->is_uv_swapped)
267 fmt.i_chroma = vd->fmt.i_chroma;
273 msg_Warn(vd, "SDL overlay disabled by the user");
277 vout_display_cfg_t place_cfg = *vd->cfg;
278 place_cfg.display.width = display_width;
279 place_cfg.display.height = display_height;
280 vout_display_PlacePicture(&sys->place, &vd->source, &place_cfg, !sys->overlay);
282 /* If no overlay, fallback to software output */
285 switch (sys->display->format->BitsPerPixel) {
287 fmt.i_chroma = VLC_CODEC_RGB8;
290 fmt.i_chroma = VLC_CODEC_RGB15;
293 fmt.i_chroma = VLC_CODEC_RGB16;
296 fmt.i_chroma = VLC_CODEC_RGB24;
299 fmt.i_chroma = VLC_CODEC_RGB32;
302 msg_Err(vd, "unknown screen depth %i",
303 sys->display->format->BitsPerPixel);
307 /* All we have is an RGB image with square pixels */
308 fmt.i_width = display_width;
309 fmt.i_height = display_height;
310 fmt.i_rmask = sys->display->format->Rmask;
311 fmt.i_gmask = sys->display->format->Gmask;
312 fmt.i_bmask = sys->display->format->Bmask;
314 info.has_pictures_invalid = true;
317 if (vd->cfg->display.title)
318 SDL_WM_SetCaption(vd->cfg->display.title,
319 vd->cfg->display.title);
320 else if (!sys->overlay)
321 SDL_WM_SetCaption(VOUT_TITLE " (software RGB SDL output)",
322 VOUT_TITLE " (software RGB SDL output)");
323 else if (sys->overlay->hw_overlay)
324 SDL_WM_SetCaption(VOUT_TITLE " (hardware YUV SDL output)",
325 VOUT_TITLE " (hardware YUV SDL output)");
327 SDL_WM_SetCaption(VOUT_TITLE " (software YUV SDL output)",
328 VOUT_TITLE " (software YUV SDL output)");
331 SDL_EventState(SDL_KEYUP, SDL_IGNORE); /* ignore keys up */
333 /* Setup vout_display now that everything is fine */
339 vd->display = PictureDisplay;
340 vd->control = Control;
344 vout_display_SendEventDisplaySize(vd, display_width, display_height, vd->cfg->is_fullscreen);
348 msg_Err(vd, "cannot set up SDL (%s)", SDL_GetError());
351 SDL_UnlockSurface(sys->display);
352 SDL_FreeSurface(sys->display);
355 vlc_mutex_lock(&sdl_lock);
356 SDL_QuitSubSystem(SDL_INIT_VIDEO);
357 vlc_mutex_unlock(&sdl_lock);
364 * Close a SDL video output
366 static void Close(vlc_object_t *object)
368 vout_display_t *vd = (vout_display_t *)object;
369 vout_display_sys_t *sys = vd->sys;
372 picture_pool_Delete(sys->pool);
375 SDL_LockYUVOverlay(sys->overlay);
376 SDL_FreeYUVOverlay(sys->overlay);
378 SDL_UnlockSurface (sys->display);
379 SDL_FreeSurface(sys->display);
381 vlc_mutex_lock(&sdl_lock);
382 SDL_QuitSubSystem(SDL_INIT_VIDEO);
383 vlc_mutex_unlock(&sdl_lock);
389 * Return a pool of direct buffers
391 static picture_pool_t *Pool(vout_display_t *vd, unsigned count)
393 vout_display_sys_t *sys = vd->sys;
397 picture_resource_t rsc;
399 memset(&rsc, 0, sizeof(rsc));
402 SDL_Overlay *ol = sys->overlay;
404 for (int i = 0; i < ol->planes; i++) {
405 rsc.p[i].p_pixels = ol->pixels[ i > 0 && sys->is_uv_swapped ? (3-i) : i];
406 rsc.p[i].i_pitch = ol->pitches[i > 0 && sys->is_uv_swapped ? (3-i) : i];
407 rsc.p[i].i_lines = ol->h;
408 if (ol->format == SDL_YV12_OVERLAY ||
409 ol->format == SDL_IYUV_OVERLAY)
410 rsc.p[i].i_lines /= 2;
414 const int x = sys->place.x;
415 const int y = sys->place.y;
417 SDL_Surface *sf = sys->display;
418 SDL_FillRect(sf, NULL, 0);
420 assert(x >= 0 && y >= 0);
421 rsc.p[0].p_pixels = (uint8_t*)sf->pixels + y * sf->pitch + x * ((sf->format->BitsPerPixel + 7) / 8);
422 rsc.p[0].i_pitch = sf->pitch;
423 rsc.p[0].i_lines = vd->fmt.i_height;
426 picture_t *picture = picture_NewFromResource(&vd->fmt, &rsc);;
430 sys->pool = picture_pool_New(1, &picture);
439 static void PictureDisplay(vout_display_t *vd, picture_t *p_pic, subpicture_t *p_subpicture)
441 vout_display_sys_t *sys = vd->sys;
445 disp.x = sys->place.x;
446 disp.y = sys->place.y;
447 disp.w = sys->place.width;
448 disp.h = sys->place.height;
450 SDL_UnlockYUVOverlay(sys->overlay);
451 SDL_DisplayYUVOverlay(sys->overlay , &disp);
452 SDL_LockYUVOverlay(sys->overlay);
454 SDL_Flip(sys->display);
457 picture_Release(p_pic);
458 VLC_UNUSED(p_subpicture);
463 * Control for vout display
465 static int Control(vout_display_t *vd, int query, va_list args)
467 vout_display_sys_t *sys = vd->sys;
471 case VOUT_DISPLAY_HIDE_MOUSE:
475 case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE: {
476 const vout_display_cfg_t *cfg = va_arg(args, const vout_display_cfg_t *);
479 sys->display = SDL_SetVideoMode(cfg->display.width,
481 sys->display_bpp, sys->display_flags);
483 sys->display = SDL_SetVideoMode(vd->cfg->display.width,
484 vd->cfg->display.height,
485 sys->display_bpp, sys->display_flags);
489 vout_display_PlacePicture(&sys->place, &vd->source, cfg, !sys->overlay);
491 vout_display_SendEventPicturesInvalid(vd);
494 case VOUT_DISPLAY_CHANGE_FULLSCREEN: {
495 vout_display_cfg_t cfg = *va_arg(args, const vout_display_cfg_t *);
498 sys->display_flags &= ~(SDL_FULLSCREEN | SDL_RESIZABLE);
499 sys->display_flags |= cfg.is_fullscreen ? SDL_FULLSCREEN : SDL_RESIZABLE;
501 if (cfg.is_fullscreen) {
502 cfg.display.width = sys->desktop_width;
503 cfg.display.height = sys->desktop_height;
507 sys->display = SDL_SetVideoMode(cfg.display.width, cfg.display.height,
508 sys->display_bpp, sys->display_flags);
510 vout_display_PlacePicture(&sys->place, &vd->source, &cfg, !sys->overlay);
512 vout_display_SendEventDisplaySize(vd, cfg.display.width, cfg.display.height, cfg.is_fullscreen);
515 case VOUT_DISPLAY_CHANGE_ZOOM:
516 case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
517 case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT: {
518 const vout_display_cfg_t *cfg;
519 const video_format_t *source;
521 if (query == VOUT_DISPLAY_CHANGE_SOURCE_ASPECT) {
522 source = va_arg(args, const video_format_t *);
525 source = &vd->source;
526 cfg = va_arg(args, const vout_display_cfg_t *);
529 sys->display = SDL_SetVideoMode(cfg->display.width, cfg->display.height,
530 sys->display_bpp, sys->display_flags);
532 vout_display_PlacePicture(&sys->place, source, cfg, !sys->overlay);
534 vout_display_SendEventPicturesInvalid(vd);
539 case VOUT_DISPLAY_RESET_PICTURES: {
541 assert(!sys->overlay);
545 picture_pool_Delete(sys->pool);
548 vout_display_PlacePicture(&sys->place, &vd->source, vd->cfg, !sys->overlay);
551 vd->fmt.i_width = sys->place.width;
552 vd->fmt.i_height = sys->place.height;
556 case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
557 case VOUT_DISPLAY_CHANGE_WINDOW_STATE:
558 /* I don't think it is possible to support with SDL:
565 msg_Err(vd, "Unsupported query in vout display SDL");
571 * Proccess pending event
573 static void Manage(vout_display_t *vd)
575 vout_display_sys_t *sys = vd->sys;
579 while (SDL_PollEvent(&event)) {
580 switch (event.type) {
582 vout_display_SendEventClose(vd);
586 /* convert the key if possible */
587 int key = ConvertKey(event.key.keysym.sym);
590 /* Find the right caracter */
591 if ((event.key.keysym.unicode & 0xff80) == 0) {
592 key = event.key.keysym.unicode & 0x7f;
593 /* FIXME: find a better solution than this
594 hack to find the right caracter */
595 if (key >= 1 && key <= 26)
597 else if (key >= 65 && key <= 90)
604 if (event.key.keysym.mod & KMOD_SHIFT)
605 key |= KEY_MODIFIER_SHIFT;
606 if (event.key.keysym.mod & KMOD_CTRL)
607 key |= KEY_MODIFIER_CTRL;
608 if (event.key.keysym.mod & KMOD_ALT)
609 key |= KEY_MODIFIER_ALT;
610 vout_display_SendEventKey(vd, key);
614 case SDL_MOUSEBUTTONDOWN:
615 case SDL_MOUSEBUTTONUP: {
616 static const struct { int sdl; int vlc; } buttons[] = {
617 { SDL_BUTTON_LEFT, MOUSE_BUTTON_LEFT },
618 { SDL_BUTTON_MIDDLE, MOUSE_BUTTON_CENTER },
619 { SDL_BUTTON_RIGHT, MOUSE_BUTTON_RIGHT },
620 { SDL_BUTTON_WHEELUP, MOUSE_BUTTON_WHEEL_UP },
621 { SDL_BUTTON_WHEELDOWN, MOUSE_BUTTON_WHEEL_DOWN },
626 for (int i = 0; buttons[i].sdl != -1; i++) {
627 if (buttons[i].sdl == event.button.button) {
628 if (event.type == SDL_MOUSEBUTTONDOWN)
629 vout_display_SendEventMousePressed(vd, buttons[i].vlc);
631 vout_display_SendEventMouseReleased(vd, buttons[i].vlc);
637 case SDL_MOUSEMOTION: {
638 if (sys->place.width <= 0 || sys->place.height <= 0)
641 const int x = (int64_t)(event.motion.x - sys->place.x) * vd->source.i_width / sys->place.width;
642 const int y = (int64_t)(event.motion.y - sys->place.y) * vd->source.i_height / sys->place.height;
645 vout_display_SendEventMouseMoved(vd, x, y);
649 case SDL_VIDEORESIZE:
650 vout_display_SendEventDisplaySize(vd, event.resize.w, event.resize.h, vd->cfg->is_fullscreen);
660 static const struct {
664 } sdlkeys_to_vlckeys[] = {
674 { SDLK_F10, KEY_F10 },
675 { SDLK_F11, KEY_F11 },
676 { SDLK_F12, KEY_F12 },
678 { SDLK_RETURN, KEY_ENTER },
679 { SDLK_KP_ENTER, KEY_ENTER },
681 { SDLK_ESCAPE, KEY_ESC },
683 { SDLK_MENU, KEY_MENU },
684 { SDLK_LEFT, KEY_LEFT },
685 { SDLK_RIGHT, KEY_RIGHT },
687 { SDLK_DOWN, KEY_DOWN },
689 { SDLK_HOME, KEY_HOME },
690 { SDLK_END, KEY_END },
691 { SDLK_PAGEUP, KEY_PAGEUP },
692 { SDLK_PAGEDOWN, KEY_PAGEDOWN },
694 { SDLK_INSERT, KEY_INSERT },
695 { SDLK_DELETE, KEY_DELETE },
696 /*TODO: find a equivalent for SDL
697 { , KEY_MEDIA_NEXT_TRACK }
698 { , KEY_MEDIA_PREV_TRACK }
699 { , KEY_VOLUME_MUTE }
700 { , KEY_VOLUME_DOWN }
702 { , KEY_MEDIA_PLAY_PAUSE }
703 { , KEY_MEDIA_PLAY_PAUSE }*/
708 static int ConvertKey(SDLKey sdl_key)
710 for (int i = 0; sdlkeys_to_vlckeys[i].sdl_key != 0; i++) {
711 if (sdlkeys_to_vlckeys[i].sdl_key == sdl_key)
712 return sdlkeys_to_vlckeys[i].vlckey;