video_output.c 51.4 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.
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
8
 * Copyright (C) 2000-2007 VLC authors and VideoLAN
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
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
15 16 17
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
18
 * (at your option) any later version.
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
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
22 23
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
24
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
25 26 27
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software 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>
47
#include <vlc_image.h>
Clément Stenac's avatar
Clément Stenac committed
48

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

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

61 62 63 64
/* 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))
65

66 67 68 69
/**
 * Late pictures having a delay higher than this value are thrashed.
 */
#define VOUT_DISPLAY_LATE_THRESHOLD (INT64_C(20000))
70 71

/* Better be in advance when awakening than late... */
72
#define VOUT_MWAIT_TOLERANCE (INT64_C(4000))
73

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

84 85 86 87 88 89 90 91 92 93
    /* */
    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);
94
    return VLC_SUCCESS;
95
}
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
static void VideoFormatCopyCropAr(video_format_t *dst,
                                  const video_format_t *src)
{
    video_format_CopyCrop(dst, src);
    dst->i_sar_num = src->i_sar_num;
    dst->i_sar_den = src->i_sar_den;
}
static bool VideoFormatIsCropArEqual(video_format_t *dst,
                                     const video_format_t *src)
{
    return dst->i_sar_num * src->i_sar_den == dst->i_sar_den * src->i_sar_num &&
           dst->i_x_offset       == src->i_x_offset &&
           dst->i_y_offset       == src->i_y_offset &&
           dst->i_visible_width  == src->i_visible_width &&
           dst->i_visible_height == src->i_visible_height;
}
112

113 114
static vout_thread_t *VoutCreate(vlc_object_t *object,
                                 const vout_configuration_t *cfg)
Michel Kaempf's avatar
Michel Kaempf committed
115
{
116
    video_format_t original;
117
    if (VoutValidateFormat(&original, cfg->fmt))
118 119
        return NULL;

120
    /* Allocate descriptor */
Laurent Aimar's avatar
Laurent Aimar committed
121 122
    vout_thread_t *vout = vlc_custom_create(object,
                                            sizeof(*vout) + sizeof(*vout->p),
123
                                            "video output");
Laurent Aimar's avatar
Laurent Aimar committed
124
    if (!vout) {
125
        video_format_Clean(&original);
126 127 128
        return NULL;
    }

129
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
130
    vout->p = (vout_thread_sys_t*)&vout[1];
131

Laurent Aimar's avatar
Laurent Aimar committed
132
    vout->p->original = original;
133
    vout->p->dpb_size = cfg->dpb_size;
134

Laurent Aimar's avatar
Laurent Aimar committed
135 136
    vout_control_Init(&vout->p->control);
    vout_control_PushVoid(&vout->p->control, VOUT_CONTROL_INIT);
137

Laurent Aimar's avatar
Laurent Aimar committed
138
    vout_statistic_Init(&vout->p->statistic);
139

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

Gildas Bazin's avatar
 
Gildas Bazin committed
142
    /* Initialize locks */
143
    vlc_mutex_init(&vout->p->filter.lock);
144
    vlc_mutex_init(&vout->p->spu_lock);
Gildas Bazin's avatar
 
Gildas Bazin committed
145

146
    /* Initialize subpicture unit */
Laurent Aimar's avatar
Laurent Aimar committed
147
    vout->p->spu = spu_Create(vout);
148

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

152 153 154
    vout->p->title.show     = var_InheritBool(vout, "video-title-show");
    vout->p->title.timeout  = var_InheritInteger(vout, "video-title-timeout");
    vout->p->title.position = var_InheritInteger(vout, "video-title-position");
155

156
    /* Get splitter name if present */
157
    vout->p->splitter_name = var_InheritString(vout, "video-splitter");
Sam Hocevar's avatar
 
Sam Hocevar committed
158

Laurent Aimar's avatar
Laurent Aimar committed
159
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
160
    vout_InitInterlacingSupport(vout, vout->p->displayed.is_interlaced);
Laurent Aimar's avatar
Laurent Aimar committed
161

162 163 164 165 166 167 168 169 170 171 172 173 174 175
    /* Window */
    if (vout->p->splitter_name == NULL) {
        vout_window_cfg_t wcfg = {
            .is_standalone = !var_InheritBool(vout, "embedded-video"),
            .type = VOUT_WINDOW_TYPE_INVALID,
            // TODO: take pixel A/R, crop and zoom into account
#ifdef __APPLE__
            .x = var_InheritInteger(vout, "video-x"),
            .y = var_InheritInteger(vout, "video-y"),
#endif
            .width = cfg->fmt->i_visible_width,
            .height = cfg->fmt->i_visible_height,
        };

176 177 178
        vout_window_t *window = vout_display_window_New(vout, &wcfg);
        if (window != NULL)
        {
179 180
            if (var_InheritBool(vout, "fullscreen"))
                vout_window_SetFullScreen(window, true);
181 182 183 184 185 186
            if (var_InheritBool(vout, "video-wallpaper"))
                vout_window_SetState(window, VOUT_WINDOW_STATE_BELOW);
            else if (var_InheritBool(vout, "video-on-top"))
                vout_window_SetState(window, VOUT_WINDOW_STATE_ABOVE);
        }
        vout->p->window = window;
187 188 189
    } else
        vout->p->window = NULL;

Laurent Aimar's avatar
Laurent Aimar committed
190
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
191
    vlc_object_set_destructor(vout, VoutDestructor);
Gildas Bazin's avatar
 
Gildas Bazin committed
192

193
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
194 195
    if (vlc_clone(&vout->p->thread, Thread, vout,
                  VLC_THREAD_PRIORITY_OUTPUT)) {
196 197
        if (vout->p->window != NULL)
            vout_display_window_Delete(vout->p->window);
Laurent Aimar's avatar
Laurent Aimar committed
198
        spu_Destroy(vout->p->spu);
Laurent Aimar's avatar
Laurent Aimar committed
199
        vlc_object_release(vout);
200 201 202
        return NULL;
    }

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

Laurent Aimar's avatar
Laurent Aimar committed
205 206 207
    if (vout->p->dead) {
        msg_Err(vout, "video output creation failed");
        vout_CloseAndRelease(vout);
208
        return NULL;
209
    }
Michel Kaempf's avatar
Michel Kaempf committed
210

211 212
    vout->p->input = cfg->input;
    if (vout->p->input)
Laurent Aimar's avatar
Laurent Aimar committed
213
        spu_Attach(vout->p->spu, vout->p->input, true);
214

Laurent Aimar's avatar
Laurent Aimar committed
215
    return vout;
Michel Kaempf's avatar
Michel Kaempf committed
216 217
}

