video_output.c 39.3 KB
Newer Older
1
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
2
 * video_output.c : video output thread
3
 *
Michel Kaempf's avatar
Michel Kaempf committed
4 5
 * This module describes the programming interface for video output threads.
 * It includes functions allowing to open a new thread, send pictures to a
6 7
 * thread, and destroy a previously oppened video output thread.
 *****************************************************************************
8
 * Copyright (C) 2000-2007 the VideoLAN team
Gildas Bazin's avatar
Gildas Bazin committed
9
 * $Id$
10
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
11
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
12
 *          Gildas Bazin <gbazin@videolan.org>
13
 *          Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
14 15 16 17 18
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
Sam Hocevar's avatar
Sam Hocevar committed
19
 *
20 21
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 23
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
24
 *
25 26
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
27
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
28
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
29

30
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
31
 * Preamble
32
 *****************************************************************************/
33 34 35 36
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

37
#include <vlc_common.h>
38

39
#include <stdlib.h>                                                /* free() */
40
#include <string.h>
41
#include <assert.h>
Vincent Seguin's avatar
Vincent Seguin committed
42

Clément Stenac's avatar
Clément Stenac committed
43
#include <vlc_vout.h>
44

Clément Stenac's avatar
Clément Stenac committed
45
#include <vlc_filter.h>
46
#include <vlc_vout_osd.h>
Clément Stenac's avatar
Clément Stenac committed
47

48
#include <libvlc.h>
Laurent Aimar's avatar
Laurent Aimar committed
49
#include "vout_internal.h"
50 51
#include "interlacing.h"
#include "postprocessing.h"
52
#include "display.h"
53

54
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
55
 * Local prototypes
56
 *****************************************************************************/
57 58
static void *Thread(void *);
static void VoutDestructor(vlc_object_t *);
Laurent Aimar's avatar
Laurent Aimar committed
59

Laurent Aimar's avatar
Laurent Aimar committed
60 61 62 63
/* Maximum delay between 2 displayed pictures.
 * XXX it is needed for now but should be removed in the long term.
 */
#define VOUT_REDISPLAY_DELAY (INT64_C(80000))
64

Laurent Aimar's avatar
Laurent Aimar committed
65 66 67 68
/**
 * Late pictures having a delay higher than this value are thrashed.
 */
#define VOUT_DISPLAY_LATE_THRESHOLD (INT64_C(20000))
69 70

/* Better be in advance when awakening than late... */
Laurent Aimar's avatar
Laurent Aimar committed
71
#define VOUT_MWAIT_TOLERANCE (INT64_C(1000))
72

73 74 75
/* */
static int VoutValidateFormat(video_format_t *dst,
                              const video_format_t *src)
76
{
77 78 79 80
    if (src->i_width <= 0 || src->i_height <= 0)
        return VLC_EGENERIC;
    if (src->i_sar_num <= 0 || src->i_sar_den <= 0)
        return VLC_EGENERIC;
81

82 83 84 85 86 87 88 89 90 91
    /* */
    video_format_Copy(dst, src);
    dst->i_chroma = vlc_fourcc_GetCodec(VIDEO_ES, src->i_chroma);
    vlc_ureduce( &dst->i_sar_num, &dst->i_sar_den,
                 src->i_sar_num,  src->i_sar_den, 50000 );
    if (dst->i_sar_num <= 0 || dst->i_sar_den <= 0) {
        dst->i_sar_num = 1;
        dst->i_sar_den = 1;
    }
    video_format_FixRgb(dst);
92
    return VLC_SUCCESS;
93 94
}

95 96
static vout_thread_t *VoutCreate(vlc_object_t *object,
                                 const vout_configuration_t *cfg)
