display.c 53.7 KB
Newer Older
1 2 3 4 5 6 7 8
/*****************************************************************************
 * display.c: "vout display" managment
 *****************************************************************************
 * Copyright (C) 2009 Laurent Aimar
 * $Id$
 *
 * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
9 10 11
 * 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
12 13 14 15
 * (at your option) any later version.
 *
 * 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
16 17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
18
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
19 20 21
 * 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.
22 23 24 25 26 27 28 29 30 31 32 33 34 35
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
#include <assert.h>

#include <vlc_common.h>
#include <vlc_video_splitter.h>
#include <vlc_vout_display.h>
#include <vlc_vout.h>
36
#include <vlc_block.h>
37
#include <vlc_modules.h>
38 39 40 41 42 43 44

#include <libvlc.h>

#include "display.h"

#include "event.h"

45 46 47 48
/* It must be present as long as a vout_display_t must be created using a dummy
 * vout (as an opengl provider) */
#define ALLOW_DUMMY_VOUT

49 50 51 52 53 54 55
static void SplitterClose(vout_display_t *vd);

/*****************************************************************************
 * FIXME/TODO see how to have direct rendering here (interact with vout.c)
 *****************************************************************************/
static picture_t *VideoBufferNew(filter_t *filter)
{
56
    vout_display_t *vd = filter->owner.sys;
57 58
    const video_format_t *fmt = &filter->fmt_out.video;

59 60 61 62
    assert(vd->fmt.i_chroma == fmt->i_chroma &&
           vd->fmt.i_width  == fmt->i_width  &&
           vd->fmt.i_height == fmt->i_height);

63
    picture_pool_t *pool = vout_display_Pool(vd, 3);
64 65 66
    if (!pool)
        return NULL;
    return picture_pool_Get(pool);
67
}
68

69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
static void VideoBufferDelete(filter_t *filter, picture_t *picture)
{
    VLC_UNUSED(filter);
    picture_Release(picture);
}

/*****************************************************************************
 *
 *****************************************************************************/

/**
 * It creates a new vout_display_t using the given configuration.
 */
static vout_display_t *vout_display_New(vlc_object_t *obj,
                                        const char *module, bool load_module,
                                        const video_format_t *fmt,
                                        const vout_display_cfg_t *cfg,
                                        vout_display_owner_t *owner)
{
    /* */
89
    vout_display_t *vd = vlc_custom_create(obj, sizeof(*vd), "vout display" );
90 91 92 93 94 95 96 97 98 99 100 101 102

    /* */
    video_format_Copy(&vd->source, fmt);

    /* Picture buffer does not have the concept of aspect ratio */
    video_format_Copy(&vd->fmt, fmt);
    vd->fmt.i_sar_num = 0;
    vd->fmt.i_sar_den = 0;

    vd->info.is_slow = false;
    vd->info.has_double_click = false;
    vd->info.has_hide_mouse = false;
    vd->info.has_pictures_invalid = false;
103
    vd->info.has_event_thread = false;
104
    vd->info.subpicture_chromas = NULL;
105 106

    vd->cfg = cfg;
107
    vd->pool = NULL;
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
    vd->prepare = NULL;
    vd->display = NULL;
    vd->control = NULL;
    vd->manage = NULL;
    vd->sys = NULL;

    vd->owner = *owner;

    if (load_module) {
        vd->module = module_need(vd, "vout display", module, module && *module != '\0');
        if (!vd->module) {
            vlc_object_release(vd);
            return NULL;
        }
    } else {
        vd->module = NULL;
    }
    return vd;
}

/**
 * It deletes a vout_display_t
 */
static void vout_display_Delete(vout_display_t *vd)
{
    if (vd->module)
        module_unneed(vd, vd->module);

Hannes Domani's avatar
Hannes Domani committed
136 137 138
    video_format_Clean(&vd->source);
    video_format_Clean(&vd->fmt);

139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
    vlc_object_release(vd);
}

/**
 * It controls a vout_display_t
 */
static int vout_display_Control(vout_display_t *vd, int query, ...)
{
    va_list args;
    int result;

    va_start(args, query);
    result = vd->control(vd, query, args);
    va_end(args);

    return result;
}
156

157 158
static void vout_display_Manage(vout_display_t *vd)
{
159 160
    if (vd->manage)
        vd->manage(vd);
161 162 163
}

/* */
164
void vout_display_GetDefaultDisplaySize(unsigned *width, unsigned *height,
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
                                        const video_format_t *source,
                                        const vout_display_cfg_t *cfg)
{
    if (cfg->display.width > 0 && cfg->display.height > 0) {
        *width  = cfg->display.width;
        *height = cfg->display.height;
    } else if (cfg->display.width > 0) {
        *width  = cfg->display.width;
        *height = (int64_t)source->i_visible_height * source->i_sar_den * cfg->display.width * cfg->display.sar.num /
            source->i_visible_width / source->i_sar_num / cfg->display.sar.den;
    } else if (cfg->display.height > 0) {
        *width  = (int64_t)source->i_visible_width * source->i_sar_num * cfg->display.height * cfg->display.sar.den /
            source->i_visible_height / source->i_sar_den / cfg->display.sar.num;
        *height = cfg->display.height;
    } else if (source->i_sar_num >= source->i_sar_den) {
        *width  = (int64_t)source->i_visible_width * source->i_sar_num * cfg->display.sar.den / source->i_sar_den / cfg->display.sar.num;
        *height = source->i_visible_height;
    } else {
        *width  = source->i_visible_width;
        *height = (int64_t)source->i_visible_height * source->i_sar_den * cfg->display.sar.num / source->i_sar_num / cfg->display.sar.den;
    }

    *width  = *width  * cfg->zoom.num / cfg->zoom.den;
    *height = *height * cfg->zoom.num / cfg->zoom.den;
189 190 191 192 193 194 195

    if (ORIENT_IS_SWAP(source->orientation)) {

        unsigned store = *width;
        *width = *height;
        *height = store;
    }
196 197 198 199 200 201 202 203 204 205 206 207 208 209
}