Rafaël Carré's avatar
Rafaël Carré committed
218 219
#undef vout_Request
vout_thread_t *vout_Request(vlc_object_t *object,
220 221 222
                              const vout_configuration_t *cfg)
{
    vout_thread_t *vout = cfg->vout;
Laurent Aimar's avatar
Laurent Aimar committed
223
    if (cfg->change_fmt && !cfg->fmt) {
224 225 226 227 228 229 230
        if (vout)
            vout_CloseAndRelease(vout);
        return NULL;
    }

    /* If a vout is provided, try reusing it */
    if (vout) {
231 232
        if (vout->p->input != cfg->input) {
            if (vout->p->input)
Laurent Aimar's avatar
Laurent Aimar committed
233
                spu_Attach(vout->p->spu, vout->p->input, false);
234 235
            vout->p->input = cfg->input;
            if (vout->p->input)
Laurent Aimar's avatar
Laurent Aimar committed
236
                spu_Attach(vout->p->spu, vout->p->input, true);
237
        }
238

Laurent Aimar's avatar
Laurent Aimar committed
239 240 241 242 243 244 245 246
        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);
        }
247 248 249

        if (!vout->p->dead) {
            msg_Dbg(object, "reusing provided vout");
250
            vout_IntfReinit(vout);
251 252 253 254 255 256 257 258 259
            return vout;
        }
        vout_CloseAndRelease(vout);

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

Laurent Aimar's avatar
Laurent Aimar committed
260
void vout_Close(vout_thread_t *vout)
261
{
Laurent Aimar's avatar
Laurent Aimar committed
262
    assert(vout);
263

264
    if (vout->p->input)
Laurent Aimar's avatar
Laurent Aimar committed
265
        spu_Attach(vout->p->spu, vout->p->input, false);
266

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

Laurent Aimar's avatar
Laurent Aimar committed
269 270
    vout_control_PushVoid(&vout->p->control, VOUT_CONTROL_CLEAN);
    vlc_join(vout->p->thread, NULL);
271

272 273 274
    if (vout->p->window != NULL)
        vout_display_window_Delete(vout->p->window);

275
    vlc_mutex_lock(&vout->p->spu_lock);
Laurent Aimar's avatar
Laurent Aimar committed
276 277
    spu_Destroy(vout->p->spu);
    vout->p->spu = NULL;
278
    vlc_mutex_unlock(&vout->p->spu_lock);
279 280 281
}

/* */
Laurent Aimar's avatar
Laurent Aimar committed
282
static void VoutDestructor(vlc_object_t *object)
283
{
Laurent Aimar's avatar
Laurent Aimar committed
284
    vout_thread_t *vout = (vout_thread_t *)object;
285

286
    /* Make sure the vout was stopped first */
Laurent Aimar's avatar
Laurent Aimar committed
287
    //assert(!vout->p_module);
288

Laurent Aimar's avatar
Laurent Aimar committed
289
    free(vout->p->splitter_name);
290

291
    /* Destroy the locks */
292
    vlc_mutex_destroy(&vout->p->spu_lock);
293
    vlc_mutex_destroy(&vout->p->filter.lock);
Laurent Aimar's avatar
Laurent Aimar committed
294
    vout_control_Clean(&vout->p->control);
295

296
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
297
    vout_statistic_Clean(&vout->p->statistic);
298

299
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
300
    vout_snapshot_Clean(&vout->p->snapshot);
301

Laurent Aimar's avatar
Laurent Aimar committed
302
    video_format_Clean(&vout->p->original);
Michel Kaempf's avatar
Michel Kaempf committed
303 304
}

