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, 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 vlc_ureduce( &p_vout->fmt_render.i_sar_num, &p_vout->fmt_render.i_sar_den,
253 p_vout->fmt_render.i_sar_num, p_vout->fmt_render.i_sar_den, 0 );
254 vlc_ureduce( &p_vout->fmt_in.i_sar_num, &p_vout->fmt_in.i_sar_den,
255 p_vout->fmt_in.i_sar_num, p_vout->fmt_in.i_sar_den, 0 );
257 p_vout->render.i_width = i_width;
258 p_vout->render.i_height = i_height;
259 p_vout->render.i_chroma = i_chroma;
260 p_vout->render.i_aspect = i_aspect;
262 p_vout->render.i_rmask = 0;
263 p_vout->render.i_gmask = 0;
264 p_vout->render.i_bmask = 0;
266 p_vout->render.i_last_used_pic = -1;
267 p_vout->render.b_allow_modify_pics = 1;
269 /* Zero the output heap */
270 I_OUTPUTPICTURES = 0;
271 p_vout->output.i_width = 0;
272 p_vout->output.i_height = 0;
273 p_vout->output.i_chroma = 0;
274 p_vout->output.i_aspect = 0;
276 p_vout->output.i_rmask = 0;
277 p_vout->output.i_gmask = 0;
278 p_vout->output.i_bmask = 0;
280 /* Initialize misc stuff */
281 p_vout->i_changes = 0;
283 p_vout->b_grayscale = 0;
285 p_vout->b_interface = 0;
287 p_vout->b_fullscreen = 0;
288 p_vout->i_alignment = 0;
289 p_vout->render_time = 10;
290 p_vout->c_fps_samples = 0;
291 p_vout->b_filter_change = 0;
292 p_vout->pf_control = 0;
293 p_vout->p_parent_intf = 0;
294 p_vout->i_par_num = p_vout->i_par_den = 1;
296 /* Initialize locks */
297 vlc_mutex_init( p_vout, &p_vout->picture_lock );
298 vlc_mutex_init( p_vout, &p_vout->change_lock );
300 /* Mouse coordinates */
301 var_Create( p_vout, "mouse-x", VLC_VAR_INTEGER );
302 var_Create( p_vout, "mouse-y", VLC_VAR_INTEGER );
303 var_Create( p_vout, "mouse-button-down", VLC_VAR_INTEGER );
304 var_Create( p_vout, "mouse-moved", VLC_VAR_BOOL );
305 var_Create( p_vout, "mouse-clicked", VLC_VAR_INTEGER );
307 /* Initialize subpicture unit */
308 p_vout->p_spu = spu_Create( p_vout );
309 spu_Attach( p_vout->p_spu, p_parent, VLC_TRUE );
311 /* Attach the new object now so we can use var inheritance below */
312 vlc_object_attach( p_vout, p_parent );
314 spu_Init( p_vout->p_spu );
316 /* Take care of some "interface/control" related initialisations */
317 vout_IntfInit( p_vout );
319 p_vout->b_override_aspect = VLC_FALSE;
321 /* If the parent is not a VOUT object, that means we are at the start of
322 * the video output pipe */
323 if( p_parent->i_object_type != VLC_OBJECT_VOUT )
325 /* Look for the default filter configuration */
326 var_Create( p_vout, "vout-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
327 var_Get( p_vout, "vout-filter", &val );
328 p_vout->psz_filter_chain = val.psz_string;
332 /* continue the parent's filter chain */
335 psz_end = strchr( ((vout_thread_t *)p_parent)->psz_filter_chain, ':' );
336 if( psz_end && *(psz_end+1) )
337 p_vout->psz_filter_chain = strdup( psz_end+1 );
338 else p_vout->psz_filter_chain = NULL;
341 /* Choose the video output module */
342 if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
344 var_Create( p_vout, "vout", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
345 var_Get( p_vout, "vout", &val );
346 psz_plugin = val.psz_string;
350 /* the filter chain is a string list of filters separated by double
354 psz_end = strchr( p_vout->psz_filter_chain, ':' );
356 psz_plugin = strndup( p_vout->psz_filter_chain,
357 psz_end - p_vout->psz_filter_chain );
358 else psz_plugin = strdup( p_vout->psz_filter_chain );
361 /* Initialize the dimensions of the video window */
362 InitWindowSize( p_vout, &p_vout->i_window_width,
363 &p_vout->i_window_height );
364 msg_Dbg( p_vout, "Window size: %dx%d", p_vout->i_window_width,
365 p_vout->i_window_height );
367 /* Create the vout thread */
368 p_vout->p_module = module_Need( p_vout,
369 ( p_vout->psz_filter_chain && *p_vout->psz_filter_chain ) ?
370 "video filter" : "video output", psz_plugin, 0 );
372 if( psz_plugin ) free( psz_plugin );
373 if( p_vout->p_module == NULL )
375 msg_Err( p_vout, "no suitable vout module" );
376 vlc_object_detach( p_vout );
377 vlc_object_destroy( p_vout );
381 /* Create a few object variables for interface interaction */
382 var_Create( p_vout, "deinterlace", VLC_VAR_STRING | VLC_VAR_HASCHOICE );
383 text.psz_string = _("Deinterlace");
384 var_Change( p_vout, "deinterlace", VLC_VAR_SETTEXT, &text, NULL );
385 val.psz_string = ""; text.psz_string = _("Disable");
386 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
387 val.psz_string = "discard"; text.psz_string = _("Discard");
388 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
389 val.psz_string = "blend"; text.psz_string = _("Blend");
390 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
391 val.psz_string = "mean"; text.psz_string = _("Mean");
392 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
393 val.psz_string = "bob"; text.psz_string = _("Bob");
394 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
395 val.psz_string = "linear"; text.psz_string = _("Linear");
396 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
397 val.psz_string = "x"; text.psz_string = "X";
398 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
400 if( var_Get( p_vout, "deinterlace-mode", &val ) == VLC_SUCCESS )
402 var_Set( p_vout, "deinterlace", val );
403 if( val.psz_string ) free( val.psz_string );
405 var_AddCallback( p_vout, "deinterlace", DeinterlaceCallback, NULL );
408 var_Create( p_vout, "vout-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
409 text.psz_string = _("Filters");
410 var_Change( p_vout, "vout-filter", VLC_VAR_SETTEXT, &text, NULL );
411 var_AddCallback( p_vout, "vout-filter", FilterCallback, NULL );
413 /* Calculate delay created by internal caching */
414 p_input_thread = (input_thread_t *)vlc_object_find( p_vout,
415 VLC_OBJECT_INPUT, FIND_ANYWHERE );
418 p_vout->i_pts_delay = p_input_thread->i_pts_delay;
419 vlc_object_release( p_input_thread );
423 p_vout->i_pts_delay = DEFAULT_PTS_DELAY;
426 if( vlc_thread_create( p_vout, "video output", RunThread,
427 VLC_THREAD_PRIORITY_OUTPUT, VLC_TRUE ) )
429 msg_Err( p_vout, "out of memory" );
430 module_Unneed( p_vout, p_vout->p_module );
431 vlc_object_detach( p_vout );
432 vlc_object_destroy( p_vout );
436 if( p_vout->b_error )
438 msg_Err( p_vout, "video output creation failed" );
440 /* Make sure the thread is destroyed */
441 p_vout->b_die = VLC_TRUE;
443 vlc_thread_join( p_vout );
445 vlc_object_detach( p_vout );
446 vlc_object_destroy( p_vout );
453 /*****************************************************************************
454 * vout_Destroy: destroys a previously created video output
455 *****************************************************************************
456 * Destroy a terminated thread.
457 * The function will request a destruction of the specified thread. If pi_error
458 * is NULL, it will return once the thread is destroyed. Else, it will be
459 * update using one of the THREAD_* constants.
460 *****************************************************************************/
461 void vout_Destroy( vout_thread_t *p_vout )
463 vlc_object_t *p_playlist;
465 /* Request thread destruction */
466 p_vout->b_die = VLC_TRUE;
467 vlc_thread_join( p_vout );
469 var_Destroy( p_vout, "intf-change" );
471 p_playlist = vlc_object_find( p_vout, VLC_OBJECT_PLAYLIST,
474 if( p_vout->psz_filter_chain ) free( p_vout->psz_filter_chain );
477 vlc_object_destroy( p_vout );
479 /* If it was the last vout, tell the interface to show up */
480 if( p_playlist != NULL )
482 vout_thread_t *p_another_vout = vlc_object_find( p_playlist,
483 VLC_OBJECT_VOUT, FIND_ANYWHERE );
484 if( p_another_vout == NULL )
487 val.b_bool = VLC_TRUE;
488 var_Set( p_playlist, "intf-show", val );
492 vlc_object_release( p_another_vout );
494 vlc_object_release( p_playlist );
498 /*****************************************************************************
499 * InitThread: initialize video output thread
500 *****************************************************************************
501 * This function is called from RunThread and performs the second step of the
502 * initialization. It returns 0 on success. Note that the thread's flag are not
503 * modified inside this function.
504 *****************************************************************************/
505 static int InitThread( vout_thread_t *p_vout )
507 int i, i_aspect_x, i_aspect_y;
509 vlc_mutex_lock( &p_vout->change_lock );
515 /* Initialize output method, it allocates direct buffers for us */
516 if( p_vout->pf_init( p_vout ) )
518 vlc_mutex_unlock( &p_vout->change_lock );
522 if( !I_OUTPUTPICTURES )
524 msg_Err( p_vout, "plugin was unable to allocate at least "
525 "one direct buffer" );
526 p_vout->pf_end( p_vout );
527 vlc_mutex_unlock( &p_vout->change_lock );
531 if( I_OUTPUTPICTURES > VOUT_MAX_PICTURES )
533 msg_Err( p_vout, "plugin allocated too many direct buffers, "
534 "our internal buffers must have overflown." );
535 p_vout->pf_end( p_vout );
536 vlc_mutex_unlock( &p_vout->change_lock );
540 msg_Dbg( p_vout, "got %i direct buffer(s)", I_OUTPUTPICTURES );
542 AspectRatio( p_vout->fmt_render.i_aspect, &i_aspect_x, &i_aspect_y );
544 msg_Dbg( p_vout, "picture in %ix%i (%i,%i,%ix%i), "
545 "chroma %4.4s, ar %i:%i, sar %i:%i",
546 p_vout->fmt_render.i_width, p_vout->fmt_render.i_height,
547 p_vout->fmt_render.i_x_offset, p_vout->fmt_render.i_y_offset,
548 p_vout->fmt_render.i_visible_width,
549 p_vout->fmt_render.i_visible_height,
550 (char*)&p_vout->fmt_render.i_chroma,
551 i_aspect_x, i_aspect_y,
552 p_vout->fmt_render.i_sar_num, p_vout->fmt_render.i_sar_den );
554 AspectRatio( p_vout->fmt_in.i_aspect, &i_aspect_x, &i_aspect_y );
556 msg_Dbg( p_vout, "picture user %ix%i (%i,%i,%ix%i), "
557 "chroma %4.4s, ar %i:%i, sar %i:%i",
558 p_vout->fmt_in.i_width, p_vout->fmt_in.i_height,
559 p_vout->fmt_in.i_x_offset, p_vout->fmt_in.i_y_offset,
560 p_vout->fmt_in.i_visible_width,
561 p_vout->fmt_in.i_visible_height,
562 (char*)&p_vout->fmt_in.i_chroma,
563 i_aspect_x, i_aspect_y,
564 p_vout->fmt_in.i_sar_num, p_vout->fmt_in.i_sar_den );
566 if( !p_vout->fmt_out.i_width || !p_vout->fmt_out.i_height )
568 p_vout->fmt_out.i_width = p_vout->fmt_out.i_visible_width =
569 p_vout->output.i_width;
570 p_vout->fmt_out.i_height = p_vout->fmt_out.i_visible_height =
571 p_vout->output.i_height;
572 p_vout->fmt_out.i_x_offset = p_vout->fmt_out.i_y_offset = 0;
574 p_vout->fmt_out.i_aspect = p_vout->output.i_aspect;
575 p_vout->fmt_out.i_chroma = p_vout->output.i_chroma;
577 if( !p_vout->fmt_out.i_sar_num || !p_vout->fmt_out.i_sar_num )
579 p_vout->fmt_out.i_sar_num = p_vout->fmt_out.i_aspect *
580 p_vout->fmt_out.i_height;
581 p_vout->fmt_out.i_sar_den = VOUT_ASPECT_FACTOR *
582 p_vout->fmt_out.i_width;
585 vlc_ureduce( &p_vout->fmt_out.i_sar_num, &p_vout->fmt_out.i_sar_den,
586 p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den, 0 );
588 AspectRatio( p_vout->fmt_out.i_aspect, &i_aspect_x, &i_aspect_y );
590 msg_Dbg( p_vout, "picture out %ix%i (%i,%i,%ix%i), "
591 "chroma %4.4s, ar %i:%i, sar %i:%i",
592 p_vout->fmt_out.i_width, p_vout->fmt_out.i_height,
593 p_vout->fmt_out.i_x_offset, p_vout->fmt_out.i_y_offset,
594 p_vout->fmt_out.i_visible_width,
595 p_vout->fmt_out.i_visible_height,
596 (char*)&p_vout->fmt_out.i_chroma,
597 i_aspect_x, i_aspect_y,
598 p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den );
600 /* Calculate shifts from system-updated masks */
601 MaskToShift( &p_vout->output.i_lrshift, &p_vout->output.i_rrshift,
602 p_vout->output.i_rmask );
603 MaskToShift( &p_vout->output.i_lgshift, &p_vout->output.i_rgshift,
604 p_vout->output.i_gmask );
605 MaskToShift( &p_vout->output.i_lbshift, &p_vout->output.i_rbshift,
606 p_vout->output.i_bmask );
608 /* Check whether we managed to create direct buffers similar to
609 * the render buffers, ie same size and chroma */
610 if( ( p_vout->output.i_width == p_vout->render.i_width )
611 && ( p_vout->output.i_height == p_vout->render.i_height )
612 && ( vout_ChromaCmp( p_vout->output.i_chroma, p_vout->render.i_chroma ) ) )
614 /* Cool ! We have direct buffers, we can ask the decoder to
615 * directly decode into them ! Map the first render buffers to
616 * the first direct buffers, but keep the first direct buffer
617 * for memcpy operations */
618 p_vout->b_direct = 1;
620 for( i = 1; i < VOUT_MAX_PICTURES; i++ )
622 if( p_vout->p_picture[ i ].i_type != DIRECT_PICTURE &&
623 I_RENDERPICTURES >= VOUT_MIN_DIRECT_PICTURES - 1 &&
624 p_vout->p_picture[ i - 1 ].i_type == DIRECT_PICTURE )
626 /* We have enough direct buffers so there's no need to
627 * try to use system memory buffers. */
630 PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
634 msg_Dbg( p_vout, "direct render, mapping "
635 "render pictures 0-%i to system pictures 1-%i",
636 VOUT_MAX_PICTURES - 2, VOUT_MAX_PICTURES - 1 );
640 /* Rats... Something is wrong here, we could not find an output
641 * plugin able to directly render what we decode. See if we can
642 * find a chroma plugin to do the conversion */
643 p_vout->b_direct = 0;
645 /* Choose the best module */
646 p_vout->chroma.p_module = module_Need( p_vout, "chroma", NULL, 0 );
648 if( p_vout->chroma.p_module == NULL )
650 msg_Err( p_vout, "no chroma module for %4.4s to %4.4s",
651 (char*)&p_vout->render.i_chroma,
652 (char*)&p_vout->output.i_chroma );
653 p_vout->pf_end( p_vout );
654 vlc_mutex_unlock( &p_vout->change_lock );
658 msg_Dbg( p_vout, "indirect render, mapping "
659 "render pictures 0-%i to system pictures %i-%i",
660 VOUT_MAX_PICTURES - 1, I_OUTPUTPICTURES,
661 I_OUTPUTPICTURES + VOUT_MAX_PICTURES - 1 );
663 /* Append render buffers after the direct buffers */
664 for( i = I_OUTPUTPICTURES; i < 2 * VOUT_MAX_PICTURES; i++ )
666 PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
669 /* Check if we have enough render pictures */
670 if( I_RENDERPICTURES == VOUT_MAX_PICTURES )
675 /* Link pictures back to their heap */
676 for( i = 0 ; i < I_RENDERPICTURES ; i++ )
678 PP_RENDERPICTURE[ i ]->p_heap = &p_vout->render;
681 for( i = 0 ; i < I_OUTPUTPICTURES ; i++ )
683 PP_OUTPUTPICTURE[ i ]->p_heap = &p_vout->output;
686 /* XXX XXX mark thread ready */
690 /*****************************************************************************
691 * RunThread: video output thread
692 *****************************************************************************
693 * Video output thread. This function does only returns when the thread is
694 * terminated. It handles the pictures arriving in the video heap and the
695 * display device events.
696 *****************************************************************************/
697 static void RunThread( vout_thread_t *p_vout)
699 int i_index; /* index in heap */
700 int i_idle_loops = 0; /* loops without displaying a picture */
701 mtime_t current_date; /* current date */
702 mtime_t display_date; /* display date */
704 picture_t * p_picture; /* picture pointer */
705 picture_t * p_last_picture = NULL; /* last picture */
706 picture_t * p_directbuffer; /* direct buffer to display */
708 subpicture_t * p_subpic = NULL; /* subpicture pointer */
713 p_vout->b_error = InitThread( p_vout );
715 /* signal the creation of the vout */
716 vlc_thread_ready( p_vout );
718 if( p_vout->b_error )
720 /* Destroy thread structures allocated by Create and InitThread */
721 DestroyThread( p_vout );
726 * Main loop - it is not executed if an error occurred during
729 while( (!p_vout->b_die) && (!p_vout->b_error) )
731 /* Initialize loop variables */
734 current_date = mdate();
738 if( !(p_vout->c_loops % VOUT_STATS_NB_LOOPS) )
740 msg_Dbg( p_vout, "picture heap: %d/%d",
741 I_RENDERPICTURES, p_vout->i_heap_size );
746 * Find the picture to display (the one with the earliest date).
747 * This operation does not need lock, since only READY_PICTUREs
749 for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
751 if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
752 && ( (p_picture == NULL) ||
753 (PP_RENDERPICTURE[i_index]->date < display_date) ) )
755 p_picture = PP_RENDERPICTURE[i_index];
756 display_date = p_picture->date;
762 /* If we met the last picture, parse again to see whether there is
763 * a more appropriate one. */
764 if( p_picture == p_last_picture )
766 for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
768 if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
769 && (PP_RENDERPICTURE[i_index] != p_last_picture)
770 && ((p_picture == p_last_picture) ||
771 (PP_RENDERPICTURE[i_index]->date < display_date)) )
773 p_picture = PP_RENDERPICTURE[i_index];
774 display_date = p_picture->date;
779 /* If we found better than the last picture, destroy it */
780 if( p_last_picture && p_picture != p_last_picture )
782 vlc_mutex_lock( &p_vout->picture_lock );
783 if( p_last_picture->i_refcount )
785 p_last_picture->i_status = DISPLAYED_PICTURE;
789 p_last_picture->i_status = DESTROYED_PICTURE;
790 p_vout->i_heap_size--;
792 vlc_mutex_unlock( &p_vout->picture_lock );
793 p_last_picture = NULL;
796 /* Compute FPS rate */
797 p_vout->p_fps_sample[ p_vout->c_fps_samples++ % VOUT_FPS_SAMPLES ]
800 if( !p_picture->b_force &&
801 p_picture != p_last_picture &&
802 display_date < current_date + p_vout->render_time )
804 /* Picture is late: it will be destroyed and the thread
805 * will directly choose the next picture */
806 vlc_mutex_lock( &p_vout->picture_lock );
807 if( p_picture->i_refcount )
809 /* Pretend we displayed the picture, but don't destroy
810 * it since the decoder might still need it. */
811 p_picture->i_status = DISPLAYED_PICTURE;
815 /* Destroy the picture without displaying it */
816 p_picture->i_status = DESTROYED_PICTURE;
817 p_vout->i_heap_size--;
819 msg_Warn( p_vout, "late picture skipped ("I64Fd")",
820 current_date - display_date );
821 vlc_mutex_unlock( &p_vout->picture_lock );
827 current_date + p_vout->i_pts_delay + VOUT_BOGUS_DELAY )
829 /* Picture is waaay too early: it will be destroyed */
830 vlc_mutex_lock( &p_vout->picture_lock );
831 if( p_picture->i_refcount )
833 /* Pretend we displayed the picture, but don't destroy
834 * it since the decoder might still need it. */
835 p_picture->i_status = DISPLAYED_PICTURE;
839 /* Destroy the picture without displaying it */
840 p_picture->i_status = DESTROYED_PICTURE;
841 p_vout->i_heap_size--;
843 msg_Warn( p_vout, "vout warning: early picture skipped "
844 "("I64Fd")", display_date - current_date
845 - p_vout->i_pts_delay );
846 vlc_mutex_unlock( &p_vout->picture_lock );
851 if( display_date > current_date + VOUT_DISPLAY_DELAY )
853 /* A picture is ready to be rendered, but its rendering date
854 * is far from the current one so the thread will perform an
855 * empty loop as if no picture were found. The picture state
860 else if( p_picture == p_last_picture )
862 /* We are asked to repeat the previous picture, but we first
863 * wait for a couple of idle loops */
864 if( i_idle_loops < 4 )
871 /* We set the display date to something high, otherwise
872 * we'll have lots of problems with late pictures */
873 display_date = current_date + p_vout->render_time;
878 if( p_picture == NULL )
883 if( p_picture && p_vout->b_snapshot )
885 p_vout->b_snapshot = VLC_FALSE;
886 vout_Snapshot( p_vout, p_picture );
890 * Check for subpictures to display
892 if( display_date > 0 )
894 p_subpic = spu_SortSubpictures( p_vout->p_spu, display_date );
900 p_directbuffer = vout_RenderPicture( p_vout, p_picture, p_subpic );
903 * Call the plugin-specific rendering method if there is one
905 if( p_picture != NULL && p_directbuffer != NULL && p_vout->pf_render )
907 /* Render the direct buffer returned by vout_RenderPicture */
908 p_vout->pf_render( p_vout, p_directbuffer );
914 if( display_date != 0 && p_directbuffer != NULL )
916 mtime_t current_render_time = mdate() - current_date;
917 /* if render time is very large we don't include it in the mean */
918 if( current_render_time < p_vout->render_time +
921 /* Store render time using a sliding mean weighting to
922 * current value in a 3 to 1 ratio*/
923 p_vout->render_time *= 3;
924 p_vout->render_time += current_render_time;
925 p_vout->render_time >>= 2;
929 /* Give back change lock */
930 vlc_mutex_unlock( &p_vout->change_lock );
932 /* Sleep a while or until a given date */
933 if( display_date != 0 )
935 /* If there are filters in the chain, better give them the picture
937 if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
939 mwait( display_date - VOUT_MWAIT_TOLERANCE );
944 msleep( VOUT_IDLE_SLEEP );
947 /* On awakening, take back lock and send immediately picture
949 vlc_mutex_lock( &p_vout->change_lock );
952 * Display the previously rendered picture
954 if( p_picture != NULL && p_directbuffer != NULL )
956 /* Display the direct buffer returned by vout_RenderPicture */
957 if( p_vout->pf_display )
959 p_vout->pf_display( p_vout, p_directbuffer );
962 /* Tell the vout this was the last picture and that it does not
963 * need to be forced anymore. */
964 p_last_picture = p_picture;
965 p_last_picture->b_force = 0;
968 if( p_picture != NULL )
970 /* Reinitialize idle loop count */
975 * Check events and manage thread
977 if( p_vout->pf_manage && p_vout->pf_manage( p_vout ) )
979 /* A fatal error occurred, and the thread must terminate
980 * immediately, without displaying anything - setting b_error to 1
981 * causes the immediate end of the main while() loop. */
985 if( p_vout->i_changes & VOUT_SIZE_CHANGE )
987 /* this must only happen when the vout plugin is incapable of
988 * rescaling the picture itself. In this case we need to destroy
989 * the current picture buffers and recreate new ones with the right
993 p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
995 p_vout->pf_end( p_vout );
996 for( i = 0; i < I_OUTPUTPICTURES; i++ )
997 p_vout->p_picture[ i ].i_status = FREE_PICTURE;
999 I_OUTPUTPICTURES = 0;
1000 if( p_vout->pf_init( p_vout ) )
1002 msg_Err( p_vout, "cannot resize display" );
1003 /* FIXME: pf_end will be called again in EndThread() */
1004 p_vout->b_error = 1;
1007 /* Need to reinitialise the chroma plugin */
1008 if( p_vout->chroma.p_module )
1010 if( p_vout->chroma.p_module->pf_deactivate )
1011 p_vout->chroma.p_module->pf_deactivate( VLC_OBJECT(p_vout) );
1012 p_vout->chroma.p_module->pf_activate( VLC_OBJECT(p_vout) );
1016 if( p_vout->i_changes & VOUT_PICTURE_BUFFERS_CHANGE )
1018 /* This happens when the picture buffers need to be recreated.
1019 * This is useful on multimonitor displays for instance.
1021 * Warning: This only works when the vout creates only 1 picture
1023 p_vout->i_changes &= ~VOUT_PICTURE_BUFFERS_CHANGE;
1025 if( !p_vout->b_direct )
1027 module_Unneed( p_vout, p_vout->chroma.p_module );
1030 vlc_mutex_lock( &p_vout->picture_lock );
1032 p_vout->pf_end( p_vout );
1034 I_OUTPUTPICTURES = I_RENDERPICTURES = 0;
1036 p_vout->b_error = InitThread( p_vout );
1038 vlc_mutex_unlock( &p_vout->picture_lock );
1043 * Error loop - wait until the thread destruction is requested
1045 if( p_vout->b_error )
1047 ErrorThread( p_vout );
1051 EndThread( p_vout );
1053 /* Destroy thread structures allocated by CreateThread */
1054 DestroyThread( p_vout );
1057 /*****************************************************************************
1058 * ErrorThread: RunThread() error loop
1059 *****************************************************************************
1060 * This function is called when an error occurred during thread main's loop.
1061 * The thread can still receive feed, but must be ready to terminate as soon
1063 *****************************************************************************/
1064 static void ErrorThread( vout_thread_t *p_vout )
1066 /* Wait until a `die' order */
1067 while( !p_vout->b_die )
1070 msleep( VOUT_IDLE_SLEEP );
1074 /*****************************************************************************
1075 * EndThread: thread destruction
1076 *****************************************************************************
1077 * This function is called when the thread ends after a sucessful
1078 * initialization. It frees all resources allocated by InitThread.
1079 *****************************************************************************/
1080 static void EndThread( vout_thread_t *p_vout )
1082 int i_index; /* index in heap */
1086 struct tms cpu_usage;
1087 times( &cpu_usage );
1089 msg_Dbg( p_vout, "cpu usage (user: %d, system: %d)",
1090 cpu_usage.tms_utime, cpu_usage.tms_stime );
1094 if( !p_vout->b_direct )
1096 module_Unneed( p_vout, p_vout->chroma.p_module );
1099 /* Destroy all remaining pictures */
1100 for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++ )
1102 if ( p_vout->p_picture[i_index].i_type == MEMORY_PICTURE )
1104 free( p_vout->p_picture[i_index].p_data_orig );
1108 /* Destroy subpicture unit */
1109 spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), VLC_FALSE );
1110 spu_Destroy( p_vout->p_spu );
1112 /* Destroy translation tables */
1113 p_vout->pf_end( p_vout );
1115 /* Release the change lock */
1116 vlc_mutex_unlock( &p_vout->change_lock );
1119 /*****************************************************************************
1120 * DestroyThread: thread destruction
1121 *****************************************************************************
1122 * This function is called when the thread ends. It frees all ressources
1123 * allocated by CreateThread. Status is available at this stage.
1124 *****************************************************************************/
1125 static void DestroyThread( vout_thread_t *p_vout )
1127 /* Destroy the locks */
1128 vlc_mutex_destroy( &p_vout->picture_lock );
1129 vlc_mutex_destroy( &p_vout->change_lock );
1131 /* Release the module */
1132 if( p_vout && p_vout->p_module )
1134 module_Unneed( p_vout, p_vout->p_module );
1138 /* following functions are local */
1140 static int ReduceHeight( int i_ratio )
1142 int i_dummy = VOUT_ASPECT_FACTOR;
1150 /* VOUT_ASPECT_FACTOR is (2^7 * 3^3 * 5^3), we just check for 2, 3 and 5 */
1151 while( !(i_ratio & 1) && !(i_dummy & 1) )
1158 while( !(i_ratio % 3) && !(i_dummy % 3) )
1165 while( !(i_ratio % 5) && !(i_dummy % 5) )
1175 static void AspectRatio( int i_aspect, int *i_aspect_x, int *i_aspect_y )
1177 unsigned int i_pgcd = ReduceHeight( i_aspect );
1178 *i_aspect_x = i_aspect / i_pgcd;
1179 *i_aspect_y = VOUT_ASPECT_FACTOR / i_pgcd;
1182 /*****************************************************************************
1183 * BinaryLog: computes the base 2 log of a binary value
1184 *****************************************************************************
1185 * This functions is used by MaskToShift, to get a bit index from a binary
1187 *****************************************************************************/
1188 static int BinaryLog( uint32_t i )
1192 if( i == 0 ) return -31337;
1194 if( i & 0xffff0000 ) i_log += 16;
1195 if( i & 0xff00ff00 ) i_log += 8;
1196 if( i & 0xf0f0f0f0 ) i_log += 4;
1197 if( i & 0xcccccccc ) i_log += 2;
1198 if( i & 0xaaaaaaaa ) i_log += 1;
1203 /*****************************************************************************
1204 * MaskToShift: transform a color mask into right and left shifts
1205 *****************************************************************************
1206 * This function is used for obtaining color shifts from masks.
1207 *****************************************************************************/
1208 static void MaskToShift( int *pi_left, int *pi_right, uint32_t i_mask )
1210 uint32_t i_low, i_high; /* lower hand higher bits of the mask */
1214 *pi_left = *pi_right = 0;
1219 i_low = i_mask & (- (int32_t)i_mask); /* lower bit of the mask */
1220 i_high = i_mask + i_low; /* higher bit of the mask */
1222 /* Transform bits into an index */
1223 i_low = BinaryLog (i_low);
1224 i_high = BinaryLog (i_high);
1226 /* Update pointers and return */
1228 *pi_right = (8 - i_high + i_low);
1231 /*****************************************************************************
1232 * InitWindowSize: find the initial dimensions the video window should have.
1233 *****************************************************************************
1234 * This function will check the "width", "height" and "zoom" config options and
1235 * will calculate the size that the video window should have.
1236 *****************************************************************************/
1237 static void InitWindowSize( vout_thread_t *p_vout, unsigned *pi_width,
1238 unsigned *pi_height )
1241 int i_width, i_height;
1244 #define FP_FACTOR 1000 /* our fixed point factor */
1246 var_Get( p_vout, "align", &val );
1247 p_vout->i_alignment = val.i_int;
1249 var_Get( p_vout, "width", &val );
1250 i_width = val.i_int;
1251 var_Get( p_vout, "height", &val );
1252 i_height = val.i_int;
1253 var_Get( p_vout, "zoom", &val );
1254 ll_zoom = (uint64_t)( FP_FACTOR * val.f_float );
1256 if( i_width > 0 && i_height > 0)
1258 *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
1259 *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
1262 else if( i_width > 0 )
1264 *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
1265 *pi_height = (int)( i_width * ll_zoom * VOUT_ASPECT_FACTOR /
1266 p_vout->fmt_in.i_aspect / FP_FACTOR );
1269 else if( i_height > 0 )
1271 *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
1272 *pi_width = (int)( i_height * ll_zoom * p_vout->fmt_in.i_aspect /
1273 VOUT_ASPECT_FACTOR / FP_FACTOR );
1277 if( p_vout->fmt_in.i_visible_height * p_vout->fmt_in.i_aspect
1278 >= p_vout->fmt_in.i_visible_width * VOUT_ASPECT_FACTOR )
1280 *pi_width = (int)( p_vout->fmt_in.i_visible_height * ll_zoom
1281 * p_vout->fmt_in.i_aspect / VOUT_ASPECT_FACTOR / FP_FACTOR );
1282 *pi_height = (int)( p_vout->fmt_in.i_visible_height * ll_zoom
1287 *pi_width = (int)( p_vout->fmt_in.i_visible_width * ll_zoom
1289 *pi_height = (int)( p_vout->fmt_in.i_visible_width * ll_zoom
1290 * VOUT_ASPECT_FACTOR / p_vout->fmt_in.i_aspect / FP_FACTOR );
1296 /*****************************************************************************
1297 * vout_VarCallback: generic callback for intf variables
1298 *****************************************************************************/
1299 int vout_VarCallback( vlc_object_t * p_this, const char * psz_variable,
1300 vlc_value_t old_value, vlc_value_t new_value,
1303 vout_thread_t * p_vout = (vout_thread_t *)p_this;
1305 val.b_bool = VLC_TRUE;
1306 var_Set( p_vout, "intf-change", val );
1310 /*****************************************************************************
1311 * Helper thread for object variables callbacks.
1312 * Only used to avoid deadlocks when using the video embedded mode.
1313 *****************************************************************************/
1314 typedef struct suxor_thread_t
1317 input_thread_t *p_input;
1321 static void SuxorRestartVideoES( suxor_thread_t *p_this )
1325 vlc_thread_ready( p_this );
1327 /* Now restart current video stream */
1328 var_Get( p_this->p_input, "video-es", &val );
1329 if( val.i_int >= 0 )
1332 val_es.i_int = -VIDEO_ES;
1333 var_Set( p_this->p_input, "video-es", val_es );
1334 var_Set( p_this->p_input, "video-es", val );
1337 vlc_object_release( p_this->p_input );
1340 CloseHandle( p_this->thread_id );
1343 vlc_object_destroy( p_this );
1346 /*****************************************************************************
1347 * object variables callbacks: a bunch of object variables are used by the
1348 * interfaces to interact with the vout.
1349 *****************************************************************************/
1350 static int DeinterlaceCallback( vlc_object_t *p_this, char const *psz_cmd,
1351 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1353 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1354 input_thread_t *p_input;
1357 char *psz_mode = newval.psz_string;
1358 char *psz_filter, *psz_deinterlace = NULL;
1360 var_Get( p_vout, "vout-filter", &val );
1361 psz_filter = val.psz_string;
1362 if( psz_filter ) psz_deinterlace = strstr( psz_filter, "deinterlace" );
1364 if( !psz_mode || !*psz_mode )
1366 if( psz_deinterlace )
1368 char *psz_src = psz_deinterlace + sizeof("deinterlace") - 1;
1369 if( psz_src[0] == ':' ) psz_src++;
1370 memmove( psz_deinterlace, psz_src, strlen(psz_src) + 1 );
1373 else if( !psz_deinterlace )
1375 psz_filter = realloc( psz_filter, strlen( psz_filter ) +
1376 sizeof(":deinterlace") );
1377 if( psz_filter && *psz_filter ) strcat( psz_filter, ":" );
1378 strcat( psz_filter, "deinterlace" );
1381 p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1383 if( !p_input ) return VLC_EGENERIC;
1385 if( psz_mode && *psz_mode )
1387 /* Modify input as well because the vout might have to be restarted */
1388 val.psz_string = psz_mode;
1389 var_Create( p_input, "deinterlace-mode", VLC_VAR_STRING );
1390 var_Set( p_input, "deinterlace-mode", val );
1392 vlc_object_release( p_input );
1394 val.b_bool = VLC_TRUE;
1395 var_Set( p_vout, "intf-change", val );
1397 val.psz_string = psz_filter;
1398 var_Set( p_vout, "vout-filter", val );
1399 if( psz_filter ) free( psz_filter );
1404 static int FilterCallback( vlc_object_t *p_this, char const *psz_cmd,
1405 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1407 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1408 input_thread_t *p_input;
1411 p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1415 msg_Err( p_vout, "Input not found" );
1416 return( VLC_EGENERIC );
1419 val.b_bool = VLC_TRUE;
1420 var_Set( p_vout, "intf-change", val );
1422 /* Modify input as well because the vout might have to be restarted */
1423 val.psz_string = newval.psz_string;
1424 var_Create( p_input, "vout-filter", VLC_VAR_STRING );
1426 var_Set( p_input, "vout-filter", val );
1428 /* Now restart current video stream */
1429 var_Get( p_input, "video-es", &val );
1430 if( val.i_int >= 0 )
1432 suxor_thread_t *p_suxor =
1433 vlc_object_create( p_vout, sizeof(suxor_thread_t) );
1434 p_suxor->p_input = p_input;
1435 p_vout->b_filter_change = VLC_TRUE;
1436 vlc_object_yield( p_input );
1437 vlc_thread_create( p_suxor, "suxor", SuxorRestartVideoES,
1438 VLC_THREAD_PRIORITY_LOW, VLC_FALSE );
1441 vlc_object_release( p_input );