1 /*****************************************************************************
2 * vout_sdl.c: SDL video output display method
3 *****************************************************************************
4 * Copyright (C) 1998, 1999, 2000 VideoLAN
6 * Authors: Samuel Hocevar <sam@zoy.org>
7 * Pierre Baillet <oct@zoy.org>
8 * Arnaud de Bossoreille de Ribou <bozo@via.ecp.fr>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
23 *****************************************************************************/
25 #define MODULE_NAME sdl
26 #include "modules_inner.h"
28 /*****************************************************************************
30 *****************************************************************************/
33 #include <errno.h> /* ENOMEM */
34 #include <stdlib.h> /* free() */
35 #include <string.h> /* strerror() */
47 #include "video_output.h"
50 #include "interface.h"
51 /* FIXME: get rid of this */
52 #include "keystrokes.h"
55 /*****************************************************************************
56 * FIXME: this file is ... *
58 * XXX XXX FIXME XXX XXX XXX XXX *
59 * XXX XXX XXX XXX XXX XXX XXX XXX *
60 * XXX XXX XXX XXX FIXME XXX *
61 * XXX XXX XXX TODO XXX XXX XXX *
62 * XXX XXX XXX XXX XXX XXX *
63 * FIXME FIXME FIXME XXX XXX *
65 *****************************************************************************/
67 /*****************************************************************************
68 * vout_sys_t: video output SDL method descriptor
69 *****************************************************************************
70 * This structure is part of the video output thread descriptor.
71 * It describes the SDL specific properties of an output thread.
72 *****************************************************************************/
73 typedef struct vout_sys_s
77 SDL_Surface * p_display; /* display device */
78 SDL_Overlay * p_overlay; /* overlay device */
79 boolean_t b_fullscreen;
82 boolean_t b_reopen_display;
83 Uint8 * p_sdl_buf[2]; /* Buffer information */
86 /*****************************************************************************
88 *****************************************************************************/
89 static int vout_Probe ( probedata_t *p_data );
90 static int vout_Create ( struct vout_thread_s * );
91 static int vout_Init ( struct vout_thread_s * );
92 static void vout_End ( struct vout_thread_s * );
93 static void vout_Destroy ( struct vout_thread_s * );
94 static int vout_Manage ( struct vout_thread_s * );
95 static void vout_Display ( struct vout_thread_s * );
96 static void vout_SetPalette( p_vout_thread_t p_vout, u16 *red, u16 *green,
97 u16 *blue, u16 *transp );
99 static int SDLOpenDisplay ( vout_thread_t *p_vout );
100 static void SDLCloseDisplay ( vout_thread_t *p_vout );
102 /*****************************************************************************
103 * Functions exported as capabilities. They are declared as static so that
104 * we don't pollute the namespace too much.
105 *****************************************************************************/
106 void _M( vout_getfunctions )( function_list_t * p_function_list )
108 p_function_list->pf_probe = vout_Probe;
109 p_function_list->functions.vout.pf_create = vout_Create;
110 p_function_list->functions.vout.pf_init = vout_Init;
111 p_function_list->functions.vout.pf_end = vout_End;
112 p_function_list->functions.vout.pf_destroy = vout_Destroy;
113 p_function_list->functions.vout.pf_manage = vout_Manage;
114 p_function_list->functions.vout.pf_display = vout_Display;
115 p_function_list->functions.vout.pf_setpalette = vout_SetPalette;
118 /*****************************************************************************
119 * vout_Probe: probe the video driver and return a score
120 *****************************************************************************
121 * This function tries to initialize SDL and returns a score to the
122 * plugin manager so that it can select the best plugin.
123 *****************************************************************************/
124 static int vout_Probe( probedata_t *p_data )
126 if( TestMethod( VOUT_METHOD_VAR, "sdl" ) )
134 /*****************************************************************************
135 * vout_Create: allocate SDL video thread output method
136 *****************************************************************************
137 * This function allocate and initialize a SDL vout method. It uses some of the
138 * vout properties to choose the correct mode, and change them according to the
139 * mode actually used.
140 *****************************************************************************/
141 static int vout_Create( vout_thread_t *p_vout )
143 /* Allocate structure */
144 p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
145 if( p_vout->p_sys == NULL )
147 intf_ErrMsg( "vout error: can't create p_sys (%s)", strerror(ENOMEM) );
151 /* Initialize library */
152 if( SDL_Init(SDL_INIT_VIDEO | SDL_INIT_EVENTTHREAD | SDL_INIT_NOPARACHUTE)
155 intf_ErrMsg( "vout error: can't initialize SDL (%s)", SDL_GetError() );
156 free( p_vout->p_sys );
160 p_vout->p_sys->b_cursor = 1; /* TODO should be done with a main_GetInt.. */
161 p_vout->p_sys->b_fullscreen = main_GetIntVariable( VOUT_FULLSCREEN_VAR,
162 VOUT_FULLSCREEN_DEFAULT );
163 p_vout->p_sys->b_overlay = main_GetIntVariable( VOUT_OVERLAY_VAR,
164 VOUT_OVERLAY_DEFAULT );
165 p_vout->p_sys->i_width = main_GetIntVariable( VOUT_WIDTH_VAR,
166 VOUT_WIDTH_DEFAULT );
167 p_vout->p_sys->i_height = main_GetIntVariable( VOUT_HEIGHT_VAR,
168 VOUT_HEIGHT_DEFAULT );
170 p_vout->p_sys->p_display = NULL;
171 p_vout->p_sys->p_overlay = NULL;
173 if( SDLOpenDisplay(p_vout) )
175 intf_ErrMsg( "vout error: can't set up SDL (%s)", SDL_GetError() );
176 free( p_vout->p_sys );
180 /* FIXME: get rid of this ASAP, it's FUCKING UGLY */
181 { intf_thread_t * p_intf = p_main->p_intf;
182 intf_AssignKey(p_intf, SDLK_q, INTF_KEY_QUIT, 0);
183 intf_AssignKey(p_intf, SDLK_ESCAPE, INTF_KEY_QUIT, 0);
184 /* intf_AssignKey(p_intf,3,'Q'); */
185 intf_AssignKey(p_intf, SDLK_0, INTF_KEY_SET_CHANNEL,0);
186 intf_AssignKey(p_intf, SDLK_1, INTF_KEY_SET_CHANNEL,1);
187 intf_AssignKey(p_intf, SDLK_2, INTF_KEY_SET_CHANNEL,2);
188 intf_AssignKey(p_intf, SDLK_3, INTF_KEY_SET_CHANNEL,3);
189 intf_AssignKey(p_intf, SDLK_4, INTF_KEY_SET_CHANNEL,4);
190 intf_AssignKey(p_intf, SDLK_5, INTF_KEY_SET_CHANNEL,5);
191 intf_AssignKey(p_intf, SDLK_6, INTF_KEY_SET_CHANNEL,6);
192 intf_AssignKey(p_intf, SDLK_7, INTF_KEY_SET_CHANNEL,7);
193 intf_AssignKey(p_intf, SDLK_8, INTF_KEY_SET_CHANNEL,8);
194 intf_AssignKey(p_intf, SDLK_9, INTF_KEY_SET_CHANNEL,9);
195 intf_AssignKey(p_intf, SDLK_PLUS, INTF_KEY_INC_VOLUME, 0);
196 intf_AssignKey(p_intf, SDLK_MINUS, INTF_KEY_DEC_VOLUME, 0);
197 intf_AssignKey(p_intf, SDLK_m, INTF_KEY_TOGGLE_VOLUME, 0);
198 /* intf_AssignKey(p_intf,'M','M'); */
199 intf_AssignKey(p_intf, SDLK_g, INTF_KEY_DEC_GAMMA, 0);
200 /* intf_AssignKey(p_intf,'G','G'); */
201 intf_AssignKey(p_intf, SDLK_c, INTF_KEY_TOGGLE_GRAYSCALE, 0);
202 intf_AssignKey(p_intf, SDLK_SPACE, INTF_KEY_TOGGLE_INTERFACE, 0);
203 intf_AssignKey(p_intf, SDLK_i, INTF_KEY_TOGGLE_INFO, 0);
204 intf_AssignKey(p_intf, SDLK_s, INTF_KEY_TOGGLE_SCALING, 0); }
209 /*****************************************************************************
210 * vout_Init: initialize SDL video thread output method
211 *****************************************************************************
212 * This function initialize the SDL display device.
213 *****************************************************************************/
214 static int vout_Init( vout_thread_t *p_vout )
216 /* This hack is hugly, but hey, you are, too. */
218 SDL_Overlay * p_overlay;
220 p_overlay = SDL_CreateYUVOverlay( VOUT_WIDTH_DEFAULT, VOUT_HEIGHT_DEFAULT,
222 p_vout->p_sys->p_display );
223 intf_Msg( "vout: YUV acceleration %s",
224 p_overlay->hw_overlay ? "activated" : "unavailable !" );
225 p_vout->b_need_render = !p_overlay->hw_overlay;
227 SDL_FreeYUVOverlay( p_overlay );
232 /*****************************************************************************
233 * vout_End: terminate Sys video thread output method
234 *****************************************************************************
235 * Terminate an output method created by vout_SDLCreate
236 *****************************************************************************/
237 static void vout_End( vout_thread_t *p_vout )
239 SDLCloseDisplay( p_vout );
243 /*****************************************************************************
244 * vout_Destroy: destroy Sys video thread output method
245 *****************************************************************************
246 * Terminate an output method created by vout_SDLCreate
247 *****************************************************************************/
248 static void vout_Destroy( vout_thread_t *p_vout )
250 free( p_vout->p_sys );
253 /*****************************************************************************
254 * vout_Manage: handle Sys events
255 *****************************************************************************
256 * This function should be called regularly by video output thread. It returns
257 * a non null value if an error occured.
258 *****************************************************************************/
259 static int vout_Manage( vout_thread_t *p_vout )
261 SDL_Event event; /* SDL event */
265 while( SDL_PollEvent(&event) )
269 case SDL_VIDEORESIZE: /* Resizing of window */
270 p_vout->i_width = event.resize.w;
271 p_vout->i_height = event.resize.h;
272 p_vout->i_changes |= VOUT_SIZE_CHANGE;
275 case SDL_MOUSEBUTTONUP:
276 switch( event.button.button )
278 case SDL_BUTTON_RIGHT:
279 p_main->p_intf->b_menu_change = 1;
284 case SDL_MOUSEBUTTONDOWN:
285 switch( event.button.button )
287 case SDL_BUTTON_MIDDLE:
288 p_vout->i_changes |= VOUT_CURSOR_CHANGE;
294 intf_ProcessKey( p_main->p_intf, SDLK_q );
297 case SDL_KEYDOWN: /* if a key is pressed */
298 i_key = event.key.keysym.sym;
302 case SDLK_f: /* switch to fullscreen */
303 p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
306 case SDLK_y: /* switch to hard YUV */
307 p_vout->i_changes |= VOUT_YUV_CHANGE;
310 case SDLK_c: /* toggle grayscale */
311 p_vout->b_grayscale = ! p_vout->b_grayscale;
312 p_vout->i_changes |= VOUT_GRAYSCALE_CHANGE;
315 case SDLK_i: /* toggle info */
316 p_vout->b_info = ! p_vout->b_info;
317 p_vout->i_changes |= VOUT_INFO_CHANGE;
320 case SDLK_s: /* toggle scaling */
321 p_vout->b_scale = ! p_vout->b_scale;
322 p_vout->i_changes |= VOUT_SCALE_CHANGE;
325 case SDLK_SPACE: /* toggle interface */
326 p_vout->b_interface = ! p_vout->b_interface;
327 p_vout->i_changes |= VOUT_INTF_CHANGE;
331 if( intf_ProcessKey( p_main->p_intf, (char )i_key ) )
333 intf_DbgMsg( "unhandled key '%c' (%i)", (char)i_key, i_key ); }
346 if( p_vout->i_changes & VOUT_SIZE_CHANGE )
348 p_vout->p_sys->i_width = p_vout->i_width;
349 p_vout->p_sys->i_height = p_vout->i_height;
351 /* Need to reopen display */
352 SDLCloseDisplay( p_vout );
353 if( SDLOpenDisplay( p_vout ) )
355 intf_ErrMsg( "vout error: can't reopen display after resize" );
358 p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
364 if( p_vout->i_changes & VOUT_YUV_CHANGE )
366 p_vout->b_need_render = ! p_vout->b_need_render;
368 /* Need to reopen display */
369 SDLCloseDisplay( p_vout );
370 if( SDLOpenDisplay( p_vout ) )
372 intf_ErrMsg( "error: can't reopen display after YUV change" );
375 p_vout->i_changes &= ~VOUT_YUV_CHANGE;
381 if( p_vout->i_changes & VOUT_FULLSCREEN_CHANGE )
383 p_vout->p_sys->b_fullscreen = ! p_vout->p_sys->b_fullscreen;
385 if( p_vout->p_sys->b_fullscreen )
387 p_vout->p_sys->b_fullscreen = 0;
388 p_vout->p_sys->b_cursor = 1;
393 p_vout->p_sys->b_fullscreen = 1;
394 p_vout->p_sys->b_cursor = 0;
398 SDL_WM_ToggleFullScreen(p_vout->p_sys->p_display);
400 p_vout->i_changes &= ~VOUT_FULLSCREEN_CHANGE;
406 if( p_vout->i_changes & VOUT_CURSOR_CHANGE )
408 if( p_vout->p_sys->b_cursor )
411 p_vout->p_sys->b_cursor = 0;
416 p_vout->p_sys->b_cursor = 1;
418 p_vout->i_changes &= ~VOUT_CURSOR_CHANGE;
424 /*****************************************************************************
425 * vout_SetPalette: sets an 8 bpp palette
426 *****************************************************************************
427 * This function sets the palette given as an argument. It does not return
428 * anything, but could later send information on which colors it was unable
430 *****************************************************************************/
431 static void vout_SetPalette( p_vout_thread_t p_vout, u16 *red, u16 *green,
432 u16 *blue, u16 *transp)
434 /* Create a display surface with a grayscale palette */
435 SDL_Color colors[256];
438 /* Fill colors with color information */
439 for( i = 0; i < 256; i++ )
441 colors[ i ].r = red[ i ] >> 8;
442 colors[ i ].g = green[ i ] >> 8;
443 colors[ i ].b = blue[ i ] >> 8;
447 if( SDL_SetColors( p_vout->p_sys->p_display, colors, 0, 256 ) == 0 )
449 intf_ErrMsg( "vout error: failed setting palette" );
454 /*****************************************************************************
455 * vout_Display: displays previously rendered output
456 *****************************************************************************
457 * This function send the currently rendered image to the display, wait until
458 * it is displayed and switch the two rendering buffer, preparing next frame.
459 *****************************************************************************/
460 static void vout_Display( vout_thread_t *p_vout )
463 if((p_vout->p_sys->p_display != NULL) && !p_vout->p_sys->b_reopen_display)
465 if( p_vout->b_need_render )
467 /* Change display frame */
468 SDL_Flip( p_vout->p_sys->p_display );
474 * p_vout->p_rendered_pic->p_y/u/v contains the YUV buffers to
477 /* TODO: support for streams other than 4:2:0 */
478 /* create the overlay if necessary */
479 if( p_vout->p_sys->p_overlay == NULL )
481 p_vout->p_sys->p_overlay = SDL_CreateYUVOverlay(
482 p_vout->p_rendered_pic->i_width,
483 p_vout->p_rendered_pic->i_height,
485 p_vout->p_sys->p_display
487 intf_Msg("vout: YUV acceleration %s",
488 p_vout->p_sys->p_overlay->hw_overlay
489 ? "activated" : "unavailable !" );
492 SDL_LockYUVOverlay(p_vout->p_sys->p_overlay);
493 /* copy the data into video buffers */
495 memcpy(p_vout->p_sys->p_overlay->pixels[0],
496 p_vout->p_rendered_pic->p_y,
497 p_vout->p_sys->p_overlay->h *
498 p_vout->p_sys->p_overlay->pitches[0]);
500 memcpy(p_vout->p_sys->p_overlay->pixels[1],
501 p_vout->p_rendered_pic->p_v,
502 p_vout->p_sys->p_overlay->h *
503 p_vout->p_sys->p_overlay->pitches[1] / 2);
505 memcpy(p_vout->p_sys->p_overlay->pixels[2],
506 p_vout->p_rendered_pic->p_u,
507 p_vout->p_sys->p_overlay->h *
508 p_vout->p_sys->p_overlay->pitches[2] / 2);
510 disp.w = (&p_vout->p_buffer[p_vout->i_buffer_index])->i_pic_width;
511 disp.h = (&p_vout->p_buffer[p_vout->i_buffer_index])->i_pic_height;
512 disp.x = (p_vout->i_width - disp.w)/2;
513 disp.y = (p_vout->i_height - disp.h)/2;
515 SDL_DisplayYUVOverlay( p_vout->p_sys->p_overlay , &disp );
516 SDL_UnlockYUVOverlay(p_vout->p_sys->p_overlay);
521 /* following functions are local */
523 /*****************************************************************************
524 * SDLOpenDisplay: open and initialize SDL device
525 *****************************************************************************
526 * Open and initialize display according to preferences specified in the vout
528 *****************************************************************************/
529 static int SDLOpenDisplay( vout_thread_t *p_vout )
531 SDL_Rect clipping_rect;
535 * TODO: Check that we can request for a DOUBLEBUF HWSURFACE display
538 /* init flags and cursor */
539 flags = SDL_ANYFORMAT | SDL_HWPALETTE;
541 if( p_vout->p_sys->b_fullscreen )
542 flags |= SDL_FULLSCREEN;
544 flags |= SDL_RESIZABLE;
546 if( p_vout->b_need_render )
547 flags |= SDL_HWSURFACE | SDL_DOUBLEBUF;
549 flags |= SDL_SWSURFACE; /* save video memory */
551 bpp = SDL_VideoModeOK( p_vout->p_sys->i_width,
552 p_vout->p_sys->i_height,
553 p_vout->i_screen_depth, flags );
557 intf_ErrMsg( "vout error: no video mode available" );
561 p_vout->p_sys->p_display = SDL_SetVideoMode(p_vout->p_sys->i_width,
562 p_vout->p_sys->i_height,
565 if( p_vout->p_sys->p_display == NULL )
567 intf_ErrMsg( "vout error: cannot set video mode" );
571 SDL_LockSurface(p_vout->p_sys->p_display);
573 if( p_vout->p_sys->b_fullscreen )
578 SDL_WM_SetCaption( VOUT_TITLE " (SDL output)",
579 VOUT_TITLE " (SDL output)" );
580 SDL_EventState(SDL_KEYUP , SDL_IGNORE); /* ignore keys up */
582 if( p_vout->b_need_render )
584 p_vout->p_sys->p_sdl_buf[ 0 ] = p_vout->p_sys->p_display->pixels;
585 SDL_Flip(p_vout->p_sys->p_display);
586 p_vout->p_sys->p_sdl_buf[ 1 ] = p_vout->p_sys->p_display->pixels;
587 SDL_Flip(p_vout->p_sys->p_display);
589 /* Set clipping for text */
592 clipping_rect.w = p_vout->p_sys->p_display->w;
593 clipping_rect.h = p_vout->p_sys->p_display->h;
594 SDL_SetClipRect(p_vout->p_sys->p_display, &clipping_rect);
596 /* Set thread information */
597 p_vout->i_width = p_vout->p_sys->p_display->w;
598 p_vout->i_height = p_vout->p_sys->p_display->h;
599 p_vout->i_bytes_per_line = p_vout->p_sys->p_display->pitch;
601 p_vout->i_screen_depth =
602 p_vout->p_sys->p_display->format->BitsPerPixel;
603 p_vout->i_bytes_per_pixel =
604 p_vout->p_sys->p_display->format->BytesPerPixel;
606 p_vout->i_red_mask = p_vout->p_sys->p_display->format->Rmask;
607 p_vout->i_green_mask = p_vout->p_sys->p_display->format->Gmask;
608 p_vout->i_blue_mask = p_vout->p_sys->p_display->format->Bmask;
610 /* FIXME: palette in 8bpp ?? */
611 /* Set and initialize buffers */
612 vout_SetBuffers( p_vout, p_vout->p_sys->p_sdl_buf[ 0 ],
613 p_vout->p_sys->p_sdl_buf[ 1 ] );
617 p_vout->p_sys->p_sdl_buf[ 0 ] = p_vout->p_sys->p_display->pixels;
618 p_vout->p_sys->p_sdl_buf[ 1 ] = p_vout->p_sys->p_display->pixels;
620 /* Set thread information */
621 p_vout->i_width = p_vout->p_sys->p_display->w;
622 p_vout->i_height = p_vout->p_sys->p_display->h;
623 p_vout->i_bytes_per_line = p_vout->p_sys->p_display->pitch;
625 vout_SetBuffers( p_vout, p_vout->p_sys->p_sdl_buf[ 0 ],
626 p_vout->p_sys->p_sdl_buf[ 1 ] );
629 p_vout->p_sys->b_reopen_display = 0;
634 /*****************************************************************************
635 * SDLCloseDisplay: close and reset SDL device
636 *****************************************************************************
637 * This function returns all resources allocated by SDLOpenDisplay and restore
638 * the original state of the device.
639 *****************************************************************************/
640 static void SDLCloseDisplay( vout_thread_t *p_vout )
642 if( p_vout->p_sys->p_display != NULL )
644 if( p_vout->p_sys->p_overlay != NULL )
646 SDL_FreeYUVOverlay( p_vout->p_sys->p_overlay );
647 p_vout->p_sys->p_overlay = NULL;
650 SDL_UnlockSurface ( p_vout->p_sys->p_display );
651 SDL_FreeSurface( p_vout->p_sys->p_display );
652 p_vout->p_sys->p_display = NULL;