6b36c9af019cd7a4faaa106d97db862087958e13
[vlc.git] / src / video_output / video_output.c
1 /*****************************************************************************
2  * video_output.c : video output thread
3  * This module describes the programming interface for video output threads.
4  * It includes functions allowing to open a new thread, send pictures to a
5  * thread, and destroy a previously oppened video output thread.
6  *****************************************************************************
7  * Copyright (C) 2000-2001 VideoLAN
8  * $Id: video_output.c,v 1.208 2003/01/28 12:30:44 gbazin Exp $
9  *
10  * Authors: Vincent Seguin <seguin@via.ecp.fr>
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
25  *****************************************************************************/
26
27 /*****************************************************************************
28  * Preamble
29  *****************************************************************************/
30 #include <stdlib.h>                                                /* free() */
31
32 #include <vlc/vlc.h>
33
34 #ifdef HAVE_SYS_TIMES_H
35 #   include <sys/times.h>
36 #endif
37
38 #include "video.h"
39 #include "video_output.h"
40
41 #if defined( SYS_DARWIN )
42 #include "darwin_specific.h"
43 #endif
44
45 /*****************************************************************************
46  * Local prototypes
47  *****************************************************************************/
48 static int      InitThread        ( vout_thread_t * );
49 static void     RunThread         ( vout_thread_t * );
50 static void     ErrorThread       ( vout_thread_t * );
51 static void     EndThread         ( vout_thread_t * );
52 static void     DestroyThread     ( vout_thread_t * );
53
54 static int      ReduceHeight      ( int );
55 static int      BinaryLog         ( uint32_t );
56 static void     MaskToShift       ( int *, int *, uint32_t );
57 static void     InitWindowSize    ( vout_thread_t *, int *, int * );
58
59 /*****************************************************************************
60  * vout_Request: find a video output thread, create one, or destroy one.
61  *****************************************************************************
62  * This function looks for a video output thread matching the current
63  * properties. If not found, it spawns a new one.
64  *****************************************************************************/
65 vout_thread_t * __vout_Request ( vlc_object_t *p_this, vout_thread_t *p_vout,
66                                  unsigned int i_width, unsigned int i_height,
67                                  vlc_fourcc_t i_chroma, unsigned int i_aspect )
68 {
69     if( !i_width || !i_height || !i_chroma )
70     {
71         /* Reattach video output to p_vlc before bailing out */
72         if( p_vout )
73         {
74             char *psz_sout = config_GetPsz( p_this, "sout" );
75
76             if( !psz_sout || !*psz_sout )
77             {
78                 vlc_object_detach( p_vout );
79                 vlc_object_attach( p_vout, p_this->p_vlc );
80             }
81             else
82             {
83                 vlc_object_detach( p_vout );
84                 vlc_object_release( p_vout );
85                 vout_Destroy( p_vout );
86             }
87             if( psz_sout ) free( psz_sout );
88         }
89
90         return NULL;
91     }
92
93     /* If a video output was provided, lock it, otherwise look for one. */
94     if( p_vout )
95     {
96         vlc_object_yield( p_vout );
97     }
98     else
99     {
100         p_vout = vlc_object_find( p_this, VLC_OBJECT_VOUT, FIND_CHILD );
101
102         if( !p_vout )
103         {
104             p_vout = vlc_object_find( p_this, VLC_OBJECT_VOUT, FIND_ANYWHERE );
105         }
106     }
107
108     /* If we now have a video output, check it has the right properties */
109     if( p_vout )
110     {
111         char *psz_filter_chain;
112
113         /* We don't directly check for the "filter" variable for obvious
114          * performance reasons. */
115         if( p_vout->b_filter_change )
116         {
117             psz_filter_chain = config_GetPsz( p_this, "filter" );
118
119             if( psz_filter_chain && !*psz_filter_chain )
120             {
121                 free( psz_filter_chain );
122                 psz_filter_chain = NULL;
123             }
124             if( p_vout->psz_filter_chain && !*p_vout->psz_filter_chain )
125             {
126                 free( p_vout->psz_filter_chain );
127                 p_vout->psz_filter_chain = NULL;
128             }
129
130             if( ( !psz_filter_chain && !p_vout->psz_filter_chain ) ||
131                 ( psz_filter_chain && p_vout->psz_filter_chain &&
132                   !strcmp( psz_filter_chain, p_vout->psz_filter_chain ) ) )
133             {
134                 p_vout->b_filter_change = VLC_FALSE;
135             }
136
137         }
138
139         if( ( p_vout->render.i_width != i_width ) ||
140             ( p_vout->render.i_height != i_height ) ||
141             ( p_vout->render.i_chroma != i_chroma ) ||
142             ( p_vout->render.i_aspect != i_aspect ) ||
143             p_vout->b_filter_change )
144         {
145             /* We are not interested in this format, close this vout */
146             vlc_object_detach( p_vout );
147             vlc_object_release( p_vout );
148             vout_Destroy( p_vout );
149             p_vout = NULL;
150         }
151         else
152         {
153             /* This video output is cool! Hijack it. */
154             vlc_object_detach( p_vout );
155             vlc_object_attach( p_vout, p_this );
156             vlc_object_release( p_vout );
157         }
158
159         if( psz_filter_chain ) free( psz_filter_chain );
160     }
161
162     if( !p_vout )
163     {
164         msg_Dbg( p_this, "no usable vout present, spawning one" );
165
166         p_vout = vout_Create( p_this, i_width, i_height, i_chroma, i_aspect );
167     }
168
169     return p_vout;
170 }
171
172 /*****************************************************************************
173  * vout_Create: creates a new video output thread
174  *****************************************************************************
175  * This function creates a new video output thread, and returns a pointer
176  * to its description. On error, it returns NULL.
177  *****************************************************************************/
178 vout_thread_t * __vout_Create( vlc_object_t *p_parent,
179                                unsigned int i_width, unsigned int i_height,
180                                vlc_fourcc_t i_chroma, unsigned int i_aspect )
181 {
182     vout_thread_t * p_vout;                             /* thread descriptor */
183     int             i_index;                                /* loop variable */
184     char          * psz_plugin;
185     vlc_value_t     val;
186
187     /* Allocate descriptor */
188     p_vout = vlc_object_create( p_parent, VLC_OBJECT_VOUT );
189     if( p_vout == NULL )
190     {
191         msg_Err( p_parent, "out of memory" );
192         return NULL;
193     }
194
195     var_Create( p_vout, "intf-change", VLC_VAR_BOOL );
196     val.b_bool = VLC_TRUE;
197     var_Set( p_vout, "intf-change", val );
198
199     /* If the parent is not a VOUT object, that means we are at the start of
200      * the video output pipe */
201     if( p_parent->i_object_type != VLC_OBJECT_VOUT )
202     {
203         char *psz_aspect = config_GetPsz( p_parent, "aspect-ratio" );
204
205         /* Check whether the user tried to override aspect ratio */
206         if( psz_aspect )
207         {
208             unsigned int i_new_aspect = i_aspect;
209             char *psz_parser = strchr( psz_aspect, ':' );
210
211             if( psz_parser )
212             {
213                 *psz_parser++ = '\0';
214                 i_new_aspect = atoi( psz_aspect ) * VOUT_ASPECT_FACTOR
215                                                   / atoi( psz_parser );
216             }
217             else
218             {
219                 i_new_aspect = i_width * VOUT_ASPECT_FACTOR
220                                        * atof( psz_aspect )
221                                        / i_height;
222             }
223
224             free( psz_aspect );
225
226             if( i_new_aspect && i_new_aspect != i_aspect )
227             {
228                 int i_pgcd = ReduceHeight( i_new_aspect );
229
230                 msg_Dbg( p_vout, "overriding source aspect ratio to %i:%i",
231                          i_new_aspect / i_pgcd, VOUT_ASPECT_FACTOR / i_pgcd );
232
233                 i_aspect = i_new_aspect;
234             }
235         }
236
237         /* Look for the default filter configuration */
238         p_vout->psz_filter_chain = config_GetPsz( p_parent, "filter" );
239     }
240     else
241     {
242         /* continue the parent's filter chain */
243         char *psz_end;
244
245         psz_end = strchr( ((vout_thread_t *)p_parent)->psz_filter_chain, ':' );
246         if( psz_end && *(psz_end+1) )
247             p_vout->psz_filter_chain = strdup( psz_end+1 );
248         else p_vout->psz_filter_chain = NULL;
249     }
250
251     /* Choose the video output module */
252     if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
253     {
254         psz_plugin = config_GetPsz( p_parent, "vout" );
255     }
256     else
257     {
258         /* the filter chain is a string list of filters separated by double
259          * colons */
260         char *psz_end;
261
262         psz_end = strchr( p_vout->psz_filter_chain, ':' );
263         if( psz_end )
264             psz_plugin = strndup( p_vout->psz_filter_chain,
265                                   psz_end - p_vout->psz_filter_chain );
266         else psz_plugin = strdup( p_vout->psz_filter_chain );
267     }
268
269     /* Initialize pictures and subpictures - translation tables and functions
270      * will be initialized later in InitThread */
271     for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES; i_index++)
272     {
273         p_vout->p_picture[i_index].i_status = FREE_PICTURE;
274         p_vout->p_picture[i_index].i_type   = EMPTY_PICTURE;
275     }
276
277     for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++)
278     {
279         p_vout->p_subpicture[i_index].i_status = FREE_SUBPICTURE;
280         p_vout->p_subpicture[i_index].i_type   = EMPTY_SUBPICTURE;
281     }
282
283     /* No images in the heap */
284     p_vout->i_heap_size = 0;
285
286     /* Initialize the rendering heap */
287     I_RENDERPICTURES = 0;
288     p_vout->render.i_width    = i_width;
289     p_vout->render.i_height   = i_height;
290     p_vout->render.i_chroma   = i_chroma;
291     p_vout->render.i_aspect   = i_aspect;
292
293     p_vout->render.i_rmask    = 0;
294     p_vout->render.i_gmask    = 0;
295     p_vout->render.i_bmask    = 0;
296
297     p_vout->render.i_last_used_pic = -1;
298     p_vout->render.b_allow_modify_pics = 1;
299
300     /* Zero the output heap */
301     I_OUTPUTPICTURES = 0;
302     p_vout->output.i_width    = 0;
303     p_vout->output.i_height   = 0;
304     p_vout->output.i_chroma   = 0;
305     p_vout->output.i_aspect   = 0;
306
307     p_vout->output.i_rmask    = 0;
308     p_vout->output.i_gmask    = 0;
309     p_vout->output.i_bmask    = 0;
310
311     /* Initialize misc stuff */
312     p_vout->i_changes    = 0;
313     p_vout->f_gamma      = 0;
314     p_vout->b_grayscale  = 0;
315     p_vout->b_info       = 0;
316     p_vout->b_interface  = 0;
317     p_vout->b_scale      = 1;
318     p_vout->b_fullscreen = 0;
319     p_vout->render_time  = 10;
320     p_vout->c_fps_samples= 0;
321     p_vout->b_filter_change = 0;
322
323     /* Mouse coordinates */
324     var_Create( p_vout, "mouse-x", VLC_VAR_INTEGER );
325     var_Create( p_vout, "mouse-y", VLC_VAR_INTEGER );
326     var_Create( p_vout, "mouse-moved", VLC_VAR_BOOL );
327     var_Create( p_vout, "mouse-clicked", VLC_VAR_INTEGER );
328     var_Create( p_vout, "key-pressed", VLC_VAR_STRING );
329
330     /* user requested fullscreen? */
331     if( config_GetInt( p_vout, "fullscreen" ) )
332     {
333         p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
334     }
335
336     /* Initialize the dimensions of the video window */
337     InitWindowSize( p_vout, &p_vout->i_window_width,
338                     &p_vout->i_window_height );
339
340
341     p_vout->p_module = module_Need( p_vout,
342                            ( p_vout->psz_filter_chain &&
343                                *p_vout->psz_filter_chain ) ?
344                            "video filter" : "video output",
345                            psz_plugin );
346
347     if( psz_plugin ) free( psz_plugin );
348     if( p_vout->p_module == NULL )
349     {
350         msg_Err( p_vout, "no suitable vout module" );
351         vlc_object_destroy( p_vout );
352         return NULL;
353     }
354
355     /* Create thread and set locks */
356     vlc_mutex_init( p_vout, &p_vout->picture_lock );
357     vlc_mutex_init( p_vout, &p_vout->subpicture_lock );
358     vlc_mutex_init( p_vout, &p_vout->change_lock );
359
360     vlc_object_attach( p_vout, p_parent );
361
362     if( vlc_thread_create( p_vout, "video output", RunThread,
363                            VLC_THREAD_PRIORITY_OUTPUT, VLC_FALSE ) )
364     {
365         msg_Err( p_vout, "out of memory" );
366         module_Unneed( p_vout, p_vout->p_module );
367         vlc_object_destroy( p_vout );
368         return NULL;
369     }
370
371     return p_vout;
372 }
373
374 /*****************************************************************************
375  * vout_Destroy: destroys a previously created video output
376  *****************************************************************************
377  * Destroy a terminated thread.
378  * The function will request a destruction of the specified thread. If pi_error
379  * is NULL, it will return once the thread is destroyed. Else, it will be
380  * update using one of the THREAD_* constants.
381  *****************************************************************************/
382 void vout_Destroy( vout_thread_t *p_vout )
383 {
384     /* Request thread destruction */
385     p_vout->b_die = VLC_TRUE;
386     vlc_thread_join( p_vout );
387
388     var_Destroy( p_vout, "intf-change" );
389
390     /* Free structure */
391     vlc_object_destroy( p_vout );
392 }
393
394 /*****************************************************************************
395  * InitThread: initialize video output thread
396  *****************************************************************************
397  * This function is called from RunThread and performs the second step of the
398  * initialization. It returns 0 on success. Note that the thread's flag are not
399  * modified inside this function.
400  *****************************************************************************/
401 static int InitThread( vout_thread_t *p_vout )
402 {
403     int i, i_pgcd;
404
405     vlc_mutex_lock( &p_vout->change_lock );
406
407 #ifdef STATS
408     p_vout->c_loops = 0;
409 #endif
410
411     /* Initialize output method, it allocates direct buffers for us */
412     if( p_vout->pf_init( p_vout ) )
413     {
414         vlc_mutex_unlock( &p_vout->change_lock );
415         return VLC_EGENERIC;
416     }
417
418     if( !I_OUTPUTPICTURES )
419     {
420         msg_Err( p_vout, "plugin was unable to allocate at least "
421                          "one direct buffer" );
422         p_vout->pf_end( p_vout );
423         vlc_mutex_unlock( &p_vout->change_lock );
424         return VLC_EGENERIC;
425     }
426
427     if( I_OUTPUTPICTURES > VOUT_MAX_PICTURES )
428     {
429         msg_Err( p_vout, "plugin allocated too many direct buffers, "
430                          "our internal buffers must have overflown." );
431         p_vout->pf_end( p_vout );
432         vlc_mutex_unlock( &p_vout->change_lock );
433         return VLC_EGENERIC;
434     }
435
436     msg_Dbg( p_vout, "got %i direct buffer(s)", I_OUTPUTPICTURES );
437
438 #if 0
439     if( !p_vout->psz_filter_chain )
440     {
441         char *psz_aspect = config_GetPsz( p_vout, "pixel-ratio" );
442
443         if( psz_aspect )
444         {
445             int i_new_aspect = p_vout->output.i_width * VOUT_ASPECT_FACTOR
446                                                       * atof( psz_aspect )
447                                                       / p_vout->output.i_height;
448             free( psz_aspect );
449
450             if( i_new_aspect && i_new_aspect != p_vout->output.i_aspect )
451             {
452                 int i_pgcd = ReduceHeight( i_new_aspect );
453                 msg_Dbg( p_vout, "output ratio forced to %i:%i\n",
454                          i_new_aspect / i_pgcd, VOUT_ASPECT_FACTOR / i_pgcd );
455                 p_vout->output.i_aspect = i_new_aspect;
456             }
457         }
458     }
459 #endif
460
461     i_pgcd = ReduceHeight( p_vout->render.i_aspect );
462     msg_Dbg( p_vout,
463              "picture in %ix%i, chroma 0x%.8x (%4.4s), aspect ratio %i:%i",
464              p_vout->render.i_width, p_vout->render.i_height,
465              p_vout->render.i_chroma, (char*)&p_vout->render.i_chroma,
466              p_vout->render.i_aspect / i_pgcd, VOUT_ASPECT_FACTOR / i_pgcd );
467
468     i_pgcd = ReduceHeight( p_vout->output.i_aspect );
469     msg_Dbg( p_vout,
470              "picture out %ix%i, chroma 0x%.8x (%4.4s), aspect ratio %i:%i",
471              p_vout->output.i_width, p_vout->output.i_height,
472              p_vout->output.i_chroma, (char*)&p_vout->output.i_chroma,
473              p_vout->output.i_aspect / i_pgcd, VOUT_ASPECT_FACTOR / i_pgcd );
474
475     /* Calculate shifts from system-updated masks */
476     MaskToShift( &p_vout->output.i_lrshift, &p_vout->output.i_rrshift,
477                  p_vout->output.i_rmask );
478     MaskToShift( &p_vout->output.i_lgshift, &p_vout->output.i_rgshift,
479                  p_vout->output.i_gmask );
480     MaskToShift( &p_vout->output.i_lbshift, &p_vout->output.i_rbshift,
481                  p_vout->output.i_bmask );
482
483     /* Check whether we managed to create direct buffers similar to
484      * the render buffers, ie same size and chroma */
485     if( ( p_vout->output.i_width == p_vout->render.i_width )
486      && ( p_vout->output.i_height == p_vout->render.i_height )
487      && ( vout_ChromaCmp( p_vout->output.i_chroma, p_vout->render.i_chroma ) ) )
488     {
489         /* Cool ! We have direct buffers, we can ask the decoder to
490          * directly decode into them ! Map the first render buffers to
491          * the first direct buffers, but keep the first direct buffer
492          * for memcpy operations */
493         p_vout->b_direct = 1;
494
495         for( i = 1; i < VOUT_MAX_PICTURES; i++ )
496         {
497             if( p_vout->p_picture[ i ].i_type != DIRECT_PICTURE &&
498                 I_RENDERPICTURES >= VOUT_MIN_DIRECT_PICTURES - 1 &&
499                 p_vout->p_picture[ i - 1 ].i_type == DIRECT_PICTURE )
500             {
501                 /* We have enough direct buffers so there's no need to
502                  * try to use system memory buffers. */
503                 break;
504             }
505             PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
506             I_RENDERPICTURES++;
507         }
508
509         msg_Dbg( p_vout, "direct render, mapping "
510                  "render pictures 0-%i to system pictures 1-%i",
511                  VOUT_MAX_PICTURES - 2, VOUT_MAX_PICTURES - 1 );
512     }
513     else
514     {
515         /* Rats... Something is wrong here, we could not find an output
516          * plugin able to directly render what we decode. See if we can
517          * find a chroma plugin to do the conversion */
518         p_vout->b_direct = 0;
519
520         /* Choose the best module */
521         p_vout->chroma.p_module = module_Need( p_vout, "chroma", NULL );
522
523         if( p_vout->chroma.p_module == NULL )
524         {
525             msg_Err( p_vout, "no chroma module for %4.4s to %4.4s",
526                      (char*)&p_vout->render.i_chroma,
527                      (char*)&p_vout->output.i_chroma );
528             p_vout->pf_end( p_vout );
529             vlc_mutex_unlock( &p_vout->change_lock );
530             return VLC_EGENERIC;
531         }
532
533         msg_Dbg( p_vout, "indirect render, mapping "
534                  "render pictures 0-%i to system pictures %i-%i",
535                  VOUT_MAX_PICTURES - 1, I_OUTPUTPICTURES,
536                  I_OUTPUTPICTURES + VOUT_MAX_PICTURES - 1 );
537
538         /* Append render buffers after the direct buffers */
539         for( i = I_OUTPUTPICTURES; i < 2 * VOUT_MAX_PICTURES; i++ )
540         {
541             PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
542             I_RENDERPICTURES++;
543
544             /* Check if we have enough render pictures */
545             if( I_RENDERPICTURES == VOUT_MAX_PICTURES )
546                 break;
547         }
548     }
549
550     /* Link pictures back to their heap */
551     for( i = 0 ; i < I_RENDERPICTURES ; i++ )
552     {
553         PP_RENDERPICTURE[ i ]->p_heap = &p_vout->render;
554     }
555
556     for( i = 0 ; i < I_OUTPUTPICTURES ; i++ )
557     {
558         PP_OUTPUTPICTURE[ i ]->p_heap = &p_vout->output;
559     }
560
561 /* XXX XXX mark thread ready */
562     return VLC_SUCCESS;
563 }
564
565 /*****************************************************************************
566  * RunThread: video output thread
567  *****************************************************************************
568  * Video output thread. This function does only returns when the thread is
569  * terminated. It handles the pictures arriving in the video heap and the
570  * display device events.
571  *****************************************************************************/
572 static void RunThread( vout_thread_t *p_vout)
573 {
574     int             i_index;                                /* index in heap */
575     int             i_idle_loops = 0;  /* loops without displaying a picture */
576     mtime_t         current_date;                            /* current date */
577     mtime_t         display_date;                            /* display date */
578
579     picture_t *     p_picture;                            /* picture pointer */
580     picture_t *     p_last_picture = NULL;                   /* last picture */
581     picture_t *     p_directbuffer;              /* direct buffer to display */
582
583     subpicture_t *  p_subpic;                          /* subpicture pointer */
584
585     /*
586      * Initialize thread
587      */
588     p_vout->b_error = InitThread( p_vout );
589     if( p_vout->b_error )
590     {
591         /* Destroy thread structures allocated by Create and InitThread */
592         DestroyThread( p_vout );
593         return;
594     }
595
596     /*
597      * Main loop - it is not executed if an error occured during
598      * initialization
599      */
600     while( (!p_vout->b_die) && (!p_vout->b_error) )
601     {
602         /* Initialize loop variables */
603         p_picture = NULL;
604         display_date = 0;
605         current_date = mdate();
606
607 #ifdef STATS
608         p_vout->c_loops++;
609         if( !(p_vout->c_loops % VOUT_STATS_NB_LOOPS) )
610         {
611             msg_Dbg( p_vout, "picture heap: %d/%d",
612                      I_RENDERPICTURES, p_vout->i_heap_size );
613         }
614 #endif
615
616         /*
617          * Find the picture to display (the one with the earliest date).
618          * This operation does not need lock, since only READY_PICTUREs
619          * are handled. */
620         for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
621         {
622             if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
623                 && ( (p_picture == NULL) ||
624                      (PP_RENDERPICTURE[i_index]->date < display_date) ) )
625             {
626                 p_picture = PP_RENDERPICTURE[i_index];
627                 display_date = p_picture->date;
628             }
629         }
630
631         if( p_picture )
632         {
633             /* If we met the last picture, parse again to see whether there is
634              * a more appropriate one. */
635             if( p_picture == p_last_picture )
636             {
637                 for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
638                 {
639                     if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
640                         && (PP_RENDERPICTURE[i_index] != p_last_picture)
641                         && ((p_picture == p_last_picture) ||
642                             (PP_RENDERPICTURE[i_index]->date < display_date)) )
643                     {
644                         p_picture = PP_RENDERPICTURE[i_index];
645                         display_date = p_picture->date;
646                     }
647                 }
648             }
649     
650             /* If we found better than the last picture, destroy it */
651             if( p_last_picture && p_picture != p_last_picture )
652             {
653                 vlc_mutex_lock( &p_vout->picture_lock );
654                 if( p_last_picture->i_refcount )
655                 {
656                     p_last_picture->i_status = DISPLAYED_PICTURE;
657                 }
658                 else
659                 {
660                     p_last_picture->i_status = DESTROYED_PICTURE;
661                     p_vout->i_heap_size--;
662                 }
663                 vlc_mutex_unlock( &p_vout->picture_lock );
664                 p_last_picture = NULL;
665             }
666
667             /* Compute FPS rate */
668             p_vout->p_fps_sample[ p_vout->c_fps_samples++ % VOUT_FPS_SAMPLES ]
669                 = display_date;
670
671             if( !p_picture->b_force &&
672                 p_picture != p_last_picture &&
673                 display_date < current_date + p_vout->render_time )
674             {
675                 /* Picture is late: it will be destroyed and the thread
676                  * will directly choose the next picture */
677                 vlc_mutex_lock( &p_vout->picture_lock );
678                 if( p_picture->i_refcount )
679                 {
680                     /* Pretend we displayed the picture, but don't destroy
681                      * it since the decoder might still need it. */
682                     p_picture->i_status = DISPLAYED_PICTURE;
683                 }
684                 else
685                 {
686                     /* Destroy the picture without displaying it */
687                     p_picture->i_status = DESTROYED_PICTURE;
688                     p_vout->i_heap_size--;
689                 }
690                 msg_Warn( p_vout, "late picture skipped ("I64Fd")",
691                                   current_date - display_date );
692                 vlc_mutex_unlock( &p_vout->picture_lock );
693
694                 continue;
695             }
696 #if 0
697             /* Removed because it causes problems for some people --Meuuh */
698             if( display_date > current_date + VOUT_BOGUS_DELAY )
699             {
700                 /* Picture is waaay too early: it will be destroyed */
701                 vlc_mutex_lock( &p_vout->picture_lock );
702                 if( p_picture->i_refcount )
703                 {
704                     /* Pretend we displayed the picture, but don't destroy
705                      * it since the decoder might still need it. */
706                     p_picture->i_status = DISPLAYED_PICTURE;
707                 }
708                 else
709                 {
710                     /* Destroy the picture without displaying it */
711                     p_picture->i_status = DESTROYED_PICTURE;
712                     p_vout->i_heap_size--;
713                 }
714                 intf_WarnMsg( 1, "vout warning: early picture skipped "
715                               "("I64Fd")", display_date - current_date );
716                 vlc_mutex_unlock( &p_vout->picture_lock );
717
718                 continue;
719             }
720 #endif
721             if( display_date > current_date + VOUT_DISPLAY_DELAY )
722             {
723                 /* A picture is ready to be rendered, but its rendering date
724                  * is far from the current one so the thread will perform an
725                  * empty loop as if no picture were found. The picture state
726                  * is unchanged */
727                 p_picture    = NULL;
728                 display_date = 0;
729             }
730             else if( p_picture == p_last_picture )
731             {
732                 /* We are asked to repeat the previous picture, but we first
733                  * wait for a couple of idle loops */
734                 if( i_idle_loops < 4 )
735                 {
736                     p_picture    = NULL;
737                     display_date = 0;
738                 }
739                 else
740                 {
741                     /* We set the display date to something high, otherwise
742                      * we'll have lots of problems with late pictures */
743                     display_date = current_date + p_vout->render_time;
744                 }
745             }
746         }
747
748         if( p_picture == NULL )
749         {
750             i_idle_loops++;
751         }
752
753         /*
754          * Check for subpictures to display
755          */
756         p_subpic = vout_SortSubPictures( p_vout, display_date );
757
758         /*
759          * Perform rendering
760          */
761         p_directbuffer = vout_RenderPicture( p_vout, p_picture, p_subpic );
762
763         /*
764          * Call the plugin-specific rendering method if there is one
765          */
766         if( p_picture != NULL && p_vout->pf_render )
767         {
768             /* Render the direct buffer returned by vout_RenderPicture */
769             p_vout->pf_render( p_vout, p_directbuffer );
770         }
771
772         /*
773          * Sleep, wake up
774          */
775         if( display_date != 0 )
776         {
777             /* Store render time using a sliding mean */
778             p_vout->render_time += mdate() - current_date;
779             p_vout->render_time >>= 1;
780         }
781
782         /* Give back change lock */
783         vlc_mutex_unlock( &p_vout->change_lock );
784
785         /* Sleep a while or until a given date */
786         if( display_date != 0 )
787         {
788             mwait( display_date - VOUT_MWAIT_TOLERANCE );
789         }
790         else
791         {
792             msleep( VOUT_IDLE_SLEEP );
793         }
794
795         /* On awakening, take back lock and send immediately picture
796          * to display. */
797         vlc_mutex_lock( &p_vout->change_lock );
798
799         /*
800          * Display the previously rendered picture
801          */
802         if( p_picture != NULL )
803         {
804             /* Display the direct buffer returned by vout_RenderPicture */
805             if( p_vout->pf_display )
806             {
807                 p_vout->pf_display( p_vout, p_directbuffer );
808             }
809
810             /* Reinitialize idle loop count */
811             i_idle_loops = 0;
812
813             /* Tell the vout this was the last picture and that it does not
814              * need to be forced anymore. */
815             p_last_picture = p_picture;
816             p_last_picture->b_force = 0;
817         }
818
819         /*
820          * Check events and manage thread
821          */
822         if( p_vout->pf_manage && p_vout->pf_manage( p_vout ) )
823         {
824             /* A fatal error occured, and the thread must terminate
825              * immediately, without displaying anything - setting b_error to 1
826              * causes the immediate end of the main while() loop. */
827             p_vout->b_error = 1;
828         }
829
830         if( p_vout->i_changes & VOUT_SIZE_CHANGE )
831         {
832             /* this must only happen when the vout plugin is incapable of
833              * rescaling the picture itself. In this case we need to destroy
834              * the current picture buffers and recreate new ones with the right
835              * dimensions */
836             int i;
837
838             p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
839
840             p_vout->pf_end( p_vout );
841             for( i = 0; i < I_OUTPUTPICTURES; i++ )
842                  p_vout->p_picture[ i ].i_status = FREE_PICTURE;
843
844             I_OUTPUTPICTURES = 0;
845             if( p_vout->pf_init( p_vout ) )
846             {
847                 msg_Err( p_vout, "cannot resize display" );
848                 /* FIXME: pf_end will be called again in EndThread() */
849                 p_vout->b_error = 1;
850             }
851
852             /* Need to reinitialise the chroma plugin */
853             p_vout->chroma.p_module->pf_deactivate( VLC_OBJECT(p_vout) );
854             p_vout->chroma.p_module->pf_activate( VLC_OBJECT(p_vout) );
855         }
856     }
857
858     /*
859      * Error loop - wait until the thread destruction is requested
860      */
861     if( p_vout->b_error )
862     {
863         ErrorThread( p_vout );
864     }
865
866     /* End of thread */
867     EndThread( p_vout );
868
869     /* Destroy thread structures allocated by CreateThread */
870     DestroyThread( p_vout );
871 }
872
873 /*****************************************************************************
874  * ErrorThread: RunThread() error loop
875  *****************************************************************************
876  * This function is called when an error occured during thread main's loop. The
877  * thread can still receive feed, but must be ready to terminate as soon as
878  * possible.
879  *****************************************************************************/
880 static void ErrorThread( vout_thread_t *p_vout )
881 {
882     /* Wait until a `die' order */
883     while( !p_vout->b_die )
884     {
885         /* Sleep a while */
886         msleep( VOUT_IDLE_SLEEP );
887     }
888 }
889
890 /*****************************************************************************
891  * EndThread: thread destruction
892  *****************************************************************************
893  * This function is called when the thread ends after a sucessful
894  * initialization. It frees all ressources allocated by InitThread.
895  *****************************************************************************/
896 static void EndThread( vout_thread_t *p_vout )
897 {
898     int     i_index;                                        /* index in heap */
899
900 #ifdef STATS
901     {
902         struct tms cpu_usage;
903         times( &cpu_usage );
904
905         msg_Dbg( p_vout, "cpu usage (user: %d, system: %d)",
906                  cpu_usage.tms_utime, cpu_usage.tms_stime );
907     }
908 #endif
909
910     if( !p_vout->b_direct )
911     {
912         module_Unneed( p_vout, p_vout->chroma.p_module );
913     }
914
915     /* Destroy all remaining pictures */
916     for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES; i_index++ )
917     {
918         if ( p_vout->p_picture[i_index].i_type == MEMORY_PICTURE )
919         {
920             free( p_vout->p_picture[i_index].p_data_orig );
921         }
922     }
923
924     /* Destroy all remaining subpictures */
925     for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
926     {
927         if( p_vout->p_subpicture[i_index].i_status != FREE_SUBPICTURE )
928         {
929             free( p_vout->p_subpicture[i_index].p_sys );
930         }
931     }
932
933     /* Destroy translation tables */
934     p_vout->pf_end( p_vout );
935
936     /* Release the change lock */
937     vlc_mutex_unlock( &p_vout->change_lock );
938 }
939
940 /*****************************************************************************
941  * DestroyThread: thread destruction
942  *****************************************************************************
943  * This function is called when the thread ends. It frees all ressources
944  * allocated by CreateThread. Status is available at this stage.
945  *****************************************************************************/
946 static void DestroyThread( vout_thread_t *p_vout )
947 {
948     /* Destroy the locks */
949     vlc_mutex_destroy( &p_vout->picture_lock );
950     vlc_mutex_destroy( &p_vout->subpicture_lock );
951     vlc_mutex_destroy( &p_vout->change_lock );
952
953     /* Release the module */
954     module_Unneed( p_vout, p_vout->p_module );
955 }
956
957 /* following functions are local */
958
959 static int ReduceHeight( int i_ratio )
960 {
961     int i_dummy = VOUT_ASPECT_FACTOR;
962     int i_pgcd  = 1;
963  
964     if( !i_ratio )
965     {
966         return i_pgcd;
967     }
968
969     /* VOUT_ASPECT_FACTOR is (2^7 * 3^3 * 5^3), we just check for 2, 3 and 5 */
970     while( !(i_ratio & 1) && !(i_dummy & 1) )
971     {
972         i_ratio >>= 1;
973         i_dummy >>= 1;
974         i_pgcd  <<= 1;
975     }
976
977     while( !(i_ratio % 3) && !(i_dummy % 3) )
978     {
979         i_ratio /= 3;
980         i_dummy /= 3;
981         i_pgcd  *= 3;
982     }
983
984     while( !(i_ratio % 5) && !(i_dummy % 5) )
985     {
986         i_ratio /= 5;
987         i_dummy /= 5;
988         i_pgcd  *= 5;
989     }
990
991     return i_pgcd;
992 }
993
994 /*****************************************************************************
995  * BinaryLog: computes the base 2 log of a binary value
996  *****************************************************************************
997  * This functions is used by MaskToShift, to get a bit index from a binary
998  * value.
999  *****************************************************************************/
1000 static int BinaryLog( uint32_t i )
1001 {
1002     int i_log = 0;
1003
1004     if( i == 0 ) return -31337;
1005
1006     if( i & 0xffff0000 ) i_log += 16;
1007     if( i & 0xff00ff00 ) i_log += 8;
1008     if( i & 0xf0f0f0f0 ) i_log += 4;
1009     if( i & 0xcccccccc ) i_log += 2;
1010     if( i & 0xaaaaaaaa ) i_log += 1;
1011
1012     return i_log;
1013 }
1014
1015 /*****************************************************************************
1016  * MaskToShift: transform a color mask into right and left shifts
1017  *****************************************************************************
1018  * This function is used for obtaining color shifts from masks.
1019  *****************************************************************************/
1020 static void MaskToShift( int *pi_left, int *pi_right, uint32_t i_mask )
1021 {
1022     uint32_t i_low, i_high;            /* lower hand higher bits of the mask */
1023
1024     if( !i_mask )
1025     {
1026         *pi_left = *pi_right = 0;
1027         return;
1028     }
1029
1030     /* Get bits */
1031     i_low =  i_mask & (- (int32_t)i_mask);          /* lower bit of the mask */
1032     i_high = i_mask + i_low;                       /* higher bit of the mask */
1033
1034     /* Transform bits into an index */
1035     i_low =  BinaryLog (i_low);
1036     i_high = BinaryLog (i_high);
1037
1038     /* Update pointers and return */
1039     *pi_left =   i_low;
1040     *pi_right = (8 - i_high + i_low);
1041 }
1042
1043 /*****************************************************************************
1044  * InitWindowSize: find the initial dimensions the video window should have.
1045  *****************************************************************************
1046  * This function will check the "width", "height" and "zoom" config options and
1047  * will calculate the size that the video window should have.
1048  *****************************************************************************/
1049 static void InitWindowSize( vout_thread_t *p_vout, int *pi_width,
1050                             int *pi_height )
1051 {
1052     int i_width, i_height;
1053     uint64_t ll_zoom;
1054
1055 #define FP_FACTOR 1000                             /* our fixed point factor */
1056
1057     i_width = config_GetInt( p_vout, "width" );
1058     i_height = config_GetInt( p_vout, "height" );
1059     ll_zoom = (uint64_t)( FP_FACTOR * config_GetFloat( p_vout, "zoom" ) );
1060
1061     if( (i_width >= 0) && (i_height >= 0))
1062     {
1063         *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
1064         *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
1065         return;
1066     }
1067     else if( i_width >= 0 )
1068     {
1069         *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
1070         *pi_height = (int)( i_width * ll_zoom * VOUT_ASPECT_FACTOR /
1071                             p_vout->render.i_aspect / FP_FACTOR );
1072         return;
1073     }
1074     else if( i_height >= 0 )
1075     {
1076         *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
1077         *pi_width = (int)( i_height * ll_zoom * p_vout->render.i_aspect /
1078                            VOUT_ASPECT_FACTOR / FP_FACTOR );
1079         return;
1080     }
1081
1082     if( p_vout->render.i_height * p_vout->render.i_aspect
1083         >= p_vout->render.i_width * VOUT_ASPECT_FACTOR )
1084     {
1085         *pi_width = (int)( p_vout->render.i_height * ll_zoom
1086           * p_vout->render.i_aspect / VOUT_ASPECT_FACTOR / FP_FACTOR );
1087         *pi_height = (int)( p_vout->render.i_height * ll_zoom / FP_FACTOR );
1088     }
1089     else
1090     {
1091         *pi_width = (int)( p_vout->render.i_width * ll_zoom / FP_FACTOR );
1092         *pi_height = (int)( p_vout->render.i_width * ll_zoom
1093           * VOUT_ASPECT_FACTOR / p_vout->render.i_aspect / FP_FACTOR );
1094     }
1095
1096 #undef FP_FACTOR
1097 }
1098
1099 /*****************************************************************************
1100  * vout_VarCallback: generic callback for intf variables
1101  *****************************************************************************/
1102 int vout_VarCallback( vlc_object_t * p_this, const char * psz_variable,
1103                       vlc_value_t old_value, vlc_value_t new_value,
1104                       void * unused )
1105 {
1106     vout_thread_t * p_vout = (vout_thread_t *)p_this;
1107     vlc_value_t val;
1108     val.b_bool = 1;
1109     var_Set( p_vout, "intf-change", val );
1110     return 0;
1111 }