Michel Kaempf's avatar
Michel Kaempf committed
97
{
98
    video_format_t original;
99
    if (VoutValidateFormat(&original, cfg->fmt))
100 101
        return NULL;

102
    /* Allocate descriptor */
Laurent Aimar's avatar
Laurent Aimar committed
103 104 105 106
    vout_thread_t *vout = vlc_custom_create(object,
                                            sizeof(*vout) + sizeof(*vout->p),
                                            VLC_OBJECT_VOUT, "video output");
    if (!vout) {
107
        video_format_Clean(&original);
108 109 110
        return NULL;
    }

111
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
112
    vout->p = (vout_thread_sys_t*)&vout[1];
113

Laurent Aimar's avatar
Laurent Aimar committed
114
    vout->p->original = original;
115
    vout->p->dpb_size = cfg->dpb_size;
116

Laurent Aimar's avatar
Laurent Aimar committed
117 118
    vout_control_Init(&vout->p->control);
    vout_control_PushVoid(&vout->p->control, VOUT_CONTROL_INIT);
119

Laurent Aimar's avatar
Laurent Aimar committed
120 121 122
    vout_statistic_Init(&vout->p->statistic);
    vout->p->i_par_num =
    vout->p->i_par_den = 1;
123

Laurent Aimar's avatar
Laurent Aimar committed
124
    vout_snapshot_Init(&vout->p->snapshot);
125

Gildas Bazin's avatar
 
Gildas Bazin committed
126
    /* Initialize locks */
Laurent Aimar's avatar
Laurent Aimar committed
127 128
    vlc_mutex_init(&vout->p->picture_lock);
    vlc_mutex_init(&vout->p->vfilter_lock);
Gildas Bazin's avatar
 
Gildas Bazin committed
129 130

    /* Attach the new object now so we can use var inheritance below */
Laurent Aimar's avatar
Laurent Aimar committed
131
    vlc_object_attach(vout, object);
Gildas Bazin's avatar
 
Gildas Bazin committed
132

133
    /* Initialize subpicture unit */
Laurent Aimar's avatar
Laurent Aimar committed
134
    vout->p->p_spu = spu_Create(vout);
135

136
    /* Take care of some "interface/control" related initialisations */
Laurent Aimar's avatar
Laurent Aimar committed
137
    vout_IntfInit(vout);
Gildas Bazin's avatar
 
Gildas Bazin committed
138

139
    /* Get splitter name if present */
Laurent Aimar's avatar
Laurent Aimar committed
140
    char *splitter_name = var_GetNonEmptyString(vout, "vout-filter");
141
    if (splitter_name) {
Laurent Aimar's avatar
Laurent Aimar committed
142 143
        if (asprintf(&vout->p->splitter_name, "%s,none", splitter_name) < 0)
            vout->p->splitter_name = NULL;
144 145
        free(splitter_name);
    } else {
Laurent Aimar's avatar
Laurent Aimar committed
146
        vout->p->splitter_name = NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
147 148
    }

Laurent Aimar's avatar
Laurent Aimar committed
149
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
150
    vout_InitInterlacingSupport(vout, vout->p->displayed.is_interlaced);
Laurent Aimar's avatar
Laurent Aimar committed
151 152

    /* */
Laurent Aimar's avatar
Laurent Aimar committed
153
    vlc_object_set_destructor(vout, VoutDestructor);
Gildas Bazin's avatar
 
Gildas Bazin committed
154

Laurent Aimar's avatar
Laurent Aimar committed
155
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
156 157 158
    if (vlc_clone(&vout->p->thread, Thread, vout,
                  VLC_THREAD_PRIORITY_OUTPUT)) {
        vlc_object_release(vout);
159 160 161
        return NULL;
    }

Laurent Aimar's avatar
Laurent Aimar committed
162
    vout_control_WaitEmpty(&vout->p->control);
163

Laurent Aimar's avatar
Laurent Aimar committed
164 165 166
    if (vout->p->dead) {
        msg_Err(vout, "video output creation failed");
        vout_CloseAndRelease(vout);
167
        return NULL;
168
    }
Michel Kaempf's avatar
Michel Kaempf committed
169

170 171 172 173
    vout->p->input = cfg->input;
    if (vout->p->input)
        spu_Attach(vout->p->p_spu, vout->p->input, true);

Laurent Aimar's avatar
Laurent Aimar committed
174
    return vout;
Michel Kaempf's avatar
Michel Kaempf committed
175 176
}

177 178 179 180
vout_thread_t *(vout_Request)(vlc_object_t *object,
                              const vout_configuration_t *cfg)
{
    vout_thread_t *vout = cfg->vout;
Laurent Aimar's avatar
Laurent Aimar committed
181
    if (cfg->change_fmt && !cfg->fmt) {
182 183 184 185 186 187 188
        if (vout)
            vout_CloseAndRelease(vout);
        return NULL;
    }

    /* If a vout is provided, try reusing it */
    if (vout) {
189 190 191 192 193 194 195
        if (vout->p->input != cfg->input) {
            if (vout->p->input)
                spu_Attach(vout->p->p_spu, vout->p->input, false);
            vout->p->input = cfg->input;
            if (vout->p->input)
                spu_Attach(vout->p->p_spu, vout->p->input, true);
        }
196

Laurent Aimar's avatar
Laurent Aimar committed
197 198 199 200 201 202 203 204
        if (cfg->change_fmt) {
            vout_control_cmd_t cmd;
            vout_control_cmd_Init(&cmd, VOUT_CONTROL_REINIT);
            cmd.u.cfg = cfg;

            vout_control_Push(&vout->p->control, &cmd);
            vout_control_WaitEmpty(&vout->p->control);
        }
205 206 207 208 209 210 211 212 213 214 215 216

        if (!vout->p->dead) {
            msg_Dbg(object, "reusing provided vout");
            return vout;
        }
        vout_CloseAndRelease(vout);

        msg_Warn(object, "cannot reuse provided vout");
    }
    return VoutCreate(object, cfg);
}

217
/*****************************************************************************
218
 * vout_Close: Close a vout created by VoutCreate.
219
 *****************************************************************************
220 221
 * You HAVE to call it on vout created by VoutCreate before vlc_object_release.
 * You should NEVER call it on vout not obtained through VoutCreate
222
 * (like with vout_Request or vlc_object_find.)
223
 * You can use vout_CloseAndRelease() as a convenience method.
224
 *****************************************************************************/
Laurent Aimar's avatar
Laurent Aimar committed
225
void vout_Close(vout_thread_t *vout)
226
{
Laurent Aimar's avatar
Laurent Aimar committed
227
    assert(vout);
228

229 230
    if (vout->p->input)
        spu_Attach(vout->p->p_spu, vout->p->input, false);
231
    vlc_object_detach(vout->p->p_spu);
232

Laurent Aimar's avatar
Laurent Aimar committed
233
    vout_snapshot_End(&vout->p->snapshot);
234

Laurent Aimar's avatar
Laurent Aimar committed
235 236
    vout_control_PushVoid(&vout->p->control, VOUT_CONTROL_CLEAN);
    vlc_join(vout->p->thread, NULL);
237 238 239
}

/* */
Laurent Aimar's avatar
Laurent Aimar committed
240
static void VoutDestructor(vlc_object_t *object)
241
{
Laurent Aimar's avatar
Laurent Aimar committed
242
    vout_thread_t *vout = (vout_thread_t *)object;
243

244
    /* Make sure the vout was stopped first */
Laurent Aimar's avatar
Laurent Aimar committed
245
    //assert(!vout->p_module);
246

Laurent Aimar's avatar
Laurent Aimar committed
247
    free(vout->p->splitter_name);
248

Laurent Aimar's avatar
Laurent Aimar committed
249
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
250
    spu_Destroy(vout->p->p_spu);
251

252
    /* Destroy the locks */
Laurent Aimar's avatar
Laurent Aimar committed
253 254 255
    vlc_mutex_destroy(&vout->p->picture_lock);
    vlc_mutex_destroy(&vout->p->vfilter_lock);
    vout_control_Clean(&vout->p->control);
256

257
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
258
    vout_statistic_Clean(&vout->p->statistic);
259

260
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
261
    vout_snapshot_Clean(&vout->p->snapshot);
262

Laurent Aimar's avatar
Laurent Aimar committed
263
    video_format_Clean(&vout->p->original);
Michel Kaempf's avatar
Michel Kaempf committed
264 265
}

