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
8 * $Id: video_output.c,v 1.244 2004/01/10 13:59:25 rocky Exp $
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 FullscreenCallback( vlc_object_t *, char const *,
62 vlc_value_t, vlc_value_t, void * );
63 static int DeinterlaceCallback( vlc_object_t *, char const *,
64 vlc_value_t, vlc_value_t, void * );
65 static int FilterCallback( vlc_object_t *, char const *,
66 vlc_value_t, vlc_value_t, void * );
71 * Set the i_aspect_x and i_aspect_y from i_aspect.
73 void vout_AspectRatio( unsigned int i_aspect,
74 /*out*/ unsigned int *i_aspect_x,
75 /*out*/ unsigned int *i_aspect_y )
77 unsigned int i_pgcd = ReduceHeight( i_aspect );
78 *i_aspect_x = i_aspect / i_pgcd;
79 *i_aspect_y = VOUT_ASPECT_FACTOR / i_pgcd;
82 /*****************************************************************************
83 * vout_Request: find a video output thread, create one, or destroy one.
84 *****************************************************************************
85 * This function looks for a video output thread matching the current
86 * properties. If not found, it spawns a new one.
87 *****************************************************************************/
88 vout_thread_t * __vout_Request ( vlc_object_t *p_this, vout_thread_t *p_vout,
89 unsigned int i_width, unsigned int i_height,
90 vlc_fourcc_t i_chroma, unsigned int i_aspect )
92 if( !i_width || !i_height || !i_chroma )
94 /* Reattach video output to input before bailing out */
97 vlc_object_t *p_playlist;
99 p_playlist = vlc_object_find( p_this,
100 VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
104 vlc_object_detach( p_vout );
105 vlc_object_attach( p_vout, p_playlist );
107 vlc_object_release( p_playlist );
111 msg_Dbg( p_this, "cannot find playlist destroying vout" );
112 vlc_object_detach( p_vout );
113 vout_Destroy( p_vout );
119 /* If a video output was provided, lock it, otherwise look for one. */
122 vlc_object_yield( p_vout );
126 p_vout = vlc_object_find( p_this, VLC_OBJECT_VOUT, FIND_CHILD );
130 vlc_object_t *p_playlist;
132 p_playlist = vlc_object_find( p_this,
133 VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
136 p_vout = vlc_object_find( p_playlist,
137 VLC_OBJECT_VOUT, FIND_CHILD );
138 /* only first children of p_input for unused vout */
139 if( p_vout && p_vout->p_parent != p_playlist )
141 vlc_object_release( p_vout );
144 vlc_object_release( p_playlist );
149 /* If we now have a video output, check it has the right properties */
152 char *psz_filter_chain;
154 /* We don't directly check for the "filter" variable for obvious
155 * performance reasons. */
156 if( p_vout->b_filter_change )
158 psz_filter_chain = config_GetPsz( p_this, "filter" );
160 if( psz_filter_chain && !*psz_filter_chain )
162 free( psz_filter_chain );
163 psz_filter_chain = NULL;
165 if( p_vout->psz_filter_chain && !*p_vout->psz_filter_chain )
167 free( p_vout->psz_filter_chain );
168 p_vout->psz_filter_chain = NULL;
171 if( ( !psz_filter_chain && !p_vout->psz_filter_chain ) ||
172 ( psz_filter_chain && p_vout->psz_filter_chain &&
173 !strcmp( psz_filter_chain, p_vout->psz_filter_chain ) ) )
175 p_vout->b_filter_change = VLC_FALSE;
178 if( psz_filter_chain ) free( psz_filter_chain );
181 if( ( p_vout->render.i_width != i_width ) ||
182 ( p_vout->render.i_height != i_height ) ||
183 ( p_vout->render.i_chroma != i_chroma ) ||
184 ( p_vout->render.i_aspect != i_aspect
185 && !p_vout->b_override_aspect ) ||
186 p_vout->b_filter_change )
188 /* We are not interested in this format, close this vout */
189 vlc_object_detach( p_vout );
190 vlc_object_release( p_vout );
191 vout_Destroy( p_vout );
196 /* This video output is cool! Hijack it. */
197 vlc_object_detach( p_vout );
198 vlc_object_attach( p_vout, p_this );
199 vlc_object_release( p_vout );
205 msg_Dbg( p_this, "no usable vout present, spawning one" );
207 p_vout = vout_Create( p_this, i_width, i_height, i_chroma, i_aspect );
213 /*****************************************************************************
214 * vout_Create: creates a new video output thread
215 *****************************************************************************
216 * This function creates a new video output thread, and returns a pointer
217 * to its description. On error, it returns NULL.
218 *****************************************************************************/
219 vout_thread_t * __vout_Create( vlc_object_t *p_parent,
220 unsigned int i_width, unsigned int i_height,
221 vlc_fourcc_t i_chroma, unsigned int i_aspect )
223 vout_thread_t * p_vout; /* thread descriptor */
224 input_thread_t * p_input_thread;
225 int i_index; /* loop variable */
227 vlc_value_t val, text;
229 /* Allocate descriptor */
230 p_vout = vlc_object_create( p_parent, VLC_OBJECT_VOUT );
233 msg_Err( p_parent, "out of memory" );
237 /* Initialize pictures and subpictures - translation tables and functions
238 * will be initialized later in InitThread */
239 for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES; i_index++)
241 p_vout->p_picture[i_index].pf_lock = NULL;
242 p_vout->p_picture[i_index].pf_unlock = NULL;
243 p_vout->p_picture[i_index].i_status = FREE_PICTURE;
244 p_vout->p_picture[i_index].i_type = EMPTY_PICTURE;
247 for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++)
249 p_vout->p_subpicture[i_index].i_status = FREE_SUBPICTURE;
250 p_vout->p_subpicture[i_index].i_type = EMPTY_SUBPICTURE;
253 /* No images in the heap */
254 p_vout->i_heap_size = 0;
256 /* Initialize the rendering heap */
257 I_RENDERPICTURES = 0;
258 p_vout->render.i_width = i_width;
259 p_vout->render.i_height = i_height;
260 p_vout->render.i_chroma = i_chroma;
261 p_vout->render.i_aspect = i_aspect;
263 p_vout->render.i_rmask = 0;
264 p_vout->render.i_gmask = 0;
265 p_vout->render.i_bmask = 0;
267 p_vout->render.i_last_used_pic = -1;
268 p_vout->render.b_allow_modify_pics = 1;
270 /* Zero the output heap */
271 I_OUTPUTPICTURES = 0;
272 p_vout->output.i_width = 0;
273 p_vout->output.i_height = 0;
274 p_vout->output.i_chroma = 0;
275 p_vout->output.i_aspect = 0;
277 p_vout->output.i_rmask = 0;
278 p_vout->output.i_gmask = 0;
279 p_vout->output.i_bmask = 0;
281 /* Initialize misc stuff */
282 p_vout->i_changes = 0;
284 p_vout->b_grayscale = 0;
286 p_vout->b_interface = 0;
288 p_vout->b_fullscreen = 0;
289 p_vout->i_alignment = 0;
290 p_vout->render_time = 10;
291 p_vout->c_fps_samples = 0;
292 p_vout->b_filter_change = 0;
294 /* Mouse coordinates */
295 var_Create( p_vout, "mouse-x", VLC_VAR_INTEGER );
296 var_Create( p_vout, "mouse-y", VLC_VAR_INTEGER );
297 var_Create( p_vout, "mouse-button-down", VLC_VAR_INTEGER );
298 var_Create( p_vout, "mouse-moved", VLC_VAR_BOOL );
299 var_Create( p_vout, "mouse-clicked", VLC_VAR_INTEGER );
301 var_Create( p_vout, "intf-change", VLC_VAR_BOOL );
302 val.b_bool = VLC_TRUE;
303 var_Set( p_vout, "intf-change", val );
305 /* Initialize locks */
306 vlc_mutex_init( p_vout, &p_vout->picture_lock );
307 vlc_mutex_init( p_vout, &p_vout->subpicture_lock );
308 vlc_mutex_init( p_vout, &p_vout->change_lock );
310 /* Attach the new object now so we can use var inheritance below */
311 vlc_object_attach( p_vout, p_parent );
313 /* Create a few object variables we'll need later on */
314 var_Create( p_vout, "aspect-ratio", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
315 var_Create( p_vout, "width", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
316 var_Create( p_vout, "height", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
317 var_Create( p_vout, "zoom", VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
318 var_Create( p_vout, "align", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
320 p_vout->b_override_aspect = VLC_FALSE;
322 /* If the parent is not a VOUT object, that means we are at the start of
323 * the video output pipe */
324 if( p_parent->i_object_type != VLC_OBJECT_VOUT )
326 var_Get( p_vout, "aspect-ratio", &val );
328 /* Check whether the user tried to override aspect ratio */
331 unsigned int i_new_aspect = i_aspect;
332 char *psz_parser = strchr( val.psz_string, ':' );
336 *psz_parser++ = '\0';
337 i_new_aspect = atoi( val.psz_string ) * VOUT_ASPECT_FACTOR
338 / atoi( psz_parser );
342 i_new_aspect = i_width * VOUT_ASPECT_FACTOR
343 * atof( val.psz_string )
347 free( val.psz_string );
349 if( i_new_aspect && i_new_aspect != i_aspect )
351 unsigned int i_aspect_x, i_aspect_y;
353 vout_AspectRatio( i_new_aspect, &i_aspect_x, &i_aspect_y );
355 msg_Dbg( p_vout, "overriding source aspect ratio to %i:%i",
356 i_aspect_x, i_aspect_y );
358 p_vout->render.i_aspect = i_new_aspect;
360 p_vout->b_override_aspect = VLC_TRUE;
364 /* Look for the default filter configuration */
365 var_Create( p_vout, "filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
366 var_Get( p_vout, "filter", &val );
367 p_vout->psz_filter_chain = val.psz_string;
371 /* continue the parent's filter chain */
374 psz_end = strchr( ((vout_thread_t *)p_parent)->psz_filter_chain, ':' );
375 if( psz_end && *(psz_end+1) )
376 p_vout->psz_filter_chain = strdup( psz_end+1 );
377 else p_vout->psz_filter_chain = NULL;
380 /* Choose the video output module */
381 if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
383 var_Create( p_vout, "vout", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
384 var_Get( p_vout, "vout", &val );
385 psz_plugin = val.psz_string;
389 /* the filter chain is a string list of filters separated by double
393 psz_end = strchr( p_vout->psz_filter_chain, ':' );
395 psz_plugin = strndup( p_vout->psz_filter_chain,
396 psz_end - p_vout->psz_filter_chain );
397 else psz_plugin = strdup( p_vout->psz_filter_chain );
400 /* Initialize the dimensions of the video window */
401 InitWindowSize( p_vout, &p_vout->i_window_width,
402 &p_vout->i_window_height );
404 /* Create the vout thread */
405 p_vout->p_module = module_Need( p_vout,
406 ( p_vout->psz_filter_chain &&
407 *p_vout->psz_filter_chain ) ?
408 "video filter" : "video output",
411 if( psz_plugin ) free( psz_plugin );
412 if( p_vout->p_module == NULL )
414 msg_Err( p_vout, "no suitable vout module" );
415 vlc_object_destroy( p_vout );
419 p_vout->p_text_renderer_module = module_Need( p_vout, "text renderer",
421 if( p_vout->p_text_renderer_module == NULL )
423 msg_Warn( p_vout, "no suitable text renderer module" );
424 p_vout->pf_add_string = NULL;
427 /* Create a few object variables for interface interaction */
428 var_Create( p_vout, "fullscreen", VLC_VAR_BOOL );
429 text.psz_string = _("Fullscreen");
430 var_Change( p_vout, "fullscreen", VLC_VAR_SETTEXT, &text, NULL );
431 var_Change( p_vout, "fullscreen", VLC_VAR_INHERITVALUE, &val, NULL );
434 /* user requested fullscreen */
435 p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
437 var_AddCallback( p_vout, "fullscreen", FullscreenCallback, NULL );
439 var_Create( p_vout, "deinterlace", VLC_VAR_STRING | VLC_VAR_HASCHOICE );
440 text.psz_string = _("Deinterlace");
441 var_Change( p_vout, "deinterlace", VLC_VAR_SETTEXT, &text, NULL );
442 val.psz_string = ""; text.psz_string = _("Disable");
443 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
444 val.psz_string = "discard"; text.psz_string = _("Discard");
445 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
446 val.psz_string = "blend"; text.psz_string = _("Blend");
447 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
448 val.psz_string = "mean"; text.psz_string = _("Mean");
449 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
450 val.psz_string = "bob"; text.psz_string = _("Bob");
451 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
452 val.psz_string = "linear"; text.psz_string = _("Linear");
453 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
454 if( var_Get( p_vout, "deinterlace-mode", &val ) == VLC_SUCCESS )
456 var_Set( p_vout, "deinterlace", val );
457 if( val.psz_string ) free( val.psz_string );
459 var_AddCallback( p_vout, "deinterlace", DeinterlaceCallback, NULL );
462 var_Create( p_vout, "filter", VLC_VAR_STRING );
463 text.psz_string = _("Filters");
464 var_Change( p_vout, "filter", VLC_VAR_SETTEXT, &text, NULL );
465 var_Change( p_vout, "filter", VLC_VAR_INHERITVALUE, &val, NULL );
468 var_Set( p_vout, "filter", val );
469 free( val.psz_string );
471 var_AddCallback( p_vout, "filter", FilterCallback, NULL );
473 /* Calculate delay created by internal caching */
474 p_input_thread = (input_thread_t *)vlc_object_find( p_vout,
475 VLC_OBJECT_INPUT, FIND_ANYWHERE );
478 p_vout->i_pts_delay = p_input_thread->i_pts_delay;
479 vlc_object_release( p_input_thread );
483 p_vout->i_pts_delay = DEFAULT_PTS_DELAY;
486 if( vlc_thread_create( p_vout, "video output", RunThread,
487 VLC_THREAD_PRIORITY_OUTPUT, VLC_TRUE ) )
489 msg_Err( p_vout, "out of memory" );
490 module_Unneed( p_vout, p_vout->p_module );
491 vlc_object_destroy( p_vout );
498 /*****************************************************************************
499 * vout_Destroy: destroys a previously created video output
500 *****************************************************************************
501 * Destroy a terminated thread.
502 * The function will request a destruction of the specified thread. If pi_error
503 * is NULL, it will return once the thread is destroyed. Else, it will be
504 * update using one of the THREAD_* constants.
505 *****************************************************************************/
506 void vout_Destroy( vout_thread_t *p_vout )
508 vlc_object_t *p_playlist;
510 /* Request thread destruction */
511 p_vout->b_die = VLC_TRUE;
512 vlc_thread_join( p_vout );
514 var_Destroy( p_vout, "intf-change" );
516 p_playlist = vlc_object_find( p_vout, VLC_OBJECT_PLAYLIST,
519 if( p_vout->psz_filter_chain ) free( p_vout->psz_filter_chain );
522 vlc_object_destroy( p_vout );
524 /* If it was the last vout, tell the interface to show up */
525 if( p_playlist != NULL )
527 vout_thread_t *p_another_vout = vlc_object_find( p_playlist,
528 VLC_OBJECT_VOUT, FIND_ANYWHERE );
529 if( p_another_vout == NULL )
532 val.b_bool = VLC_TRUE;
533 var_Set( p_playlist, "intf-show", val );
537 vlc_object_release( p_another_vout );
539 vlc_object_release( p_playlist );
543 /*****************************************************************************
544 * InitThread: initialize video output thread
545 *****************************************************************************
546 * This function is called from RunThread and performs the second step of the
547 * initialization. It returns 0 on success. Note that the thread's flag are not
548 * modified inside this function.
549 *****************************************************************************/
550 static int InitThread( vout_thread_t *p_vout )
553 unsigned int i_aspect_x, i_aspect_y;
555 vlc_mutex_lock( &p_vout->change_lock );
561 /* Initialize output method, it allocates direct buffers for us */
562 if( p_vout->pf_init( p_vout ) )
564 vlc_mutex_unlock( &p_vout->change_lock );
568 if( !I_OUTPUTPICTURES )
570 msg_Err( p_vout, "plugin was unable to allocate at least "
571 "one direct buffer" );
572 p_vout->pf_end( p_vout );
573 vlc_mutex_unlock( &p_vout->change_lock );
577 if( I_OUTPUTPICTURES > VOUT_MAX_PICTURES )
579 msg_Err( p_vout, "plugin allocated too many direct buffers, "
580 "our internal buffers must have overflown." );
581 p_vout->pf_end( p_vout );
582 vlc_mutex_unlock( &p_vout->change_lock );
586 msg_Dbg( p_vout, "got %i direct buffer(s)", I_OUTPUTPICTURES );
589 if( !p_vout->psz_filter_chain )
591 char *psz_aspect = config_GetPsz( p_vout, "pixel-ratio" );
595 int i_new_aspect = p_vout->output.i_width * VOUT_ASPECT_FACTOR
597 / p_vout->output.i_height;
600 if( i_new_aspect && i_new_aspect != p_vout->output.i_aspect )
602 vout_AspectRatio( i_new_aspect, &i_aspect_x, &i_aspect_y );
604 msg_Dbg( p_vout, "output ratio forced to %i:%i\n",
605 i_aspect_x, i_aspect_y );
606 p_vout->output.i_aspect = i_new_aspect;
612 vout_AspectRatio( p_vout->render.i_aspect, &i_aspect_x, &i_aspect_y );
614 "picture in %ix%i, chroma 0x%.8x (%4.4s), aspect ratio %i:%i",
615 p_vout->render.i_width, p_vout->render.i_height,
616 p_vout->render.i_chroma, (char*)&p_vout->render.i_chroma,
617 i_aspect_x, i_aspect_y );
619 vout_AspectRatio( p_vout->output.i_aspect, &i_aspect_x, &i_aspect_y );
621 "picture out %ix%i, chroma 0x%.8x (%4.4s), aspect ratio %i:%i",
622 p_vout->output.i_width, p_vout->output.i_height,
623 p_vout->output.i_chroma, (char*)&p_vout->output.i_chroma,
624 i_aspect_x, i_aspect_y );
626 /* Calculate shifts from system-updated masks */
627 MaskToShift( &p_vout->output.i_lrshift, &p_vout->output.i_rrshift,
628 p_vout->output.i_rmask );
629 MaskToShift( &p_vout->output.i_lgshift, &p_vout->output.i_rgshift,
630 p_vout->output.i_gmask );
631 MaskToShift( &p_vout->output.i_lbshift, &p_vout->output.i_rbshift,
632 p_vout->output.i_bmask );
634 /* Check whether we managed to create direct buffers similar to
635 * the render buffers, ie same size and chroma */
636 if( ( p_vout->output.i_width == p_vout->render.i_width )
637 && ( p_vout->output.i_height == p_vout->render.i_height )
638 && ( vout_ChromaCmp( p_vout->output.i_chroma, p_vout->render.i_chroma ) ) )
640 /* Cool ! We have direct buffers, we can ask the decoder to
641 * directly decode into them ! Map the first render buffers to
642 * the first direct buffers, but keep the first direct buffer
643 * for memcpy operations */
644 p_vout->b_direct = 1;
646 for( i = 1; i < VOUT_MAX_PICTURES; i++ )
648 if( p_vout->p_picture[ i ].i_type != DIRECT_PICTURE &&
649 I_RENDERPICTURES >= VOUT_MIN_DIRECT_PICTURES - 1 &&
650 p_vout->p_picture[ i - 1 ].i_type == DIRECT_PICTURE )
652 /* We have enough direct buffers so there's no need to
653 * try to use system memory buffers. */
656 PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
660 msg_Dbg( p_vout, "direct render, mapping "
661 "render pictures 0-%i to system pictures 1-%i",
662 VOUT_MAX_PICTURES - 2, VOUT_MAX_PICTURES - 1 );
666 /* Rats... Something is wrong here, we could not find an output
667 * plugin able to directly render what we decode. See if we can
668 * find a chroma plugin to do the conversion */
669 p_vout->b_direct = 0;
671 /* Choose the best module */
672 p_vout->chroma.p_module = module_Need( p_vout, "chroma", NULL );
674 if( p_vout->chroma.p_module == NULL )
676 msg_Err( p_vout, "no chroma module for %4.4s to %4.4s",
677 (char*)&p_vout->render.i_chroma,
678 (char*)&p_vout->output.i_chroma );
679 p_vout->pf_end( p_vout );
680 vlc_mutex_unlock( &p_vout->change_lock );
684 msg_Dbg( p_vout, "indirect render, mapping "
685 "render pictures 0-%i to system pictures %i-%i",
686 VOUT_MAX_PICTURES - 1, I_OUTPUTPICTURES,
687 I_OUTPUTPICTURES + VOUT_MAX_PICTURES - 1 );
689 /* Append render buffers after the direct buffers */
690 for( i = I_OUTPUTPICTURES; i < 2 * VOUT_MAX_PICTURES; i++ )
692 PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
695 /* Check if we have enough render pictures */
696 if( I_RENDERPICTURES == VOUT_MAX_PICTURES )
701 /* Link pictures back to their heap */
702 for( i = 0 ; i < I_RENDERPICTURES ; i++ )
704 PP_RENDERPICTURE[ i ]->p_heap = &p_vout->render;
707 for( i = 0 ; i < I_OUTPUTPICTURES ; i++ )
709 PP_OUTPUTPICTURE[ i ]->p_heap = &p_vout->output;
712 /* XXX XXX mark thread ready */
716 /*****************************************************************************
717 * RunThread: video output thread
718 *****************************************************************************
719 * Video output thread. This function does only returns when the thread is
720 * terminated. It handles the pictures arriving in the video heap and the
721 * display device events.
722 *****************************************************************************/
723 static void RunThread( vout_thread_t *p_vout)
725 int i_index; /* index in heap */
726 int i_idle_loops = 0; /* loops without displaying a picture */
727 mtime_t current_date; /* current date */
728 mtime_t display_date; /* display date */
730 picture_t * p_picture; /* picture pointer */
731 picture_t * p_last_picture = NULL; /* last picture */
732 picture_t * p_directbuffer; /* direct buffer to display */
734 subpicture_t * p_subpic; /* subpicture pointer */
739 p_vout->b_error = InitThread( p_vout );
741 /* signal the creation of the vout */
742 vlc_thread_ready( p_vout );
744 if( p_vout->b_error )
746 /* Destroy thread structures allocated by Create and InitThread */
747 DestroyThread( p_vout );
752 * Main loop - it is not executed if an error occured during
755 while( (!p_vout->b_die) && (!p_vout->b_error) )
757 /* Initialize loop variables */
760 current_date = mdate();
764 if( !(p_vout->c_loops % VOUT_STATS_NB_LOOPS) )
766 msg_Dbg( p_vout, "picture heap: %d/%d",
767 I_RENDERPICTURES, p_vout->i_heap_size );
772 * Find the picture to display (the one with the earliest date).
773 * This operation does not need lock, since only READY_PICTUREs
775 for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
777 if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
778 && ( (p_picture == NULL) ||
779 (PP_RENDERPICTURE[i_index]->date < display_date) ) )
781 p_picture = PP_RENDERPICTURE[i_index];
782 display_date = p_picture->date;
788 /* If we met the last picture, parse again to see whether there is
789 * a more appropriate one. */
790 if( p_picture == p_last_picture )
792 for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
794 if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
795 && (PP_RENDERPICTURE[i_index] != p_last_picture)
796 && ((p_picture == p_last_picture) ||
797 (PP_RENDERPICTURE[i_index]->date < display_date)) )
799 p_picture = PP_RENDERPICTURE[i_index];
800 display_date = p_picture->date;
805 /* If we found better than the last picture, destroy it */
806 if( p_last_picture && p_picture != p_last_picture )
808 vlc_mutex_lock( &p_vout->picture_lock );
809 if( p_last_picture->i_refcount )
811 p_last_picture->i_status = DISPLAYED_PICTURE;
815 p_last_picture->i_status = DESTROYED_PICTURE;
816 p_vout->i_heap_size--;
818 vlc_mutex_unlock( &p_vout->picture_lock );
819 p_last_picture = NULL;
822 /* Compute FPS rate */
823 p_vout->p_fps_sample[ p_vout->c_fps_samples++ % VOUT_FPS_SAMPLES ]
826 if( !p_picture->b_force &&
827 p_picture != p_last_picture &&
828 display_date < current_date + p_vout->render_time )
830 /* Picture is late: it will be destroyed and the thread
831 * will directly choose the next picture */
832 vlc_mutex_lock( &p_vout->picture_lock );
833 if( p_picture->i_refcount )
835 /* Pretend we displayed the picture, but don't destroy
836 * it since the decoder might still need it. */
837 p_picture->i_status = DISPLAYED_PICTURE;
841 /* Destroy the picture without displaying it */
842 p_picture->i_status = DESTROYED_PICTURE;
843 p_vout->i_heap_size--;
845 msg_Warn( p_vout, "late picture skipped ("I64Fd")",
846 current_date - display_date );
847 vlc_mutex_unlock( &p_vout->picture_lock );
853 current_date + p_vout->i_pts_delay + VOUT_BOGUS_DELAY )
855 /* Picture is waaay too early: it will be destroyed */
856 vlc_mutex_lock( &p_vout->picture_lock );
857 if( p_picture->i_refcount )
859 /* Pretend we displayed the picture, but don't destroy
860 * it since the decoder might still need it. */
861 p_picture->i_status = DISPLAYED_PICTURE;
865 /* Destroy the picture without displaying it */
866 p_picture->i_status = DESTROYED_PICTURE;
867 p_vout->i_heap_size--;
869 msg_Warn( p_vout, "vout warning: early picture skipped "
870 "("I64Fd")", display_date - current_date
871 - p_vout->i_pts_delay );
872 vlc_mutex_unlock( &p_vout->picture_lock );
877 if( display_date > current_date + VOUT_DISPLAY_DELAY )
879 /* A picture is ready to be rendered, but its rendering date
880 * is far from the current one so the thread will perform an
881 * empty loop as if no picture were found. The picture state
886 else if( p_picture == p_last_picture )
888 /* We are asked to repeat the previous picture, but we first
889 * wait for a couple of idle loops */
890 if( i_idle_loops < 4 )
897 /* We set the display date to something high, otherwise
898 * we'll have lots of problems with late pictures */
899 display_date = current_date + p_vout->render_time;
904 if( p_picture == NULL )
910 * Check for subpictures to display
912 p_subpic = vout_SortSubPictures( p_vout, display_date );
917 p_directbuffer = vout_RenderPicture( p_vout, p_picture, p_subpic );
920 * Call the plugin-specific rendering method if there is one
922 if( p_picture != NULL && p_directbuffer != NULL && p_vout->pf_render )
924 /* Render the direct buffer returned by vout_RenderPicture */
925 p_vout->pf_render( p_vout, p_directbuffer );
931 if( display_date != 0 && p_directbuffer != NULL )
933 mtime_t current_render_time = mdate() - current_date;
934 /* if render time is very large we don't include it in the mean */
935 if( current_render_time < p_vout->render_time +
938 /* Store render time using a sliding mean weighting to
939 * current value in a 3 to 1 ratio*/
940 p_vout->render_time *= 3;
941 p_vout->render_time += current_render_time;
942 p_vout->render_time >>= 2;
946 /* Give back change lock */
947 vlc_mutex_unlock( &p_vout->change_lock );
949 /* Sleep a while or until a given date */
950 if( display_date != 0 )
952 /* If there are filters in the chain, better give them the picture
954 if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
956 mwait( display_date - VOUT_MWAIT_TOLERANCE );
961 msleep( VOUT_IDLE_SLEEP );
964 /* On awakening, take back lock and send immediately picture
966 vlc_mutex_lock( &p_vout->change_lock );
969 * Display the previously rendered picture
971 if( p_picture != NULL && p_directbuffer != NULL )
973 /* Display the direct buffer returned by vout_RenderPicture */
974 if( p_vout->pf_display )
976 p_vout->pf_display( p_vout, p_directbuffer );
979 /* Reinitialize idle loop count */
982 /* Tell the vout this was the last picture and that it does not
983 * need to be forced anymore. */
984 p_last_picture = p_picture;
985 p_last_picture->b_force = 0;
989 * Check events and manage thread
991 if( p_vout->pf_manage && p_vout->pf_manage( p_vout ) )
993 /* A fatal error occured, and the thread must terminate
994 * immediately, without displaying anything - setting b_error to 1
995 * causes the immediate end of the main while() loop. */
999 if( p_vout->i_changes & VOUT_SIZE_CHANGE )
1001 /* this must only happen when the vout plugin is incapable of
1002 * rescaling the picture itself. In this case we need to destroy
1003 * the current picture buffers and recreate new ones with the right
1007 p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
1009 p_vout->pf_end( p_vout );
1010 for( i = 0; i < I_OUTPUTPICTURES; i++ )
1011 p_vout->p_picture[ i ].i_status = FREE_PICTURE;
1013 I_OUTPUTPICTURES = 0;
1014 if( p_vout->pf_init( p_vout ) )
1016 msg_Err( p_vout, "cannot resize display" );
1017 /* FIXME: pf_end will be called again in EndThread() */
1018 p_vout->b_error = 1;
1021 /* Need to reinitialise the chroma plugin */
1022 if( p_vout->chroma.p_module )
1024 if( p_vout->chroma.p_module->pf_deactivate )
1025 p_vout->chroma.p_module->pf_deactivate( VLC_OBJECT(p_vout) );
1026 p_vout->chroma.p_module->pf_activate( VLC_OBJECT(p_vout) );
1030 if( p_vout->i_changes & VOUT_PICTURE_BUFFERS_CHANGE )
1032 /* This happens when the picture buffers need to be recreated.
1033 * This is useful on multimonitor displays for instance.
1035 * Warning: This only works when the vout creates only 1 picture
1037 p_vout->i_changes &= ~VOUT_PICTURE_BUFFERS_CHANGE;
1039 if( !p_vout->b_direct )
1041 module_Unneed( p_vout, p_vout->chroma.p_module );
1044 vlc_mutex_lock( &p_vout->picture_lock );
1046 p_vout->pf_end( p_vout );
1048 I_OUTPUTPICTURES = I_RENDERPICTURES = 0;
1050 p_vout->b_error = InitThread( p_vout );
1052 vlc_mutex_unlock( &p_vout->picture_lock );
1057 * Error loop - wait until the thread destruction is requested
1059 if( p_vout->b_error )
1061 ErrorThread( p_vout );
1065 EndThread( p_vout );
1067 /* Destroy thread structures allocated by CreateThread */
1068 DestroyThread( p_vout );
1071 /*****************************************************************************
1072 * ErrorThread: RunThread() error loop
1073 *****************************************************************************
1074 * This function is called when an error occured during thread main's loop. The
1075 * thread can still receive feed, but must be ready to terminate as soon as
1077 *****************************************************************************/
1078 static void ErrorThread( vout_thread_t *p_vout )
1080 /* Wait until a `die' order */
1081 while( !p_vout->b_die )
1084 msleep( VOUT_IDLE_SLEEP );
1088 /*****************************************************************************
1089 * EndThread: thread destruction
1090 *****************************************************************************
1091 * This function is called when the thread ends after a sucessful
1092 * initialization. It frees all ressources allocated by InitThread.
1093 *****************************************************************************/
1094 static void EndThread( vout_thread_t *p_vout )
1096 int i_index; /* index in heap */
1100 struct tms cpu_usage;
1101 times( &cpu_usage );
1103 msg_Dbg( p_vout, "cpu usage (user: %d, system: %d)",
1104 cpu_usage.tms_utime, cpu_usage.tms_stime );
1108 if( !p_vout->b_direct )
1110 module_Unneed( p_vout, p_vout->chroma.p_module );
1113 /* Destroy all remaining pictures */
1114 for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES; i_index++ )
1116 if ( p_vout->p_picture[i_index].i_type == MEMORY_PICTURE )
1118 free( p_vout->p_picture[i_index].p_data_orig );
1122 /* Destroy all remaining subpictures */
1123 for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
1125 if( p_vout->p_subpicture[i_index].i_status != FREE_SUBPICTURE )
1127 vout_DestroySubPicture( p_vout,
1128 &p_vout->p_subpicture[i_index] );
1132 if( p_vout->p_text_renderer_module )
1133 module_Unneed( p_vout, p_vout->p_text_renderer_module );
1135 /* Destroy translation tables */
1136 p_vout->pf_end( p_vout );
1138 /* Release the change lock */
1139 vlc_mutex_unlock( &p_vout->change_lock );
1142 /*****************************************************************************
1143 * DestroyThread: thread destruction
1144 *****************************************************************************
1145 * This function is called when the thread ends. It frees all ressources
1146 * allocated by CreateThread. Status is available at this stage.
1147 *****************************************************************************/
1148 static void DestroyThread( vout_thread_t *p_vout )
1150 /* Destroy the locks */
1151 vlc_mutex_destroy( &p_vout->picture_lock );
1152 vlc_mutex_destroy( &p_vout->subpicture_lock );
1153 vlc_mutex_destroy( &p_vout->change_lock );
1155 /* Release the module */
1156 module_Unneed( p_vout, p_vout->p_module );
1159 /* following functions are local */
1161 static int ReduceHeight( int i_ratio )
1163 int i_dummy = VOUT_ASPECT_FACTOR;
1171 /* VOUT_ASPECT_FACTOR is (2^7 * 3^3 * 5^3), we just check for 2, 3 and 5 */
1172 while( !(i_ratio & 1) && !(i_dummy & 1) )
1179 while( !(i_ratio % 3) && !(i_dummy % 3) )
1186 while( !(i_ratio % 5) && !(i_dummy % 5) )
1196 /*****************************************************************************
1197 * BinaryLog: computes the base 2 log of a binary value
1198 *****************************************************************************
1199 * This functions is used by MaskToShift, to get a bit index from a binary
1201 *****************************************************************************/
1202 static int BinaryLog( uint32_t i )
1206 if( i == 0 ) return -31337;
1208 if( i & 0xffff0000 ) i_log += 16;
1209 if( i & 0xff00ff00 ) i_log += 8;
1210 if( i & 0xf0f0f0f0 ) i_log += 4;
1211 if( i & 0xcccccccc ) i_log += 2;
1212 if( i & 0xaaaaaaaa ) i_log += 1;
1217 /*****************************************************************************
1218 * MaskToShift: transform a color mask into right and left shifts
1219 *****************************************************************************
1220 * This function is used for obtaining color shifts from masks.
1221 *****************************************************************************/
1222 static void MaskToShift( int *pi_left, int *pi_right, uint32_t i_mask )
1224 uint32_t i_low, i_high; /* lower hand higher bits of the mask */
1228 *pi_left = *pi_right = 0;
1233 i_low = i_mask & (- (int32_t)i_mask); /* lower bit of the mask */
1234 i_high = i_mask + i_low; /* higher bit of the mask */
1236 /* Transform bits into an index */
1237 i_low = BinaryLog (i_low);
1238 i_high = BinaryLog (i_high);
1240 /* Update pointers and return */
1242 *pi_right = (8 - i_high + i_low);
1245 /*****************************************************************************
1246 * InitWindowSize: find the initial dimensions the video window should have.
1247 *****************************************************************************
1248 * This function will check the "width", "height" and "zoom" config options and
1249 * will calculate the size that the video window should have.
1250 *****************************************************************************/
1251 static void InitWindowSize( vout_thread_t *p_vout, int *pi_width,
1255 int i_width, i_height;
1258 #define FP_FACTOR 1000 /* our fixed point factor */
1260 var_Get( p_vout, "align", &val );
1261 p_vout->i_alignment = val.i_int;
1263 var_Get( p_vout, "width", &val );
1264 i_width = val.i_int;
1265 var_Get( p_vout, "height", &val );
1266 i_height = val.i_int;
1267 var_Get( p_vout, "zoom", &val );
1268 ll_zoom = (uint64_t)( FP_FACTOR * val.f_float );
1270 if( i_width > 0 && i_height > 0)
1272 *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
1273 *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
1276 else if( i_width > 0 )
1278 *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
1279 *pi_height = (int)( i_width * ll_zoom * VOUT_ASPECT_FACTOR /
1280 p_vout->render.i_aspect / FP_FACTOR );
1283 else if( i_height > 0 )
1285 *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
1286 *pi_width = (int)( i_height * ll_zoom * p_vout->render.i_aspect /
1287 VOUT_ASPECT_FACTOR / FP_FACTOR );
1291 if( p_vout->render.i_height * p_vout->render.i_aspect
1292 >= p_vout->render.i_width * VOUT_ASPECT_FACTOR )
1294 *pi_width = (int)( p_vout->render.i_height * ll_zoom
1295 * p_vout->render.i_aspect / VOUT_ASPECT_FACTOR / FP_FACTOR );
1296 *pi_height = (int)( p_vout->render.i_height * ll_zoom / FP_FACTOR );
1300 *pi_width = (int)( p_vout->render.i_width * ll_zoom / FP_FACTOR );
1301 *pi_height = (int)( p_vout->render.i_width * ll_zoom
1302 * VOUT_ASPECT_FACTOR / p_vout->render.i_aspect / FP_FACTOR );
1308 /*****************************************************************************
1309 * vout_VarCallback: generic callback for intf variables
1310 *****************************************************************************/
1311 int vout_VarCallback( vlc_object_t * p_this, const char * psz_variable,
1312 vlc_value_t old_value, vlc_value_t new_value,
1315 vout_thread_t * p_vout = (vout_thread_t *)p_this;
1317 val.b_bool = VLC_TRUE;
1318 var_Set( p_vout, "intf-change", val );
1322 /*****************************************************************************
1323 * object variables callbacks: a bunch of object variables are used by the
1324 * interfaces to interact with the vout.
1325 *****************************************************************************/
1326 static int FullscreenCallback( vlc_object_t *p_this, char const *psz_cmd,
1327 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1329 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1330 input_thread_t *p_input;
1333 p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
1335 p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1339 /* Modify input as well because the vout might have to be restarted */
1340 var_Create( p_input, "fullscreen", VLC_VAR_BOOL );
1341 var_Set( p_input, "fullscreen", newval );
1343 vlc_object_release( p_input );
1346 val.b_bool = VLC_TRUE;
1347 var_Set( p_vout, "intf-change", val );
1351 static int DeinterlaceCallback( vlc_object_t *p_this, char const *psz_cmd,
1352 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1354 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1355 input_thread_t *p_input;
1358 char *psz_mode = newval.psz_string;
1362 psz_filter = config_GetPsz( p_vout, "filter" );
1364 if( !psz_mode || !*psz_mode )
1366 config_PutPsz( p_vout, "filter", "" );
1370 if( !psz_filter || !*psz_filter )
1372 config_PutPsz( p_vout, "filter", "deinterlace" );
1376 if( strstr( psz_filter, "deinterlace" ) == NULL )
1378 psz_filter = realloc( psz_filter, strlen( psz_filter ) + 20 );
1379 strcat( psz_filter, ",deinterlace" );
1381 config_PutPsz( p_vout, "filter", psz_filter );
1385 if( psz_filter ) free( psz_filter );
1388 p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1390 if( !p_input ) return VLC_EGENERIC;
1392 if( psz_mode && *psz_mode )
1394 val.psz_string = psz_mode;
1395 var_Set( p_vout, "deinterlace-mode", val );
1396 /* Modify input as well because the vout might have to be restarted */
1397 var_Create( p_input, "deinterlace-mode", VLC_VAR_STRING );
1398 var_Set( p_input, "deinterlace-mode", val );
1401 /* now restart all video streams */
1402 vlc_mutex_lock( &p_input->stream.stream_lock );
1404 p_vout->b_filter_change = VLC_TRUE;
1406 #define ES p_input->stream.pp_es[i]
1408 for( i = 0 ; i < p_input->stream.i_es_number ; i++ )
1410 if( ( ES->i_cat == VIDEO_ES ) && ES->p_dec != NULL )
1412 input_UnselectES( p_input, ES );
1413 input_SelectES( p_input, ES );
1417 vlc_mutex_unlock( &p_input->stream.stream_lock );
1419 vlc_object_release( p_input );
1421 val.b_bool = VLC_TRUE;
1422 var_Set( p_vout, "intf-change", val );
1426 static int FilterCallback( vlc_object_t *p_this, char const *psz_cmd,
1427 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1429 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1430 input_thread_t *p_input;
1434 p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1439 msg_Err( p_vout, "Input not found" );
1440 return( VLC_EGENERIC );
1442 /* Restart the video stream */
1443 vlc_mutex_lock( &p_input->stream.stream_lock );
1445 p_vout->b_filter_change = VLC_TRUE;
1447 #define ES p_input->stream.pp_es[i]
1449 for( i = 0 ; i < p_input->stream.i_es_number ; i++ )
1451 if( ( ES->i_cat == VIDEO_ES ) && ES->p_dec != NULL )
1453 input_UnselectES( p_input, ES );
1454 input_SelectES( p_input, ES );
1458 vlc_mutex_unlock( &p_input->stream.stream_lock );
1460 vlc_object_release( p_input );
1462 val.b_bool = VLC_TRUE;
1463 var_Set( p_vout, "intf-change", val );