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