Laurent Aimar's avatar
Laurent Aimar committed
305
/* */
306
void vout_ChangePause(vout_thread_t *vout, bool is_paused, mtime_t date)
Laurent Aimar's avatar
Laurent Aimar committed
307
{
308 309 310 311 312
    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
313

314
    vout_control_WaitEmpty(&vout->p->control);
Laurent Aimar's avatar
Laurent Aimar committed
315
}
316

Laurent Aimar's avatar
Laurent Aimar committed
317
void vout_GetResetStatistic(vout_thread_t *vout, int *displayed, int *lost)
318
{
Laurent Aimar's avatar
Laurent Aimar committed
319
    vout_statistic_GetReset( &vout->p->statistic, displayed, lost );
320
}
321

322
void vout_Flush(vout_thread_t *vout, mtime_t date)
323
{
324 325
    vout_control_PushTime(&vout->p->control, VOUT_CONTROL_FLUSH, date);
    vout_control_WaitEmpty(&vout->p->control);
326
}
327

328
void vout_Reset(vout_thread_t *vout)
329
{
330 331
    vout_control_PushVoid(&vout->p->control, VOUT_CONTROL_RESET);
    vout_control_WaitEmpty(&vout->p->control);
332
}
333

334 335 336 337 338 339 340 341 342
bool vout_IsEmpty(vout_thread_t *vout)
{
    picture_t *picture = picture_fifo_Peek(vout->p->decoder_fifo);
    if (picture)
        picture_Release(picture);

    return !picture;
}

343
void vout_NextPicture(vout_thread_t *vout, mtime_t *duration)
344
{
345 346 347
    vout_control_cmd_t cmd;
    vout_control_cmd_Init(&cmd, VOUT_CONTROL_STEP);
    cmd.u.time_ptr = duration;
348

349 350
    vout_control_Push(&vout->p->control, &cmd);
    vout_control_WaitEmpty(&vout->p->control);
351
}
352

353
void vout_DisplayTitle(vout_thread_t *vout, const char *title)
354
{
355 356
    assert(title);
    vout_control_PushString(&vout->p->control, VOUT_CONTROL_OSD_TITLE, title);
357
}
358

359 360
void vout_PutSubpicture( vout_thread_t *vout, subpicture_t *subpic )
{
361 362 363 364 365
    vout_control_cmd_t cmd;
    vout_control_cmd_Init(&cmd, VOUT_CONTROL_SUBPICTURE);
    cmd.u.subpicture = subpic;

    vout_control_Push(&vout->p->control, &cmd);
366 367 368
}
int vout_RegisterSubpictureChannel( vout_thread_t *vout )
{
369 370 371
    int channel = SPU_DEFAULT_CHANNEL;

    vlc_mutex_lock(&vout->p->spu_lock);
Laurent Aimar's avatar
Laurent Aimar committed
372 373
    if (vout->p->spu)
        channel = spu_RegisterChannel(vout->p->spu);
374 375 376
    vlc_mutex_unlock(&vout->p->spu_lock);

    return channel;
377 378 379
}
void vout_FlushSubpictureChannel( vout_thread_t *vout, int channel )
{
380 381
    vout_control_PushInteger(&vout->p->control, VOUT_CONTROL_FLUSH_SUBPICTURE,
                             channel);
382 383
}

384 385 386 387
/**
 * It retreives a picture from the vout or NULL if no pictures are
 * available yet.
 *
388
 * You MUST call vout_PutPicture or picture_Release on it.
389
 *
390
 * You may use picture_Hold() (paired with picture_Release()) to keep a
391 392 393 394 395 396 397
 * read-only reference.
 */
picture_t *vout_GetPicture(vout_thread_t *vout)
{
    picture_t *picture = picture_pool_Get(vout->p->decoder_pool);
    if (picture) {
        picture_Reset(picture);
398
        VideoFormatCopyCropAr(&picture->format, &vout->p->original);
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
    }

    return picture;
}

/**
 * It gives to the vout a picture to be displayed.
 *
 * The given picture MUST comes from vout_GetPicture.
 *
 * Becareful, after vout_PutPicture is called, picture_t::p_next cannot be
 * read/used.
 */
void vout_PutPicture(vout_thread_t *vout, picture_t *picture)
{
    picture->p_next = NULL;
    picture_fifo_Push(vout->p->decoder_fifo, picture);

    vout_control_Wake(&vout->p->control);
}