/* */
void vout_display_PlacePicture(vout_display_place_t *place,
                               const video_format_t *source,
                               const vout_display_cfg_t *cfg,
                               bool do_clipping)
{
    /* */
    memset(place, 0, sizeof(*place));
    if (cfg->display.width <= 0 || cfg->display.height <= 0)
        return;

    /* */
210 211
    unsigned display_width;
    unsigned display_height;
212

213
    video_format_t source_rot;
214
    video_format_ApplyRotation(&source_rot, source);
215 216
    source = &source_rot;

217 218 219 220 221 222 223 224
    if (cfg->is_display_filled) {
        display_width  = cfg->display.width;
        display_height = cfg->display.height;
    } else {
        vout_display_cfg_t cfg_tmp = *cfg;

        cfg_tmp.display.width  = 0;
        cfg_tmp.display.height = 0;
225
        vout_display_GetDefaultDisplaySize(&display_width, &display_height,
226 227 228 229 230 231 232 233
                                           source, &cfg_tmp);

        if (do_clipping) {
            display_width  = __MIN(display_width,  cfg->display.width);
            display_height = __MIN(display_height, cfg->display.height);
        }
    }

234 235
    const unsigned width  = source->i_visible_width;
    const unsigned height = source->i_visible_height;
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
    /* Compute the height if we use the width to fill up display_width */
    const int64_t scaled_height = (int64_t)height * display_width  * cfg->display.sar.num * source->i_sar_den / width  / source->i_sar_num / cfg->display.sar.den;
    /* And the same but switching width/height */
    const int64_t scaled_width  = (int64_t)width  * display_height * cfg->display.sar.den * source->i_sar_num / height / source->i_sar_den / cfg->display.sar.num;

    /* We keep the solution that avoid filling outside the display */
    if (scaled_width <= cfg->display.width) {
        place->width  = scaled_width;
        place->height = display_height;
    } else {
        place->width  = display_width;
        place->height = scaled_height;
    }

    /*  Compute position */
    switch (cfg->align.horizontal) {
    case VOUT_DISPLAY_ALIGN_LEFT:
        place->x = 0;
        break;
    case VOUT_DISPLAY_ALIGN_RIGHT:
        place->x = cfg->display.width - place->width;
        break;
    default:
Erwan Tulou's avatar
Erwan Tulou committed
259
        place->x = ((int)cfg->display.width - (int)place->width) / 2;
260 261 262 263 264 265 266 267 268 269 270
        break;
    }

    switch (cfg->align.vertical) {
    case VOUT_DISPLAY_ALIGN_TOP:
        place->y = 0;
        break;
    case VOUT_DISPLAY_ALIGN_BOTTOM:
        place->y = cfg->display.height - place->height;
        break;
    default:
Erwan Tulou's avatar
Erwan Tulou committed
271
        place->y = ((int)cfg->display.height - (int)place->height) / 2;
272 273 274 275
        break;
    }
}

276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
void vout_display_SendMouseMovedDisplayCoordinates(vout_display_t *vd, video_orientation_t orient_display, int m_x, int m_y, vout_display_place_t *place)
{
    video_format_t source_rot = vd->source;
    video_format_TransformTo(&source_rot, orient_display);

    if (place->width > 0 && place->height > 0) {

        int x = (int)(source_rot.i_x_offset +
                            (int64_t)(m_x - place->x) * source_rot.i_visible_width / place->width);
        int y = (int)(source_rot.i_y_offset +
                            (int64_t)(m_y - place->y) * source_rot.i_visible_height/ place->height);

        video_transform_t transform = video_format_GetTransform(vd->source.orientation, orient_display);

        int store;

        switch (transform) {

            case TRANSFORM_R90:
                store = x;
                x = y;
                y = vd->source.i_visible_height - store;
                break;
            case TRANSFORM_R180:
                x = vd->source.i_visible_width - x;
                y = vd->source.i_visible_height - y;
                break;
            case TRANSFORM_R270:
                store = x;
                x = vd->source.i_visible_width - y;
                y = store;
                break;
            case TRANSFORM_HFLIP:
                x = vd->source.i_visible_width - x;
                break;
            case TRANSFORM_VFLIP:
                y = vd->source.i_visible_height - y;
                break;
            case TRANSFORM_TRANSPOSE:
                store = x;
                x = y;
                y = store;
                break;
            case TRANSFORM_ANTI_TRANSPOSE:
                store = x;
                x = vd->source.i_visible_width - y;
                y = vd->source.i_visible_height - store;
                break;
            default:
                break;
        }

        vout_display_SendEventMouseMoved (vd, x, y);
    }
}

332 333 334 335 336 337 338
struct vout_display_owner_sys_t {
    vout_thread_t   *vout;
    bool            is_wrapper;  /* Is the current display a wrapper */
    vout_display_t  *wrapper; /* Vout display wrapper */

    /* */
    vout_display_cfg_t cfg;
339
    unsigned     wm_state_initial;
340 341 342 343 344 345
    struct {
        unsigned num;
        unsigned den;
    } sar_initial;

    /* */
Laurent Aimar's avatar
Laurent Aimar committed
346 347
    unsigned width_saved;
    unsigned height_saved;
348 349 350 351 352 353 354 355 356 357 358 359

    struct {
        unsigned num;
        unsigned den;
    } crop_saved;

    /* */
    bool ch_display_filled;
    bool is_display_filled;

    bool ch_zoom;
    struct {
360 361
        unsigned num;
        unsigned den;
362 363
    } zoom;

364 365
    bool ch_wm_state;
    unsigned wm_state;
366 367 368 369 370 371 372 373 374

    bool ch_sar;
    struct {
        unsigned num;
        unsigned den;
    } sar;

