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