1 /*****************************************************************************
2 * vout_sdl.c: SDL video output display method
3 *****************************************************************************
4 * Copyright (C) 1998, 1999, 2000 VideoLAN
5 * $Id: vout_sdl.c,v 1.54 2001/05/31 03:23:24 sam Exp $
7 * Authors: Samuel Hocevar <sam@zoy.org>
8 * Pierre Baillet <oct@zoy.org>
9 * Arnaud de Bossoreille de Ribou <bozo@via.ecp.fr>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
24 *****************************************************************************/
26 #define MODULE_NAME sdl
27 #include "modules_inner.h"
29 /*****************************************************************************
31 *****************************************************************************/
34 #include <errno.h> /* ENOMEM */
35 #include <stdlib.h> /* free() */
36 #include <string.h> /* strerror() */
39 #include <netinet/in.h> /* BSD: struct in_addr */
51 #include "video_output.h"
54 #include "interface.h"
55 /* FIXME: get rid of this */
56 #include "keystrokes.h"
61 #include "modules_export.h"
63 /*****************************************************************************
64 * FIXME: this file is ... *
66 * XXX XXX FIXME XXX XXX XXX XXX *
67 * XXX XXX XXX XXX XXX XXX XXX XXX *
68 * XXX XXX XXX XXX FIXME XXX *
69 * XXX XXX XXX TODO XXX XXX XXX *
70 * XXX XXX XXX XXX XXX XXX *
71 * FIXME FIXME FIXME XXX XXX *
73 *****************************************************************************/
75 /*****************************************************************************
76 * vout_sys_t: video output SDL method descriptor
77 *****************************************************************************
78 * This structure is part of the video output thread descriptor.
79 * It describes the SDL specific properties of an output thread.
80 *****************************************************************************/
81 typedef struct vout_sys_s
86 SDL_Surface * p_display; /* display device */
87 SDL_Overlay * p_overlay; /* overlay device */
91 boolean_t b_reopen_display;
93 boolean_t b_cursor_autohidden;
96 Uint8 * p_sdl_buf[2]; /* Buffer information */
100 /*****************************************************************************
102 *****************************************************************************/
103 static int vout_Probe ( probedata_t *p_data );
104 static int vout_Create ( struct vout_thread_s * );
105 static int vout_Init ( struct vout_thread_s * );
106 static void vout_End ( struct vout_thread_s * );
107 static void vout_Destroy ( struct vout_thread_s * );
108 static int vout_Manage ( struct vout_thread_s * );
109 static void vout_Display ( struct vout_thread_s * );
110 static void vout_SetPalette( p_vout_thread_t p_vout, u16 *red, u16 *green,
111 u16 *blue, u16 *transp );
113 static int SDLOpenDisplay ( vout_thread_t *p_vout );
114 static void SDLCloseDisplay ( vout_thread_t *p_vout );
116 /*****************************************************************************
117 * Functions exported as capabilities. They are declared as static so that
118 * we don't pollute the namespace too much.
119 *****************************************************************************/
120 void _M( vout_getfunctions )( function_list_t * p_function_list )
122 p_function_list->pf_probe = vout_Probe;
123 p_function_list->functions.vout.pf_create = vout_Create;
124 p_function_list->functions.vout.pf_init = vout_Init;
125 p_function_list->functions.vout.pf_end = vout_End;
126 p_function_list->functions.vout.pf_destroy = vout_Destroy;
127 p_function_list->functions.vout.pf_manage = vout_Manage;
128 p_function_list->functions.vout.pf_display = vout_Display;
129 p_function_list->functions.vout.pf_setpalette = vout_SetPalette;
132 /*****************************************************************************
133 * vout_Probe: probe the video driver and return a score
134 *****************************************************************************
135 * This function tries to initialize SDL and returns a score to the
136 * plugin manager so that it can select the best plugin.
137 *****************************************************************************/
138 static int vout_Probe( probedata_t *p_data )
140 if( TestMethod( VOUT_METHOD_VAR, "sdl" ) )
148 /*****************************************************************************
149 * vout_Create: allocate SDL video thread output method
150 *****************************************************************************
151 * This function allocate and initialize a SDL vout method. It uses some of the
152 * vout properties to choose the correct mode, and change them according to the
153 * mode actually used.
154 *****************************************************************************/
155 static int vout_Create( vout_thread_t *p_vout )
157 /* Allocate structure */
158 p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
159 if( p_vout->p_sys == NULL )
161 intf_ErrMsg( "vout error: can't create p_sys (%s)", strerror(ENOMEM) );
165 /* Initialize library */
166 if( SDL_Init( SDL_INIT_VIDEO
168 /* Win32 SDL implementation doesn't support SDL_INIT_EVENTTHREAD yet*/
169 | SDL_INIT_EVENTTHREAD
171 | SDL_INIT_NOPARACHUTE ) < 0 )
173 intf_ErrMsg( "vout error: can't initialize SDL (%s)", SDL_GetError() );
174 free( p_vout->p_sys );
178 p_vout->p_sys->b_cursor = 1; /* TODO should be done with a main_GetInt.. */
180 p_vout->p_sys->b_cursor_autohidden = 0;
181 p_vout->p_sys->i_lastmoved = mdate();
183 p_vout->b_fullscreen = main_GetIntVariable( VOUT_FULLSCREEN_VAR,
184 VOUT_FULLSCREEN_DEFAULT );
185 p_vout->p_sys->b_overlay = main_GetIntVariable( VOUT_OVERLAY_VAR,
186 VOUT_OVERLAY_DEFAULT );
187 p_vout->p_sys->i_width = main_GetIntVariable( VOUT_WIDTH_VAR,
188 VOUT_WIDTH_DEFAULT );
189 p_vout->p_sys->i_height = main_GetIntVariable( VOUT_HEIGHT_VAR,
190 VOUT_HEIGHT_DEFAULT );
192 p_vout->p_sys->p_display = NULL;
193 p_vout->p_sys->p_overlay = NULL;
195 if( SDLOpenDisplay(p_vout) )
197 intf_ErrMsg( "vout error: can't set up SDL (%s)", SDL_GetError() );
198 free( p_vout->p_sys );
202 /* FIXME: get rid of this ASAP, it's FUCKING UGLY */
203 { intf_thread_t * p_intf = p_main->p_intf;
204 intf_AssignKey(p_intf, SDLK_q, INTF_KEY_QUIT, 0);
205 intf_AssignKey(p_intf, SDLK_ESCAPE, INTF_KEY_QUIT, 0);
206 /* intf_AssignKey(p_intf,3,'Q'); */
207 intf_AssignKey(p_intf, SDLK_0, INTF_KEY_SET_CHANNEL,0);
208 intf_AssignKey(p_intf, SDLK_1, INTF_KEY_SET_CHANNEL,1);
209 intf_AssignKey(p_intf, SDLK_2, INTF_KEY_SET_CHANNEL,2);
210 intf_AssignKey(p_intf, SDLK_3, INTF_KEY_SET_CHANNEL,3);
211 intf_AssignKey(p_intf, SDLK_4, INTF_KEY_SET_CHANNEL,4);
212 intf_AssignKey(p_intf, SDLK_5, INTF_KEY_SET_CHANNEL,5);
213 intf_AssignKey(p_intf, SDLK_6, INTF_KEY_SET_CHANNEL,6);
214 intf_AssignKey(p_intf, SDLK_7, INTF_KEY_SET_CHANNEL,7);
215 intf_AssignKey(p_intf, SDLK_8, INTF_KEY_SET_CHANNEL,8);
216 intf_AssignKey(p_intf, SDLK_9, INTF_KEY_SET_CHANNEL,9);
217 intf_AssignKey(p_intf, SDLK_PLUS, INTF_KEY_INC_VOLUME, 0);
218 intf_AssignKey(p_intf, SDLK_MINUS, INTF_KEY_DEC_VOLUME, 0);
219 intf_AssignKey(p_intf, SDLK_m, INTF_KEY_TOGGLE_VOLUME, 0);
220 /* intf_AssignKey(p_intf,'M','M'); */
221 intf_AssignKey(p_intf, SDLK_g, INTF_KEY_DEC_GAMMA, 0);
222 /* intf_AssignKey(p_intf,'G','G'); */
223 intf_AssignKey(p_intf, SDLK_c, INTF_KEY_TOGGLE_GRAYSCALE, 0);
224 intf_AssignKey(p_intf, SDLK_SPACE, INTF_KEY_TOGGLE_INTERFACE, 0);
225 intf_AssignKey(p_intf, SDLK_i, INTF_KEY_TOGGLE_INFO, 0);
226 intf_AssignKey(p_intf, SDLK_s, INTF_KEY_TOGGLE_SCALING, 0);
227 intf_AssignKey(p_intf, SDLK_d, INTF_KEY_DUMP_STREAM, 0); }
232 /*****************************************************************************
233 * vout_Init: initialize SDL video thread output method
234 *****************************************************************************
235 * This function initialize the SDL display device.
236 *****************************************************************************/
237 static int vout_Init( vout_thread_t *p_vout )
239 /* This hack is hugly, but hey, you are, too. */
241 SDL_Overlay * p_overlay;
243 p_overlay = SDL_CreateYUVOverlay(
244 main_GetIntVariable( VOUT_WIDTH_VAR,VOUT_WIDTH_DEFAULT ),
245 main_GetIntVariable( VOUT_HEIGHT_VAR,VOUT_HEIGHT_DEFAULT ),
247 p_vout->p_sys->p_display );
248 intf_WarnMsg( 2, "vout: YUV acceleration %s",
249 p_overlay->hw_overlay ? "activated" : "unavailable !" );
250 p_vout->b_need_render = !p_overlay->hw_overlay;
252 SDL_FreeYUVOverlay( p_overlay );
257 /*****************************************************************************
258 * vout_End: terminate Sys video thread output method
259 *****************************************************************************
260 * Terminate an output method created by vout_SDLCreate
261 *****************************************************************************/
262 static void vout_End( vout_thread_t *p_vout )
264 SDLCloseDisplay( p_vout );
265 SDL_QuitSubSystem( SDL_INIT_VIDEO );
268 /*****************************************************************************
269 * vout_Destroy: destroy Sys video thread output method
270 *****************************************************************************
271 * Terminate an output method created by vout_SDLCreate
272 *****************************************************************************/
273 static void vout_Destroy( vout_thread_t *p_vout )
275 free( p_vout->p_sys );
278 /*****************************************************************************
279 * vout_Manage: handle Sys events
280 *****************************************************************************
281 * This function should be called regularly by video output thread. It returns
282 * a non null value if an error occured.
283 *****************************************************************************/
284 static int vout_Manage( vout_thread_t *p_vout )
286 SDL_Event event; /* SDL event */
290 while( SDL_PollEvent(&event) )
294 case SDL_VIDEORESIZE: /* Resizing of window */
295 p_vout->i_width = event.resize.w;
296 p_vout->i_height = event.resize.h;
297 p_vout->i_changes |= VOUT_SIZE_CHANGE;
300 case SDL_MOUSEMOTION:
301 if( p_vout->p_sys->b_cursor &&
302 (abs(event.motion.xrel) > 2 || abs(event.motion.yrel) > 2) )
304 if( p_vout->p_sys->b_cursor_autohidden )
306 p_vout->p_sys->b_cursor_autohidden = 0;
311 p_vout->p_sys->i_lastmoved = mdate();
316 case SDL_MOUSEBUTTONUP:
317 switch( event.button.button )
319 case SDL_BUTTON_RIGHT:
320 p_main->p_intf->b_menu_change = 1;
325 case SDL_MOUSEBUTTONDOWN:
326 switch( event.button.button )
328 case SDL_BUTTON_MIDDLE:
329 p_vout->i_changes |= VOUT_CURSOR_CHANGE;
335 intf_ProcessKey( p_main->p_intf, SDLK_q );
338 case SDL_KEYDOWN: /* if a key is pressed */
340 switch( event.key.keysym.sym )
342 case SDLK_f: /* switch to fullscreen */
343 p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
346 case SDLK_y: /* switch to hard YUV */
347 p_vout->i_changes |= VOUT_YUV_CHANGE;
350 case SDLK_c: /* toggle grayscale */
351 p_vout->b_grayscale = ! p_vout->b_grayscale;
352 p_vout->i_changes |= VOUT_GRAYSCALE_CHANGE;
355 case SDLK_i: /* toggle info */
356 p_vout->b_info = ! p_vout->b_info;
357 p_vout->i_changes |= VOUT_INFO_CHANGE;
360 case SDLK_s: /* toggle scaling */
361 p_vout->b_scale = ! p_vout->b_scale;
362 p_vout->i_changes |= VOUT_SCALE_CHANGE;
365 case SDLK_SPACE: /* toggle interface */
366 p_vout->b_interface = ! p_vout->b_interface;
367 p_vout->i_changes |= VOUT_INTF_CHANGE;
371 network_ChannelJoin( 0 );
374 network_ChannelJoin( 1 );
377 network_ChannelJoin( 2 );
380 network_ChannelJoin( 3 );
383 network_ChannelJoin( 4 );
386 network_ChannelJoin( 5 );
389 network_ChannelJoin( 6 );
392 network_ChannelJoin( 7 );
395 network_ChannelJoin( 8 );
398 network_ChannelJoin( 9 );
402 p_main->p_intf->b_menu_change = 1;
406 p_key = SDL_GetKeyName( event.key.keysym.sym ) ;
407 if( intf_ProcessKey( p_main->p_intf,
408 (char )event.key.keysym.sym ) )
410 intf_DbgMsg( "unhandled key '%c' (%i)",
411 (char)event.key.keysym.sym,
412 event.key.keysym.sym );
426 if( p_vout->i_changes & VOUT_SIZE_CHANGE )
428 p_vout->p_sys->i_width = p_vout->i_width;
429 p_vout->p_sys->i_height = p_vout->i_height;
431 /* Need to reopen display */
432 SDLCloseDisplay( p_vout );
433 if( SDLOpenDisplay( p_vout ) )
435 intf_ErrMsg( "vout error: can't reopen display after resize" );
438 p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
444 if( p_vout->i_changes & VOUT_YUV_CHANGE )
446 p_vout->b_need_render = ! p_vout->b_need_render;
448 /* Need to reopen display */
449 SDLCloseDisplay( p_vout );
450 if( SDLOpenDisplay( p_vout ) )
452 intf_ErrMsg( "error: can't reopen display after YUV change" );
455 p_vout->i_changes &= ~VOUT_YUV_CHANGE;
461 if( p_vout->i_changes & VOUT_FULLSCREEN_CHANGE )
463 p_vout->b_fullscreen = ! p_vout->b_fullscreen;
465 SDL_WM_ToggleFullScreen(p_vout->p_sys->p_display);
467 p_vout->p_sys->b_cursor_autohidden = 0;
468 SDL_ShowCursor( p_vout->p_sys->b_cursor &&
469 ! p_vout->p_sys->b_cursor_autohidden );
471 p_vout->i_changes &= ~VOUT_FULLSCREEN_CHANGE;
477 if( ! p_vout->p_sys->b_cursor_autohidden &&
478 ( mdate() - p_vout->p_sys->i_lastmoved > 2000000 ) )
480 /* Hide the mouse automatically */
481 p_vout->p_sys->b_cursor_autohidden = 1;
485 if( p_vout->i_changes & VOUT_CURSOR_CHANGE )
487 p_vout->p_sys->b_cursor = ! p_vout->p_sys->b_cursor;
489 SDL_ShowCursor( p_vout->p_sys->b_cursor &&
490 ! p_vout->p_sys->b_cursor_autohidden );
492 p_vout->i_changes &= ~VOUT_CURSOR_CHANGE;
498 /*****************************************************************************
499 * vout_SetPalette: sets an 8 bpp palette
500 *****************************************************************************
501 * This function sets the palette given as an argument. It does not return
502 * anything, but could later send information on which colors it was unable
504 *****************************************************************************/
505 static void vout_SetPalette( p_vout_thread_t p_vout, u16 *red, u16 *green,
506 u16 *blue, u16 *transp)
508 /* Create a display surface with a grayscale palette */
509 SDL_Color colors[256];
512 /* Fill colors with color information */
513 for( i = 0; i < 256; i++ )
515 colors[ i ].r = red[ i ] >> 8;
516 colors[ i ].g = green[ i ] >> 8;
517 colors[ i ].b = blue[ i ] >> 8;
521 if( SDL_SetColors( p_vout->p_sys->p_display, colors, 0, 256 ) == 0 )
523 intf_ErrMsg( "vout error: failed setting palette" );
528 /*****************************************************************************
529 * vout_Display: displays previously rendered output
530 *****************************************************************************
531 * This function send the currently rendered image to the display, wait until
532 * it is displayed and switch the two rendering buffer, preparing next frame.
533 *****************************************************************************/
534 static void vout_Display( vout_thread_t *p_vout )
537 if((p_vout->p_sys->p_display != NULL) && !p_vout->p_sys->b_reopen_display)
539 if( p_vout->b_need_render )
541 /* Change display frame */
542 SDL_Flip( p_vout->p_sys->p_display );
547 * p_vout->p_rendered_pic->p_y/u/v contains the YUV buffers to
550 /* TODO: support for streams other than 4:2:0 */
551 /* create the overlay if necessary */
552 if( p_vout->p_sys->p_overlay == NULL )
554 p_vout->p_sys->p_overlay = SDL_CreateYUVOverlay(
555 p_vout->p_rendered_pic->i_width,
556 p_vout->p_rendered_pic->i_height,
558 p_vout->p_sys->p_display
560 intf_WarnMsg( 2, "vout: YUV acceleration %s",
561 p_vout->p_sys->p_overlay->hw_overlay
562 ? "activated" : "unavailable !" );
565 SDL_LockYUVOverlay(p_vout->p_sys->p_overlay);
566 /* copy the data into video buffers */
568 memcpy(p_vout->p_sys->p_overlay->pixels[0],
569 p_vout->p_rendered_pic->p_y,
570 p_vout->p_sys->p_overlay->h *
571 p_vout->p_sys->p_overlay->pitches[0]);
573 memcpy(p_vout->p_sys->p_overlay->pixels[1],
574 p_vout->p_rendered_pic->p_v,
575 p_vout->p_sys->p_overlay->h *
576 p_vout->p_sys->p_overlay->pitches[1] / 2);
578 memcpy(p_vout->p_sys->p_overlay->pixels[2],
579 p_vout->p_rendered_pic->p_u,
580 p_vout->p_sys->p_overlay->h *
581 p_vout->p_sys->p_overlay->pitches[2] / 2);
583 disp.w = (&p_vout->p_buffer[p_vout->i_buffer_index])->i_pic_width;
584 disp.h = (&p_vout->p_buffer[p_vout->i_buffer_index])->i_pic_height;
585 disp.x = (p_vout->i_width - disp.w)/2;
586 disp.y = (p_vout->i_height - disp.h)/2;
588 SDL_DisplayYUVOverlay( p_vout->p_sys->p_overlay , &disp );
589 SDL_UnlockYUVOverlay(p_vout->p_sys->p_overlay);
594 /* following functions are local */
596 /*****************************************************************************
597 * SDLOpenDisplay: open and initialize SDL device
598 *****************************************************************************
599 * Open and initialize display according to preferences specified in the vout
601 *****************************************************************************/
602 static int SDLOpenDisplay( vout_thread_t *p_vout )
604 SDL_Rect clipping_rect;
608 * TODO: Check that we can request for a DOUBLEBUF HWSURFACE display
611 /* init flags and cursor */
612 flags = SDL_ANYFORMAT | SDL_HWPALETTE;
614 if( p_vout->b_fullscreen )
616 flags |= SDL_FULLSCREEN;
620 flags |= SDL_RESIZABLE;
623 if( p_vout->b_need_render )
625 flags |= SDL_HWSURFACE | SDL_DOUBLEBUF;
629 flags |= SDL_SWSURFACE; /* save video memory */
632 bpp = SDL_VideoModeOK( p_vout->p_sys->i_width,
633 p_vout->p_sys->i_height,
634 p_vout->i_screen_depth, flags );
638 intf_ErrMsg( "vout error: no video mode available" );
642 p_vout->p_sys->p_display = SDL_SetVideoMode(p_vout->p_sys->i_width,
643 p_vout->p_sys->i_height,
646 if( p_vout->p_sys->p_display == NULL )
648 intf_ErrMsg( "vout error: cannot set video mode" );
652 SDL_LockSurface( p_vout->p_sys->p_display );
654 SDL_WM_SetCaption( VOUT_TITLE " (SDL output)",
655 VOUT_TITLE " (SDL output)" );
656 SDL_EventState(SDL_KEYUP , SDL_IGNORE); /* ignore keys up */
658 if( p_vout->b_need_render )
660 p_vout->p_sys->p_sdl_buf[ 0 ] = p_vout->p_sys->p_display->pixels;
661 SDL_Flip(p_vout->p_sys->p_display);
662 p_vout->p_sys->p_sdl_buf[ 1 ] = p_vout->p_sys->p_display->pixels;
663 SDL_Flip(p_vout->p_sys->p_display);
665 /* Set clipping for text */
668 clipping_rect.w = p_vout->p_sys->p_display->w;
669 clipping_rect.h = p_vout->p_sys->p_display->h;
670 SDL_SetClipRect(p_vout->p_sys->p_display, &clipping_rect);
672 /* Set thread information */
673 p_vout->i_width = p_vout->p_sys->p_display->w;
674 p_vout->i_height = p_vout->p_sys->p_display->h;
675 p_vout->i_bytes_per_line = p_vout->p_sys->p_display->pitch;
677 p_vout->i_screen_depth =
678 p_vout->p_sys->p_display->format->BitsPerPixel;
679 p_vout->i_bytes_per_pixel =
680 p_vout->p_sys->p_display->format->BytesPerPixel;
682 p_vout->i_red_mask = p_vout->p_sys->p_display->format->Rmask;
683 p_vout->i_green_mask = p_vout->p_sys->p_display->format->Gmask;
684 p_vout->i_blue_mask = p_vout->p_sys->p_display->format->Bmask;
686 /* FIXME: palette in 8bpp ?? */
687 /* Set and initialize buffers */
688 p_vout->pf_setbuffers( p_vout, p_vout->p_sys->p_sdl_buf[ 0 ],
689 p_vout->p_sys->p_sdl_buf[ 1 ] );
693 p_vout->p_sys->p_sdl_buf[ 0 ] = p_vout->p_sys->p_display->pixels;
694 p_vout->p_sys->p_sdl_buf[ 1 ] = p_vout->p_sys->p_display->pixels;
696 /* Set thread information */
697 p_vout->i_width = p_vout->p_sys->p_display->w;
698 p_vout->i_height = p_vout->p_sys->p_display->h;
699 p_vout->i_bytes_per_line = p_vout->p_sys->p_display->pitch;
701 p_vout->pf_setbuffers( p_vout, p_vout->p_sys->p_sdl_buf[ 0 ],
702 p_vout->p_sys->p_sdl_buf[ 1 ] );
705 p_vout->p_sys->b_reopen_display = 0;
710 /*****************************************************************************
711 * SDLCloseDisplay: close and reset SDL device
712 *****************************************************************************
713 * This function returns all resources allocated by SDLOpenDisplay and restore
714 * the original state of the device.
715 *****************************************************************************/
716 static void SDLCloseDisplay( vout_thread_t *p_vout )
718 if( p_vout->p_sys->p_display != NULL )
720 if( p_vout->p_sys->p_overlay != NULL )
722 SDL_FreeYUVOverlay( p_vout->p_sys->p_overlay );
723 p_vout->p_sys->p_overlay = NULL;
726 SDL_UnlockSurface ( p_vout->p_sys->p_display );
727 SDL_FreeSurface( p_vout->p_sys->p_display );
728 p_vout->p_sys->p_display = NULL;