    bool ch_crop;
    struct {
375 376 377 378
        int      left;
        int      top;
        int      right;
        int      bottom;
379 380 381 382 383 384 385
        unsigned num;
        unsigned den;
    } crop;

    /* */
    video_format_t source;
    filter_chain_t *filters;
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412

    /* Lock protecting the variables used by
     * VoutDisplayEvent(ie vout_display_SendEvent) */
    vlc_mutex_t lock;

    /* mouse state */
    struct {
        vlc_mouse_t state;

        mtime_t last_pressed;
        mtime_t last_moved;
        bool    is_hidden;
        bool    ch_activity;

        /* */
        mtime_t double_click_timeout;
        mtime_t hide_timeout;
    } mouse;

    bool reset_pictures;

    bool ch_fullscreen;
    bool is_fullscreen;

    bool ch_display_size;
    int  display_width;
    int  display_height;
413
    bool display_is_forced;
414

415 416
    int  fit_window;

417 418 419 420 421
    struct {
        vlc_thread_t thread;
        block_fifo_t *fifo;
    } event;

422 423 424
#ifdef ALLOW_DUMMY_VOUT
    vlc_mouse_t vout_mouse;
#endif
425 426
};

427 428
static void DummyVoutSendDisplayEventMouse(vout_thread_t *, vlc_mouse_t *fallback, const vlc_mouse_t *m);

429 430 431 432 433 434 435 436 437 438 439 440 441 442
static void VoutDisplayCreateRender(vout_display_t *vd)
{
    vout_display_owner_sys_t *osys = vd->owner.sys;

    osys->filters = NULL;

    video_format_t v_src = vd->source;
    v_src.i_sar_num = 0;
    v_src.i_sar_den = 0;

    video_format_t v_dst = vd->fmt;
    v_dst.i_sar_num = 0;
    v_dst.i_sar_den = 0;

443 444 445 446 447 448 449 450
    video_format_t v_dst_cmp = v_dst;
    if ((v_src.i_chroma == VLC_CODEC_J420 && v_dst.i_chroma == VLC_CODEC_I420) ||
        (v_src.i_chroma == VLC_CODEC_J422 && v_dst.i_chroma == VLC_CODEC_I422) ||
        (v_src.i_chroma == VLC_CODEC_J440 && v_dst.i_chroma == VLC_CODEC_I440) ||
        (v_src.i_chroma == VLC_CODEC_J444 && v_dst.i_chroma == VLC_CODEC_I444))
        v_dst_cmp.i_chroma = v_src.i_chroma;

    const bool convert = memcmp(&v_src, &v_dst_cmp, sizeof(v_src)) != 0;
451 452 453
    if (!convert)
        return;

Antoine Cellerier's avatar
Antoine Cellerier committed
454
    msg_Dbg(vd, "A filter to adapt decoder to display is needed");
455

456 457 458 459 460 461 462 463 464
    filter_owner_t owner = {
        .sys = vd,
        .video = {
            .buffer_new = VideoBufferNew,
            .buffer_del = VideoBufferDelete,
        },
    };

    osys->filters = filter_chain_NewVideo(vd, false, &owner);
465 466 467 468 469 470 471
    assert(osys->filters); /* TODO critical */

    /* */
    es_format_t src;
    es_format_InitFromVideo(&src, &v_src);

    /* */
472 473
    filter_t *filter;
    for (int i = 0; i < 1 + (v_dst_cmp.i_chroma != v_dst.i_chroma); i++) {
Hannes Domani's avatar
Hannes Domani committed
474
        es_format_t dst;
475

476 477 478 479 480
        es_format_InitFromVideo(&dst, i == 0 ? &v_dst : &v_dst_cmp);

        filter_chain_Reset(osys->filters, &src, &dst);
        filter = filter_chain_AppendFilter(osys->filters,
                                           NULL, NULL, &src, &dst);
Hannes Domani's avatar
Hannes Domani committed
481
        es_format_Clean(&dst);
482 483 484
        if (filter)
            break;
    }
Hannes Domani's avatar
Hannes Domani committed
485
    es_format_Clean(&src);
486
    if (!filter)
487
        msg_Err(vd, "Failed to adapt decoder format to display");
488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
}

static void VoutDisplayDestroyRender(vout_display_t *vd)
{
    vout_display_owner_sys_t *osys = vd->owner.sys;

    if (osys->filters)
        filter_chain_Delete(osys->filters);
}

