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