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.")
56 set_category(CAT_VIDEO)
57 set_subcategory(SUBCAT_VIDEO_VOUT)
58 set_description(N_("Simple DirectMedia Layer video output"))
59 set_capability("vout display", 60)
61 add_string("sdl-chroma", NULL, NULL, CHROMA_TEXT, CHROMA_LONGTEXT, true)
62 add_obsolete_string("sdl-video-driver") /* obsolete since 1.1.0 */
63 set_callbacks(Open, Close)
64 #if defined(__i386__) || defined(__x86_64__)
65 /* On i386, SDL is linked against svgalib */
66 cannot_unload_broken_library()
71 /*****************************************************************************
73 *****************************************************************************/
74 static picture_pool_t *Pool (vout_display_t *, unsigned);
75 static void Display(vout_display_t *, picture_t *);
76 static int Control(vout_display_t *, int, va_list);
77 static void Manage(vout_display_t *);
80 static int ConvertKey(SDLKey);
83 static vlc_mutex_t sdl_lock = VLC_STATIC_MUTEX;
86 struct vout_display_sys_t {
87 vout_display_place_t place;
91 uint32_t display_flags;
93 unsigned int desktop_width;
94 unsigned int desktop_height;
101 picture_pool_t *pool;
105 * This function initializes SDL vout method.
107 static int Open(vlc_object_t *object)
109 vout_display_t *vd = (vout_display_t *)object;
110 vout_display_sys_t *sys;
112 /* XXX: check for conflicts with the SDL audio output */
113 vlc_mutex_lock(&sdl_lock);
115 /* Check if SDL video module has been initialized */
116 if (SDL_WasInit(SDL_INIT_VIDEO) != 0) {
117 vlc_mutex_unlock(&sdl_lock);
121 vd->sys = sys = calloc(1, sizeof(*sys));
123 vlc_mutex_unlock(&sdl_lock);
128 int sdl_flags = SDL_INIT_VIDEO;
130 /* Win32 SDL implementation doesn't support SDL_INIT_EVENTTHREAD yet*/
131 sdl_flags |= SDL_INIT_EVENTTHREAD;
134 /* In debug mode you may want vlc to dump a core instead of staying stuck */
135 sdl_flags |= SDL_INIT_NOPARACHUTE;
138 /* Initialize library */
139 if (SDL_Init(sdl_flags) < 0) {
140 vlc_mutex_unlock(&sdl_lock);
142 msg_Err(vd, "cannot initialize SDL (%s)", SDL_GetError());
146 vlc_mutex_unlock(&sdl_lock);
148 /* Translate keys into unicode */
149 SDL_EnableUNICODE(1);
151 /* Get the desktop resolution */
152 /* FIXME: SDL has a problem with virtual desktop */
153 sys->desktop_width = SDL_GetVideoInfo()->current_w;
154 sys->desktop_height = SDL_GetVideoInfo()->current_h;
157 video_format_t fmt = vd->fmt;
160 vout_display_info_t info = vd->info;
162 /* Set main window's size */
165 if (vd->cfg->is_fullscreen) {
166 display_width = sys->desktop_width;
167 display_height = sys->desktop_height;
169 display_width = vd->cfg->display.width;
170 display_height = vd->cfg->display.height;
173 /* Initialize flags and cursor */
174 sys->display_flags = SDL_ANYFORMAT | SDL_HWPALETTE | SDL_HWSURFACE | SDL_DOUBLEBUF;
175 sys->display_flags |= vd->cfg->is_fullscreen ? SDL_FULLSCREEN : SDL_RESIZABLE;
177 sys->display_bpp = SDL_VideoModeOK(display_width, display_height,
178 16, sys->display_flags);
179 if (sys->display_bpp == 0) {
180 msg_Err(vd, "no video mode available");
183 vout_display_DeleteWindow(vd, NULL);
185 sys->display = SDL_SetVideoMode(display_width, display_height,
186 sys->display_bpp, sys->display_flags);
188 msg_Err(vd, "cannot set video mode");
192 /* We keep the surface locked forever */
193 SDL_LockSurface(sys->display);
196 vlc_fourcc_t forced_chroma = 0;
197 char *psz_chroma = var_CreateGetNonEmptyString(vd, "sdl-chroma");
199 forced_chroma = vlc_fourcc_GetCodecFromString(VIDEO_ES, psz_chroma);
201 msg_Dbg(vd, "Forcing chroma to 0x%.8x (%4.4s)",
202 forced_chroma, (const char*)&forced_chroma);
206 /* Try to open an overlay if requested */
208 const bool is_overlay = var_CreateGetBool(vd, "overlay");
215 { VLC_CODEC_YV12, SDL_YV12_OVERLAY },
216 { VLC_CODEC_I420, SDL_IYUV_OVERLAY },
217 { VLC_CODEC_YUYV, SDL_YUY2_OVERLAY },
218 { VLC_CODEC_UYVY, SDL_UYVY_OVERLAY },
219 { VLC_CODEC_YVYU, SDL_YVYU_OVERLAY },
223 const vlc_fourcc_t forced_chromas[] = {
226 const vlc_fourcc_t *fallback_chromas =
227 vlc_fourcc_GetYUVFallback(fmt.i_chroma);
228 const vlc_fourcc_t *chromas = forced_chroma ? forced_chromas : fallback_chromas;
230 for (int pass = forced_chroma ? 1 : 0; pass < 2 && !sys->overlay; pass++) {
231 for (int i = 0; chromas[i] != 0; i++) {
232 const vlc_fourcc_t vlc = chromas[i];
235 for (int j = 0; vlc_to_sdl[j].vlc != 0 && !sdl; j++) {
236 if (vlc_to_sdl[j].vlc == vlc)
237 sdl = vlc_to_sdl[j].sdl;
242 sys->overlay = SDL_CreateYUVOverlay(fmt.i_width, fmt.i_height,
244 if (sys->overlay && !sys->overlay->hw_overlay && pass == 0) {
245 /* Ignore non hardware overlay surface in first pass */
246 SDL_FreeYUVOverlay(sys->overlay);
250 /* We keep the surface locked forever */
251 SDL_LockYUVOverlay(sys->overlay);
254 sys->is_uv_swapped = vlc_fourcc_AreUVPlanesSwapped(fmt.i_chroma,
256 if (sys->is_uv_swapped)
257 fmt.i_chroma = vd->fmt.i_chroma;
263 msg_Warn(vd, "SDL overlay disabled by the user");
267 vout_display_cfg_t place_cfg = *vd->cfg;
268 place_cfg.display.width = display_width;
269 place_cfg.display.height = display_height;
270 vout_display_PlacePicture(&sys->place, &vd->source, &place_cfg, !sys->overlay);
272 /* If no overlay, fallback to software output */
275 switch (sys->display->format->BitsPerPixel) {
277 fmt.i_chroma = VLC_CODEC_RGB8;
280 fmt.i_chroma = VLC_CODEC_RGB15;
283 fmt.i_chroma = VLC_CODEC_RGB16;
286 fmt.i_chroma = VLC_CODEC_RGB24;
289 fmt.i_chroma = VLC_CODEC_RGB32;
292 msg_Err(vd, "unknown screen depth %i",
293 sys->display->format->BitsPerPixel);
297 /* All we have is an RGB image with square pixels */
298 fmt.i_width = display_width;
299 fmt.i_height = display_height;
300 fmt.i_rmask = sys->display->format->Rmask;
301 fmt.i_gmask = sys->display->format->Gmask;
302 fmt.i_bmask = sys->display->format->Bmask;
304 info.has_pictures_invalid = true;
307 if (vd->cfg->display.title)
308 SDL_WM_SetCaption(vd->cfg->display.title,
309 vd->cfg->display.title);
310 else if (!sys->overlay)
311 SDL_WM_SetCaption(VOUT_TITLE " (software RGB SDL output)",
312 VOUT_TITLE " (software RGB SDL output)");
313 else if (sys->overlay->hw_overlay)
314 SDL_WM_SetCaption(VOUT_TITLE " (hardware YUV SDL output)",
315 VOUT_TITLE " (hardware YUV SDL output)");
317 SDL_WM_SetCaption(VOUT_TITLE " (software YUV SDL output)",
318 VOUT_TITLE " (software YUV SDL output)");
321 SDL_EventState(SDL_KEYUP, SDL_IGNORE); /* ignore keys up */
323 /* Setup vout_display now that everything is fine */
329 vd->display = Display;
330 vd->control = Control;
334 vout_display_SendEventDisplaySize(vd, display_width, display_height, vd->cfg->is_fullscreen);
338 msg_Err(vd, "cannot set up SDL (%s)", SDL_GetError());
341 SDL_UnlockSurface(sys->display);
342 SDL_FreeSurface(sys->display);
345 vlc_mutex_lock(&sdl_lock);
346 SDL_QuitSubSystem(SDL_INIT_VIDEO);
347 vlc_mutex_unlock(&sdl_lock);
354 * Close a SDL video output
356 static void Close(vlc_object_t *object)
358 vout_display_t *vd = (vout_display_t *)object;
359 vout_display_sys_t *sys = vd->sys;
362 picture_pool_Delete(sys->pool);
365 SDL_LockYUVOverlay(sys->overlay);
366 SDL_FreeYUVOverlay(sys->overlay);
368 SDL_UnlockSurface (sys->display);
369 SDL_FreeSurface(sys->display);
371 vlc_mutex_lock(&sdl_lock);
372 SDL_QuitSubSystem(SDL_INIT_VIDEO);
373 vlc_mutex_unlock(&sdl_lock);
379 * Return a pool of direct buffers
381 static picture_pool_t *Pool(vout_display_t *vd, unsigned count)
383 vout_display_sys_t *sys = vd->sys;
387 picture_resource_t rsc;
389 memset(&rsc, 0, sizeof(rsc));
392 SDL_Overlay *ol = sys->overlay;
394 for (int i = 0; i < ol->planes; i++) {
395 rsc.p[i].p_pixels = ol->pixels[ i > 0 && sys->is_uv_swapped ? (3-i) : i];
396 rsc.p[i].i_pitch = ol->pitches[i > 0 && sys->is_uv_swapped ? (3-i) : i];
397 rsc.p[i].i_lines = ol->h;
398 if (ol->format == SDL_YV12_OVERLAY ||
399 ol->format == SDL_IYUV_OVERLAY)
400 rsc.p[i].i_lines /= 2;
404 const int x = sys->place.x;
405 const int y = sys->place.y;
407 SDL_Surface *sf = sys->display;
408 SDL_FillRect(sf, NULL, 0);
410 assert(x >= 0 && y >= 0);
411 rsc.p[0].p_pixels = (uint8_t*)sf->pixels + y * sf->pitch + x * ((sf->format->BitsPerPixel + 7) / 8);
412 rsc.p[0].i_pitch = sf->pitch;
413 rsc.p[0].i_lines = vd->fmt.i_height;
416 picture_t *picture = picture_NewFromResource(&vd->fmt, &rsc);;
420 sys->pool = picture_pool_New(1, &picture);
429 static void Display(vout_display_t *vd, picture_t *p_pic)
431 vout_display_sys_t *sys = vd->sys;
435 disp.x = sys->place.x;
436 disp.y = sys->place.y;
437 disp.w = sys->place.width;
438 disp.h = sys->place.height;
440 SDL_UnlockYUVOverlay(sys->overlay);
441 SDL_DisplayYUVOverlay(sys->overlay , &disp);
442 SDL_LockYUVOverlay(sys->overlay);
444 SDL_Flip(sys->display);
447 picture_Release(p_pic);
452 * Control for vout display
454 static int Control(vout_display_t *vd, int query, va_list args)
456 vout_display_sys_t *sys = vd->sys;
460 case VOUT_DISPLAY_HIDE_MOUSE:
464 case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE: {
465 const vout_display_cfg_t *cfg = va_arg(args, const vout_display_cfg_t *);
468 sys->display = SDL_SetVideoMode(cfg->display.width,
470 sys->display_bpp, sys->display_flags);
472 sys->display = SDL_SetVideoMode(vd->cfg->display.width,
473 vd->cfg->display.height,
474 sys->display_bpp, sys->display_flags);
478 vout_display_PlacePicture(&sys->place, &vd->source, cfg, !sys->overlay);
480 vout_display_SendEventPicturesInvalid(vd);
483 case VOUT_DISPLAY_CHANGE_FULLSCREEN: {
484 vout_display_cfg_t cfg = *va_arg(args, const vout_display_cfg_t *);
487 sys->display_flags &= ~(SDL_FULLSCREEN | SDL_RESIZABLE);
488 sys->display_flags |= cfg.is_fullscreen ? SDL_FULLSCREEN : SDL_RESIZABLE;
490 if (cfg.is_fullscreen) {
491 cfg.display.width = sys->desktop_width;
492 cfg.display.height = sys->desktop_height;
496 sys->display = SDL_SetVideoMode(cfg.display.width, cfg.display.height,
497 sys->display_bpp, sys->display_flags);
499 vout_display_PlacePicture(&sys->place, &vd->source, &cfg, !sys->overlay);
501 vout_display_SendEventDisplaySize(vd, cfg.display.width, cfg.display.height, cfg.is_fullscreen);
504 case VOUT_DISPLAY_CHANGE_ZOOM:
505 case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
506 case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT: {
507 const vout_display_cfg_t *cfg;
508 const video_format_t *source;
510 if (query == VOUT_DISPLAY_CHANGE_SOURCE_ASPECT) {
511 source = va_arg(args, const video_format_t *);
514 source = &vd->source;
515 cfg = va_arg(args, const vout_display_cfg_t *);
518 sys->display = SDL_SetVideoMode(cfg->display.width, cfg->display.height,
519 sys->display_bpp, sys->display_flags);
521 vout_display_PlacePicture(&sys->place, source, cfg, !sys->overlay);
523 vout_display_SendEventPicturesInvalid(vd);
528 case VOUT_DISPLAY_RESET_PICTURES: {
530 assert(!sys->overlay);
534 picture_pool_Delete(sys->pool);
537 vout_display_PlacePicture(&sys->place, &vd->source, vd->cfg, !sys->overlay);
540 vd->fmt.i_width = sys->place.width;
541 vd->fmt.i_height = sys->place.height;
545 case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
546 case VOUT_DISPLAY_CHANGE_WINDOW_STATE:
547 /* I don't think it is possible to support with SDL:
554 msg_Err(vd, "Unsupported query in vout display SDL");
560 * Proccess pending event
562 static void Manage(vout_display_t *vd)
564 vout_display_sys_t *sys = vd->sys;
568 while (SDL_PollEvent(&event)) {
569 switch (event.type) {
571 vout_display_SendEventClose(vd);
575 /* convert the key if possible */
576 int key = ConvertKey(event.key.keysym.sym);
579 /* Find the right caracter */
580 if ((event.key.keysym.unicode & 0xff80) == 0) {
581 key = event.key.keysym.unicode & 0x7f;
582 /* FIXME: find a better solution than this
583 hack to find the right caracter */
584 if (key >= 1 && key <= 26)
586 else if (key >= 65 && key <= 90)
593 if (event.key.keysym.mod & KMOD_SHIFT)
594 key |= KEY_MODIFIER_SHIFT;
595 if (event.key.keysym.mod & KMOD_CTRL)
596 key |= KEY_MODIFIER_CTRL;
597 if (event.key.keysym.mod & KMOD_ALT)
598 key |= KEY_MODIFIER_ALT;
599 vout_display_SendEventKey(vd, key);
603 case SDL_MOUSEBUTTONDOWN:
604 case SDL_MOUSEBUTTONUP: {
605 static const struct { int sdl; int vlc; } buttons[] = {
606 { SDL_BUTTON_LEFT, MOUSE_BUTTON_LEFT },
607 { SDL_BUTTON_MIDDLE, MOUSE_BUTTON_CENTER },
608 { SDL_BUTTON_RIGHT, MOUSE_BUTTON_RIGHT },
609 { SDL_BUTTON_WHEELUP, MOUSE_BUTTON_WHEEL_UP },
610 { SDL_BUTTON_WHEELDOWN, MOUSE_BUTTON_WHEEL_DOWN },
615 for (int i = 0; buttons[i].sdl != -1; i++) {
616 if (buttons[i].sdl == event.button.button) {
617 if (event.type == SDL_MOUSEBUTTONDOWN)
618 vout_display_SendEventMousePressed(vd, buttons[i].vlc);
620 vout_display_SendEventMouseReleased(vd, buttons[i].vlc);
626 case SDL_MOUSEMOTION: {
627 if (sys->place.width <= 0 || sys->place.height <= 0)
630 const int x = (int64_t)(event.motion.x - sys->place.x) * vd->source.i_width / sys->place.width;
631 const int y = (int64_t)(event.motion.y - sys->place.y) * vd->source.i_height / sys->place.height;
634 vout_display_SendEventMouseMoved(vd, x, y);
638 case SDL_VIDEORESIZE:
639 vout_display_SendEventDisplaySize(vd, event.resize.w, event.resize.h, vd->cfg->is_fullscreen);
649 static const struct {
653 } sdlkeys_to_vlckeys[] = {
663 { SDLK_F10, KEY_F10 },
664 { SDLK_F11, KEY_F11 },
665 { SDLK_F12, KEY_F12 },
667 { SDLK_RETURN, KEY_ENTER },
668 { SDLK_KP_ENTER, KEY_ENTER },
670 { SDLK_ESCAPE, KEY_ESC },
672 { SDLK_MENU, KEY_MENU },
673 { SDLK_LEFT, KEY_LEFT },
674 { SDLK_RIGHT, KEY_RIGHT },
676 { SDLK_DOWN, KEY_DOWN },
678 { SDLK_HOME, KEY_HOME },
679 { SDLK_END, KEY_END },
680 { SDLK_PAGEUP, KEY_PAGEUP },
681 { SDLK_PAGEDOWN, KEY_PAGEDOWN },
683 { SDLK_INSERT, KEY_INSERT },
684 { SDLK_DELETE, KEY_DELETE },
685 /*TODO: find a equivalent for SDL
686 { , KEY_MEDIA_NEXT_TRACK }
687 { , KEY_MEDIA_PREV_TRACK }
688 { , KEY_VOLUME_MUTE }
689 { , KEY_VOLUME_DOWN }
691 { , KEY_MEDIA_PLAY_PAUSE }
692 { , KEY_MEDIA_PLAY_PAUSE }*/
697 static int ConvertKey(SDLKey sdl_key)
699 for (int i = 0; sdlkeys_to_vlckeys[i].sdl_key != 0; i++) {
700 if (sdlkeys_to_vlckeys[i].sdl_key == sdl_key)
701 return sdlkeys_to_vlckeys[i].vlckey;