static void VoutDisplayResetRender(vout_display_t *vd)
{
    VoutDisplayDestroyRender(vd);
    VoutDisplayCreateRender(vd);
}
503
static void VoutDisplayEventMouse(vout_display_t *vd, int event, va_list args)
504 505 506
{
    vout_display_owner_sys_t *osys = vd->owner.sys;

507 508
    vlc_mutex_lock(&osys->lock);

509
    /* */
510 511
    vlc_mouse_t m = osys->mouse.state;
    bool is_ignored = false;
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528

    switch (event) {
    case VOUT_DISPLAY_EVENT_MOUSE_STATE: {
        const int x = (int)va_arg(args, int);
        const int y = (int)va_arg(args, int);
        const int button_mask = (int)va_arg(args, int);

        vlc_mouse_Init(&m);
        m.i_x = x;
        m.i_y = y;
        m.i_pressed = button_mask;
        break;
    }
    case VOUT_DISPLAY_EVENT_MOUSE_MOVED: {
        const int x = (int)va_arg(args, int);
        const int y = (int)va_arg(args, int);

529 530 531 532 533
        //msg_Dbg(vd, "VoutDisplayEvent 'mouse' @%d,%d", x, y);

        m.i_x = x;
        m.i_y = y;
        m.b_double_click = false;
534 535 536 537 538 539 540
        break;
    }
    case VOUT_DISPLAY_EVENT_MOUSE_PRESSED:
    case VOUT_DISPLAY_EVENT_MOUSE_RELEASED: {
        const int button = (int)va_arg(args, int);
        const int button_mask = 1 << button;

541 542 543 544
        /* Ignore inconsistent event */
        if ((event == VOUT_DISPLAY_EVENT_MOUSE_PRESSED  &&  (osys->mouse.state.i_pressed & button_mask)) ||
            (event == VOUT_DISPLAY_EVENT_MOUSE_RELEASED && !(osys->mouse.state.i_pressed & button_mask))) {
            is_ignored = true;
545
            break;
546
        }
547 548 549 550 551 552 553 554 555 556 557

        /* */
        msg_Dbg(vd, "VoutDisplayEvent 'mouse button' %d t=%d", button, event);

        m.b_double_click = false;
        if (event == VOUT_DISPLAY_EVENT_MOUSE_PRESSED)
            m.i_pressed |= button_mask;
        else
            m.i_pressed &= ~button_mask;
        break;
    }
558
    case VOUT_DISPLAY_EVENT_MOUSE_DOUBLE_CLICK:
559 560 561
        msg_Dbg(vd, "VoutDisplayEvent 'double click'");

        m.b_double_click = true;
562 563 564 565 566
        break;
    default:
        assert(0);
    }

567 568
    if (is_ignored) {
        vlc_mutex_unlock(&osys->lock);
569
        return;
570
    }
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588

    /* Emulate double-click if needed */
    if (!vd->info.has_double_click &&
        vlc_mouse_HasPressed(&osys->mouse.state, &m, MOUSE_BUTTON_LEFT)) {
        const mtime_t i_date = mdate();

        if (i_date - osys->mouse.last_pressed < osys->mouse.double_click_timeout ) {
            m.b_double_click = true;
            osys->mouse.last_pressed = 0;
        } else {
            osys->mouse.last_pressed = mdate();
        }
    }

    /* */
    osys->mouse.state = m;

    /* */
589
    osys->mouse.ch_activity = true;
590 591 592 593 594
    if (!vd->info.has_hide_mouse)
        osys->mouse.last_moved = mdate();

    /* */
    vout_SendEventMouseVisible(osys->vout);
595 596 597
#ifdef ALLOW_DUMMY_VOUT
    DummyVoutSendDisplayEventMouse(osys->vout, &osys->vout_mouse, &m);
#else
598
    vout_SendDisplayEventMouse(osys->vout, &m);
599
#endif
600
    vlc_mutex_unlock(&osys->lock);
601 602
}

603
VLC_NORETURN
604 605
static void *VoutDisplayEventKeyDispatch(void *data)
{
606
    vout_display_owner_sys_t *osys = data;
607 608 609

    for (;;) {
        block_t *event = block_FifoGet(osys->event.fifo);
610 611

        int cancel = vlc_savecancel();
612 613 614 615 616

        int key;
        memcpy(&key, event->p_buffer, sizeof(key));
        vout_SendEventKey(osys->vout, key);
        block_Release(event);
617 618

        vlc_restorecancel(cancel);
619 620 621 622 623 624 625 626 627 628 629 630
    }
}

static void VoutDisplayEventKey(vout_display_t *vd, int key)
{
    vout_display_owner_sys_t *osys = vd->owner.sys;

    if (!osys->event.fifo) {
        osys->event.fifo = block_FifoNew();
        if (!osys->event.fifo)
            return;
        if (vlc_clone(&osys->event.thread, VoutDisplayEventKeyDispatch,
631
                      osys, VLC_THREAD_PRIORITY_LOW)) {
632 633 634 635 636 637 638 639 640 641 642 643
            block_FifoRelease(osys->event.fifo);
            osys->event.fifo = NULL;
            return;
        }
    }
    block_t *event = block_Alloc(sizeof(key));
    if (event) {
        memcpy(event->p_buffer, &key, sizeof(key));
        block_FifoPut(osys->event.fifo, event);
    }
}

644 645 646 647 648 649 650 651 652 653 654 655 656
static void VoutDisplayEvent(vout_display_t *vd, int event, va_list args)
{
    vout_display_owner_sys_t *osys = vd->owner.sys;

    switch (event) {
    case VOUT_DISPLAY_EVENT_CLOSE: {
        msg_Dbg(vd, "VoutDisplayEvent 'close'");
        vout_SendEventClose(osys->vout);
        break;
    }
    case VOUT_DISPLAY_EVENT_KEY: {
        const int key = (int)va_arg(args, int);
        msg_Dbg(vd, "VoutDisplayEvent 'key' 0x%2.2x", key);
657 658 659 660
        if (vd->info.has_event_thread)
            vout_SendEventKey(osys->vout, key);
        else
            VoutDisplayEventKey(vd, key);
661 662
        break;
    }
663 664 665 666 667 668 669
    case VOUT_DISPLAY_EVENT_MOUSE_STATE:
    case VOUT_DISPLAY_EVENT_MOUSE_MOVED:
    case VOUT_DISPLAY_EVENT_MOUSE_PRESSED:
    case VOUT_DISPLAY_EVENT_MOUSE_RELEASED:
    case VOUT_DISPLAY_EVENT_MOUSE_DOUBLE_CLICK:
        VoutDisplayEventMouse(vd, event, args);
        break;
670 671 672 673 674 675

    case VOUT_DISPLAY_EVENT_FULLSCREEN: {
        const int is_fullscreen = (int)va_arg(args, int);

        msg_Dbg(vd, "VoutDisplayEvent 'fullscreen' %d", is_fullscreen);

676 677 678 679 680 681
        vlc_mutex_lock(&osys->lock);
        if (!is_fullscreen != !osys->is_fullscreen) {
            osys->ch_fullscreen = true;
            osys->is_fullscreen = is_fullscreen;
        }
        vlc_mutex_unlock(&osys->lock);
682 683 684
        break;
    }

685 686
    case VOUT_DISPLAY_EVENT_WINDOW_STATE: {
        const unsigned state = va_arg(args, unsigned);
687

688
        msg_Dbg(vd, "VoutDisplayEvent 'window state' %u", state);
689 690

        vlc_mutex_lock(&osys->lock);
691 692 693
        if (state != osys->wm_state) {
            osys->ch_wm_state = true;
            osys->wm_state = state;
694 695 696 697 698
        }
        vlc_mutex_unlock(&osys->lock);
        break;
    }

699 700 701
    case VOUT_DISPLAY_EVENT_DISPLAY_SIZE: {
        const int width  = (int)va_arg(args, int);
        const int height = (int)va_arg(args, int);
702 703 704
        const bool is_fullscreen = (bool)va_arg(args, int);
        msg_Dbg(vd, "VoutDisplayEvent 'resize' %dx%d %s",
                width, height, is_fullscreen ? "fullscreen" : "window");
705 706

        /* */
707 708
        vlc_mutex_lock(&osys->lock);

709 710 711 712
        osys->ch_display_size   = true;
        osys->display_width     = width;
        osys->display_height    = height;
        osys->display_is_forced = false;
713 714

        vlc_mutex_unlock(&osys->lock);
715 716 717 718 719 720 721 722
        break;
    }

    case VOUT_DISPLAY_EVENT_PICTURES_INVALID: {
        msg_Warn(vd, "VoutDisplayEvent 'pictures invalid'");

        /* */
        assert(vd->info.has_pictures_invalid);
723 724

        vlc_mutex_lock(&osys->lock);
725
        osys->reset_pictures = true;
726
        vlc_mutex_unlock(&osys->lock);
727 728 729 730 731 732 733 734 735 736 737 738 739
        break;
    }
    default:
        msg_Err(vd, "VoutDisplayEvent received event %d", event);
        /* TODO add an assert when all event are handled */
        break;
    }
}

