]> git.sesse.net Git - vlc/blob - src/video_output/video_output.c
0bf78c8d73653e78a1c37d0812088db94253cbed
[vlc] / src / video_output / video_output.c
1 /*****************************************************************************
2  * video_output.c : video output thread
3  *
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
9  * $Id$
10  *
11  * Authors: Vincent Seguin <seguin@via.ecp.fr>
12  *          Gildas Bazin <gbazin@videolan.org>
13  *          Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
14  *
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.
19  *
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.
24  *
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  *****************************************************************************/
29
30 /*****************************************************************************
31  * Preamble
32  *****************************************************************************/
33 #ifdef HAVE_CONFIG_H
34 # include "config.h"
35 #endif
36
37 #include <vlc_common.h>
38
39 #include <stdlib.h>                                                /* free() */
40 #include <string.h>
41 #include <assert.h>
42
43 #include <vlc_vout.h>
44
45 #include <vlc_filter.h>
46 #include <vlc_vout_osd.h>
47
48 #include <libvlc.h>
49 #include "vout_internal.h"
50 #include "interlacing.h"
51 #include "postprocessing.h"
52 #include "display.h"
53
54 /*****************************************************************************
55  * Local prototypes
56  *****************************************************************************/
57 static void *Thread(void *);
58 static void VoutDestructor(vlc_object_t *);
59
60 /* Maximum delay between 2 displayed pictures.
61  * XXX it is needed for now but should be removed in the long term.
62  */
63 #define VOUT_REDISPLAY_DELAY (INT64_C(80000))
64
65 /**
66  * Late pictures having a delay higher than this value are thrashed.
67  */
68 #define VOUT_DISPLAY_LATE_THRESHOLD (INT64_C(20000))
69
70 /* Better be in advance when awakening than late... */
71 #define VOUT_MWAIT_TOLERANCE (INT64_C(1000))
72
73 /* */
74 static int VoutValidateFormat(video_format_t *dst,
75                               const video_format_t *src)
76 {
77     if (src->i_width <= 0 || src->i_height <= 0)
78         return VLC_EGENERIC;
79     if (src->i_sar_num <= 0 || src->i_sar_den <= 0)
80         return VLC_EGENERIC;
81
82     /* */
83     video_format_Copy(dst, src);
84     dst->i_chroma = vlc_fourcc_GetCodec(VIDEO_ES, src->i_chroma);
85     vlc_ureduce( &dst->i_sar_num, &dst->i_sar_den,
86                  src->i_sar_num,  src->i_sar_den, 50000 );
87     if (dst->i_sar_num <= 0 || dst->i_sar_den <= 0) {
88         dst->i_sar_num = 1;
89         dst->i_sar_den = 1;
90     }
91     video_format_FixRgb(dst);
92     return VLC_SUCCESS;
93 }
94
95 static vout_thread_t *VoutCreate(vlc_object_t *object,
96                                  const vout_configuration_t *cfg)
97 {
98     video_format_t original;
99     if (VoutValidateFormat(&original, cfg->fmt))
100         return NULL;
101
102     /* Allocate descriptor */
103     vout_thread_t *vout = vlc_custom_create(object,
104                                             sizeof(*vout) + sizeof(*vout->p),
105                                             VLC_OBJECT_VOUT, "video output");
106     if (!vout) {
107         video_format_Clean(&original);
108         return NULL;
109     }
110
111     /* */
112     vout->p = (vout_thread_sys_t*)&vout[1];
113
114     vout->p->original = original;
115     vout->p->dpb_size = cfg->dpb_size;
116
117     vout_control_Init(&vout->p->control);
118     vout_control_PushVoid(&vout->p->control, VOUT_CONTROL_INIT);
119
120     vout_statistic_Init(&vout->p->statistic);
121     vout->p->i_par_num =
122     vout->p->i_par_den = 1;
123
124     vout_snapshot_Init(&vout->p->snapshot);
125
126     /* Initialize locks */
127     vlc_mutex_init(&vout->p->picture_lock);
128     vlc_mutex_init(&vout->p->vfilter_lock);
129
130     /* Attach the new object now so we can use var inheritance below */
131     vlc_object_attach(vout, object);
132
133     /* Initialize subpicture unit */
134     vout->p->p_spu = spu_Create(vout);
135
136     /* Take care of some "interface/control" related initialisations */
137     vout_IntfInit(vout);
138
139     /* Get splitter name if present */
140     char *splitter_name = var_GetNonEmptyString(vout, "vout-filter");
141     if (splitter_name) {
142         if (asprintf(&vout->p->splitter_name, "%s,none", splitter_name) < 0)
143             vout->p->splitter_name = NULL;
144         free(splitter_name);
145     } else {
146         vout->p->splitter_name = NULL;
147     }
148
149     /* */
150     vout_InitInterlacingSupport(vout, vout->p->displayed.is_interlaced);
151
152     /* */
153     vlc_object_set_destructor(vout, VoutDestructor);
154
155     /* */
156     if (vlc_clone(&vout->p->thread, Thread, vout,
157                   VLC_THREAD_PRIORITY_OUTPUT)) {
158         vlc_object_release(vout);
159         return NULL;
160     }
161
162     vout_control_WaitEmpty(&vout->p->control);
163
164     if (vout->p->dead) {
165         msg_Err(vout, "video output creation failed");
166         vout_CloseAndRelease(vout);
167         return NULL;
168     }
169
170     vout->p->input = cfg->input;
171     if (vout->p->input)
172         spu_Attach(vout->p->p_spu, vout->p->input, true);
173
174     return vout;
175 }
176
177 vout_thread_t *(vout_Request)(vlc_object_t *object,
178                               const vout_configuration_t *cfg)
179 {
180     vout_thread_t *vout = cfg->vout;
181     if (cfg->change_fmt && !cfg->fmt) {
182         if (vout)
183             vout_CloseAndRelease(vout);
184         return NULL;
185     }
186
187     /* If a vout is provided, try reusing it */
188     if (vout) {
189         if (vout->p->input != cfg->input) {
190             if (vout->p->input)
191                 spu_Attach(vout->p->p_spu, vout->p->input, false);
192             vout->p->input = cfg->input;
193             if (vout->p->input)
194                 spu_Attach(vout->p->p_spu, vout->p->input, true);
195         }
196
197         if (cfg->change_fmt) {
198             vout_control_cmd_t cmd;
199             vout_control_cmd_Init(&cmd, VOUT_CONTROL_REINIT);
200             cmd.u.cfg = cfg;
201
202             vout_control_Push(&vout->p->control, &cmd);
203             vout_control_WaitEmpty(&vout->p->control);
204         }
205
206         if (!vout->p->dead) {
207             msg_Dbg(object, "reusing provided vout");
208             return vout;
209         }
210         vout_CloseAndRelease(vout);
211
212         msg_Warn(object, "cannot reuse provided vout");
213     }
214     return VoutCreate(object, cfg);
215 }
216
217 /*****************************************************************************
218  * vout_Close: Close a vout created by VoutCreate.
219  *****************************************************************************
220  * You HAVE to call it on vout created by VoutCreate before vlc_object_release.
221  * You should NEVER call it on vout not obtained through VoutCreate
222  * (like with vout_Request or vlc_object_find.)
223  * You can use vout_CloseAndRelease() as a convenience method.
224  *****************************************************************************/
225 void vout_Close(vout_thread_t *vout)
226 {
227     assert(vout);
228
229     if (vout->p->input)
230         spu_Attach(vout->p->p_spu, vout->p->input, false);
231     vlc_object_detach(vout->p->p_spu);
232
233     vout_snapshot_End(&vout->p->snapshot);
234
235     vout_control_PushVoid(&vout->p->control, VOUT_CONTROL_CLEAN);
236     vlc_join(vout->p->thread, NULL);
237 }
238
239 /* */
240 static void VoutDestructor(vlc_object_t *object)
241 {
242     vout_thread_t *vout = (vout_thread_t *)object;
243
244     /* Make sure the vout was stopped first */
245     //assert(!vout->p_module);
246
247     free(vout->p->splitter_name);
248
249     /* */
250     spu_Destroy(vout->p->p_spu);
251
252     /* Destroy the locks */
253     vlc_mutex_destroy(&vout->p->picture_lock);
254     vlc_mutex_destroy(&vout->p->vfilter_lock);
255     vout_control_Clean(&vout->p->control);
256
257     /* */
258     vout_statistic_Clean(&vout->p->statistic);
259
260     /* */
261     vout_snapshot_Clean(&vout->p->snapshot);
262
263     video_format_Clean(&vout->p->original);
264 }
265
266 /* */
267 void vout_ChangePause(vout_thread_t *vout, bool is_paused, mtime_t date)
268 {
269     vout_control_cmd_t cmd;
270     vout_control_cmd_Init(&cmd, VOUT_CONTROL_PAUSE);
271     cmd.u.pause.is_on = is_paused;
272     cmd.u.pause.date  = date;
273     vout_control_Push(&vout->p->control, &cmd);
274
275     vout_control_WaitEmpty(&vout->p->control);
276 }
277
278 void vout_GetResetStatistic(vout_thread_t *vout, int *displayed, int *lost)
279 {
280     vout_statistic_GetReset( &vout->p->statistic, displayed, lost );
281 }
282
283 void vout_Flush(vout_thread_t *vout, mtime_t date)
284 {
285     vout_control_PushTime(&vout->p->control, VOUT_CONTROL_FLUSH, date);
286     vout_control_WaitEmpty(&vout->p->control);
287 }
288
289 void vout_Reset(vout_thread_t *vout)
290 {
291     vout_control_PushVoid(&vout->p->control, VOUT_CONTROL_RESET);
292     vout_control_WaitEmpty(&vout->p->control);
293 }
294
295 bool vout_IsEmpty(vout_thread_t *vout)
296 {
297     vlc_mutex_lock(&vout->p->picture_lock);
298
299     picture_t *picture = picture_fifo_Peek(vout->p->decoder_fifo);
300     if (picture)
301         picture_Release(picture);
302
303     vlc_mutex_unlock(&vout->p->picture_lock);
304
305     return !picture;
306 }
307
308 void vout_FixLeaks( vout_thread_t *vout )
309 {
310     vlc_mutex_lock(&vout->p->picture_lock);
311
312     picture_t *picture = picture_fifo_Peek(vout->p->decoder_fifo);
313     if (!picture) {
314         picture = picture_pool_Get(vout->p->decoder_pool);
315     }
316
317     if (picture) {
318         picture_Release(picture);
319         /* Not all pictures has been displayed yet or some are
320          * free */
321         vlc_mutex_unlock(&vout->p->picture_lock);
322         return;
323     }
324
325     /* There is no reason that no pictures are available, force one
326      * from the pool, becarefull with it though */
327     msg_Err(vout, "pictures leaked, trying to workaround");
328
329     /* */
330     picture_pool_NonEmpty(vout->p->decoder_pool, false);
331
332     vlc_mutex_unlock(&vout->p->picture_lock);
333 }
334 void vout_NextPicture(vout_thread_t *vout, mtime_t *duration)
335 {
336     vout_control_cmd_t cmd;
337     vout_control_cmd_Init(&cmd, VOUT_CONTROL_STEP);
338     cmd.u.time_ptr = duration;
339
340     vout_control_Push(&vout->p->control, &cmd);
341     vout_control_WaitEmpty(&vout->p->control);
342 }
343
344 void vout_DisplayTitle(vout_thread_t *vout, const char *title)
345 {
346     assert(title);
347     vout_control_PushString(&vout->p->control, VOUT_CONTROL_OSD_TITLE, title);
348 }
349
350 void vout_PutSubpicture( vout_thread_t *vout, subpicture_t *subpic )
351 {
352     spu_DisplaySubpicture(vout->p->p_spu, subpic);
353 }
354 int vout_RegisterSubpictureChannel( vout_thread_t *vout )
355 {
356     return spu_RegisterChannel(vout->p->p_spu);
357 }
358 void vout_FlushSubpictureChannel( vout_thread_t *vout, int channel )
359 {
360     spu_ClearChannel(vout->p->p_spu, channel);
361 }
362
363 /* vout_Control* are usable by anyone at anytime */
364 void vout_ControlChangeFullscreen(vout_thread_t *vout, bool fullscreen)
365 {
366     vout_control_PushBool(&vout->p->control, VOUT_CONTROL_FULLSCREEN,
367                           fullscreen);
368 }
369 void vout_ControlChangeOnTop(vout_thread_t *vout, bool is_on_top)
370 {
371     vout_control_PushBool(&vout->p->control, VOUT_CONTROL_ON_TOP,
372                           is_on_top);
373 }
374 void vout_ControlChangeDisplayFilled(vout_thread_t *vout, bool is_filled)
375 {
376     vout_control_PushBool(&vout->p->control, VOUT_CONTROL_DISPLAY_FILLED,
377                           is_filled);
378 }
379 void vout_ControlChangeZoom(vout_thread_t *vout, int num, int den)
380 {
381     vout_control_PushPair(&vout->p->control, VOUT_CONTROL_ZOOM,
382                           num, den);
383 }
384 void vout_ControlChangeSampleAspectRatio(vout_thread_t *vout,
385                                          unsigned num, unsigned den)
386 {
387     vout_control_PushPair(&vout->p->control, VOUT_CONTROL_ASPECT_RATIO,
388                           num, den);
389 }
390 void vout_ControlChangeCropRatio(vout_thread_t *vout,
391                                  unsigned num, unsigned den)
392 {
393     vout_control_PushPair(&vout->p->control, VOUT_CONTROL_CROP_RATIO,
394                           num, den);
395 }
396 void vout_ControlChangeCropWindow(vout_thread_t *vout,
397                                   int x, int y, int width, int height)
398 {
399     vout_control_cmd_t cmd;
400     vout_control_cmd_Init(&cmd, VOUT_CONTROL_CROP_WINDOW);
401     cmd.u.window.x      = x;
402     cmd.u.window.y      = y;
403     cmd.u.window.width  = width;
404     cmd.u.window.height = height;
405
406     vout_control_Push(&vout->p->control, &cmd);
407 }
408 void vout_ControlChangeCropBorder(vout_thread_t *vout,
409                                   int left, int top, int right, int bottom)
410 {
411     vout_control_cmd_t cmd;
412     vout_control_cmd_Init(&cmd, VOUT_CONTROL_CROP_BORDER);
413     cmd.u.border.left   = left;
414     cmd.u.border.top    = top;
415     cmd.u.border.right  = right;
416     cmd.u.border.bottom = bottom;
417
418     vout_control_Push(&vout->p->control, &cmd);
419 }
420 void vout_ControlChangeFilters(vout_thread_t *vout, const char *filters)
421 {
422     vout_control_PushString(&vout->p->control, VOUT_CONTROL_CHANGE_FILTERS,
423                             filters);
424 }
425 void vout_ControlChangeSubFilters(vout_thread_t *vout, const char *filters)
426 {
427     vout_control_PushString(&vout->p->control, VOUT_CONTROL_CHANGE_SUB_FILTERS,
428                             filters);
429 }
430
431 /* */
432 static void VoutGetDisplayCfg(vout_thread_t *vout, vout_display_cfg_t *cfg, const char *title)
433 {
434     /* Load configuration */
435     cfg->is_fullscreen = var_CreateGetBool(vout, "fullscreen");
436     cfg->display.title = title;
437     const int display_width = var_CreateGetInteger(vout, "width");
438     const int display_height = var_CreateGetInteger(vout, "height");
439     cfg->display.width   = display_width > 0  ? display_width  : 0;
440     cfg->display.height  = display_height > 0 ? display_height : 0;
441     cfg->is_display_filled  = var_CreateGetBool(vout, "autoscale");
442     cfg->display.sar.num = 1; /* TODO monitor AR */
443     cfg->display.sar.den = 1;
444     unsigned zoom_den = 1000;
445     unsigned zoom_num = zoom_den * var_CreateGetFloat(vout, "scale");
446     vlc_ureduce(&zoom_num, &zoom_den, zoom_num, zoom_den, 0);
447     cfg->zoom.num = zoom_num;
448     cfg->zoom.den = zoom_den;
449     cfg->align.vertical = VOUT_DISPLAY_ALIGN_CENTER;
450     cfg->align.horizontal = VOUT_DISPLAY_ALIGN_CENTER;
451     const int align_mask = var_CreateGetInteger(vout, "align");
452     if (align_mask & 0x1)
453         cfg->align.horizontal = VOUT_DISPLAY_ALIGN_LEFT;
454     else if (align_mask & 0x2)
455         cfg->align.horizontal = VOUT_DISPLAY_ALIGN_RIGHT;
456     if (align_mask & 0x4)
457         cfg->align.horizontal = VOUT_DISPLAY_ALIGN_TOP;
458     else if (align_mask & 0x8)
459         cfg->align.horizontal = VOUT_DISPLAY_ALIGN_BOTTOM;
460 }
461
462 vout_window_t * vout_NewDisplayWindow(vout_thread_t *vout, vout_display_t *vd,
463                                       const vout_window_cfg_t *cfg)
464 {
465     VLC_UNUSED(vd);
466     vout_window_cfg_t cfg_override = *cfg;
467
468     if (!var_InheritBool( vout, "embedded-video"))
469         cfg_override.is_standalone = true;
470
471     if (vout->p->window.is_unused && vout->p->window.object) {
472         assert(!vout->p->splitter_name);
473         if (!cfg_override.is_standalone == !vout->p->window.cfg.is_standalone &&
474             cfg_override.type           == vout->p->window.cfg.type) {
475             /* Reuse the stored window */
476             msg_Dbg(vout, "Reusing previous vout window");
477             vout_window_t *window = vout->p->window.object;
478             if (cfg_override.width  != vout->p->window.cfg.width ||
479                 cfg_override.height != vout->p->window.cfg.height)
480                 vout_window_SetSize(window,
481                                     cfg_override.width, cfg_override.height);
482             vout->p->window.is_unused = false;
483             vout->p->window.cfg       = cfg_override;
484             return window;
485         }
486
487         vout_window_Delete(vout->p->window.object);
488         vout->p->window.is_unused = true;
489         vout->p->window.object    = NULL;
490     }
491
492     vout_window_t *window = vout_window_New(VLC_OBJECT(vout), NULL,
493                                             &cfg_override);
494     if (!window)
495         return NULL;
496     if (!vout->p->splitter_name) {
497         vout->p->window.is_unused = false;
498         vout->p->window.cfg       = cfg_override;
499         vout->p->window.object    = window;
500     }
501     return window;
502 }
503
504 void vout_DeleteDisplayWindow(vout_thread_t *vout, vout_display_t *vd,
505                               vout_window_t *window)
506 {
507     VLC_UNUSED(vd);
508     if (!vout->p->window.is_unused && vout->p->window.object == window) {
509         vout->p->window.is_unused = true;
510     } else if (vout->p->window.is_unused && vout->p->window.object && !window) {
511         vout_window_Delete(vout->p->window.object);
512         vout->p->window.is_unused = true;
513         vout->p->window.object    = NULL;
514     } else if (window) {
515         vout_window_Delete(window);
516     }
517 }
518
519 /* */
520 static picture_t *VoutVideoFilterNewPicture(filter_t *filter)
521 {
522     vout_thread_t *vout = (vout_thread_t*)filter->p_owner;
523     return picture_pool_Get(vout->p->private_pool);
524 }
525 static void VoutVideoFilterDelPicture(filter_t *filter, picture_t *picture)
526 {
527     VLC_UNUSED(filter);
528     picture_Release(picture);
529 }
530 static int VoutVideoFilterAllocationSetup(filter_t *filter, void *data)
531 {
532     filter->pf_video_buffer_new = VoutVideoFilterNewPicture;
533     filter->pf_video_buffer_del = VoutVideoFilterDelPicture;
534     filter->p_owner             = data; /* vout */
535     return VLC_SUCCESS;
536 }
537
538 /* */
539 static int ThreadDisplayPicture(vout_thread_t *vout,
540                                 bool now, mtime_t *deadline)
541 {
542     vout_display_t *vd = vout->p->display.vd;
543     int displayed_count = 0;
544     int lost_count = 0;
545
546     for (;;) {
547         const mtime_t date = mdate();
548         const bool is_paused = vout->p->pause.is_on;
549         bool redisplay = is_paused && !now && vout->p->displayed.decoded;
550         bool is_forced;
551
552         /* FIXME/XXX we must redisplay the last decoded picture (because
553          * of potential vout updated, or filters update or SPU update)
554          * For now a high update period is needed but it coulmd be removed
555          * if and only if:
556          * - vout module emits events from theselves.
557          * - *and* SPU is modified to emit an event or a deadline when needed.
558          *
559          * So it will be done latter.
560          */
561         if (!redisplay) {
562             picture_t *peek = picture_fifo_Peek(vout->p->decoder_fifo);
563             if (peek) {
564                 is_forced = peek->b_force || is_paused || now;
565                 *deadline = (is_forced ? date : peek->date) - vout_chrono_GetHigh(&vout->p->render);
566                 picture_Release(peek);
567             } else {
568                 redisplay = true;
569             }
570         }
571         if (redisplay) {
572              /* FIXME a better way for this delay is needed */
573             const mtime_t date_update = vout->p->displayed.date + VOUT_REDISPLAY_DELAY;
574             if (date_update > date || !vout->p->displayed.decoded) {
575                 *deadline = vout->p->displayed.decoded ? date_update : VLC_TS_INVALID;
576                 break;
577             }
578             /* */
579             is_forced = true;
580             *deadline = date - vout_chrono_GetHigh(&vout->p->render);
581         }
582         if (*deadline > VOUT_MWAIT_TOLERANCE)
583             *deadline -= VOUT_MWAIT_TOLERANCE;
584
585         /* If we are too early and can wait, do it */
586         if (date < *deadline && !now)
587             break;
588
589         picture_t *decoded;
590         if (redisplay) {
591             decoded = vout->p->displayed.decoded;
592             vout->p->displayed.decoded = NULL;
593         } else {
594             decoded = picture_fifo_Pop(vout->p->decoder_fifo);
595             assert(decoded);
596             if (!is_forced && !vout->p->is_late_dropped) {
597                 const mtime_t predicted = date + vout_chrono_GetLow(&vout->p->render);
598                 const mtime_t late = predicted - decoded->date;
599                 if (late > 0) {
600                     msg_Dbg(vout, "picture might be displayed late (missing %d ms)", (int)(late/1000));
601                     if (late > VOUT_DISPLAY_LATE_THRESHOLD) {
602                         msg_Warn(vout, "rejected picture because of render time");
603                         /* TODO */
604                         picture_Release(decoded);
605                         lost_count++;
606                         break;
607                     }
608                 }
609             }
610
611             vout->p->displayed.is_interlaced = !decoded->b_progressive;
612             vout->p->displayed.qtype         = decoded->i_qtype;
613         }
614         vout->p->displayed.timestamp = decoded->date;
615
616         /* */
617         if (vout->p->displayed.decoded)
618             picture_Release(vout->p->displayed.decoded);
619         picture_Hold(decoded);
620         vout->p->displayed.decoded = decoded;
621
622         /* */
623         vout_chrono_Start(&vout->p->render);
624
625         picture_t *filtered = NULL;
626         if (decoded) {
627             vlc_mutex_lock(&vout->p->vfilter_lock);
628             filtered = filter_chain_VideoFilter(vout->p->vfilter_chain, decoded);
629             //assert(filtered == decoded); // TODO implement
630             vlc_mutex_unlock(&vout->p->vfilter_lock);
631             if (!filtered)
632                 continue;
633         }
634
635         /*
636          * Check for subpictures to display
637          */
638         const bool do_snapshot = vout_snapshot_IsRequested(&vout->p->snapshot);
639         mtime_t spu_render_time = is_forced ? mdate() : filtered->date;
640         if (vout->p->pause.is_on)
641             spu_render_time = vout->p->pause.date;
642         else
643             spu_render_time = filtered->date > 1 ? filtered->date : mdate();
644
645         subpicture_t *subpic = spu_SortSubpictures(vout->p->p_spu,
646                                                    spu_render_time,
647                                                    do_snapshot);
648         /*
649          * Perform rendering
650          *
651          * We have to:
652          * - be sure to end up with a direct buffer.
653          * - blend subtitles, and in a fast access buffer
654          */
655         picture_t *direct = NULL;
656         if (filtered &&
657             (vout->p->decoder_pool != vout->p->display_pool || subpic)) {
658             picture_t *render;
659             if (vout->p->is_decoder_pool_slow)
660                 render = picture_NewFromFormat(&vd->source);
661             else if (vout->p->decoder_pool != vout->p->display_pool)
662                 render = picture_pool_Get(vout->p->display_pool);
663             else
664                 render = picture_pool_Get(vout->p->private_pool);
665
666             if (render) {
667                 picture_Copy(render, filtered);
668
669                 spu_RenderSubpictures(vout->p->p_spu,
670                                       render, &vd->source,
671                                       subpic, &vd->source, spu_render_time);
672             }
673             if (vout->p->is_decoder_pool_slow) {
674                 direct = picture_pool_Get(vout->p->display_pool);
675                 if (direct)
676                     picture_Copy(direct, render);
677                 picture_Release(render);
678
679             } else {
680                 direct = render;
681             }
682             picture_Release(filtered);
683             filtered = NULL;
684         } else {
685             direct = filtered;
686         }
687
688         /*
689          * Take a snapshot if requested
690          */
691         if (direct && do_snapshot)
692             vout_snapshot_Set(&vout->p->snapshot, &vd->source, direct);
693
694         /* Render the direct buffer returned by vout_RenderPicture */
695         if (direct) {
696             vout_RenderWrapper(vout, direct);
697
698             vout_chrono_Stop(&vout->p->render);
699 #if 0
700             {
701             static int i = 0;
702             if (((i++)%10) == 0)
703                 msg_Info(vout, "render: avg %d ms var %d ms",
704                          (int)(vout->p->render.avg/1000), (int)(vout->p->render.var/1000));
705             }
706 #endif
707         }
708
709         /* Wait the real date (for rendering jitter) */
710         if (!is_forced)
711             mwait(decoded->date);
712
713         /* Display the direct buffer returned by vout_RenderPicture */
714         vout->p->displayed.date = mdate();
715         if (direct)
716             vout_DisplayWrapper(vout, direct);
717
718         displayed_count++;
719         break;
720     }
721
722     vout_statistic_Update(&vout->p->statistic, displayed_count, lost_count);
723     if (displayed_count <= 0)
724         return VLC_EGENERIC;
725     return VLC_SUCCESS;
726 }
727
728 static void ThreadManage(vout_thread_t *vout,
729                          mtime_t *deadline,
730                          vout_interlacing_support_t *interlacing,
731                          vout_postprocessing_support_t *postprocessing)
732 {
733     vlc_mutex_lock(&vout->p->picture_lock);
734
735     *deadline = VLC_TS_INVALID;
736     ThreadDisplayPicture(vout, false, deadline);
737
738     const int  picture_qtype      = vout->p->displayed.qtype;
739     const bool picture_interlaced = vout->p->displayed.is_interlaced;
740
741     vlc_mutex_unlock(&vout->p->picture_lock);
742
743     /* Post processing */
744     vout_SetPostProcessingState(vout, postprocessing, picture_qtype);
745
746     /* Deinterlacing */
747     vout_SetInterlacingState(vout, interlacing, picture_interlaced);
748
749     vout_ManageWrapper(vout);
750 }
751
752 static void ThreadDisplayOsdTitle(vout_thread_t *vout, const char *string)
753 {
754     if (!vout->p->title.show)
755         return;
756
757     vout_OSDText(vout, SPU_DEFAULT_CHANNEL,
758                  vout->p->title.position, INT64_C(1000) * vout->p->title.timeout,
759                  string);
760 }
761
762 static void ThreadChangeFilters(vout_thread_t *vout, const char *filters)
763 {
764     es_format_t fmt;
765     es_format_Init(&fmt, VIDEO_ES, vout->p->original.i_chroma);
766     fmt.video = vout->p->original;
767
768     vlc_mutex_lock(&vout->p->vfilter_lock);
769
770     filter_chain_Reset(vout->p->vfilter_chain, &fmt, &fmt);
771     if (filter_chain_AppendFromString(vout->p->vfilter_chain,
772                                       filters) < 0)
773         msg_Err(vout, "Video filter chain creation failed");
774
775     vlc_mutex_unlock(&vout->p->vfilter_lock);
776 }
777
778 static void ThreadChangeSubFilters(vout_thread_t *vout, const char *filters)
779 {
780     spu_ChangeFilters(vout->p->p_spu, filters);
781 }
782
783 static void ThreadChangePause(vout_thread_t *vout, bool is_paused, mtime_t date)
784 {
785     assert(!vout->p->pause.is_on || !is_paused);
786
787     if (vout->p->pause.is_on) {
788         const mtime_t duration = date - vout->p->pause.date;
789
790         if (vout->p->step.timestamp > VLC_TS_INVALID)
791             vout->p->step.timestamp += duration;
792         if (vout->p->step.last > VLC_TS_INVALID)
793             vout->p->step.last += duration;
794         picture_fifo_OffsetDate(vout->p->decoder_fifo, duration);
795         if (vout->p->displayed.decoded)
796             vout->p->displayed.decoded->date += duration;
797
798         spu_OffsetSubtitleDate(vout->p->p_spu, duration);
799     } else {
800         vout->p->step.timestamp = VLC_TS_INVALID;
801         vout->p->step.last      = VLC_TS_INVALID;
802     }
803     vout->p->pause.is_on = is_paused;
804     vout->p->pause.date  = date;
805 }
806
807 static void ThreadFlush(vout_thread_t *vout, bool below, mtime_t date)
808 {
809     vout->p->step.timestamp = VLC_TS_INVALID;
810     vout->p->step.last      = VLC_TS_INVALID;
811
812     picture_t *last = vout->p->displayed.decoded;
813     if (last) {
814         if (( below && last->date <= date) ||
815             (!below && last->date >= date)) {
816             picture_Release(last);
817
818             vout->p->displayed.decoded   = NULL;
819             vout->p->displayed.date      = VLC_TS_INVALID;
820             vout->p->displayed.timestamp = VLC_TS_INVALID;
821         }
822     }
823     picture_fifo_Flush(vout->p->decoder_fifo, date, below);
824 }
825
826 static void ThreadReset(vout_thread_t *vout)
827 {
828     ThreadFlush(vout, true, INT64_MAX);
829     if (vout->p->decoder_pool)
830         picture_pool_NonEmpty(vout->p->decoder_pool, true);
831     vout->p->pause.is_on = false;
832     vout->p->pause.date  = mdate();
833 }
834
835 static void ThreadStep(vout_thread_t *vout, mtime_t *duration)
836 {
837     *duration = 0;
838
839     if (vout->p->step.last <= VLC_TS_INVALID)
840         vout->p->step.last = vout->p->displayed.timestamp;
841
842     mtime_t dummy;
843     if (ThreadDisplayPicture(vout, true, &dummy))
844         return;
845
846     vout->p->step.timestamp = vout->p->displayed.timestamp;
847
848     if (vout->p->step.last > VLC_TS_INVALID &&
849         vout->p->step.timestamp > vout->p->step.last) {
850         *duration = vout->p->step.timestamp - vout->p->step.last;
851         vout->p->step.last = vout->p->step.timestamp;
852         /* TODO advance subpicture by the duration ... */
853     }
854 }
855
856 static void ThreadChangeFullscreen(vout_thread_t *vout, bool fullscreen)
857 {
858     /* FIXME not sure setting "fullscreen" is good ... */
859     var_SetBool(vout, "fullscreen", fullscreen);
860     vout_SetDisplayFullscreen(vout->p->display.vd, fullscreen);
861 }
862
863 static void ThreadChangeOnTop(vout_thread_t *vout, bool is_on_top)
864 {
865     vout_SetWindowState(vout->p->display.vd,
866                         is_on_top ? VOUT_WINDOW_STATE_ABOVE :
867                                     VOUT_WINDOW_STATE_NORMAL);
868 }
869
870 static void ThreadChangeDisplayFilled(vout_thread_t *vout, bool is_filled)
871 {
872     vout_SetDisplayFilled(vout->p->display.vd, is_filled);
873 }
874
875 static void ThreadChangeZoom(vout_thread_t *vout, int num, int den)
876 {
877     if (num * 10 < den) {
878         num = den;
879         den *= 10;
880     } else if (num > den * 10) {
881         num = den * 10;
882     }
883
884     vout_SetDisplayZoom(vout->p->display.vd, num, den);
885 }
886
887 static void ThreadChangeAspectRatio(vout_thread_t *vout,
888                                     unsigned num, unsigned den)
889 {
890     const video_format_t *source = &vout->p->original;
891
892     if (num > 0 && den > 0) {
893         num *= source->i_visible_height;
894         den *= source->i_visible_width;
895         vlc_ureduce(&num, &den, num, den, 0);
896     }
897     vout_SetDisplayAspect(vout->p->display.vd, num, den);
898 }
899
900
901 static void ThreadExecuteCropWindow(vout_thread_t *vout,
902                                     unsigned crop_num, unsigned crop_den,
903                                     unsigned x, unsigned y,
904                                     unsigned width, unsigned height)
905 {
906     const video_format_t *source = &vout->p->original;
907
908     vout_SetDisplayCrop(vout->p->display.vd,
909                         crop_num, crop_den,
910                         source->i_x_offset + x,
911                         source->i_y_offset + y,
912                         width, height);
913 }
914 static void ThreadExecuteCropBorder(vout_thread_t *vout,
915                                     unsigned left, unsigned top,
916                                     unsigned right, unsigned bottom)
917 {
918     const video_format_t *source = &vout->p->original;
919     ThreadExecuteCropWindow(vout, 0, 0,
920                             left,
921                             top,
922                             /* At worst, it becomes < 0 (but unsigned) and will be rejected */
923                             source->i_visible_width  - (left + right),
924                             source->i_visible_height - (top  + bottom));
925 }
926
927 static void ThreadExecuteCropRatio(vout_thread_t *vout,
928                                    unsigned num, unsigned den)
929 {
930     const video_format_t *source = &vout->p->original;
931     ThreadExecuteCropWindow(vout, num, den,
932                             0, 0,
933                             source->i_visible_width,
934                             source->i_visible_height);
935 }
936
937 static int ThreadStart(vout_thread_t *vout, const vout_display_state_t *state)
938 {
939     vlc_mouse_Init(&vout->p->mouse);
940     vout->p->decoder_fifo = picture_fifo_New();
941     vout->p->decoder_pool = NULL;
942     vout->p->display_pool = NULL;
943     vout->p->private_pool = NULL;
944
945     vout->p->vfilter_chain =
946         filter_chain_New( vout, "video filter2", false,
947                           VoutVideoFilterAllocationSetup, NULL, vout);
948
949     vout_display_state_t state_default;
950     if (!state) {
951         VoutGetDisplayCfg(vout, &state_default.cfg, vout->p->display.title);
952         state_default.wm_state = var_CreateGetBool(vout, "video-on-top") ? VOUT_WINDOW_STATE_ABOVE :
953                                                                            VOUT_WINDOW_STATE_NORMAL;
954         state_default.sar.num = 0;
955         state_default.sar.den = 0;
956
957         state = &state_default;
958     }
959
960     if (vout_OpenWrapper(vout, vout->p->splitter_name, state))
961         return VLC_EGENERIC;
962     if (vout_InitWrapper(vout))
963         return VLC_EGENERIC;
964     assert(vout->p->decoder_pool);
965
966     vout->p->displayed.decoded       = NULL;
967     vout->p->displayed.date          = VLC_TS_INVALID;
968     vout->p->displayed.decoded       = NULL;
969     vout->p->displayed.timestamp     = VLC_TS_INVALID;
970     vout->p->displayed.qtype         = QTYPE_NONE;
971     vout->p->displayed.is_interlaced = false;
972
973     vout->p->step.last               = VLC_TS_INVALID;
974     vout->p->step.timestamp          = VLC_TS_INVALID;
975
976     video_format_Print(VLC_OBJECT(vout), "original format", &vout->p->original);
977     return VLC_SUCCESS;
978 }
979
980 static void ThreadStop(vout_thread_t *vout, vout_display_state_t *state)
981 {
982     /* Destroy the video filters2 */
983     filter_chain_Delete(vout->p->vfilter_chain);
984
985     /* Destroy translation tables */
986     if (vout->p->display.vd) {
987         if (vout->p->decoder_pool) {
988             ThreadFlush(vout, true, INT64_MAX);
989             vout_EndWrapper(vout);
990         }
991         vout_CloseWrapper(vout, state);
992     }
993
994     if (vout->p->decoder_fifo)
995         picture_fifo_Delete(vout->p->decoder_fifo);
996     assert(!vout->p->decoder_pool);
997 }
998
999 static void ThreadInit(vout_thread_t *vout)
1000 {
1001     vout->p->window.is_unused = true;
1002     vout->p->window.object    = NULL;
1003     vout->p->dead             = false;
1004     vout->p->is_late_dropped  = var_InheritBool(vout, "drop-late-frames");
1005     vout->p->pause.is_on      = false;
1006     vout->p->pause.date       = VLC_TS_INVALID;
1007
1008     vout_chrono_Init(&vout->p->render, 5, 10000); /* Arbitrary initial time */
1009 }
1010
1011 static void ThreadClean(vout_thread_t *vout)
1012 {
1013     if (vout->p->window.object) {
1014         assert(vout->p->window.is_unused);
1015         vout_window_Delete(vout->p->window.object);
1016     }
1017     vout_chrono_Clean(&vout->p->render);
1018     vout->p->dead = true;
1019     vout_control_Dead(&vout->p->control);
1020 }
1021
1022 static int ThreadReinit(vout_thread_t *vout,
1023                         const vout_configuration_t *cfg)
1024 {
1025     video_format_t original;
1026     if (VoutValidateFormat(&original, cfg->fmt)) {
1027         ThreadStop(vout, NULL);
1028         ThreadClean(vout);
1029         return VLC_EGENERIC;
1030     }
1031     if (video_format_IsSimilar(&original, &vout->p->original)) {
1032         if (cfg->dpb_size <= vout->p->dpb_size)
1033             return VLC_SUCCESS;
1034         msg_Warn(vout, "DPB need to be increased");
1035     }
1036
1037     vout_display_state_t state;
1038     memset(&state, 0, sizeof(state));
1039
1040     ThreadStop(vout, &state);
1041
1042     if (!state.cfg.is_fullscreen) {
1043         state.cfg.display.width  = 0;
1044         state.cfg.display.height = 0;
1045     }
1046     state.sar.num = 0;
1047     state.sar.den = 0;
1048     /* FIXME current vout "variables" are not in sync here anymore
1049      * and I am not sure what to do */
1050
1051     vout->p->original = original;
1052     vout->p->dpb_size = cfg->dpb_size;
1053     if (ThreadStart(vout, &state)) {
1054         ThreadClean(vout);
1055         return VLC_EGENERIC;
1056     }
1057     return VLC_SUCCESS;
1058 }
1059
1060 /*****************************************************************************
1061  * Thread: video output thread
1062  *****************************************************************************
1063  * Video output thread. This function does only returns when the thread is
1064  * terminated. It handles the pictures arriving in the video heap and the
1065  * display device events.
1066  *****************************************************************************/
1067 static void *Thread(void *object)
1068 {
1069     vout_thread_t *vout = object;
1070
1071     vout_interlacing_support_t interlacing = {
1072         .is_interlaced = false,
1073         .date = mdate(),
1074     };
1075     vout_postprocessing_support_t postprocessing = {
1076         .qtype = QTYPE_NONE,
1077     };
1078
1079     mtime_t deadline = VLC_TS_INVALID;
1080     for (;;) {
1081         vout_control_cmd_t cmd;
1082
1083         /* FIXME remove thoses ugly timeouts
1084          */
1085         while (!vout_control_Pop(&vout->p->control, &cmd, deadline, 100000)) {
1086             switch(cmd.type) {
1087             case VOUT_CONTROL_INIT:
1088                 ThreadInit(vout);
1089                 if (ThreadStart(vout, NULL)) {
1090                     ThreadStop(vout, NULL);
1091                     ThreadClean(vout);
1092                     return NULL;
1093                 }
1094                 break;
1095             case VOUT_CONTROL_CLEAN:
1096                 ThreadStop(vout, NULL);
1097                 ThreadClean(vout);
1098                 return NULL;
1099             case VOUT_CONTROL_REINIT:
1100                 if (ThreadReinit(vout, cmd.u.cfg))
1101                     return NULL;
1102                 break;
1103             case VOUT_CONTROL_OSD_TITLE:
1104                 ThreadDisplayOsdTitle(vout, cmd.u.string);
1105                 break;
1106             case VOUT_CONTROL_CHANGE_FILTERS:
1107                 ThreadChangeFilters(vout, cmd.u.string);
1108                 break;
1109             case VOUT_CONTROL_CHANGE_SUB_FILTERS:
1110                 ThreadChangeSubFilters(vout, cmd.u.string);
1111                 break;
1112             case VOUT_CONTROL_PAUSE:
1113                 ThreadChangePause(vout, cmd.u.pause.is_on, cmd.u.pause.date);
1114                 break;
1115             case VOUT_CONTROL_FLUSH:
1116                 ThreadFlush(vout, false, cmd.u.time);
1117                 break;
1118             case VOUT_CONTROL_RESET:
1119                 ThreadReset(vout);
1120                 break;
1121             case VOUT_CONTROL_STEP:
1122                 ThreadStep(vout, cmd.u.time_ptr);
1123                 break;
1124             case VOUT_CONTROL_FULLSCREEN:
1125                 ThreadChangeFullscreen(vout, cmd.u.boolean);
1126                 break;
1127             case VOUT_CONTROL_ON_TOP:
1128                 ThreadChangeOnTop(vout, cmd.u.boolean);
1129                 break;
1130             case VOUT_CONTROL_DISPLAY_FILLED:
1131                 ThreadChangeDisplayFilled(vout, cmd.u.boolean);
1132                 break;
1133             case VOUT_CONTROL_ZOOM:
1134                 ThreadChangeZoom(vout, cmd.u.pair.a, cmd.u.pair.b);
1135                 break;
1136             case VOUT_CONTROL_ASPECT_RATIO:
1137                 ThreadChangeAspectRatio(vout, cmd.u.pair.a, cmd.u.pair.b);
1138                 break;
1139            case VOUT_CONTROL_CROP_RATIO:
1140                 ThreadExecuteCropRatio(vout, cmd.u.pair.a, cmd.u.pair.b);
1141                 break;
1142             case VOUT_CONTROL_CROP_WINDOW:
1143                 ThreadExecuteCropWindow(vout, 0, 0,
1144                                         cmd.u.window.x, cmd.u.window.y,
1145                                         cmd.u.window.width, cmd.u.window.height);
1146                 break;
1147             case VOUT_CONTROL_CROP_BORDER:
1148                 ThreadExecuteCropBorder(vout,
1149                                         cmd.u.border.left,  cmd.u.border.top,
1150                                         cmd.u.border.right, cmd.u.border.bottom);
1151                 break;
1152             default:
1153                 break;
1154             }
1155             vout_control_cmd_Clean(&cmd);
1156         }
1157
1158         ThreadManage(vout, &deadline, &interlacing, &postprocessing);
1159     }
1160 }
1161