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