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