git.sesse.net Git - vlc/blob - plugins/sdl/vout_sdl.c

   1 /*****************************************************************************
   2  * vout_sdl.c: SDL video output display method
   3  *****************************************************************************
   4  * Copyright (C) 1998, 1999, 2000 VideoLAN
   5  *
   6  * Authors:
   7  *
   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.
  12  *
  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.
  17  *
  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  *****************************************************************************/
  22
  23 /*****************************************************************************
  24  * Preamble
  25  *****************************************************************************/
  26 #include "defs.h"
  27
  28 #include <errno.h>                                                 /* ENOMEM */
  29 #include <stdlib.h>                                                /* free() */
  30 #include <string.h>                                            /* strerror() */
  31
  32 #include <SDL/SDL.h>
  33
  34 #include "config.h"
  35 #include "common.h"
  36 #include "threads.h"
  37 #include "mtime.h"
  38 #include "plugins.h"
  39
  40 #include "video.h"
  41 #include "video_output.h"
  42
  43 #include "intf_msg.h"
  44
  45 /*****************************************************************************
  46  * vout_sys_t: video output SDL method descriptor
  47  *****************************************************************************
  48  * This structure is part of the video output thread descriptor.
  49  * It describes the SDL specific properties of an output thread.
  50  *****************************************************************************/
  51 typedef struct vout_sys_s
  52 {
  53     int i_width;
  54     int i_height;
  55     SDL_Surface *   p_display;                             /* display device */
  56     SDL_Overlay *   p_overlay;                             /* overlay device */
  57     boolean_t   b_fullscreen;
  58     boolean_t   b_reopen_display;
  59     boolean_t   b_toggle_fullscreen;
  60     Uint8   *   p_buffer[2];
  61                                                      /* Buffers informations */
  62 }   vout_sys_t;
  63
  64 /*****************************************************************************
  65  * Local prototypes
  66  *****************************************************************************/
  67 static int     SDLOpenDisplay       ( vout_thread_t *p_vout );
  68 static void    SDLCloseDisplay      ( vout_thread_t *p_vout );
  69 static void    SDLToggleFullScreen  ( vout_thread_t *p_vout );
  70
  71 /*****************************************************************************
  72  * vout_SDLCreate: allocate SDL video thread output method
  73  *****************************************************************************
  74  * This function allocate and initialize a SDL vout method. It uses some of the
  75  * vout properties to choose the correct mode, and change them according to the
  76  * mode actually used.
  77  *****************************************************************************/
  78 int vout_SDLCreate( vout_thread_t *p_vout, char *psz_display,
  79                     int i_root_window, void *p_data )
  80 {
  81     /* Allocate structure */
  82     p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
  83     if( p_vout->p_sys == NULL )
  84     {
  85         intf_ErrMsg( "error: %s", strerror(ENOMEM) );
  86         return( 1 );
  87     }
  88
  89     p_vout->p_sys->p_display = NULL;
  90     p_vout->p_sys->p_overlay = NULL;
  91
  92     /* Initialize library */
  93     if( SDL_Init(SDL_INIT_VIDEO | SDL_INIT_EVENTTHREAD) < 0 )
  94     {
  95         intf_ErrMsg( "error: can't initialize SDL library: %s",
  96                      SDL_GetError() );
  97         free( p_vout->p_sys );
  98         return( 1 );
  99     }
 100
 101     /* Force the software yuv even if it is not used */
 102     /* If we don't do this, p_vout is not correctly initialized
 103        and it's impossible to switch between soft/hard yuv */
 104     p_vout->b_need_render = 1;
 105
 106     if(psz_display != NULL && strcmp(psz_display,"fullscreen")==0)
 107     {
 108         p_vout->p_sys->b_fullscreen = 1;
 109     }
 110     else
 111     {
 112         p_vout->p_sys->b_fullscreen = 0;
 113     }
 114
 115     p_vout->p_sys->i_width = VOUT_WIDTH_DEFAULT;
 116     p_vout->p_sys->i_height = VOUT_HEIGHT_DEFAULT;
 117
 118     if( SDLOpenDisplay(p_vout) )
 119     {
 120       intf_ErrMsg( "error: can't initialize SDL library: %s",
 121                    SDL_GetError() );
 122       return( 1 );
 123     }
 124
 125     p_vout->p_sys->b_toggle_fullscreen = 0;
 126
 127     return( 0 );
 128 }
 129
 130 /*****************************************************************************
 131  * vout_SDLInit: initialize SDL video thread output method
 132  *****************************************************************************
 133  * This function initialize the SDL display device.
 134  *****************************************************************************/
 135 int vout_SDLInit( vout_thread_t *p_vout )
 136 {
 137     return( 0 );
 138 }
 139
 140 /*****************************************************************************
 141  * vout_SDLEnd: terminate Sys video thread output method
 142  *****************************************************************************
 143  * Terminate an output method created by vout_SDLCreate
 144  *****************************************************************************/
 145 void vout_SDLEnd( vout_thread_t *p_vout )
 146 {
 147     SDLCloseDisplay( p_vout );
 148     SDL_Quit();
 149 }
 150
 151 /*****************************************************************************
 152  * vout_SDLDestroy: destroy Sys video thread output method
 153  *****************************************************************************
 154  * Terminate an output method created by vout_SDLCreate
 155  *****************************************************************************/
 156 void vout_SDLDestroy( vout_thread_t *p_vout )
 157 {
 158     free( p_vout->p_sys );
 159 }
 160
 161 /*****************************************************************************
 162  * vout_SDLManage: handle Sys events
 163  *****************************************************************************
 164  * This function should be called regularly by video output thread. It returns
 165  * a non null value if an error occured.
 166  *****************************************************************************/
 167 int vout_SDLManage( vout_thread_t *p_vout )
 168 {
 169     /* If the display has to be reopened we do so */
 170     if( p_vout->p_sys->b_reopen_display )
 171     {
 172         SDLCloseDisplay(p_vout);
 173
 174         if( SDLOpenDisplay(p_vout) )
 175         {
 176             intf_ErrMsg( "error: can't open DISPLAY default display" );
 177             return( 1 );
 178         }
 179     }
 180
 181     /* if fullscreen has to be toggled we do so */
 182     if( p_vout->p_sys->b_toggle_fullscreen )
 183     {
 184         SDLToggleFullScreen(p_vout);
 185     }
 186
 187     return( 0 );
 188 }
 189 /*****************************************************************************
 190  * vout_SDLSetPalette: sets an 8 bpp palette
 191  *****************************************************************************
 192  * This function sets the palette given as an argument. It does not return
 193  * anything, but could later send information on which colors it was unable
 194  * to set.
 195  *****************************************************************************/
 196 void vout_SDLSetPalette( p_vout_thread_t p_vout, u16 *red, u16 *green, u16 *blue, u16 *transp)
 197 {
 198      /* Create a display surface with a grayscale palette */
 199     SDL_Color colors[256];
 200     int i;
 201     intf_ErrMsgImm( "palettin'\n");
 202
 203     /* Fill colors with color information */
 204     for(i=0;i<256;i++){
 205       colors[i].r=red[i]>>8;
 206       colors[i].g=green[i]>>8;
 207       colors[i].b=blue[i]>>8;
 208     }
 209
 210     /* Set palette */
 211     if(SDL_SetColors(p_vout->p_sys->p_display, colors, 0, 256) == 0)
 212         intf_ErrMsgImm( "error\n");
 213
 214 }
 215
 216
 217
 218
 219
 220 /*****************************************************************************
 221  * vout_SDLDisplay: displays previously rendered output
 222  *****************************************************************************
 223  * This function send the currently rendered image to the display, wait until
 224  * it is displayed and switch the two rendering buffer, preparing next frame.
 225  *****************************************************************************/
 226 void vout_SDLDisplay( vout_thread_t *p_vout )
 227 {
 228     SDL_Rect    disp;
 229     if((p_vout->p_sys->p_display != NULL) && !p_vout->p_sys->b_reopen_display)
 230     {
 231         if(p_vout->b_need_render)
 232         {
 233             /* Change display frame */
 234             SDL_Flip( p_vout->p_sys->p_display );
 235         }
 236         else
 237         {
 238
 239             /*
 240              * p_vout->p_rendered_pic->p_y/u/v contains the YUV buffers to
 241              * render
 242              */
 243             /* TODO: support for streams other than 4:2:0 */
 244             /* create the overlay if necessary */
 245             if( p_vout->p_sys->p_overlay == NULL )
 246             {
 247                 p_vout->p_sys->p_overlay = SDL_CreateYUVOverlay(
 248                                              p_vout->p_rendered_pic->i_width,
 249                                              p_vout->p_rendered_pic->i_height,
 250                                              SDL_YV12_OVERLAY,
 251                                              p_vout->p_sys->p_display
 252                                            );
 253                 intf_Msg("[YUV acceleration] : %d,",
 254                             p_vout->p_sys->p_overlay->hw_overlay);
 255             }
 256
 257             SDL_LockYUVOverlay(p_vout->p_sys->p_overlay);
 258             /* copy the data into video buffers */
 259             /* Y first */
 260             memcpy(p_vout->p_sys->p_overlay->pixels[0],
 261                    p_vout->p_rendered_pic->p_y,
 262                    p_vout->p_sys->p_overlay->h *
 263                    p_vout->p_sys->p_overlay->pitches[0]);
 264             /* then V */
 265             memcpy(p_vout->p_sys->p_overlay->pixels[1],
 266                    p_vout->p_rendered_pic->p_v,
 267                    p_vout->p_sys->p_overlay->h *
 268                    p_vout->p_sys->p_overlay->pitches[1] / 2);
 269             /* and U */
 270             memcpy(p_vout->p_sys->p_overlay->pixels[2],
 271                    p_vout->p_rendered_pic->p_u,
 272                    p_vout->p_sys->p_overlay->h *
 273                    p_vout->p_sys->p_overlay->pitches[2] / 2);
 274
 275             disp.w = (&p_vout->p_buffer[p_vout->i_buffer_index])->i_pic_width;
 276             disp.h = (&p_vout->p_buffer[p_vout->i_buffer_index])->i_pic_height;
 277             disp.x = (p_vout->i_width - disp.w)/2;
 278             disp.y = (p_vout->i_height - disp.h)/2;
 279
 280             SDL_DisplayYUVOverlay( p_vout->p_sys->p_overlay , &disp );
 281             SDL_UnlockYUVOverlay(p_vout->p_sys->p_overlay);
 282         }
 283     }
 284 }
 285
 286 /* following functions are local */
 287
 288 /*****************************************************************************
 289  * SDLOpenDisplay: open and initialize SDL device
 290  *****************************************************************************
 291  * Open and initialize display according to preferences specified in the vout
 292  * thread fields.
 293  *****************************************************************************/
 294 static int SDLOpenDisplay( vout_thread_t *p_vout )
 295 {
 296     SDL_Rect    clipping_rect;
 297     Uint32      flags;
 298     int bpp;
 299     /* Open display
 300      * TODO: Check that we can request for a DOUBLEBUF HWSURFACE display
 301      */
 302
 303     /* init flags and cursor */
 304     flags = SDL_ANYFORMAT | SDL_HWPALETTE;
 305
 306     if( p_vout->p_sys->b_fullscreen )
 307         flags |= SDL_FULLSCREEN;
 308     else
 309         flags |= SDL_RESIZABLE;
 310
 311     if( p_vout->b_need_render )
 312         flags |= SDL_HWSURFACE | SDL_DOUBLEBUF;
 313     else
 314         flags |= SDL_SWSURFACE; /* save video memory */
 315
 316     bpp = SDL_VideoModeOK(p_vout->p_sys->i_width,
 317                           p_vout->p_sys->i_height,
 318                           p_vout->i_screen_depth, flags);
 319
 320     if(bpp == 0)
 321     {
 322         intf_ErrMsg( "error: can't open DISPLAY default display" );
 323         return( 1 );
 324     }
 325
 326     p_vout->p_sys->p_display = SDL_SetVideoMode(p_vout->p_sys->i_width,
 327                                                 p_vout->p_sys->i_height,
 328                                                 bpp, flags);
 329
 330     if( p_vout->p_sys->p_display == NULL )
 331     {
 332         intf_ErrMsg( "error: can't open DISPLAY default display" );
 333         return( 1 );
 334     }
 335
 336     SDL_LockSurface(p_vout->p_sys->p_display);
 337
 338     if( p_vout->p_sys->b_fullscreen )
 339         SDL_ShowCursor( 0 );
 340     else
 341         SDL_ShowCursor( 1 );
 342
 343     SDL_WM_SetCaption( VOUT_TITLE , VOUT_TITLE );
 344     SDL_EventState(SDL_KEYUP , SDL_IGNORE); /* ignore keys up */
 345
 346     if( p_vout->b_need_render )
 347     {
 348         p_vout->p_sys->p_buffer[ 0 ] = p_vout->p_sys->p_display->pixels;
 349         SDL_Flip(p_vout->p_sys->p_display);
 350         p_vout->p_sys->p_buffer[ 1 ] = p_vout->p_sys->p_display->pixels;
 351         SDL_Flip(p_vout->p_sys->p_display);
 352
 353         /* Set clipping for text */
 354         clipping_rect.x = 0;
 355         clipping_rect.y = 0;
 356         clipping_rect.w = p_vout->p_sys->p_display->w;
 357         clipping_rect.h = p_vout->p_sys->p_display->h;
 358         SDL_SetClipRect(p_vout->p_sys->p_display, &clipping_rect);
 359
 360         /* Set thread information */
 361         p_vout->i_width =           p_vout->p_sys->p_display->w;
 362         p_vout->i_height =          p_vout->p_sys->p_display->h;
 363         p_vout->i_bytes_per_line =  p_vout->p_sys->p_display->pitch;
 364
 365         p_vout->i_screen_depth =
 366             p_vout->p_sys->p_display->format->BitsPerPixel;
 367         p_vout->i_bytes_per_pixel =
 368             p_vout->p_sys->p_display->format->BytesPerPixel;
 369
 370         p_vout->i_red_mask =        p_vout->p_sys->p_display->format->Rmask;
 371         p_vout->i_green_mask =      p_vout->p_sys->p_display->format->Gmask;
 372         p_vout->i_blue_mask =       p_vout->p_sys->p_display->format->Bmask;
 373
 374         /* FIXME: palette in 8bpp ?? */
 375         /* Set and initialize buffers */
 376         vout_SetBuffers( p_vout, p_vout->p_sys->p_buffer[ 0 ],
 377                                  p_vout->p_sys->p_buffer[ 1 ] );
 378     }
 379     else
 380     {
 381         p_vout->p_sys->p_buffer[ 0 ] = p_vout->p_sys->p_display->pixels;
 382         p_vout->p_sys->p_buffer[ 1 ] = p_vout->p_sys->p_display->pixels;
 383
 384         /* Set thread information */
 385         p_vout->i_width =           p_vout->p_sys->p_display->w;
 386         p_vout->i_height =          p_vout->p_sys->p_display->h;
 387         p_vout->i_bytes_per_line =  p_vout->p_sys->p_display->pitch;
 388
 389         vout_SetBuffers( p_vout, p_vout->p_sys->p_buffer[ 0 ],
 390                                  p_vout->p_sys->p_buffer[ 1 ] );
 391     }
 392
 393     p_vout->i_changes |= VOUT_YUV_CHANGE;
 394
 395     p_vout->p_sys->b_reopen_display = 0;
 396
 397     return( 0 );
 398 }
 399
 400 /*****************************************************************************
 401  * SDLCloseDisplay: close and reset SDL device
 402  *****************************************************************************
 403  * This function returns all resources allocated by SDLOpenDisplay and restore
 404  * the original state of the device.
 405  *****************************************************************************/
 406 static void SDLCloseDisplay( vout_thread_t *p_vout )
 407 {
 408     if( p_vout->p_sys->p_display != NULL )
 409     {
 410         if( p_vout->p_sys->p_overlay != NULL )
 411         {
 412             SDL_FreeYUVOverlay(p_vout->p_sys->p_overlay);
 413             p_vout->p_sys->p_overlay = NULL;
 414         }
 415         SDL_UnlockSurface ( p_vout->p_sys->p_display );
 416         SDL_FreeSurface( p_vout->p_sys->p_display );
 417         p_vout->p_sys->p_display = NULL;
 418     }
 419 }
 420
 421 /*****************************************************************************
 422  * SDLToggleFullScreen: toggle fullscreen
 423  *****************************************************************************
 424  * This function toggles the fullscreen state of the surface.
 425  *****************************************************************************/
 426 static void SDLToggleFullScreen( vout_thread_t *p_vout )
 427 {
 428     SDL_WM_ToggleFullScreen(p_vout->p_sys->p_display);
 429
 430     if( p_vout->p_sys->b_fullscreen )
 431         SDL_ShowCursor( 0 );
 432     else
 433         SDL_ShowCursor( 1 );
 434
 435     p_vout->p_sys->b_toggle_fullscreen = 0;
 436 }
 437