static vout_window_t *VoutDisplayNewWindow(vout_display_t *vd, const vout_window_cfg_t *cfg)
{
    vout_display_owner_sys_t *osys = vd->owner.sys;

740 741 742 743 744 745 746
#ifdef ALLOW_DUMMY_VOUT
    if (!osys->vout->p) {
        vout_window_cfg_t cfg_override = *cfg;

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

747 748
        return vout_window_New(VLC_OBJECT(osys->vout), "$window",
                               &cfg_override, NULL);
749 750
    }
#endif
751
    return vout_NewDisplayWindow(osys->vout, cfg);
752
}
753

754 755 756 757
static void VoutDisplayDelWindow(vout_display_t *vd, vout_window_t *window)
{
    vout_display_owner_sys_t *osys = vd->owner.sys;

758 759 760 761 762 763 764
#ifdef ALLOW_DUMMY_VOUT
    if (!osys->vout->p) {
        if( window)
            vout_window_Delete(window);
        return;
    }
#endif
765
    vout_DeleteDisplayWindow(osys->vout, window);
766 767
}

768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791
static void VoutDisplayFitWindow(vout_display_t *vd, bool default_size)
{
    vout_display_owner_sys_t *osys = vd->owner.sys;
    vout_display_cfg_t cfg = osys->cfg;

    if (!cfg.is_display_filled)
        return;

    cfg.display.width = 0;
    if (default_size) {
        cfg.display.height = 0;
    } else {
        cfg.display.height = osys->height_saved;
        cfg.zoom.num = 1;
        cfg.zoom.den = 1;
    }

    unsigned display_width;
    unsigned display_height;
    vout_display_GetDefaultDisplaySize(&display_width, &display_height,
                                       &vd->source, &cfg);

    vlc_mutex_lock(&osys->lock);

792 793 794 795
    osys->ch_display_size   = true;
    osys->display_width     = display_width;
    osys->display_height    = display_height;
    osys->display_is_forced = true;
796 797 798 799

    vlc_mutex_unlock(&osys->lock);
}

800
static void VoutDisplayCropRatio(int *left, int *top, int *right, int *bottom,
801 802 803 804 805 806 807
                                 const video_format_t *source,
                                 unsigned num, unsigned den)
{
    unsigned scaled_width  = (uint64_t)source->i_visible_height * num * source->i_sar_den / den / source->i_sar_num;
    unsigned scaled_height = (uint64_t)source->i_visible_width  * den * source->i_sar_num / num / source->i_sar_den;

    if (scaled_width < source->i_visible_width) {
808 809 810 811
        *left   = (source->i_visible_width - scaled_width) / 2;
        *top    = 0;
        *right  = *left + scaled_width;
        *bottom = *top  + source->i_visible_height;
812
    } else {
813 814 815 816
        *left   = 0;
        *top    = (source->i_visible_height - scaled_height) / 2;
        *right  = *left + source->i_visible_width;
        *bottom = *top  + scaled_height;
817 818 819
    }
}

