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