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
78 SDL_Surface * p_display; /* display device */
79 SDL_Overlay * p_overlay; /* overlay device */
81 boolean_t b_fullscreen;
84 boolean_t b_reopen_display;
86 boolean_t b_cursor_autohidden;
89 Uint8 * p_sdl_buf[2]; /* Buffer information */
93 /*****************************************************************************
95 *****************************************************************************/
96 static int vout_Probe ( probedata_t *p_data );
97 static int vout_Create ( struct vout_thread_s * );
98 static int vout_Init ( struct vout_thread_s * );
99 static void vout_End ( struct vout_thread_s * );
100 static void vout_Destroy ( struct vout_thread_s * );
101 static int vout_Manage ( struct vout_thread_s * );
102 static void vout_Display ( struct vout_thread_s * );
103 static void vout_SetPalette( p_vout_thread_t p_vout, u16 *red, u16 *green,
104 u16 *blue, u16 *transp );
106 static int SDLOpenDisplay ( vout_thread_t *p_vout );
107 static void SDLCloseDisplay ( vout_thread_t *p_vout );
109 /*****************************************************************************
110 * Functions exported as capabilities. They are declared as static so that
111 * we don't pollute the namespace too much.
112 *****************************************************************************/
113 void _M( vout_getfunctions )( function_list_t * p_function_list )
115 p_function_list->pf_probe = vout_Probe;
116 p_function_list->functions.vout.pf_create = vout_Create;
117 p_function_list->functions.vout.pf_init = vout_Init;
118 p_function_list->functions.vout.pf_end = vout_End;
119 p_function_list->functions.vout.pf_destroy = vout_Destroy;
120 p_function_list->functions.vout.pf_manage = vout_Manage;
121 p_function_list->functions.vout.pf_display = vout_Display;
122 p_function_list->functions.vout.pf_setpalette = vout_SetPalette;
125 /*****************************************************************************
126 * vout_Probe: probe the video driver and return a score
127 *****************************************************************************
128 * This function tries to initialize SDL and returns a score to the
129 * plugin manager so that it can select the best plugin.
130 *****************************************************************************/
131 static int vout_Probe( probedata_t *p_data )
133 if( TestMethod( VOUT_METHOD_VAR, "sdl" ) )
141 /*****************************************************************************
142 * vout_Create: allocate SDL video thread output method
143 *****************************************************************************
144 * This function allocate and initialize a SDL vout method. It uses some of the
145 * vout properties to choose the correct mode, and change them according to the
146 * mode actually used.
147 *****************************************************************************/
148 static int vout_Create( vout_thread_t *p_vout )
150 /* Allocate structure */
151 p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
152 if( p_vout->p_sys == NULL )
154 intf_ErrMsg( "vout error: can't create p_sys (%s)", strerror(ENOMEM) );
158 /* Initialize library */
159 if( SDL_Init(SDL_INIT_VIDEO | SDL_INIT_EVENTTHREAD | SDL_INIT_NOPARACHUTE)
162 intf_ErrMsg( "vout error: can't initialize SDL (%s)", SDL_GetError() );
163 free( p_vout->p_sys );
167 p_vout->p_sys->b_cursor = 1; /* TODO should be done with a main_GetInt.. */
169 p_vout->p_sys->b_cursor_autohidden = 0;
170 p_vout->p_sys->i_lastmoved = mdate();
172 p_vout->p_sys->b_fullscreen = main_GetIntVariable( VOUT_FULLSCREEN_VAR,
173 VOUT_FULLSCREEN_DEFAULT );
174 p_vout->p_sys->b_overlay = main_GetIntVariable( VOUT_OVERLAY_VAR,
175 VOUT_OVERLAY_DEFAULT );
176 p_vout->p_sys->i_width = main_GetIntVariable( VOUT_WIDTH_VAR,
177 VOUT_WIDTH_DEFAULT );
178 p_vout->p_sys->i_height = main_GetIntVariable( VOUT_HEIGHT_VAR,
179 VOUT_HEIGHT_DEFAULT );
181 p_vout->p_sys->p_display = NULL;
182 p_vout->p_sys->p_overlay = NULL;
184 if( SDLOpenDisplay(p_vout) )
186 intf_ErrMsg( "vout error: can't set up SDL (%s)", SDL_GetError() );
187 free( p_vout->p_sys );
191 /* FIXME: get rid of this ASAP, it's FUCKING UGLY */
192 { intf_thread_t * p_intf = p_main->p_intf;
193 intf_AssignKey(p_intf, SDLK_q, INTF_KEY_QUIT, 0);
194 intf_AssignKey(p_intf, SDLK_ESCAPE, INTF_KEY_QUIT, 0);
195 /* intf_AssignKey(p_intf,3,'Q'); */
196 intf_AssignKey(p_intf, SDLK_0, INTF_KEY_SET_CHANNEL,0);
197 intf_AssignKey(p_intf, SDLK_1, INTF_KEY_SET_CHANNEL,1);
198 intf_AssignKey(p_intf, SDLK_2, INTF_KEY_SET_CHANNEL,2);
199 intf_AssignKey(p_intf, SDLK_3, INTF_KEY_SET_CHANNEL,3);
200 intf_AssignKey(p_intf, SDLK_4, INTF_KEY_SET_CHANNEL,4);
201 intf_AssignKey(p_intf, SDLK_5, INTF_KEY_SET_CHANNEL,5);
202 intf_AssignKey(p_intf, SDLK_6, INTF_KEY_SET_CHANNEL,6);
203 intf_AssignKey(p_intf, SDLK_7, INTF_KEY_SET_CHANNEL,7);
204 intf_AssignKey(p_intf, SDLK_8, INTF_KEY_SET_CHANNEL,8);
205 intf_AssignKey(p_intf, SDLK_9, INTF_KEY_SET_CHANNEL,9);
206 intf_AssignKey(p_intf, SDLK_PLUS, INTF_KEY_INC_VOLUME, 0);
207 intf_AssignKey(p_intf, SDLK_MINUS, INTF_KEY_DEC_VOLUME, 0);
208 intf_AssignKey(p_intf, SDLK_m, INTF_KEY_TOGGLE_VOLUME, 0);
209 /* intf_AssignKey(p_intf,'M','M'); */
210 intf_AssignKey(p_intf, SDLK_g, INTF_KEY_DEC_GAMMA, 0);
211 /* intf_AssignKey(p_intf,'G','G'); */
212 intf_AssignKey(p_intf, SDLK_c, INTF_KEY_TOGGLE_GRAYSCALE, 0);
213 intf_AssignKey(p_intf, SDLK_SPACE, INTF_KEY_TOGGLE_INTERFACE, 0);
214 intf_AssignKey(p_intf, SDLK_i, INTF_KEY_TOGGLE_INFO, 0);
215 intf_AssignKey(p_intf, SDLK_s, INTF_KEY_TOGGLE_SCALING, 0);
216 intf_AssignKey(p_intf, SDLK_d, INTF_KEY_DUMP_STREAM, 0); }
221 /*****************************************************************************
222 * vout_Init: initialize SDL video thread output method
223 *****************************************************************************
224 * This function initialize the SDL display device.
225 *****************************************************************************/
226 static int vout_Init( vout_thread_t *p_vout )
228 /* This hack is hugly, but hey, you are, too. */
230 SDL_Overlay * p_overlay;
232 p_overlay = SDL_CreateYUVOverlay(
233 main_GetIntVariable( VOUT_WIDTH_VAR,VOUT_WIDTH_DEFAULT ),
234 main_GetIntVariable( VOUT_HEIGHT_VAR,VOUT_HEIGHT_DEFAULT ),
236 p_vout->p_sys->p_display );
237 intf_Msg( "vout: YUV acceleration %s",
238 p_overlay->hw_overlay ? "activated" : "unavailable !" );
239 p_vout->b_need_render = !p_overlay->hw_overlay;
241 SDL_FreeYUVOverlay( p_overlay );
246 /*****************************************************************************
247 * vout_End: terminate Sys video thread output method
248 *****************************************************************************
249 * Terminate an output method created by vout_SDLCreate
250 *****************************************************************************/
251 static void vout_End( vout_thread_t *p_vout )
253 SDLCloseDisplay( p_vout );
257 /*****************************************************************************
258 * vout_Destroy: destroy Sys video thread output method
259 *****************************************************************************
260 * Terminate an output method created by vout_SDLCreate
261 *****************************************************************************/
262 static void vout_Destroy( vout_thread_t *p_vout )
264 free( p_vout->p_sys );
267 /*****************************************************************************
268 * vout_Manage: handle Sys events
269 *****************************************************************************
270 * This function should be called regularly by video output thread. It returns
271 * a non null value if an error occured.
272 *****************************************************************************/
273 static int vout_Manage( vout_thread_t *p_vout )
275 SDL_Event event; /* SDL event */
279 while( SDL_PollEvent(&event) )
283 case SDL_VIDEORESIZE: /* Resizing of window */
284 p_vout->i_width = event.resize.w;
285 p_vout->i_height = event.resize.h;
286 p_vout->i_changes |= VOUT_SIZE_CHANGE;
289 case SDL_MOUSEMOTION:
290 if( p_vout->p_sys->b_cursor &&
291 (abs(event.motion.xrel) > 2 || abs(event.motion.yrel) > 2) )
293 if( p_vout->p_sys->b_cursor_autohidden )
295 p_vout->p_sys->b_cursor_autohidden = 0;
300 p_vout->p_sys->i_lastmoved = mdate();
305 case SDL_MOUSEBUTTONUP:
306 switch( event.button.button )
308 case SDL_BUTTON_RIGHT:
309 p_main->p_intf->b_menu_change = 1;
314 case SDL_MOUSEBUTTONDOWN:
315 switch( event.button.button )
317 case SDL_BUTTON_MIDDLE:
318 p_vout->i_changes |= VOUT_CURSOR_CHANGE;
324 intf_ProcessKey( p_main->p_intf, SDLK_q );
327 case SDL_KEYDOWN: /* if a key is pressed */
328 i_key = event.key.keysym.sym;
332 case SDLK_f: /* switch to fullscreen */
333 p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
336 case SDLK_y: /* switch to hard YUV */
337 p_vout->i_changes |= VOUT_YUV_CHANGE;
340 case SDLK_c: /* toggle grayscale */
341 p_vout->b_grayscale = ! p_vout->b_grayscale;
342 p_vout->i_changes |= VOUT_GRAYSCALE_CHANGE;
345 case SDLK_i: /* toggle info */
346 p_vout->b_info = ! p_vout->b_info;
347 p_vout->i_changes |= VOUT_INFO_CHANGE;
350 case SDLK_s: /* toggle scaling */
351 p_vout->b_scale = ! p_vout->b_scale;
352 p_vout->i_changes |= VOUT_SCALE_CHANGE;
355 case SDLK_SPACE: /* toggle interface */
356 p_vout->b_interface = ! p_vout->b_interface;
357 p_vout->i_changes |= VOUT_INTF_CHANGE;
361 if( intf_ProcessKey( p_main->p_intf, (char )i_key ) )
363 intf_DbgMsg( "unhandled key '%c' (%i)", (char)i_key, i_key ); }
376 if( p_vout->i_changes & VOUT_SIZE_CHANGE )
378 p_vout->p_sys->i_width = p_vout->i_width;
379 p_vout->p_sys->i_height = p_vout->i_height;
381 /* Need to reopen display */
382 SDLCloseDisplay( p_vout );
383 if( SDLOpenDisplay( p_vout ) )
385 intf_ErrMsg( "vout error: can't reopen display after resize" );
388 p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
394 if( p_vout->i_changes & VOUT_YUV_CHANGE )
396 p_vout->b_need_render = ! p_vout->b_need_render;
398 /* Need to reopen display */
399 SDLCloseDisplay( p_vout );
400 if( SDLOpenDisplay( p_vout ) )
402 intf_ErrMsg( "error: can't reopen display after YUV change" );
405 p_vout->i_changes &= ~VOUT_YUV_CHANGE;
411 if( p_vout->i_changes & VOUT_FULLSCREEN_CHANGE )
413 p_vout->p_sys->b_fullscreen = ! p_vout->p_sys->b_fullscreen;
415 SDL_WM_ToggleFullScreen(p_vout->p_sys->p_display);
417 p_vout->p_sys->b_cursor_autohidden = 0;
418 SDL_ShowCursor( p_vout->p_sys->b_cursor &&
419 ! p_vout->p_sys->b_cursor_autohidden );
421 p_vout->i_changes &= ~VOUT_FULLSCREEN_CHANGE;
427 if( ! p_vout->p_sys->b_cursor_autohidden &&
428 ( mdate() - p_vout->p_sys->i_lastmoved > 2000000 ) )
430 /* Hide the mouse automatically */
431 p_vout->p_sys->b_cursor_autohidden = 1;
435 if( p_vout->i_changes & VOUT_CURSOR_CHANGE )
437 p_vout->p_sys->b_cursor = ! p_vout->p_sys->b_cursor;
439 SDL_ShowCursor( p_vout->p_sys->b_cursor &&
440 ! p_vout->p_sys->b_cursor_autohidden );
442 p_vout->i_changes &= ~VOUT_CURSOR_CHANGE;
448 /*****************************************************************************
449 * vout_SetPalette: sets an 8 bpp palette
450 *****************************************************************************
451 * This function sets the palette given as an argument. It does not return
452 * anything, but could later send information on which colors it was unable
454 *****************************************************************************/
455 static void vout_SetPalette( p_vout_thread_t p_vout, u16 *red, u16 *green,
456 u16 *blue, u16 *transp)
458 /* Create a display surface with a grayscale palette */
459 SDL_Color colors[256];
462 /* Fill colors with color information */
463 for( i = 0; i < 256; i++ )
465 colors[ i ].r = red[ i ] >> 8;
466 colors[ i ].g = green[ i ] >> 8;
467 colors[ i ].b = blue[ i ] >> 8;
471 if( SDL_SetColors( p_vout->p_sys->p_display, colors, 0, 256 ) == 0 )
473 intf_ErrMsg( "vout error: failed setting palette" );
478 /*****************************************************************************
479 * vout_Display: displays previously rendered output
480 *****************************************************************************
481 * This function send the currently rendered image to the display, wait until
482 * it is displayed and switch the two rendering buffer, preparing next frame.
483 *****************************************************************************/
484 static void vout_Display( vout_thread_t *p_vout )
487 if((p_vout->p_sys->p_display != NULL) && !p_vout->p_sys->b_reopen_display)
489 if( p_vout->b_need_render )
491 /* Change display frame */
492 SDL_Flip( p_vout->p_sys->p_display );
497 * p_vout->p_rendered_pic->p_y/u/v contains the YUV buffers to
500 /* TODO: support for streams other than 4:2:0 */
501 /* create the overlay if necessary */
502 if( p_vout->p_sys->p_overlay == NULL )
504 p_vout->p_sys->p_overlay = SDL_CreateYUVOverlay(
505 p_vout->p_rendered_pic->i_width,
506 p_vout->p_rendered_pic->i_height,
508 p_vout->p_sys->p_display
510 intf_Msg("vout: YUV acceleration %s",
511 p_vout->p_sys->p_overlay->hw_overlay
512 ? "activated" : "unavailable !" );
515 SDL_LockYUVOverlay(p_vout->p_sys->p_overlay);
516 /* copy the data into video buffers */
518 memcpy(p_vout->p_sys->p_overlay->pixels[0],
519 p_vout->p_rendered_pic->p_y,
520 p_vout->p_sys->p_overlay->h *
521 p_vout->p_sys->p_overlay->pitches[0]);
523 memcpy(p_vout->p_sys->p_overlay->pixels[1],
524 p_vout->p_rendered_pic->p_v,
525 p_vout->p_sys->p_overlay->h *
526 p_vout->p_sys->p_overlay->pitches[1] / 2);
528 memcpy(p_vout->p_sys->p_overlay->pixels[2],
529 p_vout->p_rendered_pic->p_u,
530 p_vout->p_sys->p_overlay->h *
531 p_vout->p_sys->p_overlay->pitches[2] / 2);
533 disp.w = (&p_vout->p_buffer[p_vout->i_buffer_index])->i_pic_width;
534 disp.h = (&p_vout->p_buffer[p_vout->i_buffer_index])->i_pic_height;
535 disp.x = (p_vout->i_width - disp.w)/2;
536 disp.y = (p_vout->i_height - disp.h)/2;
538 SDL_DisplayYUVOverlay( p_vout->p_sys->p_overlay , &disp );
539 SDL_UnlockYUVOverlay(p_vout->p_sys->p_overlay);
544 /* following functions are local */
546 /*****************************************************************************
547 * SDLOpenDisplay: open and initialize SDL device
548 *****************************************************************************
549 * Open and initialize display according to preferences specified in the vout
551 *****************************************************************************/
552 static int SDLOpenDisplay( vout_thread_t *p_vout )
554 SDL_Rect clipping_rect;
558 * TODO: Check that we can request for a DOUBLEBUF HWSURFACE display
561 /* init flags and cursor */
562 flags = SDL_ANYFORMAT | SDL_HWPALETTE;
564 if( p_vout->p_sys->b_fullscreen )
566 flags |= SDL_FULLSCREEN;
570 flags |= SDL_RESIZABLE;
573 if( p_vout->b_need_render )
575 flags |= SDL_HWSURFACE | SDL_DOUBLEBUF;
579 flags |= SDL_SWSURFACE; /* save video memory */
582 bpp = SDL_VideoModeOK( p_vout->p_sys->i_width,
583 p_vout->p_sys->i_height,
584 p_vout->i_screen_depth, flags );
588 intf_ErrMsg( "vout error: no video mode available" );
592 p_vout->p_sys->p_display = SDL_SetVideoMode(p_vout->p_sys->i_width,
593 p_vout->p_sys->i_height,
596 if( p_vout->p_sys->p_display == NULL )
598 intf_ErrMsg( "vout error: cannot set video mode" );
602 SDL_LockSurface( p_vout->p_sys->p_display );
604 SDL_WM_SetCaption( VOUT_TITLE " (SDL output)",
605 VOUT_TITLE " (SDL output)" );
606 SDL_EventState(SDL_KEYUP , SDL_IGNORE); /* ignore keys up */
608 if( p_vout->b_need_render )
610 p_vout->p_sys->p_sdl_buf[ 0 ] = p_vout->p_sys->p_display->pixels;
611 SDL_Flip(p_vout->p_sys->p_display);
612 p_vout->p_sys->p_sdl_buf[ 1 ] = p_vout->p_sys->p_display->pixels;
613 SDL_Flip(p_vout->p_sys->p_display);
615 /* Set clipping for text */
618 clipping_rect.w = p_vout->p_sys->p_display->w;
619 clipping_rect.h = p_vout->p_sys->p_display->h;
620 SDL_SetClipRect(p_vout->p_sys->p_display, &clipping_rect);
622 /* Set thread information */
623 p_vout->i_width = p_vout->p_sys->p_display->w;
624 p_vout->i_height = p_vout->p_sys->p_display->h;
625 p_vout->i_bytes_per_line = p_vout->p_sys->p_display->pitch;
627 p_vout->i_screen_depth =
628 p_vout->p_sys->p_display->format->BitsPerPixel;
629 p_vout->i_bytes_per_pixel =
630 p_vout->p_sys->p_display->format->BytesPerPixel;
632 p_vout->i_red_mask = p_vout->p_sys->p_display->format->Rmask;
633 p_vout->i_green_mask = p_vout->p_sys->p_display->format->Gmask;
634 p_vout->i_blue_mask = p_vout->p_sys->p_display->format->Bmask;
636 /* FIXME: palette in 8bpp ?? */
637 /* Set and initialize buffers */
638 vout_SetBuffers( p_vout, p_vout->p_sys->p_sdl_buf[ 0 ],
639 p_vout->p_sys->p_sdl_buf[ 1 ] );
643 p_vout->p_sys->p_sdl_buf[ 0 ] = p_vout->p_sys->p_display->pixels;
644 p_vout->p_sys->p_sdl_buf[ 1 ] = p_vout->p_sys->p_display->pixels;
646 /* Set thread information */
647 p_vout->i_width = p_vout->p_sys->p_display->w;
648 p_vout->i_height = p_vout->p_sys->p_display->h;
649 p_vout->i_bytes_per_line = p_vout->p_sys->p_display->pitch;
651 vout_SetBuffers( p_vout, p_vout->p_sys->p_sdl_buf[ 0 ],
652 p_vout->p_sys->p_sdl_buf[ 1 ] );
655 p_vout->p_sys->b_reopen_display = 0;
660 /*****************************************************************************
661 * SDLCloseDisplay: close and reset SDL device
662 *****************************************************************************
663 * This function returns all resources allocated by SDLOpenDisplay and restore
664 * the original state of the device.
665 *****************************************************************************/
666 static void SDLCloseDisplay( vout_thread_t *p_vout )
668 if( p_vout->p_sys->p_display != NULL )
670 if( p_vout->p_sys->p_overlay != NULL )
672 SDL_FreeYUVOverlay( p_vout->p_sys->p_overlay );
673 p_vout->p_sys->p_overlay = NULL;
676 SDL_UnlockSurface ( p_vout->p_sys->p_display );
677 SDL_FreeSurface( p_vout->p_sys->p_display );
678 p_vout->p_sys->p_display = NULL;