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