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