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