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