video_output.c 38.6 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);
129
    vlc_mutex_init(&vout->p->spu_lock);
Gildas Bazin's avatar
 
Gildas Bazin committed
130 131

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

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

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

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

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

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

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

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

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

172 173 174 175
    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
176
    return vout;
Michel Kaempf's avatar
Michel Kaempf committed
177 178
}

179 180 181 182
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
183
    if (cfg->change_fmt && !cfg->fmt) {
184 185 186 187 188 189 190
        if (vout)
            vout_CloseAndRelease(vout);
        return NULL;
    }

    /* If a vout is provided, try reusing it */
    if (vout) {
191 192 193 194 195 196 197
        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);
        }
198

Laurent Aimar's avatar
Laurent Aimar committed
199 200 201 202 203 204 205 206
        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);
        }
207 208 209 210 211 212 213 214 215 216 217 218

        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);
}

Laurent Aimar's avatar
Laurent Aimar committed
219
void vout_Close(vout_thread_t *vout)
220
{
Laurent Aimar's avatar
Laurent Aimar committed
221
    assert(vout);
222

223 224
    if (vout->p->input)
        spu_Attach(vout->p->p_spu, vout->p->input, false);
225

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

Laurent Aimar's avatar
Laurent Aimar committed
228 229
    vout_control_PushVoid(&vout->p->control, VOUT_CONTROL_CLEAN);
    vlc_join(vout->p->thread, NULL);
230

231
    vlc_mutex_lock(&vout->p->spu_lock);
232
    spu_Destroy(vout->p->p_spu);
233 234
    vout->p->p_spu = NULL;
    vlc_mutex_unlock(&vout->p->spu_lock);
235 236 237
}

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

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

Laurent Aimar's avatar
Laurent Aimar committed
245
    free(vout->p->splitter_name);
246

247
    /* Destroy the locks */
248
    vlc_mutex_destroy(&vout->p->spu_lock);
Laurent Aimar's avatar
Laurent Aimar committed
249 250 251
    vlc_mutex_destroy(&vout->p->picture_lock);
    vlc_mutex_destroy(&vout->p->vfilter_lock);
    vout_control_Clean(&vout->p->control);
252

253
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
254
    vout_statistic_Clean(&vout->p->statistic);
255

256
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
257
    vout_snapshot_Clean(&vout->p->snapshot);
258

Laurent Aimar's avatar
Laurent Aimar committed
259
    video_format_Clean(&vout->p->original);
Michel Kaempf's avatar
Michel Kaempf committed
260 261
}

Laurent Aimar's avatar
Laurent Aimar committed
262
/* */
263
void vout_ChangePause(vout_thread_t *vout, bool is_paused, mtime_t date)
Laurent Aimar's avatar
Laurent Aimar committed
264
{
265 266 267 268 269
    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
270

271
    vout_control_WaitEmpty(&vout->p->control);
Laurent Aimar's avatar
Laurent Aimar committed
272
}
273

Laurent Aimar's avatar
Laurent Aimar committed
274
void vout_GetResetStatistic(vout_thread_t *vout, int *displayed, int *lost)
275
{
Laurent Aimar's avatar
Laurent Aimar committed
276
    vout_statistic_GetReset( &vout->p->statistic, displayed, lost );
277
}
278

279
void vout_Flush(vout_thread_t *vout, mtime_t date)
280
{
281 282
    vout_control_PushTime(&vout->p->control, VOUT_CONTROL_FLUSH, date);
    vout_control_WaitEmpty(&vout->p->control);
283
}
284

285
void vout_Reset(vout_thread_t *vout)
286
{
287 288
    vout_control_PushVoid(&vout->p->control, VOUT_CONTROL_RESET);
    vout_control_WaitEmpty(&vout->p->control);
289
}
290

291 292 293 294 295 296 297 298 299 300 301 302 303
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;
}

304
void vout_FixLeaks( vout_thread_t *vout )
305 306 307 308 309 310
{
    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);
311
    }
312 313 314 315 316 317

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

321 322 323
    /* 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
324

325 326
    /* */
    picture_pool_NonEmpty(vout->p->decoder_pool, false);
Laurent Aimar's avatar
Laurent Aimar committed
327

328
    vlc_mutex_unlock(&vout->p->picture_lock);
329
}
330
void vout_NextPicture(vout_thread_t *vout, mtime_t *duration)
Laurent Aimar's avatar
Laurent Aimar committed
331
{
332 333 334
    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
335

336 337
    vout_control_Push(&vout->p->control, &cmd);
    vout_control_WaitEmpty(&vout->p->control);
Laurent Aimar's avatar
Laurent Aimar committed
338
}
339