820
bool vout_ManageDisplay(vout_display_t *vd, bool allow_reset_pictures)
821 822 823 824 825 826 827
{
    vout_display_owner_sys_t *osys = vd->owner.sys;

    vout_display_Manage(vd);

    /* Handle mouse timeout */
    const mtime_t date = mdate();
828 829 830 831
    bool  hide_mouse = false;

    vlc_mutex_lock(&osys->lock);

832 833
    if (!osys->mouse.is_hidden &&
        osys->mouse.last_moved + osys->mouse.hide_timeout < date) {
834 835 836 837 838 839 840 841
        osys->mouse.is_hidden = hide_mouse = true;
    } else if (osys->mouse.ch_activity) {
        osys->mouse.is_hidden = false;
    }
    osys->mouse.ch_activity = false;
    vlc_mutex_unlock(&osys->lock);

    if (hide_mouse) {
842
        if (!vd->info.has_hide_mouse) {
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
843
            msg_Dbg(vd, "auto hiding mouse cursor");
844 845 846 847 848
            vout_display_Control(vd, VOUT_DISPLAY_HIDE_MOUSE);
        }
        vout_SendEventMouseHidden(osys->vout);
    }

849
    bool reset_render = false;
850
    for (;;) {
851 852 853 854 855 856 857

        vlc_mutex_lock(&osys->lock);

        bool ch_fullscreen  = osys->ch_fullscreen;
        bool is_fullscreen  = osys->is_fullscreen;
        osys->ch_fullscreen = false;

858 859 860
        bool ch_wm_state  = osys->ch_wm_state;
        unsigned wm_state  = osys->wm_state;
        osys->ch_wm_state = false;
861

862 863 864
        bool ch_display_size       = osys->ch_display_size;
        int  display_width         = osys->display_width;
        int  display_height        = osys->display_height;
865
        bool display_is_forced     = osys->display_is_forced;
866 867
        osys->ch_display_size = false;

868 869 870 871 872 873 874
        bool reset_pictures;
        if (allow_reset_pictures) {
            reset_pictures = osys->reset_pictures;
            osys->reset_pictures = false;
        } else {
            reset_pictures = false;
        }
875 876 877 878 879 880

        vlc_mutex_unlock(&osys->lock);

        if (!ch_fullscreen &&
            !ch_display_size &&
            !reset_pictures &&
881 882
            !osys->ch_display_filled &&
            !osys->ch_zoom &&
883
            !ch_wm_state &&
884
            !osys->ch_sar &&
885 886 887 888 889 890 891
            !osys->ch_crop) {

            if (!osys->cfg.is_fullscreen && osys->fit_window != 0) {
                VoutDisplayFitWindow(vd, osys->fit_window == -1);
                osys->fit_window = 0;
                continue;
            }
892
            break;
893
        }
894 895

        /* */
896
        if (ch_fullscreen) {
897 898
            vout_display_cfg_t cfg = osys->cfg;

899
            cfg.is_fullscreen  = is_fullscreen;
900 901 902 903 904
            cfg.display.width  = cfg.is_fullscreen ? 0 : osys->width_saved;
            cfg.display.height = cfg.is_fullscreen ? 0 : osys->height_saved;

            if (vout_display_Control(vd, VOUT_DISPLAY_CHANGE_FULLSCREEN, &cfg)) {
                msg_Err(vd, "Failed to set fullscreen");
905
                is_fullscreen = osys->cfg.is_fullscreen;
906 907
            } else if (!is_fullscreen) {
                vout_display_Control(vd, VOUT_DISPLAY_CHANGE_DISPLAY_SIZE, &cfg, true);
908
            }
909
            osys->cfg.is_fullscreen = is_fullscreen;
910 911 912 913 914 915

            /* */
            vout_SendEventFullscreen(osys->vout, osys->cfg.is_fullscreen);
        }

        /* */
916
        if (ch_display_size) {
917
            vout_display_cfg_t cfg = osys->cfg;
918 919
            cfg.display.width  = display_width;
            cfg.display.height = display_height;
920

921 922 923 924 925
            osys->width_saved  = osys->cfg.display.width;
            osys->height_saved = osys->cfg.display.height;

            if (vout_display_Control(vd, VOUT_DISPLAY_CHANGE_DISPLAY_SIZE,
                                     &cfg, display_is_forced)) {
926
                if (!display_is_forced)
927
                    msg_Err(vd, "Failed to resize display");
928 929

                /* We ignore the resized */
930 931
                display_width  = osys->cfg.display.width;
                display_height = osys->cfg.display.height;
932
            }
933 934
            osys->cfg.display.width  = display_width;
            osys->cfg.display.height = display_height;
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 961 962 963 964 965 966 967 968 969
        }
        /* */
        if (osys->ch_display_filled) {
            vout_display_cfg_t cfg = osys->cfg;

            cfg.is_display_filled = osys->is_display_filled;

            if (vout_display_Control(vd, VOUT_DISPLAY_CHANGE_DISPLAY_FILLED, &cfg)) {
                msg_Err(vd, "Failed to change display filled state");
                osys->is_display_filled = osys->cfg.is_display_filled;
            }
            osys->cfg.is_display_filled = osys->is_display_filled;
            osys->ch_display_filled = false;

            vout_SendEventDisplayFilled(osys->vout, osys->cfg.is_display_filled);
        }
        /* */
        if (osys->ch_zoom) {
            vout_display_cfg_t cfg = osys->cfg;

            cfg.zoom.num = osys->zoom.num;
            cfg.zoom.den = osys->zoom.den;

            if (10 * cfg.zoom.num <= cfg.zoom.den) {
                cfg.zoom.num = 1;
                cfg.zoom.den = 10;
            } else if (cfg.zoom.num >= 10 * cfg.zoom.den) {
                cfg.zoom.num = 10;
                cfg.zoom.den = 1;
            }

            if (vout_display_Control(vd, VOUT_DISPLAY_CHANGE_ZOOM, &cfg)) {
                msg_Err(vd, "Failed to change zoom");
                osys->zoom.num = osys->cfg.zoom.num;
                osys->zoom.den = osys->cfg.zoom.den;
970 971
            } else {
                osys->fit_window = -1;
972 973 974 975 976 977 978 979 980
            }

            osys->cfg.zoom.num = osys->zoom.num;
            osys->cfg.zoom.den = osys->zoom.den;
            osys->ch_zoom = false;

            vout_SendEventZoom(osys->vout, osys->cfg.zoom.num, osys->cfg.zoom.den);
        }
        /* */
981 982
        if (ch_wm_state) {
            if (vout_display_Control(vd, VOUT_DISPLAY_CHANGE_WINDOW_STATE, wm_state)) {
983
                msg_Err(vd, "Failed to set on top");
984
                wm_state = osys->wm_state;
985
            }
986
            osys->wm_state_initial = wm_state;
987 988

            /* */
989
            vout_SendEventOnTop(osys->vout, osys->wm_state_initial);
990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
        }
        /* */
        if (osys->ch_sar) {
            video_format_t source = vd->source;

            if (osys->sar.num > 0 && osys->sar.den > 0) {
                source.i_sar_num = osys->sar.num;
                source.i_sar_den = osys->sar.den;
            } else {
                source.i_sar_num = osys->source.i_sar_num;
                source.i_sar_den = osys->source.i_sar_den;
            }

            if (vout_display_Control(vd, VOUT_DISPLAY_CHANGE_SOURCE_ASPECT, &source)) {
                /* There nothing much we can do. The only reason a vout display
                 * does not support it is because it need the core to add black border
                 * to the video for it.
                 * TODO add black borders ?
                 */
                msg_Err(vd, "Failed to change source AR");
                source = vd->source;
1011 1012
            } else if (!osys->fit_window) {
                osys->fit_window = 1;
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
            }
            vd->source = source;
            osys->sar.num = source.i_sar_num;
            osys->sar.den = source.i_sar_den;
            osys->ch_sar  = false;

            /* */
            if (osys->sar.num == osys->source.i_sar_num &&
                osys->sar.den == osys->source.i_sar_den)
            {
                vout_SendEventSourceAspect(osys->vout, 0, 0);
            }
            else
            {
                unsigned dar_num, dar_den;
                vlc_ureduce( &dar_num, &dar_den,
                             osys->sar.num * vd->source.i_visible_width,
                             osys->sar.den * vd->source.i_visible_height,
                             65536);
                vout_SendEventSourceAspect(osys->vout, dar_num, dar_den);
            }
1034 1035 1036
            /* If a crop ratio is requested, recompute the parameters */
            if (osys->crop.num > 0 && osys->crop.den > 0)
                osys->ch_crop = true;
1037 1038 1039 1040
        }
        /* */
        if (osys->ch_crop) {
            video_format_t source = vd->source;
1041

1042 1043
            unsigned crop_num = osys->crop.num;
            unsigned crop_den = osys->crop.den;
1044 1045 1046 1047
            if (crop_num > 0 && crop_den > 0) {
                video_format_t fmt = osys->source;
                fmt.i_sar_num = source.i_sar_num;
                fmt.i_sar_den = source.i_sar_den;
1048 1049
                VoutDisplayCropRatio(&osys->crop.left,  &osys->crop.top,
                                     &osys->crop.right, &osys->crop.bottom,
1050 1051
                                     &fmt, crop_num, crop_den);
            }
1052 1053
            const int right_max  = osys->source.i_x_offset + osys->source.i_visible_width;
            const int bottom_max = osys->source.i_y_offset + osys->source.i_visible_height;
1054
            int left   = VLC_CLIP((int)osys->source.i_x_offset + osys->crop.left,
1055
                                0, right_max - 1);
1056
            int top    = VLC_CLIP((int)osys->source.i_y_offset + osys->crop.top,
1057 1058 1059 1060 1061 1062
                                0, bottom_max - 1);
            int right, bottom;
            if (osys->crop.right <= 0)
                right = (int)(osys->source.i_x_offset + osys->source.i_visible_width) + osys->crop.right;
            else
                right = (int)osys->source.i_x_offset + osys->crop.right;
1063
            right = VLC_CLIP(right, left + 1, right_max);
1064 1065 1066 1067
            if (osys->crop.bottom <= 0)
                bottom = (int)(osys->source.i_y_offset + osys->source.i_visible_height) + osys->crop.bottom;
            else
                bottom = (int)osys->source.i_y_offset + osys->crop.bottom;
1068
            bottom = VLC_CLIP(bottom, top + 1, bottom_max);
1069 1070 1071 1072 1073 1074 1075 1076 1077

            source.i_x_offset       = left;
            source.i_y_offset       = top;
            source.i_visible_width  = right - left;
            source.i_visible_height = bottom - top;
            video_format_Print(VLC_OBJECT(vd), "SOURCE ", &osys->source);
            video_format_Print(VLC_OBJECT(vd), "CROPPED", &source);
            if (vout_display_Control(vd, VOUT_DISPLAY_CHANGE_SOURCE_CROP, &source)) {
                msg_Err(vd, "Failed to change source crop TODO implement crop at core");
1078 1079 1080 1081 1082 1083 1084

                source = vd->source;
                crop_num = osys->crop_saved.num;
                crop_den = osys->crop_saved.den;
                /* FIXME implement cropping in the core if not supported by the
                 * vout module (easy)
                 */
1085 1086
            } else if (!osys->fit_window) {
                osys->fit_window = 1;
1087 1088
            }
            vd->source = source;
1089 1090 1091 1092 1093 1094 1095
            osys->crop.left   = source.i_x_offset - osys->source.i_x_offset;
            osys->crop.top    = source.i_y_offset - osys->source.i_y_offset;
            /* FIXME for right/bottom we should keep the 'type' border vs window */
            osys->crop.right  = (source.i_x_offset + source.i_visible_width) -
                                (osys->source.i_x_offset + osys->source.i_visible_width);
            osys->crop.bottom = (source.i_y_offset + source.i_visible_height) -
                                (osys->source.i_y_offset + osys->source.i_visible_height);
1096 1097 1098 1099 1100 1101
            osys->crop.num    = crop_num;
            osys->crop.den    = crop_den;
            osys->ch_crop = false;

            vout_SendEventSourceCrop(osys->vout,
                                     osys->crop.num, osys->crop.den,
1102 1103
                                     osys->crop.left, osys->crop.top,
                                     -osys->crop.right, -osys->crop.bottom);
1104 1105 1106
        }

        /* */
1107
        if (reset_pictures) {
1108 1109 1110 1111
            if (vout_display_Control(vd, VOUT_DISPLAY_RESET_PICTURES)) {
                /* FIXME what to do here ? */
                msg_Err(vd, "Failed to reset pictures (probably fatal)");
            }
1112
            reset_render = true;
1113 1114
        }
    }
1115
    if (reset_render)
1116
        VoutDisplayResetRender(vd);
1117 1118

    return reset_render;
1119 1120 1121 1122 1123 1124
}

