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