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-2001 VideoLAN
   5  * $Id: vout_sdl.c,v 1.70 2001/12/16 16:18:36 sam Exp $
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   8  *          Pierre Baillet <oct@zoy.org>
   9  *          Arnaud de Bossoreille de Ribou <bozo@via.ecp.fr>
  10  *
  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.
  15  *
  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.
  20  *
  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  *****************************************************************************/
  25
  26 #define MODULE_NAME sdl
  27 #include "modules_inner.h"
  28
  29 /*****************************************************************************
  30  * Preamble
  31  *****************************************************************************/
  32 #include "defs.h"
  33
  34 #include <errno.h>                                                 /* ENOMEM */
  35 #include <stdlib.h>                                                /* free() */
  36 #include <string.h>                                            /* strerror() */
  37
  38 #include <sys/types.h>
  39 #ifndef WIN32
  40 #   include <netinet/in.h>                            /* BSD: struct in_addr */
  41 #endif
  42
  43 #include SDL_INCLUDE_FILE
  44
  45 #include "common.h"
  46 #include "intf_msg.h"
  47 #include "threads.h"
  48 #include "mtime.h"
  49 #include "tests.h"
  50
  51 #include "video.h"
  52 #include "video_output.h"
  53
  54 #include "interface.h"
  55
  56 #include "modules.h"
  57 #include "modules_export.h"
  58
  59 #define SDL_MAX_DIRECTBUFFERS 5
  60 #define SDL_DEFAULT_BPP 16
  61
  62 /*****************************************************************************
  63  * vout_sys_t: video output SDL method descriptor
  64  *****************************************************************************
  65  * This structure is part of the video output thread descriptor.
  66  * It describes the SDL specific properties of an output thread.
  67  *****************************************************************************/
  68 typedef struct vout_sys_s
  69 {
  70     SDL_Surface *   p_display;                             /* display device */
  71
  72     int i_width;
  73     int i_height;
  74
  75     boolean_t   b_cursor;
  76     boolean_t   b_cursor_autohidden;
  77     mtime_t     i_lastmoved;
  78
  79 } vout_sys_t;
  80
  81 /*****************************************************************************
  82  * picture_sys_t: direct buffer method descriptor
  83  *****************************************************************************
  84  * This structure is part of the picture descriptor, it describes the
  85  * SDL specific properties of a direct buffer.
  86  *****************************************************************************/
  87 typedef struct picture_sys_s
  88 {
  89     SDL_Overlay *p_overlay;
  90
  91 } picture_sys_t;
  92
  93 /*****************************************************************************
  94  * Local prototypes.
  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 *, struct picture_s * );
 103
 104 static int  SDLOpenDisplay      ( vout_thread_t *p_vout );
 105 static void SDLCloseDisplay     ( vout_thread_t *p_vout );
 106 static int  SDLNewPicture       ( vout_thread_t *p_vout, picture_t *p_pic );
 107
 108 /*****************************************************************************
 109  * Functions exported as capabilities. They are declared as static so that
 110  * we don't pollute the namespace too much.
 111  *****************************************************************************/
 112 void _M( vout_getfunctions )( function_list_t * p_function_list )
 113 {
 114     p_function_list->pf_probe = vout_Probe;
 115     p_function_list->functions.vout.pf_create     = vout_Create;
 116     p_function_list->functions.vout.pf_init       = vout_Init;
 117     p_function_list->functions.vout.pf_end        = vout_End;
 118     p_function_list->functions.vout.pf_destroy    = vout_Destroy;
 119     p_function_list->functions.vout.pf_manage     = vout_Manage;
 120     p_function_list->functions.vout.pf_display    = vout_Display;
 121     p_function_list->functions.vout.pf_setpalette = NULL;
 122 }
 123
 124 /*****************************************************************************
 125  * vout_Probe: probe the video driver and return a score
 126  *****************************************************************************
 127  * This function tries to initialize SDL and returns a score to the
 128  * plugin manager so that it can select the best plugin.
 129  *****************************************************************************/
 130 static int vout_Probe( probedata_t *p_data )
 131 {
 132     if( TestMethod( VOUT_METHOD_VAR, "sdl" ) )
 133     {
 134         return( 999 );
 135     }
 136
 137     return( 100 );
 138 }
 139
 140 /*****************************************************************************
 141  * vout_Create: allocate SDL video thread output method
 142  *****************************************************************************
 143  * This function allocate and initialize a SDL vout method. It uses some of the
 144  * vout properties to choose the correct mode, and change them according to the
 145  * mode actually used.
 146  *****************************************************************************/
 147 static int vout_Create( vout_thread_t *p_vout )
 148 {
 149     /* Allocate structure */
 150     p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
 151     if( p_vout->p_sys == NULL )
 152     {
 153         intf_ErrMsg( "vout error: can't create p_sys (%s)", strerror(ENOMEM) );
 154         return( 1 );
 155     }
 156
 157     /* Initialize library */
 158     if( SDL_Init( SDL_INIT_VIDEO
 159 #ifndef WIN32
 160     /* Win32 SDL implementation doesn't support SDL_INIT_EVENTTHREAD yet*/
 161                 | SDL_INIT_EVENTTHREAD
 162 #endif
 163 #ifdef DEBUG
 164     /* In debug mode you may want vlc to dump a core instead of staying
 165      * stuck */
 166                 | SDL_INIT_NOPARACHUTE
 167 #endif
 168                 ) < 0 )
 169     {
 170         intf_ErrMsg( "vout error: can't initialize SDL (%s)", SDL_GetError() );
 171         free( p_vout->p_sys );
 172         return( 1 );
 173     }
 174
 175     p_vout->p_sys->b_cursor = 1; /* TODO should be done with a main_GetInt.. */
 176     p_vout->p_sys->b_cursor_autohidden = 0;
 177     p_vout->p_sys->i_lastmoved = mdate();
 178
 179     if( p_vout->render.i_height * p_vout->render.i_aspect
 180          >= p_vout->render.i_width * VOUT_ASPECT_FACTOR )
 181     {
 182         p_vout->p_sys->i_width = p_vout->render.i_height
 183             * p_vout->render.i_aspect / VOUT_ASPECT_FACTOR;
 184         p_vout->p_sys->i_height = p_vout->render.i_height;
 185     }
 186     else
 187     {
 188         p_vout->p_sys->i_width = p_vout->render.i_width;
 189         p_vout->p_sys->i_height = p_vout->render.i_width
 190             * VOUT_ASPECT_FACTOR / p_vout->render.i_aspect;
 191     }
 192
 193     if( p_vout->p_sys->i_width <= 400 && p_vout->p_sys->i_height <= 300 )
 194     {
 195         p_vout->p_sys->i_width *= 2;
 196         p_vout->p_sys->i_height *= 2;
 197     }
 198
 199     if( SDLOpenDisplay( p_vout ) )
 200     {
 201         intf_ErrMsg( "vout error: can't set up SDL (%s)", SDL_GetError() );
 202         free( p_vout->p_sys );
 203         return( 1 );
 204     }
 205
 206     return( 0 );
 207 }
 208
 209 /*****************************************************************************
 210  * vout_Init: initialize SDL video thread output method
 211  *****************************************************************************
 212  * This function initialize the SDL display device.
 213  *****************************************************************************/
 214 static int vout_Init( vout_thread_t *p_vout )
 215 {
 216     int i_index;
 217     picture_t *p_pic;
 218
 219     I_OUTPUTPICTURES = 0;
 220
 221     /* Initialize the output structure */
 222     switch( p_vout->render.i_chroma )
 223     {
 224         case YUV_420_PICTURE:
 225             p_vout->output.i_chroma = p_vout->render.i_chroma;
 226             p_vout->output.i_width  = p_vout->render.i_width;
 227             p_vout->output.i_height = p_vout->render.i_height;
 228             p_vout->output.i_aspect = p_vout->render.i_aspect;
 229             break;
 230
 231         default:
 232             return( 0 );
 233     }
 234
 235     /* Try to initialize SDL_MAX_DIRECTBUFFERS direct buffers */
 236     while( I_OUTPUTPICTURES < SDL_MAX_DIRECTBUFFERS )
 237     {
 238         p_pic = NULL;
 239
 240         /* Find an empty picture slot */
 241         for( i_index = 0 ; i_index < VOUT_MAX_PICTURES ; i_index++ )
 242         {
 243             if( p_vout->p_picture[ i_index ].i_status == FREE_PICTURE )
 244             {
 245                 p_pic = p_vout->p_picture + i_index;
 246                 break;
 247             }
 248         }
 249
 250         /* Allocate the picture */
 251         if( SDLNewPicture( p_vout, p_pic ) )
 252         {
 253             break;
 254         }
 255
 256         p_pic->i_status        = DESTROYED_PICTURE;
 257         p_pic->i_type          = DIRECT_PICTURE;
 258
 259         p_pic->i_left_margin   =
 260         p_pic->i_right_margin  =
 261         p_pic->i_top_margin    =
 262         p_pic->i_bottom_margin = 0;
 263
 264         PP_OUTPUTPICTURE[ I_OUTPUTPICTURES ] = p_pic;
 265
 266         I_OUTPUTPICTURES++;
 267     }
 268
 269     return( 0 );
 270 }
 271
 272 /*****************************************************************************
 273  * vout_End: terminate Sys video thread output method
 274  *****************************************************************************
 275  * Terminate an output method created by vout_SDLCreate
 276  *****************************************************************************/
 277 static void vout_End( vout_thread_t *p_vout )
 278 {
 279     int i_index;
 280
 281     /* Free the output buffers we allocated */
 282     for( i_index = I_OUTPUTPICTURES ; i_index ; )
 283     {
 284         i_index--;
 285         SDL_UnlockYUVOverlay( PP_OUTPUTPICTURE[ i_index ]->p_sys->p_overlay );
 286         SDL_FreeYUVOverlay( PP_OUTPUTPICTURE[ i_index ]->p_sys->p_overlay );
 287         free( PP_OUTPUTPICTURE[ i_index ]->p_sys );
 288     }
 289 }
 290
 291 /*****************************************************************************
 292  * vout_Destroy: destroy Sys video thread output method
 293  *****************************************************************************
 294  * Terminate an output method created by vout_SDLCreate
 295  *****************************************************************************/
 296 static void vout_Destroy( vout_thread_t *p_vout )
 297 {
 298     SDLCloseDisplay( p_vout );
 299
 300     SDL_QuitSubSystem( SDL_INIT_VIDEO );
 301
 302     free( p_vout->p_sys );
 303 }
 304
 305 /*****************************************************************************
 306  * vout_Manage: handle Sys events
 307  *****************************************************************************
 308  * This function should be called regularly by video output thread. It returns
 309  * a non null value if an error occured.
 310  *****************************************************************************/
 311 static int vout_Manage( vout_thread_t *p_vout )
 312 {
 313     SDL_Event event;                                            /* SDL event */
 314
 315     /* Process events */
 316     while( SDL_PollEvent(&event) )
 317     {
 318         switch( event.type )
 319         {
 320         case SDL_VIDEORESIZE:                          /* Resizing of window */
 321             p_vout->p_sys->i_width = event.resize.w;
 322             p_vout->p_sys->i_height = event.resize.h;
 323             SDLCloseDisplay( p_vout );
 324             SDLOpenDisplay( p_vout );
 325             break;
 326
 327         case SDL_MOUSEMOTION:
 328             if( p_vout->p_sys->b_cursor &&
 329                 (abs(event.motion.xrel) > 2 || abs(event.motion.yrel) > 2) )
 330             {
 331                 if( p_vout->p_sys->b_cursor_autohidden )
 332                 {
 333                     p_vout->p_sys->b_cursor_autohidden = 0;
 334                     SDL_ShowCursor( 1 );
 335                 }
 336                 else
 337                 {
 338                     p_vout->p_sys->i_lastmoved = mdate();
 339                 }
 340             }
 341             break;
 342
 343         case SDL_MOUSEBUTTONUP:
 344             switch( event.button.button )
 345             {
 346             case SDL_BUTTON_RIGHT:
 347                 p_main->p_intf->b_menu_change = 1;
 348                 break;
 349             }
 350             break;
 351
 352         case SDL_MOUSEBUTTONDOWN:
 353             switch( event.button.button )
 354             {
 355             case SDL_BUTTON_LEFT:
 356                 /* Handle clicks */
 357                 break;
 358             }
 359             break;
 360
 361         case SDL_QUIT:
 362             p_main->p_intf->b_die = 1;
 363             break;
 364
 365         case SDL_KEYDOWN:                             /* if a key is pressed */
 366
 367             switch( event.key.keysym.sym )
 368             {
 369             case SDLK_q:                                             /* quit */
 370             case SDLK_ESCAPE:
 371                 p_main->p_intf->b_die = 1;
 372                 break;
 373
 374             case SDLK_f:                             /* switch to fullscreen */
 375                 p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
 376                 break;
 377
 378             case SDLK_c:                                 /* toggle grayscale */
 379                 p_vout->b_grayscale = ! p_vout->b_grayscale;
 380                 p_vout->i_changes |= VOUT_GRAYSCALE_CHANGE;
 381                 break;
 382
 383             case SDLK_i:                                      /* toggle info */
 384                 p_vout->b_info = ! p_vout->b_info;
 385                 p_vout->i_changes |= VOUT_INFO_CHANGE;
 386                 break;
 387
 388             case SDLK_s:                                   /* toggle scaling */
 389                 p_vout->b_scale = ! p_vout->b_scale;
 390                 p_vout->i_changes |= VOUT_SCALE_CHANGE;
 391                 break;
 392
 393             case SDLK_SPACE:                             /* toggle interface */
 394                 p_vout->b_interface = ! p_vout->b_interface;
 395                 p_vout->i_changes |= VOUT_INTF_CHANGE;
 396                 break;
 397
 398             case SDLK_MENU:
 399                 p_main->p_intf->b_menu_change = 1;
 400                 break;
 401
 402             case SDLK_F10: network_ChannelJoin( 0 ); break;
 403             case SDLK_F1:  network_ChannelJoin( 1 ); break;
 404             case SDLK_F2:  network_ChannelJoin( 2 ); break;
 405             case SDLK_F3:  network_ChannelJoin( 3 ); break;
 406             case SDLK_F4:  network_ChannelJoin( 4 ); break;
 407             case SDLK_F5:  network_ChannelJoin( 5 ); break;
 408             case SDLK_F6:  network_ChannelJoin( 6 ); break;
 409             case SDLK_F7:  network_ChannelJoin( 7 ); break;
 410             case SDLK_F8:  network_ChannelJoin( 8 ); break;
 411             case SDLK_F9:  network_ChannelJoin( 9 ); break;
 412
 413             default:
 414                 intf_DbgMsg( "unhandled key %i", event.key.keysym.sym );
 415                 break;
 416             }
 417             break;
 418
 419         default:
 420             break;
 421         }
 422     }
 423
 424     /* Fullscreen change */
 425     if( p_vout->i_changes & VOUT_FULLSCREEN_CHANGE )
 426     {
 427         p_vout->b_fullscreen = ! p_vout->b_fullscreen;
 428
 429         SDL_WM_ToggleFullScreen(p_vout->p_sys->p_display);
 430
 431         p_vout->p_sys->b_cursor_autohidden = 0;
 432         SDL_ShowCursor( p_vout->p_sys->b_cursor &&
 433                         ! p_vout->p_sys->b_cursor_autohidden );
 434
 435         p_vout->i_changes &= ~VOUT_FULLSCREEN_CHANGE;
 436     }
 437
 438     /* Pointer change */
 439     if( ! p_vout->p_sys->b_cursor_autohidden &&
 440         ( mdate() - p_vout->p_sys->i_lastmoved > 2000000 ) )
 441     {
 442         /* Hide the mouse automatically */
 443         p_vout->p_sys->b_cursor_autohidden = 1;
 444         SDL_ShowCursor( 0 );
 445     }
 446
 447     return( 0 );
 448 }
 449
 450 /*****************************************************************************
 451  * vout_Display: displays previously rendered output
 452  *****************************************************************************
 453  * This function sends the currently rendered image to the display.
 454  *****************************************************************************/
 455 static void vout_Display( vout_thread_t *p_vout, picture_t *p_pic )
 456 {
 457     int x, y, w, h;
 458     SDL_Rect disp;
 459
 460     vout_PlacePicture( p_vout, p_vout->p_sys->i_width, p_vout->p_sys->i_height,
 461                        &x, &y, &w, &h );
 462     disp.x = x;
 463     disp.y = y;
 464     disp.w = w;
 465     disp.h = h;
 466
 467     SDL_UnlockYUVOverlay( p_pic->p_sys->p_overlay);
 468     SDL_DisplayYUVOverlay( p_pic->p_sys->p_overlay , &disp );
 469     SDL_LockYUVOverlay( p_pic->p_sys->p_overlay);
 470 }
 471
 472 /* following functions are local */
 473
 474 /*****************************************************************************
 475  * SDLOpenDisplay: open and initialize SDL device
 476  *****************************************************************************
 477  * Open and initialize display according to preferences specified in the vout
 478  * thread fields.
 479  *****************************************************************************/
 480 static int SDLOpenDisplay( vout_thread_t *p_vout )
 481 {
 482     Uint32 i_flags;
 483     int    i_bpp;
 484
 485     /* Initialize flags and cursor */
 486     i_flags = SDL_ANYFORMAT | SDL_HWPALETTE | SDL_HWSURFACE;
 487     i_flags |= p_vout->b_fullscreen ? SDL_FULLSCREEN : SDL_RESIZABLE;
 488
 489     i_bpp = SDL_VideoModeOK( p_vout->p_sys->i_width, p_vout->p_sys->i_height,
 490                              SDL_DEFAULT_BPP, i_flags );
 491     if( i_bpp == 0 )
 492     {
 493         intf_ErrMsg( "vout error: no video mode available" );
 494         return( 1 );
 495     }
 496
 497     p_vout->p_sys->p_display = SDL_SetVideoMode( p_vout->p_sys->i_width,
 498                                                  p_vout->p_sys->i_height,
 499                                                  i_bpp, i_flags );
 500
 501     if( p_vout->p_sys->p_display == NULL )
 502     {
 503         intf_ErrMsg( "vout error: cannot set video mode" );
 504         return( 1 );
 505     }
 506
 507     SDL_LockSurface( p_vout->p_sys->p_display );
 508
 509     SDL_WM_SetCaption( VOUT_TITLE " (SDL output)",
 510                        VOUT_TITLE " (SDL output)" );
 511     SDL_EventState( SDL_KEYUP, SDL_IGNORE );               /* ignore keys up */
 512
 513     return( 0 );
 514 }
 515
 516 /*****************************************************************************
 517  * SDLCloseDisplay: close and reset SDL device
 518  *****************************************************************************
 519  * This function returns all resources allocated by SDLOpenDisplay and restore
 520  * the original state of the device.
 521  *****************************************************************************/
 522 static void SDLCloseDisplay( vout_thread_t *p_vout )
 523 {
 524     SDL_UnlockSurface ( p_vout->p_sys->p_display );
 525     SDL_FreeSurface( p_vout->p_sys->p_display );
 526 }
 527
 528 /*****************************************************************************
 529  * SDLNewPicture: allocate a picture
 530  *****************************************************************************
 531  * Returns 0 on success, -1 otherwise
 532  *****************************************************************************/
 533 static int SDLNewPicture( vout_thread_t *p_vout, picture_t *p_pic )
 534 {
 535     int i_width  = p_vout->output.i_width;
 536     int i_height = p_vout->output.i_height;
 537
 538     switch( p_vout->output.i_chroma )
 539     {
 540         case YUV_420_PICTURE:
 541             /* We know this chroma, allocate a buffer which will be used
 542              * directly by the decoder */
 543             p_pic->p_sys = malloc( sizeof( picture_sys_t ) );
 544
 545             if( p_pic->p_sys == NULL )
 546             {
 547                 return -1;
 548             }
 549
 550             p_pic->p_sys->p_overlay =
 551                 SDL_CreateYUVOverlay( i_width, i_height,
 552                                       SDL_YV12_OVERLAY,
 553                                       p_vout->p_sys->p_display );
 554
 555             if( p_pic->p_sys->p_overlay == NULL )
 556             {
 557                 free( p_pic->p_sys );
 558                 return -1;
 559             }
 560
 561             SDL_LockYUVOverlay( p_pic->p_sys->p_overlay );
 562
 563             /* Precalculate some values */
 564             p_pic->i_size         = i_width * i_height;
 565             p_pic->i_chroma_width = i_width / 2;
 566             p_pic->i_chroma_size  = i_height * ( i_width / 2 );
 567
 568             /* FIXME: try to get the right i_bytes value from p_overlay */
 569             p_pic->planes[ Y_PLANE ].p_data = p_pic->p_sys->p_overlay->pixels[ 0 ];
 570             p_pic->planes[ Y_PLANE ].i_bytes = p_pic->i_size * sizeof( u8 );
 571             p_pic->planes[ Y_PLANE ].i_line_bytes = i_width * sizeof( u8 );
 572
 573             p_pic->planes[ U_PLANE ].p_data = p_pic->p_sys->p_overlay->pixels[ 2 ];
 574             p_pic->planes[ U_PLANE ].i_bytes = p_pic->i_size * sizeof( u8 ) / 4;
 575             p_pic->planes[ U_PLANE ].i_line_bytes = p_pic->i_chroma_width * sizeof( u8 );
 576
 577             p_pic->planes[ V_PLANE ].p_data = p_pic->p_sys->p_overlay->pixels[ 1 ];
 578             p_pic->planes[ V_PLANE ].i_bytes = p_pic->i_size * sizeof( u8 ) / 4;
 579             p_pic->planes[ V_PLANE ].i_line_bytes = p_pic->i_chroma_width * sizeof( u8 );
 580
 581             p_pic->i_planes = 3;
 582
 583             return 0;
 584
 585         default:
 586             /* Unknown chroma, tell the guy to get lost */
 587             p_pic->i_planes = 0;
 588
 589             return 0;
 590     }
 591 }
 592