420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
/* */
int vout_GetSnapshot(vout_thread_t *vout,
                     block_t **image_dst, picture_t **picture_dst,
                     video_format_t *fmt,
                     const char *type, mtime_t timeout)
{
    picture_t *picture = vout_snapshot_Get(&vout->p->snapshot, timeout);
    if (!picture) {
        msg_Err(vout, "Failed to grab a snapshot");
        return VLC_EGENERIC;
    }

    if (image_dst) {
        vlc_fourcc_t codec = VLC_CODEC_PNG;
        if (type && image_Type2Fourcc(type))
            codec = image_Type2Fourcc(type);

437 438
        const int override_width  = var_InheritInteger(vout, "snapshot-width");
        const int override_height = var_InheritInteger(vout, "snapshot-height");
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453

        if (picture_Export(VLC_OBJECT(vout), image_dst, fmt,
                           picture, codec, override_width, override_height)) {
            msg_Err(vout, "Failed to convert image for snapshot");
            picture_Release(picture);
            return VLC_EGENERIC;
        }
    }
    if (picture_dst)
        *picture_dst = picture;
    else
        picture_Release(picture);
    return VLC_SUCCESS;
}

454 455 456 457 458 459
void vout_ChangeAspectRatio( vout_thread_t *p_vout,
                             unsigned int i_num, unsigned int i_den )
{
    vout_ControlChangeSampleAspectRatio( p_vout, i_num, i_den );
}

460 461 462 463 464 465
/* 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);
}
466
void vout_ControlChangeWindowState(vout_thread_t *vout, unsigned st)
467
{
468
    vout_control_PushInteger(&vout->p->control, VOUT_CONTROL_WINDOW_STATE, st);
469 470 471 472 473 474 475 476 477 478 479
}
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);
}
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
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);
497 498 499 500
    cmd.u.window.x      = __MAX(x, 0);
    cmd.u.window.y      = __MAX(y, 0);
    cmd.u.window.width  = __MAX(width, 0);
    cmd.u.window.height = __MAX(height, 0);
501 502 503 504 505 506 507 508

    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);
509 510 511 512
    cmd.u.border.left   = __MAX(left, 0);
    cmd.u.border.top    = __MAX(top, 0);
    cmd.u.border.right  = __MAX(right, 0);
    cmd.u.border.bottom = __MAX(bottom, 0);
513 514 515

    vout_control_Push(&vout->p->control, &cmd);
}
516 517 518 519 520
void vout_ControlChangeFilters(vout_thread_t *vout, const char *filters)
{
    vout_control_PushString(&vout->p->control, VOUT_CONTROL_CHANGE_FILTERS,
                            filters);
}
521
void vout_ControlChangeSubSources(vout_thread_t *vout, const char *filters)
522
{
523
    vout_control_PushString(&vout->p->control, VOUT_CONTROL_CHANGE_SUB_SOURCES,
524 525
                            filters);
}
526 527 528 529 530
void vout_ControlChangeSubFilters(vout_thread_t *vout, const char *filters)
{
    vout_control_PushString(&vout->p->control, VOUT_CONTROL_CHANGE_SUB_FILTERS,
                            filters);
}
Laurent Aimar's avatar
Laurent Aimar committed
531 532 533 534 535
void vout_ControlChangeSubMargin(vout_thread_t *vout, int margin)
{
    vout_control_PushInteger(&vout->p->control, VOUT_CONTROL_CHANGE_SUB_MARGIN,
                             margin);
}
536

537 538 539 540
/* */
static void VoutGetDisplayCfg(vout_thread_t *vout, vout_display_cfg_t *cfg, const char *title)
{
    /* Load configuration */
541 542
    cfg->is_fullscreen = var_CreateGetBool(vout, "fullscreen")
                         || var_InheritBool(vout, "video-wallpaper");
543 544 545 546 547 548
    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");
549 550 551 552 553 554 555 556
    unsigned msar_num, msar_den;
    if (var_InheritURational(vout, &msar_num, &msar_den, "monitor-par") ||
        msar_num <= 0 || msar_den <= 0) {
        msar_num = 1;
        msar_den = 1;
    }
    cfg->display.sar.num = msar_num;
    cfg->display.sar.den = msar_den;
557
    unsigned zoom_den = 1000;
558
    unsigned zoom_num = zoom_den * var_CreateGetFloat(vout, "zoom");
559 560 561 562 563 564 565 566 567 568 569
    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)
570
        cfg->align.vertical = VOUT_DISPLAY_ALIGN_TOP;
571
    else if (align_mask & 0x8)
572
        cfg->align.vertical = VOUT_DISPLAY_ALIGN_BOTTOM;
573 574
}

575
vout_window_t *vout_NewDisplayWindow(vout_thread_t *vout, unsigned type)
576
{
577
    vout_window_t *window = vout->p->window;
578

579
    assert(vout->p->splitter_name == NULL);
580

581 582
    if (window == NULL)
        return NULL;
583
    if (type != VOUT_WINDOW_TYPE_INVALID && type != window->type)
584
        return NULL;
585 586 587
    return window;
}

588
void vout_DeleteDisplayWindow(vout_thread_t *vout, vout_window_t *window)
589
{
590
    if (window == NULL && vout->p->window != NULL) {
591
        vout_display_window_Delete(vout->p->window);
592
        vout->p->window = NULL;
593
    }
594
    assert(vout->p->window == window);
595 596
}

