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-2007 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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
27 *****************************************************************************/
29 /*****************************************************************************
31 *****************************************************************************/
36 #include <vlc_common.h>
38 #include <stdlib.h> /* free() */
42 #ifdef HAVE_SYS_TIMES_H
43 # include <sys/times.h>
48 #include <vlc_filter.h>
52 #if defined( __APPLE__ )
53 /* Include darwin_specific.h here if needed */
56 /** FIXME This is quite ugly but needed while we don't have counters
58 //#include "input/input_internal.h"
61 #include <vlc_input.h>
62 #include "vout_pictures.h"
63 #include "vout_internal.h"
65 /*****************************************************************************
67 *****************************************************************************/
68 static int InitThread ( vout_thread_t * );
69 static void* RunThread ( void * );
70 static void ErrorThread ( vout_thread_t * );
71 static void CleanThread ( vout_thread_t * );
72 static void EndThread ( vout_thread_t * );
74 static void VideoFormatImportRgb( video_format_t *, const picture_heap_t * );
75 static void PictureHeapFixRgb( picture_heap_t * );
77 static void vout_Destructor ( vlc_object_t * p_this );
79 /* Object variables callbacks */
80 static int FilterCallback( vlc_object_t *, char const *,
81 vlc_value_t, vlc_value_t, void * );
82 static int VideoFilter2Callback( vlc_object_t *, char const *,
83 vlc_value_t, vlc_value_t, void * );
86 static void PostProcessEnable( vout_thread_t * );
87 static void PostProcessDisable( vout_thread_t * );
88 static void PostProcessSetFilterQuality( vout_thread_t *p_vout );
89 static int PostProcessCallback( vlc_object_t *, char const *,
90 vlc_value_t, vlc_value_t, void * );
92 static void DeinterlaceEnable( vout_thread_t * );
93 static void DeinterlaceNeeded( vout_thread_t *, bool );
95 /* From vout_intf.c */
96 int vout_Snapshot( vout_thread_t *, picture_t * );
98 /* Display media title in OSD */
99 static void DisplayTitleOnOSD( vout_thread_t *p_vout );
101 /* Time during which the thread will sleep if it has nothing to
102 * display (in micro-seconds) */
103 #define VOUT_IDLE_SLEEP ((int)(0.020*CLOCK_FREQ))
105 /* Maximum lap of time allowed between the beginning of rendering and
106 * display. If, compared to the current date, the next image is too
107 * late, the thread will perform an idle loop. This time should be
108 * at least VOUT_IDLE_SLEEP plus the time required to render a few
109 * images, to avoid trashing of decoded images */
110 #define VOUT_DISPLAY_DELAY ((int)(0.200*CLOCK_FREQ))
112 /* Better be in advance when awakening than late... */
113 #define VOUT_MWAIT_TOLERANCE ((mtime_t)(0.020*CLOCK_FREQ))
115 /* Minimum number of direct pictures the video output will accept without
116 * creating additional pictures in system memory */
117 #ifdef OPTIMIZE_MEMORY
118 # define VOUT_MIN_DIRECT_PICTURES (VOUT_MAX_PICTURES/2)
120 # define VOUT_MIN_DIRECT_PICTURES (3*VOUT_MAX_PICTURES/4)
123 /*****************************************************************************
124 * Video Filter2 functions
125 *****************************************************************************/
126 static picture_t *video_new_buffer_filter( filter_t *p_filter )
128 vout_thread_t *p_vout = (vout_thread_t*)p_filter->p_owner;
129 picture_t *p_picture = vout_CreatePicture( p_vout, 0, 0, 0 );
131 p_picture->i_status = READY_PICTURE;
136 static void video_del_buffer_filter( filter_t *p_filter, picture_t *p_pic )
138 vout_thread_t *p_vout = (vout_thread_t*)p_filter->p_owner;
140 vlc_mutex_lock( &p_vout->picture_lock );
141 vout_UsePictureLocked( p_vout, p_pic );
142 vlc_mutex_unlock( &p_vout->picture_lock );
145 static int video_filter_buffer_allocation_init( filter_t *p_filter, void *p_data )
147 p_filter->pf_vout_buffer_new = video_new_buffer_filter;
148 p_filter->pf_vout_buffer_del = video_del_buffer_filter;
149 p_filter->p_owner = p_data; /* p_vout */
153 /*****************************************************************************
154 * vout_Request: find a video output thread, create one, or destroy one.
155 *****************************************************************************
156 * This function looks for a video output thread matching the current
157 * properties. If not found, it spawns a new one.
158 *****************************************************************************/
159 vout_thread_t *__vout_Request( vlc_object_t *p_this, vout_thread_t *p_vout,
160 video_format_t *p_fmt )
164 /* Video output is no longer used.
165 * TODO: support for reusing video outputs with proper _thread-safe_
166 * reference handling. */
168 vout_CloseAndRelease( p_vout );
172 /* If a video output was provided, lock it, otherwise look for one. */
175 vlc_object_hold( p_vout );
178 /* TODO: find a suitable unused video output */
180 /* If we now have a video output, check it has the right properties */
183 vlc_mutex_lock( &p_vout->change_lock );
185 /* We don't directly check for the "vout-filter" variable for obvious
186 * performance reasons. */
187 if( p_vout->p->b_filter_change )
189 char *psz_filter_chain = var_GetString( p_vout, "vout-filter" );
191 if( psz_filter_chain && !*psz_filter_chain )
193 free( psz_filter_chain );
194 psz_filter_chain = NULL;
196 if( p_vout->p->psz_filter_chain && !*p_vout->p->psz_filter_chain )
198 free( p_vout->p->psz_filter_chain );
199 p_vout->p->psz_filter_chain = NULL;
202 if( !psz_filter_chain && !p_vout->p->psz_filter_chain )
204 p_vout->p->b_filter_change = false;
207 free( psz_filter_chain );
210 if( p_vout->fmt_render.i_chroma != vlc_fourcc_GetCodec( VIDEO_ES, p_fmt->i_chroma ) ||
211 p_vout->fmt_render.i_width != p_fmt->i_width ||
212 p_vout->fmt_render.i_height != p_fmt->i_height ||
213 p_vout->p->b_filter_change )
215 vlc_mutex_unlock( &p_vout->change_lock );
217 /* We are not interested in this format, close this vout */
218 vout_CloseAndRelease( p_vout );
219 vlc_object_release( p_vout );
224 /* This video output is cool! Hijack it. */
225 /* Correct aspect ratio on change
226 * FIXME factorize this code with other aspect ration related code */
227 unsigned int i_sar_num;
228 unsigned int i_sar_den;
229 vlc_ureduce( &i_sar_num, &i_sar_den,
230 p_fmt->i_sar_num, p_fmt->i_sar_den, 50000 );
232 /* What's that, it does not seems to be used correcly everywhere */
233 if( p_vout->i_par_num > 0 && p_vout->i_par_den > 0 )
235 i_sar_num *= p_vout->i_par_den;
236 i_sar_den *= p_vout->i_par_num;
240 if( i_sar_num > 0 && i_sar_den > 0 &&
241 ( i_sar_num != p_vout->fmt_render.i_sar_num ||
242 i_sar_den != p_vout->fmt_render.i_sar_den ) )
244 p_vout->fmt_in.i_sar_num = i_sar_num;
245 p_vout->fmt_in.i_sar_den = i_sar_den;
247 p_vout->fmt_render.i_sar_num = i_sar_num;
248 p_vout->fmt_render.i_sar_den = i_sar_den;
250 p_vout->render.i_aspect = (int64_t)i_sar_num *
251 p_vout->fmt_render.i_width *
254 p_vout->fmt_render.i_height;
255 p_vout->i_changes |= VOUT_ASPECT_CHANGE;
257 vlc_mutex_unlock( &p_vout->change_lock );
259 vlc_object_release( p_vout );
264 msg_Dbg( p_this, "reusing provided vout" );
266 spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), false );
267 vlc_object_detach( p_vout );
269 vlc_object_attach( p_vout, p_this );
270 spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), true );
276 msg_Dbg( p_this, "no usable vout present, spawning one" );
278 p_vout = vout_Create( p_this, p_fmt );
284 /*****************************************************************************
285 * vout_Create: creates a new video output thread
286 *****************************************************************************
287 * This function creates a new video output thread, and returns a pointer
288 * to its description. On error, it returns NULL.
289 *****************************************************************************/
290 vout_thread_t * __vout_Create( vlc_object_t *p_parent, video_format_t *p_fmt )
292 vout_thread_t * p_vout; /* thread descriptor */
293 int i_index; /* loop variable */
296 unsigned int i_width = p_fmt->i_width;
297 unsigned int i_height = p_fmt->i_height;
298 vlc_fourcc_t i_chroma = vlc_fourcc_GetCodec( VIDEO_ES, p_fmt->i_chroma );
300 config_chain_t *p_cfg;
304 if( i_width <= 0 || i_height <= 0 )
307 vlc_ureduce( &p_fmt->i_sar_num, &p_fmt->i_sar_den,
308 p_fmt->i_sar_num, p_fmt->i_sar_den, 50000 );
309 if( p_fmt->i_sar_num <= 0 || p_fmt->i_sar_den <= 0 )
311 unsigned int i_aspect = (int64_t)p_fmt->i_sar_num *
317 /* Allocate descriptor */
318 static const char typename[] = "video output";
319 p_vout = vlc_custom_create( p_parent, sizeof( *p_vout ), VLC_OBJECT_VOUT,
325 p_vout->p = calloc( 1, sizeof(*p_vout->p) );
328 vlc_object_release( p_vout );
332 /* Initialize pictures - translation tables and functions
333 * will be initialized later in InitThread */
334 for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++)
336 p_vout->p_picture[i_index].pf_lock = NULL;
337 p_vout->p_picture[i_index].pf_unlock = NULL;
338 p_vout->p_picture[i_index].i_status = FREE_PICTURE;
339 p_vout->p_picture[i_index].i_type = EMPTY_PICTURE;
340 p_vout->p_picture[i_index].b_slow = 0;
343 /* No images in the heap */
344 p_vout->i_heap_size = 0;
346 /* Initialize the rendering heap */
347 I_RENDERPICTURES = 0;
349 p_vout->fmt_render = *p_fmt; /* FIXME palette */
350 p_vout->fmt_in = *p_fmt; /* FIXME palette */
352 p_vout->render.i_width = i_width;
353 p_vout->render.i_height = i_height;
354 p_vout->render.i_chroma = i_chroma;
355 p_vout->render.i_aspect = i_aspect;
357 p_vout->render.i_rmask = p_fmt->i_rmask;
358 p_vout->render.i_gmask = p_fmt->i_gmask;
359 p_vout->render.i_bmask = p_fmt->i_bmask;
361 p_vout->render.i_last_used_pic = -1;
362 p_vout->render.b_allow_modify_pics = 1;
364 /* Zero the output heap */
365 I_OUTPUTPICTURES = 0;
366 p_vout->output.i_width = 0;
367 p_vout->output.i_height = 0;
368 p_vout->output.i_chroma = 0;
369 p_vout->output.i_aspect = 0;
371 p_vout->output.i_rmask = 0;
372 p_vout->output.i_gmask = 0;
373 p_vout->output.i_bmask = 0;
375 /* Initialize misc stuff */
376 p_vout->i_changes = 0;
377 p_vout->b_autoscale = 1;
378 p_vout->i_zoom = ZOOM_FP_FACTOR;
379 p_vout->b_fullscreen = 0;
380 p_vout->i_alignment = 0;
381 p_vout->p->render_time = 10;
382 p_vout->p->c_fps_samples = 0;
383 vout_statistic_Init( &p_vout->p->statistic );
384 p_vout->p->b_filter_change = 0;
385 p_vout->p->b_paused = false;
386 p_vout->p->i_pause_date = 0;
387 p_vout->pf_control = NULL;
388 p_vout->p->i_par_num =
389 p_vout->p->i_par_den = 1;
390 p_vout->p->p_picture_displayed = NULL;
391 p_vout->p->i_picture_displayed_date = 0;
392 p_vout->p->b_picture_displayed = false;
393 p_vout->p->b_picture_empty = false;
394 p_vout->p->i_picture_qtype = QTYPE_NONE;
395 p_vout->p->b_picture_interlaced = false;
397 vlc_mouse_Init( &p_vout->p->mouse );
399 vout_snapshot_Init( &p_vout->p->snapshot );
401 /* Initialize locks */
402 vlc_mutex_init( &p_vout->picture_lock );
403 vlc_cond_init( &p_vout->p->picture_wait );
404 vlc_mutex_init( &p_vout->change_lock );
405 vlc_mutex_init( &p_vout->p->vfilter_lock );
407 /* Mouse coordinates */
408 var_Create( p_vout, "mouse-x", VLC_VAR_INTEGER );
409 var_Create( p_vout, "mouse-y", VLC_VAR_INTEGER );
410 var_Create( p_vout, "mouse-button-down", VLC_VAR_INTEGER );
411 var_Create( p_vout, "mouse-moved", VLC_VAR_BOOL );
412 var_Create( p_vout, "mouse-clicked", VLC_VAR_BOOL );
414 /* Initialize subpicture unit */
415 p_vout->p_spu = spu_Create( p_vout );
417 /* Attach the new object now so we can use var inheritance below */
418 vlc_object_attach( p_vout, p_parent );
421 spu_Init( p_vout->p_spu );
423 spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), true );
425 /* Take care of some "interface/control" related initialisations */
426 vout_IntfInit( p_vout );
428 /* If the parent is not a VOUT object, that means we are at the start of
429 * the video output pipe */
430 if( vlc_internals( p_parent )->i_object_type != VLC_OBJECT_VOUT )
432 /* Look for the default filter configuration */
433 p_vout->p->psz_filter_chain =
434 var_CreateGetStringCommand( p_vout, "vout-filter" );
436 /* Apply video filter2 objects on the first vout */
438 var_CreateGetStringCommand( p_vout, "video-filter" );
440 p_vout->p->b_first_vout = true;
444 /* continue the parent's filter chain */
447 /* Ugly hack to jump to our configuration chain */
448 p_vout->p->psz_filter_chain
449 = ((vout_thread_t *)p_parent)->p->psz_filter_chain;
450 p_vout->p->psz_filter_chain
451 = config_ChainCreate( &psz_tmp, &p_cfg, p_vout->p->psz_filter_chain );
452 config_ChainDestroy( p_cfg );
455 /* Create a video filter2 var ... but don't inherit values */
456 var_Create( p_vout, "video-filter",
457 VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
458 p_vout->p->psz_vf2 = var_GetString( p_vout, "video-filter" );
461 p_vout->p->b_first_vout = false;
464 var_AddCallback( p_vout, "video-filter", VideoFilter2Callback, NULL );
465 p_vout->p->p_vf2_chain = filter_chain_New( p_vout, "video filter2",
466 false, video_filter_buffer_allocation_init, NULL, p_vout );
468 /* Choose the video output module */
469 if( !p_vout->p->psz_filter_chain || !*p_vout->p->psz_filter_chain )
471 psz_parser = var_CreateGetString( p_vout, "vout" );
475 psz_parser = strdup( p_vout->p->psz_filter_chain );
476 p_vout->p->b_title_show = false;
479 /* Create the vout thread */
480 char* psz_tmp = config_ChainCreate( &psz_name, &p_cfg, psz_parser );
483 p_vout->p_cfg = p_cfg;
485 /* Create a few object variables for interface interaction */
486 var_Create( p_vout, "vout-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
487 text.psz_string = _("Filters");
488 var_Change( p_vout, "vout-filter", VLC_VAR_SETTEXT, &text, NULL );
489 var_AddCallback( p_vout, "vout-filter", FilterCallback, NULL );
492 DeinterlaceEnable( p_vout );
494 if( p_vout->p->psz_filter_chain && *p_vout->p->psz_filter_chain )
495 p_vout->p->psz_module_type = "video filter";
497 p_vout->p->psz_module_type = "video output";
498 p_vout->p->psz_module_name = psz_name;
499 p_vout->p_module = NULL;
502 vlc_object_set_destructor( p_vout, vout_Destructor );
505 vlc_cond_init( &p_vout->p->change_wait );
506 if( vlc_clone( &p_vout->p->thread, RunThread, p_vout,
507 VLC_THREAD_PRIORITY_OUTPUT ) )
509 spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), false );
510 spu_Destroy( p_vout->p_spu );
511 p_vout->p_spu = NULL;
512 vlc_object_release( p_vout );
516 vlc_mutex_lock( &p_vout->change_lock );
517 while( !p_vout->p->b_ready )
518 { /* We are (ab)using the same condition in opposite directions for
519 * b_ready and b_done. This works because of the strict ordering. */
520 assert( !p_vout->p->b_done );
521 vlc_cond_wait( &p_vout->p->change_wait, &p_vout->change_lock );
523 vlc_mutex_unlock( &p_vout->change_lock );
525 if( p_vout->b_error )
527 msg_Err( p_vout, "video output creation failed" );
528 vout_CloseAndRelease( p_vout );
535 /*****************************************************************************
536 * vout_Close: Close a vout created by vout_Create.
537 *****************************************************************************
538 * You HAVE to call it on vout created by vout_Create before vlc_object_release.
539 * You should NEVER call it on vout not obtained through vout_Create
540 * (like with vout_Request or vlc_object_find.)
541 * You can use vout_CloseAndRelease() as a convenience method.
542 *****************************************************************************/
543 void vout_Close( vout_thread_t *p_vout )
547 vlc_mutex_lock( &p_vout->change_lock );
548 p_vout->p->b_done = true;
549 vlc_cond_signal( &p_vout->p->change_wait );
550 vlc_mutex_unlock( &p_vout->change_lock );
552 vout_snapshot_End( &p_vout->p->snapshot );
554 vlc_join( p_vout->p->thread, NULL );
558 static void vout_Destructor( vlc_object_t * p_this )
560 vout_thread_t *p_vout = (vout_thread_t *)p_this;
562 /* Make sure the vout was stopped first */
563 assert( !p_vout->p_module );
565 free( p_vout->p->psz_module_name );
569 spu_Destroy( p_vout->p_spu );
571 /* Destroy the locks */
572 vlc_cond_destroy( &p_vout->p->change_wait );
573 vlc_cond_destroy( &p_vout->p->picture_wait );
574 vlc_mutex_destroy( &p_vout->picture_lock );
575 vlc_mutex_destroy( &p_vout->change_lock );
576 vlc_mutex_destroy( &p_vout->p->vfilter_lock );
579 vout_statistic_Clean( &p_vout->p->statistic );
582 vout_snapshot_Clean( &p_vout->p->snapshot );
585 free( p_vout->p->psz_filter_chain );
586 free( p_vout->p->psz_title );
588 config_ChainDestroy( p_vout->p_cfg );
595 void vout_ChangePause( vout_thread_t *p_vout, bool b_paused, mtime_t i_date )
597 vlc_mutex_lock( &p_vout->change_lock );
599 assert( !p_vout->p->b_paused || !b_paused );
601 vlc_mutex_lock( &p_vout->picture_lock );
603 p_vout->p->i_picture_displayed_date = 0;
605 if( p_vout->p->b_paused )
607 const mtime_t i_duration = i_date - p_vout->p->i_pause_date;
609 for( int i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
611 picture_t *p_pic = PP_RENDERPICTURE[i_index];
613 if( p_pic->i_status == READY_PICTURE )
614 p_pic->date += i_duration;
616 vlc_cond_signal( &p_vout->p->picture_wait );
617 vlc_mutex_unlock( &p_vout->picture_lock );
619 spu_OffsetSubtitleDate( p_vout->p_spu, i_duration );
623 vlc_mutex_unlock( &p_vout->picture_lock );
625 p_vout->p->b_paused = b_paused;
626 p_vout->p->i_pause_date = i_date;
628 vlc_mutex_unlock( &p_vout->change_lock );
631 void vout_GetResetStatistic( vout_thread_t *p_vout, int *pi_displayed, int *pi_lost )
633 vout_statistic_GetReset( &p_vout->p->statistic,
634 pi_displayed, pi_lost );
637 void vout_Flush( vout_thread_t *p_vout, mtime_t i_date )
639 vlc_mutex_lock( &p_vout->picture_lock );
640 p_vout->p->i_picture_displayed_date = 0;
641 for( int i = 0; i < p_vout->render.i_pictures; i++ )
643 picture_t *p_pic = p_vout->render.pp_picture[i];
645 if( p_pic->i_status == READY_PICTURE ||
646 p_pic->i_status == DISPLAYED_PICTURE )
648 /* We cannot change picture status if it is in READY_PICTURE state,
649 * Just make sure they won't be displayed */
650 if( p_pic->date > i_date )
651 p_pic->date = i_date;
654 vlc_cond_signal( &p_vout->p->picture_wait );
655 vlc_mutex_unlock( &p_vout->picture_lock );
658 void vout_FixLeaks( vout_thread_t *p_vout, bool b_forced )
660 int i_pic, i_ready_pic;
662 vlc_mutex_lock( &p_vout->picture_lock );
664 for( i_pic = 0, i_ready_pic = 0; i_pic < p_vout->render.i_pictures && !b_forced; i_pic++ )
666 const picture_t *p_pic = p_vout->render.pp_picture[i_pic];
668 if( p_pic->i_status == READY_PICTURE )
671 /* If we have at least 2 ready pictures, wait for the vout thread to
673 if( i_ready_pic >= 2 )
679 if( p_pic->i_status == DISPLAYED_PICTURE )
681 /* If at least one displayed picture is not referenced
682 * let vout free it */
683 if( p_pic->i_refcount == 0 )
687 if( i_pic < p_vout->render.i_pictures && !b_forced )
689 vlc_mutex_unlock( &p_vout->picture_lock );
693 /* Too many pictures are still referenced, there is probably a bug
694 * with the decoder */
696 msg_Err( p_vout, "pictures leaked, resetting the heap" );
698 /* Just free all the pictures */
699 for( i_pic = 0; i_pic < p_vout->render.i_pictures; i_pic++ )
701 picture_t *p_pic = p_vout->render.pp_picture[i_pic];
703 msg_Dbg( p_vout, "[%d] %d %d", i_pic, p_pic->i_status, p_pic->i_refcount );
704 p_pic->i_refcount = 0;
706 switch( p_pic->i_status )
709 case DISPLAYED_PICTURE:
710 case RESERVED_PICTURE:
711 if( p_pic != p_vout->p->p_picture_displayed )
712 vout_UsePictureLocked( p_vout, p_pic );
716 vlc_cond_signal( &p_vout->p->picture_wait );
717 vlc_mutex_unlock( &p_vout->picture_lock );
719 void vout_NextPicture( vout_thread_t *p_vout, mtime_t *pi_duration )
721 vlc_mutex_lock( &p_vout->picture_lock );
723 const mtime_t i_displayed_date = p_vout->p->i_picture_displayed_date;
725 p_vout->p->b_picture_displayed = false;
726 p_vout->p->b_picture_empty = false;
727 if( p_vout->p->p_picture_displayed )
729 p_vout->p->p_picture_displayed->date = 1;
730 vlc_cond_signal( &p_vout->p->picture_wait );
733 while( !p_vout->p->b_picture_displayed && !p_vout->p->b_picture_empty )
734 vlc_cond_wait( &p_vout->p->picture_wait, &p_vout->picture_lock );
736 *pi_duration = __MAX( p_vout->p->i_picture_displayed_date - i_displayed_date, 0 );
738 /* TODO advance subpicture by the duration ... */
740 vlc_mutex_unlock( &p_vout->picture_lock );
743 void vout_DisplayTitle( vout_thread_t *p_vout, const char *psz_title )
747 if( !config_GetInt( p_vout, "osd" ) )
750 vlc_mutex_lock( &p_vout->change_lock );
751 free( p_vout->p->psz_title );
752 p_vout->p->psz_title = strdup( psz_title );
753 vlc_mutex_unlock( &p_vout->change_lock );
756 spu_t *vout_GetSpu( vout_thread_t *p_vout )
758 return p_vout->p_spu;
761 /*****************************************************************************
762 * InitThread: initialize video output thread
763 *****************************************************************************
764 * This function is called from RunThread and performs the second step of the
765 * initialization. It returns 0 on success. Note that the thread's flag are not
766 * modified inside this function.
767 * XXX You have to enter it with change_lock taken.
768 *****************************************************************************/
769 static int ChromaCreate( vout_thread_t *p_vout );
770 static void ChromaDestroy( vout_thread_t *p_vout );
772 static bool ChromaIsEqual( const picture_heap_t *p_output, const picture_heap_t *p_render )
774 if( !vout_ChromaCmp( p_output->i_chroma, p_render->i_chroma ) )
777 if( p_output->i_chroma != VLC_CODEC_RGB15 &&
778 p_output->i_chroma != VLC_CODEC_RGB16 &&
779 p_output->i_chroma != VLC_CODEC_RGB24 &&
780 p_output->i_chroma != VLC_CODEC_RGB32 )
783 return p_output->i_rmask == p_render->i_rmask &&
784 p_output->i_gmask == p_render->i_gmask &&
785 p_output->i_bmask == p_render->i_bmask;
788 static int InitThread( vout_thread_t *p_vout )
792 /* Initialize output method, it allocates direct buffers for us */
793 if( p_vout->pf_init( p_vout ) )
796 p_vout->p->p_picture_displayed = NULL;
798 if( !I_OUTPUTPICTURES )
800 msg_Err( p_vout, "plugin was unable to allocate at least "
801 "one direct buffer" );
802 p_vout->pf_end( p_vout );
806 if( I_OUTPUTPICTURES > VOUT_MAX_PICTURES )
808 msg_Err( p_vout, "plugin allocated too many direct buffers, "
809 "our internal buffers must have overflown." );
810 p_vout->pf_end( p_vout );
814 msg_Dbg( p_vout, "got %i direct buffer(s)", I_OUTPUTPICTURES );
816 if( !p_vout->fmt_out.i_width || !p_vout->fmt_out.i_height )
818 p_vout->fmt_out.i_width = p_vout->fmt_out.i_visible_width =
819 p_vout->output.i_width;
820 p_vout->fmt_out.i_height = p_vout->fmt_out.i_visible_height =
821 p_vout->output.i_height;
822 p_vout->fmt_out.i_x_offset = p_vout->fmt_out.i_y_offset = 0;
824 p_vout->fmt_out.i_chroma = p_vout->output.i_chroma;
826 if( !p_vout->fmt_out.i_sar_num || !p_vout->fmt_out.i_sar_num )
828 p_vout->fmt_out.i_sar_num = p_vout->output.i_aspect *
829 p_vout->fmt_out.i_height;
830 p_vout->fmt_out.i_sar_den = VOUT_ASPECT_FACTOR *
831 p_vout->fmt_out.i_width;
834 vlc_ureduce( &p_vout->fmt_out.i_sar_num, &p_vout->fmt_out.i_sar_den,
835 p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den, 0 );
837 /* FIXME removed the need of both fmt_* and heap infos */
838 /* Calculate shifts from system-updated masks */
839 PictureHeapFixRgb( &p_vout->render );
840 VideoFormatImportRgb( &p_vout->fmt_render, &p_vout->render );
842 PictureHeapFixRgb( &p_vout->output );
843 VideoFormatImportRgb( &p_vout->fmt_out, &p_vout->output );
845 /* print some usefull debug info about different vout formats
847 msg_Dbg( p_vout, "pic render sz %ix%i, of (%i,%i), vsz %ix%i, 4cc %4.4s, sar %i:%i, msk r0x%x g0x%x b0x%x",
848 p_vout->fmt_render.i_width, p_vout->fmt_render.i_height,
849 p_vout->fmt_render.i_x_offset, p_vout->fmt_render.i_y_offset,
850 p_vout->fmt_render.i_visible_width,
851 p_vout->fmt_render.i_visible_height,
852 (char*)&p_vout->fmt_render.i_chroma,
853 p_vout->fmt_render.i_sar_num, p_vout->fmt_render.i_sar_den,
854 p_vout->fmt_render.i_rmask, p_vout->fmt_render.i_gmask, p_vout->fmt_render.i_bmask );
856 msg_Dbg( p_vout, "pic in sz %ix%i, of (%i,%i), vsz %ix%i, 4cc %4.4s, sar %i:%i, msk r0x%x g0x%x b0x%x",
857 p_vout->fmt_in.i_width, p_vout->fmt_in.i_height,
858 p_vout->fmt_in.i_x_offset, p_vout->fmt_in.i_y_offset,
859 p_vout->fmt_in.i_visible_width,
860 p_vout->fmt_in.i_visible_height,
861 (char*)&p_vout->fmt_in.i_chroma,
862 p_vout->fmt_in.i_sar_num, p_vout->fmt_in.i_sar_den,
863 p_vout->fmt_in.i_rmask, p_vout->fmt_in.i_gmask, p_vout->fmt_in.i_bmask );
865 msg_Dbg( p_vout, "pic out sz %ix%i, of (%i,%i), vsz %ix%i, 4cc %4.4s, sar %i:%i, msk r0x%x g0x%x b0x%x",
866 p_vout->fmt_out.i_width, p_vout->fmt_out.i_height,
867 p_vout->fmt_out.i_x_offset, p_vout->fmt_out.i_y_offset,
868 p_vout->fmt_out.i_visible_width,
869 p_vout->fmt_out.i_visible_height,
870 (char*)&p_vout->fmt_out.i_chroma,
871 p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den,
872 p_vout->fmt_out.i_rmask, p_vout->fmt_out.i_gmask, p_vout->fmt_out.i_bmask );
874 /* Check whether we managed to create direct buffers similar to
875 * the render buffers, ie same size and chroma */
876 if( ( p_vout->output.i_width == p_vout->render.i_width )
877 && ( p_vout->output.i_height == p_vout->render.i_height )
878 && ( ChromaIsEqual( &p_vout->output, &p_vout->render ) ) )
880 /* Cool ! We have direct buffers, we can ask the decoder to
881 * directly decode into them ! Map the first render buffers to
882 * the first direct buffers, but keep the first direct buffer
883 * for memcpy operations */
884 p_vout->p->b_direct = true;
886 for( i = 1; i < VOUT_MAX_PICTURES; i++ )
888 if( p_vout->p_picture[ i ].i_type != DIRECT_PICTURE &&
889 I_RENDERPICTURES >= VOUT_MIN_DIRECT_PICTURES - 1 &&
890 p_vout->p_picture[ i - 1 ].i_type == DIRECT_PICTURE )
892 /* We have enough direct buffers so there's no need to
893 * try to use system memory buffers. */
896 PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
900 msg_Dbg( p_vout, "direct render, mapping "
901 "render pictures 0-%i to system pictures 1-%i",
902 VOUT_MAX_PICTURES - 2, VOUT_MAX_PICTURES - 1 );
906 /* Rats... Something is wrong here, we could not find an output
907 * plugin able to directly render what we decode. See if we can
908 * find a chroma plugin to do the conversion */
909 p_vout->p->b_direct = false;
911 if( ChromaCreate( p_vout ) )
913 p_vout->pf_end( p_vout );
917 msg_Dbg( p_vout, "indirect render, mapping "
918 "render pictures 0-%i to system pictures %i-%i",
919 VOUT_MAX_PICTURES - 1, I_OUTPUTPICTURES,
920 I_OUTPUTPICTURES + VOUT_MAX_PICTURES - 1 );
922 /* Append render buffers after the direct buffers */
923 for( i = I_OUTPUTPICTURES; i < 2 * VOUT_MAX_PICTURES; i++ )
925 PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
928 /* Check if we have enough render pictures */
929 if( I_RENDERPICTURES == VOUT_MAX_PICTURES )
937 /*****************************************************************************
938 * RunThread: video output thread
939 *****************************************************************************
940 * Video output thread. This function does only returns when the thread is
941 * terminated. It handles the pictures arriving in the video heap and the
942 * display device events.
943 *****************************************************************************/
944 static void* RunThread( void *p_this )
946 vout_thread_t *p_vout = p_this;
947 int i_idle_loops = 0; /* loops without displaying a picture */
948 int i_picture_qtype_last = QTYPE_NONE;
949 bool b_picture_interlaced_last = false;
950 mtime_t i_picture_interlaced_last_date;
955 p_vout->p_module = module_need( p_vout,
956 p_vout->p->psz_module_type,
957 p_vout->p->psz_module_name,
958 !strcmp(p_vout->p->psz_module_type, "video filter") );
960 vlc_mutex_lock( &p_vout->change_lock );
962 if( p_vout->p_module )
963 p_vout->b_error = InitThread( p_vout );
965 p_vout->b_error = true;
967 /* signal the creation of the vout */
968 p_vout->p->b_ready = true;
969 vlc_cond_signal( &p_vout->p->change_wait );
971 if( p_vout->b_error )
975 const bool b_drop_late = var_CreateGetBool( p_vout, "drop-late-frames" );
976 i_picture_interlaced_last_date = mdate();
979 * Main loop - it is not executed if an error occurred during
982 while( !p_vout->p->b_done && !p_vout->b_error )
984 /* Initialize loop variables */
985 const mtime_t current_date = mdate();
986 picture_t *p_picture;
987 picture_t *p_filtered_picture;
988 mtime_t display_date;
989 picture_t *p_directbuffer;
992 if( p_vout->p->b_title_show && p_vout->p->psz_title )
993 DisplayTitleOnOSD( p_vout );
995 vlc_mutex_lock( &p_vout->picture_lock );
997 /* Look for the earliest picture but after the last displayed one */
998 picture_t *p_last = p_vout->p->p_picture_displayed;;
1001 for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
1003 picture_t *p_pic = PP_RENDERPICTURE[i_index];
1005 if( p_pic->i_status != READY_PICTURE )
1008 if( p_vout->p->b_paused && p_last && p_last->date > 1 )
1011 if( p_last && p_pic != p_last && p_pic->date <= p_last->date )
1013 /* Drop old picture */
1014 vout_UsePictureLocked( p_vout, p_pic );
1016 else if( !p_vout->p->b_paused && !p_pic->b_force && p_pic != p_last &&
1017 p_pic->date < current_date + p_vout->p->render_time &&
1020 /* Picture is late: it will be destroyed and the thread
1021 * will directly choose the next picture */
1022 vout_UsePictureLocked( p_vout, p_pic );
1023 vout_statistic_Update( &p_vout->p->statistic, 0, 1 );
1025 msg_Warn( p_vout, "late picture skipped (%"PRId64" > %d)",
1026 current_date - p_pic->date, - p_vout->p->render_time );
1028 else if( ( !p_last || p_last->date < p_pic->date ) &&
1029 ( p_picture == NULL || p_pic->date < p_picture->date ) )
1038 if( !p_vout->p->b_picture_empty )
1040 p_vout->p->b_picture_empty = true;
1041 vlc_cond_signal( &p_vout->p->picture_wait );
1048 display_date = p_picture->date;
1050 /* If we found better than the last picture, destroy it */
1051 if( p_last && p_picture != p_last )
1053 vout_UsePictureLocked( p_vout, p_last );
1054 p_vout->p->p_picture_displayed = p_last = NULL;
1057 /* Compute FPS rate */
1058 p_vout->p->p_fps_sample[ p_vout->p->c_fps_samples++ % VOUT_FPS_SAMPLES ] = display_date;
1060 if( !p_vout->p->b_paused && display_date > current_date + VOUT_DISPLAY_DELAY )
1062 /* A picture is ready to be rendered, but its rendering date
1063 * is far from the current one so the thread will perform an
1064 * empty loop as if no picture were found. The picture state
1069 else if( p_picture == p_last )
1071 /* We are asked to repeat the previous picture, but we first
1072 * wait for a couple of idle loops */
1073 if( i_idle_loops < 4 )
1080 /* We set the display date to something high, otherwise
1081 * we'll have lots of problems with late pictures */
1082 display_date = current_date + p_vout->p->render_time;
1085 else if( p_vout->p->b_paused && display_date > current_date + VOUT_DISPLAY_DELAY )
1087 display_date = current_date + VOUT_DISPLAY_DELAY;
1092 if( p_picture->date > 1 )
1094 p_vout->p->i_picture_displayed_date = p_picture->date;
1095 if( p_picture != p_last && !p_vout->p->b_picture_displayed )
1097 p_vout->p->b_picture_displayed = true;
1098 vlc_cond_signal( &p_vout->p->picture_wait );
1101 p_vout->p->p_picture_displayed = p_picture;
1106 const int i_postproc_type = p_vout->p->i_picture_qtype;
1107 const int i_postproc_state = (p_vout->p->i_picture_qtype != QTYPE_NONE) - (i_picture_qtype_last != QTYPE_NONE);
1109 const bool b_picture_interlaced = p_vout->p->b_picture_interlaced;
1110 const int i_picture_interlaced_state = (!!p_vout->p->b_picture_interlaced) - (!!b_picture_interlaced_last);
1112 vlc_mutex_unlock( &p_vout->picture_lock );
1114 if( p_picture == NULL )
1117 p_filtered_picture = NULL;
1119 p_filtered_picture = filter_chain_VideoFilter( p_vout->p->p_vf2_chain,
1122 const bool b_snapshot = vout_snapshot_IsRequested( &p_vout->p->snapshot );
1125 * Check for subpictures to display
1127 mtime_t spu_render_time;
1128 if( p_vout->p->b_paused )
1129 spu_render_time = p_vout->p->i_pause_date;
1130 else if( p_picture )
1131 spu_render_time = p_picture->date > 1 ? p_picture->date : mdate();
1133 spu_render_time = 0;
1135 subpicture_t *p_subpic = spu_SortSubpictures( p_vout->p_spu,
1141 vout_statistic_Update( &p_vout->p->statistic, 1, 0 );
1142 p_directbuffer = vout_RenderPicture( p_vout,
1143 p_filtered_picture, p_subpic,
1147 * Take a snapshot if requested
1149 if( p_directbuffer && b_snapshot )
1150 vout_snapshot_Set( &p_vout->p->snapshot,
1151 &p_vout->fmt_out, p_directbuffer );
1154 * Call the plugin-specific rendering method if there is one
1156 if( p_filtered_picture != NULL && p_directbuffer != NULL && p_vout->pf_render )
1158 /* Render the direct buffer returned by vout_RenderPicture */
1159 p_vout->pf_render( p_vout, p_directbuffer );
1165 if( display_date != 0 && p_directbuffer != NULL )
1167 mtime_t current_render_time = mdate() - current_date;
1168 /* if render time is very large we don't include it in the mean */
1169 if( current_render_time < p_vout->p->render_time +
1170 VOUT_DISPLAY_DELAY )
1172 /* Store render time using a sliding mean weighting to
1173 * current value in a 3 to 1 ratio*/
1174 p_vout->p->render_time *= 3;
1175 p_vout->p->render_time += current_render_time;
1176 p_vout->p->render_time >>= 2;
1179 msg_Dbg( p_vout, "skipped big render time %d > %d", (int) current_render_time,
1180 (int) (p_vout->p->render_time +VOUT_DISPLAY_DELAY ) ) ;
1183 /* Give back change lock */
1184 vlc_mutex_unlock( &p_vout->change_lock );
1186 /* Sleep a while or until a given date */
1187 if( display_date != 0 )
1189 /* If there are *vout* filters in the chain, better give them the picture
1191 if( !p_vout->p->psz_filter_chain || !*p_vout->p->psz_filter_chain )
1193 mwait( display_date - VOUT_MWAIT_TOLERANCE );
1198 /* Wait until a frame is being sent or a spurious wakeup (not a problem here) */
1199 vlc_mutex_lock( &p_vout->picture_lock );
1200 vlc_cond_timedwait( &p_vout->p->picture_wait, &p_vout->picture_lock, current_date + VOUT_IDLE_SLEEP );
1201 vlc_mutex_unlock( &p_vout->picture_lock );
1204 /* On awakening, take back lock and send immediately picture
1206 /* Note: p_vout->p->b_done could be true here and now */
1207 vlc_mutex_lock( &p_vout->change_lock );
1210 * Display the previously rendered picture
1212 if( p_filtered_picture != NULL && p_directbuffer != NULL )
1214 /* Display the direct buffer returned by vout_RenderPicture */
1215 if( p_vout->pf_display )
1216 p_vout->pf_display( p_vout, p_directbuffer );
1218 /* Tell the vout this was the last picture and that it does not
1219 * need to be forced anymore. */
1220 p_picture->b_force = false;
1223 /* Drop the filtered picture if created by video filters */
1224 if( p_filtered_picture != NULL && p_filtered_picture != p_picture )
1226 vlc_mutex_lock( &p_vout->picture_lock );
1227 vout_UsePictureLocked( p_vout, p_filtered_picture );
1228 vlc_mutex_unlock( &p_vout->picture_lock );
1231 if( p_picture != NULL )
1233 /* Reinitialize idle loop count */
1238 * Check events and manage thread
1240 if( p_vout->pf_manage && p_vout->pf_manage( p_vout ) )
1242 /* A fatal error occurred, and the thread must terminate
1243 * immediately, without displaying anything - setting b_error to 1
1244 * causes the immediate end of the main while() loop. */
1246 p_vout->b_error = 1;
1250 while( p_vout->i_changes & VOUT_ON_TOP_CHANGE )
1252 p_vout->i_changes &= ~VOUT_ON_TOP_CHANGE;
1253 vlc_mutex_unlock( &p_vout->change_lock );
1254 vout_Control( p_vout, VOUT_SET_STAY_ON_TOP, p_vout->b_on_top );
1255 vlc_mutex_lock( &p_vout->change_lock );
1258 if( p_vout->i_changes & VOUT_SIZE_CHANGE )
1260 /* this must only happen when the vout plugin is incapable of
1261 * rescaling the picture itself. In this case we need to destroy
1262 * the current picture buffers and recreate new ones with the right
1266 p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
1268 assert( !p_vout->p->b_direct );
1270 ChromaDestroy( p_vout );
1272 vlc_mutex_lock( &p_vout->picture_lock );
1274 p_vout->pf_end( p_vout );
1276 p_vout->p->p_picture_displayed = NULL;
1277 for( i = 0; i < I_OUTPUTPICTURES; i++ )
1278 p_vout->p_picture[ i ].i_status = FREE_PICTURE;
1279 vlc_cond_signal( &p_vout->p->picture_wait );
1281 I_OUTPUTPICTURES = 0;
1283 if( p_vout->pf_init( p_vout ) )
1285 msg_Err( p_vout, "cannot resize display" );
1286 /* FIXME: pf_end will be called again in CleanThread()? */
1287 p_vout->b_error = 1;
1290 vlc_mutex_unlock( &p_vout->picture_lock );
1292 /* Need to reinitialise the chroma plugin. Since we might need
1293 * resizing too and it's not sure that we already had it,
1294 * recreate the chroma plugin chain from scratch. */
1296 if( ChromaCreate( p_vout ) )
1298 msg_Err( p_vout, "WOW THIS SUCKS BIG TIME!!!!!" );
1299 p_vout->b_error = 1;
1301 if( p_vout->b_error )
1305 if( p_vout->i_changes & VOUT_PICTURE_BUFFERS_CHANGE )
1307 /* This happens when the picture buffers need to be recreated.
1308 * This is useful on multimonitor displays for instance.
1310 * Warning: This only works when the vout creates only 1 picture
1312 p_vout->i_changes &= ~VOUT_PICTURE_BUFFERS_CHANGE;
1314 if( !p_vout->p->b_direct )
1315 ChromaDestroy( p_vout );
1317 vlc_mutex_lock( &p_vout->picture_lock );
1319 p_vout->pf_end( p_vout );
1321 I_OUTPUTPICTURES = I_RENDERPICTURES = 0;
1323 p_vout->b_error = InitThread( p_vout );
1324 if( p_vout->b_error )
1325 msg_Err( p_vout, "InitThread after VOUT_PICTURE_BUFFERS_CHANGE failed" );
1327 vlc_cond_signal( &p_vout->p->picture_wait );
1328 vlc_mutex_unlock( &p_vout->picture_lock );
1330 if( p_vout->b_error )
1334 /* Post processing */
1335 if( i_postproc_state == 1 )
1336 PostProcessEnable( p_vout );
1337 else if( i_postproc_state == -1 )
1338 PostProcessDisable( p_vout );
1339 if( i_postproc_state != 0 )
1340 i_picture_qtype_last = i_postproc_type;
1343 * Wait 30s before quiting interlacing mode */
1344 if( ( i_picture_interlaced_state == 1 ) ||
1345 ( i_picture_interlaced_state == -1 && i_picture_interlaced_last_date + 30000000 < current_date ) )
1347 DeinterlaceNeeded( p_vout, b_picture_interlaced );
1348 b_picture_interlaced_last = b_picture_interlaced;
1350 if( b_picture_interlaced )
1351 i_picture_interlaced_last_date = current_date;
1354 /* Check for "video filter2" changes */
1355 vlc_mutex_lock( &p_vout->p->vfilter_lock );
1356 if( p_vout->p->psz_vf2 )
1360 es_format_Init( &fmt, VIDEO_ES, p_vout->fmt_render.i_chroma );
1361 fmt.video = p_vout->fmt_render;
1362 filter_chain_Reset( p_vout->p->p_vf2_chain, &fmt, &fmt );
1364 if( filter_chain_AppendFromString( p_vout->p->p_vf2_chain,
1365 p_vout->p->psz_vf2 ) < 0 )
1366 msg_Err( p_vout, "Video filter chain creation failed" );
1368 free( p_vout->p->psz_vf2 );
1369 p_vout->p->psz_vf2 = NULL;
1371 if( i_picture_qtype_last != QTYPE_NONE )
1372 PostProcessSetFilterQuality( p_vout );
1374 vlc_mutex_unlock( &p_vout->p->vfilter_lock );
1378 * Error loop - wait until the thread destruction is requested
1380 if( p_vout->b_error )
1381 ErrorThread( p_vout );
1384 CleanThread( p_vout );
1388 EndThread( p_vout );
1389 vlc_mutex_unlock( &p_vout->change_lock );
1391 if( p_vout->p_module )
1392 module_unneed( p_vout, p_vout->p_module );
1393 p_vout->p_module = NULL;
1398 /*****************************************************************************
1399 * ErrorThread: RunThread() error loop
1400 *****************************************************************************
1401 * This function is called when an error occurred during thread main's loop.
1402 * The thread can still receive feed, but must be ready to terminate as soon
1404 *****************************************************************************/
1405 static void ErrorThread( vout_thread_t *p_vout )
1407 /* Wait until a `close' order */
1408 while( !p_vout->p->b_done )
1409 vlc_cond_wait( &p_vout->p->change_wait, &p_vout->change_lock );
1412 /*****************************************************************************
1413 * CleanThread: clean up after InitThread
1414 *****************************************************************************
1415 * This function is called after a sucessful
1416 * initialization. It frees all resources allocated by InitThread.
1417 * XXX You have to enter it with change_lock taken.
1418 *****************************************************************************/
1419 static void CleanThread( vout_thread_t *p_vout )
1421 int i_index; /* index in heap */
1423 if( !p_vout->p->b_direct )
1424 ChromaDestroy( p_vout );
1426 /* Destroy all remaining pictures */
1427 for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++ )
1429 if ( p_vout->p_picture[i_index].i_type == MEMORY_PICTURE )
1431 free( p_vout->p_picture[i_index].p_data_orig );
1435 /* Destroy translation tables */
1436 if( !p_vout->b_error )
1437 p_vout->pf_end( p_vout );
1440 /*****************************************************************************
1441 * EndThread: thread destruction
1442 *****************************************************************************
1443 * This function is called when the thread ends.
1444 * It frees all resources not allocated by InitThread.
1445 * XXX You have to enter it with change_lock taken.
1446 *****************************************************************************/
1447 static void EndThread( vout_thread_t *p_vout )
1451 struct tms cpu_usage;
1452 times( &cpu_usage );
1454 msg_Dbg( p_vout, "cpu usage (user: %d, system: %d)",
1455 cpu_usage.tms_utime, cpu_usage.tms_stime );
1459 /* FIXME does that function *really* need to be called inside the thread ? */
1461 /* Detach subpicture unit from both input and vout */
1462 spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), false );
1463 vlc_object_detach( p_vout->p_spu );
1465 /* Destroy the video filters2 */
1466 filter_chain_Delete( p_vout->p->p_vf2_chain );
1469 /* Thread helpers */
1470 static picture_t *ChromaGetPicture( filter_t *p_filter )
1472 picture_t *p_pic = (picture_t *)p_filter->p_owner;
1473 p_filter->p_owner = NULL;
1477 static int ChromaCreate( vout_thread_t *p_vout )
1479 static const char typename[] = "chroma";
1482 /* Choose the best module */
1483 p_chroma = p_vout->p->p_chroma =
1484 vlc_custom_create( p_vout, sizeof(filter_t), VLC_OBJECT_GENERIC,
1487 vlc_object_attach( p_chroma, p_vout );
1489 /* TODO: Set the fmt_in and fmt_out stuff here */
1490 p_chroma->fmt_in.video = p_vout->fmt_render;
1491 p_chroma->fmt_out.video = p_vout->fmt_out;
1492 VideoFormatImportRgb( &p_chroma->fmt_in.video, &p_vout->render );
1493 VideoFormatImportRgb( &p_chroma->fmt_out.video, &p_vout->output );
1495 p_chroma->p_module = module_need( p_chroma, "video filter2", NULL, false );
1497 if( p_chroma->p_module == NULL )
1499 msg_Err( p_vout, "no chroma module for %4.4s to %4.4s i=%dx%d o=%dx%d",
1500 (char*)&p_vout->render.i_chroma,
1501 (char*)&p_vout->output.i_chroma,
1502 p_chroma->fmt_in.video.i_width, p_chroma->fmt_in.video.i_height,
1503 p_chroma->fmt_out.video.i_width, p_chroma->fmt_out.video.i_height
1506 vlc_object_release( p_vout->p->p_chroma );
1507 p_vout->p->p_chroma = NULL;
1509 return VLC_EGENERIC;
1511 p_chroma->pf_vout_buffer_new = ChromaGetPicture;
1515 static void ChromaDestroy( vout_thread_t *p_vout )
1517 assert( !p_vout->p->b_direct );
1519 if( !p_vout->p->p_chroma )
1522 module_unneed( p_vout->p->p_chroma, p_vout->p->p_chroma->p_module );
1523 vlc_object_release( p_vout->p->p_chroma );
1524 p_vout->p->p_chroma = NULL;
1527 /* following functions are local */
1530 * This function copies all RGB informations from a picture_heap_t into
1533 static void VideoFormatImportRgb( video_format_t *p_fmt, const picture_heap_t *p_heap )
1535 p_fmt->i_rmask = p_heap->i_rmask;
1536 p_fmt->i_gmask = p_heap->i_gmask;
1537 p_fmt->i_bmask = p_heap->i_bmask;
1538 p_fmt->i_rrshift = p_heap->i_rrshift;
1539 p_fmt->i_lrshift = p_heap->i_lrshift;
1540 p_fmt->i_rgshift = p_heap->i_rgshift;
1541 p_fmt->i_lgshift = p_heap->i_lgshift;
1542 p_fmt->i_rbshift = p_heap->i_rbshift;
1543 p_fmt->i_lbshift = p_heap->i_lbshift;
1547 * This funtion copes all RGB informations from a video_format_t into
1550 static void VideoFormatExportRgb( const video_format_t *p_fmt, picture_heap_t *p_heap )
1552 p_heap->i_rmask = p_fmt->i_rmask;
1553 p_heap->i_gmask = p_fmt->i_gmask;
1554 p_heap->i_bmask = p_fmt->i_bmask;
1555 p_heap->i_rrshift = p_fmt->i_rrshift;
1556 p_heap->i_lrshift = p_fmt->i_lrshift;
1557 p_heap->i_rgshift = p_fmt->i_rgshift;
1558 p_heap->i_lgshift = p_fmt->i_lgshift;
1559 p_heap->i_rbshift = p_fmt->i_rbshift;
1560 p_heap->i_lbshift = p_fmt->i_lbshift;
1564 * This function computes rgb shifts from masks
1566 static void PictureHeapFixRgb( picture_heap_t *p_heap )
1571 fmt.i_chroma = p_heap->i_chroma;
1572 VideoFormatImportRgb( &fmt, p_heap );
1575 video_format_FixRgb( &fmt );
1577 VideoFormatExportRgb( &fmt, p_heap );
1580 /*****************************************************************************
1581 * object variables callbacks: a bunch of object variables are used by the
1582 * interfaces to interact with the vout.
1583 *****************************************************************************/
1584 static int FilterCallback( vlc_object_t *p_this, char const *psz_cmd,
1585 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1587 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1588 input_thread_t *p_input;
1589 (void)psz_cmd; (void)oldval; (void)p_data;
1591 p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1595 msg_Err( p_vout, "Input not found" );
1596 return VLC_EGENERIC;
1599 var_SetBool( p_vout, "intf-change", true );
1601 /* Modify input as well because the vout might have to be restarted */
1602 var_Create( p_input, "vout-filter", VLC_VAR_STRING );
1603 var_SetString( p_input, "vout-filter", newval.psz_string );
1605 /* Now restart current video stream */
1606 input_Control( p_input, INPUT_RESTART_ES, -VIDEO_ES );
1607 vlc_object_release( p_input );
1612 /*****************************************************************************
1613 * Video Filter2 stuff
1614 *****************************************************************************/
1615 static int VideoFilter2Callback( vlc_object_t *p_this, char const *psz_cmd,
1616 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1618 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1619 (void)psz_cmd; (void)oldval; (void)p_data;
1621 vlc_mutex_lock( &p_vout->p->vfilter_lock );
1622 p_vout->p->psz_vf2 = strdup( newval.psz_string );
1623 vlc_mutex_unlock( &p_vout->p->vfilter_lock );
1628 /*****************************************************************************
1630 *****************************************************************************/
1631 static bool PostProcessIsPresent( const char *psz_filter )
1633 const char *psz_pp = "postproc";
1634 const size_t i_pp = strlen(psz_pp);
1635 return psz_filter &&
1636 !strncmp( psz_filter, psz_pp, strlen(psz_pp) ) &&
1637 ( psz_filter[i_pp] == '\0' || psz_filter[i_pp] == ':' );
1640 static int PostProcessCallback( vlc_object_t *p_this, char const *psz_cmd,
1641 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1643 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1644 VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval); VLC_UNUSED(p_data);
1646 static const char *psz_pp = "postproc";
1648 char *psz_vf2 = var_GetString( p_vout, "video-filter" );
1650 if( newval.i_int <= 0 )
1652 if( PostProcessIsPresent( psz_vf2 ) )
1654 strcpy( psz_vf2, &psz_vf2[strlen(psz_pp)] );
1655 if( *psz_vf2 == ':' )
1656 strcpy( psz_vf2, &psz_vf2[1] );
1661 if( !PostProcessIsPresent( psz_vf2 ) )
1665 char *psz_tmp = psz_vf2;
1666 if( asprintf( &psz_vf2, "%s:%s", psz_pp, psz_tmp ) < 0 )
1673 psz_vf2 = strdup( psz_pp );
1679 var_SetString( p_vout, "video-filter", psz_vf2 );
1685 static void PostProcessEnable( vout_thread_t *p_vout )
1688 msg_Dbg( p_vout, "Post-processing available" );
1689 var_Create( p_vout, "postprocess", VLC_VAR_INTEGER | VLC_VAR_HASCHOICE );
1690 text.psz_string = _("Post processing");
1691 var_Change( p_vout, "postprocess", VLC_VAR_SETTEXT, &text, NULL );
1693 for( int i = 0; i <= 6; i++ )
1700 snprintf( psz_text, sizeof(psz_text), "%d", i );
1702 text.psz_string = _("Disable");
1704 text.psz_string = psz_text;
1705 var_Change( p_vout, "postprocess", VLC_VAR_ADDCHOICE, &val, &text );
1707 var_AddCallback( p_vout, "postprocess", PostProcessCallback, NULL );
1710 char *psz_filter = var_GetNonEmptyString( p_vout, "video-filter" );
1711 int i_postproc_q = 0;
1712 if( PostProcessIsPresent( psz_filter ) )
1713 i_postproc_q = var_CreateGetInteger( p_vout, "postproc-q" );
1715 var_SetInteger( p_vout, "postprocess", i_postproc_q );
1719 static void PostProcessDisable( vout_thread_t *p_vout )
1721 msg_Dbg( p_vout, "Post-processing no more available" );
1722 var_Destroy( p_vout, "postprocess" );
1724 static void PostProcessSetFilterQuality( vout_thread_t *p_vout )
1726 vlc_object_t *p_pp = vlc_object_find_name( p_vout, "postproc", FIND_CHILD );
1730 var_SetInteger( p_pp, "postproc-q", var_GetInteger( p_vout, "postprocess" ) );
1731 vlc_object_release( p_pp );
1735 static void DisplayTitleOnOSD( vout_thread_t *p_vout )
1737 const mtime_t i_start = mdate();
1738 const mtime_t i_stop = i_start + INT64_C(1000) * p_vout->p->i_title_timeout;
1740 if( i_stop <= i_start )
1743 vlc_assert_locked( &p_vout->change_lock );
1745 vout_ShowTextAbsolute( p_vout, DEFAULT_CHAN,
1746 p_vout->p->psz_title, NULL,
1747 p_vout->p->i_title_position,
1748 30 + p_vout->fmt_in.i_width
1749 - p_vout->fmt_in.i_visible_width
1750 - p_vout->fmt_in.i_x_offset,
1751 20 + p_vout->fmt_in.i_y_offset,
1754 free( p_vout->p->psz_title );
1756 p_vout->p->psz_title = NULL;
1759 /*****************************************************************************
1761 *****************************************************************************/
1764 const char *psz_mode;
1766 } deinterlace_mode_t;
1769 * You can use the non vout filter if and only if the video properties stay the
1770 * same (width/height/chroma/fps), at least for now.
1772 static const deinterlace_mode_t p_deinterlace_mode[] = {
1774 { "discard", true },
1781 { "yadif2x", true },
1785 static char *FilterFind( char *psz_filter_base, const char *psz_module )
1787 const size_t i_module = strlen( psz_module );
1788 const char *psz_filter = psz_filter_base;
1790 if( !psz_filter || i_module <= 0 )
1795 char *psz_find = strstr( psz_filter, psz_module );
1798 if( psz_find[i_module] == '\0' || psz_find[i_module] == ':' )
1800 psz_filter = &psz_find[i_module];
1804 static bool DeinterlaceIsPresent( vout_thread_t *p_vout, bool b_vout_filter )
1806 char *psz_filter = var_GetNonEmptyString( p_vout, b_vout_filter ? "vout-filter" : "video-filter" );
1808 bool b_found = FilterFind( psz_filter, "deinterlace" ) != NULL;
1815 static void DeinterlaceRemove( vout_thread_t *p_vout, bool b_vout_filter )
1817 const char *psz_variable = b_vout_filter ? "vout-filter" : "video-filter";
1818 char *psz_filter = var_GetNonEmptyString( p_vout, psz_variable );
1820 char *psz = FilterFind( psz_filter, "deinterlace" );
1828 strcpy( &psz[0], &psz[strlen("deinterlace")] );
1830 strcpy( &psz[0], &psz[1] );
1832 var_SetString( p_vout, psz_variable, psz_filter );
1835 static void DeinterlaceAdd( vout_thread_t *p_vout, bool b_vout_filter )
1837 const char *psz_variable = b_vout_filter ? "vout-filter" : "video-filter";
1839 char *psz_filter = var_GetNonEmptyString( p_vout, psz_variable );
1841 if( FilterFind( psz_filter, "deinterlace" ) )
1850 char *psz_tmp = psz_filter;
1851 if( asprintf( &psz_filter, "%s:%s", psz_tmp, "deinterlace" ) < 0 )
1852 psz_filter = psz_tmp;
1858 psz_filter = strdup( "deinterlace" );
1863 var_SetString( p_vout, psz_variable, psz_filter );
1868 static void DeinterlaceSave( vout_thread_t *p_vout, int i_deinterlace, const char *psz_mode, bool is_needed )
1870 /* We have to set input variable to ensure restart support
1871 * XXX it is only needed because of vout-filter but must be done
1872 * for non video filter anyway */
1873 vlc_object_t *p_input = vlc_object_find( p_vout, VLC_OBJECT_INPUT, FIND_PARENT );
1877 /* Another hack for "vout filter" mode */
1878 if( i_deinterlace < 0 )
1879 i_deinterlace = is_needed ? -2 : -3;
1881 var_Create( p_input, "deinterlace", VLC_VAR_INTEGER );
1882 var_SetInteger( p_input, "deinterlace", i_deinterlace );
1884 static const char * const ppsz_variable[] = {
1886 "filter-deinterlace-mode",
1887 "sout-deinterlace-mode",
1890 for( int i = 0; ppsz_variable[i]; i++ )
1892 var_Create( p_input, ppsz_variable[i], VLC_VAR_STRING );
1893 var_SetString( p_input, ppsz_variable[i], psz_mode );
1896 vlc_object_release( p_input );
1898 static int DeinterlaceCallback( vlc_object_t *p_this, char const *psz_cmd,
1899 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1901 VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval); VLC_UNUSED(newval); VLC_UNUSED(p_data);
1902 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1905 const int i_deinterlace = var_GetInteger( p_this, "deinterlace" );
1906 char *psz_mode = var_GetString( p_this, "deinterlace-mode" );
1907 const bool is_needed = var_GetBool( p_this, "deinterlace-needed" );
1909 return VLC_EGENERIC;
1911 DeinterlaceSave( p_vout, i_deinterlace, psz_mode, is_needed );
1914 bool b_vout_filter = true;
1915 for( const deinterlace_mode_t *p_mode = &p_deinterlace_mode[0]; p_mode->psz_mode; p_mode++ )
1917 if( !strcmp( p_mode->psz_mode, psz_mode ) )
1919 b_vout_filter = p_mode->b_vout_filter;
1928 psz_old = var_CreateGetString( p_vout, "filter-deinterlace-mode" );
1932 psz_old = var_CreateGetString( p_vout, "sout-deinterlace-mode" );
1933 var_SetString( p_vout, "sout-deinterlace-mode", psz_mode );
1936 msg_Dbg( p_vout, "deinterlace %d, mode %s, is_needed %d", i_deinterlace, psz_mode, is_needed );
1937 if( i_deinterlace == 0 || ( i_deinterlace == -1 && !is_needed ) )
1939 DeinterlaceRemove( p_vout, false );
1940 DeinterlaceRemove( p_vout, true );
1944 if( !DeinterlaceIsPresent( p_vout, b_vout_filter ) )
1946 DeinterlaceRemove( p_vout, !b_vout_filter );
1947 DeinterlaceAdd( p_vout, b_vout_filter );
1951 /* The deinterlace filter was already inserted but we have changed the mode */
1952 DeinterlaceRemove( p_vout, !b_vout_filter );
1953 if( psz_old && strcmp( psz_old, psz_mode ) )
1954 var_TriggerCallback( p_vout, b_vout_filter ? "vout-filter" : "video-filter" );
1964 static void DeinterlaceEnable( vout_thread_t *p_vout )
1966 vlc_value_t val, text;
1968 if( !p_vout->p->b_first_vout )
1971 msg_Dbg( p_vout, "Deinterlacing available" );
1973 /* Create the configuration variables */
1975 var_Create( p_vout, "deinterlace", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT | VLC_VAR_HASCHOICE );
1976 int i_deinterlace = var_GetInteger( p_vout, "deinterlace" );
1978 text.psz_string = _("Deinterlace");
1979 var_Change( p_vout, "deinterlace", VLC_VAR_SETTEXT, &text, NULL );
1981 const module_config_t *p_optd = config_FindConfig( VLC_OBJECT(p_vout), "deinterlace" );
1982 var_Change( p_vout, "deinterlace", VLC_VAR_CLEARCHOICES, NULL, NULL );
1983 for( int i = 0; p_optd && i < p_optd->i_list; i++ )
1985 val.i_int = p_optd->pi_list[i];
1986 text.psz_string = (char*)vlc_gettext(p_optd->ppsz_list_text[i]);
1987 var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
1989 var_AddCallback( p_vout, "deinterlace", DeinterlaceCallback, NULL );
1991 var_Create( p_vout, "deinterlace-mode", VLC_VAR_STRING | VLC_VAR_DOINHERIT | VLC_VAR_HASCHOICE );
1992 char *psz_deinterlace = var_GetNonEmptyString( p_vout, "deinterlace-mode" );
1994 text.psz_string = _("Deinterlace mode");
1995 var_Change( p_vout, "deinterlace-mode", VLC_VAR_SETTEXT, &text, NULL );
1997 const module_config_t *p_optm = config_FindConfig( VLC_OBJECT(p_vout), "deinterlace-mode" );
1998 var_Change( p_vout, "deinterlace-mode", VLC_VAR_CLEARCHOICES, NULL, NULL );
1999 for( int i = 0; p_optm && i < p_optm->i_list; i++ )
2001 val.psz_string = p_optm->ppsz_list[i];
2002 text.psz_string = (char*)vlc_gettext(p_optm->ppsz_list_text[i]);
2003 var_Change( p_vout, "deinterlace-mode", VLC_VAR_ADDCHOICE, &val, &text );
2005 var_AddCallback( p_vout, "deinterlace-mode", DeinterlaceCallback, NULL );
2007 var_Create( p_vout, "deinterlace-needed", VLC_VAR_BOOL );
2008 var_AddCallback( p_vout, "deinterlace-needed", DeinterlaceCallback, NULL );
2010 /* Override the initial value from filters if present */
2011 char *psz_filter_mode = NULL;
2012 if( DeinterlaceIsPresent( p_vout, true ) )
2013 psz_filter_mode = var_CreateGetNonEmptyString( p_vout, "filter-deinterlace-mode" );
2014 else if( DeinterlaceIsPresent( p_vout, false ) )
2015 psz_filter_mode = var_CreateGetNonEmptyString( p_vout, "sout-deinterlace-mode" );
2016 if( psz_filter_mode )
2018 free( psz_deinterlace );
2019 if( i_deinterlace >= -1 )
2021 psz_deinterlace = psz_filter_mode;
2025 if( i_deinterlace == -2 )
2026 p_vout->p->b_picture_interlaced = true;
2027 else if( i_deinterlace == -3 )
2028 p_vout->p->b_picture_interlaced = false;
2029 if( i_deinterlace < 0 )
2033 val.psz_string = psz_deinterlace ? psz_deinterlace : p_optm->orig.psz;
2034 var_Change( p_vout, "deinterlace-mode", VLC_VAR_SETVALUE, &val, NULL );
2035 val.b_bool = p_vout->p->b_picture_interlaced;
2036 var_Change( p_vout, "deinterlace-needed", VLC_VAR_SETVALUE, &val, NULL );
2038 var_SetInteger( p_vout, "deinterlace", i_deinterlace );
2039 free( psz_deinterlace );
2042 static void DeinterlaceNeeded( vout_thread_t *p_vout, bool is_interlaced )
2044 msg_Dbg( p_vout, "Detected %s video",
2045 is_interlaced ? "interlaced" : "progressive" );
2046 var_SetBool( p_vout, "deinterlace-needed", is_interlaced );