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