340
void vout_DisplayTitle(vout_thread_t *vout, const char *title)
341
{
342 343
    assert(title);
    vout_control_PushString(&vout->p->control, VOUT_CONTROL_OSD_TITLE, title);
344
}
345

346 347
void vout_PutSubpicture( vout_thread_t *vout, subpicture_t *subpic )
{
348 349 350 351 352
    vout_control_cmd_t cmd;
    vout_control_cmd_Init(&cmd, VOUT_CONTROL_SUBPICTURE);
    cmd.u.subpicture = subpic;

    vout_control_Push(&vout->p->control, &cmd);
353 354 355
}
int vout_RegisterSubpictureChannel( vout_thread_t *vout )
{
356 357 358 359 360 361 362 363
    int channel = SPU_DEFAULT_CHANNEL;

    vlc_mutex_lock(&vout->p->spu_lock);
    if (vout->p->p_spu)
        channel = spu_RegisterChannel(vout->p->p_spu);
    vlc_mutex_unlock(&vout->p->spu_lock);

    return channel;
364 365 366
}
void vout_FlushSubpictureChannel( vout_thread_t *vout, int channel )
{
367 368
    vout_control_PushInteger(&vout->p->control, VOUT_CONTROL_FLUSH_SUBPICTURE,
                             channel);
369 370
}

371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
/* 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);
}
392 393 394 395 396 397 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
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);
}
428 429 430 431 432
void vout_ControlChangeFilters(vout_thread_t *vout, const char *filters)
{
    vout_control_PushString(&vout->p->control, VOUT_CONTROL_CHANGE_FILTERS,
                            filters);
}
433 434 435 436 437
void vout_ControlChangeSubFilters(vout_thread_t *vout, const char *filters)
{
    vout_control_PushString(&vout->p->control, VOUT_CONTROL_CHANGE_SUB_FILTERS,
                            filters);
}
438

439 440 441 442 443 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
/* */
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);
516
    if (!vout->p->window.is_unused && vout->p->window.object == window) {
517
        vout->p->window.is_unused = true;
518 519 520 521 522
    } 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) {
523
        vout_window_Delete(window);
524
    }
525 526
}

527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
/* */
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;
}
545

Laurent Aimar's avatar
Laurent Aimar committed
546
/* */
547 548
static int ThreadDisplayPicture(vout_thread_t *vout,
                                bool now, mtime_t *deadline)
Vincent Seguin's avatar
Vincent Seguin committed
549
{
550
    vout_display_t *vd = vout->p->display.vd;
551 552 553 554 555
    int displayed_count = 0;
    int lost_count = 0;

    for (;;) {
        const mtime_t date = mdate();
Laurent Aimar's avatar
Laurent Aimar committed
556
        const bool is_paused = vout->p->pause.is_on;
557
        bool redisplay = is_paused && !now && vout->p->displayed.decoded;
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
        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;
577 578
            }
        }
579 580
        if (redisplay) {
             /* FIXME a better way for this delay is needed */
Laurent Aimar's avatar
Laurent Aimar committed
581
            const mtime_t date_update = vout->p->displayed.date + VOUT_REDISPLAY_DELAY;
582 583 584
            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
585
            }
586 587 588
            /* */
            is_forced = true;
            *deadline = date - vout_chrono_GetHigh(&vout->p->render);
Laurent Aimar's avatar
Laurent Aimar committed
589
        }
Laurent Aimar's avatar
Laurent Aimar committed
590 591
        if (*deadline > VOUT_MWAIT_TOLERANCE)
            *deadline -= VOUT_MWAIT_TOLERANCE;
Laurent Aimar's avatar
Laurent Aimar committed
592

Laurent Aimar's avatar
Laurent Aimar committed
593
        /* If we are too early and can wait, do it */
594 595
        if (date < *deadline && !now)
            break;
596

597 598 599 600 601 602 603 604 605 606 607 608
        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
609
                    if (late > VOUT_DISPLAY_LATE_THRESHOLD) {
610 611 612 613 614
                        msg_Warn(vout, "rejected picture because of render time");
                        /* TODO */
                        picture_Release(decoded);
                        lost_count++;
                        break;
Laurent Aimar's avatar
Laurent Aimar committed
615 616 617
                    }
                }
            }
618 619 620

            vout->p->displayed.is_interlaced = !decoded->b_progressive;
            vout->p->displayed.qtype         = decoded->i_qtype;
