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