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>
13 * Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
15 * This program is free software; you can redistribute it and/or modify
16 * it under the terms of the GNU General Public License as published by
17 * the Free Software Foundation; either version 2 of the License, or
18 * (at your option) any later version.
20 * This program is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
25 * You should have received a copy of the GNU General Public License
26 * along with this program; if not, write to the Free Software
27 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
28 *****************************************************************************/
30 /*****************************************************************************
32 *****************************************************************************/
37 #include <vlc_common.h>
39 #include <stdlib.h> /* free() */
45 #include <vlc_filter.h>
46 #include <vlc_vout_osd.h>
49 #include <vlc_input.h>
50 #include "vout_internal.h"
51 #include "interlacing.h"
52 #include "postprocessing.h"
55 /*****************************************************************************
57 *****************************************************************************/
58 static void *Thread(void *);
59 static void vout_Destructor(vlc_object_t *);
61 /* Object variables callbacks */
62 static int FilterCallback( vlc_object_t *, char const *,
63 vlc_value_t, vlc_value_t, void * );
64 static int VideoFilter2Callback( vlc_object_t *, char const *,
65 vlc_value_t, vlc_value_t, void * );
68 static void PrintVideoFormat(vout_thread_t *, const char *, const video_format_t *);
70 /* Maximum delay between 2 displayed pictures.
71 * XXX it is needed for now but should be removed in the long term.
73 #define VOUT_REDISPLAY_DELAY (INT64_C(80000))
76 * Late pictures having a delay higher than this value are thrashed.
78 #define VOUT_DISPLAY_LATE_THRESHOLD (INT64_C(20000))
80 /* Better be in advance when awakening than late... */
81 #define VOUT_MWAIT_TOLERANCE (INT64_C(1000))
83 /*****************************************************************************
84 * Video Filter2 functions
85 *****************************************************************************/
86 static picture_t *video_new_buffer_filter( filter_t *p_filter )
88 vout_thread_t *p_vout = (vout_thread_t*)p_filter->p_owner;
89 return picture_pool_Get(p_vout->p->private_pool);
92 static void video_del_buffer_filter( filter_t *p_filter, picture_t *p_pic )
95 picture_Release(p_pic);
98 static int video_filter_buffer_allocation_init( filter_t *p_filter, void *p_data )
100 p_filter->pf_video_buffer_new = video_new_buffer_filter;
101 p_filter->pf_video_buffer_del = video_del_buffer_filter;
102 p_filter->p_owner = p_data; /* p_vout */
107 /*****************************************************************************
108 * vout_Request: find a video output thread, create one, or destroy one.
109 *****************************************************************************
110 * This function looks for a video output thread matching the current
111 * properties. If not found, it spawns a new one.
112 *****************************************************************************/
113 vout_thread_t *vout_Request( vlc_object_t *p_this, vout_thread_t *p_vout,
114 video_format_t *p_fmt )
118 /* Video output is no longer used.
119 * TODO: support for reusing video outputs with proper _thread-safe_
120 * reference handling. */
122 vout_CloseAndRelease( p_vout );
126 /* If a video output was provided, lock it, otherwise look for one. */
129 vlc_object_hold( p_vout );
132 /* TODO: find a suitable unused video output */
134 /* If we now have a video output, check it has the right properties */
137 vlc_mutex_lock( &p_vout->p->change_lock );
139 if( !video_format_IsSimilar( &p_vout->p->original, p_fmt ) )
141 vlc_mutex_unlock( &p_vout->p->change_lock );
143 /* We are not interested in this format, close this vout */
144 vout_CloseAndRelease( p_vout );
145 vlc_object_release( p_vout );
150 /* This video output is cool! Hijack it. */
151 vlc_mutex_unlock( &p_vout->p->change_lock );
153 vlc_object_release( p_vout );
158 msg_Dbg( p_this, "reusing provided vout" );
160 spu_Attach( p_vout->p->p_spu, VLC_OBJECT(p_vout), false );
161 vlc_object_detach( p_vout );
163 vlc_object_attach( p_vout, p_this );
164 spu_Attach( p_vout->p->p_spu, VLC_OBJECT(p_vout), true );
170 msg_Dbg( p_this, "no usable vout present, spawning one" );
172 p_vout = vout_Create( p_this, p_fmt );
178 /*****************************************************************************
179 * vout_Create: creates a new video output thread
180 *****************************************************************************
181 * This function creates a new video output thread, and returns a pointer
182 * to its description. On error, it returns NULL.
183 *****************************************************************************/
184 vout_thread_t * (vout_Create)( vlc_object_t *p_parent, video_format_t *p_fmt )
186 vout_thread_t *p_vout; /* thread descriptor */
190 config_chain_t *p_cfg;
194 if( p_fmt->i_width <= 0 || p_fmt->i_height <= 0 )
196 const vlc_fourcc_t i_chroma = vlc_fourcc_GetCodec( VIDEO_ES, p_fmt->i_chroma );
198 vlc_ureduce( &p_fmt->i_sar_num, &p_fmt->i_sar_den,
199 p_fmt->i_sar_num, p_fmt->i_sar_den, 50000 );
200 if( p_fmt->i_sar_num <= 0 || p_fmt->i_sar_den <= 0 )
203 /* Allocate descriptor */
204 static const char typename[] = "video output";
205 p_vout = vlc_custom_create( p_parent, sizeof( *p_vout ), VLC_OBJECT_VOUT,
211 p_vout->p = calloc( 1, sizeof(*p_vout->p) );
214 vlc_object_release( p_vout );
219 p_vout->p->original = *p_fmt; /* FIXME palette */
220 p_vout->p->original.i_chroma = i_chroma;
221 video_format_FixRgb( &p_vout->p->original );
223 /* Initialize misc stuff */
224 vout_control_Init( &p_vout->p->control );
225 vout_chrono_Init( &p_vout->p->render, 5, 10000 ); /* Arbitrary initial time */
226 vout_statistic_Init( &p_vout->p->statistic );
227 p_vout->p->i_par_num =
228 p_vout->p->i_par_den = 1;
229 p_vout->p->displayed.date = VLC_TS_INVALID;
230 p_vout->p->displayed.decoded = NULL;
231 p_vout->p->displayed.timestamp = VLC_TS_INVALID;
232 p_vout->p->displayed.qtype = QTYPE_NONE;
233 p_vout->p->displayed.is_interlaced = false;
235 p_vout->p->step.last = VLC_TS_INVALID;
236 p_vout->p->step.timestamp = VLC_TS_INVALID;
238 p_vout->p->pause.is_on = false;
239 p_vout->p->pause.date = VLC_TS_INVALID;
241 p_vout->p->decoder_fifo = picture_fifo_New();
242 p_vout->p->decoder_pool = NULL;
244 vlc_mouse_Init( &p_vout->p->mouse );
246 vout_snapshot_Init( &p_vout->p->snapshot );
248 p_vout->p->vfilter_chain =
249 filter_chain_New( p_vout, "video filter2", false,
250 video_filter_buffer_allocation_init, NULL, p_vout );
252 /* Initialize locks */
253 vlc_mutex_init( &p_vout->p->picture_lock );
254 vlc_mutex_init( &p_vout->p->change_lock );
255 vlc_mutex_init( &p_vout->p->vfilter_lock );
257 /* Mouse coordinates */
258 var_Create( p_vout, "mouse-button-down", VLC_VAR_INTEGER );
259 var_Create( p_vout, "mouse-moved", VLC_VAR_COORDS );
260 var_Create( p_vout, "mouse-clicked", VLC_VAR_COORDS );
261 /* Mouse object (area of interest in a video filter) */
262 var_Create( p_vout, "mouse-object", VLC_VAR_BOOL );
264 /* Attach the new object now so we can use var inheritance below */
265 vlc_object_attach( p_vout, p_parent );
267 /* Initialize subpicture unit */
268 p_vout->p->p_spu = spu_Create( p_vout );
271 spu_Init( p_vout->p->p_spu );
273 spu_Attach( p_vout->p->p_spu, VLC_OBJECT(p_vout), true );
275 p_vout->p->is_late_dropped = var_InheritBool( p_vout, "drop-late-frames" );
277 /* Take care of some "interface/control" related initialisations */
278 vout_IntfInit( p_vout );
280 /* Look for the default filter configuration */
281 p_vout->p->psz_filter_chain =
282 var_CreateGetStringCommand( p_vout, "vout-filter" );
284 /* Apply video filter2 objects on the first vout */
285 var_Create( p_vout, "video-filter",
286 VLC_VAR_STRING | VLC_VAR_DOINHERIT | VLC_VAR_ISCOMMAND );
287 var_AddCallback( p_vout, "video-filter", VideoFilter2Callback, NULL );
288 var_TriggerCallback( p_vout, "video-filter" );
290 /* Choose the video output module */
291 if( !p_vout->p->psz_filter_chain || !*p_vout->p->psz_filter_chain )
297 psz_parser = strdup( p_vout->p->psz_filter_chain );
298 p_vout->p->title.show = false;
301 /* Create the vout thread */
302 char *psz_tmp = config_ChainCreate( &psz_name, &p_cfg, psz_parser );
305 p_vout->p->p_cfg = p_cfg;
307 /* Create a few object variables for interface interaction */
308 var_Create( p_vout, "vout-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
309 text.psz_string = _("Filters");
310 var_Change( p_vout, "vout-filter", VLC_VAR_SETTEXT, &text, NULL );
311 var_AddCallback( p_vout, "vout-filter", FilterCallback, NULL );
314 vout_InitInterlacingSupport( p_vout, p_vout->p->displayed.is_interlaced );
316 if( p_vout->p->psz_filter_chain && *p_vout->p->psz_filter_chain )
319 if( asprintf( &psz_tmp, "%s,none", psz_name ) < 0 )
320 psz_tmp = strdup( "" );
324 p_vout->p->psz_module_name = psz_name;
327 vlc_object_set_destructor( p_vout, vout_Destructor );
330 vlc_cond_init( &p_vout->p->change_wait );
331 if( vlc_clone( &p_vout->p->thread, Thread, p_vout,
332 VLC_THREAD_PRIORITY_OUTPUT ) )
334 spu_Attach( p_vout->p->p_spu, VLC_OBJECT(p_vout), false );
335 spu_Destroy( p_vout->p->p_spu );
336 p_vout->p->p_spu = NULL;
337 vlc_object_release( p_vout );
341 vlc_mutex_lock( &p_vout->p->change_lock );
342 while( !p_vout->p->b_ready )
343 { /* We are (ab)using the same condition in opposite directions for
344 * b_ready and b_done. This works because of the strict ordering. */
345 assert( !p_vout->p->b_done );
346 vlc_cond_wait( &p_vout->p->change_wait, &p_vout->p->change_lock );
348 vlc_mutex_unlock( &p_vout->p->change_lock );
350 if( p_vout->p->b_error )
352 msg_Err( p_vout, "video output creation failed" );
353 vout_CloseAndRelease( p_vout );
360 /*****************************************************************************
361 * vout_Close: Close a vout created by vout_Create.
362 *****************************************************************************
363 * You HAVE to call it on vout created by vout_Create before vlc_object_release.
364 * You should NEVER call it on vout not obtained through vout_Create
365 * (like with vout_Request or vlc_object_find.)
366 * You can use vout_CloseAndRelease() as a convenience method.
367 *****************************************************************************/
368 void vout_Close( vout_thread_t *p_vout )
372 vlc_mutex_lock( &p_vout->p->change_lock );
373 p_vout->p->b_done = true;
374 vlc_cond_signal( &p_vout->p->change_wait );
375 vlc_mutex_unlock( &p_vout->p->change_lock );
377 vout_snapshot_End( &p_vout->p->snapshot );
379 vlc_join( p_vout->p->thread, NULL );
383 static void vout_Destructor( vlc_object_t * p_this )
385 vout_thread_t *p_vout = (vout_thread_t *)p_this;
387 /* Make sure the vout was stopped first */
388 //assert( !p_vout->p_module );
390 free( p_vout->p->psz_module_name );
393 if( p_vout->p->p_spu )
394 spu_Destroy( p_vout->p->p_spu );
396 vout_chrono_Clean( &p_vout->p->render );
398 if( p_vout->p->decoder_fifo )
399 picture_fifo_Delete( p_vout->p->decoder_fifo );
400 assert( !p_vout->p->decoder_pool );
402 /* Destroy the locks */
403 vlc_cond_destroy( &p_vout->p->change_wait );
404 vlc_mutex_destroy( &p_vout->p->picture_lock );
405 vlc_mutex_destroy( &p_vout->p->change_lock );
406 vlc_mutex_destroy( &p_vout->p->vfilter_lock );
407 vout_control_Clean( &p_vout->p->control );
410 vout_statistic_Clean( &p_vout->p->statistic );
413 vout_snapshot_Clean( &p_vout->p->snapshot );
416 free( p_vout->p->psz_filter_chain );
418 config_ChainDestroy( p_vout->p->p_cfg );
425 void vout_ChangePause(vout_thread_t *vout, bool is_paused, mtime_t date)
427 vout_control_cmd_t cmd;
428 vout_control_cmd_Init(&cmd, VOUT_CONTROL_PAUSE);
429 cmd.u.pause.is_on = is_paused;
430 cmd.u.pause.date = date;
431 vout_control_Push(&vout->p->control, &cmd);
433 vout_control_WaitEmpty(&vout->p->control);
436 void vout_GetResetStatistic( vout_thread_t *p_vout, int *pi_displayed, int *pi_lost )
438 vout_statistic_GetReset( &p_vout->p->statistic,
439 pi_displayed, pi_lost );
442 void vout_Flush(vout_thread_t *vout, mtime_t date)
444 vout_control_PushTime(&vout->p->control, VOUT_CONTROL_FLUSH, date);
445 vout_control_WaitEmpty(&vout->p->control);
448 void vout_Reset(vout_thread_t *vout)
450 vout_control_PushVoid(&vout->p->control, VOUT_CONTROL_RESET);
451 vout_control_WaitEmpty(&vout->p->control);
454 bool vout_IsEmpty(vout_thread_t *vout)
456 vlc_mutex_lock(&vout->p->picture_lock);
458 picture_t *picture = picture_fifo_Peek(vout->p->decoder_fifo);
460 picture_Release(picture);
462 vlc_mutex_unlock(&vout->p->picture_lock);
467 void vout_FixLeaks( vout_thread_t *vout )
469 vlc_mutex_lock(&vout->p->picture_lock);
471 picture_t *picture = picture_fifo_Peek(vout->p->decoder_fifo);
473 picture = picture_pool_Get(vout->p->decoder_pool);
477 picture_Release(picture);
478 /* Not all pictures has been displayed yet or some are
480 vlc_mutex_unlock(&vout->p->picture_lock);
484 /* There is no reason that no pictures are available, force one
485 * from the pool, becarefull with it though */
486 msg_Err(vout, "pictures leaked, trying to workaround");
489 picture_pool_NonEmpty(vout->p->decoder_pool, false);
491 vlc_mutex_unlock(&vout->p->picture_lock);
493 void vout_NextPicture(vout_thread_t *vout, mtime_t *duration)
495 vout_control_cmd_t cmd;
496 vout_control_cmd_Init(&cmd, VOUT_CONTROL_STEP);
497 cmd.u.time_ptr = duration;
499 vout_control_Push(&vout->p->control, &cmd);
500 vout_control_WaitEmpty(&vout->p->control);
503 void vout_DisplayTitle(vout_thread_t *vout, const char *title)
506 vout_control_PushString(&vout->p->control, VOUT_CONTROL_OSD_TITLE, title);
509 void vout_PutSubpicture( vout_thread_t *vout, subpicture_t *subpic )
511 spu_DisplaySubpicture(vout->p->p_spu, subpic);
513 int vout_RegisterSubpictureChannel( vout_thread_t *vout )
515 return spu_RegisterChannel(vout->p->p_spu);
517 void vout_FlushSubpictureChannel( vout_thread_t *vout, int channel )
519 spu_ClearChannel(vout->p->p_spu, channel);
522 spu_t *vout_GetSpu( vout_thread_t *p_vout )
524 return p_vout->p->p_spu;
527 /* vout_Control* are usable by anyone at anytime */
528 void vout_ControlChangeFullscreen(vout_thread_t *vout, bool fullscreen)
530 vout_control_PushBool(&vout->p->control, VOUT_CONTROL_FULLSCREEN,
533 void vout_ControlChangeOnTop(vout_thread_t *vout, bool is_on_top)
535 vout_control_PushBool(&vout->p->control, VOUT_CONTROL_ON_TOP,
538 void vout_ControlChangeDisplayFilled(vout_thread_t *vout, bool is_filled)
540 vout_control_PushBool(&vout->p->control, VOUT_CONTROL_DISPLAY_FILLED,
543 void vout_ControlChangeZoom(vout_thread_t *vout, int num, int den)
545 vout_control_PushPair(&vout->p->control, VOUT_CONTROL_ZOOM,
548 void vout_ControlChangeSampleAspectRatio(vout_thread_t *vout,
549 unsigned num, unsigned den)
551 vout_control_PushPair(&vout->p->control, VOUT_CONTROL_ASPECT_RATIO,
554 void vout_ControlChangeCropRatio(vout_thread_t *vout,
555 unsigned num, unsigned den)
557 vout_control_PushPair(&vout->p->control, VOUT_CONTROL_CROP_RATIO,
560 void vout_ControlChangeCropWindow(vout_thread_t *vout,
561 int x, int y, int width, int height)
563 vout_control_cmd_t cmd;
564 vout_control_cmd_Init(&cmd, VOUT_CONTROL_CROP_WINDOW);
567 cmd.u.window.width = width;
568 cmd.u.window.height = height;
570 vout_control_Push(&vout->p->control, &cmd);
572 void vout_ControlChangeCropBorder(vout_thread_t *vout,
573 int left, int top, int right, int bottom)
575 vout_control_cmd_t cmd;
576 vout_control_cmd_Init(&cmd, VOUT_CONTROL_CROP_BORDER);
577 cmd.u.border.left = left;
578 cmd.u.border.top = top;
579 cmd.u.border.right = right;
580 cmd.u.border.bottom = bottom;
582 vout_control_Push(&vout->p->control, &cmd);
585 /*****************************************************************************
586 * InitThread: initialize video output thread
587 *****************************************************************************
588 * This function is called from Thread and performs the second step of the
589 * initialization. It returns 0 on success. Note that the thread's flag are not
590 * modified inside this function.
591 * XXX You have to enter it with change_lock taken.
592 *****************************************************************************/
593 static int ThreadInit(vout_thread_t *vout)
595 /* Initialize output method, it allocates direct buffers for us */
596 if (vout_InitWrapper(vout))
598 assert(vout->p->decoder_pool);
600 vout->p->displayed.decoded = NULL;
602 /* print some usefull debug info about different vout formats
604 PrintVideoFormat(vout, "pic render", &vout->p->original);
608 static int ThreadDisplayPicture(vout_thread_t *vout,
609 bool now, mtime_t *deadline)
611 vout_display_t *vd = vout->p->display.vd;
612 int displayed_count = 0;
616 const mtime_t date = mdate();
617 const bool is_paused = vout->p->pause.is_on;
618 bool redisplay = is_paused && !now && vout->p->displayed.decoded;
621 /* FIXME/XXX we must redisplay the last decoded picture (because
622 * of potential vout updated, or filters update or SPU update)
623 * For now a high update period is needed but it coulmd be removed
625 * - vout module emits events from theselves.
626 * - *and* SPU is modified to emit an event or a deadline when needed.
628 * So it will be done latter.
631 picture_t *peek = picture_fifo_Peek(vout->p->decoder_fifo);
633 is_forced = peek->b_force || is_paused || now;
634 *deadline = (is_forced ? date : peek->date) - vout_chrono_GetHigh(&vout->p->render);
635 picture_Release(peek);
641 /* FIXME a better way for this delay is needed */
642 const mtime_t date_update = vout->p->displayed.date + VOUT_REDISPLAY_DELAY;
643 if (date_update > date || !vout->p->displayed.decoded) {
644 *deadline = vout->p->displayed.decoded ? date_update : VLC_TS_INVALID;
649 *deadline = date - vout_chrono_GetHigh(&vout->p->render);
651 if (*deadline > VOUT_MWAIT_TOLERANCE)
652 *deadline -= VOUT_MWAIT_TOLERANCE;
654 /* If we are too early and can wait, do it */
655 if (date < *deadline && !now)
660 decoded = vout->p->displayed.decoded;
661 vout->p->displayed.decoded = NULL;
663 decoded = picture_fifo_Pop(vout->p->decoder_fifo);
665 if (!is_forced && !vout->p->is_late_dropped) {
666 const mtime_t predicted = date + vout_chrono_GetLow(&vout->p->render);
667 const mtime_t late = predicted - decoded->date;
669 msg_Dbg(vout, "picture might be displayed late (missing %d ms)", (int)(late/1000));
670 if (late > VOUT_DISPLAY_LATE_THRESHOLD) {
671 msg_Warn(vout, "rejected picture because of render time");
673 picture_Release(decoded);
680 vout->p->displayed.is_interlaced = !decoded->b_progressive;
681 vout->p->displayed.qtype = decoded->i_qtype;
683 vout->p->displayed.timestamp = decoded->date;
686 if (vout->p->displayed.decoded)
687 picture_Release(vout->p->displayed.decoded);
688 picture_Hold(decoded);
689 vout->p->displayed.decoded = decoded;
692 vout_chrono_Start(&vout->p->render);
694 picture_t *filtered = NULL;
696 vlc_mutex_lock(&vout->p->vfilter_lock);
697 filtered = filter_chain_VideoFilter(vout->p->vfilter_chain, decoded);
698 //assert(filtered == decoded); // TODO implement
699 vlc_mutex_unlock(&vout->p->vfilter_lock);
705 * Check for subpictures to display
707 const bool do_snapshot = vout_snapshot_IsRequested(&vout->p->snapshot);
708 mtime_t spu_render_time = is_forced ? mdate() : filtered->date;
709 if (vout->p->pause.is_on)
710 spu_render_time = vout->p->pause.date;
712 spu_render_time = filtered->date > 1 ? filtered->date : mdate();
714 subpicture_t *subpic = spu_SortSubpictures(vout->p->p_spu,
721 * - be sure to end up with a direct buffer.
722 * - blend subtitles, and in a fast access buffer
724 picture_t *direct = NULL;
726 (vout->p->decoder_pool != vout->p->display_pool || subpic)) {
728 if (vout->p->is_decoder_pool_slow)
729 render = picture_NewFromFormat(&vd->source);
730 else if (vout->p->decoder_pool != vout->p->display_pool)
731 render = picture_pool_Get(vout->p->display_pool);
733 render = picture_pool_Get(vout->p->private_pool);
736 picture_Copy(render, filtered);
738 spu_RenderSubpictures(vout->p->p_spu,
740 subpic, &vd->source, spu_render_time);
742 if (vout->p->is_decoder_pool_slow) {
743 direct = picture_pool_Get(vout->p->display_pool);
745 picture_Copy(direct, render);
746 picture_Release(render);
751 picture_Release(filtered);
758 * Take a snapshot if requested
760 if (direct && do_snapshot)
761 vout_snapshot_Set(&vout->p->snapshot, &vd->source, direct);
763 /* Render the direct buffer returned by vout_RenderPicture */
765 vout_RenderWrapper(vout, direct);
767 vout_chrono_Stop(&vout->p->render);
772 msg_Info(vout, "render: avg %d ms var %d ms",
773 (int)(vout->p->render.avg/1000), (int)(vout->p->render.var/1000));
778 /* Wait the real date (for rendering jitter) */
780 mwait(decoded->date);
782 /* Display the direct buffer returned by vout_RenderPicture */
783 vout->p->displayed.date = mdate();
785 vout_DisplayWrapper(vout, direct);
791 vout_statistic_Update(&vout->p->statistic, displayed_count, lost_count);
792 if (displayed_count <= 0)
797 static int ThreadManage(vout_thread_t *vout,
799 vout_interlacing_support_t *interlacing,
800 vout_postprocessing_support_t *postprocessing)
802 vlc_mutex_lock(&vout->p->picture_lock);
804 *deadline = VLC_TS_INVALID;
805 ThreadDisplayPicture(vout, false, deadline);
807 const int picture_qtype = vout->p->displayed.qtype;
808 const bool picture_interlaced = vout->p->displayed.is_interlaced;
810 vlc_mutex_unlock(&vout->p->picture_lock);
812 /* Post processing */
813 vout_SetPostProcessingState(vout, postprocessing, picture_qtype);
816 vout_SetInterlacingState(vout, interlacing, picture_interlaced);
818 if (vout_ManageWrapper(vout)) {
819 /* A fatal error occurred, and the thread must terminate
820 * immediately, without displaying anything - setting b_error to 1
821 * causes the immediate end of the main while() loop. */
828 static void ThreadDisplayOsdTitle(vout_thread_t *vout, const char *string)
830 if (!vout->p->title.show)
833 vlc_assert_locked(&vout->p->change_lock);
835 vout_OSDText(vout, SPU_DEFAULT_CHANNEL,
836 vout->p->title.position, INT64_C(1000) * vout->p->title.timeout,
840 static void ThreadChangeFilters(vout_thread_t *vout, const char *filters)
843 es_format_Init(&fmt, VIDEO_ES, vout->p->original.i_chroma);
844 fmt.video = vout->p->original;
846 vlc_mutex_lock(&vout->p->vfilter_lock);
848 filter_chain_Reset(vout->p->vfilter_chain, &fmt, &fmt);
849 if (filter_chain_AppendFromString(vout->p->vfilter_chain,
851 msg_Err(vout, "Video filter chain creation failed");
853 vlc_mutex_unlock(&vout->p->vfilter_lock);
856 static void ThreadChangePause(vout_thread_t *vout, bool is_paused, mtime_t date)
858 vlc_assert_locked(&vout->p->change_lock);
859 assert(!vout->p->pause.is_on || !is_paused);
861 if (vout->p->pause.is_on) {
862 const mtime_t duration = date - vout->p->pause.date;
864 if (vout->p->step.timestamp > VLC_TS_INVALID)
865 vout->p->step.timestamp += duration;
866 if (vout->p->step.last > VLC_TS_INVALID)
867 vout->p->step.last += duration;
868 picture_fifo_OffsetDate(vout->p->decoder_fifo, duration);
869 if (vout->p->displayed.decoded)
870 vout->p->displayed.decoded->date += duration;
872 spu_OffsetSubtitleDate(vout->p->p_spu, duration);
874 vout->p->step.timestamp = VLC_TS_INVALID;
875 vout->p->step.last = VLC_TS_INVALID;
877 vout->p->pause.is_on = is_paused;
878 vout->p->pause.date = date;
881 static void ThreadFlush(vout_thread_t *vout, bool below, mtime_t date)
883 vout->p->step.timestamp = VLC_TS_INVALID;
884 vout->p->step.last = VLC_TS_INVALID;
886 picture_t *last = vout->p->displayed.decoded;
888 if (( below && last->date <= date) ||
889 (!below && last->date >= date)) {
890 picture_Release(last);
892 vout->p->displayed.decoded = NULL;
893 vout->p->displayed.date = VLC_TS_INVALID;
894 vout->p->displayed.timestamp = VLC_TS_INVALID;
897 picture_fifo_Flush(vout->p->decoder_fifo, date, below);
900 static void ThreadReset(vout_thread_t *vout)
902 ThreadFlush(vout, true, INT64_MAX);
903 if (vout->p->decoder_pool)
904 picture_pool_NonEmpty(vout->p->decoder_pool, true);
905 vout->p->pause.is_on = false;
906 vout->p->pause.date = mdate();
909 static void ThreadStep(vout_thread_t *vout, mtime_t *duration)
913 if (vout->p->step.last <= VLC_TS_INVALID)
914 vout->p->step.last = vout->p->displayed.timestamp;
917 if (ThreadDisplayPicture(vout, true, &dummy))
920 vout->p->step.timestamp = vout->p->displayed.timestamp;
922 if (vout->p->step.last > VLC_TS_INVALID &&
923 vout->p->step.timestamp > vout->p->step.last) {
924 *duration = vout->p->step.timestamp - vout->p->step.last;
925 vout->p->step.last = vout->p->step.timestamp;
926 /* TODO advance subpicture by the duration ... */
930 static void ThreadChangeFullscreen(vout_thread_t *vout, bool fullscreen)
932 /* FIXME not sure setting "fullscreen" is good ... */
933 var_SetBool(vout, "fullscreen", fullscreen);
934 vout_SetDisplayFullscreen(vout->p->display.vd, fullscreen);
937 static void ThreadChangeOnTop(vout_thread_t *vout, bool is_on_top)
939 vout_SetWindowState(vout->p->display.vd,
940 is_on_top ? VOUT_WINDOW_STATE_ABOVE :
941 VOUT_WINDOW_STATE_NORMAL);
944 static void ThreadChangeDisplayFilled(vout_thread_t *vout, bool is_filled)
946 vout_SetDisplayFilled(vout->p->display.vd, is_filled);
949 static void ThreadChangeZoom(vout_thread_t *vout, int num, int den)
951 if (num * 10 < den) {
954 } else if (num > den * 10) {
958 vout_SetDisplayZoom(vout->p->display.vd, num, den);
961 static void ThreadChangeAspectRatio(vout_thread_t *vout,
962 unsigned num, unsigned den)
964 const video_format_t *source = &vout->p->original;
966 if (num > 0 && den > 0) {
967 num *= source->i_visible_height;
968 den *= source->i_visible_width;
969 vlc_ureduce(&num, &den, num, den, 0);
971 vout_SetDisplayAspect(vout->p->display.vd, num, den);
975 static void ThreadExecuteCropWindow(vout_thread_t *vout,
976 unsigned crop_num, unsigned crop_den,
977 unsigned x, unsigned y,
978 unsigned width, unsigned height)
980 const video_format_t *source = &vout->p->original;
982 vout_SetDisplayCrop(vout->p->display.vd,
984 source->i_x_offset + x,
985 source->i_y_offset + y,
988 static void ThreadExecuteCropBorder(vout_thread_t *vout,
989 unsigned left, unsigned top,
990 unsigned right, unsigned bottom)
992 const video_format_t *source = &vout->p->original;
993 ThreadExecuteCropWindow(vout, 0, 0,
996 /* At worst, it becomes < 0 (but unsigned) and will be rejected */
997 source->i_visible_width - (left + right),
998 source->i_visible_height - (top + bottom));
1001 static void ThreadExecuteCropRatio(vout_thread_t *vout,
1002 unsigned num, unsigned den)
1004 const video_format_t *source = &vout->p->original;
1008 if (num <= 0 || den <= 0) {
1013 width = source->i_visible_width;
1014 height = source->i_visible_height;
1016 unsigned scaled_width = (uint64_t)source->i_visible_height * num * source->i_sar_den / den / source->i_sar_num;
1017 unsigned scaled_height = (uint64_t)source->i_visible_width * den * source->i_sar_num / num / source->i_sar_den;
1019 if (scaled_width < source->i_visible_width) {
1020 x = (source->i_visible_width - scaled_width) / 2;
1022 width = scaled_width;
1023 height = source->i_visible_height;
1026 y = (source->i_visible_height - scaled_height) / 2;
1027 width = source->i_visible_width;
1028 height = scaled_height;
1031 ThreadExecuteCropWindow(vout, num, den, x, y, width, height);
1034 static void ThreadClean(vout_thread_t *vout)
1036 /* Destroy translation tables */
1037 if (!vout->p->b_error) {
1038 ThreadFlush(vout, true, INT64_MAX);
1039 vout_EndWrapper(vout);
1043 /*****************************************************************************
1044 * Thread: video output thread
1045 *****************************************************************************
1046 * Video output thread. This function does only returns when the thread is
1047 * terminated. It handles the pictures arriving in the video heap and the
1048 * display device events.
1049 *****************************************************************************/
1050 static void *Thread(void *object)
1052 vout_thread_t *vout = object;
1058 has_wrapper = !vout_OpenWrapper(vout, vout->p->psz_module_name);
1060 vlc_mutex_lock(&vout->p->change_lock);
1063 vout->p->b_error = ThreadInit(vout);
1065 vout->p->b_error = true;
1067 /* signal the creation of the vout */
1068 vout->p->b_ready = true;
1069 vlc_cond_signal(&vout->p->change_wait);
1071 if (vout->p->b_error)
1075 vout_interlacing_support_t interlacing = {
1076 .is_interlaced = false,
1079 vout_postprocessing_support_t postprocessing = {
1080 .qtype = QTYPE_NONE,
1084 * Main loop - it is not executed if an error occurred during
1087 mtime_t deadline = VLC_TS_INVALID;
1088 while (!vout->p->b_done && !vout->p->b_error) {
1089 vout_control_cmd_t cmd;
1091 vlc_mutex_unlock(&vout->p->change_lock);
1092 /* FIXME remove thoses ugly timeouts
1094 while (!vout_control_Pop(&vout->p->control, &cmd, deadline, 100000)) {
1095 /* TODO remove the lock when possible (ie when
1096 * vout->p->fmt_* are not protected by it anymore) */
1097 vlc_mutex_lock(&vout->p->change_lock);
1099 case VOUT_CONTROL_OSD_TITLE:
1100 ThreadDisplayOsdTitle(vout, cmd.u.string);
1102 case VOUT_CONTROL_CHANGE_FILTERS:
1103 ThreadChangeFilters(vout, cmd.u.string);
1105 case VOUT_CONTROL_PAUSE:
1106 ThreadChangePause(vout, cmd.u.pause.is_on, cmd.u.pause.date);
1108 case VOUT_CONTROL_FLUSH:
1109 ThreadFlush(vout, false, cmd.u.time);
1111 case VOUT_CONTROL_RESET:
1114 case VOUT_CONTROL_STEP:
1115 ThreadStep(vout, cmd.u.time_ptr);
1117 case VOUT_CONTROL_FULLSCREEN:
1118 ThreadChangeFullscreen(vout, cmd.u.boolean);
1120 case VOUT_CONTROL_ON_TOP:
1121 ThreadChangeOnTop(vout, cmd.u.boolean);
1123 case VOUT_CONTROL_DISPLAY_FILLED:
1124 ThreadChangeDisplayFilled(vout, cmd.u.boolean);
1126 case VOUT_CONTROL_ZOOM:
1127 ThreadChangeZoom(vout, cmd.u.pair.a, cmd.u.pair.b);
1129 case VOUT_CONTROL_ASPECT_RATIO:
1130 ThreadChangeAspectRatio(vout, cmd.u.pair.a, cmd.u.pair.b);
1132 case VOUT_CONTROL_CROP_RATIO:
1133 ThreadExecuteCropRatio(vout, cmd.u.pair.a, cmd.u.pair.b);
1135 case VOUT_CONTROL_CROP_WINDOW:
1136 ThreadExecuteCropWindow(vout, 0, 0,
1137 cmd.u.window.x, cmd.u.window.y,
1138 cmd.u.window.width, cmd.u.window.height);
1140 case VOUT_CONTROL_CROP_BORDER:
1141 ThreadExecuteCropBorder(vout,
1142 cmd.u.border.left, cmd.u.border.top,
1143 cmd.u.border.right, cmd.u.border.bottom);
1148 vlc_mutex_unlock(&vout->p->change_lock);
1149 vout_control_cmd_Clean(&cmd);
1151 vlc_mutex_lock(&vout->p->change_lock);
1154 if (ThreadManage(vout, &deadline,
1155 &interlacing, &postprocessing)) {
1156 vout->p->b_error = true;
1162 * Error loop - wait until the thread destruction is requested
1164 * XXX I wonder if we should periodically clean the decoder_fifo
1165 * or have a way to prevent it filling up.
1167 while (vout->p->b_error && !vout->p->b_done)
1168 vlc_cond_wait(&vout->p->change_wait, &vout->p->change_lock);
1174 /* Detach subpicture unit from both input and vout */
1175 spu_Attach(vout->p->p_spu, VLC_OBJECT(vout), false);
1176 vlc_object_detach(vout->p->p_spu);
1178 vlc_mutex_unlock(&vout->p->change_lock);
1181 vout_CloseWrapper(vout);
1182 vout_control_Dead(&vout->p->control);
1184 /* Destroy the video filters2 */
1185 filter_chain_Delete(vout->p->vfilter_chain);
1190 /*****************************************************************************
1191 * object variables callbacks: a bunch of object variables are used by the
1192 * interfaces to interact with the vout.
1193 *****************************************************************************/
1194 static int FilterCallback( vlc_object_t *p_this, char const *psz_cmd,
1195 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1197 vout_thread_t *p_vout = (vout_thread_t *)p_this;
1198 input_thread_t *p_input;
1199 (void)psz_cmd; (void)oldval; (void)p_data;
1201 p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1205 msg_Err( p_vout, "Input not found" );
1206 return VLC_EGENERIC;
1209 /* Modify input as well because the vout might have to be restarted */
1210 var_Create( p_input, "vout-filter", VLC_VAR_STRING );
1211 var_SetString( p_input, "vout-filter", newval.psz_string );
1213 /* Now restart current video stream */
1214 input_Control( p_input, INPUT_RESTART_ES, -VIDEO_ES );
1215 vlc_object_release( p_input );
1220 /*****************************************************************************
1221 * Video Filter2 stuff
1222 *****************************************************************************/
1223 static int VideoFilter2Callback(vlc_object_t *object, char const *cmd,
1224 vlc_value_t oldval, vlc_value_t newval,
1227 vout_thread_t *vout = (vout_thread_t *)object;
1228 (void)cmd; (void)oldval; (void)data;
1230 vout_control_PushString(&vout->p->control, VOUT_CONTROL_CHANGE_FILTERS,
1236 static void PrintVideoFormat(vout_thread_t *vout,
1237 const char *description,
1238 const video_format_t *fmt)
1240 msg_Dbg(vout, "%s sz %ix%i, of (%i,%i), vsz %ix%i, 4cc %4.4s, sar %i:%i, msk r0x%x g0x%x b0x%x",
1242 fmt->i_width, fmt->i_height, fmt->i_x_offset, fmt->i_y_offset,
1243 fmt->i_visible_width, fmt->i_visible_height,
1244 (char*)&fmt->i_chroma,
1245 fmt->i_sar_num, fmt->i_sar_den,
1246 fmt->i_rmask, fmt->i_gmask, fmt->i_bmask);