Laurent Aimar's avatar
Laurent Aimar committed
266
/* */
267
void vout_ChangePause(vout_thread_t *vout, bool is_paused, mtime_t date)
Laurent Aimar's avatar
Laurent Aimar committed
268
{
269 270 271 272 273
    vout_control_cmd_t cmd;
    vout_control_cmd_Init(&cmd, VOUT_CONTROL_PAUSE);
    cmd.u.pause.is_on = is_paused;
    cmd.u.pause.date  = date;
    vout_control_Push(&vout->p->control, &cmd);
Laurent Aimar's avatar
Laurent Aimar committed
274

275
    vout_control_WaitEmpty(&vout->p->control);
Laurent Aimar's avatar
Laurent Aimar committed
276
}
277

Laurent Aimar's avatar
Laurent Aimar committed
278
void vout_GetResetStatistic(vout_thread_t *vout, int *displayed, int *lost)
279
{
Laurent Aimar's avatar
Laurent Aimar committed
280
    vout_statistic_GetReset( &vout->p->statistic, displayed, lost );
281
}
282

283
void vout_Flush(vout_thread_t *vout, mtime_t date)
284
{
285 286
    vout_control_PushTime(&vout->p->control, VOUT_CONTROL_FLUSH, date);
    vout_control_WaitEmpty(&vout->p->control);
287
}
288

289
void vout_Reset(vout_thread_t *vout)
290
{
291 292
    vout_control_PushVoid(&vout->p->control, VOUT_CONTROL_RESET);
    vout_control_WaitEmpty(&vout->p->control);
293
}
294

295 296 297 298 299 300 301 302 303 304 305 306 307
bool vout_IsEmpty(vout_thread_t *vout)
{
    vlc_mutex_lock(&vout->p->picture_lock);

    picture_t *picture = picture_fifo_Peek(vout->p->decoder_fifo);
    if (picture)
        picture_Release(picture);

    vlc_mutex_unlock(&vout->p->picture_lock);

    return !picture;
}

308
void vout_FixLeaks( vout_thread_t *vout )
309 310 311 312 313 314
{
    vlc_mutex_lock(&vout->p->picture_lock);

    picture_t *picture = picture_fifo_Peek(vout->p->decoder_fifo);
    if (!picture) {
        picture = picture_pool_Get(vout->p->decoder_pool);
315
    }
316 317 318 319 320 321

    if (picture) {
        picture_Release(picture);
        /* Not all pictures has been displayed yet or some are
         * free */
        vlc_mutex_unlock(&vout->p->picture_lock);
322 323 324
        return;
    }

325 326 327
    /* There is no reason that no pictures are available, force one
     * from the pool, becarefull with it though */
    msg_Err(vout, "pictures leaked, trying to workaround");
Laurent Aimar's avatar
Laurent Aimar committed
328

329 330
    /* */
    picture_pool_NonEmpty(vout->p->decoder_pool, false);
Laurent Aimar's avatar
Laurent Aimar committed
331

332
    vlc_mutex_unlock(&vout->p->picture_lock);
333
}
334
void vout_NextPicture(vout_thread_t *vout, mtime_t *duration)
Laurent Aimar's avatar
Laurent Aimar committed
335
{
336 337 338
    vout_control_cmd_t cmd;
    vout_control_cmd_Init(&cmd, VOUT_CONTROL_STEP);
    cmd.u.time_ptr = duration;
Laurent Aimar's avatar
Laurent Aimar committed
339

340 341
    vout_control_Push(&vout->p->control, &cmd);
    vout_control_WaitEmpty(&vout->p->control);
Laurent Aimar's avatar
Laurent Aimar committed
342
}
343

344
void vout_DisplayTitle(vout_thread_t *vout, const char *title)
345
{
346 347
    assert(title);
    vout_control_PushString(&vout->p->control, VOUT_CONTROL_OSD_TITLE, title);
348
}
349

350 351
void vout_PutSubpicture( vout_thread_t *vout, subpicture_t *subpic )
{
352 353 354 355 356
    vout_control_cmd_t cmd;
    vout_control_cmd_Init(&cmd, VOUT_CONTROL_SUBPICTURE);
    cmd.u.subpicture = subpic;

    vout_control_Push(&vout->p->control, &cmd);
357 358 359
}
int vout_RegisterSubpictureChannel( vout_thread_t *vout )
{
360 361 362 363 364 365 366 367 368 369
    int channel = SPU_DEFAULT_CHANNEL;

    vout_control_cmd_t cmd;
    vout_control_cmd_Init(&cmd, VOUT_CONTROL_REGISTER_SUBPICTURE);
    cmd.u.integer_ptr = &channel;

    vout_control_Push(&vout->p->control, &cmd);
    vout_control_WaitEmpty(&vout->p->control);

    return channel;
370 371 372
}
void vout_FlushSubpictureChannel( vout_thread_t *vout, int channel )
{
373 374
    vout_control_PushInteger(&vout->p->control, VOUT_CONTROL_FLUSH_SUBPICTURE,
                             channel);
375 376
}

