1 /*****************************************************************************
2 * vout_sdl.c: SDL video output display method
3 *****************************************************************************
4 * Copyright (C) 1998, 1999, 2000 VideoLAN
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
21 *****************************************************************************/
23 /*****************************************************************************
25 *****************************************************************************/
28 #include <errno.h> /* ENOMEM */
29 #include <stdlib.h> /* free() */
30 #include <string.h> /* strerror() */
41 /* FIXME: it's up to the _interface_ to do this, not the video output */
42 #include "stream_control.h"
43 #include "input_ext-intf.h"
46 #include "video_output.h"
49 #include "interface.h"
50 /* FIXME: get rid of this */
51 #include "keystrokes.h"
54 /*****************************************************************************
55 * FIXME: this file is ... *
57 * XXX XXX FIXME XXX XXX XXX XXX *
58 * XXX XXX XXX XXX XXX XXX XXX XXX *
59 * XXX XXX XXX XXX FIXME XXX *
60 * XXX XXX XXX TODO XXX XXX XXX *
61 * XXX XXX XXX XXX XXX XXX *
62 * FIXME FIXME FIXME XXX XXX *
64 *****************************************************************************/
66 /*****************************************************************************
67 * vout_sys_t: video output SDL method descriptor
68 *****************************************************************************
69 * This structure is part of the video output thread descriptor.
70 * It describes the SDL specific properties of an output thread.
71 *****************************************************************************/
72 typedef struct vout_sys_s
76 SDL_Surface * p_display; /* display device */
77 SDL_Overlay * p_overlay; /* overlay device */
78 boolean_t b_fullscreen;
81 boolean_t b_reopen_display;
82 Uint8 * p_sdl_buf[2]; /* Buffer information */
85 /*****************************************************************************
87 *****************************************************************************/
88 static int vout_Probe ( probedata_t *p_data );
89 static int vout_Create ( struct vout_thread_s * );
90 static int vout_Init ( struct vout_thread_s * );
91 static void vout_End ( struct vout_thread_s * );
92 static void vout_Destroy ( struct vout_thread_s * );
93 static int vout_Manage ( struct vout_thread_s * );
94 static void vout_Display ( struct vout_thread_s * );
96 static int SDLOpenDisplay ( vout_thread_t *p_vout );
97 static void SDLCloseDisplay ( vout_thread_t *p_vout );
99 /*****************************************************************************
100 * Functions exported as capabilities. They are declared as static so that
101 * we don't pollute the namespace too much.
102 *****************************************************************************/
103 void vout_getfunctions( function_list_t * p_function_list )
105 p_function_list->pf_probe = vout_Probe;
106 p_function_list->functions.vout.pf_create = vout_Create;
107 p_function_list->functions.vout.pf_init = vout_Init;
108 p_function_list->functions.vout.pf_end = vout_End;
109 p_function_list->functions.vout.pf_destroy = vout_Destroy;
110 p_function_list->functions.vout.pf_manage = vout_Manage;
111 p_function_list->functions.vout.pf_display = vout_Display;
112 p_function_list->functions.vout.pf_setpalette = NULL;
115 /*****************************************************************************
116 * intf_Probe: probe the video driver and return a score
117 *****************************************************************************
118 * This function tries to initialize SDL and returns a score to the
119 * plugin manager so that it can select the best plugin.
120 *****************************************************************************/
121 static int vout_Probe( probedata_t *p_data )
123 if( TestMethod( VOUT_METHOD_VAR, "sdl" ) )
131 /*****************************************************************************
132 * vout_Create: allocate SDL video thread output method
133 *****************************************************************************
134 * This function allocate and initialize a SDL vout method. It uses some of the
135 * vout properties to choose the correct mode, and change them according to the
136 * mode actually used.
137 *****************************************************************************/
138 int vout_Create( vout_thread_t *p_vout )
140 /* Allocate structure */
141 p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
142 if( p_vout->p_sys == NULL )
144 intf_ErrMsg( "vout error: can't create p_sys (%s)", strerror(ENOMEM) );
148 /* Initialize library */
149 if( SDL_Init(SDL_INIT_VIDEO | SDL_INIT_EVENTTHREAD | SDL_INIT_NOPARACHUTE)
152 intf_ErrMsg( "vout error: can't initialize SDL (%s)", SDL_GetError() );
153 free( p_vout->p_sys );
157 /* Force the software yuv even if it is not used */
158 /* If we don't do this, p_vout is not correctly initialized
159 and it's impossible to switch between soft/hard yuv */
160 /* FIXME: this is a broken way to do !! fix this !! */
161 p_vout->b_need_render = 1;
163 p_vout->p_sys->b_cursor = 1; /* TODO should be done with a main_GetInt.. */
164 p_vout->p_sys->b_fullscreen = main_GetIntVariable( VOUT_FULLSCREEN_VAR,
165 VOUT_FULLSCREEN_DEFAULT );
166 p_vout->p_sys->b_overlay = main_GetIntVariable( VOUT_OVERLAY_VAR,
167 VOUT_OVERLAY_DEFAULT );
168 p_vout->p_sys->i_width = main_GetIntVariable( VOUT_WIDTH_VAR,
169 VOUT_WIDTH_DEFAULT );
170 p_vout->p_sys->i_height = main_GetIntVariable( VOUT_HEIGHT_VAR,
171 VOUT_HEIGHT_DEFAULT );
173 p_vout->p_sys->p_display = NULL;
174 p_vout->p_sys->p_overlay = NULL;
176 if( SDLOpenDisplay(p_vout) )
178 intf_ErrMsg( "vout error: can't initialize SDL (%s)", SDL_GetError() );
179 free( p_vout->p_sys );
183 /* FIXME: get rid of this ASAP, it's FUCKING UGLY */
184 { intf_thread_t * p_intf = p_main->p_intf;
185 /* p_intf->p_intf_getKey = intf_getKey; */
186 intf_AssignKey(p_intf, SDLK_q, INTF_KEY_QUIT, 0);
187 intf_AssignKey(p_intf, SDLK_ESCAPE, INTF_KEY_QUIT, 0);
188 /* intf_AssignKey(p_intf,3,'Q'); */
189 intf_AssignKey(p_intf, SDLK_0, INTF_KEY_SET_CHANNEL,0);
190 intf_AssignKey(p_intf, SDLK_1, INTF_KEY_SET_CHANNEL,1);
191 intf_AssignKey(p_intf, SDLK_2, INTF_KEY_SET_CHANNEL,2);
192 intf_AssignKey(p_intf, SDLK_3, INTF_KEY_SET_CHANNEL,3);
193 intf_AssignKey(p_intf, SDLK_4, INTF_KEY_SET_CHANNEL,4);
194 intf_AssignKey(p_intf, SDLK_5, INTF_KEY_SET_CHANNEL,5);
195 intf_AssignKey(p_intf, SDLK_6, INTF_KEY_SET_CHANNEL,6);
196 intf_AssignKey(p_intf, SDLK_7, INTF_KEY_SET_CHANNEL,7);
197 intf_AssignKey(p_intf, SDLK_8, INTF_KEY_SET_CHANNEL,8);
198 intf_AssignKey(p_intf, SDLK_9, INTF_KEY_SET_CHANNEL,9);
199 intf_AssignKey(p_intf, SDLK_PLUS, INTF_KEY_INC_VOLUME, 0);
200 intf_AssignKey(p_intf, SDLK_MINUS, INTF_KEY_DEC_VOLUME, 0);
201 intf_AssignKey(p_intf, SDLK_m, INTF_KEY_TOGGLE_VOLUME, 0);
202 /* intf_AssignKey(p_intf,'M','M'); */
203 intf_AssignKey(p_intf, SDLK_g, INTF_KEY_DEC_GAMMA, 0);
204 /* intf_AssignKey(p_intf,'G','G'); */
205 intf_AssignKey(p_intf, SDLK_c, INTF_KEY_TOGGLE_GRAYSCALE, 0);
206 intf_AssignKey(p_intf, SDLK_SPACE, INTF_KEY_TOGGLE_INTERFACE, 0);
207 intf_AssignKey(p_intf, SDLK_i, INTF_KEY_TOGGLE_INFO, 0);
208 intf_AssignKey(p_intf, SDLK_s, INTF_KEY_TOGGLE_SCALING, 0); }
213 /*****************************************************************************
214 * vout_Init: initialize SDL video thread output method
215 *****************************************************************************
216 * This function initialize the SDL display device.
217 *****************************************************************************/
218 int vout_Init( vout_thread_t *p_vout )
223 /*****************************************************************************
224 * vout_End: terminate Sys video thread output method
225 *****************************************************************************
226 * Terminate an output method created by vout_SDLCreate
227 *****************************************************************************/
228 void vout_End( vout_thread_t *p_vout )
230 SDLCloseDisplay( p_vout );
234 /*****************************************************************************
235 * vout_Destroy: destroy Sys video thread output method
236 *****************************************************************************
237 * Terminate an output method created by vout_SDLCreate
238 *****************************************************************************/
239 void vout_Destroy( vout_thread_t *p_vout )
241 free( p_vout->p_sys );
244 /*****************************************************************************
245 * vout_Manage: handle Sys events
246 *****************************************************************************
247 * This function should be called regularly by video output thread. It returns
248 * a non null value if an error occured.
249 *****************************************************************************/
250 int vout_Manage( vout_thread_t *p_vout )
252 SDL_Event event; /* SDL event */
255 /* FIXME: do this nicely */
256 input_thread_t * p_input = p_main->p_intf->p_input;
259 while( SDL_PollEvent(&event) )
263 case SDL_VIDEORESIZE: /* Resizing of window */
264 p_vout->i_width = event.resize.w;
265 p_vout->i_height = event.resize.h;
266 p_vout->i_changes |= VOUT_SIZE_CHANGE;
269 case SDL_MOUSEBUTTONDOWN:
270 switch( event.button.button )
272 case SDL_BUTTON_MIDDLE:
273 p_vout->i_changes |= VOUT_CURSOR_CHANGE;
276 case SDL_BUTTON_RIGHT:
277 p_main->p_intf->b_menu_change = 1;
283 intf_ProcessKey( p_main->p_intf, SDLK_q );
286 case SDL_KEYDOWN: /* if a key is pressed */
287 i_key = event.key.keysym.sym;
291 case SDLK_f: /* switch to fullscreen */
292 p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
295 case SDLK_y: /* switch to hard YUV */
296 p_vout->i_changes |= VOUT_YUV_CHANGE;
299 case SDLK_c: /* toggle grayscale */
300 p_vout->b_grayscale = ! p_vout->b_grayscale;
301 p_vout->i_changes |= VOUT_GRAYSCALE_CHANGE;
304 case SDLK_i: /* toggle info */
305 p_vout->b_info = ! p_vout->b_info;
306 p_vout->i_changes |= VOUT_INFO_CHANGE;
309 case SDLK_s: /* toggle scaling */
310 p_vout->b_scale = ! p_vout->b_scale;
311 p_vout->i_changes |= VOUT_SCALE_CHANGE;
314 case SDLK_SPACE: /* toggle interface */
315 p_vout->b_interface = ! p_vout->b_interface;
316 p_vout->i_changes |= VOUT_INTF_CHANGE;
319 /* FIXME : this is temporary */
321 if( p_input != NULL )
323 input_SetRate( p_input, INPUT_RATE_PAUSE );
328 if( p_input != NULL )
330 input_SetRate( p_input, INPUT_RATE_FASTER );
335 if( p_input != NULL )
337 input_SetRate( p_input, INPUT_RATE_SLOWER );
342 if( p_input != NULL )
345 input_Seek( p_input, p_input->stream.i_tell
346 + p_input->stream.i_size / 20 );
352 if( p_input != NULL )
355 input_Seek( p_input, p_input->stream.i_tell
356 - p_input->stream.i_size / 20 );
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( "error: can't open DISPLAY default display" );
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 open DISPLAY default display" );
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 if( p_vout->p_sys->b_fullscreen )
417 p_vout->p_sys->b_fullscreen = 0;
418 p_vout->p_sys->b_cursor = 1;
423 p_vout->p_sys->b_fullscreen = 1;
424 p_vout->p_sys->b_cursor = 0;
428 SDL_WM_ToggleFullScreen(p_vout->p_sys->p_display);
430 p_vout->i_changes &= ~VOUT_FULLSCREEN_CHANGE;
436 if( p_vout->i_changes & VOUT_CURSOR_CHANGE )
438 if( p_vout->p_sys->b_cursor )
441 p_vout->p_sys->b_cursor = 0;
446 p_vout->p_sys->b_cursor = 1;
448 p_vout->i_changes &= ~VOUT_CURSOR_CHANGE;
454 /*****************************************************************************
455 * vout_SetPalette: sets an 8 bpp palette
456 *****************************************************************************
457 * This function sets the palette given as an argument. It does not return
458 * anything, but could later send information on which colors it was unable
460 *****************************************************************************/
461 void vout_SetPalette( p_vout_thread_t p_vout, u16 *red, u16 *green,
462 u16 *blue, u16 *transp)
464 /* Create a display surface with a grayscale palette */
465 SDL_Color colors[256];
468 /* Fill colors with color information */
469 for( i = 0; i < 256; i++ )
471 colors[ i ].r = red[ i ] >> 8;
472 colors[ i ].g = green[ i ] >> 8;
473 colors[ i ].b = blue[ i ] >> 8;
477 if( SDL_SetColors( p_vout->p_sys->p_display, colors, 0, 256 ) == 0 )
479 intf_ErrMsg( "vout error: failed setting palette" );
484 /*****************************************************************************
485 * vout_Display: displays previously rendered output
486 *****************************************************************************
487 * This function send the currently rendered image to the display, wait until
488 * it is displayed and switch the two rendering buffer, preparing next frame.
489 *****************************************************************************/
490 void vout_Display( vout_thread_t *p_vout )
493 if((p_vout->p_sys->p_display != NULL) && !p_vout->p_sys->b_reopen_display)
495 if( p_vout->b_need_render )
497 /* Change display frame */
498 SDL_Flip( p_vout->p_sys->p_display );
504 * p_vout->p_rendered_pic->p_y/u/v contains the YUV buffers to
507 /* TODO: support for streams other than 4:2:0 */
508 /* create the overlay if necessary */
509 if( p_vout->p_sys->p_overlay == NULL )
511 p_vout->p_sys->p_overlay = SDL_CreateYUVOverlay(
512 p_vout->p_rendered_pic->i_width,
513 p_vout->p_rendered_pic->i_height,
515 p_vout->p_sys->p_display
517 intf_Msg("vout: YUV acceleration %s",
518 p_vout->p_sys->p_overlay->hw_overlay
519 ? "activated" : "unavailable !" );
522 SDL_LockYUVOverlay(p_vout->p_sys->p_overlay);
523 /* copy the data into video buffers */
525 memcpy(p_vout->p_sys->p_overlay->pixels[0],
526 p_vout->p_rendered_pic->p_y,
527 p_vout->p_sys->p_overlay->h *
528 p_vout->p_sys->p_overlay->pitches[0]);
530 memcpy(p_vout->p_sys->p_overlay->pixels[1],
531 p_vout->p_rendered_pic->p_v,
532 p_vout->p_sys->p_overlay->h *
533 p_vout->p_sys->p_overlay->pitches[1] / 2);
535 memcpy(p_vout->p_sys->p_overlay->pixels[2],
536 p_vout->p_rendered_pic->p_u,
537 p_vout->p_sys->p_overlay->h *
538 p_vout->p_sys->p_overlay->pitches[2] / 2);
540 disp.w = (&p_vout->p_buffer[p_vout->i_buffer_index])->i_pic_width;
541 disp.h = (&p_vout->p_buffer[p_vout->i_buffer_index])->i_pic_height;
542 disp.x = (p_vout->i_width - disp.w)/2;
543 disp.y = (p_vout->i_height - disp.h)/2;
545 SDL_DisplayYUVOverlay( p_vout->p_sys->p_overlay , &disp );
546 SDL_UnlockYUVOverlay(p_vout->p_sys->p_overlay);
551 /* following functions are local */
553 /*****************************************************************************
554 * SDLOpenDisplay: open and initialize SDL device
555 *****************************************************************************
556 * Open and initialize display according to preferences specified in the vout
558 *****************************************************************************/
559 static int SDLOpenDisplay( vout_thread_t *p_vout )
561 SDL_Rect clipping_rect;
565 * TODO: Check that we can request for a DOUBLEBUF HWSURFACE display
568 /* init flags and cursor */
569 flags = SDL_ANYFORMAT | SDL_HWPALETTE;
571 if( p_vout->p_sys->b_fullscreen )
572 flags |= SDL_FULLSCREEN;
574 flags |= SDL_RESIZABLE;
576 if( p_vout->b_need_render )
577 flags |= SDL_HWSURFACE | SDL_DOUBLEBUF;
579 flags |= SDL_SWSURFACE; /* save video memory */
581 bpp = SDL_VideoModeOK(p_vout->p_sys->i_width,
582 p_vout->p_sys->i_height,
583 p_vout->i_screen_depth, flags);
587 intf_ErrMsg( "error: can't open DISPLAY default display" );
591 p_vout->p_sys->p_display = SDL_SetVideoMode(p_vout->p_sys->i_width,
592 p_vout->p_sys->i_height,
595 if( p_vout->p_sys->p_display == NULL )
597 intf_ErrMsg( "error: can't open DISPLAY default display" );
601 SDL_LockSurface(p_vout->p_sys->p_display);
603 if( p_vout->p_sys->b_fullscreen )
608 SDL_WM_SetCaption( VOUT_TITLE , VOUT_TITLE );
609 SDL_EventState(SDL_KEYUP , SDL_IGNORE); /* ignore keys up */
610 SDL_EventState(SDL_MOUSEBUTTONUP, SDL_IGNORE);
612 if( p_vout->b_need_render )
614 p_vout->p_sys->p_sdl_buf[ 0 ] = p_vout->p_sys->p_display->pixels;
615 SDL_Flip(p_vout->p_sys->p_display);
616 p_vout->p_sys->p_sdl_buf[ 1 ] = p_vout->p_sys->p_display->pixels;
617 SDL_Flip(p_vout->p_sys->p_display);
619 /* Set clipping for text */
622 clipping_rect.w = p_vout->p_sys->p_display->w;
623 clipping_rect.h = p_vout->p_sys->p_display->h;
624 SDL_SetClipRect(p_vout->p_sys->p_display, &clipping_rect);
626 /* Set thread information */
627 p_vout->i_width = p_vout->p_sys->p_display->w;
628 p_vout->i_height = p_vout->p_sys->p_display->h;
629 p_vout->i_bytes_per_line = p_vout->p_sys->p_display->pitch;
631 p_vout->i_screen_depth =
632 p_vout->p_sys->p_display->format->BitsPerPixel;
633 p_vout->i_bytes_per_pixel =
634 p_vout->p_sys->p_display->format->BytesPerPixel;
636 p_vout->i_red_mask = p_vout->p_sys->p_display->format->Rmask;
637 p_vout->i_green_mask = p_vout->p_sys->p_display->format->Gmask;
638 p_vout->i_blue_mask = p_vout->p_sys->p_display->format->Bmask;
640 /* FIXME: palette in 8bpp ?? */
641 /* Set and initialize buffers */
642 vout_SetBuffers( p_vout, p_vout->p_sys->p_sdl_buf[ 0 ],
643 p_vout->p_sys->p_sdl_buf[ 1 ] );
647 p_vout->p_sys->p_sdl_buf[ 0 ] = p_vout->p_sys->p_display->pixels;
648 p_vout->p_sys->p_sdl_buf[ 1 ] = p_vout->p_sys->p_display->pixels;
650 /* Set thread information */
651 p_vout->i_width = p_vout->p_sys->p_display->w;
652 p_vout->i_height = p_vout->p_sys->p_display->h;
653 p_vout->i_bytes_per_line = p_vout->p_sys->p_display->pitch;
655 vout_SetBuffers( p_vout, p_vout->p_sys->p_sdl_buf[ 0 ],
656 p_vout->p_sys->p_sdl_buf[ 1 ] );
659 p_vout->p_sys->b_reopen_display = 0;
664 /*****************************************************************************
665 * SDLCloseDisplay: close and reset SDL device
666 *****************************************************************************
667 * This function returns all resources allocated by SDLOpenDisplay and restore
668 * the original state of the device.
669 *****************************************************************************/
670 static void SDLCloseDisplay( vout_thread_t *p_vout )
672 if( p_vout->p_sys->p_display != NULL )
674 if( p_vout->p_sys->p_overlay != NULL )
676 SDL_FreeYUVOverlay( p_vout->p_sys->p_overlay );
677 p_vout->p_sys->p_overlay = NULL;
680 SDL_UnlockSurface ( p_vout->p_sys->p_display );
681 SDL_FreeSurface( p_vout->p_sys->p_display );
682 p_vout->p_sys->p_display = NULL;