597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
void vout_SetDisplayWindowSize(vout_thread_t *vout,
                               unsigned width, unsigned height)
{
    vout_window_t *window = vout->p->window;

    if (window != NULL)
    /* Request a resize of the window. If it fails, there is nothing to do.
     * If it succeeds, the window will emit a resize event later. */
        vout_window_SetSize(window, width, height);
    else
    if (vout->p->display.vd != NULL)
    /* Force a resize of window-less display. This is not allowed to fail,
     * although the display is allowed to ignore the size anyway. */
        /* FIXME: remove this, fix MSW and OS/2 window providers */
        vout_display_SendEventDisplaySize(vout->p->display.vd, width, height);
}

614
/* */
615
static picture_t *VoutVideoFilterInteractiveNewPicture(filter_t *filter)
616
{
617
    vout_thread_t *vout = filter->owner.sys;
618

619
    picture_t *picture = picture_pool_Get(vout->p->private_pool);
620 621
    if (picture) {
        picture_Reset(picture);
622
        VideoFormatCopyCropAr(&picture->format, &filter->fmt_out.video);
623
    }
624
    return picture;
625
}
626

627 628
static picture_t *VoutVideoFilterStaticNewPicture(filter_t *filter)
{
629
    vout_thread_t *vout = filter->owner.sys;
630 631 632 633

    vlc_assert_locked(&vout->p->filter.lock);
    if (filter_chain_GetLength(vout->p->filter.chain_interactive) == 0)
        return VoutVideoFilterInteractiveNewPicture(filter);
634

635 636
    return picture_NewFromFormat(&filter->fmt_out.video);
}
637

638
static void ThreadFilterFlush(vout_thread_t *vout, bool is_locked)
Laurent Aimar's avatar
Laurent Aimar committed
639 640 641 642 643 644 645 646 647
{
    if (vout->p->displayed.current)
        picture_Release( vout->p->displayed.current );
    vout->p->displayed.current = NULL;

    if (vout->p->displayed.next)
        picture_Release( vout->p->displayed.next );
    vout->p->displayed.next = NULL;

648 649
    if (!is_locked)
        vlc_mutex_lock(&vout->p->filter.lock);
Laurent Aimar's avatar
Laurent Aimar committed
650 651
    filter_chain_VideoFlush(vout->p->filter.chain_static);
    filter_chain_VideoFlush(vout->p->filter.chain_interactive);
652 653
    if (!is_locked)
        vlc_mutex_unlock(&vout->p->filter.lock);
Laurent Aimar's avatar
Laurent Aimar committed
654 655 656 657 658 659 660
}

typedef struct {
    char           *name;
    config_chain_t *cfg;
} vout_filter_t;

661 662 663 664
static void ThreadChangeFilters(vout_thread_t *vout,
                                const video_format_t *source,
                                const char *filters,
                                bool is_locked)
Laurent Aimar's avatar
Laurent Aimar committed
665
{
666
    ThreadFilterFlush(vout, is_locked);
Laurent Aimar's avatar
Laurent Aimar committed
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697

    vlc_array_t array_static;
    vlc_array_t array_interactive;

    vlc_array_init(&array_static);
    vlc_array_init(&array_interactive);
    char *current = filters ? strdup(filters) : NULL;
    while (current) {
        config_chain_t *cfg;
        char *name;
        char *next = config_ChainCreate(&name, &cfg, current);

        if (name && *name) {
            vout_filter_t *e = xmalloc(sizeof(*e));
            e->name = name;
            e->cfg  = cfg;
            if (!strcmp(e->name, "deinterlace") ||
                !strcmp(e->name, "postproc")) {
                vlc_array_append(&array_static, e);
            } else {
                vlc_array_append(&array_interactive, e);
            }
        } else {
            if (cfg)
                config_ChainDestroy(cfg);
            free(name);
        }
        free(current);
        current = next;
    }

698 699 700
    if (!is_locked)
        vlc_mutex_lock(&vout->p->filter.lock);

Laurent Aimar's avatar
Laurent Aimar committed
701
    es_format_t fmt_target;
702
    es_format_InitFromVideo(&fmt_target, source ? source : &vout->p->filter.format);
Laurent Aimar's avatar
Laurent Aimar committed
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725

    es_format_t fmt_current = fmt_target;

    for (int a = 0; a < 2; a++) {
        vlc_array_t    *array = a == 0 ? &array_static :
                                         &array_interactive;
        filter_chain_t *chain = a == 0 ? vout->p->filter.chain_static :
                                         vout->p->filter.chain_interactive;

        filter_chain_Reset(chain, &fmt_current, &fmt_current);
        for (int i = 0; i < vlc_array_count(array); i++) {
            vout_filter_t *e = vlc_array_item_at_index(array, i);
            msg_Dbg(vout, "Adding '%s' as %s", e->name, a == 0 ? "static" : "interactive");
            if (!filter_chain_AppendFilter(chain, e->name, e->cfg, NULL, NULL)) {
                msg_Err(vout, "Failed to add filter '%s'", e->name);
                config_ChainDestroy(e->cfg);
            }
            free(e->name);
            free(e);
        }
        fmt_current = *filter_chain_GetFmtOut(chain);
        vlc_array_clear(array);
    }
726

Laurent Aimar's avatar
Laurent Aimar committed
727 728 729 730 731 732 733 734 735 736
    if (!es_format_IsSimilar(&fmt_current, &fmt_target)) {
        msg_Dbg(vout, "Adding a filter to compensate for format changes");
        if (!filter_chain_AppendFilter(vout->p->filter.chain_interactive, NULL, NULL,
                                       &fmt_current, &fmt_target)) {
            msg_Err(vout, "Failed to compensate for the format changes, removing all filters");
            filter_chain_Reset(vout->p->filter.chain_static,      &fmt_target, &fmt_target);
            filter_chain_Reset(vout->p->filter.chain_interactive, &fmt_target, &fmt_target);
        }
    }

Hannes Domani's avatar
Hannes Domani committed
737 738
    es_format_Clean(&fmt_target);

739 740 741 742 743 744 745 746 747 748 749
    if (vout->p->filter.configuration != filters) {
        free(vout->p->filter.configuration);
        vout->p->filter.configuration = filters ? strdup(filters) : NULL;
    }
    if (source) {
        video_format_Clean(&vout->p->filter.format);
        video_format_Copy(&vout->p->filter.format, source);
    }

    if (!is_locked)
        vlc_mutex_unlock(&vout->p->filter.lock);
Laurent Aimar's avatar
Laurent Aimar committed
750 751
}

