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