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