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

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