377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
/* vout_Control* are usable by anyone at anytime */
void vout_ControlChangeFullscreen(vout_thread_t *vout, bool fullscreen)
{
    vout_control_PushBool(&vout->p->control, VOUT_CONTROL_FULLSCREEN,
                          fullscreen);
}
void vout_ControlChangeOnTop(vout_thread_t *vout, bool is_on_top)
{
    vout_control_PushBool(&vout->p->control, VOUT_CONTROL_ON_TOP,
                          is_on_top);
}
void vout_ControlChangeDisplayFilled(vout_thread_t *vout, bool is_filled)
{
    vout_control_PushBool(&vout->p->control, VOUT_CONTROL_DISPLAY_FILLED,
                          is_filled);
}
void vout_ControlChangeZoom(vout_thread_t *vout, int num, int den)
{
    vout_control_PushPair(&vout->p->control, VOUT_CONTROL_ZOOM,
                          num, den);
}
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
void vout_ControlChangeSampleAspectRatio(vout_thread_t *vout,
                                         unsigned num, unsigned den)
{
    vout_control_PushPair(&vout->p->control, VOUT_CONTROL_ASPECT_RATIO,
                          num, den);
}
void vout_ControlChangeCropRatio(vout_thread_t *vout,
                                 unsigned num, unsigned den)
{
    vout_control_PushPair(&vout->p->control, VOUT_CONTROL_CROP_RATIO,
                          num, den);
}
void vout_ControlChangeCropWindow(vout_thread_t *vout,
                                  int x, int y, int width, int height)
{
    vout_control_cmd_t cmd;
    vout_control_cmd_Init(&cmd, VOUT_CONTROL_CROP_WINDOW);
    cmd.u.window.x      = x;
    cmd.u.window.y      = y;
    cmd.u.window.width  = width;
    cmd.u.window.height = height;

    vout_control_Push(&vout->p->control, &cmd);
}
void vout_ControlChangeCropBorder(vout_thread_t *vout,
                                  int left, int top, int right, int bottom)
{
    vout_control_cmd_t cmd;
    vout_control_cmd_Init(&cmd, VOUT_CONTROL_CROP_BORDER);
    cmd.u.border.left   = left;
    cmd.u.border.top    = top;
    cmd.u.border.right  = right;
    cmd.u.border.bottom = bottom;

    vout_control_Push(&vout->p->control, &cmd);
}
434 435 436 437 438
void vout_ControlChangeFilters(vout_thread_t *vout, const char *filters)
{
    vout_control_PushString(&vout->p->control, VOUT_CONTROL_CHANGE_FILTERS,
                            filters);
}
439 440 441 442 443
void vout_ControlChangeSubFilters(vout_thread_t *vout, const char *filters)
{
    vout_control_PushString(&vout->p->control, VOUT_CONTROL_CHANGE_SUB_FILTERS,
                            filters);
}
444

445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
/* */
static void VoutGetDisplayCfg(vout_thread_t *vout, vout_display_cfg_t *cfg, const char *title)
{
    /* Load configuration */
    cfg->is_fullscreen = var_CreateGetBool(vout, "fullscreen");
    cfg->display.title = title;
    const int display_width = var_CreateGetInteger(vout, "width");
    const int display_height = var_CreateGetInteger(vout, "height");
    cfg->display.width   = display_width > 0  ? display_width  : 0;
    cfg->display.height  = display_height > 0 ? display_height : 0;
    cfg->is_display_filled  = var_CreateGetBool(vout, "autoscale");
    cfg->display.sar.num = 1; /* TODO monitor AR */
    cfg->display.sar.den = 1;
    unsigned zoom_den = 1000;
    unsigned zoom_num = zoom_den * var_CreateGetFloat(vout, "scale");
    vlc_ureduce(&zoom_num, &zoom_den, zoom_num, zoom_den, 0);
    cfg->zoom.num = zoom_num;
    cfg->zoom.den = zoom_den;
    cfg->align.vertical = VOUT_DISPLAY_ALIGN_CENTER;
    cfg->align.horizontal = VOUT_DISPLAY_ALIGN_CENTER;
    const int align_mask = var_CreateGetInteger(vout, "align");
    if (align_mask & 0x1)
        cfg->align.horizontal = VOUT_DISPLAY_ALIGN_LEFT;
    else if (align_mask & 0x2)
        cfg->align.horizontal = VOUT_DISPLAY_ALIGN_RIGHT;
    if (align_mask & 0x4)
        cfg->align.horizontal = VOUT_DISPLAY_ALIGN_TOP;
    else if (align_mask & 0x8)
        cfg->align.horizontal = VOUT_DISPLAY_ALIGN_BOTTOM;
}

vout_window_t * vout_NewDisplayWindow(vout_thread_t *vout, vout_display_t *vd,
                                      const vout_window_cfg_t *cfg)
{
    VLC_UNUSED(vd);
    vout_window_cfg_t cfg_override = *cfg;

    if (!var_InheritBool( vout, "embedded-video"))
        cfg_override.is_standalone = true;

    if (vout->p->window.is_unused && vout->p->window.object) {
        assert(!vout->p->splitter_name);
        if (!cfg_override.is_standalone == !vout->p->window.cfg.is_standalone &&
            cfg_override.type           == vout->p->window.cfg.type) {
            /* Reuse the stored window */
            msg_Dbg(vout, "Reusing previous vout window");
            vout_window_t *window = vout->p->window.object;
            if (cfg_override.width  != vout->p->window.cfg.width ||
                cfg_override.height != vout->p->window.cfg.height)
                vout_window_SetSize(window,
                                    cfg_override.width, cfg_override.height);
            vout->p->window.is_unused = false;
            vout->p->window.cfg       = cfg_override;
            return window;
        }

        vout_window_Delete(vout->p->window.object);
        vout->p->window.is_unused = true;
        vout->p->window.object    = NULL;
    }

    vout_window_t *window = vout_window_New(VLC_OBJECT(vout), NULL,
                                            &cfg_override);
    if (!window)
        return NULL;
    if (!vout->p->splitter_name) {
        vout->p->window.is_unused = false;
        vout->p->window.cfg       = cfg_override;
        vout->p->window.object    = window;
    }
    return window;
}

