git.sesse.net Git - vlc/blob - src/video_output/video_output.c

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