1 /*****************************************************************************
2 * video_output.c : video output thread
4 * This module describes the programming interface for video output threads.
5 * It includes functions allowing to open a new thread, send pictures to a
6 * thread, and destroy a previously oppened video output thread.
7 *****************************************************************************
8 * Copyright (C) 2000-2004 the VideoLAN team
11 * Authors: Vincent Seguin <seguin@via.ecp.fr>
12 * Gildas Bazin <gbazin@videolan.org>
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software
26 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
27 *****************************************************************************/
29 /*****************************************************************************
31 *****************************************************************************/
32 #include <stdlib.h> /* free() */
36 #ifdef HAVE_SYS_TIMES_H
37 # include <sys/times.h>
40 #include "vlc_video.h"
41 #include "video_output.h"
43 #include <vlc/input.h> /* for input_thread_t and i_pts_delay */
44 #include "vlc_playlist.h"
46 #if defined( SYS_DARWIN )
47 #include "darwin_specific.h"
50 /*****************************************************************************
52 *****************************************************************************/
53 static int InitThread ( vout_thread_t * );
54 static void RunThread ( vout_thread_t * );
55 static void ErrorThread ( vout_thread_t * );
56 static void EndThread ( vout_thread_t * );
57 static void DestroyThread ( vout_thread_t * );
59 static void AspectRatio ( int, int *, int * );
60 static int BinaryLog ( uint32_t );
61 static void MaskToShift ( int *, int *, uint32_t );
62 static void InitWindowSize ( vout_thread_t *, unsigned *, unsigned * );
64 /* Object variables callbacks */
65 static int DeinterlaceCallback( vlc_object_t *, char const *,
66 vlc_value_t, vlc_value_t, void * );
67 static int FilterCallback( vlc_object_t *, char const *,
68 vlc_value_t, vlc_value_t, void * );
70 /* From vout_intf.c */
71 int vout_Snapshot( vout_thread_t *, picture_t * );
73 /*****************************************************************************
74 * vout_Request: find a video output thread, create one, or destroy one.
75 *****************************************************************************
76 * This function looks for a video output thread matching the current
77 * properties. If not found, it spawns a new one.
78 *****************************************************************************/
79 vout_thread_t *__vout_Request( vlc_object_t *p_this, vout_thread_t *p_vout,
80 video_format_t *p_fmt )
84 /* Reattach video output to input before bailing out */
87 vlc_object_t *p_playlist;
89 p_playlist = vlc_object_find( p_this, VLC_OBJECT_PLAYLIST,
94 spu_Attach( p_vout->p_spu, p_this, VLC_FALSE );
95 vlc_object_detach( p_vout );
96 vlc_object_attach( p_vout, p_playlist );
98 vlc_object_release( p_playlist );
102 msg_Dbg( p_this, "cannot find playlist, destroying vout" );
103 vlc_object_detach( p_vout );
104 vout_Destroy( p_vout );
110 /* If a video output was provided, lock it, otherwise look for one. */
113 vlc_object_yield( p_vout );
117 p_vout = vlc_object_find( p_this, VLC_OBJECT_VOUT, FIND_CHILD );
121 playlist_t *p_playlist;
123 p_playlist = vlc_object_find( p_this,
124 VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
127 vlc_mutex_lock( &p_playlist->gc_lock );
128 p_vout = vlc_object_find( p_playlist,
129 VLC_OBJECT_VOUT, FIND_CHILD );
130 /* only first children of p_input for unused vout */
131 if( p_vout && p_vout->p_parent != (vlc_object_t *)p_playlist )
133 vlc_object_release( p_vout );
136 vlc_mutex_unlock( &p_playlist->gc_lock );
137 vlc_object_release( p_playlist );
142 /* If we now have a video output, check it has the right properties */
145 char *psz_filter_chain;
148 /* We don't directly check for the "vout-filter" variable for obvious
149 * performance reasons. */
150 if( p_vout->b_filter_change )
152 var_Get( p_vout, "vout-filter", &val );
153 psz_filter_chain = val.psz_string;
155 if( psz_filter_chain && !*psz_filter_chain )
157 free( psz_filter_chain );
158 psz_filter_chain = NULL;
160 if( p_vout->psz_filter_chain && !*p_vout->psz_filter_chain )
162 free( p_vout->psz_filter_chain );
163 p_vout->psz_filter_chain = NULL;
166 if( !psz_filter_chain && !p_vout->psz_filter_chain )
168 p_vout->b_filter_change = VLC_FALSE;
171 if( psz_filter_chain ) free( psz_filter_chain );
174 if( ( p_vout->fmt_render.i_width != p_fmt->i_width ) ||
175 ( p_vout->fmt_render.i_height != p_fmt->i_height ) ||
176 ( p_vout->fmt_render.i_chroma != p_fmt->i_chroma ) ||
177 ( p_vout->fmt_render.i_aspect != p_fmt->i_aspect
178 && !p_vout->b_override_aspect ) ||
179 p_vout->b_filter_change )
181 /* We are not interested in this format, close this vout */
182 vlc_object_detach( p_vout );
183 vlc_object_release( p_vout );
184 vout_Destroy( p_vout );
189 /* This video output is cool! Hijack it. */
190 vlc_object_detach( p_vout );
191 spu_Attach( p_vout->p_spu, p_this, VLC_TRUE );
192 vlc_object_attach( p_vout, p_this );
193 vlc_object_release( p_vout );
199 msg_Dbg( p_this, "no usable vout present, spawning one" );
201 p_vout = vout_Create( p_this, p_fmt );
207 /*****************************************************************************
208 * vout_Create: creates a new video output thread
209 *****************************************************************************
210 * This function creates a new video output thread, and returns a pointer
211 * to its description. On error, it returns NULL.
212 *****************************************************************************/
213 vout_thread_t * __vout_Create( vlc_object_t *p_parent, video_format_t *p_fmt )
215 vout_thread_t * p_vout; /* thread descriptor */
216 input_thread_t * p_input_thread;
217 int i_index; /* loop variable */
219 vlc_value_t val, val2, text;
221 unsigned int i_width = p_fmt->i_width;
222 unsigned int i_height = p_fmt->i_height;
223 vlc_fourcc_t i_chroma = p_fmt->i_chroma;
224 unsigned int i_aspect = p_fmt->i_aspect;
226 /* Allocate descriptor */
227 p_vout = vlc_object_create( p_parent, VLC_OBJECT_VOUT );
230 msg_Err( p_parent, "out of memory" );
234 /* Initialize pictures - translation tables and functions
235 * will be initialized later in InitThread */
236 for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++)
238 p_vout->p_picture[i_index].pf_lock = NULL;
239 p_vout->p_picture[i_index].pf_unlock = NULL;
240 p_vout->p_picture[i_index].i_status = FREE_PICTURE;
241 p_vout->p_picture[i_index].i_type = EMPTY_PICTURE;
242 p_vout->p_picture[i_index].b_slow = 0;
245 /* No images in the heap */
246 p_vout->i_heap_size = 0;
248 /* Initialize the rendering heap */
249 I_RENDERPICTURES = 0;
250 p_vout->fmt_render = *p_fmt; /* FIXME palette */
251 p_vout->fmt_in = *p_fmt; /* FIXME palette */
252 p_vout->render.i_width = i_width;
253 p_vout->render.i_height = i_height;
254 p_vout->render.i_chroma = i_chroma;
255 p_vout->render.i_aspect = i_aspect;
257 p_vout->render.i_rmask = 0;
258 p_vout->render.i_gmask = 0;
259 p_vout->render.i_bmask = 0;
261 p_vout->render.i_last_used_pic = -1;
262 p_vout->render.b_allow_modify_pics = 1;
264 /* Zero the output heap */
265 I_OUTPUTPICTURES = 0;
266 p_vout->output.i_width = 0;
267 p_vout->output.i_height = 0;
268 p_vout->output.i_chroma = 0;
269 p_vout->output.i_aspect = 0;
271 p_vout->output.i_rmask = 0;
272 p_vout->output.i_gmask = 0;
273 p_vout->output.i_bmask = 0;
275 /* Initialize misc stuff */
276 p_vout->i_changes = 0;
278 p_vout->b_grayscale = 0;
280 p_vout->b_interface = 0;
282 p_vout->b_fullscreen = 0;
283 p_vout->i_alignment = 0;
284 p_vout->render_time = 10;
285 p_vout->c_fps_samples = 0;
286 p_vout->b_filter_change = 0;
287 p_vout->pf_control = 0;
288 p_vout->p_parent_intf = 0;
290 /* Initialize locks */
291 vlc_mutex_init( p_vout, &p_vout->picture_lock );
292 vlc_mutex_init( p_vout, &p_vout->change_lock );
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 /* Initialize subpicture unit */
302 p_vout->p_spu = spu_Create( p_vout );
303 spu_Attach( p_vout->p_spu, p_parent, VLC_TRUE );
305 /* Attach the new object now so we can use var inheritance below */
306 vlc_object_attach( p_vout, p_parent );
308 spu_Init( p_vout->p_spu );
310 /* Take care of some "interface/control" related initialisations */
311 vout_IntfInit( p_vout );
313 p_vout->b_override_aspect = VLC_FALSE;
315 /* If the parent is not a VOUT object, that means we are at the start of
316 * the video output pipe */
317 if( p_parent->i_object_type != VLC_OBJECT_VOUT )
319 int i_monitor_aspect_x = 4 , i_monitor_aspect_y = 3;
320 var_Get( p_vout, "aspect-ratio", &val );
321 var_Get( p_vout, "monitor-aspect-ratio", &val2 );
323 if( val2.psz_string )
325 char *psz_parser = strchr( val2.psz_string, ':' );
328 *psz_parser++ = '\0';
329 i_monitor_aspect_x = atoi( val2.psz_string );
330 i_monitor_aspect_y = atoi( psz_parser );
332 AspectRatio( VOUT_ASPECT_FACTOR * atof( val2.psz_string ),
333 &i_monitor_aspect_x, &i_monitor_aspect_y );
336 free( val2.psz_string );
339 /* Check whether the user tried to override aspect ratio */
342 unsigned int i_new_aspect = i_aspect;
343 char *psz_parser = strchr( val.psz_string, ':' );
344 int i_aspect_x, i_aspect_y;
345 AspectRatio( i_aspect, &i_aspect_x, &i_aspect_y );
349 *psz_parser++ = '\0';
350 i_new_aspect = atoi( val.psz_string )
351 * VOUT_ASPECT_FACTOR / atoi( psz_parser );
355 if( atof( val.psz_string ) != 0 )
357 i_new_aspect = VOUT_ASPECT_FACTOR * atof( val.psz_string );
360 i_new_aspect = (int)((float)i_new_aspect
361 * (float)i_monitor_aspect_y*4.0/((float)i_monitor_aspect_x*3.0));
363 free( val.psz_string );
365 if( i_new_aspect && i_new_aspect != i_aspect )
367 int i_aspect_x, i_aspect_y;
369 AspectRatio( i_new_aspect, &i_aspect_x, &i_aspect_y );
371 msg_Dbg( p_vout, "overriding source aspect ratio to %i:%i",
372 i_aspect_x, i_aspect_y );
374 p_vout->render.i_aspect = i_new_aspect;
376 p_vout->b_override_aspect = VLC_TRUE;
380 /* Look for the default filter configuration */
381 var_Create( p_vout, "vout-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
382 var_Get( p_vout, "vout-filter", &val );
383 p_vout->psz_filter_chain = val.psz_string;
387 /* continue the parent's filter chain */
390 psz_end = strchr( ((vout_thread_t *)p_parent)->psz_filter_chain, ':' );
391 if( psz_end && *(psz_end+1) )
392 p_vout->psz_filter_chain = strdup( psz_end+1 );
393 else p_vout->psz_filter_chain = NULL;
396 /* Choose the video output module */
397 if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
399 var_Create( p_vout, "vout", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
400 var_Get( p_vout, "vout", &val );
401 psz_plugin = val.psz_string;
405 /* the filter chain is a string list of filters separated by double
409 psz_end = strchr( p_vout->psz_filter_chain, ':' );
411 psz_plugin = strndup( p_vout->psz_filter_chain,
412 psz_end - p_vout->psz_filter_chain );
413 else psz_plugin = strdup( p_vout->psz_filter_chain );
416 /* Initialize the dimensions of the video window */
417 InitWindowSize( p_vout, &p_vout->i_window_width,
418 &p_vout->i_window_height );
420 /* Create the vout thread */
421 p_vout->p_module = module_Need( p_vout,
422 ( p_vout->psz_filter_chain && *p_vout->psz_filter_chain ) ?
423 "video filter" : "video output", psz_plugin, 0 );
425 if( psz_plugin ) free( psz_plugin );
426 if( p_vout->p_module == NULL )
428 msg_Err( p_vout, "no suitable vout module" );
429 vlc_object_detach( p_vout );
430 vlc_object_destroy( p_vout );
434 /* Create a few object variables for interface interaction */
435 var_Create( p_vout, "deinterlace", VLC_VAR_STRING | VLC_VAR_HASCHOICE );
436 text.psz_string = _("Deinterlace");
437 var_Change( p_vout, "deinterlace", VLC_VAR_SETTEXT, &text, NULL );
438 val.psz_string = ""; text.psz_string = _("Disable");
439 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
440 val.psz_string = "discard"; text.psz_string = _("Discard");
441 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
442 val.psz_string = "blend"; text.psz_string = _("Blend");
443 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
444 val.psz_string = "mean"; text.psz_string = _("Mean");
445 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
446 val.psz_string = "bob"; text.psz_string = _("Bob");
447 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
448 val.psz_string = "linear"; text.psz_string = _("Linear");
449 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
450 val.psz_string = "x"; text.psz_string = "X";
451 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
453 if( var_Get( p_vout, "deinterlace-mode", &val ) == VLC_SUCCESS )
455 var_Set( p_vout, "deinterlace", val );
456 if( val.psz_string ) free( val.psz_string );
458 var_AddCallback( p_vout, "deinterlace", DeinterlaceCallback, NULL );
461 var_Create( p_vout, "vout-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
462 text.psz_string = _("Filters");
463 var_Change( p_vout, "vout-filter", VLC_VAR_SETTEXT, &text, NULL );
464 var_AddCallback( p_vout, "vout-filter", FilterCallback, NULL );
466 /* Calculate delay created by internal caching */
467 p_input_thread = (input_thread_t *)vlc_object_find( p_vout,
468 VLC_OBJECT_INPUT, FIND_ANYWHERE );
471 p_vout->i_pts_delay = p_input_thread->i_pts_delay;
472 vlc_object_release( p_input_thread );
476 p_vout->i_pts_delay = DEFAULT_PTS_DELAY;
479 if( vlc_thread_create( p_vout, "video output", RunThread,
480 VLC_THREAD_PRIORITY_OUTPUT, VLC_TRUE ) )
482 msg_Err( p_vout, "out of memory" );
483 module_Unneed( p_vout, p_vout->p_module );
484 vlc_object_detach( p_vout );
485 vlc_object_destroy( p_vout );
489 if( p_vout->b_error )
491 msg_Err( p_vout, "video output creation failed" );
493 /* Make sure the thread is destroyed */
494 p_vout->b_die = VLC_TRUE;
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 )
560 int i, i_aspect_x, i_aspect_y;
562 vlc_mutex_lock( &p_vout->change_lock );
568 /* Initialize output method, it allocates direct buffers for us */
569 if( p_vout->pf_init( p_vout ) )
571 vlc_mutex_unlock( &p_vout->change_lock );
575 if( !I_OUTPUTPICTURES )
577 msg_Err( p_vout, "plugin was unable to allocate at least "
578 "one direct buffer" );
579 p_vout->pf_end( p_vout );
580 vlc_mutex_unlock( &p_vout->change_lock );
584 if( I_OUTPUTPICTURES > VOUT_MAX_PICTURES )
586 msg_Err( p_vout, "plugin allocated too many direct buffers, "
587 "our internal buffers must have overflown." );
588 p_vout->pf_end( p_vout );
589 vlc_mutex_unlock( &p_vout->change_lock );
593 msg_Dbg( p_vout, "got %i direct buffer(s)", I_OUTPUTPICTURES );
595 AspectRatio( p_vout->fmt_render.i_aspect, &i_aspect_x, &i_aspect_y );
597 msg_Dbg( p_vout, "picture in %ix%i (%i,%i,%ix%i), "
598 "chroma %4.4s, ar %i:%i, sar %i:%i",
599 p_vout->fmt_render.i_width, p_vout->fmt_render.i_height,
600 p_vout->fmt_render.i_x_offset, p_vout->fmt_render.i_y_offset,
601 p_vout->fmt_render.i_visible_width,
602 p_vout->fmt_render.i_visible_height,
603 (char*)&p_vout->fmt_render.i_chroma,
604 i_aspect_x, i_aspect_y,
605 p_vout->fmt_render.i_sar_num, p_vout->fmt_render.i_sar_den );
607 AspectRatio( p_vout->fmt_in.i_aspect, &i_aspect_x, &i_aspect_y );
609 msg_Dbg( p_vout, "picture user %ix%i (%i,%i,%ix%i), "
610 "chroma %4.4s, ar %i:%i, sar %i:%i",
611 p_vout->fmt_in.i_width, p_vout->fmt_in.i_height,
612 p_vout->fmt_in.i_x_offset, p_vout->fmt_in.i_y_offset,
613 p_vout->fmt_in.i_visible_width,
614 p_vout->fmt_in.i_visible_height,
615 (char*)&p_vout->fmt_in.i_chroma,
616 i_aspect_x, i_aspect_y,
617 p_vout->fmt_in.i_sar_num, p_vout->fmt_in.i_sar_den );
619 if( !p_vout->fmt_out.i_width || !p_vout->fmt_out.i_height )
621 p_vout->fmt_out.i_width = p_vout->fmt_out.i_visible_width =
622 p_vout->output.i_width;
623 p_vout->fmt_out.i_height = p_vout->fmt_out.i_visible_height =
624 p_vout->output.i_height;
625 p_vout->fmt_out.i_x_offset = p_vout->fmt_out.i_y_offset = 0;
627 p_vout->fmt_out.i_aspect = p_vout->output.i_aspect;
628 p_vout->fmt_out.i_chroma = p_vout->output.i_chroma;
630 if( !p_vout->fmt_out.i_sar_num || !p_vout->fmt_out.i_sar_num )
632 p_vout->fmt_out.i_sar_num = p_vout->fmt_out.i_aspect *
633 p_vout->fmt_out.i_height;
634 p_vout->fmt_out.i_sar_den = VOUT_ASPECT_FACTOR *
635 p_vout->fmt_out.i_width;
638 vlc_ureduce( &p_vout->fmt_out.i_sar_num, &p_vout->fmt_out.i_sar_den,
639 p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den, 0 );
641 AspectRatio( p_vout->fmt_out.i_aspect, &i_aspect_x, &i_aspect_y );
643 msg_Dbg( p_vout, "picture out %ix%i, chroma %4.4s, ar %i:%i, sar %i:%i",
644 p_vout->output.i_width, p_vout->output.i_height,
645 (char*)&p_vout->output.i_chroma,
646 i_aspect_x, i_aspect_y,
647 p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den );
649 /* Calculate shifts from system-updated masks */
650 MaskToShift( &p_vout->output.i_lrshift, &p_vout->output.i_rrshift,
651 p_vout->output.i_rmask );
652 MaskToShift( &p_vout->output.i_lgshift, &p_vout->output.i_rgshift,
653 p_vout->output.i_gmask );
654 MaskToShift( &p_vout->output.i_lbshift, &p_vout->output.i_rbshift,
655 p_vout->output.i_bmask );
657 /* Check whether we managed to create direct buffers similar to
658 * the render buffers, ie same size and chroma */
659 if( ( p_vout->output.i_width == p_vout->render.i_width )
660 && ( p_vout->output.i_height == p_vout->render.i_height )
661 && ( vout_ChromaCmp( p_vout->output.i_chroma, p_vout->render.i_chroma ) ) )
663 /* Cool ! We have direct buffers, we can ask the decoder to
664 * directly decode into them ! Map the first render buffers to
665 * the first direct buffers, but keep the first direct buffer
666 * for memcpy operations */
667 p_vout->b_direct = 1;
669 for( i = 1; i < VOUT_MAX_PICTURES; i++ )
671 if( p_vout->p_picture[ i ].i_type != DIRECT_PICTURE &&
672 I_RENDERPICTURES >= VOUT_MIN_DIRECT_PICTURES - 1 &&
673 p_vout->p_picture[ i - 1 ].i_type == DIRECT_PICTURE )
675 /* We have enough direct buffers so there's no need to
676 * try to use system memory buffers. */
679 PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
683 msg_Dbg( p_vout, "direct render, mapping "
684 "render pictures 0-%i to system pictures 1-%i",
685 VOUT_MAX_PICTURES - 2, VOUT_MAX_PICTURES - 1 );
689 /* Rats... Something is wrong here, we could not find an output
690 * plugin able to directly render what we decode. See if we can
691 * find a chroma plugin to do the conversion */
692 p_vout->b_direct = 0;
694 /* Choose the best module */
695 p_vout->chroma.p_module = module_Need( p_vout, "chroma", NULL, 0 );
697 if( p_vout->chroma.p_module == NULL )
699 msg_Err( p_vout, "no chroma module for %4.4s to %4.4s",
700 (char*)&p_vout->render.i_chroma,
701 (char*)&p_vout->output.i_chroma );
702 p_vout->pf_end( p_vout );
703 vlc_mutex_unlock( &p_vout->change_lock );
707 msg_Dbg( p_vout, "indirect render, mapping "
708 "render pictures 0-%i to system pictures %i-%i",
709 VOUT_MAX_PICTURES - 1, I_OUTPUTPICTURES,
710 I_OUTPUTPICTURES + VOUT_MAX_PICTURES - 1 );
712 /* Append render buffers after the direct buffers */
713 for( i = I_OUTPUTPICTURES; i < 2 * VOUT_MAX_PICTURES; i++ )
715 PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
718 /* Check if we have enough render pictures */
719 if( I_RENDERPICTURES == VOUT_MAX_PICTURES )
724 /* Link pictures back to their heap */
725 for( i = 0 ; i < I_RENDERPICTURES ; i++ )
727 PP_RENDERPICTURE[ i ]->p_heap = &p_vout->render;
730 for( i = 0 ; i < I_OUTPUTPICTURES ; i++ )
732 PP_OUTPUTPICTURE[ i ]->p_heap = &p_vout->output;
735 /* XXX XXX mark thread ready */
739 /*****************************************************************************
740 * RunThread: video output thread
741 *****************************************************************************
742 * Video output thread. This function does only returns when the thread is
743 * terminated. It handles the pictures arriving in the video heap and the
744 * display device events.
745 *****************************************************************************/
746 static void RunThread( vout_thread_t *p_vout)
748 int i_index; /* index in heap */
749 int i_idle_loops = 0; /* loops without displaying a picture */
750 mtime_t current_date; /* current date */
751 mtime_t display_date; /* display date */
753 picture_t * p_picture; /* picture pointer */
754 picture_t * p_last_picture = NULL; /* last picture */
755 picture_t * p_directbuffer; /* direct buffer to display */
757 subpicture_t * p_subpic = NULL; /* subpicture pointer */
762 p_vout->b_error = InitThread( p_vout );
764 /* signal the creation of the vout */
765 vlc_thread_ready( p_vout );
767 if( p_vout->b_error )
769 /* Destroy thread structures allocated by Create and InitThread */
770 DestroyThread( p_vout );
775 * Main loop - it is not executed if an error occurred during
778 while( (!p_vout->b_die) && (!p_vout->b_error) )
780 /* Initialize loop variables */
783 current_date = mdate();
787 if( !(p_vout->c_loops % VOUT_STATS_NB_LOOPS) )
789 msg_Dbg( p_vout, "picture heap: %d/%d",
790 I_RENDERPICTURES, p_vout->i_heap_size );
795 * Find the picture to display (the one with the earliest date).
796 * This operation does not need lock, since only READY_PICTUREs
798 for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
800 if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
801 && ( (p_picture == NULL) ||
802 (PP_RENDERPICTURE[i_index]->date < display_date) ) )
804 p_picture = PP_RENDERPICTURE[i_index];
805 display_date = p_picture->date;
811 /* If we met the last picture, parse again to see whether there is
812 * a more appropriate one. */
813 if( p_picture == p_last_picture )
815 for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
817 if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
818 && (PP_RENDERPICTURE[i_index] != p_last_picture)
819 && ((p_picture == p_last_picture) ||
820 (PP_RENDERPICTURE[i_index]->date < display_date)) )
822 p_picture = PP_RENDERPICTURE[i_index];
823 display_date = p_picture->date;
828 /* If we found better than the last picture, destroy it */
829 if( p_last_picture && p_picture != p_last_picture )
831 vlc_mutex_lock( &p_vout->picture_lock );
832 if( p_last_picture->i_refcount )
834 p_last_picture->i_status = DISPLAYED_PICTURE;
838 p_last_picture->i_status = DESTROYED_PICTURE;
839 p_vout->i_heap_size--;
841 vlc_mutex_unlock( &p_vout->picture_lock );
842 p_last_picture = NULL;
845 /* Compute FPS rate */
846 p_vout->p_fps_sample[ p_vout->c_fps_samples++ % VOUT_FPS_SAMPLES ]
849 if( !p_picture->b_force &&
850 p_picture != p_last_picture &&
851 display_date < current_date + p_vout->render_time )
853 /* Picture is late: it will be destroyed and the thread
854 * will directly choose the next picture */
855 vlc_mutex_lock( &p_vout->picture_lock );
856 if( p_picture->i_refcount )
858 /* Pretend we displayed the picture, but don't destroy
859 * it since the decoder might still need it. */
860 p_picture->i_status = DISPLAYED_PICTURE;
864 /* Destroy the picture without displaying it */
865 p_picture->i_status = DESTROYED_PICTURE;
866 p_vout->i_heap_size--;
868 msg_Warn( p_vout, "late picture skipped ("I64Fd")",
869 current_date - display_date );
870 vlc_mutex_unlock( &p_vout->picture_lock );
876 current_date + p_vout->i_pts_delay + VOUT_BOGUS_DELAY )
878 /* Picture is waaay too early: it will be destroyed */
879 vlc_mutex_lock( &p_vout->picture_lock );
880 if( p_picture->i_refcount )
882 /* Pretend we displayed the picture, but don't destroy
883 * it since the decoder might still need it. */
884 p_picture->i_status = DISPLAYED_PICTURE;
888 /* Destroy the picture without displaying it */
889 p_picture->i_status = DESTROYED_PICTURE;
890 p_vout->i_heap_size--;
892 msg_Warn( p_vout, "vout warning: early picture skipped "
893 "("I64Fd")", display_date - current_date
894 - p_vout->i_pts_delay );
895 vlc_mutex_unlock( &p_vout->picture_lock );
900 if( display_date > current_date + VOUT_DISPLAY_DELAY )
902 /* A picture is ready to be rendered, but its rendering date
903 * is far from the current one so the thread will perform an
904 * empty loop as if no picture were found. The picture state
909 else if( p_picture == p_last_picture )
911 /* We are asked to repeat the previous picture, but we first
912 * wait for a couple of idle loops */
913 if( i_idle_loops < 4 )
920 /* We set the display date to something high, otherwise
921 * we'll have lots of problems with late pictures */
922 display_date = current_date + p_vout->render_time;
927 if( p_picture == NULL )
932 if( p_picture && p_vout->b_snapshot )
934 p_vout->b_snapshot = VLC_FALSE;
935 vout_Snapshot( p_vout, p_picture );
939 * Check for subpictures to display
941 if( display_date > 0 )
943 p_subpic = spu_SortSubpictures( p_vout->p_spu, display_date );
949 p_directbuffer = vout_RenderPicture( p_vout, p_picture, p_subpic );
952 * Call the plugin-specific rendering method if there is one
954 if( p_picture != NULL && p_directbuffer != NULL && p_vout->pf_render )
956 /* Render the direct buffer returned by vout_RenderPicture */
957 p_vout->pf_render( p_vout, p_directbuffer );
963 if( display_date != 0 && p_directbuffer != NULL )
965 mtime_t current_render_time = mdate() - current_date;
966 /* if render time is very large we don't include it in the mean */
967 if( current_render_time < p_vout->render_time +
970 /* Store render time using a sliding mean weighting to
971 * current value in a 3 to 1 ratio*/
972 p_vout->render_time *= 3;
973 p_vout->render_time += current_render_time;
974 p_vout->render_time >>= 2;
978 /* Give back change lock */
979 vlc_mutex_unlock( &p_vout->change_lock );
981 /* Sleep a while or until a given date */
982 if( display_date != 0 )
984 /* If there are filters in the chain, better give them the picture
986 if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
988 mwait( display_date - VOUT_MWAIT_TOLERANCE );
993 msleep( VOUT_IDLE_SLEEP );
996 /* On awakening, take back lock and send immediately picture
998 vlc_mutex_lock( &p_vout->change_lock );
1001 * Display the previously rendered picture
1003 if( p_picture != NULL && p_directbuffer != NULL )
1005 /* Display the direct buffer returned by vout_RenderPicture */
1006 if( p_vout->pf_display )
1008 p_vout->pf_display( p_vout, p_directbuffer );
1011 /* Tell the vout this was the last picture and that it does not
1012 * need to be forced anymore. */
1013 p_last_picture = p_picture;
1014 p_last_picture->b_force = 0;
1017 if( p_picture != NULL )
1019 /* Reinitialize idle loop count */
1024 * Check events and manage thread
1026 if( p_vout->pf_manage && p_vout->pf_manage( p_vout ) )
1028 /* A fatal error occurred, and the thread must terminate
1029 * immediately, without displaying anything - setting b_error to 1
1030 * causes the immediate end of the main while() loop. */
1031 p_vout->b_error = 1;
1034 if( p_vout->i_changes & VOUT_SIZE_CHANGE )
1036 /* this must only happen when the vout plugin is incapable of
1037 * rescaling the picture itself. In this case we need to destroy
1038 * the current picture buffers and recreate new ones with the right
1042 p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
1044 p_vout->pf_end( p_vout );
1045 for( i = 0; i < I_OUTPUTPICTURES; i++ )
1046 p_vout->p_picture[ i ].i_status = FREE_PICTURE;
1048 I_OUTPUTPICTURES = 0;
1049 if( p_vout->pf_init( p_vout ) )
1051 msg_Err( p_vout, "cannot resize display" );
1052 /* FIXME: pf_end will be called again in EndThread() */
1053 p_vout->b_error = 1;
1056 /* Need to reinitialise the chroma plugin */
1057 if( p_vout->chroma.p_module )
1059 if( p_vout->chroma.p_module->pf_deactivate )
1060 p_vout->chroma.p_module->pf_deactivate( VLC_OBJECT(p_vout) );
1061 p_vout->chroma.p_module->pf_activate( VLC_OBJECT(p_vout) );
1065 if( p_vout->i_changes & VOUT_PICTURE_BUFFERS_CHANGE )
1067 /* This happens when the picture buffers need to be recreated.
1068 * This is useful on multimonitor displays for instance.
1070 * Warning: This only works when the vout creates only 1 picture
1072 p_vout->i_changes &= ~VOUT_PICTURE_BUFFERS_CHANGE;
1074 if( !p_vout->b_direct )
1076 module_Unneed( p_vout, p_vout->chroma.p_module );
1079 vlc_mutex_lock( &p_vout->picture_lock );
1081 p_vout->pf_end( p_vout );
1083 I_OUTPUTPICTURES = I_RENDERPICTURES = 0;
1085 p_vout->b_error = InitThread( p_vout );
1087 vlc_mutex_unlock( &p_vout->picture_lock );
1092 * Error loop - wait until the thread destruction is requested
1094 if( p_vout->b_error )
1096 ErrorThread( p_vout );
1100 EndThread( p_vout );
1102 /* Destroy thread structures allocated by CreateThread */
1103 DestroyThread( p_vout );
1106 /*****************************************************************************
1107 * ErrorThread: RunThread() error loop
1108 *****************************************************************************
1109 * This function is called when an error occurred during thread main's loop.
1110 * The thread can still receive feed, but must be ready to terminate as soon
1112 *****************************************************************************/
1113 static void ErrorThread( vout_thread_t *p_vout )
1115 /* Wait until a `die' order */
1116 while( !p_vout->b_die )
1119 msleep( VOUT_IDLE_SLEEP );
1123 /*****************************************************************************
1124 * EndThread: thread destruction
1125 *****************************************************************************
1126 * This function is called when the thread ends after a sucessful
1127 * initialization. It frees all resources allocated by InitThread.
1128 *****************************************************************************/
1129 static void EndThread( vout_thread_t *p_vout )
1131 int i_index; /* index in heap */
1135 struct tms cpu_usage;
1136 times( &cpu_usage );
1138 msg_Dbg( p_vout, "cpu usage (user: %d, system: %d)",
1139 cpu_usage.tms_utime, cpu_usage.tms_stime );
1143 if( !p_vout->b_direct )
1145 module_Unneed( p_vout, p_vout->chroma.p_module );
1148 /* Destroy all remaining pictures */
1149 for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++ )
1151 if ( p_vout->p_picture[i_index].i_type == MEMORY_PICTURE )
1153 free( p_vout->p_picture[i_index].p_data_orig );
1157 /* Destroy subpicture unit */
1158 spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), VLC_FALSE );
1159 spu_Destroy( p_vout->p_spu );
1161 /* Destroy translation tables */
1162 p_vout->pf_end( p_vout );
1164 /* Release the change lock */
1165 vlc_mutex_unlock( &p_vout->change_lock );
1168 /*****************************************************************************
1169 * DestroyThread: thread destruction
1170 *****************************************************************************
1171 * This function is called when the thread ends. It frees all ressources
1172 * allocated by CreateThread. Status is available at this stage.
1173 *****************************************************************************/
1174 static void DestroyThread( vout_thread_t *p_vout )
1176 /* Destroy the locks */
1177 vlc_mutex_destroy( &p_vout->picture_lock );
1178 vlc_mutex_destroy( &p_vout->change_lock );
1180 /* Release the module */
1181 if( p_vout && p_vout->p_module )
1183 module_Unneed( p_vout, p_vout->p_module );
1187 /* following functions are local */
1189 static int ReduceHeight( int i_ratio )
1191 int i_dummy = VOUT_ASPECT_FACTOR;
1199 /* VOUT_ASPECT_FACTOR is (2^7 * 3^3 * 5^3), we just check for 2, 3 and 5 */
1200 while( !(i_ratio & 1) && !(i_dummy & 1) )
1207 while( !(i_ratio % 3) && !(i_dummy % 3) )
1214 while( !(i_ratio % 5) && !(i_dummy % 5) )
1224 static void AspectRatio( int i_aspect, int *i_aspect_x, int *i_aspect_y )
1226 unsigned int i_pgcd = ReduceHeight( i_aspect );
1227 *i_aspect_x = i_aspect / i_pgcd;
1228 *i_aspect_y = VOUT_ASPECT_FACTOR / i_pgcd;
1231 /*****************************************************************************
1232 * BinaryLog: computes the base 2 log of a binary value
1233 *****************************************************************************
1234 * This functions is used by MaskToShift, to get a bit index from a binary
1236 *****************************************************************************/
1237 static int BinaryLog( uint32_t i )
1241 if( i == 0 ) return -31337;
1243 if( i & 0xffff0000 ) i_log += 16;
1244 if( i & 0xff00ff00 ) i_log += 8;
1245 if( i & 0xf0f0f0f0 ) i_log += 4;
1246 if( i & 0xcccccccc ) i_log += 2;
1247 if( i & 0xaaaaaaaa ) i_log += 1;
1252 /*****************************************************************************
1253 * MaskToShift: transform a color mask into right and left shifts
1254 *****************************************************************************
1255 * This function is used for obtaining color shifts from masks.
1256 *****************************************************************************/
1257 static void MaskToShift( int *pi_left, int *pi_right, uint32_t i_mask )
1259 uint32_t i_low, i_high; /* lower hand higher bits of the mask */
1263 *pi_left = *pi_right = 0;
1268 i_low = i_mask & (- (int32_t)i_mask); /* lower bit of the mask */
1269 i_high = i_mask + i_low; /* higher bit of the mask */
1271 /* Transform bits into an index */
1272 i_low = BinaryLog (i_low);
1273 i_high = BinaryLog (i_high);
1275 /* Update pointers and return */
1277 *pi_right = (8 - i_high + i_low);
1280 /*****************************************************************************
1281 * InitWindowSize: find the initial dimensions the video window should have.
1282 *****************************************************************************
1283 * This function will check the "width", "height" and "zoom" config options and
1284 * will calculate the size that the video window should have.
1285 *****************************************************************************/
1286 static void InitWindowSize( vout_thread_t *p_vout, unsigned *pi_width,
1287 unsigned *pi_height )
1290 int i_width, i_height;
1293 #define FP_FACTOR 1000 /* our fixed point factor */
1295 var_Get( p_vout, "align", &val );
1296 p_vout->i_alignment = val.i_int;
1298 var_Get( p_vout, "width", &val );
1299 i_width = val.i_int;
1300 var_Get( p_vout, "height", &val );
1301 i_height = val.i_int;
1302 var_Get( p_vout, "zoom", &val );
1303 ll_zoom = (uint64_t)( FP_FACTOR * val.f_float );
1305 if( i_width > 0 && i_height > 0)
1307 *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
1308 *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
1311 else if( i_width > 0 )
1313 *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
1314 *pi_height = (int)( i_width * ll_zoom * VOUT_ASPECT_FACTOR /
1315 p_vout->render.i_aspect / FP_FACTOR );
1318 else if( i_height > 0 )
1320 *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
1321 *pi_width = (int)( i_height * ll_zoom * p_vout->render.i_aspect /
1322 VOUT_ASPECT_FACTOR / FP_FACTOR );
1326 if( p_vout->render.i_height * p_vout->render.i_aspect
1327 >= p_vout->render.i_width * VOUT_ASPECT_FACTOR )
1329 *pi_width = (int)( p_vout->render.i_height * ll_zoom
1330 * p_vout->render.i_aspect / VOUT_ASPECT_FACTOR / FP_FACTOR );
1331 *pi_height = (int)( p_vout->render.i_height * ll_zoom / FP_FACTOR );
1335 *pi_width = (int)( p_vout->render.i_width * ll_zoom / FP_FACTOR );
1336 *pi_height = (int)( p_vout->render.i_width * ll_zoom
1337 * VOUT_ASPECT_FACTOR / p_vout->render.i_aspect / FP_FACTOR );
1343 /*****************************************************************************
1344 * vout_VarCallback: generic callback for intf variables
1345 *****************************************************************************/
1346 int vout_VarCallback( vlc_object_t * p_this, const char * psz_variable,
1347 vlc_value_t old_value, vlc_value_t new_value,
1350 vout_thread_t * p_vout = (vout_thread_t *)p_this;
1352 val.b_bool = VLC_TRUE;
1353 var_Set( p_vout, "intf-change", val );
1357 /*****************************************************************************
1358 * Helper thread for object variables callbacks.
1359 * Only used to avoid deadlocks when using the video embedded mode.
1360 *****************************************************************************/
1361 typedef struct suxor_thread_t
1364 input_thread_t *p_input;
1368 static void SuxorRestartVideoES( suxor_thread_t *p_this )
1372 vlc_thread_ready( p_this );
1374 /* Now restart current video stream */
1375 var_Get( p_this->p_input, "video-es", &val );
1376 if( val.i_int >= 0 )
1379 val_es.i_int = -VIDEO_ES;
1380 var_Set( p_this->p_input, "video-es", val_es );
1381 var_Set( p_this->p_input, "video-es", val );
1384 vlc_object_release( p_this->p_input );
1387 CloseHandle( p_this->thread_id );
1390 vlc_object_destroy( p_this );
1393 /*****************************************************************************
1394 * object variables callbacks: a bunch of object variables are used by the
1395 * interfaces to interact with the vout.
1396 *****************************************************************************/
1397 static int DeinterlaceCallback( vlc_object_t *p_this, char const *psz_cmd,
1398 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1400 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1401 input_thread_t *p_input;
1404 char *psz_mode = newval.psz_string;
1405 char *psz_filter, *psz_deinterlace = NULL;
1407 var_Get( p_vout, "vout-filter", &val );
1408 psz_filter = val.psz_string;
1409 if( psz_filter ) psz_deinterlace = strstr( psz_filter, "deinterlace" );
1411 if( !psz_mode || !*psz_mode )
1413 if( psz_deinterlace )
1415 char *psz_src = psz_deinterlace + sizeof("deinterlace") - 1;
1416 if( psz_src[0] == ':' ) psz_src++;
1417 memmove( psz_deinterlace, psz_src, strlen(psz_src) + 1 );
1420 else if( !psz_deinterlace )
1422 psz_filter = realloc( psz_filter, strlen( psz_filter ) +
1423 sizeof(":deinterlace") );
1424 if( psz_filter && *psz_filter ) strcat( psz_filter, ":" );
1425 strcat( psz_filter, "deinterlace" );
1428 p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1430 if( !p_input ) return VLC_EGENERIC;
1432 if( psz_mode && *psz_mode )
1434 /* Modify input as well because the vout might have to be restarted */
1435 val.psz_string = psz_mode;
1436 var_Create( p_input, "deinterlace-mode", VLC_VAR_STRING );
1437 var_Set( p_input, "deinterlace-mode", val );
1439 vlc_object_release( p_input );
1441 val.b_bool = VLC_TRUE;
1442 var_Set( p_vout, "intf-change", val );
1444 val.psz_string = psz_filter;
1445 var_Set( p_vout, "vout-filter", val );
1446 if( psz_filter ) free( psz_filter );
1451 static int FilterCallback( vlc_object_t *p_this, char const *psz_cmd,
1452 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1454 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1455 input_thread_t *p_input;
1458 p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1462 msg_Err( p_vout, "Input not found" );
1463 return( VLC_EGENERIC );
1466 val.b_bool = VLC_TRUE;
1467 var_Set( p_vout, "intf-change", val );
1469 /* Modify input as well because the vout might have to be restarted */
1470 val.psz_string = newval.psz_string;
1471 var_Create( p_input, "vout-filter", VLC_VAR_STRING );
1473 var_Set( p_input, "vout-filter", val );
1475 /* Now restart current video stream */
1476 var_Get( p_input, "video-es", &val );
1477 if( val.i_int >= 0 )
1479 suxor_thread_t *p_suxor =
1480 vlc_object_create( p_vout, sizeof(suxor_thread_t) );
1481 p_suxor->p_input = p_input;
1482 p_vout->b_filter_change = VLC_TRUE;
1483 vlc_object_yield( p_input );
1484 vlc_thread_create( p_suxor, "suxor", SuxorRestartVideoES,
1485 VLC_THREAD_PRIORITY_LOW, VLC_FALSE );
1488 vlc_object_release( p_input );