752

753
/* */
754
static int ThreadDisplayPreparePicture(vout_thread_t *vout, bool reuse, bool frame_by_frame)
Vincent Seguin's avatar
Vincent Seguin committed
755
{
756
    bool is_late_dropped = vout->p->is_late_dropped && !vout->p->pause.is_on && !frame_by_frame;
757

758
    vlc_mutex_lock(&vout->p->filter.lock);
759

760 761
    picture_t *picture = filter_chain_VideoFilter(vout->p->filter.chain_static, NULL);
    assert(!reuse || !picture);
762

763 764 765 766
    while (!picture) {
        picture_t *decoded;
        if (reuse && vout->p->displayed.decoded) {
            decoded = picture_Hold(vout->p->displayed.decoded);
767
        } else {
768
            decoded = picture_fifo_Pop(vout->p->decoder_fifo);
769 770 771 772 773 774 775 776 777 778 779 780
            if (decoded) {
                if (is_late_dropped && !decoded->b_force) {
                    const mtime_t predicted = mdate() + 0; /* TODO improve */
                    const mtime_t late = predicted - decoded->date;
                    if (late > VOUT_DISPLAY_LATE_THRESHOLD) {
                        msg_Warn(vout, "picture is too late to be displayed (missing %"PRId64" ms)", late/1000);
                        picture_Release(decoded);
                        vout_statistic_AddLost(&vout->p->statistic, 1);
                        continue;
                    } else if (late > 0) {
                        msg_Dbg(vout, "picture might be displayed late (missing %"PRId64" ms)", late/1000);
                    }
781
                }
782 783
                if (!VideoFormatIsCropArEqual(&decoded->format, &vout->p->filter.format))
                    ThreadChangeFilters(vout, &decoded->format, vout->p->filter.configuration, true);
784
            }
785
        }
786

787 788 789
        if (!decoded)
            break;
        reuse = false;
790

791 792 793 794 795
        if (vout->p->displayed.decoded)
            picture_Release(vout->p->displayed.decoded);

        vout->p->displayed.decoded       = picture_Hold(decoded);
        vout->p->displayed.timestamp     = decoded->date;
796
        vout->p->displayed.is_interlaced = !decoded->b_progressive;
797 798

        picture = filter_chain_VideoFilter(vout->p->filter.chain_static, decoded);
799 800
    }

801 802 803 804
    vlc_mutex_unlock(&vout->p->filter.lock);

    if (!picture)
        return VLC_EGENERIC;
805

806 807 808 809 810 811
    assert(!vout->p->displayed.next);
    if (!vout->p->displayed.current)
        vout->p->displayed.current = picture;
    else
        vout->p->displayed.next    = picture;
    return VLC_SUCCESS;
812 813
}

