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 VideoLAN
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 */
45 #if defined( SYS_DARWIN )
46 #include "darwin_specific.h"
49 /*****************************************************************************
51 *****************************************************************************/
52 static int InitThread ( vout_thread_t * );
53 static void RunThread ( vout_thread_t * );
54 static void ErrorThread ( vout_thread_t * );
55 static void EndThread ( vout_thread_t * );
56 static void DestroyThread ( vout_thread_t * );
58 static void AspectRatio ( int, int *, int * );
59 static int BinaryLog ( uint32_t );
60 static void MaskToShift ( int *, int *, uint32_t );
61 static void InitWindowSize ( vout_thread_t *, int *, int * );
63 /* Object variables callbacks */
64 static int DeinterlaceCallback( vlc_object_t *, char const *,
65 vlc_value_t, vlc_value_t, void * );
66 static int FilterCallback( vlc_object_t *, char const *,
67 vlc_value_t, vlc_value_t, void * );
69 /* From vout_intf.c */
70 int vout_Snapshot( vout_thread_t *, picture_t * );
72 /*****************************************************************************
73 * vout_Request: find a video output thread, create one, or destroy one.
74 *****************************************************************************
75 * This function looks for a video output thread matching the current
76 * properties. If not found, it spawns a new one.
77 *****************************************************************************/
78 vout_thread_t *__vout_Request( vlc_object_t *p_this, vout_thread_t *p_vout,
79 video_format_t *p_fmt )
83 /* Reattach video output to input before bailing out */
86 vlc_object_t *p_playlist;
88 p_playlist = vlc_object_find( p_this, VLC_OBJECT_PLAYLIST,
93 spu_Attach( p_vout->p_spu, p_this, VLC_FALSE );
94 vlc_object_detach( p_vout );
95 vlc_object_attach( p_vout, p_playlist );
97 vlc_object_release( p_playlist );
101 msg_Dbg( p_this, "cannot find playlist, destroying vout" );
102 vlc_object_detach( p_vout );
103 vout_Destroy( p_vout );
109 /* If a video output was provided, lock it, otherwise look for one. */
112 vlc_object_yield( p_vout );
116 p_vout = vlc_object_find( p_this, VLC_OBJECT_VOUT, FIND_CHILD );
120 vlc_object_t *p_playlist;
122 p_playlist = vlc_object_find( p_this,
123 VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
126 p_vout = vlc_object_find( p_playlist,
127 VLC_OBJECT_VOUT, FIND_CHILD );
128 /* only first children of p_input for unused vout */
129 if( p_vout && p_vout->p_parent != p_playlist )
131 vlc_object_release( p_vout );
134 vlc_object_release( p_playlist );
139 /* If we now have a video output, check it has the right properties */
142 char *psz_filter_chain;
145 /* We don't directly check for the "filter" variable for obvious
146 * performance reasons. */
147 if( p_vout->b_filter_change )
149 var_Get( p_vout, "filter", &val );
150 psz_filter_chain = val.psz_string;
152 if( psz_filter_chain && !*psz_filter_chain )
154 free( psz_filter_chain );
155 psz_filter_chain = NULL;
157 if( p_vout->psz_filter_chain && !*p_vout->psz_filter_chain )
159 free( p_vout->psz_filter_chain );
160 p_vout->psz_filter_chain = NULL;
163 if( !psz_filter_chain && !p_vout->psz_filter_chain )
165 p_vout->b_filter_change = VLC_FALSE;
168 if( psz_filter_chain ) free( psz_filter_chain );
171 if( ( p_vout->fmt_render.i_width != p_fmt->i_width ) ||
172 ( p_vout->fmt_render.i_height != p_fmt->i_height ) ||
173 ( p_vout->fmt_render.i_chroma != p_fmt->i_chroma ) ||
174 ( p_vout->fmt_render.i_aspect != p_fmt->i_aspect
175 && !p_vout->b_override_aspect ) ||
176 p_vout->b_filter_change )
178 /* We are not interested in this format, close this vout */
179 vlc_object_detach( p_vout );
180 vlc_object_release( p_vout );
181 vout_Destroy( p_vout );
186 /* This video output is cool! Hijack it. */
187 vlc_object_detach( p_vout );
188 spu_Attach( p_vout->p_spu, p_this, VLC_TRUE );
189 vlc_object_attach( p_vout, p_this );
190 vlc_object_release( p_vout );
196 msg_Dbg( p_this, "no usable vout present, spawning one" );
198 p_vout = vout_Create( p_this, p_fmt );
204 /*****************************************************************************
205 * vout_Create: creates a new video output thread
206 *****************************************************************************
207 * This function creates a new video output thread, and returns a pointer
208 * to its description. On error, it returns NULL.
209 *****************************************************************************/
210 vout_thread_t * __vout_Create( vlc_object_t *p_parent, video_format_t *p_fmt )
212 vout_thread_t * p_vout; /* thread descriptor */
213 input_thread_t * p_input_thread;
214 int i_index; /* loop variable */
216 vlc_value_t val, text;
218 unsigned int i_width = p_fmt->i_visible_width;
219 unsigned int i_height = p_fmt->i_visible_height;
220 vlc_fourcc_t i_chroma = p_fmt->i_chroma;
221 unsigned int i_aspect = p_fmt->i_aspect;
223 /* Allocate descriptor */
224 p_vout = vlc_object_create( p_parent, VLC_OBJECT_VOUT );
227 msg_Err( p_parent, "out of memory" );
231 /* Initialize pictures - translation tables and functions
232 * will be initialized later in InitThread */
233 for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++)
235 p_vout->p_picture[i_index].pf_lock = NULL;
236 p_vout->p_picture[i_index].pf_unlock = NULL;
237 p_vout->p_picture[i_index].i_status = FREE_PICTURE;
238 p_vout->p_picture[i_index].i_type = EMPTY_PICTURE;
239 p_vout->p_picture[i_index].b_slow = 0;
242 /* No images in the heap */
243 p_vout->i_heap_size = 0;
245 /* Initialize the rendering heap */
246 I_RENDERPICTURES = 0;
247 p_vout->fmt_render = *p_fmt; /* FIXME palette */
248 p_vout->fmt_in = *p_fmt; /* FIXME palette */
249 p_vout->render.i_width = i_width;
250 p_vout->render.i_height = i_height;
251 p_vout->render.i_chroma = i_chroma;
252 p_vout->render.i_aspect = i_aspect;
254 p_vout->render.i_rmask = 0;
255 p_vout->render.i_gmask = 0;
256 p_vout->render.i_bmask = 0;
258 p_vout->render.i_last_used_pic = -1;
259 p_vout->render.b_allow_modify_pics = 1;
261 /* Zero the output heap */
262 I_OUTPUTPICTURES = 0;
263 p_vout->output.i_width = 0;
264 p_vout->output.i_height = 0;
265 p_vout->output.i_chroma = 0;
266 p_vout->output.i_aspect = 0;
268 p_vout->output.i_rmask = 0;
269 p_vout->output.i_gmask = 0;
270 p_vout->output.i_bmask = 0;
272 /* Initialize misc stuff */
273 p_vout->i_changes = 0;
275 p_vout->b_grayscale = 0;
277 p_vout->b_interface = 0;
279 p_vout->b_fullscreen = 0;
280 p_vout->i_alignment = 0;
281 p_vout->render_time = 10;
282 p_vout->c_fps_samples = 0;
283 p_vout->b_filter_change = 0;
284 p_vout->pf_control = 0;
285 p_vout->p_parent_intf = 0;
287 /* Initialize locks */
288 vlc_mutex_init( p_vout, &p_vout->picture_lock );
289 vlc_mutex_init( p_vout, &p_vout->change_lock );
291 /* Mouse coordinates */
292 var_Create( p_vout, "mouse-x", VLC_VAR_INTEGER );
293 var_Create( p_vout, "mouse-y", VLC_VAR_INTEGER );
294 var_Create( p_vout, "mouse-button-down", VLC_VAR_INTEGER );
295 var_Create( p_vout, "mouse-moved", VLC_VAR_BOOL );
296 var_Create( p_vout, "mouse-clicked", VLC_VAR_INTEGER );
298 /* Initialize subpicture unit */
299 p_vout->p_spu = spu_Create( p_vout );
300 spu_Attach( p_vout->p_spu, p_parent, VLC_TRUE );
302 /* Attach the new object now so we can use var inheritance below */
303 vlc_object_attach( p_vout, p_parent );
305 spu_Init( p_vout->p_spu );
307 /* Take care of some "interface/control" related initialisations */
308 vout_IntfInit( p_vout );
310 p_vout->b_override_aspect = VLC_FALSE;
312 /* If the parent is not a VOUT object, that means we are at the start of
313 * the video output pipe */
314 if( p_parent->i_object_type != VLC_OBJECT_VOUT )
316 var_Get( p_vout, "aspect-ratio", &val );
318 /* Check whether the user tried to override aspect ratio */
321 unsigned int i_new_aspect = i_aspect;
322 char *psz_parser = strchr( val.psz_string, ':' );
326 *psz_parser++ = '\0';
327 i_new_aspect = atoi( val.psz_string ) * VOUT_ASPECT_FACTOR
328 / atoi( psz_parser );
332 i_new_aspect = i_width * VOUT_ASPECT_FACTOR
333 * atof( val.psz_string )
337 free( val.psz_string );
339 if( i_new_aspect && i_new_aspect != i_aspect )
341 int i_aspect_x, i_aspect_y;
343 AspectRatio( i_new_aspect, &i_aspect_x, &i_aspect_y );
345 msg_Dbg( p_vout, "overriding source aspect ratio to %i:%i",
346 i_aspect_x, i_aspect_y );
348 p_vout->render.i_aspect = i_new_aspect;
350 p_vout->b_override_aspect = VLC_TRUE;
354 /* Look for the default filter configuration */
355 var_Create( p_vout, "filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
356 var_Get( p_vout, "filter", &val );
357 p_vout->psz_filter_chain = val.psz_string;
361 /* continue the parent's filter chain */
364 psz_end = strchr( ((vout_thread_t *)p_parent)->psz_filter_chain, ',' );
365 if( psz_end && *(psz_end+1) )
366 p_vout->psz_filter_chain = strdup( psz_end+1 );
367 else p_vout->psz_filter_chain = NULL;
370 /* Choose the video output module */
371 if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
373 var_Create( p_vout, "vout", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
374 var_Get( p_vout, "vout", &val );
375 psz_plugin = val.psz_string;
379 /* the filter chain is a string list of filters separated by double
383 psz_end = strchr( p_vout->psz_filter_chain, ',' );
385 psz_plugin = strndup( p_vout->psz_filter_chain,
386 psz_end - p_vout->psz_filter_chain );
387 else psz_plugin = strdup( p_vout->psz_filter_chain );
390 /* Initialize the dimensions of the video window */
391 InitWindowSize( p_vout, &p_vout->i_window_width,
392 &p_vout->i_window_height );
394 /* Create the vout thread */
395 p_vout->p_module = module_Need( p_vout,
396 ( p_vout->psz_filter_chain && *p_vout->psz_filter_chain ) ?
397 "video filter" : "video output", psz_plugin, 0 );
399 if( psz_plugin ) free( psz_plugin );
400 if( p_vout->p_module == NULL )
402 msg_Err( p_vout, "no suitable vout module" );
403 vlc_object_detach( p_vout );
404 vlc_object_destroy( p_vout );
408 /* Create a few object variables for interface interaction */
409 var_Create( p_vout, "deinterlace", VLC_VAR_STRING | VLC_VAR_HASCHOICE );
410 text.psz_string = _("Deinterlace");
411 var_Change( p_vout, "deinterlace", VLC_VAR_SETTEXT, &text, NULL );
412 val.psz_string = ""; text.psz_string = _("Disable");
413 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
414 val.psz_string = "discard"; text.psz_string = _("Discard");
415 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
416 val.psz_string = "blend"; text.psz_string = _("Blend");
417 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
418 val.psz_string = "mean"; text.psz_string = _("Mean");
419 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
420 val.psz_string = "bob"; text.psz_string = _("Bob");
421 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
422 val.psz_string = "linear"; text.psz_string = _("Linear");
423 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
424 if( var_Get( p_vout, "deinterlace-mode", &val ) == VLC_SUCCESS )
426 var_Set( p_vout, "deinterlace", val );
427 if( val.psz_string ) free( val.psz_string );
429 var_AddCallback( p_vout, "deinterlace", DeinterlaceCallback, NULL );
432 var_Create( p_vout, "filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
433 text.psz_string = _("Filters");
434 var_Change( p_vout, "filter", VLC_VAR_SETTEXT, &text, NULL );
435 var_AddCallback( p_vout, "filter", FilterCallback, NULL );
437 /* Calculate delay created by internal caching */
438 p_input_thread = (input_thread_t *)vlc_object_find( p_vout,
439 VLC_OBJECT_INPUT, FIND_ANYWHERE );
442 p_vout->i_pts_delay = p_input_thread->i_pts_delay;
443 vlc_object_release( p_input_thread );
447 p_vout->i_pts_delay = DEFAULT_PTS_DELAY;
450 if( vlc_thread_create( p_vout, "video output", RunThread,
451 VLC_THREAD_PRIORITY_OUTPUT, VLC_TRUE ) )
453 msg_Err( p_vout, "out of memory" );
454 module_Unneed( p_vout, p_vout->p_module );
455 vlc_object_detach( p_vout );
456 vlc_object_destroy( p_vout );
460 if( p_vout->b_error )
462 msg_Err( p_vout, "video output creation failed" );
464 /* Make sure the thread is destroyed */
465 p_vout->b_die = VLC_TRUE;
467 vlc_thread_join( p_vout );
469 vlc_object_detach( p_vout );
470 vlc_object_destroy( p_vout );
477 /*****************************************************************************
478 * vout_Destroy: destroys a previously created video output
479 *****************************************************************************
480 * Destroy a terminated thread.
481 * The function will request a destruction of the specified thread. If pi_error
482 * is NULL, it will return once the thread is destroyed. Else, it will be
483 * update using one of the THREAD_* constants.
484 *****************************************************************************/
485 void vout_Destroy( vout_thread_t *p_vout )
487 vlc_object_t *p_playlist;
489 /* Request thread destruction */
490 p_vout->b_die = VLC_TRUE;
491 vlc_thread_join( p_vout );
493 var_Destroy( p_vout, "intf-change" );
495 p_playlist = vlc_object_find( p_vout, VLC_OBJECT_PLAYLIST,
498 if( p_vout->psz_filter_chain ) free( p_vout->psz_filter_chain );
501 vlc_object_destroy( p_vout );
503 /* If it was the last vout, tell the interface to show up */
504 if( p_playlist != NULL )
506 vout_thread_t *p_another_vout = vlc_object_find( p_playlist,
507 VLC_OBJECT_VOUT, FIND_ANYWHERE );
508 if( p_another_vout == NULL )
511 val.b_bool = VLC_TRUE;
512 var_Set( p_playlist, "intf-show", val );
516 vlc_object_release( p_another_vout );
518 vlc_object_release( p_playlist );
522 /*****************************************************************************
523 * InitThread: initialize video output thread
524 *****************************************************************************
525 * This function is called from RunThread and performs the second step of the
526 * initialization. It returns 0 on success. Note that the thread's flag are not
527 * modified inside this function.
528 *****************************************************************************/
529 static int InitThread( vout_thread_t *p_vout )
531 int i, i_aspect_x, i_aspect_y;
533 vlc_mutex_lock( &p_vout->change_lock );
539 /* Initialize output method, it allocates direct buffers for us */
540 if( p_vout->pf_init( p_vout ) )
542 vlc_mutex_unlock( &p_vout->change_lock );
546 if( !I_OUTPUTPICTURES )
548 msg_Err( p_vout, "plugin was unable to allocate at least "
549 "one direct buffer" );
550 p_vout->pf_end( p_vout );
551 vlc_mutex_unlock( &p_vout->change_lock );
555 if( I_OUTPUTPICTURES > VOUT_MAX_PICTURES )
557 msg_Err( p_vout, "plugin allocated too many direct buffers, "
558 "our internal buffers must have overflown." );
559 p_vout->pf_end( p_vout );
560 vlc_mutex_unlock( &p_vout->change_lock );
564 msg_Dbg( p_vout, "got %i direct buffer(s)", I_OUTPUTPICTURES );
566 AspectRatio( p_vout->fmt_render.i_aspect, &i_aspect_x, &i_aspect_y );
568 msg_Dbg( p_vout, "picture in %ix%i (%i,%i,%ix%i), "
569 "chroma %4.4s, ar %i:%i, sar %i:%i",
570 p_vout->fmt_render.i_width, p_vout->fmt_render.i_height,
571 p_vout->fmt_render.i_x_offset, p_vout->fmt_render.i_y_offset,
572 p_vout->fmt_render.i_visible_width,
573 p_vout->fmt_render.i_visible_height,
574 (char*)&p_vout->fmt_render.i_chroma,
575 i_aspect_x, i_aspect_y,
576 p_vout->fmt_render.i_sar_num, p_vout->fmt_render.i_sar_den );
578 AspectRatio( p_vout->fmt_in.i_aspect, &i_aspect_x, &i_aspect_y );
580 msg_Dbg( p_vout, "picture user %ix%i (%i,%i,%ix%i), "
581 "chroma %4.4s, ar %i:%i, sar %i:%i",
582 p_vout->fmt_in.i_width, p_vout->fmt_in.i_height,
583 p_vout->fmt_in.i_x_offset, p_vout->fmt_in.i_y_offset,
584 p_vout->fmt_in.i_visible_width,
585 p_vout->fmt_in.i_visible_height,
586 (char*)&p_vout->fmt_in.i_chroma,
587 i_aspect_x, i_aspect_y,
588 p_vout->fmt_in.i_sar_num, p_vout->fmt_in.i_sar_den );
590 if( !p_vout->fmt_out.i_width || !p_vout->fmt_out.i_height )
592 p_vout->fmt_out.i_width = p_vout->fmt_out.i_visible_width =
593 p_vout->output.i_width;
594 p_vout->fmt_out.i_height = p_vout->fmt_out.i_visible_height =
595 p_vout->output.i_height;
596 p_vout->fmt_out.i_x_offset = p_vout->fmt_out.i_y_offset = 0;
598 p_vout->fmt_out.i_aspect = p_vout->output.i_aspect;
599 p_vout->fmt_out.i_chroma = p_vout->output.i_chroma;
601 if( !p_vout->fmt_out.i_sar_num || !p_vout->fmt_out.i_sar_num )
603 p_vout->fmt_out.i_sar_num = p_vout->fmt_out.i_aspect *
604 p_vout->fmt_out.i_height;
605 p_vout->fmt_out.i_sar_den = VOUT_ASPECT_FACTOR *
606 p_vout->fmt_out.i_width;
609 vlc_reduce( &p_vout->fmt_out.i_sar_num, &p_vout->fmt_out.i_sar_den,
610 p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den, 0 );
612 AspectRatio( p_vout->fmt_out.i_aspect, &i_aspect_x, &i_aspect_y );
614 msg_Dbg( p_vout, "picture out %ix%i, chroma %4.4s, ar %i:%i, sar %i:%i",
615 p_vout->output.i_width, p_vout->output.i_height,
616 (char*)&p_vout->output.i_chroma,
617 i_aspect_x, i_aspect_y,
618 p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den );
620 /* Calculate shifts from system-updated masks */
621 MaskToShift( &p_vout->output.i_lrshift, &p_vout->output.i_rrshift,
622 p_vout->output.i_rmask );
623 MaskToShift( &p_vout->output.i_lgshift, &p_vout->output.i_rgshift,
624 p_vout->output.i_gmask );
625 MaskToShift( &p_vout->output.i_lbshift, &p_vout->output.i_rbshift,
626 p_vout->output.i_bmask );
628 /* Check whether we managed to create direct buffers similar to
629 * the render buffers, ie same size and chroma */
630 if( ( p_vout->output.i_width == p_vout->render.i_width )
631 && ( p_vout->output.i_height == p_vout->render.i_height )
632 && ( vout_ChromaCmp( p_vout->output.i_chroma, p_vout->render.i_chroma ) ) )
634 /* Cool ! We have direct buffers, we can ask the decoder to
635 * directly decode into them ! Map the first render buffers to
636 * the first direct buffers, but keep the first direct buffer
637 * for memcpy operations */
638 p_vout->b_direct = 1;
640 for( i = 1; i < VOUT_MAX_PICTURES; i++ )
642 if( p_vout->p_picture[ i ].i_type != DIRECT_PICTURE &&
643 I_RENDERPICTURES >= VOUT_MIN_DIRECT_PICTURES - 1 &&
644 p_vout->p_picture[ i - 1 ].i_type == DIRECT_PICTURE )
646 /* We have enough direct buffers so there's no need to
647 * try to use system memory buffers. */
650 PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
654 msg_Dbg( p_vout, "direct render, mapping "
655 "render pictures 0-%i to system pictures 1-%i",
656 VOUT_MAX_PICTURES - 2, VOUT_MAX_PICTURES - 1 );
660 /* Rats... Something is wrong here, we could not find an output
661 * plugin able to directly render what we decode. See if we can
662 * find a chroma plugin to do the conversion */
663 p_vout->b_direct = 0;
665 /* Choose the best module */
666 p_vout->chroma.p_module = module_Need( p_vout, "chroma", NULL, 0 );
668 if( p_vout->chroma.p_module == NULL )
670 msg_Err( p_vout, "no chroma module for %4.4s to %4.4s",
671 (char*)&p_vout->render.i_chroma,
672 (char*)&p_vout->output.i_chroma );
673 p_vout->pf_end( p_vout );
674 vlc_mutex_unlock( &p_vout->change_lock );
678 msg_Dbg( p_vout, "indirect render, mapping "
679 "render pictures 0-%i to system pictures %i-%i",
680 VOUT_MAX_PICTURES - 1, I_OUTPUTPICTURES,
681 I_OUTPUTPICTURES + VOUT_MAX_PICTURES - 1 );
683 /* Append render buffers after the direct buffers */
684 for( i = I_OUTPUTPICTURES; i < 2 * VOUT_MAX_PICTURES; i++ )
686 PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
689 /* Check if we have enough render pictures */
690 if( I_RENDERPICTURES == VOUT_MAX_PICTURES )
695 /* Link pictures back to their heap */
696 for( i = 0 ; i < I_RENDERPICTURES ; i++ )
698 PP_RENDERPICTURE[ i ]->p_heap = &p_vout->render;
701 for( i = 0 ; i < I_OUTPUTPICTURES ; i++ )
703 PP_OUTPUTPICTURE[ i ]->p_heap = &p_vout->output;
706 /* XXX XXX mark thread ready */
710 /*****************************************************************************
711 * RunThread: video output thread
712 *****************************************************************************
713 * Video output thread. This function does only returns when the thread is
714 * terminated. It handles the pictures arriving in the video heap and the
715 * display device events.
716 *****************************************************************************/
717 static void RunThread( vout_thread_t *p_vout)
719 int i_index; /* index in heap */
720 int i_idle_loops = 0; /* loops without displaying a picture */
721 mtime_t current_date; /* current date */
722 mtime_t display_date; /* display date */
724 picture_t * p_picture; /* picture pointer */
725 picture_t * p_last_picture = NULL; /* last picture */
726 picture_t * p_directbuffer; /* direct buffer to display */
728 subpicture_t * p_subpic; /* subpicture pointer */
733 p_vout->b_error = InitThread( p_vout );
735 /* signal the creation of the vout */
736 vlc_thread_ready( p_vout );
738 if( p_vout->b_error )
740 /* Destroy thread structures allocated by Create and InitThread */
741 DestroyThread( p_vout );
746 * Main loop - it is not executed if an error occurred during
749 while( (!p_vout->b_die) && (!p_vout->b_error) )
751 /* Initialize loop variables */
754 current_date = mdate();
758 if( !(p_vout->c_loops % VOUT_STATS_NB_LOOPS) )
760 msg_Dbg( p_vout, "picture heap: %d/%d",
761 I_RENDERPICTURES, p_vout->i_heap_size );
766 * Find the picture to display (the one with the earliest date).
767 * This operation does not need lock, since only READY_PICTUREs
769 for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
771 if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
772 && ( (p_picture == NULL) ||
773 (PP_RENDERPICTURE[i_index]->date < display_date) ) )
775 p_picture = PP_RENDERPICTURE[i_index];
776 display_date = p_picture->date;
782 /* If we met the last picture, parse again to see whether there is
783 * a more appropriate one. */
784 if( p_picture == p_last_picture )
786 for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
788 if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
789 && (PP_RENDERPICTURE[i_index] != p_last_picture)
790 && ((p_picture == p_last_picture) ||
791 (PP_RENDERPICTURE[i_index]->date < display_date)) )
793 p_picture = PP_RENDERPICTURE[i_index];
794 display_date = p_picture->date;
799 /* If we found better than the last picture, destroy it */
800 if( p_last_picture && p_picture != p_last_picture )
802 vlc_mutex_lock( &p_vout->picture_lock );
803 if( p_last_picture->i_refcount )
805 p_last_picture->i_status = DISPLAYED_PICTURE;
809 p_last_picture->i_status = DESTROYED_PICTURE;
810 p_vout->i_heap_size--;
812 vlc_mutex_unlock( &p_vout->picture_lock );
813 p_last_picture = NULL;
816 /* Compute FPS rate */
817 p_vout->p_fps_sample[ p_vout->c_fps_samples++ % VOUT_FPS_SAMPLES ]
820 if( !p_picture->b_force &&
821 p_picture != p_last_picture &&
822 display_date < current_date + p_vout->render_time )
824 /* Picture is late: it will be destroyed and the thread
825 * will directly choose the next picture */
826 vlc_mutex_lock( &p_vout->picture_lock );
827 if( p_picture->i_refcount )
829 /* Pretend we displayed the picture, but don't destroy
830 * it since the decoder might still need it. */
831 p_picture->i_status = DISPLAYED_PICTURE;
835 /* Destroy the picture without displaying it */
836 p_picture->i_status = DESTROYED_PICTURE;
837 p_vout->i_heap_size--;
839 msg_Warn( p_vout, "late picture skipped ("I64Fd")",
840 current_date - display_date );
841 vlc_mutex_unlock( &p_vout->picture_lock );
847 current_date + p_vout->i_pts_delay + VOUT_BOGUS_DELAY )
849 /* Picture is waaay too early: it will be destroyed */
850 vlc_mutex_lock( &p_vout->picture_lock );
851 if( p_picture->i_refcount )
853 /* Pretend we displayed the picture, but don't destroy
854 * it since the decoder might still need it. */
855 p_picture->i_status = DISPLAYED_PICTURE;
859 /* Destroy the picture without displaying it */
860 p_picture->i_status = DESTROYED_PICTURE;
861 p_vout->i_heap_size--;
863 msg_Warn( p_vout, "vout warning: early picture skipped "
864 "("I64Fd")", display_date - current_date
865 - p_vout->i_pts_delay );
866 vlc_mutex_unlock( &p_vout->picture_lock );
871 if( display_date > current_date + VOUT_DISPLAY_DELAY )
873 /* A picture is ready to be rendered, but its rendering date
874 * is far from the current one so the thread will perform an
875 * empty loop as if no picture were found. The picture state
880 else if( p_picture == p_last_picture )
882 /* We are asked to repeat the previous picture, but we first
883 * wait for a couple of idle loops */
884 if( i_idle_loops < 4 )
891 /* We set the display date to something high, otherwise
892 * we'll have lots of problems with late pictures */
893 display_date = current_date + p_vout->render_time;
898 if( p_picture == NULL )
903 if( p_picture && p_vout->b_snapshot )
905 p_vout->b_snapshot = VLC_FALSE;
906 vout_Snapshot( p_vout, p_picture );
910 * Check for subpictures to display
912 p_subpic = spu_SortSubpictures( p_vout->p_spu, display_date );
917 p_directbuffer = vout_RenderPicture( p_vout, p_picture, p_subpic );
920 * Call the plugin-specific rendering method if there is one
922 if( p_picture != NULL && p_directbuffer != NULL && p_vout->pf_render )
924 /* Render the direct buffer returned by vout_RenderPicture */
925 p_vout->pf_render( p_vout, p_directbuffer );
931 if( display_date != 0 && p_directbuffer != NULL )
933 mtime_t current_render_time = mdate() - current_date;
934 /* if render time is very large we don't include it in the mean */
935 if( current_render_time < p_vout->render_time +
938 /* Store render time using a sliding mean weighting to
939 * current value in a 3 to 1 ratio*/
940 p_vout->render_time *= 3;
941 p_vout->render_time += current_render_time;
942 p_vout->render_time >>= 2;
946 /* Give back change lock */
947 vlc_mutex_unlock( &p_vout->change_lock );
949 /* Sleep a while or until a given date */
950 if( display_date != 0 )
952 /* If there are filters in the chain, better give them the picture
954 if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
956 mwait( display_date - VOUT_MWAIT_TOLERANCE );
961 msleep( VOUT_IDLE_SLEEP );
964 /* On awakening, take back lock and send immediately picture
966 vlc_mutex_lock( &p_vout->change_lock );
969 * Display the previously rendered picture
971 if( p_picture != NULL && p_directbuffer != NULL )
973 /* Display the direct buffer returned by vout_RenderPicture */
974 if( p_vout->pf_display )
976 p_vout->pf_display( p_vout, p_directbuffer );
979 /* Tell the vout this was the last picture and that it does not
980 * need to be forced anymore. */
981 p_last_picture = p_picture;
982 p_last_picture->b_force = 0;
985 if( p_picture != NULL )
987 /* Reinitialize idle loop count */
992 * Check events and manage thread
994 if( p_vout->pf_manage && p_vout->pf_manage( p_vout ) )
996 /* A fatal error occurred, and the thread must terminate
997 * immediately, without displaying anything - setting b_error to 1
998 * causes the immediate end of the main while() loop. */
1002 if( p_vout->i_changes & VOUT_SIZE_CHANGE )
1004 /* this must only happen when the vout plugin is incapable of
1005 * rescaling the picture itself. In this case we need to destroy
1006 * the current picture buffers and recreate new ones with the right
1010 p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
1012 p_vout->pf_end( p_vout );
1013 for( i = 0; i < I_OUTPUTPICTURES; i++ )
1014 p_vout->p_picture[ i ].i_status = FREE_PICTURE;
1016 I_OUTPUTPICTURES = 0;
1017 if( p_vout->pf_init( p_vout ) )
1019 msg_Err( p_vout, "cannot resize display" );
1020 /* FIXME: pf_end will be called again in EndThread() */
1021 p_vout->b_error = 1;
1024 /* Need to reinitialise the chroma plugin */
1025 if( p_vout->chroma.p_module )
1027 if( p_vout->chroma.p_module->pf_deactivate )
1028 p_vout->chroma.p_module->pf_deactivate( VLC_OBJECT(p_vout) );
1029 p_vout->chroma.p_module->pf_activate( VLC_OBJECT(p_vout) );
1033 if( p_vout->i_changes & VOUT_PICTURE_BUFFERS_CHANGE )
1035 /* This happens when the picture buffers need to be recreated.
1036 * This is useful on multimonitor displays for instance.
1038 * Warning: This only works when the vout creates only 1 picture
1040 p_vout->i_changes &= ~VOUT_PICTURE_BUFFERS_CHANGE;
1042 if( !p_vout->b_direct )
1044 module_Unneed( p_vout, p_vout->chroma.p_module );
1047 vlc_mutex_lock( &p_vout->picture_lock );
1049 p_vout->pf_end( p_vout );
1051 I_OUTPUTPICTURES = I_RENDERPICTURES = 0;
1053 p_vout->b_error = InitThread( p_vout );
1055 vlc_mutex_unlock( &p_vout->picture_lock );
1060 * Error loop - wait until the thread destruction is requested
1062 if( p_vout->b_error )
1064 ErrorThread( p_vout );
1068 EndThread( p_vout );
1070 /* Destroy thread structures allocated by CreateThread */
1071 DestroyThread( p_vout );
1074 /*****************************************************************************
1075 * ErrorThread: RunThread() error loop
1076 *****************************************************************************
1077 * This function is called when an error occurred during thread main's loop.
1078 * The thread can still receive feed, but must be ready to terminate as soon
1080 *****************************************************************************/
1081 static void ErrorThread( vout_thread_t *p_vout )
1083 /* Wait until a `die' order */
1084 while( !p_vout->b_die )
1087 msleep( VOUT_IDLE_SLEEP );
1091 /*****************************************************************************
1092 * EndThread: thread destruction
1093 *****************************************************************************
1094 * This function is called when the thread ends after a sucessful
1095 * initialization. It frees all resources allocated by InitThread.
1096 *****************************************************************************/
1097 static void EndThread( vout_thread_t *p_vout )
1099 int i_index; /* index in heap */
1103 struct tms cpu_usage;
1104 times( &cpu_usage );
1106 msg_Dbg( p_vout, "cpu usage (user: %d, system: %d)",
1107 cpu_usage.tms_utime, cpu_usage.tms_stime );
1111 if( !p_vout->b_direct )
1113 module_Unneed( p_vout, p_vout->chroma.p_module );
1116 /* Destroy all remaining pictures */
1117 for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++ )
1119 if ( p_vout->p_picture[i_index].i_type == MEMORY_PICTURE )
1121 free( p_vout->p_picture[i_index].p_data_orig );
1125 /* Destroy subpicture unit */
1126 spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), VLC_FALSE );
1127 spu_Destroy( p_vout->p_spu );
1129 /* Destroy translation tables */
1130 p_vout->pf_end( p_vout );
1132 /* Release the change lock */
1133 vlc_mutex_unlock( &p_vout->change_lock );
1136 /*****************************************************************************
1137 * DestroyThread: thread destruction
1138 *****************************************************************************
1139 * This function is called when the thread ends. It frees all ressources
1140 * allocated by CreateThread. Status is available at this stage.
1141 *****************************************************************************/
1142 static void DestroyThread( vout_thread_t *p_vout )
1144 /* Destroy the locks */
1145 vlc_mutex_destroy( &p_vout->picture_lock );
1146 vlc_mutex_destroy( &p_vout->change_lock );
1148 /* Release the module */
1149 if( p_vout && p_vout->p_module )
1151 module_Unneed( p_vout, p_vout->p_module );
1155 /* following functions are local */
1157 static int ReduceHeight( int i_ratio )
1159 int i_dummy = VOUT_ASPECT_FACTOR;
1167 /* VOUT_ASPECT_FACTOR is (2^7 * 3^3 * 5^3), we just check for 2, 3 and 5 */
1168 while( !(i_ratio & 1) && !(i_dummy & 1) )
1175 while( !(i_ratio % 3) && !(i_dummy % 3) )
1182 while( !(i_ratio % 5) && !(i_dummy % 5) )
1192 static void AspectRatio( int i_aspect, int *i_aspect_x, int *i_aspect_y )
1194 unsigned int i_pgcd = ReduceHeight( i_aspect );
1195 *i_aspect_x = i_aspect / i_pgcd;
1196 *i_aspect_y = VOUT_ASPECT_FACTOR / i_pgcd;
1199 /*****************************************************************************
1200 * BinaryLog: computes the base 2 log of a binary value
1201 *****************************************************************************
1202 * This functions is used by MaskToShift, to get a bit index from a binary
1204 *****************************************************************************/
1205 static int BinaryLog( uint32_t i )
1209 if( i == 0 ) return -31337;
1211 if( i & 0xffff0000 ) i_log += 16;
1212 if( i & 0xff00ff00 ) i_log += 8;
1213 if( i & 0xf0f0f0f0 ) i_log += 4;
1214 if( i & 0xcccccccc ) i_log += 2;
1215 if( i & 0xaaaaaaaa ) i_log += 1;
1220 /*****************************************************************************
1221 * MaskToShift: transform a color mask into right and left shifts
1222 *****************************************************************************
1223 * This function is used for obtaining color shifts from masks.
1224 *****************************************************************************/
1225 static void MaskToShift( int *pi_left, int *pi_right, uint32_t i_mask )
1227 uint32_t i_low, i_high; /* lower hand higher bits of the mask */
1231 *pi_left = *pi_right = 0;
1236 i_low = i_mask & (- (int32_t)i_mask); /* lower bit of the mask */
1237 i_high = i_mask + i_low; /* higher bit of the mask */
1239 /* Transform bits into an index */
1240 i_low = BinaryLog (i_low);
1241 i_high = BinaryLog (i_high);
1243 /* Update pointers and return */
1245 *pi_right = (8 - i_high + i_low);
1248 /*****************************************************************************
1249 * InitWindowSize: find the initial dimensions the video window should have.
1250 *****************************************************************************
1251 * This function will check the "width", "height" and "zoom" config options and
1252 * will calculate the size that the video window should have.
1253 *****************************************************************************/
1254 static void InitWindowSize( vout_thread_t *p_vout, int *pi_width,
1258 int i_width, i_height;
1261 #define FP_FACTOR 1000 /* our fixed point factor */
1263 var_Get( p_vout, "align", &val );
1264 p_vout->i_alignment = val.i_int;
1266 var_Get( p_vout, "width", &val );
1267 i_width = val.i_int;
1268 var_Get( p_vout, "height", &val );
1269 i_height = val.i_int;
1270 var_Get( p_vout, "zoom", &val );
1271 ll_zoom = (uint64_t)( FP_FACTOR * val.f_float );
1273 if( i_width > 0 && i_height > 0)
1275 *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
1276 *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
1279 else if( i_width > 0 )
1281 *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
1282 *pi_height = (int)( i_width * ll_zoom * VOUT_ASPECT_FACTOR /
1283 p_vout->render.i_aspect / FP_FACTOR );
1286 else if( i_height > 0 )
1288 *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
1289 *pi_width = (int)( i_height * ll_zoom * p_vout->render.i_aspect /
1290 VOUT_ASPECT_FACTOR / FP_FACTOR );
1294 if( p_vout->render.i_height * p_vout->render.i_aspect
1295 >= p_vout->render.i_width * VOUT_ASPECT_FACTOR )
1297 *pi_width = (int)( p_vout->render.i_height * ll_zoom
1298 * p_vout->render.i_aspect / VOUT_ASPECT_FACTOR / FP_FACTOR );
1299 *pi_height = (int)( p_vout->render.i_height * ll_zoom / FP_FACTOR );
1303 *pi_width = (int)( p_vout->render.i_width * ll_zoom / FP_FACTOR );
1304 *pi_height = (int)( p_vout->render.i_width * ll_zoom
1305 * VOUT_ASPECT_FACTOR / p_vout->render.i_aspect / FP_FACTOR );
1311 /*****************************************************************************
1312 * vout_VarCallback: generic callback for intf variables
1313 *****************************************************************************/
1314 int vout_VarCallback( vlc_object_t * p_this, const char * psz_variable,
1315 vlc_value_t old_value, vlc_value_t new_value,
1318 vout_thread_t * p_vout = (vout_thread_t *)p_this;
1320 val.b_bool = VLC_TRUE;
1321 var_Set( p_vout, "intf-change", val );
1325 /*****************************************************************************
1326 * Helper thread for object variables callbacks.
1327 * Only used to avoid deadlocks when using the video embedded mode.
1328 *****************************************************************************/
1329 typedef struct suxor_thread_t
1332 input_thread_t *p_input;
1336 static void SuxorRestartVideoES( suxor_thread_t *p_this )
1340 vlc_thread_ready( p_this );
1342 /* Now restart current video stream */
1343 var_Get( p_this->p_input, "video-es", &val );
1344 if( val.i_int >= 0 )
1347 val_es.i_int = -VIDEO_ES;
1348 var_Set( p_this->p_input, "video-es", val_es );
1349 var_Set( p_this->p_input, "video-es", val );
1352 vlc_object_release( p_this->p_input );
1355 CloseHandle( p_this->thread_id );
1358 vlc_object_destroy( p_this );
1361 /*****************************************************************************
1362 * object variables callbacks: a bunch of object variables are used by the
1363 * interfaces to interact with the vout.
1364 *****************************************************************************/
1365 static int DeinterlaceCallback( vlc_object_t *p_this, char const *psz_cmd,
1366 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1368 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1369 input_thread_t *p_input;
1372 char *psz_mode = newval.psz_string;
1373 char *psz_filter, *psz_deinterlace = NULL;
1375 var_Get( p_vout, "filter", &val );
1376 psz_filter = val.psz_string;
1377 if( psz_filter ) psz_deinterlace = strstr( psz_filter, "deinterlace" );
1379 if( !psz_mode || !*psz_mode )
1381 if( psz_deinterlace )
1383 char *psz_src = psz_deinterlace + sizeof("deinterlace") - 1;
1384 if( psz_src[0] == ',' ) psz_src++;
1385 memmove( psz_deinterlace, psz_src, strlen(psz_src) + 1 );
1388 else if( !psz_deinterlace )
1390 psz_filter = realloc( psz_filter, strlen( psz_filter ) +
1391 sizeof(",deinterlace") );
1392 if( psz_filter && *psz_filter ) strcat( psz_filter, "," );
1393 strcat( psz_filter, "deinterlace" );
1396 p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1398 if( !p_input ) return VLC_EGENERIC;
1400 if( psz_mode && *psz_mode )
1402 /* Modify input as well because the vout might have to be restarted */
1403 val.psz_string = psz_mode;
1404 var_Create( p_input, "deinterlace-mode", VLC_VAR_STRING );
1405 var_Set( p_input, "deinterlace-mode", val );
1407 vlc_object_release( p_input );
1409 val.b_bool = VLC_TRUE;
1410 var_Set( p_vout, "intf-change", val );
1412 val.psz_string = psz_filter;
1413 var_Set( p_vout, "filter", val );
1414 if( psz_filter ) free( psz_filter );
1419 static int FilterCallback( vlc_object_t *p_this, char const *psz_cmd,
1420 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1422 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1423 input_thread_t *p_input;
1426 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 val.b_bool = VLC_TRUE;
1435 var_Set( p_vout, "intf-change", val );
1437 /* Modify input as well because the vout might have to be restarted */
1438 val.psz_string = newval.psz_string;
1439 var_Create( p_input, "filter", VLC_VAR_STRING );
1440 var_Set( p_input, "filter", val );
1442 /* Now restart current video stream */
1443 var_Get( p_input, "video-es", &val );
1444 if( val.i_int >= 0 )
1446 suxor_thread_t *p_suxor =
1447 vlc_object_create( p_vout, sizeof(suxor_thread_t) );
1448 p_suxor->p_input = p_input;
1449 p_vout->b_filter_change = VLC_TRUE;
1450 vlc_object_yield( p_input );
1451 vlc_thread_create( p_suxor, "suxor", SuxorRestartVideoES,
1452 VLC_THREAD_PRIORITY_LOW, VLC_FALSE );
1455 vlc_object_release( p_input );