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