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 void vout_IntfInit( vout_thread_t * );
62 /* Object variables callbacks */
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 + 1; 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;
245 p_vout->p_picture[i_index].b_slow = 0;
248 for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++)
250 p_vout->p_subpicture[i_index].i_status = FREE_SUBPICTURE;
251 p_vout->p_subpicture[i_index].i_type = EMPTY_SUBPICTURE;
254 /* No images in the heap */
255 p_vout->i_heap_size = 0;
257 /* Register the default subpicture channel */
258 p_vout->p_default_channel = NULL;
259 p_vout->i_channel_count = 1;
261 /* Initialize the rendering heap */
262 I_RENDERPICTURES = 0;
263 p_vout->render.i_width = i_width;
264 p_vout->render.i_height = i_height;
265 p_vout->render.i_chroma = i_chroma;
266 p_vout->render.i_aspect = i_aspect;
268 p_vout->render.i_rmask = 0;
269 p_vout->render.i_gmask = 0;
270 p_vout->render.i_bmask = 0;
272 p_vout->render.i_last_used_pic = -1;
273 p_vout->render.b_allow_modify_pics = 1;
275 /* Zero the output heap */
276 I_OUTPUTPICTURES = 0;
277 p_vout->output.i_width = 0;
278 p_vout->output.i_height = 0;
279 p_vout->output.i_chroma = 0;
280 p_vout->output.i_aspect = 0;
282 p_vout->output.i_rmask = 0;
283 p_vout->output.i_gmask = 0;
284 p_vout->output.i_bmask = 0;
286 /* Initialize misc stuff */
287 p_vout->i_changes = 0;
289 p_vout->b_grayscale = 0;
291 p_vout->b_interface = 0;
293 p_vout->b_fullscreen = 0;
294 p_vout->i_alignment = 0;
295 p_vout->render_time = 10;
296 p_vout->c_fps_samples = 0;
297 p_vout->b_filter_change = 0;
298 p_vout->pf_control = 0;
299 p_vout->p_parent_intf = 0;
301 /* Mouse coordinates */
302 var_Create( p_vout, "mouse-x", VLC_VAR_INTEGER );
303 var_Create( p_vout, "mouse-y", VLC_VAR_INTEGER );
304 var_Create( p_vout, "mouse-button-down", VLC_VAR_INTEGER );
305 var_Create( p_vout, "mouse-moved", VLC_VAR_BOOL );
306 var_Create( p_vout, "mouse-clicked", VLC_VAR_INTEGER );
308 var_Create( p_vout, "intf-change", VLC_VAR_BOOL );
309 val.b_bool = VLC_TRUE;
310 var_Set( p_vout, "intf-change", val );
312 /* Initialize locks */
313 vlc_mutex_init( p_vout, &p_vout->picture_lock );
314 vlc_mutex_init( p_vout, &p_vout->subpicture_lock );
315 vlc_mutex_init( p_vout, &p_vout->change_lock );
317 /* Attach the new object now so we can use var inheritance below */
318 vlc_object_attach( p_vout, p_parent );
320 /* Take care of some "interface/control" related initialisations */
321 vout_IntfInit( p_vout );
323 p_vout->b_override_aspect = VLC_FALSE;
325 /* If the parent is not a VOUT object, that means we are at the start of
326 * the video output pipe */
327 if( p_parent->i_object_type != VLC_OBJECT_VOUT )
329 var_Get( p_vout, "aspect-ratio", &val );
331 /* Check whether the user tried to override aspect ratio */
334 unsigned int i_new_aspect = i_aspect;
335 char *psz_parser = strchr( val.psz_string, ':' );
339 *psz_parser++ = '\0';
340 i_new_aspect = atoi( val.psz_string ) * VOUT_ASPECT_FACTOR
341 / atoi( psz_parser );
345 i_new_aspect = i_width * VOUT_ASPECT_FACTOR
346 * atof( val.psz_string )
350 free( val.psz_string );
352 if( i_new_aspect && i_new_aspect != i_aspect )
354 unsigned int i_aspect_x, i_aspect_y;
356 vout_AspectRatio( i_new_aspect, &i_aspect_x, &i_aspect_y );
358 msg_Dbg( p_vout, "overriding source aspect ratio to %i:%i",
359 i_aspect_x, i_aspect_y );
361 p_vout->render.i_aspect = i_new_aspect;
363 p_vout->b_override_aspect = VLC_TRUE;
367 /* Look for the default filter configuration */
368 var_Create( p_vout, "filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
369 var_Get( p_vout, "filter", &val );
370 p_vout->psz_filter_chain = val.psz_string;
374 /* continue the parent's filter chain */
377 psz_end = strchr( ((vout_thread_t *)p_parent)->psz_filter_chain, ':' );
378 if( psz_end && *(psz_end+1) )
379 p_vout->psz_filter_chain = strdup( psz_end+1 );
380 else p_vout->psz_filter_chain = NULL;
383 /* Choose the video output module */
384 if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
386 var_Create( p_vout, "vout", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
387 var_Get( p_vout, "vout", &val );
388 psz_plugin = val.psz_string;
392 /* the filter chain is a string list of filters separated by double
396 psz_end = strchr( p_vout->psz_filter_chain, ':' );
398 psz_plugin = strndup( p_vout->psz_filter_chain,
399 psz_end - p_vout->psz_filter_chain );
400 else psz_plugin = strdup( p_vout->psz_filter_chain );
403 /* Initialize the dimensions of the video window */
404 InitWindowSize( p_vout, &p_vout->i_window_width,
405 &p_vout->i_window_height );
407 /* Create the vout thread */
408 p_vout->p_module = module_Need( p_vout,
409 ( p_vout->psz_filter_chain && *p_vout->psz_filter_chain ) ?
410 "video filter" : "video output", psz_plugin, 0 );
412 if( psz_plugin ) free( psz_plugin );
413 if( p_vout->p_module == NULL )
415 msg_Err( p_vout, "no suitable vout module" );
416 vlc_object_detach( p_vout );
417 vlc_object_destroy( p_vout );
421 p_vout->p_text_renderer_module =
422 module_Need( p_vout, "text renderer", NULL, 0 );
423 if( p_vout->p_text_renderer_module == NULL )
425 msg_Warn( p_vout, "no suitable text renderer module" );
426 p_vout->pf_add_string = NULL;
429 /* Create a few object variables for interface interaction */
430 var_Create( p_vout, "deinterlace", VLC_VAR_STRING | VLC_VAR_HASCHOICE );
431 text.psz_string = _("Deinterlace");
432 var_Change( p_vout, "deinterlace", VLC_VAR_SETTEXT, &text, NULL );
433 val.psz_string = ""; text.psz_string = _("Disable");
434 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
435 val.psz_string = "discard"; text.psz_string = _("Discard");
436 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
437 val.psz_string = "blend"; text.psz_string = _("Blend");
438 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
439 val.psz_string = "mean"; text.psz_string = _("Mean");
440 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
441 val.psz_string = "bob"; text.psz_string = _("Bob");
442 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
443 val.psz_string = "linear"; text.psz_string = _("Linear");
444 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
445 if( var_Get( p_vout, "deinterlace-mode", &val ) == VLC_SUCCESS )
447 var_Set( p_vout, "deinterlace", val );
448 if( val.psz_string ) free( val.psz_string );
450 var_AddCallback( p_vout, "deinterlace", DeinterlaceCallback, NULL );
453 var_Create( p_vout, "filter", VLC_VAR_STRING );
454 text.psz_string = _("Filters");
455 var_Change( p_vout, "filter", VLC_VAR_SETTEXT, &text, NULL );
456 var_Change( p_vout, "filter", VLC_VAR_INHERITVALUE, &val, NULL );
459 var_Set( p_vout, "filter", val );
460 free( val.psz_string );
462 var_AddCallback( p_vout, "filter", FilterCallback, NULL );
464 /* Calculate delay created by internal caching */
465 p_input_thread = (input_thread_t *)vlc_object_find( p_vout,
466 VLC_OBJECT_INPUT, FIND_ANYWHERE );
469 p_vout->i_pts_delay = p_input_thread->i_pts_delay;
470 vlc_object_release( p_input_thread );
474 p_vout->i_pts_delay = DEFAULT_PTS_DELAY;
477 if( vlc_thread_create( p_vout, "video output", RunThread,
478 VLC_THREAD_PRIORITY_OUTPUT, VLC_TRUE ) )
480 msg_Err( p_vout, "out of memory" );
481 module_Unneed( p_vout, p_vout->p_module );
482 vlc_object_detach( p_vout );
483 vlc_object_destroy( p_vout );
487 if( p_vout->b_error )
489 msg_Err( p_vout, "video output creation failed" );
491 /* Make sure the thread is destroyed */
492 p_vout->b_die = VLC_TRUE;
494 if( p_vout->p_text_renderer_module )
496 module_Unneed( p_vout, p_vout->p_text_renderer_module );
498 vlc_thread_join( p_vout );
500 vlc_object_detach( p_vout );
501 vlc_object_destroy( p_vout );
508 /*****************************************************************************
509 * vout_Destroy: destroys a previously created video output
510 *****************************************************************************
511 * Destroy a terminated thread.
512 * The function will request a destruction of the specified thread. If pi_error
513 * is NULL, it will return once the thread is destroyed. Else, it will be
514 * update using one of the THREAD_* constants.
515 *****************************************************************************/
516 void vout_Destroy( vout_thread_t *p_vout )
518 vlc_object_t *p_playlist;
520 /* Request thread destruction */
521 p_vout->b_die = VLC_TRUE;
522 vlc_thread_join( p_vout );
524 var_Destroy( p_vout, "intf-change" );
526 p_playlist = vlc_object_find( p_vout, VLC_OBJECT_PLAYLIST,
529 if( p_vout->psz_filter_chain ) free( p_vout->psz_filter_chain );
532 vlc_object_destroy( p_vout );
534 /* If it was the last vout, tell the interface to show up */
535 if( p_playlist != NULL )
537 vout_thread_t *p_another_vout = vlc_object_find( p_playlist,
538 VLC_OBJECT_VOUT, FIND_ANYWHERE );
539 if( p_another_vout == NULL )
542 val.b_bool = VLC_TRUE;
543 var_Set( p_playlist, "intf-show", val );
547 vlc_object_release( p_another_vout );
549 vlc_object_release( p_playlist );
553 /*****************************************************************************
554 * InitThread: initialize video output thread
555 *****************************************************************************
556 * This function is called from RunThread and performs the second step of the
557 * initialization. It returns 0 on success. Note that the thread's flag are not
558 * modified inside this function.
559 *****************************************************************************/
560 static int InitThread( vout_thread_t *p_vout )
563 unsigned int i_aspect_x, i_aspect_y;
565 vlc_mutex_lock( &p_vout->change_lock );
571 /* Initialize output method, it allocates direct buffers for us */
572 if( p_vout->pf_init( p_vout ) )
574 vlc_mutex_unlock( &p_vout->change_lock );
578 if( !I_OUTPUTPICTURES )
580 msg_Err( p_vout, "plugin was unable to allocate at least "
581 "one direct buffer" );
582 p_vout->pf_end( p_vout );
583 vlc_mutex_unlock( &p_vout->change_lock );
587 if( I_OUTPUTPICTURES > VOUT_MAX_PICTURES )
589 msg_Err( p_vout, "plugin allocated too many direct buffers, "
590 "our internal buffers must have overflown." );
591 p_vout->pf_end( p_vout );
592 vlc_mutex_unlock( &p_vout->change_lock );
596 msg_Dbg( p_vout, "got %i direct buffer(s)", I_OUTPUTPICTURES );
599 if( !p_vout->psz_filter_chain )
601 char *psz_aspect = config_GetPsz( p_vout, "pixel-ratio" );
605 int i_new_aspect = p_vout->output.i_width * VOUT_ASPECT_FACTOR
607 / p_vout->output.i_height;
610 if( i_new_aspect && i_new_aspect != p_vout->output.i_aspect )
612 vout_AspectRatio( i_new_aspect, &i_aspect_x, &i_aspect_y );
614 msg_Dbg( p_vout, "output ratio forced to %i:%i\n",
615 i_aspect_x, i_aspect_y );
616 p_vout->output.i_aspect = i_new_aspect;
622 vout_AspectRatio( p_vout->render.i_aspect, &i_aspect_x, &i_aspect_y );
624 "picture in %ix%i, chroma 0x%.8x (%4.4s), aspect ratio %i:%i",
625 p_vout->render.i_width, p_vout->render.i_height,
626 p_vout->render.i_chroma, (char*)&p_vout->render.i_chroma,
627 i_aspect_x, i_aspect_y );
629 vout_AspectRatio( p_vout->output.i_aspect, &i_aspect_x, &i_aspect_y );
631 "picture out %ix%i, chroma 0x%.8x (%4.4s), aspect ratio %i:%i",
632 p_vout->output.i_width, p_vout->output.i_height,
633 p_vout->output.i_chroma, (char*)&p_vout->output.i_chroma,
634 i_aspect_x, i_aspect_y );
636 /* Calculate shifts from system-updated masks */
637 MaskToShift( &p_vout->output.i_lrshift, &p_vout->output.i_rrshift,
638 p_vout->output.i_rmask );
639 MaskToShift( &p_vout->output.i_lgshift, &p_vout->output.i_rgshift,
640 p_vout->output.i_gmask );
641 MaskToShift( &p_vout->output.i_lbshift, &p_vout->output.i_rbshift,
642 p_vout->output.i_bmask );
644 /* Check whether we managed to create direct buffers similar to
645 * the render buffers, ie same size and chroma */
646 if( ( p_vout->output.i_width == p_vout->render.i_width )
647 && ( p_vout->output.i_height == p_vout->render.i_height )
648 && ( vout_ChromaCmp( p_vout->output.i_chroma, p_vout->render.i_chroma ) ) )
650 /* Cool ! We have direct buffers, we can ask the decoder to
651 * directly decode into them ! Map the first render buffers to
652 * the first direct buffers, but keep the first direct buffer
653 * for memcpy operations */
654 p_vout->b_direct = 1;
656 for( i = 1; i < VOUT_MAX_PICTURES; i++ )
658 if( p_vout->p_picture[ i ].i_type != DIRECT_PICTURE &&
659 I_RENDERPICTURES >= VOUT_MIN_DIRECT_PICTURES - 1 &&
660 p_vout->p_picture[ i - 1 ].i_type == DIRECT_PICTURE )
662 /* We have enough direct buffers so there's no need to
663 * try to use system memory buffers. */
666 PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
670 msg_Dbg( p_vout, "direct render, mapping "
671 "render pictures 0-%i to system pictures 1-%i",
672 VOUT_MAX_PICTURES - 2, VOUT_MAX_PICTURES - 1 );
676 /* Rats... Something is wrong here, we could not find an output
677 * plugin able to directly render what we decode. See if we can
678 * find a chroma plugin to do the conversion */
679 p_vout->b_direct = 0;
681 /* Choose the best module */
682 p_vout->chroma.p_module = module_Need( p_vout, "chroma", NULL, 0 );
684 if( p_vout->chroma.p_module == NULL )
686 msg_Err( p_vout, "no chroma module for %4.4s to %4.4s",
687 (char*)&p_vout->render.i_chroma,
688 (char*)&p_vout->output.i_chroma );
689 p_vout->pf_end( p_vout );
690 vlc_mutex_unlock( &p_vout->change_lock );
694 msg_Dbg( p_vout, "indirect render, mapping "
695 "render pictures 0-%i to system pictures %i-%i",
696 VOUT_MAX_PICTURES - 1, I_OUTPUTPICTURES,
697 I_OUTPUTPICTURES + VOUT_MAX_PICTURES - 1 );
699 /* Append render buffers after the direct buffers */
700 for( i = I_OUTPUTPICTURES; i < 2 * VOUT_MAX_PICTURES; i++ )
702 PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
705 /* Check if we have enough render pictures */
706 if( I_RENDERPICTURES == VOUT_MAX_PICTURES )
711 /* Link pictures back to their heap */
712 for( i = 0 ; i < I_RENDERPICTURES ; i++ )
714 PP_RENDERPICTURE[ i ]->p_heap = &p_vout->render;
717 for( i = 0 ; i < I_OUTPUTPICTURES ; i++ )
719 PP_OUTPUTPICTURE[ i ]->p_heap = &p_vout->output;
722 /* XXX XXX mark thread ready */
726 /*****************************************************************************
727 * RunThread: video output thread
728 *****************************************************************************
729 * Video output thread. This function does only returns when the thread is
730 * terminated. It handles the pictures arriving in the video heap and the
731 * display device events.
732 *****************************************************************************/
733 static void RunThread( vout_thread_t *p_vout)
735 int i_index; /* index in heap */
736 int i_idle_loops = 0; /* loops without displaying a picture */
737 mtime_t current_date; /* current date */
738 mtime_t display_date; /* display date */
740 picture_t * p_picture; /* picture pointer */
741 picture_t * p_last_picture = NULL; /* last picture */
742 picture_t * p_directbuffer; /* direct buffer to display */
744 subpicture_t * p_subpic; /* subpicture pointer */
749 p_vout->b_error = InitThread( p_vout );
751 /* signal the creation of the vout */
752 vlc_thread_ready( p_vout );
754 if( p_vout->b_error )
756 /* Destroy thread structures allocated by Create and InitThread */
757 DestroyThread( p_vout );
762 * Main loop - it is not executed if an error occured during
765 while( (!p_vout->b_die) && (!p_vout->b_error) )
767 /* Initialize loop variables */
770 current_date = mdate();
774 if( !(p_vout->c_loops % VOUT_STATS_NB_LOOPS) )
776 msg_Dbg( p_vout, "picture heap: %d/%d",
777 I_RENDERPICTURES, p_vout->i_heap_size );
782 * Find the picture to display (the one with the earliest date).
783 * This operation does not need lock, since only READY_PICTUREs
785 for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
787 if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
788 && ( (p_picture == NULL) ||
789 (PP_RENDERPICTURE[i_index]->date < display_date) ) )
791 p_picture = PP_RENDERPICTURE[i_index];
792 display_date = p_picture->date;
798 /* If we met the last picture, parse again to see whether there is
799 * a more appropriate one. */
800 if( p_picture == p_last_picture )
802 for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
804 if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
805 && (PP_RENDERPICTURE[i_index] != p_last_picture)
806 && ((p_picture == p_last_picture) ||
807 (PP_RENDERPICTURE[i_index]->date < display_date)) )
809 p_picture = PP_RENDERPICTURE[i_index];
810 display_date = p_picture->date;
815 /* If we found better than the last picture, destroy it */
816 if( p_last_picture && p_picture != p_last_picture )
818 vlc_mutex_lock( &p_vout->picture_lock );
819 if( p_last_picture->i_refcount )
821 p_last_picture->i_status = DISPLAYED_PICTURE;
825 p_last_picture->i_status = DESTROYED_PICTURE;
826 p_vout->i_heap_size--;
828 vlc_mutex_unlock( &p_vout->picture_lock );
829 p_last_picture = NULL;
832 /* Compute FPS rate */
833 p_vout->p_fps_sample[ p_vout->c_fps_samples++ % VOUT_FPS_SAMPLES ]
836 if( !p_picture->b_force &&
837 p_picture != p_last_picture &&
838 display_date < current_date + p_vout->render_time )
840 /* Picture is late: it will be destroyed and the thread
841 * will directly choose the next picture */
842 vlc_mutex_lock( &p_vout->picture_lock );
843 if( p_picture->i_refcount )
845 /* Pretend we displayed the picture, but don't destroy
846 * it since the decoder might still need it. */
847 p_picture->i_status = DISPLAYED_PICTURE;
851 /* Destroy the picture without displaying it */
852 p_picture->i_status = DESTROYED_PICTURE;
853 p_vout->i_heap_size--;
855 msg_Warn( p_vout, "late picture skipped ("I64Fd")",
856 current_date - display_date );
857 vlc_mutex_unlock( &p_vout->picture_lock );
863 current_date + p_vout->i_pts_delay + VOUT_BOGUS_DELAY )
865 /* Picture is waaay too early: it will be destroyed */
866 vlc_mutex_lock( &p_vout->picture_lock );
867 if( p_picture->i_refcount )
869 /* Pretend we displayed the picture, but don't destroy
870 * it since the decoder might still need it. */
871 p_picture->i_status = DISPLAYED_PICTURE;
875 /* Destroy the picture without displaying it */
876 p_picture->i_status = DESTROYED_PICTURE;
877 p_vout->i_heap_size--;
879 msg_Warn( p_vout, "vout warning: early picture skipped "
880 "("I64Fd")", display_date - current_date
881 - p_vout->i_pts_delay );
882 vlc_mutex_unlock( &p_vout->picture_lock );
887 if( display_date > current_date + VOUT_DISPLAY_DELAY )
889 /* A picture is ready to be rendered, but its rendering date
890 * is far from the current one so the thread will perform an
891 * empty loop as if no picture were found. The picture state
896 else if( p_picture == p_last_picture )
898 /* We are asked to repeat the previous picture, but we first
899 * wait for a couple of idle loops */
900 if( i_idle_loops < 4 )
907 /* We set the display date to something high, otherwise
908 * we'll have lots of problems with late pictures */
909 display_date = current_date + p_vout->render_time;
914 if( p_picture == NULL )
920 * Check for subpictures to display
922 p_subpic = vout_SortSubPictures( p_vout, display_date );
927 p_directbuffer = vout_RenderPicture( p_vout, p_picture, p_subpic );
930 * Call the plugin-specific rendering method if there is one
932 if( p_picture != NULL && p_directbuffer != NULL && p_vout->pf_render )
934 /* Render the direct buffer returned by vout_RenderPicture */
935 p_vout->pf_render( p_vout, p_directbuffer );
941 if( display_date != 0 && p_directbuffer != NULL )
943 mtime_t current_render_time = mdate() - current_date;
944 /* if render time is very large we don't include it in the mean */
945 if( current_render_time < p_vout->render_time +
948 /* Store render time using a sliding mean weighting to
949 * current value in a 3 to 1 ratio*/
950 p_vout->render_time *= 3;
951 p_vout->render_time += current_render_time;
952 p_vout->render_time >>= 2;
956 /* Give back change lock */
957 vlc_mutex_unlock( &p_vout->change_lock );
959 /* Sleep a while or until a given date */
960 if( display_date != 0 )
962 /* If there are filters in the chain, better give them the picture
964 if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
966 mwait( display_date - VOUT_MWAIT_TOLERANCE );
971 msleep( VOUT_IDLE_SLEEP );
974 /* On awakening, take back lock and send immediately picture
976 vlc_mutex_lock( &p_vout->change_lock );
979 * Display the previously rendered picture
981 if( p_picture != NULL && p_directbuffer != NULL )
983 /* Display the direct buffer returned by vout_RenderPicture */
984 if( p_vout->pf_display )
986 p_vout->pf_display( p_vout, p_directbuffer );
989 /* Reinitialize idle loop count */
992 /* Tell the vout this was the last picture and that it does not
993 * need to be forced anymore. */
994 p_last_picture = p_picture;
995 p_last_picture->b_force = 0;
999 * Check events and manage thread
1001 if( p_vout->pf_manage && p_vout->pf_manage( p_vout ) )
1003 /* A fatal error occured, and the thread must terminate
1004 * immediately, without displaying anything - setting b_error to 1
1005 * causes the immediate end of the main while() loop. */
1006 p_vout->b_error = 1;
1009 if( p_vout->i_changes & VOUT_SIZE_CHANGE )
1011 /* this must only happen when the vout plugin is incapable of
1012 * rescaling the picture itself. In this case we need to destroy
1013 * the current picture buffers and recreate new ones with the right
1017 p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
1019 p_vout->pf_end( p_vout );
1020 for( i = 0; i < I_OUTPUTPICTURES; i++ )
1021 p_vout->p_picture[ i ].i_status = FREE_PICTURE;
1023 I_OUTPUTPICTURES = 0;
1024 if( p_vout->pf_init( p_vout ) )
1026 msg_Err( p_vout, "cannot resize display" );
1027 /* FIXME: pf_end will be called again in EndThread() */
1028 p_vout->b_error = 1;
1031 /* Need to reinitialise the chroma plugin */
1032 if( p_vout->chroma.p_module )
1034 if( p_vout->chroma.p_module->pf_deactivate )
1035 p_vout->chroma.p_module->pf_deactivate( VLC_OBJECT(p_vout) );
1036 p_vout->chroma.p_module->pf_activate( VLC_OBJECT(p_vout) );
1040 if( p_vout->i_changes & VOUT_PICTURE_BUFFERS_CHANGE )
1042 /* This happens when the picture buffers need to be recreated.
1043 * This is useful on multimonitor displays for instance.
1045 * Warning: This only works when the vout creates only 1 picture
1047 p_vout->i_changes &= ~VOUT_PICTURE_BUFFERS_CHANGE;
1049 if( !p_vout->b_direct )
1051 module_Unneed( p_vout, p_vout->chroma.p_module );
1054 vlc_mutex_lock( &p_vout->picture_lock );
1056 p_vout->pf_end( p_vout );
1058 I_OUTPUTPICTURES = I_RENDERPICTURES = 0;
1060 p_vout->b_error = InitThread( p_vout );
1062 vlc_mutex_unlock( &p_vout->picture_lock );
1067 * Error loop - wait until the thread destruction is requested
1069 if( p_vout->b_error )
1071 ErrorThread( p_vout );
1075 EndThread( p_vout );
1077 /* Destroy thread structures allocated by CreateThread */
1078 DestroyThread( p_vout );
1081 /*****************************************************************************
1082 * ErrorThread: RunThread() error loop
1083 *****************************************************************************
1084 * This function is called when an error occured during thread main's loop. The
1085 * thread can still receive feed, but must be ready to terminate as soon as
1087 *****************************************************************************/
1088 static void ErrorThread( vout_thread_t *p_vout )
1090 /* Wait until a `die' order */
1091 while( !p_vout->b_die )
1094 msleep( VOUT_IDLE_SLEEP );
1098 /*****************************************************************************
1099 * EndThread: thread destruction
1100 *****************************************************************************
1101 * This function is called when the thread ends after a sucessful
1102 * initialization. It frees all ressources allocated by InitThread.
1103 *****************************************************************************/
1104 static void EndThread( vout_thread_t *p_vout )
1106 int i_index; /* index in heap */
1110 struct tms cpu_usage;
1111 times( &cpu_usage );
1113 msg_Dbg( p_vout, "cpu usage (user: %d, system: %d)",
1114 cpu_usage.tms_utime, cpu_usage.tms_stime );
1118 if( !p_vout->b_direct )
1120 module_Unneed( p_vout, p_vout->chroma.p_module );
1123 /* Destroy all remaining pictures */
1124 for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++ )
1126 if ( p_vout->p_picture[i_index].i_type == MEMORY_PICTURE )
1128 free( p_vout->p_picture[i_index].p_data_orig );
1132 /* Destroy all remaining subpictures */
1133 for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
1135 if( p_vout->p_subpicture[i_index].i_status != FREE_SUBPICTURE )
1137 vout_DestroySubPicture( p_vout,
1138 &p_vout->p_subpicture[i_index] );
1142 if( p_vout->p_text_renderer_module )
1143 module_Unneed( p_vout, p_vout->p_text_renderer_module );
1145 /* Destroy translation tables */
1146 p_vout->pf_end( p_vout );
1148 /* Release the change lock */
1149 vlc_mutex_unlock( &p_vout->change_lock );
1152 /*****************************************************************************
1153 * DestroyThread: thread destruction
1154 *****************************************************************************
1155 * This function is called when the thread ends. It frees all ressources
1156 * allocated by CreateThread. Status is available at this stage.
1157 *****************************************************************************/
1158 static void DestroyThread( vout_thread_t *p_vout )
1160 /* Destroy the locks */
1161 vlc_mutex_destroy( &p_vout->picture_lock );
1162 vlc_mutex_destroy( &p_vout->subpicture_lock );
1163 vlc_mutex_destroy( &p_vout->change_lock );
1165 /* Release the module */
1166 if( p_vout && p_vout->p_module )
1168 module_Unneed( p_vout, p_vout->p_module );
1172 /* following functions are local */
1174 static int ReduceHeight( int i_ratio )
1176 int i_dummy = VOUT_ASPECT_FACTOR;
1184 /* VOUT_ASPECT_FACTOR is (2^7 * 3^3 * 5^3), we just check for 2, 3 and 5 */
1185 while( !(i_ratio & 1) && !(i_dummy & 1) )
1192 while( !(i_ratio % 3) && !(i_dummy % 3) )
1199 while( !(i_ratio % 5) && !(i_dummy % 5) )
1209 /*****************************************************************************
1210 * BinaryLog: computes the base 2 log of a binary value
1211 *****************************************************************************
1212 * This functions is used by MaskToShift, to get a bit index from a binary
1214 *****************************************************************************/
1215 static int BinaryLog( uint32_t i )
1219 if( i == 0 ) return -31337;
1221 if( i & 0xffff0000 ) i_log += 16;
1222 if( i & 0xff00ff00 ) i_log += 8;
1223 if( i & 0xf0f0f0f0 ) i_log += 4;
1224 if( i & 0xcccccccc ) i_log += 2;
1225 if( i & 0xaaaaaaaa ) i_log += 1;
1230 /*****************************************************************************
1231 * MaskToShift: transform a color mask into right and left shifts
1232 *****************************************************************************
1233 * This function is used for obtaining color shifts from masks.
1234 *****************************************************************************/
1235 static void MaskToShift( int *pi_left, int *pi_right, uint32_t i_mask )
1237 uint32_t i_low, i_high; /* lower hand higher bits of the mask */
1241 *pi_left = *pi_right = 0;
1246 i_low = i_mask & (- (int32_t)i_mask); /* lower bit of the mask */
1247 i_high = i_mask + i_low; /* higher bit of the mask */
1249 /* Transform bits into an index */
1250 i_low = BinaryLog (i_low);
1251 i_high = BinaryLog (i_high);
1253 /* Update pointers and return */
1255 *pi_right = (8 - i_high + i_low);
1258 /*****************************************************************************
1259 * InitWindowSize: find the initial dimensions the video window should have.
1260 *****************************************************************************
1261 * This function will check the "width", "height" and "zoom" config options and
1262 * will calculate the size that the video window should have.
1263 *****************************************************************************/
1264 static void InitWindowSize( vout_thread_t *p_vout, int *pi_width,
1268 int i_width, i_height;
1271 #define FP_FACTOR 1000 /* our fixed point factor */
1273 var_Get( p_vout, "align", &val );
1274 p_vout->i_alignment = val.i_int;
1276 var_Get( p_vout, "width", &val );
1277 i_width = val.i_int;
1278 var_Get( p_vout, "height", &val );
1279 i_height = val.i_int;
1280 var_Get( p_vout, "zoom", &val );
1281 ll_zoom = (uint64_t)( FP_FACTOR * val.f_float );
1283 if( i_width > 0 && i_height > 0)
1285 *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
1286 *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
1289 else if( i_width > 0 )
1291 *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
1292 *pi_height = (int)( i_width * ll_zoom * VOUT_ASPECT_FACTOR /
1293 p_vout->render.i_aspect / FP_FACTOR );
1296 else if( i_height > 0 )
1298 *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
1299 *pi_width = (int)( i_height * ll_zoom * p_vout->render.i_aspect /
1300 VOUT_ASPECT_FACTOR / FP_FACTOR );
1304 if( p_vout->render.i_height * p_vout->render.i_aspect
1305 >= p_vout->render.i_width * VOUT_ASPECT_FACTOR )
1307 *pi_width = (int)( p_vout->render.i_height * ll_zoom
1308 * p_vout->render.i_aspect / VOUT_ASPECT_FACTOR / FP_FACTOR );
1309 *pi_height = (int)( p_vout->render.i_height * ll_zoom / FP_FACTOR );
1313 *pi_width = (int)( p_vout->render.i_width * ll_zoom / FP_FACTOR );
1314 *pi_height = (int)( p_vout->render.i_width * ll_zoom
1315 * VOUT_ASPECT_FACTOR / p_vout->render.i_aspect / FP_FACTOR );
1321 /*****************************************************************************
1322 * vout_VarCallback: generic callback for intf variables
1323 *****************************************************************************/
1324 int vout_VarCallback( vlc_object_t * p_this, const char * psz_variable,
1325 vlc_value_t old_value, vlc_value_t new_value,
1328 vout_thread_t * p_vout = (vout_thread_t *)p_this;
1330 val.b_bool = VLC_TRUE;
1331 var_Set( p_vout, "intf-change", val );
1335 /*****************************************************************************
1336 * object variables callbacks: a bunch of object variables are used by the
1337 * interfaces to interact with the vout.
1338 *****************************************************************************/
1339 static int DeinterlaceCallback( vlc_object_t *p_this, char const *psz_cmd,
1340 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1342 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1343 input_thread_t *p_input;
1346 char *psz_mode = newval.psz_string;
1350 psz_filter = config_GetPsz( p_vout, "filter" );
1352 if( !psz_mode || !*psz_mode )
1354 config_PutPsz( p_vout, "filter", "" );
1358 if( !psz_filter || !*psz_filter )
1360 config_PutPsz( p_vout, "filter", "deinterlace" );
1364 if( strstr( psz_filter, "deinterlace" ) == NULL )
1366 psz_filter = realloc( psz_filter, strlen( psz_filter ) + 20 );
1367 strcat( psz_filter, ",deinterlace" );
1369 config_PutPsz( p_vout, "filter", psz_filter );
1373 if( psz_filter ) free( psz_filter );
1376 p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1378 if( !p_input ) return VLC_EGENERIC;
1380 if( psz_mode && *psz_mode )
1382 val.psz_string = psz_mode;
1383 var_Set( p_vout, "deinterlace-mode", val );
1384 /* Modify input as well because the vout might have to be restarted */
1385 var_Create( p_input, "deinterlace-mode", VLC_VAR_STRING );
1386 var_Set( p_input, "deinterlace-mode", val );
1389 /* FIXME FIXME input2 --fenrir */
1391 /* now restart all video streams */
1392 vlc_mutex_lock( &p_input->stream.stream_lock );
1394 p_vout->b_filter_change = VLC_TRUE;
1396 #define ES p_input->stream.pp_es[i]
1398 for( i = 0 ; i < p_input->stream.i_es_number ; i++ )
1400 if( ( ES->i_cat == VIDEO_ES ) && ES->p_dec != NULL )
1402 input_UnselectES( p_input, ES );
1403 input_SelectES( p_input, ES );
1407 vlc_mutex_unlock( &p_input->stream.stream_lock );
1409 vlc_object_release( p_input );
1412 val.b_bool = VLC_TRUE;
1413 var_Set( p_vout, "intf-change", val );
1417 static int FilterCallback( vlc_object_t *p_this, char const *psz_cmd,
1418 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1420 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1421 input_thread_t *p_input;
1425 p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1430 msg_Err( p_vout, "Input not found" );
1431 return( VLC_EGENERIC );
1434 /* FIXME FIXME input2 --fenrir */
1436 /* Restart the video stream */
1437 vlc_mutex_lock( &p_input->stream.stream_lock );
1439 p_vout->b_filter_change = VLC_TRUE;
1441 #define ES p_input->stream.pp_es[i]
1443 for( i = 0 ; i < p_input->stream.i_es_number ; i++ )
1445 if( ( ES->i_cat == VIDEO_ES ) && ES->p_dec != NULL )
1447 input_UnselectES( p_input, ES );
1448 input_SelectES( p_input, ES );
1452 vlc_mutex_unlock( &p_input->stream.stream_lock );
1454 vlc_object_release( p_input );
1457 val.b_bool = VLC_TRUE;
1458 var_Set( p_vout, "intf-change", val );