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>
38 #include "keythread.h"
44 /*****************************************************************************
46 *****************************************************************************/
47 static int Open (vlc_object_t *);
48 static void Close(vlc_object_t *);
50 #define CHROMA_TEXT N_("SDL chroma format")
51 #define CHROMA_LONGTEXT N_(\
52 "Force the SDL renderer to use a specific chroma format instead of " \
53 "trying to improve performances by using the most efficient one.")
57 set_category(CAT_VIDEO)
58 set_subcategory(SUBCAT_VIDEO_VOUT)
59 set_description(N_("Simple DirectMedia Layer video output"))
60 set_capability("vout display", 60)
62 add_string("sdl-chroma", NULL, NULL, CHROMA_TEXT, CHROMA_LONGTEXT, true)
63 add_obsolete_string("sdl-video-driver") /* obsolete since 1.1.0 */
64 set_callbacks(Open, Close)
65 #if defined(__i386__) || defined(__x86_64__)
66 /* On i386, SDL is linked against svgalib */
67 cannot_unload_broken_library()
72 /*****************************************************************************
74 *****************************************************************************/
75 static picture_pool_t *Pool (vout_display_t *, unsigned);
76 static void Display(vout_display_t *, picture_t *);
77 static int Control(vout_display_t *, int, va_list);
78 static void Manage(vout_display_t *);
81 static int ConvertKey(SDLKey);
84 static vlc_mutex_t sdl_lock = VLC_STATIC_MUTEX;
87 struct vout_display_sys_t {
88 vout_display_place_t place;
92 uint32_t display_flags;
94 unsigned int desktop_width;
95 unsigned int desktop_height;
102 picture_pool_t *pool;
107 * This function initializes SDL vout method.
109 static int Open(vlc_object_t *object)
111 vout_display_t *vd = (vout_display_t *)object;
112 vout_display_sys_t *sys;
114 /* XXX: check for conflicts with the SDL audio output */
115 vlc_mutex_lock(&sdl_lock);
117 /* Check if SDL video module has been initialized */
118 if (SDL_WasInit(SDL_INIT_VIDEO) != 0) {
119 vlc_mutex_unlock(&sdl_lock);
123 vd->sys = sys = calloc(1, sizeof(*sys));
125 vlc_mutex_unlock(&sdl_lock);
130 int sdl_flags = SDL_INIT_VIDEO;
132 /* Win32 SDL implementation doesn't support SDL_INIT_EVENTTHREAD yet*/
133 sdl_flags |= SDL_INIT_EVENTTHREAD;
136 /* In debug mode you may want vlc to dump a core instead of staying stuck */
137 sdl_flags |= SDL_INIT_NOPARACHUTE;
140 /* Initialize library */
141 if (SDL_Init(sdl_flags) < 0) {
142 vlc_mutex_unlock(&sdl_lock);
144 msg_Err(vd, "cannot initialize SDL (%s)", SDL_GetError());
148 vlc_mutex_unlock(&sdl_lock);
150 /* Translate keys into unicode */
151 SDL_EnableUNICODE(1);
153 /* Get the desktop resolution */
154 /* FIXME: SDL has a problem with virtual desktop */
155 sys->desktop_width = SDL_GetVideoInfo()->current_w;
156 sys->desktop_height = SDL_GetVideoInfo()->current_h;
159 video_format_t fmt = vd->fmt;
162 vout_display_info_t info = vd->info;
164 /* Set main window's size */
167 if (vd->cfg->is_fullscreen) {
168 display_width = sys->desktop_width;
169 display_height = sys->desktop_height;
171 display_width = vd->cfg->display.width;
172 display_height = vd->cfg->display.height;
175 /* Initialize flags and cursor */
176 sys->display_flags = SDL_ANYFORMAT | SDL_HWPALETTE | SDL_HWSURFACE | SDL_DOUBLEBUF;
177 sys->display_flags |= vd->cfg->is_fullscreen ? SDL_FULLSCREEN : SDL_RESIZABLE;
179 sys->display_bpp = SDL_VideoModeOK(display_width, display_height,
180 16, sys->display_flags);
181 if (sys->display_bpp == 0) {
182 msg_Err(vd, "no video mode available");
185 vout_display_DeleteWindow(vd, NULL);
187 sys->display = SDL_SetVideoMode(display_width, display_height,
188 sys->display_bpp, sys->display_flags);
190 msg_Err(vd, "cannot set video mode");
194 /* We keep the surface locked forever */
195 SDL_LockSurface(sys->display);
198 vlc_fourcc_t forced_chroma = 0;
199 char *psz_chroma = var_CreateGetNonEmptyString(vd, "sdl-chroma");
201 forced_chroma = vlc_fourcc_GetCodecFromString(VIDEO_ES, psz_chroma);
203 msg_Dbg(vd, "Forcing chroma to 0x%.8x (%4.4s)",
204 forced_chroma, (const char*)&forced_chroma);
208 /* Try to open an overlay if requested */
210 const bool is_overlay = var_CreateGetBool(vd, "overlay");
217 { VLC_CODEC_YV12, SDL_YV12_OVERLAY },
218 { VLC_CODEC_I420, SDL_IYUV_OVERLAY },
219 { VLC_CODEC_YUYV, SDL_YUY2_OVERLAY },
220 { VLC_CODEC_UYVY, SDL_UYVY_OVERLAY },
221 { VLC_CODEC_YVYU, SDL_YVYU_OVERLAY },
225 const vlc_fourcc_t forced_chromas[] = {
228 const vlc_fourcc_t *fallback_chromas =
229 vlc_fourcc_GetYUVFallback(fmt.i_chroma);
230 const vlc_fourcc_t *chromas = forced_chroma ? forced_chromas : fallback_chromas;
232 for (int pass = forced_chroma ? 1 : 0; pass < 2 && !sys->overlay; pass++) {
233 for (int i = 0; chromas[i] != 0; i++) {
234 const vlc_fourcc_t vlc = chromas[i];
237 for (int j = 0; vlc_to_sdl[j].vlc != 0 && !sdl; j++) {
238 if (vlc_to_sdl[j].vlc == vlc)
239 sdl = vlc_to_sdl[j].sdl;
244 sys->overlay = SDL_CreateYUVOverlay(fmt.i_width, fmt.i_height,
246 if (sys->overlay && !sys->overlay->hw_overlay && pass == 0) {
247 /* Ignore non hardware overlay surface in first pass */
248 SDL_FreeYUVOverlay(sys->overlay);
252 /* We keep the surface locked forever */
253 SDL_LockYUVOverlay(sys->overlay);
256 sys->is_uv_swapped = vlc_fourcc_AreUVPlanesSwapped(fmt.i_chroma,
258 if (sys->is_uv_swapped)
259 fmt.i_chroma = vd->fmt.i_chroma;
265 msg_Warn(vd, "SDL overlay disabled by the user");
269 vout_display_cfg_t place_cfg = *vd->cfg;
270 place_cfg.display.width = display_width;
271 place_cfg.display.height = display_height;
272 vout_display_PlacePicture(&sys->place, &vd->source, &place_cfg, !sys->overlay);
274 /* If no overlay, fallback to software output */
277 switch (sys->display->format->BitsPerPixel) {
279 fmt.i_chroma = VLC_CODEC_RGB8;
282 fmt.i_chroma = VLC_CODEC_RGB15;
285 fmt.i_chroma = VLC_CODEC_RGB16;
288 fmt.i_chroma = VLC_CODEC_RGB24;
291 fmt.i_chroma = VLC_CODEC_RGB32;
294 msg_Err(vd, "unknown screen depth %i",
295 sys->display->format->BitsPerPixel);
299 /* All we have is an RGB image with square pixels */
300 fmt.i_width = display_width;
301 fmt.i_height = display_height;
302 fmt.i_rmask = sys->display->format->Rmask;
303 fmt.i_gmask = sys->display->format->Gmask;
304 fmt.i_bmask = sys->display->format->Bmask;
306 info.has_pictures_invalid = true;
309 if (vd->cfg->display.title)
310 SDL_WM_SetCaption(vd->cfg->display.title,
311 vd->cfg->display.title);
312 else if (!sys->overlay)
313 SDL_WM_SetCaption(VOUT_TITLE " (software RGB SDL output)",
314 VOUT_TITLE " (software RGB SDL output)");
315 else if (sys->overlay->hw_overlay)
316 SDL_WM_SetCaption(VOUT_TITLE " (hardware YUV SDL output)",
317 VOUT_TITLE " (hardware YUV SDL output)");
319 SDL_WM_SetCaption(VOUT_TITLE " (software YUV SDL output)",
320 VOUT_TITLE " (software YUV SDL output)");
323 SDL_EventState(SDL_KEYUP, SDL_IGNORE); /* ignore keys up */
325 /* Setup vout_display now that everything is fine */
331 vd->display = Display;
332 vd->control = Control;
336 vout_display_SendEventDisplaySize(vd, display_width, display_height, vd->cfg->is_fullscreen);
338 sys->keys = vlc_CreateKeyThread (vd);
342 msg_Err(vd, "cannot set up SDL (%s)", SDL_GetError());
345 SDL_UnlockSurface(sys->display);
346 SDL_FreeSurface(sys->display);
349 vlc_mutex_lock(&sdl_lock);
350 SDL_QuitSubSystem(SDL_INIT_VIDEO);
351 vlc_mutex_unlock(&sdl_lock);
358 * Close a SDL video output
360 static void Close(vlc_object_t *object)
362 vout_display_t *vd = (vout_display_t *)object;
363 vout_display_sys_t *sys = vd->sys;
365 vlc_DestroyKeyThread(sys->keys);
368 picture_pool_Delete(sys->pool);
371 SDL_LockYUVOverlay(sys->overlay);
372 SDL_FreeYUVOverlay(sys->overlay);
374 SDL_UnlockSurface (sys->display);
375 SDL_FreeSurface(sys->display);
377 vlc_mutex_lock(&sdl_lock);
378 SDL_QuitSubSystem(SDL_INIT_VIDEO);
379 vlc_mutex_unlock(&sdl_lock);
385 * Return a pool of direct buffers
387 static picture_pool_t *Pool(vout_display_t *vd, unsigned count)
389 vout_display_sys_t *sys = vd->sys;
393 picture_resource_t rsc;
395 memset(&rsc, 0, sizeof(rsc));
398 SDL_Overlay *ol = sys->overlay;
400 for (int i = 0; i < ol->planes; i++) {
401 rsc.p[i].p_pixels = ol->pixels[ i > 0 && sys->is_uv_swapped ? (3-i) : i];
402 rsc.p[i].i_pitch = ol->pitches[i > 0 && sys->is_uv_swapped ? (3-i) : i];
403 rsc.p[i].i_lines = ol->h;
404 if (ol->format == SDL_YV12_OVERLAY ||
405 ol->format == SDL_IYUV_OVERLAY)
406 rsc.p[i].i_lines /= 2;
410 const int x = sys->place.x;
411 const int y = sys->place.y;
413 SDL_Surface *sf = sys->display;
414 SDL_FillRect(sf, NULL, 0);
416 assert(x >= 0 && y >= 0);
417 rsc.p[0].p_pixels = (uint8_t*)sf->pixels + y * sf->pitch + x * ((sf->format->BitsPerPixel + 7) / 8);
418 rsc.p[0].i_pitch = sf->pitch;
419 rsc.p[0].i_lines = vd->fmt.i_height;
422 picture_t *picture = picture_NewFromResource(&vd->fmt, &rsc);;
426 sys->pool = picture_pool_New(1, &picture);
435 static void Display(vout_display_t *vd, picture_t *p_pic)
437 vout_display_sys_t *sys = vd->sys;
441 disp.x = sys->place.x;
442 disp.y = sys->place.y;
443 disp.w = sys->place.width;
444 disp.h = sys->place.height;
446 SDL_UnlockYUVOverlay(sys->overlay);
447 SDL_DisplayYUVOverlay(sys->overlay , &disp);
448 SDL_LockYUVOverlay(sys->overlay);
450 SDL_Flip(sys->display);
453 picture_Release(p_pic);
458 * Control for vout display
460 static int Control(vout_display_t *vd, int query, va_list args)
462 vout_display_sys_t *sys = vd->sys;
466 case VOUT_DISPLAY_HIDE_MOUSE:
470 case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE: {
471 const vout_display_cfg_t *cfg = va_arg(args, const vout_display_cfg_t *);
474 sys->display = SDL_SetVideoMode(cfg->display.width,
476 sys->display_bpp, sys->display_flags);
478 sys->display = SDL_SetVideoMode(vd->cfg->display.width,
479 vd->cfg->display.height,
480 sys->display_bpp, sys->display_flags);
484 vout_display_PlacePicture(&sys->place, &vd->source, cfg, !sys->overlay);
486 vout_display_SendEventPicturesInvalid(vd);
489 case VOUT_DISPLAY_CHANGE_FULLSCREEN: {
490 vout_display_cfg_t cfg = *va_arg(args, const vout_display_cfg_t *);
493 sys->display_flags &= ~(SDL_FULLSCREEN | SDL_RESIZABLE);
494 sys->display_flags |= cfg.is_fullscreen ? SDL_FULLSCREEN : SDL_RESIZABLE;
496 if (cfg.is_fullscreen) {
497 cfg.display.width = sys->desktop_width;
498 cfg.display.height = sys->desktop_height;
502 sys->display = SDL_SetVideoMode(cfg.display.width, cfg.display.height,
503 sys->display_bpp, sys->display_flags);
505 vout_display_PlacePicture(&sys->place, &vd->source, &cfg, !sys->overlay);
507 vout_display_SendEventDisplaySize(vd, cfg.display.width, cfg.display.height, cfg.is_fullscreen);
510 case VOUT_DISPLAY_CHANGE_ZOOM:
511 case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
512 case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT: {
513 const vout_display_cfg_t *cfg;
514 const video_format_t *source;
516 if (query == VOUT_DISPLAY_CHANGE_SOURCE_ASPECT) {
517 source = va_arg(args, const video_format_t *);
520 source = &vd->source;
521 cfg = va_arg(args, const vout_display_cfg_t *);
524 sys->display = SDL_SetVideoMode(cfg->display.width, cfg->display.height,
525 sys->display_bpp, sys->display_flags);
527 vout_display_PlacePicture(&sys->place, source, cfg, !sys->overlay);
529 vout_display_SendEventPicturesInvalid(vd);
534 case VOUT_DISPLAY_RESET_PICTURES: {
536 assert(!sys->overlay);
540 picture_pool_Delete(sys->pool);
543 vout_display_PlacePicture(&sys->place, &vd->source, vd->cfg, !sys->overlay);
546 vd->fmt.i_width = sys->place.width;
547 vd->fmt.i_height = sys->place.height;
551 case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
552 case VOUT_DISPLAY_CHANGE_WINDOW_STATE:
553 /* I don't think it is possible to support with SDL:
560 msg_Err(vd, "Unsupported query in vout display SDL");
566 * Proccess pending event
568 static void Manage(vout_display_t *vd)
570 vout_display_sys_t *sys = vd->sys;
574 while (SDL_PollEvent(&event)) {
575 switch (event.type) {
577 vout_display_SendEventClose(vd);
581 /* convert the key if possible */
582 int key = ConvertKey(event.key.keysym.sym);
585 /* Find the right caracter */
586 if ((event.key.keysym.unicode & 0xff80) == 0) {
587 key = event.key.keysym.unicode & 0x7f;
588 /* FIXME: find a better solution than this
589 hack to find the right caracter */
590 if (key >= 1 && key <= 26)
592 else if (key >= 65 && key <= 90)
599 if (event.key.keysym.mod & KMOD_SHIFT)
600 key |= KEY_MODIFIER_SHIFT;
601 if (event.key.keysym.mod & KMOD_CTRL)
602 key |= KEY_MODIFIER_CTRL;
603 if (event.key.keysym.mod & KMOD_ALT)
604 key |= KEY_MODIFIER_ALT;
605 vlc_EmitKey(sys->keys, key);
609 case SDL_MOUSEBUTTONDOWN:
610 case SDL_MOUSEBUTTONUP: {
611 static const struct { int sdl; int vlc; } buttons[] = {
612 { SDL_BUTTON_LEFT, MOUSE_BUTTON_LEFT },
613 { SDL_BUTTON_MIDDLE, MOUSE_BUTTON_CENTER },
614 { SDL_BUTTON_RIGHT, MOUSE_BUTTON_RIGHT },
615 { SDL_BUTTON_WHEELUP, MOUSE_BUTTON_WHEEL_UP },
616 { SDL_BUTTON_WHEELDOWN, MOUSE_BUTTON_WHEEL_DOWN },
621 for (int i = 0; buttons[i].sdl != -1; i++) {
622 if (buttons[i].sdl == event.button.button) {
623 if (event.type == SDL_MOUSEBUTTONDOWN)
624 vout_display_SendEventMousePressed(vd, buttons[i].vlc);
626 vout_display_SendEventMouseReleased(vd, buttons[i].vlc);
632 case SDL_MOUSEMOTION: {
633 if (sys->place.width <= 0 || sys->place.height <= 0)
636 const int x = (int64_t)(event.motion.x - sys->place.x) * vd->source.i_width / sys->place.width;
637 const int y = (int64_t)(event.motion.y - sys->place.y) * vd->source.i_height / sys->place.height;
640 vout_display_SendEventMouseMoved(vd, x, y);
644 case SDL_VIDEORESIZE:
645 vout_display_SendEventDisplaySize(vd, event.resize.w, event.resize.h, vd->cfg->is_fullscreen);
655 static const struct {
659 } sdlkeys_to_vlckeys[] = {
669 { SDLK_F10, KEY_F10 },
670 { SDLK_F11, KEY_F11 },
671 { SDLK_F12, KEY_F12 },
673 { SDLK_RETURN, KEY_ENTER },
674 { SDLK_KP_ENTER, KEY_ENTER },
676 { SDLK_ESCAPE, KEY_ESC },
678 { SDLK_MENU, KEY_MENU },
679 { SDLK_LEFT, KEY_LEFT },
680 { SDLK_RIGHT, KEY_RIGHT },
682 { SDLK_DOWN, KEY_DOWN },
684 { SDLK_HOME, KEY_HOME },
685 { SDLK_END, KEY_END },
686 { SDLK_PAGEUP, KEY_PAGEUP },
687 { SDLK_PAGEDOWN, KEY_PAGEDOWN },
689 { SDLK_INSERT, KEY_INSERT },
690 { SDLK_DELETE, KEY_DELETE },
691 /*TODO: find a equivalent for SDL
692 { , KEY_MEDIA_NEXT_TRACK }
693 { , KEY_MEDIA_PREV_TRACK }
694 { , KEY_VOLUME_MUTE }
695 { , KEY_VOLUME_DOWN }
697 { , KEY_MEDIA_PLAY_PAUSE }
698 { , KEY_MEDIA_PLAY_PAUSE }*/
703 static int ConvertKey(SDLKey sdl_key)
705 for (int i = 0; sdlkeys_to_vlckeys[i].sdl_key != 0; i++) {
706 if (sdlkeys_to_vlckeys[i].sdl_key == sdl_key)
707 return sdlkeys_to_vlckeys[i].vlckey;