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 /*****************************************************************************
45 *****************************************************************************/
46 static int Open (vlc_object_t *);
47 static void Close(vlc_object_t *);
49 #define CHROMA_TEXT N_("SDL chroma format")
50 #define CHROMA_LONGTEXT N_(\
51 "Force the SDL renderer to use a specific chroma format instead of " \
52 "trying to improve performances by using the most efficient one.")
54 #define DRIVER_TEXT N_("SDL video driver name")
55 #define DRIVER_LONGTEXT N_(\
56 "Force a specific SDL video output driver.")
60 set_category(CAT_VIDEO)
61 set_subcategory(SUBCAT_VIDEO_VOUT)
62 set_description(N_("Simple DirectMedia Layer video output"))
63 set_capability("vout display", 60)
65 add_string("sdl-chroma", NULL, NULL, CHROMA_TEXT, CHROMA_LONGTEXT, true)
67 add_string("sdl-video-driver", NULL, NULL, DRIVER_TEXT, DRIVER_LONGTEXT, true)
69 set_callbacks(Open, Close)
70 #if defined(__i386__) || defined(__x86_64__)
71 /* On i386, SDL is linked against svgalib */
72 linked_with_a_crap_library_which_uses_atexit()
77 /*****************************************************************************
79 *****************************************************************************/
80 static picture_pool_t *Pool (vout_display_t *, unsigned);
81 static void Display(vout_display_t *, picture_t *);
82 static int Control(vout_display_t *, int, va_list);
83 static void Manage(vout_display_t *);
86 static int ConvertKey(SDLKey);
89 static vlc_mutex_t sdl_lock = VLC_STATIC_MUTEX;
92 struct vout_display_sys_t {
93 vout_display_place_t place;
97 uint32_t display_flags;
99 unsigned int desktop_width;
100 unsigned int desktop_height;
103 SDL_Overlay *overlay;
107 picture_pool_t *pool;
111 * This function initializes SDL vout method.
113 static int Open(vlc_object_t *object)
115 vout_display_t *vd = (vout_display_t *)object;
116 vout_display_sys_t *sys;
118 /* XXX: check for conflicts with the SDL audio output */
119 vlc_mutex_lock(&sdl_lock);
121 /* Check if SDL video module has been initialized */
122 if (SDL_WasInit(SDL_INIT_VIDEO) != 0) {
123 vlc_mutex_unlock(&sdl_lock);
127 vd->sys = sys = calloc(1, sizeof(*sys));
129 vlc_mutex_unlock(&sdl_lock);
134 char *psz_driver = var_CreateGetNonEmptyString(vd, "sdl-video-driver");
136 setenv("SDL_VIDEODRIVER", psz_driver, 1);
142 int sdl_flags = SDL_INIT_VIDEO;
144 /* Win32 SDL implementation doesn't support SDL_INIT_EVENTTHREAD yet*/
145 sdl_flags |= SDL_INIT_EVENTTHREAD;
148 /* In debug mode you may want vlc to dump a core instead of staying stuck */
149 sdl_flags |= SDL_INIT_NOPARACHUTE;
152 /* Initialize library */
153 if (SDL_Init(sdl_flags) < 0) {
154 vlc_mutex_unlock(&sdl_lock);
156 msg_Err(vd, "cannot initialize SDL (%s)", SDL_GetError());
160 vlc_mutex_unlock(&sdl_lock);
162 /* Translate keys into unicode */
163 SDL_EnableUNICODE(1);
165 /* Get the desktop resolution */
166 /* FIXME: SDL has a problem with virtual desktop */
167 sys->desktop_width = SDL_GetVideoInfo()->current_w;
168 sys->desktop_height = SDL_GetVideoInfo()->current_h;
171 video_format_t fmt = vd->fmt;
174 vout_display_info_t info = vd->info;
176 /* Set main window's size */
179 if (vd->cfg->is_fullscreen) {
180 display_width = sys->desktop_width;
181 display_height = sys->desktop_height;
183 display_width = vd->cfg->display.width;
184 display_height = vd->cfg->display.height;
187 /* Initialize flags and cursor */
188 sys->display_flags = SDL_ANYFORMAT | SDL_HWPALETTE | SDL_HWSURFACE | SDL_DOUBLEBUF;
189 sys->display_flags |= vd->cfg->is_fullscreen ? SDL_FULLSCREEN : SDL_RESIZABLE;
191 sys->display_bpp = SDL_VideoModeOK(display_width, display_height,
192 16, sys->display_flags);
193 if (sys->display_bpp == 0) {
194 msg_Err(vd, "no video mode available");
198 sys->display = SDL_SetVideoMode(display_width, display_height,
199 sys->display_bpp, sys->display_flags);
201 msg_Err(vd, "cannot set video mode");
205 /* We keep the surface locked forever */
206 SDL_LockSurface(sys->display);
209 vlc_fourcc_t forced_chroma = 0;
210 char *psz_chroma = var_CreateGetNonEmptyString(vd, "sdl-chroma");
212 forced_chroma = vlc_fourcc_GetCodecFromString(VIDEO_ES, psz_chroma);
214 msg_Dbg(vd, "Forcing chroma to 0x%.8x (%4.4s)",
215 forced_chroma, (const char*)&forced_chroma);
219 /* Try to open an overlay if requested */
221 const bool is_overlay = var_CreateGetBool(vd, "overlay");
228 { VLC_CODEC_YV12, SDL_YV12_OVERLAY },
229 { VLC_CODEC_I420, SDL_IYUV_OVERLAY },
230 { VLC_CODEC_YUYV, SDL_YUY2_OVERLAY },
231 { VLC_CODEC_UYVY, SDL_UYVY_OVERLAY },
232 { VLC_CODEC_YVYU, SDL_YVYU_OVERLAY },
236 const vlc_fourcc_t forced_chromas[] = {
239 const vlc_fourcc_t *fallback_chromas =
240 vlc_fourcc_GetYUVFallback(fmt.i_chroma);
241 const vlc_fourcc_t *chromas = forced_chroma ? forced_chromas : fallback_chromas;
243 for (int pass = forced_chroma ? 1 : 0; pass < 2 && !sys->overlay; pass++) {
244 for (int i = 0; chromas[i] != 0; i++) {
245 const vlc_fourcc_t vlc = chromas[i];
248 for (int j = 0; vlc_to_sdl[j].vlc != 0 && !sdl; j++) {
249 if (vlc_to_sdl[j].vlc == vlc)
250 sdl = vlc_to_sdl[j].sdl;
255 sys->overlay = SDL_CreateYUVOverlay(fmt.i_width, fmt.i_height,
257 if (sys->overlay && !sys->overlay->hw_overlay && pass == 0) {
258 /* Ignore non hardware overlay surface in first pass */
259 SDL_FreeYUVOverlay(sys->overlay);
263 /* We keep the surface locked forever */
264 SDL_LockYUVOverlay(sys->overlay);
267 sys->is_uv_swapped = vlc_fourcc_AreUVPlanesSwapped(fmt.i_chroma,
269 if (sys->is_uv_swapped)
270 fmt.i_chroma = vd->fmt.i_chroma;
276 msg_Warn(vd, "SDL overlay disabled by the user");
280 vout_display_cfg_t place_cfg = *vd->cfg;
281 place_cfg.display.width = display_width;
282 place_cfg.display.height = display_height;
283 vout_display_PlacePicture(&sys->place, &vd->source, &place_cfg, !sys->overlay);
285 /* If no overlay, fallback to software output */
288 switch (sys->display->format->BitsPerPixel) {
290 fmt.i_chroma = VLC_CODEC_RGB8;
293 fmt.i_chroma = VLC_CODEC_RGB15;
296 fmt.i_chroma = VLC_CODEC_RGB16;
299 fmt.i_chroma = VLC_CODEC_RGB24;
302 fmt.i_chroma = VLC_CODEC_RGB32;
305 msg_Err(vd, "unknown screen depth %i",
306 sys->display->format->BitsPerPixel);
310 /* All we have is an RGB image with square pixels */
311 fmt.i_width = display_width;
312 fmt.i_height = display_height;
313 fmt.i_rmask = sys->display->format->Rmask;
314 fmt.i_gmask = sys->display->format->Gmask;
315 fmt.i_bmask = sys->display->format->Bmask;
317 info.has_pictures_invalid = true;
320 if (vd->cfg->display.title)
321 SDL_WM_SetCaption(vd->cfg->display.title,
322 vd->cfg->display.title);
323 else if (!sys->overlay)
324 SDL_WM_SetCaption(VOUT_TITLE " (software RGB SDL output)",
325 VOUT_TITLE " (software RGB SDL output)");
326 else if (sys->overlay->hw_overlay)
327 SDL_WM_SetCaption(VOUT_TITLE " (hardware YUV SDL output)",
328 VOUT_TITLE " (hardware YUV SDL output)");
330 SDL_WM_SetCaption(VOUT_TITLE " (software YUV SDL output)",
331 VOUT_TITLE " (software YUV SDL output)");
334 SDL_EventState(SDL_KEYUP, SDL_IGNORE); /* ignore keys up */
336 /* Setup vout_display now that everything is fine */
342 vd->display = Display;
343 vd->control = Control;
347 vout_display_SendEventDisplaySize(vd, display_width, display_height, vd->cfg->is_fullscreen);
351 msg_Err(vd, "cannot set up SDL (%s)", SDL_GetError());
354 SDL_UnlockSurface(sys->display);
355 SDL_FreeSurface(sys->display);
358 vlc_mutex_lock(&sdl_lock);
359 SDL_QuitSubSystem(SDL_INIT_VIDEO);
360 vlc_mutex_unlock(&sdl_lock);
367 * Close a SDL video output
369 static void Close(vlc_object_t *object)
371 vout_display_t *vd = (vout_display_t *)object;
372 vout_display_sys_t *sys = vd->sys;
375 picture_pool_Delete(sys->pool);
378 SDL_LockYUVOverlay(sys->overlay);
379 SDL_FreeYUVOverlay(sys->overlay);
381 SDL_UnlockSurface (sys->display);
382 SDL_FreeSurface(sys->display);
384 vlc_mutex_lock(&sdl_lock);
385 SDL_QuitSubSystem(SDL_INIT_VIDEO);
386 vlc_mutex_unlock(&sdl_lock);
392 * Return a pool of direct buffers
394 static picture_pool_t *Pool(vout_display_t *vd, unsigned count)
396 vout_display_sys_t *sys = vd->sys;
400 picture_resource_t rsc;
402 memset(&rsc, 0, sizeof(rsc));
405 SDL_Overlay *ol = sys->overlay;
407 for (int i = 0; i < ol->planes; i++) {
408 rsc.p[i].p_pixels = ol->pixels[ i > 0 && sys->is_uv_swapped ? (3-i) : i];
409 rsc.p[i].i_pitch = ol->pitches[i > 0 && sys->is_uv_swapped ? (3-i) : i];
410 rsc.p[i].i_lines = ol->h;
411 if (ol->format == SDL_YV12_OVERLAY ||
412 ol->format == SDL_IYUV_OVERLAY)
413 rsc.p[i].i_lines /= 2;
417 const int x = sys->place.x;
418 const int y = sys->place.y;
420 SDL_Surface *sf = sys->display;
421 SDL_FillRect(sf, NULL, 0);
423 assert(x >= 0 && y >= 0);
424 rsc.p[0].p_pixels = (uint8_t*)sf->pixels + y * sf->pitch + x * ((sf->format->BitsPerPixel + 7) / 8);
425 rsc.p[0].i_pitch = sf->pitch;
426 rsc.p[0].i_lines = vd->fmt.i_height;
429 picture_t *picture = picture_NewFromResource(&vd->fmt, &rsc);;
433 sys->pool = picture_pool_New(1, &picture);
442 static void Display(vout_display_t *vd, picture_t *p_pic)
444 vout_display_sys_t *sys = vd->sys;
448 disp.x = sys->place.x;
449 disp.y = sys->place.y;
450 disp.w = sys->place.width;
451 disp.h = sys->place.height;
453 SDL_UnlockYUVOverlay(sys->overlay);
454 SDL_DisplayYUVOverlay(sys->overlay , &disp);
455 SDL_LockYUVOverlay(sys->overlay);
457 SDL_Flip(sys->display);
460 picture_Release(p_pic);
465 * Control for vout display
467 static int Control(vout_display_t *vd, int query, va_list args)
469 vout_display_sys_t *sys = vd->sys;
473 case VOUT_DISPLAY_HIDE_MOUSE:
477 case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE: {
478 const vout_display_cfg_t *cfg = va_arg(args, const vout_display_cfg_t *);
481 sys->display = SDL_SetVideoMode(cfg->display.width,
483 sys->display_bpp, sys->display_flags);
485 sys->display = SDL_SetVideoMode(vd->cfg->display.width,
486 vd->cfg->display.height,
487 sys->display_bpp, sys->display_flags);
491 vout_display_PlacePicture(&sys->place, &vd->source, cfg, !sys->overlay);
493 vout_display_SendEventPicturesInvalid(vd);
496 case VOUT_DISPLAY_CHANGE_FULLSCREEN: {
497 vout_display_cfg_t cfg = *va_arg(args, const vout_display_cfg_t *);
500 sys->display_flags &= ~(SDL_FULLSCREEN | SDL_RESIZABLE);
501 sys->display_flags |= cfg.is_fullscreen ? SDL_FULLSCREEN : SDL_RESIZABLE;
503 if (cfg.is_fullscreen) {
504 cfg.display.width = sys->desktop_width;
505 cfg.display.height = sys->desktop_height;
509 sys->display = SDL_SetVideoMode(cfg.display.width, cfg.display.height,
510 sys->display_bpp, sys->display_flags);
512 vout_display_PlacePicture(&sys->place, &vd->source, &cfg, !sys->overlay);
514 vout_display_SendEventDisplaySize(vd, cfg.display.width, cfg.display.height, cfg.is_fullscreen);
517 case VOUT_DISPLAY_CHANGE_ZOOM:
518 case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
519 case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT: {
520 const vout_display_cfg_t *cfg;
521 const video_format_t *source;
523 if (query == VOUT_DISPLAY_CHANGE_SOURCE_ASPECT) {
524 source = va_arg(args, const video_format_t *);
527 source = &vd->source;
528 cfg = va_arg(args, const vout_display_cfg_t *);
531 sys->display = SDL_SetVideoMode(cfg->display.width, cfg->display.height,
532 sys->display_bpp, sys->display_flags);
534 vout_display_PlacePicture(&sys->place, source, cfg, !sys->overlay);
536 vout_display_SendEventPicturesInvalid(vd);
541 case VOUT_DISPLAY_RESET_PICTURES: {
543 assert(!sys->overlay);
547 picture_pool_Delete(sys->pool);
550 vout_display_PlacePicture(&sys->place, &vd->source, vd->cfg, !sys->overlay);
553 vd->fmt.i_width = sys->place.width;
554 vd->fmt.i_height = sys->place.height;
558 case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
559 case VOUT_DISPLAY_CHANGE_WINDOW_STATE:
560 /* I don't think it is possible to support with SDL:
567 msg_Err(vd, "Unsupported query in vout display SDL");
573 * Proccess pending event
575 static void Manage(vout_display_t *vd)
577 vout_display_sys_t *sys = vd->sys;
581 while (SDL_PollEvent(&event)) {
582 switch (event.type) {
584 vout_display_SendEventClose(vd);
588 /* convert the key if possible */
589 int key = ConvertKey(event.key.keysym.sym);
592 /* Find the right caracter */
593 if ((event.key.keysym.unicode & 0xff80) == 0) {
594 key = event.key.keysym.unicode & 0x7f;
595 /* FIXME: find a better solution than this
596 hack to find the right caracter */
597 if (key >= 1 && key <= 26)
599 else if (key >= 65 && key <= 90)
606 if (event.key.keysym.mod & KMOD_SHIFT)
607 key |= KEY_MODIFIER_SHIFT;
608 if (event.key.keysym.mod & KMOD_CTRL)
609 key |= KEY_MODIFIER_CTRL;
610 if (event.key.keysym.mod & KMOD_ALT)
611 key |= KEY_MODIFIER_ALT;
612 vout_display_SendEventKey(vd, key);
616 case SDL_MOUSEBUTTONDOWN:
617 case SDL_MOUSEBUTTONUP: {
618 static const struct { int sdl; int vlc; } buttons[] = {
619 { SDL_BUTTON_LEFT, MOUSE_BUTTON_LEFT },
620 { SDL_BUTTON_MIDDLE, MOUSE_BUTTON_CENTER },
621 { SDL_BUTTON_RIGHT, MOUSE_BUTTON_RIGHT },
622 { SDL_BUTTON_WHEELUP, MOUSE_BUTTON_WHEEL_UP },
623 { SDL_BUTTON_WHEELDOWN, MOUSE_BUTTON_WHEEL_DOWN },
628 for (int i = 0; buttons[i].sdl != -1; i++) {
629 if (buttons[i].sdl == event.button.button) {
630 if (event.type == SDL_MOUSEBUTTONDOWN)
631 vout_display_SendEventMousePressed(vd, buttons[i].vlc);
633 vout_display_SendEventMouseReleased(vd, buttons[i].vlc);
639 case SDL_MOUSEMOTION: {
640 if (sys->place.width <= 0 || sys->place.height <= 0)
643 const int x = (int64_t)(event.motion.x - sys->place.x) * vd->source.i_width / sys->place.width;
644 const int y = (int64_t)(event.motion.y - sys->place.y) * vd->source.i_height / sys->place.height;
647 vout_display_SendEventMouseMoved(vd, x, y);
651 case SDL_VIDEORESIZE:
652 vout_display_SendEventDisplaySize(vd, event.resize.w, event.resize.h, vd->cfg->is_fullscreen);
662 static const struct {
666 } sdlkeys_to_vlckeys[] = {
676 { SDLK_F10, KEY_F10 },
677 { SDLK_F11, KEY_F11 },
678 { SDLK_F12, KEY_F12 },
680 { SDLK_RETURN, KEY_ENTER },
681 { SDLK_KP_ENTER, KEY_ENTER },
683 { SDLK_ESCAPE, KEY_ESC },
685 { SDLK_MENU, KEY_MENU },
686 { SDLK_LEFT, KEY_LEFT },
687 { SDLK_RIGHT, KEY_RIGHT },
689 { SDLK_DOWN, KEY_DOWN },
691 { SDLK_HOME, KEY_HOME },
692 { SDLK_END, KEY_END },
693 { SDLK_PAGEUP, KEY_PAGEUP },
694 { SDLK_PAGEDOWN, KEY_PAGEDOWN },
696 { SDLK_INSERT, KEY_INSERT },
697 { SDLK_DELETE, KEY_DELETE },
698 /*TODO: find a equivalent for SDL
699 { , KEY_MEDIA_NEXT_TRACK }
700 { , KEY_MEDIA_PREV_TRACK }
701 { , KEY_VOLUME_MUTE }
702 { , KEY_VOLUME_DOWN }
704 { , KEY_MEDIA_PLAY_PAUSE }
705 { , KEY_MEDIA_PLAY_PAUSE }*/
710 static int ConvertKey(SDLKey sdl_key)
712 for (int i = 0; sdlkeys_to_vlckeys[i].sdl_key != 0; i++) {
713 if (sdlkeys_to_vlckeys[i].sdl_key == sdl_key)
714 return sdlkeys_to_vlckeys[i].vlckey;