621
        }
Laurent Aimar's avatar
Laurent Aimar committed
622
        vout->p->displayed.timestamp = decoded->date;
623 624

        /* */
625 626 627 628
        if (vout->p->displayed.decoded)
            picture_Release(vout->p->displayed.decoded);
        picture_Hold(decoded);
        vout->p->displayed.decoded = decoded;
629

630 631
        /* */
        vout_chrono_Start(&vout->p->render);
632

633 634 635
        picture_t *filtered = NULL;
        if (decoded) {
            vlc_mutex_lock(&vout->p->vfilter_lock);
Laurent Aimar's avatar
Laurent Aimar committed
636
            filtered = filter_chain_VideoFilter(vout->p->vfilter_chain, decoded);
637 638 639 640
            //assert(filtered == decoded); // TODO implement
            vlc_mutex_unlock(&vout->p->vfilter_lock);
            if (!filtered)
                continue;
641
        }
642

Sam Hocevar's avatar
 
Sam Hocevar committed
643 644 645
        /*
         * Check for subpictures to display
         */
646 647
        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
648 649
        if (vout->p->pause.is_on)
            spu_render_time = vout->p->pause.date;
650
        else
651
            spu_render_time = filtered->date > 1 ? filtered->date : mdate();
652

653 654 655
        subpicture_t *subpic = spu_SortSubpictures(vout->p->p_spu,
                                                   spu_render_time,
                                                   do_snapshot);
Sam Hocevar's avatar
 
Sam Hocevar committed
656 657
        /*
         * Perform rendering
658 659 660 661
         *
         * 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
662
         */
663 664 665 666 667
        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)
668
                render = picture_NewFromFormat(&vd->source);
669 670 671 672
            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
673

674 675
            if (render) {
                picture_Copy(render, filtered);
676

677
                spu_RenderSubpictures(vout->p->p_spu,
678 679
                                      render, &vd->source,
                                      subpic, &vd->source, spu_render_time);
680 681 682 683 684 685 686 687 688 689 690 691 692 693
            }
            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
694 695
        }

Sam Hocevar's avatar
 
Sam Hocevar committed
696
        /*
697
         * Take a snapshot if requested
Sam Hocevar's avatar
 
Sam Hocevar committed
698
         */
699
        if (direct && do_snapshot)
700
            vout_snapshot_Set(&vout->p->snapshot, &vd->source, direct);
701

702 703 704
        /* Render the direct buffer returned by vout_RenderPicture */
        if (direct) {
            vout_RenderWrapper(vout, direct);
Sam Hocevar's avatar
 
Sam Hocevar committed
705

706 707
            vout_chrono_Stop(&vout->p->render);
#if 0
Gildas Bazin's avatar
 
Gildas Bazin committed
708
            {
709 710 711 712
            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
713
            }
714
#endif
715
        }
716

717 718 719
        /* Wait the real date (for rendering jitter) */
        if (!is_forced)
            mwait(decoded->date);
Sam Hocevar's avatar
 
Sam Hocevar committed
720

721
        /* Display the direct buffer returned by vout_RenderPicture */
Laurent Aimar's avatar
Laurent Aimar committed
722
        vout->p->displayed.date = mdate();
723 724
        if (direct)
            vout_DisplayWrapper(vout, direct);
Vincent Seguin's avatar
Vincent Seguin committed
725

726 727 728
        displayed_count++;
        break;
    }
Vincent Seguin's avatar
Vincent Seguin committed
729

730 731 732 733 734
    vout_statistic_Update(&vout->p->statistic, displayed_count, lost_count);
    if (displayed_count <= 0)
        return VLC_EGENERIC;
    return VLC_SUCCESS;
}
735

Laurent Aimar's avatar
Laurent Aimar committed
736 737 738 739
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
740 741 742 743
{
    vlc_mutex_lock(&vout->p->picture_lock);

    *deadline = VLC_TS_INVALID;
744
    ThreadDisplayPicture(vout, false, deadline);
Laurent Aimar's avatar
Laurent Aimar committed
745 746 747 748 749 750 751 752 753 754 755 756

    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
757
    vout_ManageWrapper(vout);
Laurent Aimar's avatar
Laurent Aimar committed
758 759
}

760 761 762 763 764
static void ThreadDisplaySubpicture(vout_thread_t *vout,
                                    subpicture_t *subpicture)
{
    spu_DisplaySubpicture(vout->p->p_spu, subpicture);
}
765 766 767 768 769 770

