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 and subpictures - 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 for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++)
248 p_vout->p_subpicture[i_index].i_status = FREE_SUBPICTURE;
249 p_vout->p_subpicture[i_index].i_type = EMPTY_SUBPICTURE;
252 /* No images in the heap */
253 p_vout->i_heap_size = 0;
255 /* Register the default subpicture channel */
256 p_vout->p_default_channel = NULL;
257 p_vout->i_channel_count = 1;
259 /* Initialize the rendering heap */
260 I_RENDERPICTURES = 0;
261 p_vout->render.i_width = i_width;
262 p_vout->render.i_height = i_height;
263 p_vout->render.i_chroma = i_chroma;
264 p_vout->render.i_aspect = i_aspect;
266 p_vout->render.i_rmask = 0;
267 p_vout->render.i_gmask = 0;
268 p_vout->render.i_bmask = 0;
270 p_vout->render.i_last_used_pic = -1;
271 p_vout->render.b_allow_modify_pics = 1;
273 /* Zero the output heap */
274 I_OUTPUTPICTURES = 0;
275 p_vout->output.i_width = 0;
276 p_vout->output.i_height = 0;
277 p_vout->output.i_chroma = 0;
278 p_vout->output.i_aspect = 0;
280 p_vout->output.i_rmask = 0;
281 p_vout->output.i_gmask = 0;
282 p_vout->output.i_bmask = 0;
284 /* Initialize misc stuff */
285 p_vout->i_changes = 0;
287 p_vout->b_grayscale = 0;
289 p_vout->b_interface = 0;
291 p_vout->b_fullscreen = 0;
292 p_vout->i_alignment = 0;
293 p_vout->render_time = 10;
294 p_vout->c_fps_samples = 0;
295 p_vout->b_filter_change = 0;
296 p_vout->pf_control = 0;
297 p_vout->p_parent_intf = 0;
299 /* Mouse coordinates */
300 var_Create( p_vout, "mouse-x", VLC_VAR_INTEGER );
301 var_Create( p_vout, "mouse-y", VLC_VAR_INTEGER );
302 var_Create( p_vout, "mouse-button-down", VLC_VAR_INTEGER );
303 var_Create( p_vout, "mouse-moved", VLC_VAR_BOOL );
304 var_Create( p_vout, "mouse-clicked", VLC_VAR_INTEGER );
306 var_Create( p_vout, "intf-change", VLC_VAR_BOOL );
307 val.b_bool = VLC_TRUE;
308 var_Set( p_vout, "intf-change", val );
310 /* Initialize locks */
311 vlc_mutex_init( p_vout, &p_vout->picture_lock );
312 vlc_mutex_init( p_vout, &p_vout->subpicture_lock );
313 vlc_mutex_init( p_vout, &p_vout->change_lock );
315 /* Attach the new object now so we can use var inheritance below */
316 vlc_object_attach( p_vout, p_parent );
318 /* Take care of some "interface/control" related initialisations */
319 vout_IntfInit( p_vout );
321 p_vout->b_override_aspect = VLC_FALSE;
323 /* If the parent is not a VOUT object, that means we are at the start of
324 * the video output pipe */
325 if( p_parent->i_object_type != VLC_OBJECT_VOUT )
327 var_Get( p_vout, "aspect-ratio", &val );
329 /* Check whether the user tried to override aspect ratio */
332 unsigned int i_new_aspect = i_aspect;
333 char *psz_parser = strchr( val.psz_string, ':' );
337 *psz_parser++ = '\0';
338 i_new_aspect = atoi( val.psz_string ) * VOUT_ASPECT_FACTOR
339 / atoi( psz_parser );
343 i_new_aspect = i_width * VOUT_ASPECT_FACTOR
344 * atof( val.psz_string )
348 free( val.psz_string );
350 if( i_new_aspect && i_new_aspect != i_aspect )
352 unsigned int i_aspect_x, i_aspect_y;
354 vout_AspectRatio( i_new_aspect, &i_aspect_x, &i_aspect_y );
356 msg_Dbg( p_vout, "overriding source aspect ratio to %i:%i",
357 i_aspect_x, i_aspect_y );
359 p_vout->render.i_aspect = i_new_aspect;
361 p_vout->b_override_aspect = VLC_TRUE;
365 /* Look for the default filter configuration */
366 var_Create( p_vout, "filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
367 var_Get( p_vout, "filter", &val );
368 p_vout->psz_filter_chain = val.psz_string;
372 /* continue the parent's filter chain */
375 psz_end = strchr( ((vout_thread_t *)p_parent)->psz_filter_chain, ':' );
376 if( psz_end && *(psz_end+1) )
377 p_vout->psz_filter_chain = strdup( psz_end+1 );
378 else p_vout->psz_filter_chain = NULL;
381 /* Choose the video output module */
382 if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
384 var_Create( p_vout, "vout", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
385 var_Get( p_vout, "vout", &val );
386 psz_plugin = val.psz_string;
390 /* the filter chain is a string list of filters separated by double
394 psz_end = strchr( p_vout->psz_filter_chain, ':' );
396 psz_plugin = strndup( p_vout->psz_filter_chain,
397 psz_end - p_vout->psz_filter_chain );
398 else psz_plugin = strdup( p_vout->psz_filter_chain );
401 /* Initialize the dimensions of the video window */
402 InitWindowSize( p_vout, &p_vout->i_window_width,
403 &p_vout->i_window_height );
405 /* Create the vout thread */
406 p_vout->p_module = module_Need( p_vout,
407 ( p_vout->psz_filter_chain && *p_vout->psz_filter_chain ) ?
408 "video filter" : "video output", psz_plugin, 0 );
410 if( psz_plugin ) free( psz_plugin );
411 if( p_vout->p_module == NULL )
413 msg_Err( p_vout, "no suitable vout module" );
414 vlc_object_detach( p_vout );
415 vlc_object_destroy( p_vout );
419 p_vout->p_text_renderer_module =
420 module_Need( p_vout, "text renderer", NULL, 0 );
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, "deinterlace", VLC_VAR_STRING | VLC_VAR_HASCHOICE );
429 text.psz_string = _("Deinterlace");
430 var_Change( p_vout, "deinterlace", VLC_VAR_SETTEXT, &text, NULL );
431 val.psz_string = ""; text.psz_string = _("Disable");
432 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
433 val.psz_string = "discard"; text.psz_string = _("Discard");
434 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
435 val.psz_string = "blend"; text.psz_string = _("Blend");
436 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
437 val.psz_string = "mean"; text.psz_string = _("Mean");
438 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
439 val.psz_string = "bob"; text.psz_string = _("Bob");
440 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
441 val.psz_string = "linear"; text.psz_string = _("Linear");
442 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
443 if( var_Get( p_vout, "deinterlace-mode", &val ) == VLC_SUCCESS )
445 var_Set( p_vout, "deinterlace", val );
446 if( val.psz_string ) free( val.psz_string );
448 var_AddCallback( p_vout, "deinterlace", DeinterlaceCallback, NULL );
451 var_Create( p_vout, "filter", VLC_VAR_STRING );
452 text.psz_string = _("Filters");
453 var_Change( p_vout, "filter", VLC_VAR_SETTEXT, &text, NULL );
454 var_Change( p_vout, "filter", VLC_VAR_INHERITVALUE, &val, NULL );
457 var_Set( p_vout, "filter", val );
458 free( val.psz_string );
460 var_AddCallback( p_vout, "filter", FilterCallback, NULL );
462 /* Calculate delay created by internal caching */
463 p_input_thread = (input_thread_t *)vlc_object_find( p_vout,
464 VLC_OBJECT_INPUT, FIND_ANYWHERE );
467 p_vout->i_pts_delay = p_input_thread->i_pts_delay;
468 vlc_object_release( p_input_thread );
472 p_vout->i_pts_delay = DEFAULT_PTS_DELAY;
475 if( vlc_thread_create( p_vout, "video output", RunThread,
476 VLC_THREAD_PRIORITY_OUTPUT, VLC_TRUE ) )
478 msg_Err( p_vout, "out of memory" );
479 module_Unneed( p_vout, p_vout->p_module );
480 vlc_object_detach( p_vout );
481 vlc_object_destroy( p_vout );
485 if( p_vout->b_error )
487 msg_Err( p_vout, "video output creation failed" );
489 /* Make sure the thread is destroyed */
490 p_vout->b_die = VLC_TRUE;
492 if( p_vout->p_text_renderer_module )
494 module_Unneed( p_vout, p_vout->p_text_renderer_module );
496 vlc_thread_join( p_vout );
498 vlc_object_detach( p_vout );
499 vlc_object_destroy( p_vout );
506 /*****************************************************************************
507 * vout_Destroy: destroys a previously created video output
508 *****************************************************************************
509 * Destroy a terminated thread.
510 * The function will request a destruction of the specified thread. If pi_error
511 * is NULL, it will return once the thread is destroyed. Else, it will be
512 * update using one of the THREAD_* constants.
513 *****************************************************************************/
514 void vout_Destroy( vout_thread_t *p_vout )
516 vlc_object_t *p_playlist;
518 /* Request thread destruction */
519 p_vout->b_die = VLC_TRUE;
520 vlc_thread_join( p_vout );
522 var_Destroy( p_vout, "intf-change" );
524 p_playlist = vlc_object_find( p_vout, VLC_OBJECT_PLAYLIST,
527 if( p_vout->psz_filter_chain ) free( p_vout->psz_filter_chain );
530 vlc_object_destroy( p_vout );
532 /* If it was the last vout, tell the interface to show up */
533 if( p_playlist != NULL )
535 vout_thread_t *p_another_vout = vlc_object_find( p_playlist,
536 VLC_OBJECT_VOUT, FIND_ANYWHERE );
537 if( p_another_vout == NULL )
540 val.b_bool = VLC_TRUE;
541 var_Set( p_playlist, "intf-show", val );
545 vlc_object_release( p_another_vout );
547 vlc_object_release( p_playlist );
551 /*****************************************************************************
552 * InitThread: initialize video output thread
553 *****************************************************************************
554 * This function is called from RunThread and performs the second step of the
555 * initialization. It returns 0 on success. Note that the thread's flag are not
556 * modified inside this function.
557 *****************************************************************************/
558 static int InitThread( vout_thread_t *p_vout )
561 unsigned int i_aspect_x, i_aspect_y;
563 vlc_mutex_lock( &p_vout->change_lock );
569 /* Initialize output method, it allocates direct buffers for us */
570 if( p_vout->pf_init( p_vout ) )
572 vlc_mutex_unlock( &p_vout->change_lock );
576 if( !I_OUTPUTPICTURES )
578 msg_Err( p_vout, "plugin was unable to allocate at least "
579 "one direct buffer" );
580 p_vout->pf_end( p_vout );
581 vlc_mutex_unlock( &p_vout->change_lock );
585 if( I_OUTPUTPICTURES > VOUT_MAX_PICTURES )
587 msg_Err( p_vout, "plugin allocated too many direct buffers, "
588 "our internal buffers must have overflown." );
589 p_vout->pf_end( p_vout );
590 vlc_mutex_unlock( &p_vout->change_lock );
594 msg_Dbg( p_vout, "got %i direct buffer(s)", I_OUTPUTPICTURES );
597 if( !p_vout->psz_filter_chain )
599 char *psz_aspect = config_GetPsz( p_vout, "pixel-ratio" );
603 int i_new_aspect = p_vout->output.i_width * VOUT_ASPECT_FACTOR
605 / p_vout->output.i_height;
608 if( i_new_aspect && i_new_aspect != p_vout->output.i_aspect )
610 vout_AspectRatio( i_new_aspect, &i_aspect_x, &i_aspect_y );
612 msg_Dbg( p_vout, "output ratio forced to %i:%i\n",
613 i_aspect_x, i_aspect_y );
614 p_vout->output.i_aspect = i_new_aspect;
620 vout_AspectRatio( p_vout->render.i_aspect, &i_aspect_x, &i_aspect_y );
622 "picture in %ix%i, chroma 0x%.8x (%4.4s), aspect ratio %i:%i",
623 p_vout->render.i_width, p_vout->render.i_height,
624 p_vout->render.i_chroma, (char*)&p_vout->render.i_chroma,
625 i_aspect_x, i_aspect_y );
627 vout_AspectRatio( p_vout->output.i_aspect, &i_aspect_x, &i_aspect_y );
629 "picture out %ix%i, chroma 0x%.8x (%4.4s), aspect ratio %i:%i",
630 p_vout->output.i_width, p_vout->output.i_height,
631 p_vout->output.i_chroma, (char*)&p_vout->output.i_chroma,
632 i_aspect_x, i_aspect_y );
634 /* Calculate shifts from system-updated masks */
635 MaskToShift( &p_vout->output.i_lrshift, &p_vout->output.i_rrshift,
636 p_vout->output.i_rmask );
637 MaskToShift( &p_vout->output.i_lgshift, &p_vout->output.i_rgshift,
638 p_vout->output.i_gmask );
639 MaskToShift( &p_vout->output.i_lbshift, &p_vout->output.i_rbshift,
640 p_vout->output.i_bmask );
642 /* Check whether we managed to create direct buffers similar to
643 * the render buffers, ie same size and chroma */
644 if( ( p_vout->output.i_width == p_vout->render.i_width )
645 && ( p_vout->output.i_height == p_vout->render.i_height )
646 && ( vout_ChromaCmp( p_vout->output.i_chroma, p_vout->render.i_chroma ) ) )
648 /* Cool ! We have direct buffers, we can ask the decoder to
649 * directly decode into them ! Map the first render buffers to
650 * the first direct buffers, but keep the first direct buffer
651 * for memcpy operations */
652 p_vout->b_direct = 1;
654 for( i = 1; i < VOUT_MAX_PICTURES; i++ )
656 if( p_vout->p_picture[ i ].i_type != DIRECT_PICTURE &&
657 I_RENDERPICTURES >= VOUT_MIN_DIRECT_PICTURES - 1 &&
658 p_vout->p_picture[ i - 1 ].i_type == DIRECT_PICTURE )
660 /* We have enough direct buffers so there's no need to
661 * try to use system memory buffers. */
664 PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
668 msg_Dbg( p_vout, "direct render, mapping "
669 "render pictures 0-%i to system pictures 1-%i",
670 VOUT_MAX_PICTURES - 2, VOUT_MAX_PICTURES - 1 );
674 /* Rats... Something is wrong here, we could not find an output
675 * plugin able to directly render what we decode. See if we can
676 * find a chroma plugin to do the conversion */
677 p_vout->b_direct = 0;
679 /* Choose the best module */
680 p_vout->chroma.p_module = module_Need( p_vout, "chroma", NULL, 0 );
682 if( p_vout->chroma.p_module == NULL )
684 msg_Err( p_vout, "no chroma module for %4.4s to %4.4s",
685 (char*)&p_vout->render.i_chroma,
686 (char*)&p_vout->output.i_chroma );
687 p_vout->pf_end( p_vout );
688 vlc_mutex_unlock( &p_vout->change_lock );
692 msg_Dbg( p_vout, "indirect render, mapping "
693 "render pictures 0-%i to system pictures %i-%i",
694 VOUT_MAX_PICTURES - 1, I_OUTPUTPICTURES,
695 I_OUTPUTPICTURES + VOUT_MAX_PICTURES - 1 );
697 /* Append render buffers after the direct buffers */
698 for( i = I_OUTPUTPICTURES; i < 2 * VOUT_MAX_PICTURES; i++ )
700 PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
703 /* Check if we have enough render pictures */
704 if( I_RENDERPICTURES == VOUT_MAX_PICTURES )
709 /* Link pictures back to their heap */
710 for( i = 0 ; i < I_RENDERPICTURES ; i++ )
712 PP_RENDERPICTURE[ i ]->p_heap = &p_vout->render;
715 for( i = 0 ; i < I_OUTPUTPICTURES ; i++ )
717 PP_OUTPUTPICTURE[ i ]->p_heap = &p_vout->output;
720 /* XXX XXX mark thread ready */
724 /*****************************************************************************
725 * RunThread: video output thread
726 *****************************************************************************
727 * Video output thread. This function does only returns when the thread is
728 * terminated. It handles the pictures arriving in the video heap and the
729 * display device events.
730 *****************************************************************************/
731 static void RunThread( vout_thread_t *p_vout)
733 int i_index; /* index in heap */
734 int i_idle_loops = 0; /* loops without displaying a picture */
735 mtime_t current_date; /* current date */
736 mtime_t display_date; /* display date */
738 picture_t * p_picture; /* picture pointer */
739 picture_t * p_last_picture = NULL; /* last picture */
740 picture_t * p_directbuffer; /* direct buffer to display */
742 subpicture_t * p_subpic; /* subpicture pointer */
747 p_vout->b_error = InitThread( p_vout );
749 /* signal the creation of the vout */
750 vlc_thread_ready( p_vout );
752 if( p_vout->b_error )
754 /* Destroy thread structures allocated by Create and InitThread */
755 DestroyThread( p_vout );
760 * Main loop - it is not executed if an error occured during
763 while( (!p_vout->b_die) && (!p_vout->b_error) )
765 /* Initialize loop variables */
768 current_date = mdate();
772 if( !(p_vout->c_loops % VOUT_STATS_NB_LOOPS) )
774 msg_Dbg( p_vout, "picture heap: %d/%d",
775 I_RENDERPICTURES, p_vout->i_heap_size );
780 * Find the picture to display (the one with the earliest date).
781 * This operation does not need lock, since only READY_PICTUREs
783 for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
785 if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
786 && ( (p_picture == NULL) ||
787 (PP_RENDERPICTURE[i_index]->date < display_date) ) )
789 p_picture = PP_RENDERPICTURE[i_index];
790 display_date = p_picture->date;
796 /* If we met the last picture, parse again to see whether there is
797 * a more appropriate one. */
798 if( p_picture == p_last_picture )
800 for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
802 if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
803 && (PP_RENDERPICTURE[i_index] != p_last_picture)
804 && ((p_picture == p_last_picture) ||
805 (PP_RENDERPICTURE[i_index]->date < display_date)) )
807 p_picture = PP_RENDERPICTURE[i_index];
808 display_date = p_picture->date;
813 /* If we found better than the last picture, destroy it */
814 if( p_last_picture && p_picture != p_last_picture )
816 vlc_mutex_lock( &p_vout->picture_lock );
817 if( p_last_picture->i_refcount )
819 p_last_picture->i_status = DISPLAYED_PICTURE;
823 p_last_picture->i_status = DESTROYED_PICTURE;
824 p_vout->i_heap_size--;
826 vlc_mutex_unlock( &p_vout->picture_lock );
827 p_last_picture = NULL;
830 /* Compute FPS rate */
831 p_vout->p_fps_sample[ p_vout->c_fps_samples++ % VOUT_FPS_SAMPLES ]
834 if( !p_picture->b_force &&
835 p_picture != p_last_picture &&
836 display_date < current_date + p_vout->render_time )
838 /* Picture is late: it will be destroyed and the thread
839 * will directly choose the next picture */
840 vlc_mutex_lock( &p_vout->picture_lock );
841 if( p_picture->i_refcount )
843 /* Pretend we displayed the picture, but don't destroy
844 * it since the decoder might still need it. */
845 p_picture->i_status = DISPLAYED_PICTURE;
849 /* Destroy the picture without displaying it */
850 p_picture->i_status = DESTROYED_PICTURE;
851 p_vout->i_heap_size--;
853 msg_Warn( p_vout, "late picture skipped ("I64Fd")",
854 current_date - display_date );
855 vlc_mutex_unlock( &p_vout->picture_lock );
861 current_date + p_vout->i_pts_delay + VOUT_BOGUS_DELAY )
863 /* Picture is waaay too early: it will be destroyed */
864 vlc_mutex_lock( &p_vout->picture_lock );
865 if( p_picture->i_refcount )
867 /* Pretend we displayed the picture, but don't destroy
868 * it since the decoder might still need it. */
869 p_picture->i_status = DISPLAYED_PICTURE;
873 /* Destroy the picture without displaying it */
874 p_picture->i_status = DESTROYED_PICTURE;
875 p_vout->i_heap_size--;
877 msg_Warn( p_vout, "vout warning: early picture skipped "
878 "("I64Fd")", display_date - current_date
879 - p_vout->i_pts_delay );
880 vlc_mutex_unlock( &p_vout->picture_lock );
885 if( display_date > current_date + VOUT_DISPLAY_DELAY )
887 /* A picture is ready to be rendered, but its rendering date
888 * is far from the current one so the thread will perform an
889 * empty loop as if no picture were found. The picture state
894 else if( p_picture == p_last_picture )
896 /* We are asked to repeat the previous picture, but we first
897 * wait for a couple of idle loops */
898 if( i_idle_loops < 4 )
905 /* We set the display date to something high, otherwise
906 * we'll have lots of problems with late pictures */
907 display_date = current_date + p_vout->render_time;
912 if( p_picture == NULL )
918 * Check for subpictures to display
920 p_subpic = vout_SortSubPictures( p_vout, display_date );
925 p_directbuffer = vout_RenderPicture( p_vout, p_picture, p_subpic );
928 * Call the plugin-specific rendering method if there is one
930 if( p_picture != NULL && p_directbuffer != NULL && p_vout->pf_render )
932 /* Render the direct buffer returned by vout_RenderPicture */
933 p_vout->pf_render( p_vout, p_directbuffer );
939 if( display_date != 0 && p_directbuffer != NULL )
941 mtime_t current_render_time = mdate() - current_date;
942 /* if render time is very large we don't include it in the mean */
943 if( current_render_time < p_vout->render_time +
946 /* Store render time using a sliding mean weighting to
947 * current value in a 3 to 1 ratio*/
948 p_vout->render_time *= 3;
949 p_vout->render_time += current_render_time;
950 p_vout->render_time >>= 2;
954 /* Give back change lock */
955 vlc_mutex_unlock( &p_vout->change_lock );
957 /* Sleep a while or until a given date */
958 if( display_date != 0 )
960 /* If there are filters in the chain, better give them the picture
962 if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
964 mwait( display_date - VOUT_MWAIT_TOLERANCE );
969 msleep( VOUT_IDLE_SLEEP );
972 /* On awakening, take back lock and send immediately picture
974 vlc_mutex_lock( &p_vout->change_lock );
977 * Display the previously rendered picture
979 if( p_picture != NULL && p_directbuffer != NULL )
981 /* Display the direct buffer returned by vout_RenderPicture */
982 if( p_vout->pf_display )
984 p_vout->pf_display( p_vout, p_directbuffer );
987 /* Reinitialize idle loop count */
990 /* Tell the vout this was the last picture and that it does not
991 * need to be forced anymore. */
992 p_last_picture = p_picture;
993 p_last_picture->b_force = 0;
997 * Check events and manage thread
999 if( p_vout->pf_manage && p_vout->pf_manage( p_vout ) )
1001 /* A fatal error occured, and the thread must terminate
1002 * immediately, without displaying anything - setting b_error to 1
1003 * causes the immediate end of the main while() loop. */
1004 p_vout->b_error = 1;
1007 if( p_vout->i_changes & VOUT_SIZE_CHANGE )
1009 /* this must only happen when the vout plugin is incapable of
1010 * rescaling the picture itself. In this case we need to destroy
1011 * the current picture buffers and recreate new ones with the right
1015 p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
1017 p_vout->pf_end( p_vout );
1018 for( i = 0; i < I_OUTPUTPICTURES; i++ )
1019 p_vout->p_picture[ i ].i_status = FREE_PICTURE;
1021 I_OUTPUTPICTURES = 0;
1022 if( p_vout->pf_init( p_vout ) )
1024 msg_Err( p_vout, "cannot resize display" );
1025 /* FIXME: pf_end will be called again in EndThread() */
1026 p_vout->b_error = 1;
1029 /* Need to reinitialise the chroma plugin */
1030 if( p_vout->chroma.p_module )
1032 if( p_vout->chroma.p_module->pf_deactivate )
1033 p_vout->chroma.p_module->pf_deactivate( VLC_OBJECT(p_vout) );
1034 p_vout->chroma.p_module->pf_activate( VLC_OBJECT(p_vout) );
1038 if( p_vout->i_changes & VOUT_PICTURE_BUFFERS_CHANGE )
1040 /* This happens when the picture buffers need to be recreated.
1041 * This is useful on multimonitor displays for instance.
1043 * Warning: This only works when the vout creates only 1 picture
1045 p_vout->i_changes &= ~VOUT_PICTURE_BUFFERS_CHANGE;
1047 if( !p_vout->b_direct )
1049 module_Unneed( p_vout, p_vout->chroma.p_module );
1052 vlc_mutex_lock( &p_vout->picture_lock );
1054 p_vout->pf_end( p_vout );
1056 I_OUTPUTPICTURES = I_RENDERPICTURES = 0;
1058 p_vout->b_error = InitThread( p_vout );
1060 vlc_mutex_unlock( &p_vout->picture_lock );
1065 * Error loop - wait until the thread destruction is requested
1067 if( p_vout->b_error )
1069 ErrorThread( p_vout );
1073 EndThread( p_vout );
1075 /* Destroy thread structures allocated by CreateThread */
1076 DestroyThread( p_vout );
1079 /*****************************************************************************
1080 * ErrorThread: RunThread() error loop
1081 *****************************************************************************
1082 * This function is called when an error occured during thread main's loop. The
1083 * thread can still receive feed, but must be ready to terminate as soon as
1085 *****************************************************************************/
1086 static void ErrorThread( vout_thread_t *p_vout )
1088 /* Wait until a `die' order */
1089 while( !p_vout->b_die )
1092 msleep( VOUT_IDLE_SLEEP );
1096 /*****************************************************************************
1097 * EndThread: thread destruction
1098 *****************************************************************************
1099 * This function is called when the thread ends after a sucessful
1100 * initialization. It frees all resources allocated by InitThread.
1101 *****************************************************************************/
1102 static void EndThread( vout_thread_t *p_vout )
1104 int i_index; /* index in heap */
1108 struct tms cpu_usage;
1109 times( &cpu_usage );
1111 msg_Dbg( p_vout, "cpu usage (user: %d, system: %d)",
1112 cpu_usage.tms_utime, cpu_usage.tms_stime );
1116 if( !p_vout->b_direct )
1118 module_Unneed( p_vout, p_vout->chroma.p_module );
1121 /* Destroy all remaining pictures */
1122 for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++ )
1124 if ( p_vout->p_picture[i_index].i_type == MEMORY_PICTURE )
1126 free( p_vout->p_picture[i_index].p_data_orig );
1130 /* Destroy all remaining subpictures */
1131 for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
1133 if( p_vout->p_subpicture[i_index].i_status != FREE_SUBPICTURE )
1135 vout_DestroySubPicture( p_vout,
1136 &p_vout->p_subpicture[i_index] );
1140 if( p_vout->p_text_renderer_module )
1141 module_Unneed( p_vout, p_vout->p_text_renderer_module );
1143 /* Destroy translation tables */
1144 p_vout->pf_end( p_vout );
1146 /* Release the change lock */
1147 vlc_mutex_unlock( &p_vout->change_lock );
1150 /*****************************************************************************
1151 * DestroyThread: thread destruction
1152 *****************************************************************************
1153 * This function is called when the thread ends. It frees all ressources
1154 * allocated by CreateThread. Status is available at this stage.
1155 *****************************************************************************/
1156 static void DestroyThread( vout_thread_t *p_vout )
1158 /* Destroy the locks */
1159 vlc_mutex_destroy( &p_vout->picture_lock );
1160 vlc_mutex_destroy( &p_vout->subpicture_lock );
1161 vlc_mutex_destroy( &p_vout->change_lock );
1163 /* Release the module */
1164 if( p_vout && p_vout->p_module )
1166 module_Unneed( p_vout, p_vout->p_module );
1170 /* following functions are local */
1172 static int ReduceHeight( int i_ratio )
1174 int i_dummy = VOUT_ASPECT_FACTOR;
1182 /* VOUT_ASPECT_FACTOR is (2^7 * 3^3 * 5^3), we just check for 2, 3 and 5 */
1183 while( !(i_ratio & 1) && !(i_dummy & 1) )
1190 while( !(i_ratio % 3) && !(i_dummy % 3) )
1197 while( !(i_ratio % 5) && !(i_dummy % 5) )
1207 /*****************************************************************************
1208 * BinaryLog: computes the base 2 log of a binary value
1209 *****************************************************************************
1210 * This functions is used by MaskToShift, to get a bit index from a binary
1212 *****************************************************************************/
1213 static int BinaryLog( uint32_t i )
1217 if( i == 0 ) return -31337;
1219 if( i & 0xffff0000 ) i_log += 16;
1220 if( i & 0xff00ff00 ) i_log += 8;
1221 if( i & 0xf0f0f0f0 ) i_log += 4;
1222 if( i & 0xcccccccc ) i_log += 2;
1223 if( i & 0xaaaaaaaa ) i_log += 1;
1228 /*****************************************************************************
1229 * MaskToShift: transform a color mask into right and left shifts
1230 *****************************************************************************
1231 * This function is used for obtaining color shifts from masks.
1232 *****************************************************************************/
1233 static void MaskToShift( int *pi_left, int *pi_right, uint32_t i_mask )
1235 uint32_t i_low, i_high; /* lower hand higher bits of the mask */
1239 *pi_left = *pi_right = 0;
1244 i_low = i_mask & (- (int32_t)i_mask); /* lower bit of the mask */
1245 i_high = i_mask + i_low; /* higher bit of the mask */
1247 /* Transform bits into an index */
1248 i_low = BinaryLog (i_low);
1249 i_high = BinaryLog (i_high);
1251 /* Update pointers and return */
1253 *pi_right = (8 - i_high + i_low);
1256 /*****************************************************************************
1257 * InitWindowSize: find the initial dimensions the video window should have.
1258 *****************************************************************************
1259 * This function will check the "width", "height" and "zoom" config options and
1260 * will calculate the size that the video window should have.
1261 *****************************************************************************/
1262 static void InitWindowSize( vout_thread_t *p_vout, int *pi_width,
1266 int i_width, i_height;
1269 #define FP_FACTOR 1000 /* our fixed point factor */
1271 var_Get( p_vout, "align", &val );
1272 p_vout->i_alignment = val.i_int;
1274 var_Get( p_vout, "width", &val );
1275 i_width = val.i_int;
1276 var_Get( p_vout, "height", &val );
1277 i_height = val.i_int;
1278 var_Get( p_vout, "zoom", &val );
1279 ll_zoom = (uint64_t)( FP_FACTOR * val.f_float );
1281 if( i_width > 0 && i_height > 0)
1283 *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
1284 *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
1287 else if( i_width > 0 )
1289 *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
1290 *pi_height = (int)( i_width * ll_zoom * VOUT_ASPECT_FACTOR /
1291 p_vout->render.i_aspect / FP_FACTOR );
1294 else if( i_height > 0 )
1296 *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
1297 *pi_width = (int)( i_height * ll_zoom * p_vout->render.i_aspect /
1298 VOUT_ASPECT_FACTOR / FP_FACTOR );
1302 if( p_vout->render.i_height * p_vout->render.i_aspect
1303 >= p_vout->render.i_width * VOUT_ASPECT_FACTOR )
1305 *pi_width = (int)( p_vout->render.i_height * ll_zoom
1306 * p_vout->render.i_aspect / VOUT_ASPECT_FACTOR / FP_FACTOR );
1307 *pi_height = (int)( p_vout->render.i_height * ll_zoom / FP_FACTOR );
1311 *pi_width = (int)( p_vout->render.i_width * ll_zoom / FP_FACTOR );
1312 *pi_height = (int)( p_vout->render.i_width * ll_zoom
1313 * VOUT_ASPECT_FACTOR / p_vout->render.i_aspect / FP_FACTOR );
1319 /*****************************************************************************
1320 * vout_VarCallback: generic callback for intf variables
1321 *****************************************************************************/
1322 int vout_VarCallback( vlc_object_t * p_this, const char * psz_variable,
1323 vlc_value_t old_value, vlc_value_t new_value,
1326 vout_thread_t * p_vout = (vout_thread_t *)p_this;
1328 val.b_bool = VLC_TRUE;
1329 var_Set( p_vout, "intf-change", val );
1333 /*****************************************************************************
1334 * object variables callbacks: a bunch of object variables are used by the
1335 * interfaces to interact with the vout.
1336 *****************************************************************************/
1337 static int DeinterlaceCallback( vlc_object_t *p_this, char const *psz_cmd,
1338 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1340 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1341 input_thread_t *p_input;
1344 char *psz_mode = newval.psz_string;
1348 psz_filter = config_GetPsz( p_vout, "filter" );
1350 if( !psz_mode || !*psz_mode )
1352 config_PutPsz( p_vout, "filter", "" );
1356 if( !psz_filter || !*psz_filter )
1358 config_PutPsz( p_vout, "filter", "deinterlace" );
1362 if( strstr( psz_filter, "deinterlace" ) == NULL )
1364 psz_filter = realloc( psz_filter, strlen( psz_filter ) + 20 );
1365 strcat( psz_filter, ",deinterlace" );
1367 config_PutPsz( p_vout, "filter", psz_filter );
1371 if( psz_filter ) free( psz_filter );
1374 p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1376 if( !p_input ) return VLC_EGENERIC;
1378 if( psz_mode && *psz_mode )
1380 val.psz_string = psz_mode;
1381 var_Set( p_vout, "deinterlace-mode", val );
1382 /* Modify input as well because the vout might have to be restarted */
1383 var_Create( p_input, "deinterlace-mode", VLC_VAR_STRING );
1384 var_Set( p_input, "deinterlace-mode", val );
1387 /* FIXME FIXME input2 --fenrir */
1389 /* now restart all video streams */
1390 vlc_mutex_lock( &p_input->stream.stream_lock );
1392 p_vout->b_filter_change = VLC_TRUE;
1394 #define ES p_input->stream.pp_es[i]
1396 for( i = 0 ; i < p_input->stream.i_es_number ; i++ )
1398 if( ( ES->i_cat == VIDEO_ES ) && ES->p_dec != NULL )
1400 input_UnselectES( p_input, ES );
1401 input_SelectES( p_input, ES );
1405 vlc_mutex_unlock( &p_input->stream.stream_lock );
1407 vlc_object_release( p_input );
1410 val.b_bool = VLC_TRUE;
1411 var_Set( p_vout, "intf-change", val );
1415 static int FilterCallback( vlc_object_t *p_this, char const *psz_cmd,
1416 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1418 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1419 input_thread_t *p_input;
1423 p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1428 msg_Err( p_vout, "Input not found" );
1429 return( VLC_EGENERIC );
1432 /* FIXME FIXME input2 --fenrir */
1434 /* Restart the video stream */
1435 vlc_mutex_lock( &p_input->stream.stream_lock );
1437 p_vout->b_filter_change = VLC_TRUE;
1439 #define ES p_input->stream.pp_es[i]
1441 for( i = 0 ; i < p_input->stream.i_es_number ; i++ )
1443 if( ( ES->i_cat == VIDEO_ES ) && ES->p_dec != NULL )
1445 input_UnselectES( p_input, ES );
1446 input_SelectES( p_input, ES );
1450 vlc_mutex_unlock( &p_input->stream.stream_lock );
1452 vlc_object_release( p_input );
1455 val.b_bool = VLC_TRUE;
1456 var_Set( p_vout, "intf-change", val );