git.sesse.net Git - vlc/blob - src/video_output/video_output.c

   1 /*****************************************************************************
   2  * video_output.c : video output thread
   3  * This module describes the programming interface for video output threads.
   4  * It includes functions allowing to open a new thread, send pictures to a
   5  * thread, and destroy a previously oppened video output thread.
   6  *****************************************************************************
   7  * Copyright (C) 2000-2001 VideoLAN
   8  * $Id: video_output.c,v 1.216 2003/03/25 17:07:45 gbazin Exp $
   9  *
  10  * Authors: Vincent Seguin <seguin@via.ecp.fr>
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  25  *****************************************************************************/
  26
  27 /*****************************************************************************
  28  * Preamble
  29  *****************************************************************************/
  30 #include <stdlib.h>                                                /* free() */
  31
  32 #include <vlc/vlc.h>
  33
  34 #ifdef HAVE_SYS_TIMES_H
  35 #   include <sys/times.h>
  36 #endif
  37
  38 #include "video.h"
  39 #include "video_output.h"
  40 #include <vlc/input.h>                 /* for input_thread_t and i_pts_delay */
  41
  42 #if defined( SYS_DARWIN )
  43 #include "darwin_specific.h"
  44 #endif
  45
  46 /*****************************************************************************
  47  * Local prototypes
  48  *****************************************************************************/
  49 static int      InitThread        ( vout_thread_t * );
  50 static void     RunThread         ( vout_thread_t * );
  51 static void     ErrorThread       ( vout_thread_t * );
  52 static void     EndThread         ( vout_thread_t * );
  53 static void     DestroyThread     ( vout_thread_t * );
  54
  55 static int      ReduceHeight      ( int );
  56 static int      BinaryLog         ( uint32_t );
  57 static void     MaskToShift       ( int *, int *, uint32_t );
  58 static void     InitWindowSize    ( vout_thread_t *, int *, int * );
  59
  60 /*****************************************************************************
  61  * vout_Request: find a video output thread, create one, or destroy one.
  62  *****************************************************************************
  63  * This function looks for a video output thread matching the current
  64  * properties. If not found, it spawns a new one.
  65  *****************************************************************************/
  66 vout_thread_t * __vout_Request ( vlc_object_t *p_this, vout_thread_t *p_vout,
  67                                  unsigned int i_width, unsigned int i_height,
  68                                  vlc_fourcc_t i_chroma, unsigned int i_aspect )
  69 {
  70     if( !i_width || !i_height || !i_chroma )
  71     {
  72         /* Reattach video output to input before bailing out */
  73         if( p_vout )
  74         {
  75             vlc_object_t *p_input;
  76             char *psz_sout = config_GetPsz( p_this, "sout" );
  77
  78             p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
  79
  80             if( p_input && (!psz_sout || !*psz_sout) )
  81             {
  82                 vlc_object_detach( p_vout );
  83                 vlc_object_attach( p_vout, p_input );
  84             }
  85             else
  86             {
  87                 vlc_object_detach( p_vout );
  88                 vlc_object_release( p_vout );
  89                 vout_Destroy( p_vout );
  90             }
  91             if( psz_sout ) free( psz_sout );
  92             if( p_input ) vlc_object_release( p_input );
  93         }
  94
  95         return NULL;
  96     }
  97
  98     /* If a video output was provided, lock it, otherwise look for one. */
  99     if( p_vout )
 100     {
 101         vlc_object_yield( p_vout );
 102     }
 103     else
 104     {
 105         p_vout = vlc_object_find( p_this, VLC_OBJECT_VOUT, FIND_CHILD );
 106
 107         if( !p_vout )
 108         {
 109             vlc_object_t *p_input;
 110
 111             p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
 112             if( p_input )
 113             {
 114                 p_vout = vlc_object_find( p_input, VLC_OBJECT_VOUT,
 115                                           FIND_CHILD );
 116                 vlc_object_release( p_input );
 117             }
 118         }
 119     }
 120
 121     /* If we now have a video output, check it has the right properties */
 122     if( p_vout )
 123     {
 124         char *psz_filter_chain;
 125
 126         /* We don't directly check for the "filter" variable for obvious
 127          * performance reasons. */
 128         if( p_vout->b_filter_change )
 129         {
 130             psz_filter_chain = config_GetPsz( p_this, "filter" );
 131
 132             if( psz_filter_chain && !*psz_filter_chain )
 133             {
 134                 free( psz_filter_chain );
 135                 psz_filter_chain = NULL;
 136             }
 137             if( p_vout->psz_filter_chain && !*p_vout->psz_filter_chain )
 138             {
 139                 free( p_vout->psz_filter_chain );
 140                 p_vout->psz_filter_chain = NULL;
 141             }
 142
 143             if( ( !psz_filter_chain && !p_vout->psz_filter_chain ) ||
 144                 ( psz_filter_chain && p_vout->psz_filter_chain &&
 145                   !strcmp( psz_filter_chain, p_vout->psz_filter_chain ) ) )
 146             {
 147                 p_vout->b_filter_change = VLC_FALSE;
 148             }
 149
 150             if( psz_filter_chain ) free( psz_filter_chain );
 151         }
 152
 153         if( ( p_vout->render.i_width != i_width ) ||
 154             ( p_vout->render.i_height != i_height ) ||
 155             ( p_vout->render.i_chroma != i_chroma ) ||
 156             ( p_vout->render.i_aspect != i_aspect
 157                     && !p_vout->b_override_aspect ) ||
 158             p_vout->b_filter_change )
 159         {
 160             /* We are not interested in this format, close this vout */
 161             vlc_object_detach( p_vout );
 162             vlc_object_release( p_vout );
 163             vout_Destroy( p_vout );
 164             p_vout = NULL;
 165         }
 166         else
 167         {
 168             /* This video output is cool! Hijack it. */
 169             vlc_object_detach( p_vout );
 170             vlc_object_attach( p_vout, p_this );
 171             vlc_object_release( p_vout );
 172         }
 173     }
 174
 175     if( !p_vout )
 176     {
 177         msg_Dbg( p_this, "no usable vout present, spawning one" );
 178
 179         p_vout = vout_Create( p_this, i_width, i_height, i_chroma, i_aspect );
 180     }
 181
 182     return p_vout;
 183 }
 184
 185 /*****************************************************************************
 186  * vout_Create: creates a new video output thread
 187  *****************************************************************************
 188  * This function creates a new video output thread, and returns a pointer
 189  * to its description. On error, it returns NULL.
 190  *****************************************************************************/
 191 vout_thread_t * __vout_Create( vlc_object_t *p_parent,
 192                                unsigned int i_width, unsigned int i_height,
 193                                vlc_fourcc_t i_chroma, unsigned int i_aspect )
 194 {
 195     vout_thread_t  * p_vout;                            /* thread descriptor */
 196     input_thread_t * p_input_thread;
 197     int              i_index;                               /* loop variable */
 198     char           * psz_plugin;
 199     vlc_value_t      val;
 200
 201     /* Allocate descriptor */
 202     p_vout = vlc_object_create( p_parent, VLC_OBJECT_VOUT );
 203     if( p_vout == NULL )
 204     {
 205         msg_Err( p_parent, "out of memory" );
 206         return NULL;
 207     }
 208
 209     var_Create( p_vout, "intf-change", VLC_VAR_BOOL );
 210     val.b_bool = VLC_TRUE;
 211     var_Set( p_vout, "intf-change", val );
 212
 213     p_vout->b_override_aspect = VLC_FALSE;
 214
 215     /* If the parent is not a VOUT object, that means we are at the start of
 216      * the video output pipe */
 217     if( p_parent->i_object_type != VLC_OBJECT_VOUT )
 218     {
 219         char *psz_aspect = config_GetPsz( p_parent, "aspect-ratio" );
 220
 221         /* Check whether the user tried to override aspect ratio */
 222         if( psz_aspect )
 223         {
 224             unsigned int i_new_aspect = i_aspect;
 225             char *psz_parser = strchr( psz_aspect, ':' );
 226
 227             if( psz_parser )
 228             {
 229                 *psz_parser++ = '\0';
 230                 i_new_aspect = atoi( psz_aspect ) * VOUT_ASPECT_FACTOR
 231                                                   / atoi( psz_parser );
 232             }
 233             else
 234             {
 235                 i_new_aspect = i_width * VOUT_ASPECT_FACTOR
 236                                        * atof( psz_aspect )
 237                                        / i_height;
 238             }
 239
 240             free( psz_aspect );
 241
 242             if( i_new_aspect && i_new_aspect != i_aspect )
 243             {
 244                 int i_pgcd = ReduceHeight( i_new_aspect );
 245
 246                 msg_Dbg( p_vout, "overriding source aspect ratio to %i:%i",
 247                          i_new_aspect / i_pgcd, VOUT_ASPECT_FACTOR / i_pgcd );
 248
 249                 i_aspect = i_new_aspect;
 250
 251                 p_vout->b_override_aspect = VLC_TRUE;
 252             }
 253         }
 254
 255         /* Look for the default filter configuration */
 256         p_vout->psz_filter_chain = config_GetPsz( p_parent, "filter" );
 257     }
 258     else
 259     {
 260         /* continue the parent's filter chain */
 261         char *psz_end;
 262
 263         psz_end = strchr( ((vout_thread_t *)p_parent)->psz_filter_chain, ':' );
 264         if( psz_end && *(psz_end+1) )
 265             p_vout->psz_filter_chain = strdup( psz_end+1 );
 266         else p_vout->psz_filter_chain = NULL;
 267     }
 268
 269     /* Choose the video output module */
 270     if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
 271     {
 272         psz_plugin = config_GetPsz( p_parent, "vout" );
 273     }
 274     else
 275     {
 276         /* the filter chain is a string list of filters separated by double
 277          * colons */
 278         char *psz_end;
 279
 280         psz_end = strchr( p_vout->psz_filter_chain, ':' );
 281         if( psz_end )
 282             psz_plugin = strndup( p_vout->psz_filter_chain,
 283                                   psz_end - p_vout->psz_filter_chain );
 284         else psz_plugin = strdup( p_vout->psz_filter_chain );
 285     }
 286
 287     /* Initialize pictures and subpictures - translation tables and functions
 288      * will be initialized later in InitThread */
 289     for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES; i_index++)
 290     {
 291         p_vout->p_picture[i_index].i_status = FREE_PICTURE;
 292         p_vout->p_picture[i_index].i_type   = EMPTY_PICTURE;
 293     }
 294
 295     for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++)
 296     {
 297         p_vout->p_subpicture[i_index].i_status = FREE_SUBPICTURE;
 298         p_vout->p_subpicture[i_index].i_type   = EMPTY_SUBPICTURE;
 299     }
 300
 301     /* No images in the heap */
 302     p_vout->i_heap_size = 0;
 303
 304     /* Initialize the rendering heap */
 305     I_RENDERPICTURES = 0;
 306     p_vout->render.i_width    = i_width;
 307     p_vout->render.i_height   = i_height;
 308     p_vout->render.i_chroma   = i_chroma;
 309     p_vout->render.i_aspect   = i_aspect;
 310
 311     p_vout->render.i_rmask    = 0;
 312     p_vout->render.i_gmask    = 0;
 313     p_vout->render.i_bmask    = 0;
 314
 315     p_vout->render.i_last_used_pic = -1;
 316     p_vout->render.b_allow_modify_pics = 1;
 317
 318     /* Zero the output heap */
 319     I_OUTPUTPICTURES = 0;
 320     p_vout->output.i_width    = 0;
 321     p_vout->output.i_height   = 0;
 322     p_vout->output.i_chroma   = 0;
 323     p_vout->output.i_aspect   = 0;
 324
 325     p_vout->output.i_rmask    = 0;
 326     p_vout->output.i_gmask    = 0;
 327     p_vout->output.i_bmask    = 0;
 328
 329     /* Initialize misc stuff */
 330     p_vout->i_changes    = 0;
 331     p_vout->f_gamma      = 0;
 332     p_vout->b_grayscale  = 0;
 333     p_vout->b_info       = 0;
 334     p_vout->b_interface  = 0;
 335     p_vout->b_scale      = 1;
 336     p_vout->b_fullscreen = 0;
 337     p_vout->render_time  = 10;
 338     p_vout->c_fps_samples = 0;
 339     p_vout->b_filter_change = 0;
 340
 341     /* Mouse coordinates */
 342     var_Create( p_vout, "mouse-x", VLC_VAR_INTEGER );
 343     var_Create( p_vout, "mouse-y", VLC_VAR_INTEGER );
 344     var_Create( p_vout, "mouse-button-down", VLC_VAR_INTEGER );
 345     var_Create( p_vout, "mouse-moved", VLC_VAR_BOOL );
 346     var_Create( p_vout, "mouse-clicked", VLC_VAR_INTEGER );
 347     var_Create( p_vout, "key-pressed", VLC_VAR_STRING );
 348
 349     /* user requested fullscreen? */
 350     if( config_GetInt( p_vout, "fullscreen" ) )
 351     {
 352         p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
 353     }
 354
 355     /* Initialize the dimensions of the video window */
 356     InitWindowSize( p_vout, &p_vout->i_window_width,
 357                     &p_vout->i_window_height );
 358
 359
 360     p_vout->p_module = module_Need( p_vout,
 361                            ( p_vout->psz_filter_chain &&
 362                                *p_vout->psz_filter_chain ) ?
 363                            "video filter" : "video output",
 364                            psz_plugin );
 365
 366     if( psz_plugin ) free( psz_plugin );
 367     if( p_vout->p_module == NULL )
 368     {
 369         msg_Err( p_vout, "no suitable vout module" );
 370         vlc_object_destroy( p_vout );
 371         return NULL;
 372     }
 373
 374     /* Calculate delay created by internal caching */
 375     p_input_thread = (input_thread_t *)vlc_object_find( p_vout,
 376                                            VLC_OBJECT_INPUT, FIND_ANYWHERE );
 377     if( p_input_thread )
 378     {
 379         p_vout->i_pts_delay = p_input_thread->i_pts_delay;
 380         vlc_object_release( p_input_thread );
 381     }
 382     else
 383     {
 384         p_vout->i_pts_delay = DEFAULT_PTS_DELAY;
 385     }
 386
 387     /* Create thread and set locks */
 388     vlc_mutex_init( p_vout, &p_vout->picture_lock );
 389     vlc_mutex_init( p_vout, &p_vout->subpicture_lock );
 390     vlc_mutex_init( p_vout, &p_vout->change_lock );
 391
 392     vlc_object_attach( p_vout, p_parent );
 393
 394     if( vlc_thread_create( p_vout, "video output", RunThread,
 395                            VLC_THREAD_PRIORITY_OUTPUT, VLC_FALSE ) )
 396     {
 397         msg_Err( p_vout, "out of memory" );
 398         module_Unneed( p_vout, p_vout->p_module );
 399         vlc_object_destroy( p_vout );
 400         return NULL;
 401     }
 402
 403     return p_vout;
 404 }
 405
 406 /*****************************************************************************
 407  * vout_Destroy: destroys a previously created video output
 408  *****************************************************************************
 409  * Destroy a terminated thread.
 410  * The function will request a destruction of the specified thread. If pi_error
 411  * is NULL, it will return once the thread is destroyed. Else, it will be
 412  * update using one of the THREAD_* constants.
 413  *****************************************************************************/
 414 void vout_Destroy( vout_thread_t *p_vout )
 415 {
 416     /* Request thread destruction */
 417     p_vout->b_die = VLC_TRUE;
 418     vlc_thread_join( p_vout );
 419
 420     var_Destroy( p_vout, "intf-change" );
 421
 422     /* Free structure */
 423     vlc_object_destroy( p_vout );
 424 }
 425
 426 /*****************************************************************************
 427  * InitThread: initialize video output thread
 428  *****************************************************************************
 429  * This function is called from RunThread and performs the second step of the
 430  * initialization. It returns 0 on success. Note that the thread's flag are not
 431  * modified inside this function.
 432  *****************************************************************************/
 433 static int InitThread( vout_thread_t *p_vout )
 434 {
 435     int i, i_pgcd;
 436
 437     vlc_mutex_lock( &p_vout->change_lock );
 438
 439 #ifdef STATS
 440     p_vout->c_loops = 0;
 441 #endif
 442
 443     /* Initialize output method, it allocates direct buffers for us */
 444     if( p_vout->pf_init( p_vout ) )
 445     {
 446         vlc_mutex_unlock( &p_vout->change_lock );
 447         return VLC_EGENERIC;
 448     }
 449
 450     if( !I_OUTPUTPICTURES )
 451     {
 452         msg_Err( p_vout, "plugin was unable to allocate at least "
 453                          "one direct buffer" );
 454         p_vout->pf_end( p_vout );
 455         vlc_mutex_unlock( &p_vout->change_lock );
 456         return VLC_EGENERIC;
 457     }
 458
 459     if( I_OUTPUTPICTURES > VOUT_MAX_PICTURES )
 460     {
 461         msg_Err( p_vout, "plugin allocated too many direct buffers, "
 462                          "our internal buffers must have overflown." );
 463         p_vout->pf_end( p_vout );
 464         vlc_mutex_unlock( &p_vout->change_lock );
 465         return VLC_EGENERIC;
 466     }
 467
 468     msg_Dbg( p_vout, "got %i direct buffer(s)", I_OUTPUTPICTURES );
 469
 470 #if 0
 471     if( !p_vout->psz_filter_chain )
 472     {
 473         char *psz_aspect = config_GetPsz( p_vout, "pixel-ratio" );
 474
 475         if( psz_aspect )
 476         {
 477             int i_new_aspect = p_vout->output.i_width * VOUT_ASPECT_FACTOR
 478                                                       * atof( psz_aspect )
 479                                                       / p_vout->output.i_height;
 480             free( psz_aspect );
 481
 482             if( i_new_aspect && i_new_aspect != p_vout->output.i_aspect )
 483             {
 484                 int i_pgcd = ReduceHeight( i_new_aspect );
 485                 msg_Dbg( p_vout, "output ratio forced to %i:%i\n",
 486                          i_new_aspect / i_pgcd, VOUT_ASPECT_FACTOR / i_pgcd );
 487                 p_vout->output.i_aspect = i_new_aspect;
 488             }
 489         }
 490     }
 491 #endif
 492
 493     i_pgcd = ReduceHeight( p_vout->render.i_aspect );
 494     msg_Dbg( p_vout,
 495              "picture in %ix%i, chroma 0x%.8x (%4.4s), aspect ratio %i:%i",
 496              p_vout->render.i_width, p_vout->render.i_height,
 497              p_vout->render.i_chroma, (char*)&p_vout->render.i_chroma,
 498              p_vout->render.i_aspect / i_pgcd, VOUT_ASPECT_FACTOR / i_pgcd );
 499
 500     i_pgcd = ReduceHeight( p_vout->output.i_aspect );
 501     msg_Dbg( p_vout,
 502              "picture out %ix%i, chroma 0x%.8x (%4.4s), aspect ratio %i:%i",
 503              p_vout->output.i_width, p_vout->output.i_height,
 504              p_vout->output.i_chroma, (char*)&p_vout->output.i_chroma,
 505              p_vout->output.i_aspect / i_pgcd, VOUT_ASPECT_FACTOR / i_pgcd );
 506
 507     /* Calculate shifts from system-updated masks */
 508     MaskToShift( &p_vout->output.i_lrshift, &p_vout->output.i_rrshift,
 509                  p_vout->output.i_rmask );
 510     MaskToShift( &p_vout->output.i_lgshift, &p_vout->output.i_rgshift,
 511                  p_vout->output.i_gmask );
 512     MaskToShift( &p_vout->output.i_lbshift, &p_vout->output.i_rbshift,
 513                  p_vout->output.i_bmask );
 514
 515     /* Check whether we managed to create direct buffers similar to
 516      * the render buffers, ie same size and chroma */
 517     if( ( p_vout->output.i_width == p_vout->render.i_width )
 518      && ( p_vout->output.i_height == p_vout->render.i_height )
 519      && ( vout_ChromaCmp( p_vout->output.i_chroma, p_vout->render.i_chroma ) ) )
 520     {
 521         /* Cool ! We have direct buffers, we can ask the decoder to
 522          * directly decode into them ! Map the first render buffers to
 523          * the first direct buffers, but keep the first direct buffer
 524          * for memcpy operations */
 525         p_vout->b_direct = 1;
 526
 527         for( i = 1; i < VOUT_MAX_PICTURES; i++ )
 528         {
 529             if( p_vout->p_picture[ i ].i_type != DIRECT_PICTURE &&
 530                 I_RENDERPICTURES >= VOUT_MIN_DIRECT_PICTURES - 1 &&
 531                 p_vout->p_picture[ i - 1 ].i_type == DIRECT_PICTURE )
 532             {
 533                 /* We have enough direct buffers so there's no need to
 534                  * try to use system memory buffers. */
 535                 break;
 536             }
 537             PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
 538             I_RENDERPICTURES++;
 539         }
 540
 541         msg_Dbg( p_vout, "direct render, mapping "
 542                  "render pictures 0-%i to system pictures 1-%i",
 543                  VOUT_MAX_PICTURES - 2, VOUT_MAX_PICTURES - 1 );
 544     }
 545     else
 546     {
 547         /* Rats... Something is wrong here, we could not find an output
 548          * plugin able to directly render what we decode. See if we can
 549          * find a chroma plugin to do the conversion */
 550         p_vout->b_direct = 0;
 551
 552         /* Choose the best module */
 553         p_vout->chroma.p_module = module_Need( p_vout, "chroma", NULL );
 554
 555         if( p_vout->chroma.p_module == NULL )
 556         {
 557             msg_Err( p_vout, "no chroma module for %4.4s to %4.4s",
 558                      (char*)&p_vout->render.i_chroma,
 559                      (char*)&p_vout->output.i_chroma );
 560             p_vout->pf_end( p_vout );
 561             vlc_mutex_unlock( &p_vout->change_lock );
 562             return VLC_EGENERIC;
 563         }
 564
 565         msg_Dbg( p_vout, "indirect render, mapping "
 566                  "render pictures 0-%i to system pictures %i-%i",
 567                  VOUT_MAX_PICTURES - 1, I_OUTPUTPICTURES,
 568                  I_OUTPUTPICTURES + VOUT_MAX_PICTURES - 1 );
 569
 570         /* Append render buffers after the direct buffers */
 571         for( i = I_OUTPUTPICTURES; i < 2 * VOUT_MAX_PICTURES; i++ )
 572         {
 573             PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
 574             I_RENDERPICTURES++;
 575
 576             /* Check if we have enough render pictures */
 577             if( I_RENDERPICTURES == VOUT_MAX_PICTURES )
 578                 break;
 579         }
 580     }
 581
 582     /* Link pictures back to their heap */
 583     for( i = 0 ; i < I_RENDERPICTURES ; i++ )
 584     {
 585         PP_RENDERPICTURE[ i ]->p_heap = &p_vout->render;
 586     }
 587
 588     for( i = 0 ; i < I_OUTPUTPICTURES ; i++ )
 589     {
 590         PP_OUTPUTPICTURE[ i ]->p_heap = &p_vout->output;
 591     }
 592
 593 /* XXX XXX mark thread ready */
 594     return VLC_SUCCESS;
 595 }
 596
 597 /*****************************************************************************
 598  * RunThread: video output thread
 599  *****************************************************************************
 600  * Video output thread. This function does only returns when the thread is
 601  * terminated. It handles the pictures arriving in the video heap and the
 602  * display device events.
 603  *****************************************************************************/
 604 static void RunThread( vout_thread_t *p_vout)
 605 {
 606     int             i_index;                                /* index in heap */
 607     int             i_idle_loops = 0;  /* loops without displaying a picture */
 608     mtime_t         current_date;                            /* current date */
 609     mtime_t         display_date;                            /* display date */
 610
 611     picture_t *     p_picture;                            /* picture pointer */
 612     picture_t *     p_last_picture = NULL;                   /* last picture */
 613     picture_t *     p_directbuffer;              /* direct buffer to display */
 614
 615     subpicture_t *  p_subpic;                          /* subpicture pointer */
 616
 617     /*
 618      * Initialize thread
 619      */
 620     p_vout->b_error = InitThread( p_vout );
 621     if( p_vout->b_error )
 622     {
 623         /* Destroy thread structures allocated by Create and InitThread */
 624         DestroyThread( p_vout );
 625         return;
 626     }
 627
 628     /*
 629      * Main loop - it is not executed if an error occured during
 630      * initialization
 631      */
 632     while( (!p_vout->b_die) && (!p_vout->b_error) )
 633     {
 634         /* Initialize loop variables */
 635         p_picture = NULL;
 636         display_date = 0;
 637         current_date = mdate();
 638
 639 #ifdef STATS
 640         p_vout->c_loops++;
 641         if( !(p_vout->c_loops % VOUT_STATS_NB_LOOPS) )
 642         {
 643             msg_Dbg( p_vout, "picture heap: %d/%d",
 644                      I_RENDERPICTURES, p_vout->i_heap_size );
 645         }
 646 #endif
 647
 648         /*
 649          * Find the picture to display (the one with the earliest date).
 650          * This operation does not need lock, since only READY_PICTUREs
 651          * are handled. */
 652         for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
 653         {
 654             if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
 655                 && ( (p_picture == NULL) ||
 656                      (PP_RENDERPICTURE[i_index]->date < display_date) ) )
 657             {
 658                 p_picture = PP_RENDERPICTURE[i_index];
 659                 display_date = p_picture->date;
 660             }
 661         }
 662
 663         if( p_picture )
 664         {
 665             /* If we met the last picture, parse again to see whether there is
 666              * a more appropriate one. */
 667             if( p_picture == p_last_picture )
 668             {
 669                 for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
 670                 {
 671                     if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
 672                         && (PP_RENDERPICTURE[i_index] != p_last_picture)
 673                         && ((p_picture == p_last_picture) ||
 674                             (PP_RENDERPICTURE[i_index]->date < display_date)) )
 675                     {
 676                         p_picture = PP_RENDERPICTURE[i_index];
 677                         display_date = p_picture->date;
 678                     }
 679                 }
 680             }
 681
 682             /* If we found better than the last picture, destroy it */
 683             if( p_last_picture && p_picture != p_last_picture )
 684             {
 685                 vlc_mutex_lock( &p_vout->picture_lock );
 686                 if( p_last_picture->i_refcount )
 687                 {
 688                     p_last_picture->i_status = DISPLAYED_PICTURE;
 689                 }
 690                 else
 691                 {
 692                     p_last_picture->i_status = DESTROYED_PICTURE;
 693                     p_vout->i_heap_size--;
 694                 }
 695                 vlc_mutex_unlock( &p_vout->picture_lock );
 696                 p_last_picture = NULL;
 697             }
 698
 699             /* Compute FPS rate */
 700             p_vout->p_fps_sample[ p_vout->c_fps_samples++ % VOUT_FPS_SAMPLES ]
 701                 = display_date;
 702
 703             if( !p_picture->b_force &&
 704                 p_picture != p_last_picture &&
 705                 display_date < current_date + p_vout->render_time )
 706             {
 707                 /* Picture is late: it will be destroyed and the thread
 708                  * will directly choose the next picture */
 709                 vlc_mutex_lock( &p_vout->picture_lock );
 710                 if( p_picture->i_refcount )
 711                 {
 712                     /* Pretend we displayed the picture, but don't destroy
 713                      * it since the decoder might still need it. */
 714                     p_picture->i_status = DISPLAYED_PICTURE;
 715                 }
 716                 else
 717                 {
 718                     /* Destroy the picture without displaying it */
 719                     p_picture->i_status = DESTROYED_PICTURE;
 720                     p_vout->i_heap_size--;
 721                 }
 722                 msg_Warn( p_vout, "late picture skipped ("I64Fd")",
 723                                   current_date - display_date );
 724                 vlc_mutex_unlock( &p_vout->picture_lock );
 725
 726                 continue;
 727             }
 728
 729             if( display_date >
 730                 current_date + p_vout->i_pts_delay +  VOUT_BOGUS_DELAY )
 731             {
 732                 /* Picture is waaay too early: it will be destroyed */
 733                 vlc_mutex_lock( &p_vout->picture_lock );
 734                 if( p_picture->i_refcount )
 735                 {
 736                     /* Pretend we displayed the picture, but don't destroy
 737                      * it since the decoder might still need it. */
 738                     p_picture->i_status = DISPLAYED_PICTURE;
 739                 }
 740                 else
 741                 {
 742                     /* Destroy the picture without displaying it */
 743                     p_picture->i_status = DESTROYED_PICTURE;
 744                     p_vout->i_heap_size--;
 745                 }
 746                 msg_Warn( p_vout, "vout warning: early picture skipped "
 747                           "("I64Fd")", display_date - current_date
 748                           - p_vout->i_pts_delay );
 749                 vlc_mutex_unlock( &p_vout->picture_lock );
 750
 751                 continue;
 752             }
 753
 754             if( display_date > current_date + VOUT_DISPLAY_DELAY )
 755             {
 756                 /* A picture is ready to be rendered, but its rendering date
 757                  * is far from the current one so the thread will perform an
 758                  * empty loop as if no picture were found. The picture state
 759                  * is unchanged */
 760                 p_picture    = NULL;
 761                 display_date = 0;
 762             }
 763             else if( p_picture == p_last_picture )
 764             {
 765                 /* We are asked to repeat the previous picture, but we first
 766                  * wait for a couple of idle loops */
 767                 if( i_idle_loops < 4 )
 768                 {
 769                     p_picture    = NULL;
 770                     display_date = 0;
 771                 }
 772                 else
 773                 {
 774                     /* We set the display date to something high, otherwise
 775                      * we'll have lots of problems with late pictures */
 776                     display_date = current_date + p_vout->render_time;
 777                 }
 778             }
 779         }
 780
 781         if( p_picture == NULL )
 782         {
 783             i_idle_loops++;
 784         }
 785
 786         /*
 787          * Check for subpictures to display
 788          */
 789         p_subpic = vout_SortSubPictures( p_vout, display_date );
 790
 791         /*
 792          * Perform rendering
 793          */
 794         p_directbuffer = vout_RenderPicture( p_vout, p_picture, p_subpic );
 795
 796         /*
 797          * Call the plugin-specific rendering method if there is one
 798          */
 799         if( p_picture != NULL && p_vout->pf_render )
 800         {
 801             /* Render the direct buffer returned by vout_RenderPicture */
 802             p_vout->pf_render( p_vout, p_directbuffer );
 803         }
 804
 805         /*
 806          * Sleep, wake up
 807          */
 808         if( display_date != 0 )
 809         {
 810             /* Store render time using a sliding mean */
 811             p_vout->render_time += mdate() - current_date;
 812             p_vout->render_time >>= 1;
 813         }
 814
 815         /* Give back change lock */
 816         vlc_mutex_unlock( &p_vout->change_lock );
 817
 818         /* Sleep a while or until a given date */
 819         if( display_date != 0 )
 820         {
 821             mwait( display_date - VOUT_MWAIT_TOLERANCE );
 822         }
 823         else
 824         {
 825             msleep( VOUT_IDLE_SLEEP );
 826         }
 827
 828         /* On awakening, take back lock and send immediately picture
 829          * to display. */
 830         vlc_mutex_lock( &p_vout->change_lock );
 831
 832         /*
 833          * Display the previously rendered picture
 834          */
 835         if( p_picture != NULL )
 836         {
 837             /* Display the direct buffer returned by vout_RenderPicture */
 838             if( p_vout->pf_display )
 839             {
 840                 p_vout->pf_display( p_vout, p_directbuffer );
 841             }
 842
 843             /* Reinitialize idle loop count */
 844             i_idle_loops = 0;
 845
 846             /* Tell the vout this was the last picture and that it does not
 847              * need to be forced anymore. */
 848             p_last_picture = p_picture;
 849             p_last_picture->b_force = 0;
 850         }
 851
 852         /*
 853          * Check events and manage thread
 854          */
 855         if( p_vout->pf_manage && p_vout->pf_manage( p_vout ) )
 856         {
 857             /* A fatal error occured, and the thread must terminate
 858              * immediately, without displaying anything - setting b_error to 1
 859              * causes the immediate end of the main while() loop. */
 860             p_vout->b_error = 1;
 861         }
 862
 863         if( p_vout->i_changes & VOUT_SIZE_CHANGE )
 864         {
 865             /* this must only happen when the vout plugin is incapable of
 866              * rescaling the picture itself. In this case we need to destroy
 867              * the current picture buffers and recreate new ones with the right
 868              * dimensions */
 869             int i;
 870
 871             p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
 872
 873             p_vout->pf_end( p_vout );
 874             for( i = 0; i < I_OUTPUTPICTURES; i++ )
 875                  p_vout->p_picture[ i ].i_status = FREE_PICTURE;
 876
 877             I_OUTPUTPICTURES = 0;
 878             if( p_vout->pf_init( p_vout ) )
 879             {
 880                 msg_Err( p_vout, "cannot resize display" );
 881                 /* FIXME: pf_end will be called again in EndThread() */
 882                 p_vout->b_error = 1;
 883             }
 884
 885             /* Need to reinitialise the chroma plugin */
 886             p_vout->chroma.p_module->pf_deactivate( VLC_OBJECT(p_vout) );
 887             p_vout->chroma.p_module->pf_activate( VLC_OBJECT(p_vout) );
 888         }
 889     }
 890
 891     /*
 892      * Error loop - wait until the thread destruction is requested
 893      */
 894     if( p_vout->b_error )
 895     {
 896         ErrorThread( p_vout );
 897     }
 898
 899     /* End of thread */
 900     EndThread( p_vout );
 901
 902     /* Destroy thread structures allocated by CreateThread */
 903     DestroyThread( p_vout );
 904 }
 905
 906 /*****************************************************************************
 907  * ErrorThread: RunThread() error loop
 908  *****************************************************************************
 909  * This function is called when an error occured during thread main's loop. The
 910  * thread can still receive feed, but must be ready to terminate as soon as
 911  * possible.
 912  *****************************************************************************/
 913 static void ErrorThread( vout_thread_t *p_vout )
 914 {
 915     /* Wait until a `die' order */
 916     while( !p_vout->b_die )
 917     {
 918         /* Sleep a while */
 919         msleep( VOUT_IDLE_SLEEP );
 920     }
 921 }
 922
 923 /*****************************************************************************
 924  * EndThread: thread destruction
 925  *****************************************************************************
 926  * This function is called when the thread ends after a sucessful
 927  * initialization. It frees all ressources allocated by InitThread.
 928  *****************************************************************************/
 929 static void EndThread( vout_thread_t *p_vout )
 930 {
 931     int     i_index;                                        /* index in heap */
 932
 933 #ifdef STATS
 934     {
 935         struct tms cpu_usage;
 936         times( &cpu_usage );
 937
 938         msg_Dbg( p_vout, "cpu usage (user: %d, system: %d)",
 939                  cpu_usage.tms_utime, cpu_usage.tms_stime );
 940     }
 941 #endif
 942
 943     if( !p_vout->b_direct )
 944     {
 945         module_Unneed( p_vout, p_vout->chroma.p_module );
 946     }
 947
 948     /* Destroy all remaining pictures */
 949     for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES; i_index++ )
 950     {
 951         if ( p_vout->p_picture[i_index].i_type == MEMORY_PICTURE )
 952         {
 953             free( p_vout->p_picture[i_index].p_data_orig );
 954         }
 955     }
 956
 957     /* Destroy all remaining subpictures */
 958     for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
 959     {
 960         if( p_vout->p_subpicture[i_index].i_status != FREE_SUBPICTURE )
 961         {
 962             vout_DestroySubPicture( p_vout,
 963                                     &p_vout->p_subpicture[i_index] );
 964         }
 965     }
 966
 967     /* Destroy translation tables */
 968     p_vout->pf_end( p_vout );
 969
 970     /* Release the change lock */
 971     vlc_mutex_unlock( &p_vout->change_lock );
 972 }
 973
 974 /*****************************************************************************
 975  * DestroyThread: thread destruction
 976  *****************************************************************************
 977  * This function is called when the thread ends. It frees all ressources
 978  * allocated by CreateThread. Status is available at this stage.
 979  *****************************************************************************/
 980 static void DestroyThread( vout_thread_t *p_vout )
 981 {
 982     /* Destroy the locks */
 983     vlc_mutex_destroy( &p_vout->picture_lock );
 984     vlc_mutex_destroy( &p_vout->subpicture_lock );
 985     vlc_mutex_destroy( &p_vout->change_lock );
 986
 987     /* Release the module */
 988     module_Unneed( p_vout, p_vout->p_module );
 989 }
 990
 991 /* following functions are local */
 992
 993 static int ReduceHeight( int i_ratio )
 994 {
 995     int i_dummy = VOUT_ASPECT_FACTOR;
 996     int i_pgcd  = 1;
 997
 998     if( !i_ratio )
 999     {
1000         return i_pgcd;
1001     }
1002
1003     /* VOUT_ASPECT_FACTOR is (2^7 * 3^3 * 5^3), we just check for 2, 3 and 5 */
1004     while( !(i_ratio & 1) && !(i_dummy & 1) )
1005     {
1006         i_ratio >>= 1;
1007         i_dummy >>= 1;
1008         i_pgcd  <<= 1;
1009     }
1010
1011     while( !(i_ratio % 3) && !(i_dummy % 3) )
1012     {
1013         i_ratio /= 3;
1014         i_dummy /= 3;
1015         i_pgcd  *= 3;
1016     }
1017
1018     while( !(i_ratio % 5) && !(i_dummy % 5) )
1019     {
1020         i_ratio /= 5;
1021         i_dummy /= 5;
1022         i_pgcd  *= 5;
1023     }
1024
1025     return i_pgcd;
1026 }
1027
1028 /*****************************************************************************
1029  * BinaryLog: computes the base 2 log of a binary value
1030  *****************************************************************************
1031  * This functions is used by MaskToShift, to get a bit index from a binary
1032  * value.
1033  *****************************************************************************/
1034 static int BinaryLog( uint32_t i )
1035 {
1036     int i_log = 0;
1037
1038     if( i == 0 ) return -31337;
1039
1040     if( i & 0xffff0000 ) i_log += 16;
1041     if( i & 0xff00ff00 ) i_log += 8;
1042     if( i & 0xf0f0f0f0 ) i_log += 4;
1043     if( i & 0xcccccccc ) i_log += 2;
1044     if( i & 0xaaaaaaaa ) i_log += 1;
1045
1046     return i_log;
1047 }
1048
1049 /*****************************************************************************
1050  * MaskToShift: transform a color mask into right and left shifts
1051  *****************************************************************************
1052  * This function is used for obtaining color shifts from masks.
1053  *****************************************************************************/
1054 static void MaskToShift( int *pi_left, int *pi_right, uint32_t i_mask )
1055 {
1056     uint32_t i_low, i_high;            /* lower hand higher bits of the mask */
1057
1058     if( !i_mask )
1059     {
1060         *pi_left = *pi_right = 0;
1061         return;
1062     }
1063
1064     /* Get bits */
1065     i_low =  i_mask & (- (int32_t)i_mask);          /* lower bit of the mask */
1066     i_high = i_mask + i_low;                       /* higher bit of the mask */
1067
1068     /* Transform bits into an index */
1069     i_low =  BinaryLog (i_low);
1070     i_high = BinaryLog (i_high);
1071
1072     /* Update pointers and return */
1073     *pi_left =   i_low;
1074     *pi_right = (8 - i_high + i_low);
1075 }
1076
1077 /*****************************************************************************
1078  * InitWindowSize: find the initial dimensions the video window should have.
1079  *****************************************************************************
1080  * This function will check the "width", "height" and "zoom" config options and
1081  * will calculate the size that the video window should have.
1082  *****************************************************************************/
1083 static void InitWindowSize( vout_thread_t *p_vout, int *pi_width,
1084                             int *pi_height )
1085 {
1086     int i_width, i_height;
1087     uint64_t ll_zoom;
1088
1089 #define FP_FACTOR 1000                             /* our fixed point factor */
1090
1091     i_width = config_GetInt( p_vout, "width" );
1092     i_height = config_GetInt( p_vout, "height" );
1093     ll_zoom = (uint64_t)( FP_FACTOR * config_GetFloat( p_vout, "zoom" ) );
1094
1095     if( (i_width >= 0) && (i_height >= 0))
1096     {
1097         *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
1098         *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
1099         return;
1100     }
1101     else if( i_width >= 0 )
1102     {
1103         *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
1104         *pi_height = (int)( i_width * ll_zoom * VOUT_ASPECT_FACTOR /
1105                             p_vout->render.i_aspect / FP_FACTOR );
1106         return;
1107     }
1108     else if( i_height >= 0 )
1109     {
1110         *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
1111         *pi_width = (int)( i_height * ll_zoom * p_vout->render.i_aspect /
1112                            VOUT_ASPECT_FACTOR / FP_FACTOR );
1113         return;
1114     }
1115
1116     if( p_vout->render.i_height * p_vout->render.i_aspect
1117         >= p_vout->render.i_width * VOUT_ASPECT_FACTOR )
1118     {
1119         *pi_width = (int)( p_vout->render.i_height * ll_zoom
1120           * p_vout->render.i_aspect / VOUT_ASPECT_FACTOR / FP_FACTOR );
1121         *pi_height = (int)( p_vout->render.i_height * ll_zoom / FP_FACTOR );
1122     }
1123     else
1124     {
1125         *pi_width = (int)( p_vout->render.i_width * ll_zoom / FP_FACTOR );
1126         *pi_height = (int)( p_vout->render.i_width * ll_zoom
1127           * VOUT_ASPECT_FACTOR / p_vout->render.i_aspect / FP_FACTOR );
1128     }
1129
1130 #undef FP_FACTOR
1131 }
1132
1133 /*****************************************************************************
1134  * vout_VarCallback: generic callback for intf variables
1135  *****************************************************************************/
1136 int vout_VarCallback( vlc_object_t * p_this, const char * psz_variable,
1137                       vlc_value_t old_value, vlc_value_t new_value,
1138                       void * unused )
1139 {
1140     vout_thread_t * p_vout = (vout_thread_t *)p_this;
1141     vlc_value_t val;
1142     val.b_bool = 1;
1143     var_Set( p_vout, "intf-change", val );
1144     return 0;
1145 }