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