void vout_DeleteDisplayWindow(vout_thread_t *vout, vout_display_t *vd,
                              vout_window_t *window)
{
    VLC_UNUSED(vd);
522
    if (!vout->p->window.is_unused && vout->p->window.object == window) {
523
        vout->p->window.is_unused = true;
524 525 526 527 528
    } else if (vout->p->window.is_unused && vout->p->window.object && !window) {
        vout_window_Delete(vout->p->window.object);
        vout->p->window.is_unused = true;
        vout->p->window.object    = NULL;
    } else if (window) {
529
        vout_window_Delete(window);
530
    }
531 532
}

533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
/* */
static picture_t *VoutVideoFilterNewPicture(filter_t *filter)
{
    vout_thread_t *vout = (vout_thread_t*)filter->p_owner;
    return picture_pool_Get(vout->p->private_pool);
}
static void VoutVideoFilterDelPicture(filter_t *filter, picture_t *picture)
{
    VLC_UNUSED(filter);
    picture_Release(picture);
}
static int VoutVideoFilterAllocationSetup(filter_t *filter, void *data)
{
    filter->pf_video_buffer_new = VoutVideoFilterNewPicture;
    filter->pf_video_buffer_del = VoutVideoFilterDelPicture;
    filter->p_owner             = data; /* vout */
    return VLC_SUCCESS;
}
551

Laurent Aimar's avatar
Laurent Aimar committed
552
/* */
553 554
static int ThreadDisplayPicture(vout_thread_t *vout,
                                bool now, mtime_t *deadline)
Vincent Seguin's avatar
Vincent Seguin committed
555
{
556
    vout_display_t *vd = vout->p->display.vd;
557 558 559 560 561
    int displayed_count = 0;
    int lost_count = 0;

    for (;;) {
        const mtime_t date = mdate();
Laurent Aimar's avatar
Laurent Aimar committed
562
        const bool is_paused = vout->p->pause.is_on;
563
        bool redisplay = is_paused && !now && vout->p->displayed.decoded;
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
        bool is_forced;

        /* FIXME/XXX we must redisplay the last decoded picture (because
         * of potential vout updated, or filters update or SPU update)
         * For now a high update period is needed but it coulmd be removed
         * if and only if:
         * - vout module emits events from theselves.
         * - *and* SPU is modified to emit an event or a deadline when needed.
         *
         * So it will be done latter.
         */
        if (!redisplay) {
            picture_t *peek = picture_fifo_Peek(vout->p->decoder_fifo);
            if (peek) {
                is_forced = peek->b_force || is_paused || now;
                *deadline = (is_forced ? date : peek->date) - vout_chrono_GetHigh(&vout->p->render);
                picture_Release(peek);
            } else {
                redisplay = true;
583 584
            }
        }
585 586
        if (redisplay) {
             /* FIXME a better way for this delay is needed */
Laurent Aimar's avatar
Laurent Aimar committed
587
            const mtime_t date_update = vout->p->displayed.date + VOUT_REDISPLAY_DELAY;
588 589 590
            if (date_update > date || !vout->p->displayed.decoded) {
                *deadline = vout->p->displayed.decoded ? date_update : VLC_TS_INVALID;
                break;
Laurent Aimar's avatar
Laurent Aimar committed
591
            }
592 593 594
            /* */
            is_forced = true;
            *deadline = date - vout_chrono_GetHigh(&vout->p->render);
Laurent Aimar's avatar
Laurent Aimar committed
595
        }
Laurent Aimar's avatar
Laurent Aimar committed
596 597
        if (*deadline > VOUT_MWAIT_TOLERANCE)
            *deadline -= VOUT_MWAIT_TOLERANCE;
Laurent Aimar's avatar
Laurent Aimar committed
598

Laurent Aimar's avatar
Laurent Aimar committed
599
        /* If we are too early and can wait, do it */
600 601
        if (date < *deadline && !now)
            break;
602

603 604 605 606 607 608 609 610 611 612 613 614
        picture_t *decoded;
        if (redisplay) {
            decoded = vout->p->displayed.decoded;
            vout->p->displayed.decoded = NULL;
        } else {
            decoded = picture_fifo_Pop(vout->p->decoder_fifo);
            assert(decoded);
            if (!is_forced && !vout->p->is_late_dropped) {
                const mtime_t predicted = date + vout_chrono_GetLow(&vout->p->render);
                const mtime_t late = predicted - decoded->date;
                if (late > 0) {
                    msg_Dbg(vout, "picture might be displayed late (missing %d ms)", (int)(late/1000));
Laurent Aimar's avatar
Laurent Aimar committed
615
                    if (late > VOUT_DISPLAY_LATE_THRESHOLD) {
616 617 618 619 620
                        msg_Warn(vout, "rejected picture because of render time");
                        /* TODO */
                        picture_Release(decoded);
                        lost_count++;
                        break;
Laurent Aimar's avatar
Laurent Aimar committed
621 622 623
                    }
                }
            }
624 625 626

            vout->p->displayed.is_interlaced = !decoded->b_progressive;
            vout->p->displayed.qtype         = decoded->i_qtype;
627
        }
Laurent Aimar's avatar
Laurent Aimar committed
628
        vout->p->displayed.timestamp = decoded->date;
629 630

        /* */
631 632 633 634
        if (vout->p->displayed.decoded)
            picture_Release(vout->p->displayed.decoded);
        picture_Hold(decoded);
        vout->p->displayed.decoded = decoded;
635

636 637
        /* */
        vout_chrono_Start(&vout->p->render);
638

639 640 641
        picture_t *filtered = NULL;
        if (decoded) {
            vlc_mutex_lock(&vout->p->vfilter_lock);
Laurent Aimar's avatar
Laurent Aimar committed
642
            filtered = filter_chain_VideoFilter(vout->p->vfilter_chain, decoded);
643 644 645 646
            //assert(filtered == decoded); // TODO implement
            vlc_mutex_unlock(&vout->p->vfilter_lock);
            if (!filtered)
                continue;
647
        }
648

Sam Hocevar's avatar
 
Sam Hocevar committed
649 650 651
        /*
         * Check for subpictures to display
         */
652 653
        const bool do_snapshot = vout_snapshot_IsRequested(&vout->p->snapshot);
        mtime_t spu_render_time = is_forced ? mdate() : filtered->date;
Laurent Aimar's avatar
Laurent Aimar committed
654 655
        if (vout->p->pause.is_on)
            spu_render_time = vout->p->pause.date;
656
        else
657
            spu_render_time = filtered->date > 1 ? filtered->date : mdate();
658

659 660 661
        subpicture_t *subpic = spu_SortSubpictures(vout->p->p_spu,
                                                   spu_render_time,
                                                   do_snapshot);
Sam Hocevar's avatar
 
Sam Hocevar committed
662 663
        /*
         * Perform rendering
664 665 666 667
         *
         * We have to:
         * - be sure to end up with a direct buffer.
         * - blend subtitles, and in a fast access buffer
Sam Hocevar's avatar
 
Sam Hocevar committed
668
         */
669 670 671 672 673
        picture_t *direct = NULL;
        if (filtered &&
            (vout->p->decoder_pool != vout->p->display_pool || subpic)) {
            picture_t *render;
            if (vout->p->is_decoder_pool_slow)
674
                render = picture_NewFromFormat(&vd->source);
675 676 677 678
            else if (vout->p->decoder_pool != vout->p->display_pool)
                render = picture_pool_Get(vout->p->display_pool);
            else
                render = picture_pool_Get(vout->p->private_pool);
Sam Hocevar's avatar
 
Sam Hocevar committed
679

680 681
            if (render) {
                picture_Copy(render, filtered);
682

683
                spu_RenderSubpictures(vout->p->p_spu,
684 685
                                      render, &vd->source,
                                      subpic, &vd->source, spu_render_time);
686 687 688 689 690 691 692 693 694 695 696 697 698 699
            }
            if (vout->p->is_decoder_pool_slow) {
                direct = picture_pool_Get(vout->p->display_pool);
                if (direct)
                    picture_Copy(direct, render);
                picture_Release(render);

            } else {
                direct = render;
            }
            picture_Release(filtered);
            filtered = NULL;
        } else {
            direct = filtered;
Sam Hocevar's avatar
 
Sam Hocevar committed
700 701
        }

Sam Hocevar's avatar
 
Sam Hocevar committed
702
        /*
703
         * Take a snapshot if requested
Sam Hocevar's avatar
 
Sam Hocevar committed
704
         */
705
        if (direct && do_snapshot)
706
            vout_snapshot_Set(&vout->p->snapshot, &vd->source, direct);
707

708 709 710
        /* Render the direct buffer returned by vout_RenderPicture */
        if (direct) {
            vout_RenderWrapper(vout, direct);
Sam Hocevar's avatar
 
Sam Hocevar committed
711

712 713
            vout_chrono_Stop(&vout->p->render);
#if 0
Gildas Bazin's avatar
 
Gildas Bazin committed
714
            {
715 716 717 718
            static int i = 0;
            if (((i++)%10) == 0)
                msg_Info(vout, "render: avg %d ms var %d ms",
                         (int)(vout->p->render.avg/1000), (int)(vout->p->render.var/1000));
Gildas Bazin's avatar
 
Gildas Bazin committed
719
            }
720
#endif
721
        }
722

723 724 725
        /* Wait the real date (for rendering jitter) */
        if (!is_forced)
            mwait(decoded->date);
Sam Hocevar's avatar
 
Sam Hocevar committed
726

727
        /* Display the direct buffer returned by vout_RenderPicture */
Laurent Aimar's avatar
Laurent Aimar committed
728
        vout->p->displayed.date = mdate();
729 730
        if (direct)
            vout_DisplayWrapper(vout, direct);
Vincent Seguin's avatar
Vincent Seguin committed
731

732 733 734
        displayed_count++;
        break;
    }
Vincent Seguin's avatar
Vincent Seguin committed
735

736 737 738 739 740
    vout_statistic_Update(&vout->p->statistic, displayed_count, lost_count);
    if (displayed_count <= 0)
        return VLC_EGENERIC;
    return VLC_SUCCESS;
}
741

