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");
184 sys->display = SDL_SetVideoMode(display_width, display_height,
185 sys->display_bpp, sys->display_flags);
187 msg_Err(vd, "cannot set video mode");
191 /* We keep the surface locked forever */
192 SDL_LockSurface(sys->display);
195 vlc_fourcc_t forced_chroma = 0;
196 char *psz_chroma = var_CreateGetNonEmptyString(vd, "sdl-chroma");
198 forced_chroma = vlc_fourcc_GetCodecFromString(VIDEO_ES, psz_chroma);
200 msg_Dbg(vd, "Forcing chroma to 0x%.8x (%4.4s)",
201 forced_chroma, (const char*)&forced_chroma);
205 /* Try to open an overlay if requested */
207 const bool is_overlay = var_CreateGetBool(vd, "overlay");
214 { VLC_CODEC_YV12, SDL_YV12_OVERLAY },
215 { VLC_CODEC_I420, SDL_IYUV_OVERLAY },
216 { VLC_CODEC_YUYV, SDL_YUY2_OVERLAY },
217 { VLC_CODEC_UYVY, SDL_UYVY_OVERLAY },
218 { VLC_CODEC_YVYU, SDL_YVYU_OVERLAY },
222 const vlc_fourcc_t forced_chromas[] = {
225 const vlc_fourcc_t *fallback_chromas =
226 vlc_fourcc_GetYUVFallback(fmt.i_chroma);
227 const vlc_fourcc_t *chromas = forced_chroma ? forced_chromas : fallback_chromas;
229 for (int pass = forced_chroma ? 1 : 0; pass < 2 && !sys->overlay; pass++) {
230 for (int i = 0; chromas[i] != 0; i++) {
231 const vlc_fourcc_t vlc = chromas[i];
234 for (int j = 0; vlc_to_sdl[j].vlc != 0 && !sdl; j++) {
235 if (vlc_to_sdl[j].vlc == vlc)
236 sdl = vlc_to_sdl[j].sdl;
241 sys->overlay = SDL_CreateYUVOverlay(fmt.i_width, fmt.i_height,
243 if (sys->overlay && !sys->overlay->hw_overlay && pass == 0) {
244 /* Ignore non hardware overlay surface in first pass */
245 SDL_FreeYUVOverlay(sys->overlay);
249 /* We keep the surface locked forever */
250 SDL_LockYUVOverlay(sys->overlay);
253 sys->is_uv_swapped = vlc_fourcc_AreUVPlanesSwapped(fmt.i_chroma,
255 if (sys->is_uv_swapped)
256 fmt.i_chroma = vd->fmt.i_chroma;
262 msg_Warn(vd, "SDL overlay disabled by the user");
266 vout_display_cfg_t place_cfg = *vd->cfg;
267 place_cfg.display.width = display_width;
268 place_cfg.display.height = display_height;
269 vout_display_PlacePicture(&sys->place, &vd->source, &place_cfg, !sys->overlay);
271 /* If no overlay, fallback to software output */
274 switch (sys->display->format->BitsPerPixel) {
276 fmt.i_chroma = VLC_CODEC_RGB8;
279 fmt.i_chroma = VLC_CODEC_RGB15;
282 fmt.i_chroma = VLC_CODEC_RGB16;
285 fmt.i_chroma = VLC_CODEC_RGB24;
288 fmt.i_chroma = VLC_CODEC_RGB32;
291 msg_Err(vd, "unknown screen depth %i",
292 sys->display->format->BitsPerPixel);
296 /* All we have is an RGB image with square pixels */
297 fmt.i_width = display_width;
298 fmt.i_height = display_height;
299 fmt.i_rmask = sys->display->format->Rmask;
300 fmt.i_gmask = sys->display->format->Gmask;
301 fmt.i_bmask = sys->display->format->Bmask;
303 info.has_pictures_invalid = true;
306 if (vd->cfg->display.title)
307 SDL_WM_SetCaption(vd->cfg->display.title,
308 vd->cfg->display.title);
309 else if (!sys->overlay)
310 SDL_WM_SetCaption(VOUT_TITLE " (software RGB SDL output)",
311 VOUT_TITLE " (software RGB SDL output)");
312 else if (sys->overlay->hw_overlay)
313 SDL_WM_SetCaption(VOUT_TITLE " (hardware YUV SDL output)",
314 VOUT_TITLE " (hardware YUV SDL output)");
316 SDL_WM_SetCaption(VOUT_TITLE " (software YUV SDL output)",
317 VOUT_TITLE " (software YUV SDL output)");
320 SDL_EventState(SDL_KEYUP, SDL_IGNORE); /* ignore keys up */
322 /* Setup vout_display now that everything is fine */
328 vd->display = Display;
329 vd->control = Control;
333 vout_display_SendEventDisplaySize(vd, display_width, display_height, vd->cfg->is_fullscreen);
337 msg_Err(vd, "cannot set up SDL (%s)", SDL_GetError());
340 SDL_UnlockSurface(sys->display);
341 SDL_FreeSurface(sys->display);
344 vlc_mutex_lock(&sdl_lock);
345 SDL_QuitSubSystem(SDL_INIT_VIDEO);
346 vlc_mutex_unlock(&sdl_lock);
353 * Close a SDL video output
355 static void Close(vlc_object_t *object)
357 vout_display_t *vd = (vout_display_t *)object;
358 vout_display_sys_t *sys = vd->sys;
361 picture_pool_Delete(sys->pool);
364 SDL_LockYUVOverlay(sys->overlay);
365 SDL_FreeYUVOverlay(sys->overlay);
367 SDL_UnlockSurface (sys->display);
368 SDL_FreeSurface(sys->display);
370 vlc_mutex_lock(&sdl_lock);
371 SDL_QuitSubSystem(SDL_INIT_VIDEO);
372 vlc_mutex_unlock(&sdl_lock);
378 * Return a pool of direct buffers
380 static picture_pool_t *Pool(vout_display_t *vd, unsigned count)
382 vout_display_sys_t *sys = vd->sys;
386 picture_resource_t rsc;
388 memset(&rsc, 0, sizeof(rsc));
391 SDL_Overlay *ol = sys->overlay;
393 for (int i = 0; i < ol->planes; i++) {
394 rsc.p[i].p_pixels = ol->pixels[ i > 0 && sys->is_uv_swapped ? (3-i) : i];
395 rsc.p[i].i_pitch = ol->pitches[i > 0 && sys->is_uv_swapped ? (3-i) : i];
396 rsc.p[i].i_lines = ol->h;
397 if (ol->format == SDL_YV12_OVERLAY ||
398 ol->format == SDL_IYUV_OVERLAY)
399 rsc.p[i].i_lines /= 2;
403 const int x = sys->place.x;
404 const int y = sys->place.y;
406 SDL_Surface *sf = sys->display;
407 SDL_FillRect(sf, NULL, 0);
409 assert(x >= 0 && y >= 0);
410 rsc.p[0].p_pixels = (uint8_t*)sf->pixels + y * sf->pitch + x * ((sf->format->BitsPerPixel + 7) / 8);
411 rsc.p[0].i_pitch = sf->pitch;
412 rsc.p[0].i_lines = vd->fmt.i_height;
415 picture_t *picture = picture_NewFromResource(&vd->fmt, &rsc);;
419 sys->pool = picture_pool_New(1, &picture);
428 static void Display(vout_display_t *vd, picture_t *p_pic)
430 vout_display_sys_t *sys = vd->sys;
434 disp.x = sys->place.x;
435 disp.y = sys->place.y;
436 disp.w = sys->place.width;
437 disp.h = sys->place.height;
439 SDL_UnlockYUVOverlay(sys->overlay);
440 SDL_DisplayYUVOverlay(sys->overlay , &disp);
441 SDL_LockYUVOverlay(sys->overlay);
443 SDL_Flip(sys->display);
446 picture_Release(p_pic);
451 * Control for vout display
453 static int Control(vout_display_t *vd, int query, va_list args)
455 vout_display_sys_t *sys = vd->sys;
459 case VOUT_DISPLAY_HIDE_MOUSE:
463 case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE: {
464 const vout_display_cfg_t *cfg = va_arg(args, const vout_display_cfg_t *);
467 sys->display = SDL_SetVideoMode(cfg->display.width,
469 sys->display_bpp, sys->display_flags);
471 sys->display = SDL_SetVideoMode(vd->cfg->display.width,
472 vd->cfg->display.height,
473 sys->display_bpp, sys->display_flags);
477 vout_display_PlacePicture(&sys->place, &vd->source, cfg, !sys->overlay);
479 vout_display_SendEventPicturesInvalid(vd);
482 case VOUT_DISPLAY_CHANGE_FULLSCREEN: {
483 vout_display_cfg_t cfg = *va_arg(args, const vout_display_cfg_t *);
486 sys->display_flags &= ~(SDL_FULLSCREEN | SDL_RESIZABLE);
487 sys->display_flags |= cfg.is_fullscreen ? SDL_FULLSCREEN : SDL_RESIZABLE;
489 if (cfg.is_fullscreen) {
490 cfg.display.width = sys->desktop_width;
491 cfg.display.height = sys->desktop_height;
495 sys->display = SDL_SetVideoMode(cfg.display.width, cfg.display.height,
496 sys->display_bpp, sys->display_flags);
498 vout_display_PlacePicture(&sys->place, &vd->source, &cfg, !sys->overlay);
500 vout_display_SendEventDisplaySize(vd, cfg.display.width, cfg.display.height, cfg.is_fullscreen);
503 case VOUT_DISPLAY_CHANGE_ZOOM:
504 case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
505 case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT: {
506 const vout_display_cfg_t *cfg;
507 const video_format_t *source;
509 if (query == VOUT_DISPLAY_CHANGE_SOURCE_ASPECT) {
510 source = va_arg(args, const video_format_t *);
513 source = &vd->source;
514 cfg = va_arg(args, const vout_display_cfg_t *);
517 sys->display = SDL_SetVideoMode(cfg->display.width, cfg->display.height,
518 sys->display_bpp, sys->display_flags);
520 vout_display_PlacePicture(&sys->place, source, cfg, !sys->overlay);
522 vout_display_SendEventPicturesInvalid(vd);
527 case VOUT_DISPLAY_RESET_PICTURES: {
529 assert(!sys->overlay);
533 picture_pool_Delete(sys->pool);
536 vout_display_PlacePicture(&sys->place, &vd->source, vd->cfg, !sys->overlay);
539 vd->fmt.i_width = sys->place.width;
540 vd->fmt.i_height = sys->place.height;
544 case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
545 case VOUT_DISPLAY_CHANGE_WINDOW_STATE:
546 /* I don't think it is possible to support with SDL:
553 msg_Err(vd, "Unsupported query in vout display SDL");
559 * Proccess pending event
561 static void Manage(vout_display_t *vd)
563 vout_display_sys_t *sys = vd->sys;
567 while (SDL_PollEvent(&event)) {
568 switch (event.type) {
570 vout_display_SendEventClose(vd);
574 /* convert the key if possible */
575 int key = ConvertKey(event.key.keysym.sym);
578 /* Find the right caracter */
579 if ((event.key.keysym.unicode & 0xff80) == 0) {
580 key = event.key.keysym.unicode & 0x7f;
581 /* FIXME: find a better solution than this
582 hack to find the right caracter */
583 if (key >= 1 && key <= 26)
585 else if (key >= 65 && key <= 90)
592 if (event.key.keysym.mod & KMOD_SHIFT)
593 key |= KEY_MODIFIER_SHIFT;
594 if (event.key.keysym.mod & KMOD_CTRL)
595 key |= KEY_MODIFIER_CTRL;
596 if (event.key.keysym.mod & KMOD_ALT)
597 key |= KEY_MODIFIER_ALT;
598 vout_display_SendEventKey(vd, key);
602 case SDL_MOUSEBUTTONDOWN:
603 case SDL_MOUSEBUTTONUP: {
604 static const struct { int sdl; int vlc; } buttons[] = {
605 { SDL_BUTTON_LEFT, MOUSE_BUTTON_LEFT },
606 { SDL_BUTTON_MIDDLE, MOUSE_BUTTON_CENTER },
607 { SDL_BUTTON_RIGHT, MOUSE_BUTTON_RIGHT },
608 { SDL_BUTTON_WHEELUP, MOUSE_BUTTON_WHEEL_UP },
609 { SDL_BUTTON_WHEELDOWN, MOUSE_BUTTON_WHEEL_DOWN },
614 for (int i = 0; buttons[i].sdl != -1; i++) {
615 if (buttons[i].sdl == event.button.button) {
616 if (event.type == SDL_MOUSEBUTTONDOWN)
617 vout_display_SendEventMousePressed(vd, buttons[i].vlc);
619 vout_display_SendEventMouseReleased(vd, buttons[i].vlc);
625 case SDL_MOUSEMOTION: {
626 if (sys->place.width <= 0 || sys->place.height <= 0)
629 const int x = (int64_t)(event.motion.x - sys->place.x) * vd->source.i_width / sys->place.width;
630 const int y = (int64_t)(event.motion.y - sys->place.y) * vd->source.i_height / sys->place.height;
633 vout_display_SendEventMouseMoved(vd, x, y);
637 case SDL_VIDEORESIZE:
638 vout_display_SendEventDisplaySize(vd, event.resize.w, event.resize.h, vd->cfg->is_fullscreen);
648 static const struct {
652 } sdlkeys_to_vlckeys[] = {
662 { SDLK_F10, KEY_F10 },
663 { SDLK_F11, KEY_F11 },
664 { SDLK_F12, KEY_F12 },
666 { SDLK_RETURN, KEY_ENTER },
667 { SDLK_KP_ENTER, KEY_ENTER },
669 { SDLK_ESCAPE, KEY_ESC },
671 { SDLK_MENU, KEY_MENU },
672 { SDLK_LEFT, KEY_LEFT },
673 { SDLK_RIGHT, KEY_RIGHT },
675 { SDLK_DOWN, KEY_DOWN },
677 { SDLK_HOME, KEY_HOME },
678 { SDLK_END, KEY_END },
679 { SDLK_PAGEUP, KEY_PAGEUP },
680 { SDLK_PAGEDOWN, KEY_PAGEDOWN },
682 { SDLK_INSERT, KEY_INSERT },
683 { SDLK_DELETE, KEY_DELETE },
684 /*TODO: find a equivalent for SDL
685 { , KEY_MEDIA_NEXT_TRACK }
686 { , KEY_MEDIA_PREV_TRACK }
687 { , KEY_VOLUME_MUTE }
688 { , KEY_VOLUME_DOWN }
690 { , KEY_MEDIA_PLAY_PAUSE }
691 { , KEY_MEDIA_PLAY_PAUSE }*/
696 static int ConvertKey(SDLKey sdl_key)
698 for (int i = 0; sdlkeys_to_vlckeys[i].sdl_key != 0; i++) {
699 if (sdlkeys_to_vlckeys[i].sdl_key == sdl_key)
700 return sdlkeys_to_vlckeys[i].vlckey;