814
static int ThreadDisplayRenderPicture(vout_thread_t *vout, bool is_forced)
815
{
816
    vout_thread_sys_t *sys = vout->p;
817 818
    vout_display_t *vd = vout->p->display.vd;

819
    picture_t *torender = picture_Hold(vout->p->displayed.current);
820

821
    vout_chrono_Start(&vout->p->render);
822

823 824 825 826 827 828 829 830 831 832 833
    vlc_mutex_lock(&vout->p->filter.lock);
    picture_t *filtered = filter_chain_VideoFilter(vout->p->filter.chain_interactive, torender);
    vlc_mutex_unlock(&vout->p->filter.lock);

    if (!filtered)
        return VLC_EGENERIC;

    if (filtered->date != vout->p->displayed.current->date)
        msg_Warn(vout, "Unsupported timestamp modifications done by chain_interactive");

    /*
834
     * Get the subpicture to be displayed
835 836
     */
    const bool do_snapshot = vout_snapshot_IsRequested(&vout->p->snapshot);
837
    mtime_t render_subtitle_date;
838
    if (vout->p->pause.is_on)
839
        render_subtitle_date = vout->p->pause.date;
840
    else
841 842 843
        render_subtitle_date = filtered->date > 1 ? filtered->date : mdate();
    mtime_t render_osd_date = mdate(); /* FIXME wrong */

844 845 846 847 848 849
    /*
     * Get the subpicture to be displayed
     */
    const bool do_dr_spu = !do_snapshot &&
                           vd->info.subpicture_chromas &&
                           *vd->info.subpicture_chromas != 0;
850 851 852 853 854

    //FIXME: Denying do_early_spu if vd->source.orientation != ORIENT_NORMAL
    //will have the effect that snapshots miss the subpictures. We do this
    //because there is currently no way to transform subpictures to match
    //the source format.
855
    const bool do_early_spu = !do_dr_spu &&
856
                               vd->source.orientation == ORIENT_NORMAL &&
857 858 859 860 861 862
                              (vd->info.is_slow ||
                               sys->display.use_dr ||
                               do_snapshot ||
                               !vout_IsDisplayFiltered(vd) ||
                               vd->fmt.i_width * vd->fmt.i_height <= vd->source.i_width * vd->source.i_height);

863 864 865
    const vlc_fourcc_t *subpicture_chromas;
    video_format_t fmt_spu;
    if (do_dr_spu) {
866 867 868 869 870 871 872 873 874 875 876 877
        vout_display_place_t place;
        vout_display_PlacePicture(&place, &vd->source, vd->cfg, false);

        fmt_spu = vd->source;
        if (fmt_spu.i_width * fmt_spu.i_height < place.width * place.height) {
            fmt_spu.i_sar_num = vd->cfg->display.sar.num;
            fmt_spu.i_sar_den = vd->cfg->display.sar.den;
            fmt_spu.i_width          =
            fmt_spu.i_visible_width  = place.width;
            fmt_spu.i_height         =
            fmt_spu.i_visible_height = place.height;
        }
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
        subpicture_chromas = vd->info.subpicture_chromas;
    } else {
        if (do_early_spu) {
            fmt_spu = vd->source;
        } else {
            fmt_spu = vd->fmt;
            fmt_spu.i_sar_num = vd->cfg->display.sar.num;
            fmt_spu.i_sar_den = vd->cfg->display.sar.den;
        }
        subpicture_chromas = NULL;

        if (vout->p->spu_blend &&
            vout->p->spu_blend->fmt_out.video.i_chroma != fmt_spu.i_chroma) {
            filter_DeleteBlend(vout->p->spu_blend);
            vout->p->spu_blend = NULL;
            vout->p->spu_blend_chroma = 0;
        }
        if (!vout->p->spu_blend && vout->p->spu_blend_chroma != fmt_spu.i_chroma) {
            vout->p->spu_blend_chroma = fmt_spu.i_chroma;
            vout->p->spu_blend = filter_NewBlend(VLC_OBJECT(vout), &fmt_spu);
            if (!vout->p->spu_blend)
                msg_Err(vout, "Failed to create blending filter, OSD/Subtitles will not work");
        }
    }

903
    video_format_t fmt_spu_rot;
904
    video_format_ApplyRotation(&fmt_spu_rot, &fmt_spu);
905
    subpicture_t *subpic = spu_Render(vout->p->spu,
906
                                      subpicture_chromas, &fmt_spu_rot,
907
                                      &vd->source,
908 909
                                      render_subtitle_date, render_osd_date,
                                      do_snapshot);
910 911 912 913 914 915 916
    /*
     * Perform rendering
     *
     * We have to:
     * - be sure to end up with a direct buffer.
     * - blend subtitles, and in a fast access buffer
     */
917 918 919
    bool is_direct = vout->p->decoder_pool == vout->p->display_pool;
    picture_t *todisplay = filtered;
    if (do_early_spu && subpic) {
920 921 922 923 924 925 926 927 928 929 930
        if (vout->p->spu_blend) {
            picture_t *blent = picture_pool_Get(vout->p->private_pool);
            if (blent) {
                VideoFormatCopyCropAr(&blent->format, &filtered->format);
                picture_Copy(blent, filtered);
                if (picture_BlendSubpicture(blent, vout->p->spu_blend, subpic)) {
                    picture_Release(todisplay);
                    todisplay = blent;
                } else
                    picture_Release(blent);
            }
Sam Hocevar's avatar
 
Sam Hocevar committed
931
        }
932 933 934 935
        subpicture_Delete(subpic);
        subpic = NULL;
    }

936 937 938 939 940 941 942 943
    assert(vout_IsDisplayFiltered(vd) == !sys->display.use_dr);
    if (sys->display.use_dr && !is_direct) {
        picture_t *direct = picture_pool_Get(vout->p->display_pool);
        if (!direct) {
            picture_Release(todisplay);
            if (subpic)
                subpicture_Delete(subpic);
            return VLC_EGENERIC;
944
        }
Sam Hocevar's avatar
 
Sam Hocevar committed
945

946 947 948 949 950 951 952 953
        /* The display uses direct rendering (no conversion), but its pool of
         * pictures is not usable by the decoder (too few, too slow or
         * subject to invalidation...). Since there are no filters, copying
         * pictures from the decoder to the output is unavoidable. */
        VideoFormatCopyCropAr(&direct->format, &todisplay->format);
        picture_Copy(direct, todisplay);
        picture_Release(todisplay);
        todisplay = direct;
954
    }
955

956 957 958 959
    /*
     * Take a snapshot if requested
     */
    if (do_snapshot)
960
        vout_snapshot_Set(&vout->p->snapshot, &vd->source, todisplay);
Sam Hocevar's avatar
 
Sam Hocevar committed
961

962
    /* Render the direct buffer */
963
    vout_UpdateDisplaySourceProperties(vd, &todisplay->format);
964
    if (sys->display.use_dr) {
965
        vout_display_Prepare(vd, todisplay, subpic);
966
    } else {
967
        sys->display.filtered = vout_FilterDisplay(vd, todisplay);
968 969 970 971 972 973
        if (sys->display.filtered) {
            if (!do_dr_spu && !do_early_spu && vout->p->spu_blend && subpic)
                picture_BlendSubpicture(sys->display.filtered, vout->p->spu_blend, subpic);
            vout_display_Prepare(vd, sys->display.filtered, do_dr_spu ? subpic : NULL);
        }
        if (!do_dr_spu && subpic)
974
        {
975
            subpicture_Delete(subpic);
976 977
            subpic = NULL;
        }
978 979
        if (!sys->display.filtered)
            return VLC_EGENERIC;
980
    }
981 982

    vout_chrono_Stop(&vout->p->render);
983
#if 0
984 985 986 987 988
        {
        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));
