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