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