989
        }
990 991 992 993 994 995 996 997 998
#endif

    /* Wait the real date (for rendering jitter) */
#if 0
    mtime_t delay = direct->date - mdate();
    if (delay < 1000)
        msg_Warn(vout, "picture is late (%lld ms)", delay / 1000);
#endif
    if (!is_forced)
999
        mwait(todisplay->date);
1000

1001 1002
    /* Display the direct buffer returned by vout_RenderPicture */
    vout->p->displayed.date = mdate();
1003 1004
    vout_display_Display(vd,
                         sys->display.filtered ? sys->display.filtered
1005
                                                : todisplay,
1006
                         subpic);
1007
    sys->display.filtered = NULL;
1008

1009
    vout_statistic_AddDisplayed(&vout->p->statistic, 1);
1010 1011 1012

    return VLC_SUCCESS;
}
Vincent Seguin's avatar
Vincent Seguin committed
1013

1014
static int ThreadDisplayPicture(vout_thread_t *vout, mtime_t *deadline)
1015
{
1016 1017
    bool frame_by_frame = !deadline;
    bool paused = vout->p->pause.is_on;
1018
    bool first = !vout->p->displayed.current;
1019 1020 1021 1022 1023 1024 1025 1026

    if (first)
        if (ThreadDisplayPreparePicture(vout, true, frame_by_frame)) /* FIXME not sure it is ok */
            return VLC_EGENERIC;

    if (!paused || frame_by_frame)
        while (!vout->p->displayed.next && !ThreadDisplayPreparePicture(vout, false, frame_by_frame))
            ;
Vincent Seguin's avatar
Vincent Seguin committed
1027

1028 1029 1030
    const mtime_t date = mdate();
    const mtime_t render_delay = vout_chrono_GetHigh(&vout->p->render) + VOUT_MWAIT_TOLERANCE;

1031
    bool drop_next_frame = frame_by_frame;
1032
    mtime_t date_next = VLC_TS_INVALID;
1033
    if (!paused && vout->p->displayed.next) {
1034
        date_next = vout->p->displayed.next->date - render_delay;
1035 1036 1037
        if (date_next /* + 0 FIXME */ <= date)
            drop_next_frame = true;
    }
1038 1039 1040

    /* FIXME/XXX we must redisplay the last decoded picture (because
     * of potential vout updated, or filters update or SPU update)
1041
     * For now a high update period is needed but it could be removed
1042 1043 1044 1045
     * if and only if:
     * - vout module emits events from theselves.
     * - *and* SPU is modified to emit an event or a deadline when needed.
     *
1046
     * So it will be done later.
1047
     */
1048 1049
    bool refresh = false;

1050
    mtime_t date_refresh = VLC_TS_INVALID;
1051
    if (vout->p->displayed.date > VLC_TS_INVALID) {
1052 1053
        date_refresh = vout->p->displayed.date + VOUT_REDISPLAY_DELAY - render_delay;
        refresh = date_refresh <= date;
1054
    }
1055
    bool force_refresh = !drop_next_frame && refresh;
1056

Rafaël Carré's avatar <