Laurent Aimar's avatar
Laurent Aimar committed
742 743 744 745
static void ThreadManage(vout_thread_t *vout,
                         mtime_t *deadline,
                         vout_interlacing_support_t *interlacing,
                         vout_postprocessing_support_t *postprocessing)
Laurent Aimar's avatar
Laurent Aimar committed
746 747 748 749
{
    vlc_mutex_lock(&vout->p->picture_lock);

    *deadline = VLC_TS_INVALID;
750
    ThreadDisplayPicture(vout, false, deadline);
Laurent Aimar's avatar
Laurent Aimar committed
751 752 753 754 755 756 757 758 759 760 761 762

    const int  picture_qtype      = vout->p->displayed.qtype;
    const bool picture_interlaced = vout->p->displayed.is_interlaced;

    vlc_mutex_unlock(&vout->p->picture_lock);

    /* Post processing */
    vout_SetPostProcessingState(vout, postprocessing, picture_qtype);

    /* Deinterlacing */
    vout_SetInterlacingState(vout, interlacing, picture_interlaced);

Laurent Aimar's avatar
Laurent Aimar committed
763
    vout_ManageWrapper(vout);
Laurent Aimar's avatar
Laurent Aimar committed
764 765
}

766 767 768 769 770
static void ThreadDisplaySubpicture(vout_thread_t *vout,
                                    subpicture_t *subpicture)
{
    spu_DisplaySubpicture(vout->p->p_spu, subpicture);
}
771

