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

   1 /*****************************************************************************
   2  * video_output.c : video output thread
   3  *
   4  * This module describes the programming interface for video output threads.
   5  * It includes functions allowing to open a new thread, send pictures to a
   6  * thread, and destroy a previously oppened video output thread.
   7  *****************************************************************************
   8  * Copyright (C) 2000-2007 the VideoLAN team
   9  * $Id$
  10  *
  11  * Authors: Vincent Seguin <seguin@via.ecp.fr>
  12  *          Gildas Bazin <gbazin@videolan.org>
  13  *
  14  * This program is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 2 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with this program; if not, write to the Free Software
  26  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  27  *****************************************************************************/
  28
  29 /*****************************************************************************
  30  * Preamble
  31  *****************************************************************************/
  32 #ifdef HAVE_CONFIG_H
  33 # include "config.h"
  34 #endif
  35
  36 #include <vlc/vlc.h>
  37
  38 #include <stdlib.h>                                                /* free() */
  39 #include <string.h>
  40
  41
  42 #ifdef HAVE_SYS_TIMES_H
  43 #   include <sys/times.h>
  44 #endif
  45
  46 #include <vlc_vout.h>
  47 #include <vlc_playlist.h>
  48
  49 #include <vlc_filter.h>
  50 #include <vlc_osd.h>
  51
  52 #if defined( __APPLE__ )
  53 /* Include darwin_specific.h here if needed */
  54 #endif
  55
  56 /** FIXME This is quite ugly but needed while we don't have counters
  57  * helpers */
  58 #include "input/input_internal.h"
  59
  60 #include "modules/modules.h"
  61
  62 /*****************************************************************************
  63  * Local prototypes
  64  *****************************************************************************/
  65 static int      InitThread        ( vout_thread_t * );
  66 static void     RunThread         ( vout_thread_t * );
  67 static void     ErrorThread       ( vout_thread_t * );
  68 static void     EndThread         ( vout_thread_t * );
  69
  70 static void     AspectRatio       ( int, int *, int * );
  71 static int      BinaryLog         ( uint32_t );
  72 static void     MaskToShift       ( int *, int *, uint32_t );
  73
  74 static void     vout_Destructor   ( vlc_object_t * p_this );
  75
  76 /* Object variables callbacks */
  77 static int DeinterlaceCallback( vlc_object_t *, char const *,
  78                                 vlc_value_t, vlc_value_t, void * );
  79 static int FilterCallback( vlc_object_t *, char const *,
  80                            vlc_value_t, vlc_value_t, void * );
  81 static int VideoFilter2Callback( vlc_object_t *, char const *,
  82                                  vlc_value_t, vlc_value_t, void * );
  83
  84 /* From vout_intf.c */
  85 int vout_Snapshot( vout_thread_t *, picture_t * );
  86
  87 /* Video filter2 parsing */
  88 static int ParseVideoFilter2Chain( vout_thread_t *, char * );
  89 static void RemoveVideoFilters2( vout_thread_t *p_vout );
  90
  91 /* Display media title in OSD */
  92 static void DisplayTitleOnOSD( vout_thread_t *p_vout );
  93
  94 /*****************************************************************************
  95  * Video Filter2 functions
  96  *****************************************************************************/
  97 struct filter_owner_sys_t
  98 {
  99     vout_thread_t *p_vout;
 100 };
 101
 102 static picture_t *video_new_buffer_filter( filter_t *p_filter )
 103 {
 104     picture_t *p_picture;
 105     vout_thread_t *p_vout = p_filter->p_owner->p_vout;
 106
 107     p_picture = vout_CreatePicture( p_vout, 0, 0, 0 );
 108
 109     return p_picture;
 110 }
 111
 112 static void video_del_buffer_filter( filter_t *p_filter, picture_t *p_pic )
 113 {
 114     vout_DestroyPicture( p_filter->p_owner->p_vout, p_pic );
 115 }
 116
 117 /*****************************************************************************
 118  * vout_Request: find a video output thread, create one, or destroy one.
 119  *****************************************************************************
 120  * This function looks for a video output thread matching the current
 121  * properties. If not found, it spawns a new one.
 122  *****************************************************************************/
 123 vout_thread_t *__vout_Request( vlc_object_t *p_this, vout_thread_t *p_vout,
 124                                video_format_t *p_fmt )
 125 {
 126     if( !p_fmt )
 127     {
 128         /* Reattach video output to playlist before bailing out */
 129         if( p_vout )
 130         {
 131             spu_Attach( p_vout->p_spu, p_this, false );
 132             vlc_object_detach( p_vout );
 133             vlc_object_attach( p_vout, p_this->p_libvlc );
 134         }
 135         return NULL;
 136     }
 137
 138     /* If a video output was provided, lock it, otherwise look for one. */
 139     if( p_vout )
 140     {
 141         vlc_object_yield( p_vout );
 142     }
 143     else
 144     {
 145         p_vout = vlc_object_find( p_this, VLC_OBJECT_VOUT, FIND_CHILD );
 146
 147         if( !p_vout )
 148         {
 149             p_vout = vlc_object_find( p_this->p_libvlc,
 150                                       VLC_OBJECT_VOUT, FIND_CHILD );
 151             /* only first children of p_input for unused vout */
 152             if( p_vout && p_vout->p_parent != VLC_OBJECT(p_this->p_libvlc) )
 153             {
 154                 vlc_object_release( p_vout );
 155                 p_vout = NULL;
 156             }
 157             if( p_vout )
 158                 vlc_object_detach( p_vout );    /* Remove it from the GC */
 159         }
 160     }
 161
 162     /* If we now have a video output, check it has the right properties */
 163     if( p_vout )
 164     {
 165         char *psz_filter_chain;
 166         vlc_value_t val;
 167
 168         /* We don't directly check for the "vout-filter" variable for obvious
 169          * performance reasons. */
 170         if( p_vout->b_filter_change )
 171         {
 172             var_Get( p_vout, "vout-filter", &val );
 173             psz_filter_chain = val.psz_string;
 174
 175             if( psz_filter_chain && !*psz_filter_chain )
 176             {
 177                 free( psz_filter_chain );
 178                 psz_filter_chain = NULL;
 179             }
 180             if( p_vout->psz_filter_chain && !*p_vout->psz_filter_chain )
 181             {
 182                 free( p_vout->psz_filter_chain );
 183                 p_vout->psz_filter_chain = NULL;
 184             }
 185
 186             if( !psz_filter_chain && !p_vout->psz_filter_chain )
 187             {
 188                 p_vout->b_filter_change = false;
 189             }
 190
 191             free( psz_filter_chain );
 192         }
 193
 194         if( ( p_vout->fmt_render.i_width != p_fmt->i_width ) ||
 195             ( p_vout->fmt_render.i_height != p_fmt->i_height ) ||
 196             ( p_vout->fmt_render.i_aspect != p_fmt->i_aspect ) ||
 197             p_vout->b_filter_change )
 198         {
 199             /* We are not interested in this format, close this vout */
 200             vlc_object_release( p_vout );
 201             vout_Destroy( p_vout );
 202             p_vout = NULL;
 203         }
 204         else
 205         {
 206             /* This video output is cool! Hijack it. */
 207             spu_Attach( p_vout->p_spu, p_this, true );
 208             vlc_object_attach( p_vout, p_this );
 209             if( p_vout->b_title_show )
 210                 DisplayTitleOnOSD( p_vout );
 211             vlc_object_release( p_vout );
 212         }
 213     }
 214
 215     if( !p_vout )
 216     {
 217         msg_Dbg( p_this, "no usable vout present, spawning one" );
 218
 219         p_vout = vout_Create( p_this, p_fmt );
 220     }
 221
 222     return p_vout;
 223 }
 224
 225 /*****************************************************************************
 226  * vout_Create: creates a new video output thread
 227  *****************************************************************************
 228  * This function creates a new video output thread, and returns a pointer
 229  * to its description. On error, it returns NULL.
 230  *****************************************************************************/
 231 vout_thread_t * __vout_Create( vlc_object_t *p_parent, video_format_t *p_fmt )
 232 {
 233     vout_thread_t  * p_vout;                            /* thread descriptor */
 234     input_thread_t * p_input_thread;
 235     int              i_index;                               /* loop variable */
 236     vlc_value_t      val, text;
 237
 238     unsigned int i_width = p_fmt->i_width;
 239     unsigned int i_height = p_fmt->i_height;
 240     vlc_fourcc_t i_chroma = p_fmt->i_chroma;
 241     unsigned int i_aspect = p_fmt->i_aspect;
 242
 243     config_chain_t *p_cfg;
 244     char *psz_parser;
 245     char *psz_name;
 246
 247     /* Allocate descriptor */
 248     p_vout = vlc_object_create( p_parent, VLC_OBJECT_VOUT );
 249     if( p_vout == NULL )
 250     {
 251         msg_Err( p_parent, "out of memory" );
 252         return NULL;
 253     }
 254
 255     /* Initialize pictures - translation tables and functions
 256      * will be initialized later in InitThread */
 257     for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++)
 258     {
 259         p_vout->p_picture[i_index].pf_lock = NULL;
 260         p_vout->p_picture[i_index].pf_unlock = NULL;
 261         p_vout->p_picture[i_index].i_status = FREE_PICTURE;
 262         p_vout->p_picture[i_index].i_type   = EMPTY_PICTURE;
 263         p_vout->p_picture[i_index].b_slow   = 0;
 264     }
 265
 266     /* No images in the heap */
 267     p_vout->i_heap_size = 0;
 268
 269     /* Initialize the rendering heap */
 270     I_RENDERPICTURES = 0;
 271
 272     vlc_ureduce( &p_fmt->i_sar_num, &p_fmt->i_sar_den,
 273                  p_fmt->i_sar_num, p_fmt->i_sar_den, 50000 );
 274     p_vout->fmt_render        = *p_fmt;   /* FIXME palette */
 275     p_vout->fmt_in            = *p_fmt;   /* FIXME palette */
 276
 277     p_vout->render.i_width    = i_width;
 278     p_vout->render.i_height   = i_height;
 279     p_vout->render.i_chroma   = i_chroma;
 280     p_vout->render.i_aspect   = i_aspect;
 281
 282     p_vout->render.i_rmask    = 0;
 283     p_vout->render.i_gmask    = 0;
 284     p_vout->render.i_bmask    = 0;
 285
 286     p_vout->render.i_last_used_pic = -1;
 287     p_vout->render.b_allow_modify_pics = 1;
 288
 289     /* Zero the output heap */
 290     I_OUTPUTPICTURES = 0;
 291     p_vout->output.i_width    = 0;
 292     p_vout->output.i_height   = 0;
 293     p_vout->output.i_chroma   = 0;
 294     p_vout->output.i_aspect   = 0;
 295
 296     p_vout->output.i_rmask    = 0;
 297     p_vout->output.i_gmask    = 0;
 298     p_vout->output.i_bmask    = 0;
 299
 300     /* Initialize misc stuff */
 301     p_vout->i_changes    = 0;
 302     p_vout->f_gamma      = 0;
 303     p_vout->b_grayscale  = 0;
 304     p_vout->b_info       = 0;
 305     p_vout->b_interface  = 0;
 306     p_vout->b_scale      = 1;
 307     p_vout->b_fullscreen = 0;
 308     p_vout->i_alignment  = 0;
 309     p_vout->render_time  = 10;
 310     p_vout->c_fps_samples = 0;
 311     p_vout->b_filter_change = 0;
 312     p_vout->pf_control = 0;
 313     p_vout->p_parent_intf = 0;
 314     p_vout->i_par_num = p_vout->i_par_den = 1;
 315
 316     /* Initialize locks */
 317     vlc_mutex_init( &p_vout->picture_lock );
 318     vlc_mutex_init( &p_vout->change_lock );
 319     vlc_mutex_init( &p_vout->vfilter_lock );
 320
 321     /* Mouse coordinates */
 322     var_Create( p_vout, "mouse-x", VLC_VAR_INTEGER );
 323     var_Create( p_vout, "mouse-y", VLC_VAR_INTEGER );
 324     var_Create( p_vout, "mouse-button-down", VLC_VAR_INTEGER );
 325     var_Create( p_vout, "mouse-moved", VLC_VAR_BOOL );
 326     var_Create( p_vout, "mouse-clicked", VLC_VAR_INTEGER );
 327
 328     /* Initialize subpicture unit */
 329     p_vout->p_spu = spu_Create( p_vout );
 330     spu_Attach( p_vout->p_spu, p_parent, true );
 331
 332     /* Attach the new object now so we can use var inheritance below */
 333     vlc_object_attach( p_vout, p_parent );
 334
 335     spu_Init( p_vout->p_spu );
 336
 337     /* Take care of some "interface/control" related initialisations */
 338     vout_IntfInit( p_vout );
 339
 340     /* If the parent is not a VOUT object, that means we are at the start of
 341      * the video output pipe */
 342     if( p_parent->i_object_type != VLC_OBJECT_VOUT )
 343     {
 344         /* Look for the default filter configuration */
 345         var_Create( p_vout, "vout-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 346         var_Get( p_vout, "vout-filter", &val );
 347         p_vout->psz_filter_chain = val.psz_string;
 348
 349         /* Apply video filter2 objects on the first vout */
 350         var_Create( p_vout, "video-filter",
 351                     VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 352         var_Get( p_vout, "video-filter", &val );
 353         ParseVideoFilter2Chain( p_vout, val.psz_string );
 354         free( val.psz_string );
 355     }
 356     else
 357     {
 358         /* continue the parent's filter chain */
 359         char *psz_tmp;
 360
 361         /* Ugly hack to jump to our configuration chain */
 362         p_vout->psz_filter_chain
 363             = ((vout_thread_t *)p_parent)->psz_filter_chain;
 364         p_vout->psz_filter_chain
 365             = config_ChainCreate( &psz_tmp, &p_cfg, p_vout->psz_filter_chain );
 366         config_ChainDestroy( p_cfg );
 367         free( psz_tmp );
 368
 369         /* Create a video filter2 var ... but don't inherit values */
 370         var_Create( p_vout, "video-filter", VLC_VAR_STRING );
 371         ParseVideoFilter2Chain( p_vout, NULL );
 372     }
 373
 374     var_AddCallback( p_vout, "video-filter", VideoFilter2Callback, NULL );
 375     p_vout->b_vfilter_change = true;
 376     p_vout->i_vfilters = 0;
 377
 378     /* Choose the video output module */
 379     if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
 380     {
 381         var_Create( p_vout, "vout", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 382         var_Get( p_vout, "vout", &val );
 383         psz_parser = val.psz_string;
 384     }
 385     else
 386     {
 387         psz_parser = strdup( p_vout->psz_filter_chain );
 388     }
 389
 390     /* Create the vout thread */
 391     config_ChainCreate( &psz_name, &p_cfg, psz_parser );
 392     free( psz_parser );
 393     p_vout->p_cfg = p_cfg;
 394     p_vout->p_module = module_Need( p_vout,
 395         ( p_vout->psz_filter_chain && *p_vout->psz_filter_chain ) ?
 396         "video filter" : "video output", psz_name, p_vout->psz_filter_chain && *p_vout->psz_filter_chain );
 397     free( psz_name );
 398
 399     if( p_vout->p_module == NULL )
 400     {
 401         msg_Err( p_vout, "no suitable vout module" );
 402         vlc_object_detach( p_vout );
 403         vlc_object_release( p_vout );
 404         return NULL;
 405     }
 406
 407     /* Create a few object variables for interface interaction */
 408     var_Create( p_vout, "deinterlace", VLC_VAR_STRING | VLC_VAR_HASCHOICE );
 409     text.psz_string = _("Deinterlace");
 410     var_Change( p_vout, "deinterlace", VLC_VAR_SETTEXT, &text, NULL );
 411     val.psz_string = (char *)""; text.psz_string = _("Disable");
 412     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 413     val.psz_string = (char *)"discard"; text.psz_string = _("Discard");
 414     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 415     val.psz_string = (char *)"blend"; text.psz_string = _("Blend");
 416     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 417     val.psz_string = (char *)"mean"; text.psz_string = _("Mean");
 418     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 419     val.psz_string = (char *)"bob"; text.psz_string = _("Bob");
 420     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 421     val.psz_string = (char *)"linear"; text.psz_string = _("Linear");
 422     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 423     val.psz_string = (char *)"x"; text.psz_string = (char *)"X";
 424     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 425
 426     if( var_Get( p_vout, "deinterlace-mode", &val ) == VLC_SUCCESS )
 427     {
 428         var_Set( p_vout, "deinterlace", val );
 429         free( val.psz_string );
 430     }
 431     var_AddCallback( p_vout, "deinterlace", DeinterlaceCallback, NULL );
 432
 433     var_Create( p_vout, "vout-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 434     text.psz_string = _("Filters");
 435     var_Change( p_vout, "vout-filter", VLC_VAR_SETTEXT, &text, NULL );
 436     var_AddCallback( p_vout, "vout-filter", FilterCallback, NULL );
 437
 438     /* Calculate delay created by internal caching */
 439     p_input_thread = (input_thread_t *)vlc_object_find( p_vout,
 440                                            VLC_OBJECT_INPUT, FIND_ANYWHERE );
 441     if( p_input_thread )
 442     {
 443         p_vout->i_pts_delay = p_input_thread->i_pts_delay;
 444         vlc_object_release( p_input_thread );
 445     }
 446     else
 447     {
 448         p_vout->i_pts_delay = DEFAULT_PTS_DELAY;
 449     }
 450
 451     if( vlc_thread_create( p_vout, "video output", RunThread,
 452                            VLC_THREAD_PRIORITY_OUTPUT, true ) )
 453     {
 454         msg_Err( p_vout, "out of memory" );
 455         module_Unneed( p_vout, p_vout->p_module );
 456         vlc_object_release( p_vout );
 457         return NULL;
 458     }
 459
 460     if( p_vout->b_error )
 461     {
 462         msg_Err( p_vout, "video output creation failed" );
 463
 464         /* Make sure the thread is destroyed */
 465         vlc_object_release( p_vout );
 466         return NULL;
 467     }
 468
 469     vlc_object_set_destructor( p_vout, vout_Destructor );
 470
 471     return p_vout;
 472 }
 473
 474 /*****************************************************************************
 475  * vout_Destroy: destroys a previously created video output
 476  *****************************************************************************
 477  * Destroy a terminated thread.
 478  * The function will request a destruction of the specified thread. If pi_error
 479  * is NULL, it will return once the thread is destroyed. Else, it will be
 480  * update using one of the THREAD_* constants.
 481  *****************************************************************************/
 482 void vout_Destroy( vout_thread_t *p_vout )
 483 {
 484     /* XXX: should go in the destructor */
 485     var_Destroy( p_vout, "intf-change" );
 486
 487     vlc_object_release( p_vout );
 488 }
 489
 490 static void vout_Destructor( vlc_object_t * p_this )
 491 {
 492     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 493
 494     /* Destroy the locks */
 495     vlc_mutex_destroy( &p_vout->picture_lock );
 496     vlc_mutex_destroy( &p_vout->change_lock );
 497     vlc_mutex_destroy( &p_vout->vfilter_lock );
 498
 499     /* Release the module */
 500     if( p_vout->p_module )
 501     {
 502         module_Unneed( p_vout, p_vout->p_module );
 503     }
 504
 505     free( p_vout->psz_filter_chain );
 506
 507     config_ChainDestroy( p_vout->p_cfg );
 508
 509 #ifndef __APPLE__
 510     vout_thread_t *p_another_vout;
 511
 512     playlist_t *p_playlist = vlc_object_find( p_this->p_libvlc,
 513                                         VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
 514     if( !p_playlist )
 515         return;
 516
 517     /* This is a dirty hack mostly for Linux, where there is no way to get the
 518      * GUI back if you closed it while playing video. This is solved in
 519      * Mac OS X, where we have this novelty called menubar, that will always
 520      * allow you access to the applications main functionality. They should try
 521      * that on linux sometime. */
 522     p_another_vout = vlc_object_find( p_this->p_libvlc,
 523                                       VLC_OBJECT_VOUT, FIND_ANYWHERE );
 524     if( p_another_vout == NULL )
 525         var_SetBool( p_playlist, "intf-show", true );
 526     else
 527         vlc_object_release( p_another_vout );
 528     vlc_object_release( p_playlist );
 529 #endif
 530 }
 531
 532 /*****************************************************************************
 533  * InitThread: initialize video output thread
 534  *****************************************************************************
 535  * This function is called from RunThread and performs the second step of the
 536  * initialization. It returns 0 on success. Note that the thread's flag are not
 537  * modified inside this function.
 538  *****************************************************************************/
 539 static int InitThread( vout_thread_t *p_vout )
 540 {
 541     int i, i_aspect_x, i_aspect_y;
 542
 543     vlc_mutex_lock( &p_vout->change_lock );
 544
 545 #ifdef STATS
 546     p_vout->c_loops = 0;
 547 #endif
 548
 549     /* Initialize output method, it allocates direct buffers for us */
 550     if( p_vout->pf_init( p_vout ) )
 551     {
 552         vlc_mutex_unlock( &p_vout->change_lock );
 553         return VLC_EGENERIC;
 554     }
 555
 556     if( !I_OUTPUTPICTURES )
 557     {
 558         msg_Err( p_vout, "plugin was unable to allocate at least "
 559                          "one direct buffer" );
 560         p_vout->pf_end( p_vout );
 561         vlc_mutex_unlock( &p_vout->change_lock );
 562         return VLC_EGENERIC;
 563     }
 564
 565     if( I_OUTPUTPICTURES > VOUT_MAX_PICTURES )
 566     {
 567         msg_Err( p_vout, "plugin allocated too many direct buffers, "
 568                          "our internal buffers must have overflown." );
 569         p_vout->pf_end( p_vout );
 570         vlc_mutex_unlock( &p_vout->change_lock );
 571         return VLC_EGENERIC;
 572     }
 573
 574     msg_Dbg( p_vout, "got %i direct buffer(s)", I_OUTPUTPICTURES );
 575
 576     AspectRatio( p_vout->fmt_render.i_aspect, &i_aspect_x, &i_aspect_y );
 577
 578     msg_Dbg( p_vout, "picture in %ix%i (%i,%i,%ix%i), "
 579              "chroma %4.4s, ar %i:%i, sar %i:%i",
 580              p_vout->fmt_render.i_width, p_vout->fmt_render.i_height,
 581              p_vout->fmt_render.i_x_offset, p_vout->fmt_render.i_y_offset,
 582              p_vout->fmt_render.i_visible_width,
 583              p_vout->fmt_render.i_visible_height,
 584              (char*)&p_vout->fmt_render.i_chroma,
 585              i_aspect_x, i_aspect_y,
 586              p_vout->fmt_render.i_sar_num, p_vout->fmt_render.i_sar_den );
 587
 588     AspectRatio( p_vout->fmt_in.i_aspect, &i_aspect_x, &i_aspect_y );
 589
 590     msg_Dbg( p_vout, "picture user %ix%i (%i,%i,%ix%i), "
 591              "chroma %4.4s, ar %i:%i, sar %i:%i",
 592              p_vout->fmt_in.i_width, p_vout->fmt_in.i_height,
 593              p_vout->fmt_in.i_x_offset, p_vout->fmt_in.i_y_offset,
 594              p_vout->fmt_in.i_visible_width,
 595              p_vout->fmt_in.i_visible_height,
 596              (char*)&p_vout->fmt_in.i_chroma,
 597              i_aspect_x, i_aspect_y,
 598              p_vout->fmt_in.i_sar_num, p_vout->fmt_in.i_sar_den );
 599
 600     if( !p_vout->fmt_out.i_width || !p_vout->fmt_out.i_height )
 601     {
 602         p_vout->fmt_out.i_width = p_vout->fmt_out.i_visible_width =
 603             p_vout->output.i_width;
 604         p_vout->fmt_out.i_height = p_vout->fmt_out.i_visible_height =
 605             p_vout->output.i_height;
 606         p_vout->fmt_out.i_x_offset =  p_vout->fmt_out.i_y_offset = 0;
 607
 608         p_vout->fmt_out.i_aspect = p_vout->output.i_aspect;
 609         p_vout->fmt_out.i_chroma = p_vout->output.i_chroma;
 610     }
 611     if( !p_vout->fmt_out.i_sar_num || !p_vout->fmt_out.i_sar_num )
 612     {
 613         p_vout->fmt_out.i_sar_num = p_vout->fmt_out.i_aspect *
 614             p_vout->fmt_out.i_height;
 615         p_vout->fmt_out.i_sar_den = VOUT_ASPECT_FACTOR *
 616             p_vout->fmt_out.i_width;
 617     }
 618
 619     vlc_ureduce( &p_vout->fmt_out.i_sar_num, &p_vout->fmt_out.i_sar_den,
 620                  p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den, 0 );
 621
 622     AspectRatio( p_vout->fmt_out.i_aspect, &i_aspect_x, &i_aspect_y );
 623
 624     msg_Dbg( p_vout, "picture out %ix%i (%i,%i,%ix%i), "
 625              "chroma %4.4s, ar %i:%i, sar %i:%i",
 626              p_vout->fmt_out.i_width, p_vout->fmt_out.i_height,
 627              p_vout->fmt_out.i_x_offset, p_vout->fmt_out.i_y_offset,
 628              p_vout->fmt_out.i_visible_width,
 629              p_vout->fmt_out.i_visible_height,
 630              (char*)&p_vout->fmt_out.i_chroma,
 631              i_aspect_x, i_aspect_y,
 632              p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den );
 633
 634     /* Calculate shifts from system-updated masks */
 635     MaskToShift( &p_vout->output.i_lrshift, &p_vout->output.i_rrshift,
 636                  p_vout->output.i_rmask );
 637     MaskToShift( &p_vout->output.i_lgshift, &p_vout->output.i_rgshift,
 638                  p_vout->output.i_gmask );
 639     MaskToShift( &p_vout->output.i_lbshift, &p_vout->output.i_rbshift,
 640                  p_vout->output.i_bmask );
 641
 642     /* Check whether we managed to create direct buffers similar to
 643      * the render buffers, ie same size and chroma */
 644     if( ( p_vout->output.i_width == p_vout->render.i_width )
 645      && ( p_vout->output.i_height == p_vout->render.i_height )
 646      && ( vout_ChromaCmp( p_vout->output.i_chroma, p_vout->render.i_chroma ) ) )
 647     {
 648         /* Cool ! We have direct buffers, we can ask the decoder to
 649          * directly decode into them ! Map the first render buffers to
 650          * the first direct buffers, but keep the first direct buffer
 651          * for memcpy operations */
 652         p_vout->b_direct = 1;
 653
 654         for( i = 1; i < VOUT_MAX_PICTURES; i++ )
 655         {
 656             if( p_vout->p_picture[ i ].i_type != DIRECT_PICTURE &&
 657                 I_RENDERPICTURES >= VOUT_MIN_DIRECT_PICTURES - 1 &&
 658                 p_vout->p_picture[ i - 1 ].i_type == DIRECT_PICTURE )
 659             {
 660                 /* We have enough direct buffers so there's no need to
 661                  * try to use system memory buffers. */
 662                 break;
 663             }
 664             PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
 665             I_RENDERPICTURES++;
 666         }
 667
 668         msg_Dbg( p_vout, "direct render, mapping "
 669                  "render pictures 0-%i to system pictures 1-%i",
 670                  VOUT_MAX_PICTURES - 2, VOUT_MAX_PICTURES - 1 );
 671     }
 672     else
 673     {
 674         /* Rats... Something is wrong here, we could not find an output
 675          * plugin able to directly render what we decode. See if we can
 676          * find a chroma plugin to do the conversion */
 677         p_vout->b_direct = 0;
 678
 679         /* Choose the best module */
 680         p_vout->chroma.p_module = module_Need( p_vout, "chroma", NULL, 0 );
 681
 682         if( p_vout->chroma.p_module == NULL )
 683         {
 684             msg_Err( p_vout, "no chroma module for %4.4s to %4.4s",
 685                      (char*)&p_vout->render.i_chroma,
 686                      (char*)&p_vout->output.i_chroma );
 687             p_vout->pf_end( p_vout );
 688             vlc_mutex_unlock( &p_vout->change_lock );
 689             return VLC_EGENERIC;
 690         }
 691
 692         msg_Dbg( p_vout, "indirect render, mapping "
 693                  "render pictures 0-%i to system pictures %i-%i",
 694                  VOUT_MAX_PICTURES - 1, I_OUTPUTPICTURES,
 695                  I_OUTPUTPICTURES + VOUT_MAX_PICTURES - 1 );
 696
 697         /* Append render buffers after the direct buffers */
 698         for( i = I_OUTPUTPICTURES; i < 2 * VOUT_MAX_PICTURES; i++ )
 699         {
 700             PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
 701             I_RENDERPICTURES++;
 702
 703             /* Check if we have enough render pictures */
 704             if( I_RENDERPICTURES == VOUT_MAX_PICTURES )
 705                 break;
 706         }
 707     }
 708
 709     /* Link pictures back to their heap */
 710     for( i = 0 ; i < I_RENDERPICTURES ; i++ )
 711     {
 712         PP_RENDERPICTURE[ i ]->p_heap = &p_vout->render;
 713     }
 714
 715     for( i = 0 ; i < I_OUTPUTPICTURES ; i++ )
 716     {
 717         PP_OUTPUTPICTURE[ i ]->p_heap = &p_vout->output;
 718     }
 719
 720 /* XXX XXX mark thread ready */
 721     return VLC_SUCCESS;
 722 }
 723
 724 /*****************************************************************************
 725  * RunThread: video output thread
 726  *****************************************************************************
 727  * Video output thread. This function does only returns when the thread is
 728  * terminated. It handles the pictures arriving in the video heap and the
 729  * display device events.
 730  *****************************************************************************/
 731 static void RunThread( vout_thread_t *p_vout)
 732 {
 733     int             i_index;                                /* index in heap */
 734     int             i_idle_loops = 0;  /* loops without displaying a picture */
 735     mtime_t         current_date;                            /* current date */
 736     mtime_t         display_date;                            /* display date */
 737
 738     picture_t *     p_picture;                            /* picture pointer */
 739     picture_t *     p_last_picture = NULL;                   /* last picture */
 740     picture_t *     p_directbuffer;              /* direct buffer to display */
 741
 742     subpicture_t *  p_subpic = NULL;                   /* subpicture pointer */
 743
 744     input_thread_t *p_input = NULL ;           /* Parent input, if it exists */
 745
 746     vlc_value_t     val;
 747     bool      b_drop_late;
 748
 749     int             i_displayed = 0, i_lost = 0, i_loops = 0;
 750
 751     /*
 752      * Initialize thread
 753      */
 754     p_vout->b_error = InitThread( p_vout );
 755
 756     var_Create( p_vout, "drop-late-frames", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
 757     var_Get( p_vout, "drop-late-frames", &val );
 758     b_drop_late = val.b_bool;
 759
 760     /* signal the creation of the vout */
 761     vlc_thread_ready( p_vout );
 762
 763     if( p_vout->b_error )
 764         return;
 765
 766     if( p_vout->b_title_show )
 767         DisplayTitleOnOSD( p_vout );
 768
 769     /*
 770      * Main loop - it is not executed if an error occurred during
 771      * initialization
 772      */
 773     while( (!p_vout->b_die) && (!p_vout->b_error) )
 774     {
 775         /* Initialize loop variables */
 776         p_picture = NULL;
 777         display_date = 0;
 778         current_date = mdate();
 779
 780         i_loops++;
 781             if( !p_input )
 782             {
 783                 p_input = vlc_object_find( p_vout, VLC_OBJECT_INPUT,
 784                                            FIND_PARENT );
 785             }
 786             if( p_input )
 787             {
 788                 vlc_mutex_lock( &p_input->p->counters.counters_lock );
 789                 stats_UpdateInteger( p_vout, p_input->p->counters.p_lost_pictures,
 790                                      i_lost , NULL);
 791                 stats_UpdateInteger( p_vout,
 792                                      p_input->p->counters.p_displayed_pictures,
 793                                      i_displayed , NULL);
 794                 i_displayed = i_lost = 0;
 795                 vlc_mutex_unlock( &p_input->p->counters.counters_lock );
 796                 vlc_object_release( p_input );
 797                 p_input = NULL;
 798             }
 799 #if 0
 800         p_vout->c_loops++;
 801         if( !(p_vout->c_loops % VOUT_STATS_NB_LOOPS) )
 802         {
 803             msg_Dbg( p_vout, "picture heap: %d/%d",
 804                      I_RENDERPICTURES, p_vout->i_heap_size );
 805         }
 806 #endif
 807
 808         /*
 809          * Find the picture to display (the one with the earliest date).
 810          * This operation does not need lock, since only READY_PICTUREs
 811          * are handled. */
 812         for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
 813         {
 814             if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
 815                 && ( (p_picture == NULL) ||
 816                      (PP_RENDERPICTURE[i_index]->date < display_date) ) )
 817             {
 818                 p_picture = PP_RENDERPICTURE[i_index];
 819                 display_date = p_picture->date;
 820             }
 821         }
 822
 823         if( p_picture )
 824         {
 825             /* If we met the last picture, parse again to see whether there is
 826              * a more appropriate one. */
 827             if( p_picture == p_last_picture )
 828             {
 829                 for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
 830                 {
 831                     if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
 832                         && (PP_RENDERPICTURE[i_index] != p_last_picture)
 833                         && ((p_picture == p_last_picture) ||
 834                             (PP_RENDERPICTURE[i_index]->date < display_date)) )
 835                     {
 836                         p_picture = PP_RENDERPICTURE[i_index];
 837                         display_date = p_picture->date;
 838                     }
 839                 }
 840             }
 841
 842             /* If we found better than the last picture, destroy it */
 843             if( p_last_picture && p_picture != p_last_picture )
 844             {
 845                 vlc_mutex_lock( &p_vout->picture_lock );
 846                 if( p_last_picture->i_refcount )
 847                 {
 848                     p_last_picture->i_status = DISPLAYED_PICTURE;
 849                 }
 850                 else
 851                 {
 852                     p_last_picture->i_status = DESTROYED_PICTURE;
 853                     p_vout->i_heap_size--;
 854                 }
 855                 vlc_mutex_unlock( &p_vout->picture_lock );
 856                 p_last_picture = NULL;
 857             }
 858
 859             /* Compute FPS rate */
 860             p_vout->p_fps_sample[ p_vout->c_fps_samples++ % VOUT_FPS_SAMPLES ]
 861                 = display_date;
 862
 863             if( !p_picture->b_force &&
 864                 p_picture != p_last_picture &&
 865                 display_date < current_date + p_vout->render_time &&
 866                 b_drop_late )
 867             {
 868                 /* Picture is late: it will be destroyed and the thread
 869                  * will directly choose the next picture */
 870                 vlc_mutex_lock( &p_vout->picture_lock );
 871                 if( p_picture->i_refcount )
 872                 {
 873                     /* Pretend we displayed the picture, but don't destroy
 874                      * it since the decoder might still need it. */
 875                     p_picture->i_status = DISPLAYED_PICTURE;
 876                 }
 877                 else
 878                 {
 879                     /* Destroy the picture without displaying it */
 880                     p_picture->i_status = DESTROYED_PICTURE;
 881                     p_vout->i_heap_size--;
 882                 }
 883                 msg_Warn( p_vout, "late picture skipped (%"PRId64")",
 884                                   current_date - display_date );
 885                 i_lost++;
 886                 vlc_mutex_unlock( &p_vout->picture_lock );
 887
 888                 continue;
 889             }
 890
 891             if( display_date >
 892                 current_date + p_vout->i_pts_delay + VOUT_BOGUS_DELAY )
 893             {
 894                 /* Picture is waaay too early: it will be destroyed */
 895                 vlc_mutex_lock( &p_vout->picture_lock );
 896                 if( p_picture->i_refcount )
 897                 {
 898                     /* Pretend we displayed the picture, but don't destroy
 899                      * it since the decoder might still need it. */
 900                     p_picture->i_status = DISPLAYED_PICTURE;
 901                 }
 902                 else
 903                 {
 904                     /* Destroy the picture without displaying it */
 905                     p_picture->i_status = DESTROYED_PICTURE;
 906                     p_vout->i_heap_size--;
 907                 }
 908                 i_lost++;
 909                 msg_Warn( p_vout, "vout warning: early picture skipped "
 910                           "(%"PRId64")", display_date - current_date
 911                           - p_vout->i_pts_delay );
 912                 vlc_mutex_unlock( &p_vout->picture_lock );
 913
 914                 continue;
 915             }
 916
 917             if( display_date > current_date + VOUT_DISPLAY_DELAY )
 918             {
 919                 /* A picture is ready to be rendered, but its rendering date
 920                  * is far from the current one so the thread will perform an
 921                  * empty loop as if no picture were found. The picture state
 922                  * is unchanged */
 923                 p_picture    = NULL;
 924                 display_date = 0;
 925             }
 926             else if( p_picture == p_last_picture )
 927             {
 928                 /* We are asked to repeat the previous picture, but we first
 929                  * wait for a couple of idle loops */
 930                 if( i_idle_loops < 4 )
 931                 {
 932                     p_picture    = NULL;
 933                     display_date = 0;
 934                 }
 935                 else
 936                 {
 937                     /* We set the display date to something high, otherwise
 938                      * we'll have lots of problems with late pictures */
 939                     display_date = current_date + p_vout->render_time;
 940                 }
 941             }
 942         }
 943
 944         if( p_picture == NULL )
 945         {
 946             i_idle_loops++;
 947         }
 948
 949         /* Video Filter2 stuff */
 950         if( p_vout->b_vfilter_change == true )
 951         {
 952             int i;
 953             vlc_mutex_lock( &p_vout->vfilter_lock );
 954             RemoveVideoFilters2( p_vout );
 955             for( i = 0; i < p_vout->i_vfilters_cfg; i++ )
 956             {
 957                 filter_t *p_vfilter =
 958                     p_vout->pp_vfilters[p_vout->i_vfilters] =
 959                         vlc_object_create( p_vout, VLC_OBJECT_FILTER );
 960
 961                 vlc_object_attach( p_vfilter, p_vout );
 962
 963                 p_vfilter->pf_vout_buffer_new = video_new_buffer_filter;
 964                 p_vfilter->pf_vout_buffer_del = video_del_buffer_filter;
 965
 966                 if( !p_vout->i_vfilters )
 967                 {
 968                     p_vfilter->fmt_in.video = p_vout->fmt_render;
 969                 }
 970                 else
 971                 {
 972                     p_vfilter->fmt_in.video = (p_vfilter-1)->fmt_out.video;
 973                 }
 974                 /* TODO: one day filters in the middle of the chain might
 975                  * have a different fmt_out.video than fmt_render ... */
 976                 p_vfilter->fmt_out.video = p_vout->fmt_render;
 977
 978                 p_vfilter->p_cfg = p_vout->p_vfilters_cfg[i];
 979                 p_vfilter->p_module = module_Need( p_vfilter, "video filter2",
 980                                                    p_vout->psz_vfilters[i],
 981                                                    true );
 982
 983                 if( p_vfilter->p_module )
 984                 {
 985                     p_vfilter->p_owner =
 986                         malloc( sizeof( filter_owner_sys_t ) );
 987                     p_vfilter->p_owner->p_vout = p_vout;
 988                     p_vout->i_vfilters++;
 989                     msg_Dbg( p_vout, "video filter found (%s)",
 990                              p_vout->psz_vfilters[i] );
 991                 }
 992                 else
 993                 {
 994                     msg_Err( p_vout, "no video filter found (%s)",
 995                              p_vout->psz_vfilters[i] );
 996                     vlc_object_detach( p_vfilter );
 997                     vlc_object_release( p_vfilter );
 998                 }
 999             }
1000             p_vout->b_vfilter_change = false;
1001             vlc_mutex_unlock( &p_vout->vfilter_lock );
1002         }
1003
1004         if( p_picture )
1005         {
1006             int i;
1007             for( i = 0; i < p_vout->i_vfilters; i++ )
1008             {
1009                 picture_t *p_old = p_picture;
1010                 p_picture  = p_vout->pp_vfilters[i]->pf_video_filter(
1011                                  p_vout->pp_vfilters[i], p_picture );
1012                 if( !p_picture )
1013                 {
1014                     break;
1015                 }
1016                 /* FIXME: this is kind of wrong
1017                  * if you have 2 or more vfilters and the 2nd breaks,
1018                  * on the next loop the 1st one will be applied again */
1019
1020                 /* if p_old and p_picture are the same (ie the filter
1021                  * worked on the old picture), then following code is
1022                  * still alright since i_status gets changed back to
1023                  * the right value */
1024                 if( p_old->i_refcount )
1025                 {
1026                     p_old->i_status = DISPLAYED_PICTURE;
1027                 }
1028                 else
1029                 {
1030                     p_old->i_status = DESTROYED_PICTURE;
1031                 }
1032                 p_picture->i_status = READY_PICTURE;
1033             }
1034         }
1035
1036         if( p_picture && p_vout->b_snapshot )
1037         {
1038             p_vout->b_snapshot = false;
1039             vout_Snapshot( p_vout, p_picture );
1040         }
1041
1042         /*
1043          * Check for subpictures to display
1044          */
1045         if( display_date > 0 )
1046         {
1047             if( !p_input )
1048             {
1049                 p_input = vlc_object_find( p_vout, VLC_OBJECT_INPUT,
1050                                            FIND_PARENT );
1051             }
1052             p_subpic = spu_SortSubpictures( p_vout->p_spu, display_date,
1053             p_input ? var_GetBool( p_input, "state" ) == PAUSE_S : false );
1054             if( p_input )
1055                 vlc_object_release( p_input );
1056             p_input = NULL;
1057         }
1058
1059         /*
1060          * Perform rendering
1061          */
1062         i_displayed++;
1063         p_directbuffer = vout_RenderPicture( p_vout, p_picture, p_subpic );
1064
1065         /*
1066          * Call the plugin-specific rendering method if there is one
1067          */
1068         if( p_picture != NULL && p_directbuffer != NULL && p_vout->pf_render )
1069         {
1070             /* Render the direct buffer returned by vout_RenderPicture */
1071             p_vout->pf_render( p_vout, p_directbuffer );
1072         }
1073
1074         /*
1075          * Sleep, wake up
1076          */
1077         if( display_date != 0 && p_directbuffer != NULL )
1078         {
1079             mtime_t current_render_time = mdate() - current_date;
1080             /* if render time is very large we don't include it in the mean */
1081             if( current_render_time < p_vout->render_time +
1082                 VOUT_DISPLAY_DELAY )
1083             {
1084                 /* Store render time using a sliding mean weighting to
1085                  * current value in a 3 to 1 ratio*/
1086                 p_vout->render_time *= 3;
1087                 p_vout->render_time += current_render_time;
1088                 p_vout->render_time >>= 2;
1089             }
1090         }
1091
1092         /* Give back change lock */
1093         vlc_mutex_unlock( &p_vout->change_lock );
1094
1095         /* Sleep a while or until a given date */
1096         if( display_date != 0 )
1097         {
1098             /* If there are filters in the chain, better give them the picture
1099              * in advance */
1100             if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
1101             {
1102                 mwait( display_date - VOUT_MWAIT_TOLERANCE );
1103             }
1104         }
1105         else
1106         {
1107             msleep( VOUT_IDLE_SLEEP );
1108         }
1109
1110         /* On awakening, take back lock and send immediately picture
1111          * to display. */
1112         vlc_mutex_lock( &p_vout->change_lock );
1113
1114         /*
1115          * Display the previously rendered picture
1116          */
1117         if( p_picture != NULL && p_directbuffer != NULL )
1118         {
1119             /* Display the direct buffer returned by vout_RenderPicture */
1120             if( p_vout->pf_display )
1121             {
1122                 p_vout->pf_display( p_vout, p_directbuffer );
1123             }
1124
1125             /* Tell the vout this was the last picture and that it does not
1126              * need to be forced anymore. */
1127             p_last_picture = p_picture;
1128             p_last_picture->b_force = 0;
1129         }
1130
1131         if( p_picture != NULL )
1132         {
1133             /* Reinitialize idle loop count */
1134             i_idle_loops = 0;
1135         }
1136
1137         /*
1138          * Check events and manage thread
1139          */
1140         if( p_vout->pf_manage && p_vout->pf_manage( p_vout ) )
1141         {
1142             /* A fatal error occurred, and the thread must terminate
1143              * immediately, without displaying anything - setting b_error to 1
1144              * causes the immediate end of the main while() loop. */
1145             p_vout->b_error = 1;
1146         }
1147
1148         if( p_vout->i_changes & VOUT_SIZE_CHANGE )
1149         {
1150             /* this must only happen when the vout plugin is incapable of
1151              * rescaling the picture itself. In this case we need to destroy
1152              * the current picture buffers and recreate new ones with the right
1153              * dimensions */
1154             int i;
1155
1156             p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
1157
1158             p_vout->pf_end( p_vout );
1159             for( i = 0; i < I_OUTPUTPICTURES; i++ )
1160                  p_vout->p_picture[ i ].i_status = FREE_PICTURE;
1161
1162             I_OUTPUTPICTURES = 0;
1163             if( p_vout->pf_init( p_vout ) )
1164             {
1165                 msg_Err( p_vout, "cannot resize display" );
1166                 /* FIXME: pf_end will be called again in EndThread() */
1167                 p_vout->b_error = 1;
1168             }
1169
1170             /* Need to reinitialise the chroma plugin */
1171             if( p_vout->chroma.p_module )
1172             {
1173                 if( p_vout->chroma.p_module->pf_deactivate )
1174                     p_vout->chroma.p_module->pf_deactivate( VLC_OBJECT(p_vout) );
1175                 p_vout->chroma.p_module->pf_activate( VLC_OBJECT(p_vout) );
1176             }
1177         }
1178
1179         if( p_vout->i_changes & VOUT_PICTURE_BUFFERS_CHANGE )
1180         {
1181             /* This happens when the picture buffers need to be recreated.
1182              * This is useful on multimonitor displays for instance.
1183              *
1184              * Warning: This only works when the vout creates only 1 picture
1185              * buffer!! */
1186             p_vout->i_changes &= ~VOUT_PICTURE_BUFFERS_CHANGE;
1187
1188             if( !p_vout->b_direct )
1189             {
1190                 module_Unneed( p_vout, p_vout->chroma.p_module );
1191             }
1192
1193             vlc_mutex_lock( &p_vout->picture_lock );
1194
1195             p_vout->pf_end( p_vout );
1196
1197             I_OUTPUTPICTURES = I_RENDERPICTURES = 0;
1198
1199             p_vout->b_error = InitThread( p_vout );
1200
1201             vlc_mutex_unlock( &p_vout->picture_lock );
1202         }
1203     }
1204
1205     if( p_input )
1206     {
1207         vlc_object_release( p_input );
1208     }
1209
1210     /*
1211      * Error loop - wait until the thread destruction is requested
1212      */
1213     if( p_vout->b_error )
1214     {
1215         ErrorThread( p_vout );
1216     }
1217
1218     /* End of thread */
1219     EndThread( p_vout );
1220 }
1221
1222 /*****************************************************************************
1223  * ErrorThread: RunThread() error loop
1224  *****************************************************************************
1225  * This function is called when an error occurred during thread main's loop.
1226  * The thread can still receive feed, but must be ready to terminate as soon
1227  * as possible.
1228  *****************************************************************************/
1229 static void ErrorThread( vout_thread_t *p_vout )
1230 {
1231     /* Wait until a `die' order */
1232     while( !p_vout->b_die )
1233     {
1234         /* Sleep a while */
1235         msleep( VOUT_IDLE_SLEEP );
1236     }
1237 }
1238
1239 /*****************************************************************************
1240  * EndThread: thread destruction
1241  *****************************************************************************
1242  * This function is called when the thread ends after a sucessful
1243  * initialization. It frees all resources allocated by InitThread.
1244  *****************************************************************************/
1245 static void EndThread( vout_thread_t *p_vout )
1246 {
1247     int     i_index;                                        /* index in heap */
1248
1249 #ifdef STATS
1250     {
1251         struct tms cpu_usage;
1252         times( &cpu_usage );
1253
1254         msg_Dbg( p_vout, "cpu usage (user: %d, system: %d)",
1255                  cpu_usage.tms_utime, cpu_usage.tms_stime );
1256     }
1257 #endif
1258
1259     if( !p_vout->b_direct )
1260     {
1261         module_Unneed( p_vout, p_vout->chroma.p_module );
1262     }
1263
1264     /* Destroy all remaining pictures */
1265     for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++ )
1266     {
1267         if ( p_vout->p_picture[i_index].i_type == MEMORY_PICTURE )
1268         {
1269             free( p_vout->p_picture[i_index].p_data_orig );
1270         }
1271     }
1272
1273     /* Destroy subpicture unit */
1274     spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), false );
1275     spu_Destroy( p_vout->p_spu );
1276
1277     /* Destroy the video filters2 */
1278     RemoveVideoFilters2( p_vout );
1279
1280     /* Destroy translation tables */
1281     p_vout->pf_end( p_vout );
1282
1283     /* Release the change lock */
1284     vlc_mutex_unlock( &p_vout->change_lock );
1285 }
1286
1287 /* following functions are local */
1288
1289 static int ReduceHeight( int i_ratio )
1290 {
1291     int i_dummy = VOUT_ASPECT_FACTOR;
1292     int i_pgcd  = 1;
1293
1294     if( !i_ratio )
1295     {
1296         return i_pgcd;
1297     }
1298
1299     /* VOUT_ASPECT_FACTOR is (2^7 * 3^3 * 5^3), we just check for 2, 3 and 5 */
1300     while( !(i_ratio & 1) && !(i_dummy & 1) )
1301     {
1302         i_ratio >>= 1;
1303         i_dummy >>= 1;
1304         i_pgcd  <<= 1;
1305     }
1306
1307     while( !(i_ratio % 3) && !(i_dummy % 3) )
1308     {
1309         i_ratio /= 3;
1310         i_dummy /= 3;
1311         i_pgcd  *= 3;
1312     }
1313
1314     while( !(i_ratio % 5) && !(i_dummy % 5) )
1315     {
1316         i_ratio /= 5;
1317         i_dummy /= 5;
1318         i_pgcd  *= 5;
1319     }
1320
1321     return i_pgcd;
1322 }
1323
1324 static void AspectRatio( int i_aspect, int *i_aspect_x, int *i_aspect_y )
1325 {
1326     unsigned int i_pgcd = ReduceHeight( i_aspect );
1327     *i_aspect_x = i_aspect / i_pgcd;
1328     *i_aspect_y = VOUT_ASPECT_FACTOR / i_pgcd;
1329 }
1330
1331 /*****************************************************************************
1332  * BinaryLog: computes the base 2 log of a binary value
1333  *****************************************************************************
1334  * This functions is used by MaskToShift, to get a bit index from a binary
1335  * value.
1336  *****************************************************************************/
1337 static int BinaryLog( uint32_t i )
1338 {
1339     int i_log = 0;
1340
1341     if( i == 0 ) return -31337;
1342
1343     if( i & 0xffff0000 ) i_log += 16;
1344     if( i & 0xff00ff00 ) i_log += 8;
1345     if( i & 0xf0f0f0f0 ) i_log += 4;
1346     if( i & 0xcccccccc ) i_log += 2;
1347     if( i & 0xaaaaaaaa ) i_log += 1;
1348
1349     return i_log;
1350 }
1351
1352 /*****************************************************************************
1353  * MaskToShift: transform a color mask into right and left shifts
1354  *****************************************************************************
1355  * This function is used for obtaining color shifts from masks.
1356  *****************************************************************************/
1357 static void MaskToShift( int *pi_left, int *pi_right, uint32_t i_mask )
1358 {
1359     uint32_t i_low, i_high;            /* lower hand higher bits of the mask */
1360
1361     if( !i_mask )
1362     {
1363         *pi_left = *pi_right = 0;
1364         return;
1365     }
1366
1367     /* Get bits */
1368     i_low = i_high = i_mask;
1369
1370     i_low &= - (int32_t)i_low;          /* lower bit of the mask */
1371     i_high += i_low;                    /* higher bit of the mask */
1372
1373     /* Transform bits into an index. Also deal with i_high overflow, which
1374      * is faster than changing the BinaryLog code to handle 64 bit integers. */
1375     i_low =  BinaryLog (i_low);
1376     i_high = i_high ? BinaryLog (i_high) : 32;
1377
1378     /* Update pointers and return */
1379     *pi_left =   i_low;
1380     *pi_right = (8 - i_high + i_low);
1381 }
1382
1383 /*****************************************************************************
1384  * vout_VarCallback: generic callback for intf variables
1385  *****************************************************************************/
1386 int vout_VarCallback( vlc_object_t * p_this, const char * psz_variable,
1387                       vlc_value_t oldval, vlc_value_t newval,
1388                       void *p_data )
1389 {
1390     vout_thread_t * p_vout = (vout_thread_t *)p_this;
1391     vlc_value_t val;
1392     (void)psz_variable; (void)newval; (void)oldval; (void)p_data;
1393     val.b_bool = true;
1394     var_Set( p_vout, "intf-change", val );
1395     return VLC_SUCCESS;
1396 }
1397
1398 /*****************************************************************************
1399  * Helper thread for object variables callbacks.
1400  * Only used to avoid deadlocks when using the video embedded mode.
1401  *****************************************************************************/
1402 typedef struct suxor_thread_t
1403 {
1404     VLC_COMMON_MEMBERS
1405     input_thread_t *p_input;
1406
1407 } suxor_thread_t;
1408
1409 static void SuxorRestartVideoES( suxor_thread_t *p_this )
1410 {
1411     vlc_value_t val;
1412
1413     vlc_thread_ready( p_this );
1414
1415     /* Now restart current video stream */
1416     var_Get( p_this->p_input, "video-es", &val );
1417     if( val.i_int >= 0 )
1418     {
1419         vlc_value_t val_es;
1420         val_es.i_int = -VIDEO_ES;
1421         var_Set( p_this->p_input, "video-es", val_es );
1422         var_Set( p_this->p_input, "video-es", val );
1423     }
1424
1425     vlc_object_release( p_this->p_input );
1426
1427     vlc_object_release( p_this );
1428 }
1429
1430 /*****************************************************************************
1431  * object variables callbacks: a bunch of object variables are used by the
1432  * interfaces to interact with the vout.
1433  *****************************************************************************/
1434 static int DeinterlaceCallback( vlc_object_t *p_this, char const *psz_cmd,
1435                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
1436 {
1437     vout_thread_t *p_vout = (vout_thread_t *)p_this;
1438     input_thread_t *p_input;
1439     vlc_value_t val;
1440
1441     char *psz_mode = newval.psz_string;
1442     char *psz_filter, *psz_deinterlace = NULL;
1443     (void)psz_cmd; (void)oldval; (void)p_data;
1444
1445     var_Get( p_vout, "vout-filter", &val );
1446     psz_filter = val.psz_string;
1447     if( psz_filter ) psz_deinterlace = strstr( psz_filter, "deinterlace" );
1448
1449     if( !psz_mode || !*psz_mode )
1450     {
1451         if( psz_deinterlace )
1452         {
1453             char *psz_src = psz_deinterlace + sizeof("deinterlace") - 1;
1454             if( psz_src[0] == ':' ) psz_src++;
1455             memmove( psz_deinterlace, psz_src, strlen(psz_src) + 1 );
1456         }
1457     }
1458     else if( !psz_deinterlace )
1459     {
1460         psz_filter = realloc( psz_filter, strlen( psz_filter ) +
1461                               sizeof(":deinterlace") );
1462         if( psz_filter && *psz_filter ) strcat( psz_filter, ":" );
1463         strcat( psz_filter, "deinterlace" );
1464     }
1465
1466     p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1467                                                  FIND_PARENT );
1468     if( !p_input ) return VLC_EGENERIC;
1469
1470     if( psz_mode && *psz_mode )
1471     {
1472         /* Modify input as well because the vout might have to be restarted */
1473         val.psz_string = psz_mode;
1474         var_Create( p_input, "deinterlace-mode", VLC_VAR_STRING );
1475         var_Set( p_input, "deinterlace-mode", val );
1476     }
1477     vlc_object_release( p_input );
1478
1479     val.b_bool = true;
1480     var_Set( p_vout, "intf-change", val );
1481
1482     val.psz_string = psz_filter;
1483     var_Set( p_vout, "vout-filter", val );
1484     free( psz_filter );
1485
1486     return VLC_SUCCESS;
1487 }
1488
1489 static int FilterCallback( vlc_object_t *p_this, char const *psz_cmd,
1490                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
1491 {
1492     vout_thread_t *p_vout = (vout_thread_t *)p_this;
1493     input_thread_t *p_input;
1494     vlc_value_t val;
1495     (void)psz_cmd; (void)oldval; (void)p_data;
1496
1497     p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1498                                                  FIND_PARENT );
1499     if (!p_input)
1500     {
1501         msg_Err( p_vout, "Input not found" );
1502         return( VLC_EGENERIC );
1503     }
1504
1505     val.b_bool = true;
1506     var_Set( p_vout, "intf-change", val );
1507
1508     /* Modify input as well because the vout might have to be restarted */
1509     val.psz_string = newval.psz_string;
1510     var_Create( p_input, "vout-filter", VLC_VAR_STRING );
1511
1512     var_Set( p_input, "vout-filter", val );
1513
1514     /* Now restart current video stream */
1515     var_Get( p_input, "video-es", &val );
1516     if( val.i_int >= 0 )
1517     {
1518         suxor_thread_t *p_suxor =
1519             vlc_object_create( p_vout, sizeof(suxor_thread_t) );
1520         p_suxor->p_input = p_input;
1521         p_vout->b_filter_change = true;
1522         vlc_object_yield( p_input );
1523         vlc_thread_create( p_suxor, "suxor", SuxorRestartVideoES,
1524                            VLC_THREAD_PRIORITY_LOW, false );
1525     }
1526
1527     vlc_object_release( p_input );
1528
1529     return VLC_SUCCESS;
1530 }
1531
1532 /*****************************************************************************
1533  * Video Filter2 stuff
1534  *****************************************************************************/
1535 static int ParseVideoFilter2Chain( vout_thread_t *p_vout, char *psz_vfilters )
1536 {
1537     int i;
1538     for( i = 0; i < p_vout->i_vfilters_cfg; i++ )
1539     {
1540         struct config_chain_t *p_cfg =
1541             p_vout->p_vfilters_cfg[p_vout->i_vfilters_cfg];
1542         config_ChainDestroy( p_cfg );
1543         free( p_vout->psz_vfilters[p_vout->i_vfilters_cfg] );
1544         p_vout->psz_vfilters[p_vout->i_vfilters_cfg] = NULL;
1545     }
1546     p_vout->i_vfilters_cfg = 0;
1547     if( psz_vfilters && *psz_vfilters )
1548     {
1549         char *psz_parser = psz_vfilters;
1550
1551         while( psz_parser && *psz_parser )
1552         {
1553             psz_parser = config_ChainCreate(
1554                             &p_vout->psz_vfilters[p_vout->i_vfilters_cfg],
1555                             &p_vout->p_vfilters_cfg[p_vout->i_vfilters_cfg],
1556                             psz_parser );
1557             msg_Dbg( p_vout, "adding vfilter: %s",
1558                      p_vout->psz_vfilters[p_vout->i_vfilters_cfg] );
1559             p_vout->i_vfilters_cfg++;
1560             if( psz_parser && *psz_parser )
1561             {
1562                 if( p_vout->i_vfilters_cfg == MAX_VFILTERS )
1563                 {
1564                     msg_Warn( p_vout,
1565                   "maximum number of video filters reached. \"%s\" discarded",
1566                               psz_parser );
1567                     break;
1568                 }
1569             }
1570         }
1571     }
1572     return VLC_SUCCESS;
1573 }
1574
1575 static int VideoFilter2Callback( vlc_object_t *p_this, char const *psz_cmd,
1576                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
1577 {
1578     vout_thread_t *p_vout = (vout_thread_t *)p_this;
1579     (void)psz_cmd; (void)oldval; (void)p_data;
1580
1581     vlc_mutex_lock( &p_vout->vfilter_lock );
1582     ParseVideoFilter2Chain( p_vout, newval.psz_string );
1583     p_vout->b_vfilter_change = true;
1584     vlc_mutex_unlock( &p_vout->vfilter_lock );
1585
1586     return VLC_SUCCESS;
1587 }
1588
1589 static void RemoveVideoFilters2( vout_thread_t *p_vout )
1590 {
1591     int i;
1592     for( i = 0; i < p_vout->i_vfilters; i++ )
1593     {
1594         vlc_object_detach( p_vout->pp_vfilters[i] );
1595         if( p_vout->pp_vfilters[i]->p_module )
1596         {
1597             module_Unneed( p_vout->pp_vfilters[i],
1598                            p_vout->pp_vfilters[i]->p_module );
1599         }
1600
1601         free( p_vout->pp_vfilters[i]->p_owner );
1602         vlc_object_release( p_vout->pp_vfilters[i] );
1603     }
1604     p_vout->i_vfilters = 0;
1605 }
1606
1607 static void DisplayTitleOnOSD( vout_thread_t *p_vout )
1608 {
1609     input_thread_t *p_input;
1610     mtime_t i_now, i_stop;
1611
1612     p_input = (input_thread_t *)vlc_object_find( p_vout,
1613               VLC_OBJECT_INPUT, FIND_ANYWHERE );
1614     if( p_input )
1615     {
1616         i_now = mdate();
1617         i_stop = i_now + (mtime_t)(p_vout->i_title_timeout * 1000);
1618         char *psz_nowplaying =
1619             input_item_GetNowPlaying( input_GetItem( p_input ) );
1620         char *psz_artist = input_item_GetArtist( input_GetItem( p_input ) );
1621         char *psz_name = input_item_GetTitle( input_GetItem( p_input ) );
1622         if( EMPTY_STR( psz_name ) )
1623         {
1624             free( psz_name );
1625             psz_name = input_item_GetName( input_GetItem( p_input ) );
1626         }
1627         if( !EMPTY_STR( psz_nowplaying ) )
1628         {
1629             vout_ShowTextAbsolute( p_vout, DEFAULT_CHAN,
1630                                    psz_nowplaying, NULL,
1631                                    p_vout->i_title_position,
1632                                    30 + p_vout->fmt_in.i_width
1633                                       - p_vout->fmt_in.i_visible_width
1634                                       - p_vout->fmt_in.i_x_offset,
1635                                    20 + p_vout->fmt_in.i_y_offset,
1636                                    i_now, i_stop );
1637         }
1638         else if( !EMPTY_STR( psz_artist ) )
1639         {
1640             char *psz_string = NULL;
1641             if( asprintf( &psz_string, "%s - %s", psz_name, psz_artist ) != -1 )
1642             {
1643                 vout_ShowTextAbsolute( p_vout, DEFAULT_CHAN,
1644                                        psz_string, NULL,
1645                                        p_vout->i_title_position,
1646                                        30 + p_vout->fmt_in.i_width
1647                                           - p_vout->fmt_in.i_visible_width
1648                                           - p_vout->fmt_in.i_x_offset,
1649                                        20 + p_vout->fmt_in.i_y_offset,
1650                                        i_now, i_stop );
1651                 free( psz_string );
1652             }
1653         }
1654         else
1655         {
1656             vout_ShowTextAbsolute( p_vout, DEFAULT_CHAN,
1657                                    psz_name, NULL,
1658                                    p_vout->i_title_position,
1659                                    30 + p_vout->fmt_in.i_width
1660                                       - p_vout->fmt_in.i_visible_width
1661                                       - p_vout->fmt_in.i_x_offset,
1662                                    20 + p_vout->fmt_in.i_y_offset,
1663                                    i_now, i_stop );
1664         }
1665         vlc_object_release( p_input );
1666         free( psz_artist );
1667         free( psz_name );
1668         free( psz_nowplaying );
1669     }
1670 }
1671