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 );
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 playlist_t *p_playlist;
122 p_playlist = vlc_object_find( p_this,
123 VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
126 vlc_mutex_lock( &p_playlist->gc_lock );
127 p_vout = vlc_object_find( p_playlist,
128 VLC_OBJECT_VOUT, FIND_CHILD );
129 /* only first children of p_input for unused vout */
130 if( p_vout && p_vout->p_parent != (vlc_object_t *)p_playlist )
132 vlc_object_release( p_vout );
135 vlc_mutex_unlock( &p_playlist->gc_lock );
136 vlc_object_release( p_playlist );
141 /* If we now have a video output, check it has the right properties */
144 char *psz_filter_chain;
147 /* We don't directly check for the "vout-filter" variable for obvious
148 * performance reasons. */
149 if( p_vout->b_filter_change )
151 var_Get( p_vout, "vout-filter", &val );
152 psz_filter_chain = val.psz_string;
154 if( psz_filter_chain && !*psz_filter_chain )
156 free( psz_filter_chain );
157 psz_filter_chain = NULL;
159 if( p_vout->psz_filter_chain && !*p_vout->psz_filter_chain )
161 free( p_vout->psz_filter_chain );
162 p_vout->psz_filter_chain = NULL;
165 if( !psz_filter_chain && !p_vout->psz_filter_chain )
167 p_vout->b_filter_change = VLC_FALSE;
170 if( psz_filter_chain ) free( psz_filter_chain );
173 if( ( p_vout->fmt_render.i_width != p_fmt->i_width ) ||
174 ( p_vout->fmt_render.i_height != p_fmt->i_height ) ||
175 ( p_vout->fmt_render.i_chroma != p_fmt->i_chroma ) ||
176 ( p_vout->fmt_render.i_aspect != p_fmt->i_aspect ) ||
177 p_vout->b_filter_change )
179 /* We are not interested in this format, close this vout */
180 vlc_object_detach( p_vout );
181 vlc_object_release( p_vout );
182 vout_Destroy( p_vout );
187 /* This video output is cool! Hijack it. */
188 vlc_object_detach( p_vout );
189 spu_Attach( p_vout->p_spu, p_this, VLC_TRUE );
190 vlc_object_attach( p_vout, p_this );
191 vlc_object_release( p_vout );
197 msg_Dbg( p_this, "no usable vout present, spawning one" );
199 p_vout = vout_Create( p_this, p_fmt );
205 /*****************************************************************************
206 * vout_Create: creates a new video output thread
207 *****************************************************************************
208 * This function creates a new video output thread, and returns a pointer
209 * to its description. On error, it returns NULL.
210 *****************************************************************************/
211 vout_thread_t * __vout_Create( vlc_object_t *p_parent, video_format_t *p_fmt )
213 vout_thread_t * p_vout; /* thread descriptor */
214 input_thread_t * p_input_thread;
215 int i_index; /* loop variable */
217 vlc_value_t val, text;
219 unsigned int i_width = p_fmt->i_width;
220 unsigned int i_height = p_fmt->i_height;
221 vlc_fourcc_t i_chroma = p_fmt->i_chroma;
222 unsigned int i_aspect = p_fmt->i_aspect;
224 /* Allocate descriptor */
225 p_vout = vlc_object_create( p_parent, VLC_OBJECT_VOUT );
228 msg_Err( p_parent, "out of memory" );
232 /* Initialize pictures - translation tables and functions
233 * will be initialized later in InitThread */
234 for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++)
236 p_vout->p_picture[i_index].pf_lock = NULL;
237 p_vout->p_picture[i_index].pf_unlock = NULL;
238 p_vout->p_picture[i_index].i_status = FREE_PICTURE;
239 p_vout->p_picture[i_index].i_type = EMPTY_PICTURE;
240 p_vout->p_picture[i_index].b_slow = 0;
243 /* No images in the heap */
244 p_vout->i_heap_size = 0;
246 /* Initialize the rendering heap */
247 I_RENDERPICTURES = 0;
249 vlc_ureduce( &p_fmt->i_sar_num, &p_fmt->i_sar_den,
250 p_fmt->i_sar_num, p_fmt->i_sar_den, 50000 );
251 p_vout->fmt_render = *p_fmt; /* FIXME palette */
252 p_vout->fmt_in = *p_fmt; /* FIXME palette */
254 p_vout->render.i_width = i_width;
255 p_vout->render.i_height = i_height;
256 p_vout->render.i_chroma = i_chroma;
257 p_vout->render.i_aspect = i_aspect;
259 p_vout->render.i_rmask = 0;
260 p_vout->render.i_gmask = 0;
261 p_vout->render.i_bmask = 0;
263 p_vout->render.i_last_used_pic = -1;
264 p_vout->render.b_allow_modify_pics = 1;
266 /* Zero the output heap */
267 I_OUTPUTPICTURES = 0;
268 p_vout->output.i_width = 0;
269 p_vout->output.i_height = 0;
270 p_vout->output.i_chroma = 0;
271 p_vout->output.i_aspect = 0;
273 p_vout->output.i_rmask = 0;
274 p_vout->output.i_gmask = 0;
275 p_vout->output.i_bmask = 0;
277 /* Initialize misc stuff */
278 p_vout->i_changes = 0;
280 p_vout->b_grayscale = 0;
282 p_vout->b_interface = 0;
284 p_vout->b_fullscreen = 0;
285 p_vout->i_alignment = 0;
286 p_vout->render_time = 10;
287 p_vout->c_fps_samples = 0;
288 p_vout->b_filter_change = 0;
289 p_vout->pf_control = 0;
290 p_vout->p_parent_intf = 0;
291 p_vout->i_par_num = p_vout->i_par_den = 1;
293 /* Initialize locks */
294 vlc_mutex_init( p_vout, &p_vout->picture_lock );
295 vlc_mutex_init( p_vout, &p_vout->change_lock );
297 /* Mouse coordinates */
298 var_Create( p_vout, "mouse-x", VLC_VAR_INTEGER );
299 var_Create( p_vout, "mouse-y", VLC_VAR_INTEGER );
300 var_Create( p_vout, "mouse-button-down", VLC_VAR_INTEGER );
301 var_Create( p_vout, "mouse-moved", VLC_VAR_BOOL );
302 var_Create( p_vout, "mouse-clicked", VLC_VAR_INTEGER );
304 /* Initialize subpicture unit */
305 p_vout->p_spu = spu_Create( p_vout );
306 spu_Attach( p_vout->p_spu, p_parent, VLC_TRUE );
308 /* Attach the new object now so we can use var inheritance below */
309 vlc_object_attach( p_vout, p_parent );
311 spu_Init( p_vout->p_spu );
313 /* Take care of some "interface/control" related initialisations */
314 vout_IntfInit( p_vout );
316 /* If the parent is not a VOUT object, that means we are at the start of
317 * the video output pipe */
318 if( p_parent->i_object_type != VLC_OBJECT_VOUT )
320 /* Look for the default filter configuration */
321 var_Create( p_vout, "vout-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
322 var_Get( p_vout, "vout-filter", &val );
323 p_vout->psz_filter_chain = val.psz_string;
327 /* continue the parent's filter chain */
330 psz_end = strchr( ((vout_thread_t *)p_parent)->psz_filter_chain, ':' );
331 if( psz_end && *(psz_end+1) )
332 p_vout->psz_filter_chain = strdup( psz_end+1 );
333 else p_vout->psz_filter_chain = NULL;
336 /* Choose the video output module */
337 if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
339 var_Create( p_vout, "vout", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
340 var_Get( p_vout, "vout", &val );
341 psz_plugin = val.psz_string;
345 /* the filter chain is a string list of filters separated by double
349 psz_end = strchr( p_vout->psz_filter_chain, ':' );
351 psz_plugin = strndup( p_vout->psz_filter_chain,
352 psz_end - p_vout->psz_filter_chain );
353 else psz_plugin = strdup( p_vout->psz_filter_chain );
356 /* Create the vout thread */
357 p_vout->p_module = module_Need( p_vout,
358 ( p_vout->psz_filter_chain && *p_vout->psz_filter_chain ) ?
359 "video filter" : "video output", psz_plugin, 0 );
361 if( psz_plugin ) free( psz_plugin );
362 if( p_vout->p_module == NULL )
364 msg_Err( p_vout, "no suitable vout module" );
365 vlc_object_detach( p_vout );
366 vlc_object_destroy( p_vout );
370 /* Create a few object variables for interface interaction */
371 var_Create( p_vout, "deinterlace", VLC_VAR_STRING | VLC_VAR_HASCHOICE );
372 text.psz_string = _("Deinterlace");
373 var_Change( p_vout, "deinterlace", VLC_VAR_SETTEXT, &text, NULL );
374 val.psz_string = ""; text.psz_string = _("Disable");
375 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
376 val.psz_string = "discard"; text.psz_string = _("Discard");
377 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
378 val.psz_string = "blend"; text.psz_string = _("Blend");
379 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
380 val.psz_string = "mean"; text.psz_string = _("Mean");
381 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
382 val.psz_string = "bob"; text.psz_string = _("Bob");
383 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
384 val.psz_string = "linear"; text.psz_string = _("Linear");
385 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
386 val.psz_string = "x"; text.psz_string = "X";
387 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
389 if( var_Get( p_vout, "deinterlace-mode", &val ) == VLC_SUCCESS )
391 var_Set( p_vout, "deinterlace", val );
392 if( val.psz_string ) free( val.psz_string );
394 var_AddCallback( p_vout, "deinterlace", DeinterlaceCallback, NULL );
397 var_Create( p_vout, "vout-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
398 text.psz_string = _("Filters");
399 var_Change( p_vout, "vout-filter", VLC_VAR_SETTEXT, &text, NULL );
400 var_AddCallback( p_vout, "vout-filter", FilterCallback, NULL );
402 /* Calculate delay created by internal caching */
403 p_input_thread = (input_thread_t *)vlc_object_find( p_vout,
404 VLC_OBJECT_INPUT, FIND_ANYWHERE );
407 p_vout->i_pts_delay = p_input_thread->i_pts_delay;
408 vlc_object_release( p_input_thread );
412 p_vout->i_pts_delay = DEFAULT_PTS_DELAY;
415 if( vlc_thread_create( p_vout, "video output", RunThread,
416 VLC_THREAD_PRIORITY_OUTPUT, VLC_TRUE ) )
418 msg_Err( p_vout, "out of memory" );
419 module_Unneed( p_vout, p_vout->p_module );
420 vlc_object_detach( p_vout );
421 vlc_object_destroy( p_vout );
425 if( p_vout->b_error )
427 msg_Err( p_vout, "video output creation failed" );
429 /* Make sure the thread is destroyed */
430 p_vout->b_die = VLC_TRUE;
432 vlc_thread_join( p_vout );
434 vlc_object_detach( p_vout );
435 vlc_object_destroy( p_vout );
442 /*****************************************************************************
443 * vout_Destroy: destroys a previously created video output
444 *****************************************************************************
445 * Destroy a terminated thread.
446 * The function will request a destruction of the specified thread. If pi_error
447 * is NULL, it will return once the thread is destroyed. Else, it will be
448 * update using one of the THREAD_* constants.
449 *****************************************************************************/
450 void vout_Destroy( vout_thread_t *p_vout )
452 vlc_object_t *p_playlist;
454 /* Request thread destruction */
455 p_vout->b_die = VLC_TRUE;
456 vlc_thread_join( p_vout );
458 var_Destroy( p_vout, "intf-change" );
460 p_playlist = vlc_object_find( p_vout, VLC_OBJECT_PLAYLIST,
463 if( p_vout->psz_filter_chain ) free( p_vout->psz_filter_chain );
466 vlc_object_destroy( p_vout );
468 /* If it was the last vout, tell the interface to show up */
469 if( p_playlist != NULL )
471 vout_thread_t *p_another_vout = vlc_object_find( p_playlist,
472 VLC_OBJECT_VOUT, FIND_ANYWHERE );
473 if( p_another_vout == NULL )
476 val.b_bool = VLC_TRUE;
477 var_Set( p_playlist, "intf-show", val );
481 vlc_object_release( p_another_vout );
483 vlc_object_release( p_playlist );
487 /*****************************************************************************
488 * InitThread: initialize video output thread
489 *****************************************************************************
490 * This function is called from RunThread and performs the second step of the
491 * initialization. It returns 0 on success. Note that the thread's flag are not
492 * modified inside this function.
493 *****************************************************************************/
494 static int InitThread( vout_thread_t *p_vout )
496 int i, i_aspect_x, i_aspect_y;
498 vlc_mutex_lock( &p_vout->change_lock );
504 /* Initialize output method, it allocates direct buffers for us */
505 if( p_vout->pf_init( p_vout ) )
507 vlc_mutex_unlock( &p_vout->change_lock );
511 if( !I_OUTPUTPICTURES )
513 msg_Err( p_vout, "plugin was unable to allocate at least "
514 "one direct buffer" );
515 p_vout->pf_end( p_vout );
516 vlc_mutex_unlock( &p_vout->change_lock );
520 if( I_OUTPUTPICTURES > VOUT_MAX_PICTURES )
522 msg_Err( p_vout, "plugin allocated too many direct buffers, "
523 "our internal buffers must have overflown." );
524 p_vout->pf_end( p_vout );
525 vlc_mutex_unlock( &p_vout->change_lock );
529 msg_Dbg( p_vout, "got %i direct buffer(s)", I_OUTPUTPICTURES );
531 AspectRatio( p_vout->fmt_render.i_aspect, &i_aspect_x, &i_aspect_y );
533 msg_Dbg( p_vout, "picture in %ix%i (%i,%i,%ix%i), "
534 "chroma %4.4s, ar %i:%i, sar %i:%i",
535 p_vout->fmt_render.i_width, p_vout->fmt_render.i_height,
536 p_vout->fmt_render.i_x_offset, p_vout->fmt_render.i_y_offset,
537 p_vout->fmt_render.i_visible_width,
538 p_vout->fmt_render.i_visible_height,
539 (char*)&p_vout->fmt_render.i_chroma,
540 i_aspect_x, i_aspect_y,
541 p_vout->fmt_render.i_sar_num, p_vout->fmt_render.i_sar_den );
543 AspectRatio( p_vout->fmt_in.i_aspect, &i_aspect_x, &i_aspect_y );
545 msg_Dbg( p_vout, "picture user %ix%i (%i,%i,%ix%i), "
546 "chroma %4.4s, ar %i:%i, sar %i:%i",
547 p_vout->fmt_in.i_width, p_vout->fmt_in.i_height,
548 p_vout->fmt_in.i_x_offset, p_vout->fmt_in.i_y_offset,
549 p_vout->fmt_in.i_visible_width,
550 p_vout->fmt_in.i_visible_height,
551 (char*)&p_vout->fmt_in.i_chroma,
552 i_aspect_x, i_aspect_y,
553 p_vout->fmt_in.i_sar_num, p_vout->fmt_in.i_sar_den );
555 if( !p_vout->fmt_out.i_width || !p_vout->fmt_out.i_height )
557 p_vout->fmt_out.i_width = p_vout->fmt_out.i_visible_width =
558 p_vout->output.i_width;
559 p_vout->fmt_out.i_height = p_vout->fmt_out.i_visible_height =
560 p_vout->output.i_height;
561 p_vout->fmt_out.i_x_offset = p_vout->fmt_out.i_y_offset = 0;
563 p_vout->fmt_out.i_aspect = p_vout->output.i_aspect;
564 p_vout->fmt_out.i_chroma = p_vout->output.i_chroma;
566 if( !p_vout->fmt_out.i_sar_num || !p_vout->fmt_out.i_sar_num )
568 p_vout->fmt_out.i_sar_num = p_vout->fmt_out.i_aspect *
569 p_vout->fmt_out.i_height;
570 p_vout->fmt_out.i_sar_den = VOUT_ASPECT_FACTOR *
571 p_vout->fmt_out.i_width;
574 vlc_ureduce( &p_vout->fmt_out.i_sar_num, &p_vout->fmt_out.i_sar_den,
575 p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den, 0 );
577 AspectRatio( p_vout->fmt_out.i_aspect, &i_aspect_x, &i_aspect_y );
579 msg_Dbg( p_vout, "picture out %ix%i (%i,%i,%ix%i), "
580 "chroma %4.4s, ar %i:%i, sar %i:%i",
581 p_vout->fmt_out.i_width, p_vout->fmt_out.i_height,
582 p_vout->fmt_out.i_x_offset, p_vout->fmt_out.i_y_offset,
583 p_vout->fmt_out.i_visible_width,
584 p_vout->fmt_out.i_visible_height,
585 (char*)&p_vout->fmt_out.i_chroma,
586 i_aspect_x, i_aspect_y,
587 p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den );
589 /* Calculate shifts from system-updated masks */
590 MaskToShift( &p_vout->output.i_lrshift, &p_vout->output.i_rrshift,
591 p_vout->output.i_rmask );
592 MaskToShift( &p_vout->output.i_lgshift, &p_vout->output.i_rgshift,
593 p_vout->output.i_gmask );
594 MaskToShift( &p_vout->output.i_lbshift, &p_vout->output.i_rbshift,
595 p_vout->output.i_bmask );
597 /* Check whether we managed to create direct buffers similar to
598 * the render buffers, ie same size and chroma */
599 if( ( p_vout->output.i_width == p_vout->render.i_width )
600 && ( p_vout->output.i_height == p_vout->render.i_height )
601 && ( vout_ChromaCmp( p_vout->output.i_chroma, p_vout->render.i_chroma ) ) )
603 /* Cool ! We have direct buffers, we can ask the decoder to
604 * directly decode into them ! Map the first render buffers to
605 * the first direct buffers, but keep the first direct buffer
606 * for memcpy operations */
607 p_vout->b_direct = 1;
609 for( i = 1; i < VOUT_MAX_PICTURES; i++ )
611 if( p_vout->p_picture[ i ].i_type != DIRECT_PICTURE &&
612 I_RENDERPICTURES >= VOUT_MIN_DIRECT_PICTURES - 1 &&
613 p_vout->p_picture[ i - 1 ].i_type == DIRECT_PICTURE )
615 /* We have enough direct buffers so there's no need to
616 * try to use system memory buffers. */
619 PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
623 msg_Dbg( p_vout, "direct render, mapping "
624 "render pictures 0-%i to system pictures 1-%i",
625 VOUT_MAX_PICTURES - 2, VOUT_MAX_PICTURES - 1 );
629 /* Rats... Something is wrong here, we could not find an output
630 * plugin able to directly render what we decode. See if we can
631 * find a chroma plugin to do the conversion */
632 p_vout->b_direct = 0;
634 /* Choose the best module */
635 p_vout->chroma.p_module = module_Need( p_vout, "chroma", NULL, 0 );
637 if( p_vout->chroma.p_module == NULL )
639 msg_Err( p_vout, "no chroma module for %4.4s to %4.4s",
640 (char*)&p_vout->render.i_chroma,
641 (char*)&p_vout->output.i_chroma );
642 p_vout->pf_end( p_vout );
643 vlc_mutex_unlock( &p_vout->change_lock );
647 msg_Dbg( p_vout, "indirect render, mapping "
648 "render pictures 0-%i to system pictures %i-%i",
649 VOUT_MAX_PICTURES - 1, I_OUTPUTPICTURES,
650 I_OUTPUTPICTURES + VOUT_MAX_PICTURES - 1 );
652 /* Append render buffers after the direct buffers */
653 for( i = I_OUTPUTPICTURES; i < 2 * VOUT_MAX_PICTURES; i++ )
655 PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
658 /* Check if we have enough render pictures */
659 if( I_RENDERPICTURES == VOUT_MAX_PICTURES )
664 /* Link pictures back to their heap */
665 for( i = 0 ; i < I_RENDERPICTURES ; i++ )
667 PP_RENDERPICTURE[ i ]->p_heap = &p_vout->render;
670 for( i = 0 ; i < I_OUTPUTPICTURES ; i++ )
672 PP_OUTPUTPICTURE[ i ]->p_heap = &p_vout->output;
675 /* XXX XXX mark thread ready */
679 /*****************************************************************************
680 * RunThread: video output thread
681 *****************************************************************************
682 * Video output thread. This function does only returns when the thread is
683 * terminated. It handles the pictures arriving in the video heap and the
684 * display device events.
685 *****************************************************************************/
686 static void RunThread( vout_thread_t *p_vout)
688 int i_index; /* index in heap */
689 int i_idle_loops = 0; /* loops without displaying a picture */
690 mtime_t current_date; /* current date */
691 mtime_t display_date; /* display date */
693 picture_t * p_picture; /* picture pointer */
694 picture_t * p_last_picture = NULL; /* last picture */
695 picture_t * p_directbuffer; /* direct buffer to display */
697 subpicture_t * p_subpic = NULL; /* subpicture pointer */
702 p_vout->b_error = InitThread( p_vout );
704 /* signal the creation of the vout */
705 vlc_thread_ready( p_vout );
707 if( p_vout->b_error )
709 /* Destroy thread structures allocated by Create and InitThread */
710 DestroyThread( p_vout );
715 * Main loop - it is not executed if an error occurred during
718 while( (!p_vout->b_die) && (!p_vout->b_error) )
720 /* Initialize loop variables */
723 current_date = mdate();
727 if( !(p_vout->c_loops % VOUT_STATS_NB_LOOPS) )
729 msg_Dbg( p_vout, "picture heap: %d/%d",
730 I_RENDERPICTURES, p_vout->i_heap_size );
735 * Find the picture to display (the one with the earliest date).
736 * This operation does not need lock, since only READY_PICTUREs
738 for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
740 if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
741 && ( (p_picture == NULL) ||
742 (PP_RENDERPICTURE[i_index]->date < display_date) ) )
744 p_picture = PP_RENDERPICTURE[i_index];
745 display_date = p_picture->date;
751 /* If we met the last picture, parse again to see whether there is
752 * a more appropriate one. */
753 if( p_picture == p_last_picture )
755 for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
757 if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
758 && (PP_RENDERPICTURE[i_index] != p_last_picture)
759 && ((p_picture == p_last_picture) ||
760 (PP_RENDERPICTURE[i_index]->date < display_date)) )
762 p_picture = PP_RENDERPICTURE[i_index];
763 display_date = p_picture->date;
768 /* If we found better than the last picture, destroy it */
769 if( p_last_picture && p_picture != p_last_picture )
771 vlc_mutex_lock( &p_vout->picture_lock );
772 if( p_last_picture->i_refcount )
774 p_last_picture->i_status = DISPLAYED_PICTURE;
778 p_last_picture->i_status = DESTROYED_PICTURE;
779 p_vout->i_heap_size--;
781 vlc_mutex_unlock( &p_vout->picture_lock );
782 p_last_picture = NULL;
785 /* Compute FPS rate */
786 p_vout->p_fps_sample[ p_vout->c_fps_samples++ % VOUT_FPS_SAMPLES ]
789 /* XXX: config_GetInt is slow, but this kind of frame dropping
790 * should not happen that often. */
791 if( !p_picture->b_force &&
792 p_picture != p_last_picture &&
793 display_date < current_date + p_vout->render_time &&
794 config_GetInt( p_vout, "skip-frames" ) )
796 /* Picture is late: it will be destroyed and the thread
797 * will directly choose the next picture */
798 vlc_mutex_lock( &p_vout->picture_lock );
799 if( p_picture->i_refcount )
801 /* Pretend we displayed the picture, but don't destroy
802 * it since the decoder might still need it. */
803 p_picture->i_status = DISPLAYED_PICTURE;
807 /* Destroy the picture without displaying it */
808 p_picture->i_status = DESTROYED_PICTURE;
809 p_vout->i_heap_size--;
811 msg_Warn( p_vout, "late picture skipped ("I64Fd")",
812 current_date - display_date );
813 vlc_mutex_unlock( &p_vout->picture_lock );
819 current_date + p_vout->i_pts_delay + VOUT_BOGUS_DELAY )
821 /* Picture is waaay too early: it will be destroyed */
822 vlc_mutex_lock( &p_vout->picture_lock );
823 if( p_picture->i_refcount )
825 /* Pretend we displayed the picture, but don't destroy
826 * it since the decoder might still need it. */
827 p_picture->i_status = DISPLAYED_PICTURE;
831 /* Destroy the picture without displaying it */
832 p_picture->i_status = DESTROYED_PICTURE;
833 p_vout->i_heap_size--;
835 msg_Warn( p_vout, "vout warning: early picture skipped "
836 "("I64Fd")", display_date - current_date
837 - p_vout->i_pts_delay );
838 vlc_mutex_unlock( &p_vout->picture_lock );
843 if( display_date > current_date + VOUT_DISPLAY_DELAY )
845 /* A picture is ready to be rendered, but its rendering date
846 * is far from the current one so the thread will perform an
847 * empty loop as if no picture were found. The picture state
852 else if( p_picture == p_last_picture )
854 /* We are asked to repeat the previous picture, but we first
855 * wait for a couple of idle loops */
856 if( i_idle_loops < 4 )
863 /* We set the display date to something high, otherwise
864 * we'll have lots of problems with late pictures */
865 display_date = current_date + p_vout->render_time;
870 if( p_picture == NULL )
875 if( p_picture && p_vout->b_snapshot )
877 p_vout->b_snapshot = VLC_FALSE;
878 vout_Snapshot( p_vout, p_picture );
882 * Check for subpictures to display
884 if( display_date > 0 )
886 p_subpic = spu_SortSubpictures( p_vout->p_spu, display_date );
892 p_directbuffer = vout_RenderPicture( p_vout, p_picture, p_subpic );
895 * Call the plugin-specific rendering method if there is one
897 if( p_picture != NULL && p_directbuffer != NULL && p_vout->pf_render )
899 /* Render the direct buffer returned by vout_RenderPicture */
900 p_vout->pf_render( p_vout, p_directbuffer );
906 if( display_date != 0 && p_directbuffer != NULL )
908 mtime_t current_render_time = mdate() - current_date;
909 /* if render time is very large we don't include it in the mean */
910 if( current_render_time < p_vout->render_time +
913 /* Store render time using a sliding mean weighting to
914 * current value in a 3 to 1 ratio*/
915 p_vout->render_time *= 3;
916 p_vout->render_time += current_render_time;
917 p_vout->render_time >>= 2;
921 /* Give back change lock */
922 vlc_mutex_unlock( &p_vout->change_lock );
924 /* Sleep a while or until a given date */
925 if( display_date != 0 )
927 /* If there are filters in the chain, better give them the picture
929 if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
931 mwait( display_date - VOUT_MWAIT_TOLERANCE );
936 msleep( VOUT_IDLE_SLEEP );
939 /* On awakening, take back lock and send immediately picture
941 vlc_mutex_lock( &p_vout->change_lock );
944 * Display the previously rendered picture
946 if( p_picture != NULL && p_directbuffer != NULL )
948 /* Display the direct buffer returned by vout_RenderPicture */
949 if( p_vout->pf_display )
951 p_vout->pf_display( p_vout, p_directbuffer );
954 /* Tell the vout this was the last picture and that it does not
955 * need to be forced anymore. */
956 p_last_picture = p_picture;
957 p_last_picture->b_force = 0;
960 if( p_picture != NULL )
962 /* Reinitialize idle loop count */
967 * Check events and manage thread
969 if( p_vout->pf_manage && p_vout->pf_manage( p_vout ) )
971 /* A fatal error occurred, and the thread must terminate
972 * immediately, without displaying anything - setting b_error to 1
973 * causes the immediate end of the main while() loop. */
977 if( p_vout->i_changes & VOUT_SIZE_CHANGE )
979 /* this must only happen when the vout plugin is incapable of
980 * rescaling the picture itself. In this case we need to destroy
981 * the current picture buffers and recreate new ones with the right
985 p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
987 p_vout->pf_end( p_vout );
988 for( i = 0; i < I_OUTPUTPICTURES; i++ )
989 p_vout->p_picture[ i ].i_status = FREE_PICTURE;
991 I_OUTPUTPICTURES = 0;
992 if( p_vout->pf_init( p_vout ) )
994 msg_Err( p_vout, "cannot resize display" );
995 /* FIXME: pf_end will be called again in EndThread() */
999 /* Need to reinitialise the chroma plugin */
1000 if( p_vout->chroma.p_module )
1002 if( p_vout->chroma.p_module->pf_deactivate )
1003 p_vout->chroma.p_module->pf_deactivate( VLC_OBJECT(p_vout) );
1004 p_vout->chroma.p_module->pf_activate( VLC_OBJECT(p_vout) );
1008 if( p_vout->i_changes & VOUT_PICTURE_BUFFERS_CHANGE )
1010 /* This happens when the picture buffers need to be recreated.
1011 * This is useful on multimonitor displays for instance.
1013 * Warning: This only works when the vout creates only 1 picture
1015 p_vout->i_changes &= ~VOUT_PICTURE_BUFFERS_CHANGE;
1017 if( !p_vout->b_direct )
1019 module_Unneed( p_vout, p_vout->chroma.p_module );
1022 vlc_mutex_lock( &p_vout->picture_lock );
1024 p_vout->pf_end( p_vout );
1026 I_OUTPUTPICTURES = I_RENDERPICTURES = 0;
1028 p_vout->b_error = InitThread( p_vout );
1030 vlc_mutex_unlock( &p_vout->picture_lock );
1035 * Error loop - wait until the thread destruction is requested
1037 if( p_vout->b_error )
1039 ErrorThread( p_vout );
1043 EndThread( p_vout );
1045 /* Destroy thread structures allocated by CreateThread */
1046 DestroyThread( p_vout );
1049 /*****************************************************************************
1050 * ErrorThread: RunThread() error loop
1051 *****************************************************************************
1052 * This function is called when an error occurred during thread main's loop.
1053 * The thread can still receive feed, but must be ready to terminate as soon
1055 *****************************************************************************/
1056 static void ErrorThread( vout_thread_t *p_vout )
1058 /* Wait until a `die' order */
1059 while( !p_vout->b_die )
1062 msleep( VOUT_IDLE_SLEEP );
1066 /*****************************************************************************
1067 * EndThread: thread destruction
1068 *****************************************************************************
1069 * This function is called when the thread ends after a sucessful
1070 * initialization. It frees all resources allocated by InitThread.
1071 *****************************************************************************/
1072 static void EndThread( vout_thread_t *p_vout )
1074 int i_index; /* index in heap */
1078 struct tms cpu_usage;
1079 times( &cpu_usage );
1081 msg_Dbg( p_vout, "cpu usage (user: %d, system: %d)",
1082 cpu_usage.tms_utime, cpu_usage.tms_stime );
1086 if( !p_vout->b_direct )
1088 module_Unneed( p_vout, p_vout->chroma.p_module );
1091 /* Destroy all remaining pictures */
1092 for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++ )
1094 if ( p_vout->p_picture[i_index].i_type == MEMORY_PICTURE )
1096 free( p_vout->p_picture[i_index].p_data_orig );
1100 /* Destroy subpicture unit */
1101 spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), VLC_FALSE );
1102 spu_Destroy( p_vout->p_spu );
1104 /* Destroy translation tables */
1105 p_vout->pf_end( p_vout );
1107 /* Release the change lock */
1108 vlc_mutex_unlock( &p_vout->change_lock );
1111 /*****************************************************************************
1112 * DestroyThread: thread destruction
1113 *****************************************************************************
1114 * This function is called when the thread ends. It frees all ressources
1115 * allocated by CreateThread. Status is available at this stage.
1116 *****************************************************************************/
1117 static void DestroyThread( vout_thread_t *p_vout )
1119 /* Destroy the locks */
1120 vlc_mutex_destroy( &p_vout->picture_lock );
1121 vlc_mutex_destroy( &p_vout->change_lock );
1123 /* Release the module */
1124 if( p_vout && p_vout->p_module )
1126 module_Unneed( p_vout, p_vout->p_module );
1130 /* following functions are local */
1132 static int ReduceHeight( int i_ratio )
1134 int i_dummy = VOUT_ASPECT_FACTOR;
1142 /* VOUT_ASPECT_FACTOR is (2^7 * 3^3 * 5^3), we just check for 2, 3 and 5 */
1143 while( !(i_ratio & 1) && !(i_dummy & 1) )
1150 while( !(i_ratio % 3) && !(i_dummy % 3) )
1157 while( !(i_ratio % 5) && !(i_dummy % 5) )
1167 static void AspectRatio( int i_aspect, int *i_aspect_x, int *i_aspect_y )
1169 unsigned int i_pgcd = ReduceHeight( i_aspect );
1170 *i_aspect_x = i_aspect / i_pgcd;
1171 *i_aspect_y = VOUT_ASPECT_FACTOR / i_pgcd;
1174 /*****************************************************************************
1175 * BinaryLog: computes the base 2 log of a binary value
1176 *****************************************************************************
1177 * This functions is used by MaskToShift, to get a bit index from a binary
1179 *****************************************************************************/
1180 static int BinaryLog( uint32_t i )
1184 if( i == 0 ) return -31337;
1186 if( i & 0xffff0000 ) i_log += 16;
1187 if( i & 0xff00ff00 ) i_log += 8;
1188 if( i & 0xf0f0f0f0 ) i_log += 4;
1189 if( i & 0xcccccccc ) i_log += 2;
1190 if( i & 0xaaaaaaaa ) i_log += 1;
1195 /*****************************************************************************
1196 * MaskToShift: transform a color mask into right and left shifts
1197 *****************************************************************************
1198 * This function is used for obtaining color shifts from masks.
1199 *****************************************************************************/
1200 static void MaskToShift( int *pi_left, int *pi_right, uint32_t i_mask )
1202 uint32_t i_low, i_high; /* lower hand higher bits of the mask */
1206 *pi_left = *pi_right = 0;
1211 i_low = i_mask & (- (int32_t)i_mask); /* lower bit of the mask */
1212 i_high = i_mask + i_low; /* higher bit of the mask */
1214 /* Transform bits into an index */
1215 i_low = BinaryLog (i_low);
1216 i_high = BinaryLog (i_high);
1218 /* Update pointers and return */
1220 *pi_right = (8 - i_high + i_low);
1223 /*****************************************************************************
1224 * vout_VarCallback: generic callback for intf variables
1225 *****************************************************************************/
1226 int vout_VarCallback( vlc_object_t * p_this, const char * psz_variable,
1227 vlc_value_t old_value, vlc_value_t new_value,
1230 vout_thread_t * p_vout = (vout_thread_t *)p_this;
1232 val.b_bool = VLC_TRUE;
1233 var_Set( p_vout, "intf-change", val );
1237 /*****************************************************************************
1238 * Helper thread for object variables callbacks.
1239 * Only used to avoid deadlocks when using the video embedded mode.
1240 *****************************************************************************/
1241 typedef struct suxor_thread_t
1244 input_thread_t *p_input;
1248 static void SuxorRestartVideoES( suxor_thread_t *p_this )
1252 vlc_thread_ready( p_this );
1254 /* Now restart current video stream */
1255 var_Get( p_this->p_input, "video-es", &val );
1256 if( val.i_int >= 0 )
1259 val_es.i_int = -VIDEO_ES;
1260 var_Set( p_this->p_input, "video-es", val_es );
1261 var_Set( p_this->p_input, "video-es", val );
1264 vlc_object_release( p_this->p_input );
1267 CloseHandle( p_this->thread_id );
1270 vlc_object_destroy( p_this );
1273 /*****************************************************************************
1274 * object variables callbacks: a bunch of object variables are used by the
1275 * interfaces to interact with the vout.
1276 *****************************************************************************/
1277 static int DeinterlaceCallback( vlc_object_t *p_this, char const *psz_cmd,
1278 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1280 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1281 input_thread_t *p_input;
1284 char *psz_mode = newval.psz_string;
1285 char *psz_filter, *psz_deinterlace = NULL;
1287 var_Get( p_vout, "vout-filter", &val );
1288 psz_filter = val.psz_string;
1289 if( psz_filter ) psz_deinterlace = strstr( psz_filter, "deinterlace" );
1291 if( !psz_mode || !*psz_mode )
1293 if( psz_deinterlace )
1295 char *psz_src = psz_deinterlace + sizeof("deinterlace") - 1;
1296 if( psz_src[0] == ':' ) psz_src++;
1297 memmove( psz_deinterlace, psz_src, strlen(psz_src) + 1 );
1300 else if( !psz_deinterlace )
1302 psz_filter = realloc( psz_filter, strlen( psz_filter ) +
1303 sizeof(":deinterlace") );
1304 if( psz_filter && *psz_filter ) strcat( psz_filter, ":" );
1305 strcat( psz_filter, "deinterlace" );
1308 p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1310 if( !p_input ) return VLC_EGENERIC;
1312 if( psz_mode && *psz_mode )
1314 /* Modify input as well because the vout might have to be restarted */
1315 val.psz_string = psz_mode;
1316 var_Create( p_input, "deinterlace-mode", VLC_VAR_STRING );
1317 var_Set( p_input, "deinterlace-mode", val );
1319 vlc_object_release( p_input );
1321 val.b_bool = VLC_TRUE;
1322 var_Set( p_vout, "intf-change", val );
1324 val.psz_string = psz_filter;
1325 var_Set( p_vout, "vout-filter", val );
1326 if( psz_filter ) free( psz_filter );
1331 static int FilterCallback( vlc_object_t *p_this, char const *psz_cmd,
1332 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1334 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1335 input_thread_t *p_input;
1338 p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1342 msg_Err( p_vout, "Input not found" );
1343 return( VLC_EGENERIC );
1346 val.b_bool = VLC_TRUE;
1347 var_Set( p_vout, "intf-change", val );
1349 /* Modify input as well because the vout might have to be restarted */
1350 val.psz_string = newval.psz_string;
1351 var_Create( p_input, "vout-filter", VLC_VAR_STRING );
1353 var_Set( p_input, "vout-filter", val );
1355 /* Now restart current video stream */
1356 var_Get( p_input, "video-es", &val );
1357 if( val.i_int >= 0 )
1359 suxor_thread_t *p_suxor =
1360 vlc_object_create( p_vout, sizeof(suxor_thread_t) );
1361 p_suxor->p_input = p_input;
1362 p_vout->b_filter_change = VLC_TRUE;
1363 vlc_object_yield( p_input );
1364 vlc_thread_create( p_suxor, "suxor", SuxorRestartVideoES,
1365 VLC_THREAD_PRIORITY_LOW, VLC_FALSE );
1368 vlc_object_release( p_input );