772 773 774 775 776
static void ThreadRegisterSubpicture(vout_thread_t *vout, int *channel)
{
    *channel = spu_RegisterChannel(vout->p->p_spu);
}

777 778 779 780 781
static void ThreadFlushSubpicture(vout_thread_t *vout, int channel)
{
    spu_ClearChannel(vout->p->p_spu, channel);
}

782
static void ThreadDisplayOsdTitle(vout_thread_t *vout, const char *string)
Laurent Aimar's avatar
Laurent Aimar committed
783
{
784
    if (!vout->p->title.show)
Laurent Aimar's avatar
Laurent Aimar committed
785 786
        return;

787 788 789
    vout_OSDText(vout, SPU_DEFAULT_CHANNEL,
                 vout->p->title.position, INT64_C(1000) * vout->p->title.timeout,
                 string);
Laurent Aimar's avatar
Laurent Aimar committed
790 791
}

792
static void ThreadChangeFilters(vout_thread_t *vout, const char *filters)
Laurent Aimar's avatar
Laurent Aimar committed
793
{
794
    es_format_t fmt;
795 796
    es_format_Init(&fmt, VIDEO_ES, vout->p->original.i_chroma);
    fmt.video = vout->p->original;
797

Laurent Aimar's avatar
Laurent Aimar committed
798 799
    vlc_mutex_lock(&vout->p->vfilter_lock);

Laurent Aimar's avatar
Laurent Aimar committed
800 801
    filter_chain_Reset(vout->p->vfilter_chain, &fmt, &fmt);
    if (filter_chain_AppendFromString(vout->p->vfilter_chain,
802 803
                                      filters) < 0)
        msg_Err(vout, "Video filter chain creation failed");
Laurent Aimar's avatar
Laurent Aimar committed
804

805 806
    vlc_mutex_unlock(&vout->p->vfilter_lock);
}
Laurent Aimar's avatar
Laurent Aimar committed
807

808 809 810 811 812
static void ThreadChangeSubFilters(vout_thread_t *vout, const char *filters)
{
    spu_ChangeFilters(vout->p->p_spu, filters);
}

813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
static void ThreadChangePause(vout_thread_t *vout, bool is_paused, mtime_t date)
{
    assert(!vout->p->pause.is_on || !is_paused);

    if (vout->p->pause.is_on) {
        const mtime_t duration = date - vout->p->pause.date;

        if (vout->p->step.timestamp > VLC_TS_INVALID)
            vout->p->step.timestamp += duration;
        if (vout->p->step.last > VLC_TS_INVALID)
            vout->p->step.last += duration;
        picture_fifo_OffsetDate(vout->p->decoder_fifo, duration);
        if (vout->p->displayed.decoded)
            vout->p->displayed.decoded->date += duration;

        spu_OffsetSubtitleDate(vout->p->p_spu, duration);
    } else {
        vout->p->step.timestamp = VLC_TS_INVALID;
        vout->p->step.last      = VLC_TS_INVALID;
Laurent Aimar's avatar
Laurent Aimar committed
832
    }
833 834
    vout->p->pause.is_on = is_paused;
    vout->p->pause.date  = date;
Laurent Aimar's avatar
Laurent Aimar committed
835 836
}

837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885
static void ThreadFlush(vout_thread_t *vout, bool below, mtime_t date)
{
    vout->p->step.timestamp = VLC_TS_INVALID;
    vout->p->step.last      = VLC_TS_INVALID;

    picture_t *last = vout->p->displayed.decoded;
    if (last) {
        if (( below && last->date <= date) ||
            (!below && last->date >= date)) {
            picture_Release(last);

            vout->p->displayed.decoded   = NULL;
            vout->p->displayed.date      = VLC_TS_INVALID;
            vout->p->displayed.timestamp = VLC_TS_INVALID;
        }
    }
    picture_fifo_Flush(vout->p->decoder_fifo, date, below);
}

static void ThreadReset(vout_thread_t *vout)
{
    ThreadFlush(vout, true, INT64_MAX);
    if (vout->p->decoder_pool)
        picture_pool_NonEmpty(vout->p->decoder_pool, true);
    vout->p->pause.is_on = false;
    vout->p->pause.date  = mdate();
}

static void ThreadStep(vout_thread_t *vout, mtime_t *duration)
{
    *duration = 0;

    if (vout->p->step.last <= VLC_TS_INVALID)
        vout->p->step.last = vout->p->displayed.timestamp;

    mtime_t dummy;
    if (ThreadDisplayPicture(vout, true, &dummy))
        return;

    vout->p->step.timestamp = vout->p->displayed.timestamp;

    if (vout->p->step.last > VLC_TS_INVALID &&
        vout->p->step.timestamp > vout->p->step.last) {
        *duration = vout->p->step.timestamp - vout->p->step.last;
        vout->p->step.last = vout->p->step.timestamp;
        /* TODO advance subpicture by the duration ... */
    }
}

886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
static void ThreadChangeFullscreen(vout_thread_t *vout, bool fullscreen)
{
    /* FIXME not sure setting "fullscreen" is good ... */
    var_SetBool(vout, "fullscreen", fullscreen);
    vout_SetDisplayFullscreen(vout->p->display.vd, fullscreen);
}

static void ThreadChangeOnTop(vout_thread_t *vout, bool is_on_top)
{
    vout_SetWindowState(vout->p->display.vd,
                        is_on_top ? VOUT_WINDOW_STATE_ABOVE :
                                    VOUT_WINDOW_STATE_NORMAL);
}

static void ThreadChangeDisplayFilled(vout_thread_t *vout, bool is_filled)
{
    vout_SetDisplayFilled(vout->p->display.vd, is_filled);
}

static void ThreadChangeZoom(vout_thread_t *vout, int num, int den)
{
    if (num * 10 < den) {
        num = den;
        den *= 10;
    } else if (num > den * 10) {
        num = den * 10;
    }

    vout_SetDisplayZoom(vout->p->display.vd, num, den);
}
916

