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.55 2001/06/07 22:14:56 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() */
38 #include <sys/types.h>
40 # include <netinet/in.h> /* BSD: struct in_addr */
52 #include "video_output.h"
55 #include "interface.h"
56 /* FIXME: get rid of this */
57 #include "keystrokes.h"
62 #include "modules_export.h"
64 /*****************************************************************************
65 * FIXME: this file is ... *
67 * XXX XXX FIXME XXX XXX XXX XXX *
68 * XXX XXX XXX XXX XXX XXX XXX XXX *
69 * XXX XXX XXX XXX FIXME XXX *
70 * XXX XXX XXX TODO XXX XXX XXX *
71 * XXX XXX XXX XXX XXX XXX *
72 * FIXME FIXME FIXME XXX XXX *
74 *****************************************************************************/
76 /*****************************************************************************
77 * vout_sys_t: video output SDL method descriptor
78 *****************************************************************************
79 * This structure is part of the video output thread descriptor.
80 * It describes the SDL specific properties of an output thread.
81 *****************************************************************************/
82 typedef struct vout_sys_s
87 SDL_Surface * p_display; /* display device */
88 SDL_Overlay * p_overlay; /* overlay device */
92 boolean_t b_reopen_display;
94 boolean_t b_cursor_autohidden;
97 Uint8 * p_sdl_buf[2]; /* Buffer information */
101 /*****************************************************************************
103 *****************************************************************************/
104 static int vout_Probe ( probedata_t *p_data );
105 static int vout_Create ( struct vout_thread_s * );
106 static int vout_Init ( struct vout_thread_s * );
107 static void vout_End ( struct vout_thread_s * );
108 static void vout_Destroy ( struct vout_thread_s * );
109 static int vout_Manage ( struct vout_thread_s * );
110 static void vout_Display ( struct vout_thread_s * );
111 static void vout_SetPalette( p_vout_thread_t p_vout, u16 *red, u16 *green,
112 u16 *blue, u16 *transp );
114 static int SDLOpenDisplay ( vout_thread_t *p_vout );
115 static void SDLCloseDisplay ( vout_thread_t *p_vout );
117 /*****************************************************************************
118 * Functions exported as capabilities. They are declared as static so that
119 * we don't pollute the namespace too much.
120 *****************************************************************************/
121 void _M( vout_getfunctions )( function_list_t * p_function_list )
123 p_function_list->pf_probe = vout_Probe;
124 p_function_list->functions.vout.pf_create = vout_Create;
125 p_function_list->functions.vout.pf_init = vout_Init;
126 p_function_list->functions.vout.pf_end = vout_End;
127 p_function_list->functions.vout.pf_destroy = vout_Destroy;
128 p_function_list->functions.vout.pf_manage = vout_Manage;
129 p_function_list->functions.vout.pf_display = vout_Display;
130 p_function_list->functions.vout.pf_setpalette = vout_SetPalette;
133 /*****************************************************************************
134 * vout_Probe: probe the video driver and return a score
135 *****************************************************************************
136 * This function tries to initialize SDL and returns a score to the
137 * plugin manager so that it can select the best plugin.
138 *****************************************************************************/
139 static int vout_Probe( probedata_t *p_data )
141 if( TestMethod( VOUT_METHOD_VAR, "sdl" ) )
149 /*****************************************************************************
150 * vout_Create: allocate SDL video thread output method
151 *****************************************************************************
152 * This function allocate and initialize a SDL vout method. It uses some of the
153 * vout properties to choose the correct mode, and change them according to the
154 * mode actually used.
155 *****************************************************************************/
156 static int vout_Create( vout_thread_t *p_vout )
158 /* Allocate structure */
159 p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
160 if( p_vout->p_sys == NULL )
162 intf_ErrMsg( "vout error: can't create p_sys (%s)", strerror(ENOMEM) );
166 /* Initialize library */
167 if( SDL_Init( SDL_INIT_VIDEO
169 /* Win32 SDL implementation doesn't support SDL_INIT_EVENTTHREAD yet*/
170 | SDL_INIT_EVENTTHREAD
172 | SDL_INIT_NOPARACHUTE ) < 0 )
174 intf_ErrMsg( "vout error: can't initialize SDL (%s)", SDL_GetError() );
175 free( p_vout->p_sys );
179 p_vout->p_sys->b_cursor = 1; /* TODO should be done with a main_GetInt.. */
181 p_vout->p_sys->b_cursor_autohidden = 0;
182 p_vout->p_sys->i_lastmoved = mdate();
184 p_vout->b_fullscreen = main_GetIntVariable( VOUT_FULLSCREEN_VAR,
185 VOUT_FULLSCREEN_DEFAULT );
186 p_vout->p_sys->b_overlay = main_GetIntVariable( VOUT_OVERLAY_VAR,
187 VOUT_OVERLAY_DEFAULT );
188 p_vout->p_sys->i_width = main_GetIntVariable( VOUT_WIDTH_VAR,
189 VOUT_WIDTH_DEFAULT );
190 p_vout->p_sys->i_height = main_GetIntVariable( VOUT_HEIGHT_VAR,
191 VOUT_HEIGHT_DEFAULT );
193 p_vout->p_sys->p_display = NULL;
194 p_vout->p_sys->p_overlay = NULL;
196 if( SDLOpenDisplay(p_vout) )
198 intf_ErrMsg( "vout error: can't set up SDL (%s)", SDL_GetError() );
199 free( p_vout->p_sys );
203 /* FIXME: get rid of this ASAP, it's FUCKING UGLY */
204 { intf_thread_t * p_intf = p_main->p_intf;
205 intf_AssignKey(p_intf, SDLK_q, INTF_KEY_QUIT, 0);
206 intf_AssignKey(p_intf, SDLK_ESCAPE, INTF_KEY_QUIT, 0);
207 /* intf_AssignKey(p_intf,3,'Q'); */
208 intf_AssignKey(p_intf, SDLK_0, INTF_KEY_SET_CHANNEL,0);
209 intf_AssignKey(p_intf, SDLK_1, INTF_KEY_SET_CHANNEL,1);
210 intf_AssignKey(p_intf, SDLK_2, INTF_KEY_SET_CHANNEL,2);
211 intf_AssignKey(p_intf, SDLK_3, INTF_KEY_SET_CHANNEL,3);
212 intf_AssignKey(p_intf, SDLK_4, INTF_KEY_SET_CHANNEL,4);
213 intf_AssignKey(p_intf, SDLK_5, INTF_KEY_SET_CHANNEL,5);
214 intf_AssignKey(p_intf, SDLK_6, INTF_KEY_SET_CHANNEL,6);
215 intf_AssignKey(p_intf, SDLK_7, INTF_KEY_SET_CHANNEL,7);
216 intf_AssignKey(p_intf, SDLK_8, INTF_KEY_SET_CHANNEL,8);
217 intf_AssignKey(p_intf, SDLK_9, INTF_KEY_SET_CHANNEL,9);
218 intf_AssignKey(p_intf, SDLK_PLUS, INTF_KEY_INC_VOLUME, 0);
219 intf_AssignKey(p_intf, SDLK_MINUS, INTF_KEY_DEC_VOLUME, 0);
220 intf_AssignKey(p_intf, SDLK_m, INTF_KEY_TOGGLE_VOLUME, 0);
221 /* intf_AssignKey(p_intf,'M','M'); */
222 intf_AssignKey(p_intf, SDLK_g, INTF_KEY_DEC_GAMMA, 0);
223 /* intf_AssignKey(p_intf,'G','G'); */
224 intf_AssignKey(p_intf, SDLK_c, INTF_KEY_TOGGLE_GRAYSCALE, 0);
225 intf_AssignKey(p_intf, SDLK_SPACE, INTF_KEY_TOGGLE_INTERFACE, 0);
226 intf_AssignKey(p_intf, SDLK_i, INTF_KEY_TOGGLE_INFO, 0);
227 intf_AssignKey(p_intf, SDLK_s, INTF_KEY_TOGGLE_SCALING, 0);
228 intf_AssignKey(p_intf, SDLK_d, INTF_KEY_DUMP_STREAM, 0); }
233 /*****************************************************************************
234 * vout_Init: initialize SDL video thread output method
235 *****************************************************************************
236 * This function initialize the SDL display device.
237 *****************************************************************************/
238 static int vout_Init( vout_thread_t *p_vout )
240 /* This hack is hugly, but hey, you are, too. */
242 SDL_Overlay * p_overlay;
244 p_overlay = SDL_CreateYUVOverlay(
245 main_GetIntVariable( VOUT_WIDTH_VAR,VOUT_WIDTH_DEFAULT ),
246 main_GetIntVariable( VOUT_HEIGHT_VAR,VOUT_HEIGHT_DEFAULT ),
248 p_vout->p_sys->p_display );
249 intf_WarnMsg( 2, "vout: YUV acceleration %s",
250 p_overlay->hw_overlay ? "activated" : "unavailable !" );
251 p_vout->b_need_render = !p_overlay->hw_overlay;
253 SDL_FreeYUVOverlay( p_overlay );
258 /*****************************************************************************
259 * vout_End: terminate Sys video thread output method
260 *****************************************************************************
261 * Terminate an output method created by vout_SDLCreate
262 *****************************************************************************/
263 static void vout_End( vout_thread_t *p_vout )
265 SDLCloseDisplay( p_vout );
266 SDL_QuitSubSystem( SDL_INIT_VIDEO );
269 /*****************************************************************************
270 * vout_Destroy: destroy Sys video thread output method
271 *****************************************************************************
272 * Terminate an output method created by vout_SDLCreate
273 *****************************************************************************/
274 static void vout_Destroy( vout_thread_t *p_vout )
276 free( p_vout->p_sys );
279 /*****************************************************************************
280 * vout_Manage: handle Sys events
281 *****************************************************************************
282 * This function should be called regularly by video output thread. It returns
283 * a non null value if an error occured.
284 *****************************************************************************/
285 static int vout_Manage( vout_thread_t *p_vout )
287 SDL_Event event; /* SDL event */
291 while( SDL_PollEvent(&event) )
295 case SDL_VIDEORESIZE: /* Resizing of window */
296 p_vout->i_width = event.resize.w;
297 p_vout->i_height = event.resize.h;
298 p_vout->i_changes |= VOUT_SIZE_CHANGE;
301 case SDL_MOUSEMOTION:
302 if( p_vout->p_sys->b_cursor &&
303 (abs(event.motion.xrel) > 2 || abs(event.motion.yrel) > 2) )
305 if( p_vout->p_sys->b_cursor_autohidden )
307 p_vout->p_sys->b_cursor_autohidden = 0;
312 p_vout->p_sys->i_lastmoved = mdate();
317 case SDL_MOUSEBUTTONUP:
318 switch( event.button.button )
320 case SDL_BUTTON_RIGHT:
321 p_main->p_intf->b_menu_change = 1;
326 case SDL_MOUSEBUTTONDOWN:
327 switch( event.button.button )
329 case SDL_BUTTON_MIDDLE:
330 p_vout->i_changes |= VOUT_CURSOR_CHANGE;
336 intf_ProcessKey( p_main->p_intf, SDLK_q );
339 case SDL_KEYDOWN: /* if a key is pressed */
341 switch( event.key.keysym.sym )
343 case SDLK_f: /* switch to fullscreen */
344 p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
347 case SDLK_y: /* switch to hard YUV */
348 p_vout->i_changes |= VOUT_YUV_CHANGE;
351 case SDLK_c: /* toggle grayscale */
352 p_vout->b_grayscale = ! p_vout->b_grayscale;
353 p_vout->i_changes |= VOUT_GRAYSCALE_CHANGE;
356 case SDLK_i: /* toggle info */
357 p_vout->b_info = ! p_vout->b_info;
358 p_vout->i_changes |= VOUT_INFO_CHANGE;
361 case SDLK_s: /* toggle scaling */
362 p_vout->b_scale = ! p_vout->b_scale;
363 p_vout->i_changes |= VOUT_SCALE_CHANGE;
366 case SDLK_SPACE: /* toggle interface */
367 p_vout->b_interface = ! p_vout->b_interface;
368 p_vout->i_changes |= VOUT_INTF_CHANGE;
372 network_ChannelJoin( 0 );
375 network_ChannelJoin( 1 );
378 network_ChannelJoin( 2 );
381 network_ChannelJoin( 3 );
384 network_ChannelJoin( 4 );
387 network_ChannelJoin( 5 );
390 network_ChannelJoin( 6 );
393 network_ChannelJoin( 7 );
396 network_ChannelJoin( 8 );
399 network_ChannelJoin( 9 );
403 p_main->p_intf->b_menu_change = 1;
407 p_key = SDL_GetKeyName( event.key.keysym.sym ) ;
408 if( intf_ProcessKey( p_main->p_intf,
409 (char )event.key.keysym.sym ) )
411 intf_DbgMsg( "unhandled key '%c' (%i)",
412 (char)event.key.keysym.sym,
413 event.key.keysym.sym );
427 if( p_vout->i_changes & VOUT_SIZE_CHANGE )
429 p_vout->p_sys->i_width = p_vout->i_width;
430 p_vout->p_sys->i_height = p_vout->i_height;
432 /* Need to reopen display */
433 SDLCloseDisplay( p_vout );
434 if( SDLOpenDisplay( p_vout ) )
436 intf_ErrMsg( "vout error: can't reopen display after resize" );
439 p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
445 if( p_vout->i_changes & VOUT_YUV_CHANGE )
447 p_vout->b_need_render = ! p_vout->b_need_render;
449 /* Need to reopen display */
450 SDLCloseDisplay( p_vout );
451 if( SDLOpenDisplay( p_vout ) )
453 intf_ErrMsg( "error: can't reopen display after YUV change" );
456 p_vout->i_changes &= ~VOUT_YUV_CHANGE;
462 if( p_vout->i_changes & VOUT_FULLSCREEN_CHANGE )
464 p_vout->b_fullscreen = ! p_vout->b_fullscreen;
466 SDL_WM_ToggleFullScreen(p_vout->p_sys->p_display);
468 p_vout->p_sys->b_cursor_autohidden = 0;
469 SDL_ShowCursor( p_vout->p_sys->b_cursor &&
470 ! p_vout->p_sys->b_cursor_autohidden );
472 p_vout->i_changes &= ~VOUT_FULLSCREEN_CHANGE;
478 if( ! p_vout->p_sys->b_cursor_autohidden &&
479 ( mdate() - p_vout->p_sys->i_lastmoved > 2000000 ) )
481 /* Hide the mouse automatically */
482 p_vout->p_sys->b_cursor_autohidden = 1;
486 if( p_vout->i_changes & VOUT_CURSOR_CHANGE )
488 p_vout->p_sys->b_cursor = ! p_vout->p_sys->b_cursor;
490 SDL_ShowCursor( p_vout->p_sys->b_cursor &&
491 ! p_vout->p_sys->b_cursor_autohidden );
493 p_vout->i_changes &= ~VOUT_CURSOR_CHANGE;
499 /*****************************************************************************
500 * vout_SetPalette: sets an 8 bpp palette
501 *****************************************************************************
502 * This function sets the palette given as an argument. It does not return
503 * anything, but could later send information on which colors it was unable
505 *****************************************************************************/
506 static void vout_SetPalette( p_vout_thread_t p_vout, u16 *red, u16 *green,
507 u16 *blue, u16 *transp)
509 /* Create a display surface with a grayscale palette */
510 SDL_Color colors[256];
513 /* Fill colors with color information */
514 for( i = 0; i < 256; i++ )
516 colors[ i ].r = red[ i ] >> 8;
517 colors[ i ].g = green[ i ] >> 8;
518 colors[ i ].b = blue[ i ] >> 8;
522 if( SDL_SetColors( p_vout->p_sys->p_display, colors, 0, 256 ) == 0 )
524 intf_ErrMsg( "vout error: failed setting palette" );
529 /*****************************************************************************
530 * vout_Display: displays previously rendered output
531 *****************************************************************************
532 * This function send the currently rendered image to the display, wait until
533 * it is displayed and switch the two rendering buffer, preparing next frame.
534 *****************************************************************************/
535 static void vout_Display( vout_thread_t *p_vout )
538 if((p_vout->p_sys->p_display != NULL) && !p_vout->p_sys->b_reopen_display)
540 if( p_vout->b_need_render )
542 /* Change display frame */
543 SDL_Flip( p_vout->p_sys->p_display );
548 * p_vout->p_rendered_pic->p_y/u/v contains the YUV buffers to
551 /* TODO: support for streams other than 4:2:0 */
552 /* create the overlay if necessary */
553 if( p_vout->p_sys->p_overlay == NULL )
555 p_vout->p_sys->p_overlay = SDL_CreateYUVOverlay(
556 p_vout->p_rendered_pic->i_width,
557 p_vout->p_rendered_pic->i_height,
559 p_vout->p_sys->p_display
561 intf_WarnMsg( 2, "vout: YUV acceleration %s",
562 p_vout->p_sys->p_overlay->hw_overlay
563 ? "activated" : "unavailable !" );
566 SDL_LockYUVOverlay(p_vout->p_sys->p_overlay);
567 /* copy the data into video buffers */
569 memcpy(p_vout->p_sys->p_overlay->pixels[0],
570 p_vout->p_rendered_pic->p_y,
571 p_vout->p_sys->p_overlay->h *
572 p_vout->p_sys->p_overlay->pitches[0]);
574 memcpy(p_vout->p_sys->p_overlay->pixels[1],
575 p_vout->p_rendered_pic->p_v,
576 p_vout->p_sys->p_overlay->h *
577 p_vout->p_sys->p_overlay->pitches[1] / 2);
579 memcpy(p_vout->p_sys->p_overlay->pixels[2],
580 p_vout->p_rendered_pic->p_u,
581 p_vout->p_sys->p_overlay->h *
582 p_vout->p_sys->p_overlay->pitches[2] / 2);
584 disp.w = (&p_vout->p_buffer[p_vout->i_buffer_index])->i_pic_width;
585 disp.h = (&p_vout->p_buffer[p_vout->i_buffer_index])->i_pic_height;
586 disp.x = (p_vout->i_width - disp.w)/2;
587 disp.y = (p_vout->i_height - disp.h)/2;
589 SDL_DisplayYUVOverlay( p_vout->p_sys->p_overlay , &disp );
590 SDL_UnlockYUVOverlay(p_vout->p_sys->p_overlay);
595 /* following functions are local */
597 /*****************************************************************************
598 * SDLOpenDisplay: open and initialize SDL device
599 *****************************************************************************
600 * Open and initialize display according to preferences specified in the vout
602 *****************************************************************************/
603 static int SDLOpenDisplay( vout_thread_t *p_vout )
605 SDL_Rect clipping_rect;
609 * TODO: Check that we can request for a DOUBLEBUF HWSURFACE display
612 /* init flags and cursor */
613 flags = SDL_ANYFORMAT | SDL_HWPALETTE;
615 if( p_vout->b_fullscreen )
617 flags |= SDL_FULLSCREEN;
621 flags |= SDL_RESIZABLE;
624 if( p_vout->b_need_render )
626 flags |= SDL_HWSURFACE | SDL_DOUBLEBUF;
630 flags |= SDL_SWSURFACE; /* save video memory */
633 bpp = SDL_VideoModeOK( p_vout->p_sys->i_width,
634 p_vout->p_sys->i_height,
635 p_vout->i_screen_depth, flags );
639 intf_ErrMsg( "vout error: no video mode available" );
643 p_vout->p_sys->p_display = SDL_SetVideoMode(p_vout->p_sys->i_width,
644 p_vout->p_sys->i_height,
647 if( p_vout->p_sys->p_display == NULL )
649 intf_ErrMsg( "vout error: cannot set video mode" );
653 SDL_LockSurface( p_vout->p_sys->p_display );
655 SDL_WM_SetCaption( VOUT_TITLE " (SDL output)",
656 VOUT_TITLE " (SDL output)" );
657 SDL_EventState(SDL_KEYUP , SDL_IGNORE); /* ignore keys up */
659 if( p_vout->b_need_render )
661 p_vout->p_sys->p_sdl_buf[ 0 ] = p_vout->p_sys->p_display->pixels;
662 SDL_Flip(p_vout->p_sys->p_display);
663 p_vout->p_sys->p_sdl_buf[ 1 ] = p_vout->p_sys->p_display->pixels;
664 SDL_Flip(p_vout->p_sys->p_display);
666 /* Set clipping for text */
669 clipping_rect.w = p_vout->p_sys->p_display->w;
670 clipping_rect.h = p_vout->p_sys->p_display->h;
671 SDL_SetClipRect(p_vout->p_sys->p_display, &clipping_rect);
673 /* Set thread information */
674 p_vout->i_width = p_vout->p_sys->p_display->w;
675 p_vout->i_height = p_vout->p_sys->p_display->h;
676 p_vout->i_bytes_per_line = p_vout->p_sys->p_display->pitch;
678 p_vout->i_screen_depth =
679 p_vout->p_sys->p_display->format->BitsPerPixel;
680 p_vout->i_bytes_per_pixel =
681 p_vout->p_sys->p_display->format->BytesPerPixel;
683 p_vout->i_red_mask = p_vout->p_sys->p_display->format->Rmask;
684 p_vout->i_green_mask = p_vout->p_sys->p_display->format->Gmask;
685 p_vout->i_blue_mask = p_vout->p_sys->p_display->format->Bmask;
687 /* FIXME: palette in 8bpp ?? */
688 /* Set and initialize buffers */
689 p_vout->pf_setbuffers( p_vout, p_vout->p_sys->p_sdl_buf[ 0 ],
690 p_vout->p_sys->p_sdl_buf[ 1 ] );
694 p_vout->p_sys->p_sdl_buf[ 0 ] = p_vout->p_sys->p_display->pixels;
695 p_vout->p_sys->p_sdl_buf[ 1 ] = p_vout->p_sys->p_display->pixels;
697 /* Set thread information */
698 p_vout->i_width = p_vout->p_sys->p_display->w;
699 p_vout->i_height = p_vout->p_sys->p_display->h;
700 p_vout->i_bytes_per_line = p_vout->p_sys->p_display->pitch;
702 p_vout->pf_setbuffers( p_vout, p_vout->p_sys->p_sdl_buf[ 0 ],
703 p_vout->p_sys->p_sdl_buf[ 1 ] );
706 p_vout->p_sys->b_reopen_display = 0;
711 /*****************************************************************************
712 * SDLCloseDisplay: close and reset SDL device
713 *****************************************************************************
714 * This function returns all resources allocated by SDLOpenDisplay and restore
715 * the original state of the device.
716 *****************************************************************************/
717 static void SDLCloseDisplay( vout_thread_t *p_vout )
719 if( p_vout->p_sys->p_display != NULL )
721 if( p_vout->p_sys->p_overlay != NULL )
723 SDL_FreeYUVOverlay( p_vout->p_sys->p_overlay );
724 p_vout->p_sys->p_overlay = NULL;
727 SDL_UnlockSurface ( p_vout->p_sys->p_display );
728 SDL_FreeSurface( p_vout->p_sys->p_display );
729 p_vout->p_sys->p_display = NULL;