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