917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960
static void ThreadChangeAspectRatio(vout_thread_t *vout,
                                    unsigned num, unsigned den)
{
    const video_format_t *source = &vout->p->original;

    if (num > 0 && den > 0) {
        num *= source->i_visible_height;
        den *= source->i_visible_width;
        vlc_ureduce(&num, &den, num, den, 0);
    }
    vout_SetDisplayAspect(vout->p->display.vd, num, den);
}


static void ThreadExecuteCropWindow(vout_thread_t *vout,
                                    unsigned crop_num, unsigned crop_den,
                                    unsigned x, unsigned y,
                                    unsigned width, unsigned height)
{
    const video_format_t *source = &vout->p->original;

    vout_SetDisplayCrop(vout->p->display.vd,
                        crop_num, crop_den,
                        source->i_x_offset + x,
                        source->i_y_offset + y,
                        width, height);
}
static void ThreadExecuteCropBorder(vout_thread_t *vout,
                                    unsigned left, unsigned top,
                                    unsigned right, unsigned bottom)
{
    const video_format_t *source = &vout->p->original;
    ThreadExecuteCropWindow(vout, 0, 0,
                            left,
                            top,
                            /* At worst, it becomes < 0 (but unsigned) and will be rejected */
                            source->i_visible_width  - (left + right),
                            source->i_visible_height - (top  + bottom));
}

static void ThreadExecuteCropRatio(vout_thread_t *vout,
                                   unsigned num, unsigned den)
{
    const video_format_t *source = &vout->p->original;
961 962 963 964
    ThreadExecuteCropWindow(vout, num, den,
                            0, 0,
                            source->i_visible_width,
                            source->i_visible_height);
965 966
}

967
static int ThreadStart(vout_thread_t *vout, const vout_display_state_t *state)
Laurent Aimar's avatar
Laurent Aimar committed
968
{
969 970 971 972 973 974 975 976 977 978
    vlc_mouse_Init(&vout->p->mouse);
    vout->p->decoder_fifo = picture_fifo_New();
    vout->p->decoder_pool = NULL;
    vout->p->display_pool = NULL;
    vout->p->private_pool = NULL;

    vout->p->vfilter_chain =
        filter_chain_New( vout, "video filter2", false,
                          VoutVideoFilterAllocationSetup, NULL, vout);

979 980 981 982 983 984 985 986 987 988 989 990
    vout_display_state_t state_default;
    if (!state) {
        VoutGetDisplayCfg(vout, &state_default.cfg, vout->p->display.title);
        state_default.wm_state = var_CreateGetBool(vout, "video-on-top") ? VOUT_WINDOW_STATE_ABOVE :
                                                                           VOUT_WINDOW_STATE_NORMAL;
        state_default.sar.num = 0;
        state_default.sar.den = 0;

        state = &state_default;
    }

    if (vout_OpenWrapper(vout, vout->p->splitter_name, state))
Laurent Aimar's avatar
Laurent Aimar committed
991 992 993 994 995
        return VLC_EGENERIC;
    if (vout_InitWrapper(vout))
        return VLC_EGENERIC;
    assert(vout->p->decoder_pool);

996 997 998 999 1000 1001 1002 1003 1004 1005
    vout->p->displayed.decoded       = NULL;
    vout->p->displayed.date          = VLC_TS_INVALID;
    vout->p->displayed.decoded       = NULL;
    vout->p->displayed.timestamp     = VLC_TS_INVALID;
    vout->p->displayed.qtype         = QTYPE_NONE;
    vout->p->displayed.is_interlaced = false;

    vout->p->step.last               = VLC_TS_INVALID;
    vout->p->step.timestamp          = VLC_TS_INVALID;

Laurent Aimar's avatar
Laurent Aimar committed
1006
    video_format_Print(VLC_OBJECT(vout), "original format", &vout->p->original);
Laurent Aimar's avatar
Laurent Aimar committed
1007 1008 1009
    return VLC_SUCCESS;
}

1010
static void ThreadStop(vout_thread_t *vout, vout_display_state_t *state)
1011
{
Laurent Aimar's avatar
Laurent Aimar committed
1012 1013 1014
    /* Destroy the video filters2 */
    filter_chain_Delete(vout->p->vfilter_chain);

1015
    /* Destroy translation tables */
Laurent Aimar's avatar
Laurent Aimar committed
1016 1017 1018 1019 1020
    if (vout->p->display.vd) {
        if (vout->p->decoder_pool) {
            ThreadFlush(vout, true, INT64_MAX);
            vout_EndWrapper(vout);
        }
1021
        vout_CloseWrapper(vout, state);
1022
    }
Laurent Aimar's avatar
Laurent Aimar committed
1023

1024 1025 1026
    if (vout->p->decoder_fifo)
        picture_fifo_Delete(vout->p->decoder_fifo);
    assert(!vout->p->decoder_pool);
1027 1028 1029 1030
}

static void ThreadInit(vout_thread_t *vout)
{
1031 1032 1033 1034 1035 1036
    vout->p->window.is_unused = true;
    vout->p->window.object    = NULL;
    vout->p->dead             = false;
    vout->p->is_late_dropped  = var_InheritBool(vout, "drop-late-frames");
    vout->p->pause.is_on      = false;
    vout->p->pause.date       = VLC_TS_INVALID;
1037 1038 1039

    vout_chrono_Init(&vout->p->render, 5, 10000); /* Arbitrary initial time */
}
1040

1041 1042
static void ThreadClean(vout_thread_t *vout)
{
1043 1044 1045 1046
    if (vout->p->window.object) {
        assert(vout->p->window.is_unused);
        vout_window_Delete(vout->p->window.object);
    }
1047
    vout_chrono_Clean(&vout->p->render);
Laurent Aimar's avatar
Laurent Aimar committed
1048 1049
    vout->p->dead =