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

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