filter_chain: introduce dedicated filter_chain_NewVideo() for video filters
[vlc.git] / 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 VLC authors and VideoLAN
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 it
16  * under the terms of the GNU Lesser General Public License as published by
17  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
24  *
25  * You should have received a copy of the GNU Lesser General Public License
26  * along with this program; if not, write to the Free Software Foundation,
27  * 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 #include <vlc_image.h>
48
49 #include <libvlc.h>
50 #include "vout_internal.h"
51 #include "interlacing.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(4000))
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_width  > 8192 ||
78         src->i_height <= 0 || src->i_height > 8192)
79         return VLC_EGENERIC;
80     if (src->i_sar_num <= 0 || src->i_sar_den <= 0)
81         return VLC_EGENERIC;
82
83     /* */
84     video_format_Copy(dst, src);
85     dst->i_chroma = vlc_fourcc_GetCodec(VIDEO_ES, src->i_chroma);
86     vlc_ureduce( &dst->i_sar_num, &dst->i_sar_den,
87                  src->i_sar_num,  src->i_sar_den, 50000 );
88     if (dst->i_sar_num <= 0 || dst->i_sar_den <= 0) {
89         dst->i_sar_num = 1;
90         dst->i_sar_den = 1;
91     }
92     video_format_FixRgb(dst);
93     return VLC_SUCCESS;
94 }
95 static void VideoFormatCopyCropAr(video_format_t *dst,
96                                   const video_format_t *src)
97 {
98     video_format_CopyCrop(dst, src);
99     dst->i_sar_num = src->i_sar_num;
100     dst->i_sar_den = src->i_sar_den;
101 }
102 static bool VideoFormatIsCropArEqual(video_format_t *dst,
103                                      const video_format_t *src)
104 {
105     return dst->i_sar_num * src->i_sar_den == dst->i_sar_den * src->i_sar_num &&
106            dst->i_x_offset       == src->i_x_offset &&
107            dst->i_y_offset       == src->i_y_offset &&
108            dst->i_visible_width  == src->i_visible_width &&
109            dst->i_visible_height == src->i_visible_height;
110 }
111
112 static vout_thread_t *VoutCreate(vlc_object_t *object,
113                                  const vout_configuration_t *cfg)
114 {
115     video_format_t original;
116     if (VoutValidateFormat(&original, cfg->fmt))
117         return NULL;
118
119     /* Allocate descriptor */
120     vout_thread_t *vout = vlc_custom_create(object,
121                                             sizeof(*vout) + sizeof(*vout->p),
122                                             "video output");
123     if (!vout) {
124         video_format_Clean(&original);
125         return NULL;
126     }
127
128     /* */
129     vout->p = (vout_thread_sys_t*)&vout[1];
130
131     vout->p->original = original;
132     vout->p->dpb_size = cfg->dpb_size;
133
134     vout_control_Init(&vout->p->control);
135     vout_control_PushVoid(&vout->p->control, VOUT_CONTROL_INIT);
136
137     vout_statistic_Init(&vout->p->statistic);
138
139     vout_snapshot_Init(&vout->p->snapshot);
140
141     /* Initialize locks */
142     vlc_mutex_init(&vout->p->picture_lock);
143     vlc_mutex_init(&vout->p->filter.lock);
144     vlc_mutex_init(&vout->p->spu_lock);
145
146     /* Initialize subpicture unit */
147     vout->p->spu = spu_Create(vout);
148
149     /* Take care of some "interface/control" related initialisations */
150     vout_IntfInit(vout);
151
152     vout->p->title.show     = var_InheritBool(vout, "video-title-show");
153     vout->p->title.timeout  = var_InheritInteger(vout, "video-title-timeout");
154     vout->p->title.position = var_InheritInteger(vout, "video-title-position");
155
156     /* Get splitter name if present */
157     char *splitter_name = var_InheritString(vout, "video-splitter");
158     if (splitter_name && *splitter_name) {
159         vout->p->splitter_name = splitter_name;
160     } else {
161         free(splitter_name);
162     }
163
164     /* */
165     vout_InitInterlacingSupport(vout, vout->p->displayed.is_interlaced);
166
167     /* */
168     vlc_object_set_destructor(vout, VoutDestructor);
169
170     /* */
171     if (vlc_clone(&vout->p->thread, Thread, vout,
172                   VLC_THREAD_PRIORITY_OUTPUT)) {
173         spu_Destroy(vout->p->spu);
174         vlc_object_release(vout);
175         return NULL;
176     }
177
178     vout_control_WaitEmpty(&vout->p->control);
179
180     if (vout->p->dead) {
181         msg_Err(vout, "video output creation failed");
182         vout_CloseAndRelease(vout);
183         return NULL;
184     }
185
186     vout->p->input = cfg->input;
187     if (vout->p->input)
188         spu_Attach(vout->p->spu, vout->p->input, true);
189
190     return vout;
191 }
192
193 #undef vout_Request
194 vout_thread_t *vout_Request(vlc_object_t *object,
195                               const vout_configuration_t *cfg)
196 {
197     vout_thread_t *vout = cfg->vout;
198     if (cfg->change_fmt && !cfg->fmt) {
199         if (vout)
200             vout_CloseAndRelease(vout);
201         return NULL;
202     }
203
204     /* If a vout is provided, try reusing it */
205     if (vout) {
206         if (vout->p->input != cfg->input) {
207             if (vout->p->input)
208                 spu_Attach(vout->p->spu, vout->p->input, false);
209             vout->p->input = cfg->input;
210             if (vout->p->input)
211                 spu_Attach(vout->p->spu, vout->p->input, true);
212         }
213
214         if (cfg->change_fmt) {
215             vout_control_cmd_t cmd;
216             vout_control_cmd_Init(&cmd, VOUT_CONTROL_REINIT);
217             cmd.u.cfg = cfg;
218
219             vout_control_Push(&vout->p->control, &cmd);
220             vout_control_WaitEmpty(&vout->p->control);
221         }
222
223         if (!vout->p->dead) {
224             msg_Dbg(object, "reusing provided vout");
225             vout_IntfReinit(vout);
226             return vout;
227         }
228         vout_CloseAndRelease(vout);
229
230         msg_Warn(object, "cannot reuse provided vout");
231     }
232     return VoutCreate(object, cfg);
233 }
234
235 void vout_Close(vout_thread_t *vout)
236 {
237     assert(vout);
238
239     if (vout->p->input)
240         spu_Attach(vout->p->spu, vout->p->input, false);
241
242     vout_snapshot_End(&vout->p->snapshot);
243
244     vout_control_PushVoid(&vout->p->control, VOUT_CONTROL_CLEAN);
245     vlc_join(vout->p->thread, NULL);
246
247     vlc_mutex_lock(&vout->p->spu_lock);
248     spu_Destroy(vout->p->spu);
249     vout->p->spu = NULL;
250     vlc_mutex_unlock(&vout->p->spu_lock);
251 }
252
253 /* */
254 static void VoutDestructor(vlc_object_t *object)
255 {
256     vout_thread_t *vout = (vout_thread_t *)object;
257
258     /* Make sure the vout was stopped first */
259     //assert(!vout->p_module);
260
261     free(vout->p->splitter_name);
262
263     /* Destroy the locks */
264     vlc_mutex_destroy(&vout->p->spu_lock);
265     vlc_mutex_destroy(&vout->p->picture_lock);
266     vlc_mutex_destroy(&vout->p->filter.lock);
267     vout_control_Clean(&vout->p->control);
268
269     /* */
270     vout_statistic_Clean(&vout->p->statistic);
271
272     /* */
273     vout_snapshot_Clean(&vout->p->snapshot);
274
275     video_format_Clean(&vout->p->original);
276 }
277
278 /* */
279 void vout_ChangePause(vout_thread_t *vout, bool is_paused, mtime_t date)
280 {
281     vout_control_cmd_t cmd;
282     vout_control_cmd_Init(&cmd, VOUT_CONTROL_PAUSE);
283     cmd.u.pause.is_on = is_paused;
284     cmd.u.pause.date  = date;
285     vout_control_Push(&vout->p->control, &cmd);
286
287     vout_control_WaitEmpty(&vout->p->control);
288 }
289
290 void vout_GetResetStatistic(vout_thread_t *vout, int *displayed, int *lost)
291 {
292     vout_statistic_GetReset( &vout->p->statistic, displayed, lost );
293 }
294
295 void vout_Flush(vout_thread_t *vout, mtime_t date)
296 {
297     vout_control_PushTime(&vout->p->control, VOUT_CONTROL_FLUSH, date);
298     vout_control_WaitEmpty(&vout->p->control);
299 }
300
301 void vout_Reset(vout_thread_t *vout)
302 {
303     vout_control_PushVoid(&vout->p->control, VOUT_CONTROL_RESET);
304     vout_control_WaitEmpty(&vout->p->control);
305 }
306
307 bool vout_IsEmpty(vout_thread_t *vout)
308 {
309     vlc_mutex_lock(&vout->p->picture_lock);
310
311     picture_t *picture = picture_fifo_Peek(vout->p->decoder_fifo);
312     if (picture)
313         picture_Release(picture);
314
315     vlc_mutex_unlock(&vout->p->picture_lock);
316
317     return !picture;
318 }
319
320 void vout_FixLeaks( vout_thread_t *vout )
321 {
322     vlc_mutex_lock(&vout->p->picture_lock);
323
324     picture_t *picture = picture_fifo_Peek(vout->p->decoder_fifo);
325     if (!picture) {
326         picture = picture_pool_Get(vout->p->decoder_pool);
327     }
328
329     if (picture) {
330         picture_Release(picture);
331         /* Not all pictures has been displayed yet or some are
332          * free */
333         vlc_mutex_unlock(&vout->p->picture_lock);
334         return;
335     }
336
337     /* There is no reason that no pictures are available, force one
338      * from the pool, becarefull with it though */
339     msg_Err(vout, "pictures leaked, trying to workaround");
340
341     /* */
342     picture_pool_NonEmpty(vout->p->decoder_pool, false);
343
344     vlc_mutex_unlock(&vout->p->picture_lock);
345 }
346 void vout_NextPicture(vout_thread_t *vout, mtime_t *duration)
347 {
348     vout_control_cmd_t cmd;
349     vout_control_cmd_Init(&cmd, VOUT_CONTROL_STEP);
350     cmd.u.time_ptr = duration;
351
352     vout_control_Push(&vout->p->control, &cmd);
353     vout_control_WaitEmpty(&vout->p->control);
354 }
355
356 void vout_DisplayTitle(vout_thread_t *vout, const char *title)
357 {
358     assert(title);
359     vout_control_PushString(&vout->p->control, VOUT_CONTROL_OSD_TITLE, title);
360 }
361
362 void vout_PutSubpicture( vout_thread_t *vout, subpicture_t *subpic )
363 {
364     vout_control_cmd_t cmd;
365     vout_control_cmd_Init(&cmd, VOUT_CONTROL_SUBPICTURE);
366     cmd.u.subpicture = subpic;
367
368     vout_control_Push(&vout->p->control, &cmd);
369 }
370 int vout_RegisterSubpictureChannel( vout_thread_t *vout )
371 {
372     int channel = SPU_DEFAULT_CHANNEL;
373
374     vlc_mutex_lock(&vout->p->spu_lock);
375     if (vout->p->spu)
376         channel = spu_RegisterChannel(vout->p->spu);
377     vlc_mutex_unlock(&vout->p->spu_lock);
378
379     return channel;
380 }
381 void vout_FlushSubpictureChannel( vout_thread_t *vout, int channel )
382 {
383     vout_control_PushInteger(&vout->p->control, VOUT_CONTROL_FLUSH_SUBPICTURE,
384                              channel);
385 }
386
387 /**
388  * It retreives a picture from the vout or NULL if no pictures are
389  * available yet.
390  *
391  * You MUST call vout_PutPicture or vout_ReleasePicture on it.
392  *
393  * You may use vout_HoldPicture(paired with vout_ReleasePicture) to keep a
394  * read-only reference.
395  */
396 picture_t *vout_GetPicture(vout_thread_t *vout)
397 {
398     /* Get lock */
399     vlc_mutex_lock(&vout->p->picture_lock);
400     picture_t *picture = picture_pool_Get(vout->p->decoder_pool);
401     if (picture) {
402         picture_Reset(picture);
403         VideoFormatCopyCropAr(&picture->format, &vout->p->original);
404     }
405     vlc_mutex_unlock(&vout->p->picture_lock);
406
407     return picture;
408 }
409
410 /**
411  * It gives to the vout a picture to be displayed.
412  *
413  * The given picture MUST comes from vout_GetPicture.
414  *
415  * Becareful, after vout_PutPicture is called, picture_t::p_next cannot be
416  * read/used.
417  */
418 void vout_PutPicture(vout_thread_t *vout, picture_t *picture)
419 {
420     vlc_mutex_lock(&vout->p->picture_lock);
421
422     picture->p_next = NULL;
423     picture_fifo_Push(vout->p->decoder_fifo, picture);
424
425     vlc_mutex_unlock(&vout->p->picture_lock);
426
427     vout_control_Wake(&vout->p->control);
428 }
429
430 /**
431  * It releases a picture retreived by vout_GetPicture.
432  */
433 void vout_ReleasePicture(vout_thread_t *vout, picture_t *picture)
434 {
435     vlc_mutex_lock(&vout->p->picture_lock);
436
437     picture_Release(picture);
438
439     vlc_mutex_unlock(&vout->p->picture_lock);
440
441     vout_control_Wake(&vout->p->control);
442 }
443
444 /**
445  * It increment the reference counter of a picture retreived by
446  * vout_GetPicture.
447  */
448 void vout_HoldPicture(vout_thread_t *vout, picture_t *picture)
449 {
450     vlc_mutex_lock(&vout->p->picture_lock);
451
452     picture_Hold(picture);
453
454     vlc_mutex_unlock(&vout->p->picture_lock);
455 }
456
457 /* */
458 int vout_GetSnapshot(vout_thread_t *vout,
459                      block_t **image_dst, picture_t **picture_dst,
460                      video_format_t *fmt,
461                      const char *type, mtime_t timeout)
462 {
463     picture_t *picture = vout_snapshot_Get(&vout->p->snapshot, timeout);
464     if (!picture) {
465         msg_Err(vout, "Failed to grab a snapshot");
466         return VLC_EGENERIC;
467     }
468
469     if (image_dst) {
470         vlc_fourcc_t codec = VLC_CODEC_PNG;
471         if (type && image_Type2Fourcc(type))
472             codec = image_Type2Fourcc(type);
473
474         const int override_width  = var_InheritInteger(vout, "snapshot-width");
475         const int override_height = var_InheritInteger(vout, "snapshot-height");
476
477         if (picture_Export(VLC_OBJECT(vout), image_dst, fmt,
478                            picture, codec, override_width, override_height)) {
479             msg_Err(vout, "Failed to convert image for snapshot");
480             picture_Release(picture);
481             return VLC_EGENERIC;
482         }
483     }
484     if (picture_dst)
485         *picture_dst = picture;
486     else
487         picture_Release(picture);
488     return VLC_SUCCESS;
489 }
490
491 void vout_ChangeAspectRatio( vout_thread_t *p_vout,
492                              unsigned int i_num, unsigned int i_den )
493 {
494     vout_ControlChangeSampleAspectRatio( p_vout, i_num, i_den );
495 }
496
497 /* vout_Control* are usable by anyone at anytime */
498 void vout_ControlChangeFullscreen(vout_thread_t *vout, bool fullscreen)
499 {
500     vout_control_PushBool(&vout->p->control, VOUT_CONTROL_FULLSCREEN,
501                           fullscreen);
502 }
503 void vout_ControlChangeWindowState(vout_thread_t *vout, unsigned st)
504 {
505     vout_control_PushInteger(&vout->p->control, VOUT_CONTROL_WINDOW_STATE, st);
506 }
507 void vout_ControlChangeDisplayFilled(vout_thread_t *vout, bool is_filled)
508 {
509     vout_control_PushBool(&vout->p->control, VOUT_CONTROL_DISPLAY_FILLED,
510                           is_filled);
511 }
512 void vout_ControlChangeZoom(vout_thread_t *vout, int num, int den)
513 {
514     vout_control_PushPair(&vout->p->control, VOUT_CONTROL_ZOOM,
515                           num, den);
516 }
517 void vout_ControlChangeSampleAspectRatio(vout_thread_t *vout,
518                                          unsigned num, unsigned den)
519 {
520     vout_control_PushPair(&vout->p->control, VOUT_CONTROL_ASPECT_RATIO,
521                           num, den);
522 }
523 void vout_ControlChangeCropRatio(vout_thread_t *vout,
524                                  unsigned num, unsigned den)
525 {
526     vout_control_PushPair(&vout->p->control, VOUT_CONTROL_CROP_RATIO,
527                           num, den);
528 }
529 void vout_ControlChangeCropWindow(vout_thread_t *vout,
530                                   int x, int y, int width, int height)
531 {
532     vout_control_cmd_t cmd;
533     vout_control_cmd_Init(&cmd, VOUT_CONTROL_CROP_WINDOW);
534     cmd.u.window.x      = __MAX(x, 0);
535     cmd.u.window.y      = __MAX(y, 0);
536     cmd.u.window.width  = __MAX(width, 0);
537     cmd.u.window.height = __MAX(height, 0);
538
539     vout_control_Push(&vout->p->control, &cmd);
540 }
541 void vout_ControlChangeCropBorder(vout_thread_t *vout,
542                                   int left, int top, int right, int bottom)
543 {
544     vout_control_cmd_t cmd;
545     vout_control_cmd_Init(&cmd, VOUT_CONTROL_CROP_BORDER);
546     cmd.u.border.left   = __MAX(left, 0);
547     cmd.u.border.top    = __MAX(top, 0);
548     cmd.u.border.right  = __MAX(right, 0);
549     cmd.u.border.bottom = __MAX(bottom, 0);
550
551     vout_control_Push(&vout->p->control, &cmd);
552 }
553 void vout_ControlChangeFilters(vout_thread_t *vout, const char *filters)
554 {
555     vout_control_PushString(&vout->p->control, VOUT_CONTROL_CHANGE_FILTERS,
556                             filters);
557 }
558 void vout_ControlChangeSubSources(vout_thread_t *vout, const char *filters)
559 {
560     vout_control_PushString(&vout->p->control, VOUT_CONTROL_CHANGE_SUB_SOURCES,
561                             filters);
562 }
563 void vout_ControlChangeSubFilters(vout_thread_t *vout, const char *filters)
564 {
565     vout_control_PushString(&vout->p->control, VOUT_CONTROL_CHANGE_SUB_FILTERS,
566                             filters);
567 }
568 void vout_ControlChangeSubMargin(vout_thread_t *vout, int margin)
569 {
570     vout_control_PushInteger(&vout->p->control, VOUT_CONTROL_CHANGE_SUB_MARGIN,
571                              margin);
572 }
573
574 /* */
575 static void VoutGetDisplayCfg(vout_thread_t *vout, vout_display_cfg_t *cfg, const char *title)
576 {
577     /* Load configuration */
578     cfg->is_fullscreen = var_CreateGetBool(vout, "fullscreen")
579                          || var_InheritBool(vout, "video-wallpaper");
580     cfg->display.title = title;
581     const int display_width = var_CreateGetInteger(vout, "width");
582     const int display_height = var_CreateGetInteger(vout, "height");
583     cfg->display.width   = display_width > 0  ? display_width  : 0;
584     cfg->display.height  = display_height > 0 ? display_height : 0;
585     cfg->is_display_filled  = var_CreateGetBool(vout, "autoscale");
586     unsigned msar_num, msar_den;
587     if (var_InheritURational(vout, &msar_num, &msar_den, "monitor-par") ||
588         msar_num <= 0 || msar_den <= 0) {
589         msar_num = 1;
590         msar_den = 1;
591     }
592     cfg->display.sar.num = msar_num;
593     cfg->display.sar.den = msar_den;
594     unsigned zoom_den = 1000;
595     unsigned zoom_num = zoom_den * var_CreateGetFloat(vout, "scale");
596     vlc_ureduce(&zoom_num, &zoom_den, zoom_num, zoom_den, 0);
597     cfg->zoom.num = zoom_num;
598     cfg->zoom.den = zoom_den;
599     cfg->align.vertical = VOUT_DISPLAY_ALIGN_CENTER;
600     cfg->align.horizontal = VOUT_DISPLAY_ALIGN_CENTER;
601     const int align_mask = var_CreateGetInteger(vout, "align");
602     if (align_mask & 0x1)
603         cfg->align.horizontal = VOUT_DISPLAY_ALIGN_LEFT;
604     else if (align_mask & 0x2)
605         cfg->align.horizontal = VOUT_DISPLAY_ALIGN_RIGHT;
606     if (align_mask & 0x4)
607         cfg->align.vertical = VOUT_DISPLAY_ALIGN_TOP;
608     else if (align_mask & 0x8)
609         cfg->align.vertical = VOUT_DISPLAY_ALIGN_BOTTOM;
610 }
611
612 vout_window_t * vout_NewDisplayWindow(vout_thread_t *vout, vout_display_t *vd,
613                                       const vout_window_cfg_t *cfg)
614 {
615     VLC_UNUSED(vd);
616     vout_window_cfg_t cfg_override = *cfg;
617
618     if (!var_InheritBool( vout, "embedded-video"))
619         cfg_override.is_standalone = true;
620
621     if (vout->p->window.is_unused && vout->p->window.object) {
622         assert(!vout->p->splitter_name);
623         if (!cfg_override.is_standalone == !vout->p->window.cfg.is_standalone &&
624             cfg_override.type           == vout->p->window.cfg.type) {
625             /* Reuse the stored window */
626             msg_Dbg(vout, "Reusing previous vout window");
627             vout_window_t *window = vout->p->window.object;
628             if (cfg_override.width  != vout->p->window.cfg.width ||
629                 cfg_override.height != vout->p->window.cfg.height)
630                 vout_window_SetSize(window,
631                                     cfg_override.width, cfg_override.height);
632             vout->p->window.is_unused = false;
633             vout->p->window.cfg       = cfg_override;
634             return window;
635         }
636
637         vout_window_Delete(vout->p->window.object);
638         vout->p->window.is_unused = true;
639         vout->p->window.object    = NULL;
640     }
641
642     vout_window_t *window = vout_window_New(VLC_OBJECT(vout), "$window",
643                                             &cfg_override);
644     if (!window)
645         return NULL;
646     if (!vout->p->splitter_name) {
647         vout->p->window.is_unused = false;
648         vout->p->window.cfg       = cfg_override;
649         vout->p->window.object    = window;
650     }
651     return window;
652 }
653
654 void vout_DeleteDisplayWindow(vout_thread_t *vout, vout_display_t *vd,
655                               vout_window_t *window)
656 {
657     VLC_UNUSED(vd);
658     if (!vout->p->window.is_unused && vout->p->window.object == window) {
659         vout->p->window.is_unused = true;
660     } else if (vout->p->window.is_unused && vout->p->window.object && !window) {
661         vout_window_Delete(vout->p->window.object);
662         vout->p->window.is_unused = true;
663         vout->p->window.object    = NULL;
664     } else if (window) {
665         vout_window_Delete(window);
666     }
667 }
668
669 /* */
670 static picture_t *VoutVideoFilterInteractiveNewPicture(filter_t *filter)
671 {
672     vout_thread_t *vout = filter->owner.sys;
673
674     picture_t *picture = picture_pool_Get(vout->p->private_pool);
675     if (picture) {
676         picture_Reset(picture);
677         VideoFormatCopyCropAr(&picture->format, &filter->fmt_out.video);
678     }
679     return picture;
680 }
681
682 static picture_t *VoutVideoFilterStaticNewPicture(filter_t *filter)
683 {
684     vout_thread_t *vout = filter->owner.sys;
685
686     vlc_assert_locked(&vout->p->filter.lock);
687     if (filter_chain_GetLength(vout->p->filter.chain_interactive) == 0)
688         return VoutVideoFilterInteractiveNewPicture(filter);
689
690     return picture_NewFromFormat(&filter->fmt_out.video);
691 }
692
693 static void VoutVideoFilterDelPicture(filter_t *filter, picture_t *picture)
694 {
695     VLC_UNUSED(filter);
696     picture_Release(picture);
697 }
698
699 static void ThreadFilterFlush(vout_thread_t *vout, bool is_locked)
700 {
701     if (vout->p->displayed.current)
702         picture_Release( vout->p->displayed.current );
703     vout->p->displayed.current = NULL;
704
705     if (vout->p->displayed.next)
706         picture_Release( vout->p->displayed.next );
707     vout->p->displayed.next = NULL;
708
709     if (!is_locked)
710         vlc_mutex_lock(&vout->p->filter.lock);
711     filter_chain_VideoFlush(vout->p->filter.chain_static);
712     filter_chain_VideoFlush(vout->p->filter.chain_interactive);
713     if (!is_locked)
714         vlc_mutex_unlock(&vout->p->filter.lock);
715 }
716
717 typedef struct {
718     char           *name;
719     config_chain_t *cfg;
720 } vout_filter_t;
721
722 static void ThreadChangeFilters(vout_thread_t *vout,
723                                 const video_format_t *source,
724                                 const char *filters,
725                                 bool is_locked)
726 {
727     ThreadFilterFlush(vout, is_locked);
728
729     vlc_array_t array_static;
730     vlc_array_t array_interactive;
731
732     vlc_array_init(&array_static);
733     vlc_array_init(&array_interactive);
734     char *current = filters ? strdup(filters) : NULL;
735     while (current) {
736         config_chain_t *cfg;
737         char *name;
738         char *next = config_ChainCreate(&name, &cfg, current);
739
740         if (name && *name) {
741             vout_filter_t *e = xmalloc(sizeof(*e));
742             e->name = name;
743             e->cfg  = cfg;
744             if (!strcmp(e->name, "deinterlace") ||
745                 !strcmp(e->name, "postproc")) {
746                 vlc_array_append(&array_static, e);
747             } else {
748                 vlc_array_append(&array_interactive, e);
749             }
750         } else {
751             if (cfg)
752                 config_ChainDestroy(cfg);
753             free(name);
754         }
755         free(current);
756         current = next;
757     }
758
759     if (!is_locked)
760         vlc_mutex_lock(&vout->p->filter.lock);
761
762     es_format_t fmt_target;
763     es_format_InitFromVideo(&fmt_target, source ? source : &vout->p->filter.format);
764
765     es_format_t fmt_current = fmt_target;
766
767     for (int a = 0; a < 2; a++) {
768         vlc_array_t    *array = a == 0 ? &array_static :
769                                          &array_interactive;
770         filter_chain_t *chain = a == 0 ? vout->p->filter.chain_static :
771                                          vout->p->filter.chain_interactive;
772
773         filter_chain_Reset(chain, &fmt_current, &fmt_current);
774         for (int i = 0; i < vlc_array_count(array); i++) {
775             vout_filter_t *e = vlc_array_item_at_index(array, i);
776             msg_Dbg(vout, "Adding '%s' as %s", e->name, a == 0 ? "static" : "interactive");
777             if (!filter_chain_AppendFilter(chain, e->name, e->cfg, NULL, NULL)) {
778                 msg_Err(vout, "Failed to add filter '%s'", e->name);
779                 config_ChainDestroy(e->cfg);
780             }
781             free(e->name);
782             free(e);
783         }
784         fmt_current = *filter_chain_GetFmtOut(chain);
785         vlc_array_clear(array);
786     }
787
788     if (!es_format_IsSimilar(&fmt_current, &fmt_target)) {
789         msg_Dbg(vout, "Adding a filter to compensate for format changes");
790         if (!filter_chain_AppendFilter(vout->p->filter.chain_interactive, NULL, NULL,
791                                        &fmt_current, &fmt_target)) {
792             msg_Err(vout, "Failed to compensate for the format changes, removing all filters");
793             filter_chain_Reset(vout->p->filter.chain_static,      &fmt_target, &fmt_target);
794             filter_chain_Reset(vout->p->filter.chain_interactive, &fmt_target, &fmt_target);
795         }
796     }
797
798     if (vout->p->filter.configuration != filters) {
799         free(vout->p->filter.configuration);
800         vout->p->filter.configuration = filters ? strdup(filters) : NULL;
801     }
802     if (source) {
803         video_format_Clean(&vout->p->filter.format);
804         video_format_Copy(&vout->p->filter.format, source);
805     }
806
807     if (!is_locked)
808         vlc_mutex_unlock(&vout->p->filter.lock);
809 }
810
811
812 /* */
813 static int ThreadDisplayPreparePicture(vout_thread_t *vout, bool reuse, bool frame_by_frame)
814 {
815     bool is_late_dropped = vout->p->is_late_dropped && !vout->p->pause.is_on && !frame_by_frame;
816
817     vlc_mutex_lock(&vout->p->filter.lock);
818
819     picture_t *picture = filter_chain_VideoFilter(vout->p->filter.chain_static, NULL);
820     assert(!reuse || !picture);
821
822     while (!picture) {
823         picture_t *decoded;
824         if (reuse && vout->p->displayed.decoded) {
825             decoded = picture_Hold(vout->p->displayed.decoded);
826         } else {
827             decoded = picture_fifo_Pop(vout->p->decoder_fifo);
828             if (decoded) {
829                 if (is_late_dropped && !decoded->b_force) {
830                     const mtime_t predicted = mdate() + 0; /* TODO improve */
831                     const mtime_t late = predicted - decoded->date;
832                     if (late > VOUT_DISPLAY_LATE_THRESHOLD) {
833                         msg_Warn(vout, "picture is too late to be displayed (missing %"PRId64" ms)", late/1000);
834                         picture_Release(decoded);
835                         vout_statistic_AddLost(&vout->p->statistic, 1);
836                         continue;
837                     } else if (late > 0) {
838                         msg_Dbg(vout, "picture might be displayed late (missing %"PRId64" ms)", late/1000);
839                     }
840                 }
841                 if (!VideoFormatIsCropArEqual(&decoded->format, &vout->p->filter.format))
842                     ThreadChangeFilters(vout, &decoded->format, vout->p->filter.configuration, true);
843             }
844         }
845
846         if (!decoded)
847             break;
848         reuse = false;
849
850         if (vout->p->displayed.decoded)
851             picture_Release(vout->p->displayed.decoded);
852
853         vout->p->displayed.decoded       = picture_Hold(decoded);
854         vout->p->displayed.timestamp     = decoded->date;
855         vout->p->displayed.is_interlaced = !decoded->b_progressive;
856
857         picture = filter_chain_VideoFilter(vout->p->filter.chain_static, decoded);
858     }
859
860     vlc_mutex_unlock(&vout->p->filter.lock);
861
862     if (!picture)
863         return VLC_EGENERIC;
864
865     assert(!vout->p->displayed.next);
866     if (!vout->p->displayed.current)
867         vout->p->displayed.current = picture;
868     else
869         vout->p->displayed.next    = picture;
870     return VLC_SUCCESS;
871 }
872
873 static int ThreadDisplayRenderPicture(vout_thread_t *vout, bool is_forced)
874 {
875     vout_thread_sys_t *sys = vout->p;
876     vout_display_t *vd = vout->p->display.vd;
877
878     picture_t *torender = picture_Hold(vout->p->displayed.current);
879
880     vout_chrono_Start(&vout->p->render);
881
882     vlc_mutex_lock(&vout->p->filter.lock);
883     picture_t *filtered = filter_chain_VideoFilter(vout->p->filter.chain_interactive, torender);
884     vlc_mutex_unlock(&vout->p->filter.lock);
885
886     if (!filtered)
887         return VLC_EGENERIC;
888
889     if (filtered->date != vout->p->displayed.current->date)
890         msg_Warn(vout, "Unsupported timestamp modifications done by chain_interactive");
891
892     /*
893      * Get the subpicture to be displayed
894      */
895     const bool do_snapshot = vout_snapshot_IsRequested(&vout->p->snapshot);
896     mtime_t render_subtitle_date;
897     if (vout->p->pause.is_on)
898         render_subtitle_date = vout->p->pause.date;
899     else
900         render_subtitle_date = filtered->date > 1 ? filtered->date : mdate();
901     mtime_t render_osd_date = mdate(); /* FIXME wrong */
902
903     /*
904      * Get the subpicture to be displayed
905      */
906     const bool do_dr_spu = !do_snapshot &&
907                            vd->info.subpicture_chromas &&
908                            *vd->info.subpicture_chromas != 0;
909
910     //FIXME: Denying do_early_spu if vd->source.orientation != ORIENT_NORMAL
911     //will have the effect that snapshots miss the subpictures. We do this
912     //because there is currently no way to transform subpictures to match
913     //the source format.
914     const bool do_early_spu = !do_dr_spu &&
915                                vd->source.orientation == ORIENT_NORMAL &&
916                               (vd->info.is_slow ||
917                                sys->display.use_dr ||
918                                do_snapshot ||
919                                !vout_IsDisplayFiltered(vd) ||
920                                vd->fmt.i_width * vd->fmt.i_height <= vd->source.i_width * vd->source.i_height);
921
922     const vlc_fourcc_t *subpicture_chromas;
923     video_format_t fmt_spu;
924     if (do_dr_spu) {
925         vout_display_place_t place;
926         vout_display_PlacePicture(&place, &vd->source, vd->cfg, false);
927
928         fmt_spu = vd->source;
929         if (fmt_spu.i_width * fmt_spu.i_height < place.width * place.height) {
930             fmt_spu.i_sar_num = vd->cfg->display.sar.num;
931             fmt_spu.i_sar_den = vd->cfg->display.sar.den;
932             fmt_spu.i_width          =
933             fmt_spu.i_visible_width  = place.width;
934             fmt_spu.i_height         =
935             fmt_spu.i_visible_height = place.height;
936         }
937         subpicture_chromas = vd->info.subpicture_chromas;
938     } else {
939         if (do_early_spu) {
940             fmt_spu = vd->source;
941         } else {
942             fmt_spu = vd->fmt;
943             fmt_spu.i_sar_num = vd->cfg->display.sar.num;
944             fmt_spu.i_sar_den = vd->cfg->display.sar.den;
945         }
946         subpicture_chromas = NULL;
947
948         if (vout->p->spu_blend &&
949             vout->p->spu_blend->fmt_out.video.i_chroma != fmt_spu.i_chroma) {
950             filter_DeleteBlend(vout->p->spu_blend);
951             vout->p->spu_blend = NULL;
952             vout->p->spu_blend_chroma = 0;
953         }
954         if (!vout->p->spu_blend && vout->p->spu_blend_chroma != fmt_spu.i_chroma) {
955             vout->p->spu_blend_chroma = fmt_spu.i_chroma;
956             vout->p->spu_blend = filter_NewBlend(VLC_OBJECT(vout), &fmt_spu);
957             if (!vout->p->spu_blend)
958                 msg_Err(vout, "Failed to create blending filter, OSD/Subtitles will not work");
959         }
960     }
961
962     video_format_t fmt_spu_rot;
963     video_format_ApplyRotation(&fmt_spu_rot, &fmt_spu);
964     subpicture_t *subpic = spu_Render(vout->p->spu,
965                                       subpicture_chromas, &fmt_spu_rot,
966                                       &vd->source,
967                                       render_subtitle_date, render_osd_date,
968                                       do_snapshot);
969     /*
970      * Perform rendering
971      *
972      * We have to:
973      * - be sure to end up with a direct buffer.
974      * - blend subtitles, and in a fast access buffer
975      */
976     bool is_direct = vout->p->decoder_pool == vout->p->display_pool;
977     picture_t *todisplay = filtered;
978     if (do_early_spu && subpic) {
979         picture_t *blent = picture_pool_Get(vout->p->private_pool);
980         if (blent) {
981             VideoFormatCopyCropAr(&blent->format, &filtered->format);
982             picture_Copy(blent, filtered);
983             if (vout->p->spu_blend
984              && picture_BlendSubpicture(blent, vout->p->spu_blend, subpic)) {
985                 picture_Release(todisplay);
986                 todisplay = blent;
987             } else
988                 picture_Release(blent);
989         }
990         subpicture_Delete(subpic);
991         subpic = NULL;
992     }
993
994     assert(vout_IsDisplayFiltered(vd) == !sys->display.use_dr);
995     if (sys->display.use_dr && !is_direct) {
996         picture_t *direct = picture_pool_Get(vout->p->display_pool);
997         if (!direct) {
998             picture_Release(todisplay);
999             if (subpic)
1000                 subpicture_Delete(subpic);
1001             return VLC_EGENERIC;
1002         }
1003
1004         /* The display uses direct rendering (no conversion), but its pool of
1005          * pictures is not usable by the decoder (too few, too slow or
1006          * subject to invalidation...). Since there are no filters, copying
1007          * pictures from the decoder to the output is unavoidable. */
1008         VideoFormatCopyCropAr(&direct->format, &todisplay->format);
1009         picture_Copy(direct, todisplay);
1010         picture_Release(todisplay);
1011         todisplay = direct;
1012     }
1013
1014     /*
1015      * Take a snapshot if requested
1016      */
1017     if (do_snapshot)
1018         vout_snapshot_Set(&vout->p->snapshot, &vd->source, todisplay);
1019
1020     /* Render the direct buffer */
1021     vout_UpdateDisplaySourceProperties(vd, &todisplay->format);
1022     if (sys->display.use_dr) {
1023         vout_display_Prepare(vd, todisplay, subpic);
1024     } else {
1025         sys->display.filtered = vout_FilterDisplay(vd, todisplay);
1026         if (sys->display.filtered) {
1027             if (!do_dr_spu && !do_early_spu && vout->p->spu_blend && subpic)
1028                 picture_BlendSubpicture(sys->display.filtered, vout->p->spu_blend, subpic);
1029             vout_display_Prepare(vd, sys->display.filtered, do_dr_spu ? subpic : NULL);
1030         }
1031         if (!do_dr_spu && subpic)
1032         {
1033             subpicture_Delete(subpic);
1034             subpic = NULL;
1035         }
1036         if (!sys->display.filtered)
1037             return VLC_EGENERIC;
1038     }
1039
1040     vout_chrono_Stop(&vout->p->render);
1041 #if 0
1042         {
1043         static int i = 0;
1044         if (((i++)%10) == 0)
1045             msg_Info(vout, "render: avg %d ms var %d ms",
1046                      (int)(vout->p->render.avg/1000), (int)(vout->p->render.var/1000));
1047         }
1048 #endif
1049
1050     /* Wait the real date (for rendering jitter) */
1051 #if 0
1052     mtime_t delay = direct->date - mdate();
1053     if (delay < 1000)
1054         msg_Warn(vout, "picture is late (%lld ms)", delay / 1000);
1055 #endif
1056     if (!is_forced)
1057         mwait(todisplay->date);
1058
1059     /* Display the direct buffer returned by vout_RenderPicture */
1060     vout->p->displayed.date = mdate();
1061     vout_display_Display(vd,
1062                          sys->display.filtered ? sys->display.filtered
1063                                                 : todisplay,
1064                          subpic);
1065     sys->display.filtered = NULL;
1066
1067     vout_statistic_AddDisplayed(&vout->p->statistic, 1);
1068
1069     return VLC_SUCCESS;
1070 }
1071
1072 static int ThreadDisplayPicture(vout_thread_t *vout, mtime_t *deadline)
1073 {
1074     bool frame_by_frame = !deadline;
1075     bool paused = vout->p->pause.is_on;
1076     bool first = !vout->p->displayed.current;
1077
1078     if (first)
1079         if (ThreadDisplayPreparePicture(vout, true, frame_by_frame)) /* FIXME not sure it is ok */
1080             return VLC_EGENERIC;
1081
1082     if (!paused || frame_by_frame)
1083         while (!vout->p->displayed.next && !ThreadDisplayPreparePicture(vout, false, frame_by_frame))
1084             ;
1085
1086     const mtime_t date = mdate();
1087     const mtime_t render_delay = vout_chrono_GetHigh(&vout->p->render) + VOUT_MWAIT_TOLERANCE;
1088
1089     bool drop_next_frame = frame_by_frame;
1090     mtime_t date_next = VLC_TS_INVALID;
1091     if (!paused && vout->p->displayed.next) {
1092         date_next = vout->p->displayed.next->date - render_delay;
1093         if (date_next /* + 0 FIXME */ <= date)
1094             drop_next_frame = true;
1095     }
1096
1097     /* FIXME/XXX we must redisplay the last decoded picture (because
1098      * of potential vout updated, or filters update or SPU update)
1099      * For now a high update period is needed but it could be removed
1100      * if and only if:
1101      * - vout module emits events from theselves.
1102      * - *and* SPU is modified to emit an event or a deadline when needed.
1103      *
1104      * So it will be done later.
1105      */
1106     bool refresh = false;
1107
1108     mtime_t date_refresh = VLC_TS_INVALID;
1109     if (vout->p->displayed.date > VLC_TS_INVALID) {
1110         date_refresh = vout->p->displayed.date + VOUT_REDISPLAY_DELAY - render_delay;
1111         refresh = date_refresh <= date;
1112     }
1113
1114     if (!first && !refresh && !drop_next_frame) {
1115         if (!frame_by_frame) {
1116             if (date_refresh != VLC_TS_INVALID)
1117                 *deadline = date_refresh;
1118             if (date_next != VLC_TS_INVALID && date_next < *deadline)
1119                 *deadline = date_next;
1120         }
1121         return VLC_EGENERIC;
1122     }
1123
1124     if (drop_next_frame) {
1125         picture_Release(vout->p->displayed.current);
1126         vout->p->displayed.current = vout->p->displayed.next;
1127         vout->p->displayed.next    = NULL;
1128     }
1129
1130     if (!vout->p->displayed.current)
1131         return VLC_EGENERIC;
1132
1133     /* display the picture immediately */
1134     bool is_forced = frame_by_frame || (!drop_next_frame && refresh) || vout->p->displayed.current->b_force;
1135     return ThreadDisplayRenderPicture(vout, is_forced);
1136 }
1137
1138 static void ThreadDisplaySubpicture(vout_thread_t *vout,
1139                                     subpicture_t *subpicture)
1140 {
1141     spu_PutSubpicture(vout->p->spu, subpicture);
1142 }
1143
1144 static void ThreadFlushSubpicture(vout_thread_t *vout, int channel)
1145 {
1146     spu_ClearChannel(vout->p->spu, channel);
1147 }
1148
1149 static void ThreadDisplayOsdTitle(vout_thread_t *vout, const char *string)
1150 {
1151     if (!vout->p->title.show)
1152         return;
1153
1154     vout_OSDText(vout, SPU_DEFAULT_CHANNEL,
1155                  vout->p->title.position, INT64_C(1000) * vout->p->title.timeout,
1156                  string);
1157 }
1158
1159 static void ThreadChangeSubSources(vout_thread_t *vout, const char *filters)
1160 {
1161     spu_ChangeSources(vout->p->spu, filters);
1162 }
1163
1164 static void ThreadChangeSubFilters(vout_thread_t *vout, const char *filters)
1165 {
1166     spu_ChangeFilters(vout->p->spu, filters);
1167 }
1168
1169 static void ThreadChangeSubMargin(vout_thread_t *vout, int margin)
1170 {
1171     spu_ChangeMargin(vout->p->spu, margin);
1172 }
1173
1174 static void ThreadChangePause(vout_thread_t *vout, bool is_paused, mtime_t date)
1175 {
1176     assert(!vout->p->pause.is_on || !is_paused);
1177
1178     if (vout->p->pause.is_on) {
1179         const mtime_t duration = date - vout->p->pause.date;
1180
1181         if (vout->p->step.timestamp > VLC_TS_INVALID)
1182             vout->p->step.timestamp += duration;
1183         if (vout->p->step.last > VLC_TS_INVALID)
1184             vout->p->step.last += duration;
1185         picture_fifo_OffsetDate(vout->p->decoder_fifo, duration);
1186         if (vout->p->displayed.decoded)
1187             vout->p->displayed.decoded->date += duration;
1188         spu_OffsetSubtitleDate(vout->p->spu, duration);
1189
1190         ThreadFilterFlush(vout, false);
1191     } else {
1192         vout->p->step.timestamp = VLC_TS_INVALID;
1193         vout->p->step.last      = VLC_TS_INVALID;
1194     }
1195     vout->p->pause.is_on = is_paused;
1196     vout->p->pause.date  = date;
1197 }
1198
1199 static void ThreadFlush(vout_thread_t *vout, bool below, mtime_t date)
1200 {
1201     vout->p->step.timestamp = VLC_TS_INVALID;
1202     vout->p->step.last      = VLC_TS_INVALID;
1203
1204     ThreadFilterFlush(vout, false); /* FIXME too much */
1205
1206     picture_t *last = vout->p->displayed.decoded;
1207     if (last) {
1208         if (( below && last->date <= date) ||
1209             (!below && last->date >= date)) {
1210             picture_Release(last);
1211
1212             vout->p->displayed.decoded   = NULL;
1213             vout->p->displayed.date      = VLC_TS_INVALID;
1214             vout->p->displayed.timestamp = VLC_TS_INVALID;
1215         }
1216     }
1217
1218     picture_fifo_Flush(vout->p->decoder_fifo, date, below);
1219 }
1220
1221 static void ThreadReset(vout_thread_t *vout)
1222 {
1223     ThreadFlush(vout, true, INT64_MAX);
1224     if (vout->p->decoder_pool)
1225         picture_pool_NonEmpty(vout->p->decoder_pool, true);
1226     vout->p->pause.is_on = false;
1227     vout->p->pause.date  = mdate();
1228 }
1229
1230 static void ThreadStep(vout_thread_t *vout, mtime_t *duration)
1231 {
1232     *duration = 0;
1233
1234     if (vout->p->step.last <= VLC_TS_INVALID)
1235         vout->p->step.last = vout->p->displayed.timestamp;
1236
1237     if (ThreadDisplayPicture(vout, NULL))
1238         return;
1239
1240     vout->p->step.timestamp = vout->p->displayed.timestamp;
1241
1242     if (vout->p->step.last > VLC_TS_INVALID &&
1243         vout->p->step.timestamp > vout->p->step.last) {
1244         *duration = vout->p->step.timestamp - vout->p->step.last;
1245         vout->p->step.last = vout->p->step.timestamp;
1246         /* TODO advance subpicture by the duration ... */
1247     }
1248 }
1249
1250 static void ThreadChangeFullscreen(vout_thread_t *vout, bool fullscreen)
1251 {
1252     vout_SetDisplayFullscreen(vout->p->display.vd, fullscreen);
1253 }
1254
1255 static void ThreadChangeWindowState(vout_thread_t *vout, unsigned state)
1256 {
1257     vout_SetWindowState(vout->p->display.vd, state);
1258 }
1259
1260 static void ThreadChangeDisplayFilled(vout_thread_t *vout, bool is_filled)
1261 {
1262     vout_SetDisplayFilled(vout->p->display.vd, is_filled);
1263 }
1264
1265 static void ThreadChangeZoom(vout_thread_t *vout, int num, int den)
1266 {
1267     if (num * 10 < den) {
1268         num = den;
1269         den *= 10;
1270     } else if (num > den * 10) {
1271         num = den * 10;
1272     }
1273
1274     vout_SetDisplayZoom(vout->p->display.vd, num, den);
1275 }
1276
1277 static void ThreadChangeAspectRatio(vout_thread_t *vout,
1278                                     unsigned num, unsigned den)
1279 {
1280     vout_SetDisplayAspect(vout->p->display.vd, num, den);
1281 }
1282
1283
1284 static void ThreadExecuteCropWindow(vout_thread_t *vout,
1285                                     unsigned x, unsigned y,
1286                                     unsigned width, unsigned height)
1287 {
1288     vout_SetDisplayCrop(vout->p->display.vd, 0, 0,
1289                         x, y, width, height);
1290 }
1291 static void ThreadExecuteCropBorder(vout_thread_t *vout,
1292                                     unsigned left, unsigned top,
1293                                     unsigned right, unsigned bottom)
1294 {
1295     msg_Err(vout, "ThreadExecuteCropBorder %d.%d %dx%d", left, top, right, bottom);
1296     vout_SetDisplayCrop(vout->p->display.vd, 0, 0,
1297                         left, top, -(int)right, -(int)bottom);
1298 }
1299
1300 static void ThreadExecuteCropRatio(vout_thread_t *vout,
1301                                    unsigned num, unsigned den)
1302 {
1303     vout_SetDisplayCrop(vout->p->display.vd, num, den,
1304                         0, 0, 0, 0);
1305 }
1306
1307 static int ThreadStart(vout_thread_t *vout, const vout_display_state_t *state)
1308 {
1309     vlc_mouse_Init(&vout->p->mouse);
1310     vout->p->decoder_fifo = picture_fifo_New();
1311     vout->p->decoder_pool = NULL;
1312     vout->p->display_pool = NULL;
1313     vout->p->private_pool = NULL;
1314
1315     vout->p->filter.configuration = NULL;
1316     video_format_Copy(&vout->p->filter.format, &vout->p->original);
1317
1318     filter_owner_t owner = {
1319         .sys = vout,
1320         .video = {
1321             .buffer_new = VoutVideoFilterStaticNewPicture,
1322             .buffer_del = VoutVideoFilterDelPicture,
1323         },
1324     };
1325     vout->p->filter.chain_static =
1326         filter_chain_NewVideo( vout, true, &owner );
1327
1328     owner.video.buffer_new = VoutVideoFilterInteractiveNewPicture;
1329     vout->p->filter.chain_interactive =
1330         filter_chain_NewVideo( vout, true, &owner );
1331
1332     vout_display_state_t state_default;
1333     if (!state) {
1334         var_Create(vout, "video-wallpaper", VLC_VAR_BOOL|VLC_VAR_DOINHERIT);
1335         VoutGetDisplayCfg(vout, &state_default.cfg, vout->p->display.title);
1336
1337         bool below = var_InheritBool(vout, "video-wallpaper");
1338         bool above = var_CreateGetBool(vout, "video-on-top");
1339
1340         state_default.wm_state = below ? VOUT_WINDOW_STATE_BELOW
1341                                : above ? VOUT_WINDOW_STATE_ABOVE
1342                                : VOUT_WINDOW_STATE_NORMAL;
1343         state_default.sar.num = 0;
1344         state_default.sar.den = 0;
1345
1346         state = &state_default;
1347     }
1348
1349     if (vout_OpenWrapper(vout, vout->p->splitter_name, state))
1350         return VLC_EGENERIC;
1351     if (vout_InitWrapper(vout))
1352         return VLC_EGENERIC;
1353     assert(vout->p->decoder_pool);
1354
1355     vout->p->displayed.current       = NULL;
1356     vout->p->displayed.next          = NULL;
1357     vout->p->displayed.decoded       = NULL;
1358     vout->p->displayed.date          = VLC_TS_INVALID;
1359     vout->p->displayed.timestamp     = VLC_TS_INVALID;
1360     vout->p->displayed.is_interlaced = false;
1361
1362     vout->p->step.last               = VLC_TS_INVALID;
1363     vout->p->step.timestamp          = VLC_TS_INVALID;
1364
1365     vout->p->spu_blend_chroma        = 0;
1366     vout->p->spu_blend               = NULL;
1367
1368     video_format_Print(VLC_OBJECT(vout), "original format", &vout->p->original);
1369     return VLC_SUCCESS;
1370 }
1371
1372 static void ThreadStop(vout_thread_t *vout, vout_display_state_t *state)
1373 {
1374     if (vout->p->spu_blend)
1375         filter_DeleteBlend(vout->p->spu_blend);
1376
1377     /* Destroy translation tables */
1378     if (vout->p->display.vd) {
1379         if (vout->p->decoder_pool) {
1380             ThreadFlush(vout, true, INT64_MAX);
1381             vout_EndWrapper(vout);
1382         }
1383         vout_CloseWrapper(vout, state);
1384     }
1385
1386     /* Destroy the video filters2 */
1387     filter_chain_Delete(vout->p->filter.chain_interactive);
1388     filter_chain_Delete(vout->p->filter.chain_static);
1389     video_format_Clean(&vout->p->filter.format);
1390     free(vout->p->filter.configuration);
1391
1392     if (vout->p->decoder_fifo)
1393         picture_fifo_Delete(vout->p->decoder_fifo);
1394     assert(!vout->p->decoder_pool);
1395 }
1396
1397 static void ThreadInit(vout_thread_t *vout)
1398 {
1399     vout->p->window.is_unused = true;
1400     vout->p->window.object    = NULL;
1401     vout->p->dead             = false;
1402     vout->p->is_late_dropped  = var_InheritBool(vout, "drop-late-frames");
1403     vout->p->pause.is_on      = false;
1404     vout->p->pause.date       = VLC_TS_INVALID;
1405
1406     vout_chrono_Init(&vout->p->render, 5, 10000); /* Arbitrary initial time */
1407 }
1408
1409 static void ThreadClean(vout_thread_t *vout)
1410 {
1411     if (vout->p->window.object) {
1412         assert(vout->p->window.is_unused);
1413         vout_window_Delete(vout->p->window.object);
1414     }
1415     vout_chrono_Clean(&vout->p->render);
1416     vout->p->dead = true;
1417     vout_control_Dead(&vout->p->control);
1418 }
1419
1420 static int ThreadReinit(vout_thread_t *vout,
1421                         const vout_configuration_t *cfg)
1422 {
1423     video_format_t original;
1424     if (VoutValidateFormat(&original, cfg->fmt)) {
1425         ThreadStop(vout, NULL);
1426         ThreadClean(vout);
1427         return VLC_EGENERIC;
1428     }
1429     /* We ignore crop/ar changes at this point, they are dynamically supported */
1430     VideoFormatCopyCropAr(&vout->p->original, &original);
1431     if (video_format_IsSimilar(&original, &vout->p->original)) {
1432         if (cfg->dpb_size <= vout->p->dpb_size)
1433             return VLC_SUCCESS;
1434         msg_Warn(vout, "DPB need to be increased");
1435     }
1436
1437     vout_display_state_t state;
1438     memset(&state, 0, sizeof(state));
1439
1440     ThreadStop(vout, &state);
1441
1442     if (!state.cfg.is_fullscreen) {
1443         state.cfg.display.width  = 0;
1444         state.cfg.display.height = 0;
1445     }
1446     state.sar.num = 0;
1447     state.sar.den = 0;
1448     /* FIXME current vout "variables" are not in sync here anymore
1449      * and I am not sure what to do */
1450
1451     vout->p->original = original;
1452     vout->p->dpb_size = cfg->dpb_size;
1453     if (ThreadStart(vout, &state)) {
1454         ThreadClean(vout);
1455         return VLC_EGENERIC;
1456     }
1457     return VLC_SUCCESS;
1458 }
1459
1460 static int ThreadControl(vout_thread_t *vout, vout_control_cmd_t cmd)
1461 {
1462     switch(cmd.type) {
1463     case VOUT_CONTROL_INIT:
1464         ThreadInit(vout);
1465         if (!ThreadStart(vout, NULL))
1466             break;
1467     case VOUT_CONTROL_CLEAN:
1468         ThreadStop(vout, NULL);
1469         ThreadClean(vout);
1470         return 1;
1471     case VOUT_CONTROL_REINIT:
1472         if (ThreadReinit(vout, cmd.u.cfg))
1473             return 1;
1474         break;
1475     case VOUT_CONTROL_SUBPICTURE:
1476         ThreadDisplaySubpicture(vout, cmd.u.subpicture);
1477         cmd.u.subpicture = NULL;
1478         break;
1479     case VOUT_CONTROL_FLUSH_SUBPICTURE:
1480         ThreadFlushSubpicture(vout, cmd.u.integer);
1481         break;
1482     case VOUT_CONTROL_OSD_TITLE:
1483         ThreadDisplayOsdTitle(vout, cmd.u.string);
1484         break;
1485     case VOUT_CONTROL_CHANGE_FILTERS:
1486         ThreadChangeFilters(vout, NULL, cmd.u.string, false);
1487         break;
1488     case VOUT_CONTROL_CHANGE_SUB_SOURCES:
1489         ThreadChangeSubSources(vout, cmd.u.string);
1490         break;
1491     case VOUT_CONTROL_CHANGE_SUB_FILTERS:
1492         ThreadChangeSubFilters(vout, cmd.u.string);
1493         break;
1494     case VOUT_CONTROL_CHANGE_SUB_MARGIN:
1495         ThreadChangeSubMargin(vout, cmd.u.integer);
1496         break;
1497     case VOUT_CONTROL_PAUSE:
1498         ThreadChangePause(vout, cmd.u.pause.is_on, cmd.u.pause.date);
1499         break;
1500     case VOUT_CONTROL_FLUSH:
1501         ThreadFlush(vout, false, cmd.u.time);
1502         break;
1503     case VOUT_CONTROL_RESET:
1504         ThreadReset(vout);
1505         break;
1506     case VOUT_CONTROL_STEP:
1507         ThreadStep(vout, cmd.u.time_ptr);
1508         break;
1509     case VOUT_CONTROL_FULLSCREEN:
1510         ThreadChangeFullscreen(vout, cmd.u.boolean);
1511         break;
1512     case VOUT_CONTROL_WINDOW_STATE:
1513         ThreadChangeWindowState(vout, cmd.u.integer);
1514         break;
1515     case VOUT_CONTROL_DISPLAY_FILLED:
1516         ThreadChangeDisplayFilled(vout, cmd.u.boolean);
1517         break;
1518     case VOUT_CONTROL_ZOOM:
1519         ThreadChangeZoom(vout, cmd.u.pair.a, cmd.u.pair.b);
1520         break;
1521     case VOUT_CONTROL_ASPECT_RATIO:
1522         ThreadChangeAspectRatio(vout, cmd.u.pair.a, cmd.u.pair.b);
1523         break;
1524     case VOUT_CONTROL_CROP_RATIO:
1525         ThreadExecuteCropRatio(vout, cmd.u.pair.a, cmd.u.pair.b);
1526         break;
1527     case VOUT_CONTROL_CROP_WINDOW:
1528         ThreadExecuteCropWindow(vout,
1529                 cmd.u.window.x, cmd.u.window.y,
1530                 cmd.u.window.width, cmd.u.window.height);
1531         break;
1532     case VOUT_CONTROL_CROP_BORDER:
1533         ThreadExecuteCropBorder(vout,
1534                 cmd.u.border.left,  cmd.u.border.top,
1535                 cmd.u.border.right, cmd.u.border.bottom);
1536         break;
1537     default:
1538         break;
1539     }
1540     vout_control_cmd_Clean(&cmd);
1541     return 0;
1542 }
1543
1544 /*****************************************************************************
1545  * Thread: video output thread
1546  *****************************************************************************
1547  * Video output thread. This function does only returns when the thread is
1548  * terminated. It handles the pictures arriving in the video heap and the
1549  * display device events.
1550  *****************************************************************************/
1551 static void *Thread(void *object)
1552 {
1553     vout_thread_t *vout = object;
1554     vout_thread_sys_t *sys = vout->p;
1555
1556     vout_interlacing_support_t interlacing = {
1557         .is_interlaced = false,
1558         .date = mdate(),
1559     };
1560
1561     mtime_t deadline = VLC_TS_INVALID;
1562     for (;;) {
1563         vout_control_cmd_t cmd;
1564         /* FIXME remove thoses ugly timeouts */
1565         while (!vout_control_Pop(&sys->control, &cmd, deadline, 100000))
1566             if (ThreadControl(vout, cmd))
1567                 return NULL;
1568
1569         vlc_mutex_lock(&sys->picture_lock);
1570
1571         deadline = VLC_TS_INVALID;
1572         while (!ThreadDisplayPicture(vout, &deadline))
1573             ;
1574
1575         const bool picture_interlaced = sys->displayed.is_interlaced;
1576
1577         vlc_mutex_unlock(&sys->picture_lock);
1578
1579         vout_SetInterlacingState(vout, &interlacing, picture_interlaced);
1580         vout_ManageWrapper(vout);
1581     }
1582 }