bool vout_AreDisplayPicturesInvalid(vout_display_t *vd)
{
    vout_display_owner_sys_t *osys = vd->owner.sys;

1125 1126 1127 1128 1129
    vlc_mutex_lock(&osys->lock);
    const bool reset_pictures = osys->reset_pictures;
    vlc_mutex_unlock(&osys->lock);

    return reset_pictures;
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
}

bool vout_IsDisplayFiltered(vout_display_t *vd)
{
    vout_display_owner_sys_t *osys = vd->owner.sys;

    return osys->filters != NULL;
}

picture_t *vout_FilterDisplay(vout_display_t *vd, picture_t *picture)
{
    vout_display_owner_sys_t *osys = vd->owner.sys;

1143
    assert(osys->filters);
1144 1145 1146 1147
    if (filter_chain_GetLength(osys->filters) <= 0) {
        picture_Release(picture);
        return NULL;
    }
1148 1149 1150
    return filter_chain_VideoFilter(osys->filters, picture);
}

1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180
void vout_UpdateDisplaySourceProperties(vout_display_t *vd, const video_format_t *source)
{
    vout_display_owner_sys_t *osys = vd->owner.sys;

    if (source->i_sar_num * osys->source.i_sar_den !=
        source->i_sar_den * osys->source.i_sar_num) {

        osys->source.i_sar_num = source->i_sar_num;
        osys->source.i_sar_den = source->i_sar_den;
        vlc_ureduce(&osys->source.i_sar_num, &osys->source.i_sar_den,
                    osys->source.i_sar_num, osys->source.i_sar_den, 0);

        /* FIXME it will override any AR that the user would have forced */
        osys->ch_sar = true;
        osys->sar.num = osys->source.i_sar_num;
        osys->sar.den = osys->source.i_sar_den;
    }
    if (source->i_x_offset       != osys->source.i_x_offset ||
        source->i_y_offset       != osys->source.i_y_offset ||
        source->i_visible_width  != osys->source.i_visible_width ||
        source->i_visible_height != osys->source.i_visible_height) {

        video_format_CopyCrop(&osys->source, source);

        /* Force the vout to reapply the current user crop settings over the new decoder
         * crop settings. */
        osys->ch_crop = true;
    }
}

