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

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