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_common.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             vlc_object_release( 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 static void vout_Destructor( vlc_object_t * p_this )
 475 {
 476     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 477
 478     /* Destroy the locks */
 479     vlc_mutex_destroy( &p_vout->picture_lock );
 480     vlc_mutex_destroy( &p_vout->change_lock );
 481     vlc_mutex_destroy( &p_vout->vfilter_lock );
 482
 483     /* Release the module */
 484     if( p_vout->p_module )
 485     {
 486         module_Unneed( p_vout, p_vout->p_module );
 487     }
 488
 489     free( p_vout->psz_filter_chain );
 490
 491     config_ChainDestroy( p_vout->p_cfg );
 492
 493 #ifndef __APPLE__
 494     vout_thread_t *p_another_vout;
 495
 496     playlist_t *p_playlist = pl_Yield( p_this );
 497     if( !p_playlist )
 498         return;
 499
 500     /* This is a dirty hack mostly for Linux, where there is no way to get the
 501      * GUI back if you closed it while playing video. This is solved in
 502      * Mac OS X, where we have this novelty called menubar, that will always
 503      * allow you access to the applications main functionality. They should try
 504      * that on linux sometime. */
 505     p_another_vout = vlc_object_find( p_this->p_libvlc,
 506                                       VLC_OBJECT_VOUT, FIND_ANYWHERE );
 507     if( p_another_vout == NULL )
 508         var_SetBool( p_playlist, "intf-show", true );
 509     else
 510         vlc_object_release( p_another_vout );
 511     pl_Release( p_playlist );
 512 #endif
 513 }
 514
 515 /*****************************************************************************
 516  * InitThread: initialize video output thread
 517  *****************************************************************************
 518  * This function is called from RunThread and performs the second step of the
 519  * initialization. It returns 0 on success. Note that the thread's flag are not
 520  * modified inside this function.
 521  *****************************************************************************/
 522 static int InitThread( vout_thread_t *p_vout )
 523 {
 524     int i, i_aspect_x, i_aspect_y;
 525
 526     vlc_mutex_lock( &p_vout->change_lock );
 527
 528 #ifdef STATS
 529     p_vout->c_loops = 0;
 530 #endif
 531
 532     /* Initialize output method, it allocates direct buffers for us */
 533     if( p_vout->pf_init( p_vout ) )
 534     {
 535         vlc_mutex_unlock( &p_vout->change_lock );
 536         return VLC_EGENERIC;
 537     }
 538
 539     if( !I_OUTPUTPICTURES )
 540     {
 541         msg_Err( p_vout, "plugin was unable to allocate at least "
 542                          "one direct buffer" );
 543         p_vout->pf_end( p_vout );
 544         vlc_mutex_unlock( &p_vout->change_lock );
 545         return VLC_EGENERIC;
 546     }
 547
 548     if( I_OUTPUTPICTURES > VOUT_MAX_PICTURES )
 549     {
 550         msg_Err( p_vout, "plugin allocated too many direct buffers, "
 551                          "our internal buffers must have overflown." );
 552         p_vout->pf_end( p_vout );
 553         vlc_mutex_unlock( &p_vout->change_lock );
 554         return VLC_EGENERIC;
 555     }
 556
 557     msg_Dbg( p_vout, "got %i direct buffer(s)", I_OUTPUTPICTURES );
 558
 559     AspectRatio( p_vout->fmt_render.i_aspect, &i_aspect_x, &i_aspect_y );
 560
 561     msg_Dbg( p_vout, "picture in %ix%i (%i,%i,%ix%i), "
 562              "chroma %4.4s, ar %i:%i, sar %i:%i",
 563              p_vout->fmt_render.i_width, p_vout->fmt_render.i_height,
 564              p_vout->fmt_render.i_x_offset, p_vout->fmt_render.i_y_offset,
 565              p_vout->fmt_render.i_visible_width,
 566              p_vout->fmt_render.i_visible_height,
 567              (char*)&p_vout->fmt_render.i_chroma,
 568              i_aspect_x, i_aspect_y,
 569              p_vout->fmt_render.i_sar_num, p_vout->fmt_render.i_sar_den );
 570
 571     AspectRatio( p_vout->fmt_in.i_aspect, &i_aspect_x, &i_aspect_y );
 572
 573     msg_Dbg( p_vout, "picture user %ix%i (%i,%i,%ix%i), "
 574              "chroma %4.4s, ar %i:%i, sar %i:%i",
 575              p_vout->fmt_in.i_width, p_vout->fmt_in.i_height,
 576              p_vout->fmt_in.i_x_offset, p_vout->fmt_in.i_y_offset,
 577              p_vout->fmt_in.i_visible_width,
 578              p_vout->fmt_in.i_visible_height,
 579              (char*)&p_vout->fmt_in.i_chroma,
 580              i_aspect_x, i_aspect_y,
 581              p_vout->fmt_in.i_sar_num, p_vout->fmt_in.i_sar_den );
 582
 583     if( !p_vout->fmt_out.i_width || !p_vout->fmt_out.i_height )
 584     {
 585         p_vout->fmt_out.i_width = p_vout->fmt_out.i_visible_width =
 586             p_vout->output.i_width;
 587         p_vout->fmt_out.i_height = p_vout->fmt_out.i_visible_height =
 588             p_vout->output.i_height;
 589         p_vout->fmt_out.i_x_offset =  p_vout->fmt_out.i_y_offset = 0;
 590
 591         p_vout->fmt_out.i_aspect = p_vout->output.i_aspect;
 592         p_vout->fmt_out.i_chroma = p_vout->output.i_chroma;
 593     }
 594     if( !p_vout->fmt_out.i_sar_num || !p_vout->fmt_out.i_sar_num )
 595     {
 596         p_vout->fmt_out.i_sar_num = p_vout->fmt_out.i_aspect *
 597             p_vout->fmt_out.i_height;
 598         p_vout->fmt_out.i_sar_den = VOUT_ASPECT_FACTOR *
 599             p_vout->fmt_out.i_width;
 600     }
 601
 602     vlc_ureduce( &p_vout->fmt_out.i_sar_num, &p_vout->fmt_out.i_sar_den,
 603                  p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den, 0 );
 604
 605     AspectRatio( p_vout->fmt_out.i_aspect, &i_aspect_x, &i_aspect_y );
 606
 607     msg_Dbg( p_vout, "picture out %ix%i (%i,%i,%ix%i), "
 608              "chroma %4.4s, ar %i:%i, sar %i:%i",
 609              p_vout->fmt_out.i_width, p_vout->fmt_out.i_height,
 610              p_vout->fmt_out.i_x_offset, p_vout->fmt_out.i_y_offset,
 611              p_vout->fmt_out.i_visible_width,
 612              p_vout->fmt_out.i_visible_height,
 613              (char*)&p_vout->fmt_out.i_chroma,
 614              i_aspect_x, i_aspect_y,
 615              p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den );
 616
 617     /* Calculate shifts from system-updated masks */
 618     MaskToShift( &p_vout->output.i_lrshift, &p_vout->output.i_rrshift,
 619                  p_vout->output.i_rmask );
 620     MaskToShift( &p_vout->output.i_lgshift, &p_vout->output.i_rgshift,
 621                  p_vout->output.i_gmask );
 622     MaskToShift( &p_vout->output.i_lbshift, &p_vout->output.i_rbshift,
 623                  p_vout->output.i_bmask );
 624
 625     /* Check whether we managed to create direct buffers similar to
 626      * the render buffers, ie same size and chroma */
 627     if( ( p_vout->output.i_width == p_vout->render.i_width )
 628      && ( p_vout->output.i_height == p_vout->render.i_height )
 629      && ( vout_ChromaCmp( p_vout->output.i_chroma, p_vout->render.i_chroma ) ) )
 630     {
 631         /* Cool ! We have direct buffers, we can ask the decoder to
 632          * directly decode into them ! Map the first render buffers to
 633          * the first direct buffers, but keep the first direct buffer
 634          * for memcpy operations */
 635         p_vout->b_direct = 1;
 636
 637         for( i = 1; i < VOUT_MAX_PICTURES; i++ )
 638         {
 639             if( p_vout->p_picture[ i ].i_type != DIRECT_PICTURE &&
 640                 I_RENDERPICTURES >= VOUT_MIN_DIRECT_PICTURES - 1 &&
 641                 p_vout->p_picture[ i - 1 ].i_type == DIRECT_PICTURE )
 642             {
 643                 /* We have enough direct buffers so there's no need to
 644                  * try to use system memory buffers. */
 645                 break;
 646             }
 647             PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
 648             I_RENDERPICTURES++;
 649         }
 650
 651         msg_Dbg( p_vout, "direct render, mapping "
 652                  "render pictures 0-%i to system pictures 1-%i",
 653                  VOUT_MAX_PICTURES - 2, VOUT_MAX_PICTURES - 1 );
 654     }
 655     else
 656     {
 657         /* Rats... Something is wrong here, we could not find an output
 658          * plugin able to directly render what we decode. See if we can
 659          * find a chroma plugin to do the conversion */
 660         p_vout->b_direct = 0;
 661
 662         /* Choose the best module */
 663         p_vout->chroma.p_module = module_Need( p_vout, "chroma", NULL, 0 );
 664
 665         if( p_vout->chroma.p_module == NULL )
 666         {
 667             msg_Err( p_vout, "no chroma module for %4.4s to %4.4s",
 668                      (char*)&p_vout->render.i_chroma,
 669                      (char*)&p_vout->output.i_chroma );
 670             p_vout->pf_end( p_vout );
 671             vlc_mutex_unlock( &p_vout->change_lock );
 672             return VLC_EGENERIC;
 673         }
 674
 675         msg_Dbg( p_vout, "indirect render, mapping "
 676                  "render pictures 0-%i to system pictures %i-%i",
 677                  VOUT_MAX_PICTURES - 1, I_OUTPUTPICTURES,
 678                  I_OUTPUTPICTURES + VOUT_MAX_PICTURES - 1 );
 679
 680         /* Append render buffers after the direct buffers */
 681         for( i = I_OUTPUTPICTURES; i < 2 * VOUT_MAX_PICTURES; i++ )
 682         {
 683             PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
 684             I_RENDERPICTURES++;
 685
 686             /* Check if we have enough render pictures */
 687             if( I_RENDERPICTURES == VOUT_MAX_PICTURES )
 688                 break;
 689         }
 690     }
 691
 692     /* Link pictures back to their heap */
 693     for( i = 0 ; i < I_RENDERPICTURES ; i++ )
 694     {
 695         PP_RENDERPICTURE[ i ]->p_heap = &p_vout->render;
 696     }
 697
 698     for( i = 0 ; i < I_OUTPUTPICTURES ; i++ )
 699     {
 700         PP_OUTPUTPICTURE[ i ]->p_heap = &p_vout->output;
 701     }
 702
 703 /* XXX XXX mark thread ready */
 704     return VLC_SUCCESS;
 705 }
 706
 707 /*****************************************************************************
 708  * RunThread: video output thread
 709  *****************************************************************************
 710  * Video output thread. This function does only returns when the thread is
 711  * terminated. It handles the pictures arriving in the video heap and the
 712  * display device events.
 713  *****************************************************************************/
 714 static void RunThread( vout_thread_t *p_vout)
 715 {
 716     int             i_index;                                /* index in heap */
 717     int             i_idle_loops = 0;  /* loops without displaying a picture */
 718     mtime_t         current_date;                            /* current date */
 719     mtime_t         display_date;                            /* display date */
 720
 721     picture_t *     p_picture;                            /* picture pointer */
 722     picture_t *     p_last_picture = NULL;                   /* last picture */
 723     picture_t *     p_directbuffer;              /* direct buffer to display */
 724
 725     subpicture_t *  p_subpic = NULL;                   /* subpicture pointer */
 726
 727     input_thread_t *p_input = NULL ;           /* Parent input, if it exists */
 728
 729     vlc_value_t     val;
 730     bool      b_drop_late;
 731
 732     int             i_displayed = 0, i_lost = 0, i_loops = 0;
 733
 734     /*
 735      * Initialize thread
 736      */
 737     p_vout->b_error = InitThread( p_vout );
 738
 739     var_Create( p_vout, "drop-late-frames", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
 740     var_Get( p_vout, "drop-late-frames", &val );
 741     b_drop_late = val.b_bool;
 742
 743     /* signal the creation of the vout */
 744     vlc_thread_ready( p_vout );
 745
 746     if( p_vout->b_error )
 747         return;
 748
 749     vlc_object_lock( p_vout );
 750
 751     if( p_vout->b_title_show )
 752         DisplayTitleOnOSD( p_vout );
 753
 754     /*
 755      * Main loop - it is not executed if an error occurred during
 756      * initialization
 757      */
 758     while( (vlc_object_alive( p_vout )) && (!p_vout->b_error) )
 759     {
 760         /* Initialize loop variables */
 761         p_picture = NULL;
 762         display_date = 0;
 763         current_date = mdate();
 764
 765         i_loops++;
 766             if( !p_input )
 767             {
 768                 p_input = vlc_object_find( p_vout, VLC_OBJECT_INPUT,
 769                                            FIND_PARENT );
 770             }
 771             if( p_input )
 772             {
 773                 vlc_mutex_lock( &p_input->p->counters.counters_lock );
 774                 stats_UpdateInteger( p_vout, p_input->p->counters.p_lost_pictures,
 775                                      i_lost , NULL);
 776                 stats_UpdateInteger( p_vout,
 777                                      p_input->p->counters.p_displayed_pictures,
 778                                      i_displayed , NULL);
 779                 i_displayed = i_lost = 0;
 780                 vlc_mutex_unlock( &p_input->p->counters.counters_lock );
 781                 vlc_object_release( p_input );
 782                 p_input = NULL;
 783             }
 784 #if 0
 785         p_vout->c_loops++;
 786         if( !(p_vout->c_loops % VOUT_STATS_NB_LOOPS) )
 787         {
 788             msg_Dbg( p_vout, "picture heap: %d/%d",
 789                      I_RENDERPICTURES, p_vout->i_heap_size );
 790         }
 791 #endif
 792
 793         /*
 794          * Find the picture to display (the one with the earliest date).
 795          * This operation does not need lock, since only READY_PICTUREs
 796          * are handled. */
 797         for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
 798         {
 799             if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
 800                 && ( (p_picture == NULL) ||
 801                      (PP_RENDERPICTURE[i_index]->date < display_date) ) )
 802             {
 803                 p_picture = PP_RENDERPICTURE[i_index];
 804                 display_date = p_picture->date;
 805             }
 806         }
 807
 808         if( p_picture )
 809         {
 810             /* If we met the last picture, parse again to see whether there is
 811              * a more appropriate one. */
 812             if( p_picture == p_last_picture )
 813             {
 814                 for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
 815                 {
 816                     if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
 817                         && (PP_RENDERPICTURE[i_index] != p_last_picture)
 818                         && ((p_picture == p_last_picture) ||
 819                             (PP_RENDERPICTURE[i_index]->date < display_date)) )
 820                     {
 821                         p_picture = PP_RENDERPICTURE[i_index];
 822                         display_date = p_picture->date;
 823                     }
 824                 }
 825             }
 826
 827             /* If we found better than the last picture, destroy it */
 828             if( p_last_picture && p_picture != p_last_picture )
 829             {
 830                 vlc_mutex_lock( &p_vout->picture_lock );
 831                 if( p_last_picture->i_refcount )
 832                 {
 833                     p_last_picture->i_status = DISPLAYED_PICTURE;
 834                 }
 835                 else
 836                 {
 837                     p_last_picture->i_status = DESTROYED_PICTURE;
 838                     p_vout->i_heap_size--;
 839                 }
 840                 vlc_mutex_unlock( &p_vout->picture_lock );
 841                 p_last_picture = NULL;
 842             }
 843
 844             /* Compute FPS rate */
 845             p_vout->p_fps_sample[ p_vout->c_fps_samples++ % VOUT_FPS_SAMPLES ]
 846                 = display_date;
 847
 848             if( !p_picture->b_force &&
 849                 p_picture != p_last_picture &&
 850                 display_date < current_date + p_vout->render_time &&
 851                 b_drop_late )
 852             {
 853                 /* Picture is late: it will be destroyed and the thread
 854                  * will directly choose the next picture */
 855                 vlc_mutex_lock( &p_vout->picture_lock );
 856                 if( p_picture->i_refcount )
 857                 {
 858                     /* Pretend we displayed the picture, but don't destroy
 859                      * it since the decoder might still need it. */
 860                     p_picture->i_status = DISPLAYED_PICTURE;
 861                 }
 862                 else
 863                 {
 864                     /* Destroy the picture without displaying it */
 865                     p_picture->i_status = DESTROYED_PICTURE;
 866                     p_vout->i_heap_size--;
 867                 }
 868                 msg_Warn( p_vout, "late picture skipped (%"PRId64")",
 869                                   current_date - display_date );
 870                 i_lost++;
 871                 vlc_mutex_unlock( &p_vout->picture_lock );
 872
 873                 continue;
 874             }
 875
 876             if( display_date >
 877                 current_date + p_vout->i_pts_delay + VOUT_BOGUS_DELAY )
 878             {
 879                 /* Picture is waaay too early: it will be destroyed */
 880                 vlc_mutex_lock( &p_vout->picture_lock );
 881                 if( p_picture->i_refcount )
 882                 {
 883                     /* Pretend we displayed the picture, but don't destroy
 884                      * it since the decoder might still need it. */
 885                     p_picture->i_status = DISPLAYED_PICTURE;
 886                 }
 887                 else
 888                 {
 889                     /* Destroy the picture without displaying it */
 890                     p_picture->i_status = DESTROYED_PICTURE;
 891                     p_vout->i_heap_size--;
 892                 }
 893                 i_lost++;
 894                 msg_Warn( p_vout, "vout warning: early picture skipped "
 895                           "(%"PRId64")", display_date - current_date
 896                           - p_vout->i_pts_delay );
 897                 vlc_mutex_unlock( &p_vout->picture_lock );
 898
 899                 continue;
 900             }
 901
 902             if( display_date > current_date + VOUT_DISPLAY_DELAY )
 903             {
 904                 /* A picture is ready to be rendered, but its rendering date
 905                  * is far from the current one so the thread will perform an
 906                  * empty loop as if no picture were found. The picture state
 907                  * is unchanged */
 908                 p_picture    = NULL;
 909                 display_date = 0;
 910             }
 911             else if( p_picture == p_last_picture )
 912             {
 913                 /* We are asked to repeat the previous picture, but we first
 914                  * wait for a couple of idle loops */
 915                 if( i_idle_loops < 4 )
 916                 {
 917                     p_picture    = NULL;
 918                     display_date = 0;
 919                 }
 920                 else
 921                 {
 922                     /* We set the display date to something high, otherwise
 923                      * we'll have lots of problems with late pictures */
 924                     display_date = current_date + p_vout->render_time;
 925                 }
 926             }
 927         }
 928
 929         if( p_picture == NULL )
 930         {
 931             i_idle_loops++;
 932         }
 933
 934         /* Video Filter2 stuff */
 935         if( p_vout->b_vfilter_change == true )
 936         {
 937             int i;
 938             vlc_mutex_lock( &p_vout->vfilter_lock );
 939             RemoveVideoFilters2( p_vout );
 940             for( i = 0; i < p_vout->i_vfilters_cfg; i++ )
 941             {
 942                 filter_t *p_vfilter =
 943                     p_vout->pp_vfilters[p_vout->i_vfilters] =
 944                         vlc_object_create( p_vout, VLC_OBJECT_FILTER );
 945
 946                 vlc_object_attach( p_vfilter, p_vout );
 947
 948                 p_vfilter->pf_vout_buffer_new = video_new_buffer_filter;
 949                 p_vfilter->pf_vout_buffer_del = video_del_buffer_filter;
 950
 951                 if( !p_vout->i_vfilters )
 952                 {
 953                     p_vfilter->fmt_in.video = p_vout->fmt_render;
 954                 }
 955                 else
 956                 {
 957                     p_vfilter->fmt_in.video = (p_vfilter-1)->fmt_out.video;
 958                 }
 959                 /* TODO: one day filters in the middle of the chain might
 960                  * have a different fmt_out.video than fmt_render ... */
 961                 p_vfilter->fmt_out.video = p_vout->fmt_render;
 962
 963                 p_vfilter->p_cfg = p_vout->p_vfilters_cfg[i];
 964                 p_vfilter->p_module = module_Need( p_vfilter, "video filter2",
 965                                                    p_vout->psz_vfilters[i],
 966                                                    true );
 967
 968                 if( p_vfilter->p_module )
 969                 {
 970                     p_vfilter->p_owner =
 971                         malloc( sizeof( filter_owner_sys_t ) );
 972                     p_vfilter->p_owner->p_vout = p_vout;
 973                     p_vout->i_vfilters++;
 974                     msg_Dbg( p_vout, "video filter found (%s)",
 975                              p_vout->psz_vfilters[i] );
 976                 }
 977                 else
 978                 {
 979                     msg_Err( p_vout, "no video filter found (%s)",
 980                              p_vout->psz_vfilters[i] );
 981                     vlc_object_detach( p_vfilter );
 982                     vlc_object_release( p_vfilter );
 983                 }
 984             }
 985             p_vout->b_vfilter_change = false;
 986             vlc_mutex_unlock( &p_vout->vfilter_lock );
 987         }
 988
 989         if( p_picture )
 990         {
 991             int i;
 992             for( i = 0; i < p_vout->i_vfilters; i++ )
 993             {
 994                 picture_t *p_old = p_picture;
 995                 p_picture  = p_vout->pp_vfilters[i]->pf_video_filter(
 996                                  p_vout->pp_vfilters[i], p_picture );
 997                 if( !p_picture )
 998                 {
 999                     break;
1000                 }
1001                 /* FIXME: this is kind of wrong
1002                  * if you have 2 or more vfilters and the 2nd breaks,
1003                  * on the next loop the 1st one will be applied again */
1004
1005                 /* if p_old and p_picture are the same (ie the filter
1006                  * worked on the old picture), then following code is
1007                  * still alright since i_status gets changed back to
1008                  * the right value */
1009                 if( p_old->i_refcount )
1010                 {
1011                     p_old->i_status = DISPLAYED_PICTURE;
1012                 }
1013                 else
1014                 {
1015                     p_old->i_status = DESTROYED_PICTURE;
1016                 }
1017                 p_picture->i_status = READY_PICTURE;
1018             }
1019         }
1020
1021         if( p_picture && p_vout->b_snapshot )
1022         {
1023             p_vout->b_snapshot = false;
1024             vout_Snapshot( p_vout, p_picture );
1025         }
1026
1027         /*
1028          * Check for subpictures to display
1029          */
1030         if( display_date > 0 )
1031         {
1032             if( !p_input )
1033             {
1034                 p_input = vlc_object_find( p_vout, VLC_OBJECT_INPUT,
1035                                            FIND_PARENT );
1036             }
1037             p_subpic = spu_SortSubpictures( p_vout->p_spu, display_date,
1038             p_input ? var_GetBool( p_input, "state" ) == PAUSE_S : false );
1039             if( p_input )
1040                 vlc_object_release( p_input );
1041             p_input = NULL;
1042         }
1043
1044         /*
1045          * Perform rendering
1046          */
1047         i_displayed++;
1048         p_directbuffer = vout_RenderPicture( p_vout, p_picture, p_subpic );
1049
1050         /*
1051          * Call the plugin-specific rendering method if there is one
1052          */
1053         if( p_picture != NULL && p_directbuffer != NULL && p_vout->pf_render )
1054         {
1055             /* Render the direct buffer returned by vout_RenderPicture */
1056             p_vout->pf_render( p_vout, p_directbuffer );
1057         }
1058
1059         /*
1060          * Sleep, wake up
1061          */
1062         if( display_date != 0 && p_directbuffer != NULL )
1063         {
1064             mtime_t current_render_time = mdate() - current_date;
1065             /* if render time is very large we don't include it in the mean */
1066             if( current_render_time < p_vout->render_time +
1067                 VOUT_DISPLAY_DELAY )
1068             {
1069                 /* Store render time using a sliding mean weighting to
1070                  * current value in a 3 to 1 ratio*/
1071                 p_vout->render_time *= 3;
1072                 p_vout->render_time += current_render_time;
1073                 p_vout->render_time >>= 2;
1074             }
1075         }
1076
1077         /* Give back change lock */
1078         vlc_mutex_unlock( &p_vout->change_lock );
1079
1080         vlc_object_unlock( p_vout );
1081
1082         /* Sleep a while or until a given date */
1083         if( display_date != 0 )
1084         {
1085             /* If there are filters in the chain, better give them the picture
1086              * in advance */
1087             if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
1088             {
1089                 mwait( display_date - VOUT_MWAIT_TOLERANCE );
1090             }
1091         }
1092         else
1093         {
1094             msleep( VOUT_IDLE_SLEEP );
1095         }
1096
1097         /* On awakening, take back lock and send immediately picture
1098          * to display. */
1099         vlc_object_lock( p_vout );
1100         /* Note: vlc_object_alive() could be false here, and we
1101          * could be dead */
1102         vlc_mutex_lock( &p_vout->change_lock );
1103
1104         /*
1105          * Display the previously rendered picture
1106          */
1107         if( p_picture != NULL && p_directbuffer != NULL )
1108         {
1109             /* Display the direct buffer returned by vout_RenderPicture */
1110             if( p_vout->pf_display )
1111             {
1112                 p_vout->pf_display( p_vout, p_directbuffer );
1113             }
1114
1115             /* Tell the vout this was the last picture and that it does not
1116              * need to be forced anymore. */
1117             p_last_picture = p_picture;
1118             p_last_picture->b_force = 0;
1119         }
1120
1121         if( p_picture != NULL )
1122         {
1123             /* Reinitialize idle loop count */
1124             i_idle_loops = 0;
1125         }
1126
1127         /*
1128          * Check events and manage thread
1129          */
1130         if( p_vout->pf_manage && p_vout->pf_manage( p_vout ) )
1131         {
1132             /* A fatal error occurred, and the thread must terminate
1133              * immediately, without displaying anything - setting b_error to 1
1134              * causes the immediate end of the main while() loop. */
1135             p_vout->b_error = 1;
1136         }
1137
1138         if( p_vout->i_changes & VOUT_SIZE_CHANGE )
1139         {
1140             /* this must only happen when the vout plugin is incapable of
1141              * rescaling the picture itself. In this case we need to destroy
1142              * the current picture buffers and recreate new ones with the right
1143              * dimensions */
1144             int i;
1145
1146             p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
1147
1148             p_vout->pf_end( p_vout );
1149             for( i = 0; i < I_OUTPUTPICTURES; i++ )
1150                  p_vout->p_picture[ i ].i_status = FREE_PICTURE;
1151
1152             I_OUTPUTPICTURES = 0;
1153             if( p_vout->pf_init( p_vout ) )
1154             {
1155                 msg_Err( p_vout, "cannot resize display" );
1156                 /* FIXME: pf_end will be called again in EndThread() */
1157                 p_vout->b_error = 1;
1158             }
1159
1160             /* Need to reinitialise the chroma plugin */
1161             if( p_vout->chroma.p_module )
1162             {
1163                 if( p_vout->chroma.p_module->pf_deactivate )
1164                     p_vout->chroma.p_module->pf_deactivate( VLC_OBJECT(p_vout) );
1165                 p_vout->chroma.p_module->pf_activate( VLC_OBJECT(p_vout) );
1166             }
1167         }
1168
1169         if( p_vout->i_changes & VOUT_PICTURE_BUFFERS_CHANGE )
1170         {
1171             /* This happens when the picture buffers need to be recreated.
1172              * This is useful on multimonitor displays for instance.
1173              *
1174              * Warning: This only works when the vout creates only 1 picture
1175              * buffer!! */
1176             p_vout->i_changes &= ~VOUT_PICTURE_BUFFERS_CHANGE;
1177
1178             if( !p_vout->b_direct )
1179             {
1180                 module_Unneed( p_vout, p_vout->chroma.p_module );
1181             }
1182
1183             vlc_mutex_lock( &p_vout->picture_lock );
1184
1185             p_vout->pf_end( p_vout );
1186
1187             I_OUTPUTPICTURES = I_RENDERPICTURES = 0;
1188
1189             p_vout->b_error = InitThread( p_vout );
1190
1191             vlc_mutex_unlock( &p_vout->picture_lock );
1192         }
1193     }
1194
1195
1196     if( p_input )
1197     {
1198         vlc_object_release( p_input );
1199     }
1200
1201     /*
1202      * Error loop - wait until the thread destruction is requested
1203      */
1204     if( p_vout->b_error )
1205     {
1206         ErrorThread( p_vout );
1207     }
1208
1209     /* End of thread */
1210     EndThread( p_vout );
1211     vlc_object_unlock( p_vout );
1212 }
1213
1214 /*****************************************************************************
1215  * ErrorThread: RunThread() error loop
1216  *****************************************************************************
1217  * This function is called when an error occurred during thread main's loop.
1218  * The thread can still receive feed, but must be ready to terminate as soon
1219  * as possible.
1220  *****************************************************************************/
1221 static void ErrorThread( vout_thread_t *p_vout )
1222 {
1223     /* Wait until a `die' order */
1224     while( !p_vout->b_die )
1225     {
1226         /* Sleep a while */
1227         msleep( VOUT_IDLE_SLEEP );
1228     }
1229 }
1230
1231 /*****************************************************************************
1232  * EndThread: thread destruction
1233  *****************************************************************************
1234  * This function is called when the thread ends after a sucessful
1235  * initialization. It frees all resources allocated by InitThread.
1236  *****************************************************************************/
1237 static void EndThread( vout_thread_t *p_vout )
1238 {
1239     int     i_index;                                        /* index in heap */
1240
1241 #ifdef STATS
1242     {
1243         struct tms cpu_usage;
1244         times( &cpu_usage );
1245
1246         msg_Dbg( p_vout, "cpu usage (user: %d, system: %d)",
1247                  cpu_usage.tms_utime, cpu_usage.tms_stime );
1248     }
1249 #endif
1250
1251     if( !p_vout->b_direct )
1252     {
1253         module_Unneed( p_vout, p_vout->chroma.p_module );
1254     }
1255
1256     /* Destroy all remaining pictures */
1257     for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++ )
1258     {
1259         if ( p_vout->p_picture[i_index].i_type == MEMORY_PICTURE )
1260         {
1261             free( p_vout->p_picture[i_index].p_data_orig );
1262         }
1263     }
1264
1265     /* Destroy subpicture unit */
1266     spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), false );
1267     spu_Destroy( p_vout->p_spu );
1268
1269     /* Destroy the video filters2 */
1270     RemoveVideoFilters2( p_vout );
1271
1272     /* Destroy translation tables */
1273     p_vout->pf_end( p_vout );
1274
1275     /* Release the change lock */
1276     vlc_mutex_unlock( &p_vout->change_lock );
1277 }
1278
1279 /* following functions are local */
1280
1281 static int ReduceHeight( int i_ratio )
1282 {
1283     int i_dummy = VOUT_ASPECT_FACTOR;
1284     int i_pgcd  = 1;
1285
1286     if( !i_ratio )
1287     {
1288         return i_pgcd;
1289     }
1290
1291     /* VOUT_ASPECT_FACTOR is (2^7 * 3^3 * 5^3), we just check for 2, 3 and 5 */
1292     while( !(i_ratio & 1) && !(i_dummy & 1) )
1293     {
1294         i_ratio >>= 1;
1295         i_dummy >>= 1;
1296         i_pgcd  <<= 1;
1297     }
1298
1299     while( !(i_ratio % 3) && !(i_dummy % 3) )
1300     {
1301         i_ratio /= 3;
1302         i_dummy /= 3;
1303         i_pgcd  *= 3;
1304     }
1305
1306     while( !(i_ratio % 5) && !(i_dummy % 5) )
1307     {
1308         i_ratio /= 5;
1309         i_dummy /= 5;
1310         i_pgcd  *= 5;
1311     }
1312
1313     return i_pgcd;
1314 }
1315
1316 static void AspectRatio( int i_aspect, int *i_aspect_x, int *i_aspect_y )
1317 {
1318     unsigned int i_pgcd = ReduceHeight( i_aspect );
1319     *i_aspect_x = i_aspect / i_pgcd;
1320     *i_aspect_y = VOUT_ASPECT_FACTOR / i_pgcd;
1321 }
1322
1323 /*****************************************************************************
1324  * BinaryLog: computes the base 2 log of a binary value
1325  *****************************************************************************
1326  * This functions is used by MaskToShift, to get a bit index from a binary
1327  * value.
1328  *****************************************************************************/
1329 static int BinaryLog( uint32_t i )
1330 {
1331     int i_log = 0;
1332
1333     if( i == 0 ) return -31337;
1334
1335     if( i & 0xffff0000 ) i_log += 16;
1336     if( i & 0xff00ff00 ) i_log += 8;
1337     if( i & 0xf0f0f0f0 ) i_log += 4;
1338     if( i & 0xcccccccc ) i_log += 2;
1339     if( i & 0xaaaaaaaa ) i_log += 1;
1340
1341     return i_log;
1342 }
1343
1344 /*****************************************************************************
1345  * MaskToShift: transform a color mask into right and left shifts
1346  *****************************************************************************
1347  * This function is used for obtaining color shifts from masks.
1348  *****************************************************************************/
1349 static void MaskToShift( int *pi_left, int *pi_right, uint32_t i_mask )
1350 {
1351     uint32_t i_low, i_high;            /* lower hand higher bits of the mask */
1352
1353     if( !i_mask )
1354     {
1355         *pi_left = *pi_right = 0;
1356         return;
1357     }
1358
1359     /* Get bits */
1360     i_low = i_high = i_mask;
1361
1362     i_low &= - (int32_t)i_low;          /* lower bit of the mask */
1363     i_high += i_low;                    /* higher bit of the mask */
1364
1365     /* Transform bits into an index. Also deal with i_high overflow, which
1366      * is faster than changing the BinaryLog code to handle 64 bit integers. */
1367     i_low =  BinaryLog (i_low);
1368     i_high = i_high ? BinaryLog (i_high) : 32;
1369
1370     /* Update pointers and return */
1371     *pi_left =   i_low;
1372     *pi_right = (8 - i_high + i_low);
1373 }
1374
1375 /*****************************************************************************
1376  * vout_VarCallback: generic callback for intf variables
1377  *****************************************************************************/
1378 int vout_VarCallback( vlc_object_t * p_this, const char * psz_variable,
1379                       vlc_value_t oldval, vlc_value_t newval,
1380                       void *p_data )
1381 {
1382     vout_thread_t * p_vout = (vout_thread_t *)p_this;
1383     vlc_value_t val;
1384     (void)psz_variable; (void)newval; (void)oldval; (void)p_data;
1385     val.b_bool = true;
1386     var_Set( p_vout, "intf-change", val );
1387     return VLC_SUCCESS;
1388 }
1389
1390 /*****************************************************************************
1391  * Helper thread for object variables callbacks.
1392  * Only used to avoid deadlocks when using the video embedded mode.
1393  *****************************************************************************/
1394 typedef struct suxor_thread_t
1395 {
1396     VLC_COMMON_MEMBERS
1397     input_thread_t *p_input;
1398
1399 } suxor_thread_t;
1400
1401 static void SuxorRestartVideoES( suxor_thread_t *p_this )
1402 {
1403     vlc_value_t val;
1404
1405     vlc_thread_ready( p_this );
1406
1407     /* Now restart current video stream */
1408     var_Get( p_this->p_input, "video-es", &val );
1409     if( val.i_int >= 0 )
1410     {
1411         vlc_value_t val_es;
1412         val_es.i_int = -VIDEO_ES;
1413         var_Set( p_this->p_input, "video-es", val_es );
1414         var_Set( p_this->p_input, "video-es", val );
1415     }
1416
1417     vlc_object_release( p_this->p_input );
1418
1419     vlc_object_release( p_this );
1420 }
1421
1422 /*****************************************************************************
1423  * object variables callbacks: a bunch of object variables are used by the
1424  * interfaces to interact with the vout.
1425  *****************************************************************************/
1426 static int DeinterlaceCallback( vlc_object_t *p_this, char const *psz_cmd,
1427                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
1428 {
1429     vout_thread_t *p_vout = (vout_thread_t *)p_this;
1430     input_thread_t *p_input;
1431     vlc_value_t val;
1432
1433     char *psz_mode = newval.psz_string;
1434     char *psz_filter, *psz_deinterlace = NULL;
1435     (void)psz_cmd; (void)oldval; (void)p_data;
1436
1437     var_Get( p_vout, "vout-filter", &val );
1438     psz_filter = val.psz_string;
1439     if( psz_filter ) psz_deinterlace = strstr( psz_filter, "deinterlace" );
1440
1441     if( !psz_mode || !*psz_mode )
1442     {
1443         if( psz_deinterlace )
1444         {
1445             char *psz_src = psz_deinterlace + sizeof("deinterlace") - 1;
1446             if( psz_src[0] == ':' ) psz_src++;
1447             memmove( psz_deinterlace, psz_src, strlen(psz_src) + 1 );
1448         }
1449     }
1450     else if( !psz_deinterlace )
1451     {
1452         psz_filter = realloc( psz_filter, strlen( psz_filter ) +
1453                               sizeof(":deinterlace") );
1454         if( psz_filter && *psz_filter ) strcat( psz_filter, ":" );
1455         strcat( psz_filter, "deinterlace" );
1456     }
1457
1458     p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1459                                                  FIND_PARENT );
1460     if( !p_input ) return VLC_EGENERIC;
1461
1462     if( psz_mode && *psz_mode )
1463     {
1464         /* Modify input as well because the vout might have to be restarted */
1465         val.psz_string = psz_mode;
1466         var_Create( p_input, "deinterlace-mode", VLC_VAR_STRING );
1467         var_Set( p_input, "deinterlace-mode", val );
1468     }
1469     vlc_object_release( p_input );
1470
1471     val.b_bool = true;
1472     var_Set( p_vout, "intf-change", val );
1473
1474     val.psz_string = psz_filter;
1475     var_Set( p_vout, "vout-filter", val );
1476     free( psz_filter );
1477
1478     return VLC_SUCCESS;
1479 }
1480
1481 static int FilterCallback( vlc_object_t *p_this, char const *psz_cmd,
1482                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
1483 {
1484     vout_thread_t *p_vout = (vout_thread_t *)p_this;
1485     input_thread_t *p_input;
1486     vlc_value_t val;
1487     (void)psz_cmd; (void)oldval; (void)p_data;
1488
1489     p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1490                                                  FIND_PARENT );
1491     if (!p_input)
1492     {
1493         msg_Err( p_vout, "Input not found" );
1494         return( VLC_EGENERIC );
1495     }
1496
1497     val.b_bool = true;
1498     var_Set( p_vout, "intf-change", val );
1499
1500     /* Modify input as well because the vout might have to be restarted */
1501     val.psz_string = newval.psz_string;
1502     var_Create( p_input, "vout-filter", VLC_VAR_STRING );
1503
1504     var_Set( p_input, "vout-filter", val );
1505
1506     /* Now restart current video stream */
1507     var_Get( p_input, "video-es", &val );
1508     if( val.i_int >= 0 )
1509     {
1510         suxor_thread_t *p_suxor =
1511             vlc_object_create( p_vout, sizeof(suxor_thread_t) );
1512         p_suxor->p_input = p_input;
1513         p_vout->b_filter_change = true;
1514         vlc_object_yield( p_input );
1515         vlc_thread_create( p_suxor, "suxor", SuxorRestartVideoES,
1516                            VLC_THREAD_PRIORITY_LOW, false );
1517     }
1518
1519     vlc_object_release( p_input );
1520
1521     return VLC_SUCCESS;
1522 }
1523
1524 /*****************************************************************************
1525  * Video Filter2 stuff
1526  *****************************************************************************/
1527 static int ParseVideoFilter2Chain( vout_thread_t *p_vout, char *psz_vfilters )
1528 {
1529     int i;
1530     for( i = 0; i < p_vout->i_vfilters_cfg; i++ )
1531     {
1532         struct config_chain_t *p_cfg =
1533             p_vout->p_vfilters_cfg[p_vout->i_vfilters_cfg];
1534         config_ChainDestroy( p_cfg );
1535         free( p_vout->psz_vfilters[p_vout->i_vfilters_cfg] );
1536         p_vout->psz_vfilters[p_vout->i_vfilters_cfg] = NULL;
1537     }
1538     p_vout->i_vfilters_cfg = 0;
1539     if( psz_vfilters && *psz_vfilters )
1540     {
1541         char *psz_parser = psz_vfilters;
1542
1543         while( psz_parser && *psz_parser )
1544         {
1545             psz_parser = config_ChainCreate(
1546                             &p_vout->psz_vfilters[p_vout->i_vfilters_cfg],
1547                             &p_vout->p_vfilters_cfg[p_vout->i_vfilters_cfg],
1548                             psz_parser );
1549             msg_Dbg( p_vout, "adding vfilter: %s",
1550                      p_vout->psz_vfilters[p_vout->i_vfilters_cfg] );
1551             p_vout->i_vfilters_cfg++;
1552             if( psz_parser && *psz_parser )
1553             {
1554                 if( p_vout->i_vfilters_cfg == MAX_VFILTERS )
1555                 {
1556                     msg_Warn( p_vout,
1557                   "maximum number of video filters reached. \"%s\" discarded",
1558                               psz_parser );
1559                     break;
1560                 }
1561             }
1562         }
1563     }
1564     return VLC_SUCCESS;
1565 }
1566
1567 static int VideoFilter2Callback( vlc_object_t *p_this, char const *psz_cmd,
1568                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
1569 {
1570     vout_thread_t *p_vout = (vout_thread_t *)p_this;
1571     (void)psz_cmd; (void)oldval; (void)p_data;
1572
1573     vlc_mutex_lock( &p_vout->vfilter_lock );
1574     ParseVideoFilter2Chain( p_vout, newval.psz_string );
1575     p_vout->b_vfilter_change = true;
1576     vlc_mutex_unlock( &p_vout->vfilter_lock );
1577
1578     return VLC_SUCCESS;
1579 }
1580
1581 static void RemoveVideoFilters2( vout_thread_t *p_vout )
1582 {
1583     int i;
1584     for( i = 0; i < p_vout->i_vfilters; i++ )
1585     {
1586         vlc_object_detach( p_vout->pp_vfilters[i] );
1587         if( p_vout->pp_vfilters[i]->p_module )
1588         {
1589             module_Unneed( p_vout->pp_vfilters[i],
1590                            p_vout->pp_vfilters[i]->p_module );
1591         }
1592
1593         free( p_vout->pp_vfilters[i]->p_owner );
1594         vlc_object_release( p_vout->pp_vfilters[i] );
1595     }
1596     p_vout->i_vfilters = 0;
1597 }
1598
1599 static void DisplayTitleOnOSD( vout_thread_t *p_vout )
1600 {
1601     input_thread_t *p_input;
1602     mtime_t i_now, i_stop;
1603
1604     p_input = (input_thread_t *)vlc_object_find( p_vout,
1605               VLC_OBJECT_INPUT, FIND_ANYWHERE );
1606     if( p_input )
1607     {
1608         i_now = mdate();
1609         i_stop = i_now + (mtime_t)(p_vout->i_title_timeout * 1000);
1610         char *psz_nowplaying =
1611             input_item_GetNowPlaying( input_GetItem( p_input ) );
1612         char *psz_artist = input_item_GetArtist( input_GetItem( p_input ) );
1613         char *psz_name = input_item_GetTitle( input_GetItem( p_input ) );
1614         if( EMPTY_STR( psz_name ) )
1615         {
1616             free( psz_name );
1617             psz_name = input_item_GetName( input_GetItem( p_input ) );
1618         }
1619         if( !EMPTY_STR( psz_nowplaying ) )
1620         {
1621             vout_ShowTextAbsolute( p_vout, DEFAULT_CHAN,
1622                                    psz_nowplaying, NULL,
1623                                    p_vout->i_title_position,
1624                                    30 + p_vout->fmt_in.i_width
1625                                       - p_vout->fmt_in.i_visible_width
1626                                       - p_vout->fmt_in.i_x_offset,
1627                                    20 + p_vout->fmt_in.i_y_offset,
1628                                    i_now, i_stop );
1629         }
1630         else if( !EMPTY_STR( psz_artist ) )
1631         {
1632             char *psz_string = NULL;
1633             if( asprintf( &psz_string, "%s - %s", psz_name, psz_artist ) != -1 )
1634             {
1635                 vout_ShowTextAbsolute( p_vout, DEFAULT_CHAN,
1636                                        psz_string, NULL,
1637                                        p_vout->i_title_position,
1638                                        30 + p_vout->fmt_in.i_width
1639                                           - p_vout->fmt_in.i_visible_width
1640                                           - p_vout->fmt_in.i_x_offset,
1641                                        20 + p_vout->fmt_in.i_y_offset,
1642                                        i_now, i_stop );
1643                 free( psz_string );
1644             }
1645         }
1646         else
1647         {
1648             vout_ShowTextAbsolute( p_vout, DEFAULT_CHAN,
1649                                    psz_name, NULL,
1650                                    p_vout->i_title_position,
1651                                    30 + p_vout->fmt_in.i_width
1652                                       - p_vout->fmt_in.i_visible_width
1653                                       - p_vout->fmt_in.i_x_offset,
1654                                    20 + p_vout->fmt_in.i_y_offset,
1655                                    i_now, i_stop );
1656         }
1657         vlc_object_release( p_input );
1658         free( psz_artist );
1659         free( psz_name );
1660         free( psz_nowplaying );
1661     }
1662 }
1663