1181 1182 1183 1184
void vout_SetDisplayFullscreen(vout_display_t *vd, bool is_fullscreen)
{
    vout_display_owner_sys_t *osys = vd->owner.sys;

1185
    vlc_mutex_lock(&osys->lock);
1186 1187 1188 1189
    if (!osys->is_fullscreen != !is_fullscreen) {
        osys->ch_fullscreen = true;
        osys->is_fullscreen = is_fullscreen;
    }
1190
    vlc_mutex_unlock(&osys->lock);
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
}

void vout_SetDisplayFilled(vout_display_t *vd, bool is_filled)
{
    vout_display_owner_sys_t *osys = vd->owner.sys;

    if (!osys->is_display_filled != !is_filled) {
        osys->ch_display_filled = true;
        osys->is_display_filled = is_filled;
    }
}

1203
void vout_SetDisplayZoom(vout_display_t *vd, unsigned num, unsigned den)
1204 1205 1206
{
    vout_display_owner_sys_t *osys = vd->owner.sys;

1207 1208 1209 1210 1211 1212 1213
    if (num > 0 && den > 0) {
        vlc_ureduce(&num, &den, num, den, 0);
    } else {
        num = 1;
        den = 1;
    }

1214 1215
    if (osys->is_display_filled ||
        osys->zoom.num != num || osys->zoom.den != den) {
1216 1217 1218 1219 1220
        osys->ch_zoom = true;
        osys->zoom.num = num;
        osys->zoom.den = den;
    }
}
1221 1222

void vout_SetWindowState(vout_display_t *vd, unsigned state)
1223 1224 1225
{
    vout_display_owner_sys_t *osys = vd->owner.sys;

1226
    vlc_mutex_lock(&osys->lock);
1227 1228 1229
    if (osys->wm_state != state) {
        osys->ch_wm_state = true;
        osys->wm_state = state;
1230
    }
1231
    vlc_mutex_unlock(&osys->lock);
1232
}
1233

1234
void vout_SetDisplayAspect(vout_display_t *vd, unsigned dar_num, unsigned dar_den)
1235 1236 1237
{
    vout_display_owner_sys_t *osys = vd->owner.sys;

1238 1239 1240 1241 1242 1243
    unsigned sar_num, sar_den;
    if (dar_num > 0 && dar_den > 0) {
        sar_num = dar_num * osys->source.i_visible_height;
        sar_den = dar_den * osys->source.i_visible_width;
        vlc_ureduce(&sar_num, &sar_den, sar_num, sar_den, 0);
    } else {
1244 1245
        sar_num = 0;
        sar_den = 0;
1246 1247
    }

1248 1249 1250 1251 1252 1253 1254 1255
    if (osys->sar.num != sar_num || osys->sar.den != sar_den) {
        osys->ch_sar = true;
        osys->sar.num = sar_num;
        osys->sar.den = sar_den;
    }
}
void vout_SetDisplayCrop(vout_display_t *vd,
                         unsigned crop_num, unsigned crop_den,
1256
                         unsigned left, unsigned top, int right, int bottom)
1257 1258 1259
{
    vout_display_owner_sys_t *osys = vd->owner.sys;

1260 1261
    if (osys->crop.left  != (int)left  || osys->crop.top != (int)top ||
        osys->crop.right != right || osys->crop.bottom != bottom ||
1262 1263
        (crop_num > 0 && crop_den > 0 &&
         (crop_num != osys->crop.num || crop_den != osys->crop.den))) {
1264

1265 1266 1267 1268
        osys->crop.left   = left;
        osys->crop.top    = top;
        osys->crop.right  = right;
        osys->crop.bottom = bottom;
1269 1270 1271 1272 1273 1274
        osys->crop.num    = crop_num;
        osys->crop.den    = crop_den;

        osys->ch_crop = true;