static void ThreadFlushSubpicture(vout_thread_t *vout, int channel)
{
    spu_ClearChannel(vout->p->p_spu, channel);
}

771
static void ThreadDisplayOsdTitle(vout_thread_t *vout, const char *string)
Laurent Aimar's avatar
Laurent Aimar committed
772
{
773
    if (!vout->p->title.show)
Laurent Aimar's avatar
Laurent Aimar committed
774 775
        return;

776 777 778
    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
779 780
}

781
static void ThreadChangeFilters(vout_thread_t *vout, const char *filters)
Laurent Aimar's avatar
Laurent Aimar committed
782
{
783
    es_format_t fmt;
784 785
    es_format_Init(&fmt, VIDEO_ES, vout->p->original.i_chroma);
    fmt.video = vout->p->original;
786

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

Laurent Aimar's avatar
Laurent Aimar committed
789 790
    filter_chain_Reset(vout->p->vfilter_chain, &fmt, &fmt);
    if (filter_chain_AppendFromString(vout->p->vfilter_chain,
791 792
                                      filters) < 0)
        msg_Err(vout, "Video filter chain creation failed");
Laurent Aimar's avatar
Laurent Aimar committed
793

794 795
    vlc_mutex_unlock(&vout->p->vfilter_lock);
}
Laurent Aimar's avatar
Laurent Aimar committed
796

797 798 799 800 801
static void ThreadChangeSubFilters(vout_thread_t *vout, const char *filters)
{
    spu_ChangeFilters(vout->p->p_spu, filters);
}

802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820
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
821
    }
822 823
    vout->p->pause.is_on = is_paused;
    vout->p->pause.date  = date;
Laurent Aimar's avatar
Laurent Aimar committed
824 825
}

826 827 828 829 830 831 832 833 834 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
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 ... */
    }
}

875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904
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);
}
905

906 907 908 909 910 911 912 913 914 915 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
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;
950 951 952 953
    ThreadExecuteCropWindow(vout, num, den,
                            0, 0,
                            source->i_visible_width,
                            source->i_visible_height);
954 955
}

956
static int ThreadStart(vout_thread_t *vout, const vout_display_state_t *state)
Laurent Aimar's avatar
Laurent Aimar committed
957
{
958 959 960 961 962 963 964 965 966 967
    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);

968 969 970 971 972 973 974 975 976 977 978 979
    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
980 981 982 983 984
        return VLC_EGENERIC;
    if (vout_InitWrapper(vout))
        return VLC_EGENERIC;
    assert(vout->p->decoder_pool);

985 986 987 988 989 990 991 992 993 994
    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
995
    video_format_Print(VLC_OBJECT(vout), "original format", &vout->p->original);
Laurent Aimar's avatar
Laurent Aimar committed
996 997 998
    return VLC_SUCCESS;
}

999
static void ThreadStop(vout_thread_t *vout, vout_display_state_t *state)
1000
{
Laurent Aimar's avatar
Laurent Aimar committed
1001 1002 1003
    /* Destroy the video filters2 */
    filter_chain_Delete(vout->p->vfilter_chain);

1004
    /* Destroy translation tables */
Laurent Aimar's avatar
Laurent Aimar committed
1005 1006 1007 1008 1009
    if (vout->p->display.vd) {
        if (vout->p->decoder_pool) {
            ThreadFlush(vout, true, INT64_MAX);
            vout_EndWrapper(vout);
        }
1010
        vout_CloseWrapper(vout, state);
1011
    }
Laurent Aimar's avatar
Laurent Aimar committed
1012

1013 1014 1015
    if (vout->p->decoder_fifo)
        picture_fifo_Delete(vout->p->decoder_fifo);
    assert(!vout->p->decoder_pool);
1016 1017 1018 1019
}

static void ThreadInit(vout_thread_t *vout)
{
1020 1021 1022 1023 1024 1025
    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;
1026 1027 1028

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

1030 1031
static void ThreadClean(vout_thread_t *vout)
{
1032 1033 1034 1035
    if (vout->p->window.object) {
        assert(vout->p->window.is_unused);
        vout_window_Delete(vout->p->window.object);
    }
1036
    vout_chrono_Clean(&vout->p->render);
Laurent Aimar's avatar
Laurent Aimar committed
1037 1038
    vout->p->dead = true;
    vout_control_Dead(&vout->p->control);
1039
}
1040

1041
static int ThreadReinit(vout_thread_t *vout,
1042
                        const vout_configuration_t *cfg)
1043 1044
{
    video_format_t original;