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
  48 #include <vlc_filter.h>
  49 #include <vlc_osd.h>
  50 #include <assert.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 <libvlc.h>
  61 #include <vlc_input.h>
  62 #include "vout_pictures.h"
  63 #include "vout_internal.h"
  64
  65 /*****************************************************************************
  66  * Local prototypes
  67  *****************************************************************************/
  68 static int      InitThread        ( vout_thread_t * );
  69 static void*    RunThread         ( void *  );
  70 static void     ErrorThread       ( vout_thread_t * );
  71 static void     CleanThread       ( vout_thread_t * );
  72 static void     EndThread         ( vout_thread_t * );
  73
  74 static void     AspectRatio       ( int, int *, int * );
  75
  76 static void VideoFormatImportRgb( video_format_t *, const picture_heap_t * );
  77 static void PictureHeapFixRgb( picture_heap_t * );
  78
  79 static void     vout_Destructor   ( vlc_object_t * p_this );
  80
  81 /* Object variables callbacks */
  82 static int FilterCallback( vlc_object_t *, char const *,
  83                            vlc_value_t, vlc_value_t, void * );
  84 static int VideoFilter2Callback( vlc_object_t *, char const *,
  85                                  vlc_value_t, vlc_value_t, void * );
  86
  87 /* */
  88 static void PostProcessEnable( vout_thread_t * );
  89 static void PostProcessDisable( vout_thread_t * );
  90 static void PostProcessSetFilterQuality( vout_thread_t *p_vout );
  91 static int  PostProcessCallback( vlc_object_t *, char const *,
  92                                  vlc_value_t, vlc_value_t, void * );
  93 /* */
  94 static void DeinterlaceEnable( vout_thread_t * );
  95
  96 /* From vout_intf.c */
  97 int vout_Snapshot( vout_thread_t *, picture_t * );
  98
  99 /* Display media title in OSD */
 100 static void DisplayTitleOnOSD( vout_thread_t *p_vout );
 101
 102 /* Time during which the thread will sleep if it has nothing to
 103  * display (in micro-seconds) */
 104 #define VOUT_IDLE_SLEEP                 ((int)(0.020*CLOCK_FREQ))
 105
 106 /* Maximum lap of time allowed between the beginning of rendering and
 107  * display. If, compared to the current date, the next image is too
 108  * late, the thread will perform an idle loop. This time should be
 109  * at least VOUT_IDLE_SLEEP plus the time required to render a few
 110  * images, to avoid trashing of decoded images */
 111 #define VOUT_DISPLAY_DELAY              ((int)(0.200*CLOCK_FREQ))
 112
 113 /* Better be in advance when awakening than late... */
 114 #define VOUT_MWAIT_TOLERANCE            ((mtime_t)(0.020*CLOCK_FREQ))
 115
 116 /* Minimum number of direct pictures the video output will accept without
 117  * creating additional pictures in system memory */
 118 #ifdef OPTIMIZE_MEMORY
 119 #   define VOUT_MIN_DIRECT_PICTURES        (VOUT_MAX_PICTURES/2)
 120 #else
 121 #   define VOUT_MIN_DIRECT_PICTURES        (3*VOUT_MAX_PICTURES/4)
 122 #endif
 123
 124 /*****************************************************************************
 125  * Video Filter2 functions
 126  *****************************************************************************/
 127 static picture_t *video_new_buffer_filter( filter_t *p_filter )
 128 {
 129     vout_thread_t *p_vout = (vout_thread_t*)p_filter->p_owner;
 130     picture_t *p_picture = vout_CreatePicture( p_vout, 0, 0, 0 );
 131
 132     p_picture->i_status = READY_PICTURE;
 133
 134     return p_picture;
 135 }
 136
 137 static void video_del_buffer_filter( filter_t *p_filter, picture_t *p_pic )
 138 {
 139     vout_thread_t *p_vout = (vout_thread_t*)p_filter->p_owner;
 140
 141     vlc_mutex_lock( &p_vout->picture_lock );
 142     vout_UsePictureLocked( p_vout, p_pic );
 143     vlc_mutex_unlock( &p_vout->picture_lock );
 144 }
 145
 146 static int video_filter_buffer_allocation_init( filter_t *p_filter, void *p_data )
 147 {
 148     p_filter->pf_vout_buffer_new = video_new_buffer_filter;
 149     p_filter->pf_vout_buffer_del = video_del_buffer_filter;
 150     p_filter->p_owner = p_data; /* p_vout */
 151     return VLC_SUCCESS;
 152 }
 153
 154 /*****************************************************************************
 155  * vout_Request: find a video output thread, create one, or destroy one.
 156  *****************************************************************************
 157  * This function looks for a video output thread matching the current
 158  * properties. If not found, it spawns a new one.
 159  *****************************************************************************/
 160 vout_thread_t *__vout_Request( vlc_object_t *p_this, vout_thread_t *p_vout,
 161                                video_format_t *p_fmt )
 162 {
 163     if( !p_fmt )
 164     {
 165         /* Video output is no longer used.
 166          * TODO: support for reusing video outputs with proper _thread-safe_
 167          * reference handling. */
 168         if( p_vout )
 169             vout_CloseAndRelease( p_vout );
 170         return NULL;
 171     }
 172
 173     /* If a video output was provided, lock it, otherwise look for one. */
 174     if( p_vout )
 175     {
 176         vlc_object_hold( p_vout );
 177     }
 178
 179     /* TODO: find a suitable unused video output */
 180
 181     /* If we now have a video output, check it has the right properties */
 182     if( p_vout )
 183     {
 184         vlc_mutex_lock( &p_vout->change_lock );
 185
 186         /* We don't directly check for the "vout-filter" variable for obvious
 187          * performance reasons. */
 188         if( p_vout->p->b_filter_change )
 189         {
 190             char *psz_filter_chain = var_GetString( p_vout, "vout-filter" );
 191
 192             if( psz_filter_chain && !*psz_filter_chain )
 193             {
 194                 free( psz_filter_chain );
 195                 psz_filter_chain = NULL;
 196             }
 197             if( p_vout->p->psz_filter_chain && !*p_vout->p->psz_filter_chain )
 198             {
 199                 free( p_vout->p->psz_filter_chain );
 200                 p_vout->p->psz_filter_chain = NULL;
 201             }
 202
 203             if( !psz_filter_chain && !p_vout->p->psz_filter_chain )
 204             {
 205                 p_vout->p->b_filter_change = false;
 206             }
 207
 208             free( psz_filter_chain );
 209         }
 210
 211         if( p_vout->fmt_render.i_chroma != vlc_fourcc_GetCodec( VIDEO_ES, p_fmt->i_chroma ) ||
 212             p_vout->fmt_render.i_width != p_fmt->i_width ||
 213             p_vout->fmt_render.i_height != p_fmt->i_height ||
 214             p_vout->p->b_filter_change )
 215         {
 216             vlc_mutex_unlock( &p_vout->change_lock );
 217
 218             /* We are not interested in this format, close this vout */
 219             vout_CloseAndRelease( p_vout );
 220             vlc_object_release( p_vout );
 221             p_vout = NULL;
 222         }
 223         else
 224         {
 225             /* This video output is cool! Hijack it. */
 226             if( p_vout->fmt_render.i_aspect != p_fmt->i_aspect )
 227             {
 228                 /* Correct aspect ratio on change
 229                  * FIXME factorize this code with other aspect ration related code */
 230                 unsigned int i_sar_num;
 231                 unsigned int i_sar_den;
 232                 unsigned int i_aspect;
 233
 234                 i_aspect = p_fmt->i_aspect;
 235                 vlc_ureduce( &i_sar_num, &i_sar_den,
 236                              p_fmt->i_sar_num, p_fmt->i_sar_den, 50000 );
 237 #if 0
 238                 /* What's that, it does not seems to be used correcly everywhere
 239                  * beside the previous p_vout->fmt_render.i_aspect != p_fmt->i_aspect
 240                  * should be fixed to use it too then */
 241                 if( p_vout->i_par_num > 0 && p_vout->i_par_den > 0 )
 242                 {
 243                     i_sar_num *= p_vout->i_par_den;
 244                     i_sar_den *= p_vout->i_par_num;
 245                     i_aspect = i_aspect * p_vout->i_par_den / p_vout->i_par_num;
 246                 }
 247 #endif
 248
 249                 if( i_sar_num > 0 && i_sar_den > 0 && i_aspect > 0 )
 250                 {
 251                     p_vout->fmt_in.i_sar_num = i_sar_num;
 252                     p_vout->fmt_in.i_sar_den = i_sar_den;
 253                     p_vout->fmt_in.i_aspect  = i_aspect;
 254
 255                     p_vout->fmt_render.i_sar_num = i_sar_num;
 256                     p_vout->fmt_render.i_sar_den = i_sar_den;
 257                     p_vout->fmt_render.i_aspect  = i_aspect;
 258
 259                     p_vout->render.i_aspect   = i_aspect;
 260
 261                     p_vout->i_changes |= VOUT_ASPECT_CHANGE;
 262
 263                 }
 264             }
 265             vlc_mutex_unlock( &p_vout->change_lock );
 266
 267             vlc_object_release( p_vout );
 268         }
 269
 270         if( p_vout )
 271         {
 272             msg_Dbg( p_this, "reusing provided vout" );
 273
 274             spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), false );
 275             vlc_object_detach( p_vout );
 276
 277             vlc_object_attach( p_vout, p_this );
 278             spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), true );
 279         }
 280     }
 281
 282     if( !p_vout )
 283     {
 284         msg_Dbg( p_this, "no usable vout present, spawning one" );
 285
 286         p_vout = vout_Create( p_this, p_fmt );
 287     }
 288
 289     return p_vout;
 290 }
 291
 292 /*****************************************************************************
 293  * vout_Create: creates a new video output thread
 294  *****************************************************************************
 295  * This function creates a new video output thread, and returns a pointer
 296  * to its description. On error, it returns NULL.
 297  *****************************************************************************/
 298 vout_thread_t * __vout_Create( vlc_object_t *p_parent, video_format_t *p_fmt )
 299 {
 300     vout_thread_t  * p_vout;                            /* thread descriptor */
 301     int              i_index;                               /* loop variable */
 302     vlc_value_t      text;
 303
 304     unsigned int i_width = p_fmt->i_width;
 305     unsigned int i_height = p_fmt->i_height;
 306     vlc_fourcc_t i_chroma = vlc_fourcc_GetCodec( VIDEO_ES, p_fmt->i_chroma );
 307     unsigned int i_aspect = p_fmt->i_aspect;
 308
 309     config_chain_t *p_cfg;
 310     char *psz_parser;
 311     char *psz_name;
 312
 313     if( i_width <= 0 || i_height <= 0 || i_aspect <= 0 )
 314         return NULL;
 315
 316     vlc_ureduce( &p_fmt->i_sar_num, &p_fmt->i_sar_den,
 317                  p_fmt->i_sar_num, p_fmt->i_sar_den, 50000 );
 318     if( p_fmt->i_sar_num <= 0 || p_fmt->i_sar_den <= 0 )
 319         return NULL;
 320
 321     /* Allocate descriptor */
 322     static const char typename[] = "video output";
 323     p_vout = vlc_custom_create( p_parent, sizeof( *p_vout ), VLC_OBJECT_VOUT,
 324                                 typename );
 325     if( p_vout == NULL )
 326         return NULL;
 327
 328     /* */
 329     p_vout->p = calloc( 1, sizeof(*p_vout->p) );
 330     if( !p_vout->p )
 331     {
 332         vlc_object_release( p_vout );
 333         return NULL;
 334     }
 335
 336     /* Initialize pictures - translation tables and functions
 337      * will be initialized later in InitThread */
 338     for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++)
 339     {
 340         p_vout->p_picture[i_index].pf_lock = NULL;
 341         p_vout->p_picture[i_index].pf_unlock = NULL;
 342         p_vout->p_picture[i_index].i_status = FREE_PICTURE;
 343         p_vout->p_picture[i_index].i_type   = EMPTY_PICTURE;
 344         p_vout->p_picture[i_index].b_slow   = 0;
 345     }
 346
 347     /* No images in the heap */
 348     p_vout->i_heap_size = 0;
 349
 350     /* Initialize the rendering heap */
 351     I_RENDERPICTURES = 0;
 352
 353     p_vout->fmt_render        = *p_fmt;   /* FIXME palette */
 354     p_vout->fmt_in            = *p_fmt;   /* FIXME palette */
 355
 356     p_vout->render.i_width    = i_width;
 357     p_vout->render.i_height   = i_height;
 358     p_vout->render.i_chroma   = i_chroma;
 359     p_vout->render.i_aspect   = i_aspect;
 360
 361     p_vout->render.i_rmask    = p_fmt->i_rmask;
 362     p_vout->render.i_gmask    = p_fmt->i_gmask;
 363     p_vout->render.i_bmask    = p_fmt->i_bmask;
 364
 365     p_vout->render.i_last_used_pic = -1;
 366     p_vout->render.b_allow_modify_pics = 1;
 367
 368     /* Zero the output heap */
 369     I_OUTPUTPICTURES = 0;
 370     p_vout->output.i_width    = 0;
 371     p_vout->output.i_height   = 0;
 372     p_vout->output.i_chroma   = 0;
 373     p_vout->output.i_aspect   = 0;
 374
 375     p_vout->output.i_rmask    = 0;
 376     p_vout->output.i_gmask    = 0;
 377     p_vout->output.i_bmask    = 0;
 378
 379     /* Initialize misc stuff */
 380     p_vout->i_changes    = 0;
 381     p_vout->b_autoscale  = 1;
 382     p_vout->i_zoom      = ZOOM_FP_FACTOR;
 383     p_vout->b_fullscreen = 0;
 384     p_vout->i_alignment  = 0;
 385     p_vout->p->render_time  = 10;
 386     p_vout->p->c_fps_samples = 0;
 387     vout_statistic_Init( &p_vout->p->statistic );
 388     p_vout->p->b_filter_change = 0;
 389     p_vout->p->b_paused = false;
 390     p_vout->p->i_pause_date = 0;
 391     p_vout->pf_control = NULL;
 392     p_vout->p->i_par_num =
 393     p_vout->p->i_par_den = 1;
 394     p_vout->p->p_picture_displayed = NULL;
 395     p_vout->p->i_picture_displayed_date = 0;
 396     p_vout->p->b_picture_displayed = false;
 397     p_vout->p->b_picture_empty = false;
 398     p_vout->p->i_picture_qtype = QTYPE_NONE;
 399
 400     vlc_mouse_Init( &p_vout->p->mouse );
 401
 402     vout_snapshot_Init( &p_vout->p->snapshot );
 403
 404     /* Initialize locks */
 405     vlc_mutex_init( &p_vout->picture_lock );
 406     vlc_cond_init( &p_vout->p->picture_wait );
 407     vlc_mutex_init( &p_vout->change_lock );
 408     vlc_mutex_init( &p_vout->p->vfilter_lock );
 409
 410     /* Mouse coordinates */
 411     var_Create( p_vout, "mouse-x", VLC_VAR_INTEGER );
 412     var_Create( p_vout, "mouse-y", VLC_VAR_INTEGER );
 413     var_Create( p_vout, "mouse-button-down", VLC_VAR_INTEGER );
 414     var_Create( p_vout, "mouse-moved", VLC_VAR_BOOL );
 415     var_Create( p_vout, "mouse-clicked", VLC_VAR_BOOL );
 416
 417     /* Initialize subpicture unit */
 418     p_vout->p_spu = spu_Create( p_vout );
 419
 420     /* Attach the new object now so we can use var inheritance below */
 421     vlc_object_attach( p_vout, p_parent );
 422
 423     /* */
 424     spu_Init( p_vout->p_spu );
 425
 426     spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), true );
 427
 428     /* Take care of some "interface/control" related initialisations */
 429     vout_IntfInit( p_vout );
 430
 431     /* If the parent is not a VOUT object, that means we are at the start of
 432      * the video output pipe */
 433     if( vlc_internals( p_parent )->i_object_type != VLC_OBJECT_VOUT )
 434     {
 435         /* Look for the default filter configuration */
 436         p_vout->p->psz_filter_chain =
 437             var_CreateGetStringCommand( p_vout, "vout-filter" );
 438
 439         /* Apply video filter2 objects on the first vout */
 440         p_vout->p->psz_vf2 =
 441             var_CreateGetStringCommand( p_vout, "video-filter" );
 442
 443         p_vout->p->b_first_vout = true;
 444     }
 445     else
 446     {
 447         /* continue the parent's filter chain */
 448         char *psz_tmp;
 449
 450         /* Ugly hack to jump to our configuration chain */
 451         p_vout->p->psz_filter_chain
 452             = ((vout_thread_t *)p_parent)->p->psz_filter_chain;
 453         p_vout->p->psz_filter_chain
 454             = config_ChainCreate( &psz_tmp, &p_cfg, p_vout->p->psz_filter_chain );
 455         config_ChainDestroy( p_cfg );
 456         free( psz_tmp );
 457
 458         /* Create a video filter2 var ... but don't inherit values */
 459         var_Create( p_vout, "video-filter",
 460                     VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
 461         p_vout->p->psz_vf2 = var_GetString( p_vout, "video-filter" );
 462
 463         /* */
 464         p_vout->p->b_first_vout = false;
 465     }
 466
 467     var_AddCallback( p_vout, "video-filter", VideoFilter2Callback, NULL );
 468     p_vout->p->p_vf2_chain = filter_chain_New( p_vout, "video filter2",
 469         false, video_filter_buffer_allocation_init, NULL, p_vout );
 470
 471     /* Choose the video output module */
 472     if( !p_vout->p->psz_filter_chain || !*p_vout->p->psz_filter_chain )
 473     {
 474         psz_parser = var_CreateGetString( p_vout, "vout" );
 475     }
 476     else
 477     {
 478         psz_parser = strdup( p_vout->p->psz_filter_chain );
 479         p_vout->p->b_title_show = false;
 480     }
 481
 482     /* Create the vout thread */
 483     char* psz_tmp = config_ChainCreate( &psz_name, &p_cfg, psz_parser );
 484     free( psz_parser );
 485     free( psz_tmp );
 486     p_vout->p_cfg = p_cfg;
 487     p_vout->p_module = module_need( p_vout,
 488         ( p_vout->p->psz_filter_chain && *p_vout->p->psz_filter_chain ) ?
 489         "video filter" : "video output", psz_name, p_vout->p->psz_filter_chain && *p_vout->p->psz_filter_chain );
 490     free( psz_name );
 491
 492     vlc_object_set_destructor( p_vout, vout_Destructor );
 493
 494     if( p_vout->p_module == NULL )
 495     {
 496         msg_Err( p_vout, "no suitable vout module" );
 497         spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), false );
 498         spu_Destroy( p_vout->p_spu );
 499         p_vout->p_spu = NULL;
 500         vlc_object_release( p_vout );
 501         return NULL;
 502     }
 503
 504     /* Create a few object variables for interface interaction */
 505     var_Create( p_vout, "vout-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 506     text.psz_string = _("Filters");
 507     var_Change( p_vout, "vout-filter", VLC_VAR_SETTEXT, &text, NULL );
 508     var_AddCallback( p_vout, "vout-filter", FilterCallback, NULL );
 509
 510     /* */
 511     DeinterlaceEnable( p_vout );
 512
 513     /* */
 514     vlc_cond_init( &p_vout->p->change_wait );
 515     if( vlc_clone( &p_vout->p->thread, RunThread, p_vout,
 516                    VLC_THREAD_PRIORITY_OUTPUT ) )
 517     {
 518         module_unneed( p_vout, p_vout->p_module );
 519         p_vout->p_module = NULL;
 520         spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), false );
 521         spu_Destroy( p_vout->p_spu );
 522         p_vout->p_spu = NULL;
 523         vlc_object_release( p_vout );
 524         return NULL;
 525     }
 526
 527     vlc_mutex_lock( &p_vout->change_lock );
 528     while( !p_vout->p->b_ready )
 529     {   /* We are (ab)using the same condition in opposite directions for
 530          * b_ready and b_done. This works because of the strict ordering. */
 531         assert( !p_vout->p->b_done );
 532         vlc_cond_wait( &p_vout->p->change_wait, &p_vout->change_lock );
 533     }
 534     vlc_mutex_unlock( &p_vout->change_lock );
 535
 536     if( p_vout->b_error )
 537     {
 538         msg_Err( p_vout, "video output creation failed" );
 539         vout_CloseAndRelease( p_vout );
 540         return NULL;
 541     }
 542
 543     return p_vout;
 544 }
 545
 546 /*****************************************************************************
 547  * vout_Close: Close a vout created by vout_Create.
 548  *****************************************************************************
 549  * You HAVE to call it on vout created by vout_Create before vlc_object_release.
 550  * You should NEVER call it on vout not obtained through vout_Create
 551  * (like with vout_Request or vlc_object_find.)
 552  * You can use vout_CloseAndRelease() as a convenience method.
 553  *****************************************************************************/
 554 void vout_Close( vout_thread_t *p_vout )
 555 {
 556     assert( p_vout );
 557
 558     vlc_mutex_lock( &p_vout->change_lock );
 559     p_vout->p->b_done = true;
 560     vlc_cond_signal( &p_vout->p->change_wait );
 561     vlc_mutex_unlock( &p_vout->change_lock );
 562
 563     vout_snapshot_End( &p_vout->p->snapshot );
 564
 565     vlc_join( p_vout->p->thread, NULL );
 566     module_unneed( p_vout, p_vout->p_module );
 567     p_vout->p_module = NULL;
 568 }
 569
 570 /* */
 571 static void vout_Destructor( vlc_object_t * p_this )
 572 {
 573     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 574
 575     /* Make sure the vout was stopped first */
 576     assert( !p_vout->p_module );
 577
 578     /* */
 579     if( p_vout->p_spu )
 580         spu_Destroy( p_vout->p_spu );
 581
 582     /* Destroy the locks */
 583     vlc_cond_destroy( &p_vout->p->change_wait );
 584     vlc_cond_destroy( &p_vout->p->picture_wait );
 585     vlc_mutex_destroy( &p_vout->picture_lock );
 586     vlc_mutex_destroy( &p_vout->change_lock );
 587     vlc_mutex_destroy( &p_vout->p->vfilter_lock );
 588
 589     /* */
 590     vout_statistic_Clean( &p_vout->p->statistic );
 591
 592     /* */
 593     vout_snapshot_Clean( &p_vout->p->snapshot );
 594
 595     /* */
 596     free( p_vout->p->psz_filter_chain );
 597     free( p_vout->p->psz_title );
 598
 599     config_ChainDestroy( p_vout->p_cfg );
 600
 601     free( p_vout->p );
 602
 603 #ifndef __APPLE__
 604     vout_thread_t *p_another_vout;
 605
 606     /* This is a dirty hack mostly for Linux, where there is no way to get the
 607      * GUI back if you closed it while playing video. This is solved in
 608      * Mac OS X, where we have this novelty called menubar, that will always
 609      * allow you access to the applications main functionality. They should try
 610      * that on linux sometime. */
 611     p_another_vout = vlc_object_find( p_this->p_libvlc,
 612                                       VLC_OBJECT_VOUT, FIND_ANYWHERE );
 613     if( p_another_vout == NULL )
 614         var_SetBool( p_this->p_libvlc, "intf-show", true );
 615     else
 616         vlc_object_release( p_another_vout );
 617 #endif
 618 }
 619
 620 /* */
 621 void vout_ChangePause( vout_thread_t *p_vout, bool b_paused, mtime_t i_date )
 622 {
 623     vlc_mutex_lock( &p_vout->change_lock );
 624
 625     assert( !p_vout->p->b_paused || !b_paused );
 626
 627     vlc_mutex_lock( &p_vout->picture_lock );
 628
 629     p_vout->p->i_picture_displayed_date = 0;
 630
 631     if( p_vout->p->b_paused )
 632     {
 633         const mtime_t i_duration = i_date - p_vout->p->i_pause_date;
 634
 635         for( int i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
 636         {
 637             picture_t *p_pic = PP_RENDERPICTURE[i_index];
 638
 639             if( p_pic->i_status == READY_PICTURE )
 640                 p_pic->date += i_duration;
 641         }
 642         vlc_cond_signal( &p_vout->p->picture_wait );
 643         vlc_mutex_unlock( &p_vout->picture_lock );
 644
 645         spu_OffsetSubtitleDate( p_vout->p_spu, i_duration );
 646     }
 647     else
 648     {
 649         vlc_mutex_unlock( &p_vout->picture_lock );
 650     }
 651     p_vout->p->b_paused = b_paused;
 652     p_vout->p->i_pause_date = i_date;
 653
 654     vlc_mutex_unlock( &p_vout->change_lock );
 655 }
 656
 657 void vout_GetResetStatistic( vout_thread_t *p_vout, int *pi_displayed, int *pi_lost )
 658 {
 659     vout_statistic_GetReset( &p_vout->p->statistic,
 660                              pi_displayed, pi_lost );
 661 }
 662
 663 void vout_Flush( vout_thread_t *p_vout, mtime_t i_date )
 664 {
 665     vlc_mutex_lock( &p_vout->picture_lock );
 666     p_vout->p->i_picture_displayed_date = 0;
 667     for( int i = 0; i < p_vout->render.i_pictures; i++ )
 668     {
 669         picture_t *p_pic = p_vout->render.pp_picture[i];
 670
 671         if( p_pic->i_status == READY_PICTURE ||
 672             p_pic->i_status == DISPLAYED_PICTURE )
 673         {
 674             /* We cannot change picture status if it is in READY_PICTURE state,
 675              * Just make sure they won't be displayed */
 676             if( p_pic->date > i_date )
 677                 p_pic->date = i_date;
 678         }
 679     }
 680     vlc_cond_signal( &p_vout->p->picture_wait );
 681     vlc_mutex_unlock( &p_vout->picture_lock );
 682 }
 683
 684 void vout_FixLeaks( vout_thread_t *p_vout, bool b_forced )
 685 {
 686     int i_pic, i_ready_pic;
 687
 688     vlc_mutex_lock( &p_vout->picture_lock );
 689
 690     for( i_pic = 0, i_ready_pic = 0; i_pic < p_vout->render.i_pictures && !b_forced; i_pic++ )
 691     {
 692         const picture_t *p_pic = p_vout->render.pp_picture[i_pic];
 693
 694         if( p_pic->i_status == READY_PICTURE )
 695         {
 696             i_ready_pic++;
 697             /* If we have at least 2 ready pictures, wait for the vout thread to
 698              * process one */
 699             if( i_ready_pic >= 2 )
 700                 break;
 701
 702             continue;
 703         }
 704
 705         if( p_pic->i_status == DISPLAYED_PICTURE )
 706         {
 707             /* If at least one displayed picture is not referenced
 708              * let vout free it */
 709             if( p_pic->i_refcount == 0 )
 710                 break;
 711         }
 712     }
 713     if( i_pic < p_vout->render.i_pictures && !b_forced )
 714     {
 715         vlc_mutex_unlock( &p_vout->picture_lock );
 716         return;
 717     }
 718
 719     /* Too many pictures are still referenced, there is probably a bug
 720      * with the decoder */
 721     if( !b_forced )
 722         msg_Err( p_vout, "pictures leaked, resetting the heap" );
 723
 724     /* Just free all the pictures */
 725     for( i_pic = 0; i_pic < p_vout->render.i_pictures; i_pic++ )
 726     {
 727         picture_t *p_pic = p_vout->render.pp_picture[i_pic];
 728
 729         msg_Dbg( p_vout, "[%d] %d %d", i_pic, p_pic->i_status, p_pic->i_refcount );
 730         p_pic->i_refcount = 0;
 731
 732         switch( p_pic->i_status )
 733         {
 734         case READY_PICTURE:
 735         case DISPLAYED_PICTURE:
 736         case RESERVED_PICTURE:
 737             if( p_pic != p_vout->p->p_picture_displayed )
 738                 vout_UsePictureLocked( p_vout, p_pic );
 739             break;
 740         }
 741     }
 742     vlc_cond_signal( &p_vout->p->picture_wait );
 743     vlc_mutex_unlock( &p_vout->picture_lock );
 744 }
 745 void vout_NextPicture( vout_thread_t *p_vout, mtime_t *pi_duration )
 746 {
 747     vlc_mutex_lock( &p_vout->picture_lock );
 748
 749     const mtime_t i_displayed_date = p_vout->p->i_picture_displayed_date;
 750
 751     p_vout->p->b_picture_displayed = false;
 752     p_vout->p->b_picture_empty = false;
 753     if( p_vout->p->p_picture_displayed )
 754     {
 755         p_vout->p->p_picture_displayed->date = 1;
 756         vlc_cond_signal( &p_vout->p->picture_wait );
 757     }
 758
 759     while( !p_vout->p->b_picture_displayed && !p_vout->p->b_picture_empty )
 760         vlc_cond_wait( &p_vout->p->picture_wait, &p_vout->picture_lock );
 761
 762     *pi_duration = __MAX( p_vout->p->i_picture_displayed_date - i_displayed_date, 0 );
 763
 764     /* TODO advance subpicture by the duration ... */
 765
 766     vlc_mutex_unlock( &p_vout->picture_lock );
 767 }
 768
 769 void vout_DisplayTitle( vout_thread_t *p_vout, const char *psz_title )
 770 {
 771     assert( psz_title );
 772
 773     if( !config_GetInt( p_vout, "osd" ) )
 774         return;
 775
 776     vlc_mutex_lock( &p_vout->change_lock );
 777     free( p_vout->p->psz_title );
 778     p_vout->p->psz_title = strdup( psz_title );
 779     vlc_mutex_unlock( &p_vout->change_lock );
 780 }
 781
 782 spu_t *vout_GetSpu( vout_thread_t *p_vout )
 783 {
 784     return p_vout->p_spu;
 785 }
 786
 787 /*****************************************************************************
 788  * InitThread: initialize video output thread
 789  *****************************************************************************
 790  * This function is called from RunThread and performs the second step of the
 791  * initialization. It returns 0 on success. Note that the thread's flag are not
 792  * modified inside this function.
 793  * XXX You have to enter it with change_lock taken.
 794  *****************************************************************************/
 795 static int ChromaCreate( vout_thread_t *p_vout );
 796 static void ChromaDestroy( vout_thread_t *p_vout );
 797
 798 static bool ChromaIsEqual( const picture_heap_t *p_output, const picture_heap_t *p_render )
 799 {
 800      if( !vout_ChromaCmp( p_output->i_chroma, p_render->i_chroma ) )
 801          return false;
 802
 803      if( p_output->i_chroma != VLC_CODEC_RGB15 &&
 804          p_output->i_chroma != VLC_CODEC_RGB16 &&
 805          p_output->i_chroma != VLC_CODEC_RGB24 &&
 806          p_output->i_chroma != VLC_CODEC_RGB32 )
 807          return true;
 808
 809      return p_output->i_rmask == p_render->i_rmask &&
 810             p_output->i_gmask == p_render->i_gmask &&
 811             p_output->i_bmask == p_render->i_bmask;
 812 }
 813
 814 static int InitThread( vout_thread_t *p_vout )
 815 {
 816     int i, i_aspect_x, i_aspect_y;
 817
 818     /* Initialize output method, it allocates direct buffers for us */
 819     if( p_vout->pf_init( p_vout ) )
 820         return VLC_EGENERIC;
 821
 822     p_vout->p->p_picture_displayed = NULL;
 823
 824     if( !I_OUTPUTPICTURES )
 825     {
 826         msg_Err( p_vout, "plugin was unable to allocate at least "
 827                          "one direct buffer" );
 828         p_vout->pf_end( p_vout );
 829         return VLC_EGENERIC;
 830     }
 831
 832     if( I_OUTPUTPICTURES > VOUT_MAX_PICTURES )
 833     {
 834         msg_Err( p_vout, "plugin allocated too many direct buffers, "
 835                          "our internal buffers must have overflown." );
 836         p_vout->pf_end( p_vout );
 837         return VLC_EGENERIC;
 838     }
 839
 840     msg_Dbg( p_vout, "got %i direct buffer(s)", I_OUTPUTPICTURES );
 841
 842     AspectRatio( p_vout->fmt_render.i_aspect, &i_aspect_x, &i_aspect_y );
 843
 844     AspectRatio( p_vout->fmt_in.i_aspect, &i_aspect_x, &i_aspect_y );
 845
 846     if( !p_vout->fmt_out.i_width || !p_vout->fmt_out.i_height )
 847     {
 848         p_vout->fmt_out.i_width = p_vout->fmt_out.i_visible_width =
 849             p_vout->output.i_width;
 850         p_vout->fmt_out.i_height = p_vout->fmt_out.i_visible_height =
 851             p_vout->output.i_height;
 852         p_vout->fmt_out.i_x_offset =  p_vout->fmt_out.i_y_offset = 0;
 853
 854         p_vout->fmt_out.i_aspect = p_vout->output.i_aspect;
 855         p_vout->fmt_out.i_chroma = p_vout->output.i_chroma;
 856     }
 857     if( !p_vout->fmt_out.i_sar_num || !p_vout->fmt_out.i_sar_num )
 858     {
 859         p_vout->fmt_out.i_sar_num = p_vout->fmt_out.i_aspect *
 860             p_vout->fmt_out.i_height;
 861         p_vout->fmt_out.i_sar_den = VOUT_ASPECT_FACTOR *
 862             p_vout->fmt_out.i_width;
 863     }
 864
 865     vlc_ureduce( &p_vout->fmt_out.i_sar_num, &p_vout->fmt_out.i_sar_den,
 866                  p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den, 0 );
 867
 868     AspectRatio( p_vout->fmt_out.i_aspect, &i_aspect_x, &i_aspect_y );
 869
 870     /* FIXME removed the need of both fmt_* and heap infos */
 871     /* Calculate shifts from system-updated masks */
 872     PictureHeapFixRgb( &p_vout->render );
 873     VideoFormatImportRgb( &p_vout->fmt_render, &p_vout->render );
 874
 875     PictureHeapFixRgb( &p_vout->output );
 876     VideoFormatImportRgb( &p_vout->fmt_out, &p_vout->output );
 877
 878     /* print some usefull debug info about different vout formats
 879      */
 880     msg_Dbg( p_vout, "pic render sz %ix%i, of (%i,%i), vsz %ix%i, 4cc %4.4s, ar %i:%i, sar %i:%i, msk r0x%x g0x%x b0x%x",
 881              p_vout->fmt_render.i_width, p_vout->fmt_render.i_height,
 882              p_vout->fmt_render.i_x_offset, p_vout->fmt_render.i_y_offset,
 883              p_vout->fmt_render.i_visible_width,
 884              p_vout->fmt_render.i_visible_height,
 885              (char*)&p_vout->fmt_render.i_chroma,
 886              i_aspect_x, i_aspect_y,
 887              p_vout->fmt_render.i_sar_num, p_vout->fmt_render.i_sar_den,
 888              p_vout->fmt_render.i_rmask, p_vout->fmt_render.i_gmask, p_vout->fmt_render.i_bmask );
 889
 890     msg_Dbg( p_vout, "pic in sz %ix%i, of (%i,%i), vsz %ix%i, 4cc %4.4s, ar %i:%i, sar %i:%i, msk r0x%x g0x%x b0x%x",
 891              p_vout->fmt_in.i_width, p_vout->fmt_in.i_height,
 892              p_vout->fmt_in.i_x_offset, p_vout->fmt_in.i_y_offset,
 893              p_vout->fmt_in.i_visible_width,
 894              p_vout->fmt_in.i_visible_height,
 895              (char*)&p_vout->fmt_in.i_chroma,
 896              i_aspect_x, i_aspect_y,
 897              p_vout->fmt_in.i_sar_num, p_vout->fmt_in.i_sar_den,
 898              p_vout->fmt_in.i_rmask, p_vout->fmt_in.i_gmask, p_vout->fmt_in.i_bmask );
 899
 900     msg_Dbg( p_vout, "pic out sz %ix%i, of (%i,%i), vsz %ix%i, 4cc %4.4s, ar %i:%i, sar %i:%i, msk r0x%x g0x%x b0x%x",
 901              p_vout->fmt_out.i_width, p_vout->fmt_out.i_height,
 902              p_vout->fmt_out.i_x_offset, p_vout->fmt_out.i_y_offset,
 903              p_vout->fmt_out.i_visible_width,
 904              p_vout->fmt_out.i_visible_height,
 905              (char*)&p_vout->fmt_out.i_chroma,
 906              i_aspect_x, i_aspect_y,
 907              p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den,
 908              p_vout->fmt_out.i_rmask, p_vout->fmt_out.i_gmask, p_vout->fmt_out.i_bmask );
 909
 910     /* Check whether we managed to create direct buffers similar to
 911      * the render buffers, ie same size and chroma */
 912     if( ( p_vout->output.i_width == p_vout->render.i_width )
 913      && ( p_vout->output.i_height == p_vout->render.i_height )
 914      && ( ChromaIsEqual( &p_vout->output, &p_vout->render ) ) )
 915     {
 916         /* Cool ! We have direct buffers, we can ask the decoder to
 917          * directly decode into them ! Map the first render buffers to
 918          * the first direct buffers, but keep the first direct buffer
 919          * for memcpy operations */
 920         p_vout->p->b_direct = true;
 921
 922         for( i = 1; i < VOUT_MAX_PICTURES; i++ )
 923         {
 924             if( p_vout->p_picture[ i ].i_type != DIRECT_PICTURE &&
 925                 I_RENDERPICTURES >= VOUT_MIN_DIRECT_PICTURES - 1 &&
 926                 p_vout->p_picture[ i - 1 ].i_type == DIRECT_PICTURE )
 927             {
 928                 /* We have enough direct buffers so there's no need to
 929                  * try to use system memory buffers. */
 930                 break;
 931             }
 932             PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
 933             I_RENDERPICTURES++;
 934         }
 935
 936         msg_Dbg( p_vout, "direct render, mapping "
 937                  "render pictures 0-%i to system pictures 1-%i",
 938                  VOUT_MAX_PICTURES - 2, VOUT_MAX_PICTURES - 1 );
 939     }
 940     else
 941     {
 942         /* Rats... Something is wrong here, we could not find an output
 943          * plugin able to directly render what we decode. See if we can
 944          * find a chroma plugin to do the conversion */
 945         p_vout->p->b_direct = false;
 946
 947         if( ChromaCreate( p_vout ) )
 948         {
 949             p_vout->pf_end( p_vout );
 950             return VLC_EGENERIC;
 951         }
 952
 953         msg_Dbg( p_vout, "indirect render, mapping "
 954                  "render pictures 0-%i to system pictures %i-%i",
 955                  VOUT_MAX_PICTURES - 1, I_OUTPUTPICTURES,
 956                  I_OUTPUTPICTURES + VOUT_MAX_PICTURES - 1 );
 957
 958         /* Append render buffers after the direct buffers */
 959         for( i = I_OUTPUTPICTURES; i < 2 * VOUT_MAX_PICTURES; i++ )
 960         {
 961             PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
 962             I_RENDERPICTURES++;
 963
 964             /* Check if we have enough render pictures */
 965             if( I_RENDERPICTURES == VOUT_MAX_PICTURES )
 966                 break;
 967         }
 968     }
 969
 970     return VLC_SUCCESS;
 971 }
 972
 973 /*****************************************************************************
 974  * RunThread: video output thread
 975  *****************************************************************************
 976  * Video output thread. This function does only returns when the thread is
 977  * terminated. It handles the pictures arriving in the video heap and the
 978  * display device events.
 979  *****************************************************************************/
 980 static void* RunThread( void *p_this )
 981 {
 982     vout_thread_t *p_vout = p_this;
 983     int             i_idle_loops = 0;  /* loops without displaying a picture */
 984     int             i_picture_qtype_last = QTYPE_NONE;
 985
 986     bool            b_drop_late;
 987
 988     /*
 989      * Initialize thread
 990      */
 991     vlc_mutex_lock( &p_vout->change_lock );
 992     p_vout->b_error = InitThread( p_vout );
 993
 994     b_drop_late = var_CreateGetBool( p_vout, "drop-late-frames" );
 995
 996     /* signal the creation of the vout */
 997     p_vout->p->b_ready = true;
 998     vlc_cond_signal( &p_vout->p->change_wait );
 999
1000     if( p_vout->b_error )
1001     {
1002         EndThread( p_vout );
1003         vlc_mutex_unlock( &p_vout->change_lock );
1004         return NULL;
1005     }
1006
1007     /*
1008      * Main loop - it is not executed if an error occurred during
1009      * initialization
1010      */
1011     while( !p_vout->p->b_done && !p_vout->b_error )
1012     {
1013         /* Initialize loop variables */
1014         const mtime_t current_date = mdate();
1015         picture_t *p_picture;
1016         picture_t *p_filtered_picture;
1017         mtime_t display_date;
1018         picture_t *p_directbuffer;
1019         int i_index;
1020
1021         if( p_vout->p->b_title_show && p_vout->p->psz_title )
1022             DisplayTitleOnOSD( p_vout );
1023
1024         vlc_mutex_lock( &p_vout->picture_lock );
1025
1026         /* Look for the earliest picture but after the last displayed one */
1027         picture_t *p_last = p_vout->p->p_picture_displayed;;
1028
1029         p_picture = NULL;
1030         for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
1031         {
1032             picture_t *p_pic = PP_RENDERPICTURE[i_index];
1033
1034             if( p_pic->i_status != READY_PICTURE )
1035                 continue;
1036
1037             if( p_vout->p->b_paused && p_last && p_last->date > 1 )
1038                 continue;
1039
1040             if( p_last && p_pic != p_last && p_pic->date <= p_last->date )
1041             {
1042                 /* Drop old picture */
1043                 vout_UsePictureLocked( p_vout, p_pic );
1044             }
1045             else if( !p_vout->p->b_paused && !p_pic->b_force && p_pic != p_last &&
1046                      p_pic->date < current_date + p_vout->p->render_time &&
1047                      b_drop_late )
1048             {
1049                 /* Picture is late: it will be destroyed and the thread
1050                  * will directly choose the next picture */
1051                 vout_UsePictureLocked( p_vout, p_pic );
1052                 vout_statistic_Update( &p_vout->p->statistic, 0, 1 );
1053
1054                 msg_Warn( p_vout, "late picture skipped (%"PRId64" > %d)",
1055                                   current_date - p_pic->date, - p_vout->p->render_time );
1056             }
1057             else if( ( !p_last || p_last->date < p_pic->date ) &&
1058                      ( p_picture == NULL || p_pic->date < p_picture->date ) )
1059             {
1060                 p_picture = p_pic;
1061             }
1062         }
1063         if( !p_picture )
1064         {
1065             p_picture = p_last;
1066
1067             if( !p_vout->p->b_picture_empty )
1068             {
1069                 p_vout->p->b_picture_empty = true;
1070                 vlc_cond_signal( &p_vout->p->picture_wait );
1071             }
1072         }
1073
1074         display_date = 0;
1075         if( p_picture )
1076         {
1077             display_date = p_picture->date;
1078
1079             /* If we found better than the last picture, destroy it */
1080             if( p_last && p_picture != p_last )
1081             {
1082                 vout_UsePictureLocked( p_vout, p_last );
1083                 p_vout->p->p_picture_displayed = p_last = NULL;
1084             }
1085
1086             /* Compute FPS rate */
1087             p_vout->p->p_fps_sample[ p_vout->p->c_fps_samples++ % VOUT_FPS_SAMPLES ] = display_date;
1088
1089             if( !p_vout->p->b_paused && display_date > current_date + VOUT_DISPLAY_DELAY )
1090             {
1091                 /* A picture is ready to be rendered, but its rendering date
1092                  * is far from the current one so the thread will perform an
1093                  * empty loop as if no picture were found. The picture state
1094                  * is unchanged */
1095                 p_picture    = NULL;
1096                 display_date = 0;
1097             }
1098             else if( p_picture == p_last )
1099             {
1100                 /* We are asked to repeat the previous picture, but we first
1101                  * wait for a couple of idle loops */
1102                 if( i_idle_loops < 4 )
1103                 {
1104                     p_picture    = NULL;
1105                     display_date = 0;
1106                 }
1107                 else
1108                 {
1109                     /* We set the display date to something high, otherwise
1110                      * we'll have lots of problems with late pictures */
1111                     display_date = current_date + p_vout->p->render_time;
1112                 }
1113             }
1114             else if( p_vout->p->b_paused && display_date > current_date + VOUT_DISPLAY_DELAY )
1115             {
1116                 display_date = current_date + VOUT_DISPLAY_DELAY;
1117             }
1118
1119             if( p_picture )
1120             {
1121                 if( p_picture->date > 1 )
1122                 {
1123                     p_vout->p->i_picture_displayed_date = p_picture->date;
1124                     if( p_picture != p_last && !p_vout->p->b_picture_displayed )
1125                     {
1126                         p_vout->p->b_picture_displayed = true;
1127                         vlc_cond_signal( &p_vout->p->picture_wait );
1128                     }
1129                 }
1130                 p_vout->p->p_picture_displayed = p_picture;
1131             }
1132         }
1133
1134         /* */
1135         const int i_postproc_type = p_vout->p->i_picture_qtype;
1136         const int i_postproc_state = (p_vout->p->i_picture_qtype != QTYPE_NONE) - (i_picture_qtype_last != QTYPE_NONE);
1137
1138         vlc_mutex_unlock( &p_vout->picture_lock );
1139
1140         if( p_picture == NULL )
1141             i_idle_loops++;
1142
1143         p_filtered_picture = NULL;
1144         if( p_picture )
1145             p_filtered_picture = filter_chain_VideoFilter( p_vout->p->p_vf2_chain,
1146                                                            p_picture );
1147
1148         const bool b_snapshot = vout_snapshot_IsRequested( &p_vout->p->snapshot );
1149
1150         /*
1151          * Check for subpictures to display
1152          */
1153         mtime_t spu_render_time;
1154         if( p_vout->p->b_paused )
1155             spu_render_time = p_vout->p->i_pause_date;
1156         else if( p_picture )
1157             spu_render_time = p_picture->date > 1 ? p_picture->date : mdate();
1158         else
1159             spu_render_time = 0;
1160
1161         subpicture_t *p_subpic = spu_SortSubpictures( p_vout->p_spu,
1162                                                       spu_render_time,
1163                                                       b_snapshot );
1164         /*
1165          * Perform rendering
1166          */
1167         vout_statistic_Update( &p_vout->p->statistic, 1, 0 );
1168         p_directbuffer = vout_RenderPicture( p_vout,
1169                                              p_filtered_picture, p_subpic,
1170                                              spu_render_time );
1171
1172         /*
1173          * Take a snapshot if requested
1174          */
1175         if( p_directbuffer && b_snapshot )
1176             vout_snapshot_Set( &p_vout->p->snapshot,
1177                                &p_vout->fmt_out, p_directbuffer );
1178
1179         /*
1180          * Call the plugin-specific rendering method if there is one
1181          */
1182         if( p_filtered_picture != NULL && p_directbuffer != NULL && p_vout->pf_render )
1183         {
1184             /* Render the direct buffer returned by vout_RenderPicture */
1185             p_vout->pf_render( p_vout, p_directbuffer );
1186         }
1187
1188         /*
1189          * Sleep, wake up
1190          */
1191         if( display_date != 0 && p_directbuffer != NULL )
1192         {
1193             mtime_t current_render_time = mdate() - current_date;
1194             /* if render time is very large we don't include it in the mean */
1195             if( current_render_time < p_vout->p->render_time +
1196                 VOUT_DISPLAY_DELAY )
1197             {
1198                 /* Store render time using a sliding mean weighting to
1199                  * current value in a 3 to 1 ratio*/
1200                 p_vout->p->render_time *= 3;
1201                 p_vout->p->render_time += current_render_time;
1202                 p_vout->p->render_time >>= 2;
1203             }
1204             else
1205                 msg_Dbg( p_vout, "skipped big render time %d > %d", (int) current_render_time,
1206                  (int) (p_vout->p->render_time +VOUT_DISPLAY_DELAY ) ) ;
1207         }
1208
1209         /* Give back change lock */
1210         vlc_mutex_unlock( &p_vout->change_lock );
1211
1212         /* Sleep a while or until a given date */
1213         if( display_date != 0 )
1214         {
1215             /* If there are *vout* filters in the chain, better give them the picture
1216              * in advance */
1217             if( !p_vout->p->psz_filter_chain || !*p_vout->p->psz_filter_chain )
1218             {
1219                 mwait( display_date - VOUT_MWAIT_TOLERANCE );
1220             }
1221         }
1222         else
1223         {
1224             /* Wait until a frame is being sent or a spurious wakeup (not a problem here) */
1225             vlc_mutex_lock( &p_vout->picture_lock );
1226             vlc_cond_timedwait( &p_vout->p->picture_wait, &p_vout->picture_lock, current_date + VOUT_IDLE_SLEEP );
1227             vlc_mutex_unlock( &p_vout->picture_lock );
1228         }
1229
1230         /* On awakening, take back lock and send immediately picture
1231          * to display. */
1232         /* Note: p_vout->p->b_done could be true here and now */
1233         vlc_mutex_lock( &p_vout->change_lock );
1234
1235         /*
1236          * Display the previously rendered picture
1237          */
1238         if( p_filtered_picture != NULL && p_directbuffer != NULL )
1239         {
1240             /* Display the direct buffer returned by vout_RenderPicture */
1241             if( p_vout->pf_display )
1242                 p_vout->pf_display( p_vout, p_directbuffer );
1243
1244             /* Tell the vout this was the last picture and that it does not
1245              * need to be forced anymore. */
1246             p_picture->b_force = false;
1247         }
1248
1249         /* Drop the filtered picture if created by video filters */
1250         if( p_filtered_picture != NULL && p_filtered_picture != p_picture )
1251         {
1252             vlc_mutex_lock( &p_vout->picture_lock );
1253             vout_UsePictureLocked( p_vout, p_filtered_picture );
1254             vlc_mutex_unlock( &p_vout->picture_lock );
1255         }
1256
1257         if( p_picture != NULL )
1258         {
1259             /* Reinitialize idle loop count */
1260             i_idle_loops = 0;
1261         }
1262
1263         /*
1264          * Check events and manage thread
1265          */
1266         if( p_vout->pf_manage && p_vout->pf_manage( p_vout ) )
1267         {
1268             /* A fatal error occurred, and the thread must terminate
1269              * immediately, without displaying anything - setting b_error to 1
1270              * causes the immediate end of the main while() loop. */
1271             // FIXME pf_end
1272             p_vout->b_error = 1;
1273             break;
1274         }
1275
1276         while( p_vout->i_changes & VOUT_ON_TOP_CHANGE )
1277         {
1278             p_vout->i_changes &= ~VOUT_ON_TOP_CHANGE;
1279             vlc_mutex_unlock( &p_vout->change_lock );
1280             vout_Control( p_vout, VOUT_SET_STAY_ON_TOP, p_vout->b_on_top );
1281             vlc_mutex_lock( &p_vout->change_lock );
1282         }
1283
1284         if( p_vout->i_changes & VOUT_SIZE_CHANGE )
1285         {
1286             /* this must only happen when the vout plugin is incapable of
1287              * rescaling the picture itself. In this case we need to destroy
1288              * the current picture buffers and recreate new ones with the right
1289              * dimensions */
1290             int i;
1291
1292             p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
1293
1294             assert( !p_vout->p->b_direct );
1295
1296             ChromaDestroy( p_vout );
1297
1298             vlc_mutex_lock( &p_vout->picture_lock );
1299
1300             p_vout->pf_end( p_vout );
1301
1302             p_vout->p->p_picture_displayed = NULL;
1303             for( i = 0; i < I_OUTPUTPICTURES; i++ )
1304                  p_vout->p_picture[ i ].i_status = FREE_PICTURE;
1305             vlc_cond_signal( &p_vout->p->picture_wait );
1306
1307             I_OUTPUTPICTURES = 0;
1308
1309             if( p_vout->pf_init( p_vout ) )
1310             {
1311                 msg_Err( p_vout, "cannot resize display" );
1312                 /* FIXME: pf_end will be called again in EndThread() */
1313                 p_vout->b_error = 1;
1314             }
1315
1316             vlc_mutex_unlock( &p_vout->picture_lock );
1317
1318             /* Need to reinitialise the chroma plugin. Since we might need
1319              * resizing too and it's not sure that we already had it,
1320              * recreate the chroma plugin chain from scratch. */
1321             /* dionoea */
1322             if( ChromaCreate( p_vout ) )
1323             {
1324                 msg_Err( p_vout, "WOW THIS SUCKS BIG TIME!!!!!" );
1325                 p_vout->b_error = 1;
1326             }
1327             if( p_vout->b_error )
1328                 break;
1329         }
1330
1331         if( p_vout->i_changes & VOUT_PICTURE_BUFFERS_CHANGE )
1332         {
1333             /* This happens when the picture buffers need to be recreated.
1334              * This is useful on multimonitor displays for instance.
1335              *
1336              * Warning: This only works when the vout creates only 1 picture
1337              * buffer!! */
1338             p_vout->i_changes &= ~VOUT_PICTURE_BUFFERS_CHANGE;
1339
1340             if( !p_vout->p->b_direct )
1341                 ChromaDestroy( p_vout );
1342
1343             vlc_mutex_lock( &p_vout->picture_lock );
1344
1345             p_vout->pf_end( p_vout );
1346
1347             I_OUTPUTPICTURES = I_RENDERPICTURES = 0;
1348
1349             p_vout->b_error = InitThread( p_vout );
1350             if( p_vout->b_error )
1351                 msg_Err( p_vout, "InitThread after VOUT_PICTURE_BUFFERS_CHANGE failed" );
1352
1353             vlc_cond_signal( &p_vout->p->picture_wait );
1354             vlc_mutex_unlock( &p_vout->picture_lock );
1355
1356             if( p_vout->b_error )
1357                 break;
1358         }
1359
1360         /* Post processing */
1361         if( i_postproc_state == 1 )
1362             PostProcessEnable( p_vout );
1363         else if( i_postproc_state == -1 )
1364             PostProcessDisable( p_vout );
1365         if( i_postproc_state != 0 )
1366             i_picture_qtype_last = i_postproc_type;
1367
1368         /* Check for "video filter2" changes */
1369         vlc_mutex_lock( &p_vout->p->vfilter_lock );
1370         if( p_vout->p->psz_vf2 )
1371         {
1372             es_format_t fmt;
1373
1374             es_format_Init( &fmt, VIDEO_ES, p_vout->fmt_render.i_chroma );
1375             fmt.video = p_vout->fmt_render;
1376             filter_chain_Reset( p_vout->p->p_vf2_chain, &fmt, &fmt );
1377
1378             if( filter_chain_AppendFromString( p_vout->p->p_vf2_chain,
1379                                                p_vout->p->psz_vf2 ) < 0 )
1380                 msg_Err( p_vout, "Video filter chain creation failed" );
1381
1382             free( p_vout->p->psz_vf2 );
1383             p_vout->p->psz_vf2 = NULL;
1384
1385             if( i_picture_qtype_last != QTYPE_NONE )
1386                 PostProcessSetFilterQuality( p_vout );
1387         }
1388         vlc_mutex_unlock( &p_vout->p->vfilter_lock );
1389     }
1390
1391     /*
1392      * Error loop - wait until the thread destruction is requested
1393      */
1394     if( p_vout->b_error )
1395         ErrorThread( p_vout );
1396
1397     /* End of thread */
1398     CleanThread( p_vout );
1399     EndThread( p_vout );
1400     vlc_mutex_unlock( &p_vout->change_lock );
1401
1402     return NULL;
1403 }
1404
1405 /*****************************************************************************
1406  * ErrorThread: RunThread() error loop
1407  *****************************************************************************
1408  * This function is called when an error occurred during thread main's loop.
1409  * The thread can still receive feed, but must be ready to terminate as soon
1410  * as possible.
1411  *****************************************************************************/
1412 static void ErrorThread( vout_thread_t *p_vout )
1413 {
1414     /* Wait until a `close' order */
1415     while( !p_vout->p->b_done )
1416         vlc_cond_wait( &p_vout->p->change_wait, &p_vout->change_lock );
1417 }
1418
1419 /*****************************************************************************
1420  * CleanThread: clean up after InitThread
1421  *****************************************************************************
1422  * This function is called after a sucessful
1423  * initialization. It frees all resources allocated by InitThread.
1424  * XXX You have to enter it with change_lock taken.
1425  *****************************************************************************/
1426 static void CleanThread( vout_thread_t *p_vout )
1427 {
1428     int     i_index;                                        /* index in heap */
1429
1430     if( !p_vout->p->b_direct )
1431         ChromaDestroy( p_vout );
1432
1433     /* Destroy all remaining pictures */
1434     for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++ )
1435     {
1436         if ( p_vout->p_picture[i_index].i_type == MEMORY_PICTURE )
1437         {
1438             free( p_vout->p_picture[i_index].p_data_orig );
1439         }
1440     }
1441
1442     /* Destroy translation tables */
1443     if( !p_vout->b_error )
1444         p_vout->pf_end( p_vout );
1445 }
1446
1447 /*****************************************************************************
1448  * EndThread: thread destruction
1449  *****************************************************************************
1450  * This function is called when the thread ends.
1451  * It frees all resources not allocated by InitThread.
1452  * XXX You have to enter it with change_lock taken.
1453  *****************************************************************************/
1454 static void EndThread( vout_thread_t *p_vout )
1455 {
1456 #ifdef STATS
1457     {
1458         struct tms cpu_usage;
1459         times( &cpu_usage );
1460
1461         msg_Dbg( p_vout, "cpu usage (user: %d, system: %d)",
1462                  cpu_usage.tms_utime, cpu_usage.tms_stime );
1463     }
1464 #endif
1465
1466     /* FIXME does that function *really* need to be called inside the thread ? */
1467
1468     /* Detach subpicture unit from both input and vout */
1469     spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), false );
1470     vlc_object_detach( p_vout->p_spu );
1471
1472     /* Destroy the video filters2 */
1473     filter_chain_Delete( p_vout->p->p_vf2_chain );
1474 }
1475
1476 /* Thread helpers */
1477 static picture_t *ChromaGetPicture( filter_t *p_filter )
1478 {
1479     picture_t *p_pic = (picture_t *)p_filter->p_owner;
1480     p_filter->p_owner = NULL;
1481     return p_pic;
1482 }
1483
1484 static int ChromaCreate( vout_thread_t *p_vout )
1485 {
1486     static const char typename[] = "chroma";
1487     filter_t *p_chroma;
1488
1489     /* Choose the best module */
1490     p_chroma = p_vout->p->p_chroma =
1491         vlc_custom_create( p_vout, sizeof(filter_t), VLC_OBJECT_GENERIC,
1492                            typename );
1493
1494     vlc_object_attach( p_chroma, p_vout );
1495
1496     /* TODO: Set the fmt_in and fmt_out stuff here */
1497     p_chroma->fmt_in.video = p_vout->fmt_render;
1498     p_chroma->fmt_out.video = p_vout->fmt_out;
1499     VideoFormatImportRgb( &p_chroma->fmt_in.video, &p_vout->render );
1500     VideoFormatImportRgb( &p_chroma->fmt_out.video, &p_vout->output );
1501
1502     p_chroma->p_module = module_need( p_chroma, "video filter2", NULL, false );
1503
1504     if( p_chroma->p_module == NULL )
1505     {
1506         msg_Err( p_vout, "no chroma module for %4.4s to %4.4s i=%dx%d o=%dx%d",
1507                  (char*)&p_vout->render.i_chroma,
1508                  (char*)&p_vout->output.i_chroma,
1509                  p_chroma->fmt_in.video.i_width, p_chroma->fmt_in.video.i_height,
1510                  p_chroma->fmt_out.video.i_width, p_chroma->fmt_out.video.i_height
1511                  );
1512
1513         vlc_object_release( p_vout->p->p_chroma );
1514         p_vout->p->p_chroma = NULL;
1515
1516         return VLC_EGENERIC;
1517     }
1518     p_chroma->pf_vout_buffer_new = ChromaGetPicture;
1519     return VLC_SUCCESS;
1520 }
1521
1522 static void ChromaDestroy( vout_thread_t *p_vout )
1523 {
1524     assert( !p_vout->p->b_direct );
1525
1526     if( !p_vout->p->p_chroma )
1527         return;
1528
1529     module_unneed( p_vout->p->p_chroma, p_vout->p->p_chroma->p_module );
1530     vlc_object_release( p_vout->p->p_chroma );
1531     p_vout->p->p_chroma = NULL;
1532 }
1533
1534 /* following functions are local */
1535 static void AspectRatio( int i_aspect, int *i_aspect_x, int *i_aspect_y )
1536 {
1537     const int i_pgcd = i_aspect ? GCD( i_aspect, VOUT_ASPECT_FACTOR ) : 1;
1538     *i_aspect_x = i_aspect / i_pgcd;
1539     *i_aspect_y = VOUT_ASPECT_FACTOR / i_pgcd;
1540 }
1541
1542 /**
1543  * This function copies all RGB informations from a picture_heap_t into
1544  * a video_format_t
1545  */
1546 static void VideoFormatImportRgb( video_format_t *p_fmt, const picture_heap_t *p_heap )
1547 {
1548     p_fmt->i_rmask = p_heap->i_rmask;
1549     p_fmt->i_gmask = p_heap->i_gmask;
1550     p_fmt->i_bmask = p_heap->i_bmask;
1551     p_fmt->i_rrshift = p_heap->i_rrshift;
1552     p_fmt->i_lrshift = p_heap->i_lrshift;
1553     p_fmt->i_rgshift = p_heap->i_rgshift;
1554     p_fmt->i_lgshift = p_heap->i_lgshift;
1555     p_fmt->i_rbshift = p_heap->i_rbshift;
1556     p_fmt->i_lbshift = p_heap->i_lbshift;
1557 }
1558
1559 /**
1560  * This funtion copes all RGB informations from a video_format_t into
1561  * a picture_heap_t
1562  */
1563 static void VideoFormatExportRgb( const video_format_t *p_fmt, picture_heap_t *p_heap )
1564 {
1565     p_heap->i_rmask = p_fmt->i_rmask;
1566     p_heap->i_gmask = p_fmt->i_gmask;
1567     p_heap->i_bmask = p_fmt->i_bmask;
1568     p_heap->i_rrshift = p_fmt->i_rrshift;
1569     p_heap->i_lrshift = p_fmt->i_lrshift;
1570     p_heap->i_rgshift = p_fmt->i_rgshift;
1571     p_heap->i_lgshift = p_fmt->i_lgshift;
1572     p_heap->i_rbshift = p_fmt->i_rbshift;
1573     p_heap->i_lbshift = p_fmt->i_lbshift;
1574 }
1575
1576 /**
1577  * This function computes rgb shifts from masks
1578  */
1579 static void PictureHeapFixRgb( picture_heap_t *p_heap )
1580 {
1581     video_format_t fmt;
1582
1583     /* */
1584     fmt.i_chroma = p_heap->i_chroma;
1585     VideoFormatImportRgb( &fmt, p_heap );
1586
1587     /* */
1588     video_format_FixRgb( &fmt );
1589
1590     VideoFormatExportRgb( &fmt, p_heap );
1591 }
1592
1593 /*****************************************************************************
1594  * object variables callbacks: a bunch of object variables are used by the
1595  * interfaces to interact with the vout.
1596  *****************************************************************************/
1597 static int FilterCallback( vlc_object_t *p_this, char const *psz_cmd,
1598                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
1599 {
1600     vout_thread_t *p_vout = (vout_thread_t *)p_this;
1601     input_thread_t *p_input;
1602     (void)psz_cmd; (void)oldval; (void)p_data;
1603
1604     p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1605                                                  FIND_PARENT );
1606     if (!p_input)
1607     {
1608         msg_Err( p_vout, "Input not found" );
1609         return VLC_EGENERIC;
1610     }
1611
1612     var_SetBool( p_vout, "intf-change", true );
1613
1614     /* Modify input as well because the vout might have to be restarted */
1615     var_Create( p_input, "vout-filter", VLC_VAR_STRING );
1616     var_SetString( p_input, "vout-filter", newval.psz_string );
1617
1618     /* Now restart current video stream */
1619     input_Control( p_input, INPUT_RESTART_ES, -VIDEO_ES );
1620     vlc_object_release( p_input );
1621
1622     return VLC_SUCCESS;
1623 }
1624
1625 /*****************************************************************************
1626  * Video Filter2 stuff
1627  *****************************************************************************/
1628 static int VideoFilter2Callback( vlc_object_t *p_this, char const *psz_cmd,
1629                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
1630 {
1631     vout_thread_t *p_vout = (vout_thread_t *)p_this;
1632     (void)psz_cmd; (void)oldval; (void)p_data;
1633
1634     vlc_mutex_lock( &p_vout->p->vfilter_lock );
1635     p_vout->p->psz_vf2 = strdup( newval.psz_string );
1636     vlc_mutex_unlock( &p_vout->p->vfilter_lock );
1637
1638     return VLC_SUCCESS;
1639 }
1640
1641 /*****************************************************************************
1642  * Post-processing
1643  *****************************************************************************/
1644 static bool PostProcessIsPresent( const char *psz_filter )
1645 {
1646     const char  *psz_pp = "postproc";
1647     const size_t i_pp = strlen(psz_pp);
1648     return psz_filter &&
1649            !strncmp( psz_filter, psz_pp, strlen(psz_pp) ) &&
1650            ( psz_filter[i_pp] == '\0' || psz_filter[i_pp] == ':' );
1651 }
1652
1653 static int PostProcessCallback( vlc_object_t *p_this, char const *psz_cmd,
1654                                 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1655 {
1656     vout_thread_t *p_vout = (vout_thread_t *)p_this;
1657     VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval); VLC_UNUSED(p_data);
1658
1659     static const char *psz_pp = "postproc";
1660
1661     char *psz_vf2 = var_GetString( p_vout, "video-filter" );
1662
1663     if( newval.i_int <= 0 )
1664     {
1665         if( PostProcessIsPresent( psz_vf2 ) )
1666         {
1667             strcpy( psz_vf2, &psz_vf2[strlen(psz_pp)] );
1668             if( *psz_vf2 == ':' )
1669                 strcpy( psz_vf2, &psz_vf2[1] );
1670         }
1671     }
1672     else
1673     {
1674         if( !PostProcessIsPresent( psz_vf2 ) )
1675         {
1676             if( psz_vf2 )
1677             {
1678                 char *psz_tmp = psz_vf2;
1679                 if( asprintf( &psz_vf2, "%s:%s", psz_pp, psz_tmp ) < 0 )
1680                     psz_vf2 = psz_tmp;
1681                 else
1682                     free( psz_tmp );
1683             }
1684             else
1685             {
1686                 psz_vf2 = strdup( psz_pp );
1687             }
1688         }
1689     }
1690     if( psz_vf2 )
1691     {
1692         var_SetString( p_vout, "video-filter", psz_vf2 );
1693         free( psz_vf2 );
1694     }
1695
1696     return VLC_SUCCESS;
1697 }
1698 static void PostProcessEnable( vout_thread_t *p_vout )
1699 {
1700     vlc_value_t text;
1701     msg_Dbg( p_vout, "Post-processing available" );
1702     var_Create( p_vout, "postprocess", VLC_VAR_INTEGER | VLC_VAR_HASCHOICE );
1703     text.psz_string = _("Post processing");
1704     var_Change( p_vout, "postprocess", VLC_VAR_SETTEXT, &text, NULL );
1705
1706     for( int i = 0; i <= 6; i++ )
1707     {
1708         vlc_value_t val;
1709         vlc_value_t text;
1710         char psz_text[1+1];
1711
1712         val.i_int = i;
1713         snprintf( psz_text, sizeof(psz_text), "%d", i );
1714         if( i == 0 )
1715             text.psz_string = _("Disable");
1716         else
1717             text.psz_string = psz_text;
1718         var_Change( p_vout, "postprocess", VLC_VAR_ADDCHOICE, &val, &text );
1719     }
1720     var_AddCallback( p_vout, "postprocess", PostProcessCallback, NULL );
1721
1722     /* */
1723     char *psz_filter = var_GetNonEmptyString( p_vout, "video-filter" );
1724     int i_postproc_q = 0;
1725     if( PostProcessIsPresent( psz_filter ) )
1726         i_postproc_q = var_CreateGetInteger( p_vout, "postproc-q" );
1727
1728     var_SetInteger( p_vout, "postprocess", i_postproc_q );
1729
1730     free( psz_filter );
1731 }
1732 static void PostProcessDisable( vout_thread_t *p_vout )
1733 {
1734     msg_Dbg( p_vout, "Post-processing no more available" );
1735     var_Destroy( p_vout, "postprocess" );
1736 }
1737 static void PostProcessSetFilterQuality( vout_thread_t *p_vout )
1738 {
1739     vlc_object_t *p_pp = vlc_object_find_name( p_vout, "postproc", FIND_CHILD );
1740     if( !p_pp )
1741         return;
1742
1743     var_SetInteger( p_pp, "postproc-q", var_GetInteger( p_vout, "postprocess" ) );
1744     vlc_object_release( p_pp );
1745 }
1746
1747
1748 static void DisplayTitleOnOSD( vout_thread_t *p_vout )
1749 {
1750     const mtime_t i_start = mdate();
1751     const mtime_t i_stop = i_start + INT64_C(1000) * p_vout->p->i_title_timeout;
1752
1753     if( i_stop <= i_start )
1754         return;
1755
1756     vlc_assert_locked( &p_vout->change_lock );
1757
1758     vout_ShowTextAbsolute( p_vout, DEFAULT_CHAN,
1759                            p_vout->p->psz_title, NULL,
1760                            p_vout->p->i_title_position,
1761                            30 + p_vout->fmt_in.i_width
1762                               - p_vout->fmt_in.i_visible_width
1763                               - p_vout->fmt_in.i_x_offset,
1764                            20 + p_vout->fmt_in.i_y_offset,
1765                            i_start, i_stop );
1766
1767     free( p_vout->p->psz_title );
1768
1769     p_vout->p->psz_title = NULL;
1770 }
1771
1772 /*****************************************************************************
1773  * Deinterlacing
1774  *****************************************************************************/
1775 typedef struct
1776 {
1777     const char *psz_mode;
1778     const char *psz_description;
1779     bool       b_vout_filter;
1780 } deinterlace_mode_t;
1781
1782 /* XXX
1783  * You can use the non vout filter if and only if the video properties stay the
1784  * same (width/height/chroma/fps), at least for now.
1785  */
1786 static const deinterlace_mode_t p_deinterlace_mode[] = {
1787     { "",           "Disable",  false },
1788     { "discard",    "Discard",  true },
1789     { "blend",      "Blend",    false },
1790     { "mean",       "Mean",     true  },
1791     { "bob",        "Bob",      true },
1792     { "linear",     "Linear",   true },
1793     { "x",          "X",        false },
1794     { NULL, NULL, true }
1795 };
1796
1797 static char *FilterFind( char *psz_filter_base, const char *psz_module )
1798 {
1799     const size_t i_module = strlen( psz_module );
1800     const char *psz_filter = psz_filter_base;
1801
1802     if( !psz_filter || i_module <= 0 )
1803         return NULL;
1804
1805     for( ;; )
1806     {
1807         char *psz_find = strstr( psz_filter, psz_module );
1808         if( !psz_find )
1809             return NULL;
1810         if( psz_find[i_module] == '\0' || psz_find[i_module] == ':' )
1811             return psz_find;
1812         psz_filter = &psz_find[i_module];
1813     }
1814 }
1815
1816 static bool DeinterlaceIsPresent( vout_thread_t *p_vout, bool b_vout_filter )
1817 {
1818     char *psz_filter = var_GetNonEmptyString( p_vout, b_vout_filter ? "vout-filter" : "video-filter" );
1819
1820     bool b_found = FilterFind( psz_filter, "deinterlace" ) != NULL;
1821
1822     free( psz_filter );
1823
1824     return b_found;
1825 }
1826
1827 static void DeinterlaceRemove( vout_thread_t *p_vout, bool b_vout_filter )
1828 {
1829     const char *psz_variable = b_vout_filter ? "vout-filter" : "video-filter";
1830     char *psz_filter = var_GetNonEmptyString( p_vout, psz_variable );
1831
1832     char *psz = FilterFind( psz_filter, "deinterlace" );
1833     if( !psz )
1834     {
1835         free( psz_filter );
1836         return;
1837     }
1838
1839     /* */
1840     strcpy( &psz[0], &psz[strlen("deinterlace")] );
1841     if( *psz == ':' )
1842         strcpy( &psz[0], &psz[1] );
1843
1844     var_SetString( p_vout, psz_variable, psz_filter );
1845     free( psz_filter );
1846 }
1847 static void DeinterlaceAdd( vout_thread_t *p_vout, bool b_vout_filter )
1848 {
1849     const char *psz_variable = b_vout_filter ? "vout-filter" : "video-filter";
1850
1851     char *psz_filter = var_GetNonEmptyString( p_vout, psz_variable );
1852
1853     if( FilterFind( psz_filter, "deinterlace" ) )
1854     {
1855         free( psz_filter );
1856         return;
1857     }
1858
1859     /* */
1860     if( psz_filter )
1861     {
1862         char *psz_tmp = psz_filter;
1863         if( asprintf( &psz_filter, "%s:%s", psz_tmp, "deinterlace" ) < 0 )
1864             psz_filter = psz_tmp;
1865         else
1866             free( psz_tmp );
1867     }
1868     else
1869     {
1870         psz_filter = strdup( "deinterlace" );
1871     }
1872
1873     if( psz_filter )
1874     {
1875         var_SetString( p_vout, psz_variable, psz_filter );
1876         free( psz_filter );
1877     }
1878 }
1879
1880 static int DeinterlaceCallback( vlc_object_t *p_this, char const *psz_cmd,
1881                                 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1882 {
1883     vout_thread_t *p_vout = (vout_thread_t *)p_this;
1884
1885     /* */
1886     const deinterlace_mode_t *p_mode;
1887     for( p_mode = &p_deinterlace_mode[0]; p_mode->psz_mode; p_mode++ )
1888     {
1889         if( !strcmp( p_mode->psz_mode,
1890                      newval.psz_string ? newval.psz_string : "" ) )
1891             break;
1892     }
1893     if( !p_mode->psz_mode )
1894     {
1895         msg_Err( p_this, "Invalid value (%s) ignored", newval.psz_string );
1896         return VLC_EGENERIC;
1897     }
1898
1899     /* We have to set input variable to ensure restart support
1900      * XXX it is only needed because of vout-filter but must be done
1901      * for non video filter anyway */
1902     input_thread_t *p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
1903     if( p_input )
1904     {
1905         var_Create( p_input, "vout-deinterlace", VLC_VAR_STRING );
1906         var_SetString( p_input, "vout-deinterlace", p_mode->psz_mode );
1907
1908         var_Create( p_input, "deinterlace-mode", VLC_VAR_STRING );
1909         var_SetString( p_input, "deinterlace-mode", p_mode->psz_mode );
1910
1911         var_Create( p_input, "sout-deinterlace-mode", VLC_VAR_STRING );
1912         var_SetString( p_input, "sout-deinterlace-mode", p_mode->psz_mode );
1913
1914         vlc_object_release( p_input );
1915     }
1916
1917     char *psz_old;
1918
1919     if( p_mode->b_vout_filter )
1920     {
1921         psz_old = var_CreateGetString( p_vout, "deinterlace-mode" );
1922     }
1923     else
1924     {
1925         psz_old = var_CreateGetString( p_vout, "sout-deinterlace-mode" );
1926         var_SetString( p_vout, "sout-deinterlace-mode", p_mode->psz_mode );
1927     }
1928
1929     /* */
1930     if( !strcmp( p_mode->psz_mode, "" ) )
1931     {
1932         DeinterlaceRemove( p_vout, false );
1933         DeinterlaceRemove( p_vout, true );
1934     }
1935     else if( !DeinterlaceIsPresent( p_vout, p_mode->b_vout_filter ) )
1936     {
1937         DeinterlaceRemove( p_vout, !p_mode->b_vout_filter );
1938         DeinterlaceAdd( p_vout, p_mode->b_vout_filter );
1939     }
1940     else
1941     {
1942         DeinterlaceRemove( p_vout, !p_mode->b_vout_filter );
1943         if( psz_old && strcmp( psz_old, p_mode->psz_mode ) )
1944             var_TriggerCallback( p_vout, p_mode->b_vout_filter ? "vout-filter" : "video-filter" );
1945     }
1946     free( psz_old );
1947
1948     (void)psz_cmd; (void) oldval; (void) p_data;
1949     return VLC_SUCCESS;
1950 }
1951
1952 static void DeinterlaceEnable( vout_thread_t *p_vout )
1953 {
1954     vlc_value_t val, text;
1955
1956     if( !p_vout->p->b_first_vout )
1957         return;
1958
1959     msg_Dbg( p_vout, "Deinterlacing available" );
1960
1961     /* Create the configuration variable */
1962     var_Create( p_vout, "deinterlace", VLC_VAR_STRING | VLC_VAR_HASCHOICE );
1963     text.psz_string = _("Deinterlace");
1964     var_Change( p_vout, "deinterlace", VLC_VAR_SETTEXT, &text, NULL );
1965
1966     for( int i = 0; p_deinterlace_mode[i].psz_mode; i++ )
1967     {
1968         val.psz_string  = (char*)p_deinterlace_mode[i].psz_mode;
1969         text.psz_string = (char*)vlc_gettext(p_deinterlace_mode[i].psz_description);
1970         var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
1971     }
1972     var_AddCallback( p_vout, "deinterlace", DeinterlaceCallback, NULL );
1973
1974     /* */
1975     char *psz_mode = NULL;
1976     if( var_Type( p_vout, "vout-deinterlace" ) != 0 )
1977         psz_mode = var_CreateGetNonEmptyString( p_vout, "vout-deinterlace" );
1978     if( !psz_mode )
1979     {
1980         /* Get the initial value */
1981         if( DeinterlaceIsPresent( p_vout, true ) )
1982             psz_mode = var_CreateGetNonEmptyString( p_vout, "deinterlace-mode" );
1983         else if( DeinterlaceIsPresent( p_vout, false ) )
1984             psz_mode = var_CreateGetNonEmptyString( p_vout, "sout-deinterlace-mode" );
1985     }
1986     var_SetString( p_vout, "deinterlace", psz_mode ? psz_mode : "" );
1987     free( psz_mode );
1988 }
1989