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-2004 VideoLAN
10 * Authors: Vincent Seguin <seguin@via.ecp.fr>
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.
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.
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 *****************************************************************************/
27 /*****************************************************************************
29 *****************************************************************************/
30 #include <stdlib.h> /* free() */
34 #ifdef HAVE_SYS_TIMES_H
35 # include <sys/times.h>
38 #include "vlc_video.h"
39 #include "video_output.h"
40 #include <vlc/input.h> /* for input_thread_t and i_pts_delay */
42 #if defined( SYS_DARWIN )
43 #include "darwin_specific.h"
46 /*****************************************************************************
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 * );
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 * );
60 /* Object variables callbacks */
61 static int DeinterlaceCallback( vlc_object_t *, char const *,
62 vlc_value_t, vlc_value_t, void * );
63 static int FilterCallback( vlc_object_t *, char const *,
64 vlc_value_t, vlc_value_t, void * );
69 * Set the i_aspect_x and i_aspect_y from i_aspect.
71 void vout_AspectRatio( unsigned int i_aspect,
72 /*out*/ unsigned int *i_aspect_x,
73 /*out*/ unsigned int *i_aspect_y )
75 unsigned int i_pgcd = ReduceHeight( i_aspect );
76 *i_aspect_x = i_aspect / i_pgcd;
77 *i_aspect_y = VOUT_ASPECT_FACTOR / i_pgcd;
80 /*****************************************************************************
81 * vout_Request: find a video output thread, create one, or destroy one.
82 *****************************************************************************
83 * This function looks for a video output thread matching the current
84 * properties. If not found, it spawns a new one.
85 *****************************************************************************/
86 vout_thread_t * __vout_Request ( vlc_object_t *p_this, vout_thread_t *p_vout,
87 unsigned int i_width, unsigned int i_height,
88 vlc_fourcc_t i_chroma, unsigned int i_aspect )
90 if( !i_width || !i_height || !i_chroma )
92 /* Reattach video output to input before bailing out */
95 vlc_object_t *p_playlist;
97 p_playlist = vlc_object_find( p_this,
98 VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
102 vlc_object_detach( p_vout );
103 vlc_object_attach( p_vout, p_playlist );
105 vlc_object_release( p_playlist );
109 msg_Dbg( p_this, "cannot find playlist, destroying vout" );
110 vlc_object_detach( p_vout );
111 vout_Destroy( p_vout );
117 /* If a video output was provided, lock it, otherwise look for one. */
120 vlc_object_yield( p_vout );
124 p_vout = vlc_object_find( p_this, VLC_OBJECT_VOUT, FIND_CHILD );
128 vlc_object_t *p_playlist;
130 p_playlist = vlc_object_find( p_this,
131 VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
134 p_vout = vlc_object_find( p_playlist,
135 VLC_OBJECT_VOUT, FIND_CHILD );
136 /* only first children of p_input for unused vout */
137 if( p_vout && p_vout->p_parent != p_playlist )
139 vlc_object_release( p_vout );
142 vlc_object_release( p_playlist );
147 /* If we now have a video output, check it has the right properties */
150 char *psz_filter_chain;
152 /* We don't directly check for the "filter" variable for obvious
153 * performance reasons. */
154 if( p_vout->b_filter_change )
156 psz_filter_chain = config_GetPsz( p_this, "filter" );
158 if( psz_filter_chain && !*psz_filter_chain )
160 free( psz_filter_chain );
161 psz_filter_chain = NULL;
163 if( p_vout->psz_filter_chain && !*p_vout->psz_filter_chain )
165 free( p_vout->psz_filter_chain );
166 p_vout->psz_filter_chain = NULL;
169 if( ( !psz_filter_chain && !p_vout->psz_filter_chain ) ||
170 ( psz_filter_chain && p_vout->psz_filter_chain &&
171 !strcmp( psz_filter_chain, p_vout->psz_filter_chain ) ) )
173 p_vout->b_filter_change = VLC_FALSE;
176 if( psz_filter_chain ) free( psz_filter_chain );
179 if( ( p_vout->render.i_width != i_width ) ||
180 ( p_vout->render.i_height != i_height ) ||
181 ( p_vout->render.i_chroma != i_chroma ) ||
182 ( p_vout->render.i_aspect != i_aspect
183 && !p_vout->b_override_aspect ) ||
184 p_vout->b_filter_change )
186 /* We are not interested in this format, close this vout */
187 vlc_object_detach( p_vout );
188 vlc_object_release( p_vout );
189 vout_Destroy( p_vout );
194 /* This video output is cool! Hijack it. */
195 vlc_object_detach( p_vout );
196 vlc_object_attach( p_vout, p_this );
197 vlc_object_release( p_vout );
203 msg_Dbg( p_this, "no usable vout present, spawning one" );
205 p_vout = vout_Create( p_this, i_width, i_height, i_chroma, i_aspect );
211 /*****************************************************************************
212 * vout_Create: creates a new video output thread
213 *****************************************************************************
214 * This function creates a new video output thread, and returns a pointer
215 * to its description. On error, it returns NULL.
216 *****************************************************************************/
217 vout_thread_t * __vout_Create( vlc_object_t *p_parent,
218 unsigned int i_width, unsigned int i_height,
219 vlc_fourcc_t i_chroma, unsigned int i_aspect )
221 vout_thread_t * p_vout; /* thread descriptor */
222 input_thread_t * p_input_thread;
223 int i_index; /* loop variable */
225 vlc_value_t val, text;
227 /* Allocate descriptor */
228 p_vout = vlc_object_create( p_parent, VLC_OBJECT_VOUT );
231 msg_Err( p_parent, "out of memory" );
235 /* Initialize pictures - translation tables and functions
236 * will be initialized later in InitThread */
237 for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++)
239 p_vout->p_picture[i_index].pf_lock = NULL;
240 p_vout->p_picture[i_index].pf_unlock = NULL;
241 p_vout->p_picture[i_index].i_status = FREE_PICTURE;
242 p_vout->p_picture[i_index].i_type = EMPTY_PICTURE;
243 p_vout->p_picture[i_index].b_slow = 0;
246 /* No images in the heap */
247 p_vout->i_heap_size = 0;
249 /* Register the default subpicture channel */
250 p_vout->p_default_channel = NULL;
251 p_vout->i_channel_count = 1;
253 /* Initialize the rendering heap */
254 I_RENDERPICTURES = 0;
255 p_vout->render.i_width = i_width;
256 p_vout->render.i_height = i_height;
257 p_vout->render.i_chroma = i_chroma;
258 p_vout->render.i_aspect = i_aspect;
260 p_vout->render.i_rmask = 0;
261 p_vout->render.i_gmask = 0;
262 p_vout->render.i_bmask = 0;
264 p_vout->render.i_last_used_pic = -1;
265 p_vout->render.b_allow_modify_pics = 1;
267 /* Zero the output heap */
268 I_OUTPUTPICTURES = 0;
269 p_vout->output.i_width = 0;
270 p_vout->output.i_height = 0;
271 p_vout->output.i_chroma = 0;
272 p_vout->output.i_aspect = 0;
274 p_vout->output.i_rmask = 0;
275 p_vout->output.i_gmask = 0;
276 p_vout->output.i_bmask = 0;
278 /* Initialize misc stuff */
279 p_vout->i_changes = 0;
281 p_vout->b_grayscale = 0;
283 p_vout->b_interface = 0;
285 p_vout->b_fullscreen = 0;
286 p_vout->i_alignment = 0;
287 p_vout->render_time = 10;
288 p_vout->c_fps_samples = 0;
289 p_vout->b_filter_change = 0;
290 p_vout->pf_control = 0;
291 p_vout->p_parent_intf = 0;
293 /* Mouse coordinates */
294 var_Create( p_vout, "mouse-x", VLC_VAR_INTEGER );
295 var_Create( p_vout, "mouse-y", VLC_VAR_INTEGER );
296 var_Create( p_vout, "mouse-button-down", VLC_VAR_INTEGER );
297 var_Create( p_vout, "mouse-moved", VLC_VAR_BOOL );
298 var_Create( p_vout, "mouse-clicked", VLC_VAR_INTEGER );
300 var_Create( p_vout, "intf-change", VLC_VAR_BOOL );
301 val.b_bool = VLC_TRUE;
302 var_Set( p_vout, "intf-change", val );
304 /* Initialize locks */
305 vlc_mutex_init( p_vout, &p_vout->picture_lock );
306 vlc_mutex_init( p_vout, &p_vout->subpicture_lock );
307 vlc_mutex_init( p_vout, &p_vout->change_lock );
309 /* Attach the new object now so we can use var inheritance below */
310 vlc_object_attach( p_vout, p_parent );
312 /* Take care of some "interface/control" related initialisations */
313 vout_IntfInit( p_vout );
315 p_vout->b_override_aspect = VLC_FALSE;
317 /* If the parent is not a VOUT object, that means we are at the start of
318 * the video output pipe */
319 if( p_parent->i_object_type != VLC_OBJECT_VOUT )
321 var_Get( p_vout, "aspect-ratio", &val );
323 /* Check whether the user tried to override aspect ratio */
326 unsigned int i_new_aspect = i_aspect;
327 char *psz_parser = strchr( val.psz_string, ':' );
331 *psz_parser++ = '\0';
332 i_new_aspect = atoi( val.psz_string ) * VOUT_ASPECT_FACTOR
333 / atoi( psz_parser );
337 i_new_aspect = i_width * VOUT_ASPECT_FACTOR
338 * atof( val.psz_string )
342 free( val.psz_string );
344 if( i_new_aspect && i_new_aspect != i_aspect )
346 unsigned int i_aspect_x, i_aspect_y;
348 vout_AspectRatio( i_new_aspect, &i_aspect_x, &i_aspect_y );
350 msg_Dbg( p_vout, "overriding source aspect ratio to %i:%i",
351 i_aspect_x, i_aspect_y );
353 p_vout->render.i_aspect = i_new_aspect;
355 p_vout->b_override_aspect = VLC_TRUE;
359 /* Look for the default filter configuration */
360 var_Create( p_vout, "filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
361 var_Get( p_vout, "filter", &val );
362 p_vout->psz_filter_chain = val.psz_string;
366 /* continue the parent's filter chain */
369 psz_end = strchr( ((vout_thread_t *)p_parent)->psz_filter_chain, ':' );
370 if( psz_end && *(psz_end+1) )
371 p_vout->psz_filter_chain = strdup( psz_end+1 );
372 else p_vout->psz_filter_chain = NULL;
375 /* Choose the video output module */
376 if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
378 var_Create( p_vout, "vout", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
379 var_Get( p_vout, "vout", &val );
380 psz_plugin = val.psz_string;
384 /* the filter chain is a string list of filters separated by double
388 psz_end = strchr( p_vout->psz_filter_chain, ':' );
390 psz_plugin = strndup( p_vout->psz_filter_chain,
391 psz_end - p_vout->psz_filter_chain );
392 else psz_plugin = strdup( p_vout->psz_filter_chain );
395 /* Initialize the dimensions of the video window */
396 InitWindowSize( p_vout, &p_vout->i_window_width,
397 &p_vout->i_window_height );
399 /* Create the vout thread */
400 p_vout->p_module = module_Need( p_vout,
401 ( p_vout->psz_filter_chain && *p_vout->psz_filter_chain ) ?
402 "video filter" : "video output", psz_plugin, 0 );
404 if( psz_plugin ) free( psz_plugin );
405 if( p_vout->p_module == NULL )
407 msg_Err( p_vout, "no suitable vout module" );
408 vlc_object_detach( p_vout );
409 vlc_object_destroy( p_vout );
413 /* Initialize subpicture unit */
414 vout_InitSPU( p_vout );
416 /* Create a few object variables for interface interaction */
417 var_Create( p_vout, "deinterlace", VLC_VAR_STRING | VLC_VAR_HASCHOICE );
418 text.psz_string = _("Deinterlace");
419 var_Change( p_vout, "deinterlace", VLC_VAR_SETTEXT, &text, NULL );
420 val.psz_string = ""; text.psz_string = _("Disable");
421 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
422 val.psz_string = "discard"; text.psz_string = _("Discard");
423 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
424 val.psz_string = "blend"; text.psz_string = _("Blend");
425 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
426 val.psz_string = "mean"; text.psz_string = _("Mean");
427 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
428 val.psz_string = "bob"; text.psz_string = _("Bob");
429 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
430 val.psz_string = "linear"; text.psz_string = _("Linear");
431 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
432 if( var_Get( p_vout, "deinterlace-mode", &val ) == VLC_SUCCESS )
434 var_Set( p_vout, "deinterlace", val );
435 if( val.psz_string ) free( val.psz_string );
437 var_AddCallback( p_vout, "deinterlace", DeinterlaceCallback, NULL );
440 var_Create( p_vout, "filter", VLC_VAR_STRING );
441 text.psz_string = _("Filters");
442 var_Change( p_vout, "filter", VLC_VAR_SETTEXT, &text, NULL );
443 var_Change( p_vout, "filter", VLC_VAR_INHERITVALUE, &val, NULL );
446 var_Set( p_vout, "filter", val );
447 free( val.psz_string );
449 var_AddCallback( p_vout, "filter", FilterCallback, NULL );
451 /* Calculate delay created by internal caching */
452 p_input_thread = (input_thread_t *)vlc_object_find( p_vout,
453 VLC_OBJECT_INPUT, FIND_ANYWHERE );
456 p_vout->i_pts_delay = p_input_thread->i_pts_delay;
457 vlc_object_release( p_input_thread );
461 p_vout->i_pts_delay = DEFAULT_PTS_DELAY;
464 if( vlc_thread_create( p_vout, "video output", RunThread,
465 VLC_THREAD_PRIORITY_OUTPUT, VLC_TRUE ) )
467 msg_Err( p_vout, "out of memory" );
468 module_Unneed( p_vout, p_vout->p_module );
469 vlc_object_detach( p_vout );
470 vlc_object_destroy( p_vout );
474 if( p_vout->b_error )
476 msg_Err( p_vout, "video output creation failed" );
478 /* Make sure the thread is destroyed */
479 p_vout->b_die = VLC_TRUE;
481 vlc_thread_join( p_vout );
483 vlc_object_detach( p_vout );
484 vlc_object_destroy( p_vout );
491 /*****************************************************************************
492 * vout_Destroy: destroys a previously created video output
493 *****************************************************************************
494 * Destroy a terminated thread.
495 * The function will request a destruction of the specified thread. If pi_error
496 * is NULL, it will return once the thread is destroyed. Else, it will be
497 * update using one of the THREAD_* constants.
498 *****************************************************************************/
499 void vout_Destroy( vout_thread_t *p_vout )
501 vlc_object_t *p_playlist;
503 /* Request thread destruction */
504 p_vout->b_die = VLC_TRUE;
505 vlc_thread_join( p_vout );
507 var_Destroy( p_vout, "intf-change" );
509 p_playlist = vlc_object_find( p_vout, VLC_OBJECT_PLAYLIST,
512 if( p_vout->psz_filter_chain ) free( p_vout->psz_filter_chain );
515 vlc_object_destroy( p_vout );
517 /* If it was the last vout, tell the interface to show up */
518 if( p_playlist != NULL )
520 vout_thread_t *p_another_vout = vlc_object_find( p_playlist,
521 VLC_OBJECT_VOUT, FIND_ANYWHERE );
522 if( p_another_vout == NULL )
525 val.b_bool = VLC_TRUE;
526 var_Set( p_playlist, "intf-show", val );
530 vlc_object_release( p_another_vout );
532 vlc_object_release( p_playlist );
536 /*****************************************************************************
537 * InitThread: initialize video output thread
538 *****************************************************************************
539 * This function is called from RunThread and performs the second step of the
540 * initialization. It returns 0 on success. Note that the thread's flag are not
541 * modified inside this function.
542 *****************************************************************************/
543 static int InitThread( vout_thread_t *p_vout )
546 unsigned int i_aspect_x, i_aspect_y;
548 vlc_mutex_lock( &p_vout->change_lock );
554 /* Initialize output method, it allocates direct buffers for us */
555 if( p_vout->pf_init( p_vout ) )
557 vlc_mutex_unlock( &p_vout->change_lock );
561 if( !I_OUTPUTPICTURES )
563 msg_Err( p_vout, "plugin was unable to allocate at least "
564 "one direct buffer" );
565 p_vout->pf_end( p_vout );
566 vlc_mutex_unlock( &p_vout->change_lock );
570 if( I_OUTPUTPICTURES > VOUT_MAX_PICTURES )
572 msg_Err( p_vout, "plugin allocated too many direct buffers, "
573 "our internal buffers must have overflown." );
574 p_vout->pf_end( p_vout );
575 vlc_mutex_unlock( &p_vout->change_lock );
579 msg_Dbg( p_vout, "got %i direct buffer(s)", I_OUTPUTPICTURES );
582 if( !p_vout->psz_filter_chain )
584 char *psz_aspect = config_GetPsz( p_vout, "pixel-ratio" );
588 int i_new_aspect = p_vout->output.i_width * VOUT_ASPECT_FACTOR
590 / p_vout->output.i_height;
593 if( i_new_aspect && i_new_aspect != p_vout->output.i_aspect )
595 vout_AspectRatio( i_new_aspect, &i_aspect_x, &i_aspect_y );
597 msg_Dbg( p_vout, "output ratio forced to %i:%i\n",
598 i_aspect_x, i_aspect_y );
599 p_vout->output.i_aspect = i_new_aspect;
605 vout_AspectRatio( p_vout->render.i_aspect, &i_aspect_x, &i_aspect_y );
607 "picture in %ix%i, chroma 0x%.8x (%4.4s), aspect ratio %i:%i",
608 p_vout->render.i_width, p_vout->render.i_height,
609 p_vout->render.i_chroma, (char*)&p_vout->render.i_chroma,
610 i_aspect_x, i_aspect_y );
612 vout_AspectRatio( p_vout->output.i_aspect, &i_aspect_x, &i_aspect_y );
614 "picture out %ix%i, chroma 0x%.8x (%4.4s), aspect ratio %i:%i",
615 p_vout->output.i_width, p_vout->output.i_height,
616 p_vout->output.i_chroma, (char*)&p_vout->output.i_chroma,
617 i_aspect_x, i_aspect_y );
619 /* Calculate shifts from system-updated masks */
620 MaskToShift( &p_vout->output.i_lrshift, &p_vout->output.i_rrshift,
621 p_vout->output.i_rmask );
622 MaskToShift( &p_vout->output.i_lgshift, &p_vout->output.i_rgshift,
623 p_vout->output.i_gmask );
624 MaskToShift( &p_vout->output.i_lbshift, &p_vout->output.i_rbshift,
625 p_vout->output.i_bmask );
627 /* Check whether we managed to create direct buffers similar to
628 * the render buffers, ie same size and chroma */
629 if( ( p_vout->output.i_width == p_vout->render.i_width )
630 && ( p_vout->output.i_height == p_vout->render.i_height )
631 && ( vout_ChromaCmp( p_vout->output.i_chroma, p_vout->render.i_chroma ) ) )
633 /* Cool ! We have direct buffers, we can ask the decoder to
634 * directly decode into them ! Map the first render buffers to
635 * the first direct buffers, but keep the first direct buffer
636 * for memcpy operations */
637 p_vout->b_direct = 1;
639 for( i = 1; i < VOUT_MAX_PICTURES; i++ )
641 if( p_vout->p_picture[ i ].i_type != DIRECT_PICTURE &&
642 I_RENDERPICTURES >= VOUT_MIN_DIRECT_PICTURES - 1 &&
643 p_vout->p_picture[ i - 1 ].i_type == DIRECT_PICTURE )
645 /* We have enough direct buffers so there's no need to
646 * try to use system memory buffers. */
649 PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
653 msg_Dbg( p_vout, "direct render, mapping "
654 "render pictures 0-%i to system pictures 1-%i",
655 VOUT_MAX_PICTURES - 2, VOUT_MAX_PICTURES - 1 );
659 /* Rats... Something is wrong here, we could not find an output
660 * plugin able to directly render what we decode. See if we can
661 * find a chroma plugin to do the conversion */
662 p_vout->b_direct = 0;
664 /* Choose the best module */
665 p_vout->chroma.p_module = module_Need( p_vout, "chroma", NULL, 0 );
667 if( p_vout->chroma.p_module == NULL )
669 msg_Err( p_vout, "no chroma module for %4.4s to %4.4s",
670 (char*)&p_vout->render.i_chroma,
671 (char*)&p_vout->output.i_chroma );
672 p_vout->pf_end( p_vout );
673 vlc_mutex_unlock( &p_vout->change_lock );
677 msg_Dbg( p_vout, "indirect render, mapping "
678 "render pictures 0-%i to system pictures %i-%i",
679 VOUT_MAX_PICTURES - 1, I_OUTPUTPICTURES,
680 I_OUTPUTPICTURES + VOUT_MAX_PICTURES - 1 );
682 /* Append render buffers after the direct buffers */
683 for( i = I_OUTPUTPICTURES; i < 2 * VOUT_MAX_PICTURES; i++ )
685 PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
688 /* Check if we have enough render pictures */
689 if( I_RENDERPICTURES == VOUT_MAX_PICTURES )
694 /* Link pictures back to their heap */
695 for( i = 0 ; i < I_RENDERPICTURES ; i++ )
697 PP_RENDERPICTURE[ i ]->p_heap = &p_vout->render;
700 for( i = 0 ; i < I_OUTPUTPICTURES ; i++ )
702 PP_OUTPUTPICTURE[ i ]->p_heap = &p_vout->output;
705 /* XXX XXX mark thread ready */
709 /*****************************************************************************
710 * RunThread: video output thread
711 *****************************************************************************
712 * Video output thread. This function does only returns when the thread is
713 * terminated. It handles the pictures arriving in the video heap and the
714 * display device events.
715 *****************************************************************************/
716 static void RunThread( vout_thread_t *p_vout)
718 int i_index; /* index in heap */
719 int i_idle_loops = 0; /* loops without displaying a picture */
720 mtime_t current_date; /* current date */
721 mtime_t display_date; /* display date */
723 picture_t * p_picture; /* picture pointer */
724 picture_t * p_last_picture = NULL; /* last picture */
725 picture_t * p_directbuffer; /* direct buffer to display */
727 subpicture_t * p_subpic; /* subpicture pointer */
732 p_vout->b_error = InitThread( p_vout );
734 /* signal the creation of the vout */
735 vlc_thread_ready( p_vout );
737 if( p_vout->b_error )
739 /* Destroy thread structures allocated by Create and InitThread */
740 DestroyThread( p_vout );
745 * Main loop - it is not executed if an error occured during
748 while( (!p_vout->b_die) && (!p_vout->b_error) )
750 /* Initialize loop variables */
753 current_date = mdate();
757 if( !(p_vout->c_loops % VOUT_STATS_NB_LOOPS) )
759 msg_Dbg( p_vout, "picture heap: %d/%d",
760 I_RENDERPICTURES, p_vout->i_heap_size );
765 * Find the picture to display (the one with the earliest date).
766 * This operation does not need lock, since only READY_PICTUREs
768 for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
770 if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
771 && ( (p_picture == NULL) ||
772 (PP_RENDERPICTURE[i_index]->date < display_date) ) )
774 p_picture = PP_RENDERPICTURE[i_index];
775 display_date = p_picture->date;
781 /* If we met the last picture, parse again to see whether there is
782 * a more appropriate one. */
783 if( p_picture == p_last_picture )
785 for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
787 if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
788 && (PP_RENDERPICTURE[i_index] != p_last_picture)
789 && ((p_picture == p_last_picture) ||
790 (PP_RENDERPICTURE[i_index]->date < display_date)) )
792 p_picture = PP_RENDERPICTURE[i_index];
793 display_date = p_picture->date;
798 /* If we found better than the last picture, destroy it */
799 if( p_last_picture && p_picture != p_last_picture )
801 vlc_mutex_lock( &p_vout->picture_lock );
802 if( p_last_picture->i_refcount )
804 p_last_picture->i_status = DISPLAYED_PICTURE;
808 p_last_picture->i_status = DESTROYED_PICTURE;
809 p_vout->i_heap_size--;
811 vlc_mutex_unlock( &p_vout->picture_lock );
812 p_last_picture = NULL;
815 /* Compute FPS rate */
816 p_vout->p_fps_sample[ p_vout->c_fps_samples++ % VOUT_FPS_SAMPLES ]
819 if( !p_picture->b_force &&
820 p_picture != p_last_picture &&
821 display_date < current_date + p_vout->render_time )
823 /* Picture is late: it will be destroyed and the thread
824 * will directly choose the next picture */
825 vlc_mutex_lock( &p_vout->picture_lock );
826 if( p_picture->i_refcount )
828 /* Pretend we displayed the picture, but don't destroy
829 * it since the decoder might still need it. */
830 p_picture->i_status = DISPLAYED_PICTURE;
834 /* Destroy the picture without displaying it */
835 p_picture->i_status = DESTROYED_PICTURE;
836 p_vout->i_heap_size--;
838 msg_Warn( p_vout, "late picture skipped ("I64Fd")",
839 current_date - display_date );
840 vlc_mutex_unlock( &p_vout->picture_lock );
846 current_date + p_vout->i_pts_delay + VOUT_BOGUS_DELAY )
848 /* Picture is waaay too early: it will be destroyed */
849 vlc_mutex_lock( &p_vout->picture_lock );
850 if( p_picture->i_refcount )
852 /* Pretend we displayed the picture, but don't destroy
853 * it since the decoder might still need it. */
854 p_picture->i_status = DISPLAYED_PICTURE;
858 /* Destroy the picture without displaying it */
859 p_picture->i_status = DESTROYED_PICTURE;
860 p_vout->i_heap_size--;
862 msg_Warn( p_vout, "vout warning: early picture skipped "
863 "("I64Fd")", display_date - current_date
864 - p_vout->i_pts_delay );
865 vlc_mutex_unlock( &p_vout->picture_lock );
870 if( display_date > current_date + VOUT_DISPLAY_DELAY )
872 /* A picture is ready to be rendered, but its rendering date
873 * is far from the current one so the thread will perform an
874 * empty loop as if no picture were found. The picture state
879 else if( p_picture == p_last_picture )
881 /* We are asked to repeat the previous picture, but we first
882 * wait for a couple of idle loops */
883 if( i_idle_loops < 4 )
890 /* We set the display date to something high, otherwise
891 * we'll have lots of problems with late pictures */
892 display_date = current_date + p_vout->render_time;
897 if( p_picture == NULL )
903 * Check for subpictures to display
905 p_subpic = vout_SortSubPictures( p_vout, display_date );
910 p_directbuffer = vout_RenderPicture( p_vout, p_picture, p_subpic );
913 * Call the plugin-specific rendering method if there is one
915 if( p_picture != NULL && p_directbuffer != NULL && p_vout->pf_render )
917 /* Render the direct buffer returned by vout_RenderPicture */
918 p_vout->pf_render( p_vout, p_directbuffer );
924 if( display_date != 0 && p_directbuffer != NULL )
926 mtime_t current_render_time = mdate() - current_date;
927 /* if render time is very large we don't include it in the mean */
928 if( current_render_time < p_vout->render_time +
931 /* Store render time using a sliding mean weighting to
932 * current value in a 3 to 1 ratio*/
933 p_vout->render_time *= 3;
934 p_vout->render_time += current_render_time;
935 p_vout->render_time >>= 2;
939 /* Give back change lock */
940 vlc_mutex_unlock( &p_vout->change_lock );
942 /* Sleep a while or until a given date */
943 if( display_date != 0 )
945 /* If there are filters in the chain, better give them the picture
947 if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
949 mwait( display_date - VOUT_MWAIT_TOLERANCE );
954 msleep( VOUT_IDLE_SLEEP );
957 /* On awakening, take back lock and send immediately picture
959 vlc_mutex_lock( &p_vout->change_lock );
962 * Display the previously rendered picture
964 if( p_picture != NULL && p_directbuffer != NULL )
966 /* Display the direct buffer returned by vout_RenderPicture */
967 if( p_vout->pf_display )
969 p_vout->pf_display( p_vout, p_directbuffer );
972 /* Reinitialize idle loop count */
975 /* Tell the vout this was the last picture and that it does not
976 * need to be forced anymore. */
977 p_last_picture = p_picture;
978 p_last_picture->b_force = 0;
982 * Check events and manage thread
984 if( p_vout->pf_manage && p_vout->pf_manage( p_vout ) )
986 /* A fatal error occured, and the thread must terminate
987 * immediately, without displaying anything - setting b_error to 1
988 * causes the immediate end of the main while() loop. */
992 if( p_vout->i_changes & VOUT_SIZE_CHANGE )
994 /* this must only happen when the vout plugin is incapable of
995 * rescaling the picture itself. In this case we need to destroy
996 * the current picture buffers and recreate new ones with the right
1000 p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
1002 p_vout->pf_end( p_vout );
1003 for( i = 0; i < I_OUTPUTPICTURES; i++ )
1004 p_vout->p_picture[ i ].i_status = FREE_PICTURE;
1006 I_OUTPUTPICTURES = 0;
1007 if( p_vout->pf_init( p_vout ) )
1009 msg_Err( p_vout, "cannot resize display" );
1010 /* FIXME: pf_end will be called again in EndThread() */
1011 p_vout->b_error = 1;
1014 /* Need to reinitialise the chroma plugin */
1015 if( p_vout->chroma.p_module )
1017 if( p_vout->chroma.p_module->pf_deactivate )
1018 p_vout->chroma.p_module->pf_deactivate( VLC_OBJECT(p_vout) );
1019 p_vout->chroma.p_module->pf_activate( VLC_OBJECT(p_vout) );
1023 if( p_vout->i_changes & VOUT_PICTURE_BUFFERS_CHANGE )
1025 /* This happens when the picture buffers need to be recreated.
1026 * This is useful on multimonitor displays for instance.
1028 * Warning: This only works when the vout creates only 1 picture
1030 p_vout->i_changes &= ~VOUT_PICTURE_BUFFERS_CHANGE;
1032 if( !p_vout->b_direct )
1034 module_Unneed( p_vout, p_vout->chroma.p_module );
1037 vlc_mutex_lock( &p_vout->picture_lock );
1039 p_vout->pf_end( p_vout );
1041 I_OUTPUTPICTURES = I_RENDERPICTURES = 0;
1043 p_vout->b_error = InitThread( p_vout );
1045 vlc_mutex_unlock( &p_vout->picture_lock );
1050 * Error loop - wait until the thread destruction is requested
1052 if( p_vout->b_error )
1054 ErrorThread( p_vout );
1058 EndThread( p_vout );
1060 /* Destroy thread structures allocated by CreateThread */
1061 DestroyThread( p_vout );
1064 /*****************************************************************************
1065 * ErrorThread: RunThread() error loop
1066 *****************************************************************************
1067 * This function is called when an error occured during thread main's loop. The
1068 * thread can still receive feed, but must be ready to terminate as soon as
1070 *****************************************************************************/
1071 static void ErrorThread( vout_thread_t *p_vout )
1073 /* Wait until a `die' order */
1074 while( !p_vout->b_die )
1077 msleep( VOUT_IDLE_SLEEP );
1081 /*****************************************************************************
1082 * EndThread: thread destruction
1083 *****************************************************************************
1084 * This function is called when the thread ends after a sucessful
1085 * initialization. It frees all resources allocated by InitThread.
1086 *****************************************************************************/
1087 static void EndThread( vout_thread_t *p_vout )
1089 int i_index; /* index in heap */
1093 struct tms cpu_usage;
1094 times( &cpu_usage );
1096 msg_Dbg( p_vout, "cpu usage (user: %d, system: %d)",
1097 cpu_usage.tms_utime, cpu_usage.tms_stime );
1101 if( !p_vout->b_direct )
1103 module_Unneed( p_vout, p_vout->chroma.p_module );
1106 /* Destroy all remaining pictures */
1107 for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++ )
1109 if ( p_vout->p_picture[i_index].i_type == MEMORY_PICTURE )
1111 free( p_vout->p_picture[i_index].p_data_orig );
1115 /* Destroy subpicture unit */
1116 vout_DestroySPU( p_vout );
1118 /* Destroy translation tables */
1119 p_vout->pf_end( p_vout );
1121 /* Release the change lock */
1122 vlc_mutex_unlock( &p_vout->change_lock );
1125 /*****************************************************************************
1126 * DestroyThread: thread destruction
1127 *****************************************************************************
1128 * This function is called when the thread ends. It frees all ressources
1129 * allocated by CreateThread. Status is available at this stage.
1130 *****************************************************************************/
1131 static void DestroyThread( vout_thread_t *p_vout )
1133 /* Destroy the locks */
1134 vlc_mutex_destroy( &p_vout->picture_lock );
1135 vlc_mutex_destroy( &p_vout->subpicture_lock );
1136 vlc_mutex_destroy( &p_vout->change_lock );
1138 /* Release the module */
1139 if( p_vout && p_vout->p_module )
1141 module_Unneed( p_vout, p_vout->p_module );
1145 /* following functions are local */
1147 static int ReduceHeight( int i_ratio )
1149 int i_dummy = VOUT_ASPECT_FACTOR;
1157 /* VOUT_ASPECT_FACTOR is (2^7 * 3^3 * 5^3), we just check for 2, 3 and 5 */
1158 while( !(i_ratio & 1) && !(i_dummy & 1) )
1165 while( !(i_ratio % 3) && !(i_dummy % 3) )
1172 while( !(i_ratio % 5) && !(i_dummy % 5) )
1182 /*****************************************************************************
1183 * BinaryLog: computes the base 2 log of a binary value
1184 *****************************************************************************
1185 * This functions is used by MaskToShift, to get a bit index from a binary
1187 *****************************************************************************/
1188 static int BinaryLog( uint32_t i )
1192 if( i == 0 ) return -31337;
1194 if( i & 0xffff0000 ) i_log += 16;
1195 if( i & 0xff00ff00 ) i_log += 8;
1196 if( i & 0xf0f0f0f0 ) i_log += 4;
1197 if( i & 0xcccccccc ) i_log += 2;
1198 if( i & 0xaaaaaaaa ) i_log += 1;
1203 /*****************************************************************************
1204 * MaskToShift: transform a color mask into right and left shifts
1205 *****************************************************************************
1206 * This function is used for obtaining color shifts from masks.
1207 *****************************************************************************/
1208 static void MaskToShift( int *pi_left, int *pi_right, uint32_t i_mask )
1210 uint32_t i_low, i_high; /* lower hand higher bits of the mask */
1214 *pi_left = *pi_right = 0;
1219 i_low = i_mask & (- (int32_t)i_mask); /* lower bit of the mask */
1220 i_high = i_mask + i_low; /* higher bit of the mask */
1222 /* Transform bits into an index */
1223 i_low = BinaryLog (i_low);
1224 i_high = BinaryLog (i_high);
1226 /* Update pointers and return */
1228 *pi_right = (8 - i_high + i_low);
1231 /*****************************************************************************
1232 * InitWindowSize: find the initial dimensions the video window should have.
1233 *****************************************************************************
1234 * This function will check the "width", "height" and "zoom" config options and
1235 * will calculate the size that the video window should have.
1236 *****************************************************************************/
1237 static void InitWindowSize( vout_thread_t *p_vout, int *pi_width,
1241 int i_width, i_height;
1244 #define FP_FACTOR 1000 /* our fixed point factor */
1246 var_Get( p_vout, "align", &val );
1247 p_vout->i_alignment = val.i_int;
1249 var_Get( p_vout, "width", &val );
1250 i_width = val.i_int;
1251 var_Get( p_vout, "height", &val );
1252 i_height = val.i_int;
1253 var_Get( p_vout, "zoom", &val );
1254 ll_zoom = (uint64_t)( FP_FACTOR * val.f_float );
1256 if( i_width > 0 && i_height > 0)
1258 *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
1259 *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
1262 else if( i_width > 0 )
1264 *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
1265 *pi_height = (int)( i_width * ll_zoom * VOUT_ASPECT_FACTOR /
1266 p_vout->render.i_aspect / FP_FACTOR );
1269 else if( i_height > 0 )
1271 *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
1272 *pi_width = (int)( i_height * ll_zoom * p_vout->render.i_aspect /
1273 VOUT_ASPECT_FACTOR / FP_FACTOR );
1277 if( p_vout->render.i_height * p_vout->render.i_aspect
1278 >= p_vout->render.i_width * VOUT_ASPECT_FACTOR )
1280 *pi_width = (int)( p_vout->render.i_height * ll_zoom
1281 * p_vout->render.i_aspect / VOUT_ASPECT_FACTOR / FP_FACTOR );
1282 *pi_height = (int)( p_vout->render.i_height * ll_zoom / FP_FACTOR );
1286 *pi_width = (int)( p_vout->render.i_width * ll_zoom / FP_FACTOR );
1287 *pi_height = (int)( p_vout->render.i_width * ll_zoom
1288 * VOUT_ASPECT_FACTOR / p_vout->render.i_aspect / FP_FACTOR );
1294 /*****************************************************************************
1295 * vout_VarCallback: generic callback for intf variables
1296 *****************************************************************************/
1297 int vout_VarCallback( vlc_object_t * p_this, const char * psz_variable,
1298 vlc_value_t old_value, vlc_value_t new_value,
1301 vout_thread_t * p_vout = (vout_thread_t *)p_this;
1303 val.b_bool = VLC_TRUE;
1304 var_Set( p_vout, "intf-change", val );
1308 /*****************************************************************************
1309 * object variables callbacks: a bunch of object variables are used by the
1310 * interfaces to interact with the vout.
1311 *****************************************************************************/
1312 static int DeinterlaceCallback( vlc_object_t *p_this, char const *psz_cmd,
1313 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1315 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1316 input_thread_t *p_input;
1319 char *psz_mode = newval.psz_string;
1323 psz_filter = config_GetPsz( p_vout, "filter" );
1325 if( !psz_mode || !*psz_mode )
1327 config_PutPsz( p_vout, "filter", "" );
1331 if( !psz_filter || !*psz_filter )
1333 config_PutPsz( p_vout, "filter", "deinterlace" );
1337 if( strstr( psz_filter, "deinterlace" ) == NULL )
1339 psz_filter = realloc( psz_filter, strlen( psz_filter ) + 20 );
1340 strcat( psz_filter, ",deinterlace" );
1342 config_PutPsz( p_vout, "filter", psz_filter );
1346 if( psz_filter ) free( psz_filter );
1349 p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1351 if( !p_input ) return VLC_EGENERIC;
1353 if( psz_mode && *psz_mode )
1355 val.psz_string = psz_mode;
1356 var_Set( p_vout, "deinterlace-mode", val );
1357 /* Modify input as well because the vout might have to be restarted */
1358 var_Create( p_input, "deinterlace-mode", VLC_VAR_STRING );
1359 var_Set( p_input, "deinterlace-mode", val );
1362 /* FIXME FIXME input2 --fenrir */
1364 /* now restart all video streams */
1365 vlc_mutex_lock( &p_input->stream.stream_lock );
1367 p_vout->b_filter_change = VLC_TRUE;
1369 #define ES p_input->stream.pp_es[i]
1371 for( i = 0 ; i < p_input->stream.i_es_number ; i++ )
1373 if( ( ES->i_cat == VIDEO_ES ) && ES->p_dec != NULL )
1375 input_UnselectES( p_input, ES );
1376 input_SelectES( p_input, ES );
1380 vlc_mutex_unlock( &p_input->stream.stream_lock );
1382 vlc_object_release( p_input );
1385 val.b_bool = VLC_TRUE;
1386 var_Set( p_vout, "intf-change", val );
1390 static int FilterCallback( vlc_object_t *p_this, char const *psz_cmd,
1391 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1393 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1394 input_thread_t *p_input;
1398 p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1403 msg_Err( p_vout, "Input not found" );
1404 return( VLC_EGENERIC );
1407 /* FIXME FIXME input2 --fenrir */
1409 /* Restart the video stream */
1410 vlc_mutex_lock( &p_input->stream.stream_lock );
1412 p_vout->b_filter_change = VLC_TRUE;
1414 #define ES p_input->stream.pp_es[i]
1416 for( i = 0 ; i < p_input->stream.i_es_number ; i++ )
1418 if( ( ES->i_cat == VIDEO_ES ) && ES->p_dec != NULL )
1420 input_UnselectES( p_input, ES );
1421 input_SelectES( p_input, ES );
1425 vlc_mutex_unlock( &p_input->stream.stream_lock );
1427 vlc_object_release( p_input );
1430 val.b_bool = VLC_TRUE;
1431 var_Set( p_vout, "intf-change", val );