bluray.c 47 KB
Newer Older
1 2 3
/*****************************************************************************
 * bluray.c: Blu-ray disc support plugin
 *****************************************************************************
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
4
 * Copyright © 2010-2012 VideoLAN, VLC authors and libbluray AUTHORS
5 6
 *
 * Authors: Jean-Baptiste Kempf <jb@videolan.org>
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
7
 *          Hugo Beauzée-Luyssen <hugo@videolan.org>
8
 *
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
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17
 * GNU Lesser General Public License for more details.
18
 *
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
 *****************************************************************************/

#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

#include <assert.h>
29
#include <limits.h>                         /* PATH_MAX */
30 31 32 33
#if defined (HAVE_MNTENT_H) && defined(HAVE_SYS_STAT_H)
#include <mntent.h>
#include <sys/stat.h>
#endif
34

35 36 37 38 39 40 41
#ifdef __APPLE__
#include <sys/stat.h>
#include <sys/param.h>
#include <sys/ucred.h>
#include <sys/mount.h>
#endif

42 43
#include <vlc_common.h>
#include <vlc_plugin.h>
44 45
#include <vlc_demux.h>                      /* demux_t */
#include <vlc_input.h>                      /* Seekpoints, chapters */
46
#include <vlc_atomic.h>
47
#include <vlc_dialog.h>                     /* BD+/AACS warnings */
48
#include <vlc_vout.h>                       /* vout_PutSubpicture / subpicture_t */
49
#include <vlc_url.h>                        /* vlc_path2uri */
50 51 52 53 54
#include <vlc_iso_lang.h>

/* FIXME we should find a better way than including that */
#include "../../src/text/iso-639_def.h"

55 56

#include <libbluray/bluray.h>
57
#include <libbluray/keys.h>
58
#include <libbluray/meta_data.h>
59
#include <libbluray/overlay.h>
60 61 62 63 64

/*****************************************************************************
 * Module descriptor
 *****************************************************************************/

Rafaël Carré's avatar
Rafaël Carré committed
65 66 67 68 69
#define BD_MENU_TEXT        N_("Blu-ray menus")
#define BD_MENU_LONGTEXT    N_("Use Blu-ray menus. If disabled, "\
                                "the movie will start directly")
#define BD_REGION_TEXT      N_("Region code")
#define BD_REGION_LONGTEXT  N_("Blu-Ray player region code. "\
70 71 72 73 74 75 76 77
                                "Some discs can be played only with a correct region code.")

static const char *const ppsz_region_code[] = {
    "A", "B", "C" };
static const char *const ppsz_region_code_text[] = {
    "Region A", "Region B", "Region C" };

#define REGION_DEFAULT   1   /* Index to region list. Actual region code is (1<<REGION_DEFAULT) */
78
#define LANGUAGE_DEFAULT ("eng")
79

80
/* Callbacks */
Rafaël Carré's avatar
Rafaël Carré committed
81 82
static int  blurayOpen (vlc_object_t *);
static void blurayClose(vlc_object_t *);
83 84

vlc_module_begin ()
Rafaël Carré's avatar
Rafaël Carré committed
85 86
    set_shortname(N_("Blu-ray"))
    set_description(N_("Blu-ray Disc support (libbluray)"))
87

Rafaël Carré's avatar
Rafaël Carré committed
88 89 90 91 92 93
    set_category(CAT_INPUT)
    set_subcategory(SUBCAT_INPUT_ACCESS)
    set_capability("access_demux", 200)
    add_bool("bluray-menu", false, BD_MENU_TEXT, BD_MENU_LONGTEXT, false)
    add_string("bluray-region", ppsz_region_code[REGION_DEFAULT], BD_REGION_TEXT, BD_REGION_LONGTEXT, false)
        change_string_list(ppsz_region_code, ppsz_region_code_text)
94

Rafaël Carré's avatar
Rafaël Carré committed
95
    add_shortcut("bluray", "file")
96

Rafaël Carré's avatar
Rafaël Carré committed
97
    set_callbacks(blurayOpen, blurayClose)
98 99
vlc_module_end ()

100 101
/* libbluray's overlay.h defines 2 types of overlay (bd_overlay_plane_e). */
#define MAX_OVERLAY 2
102

103 104 105 106 107 108 109 110
typedef enum OverlayStatus {
    Closed = 0,
    ToDisplay,  //Used to mark the overlay to be displayed the first time.
    Displayed,
    Outdated    //used to update the overlay after it has been sent to the vout
} OverlayStatus;

typedef struct bluray_overlay_t
111
{
112
    atomic_flag         released_once;
113 114 115 116 117 118 119 120 121
    vlc_mutex_t         lock;
    subpicture_t        *p_pic;
    OverlayStatus       status;
    subpicture_region_t *p_regions;
} bluray_overlay_t;

struct  demux_sys_t
{
    BLURAY              *bluray;
122 123

    /* Titles */
124 125
    unsigned int        i_title;
    unsigned int        i_longest_title;
126
    unsigned int        i_current_clip;
127
    input_title_t       **pp_title;
128

129 130 131
    /* Meta informations */
    const META_DL       *p_meta;

132
    /* Menus */
133 134 135 136 137 138 139
    bluray_overlay_t    *p_overlays[MAX_OVERLAY];
    int                 current_overlay; // -1 if no current overlay;
    bool                b_menu;

    /* */
    input_thread_t      *p_input;
    vout_thread_t       *p_vout;
140

141
    /* TS stream */
142
    es_out_t            *p_out;
143
    vlc_array_t         es;
144
    int                 i_audio_stream; /* Selected audio stream. -1 if default */
145
    int                 i_video_stream;
146
    stream_t            *p_parser;
147 148 149

    /* Used to store bluray disc path */
    char                *psz_bd_path;
150 151 152 153 154
};

struct subpicture_updater_sys_t
{
    bluray_overlay_t    *p_overlay;
155 156
};

157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
/* Get a 3 char code
 * FIXME: partiallyy duplicated from src/input/es_out.c
 */
static const char *DemuxGetLanguageCode( demux_t *p_demux, const char *psz_var )
{
    const iso639_lang_t *pl;
    char *psz_lang;
    char *p;

    psz_lang = var_CreateGetString( p_demux, psz_var );
    if( !psz_lang )
        return LANGUAGE_DEFAULT;

    /* XXX: we will use only the first value
     * (and ignore other ones in case of a list) */
    if( ( p = strchr( psz_lang, ',' ) ) )
        *p = '\0';

    for( pl = p_languages; pl->psz_eng_name != NULL; pl++ )
    {
        if( *psz_lang == '\0' )
            continue;
        if( !strcasecmp( pl->psz_eng_name, psz_lang ) ||
            !strcasecmp( pl->psz_iso639_1, psz_lang ) ||
            !strcasecmp( pl->psz_iso639_2T, psz_lang ) ||
            !strcasecmp( pl->psz_iso639_2B, psz_lang ) )
            break;
    }

    free( psz_lang );

    if( pl->psz_eng_name != NULL )
        return pl->psz_iso639_2T;

    return LANGUAGE_DEFAULT;
}

194 195 196
/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
Rafaël Carré's avatar
Rafaël Carré committed
197
static es_out_t *esOutNew(demux_t *p_demux);
198

Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
199 200
static int   blurayControl(demux_t *, int, va_list);
static int   blurayDemux(demux_t *);
201

Rafaël Carré's avatar
Rafaël Carré committed
202
static void  blurayInitTitles(demux_t *p_demux);
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
203
static int   bluraySetTitle(demux_t *p_demux, int i_title);
204

Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
205
static void  blurayOverlayProc(void *ptr, const BD_OVERLAY * const overlay);
206
static void  blurayArgbOverlayProc(void *ptr, const BD_ARGB_OVERLAY * const overlay);
207

Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
208 209
static int   onMouseEvent(vlc_object_t *p_vout, const char *psz_var,
                          vlc_value_t old, vlc_value_t val, void *p_data);
210

211 212
static void  blurayResetParser(demux_t *p_demux);

213 214 215
#define FROM_TICKS(a) (a*CLOCK_FREQ / INT64_C(90000))
#define TO_TICKS(a)   (a*INT64_C(90000)/CLOCK_FREQ)
#define CUR_LENGTH    p_sys->pp_title[p_demux->info.i_title]->i_length
216

217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
/* */
static void FindMountPoint(char **file)
{
    char *device = *file;
#if defined (HAVE_MNTENT_H) && defined (HAVE_SYS_STAT_H)
    struct stat st;
    if (!stat (device, &st) && S_ISBLK (st.st_mode)) {
        FILE *mtab = setmntent ("/proc/self/mounts", "r");
        struct mntent *m, mbuf;
        char buf [8192];
        /* bd path may be a symlink (e.g. /dev/dvd -> /dev/sr0), so make
         * sure we look up the real device */
        char *bd_device = realpath(device, NULL);
        if (!bd_device)
            bd_device = strdup(device);

        while ((m = getmntent_r (mtab, &mbuf, buf, sizeof(buf))) != NULL) {
            if (!strcmp (m->mnt_fsname, bd_device)) {
                free(device);
                *file = strdup(m->mnt_dir);
                break;
            }
        }
        free(bd_device);
        endmntent (mtab);
    }
#elif defined(__APPLE__)
    struct stat st;
    if (!stat (device, &st) && S_ISBLK (st.st_mode)) {
        int fs_count = getfsstat (NULL, 0, MNT_NOWAIT);
        if (fs_count > 0) {
            struct statfs mbuf[128];
            getfsstat (mbuf, fs_count * sizeof(mbuf[0]), MNT_NOWAIT);
            for (int i = 0; i < fs_count; ++i)
                if (!strcmp (mbuf[i].f_mntfromname, device)) {
                    free(device);
                    *file = strdup(mbuf[i].f_mntonname);
                    return;
                }
        }
    }
#else
# warning Disc device to mount point not implemented
#endif
}

263 264 265
/*****************************************************************************
 * blurayOpen: module init function
 *****************************************************************************/
Rafaël Carré's avatar
Rafaël Carré committed
266
static int blurayOpen(vlc_object_t *object)
267
{
268 269
    demux_t *p_demux = (demux_t*)object;
    demux_sys_t *p_sys;
270

271
    const char *error_msg = NULL;
272
#define BLURAY_ERROR(s) do { error_msg = s; goto error; } while(0)
273

274
    if (strcmp(p_demux->psz_access, "bluray")) {
275
        // TODO BDMV support, once we figure out what to do in libbluray
276 277 278
        return VLC_EGENERIC;
    }

279
    /* */
280
    p_demux->p_sys = p_sys = calloc(1, sizeof(*p_sys));
Rafaël Carré's avatar
Rafaël Carré committed
281
    if (unlikely(!p_sys))
282
        return VLC_ENOMEM;
Rafaël Carré's avatar
Rafaël Carré committed
283

284
    p_sys->current_overlay = -1;
285
    p_sys->i_audio_stream = -1;
286
    p_sys->i_video_stream = -1;
287 288 289 290 291

    /* init demux info fields */
    p_demux->info.i_update    = 0;
    p_demux->info.i_title     = 0;
    p_demux->info.i_seekpoint = 0;
292

Rafaël Carré's avatar
Rafaël Carré committed
293
    TAB_INIT(p_sys->i_title, p_sys->pp_title);
294

295
    /* store current bd path */
Rafaël Carré's avatar
Rafaël Carré committed
296 297
    if (p_demux->psz_file)
        p_sys->psz_bd_path = strdup(p_demux->psz_file);
298

299
    /* If we're passed a block device, try to convert it to the mount point. */
300 301
    FindMountPoint(&p_sys->psz_bd_path);

302
    p_sys->bluray = bd_open(p_sys->psz_bd_path, NULL);
303
    if (!p_sys->bluray) {
304
        free(p_sys->psz_bd_path);
305 306 307 308
        free(p_sys);
        return VLC_EGENERIC;
    }

309 310
    /* Warning the user about AACS/BD+ */
    const BLURAY_DISC_INFO *disc_info = bd_get_disc_info(p_sys->bluray);
311 312

    /* Is it a bluray? */
313 314
    if (!disc_info->bluray_detected)
        BLURAY_ERROR(_("Path doesn't appear to be a Blu-ray"));
315

316 317
    msg_Info(p_demux, "First play: %i, Top menu: %i\n"
                      "HDMV Titles: %i, BD-J Titles: %i, Other: %i",
318 319 320 321 322 323
             disc_info->first_play_supported, disc_info->top_menu_supported,
             disc_info->num_hdmv_titles, disc_info->num_bdj_titles,
             disc_info->num_unsupported_titles);

    /* AACS */
    if (disc_info->aacs_detected) {
324
        msg_Dbg(p_demux, "Disc is using AACS");
325 326 327
        if (!disc_info->libaacs_detected)
            BLURAY_ERROR(_("This Blu-ray Disc needs a library for AACS decoding"
                      ", and your system does not have it."));
328
        if (!disc_info->aacs_handled) {
329 330 331
#ifdef BD_AACS_CORRUPTED_DISC
            if (disc_info->aacs_error_code) {
                switch (disc_info->aacs_error_code) {
332 333 334 335 336 337 338 339 340 341 342 343
                case BD_AACS_CORRUPTED_DISC:
                    BLURAY_ERROR(_("Blu-ray Disc is corrupted."));
                case BD_AACS_NO_CONFIG:
                    BLURAY_ERROR(_("Missing AACS configuration file!"));
                case BD_AACS_NO_PK:
                    BLURAY_ERROR(_("No valid processing key found in AACS config file."));
                case BD_AACS_NO_CERT:
                    BLURAY_ERROR(_("No valid host certificate found in AACS config file."));
                case BD_AACS_CERT_REVOKED:
                    BLURAY_ERROR(_("AACS Host certificate revoked."));
                case BD_AACS_MMC_FAILED:
                    BLURAY_ERROR(_("AACS MMC failed."));
344 345 346
                }
            }
#else
347 348 349
            /* libbluray < 0.2.3 */
            BLURAY_ERROR(_("Your system AACS decoding library does not work. "
                      "Missing keys?"));
350
#endif /* BD_AACS_CORRUPTED_DISC */
351 352 353 354 355
        }
    }

    /* BD+ */
    if (disc_info->bdplus_detected) {
356
        msg_Dbg(p_demux, "Disc is using BD+");
357 358 359 360 361 362
        if (!disc_info->libbdplus_detected)
            BLURAY_ERROR(_("This Blu-ray Disc needs a library for BD+ decoding"
                      ", and your system does not have it."));
        if (!disc_info->bdplus_handled)
            BLURAY_ERROR(_("Your system BD+ decoding library does not work. "
                      "Missing configuration?"));
363 364
    }

365 366 367 368 369 370
    /* set player region code */
    char *psz_region = var_InheritString(p_demux, "bluray-region");
    unsigned int region = psz_region ? (psz_region[0] - 'A') : REGION_DEFAULT;
    free(psz_region);
    bd_set_player_setting(p_sys->bluray, BLURAY_PLAYER_SETTING_REGION_CODE, 1<<region);

371 372 373 374 375 376 377 378
    /* set preferred languages */
    const char *psz_code = DemuxGetLanguageCode( p_demux, "audio-language" );
    bd_set_player_setting_str(p_sys->bluray, BLURAY_PLAYER_SETTING_AUDIO_LANG, psz_code);
    psz_code = DemuxGetLanguageCode( p_demux, "sub-language" );
    bd_set_player_setting_str(p_sys->bluray, BLURAY_PLAYER_SETTING_PG_LANG,    psz_code);
    psz_code = DemuxGetLanguageCode( p_demux, "menu-language" );
    bd_set_player_setting_str(p_sys->bluray, BLURAY_PLAYER_SETTING_MENU_LANG,  psz_code);

379
    /* Get titles and chapters */
380 381
    p_sys->p_meta = bd_get_meta(p_sys->bluray);
    if (!p_sys->p_meta)
Rafaël Carré's avatar
Rafaël Carré committed
382
        msg_Warn(p_demux, "Failed to get meta info.");
383

384
    blurayInitTitles(p_demux);
385

386 387 388 389 390
    /*
     * Initialize the event queue, so we can receive events in blurayDemux(Menu).
     */
    bd_get_event(p_sys->bluray, NULL);

Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
391 392
    p_sys->b_menu = var_InheritBool(p_demux, "bluray-menu");
    if (p_sys->b_menu) {
393
        p_sys->p_input = demux_GetParentInput(p_demux);
Rafaël Carré's avatar
Rafaël Carré committed
394
        if (unlikely(!p_sys->p_input)) {
395
            msg_Err(p_demux, "Could not get parent input");
396
            goto error;
Rafaël Carré's avatar
Rafaël Carré committed
397
        }
398

399
        /* Register ARGB overlay handler for BD-J */
400
        if (disc_info->num_bdj_titles)
401 402
            bd_register_argb_overlay_proc(p_sys->bluray, p_demux, blurayArgbOverlayProc, NULL);

403
        /* libbluray will start playback from "First-Title" title */
404 405 406
        if (bd_play(p_sys->bluray) == 0)
            BLURAY_ERROR(_("Failed to start bluray playback. Please try without menu support."));

407 408
        /* Registering overlay event handler */
        bd_register_overlay_proc(p_sys->bluray, p_demux, blurayOverlayProc);
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
409
    } else {
410
        /* set start title number */
411
        if (bluraySetTitle(p_demux, p_sys->i_longest_title) != VLC_SUCCESS) {
Rafaël Carré's avatar
Rafaël Carré committed
412
            msg_Err(p_demux, "Could not set the title %d", p_sys->i_longest_title);
413 414
            goto error;
        }
415 416
    }

417
    vlc_array_init(&p_sys->es);
Rafaël Carré's avatar
Rafaël Carré committed
418
    p_sys->p_out = esOutNew(p_demux);
Rafaël Carré's avatar
Rafaël Carré committed
419
    if (unlikely(p_sys->p_out == NULL))
420 421
        goto error;

Rafaël Carré's avatar
Rafaël Carré committed
422
    blurayResetParser(p_demux);
423 424
    if (!p_sys->p_parser) {
        msg_Err(p_demux, "Failed to create TS demuxer");
425
        goto error;
426 427 428 429
    }

    p_demux->pf_control = blurayControl;
    p_demux->pf_demux   = blurayDemux;
430 431

    return VLC_SUCCESS;
432 433 434

error:
    if (error_msg)
Christoph Miebach's avatar
Christoph Miebach committed
435
        dialog_Fatal(p_demux, _("Blu-ray error"), "%s", error_msg);
436 437
    blurayClose(object);
    return VLC_EGENERIC;
438
#undef BLURAY_ERROR
439 440 441 442 443 444
}


/*****************************************************************************
 * blurayClose: module destroy function
 *****************************************************************************/
Rafaël Carré's avatar
Rafaël Carré committed
445
static void blurayClose(vlc_object_t *object)
446
{
447 448 449
    demux_t *p_demux = (demux_t*)object;
    demux_sys_t *p_sys = p_demux->p_sys;

450 451 452
    /*
     * Close libbluray first.
     * This will close all the overlays before we release p_vout
Rafaël Carré's avatar
Rafaël Carré committed
453
     * bd_close(NULL) can crash
454 455 456 457
     */
    assert(p_sys->bluray);
    bd_close(p_sys->bluray);

458
    if (p_sys->p_vout != NULL) {
Rafaël Carré's avatar
Rafaël Carré committed
459 460
        var_DelCallback(p_sys->p_vout, "mouse-moved", onMouseEvent, p_demux);
        var_DelCallback(p_sys->p_vout, "mouse-clicked", onMouseEvent, p_demux);
461
        vlc_object_release(p_sys->p_vout);
462
    }
463 464
    if (p_sys->p_input != NULL)
        vlc_object_release(p_sys->p_input);
465 466
    if (p_sys->p_parser)
        stream_Delete(p_sys->p_parser);
467 468
    if (p_sys->p_out != NULL)
        es_out_Delete(p_sys->p_out);
Rafaël Carré's avatar
Rafaël Carré committed
469 470
    assert(vlc_array_count(&p_sys->es) == 0);
    vlc_array_clear(&p_sys->es);
471

472 473 474
    /* Titles */
    for (unsigned int i = 0; i < p_sys->i_title; i++)
        vlc_input_title_Delete(p_sys->pp_title[i]);
Rafaël Carré's avatar
Rafaël Carré committed
475
    TAB_CLEAN(p_sys->i_title, p_sys->pp_title);
476

477
    free(p_sys->psz_bd_path);
478 479 480
    free(p_sys);
}

481 482 483 484 485 486 487 488
/*****************************************************************************
 * Elementary streams handling
 *****************************************************************************/

struct es_out_sys_t {
    demux_t *p_demux;
};

489 490 491 492 493
typedef struct  fmt_es_pair {
    int         i_id;
    es_out_id_t *p_es;
}               fmt_es_pair_t;

Rafaël Carré's avatar
Rafaël Carré committed
494
static int  findEsPairIndex(demux_sys_t *p_sys, int i_id)
495
{
Rafaël Carré's avatar
Rafaël Carré committed
496 497
    for (int i = 0; i < vlc_array_count(&p_sys->es); ++i)
        if (((fmt_es_pair_t*)vlc_array_item_at_index(&p_sys->es, i))->i_id == i_id)
498
            return i;
Rafaël Carré's avatar
Rafaël Carré committed
499

500 501 502
    return -1;
}

Rafaël Carré's avatar
Rafaël Carré committed
503
static int  findEsPairIndexByEs(demux_sys_t *p_sys, es_out_id_t *p_es)
504
{
Rafaël Carré's avatar
Rafaël Carré committed
505 506
    for (int i = 0; i < vlc_array_count(&p_sys->es); ++i)
        if (((fmt_es_pair_t*)vlc_array_item_at_index(&p_sys->es, i))->p_es == p_es)
507
            return i;
Rafaël Carré's avatar
Rafaël Carré committed
508

509 510 511
    return -1;
}

Rafaël Carré's avatar
Rafaël Carré committed
512
static es_out_id_t *esOutAdd(es_out_t *p_out, const es_format_t *p_fmt)
513
{
514 515 516 517
    demux_sys_t *p_sys = p_out->p_sys->p_demux->p_sys;
    es_format_t fmt;

    es_format_Copy(&fmt, p_fmt);
Rafaël Carré's avatar
Rafaël Carré committed
518
    switch (fmt.i_cat) {
519
    case VIDEO_ES:
Rafaël Carré's avatar
Rafaël Carré committed
520
        if (p_sys->i_video_stream != -1 && p_sys->i_video_stream != p_fmt->i_id)
521
            fmt.i_priority = -2;
522 523
        break ;
    case AUDIO_ES:
Rafaël Carré's avatar
Rafaël Carré committed
524
        if (p_sys->i_audio_stream != -1 && p_sys->i_audio_stream != p_fmt->i_id)
525 526 527 528 529 530
            fmt.i_priority = -2;
        break ;
    case SPU_ES:
        break ;
    }

Rafaël Carré's avatar
Rafaël Carré committed
531 532
    es_out_id_t *p_es = es_out_Add(p_out->p_sys->p_demux->out, &fmt);
    if (p_fmt->i_id >= 0) {
533
        /* Ensure we are not overriding anything */
534
        int idx = findEsPairIndex(p_sys, p_fmt->i_id);
Rafaël Carré's avatar
Rafaël Carré committed
535 536 537
        if (idx == -1) {
            fmt_es_pair_t *p_pair = malloc(sizeof(*p_pair));
            if (likely(p_pair != NULL)) {
538 539
                p_pair->i_id = p_fmt->i_id;
                p_pair->p_es = p_es;
Rafaël Carré's avatar
Rafaël Carré committed
540
                msg_Info(p_out->p_sys->p_demux, "Adding ES %d", p_fmt->i_id);
541
                vlc_array_append(&p_sys->es, p_pair);
542 543 544
            }
        }
    }
545
    es_format_Clean(&fmt);
546
    return p_es;
547 548
}

Rafaël Carré's avatar
Rafaël Carré committed
549
static int esOutSend(es_out_t *p_out, es_out_id_t *p_es, block_t *p_block)
550
{
Rafaël Carré's avatar
Rafaël Carré committed
551
    return es_out_Send(p_out->p_sys->p_demux->out, p_es, p_block);
552 553
}

Rafaël Carré's avatar
Rafaël Carré committed
554
static void esOutDel(es_out_t *p_out, es_out_id_t *p_es)
555
{
Rafaël Carré's avatar
Rafaël Carré committed
556 557 558
    int idx = findEsPairIndexByEs(p_out->p_sys->p_demux->p_sys, p_es);
    if (idx >= 0) {
        free(vlc_array_item_at_index(&p_out->p_sys->p_demux->p_sys->es, idx));
559 560
        vlc_array_remove(&p_out->p_sys->p_demux->p_sys->es, idx);
    }
Rafaël Carré's avatar
Rafaël Carré committed
561
    es_out_Del(p_out->p_sys->p_demux->out, p_es);
562 563
}

Rafaël Carré's avatar
Rafaël Carré committed
564
static int esOutControl(es_out_t *p_out, int i_query, va_list args)
565
{
Rafaël Carré's avatar
Rafaël Carré committed
566
    return es_out_vaControl(p_out->p_sys->p_demux->out, i_query, args);
567 568
}

Rafaël Carré's avatar
Rafaël Carré committed
569
static void esOutDestroy(es_out_t *p_out)
570
{
Rafaël Carré's avatar
Rafaël Carré committed
571 572
    for (int i = 0; i < vlc_array_count(&p_out->p_sys->p_demux->p_sys->es); ++i)
        free(vlc_array_item_at_index(&p_out->p_sys->p_demux->p_sys->es, i));
573
    vlc_array_clear(&p_out->p_sys->p_demux->p_sys->es);
Rafaël Carré's avatar
Rafaël Carré committed
574 575
    free(p_out->p_sys);
    free(p_out);
576 577
}

Rafaël Carré's avatar
Rafaël Carré committed
578
static es_out_t *esOutNew(demux_t *p_demux)
579
{
Rafaël Carré's avatar
Rafaël Carré committed
580 581 582
    assert(vlc_array_count(&p_demux->p_sys->es) == 0);
    es_out_t    *p_out = malloc(sizeof(*p_out));
    if (unlikely(p_out == NULL))
583 584
        return NULL;

Rafaël Carré's avatar
Rafaël Carré committed
585 586 587 588 589
    p_out->pf_add       = esOutAdd;
    p_out->pf_control   = esOutControl;
    p_out->pf_del       = esOutDel;
    p_out->pf_destroy   = esOutDestroy;
    p_out->pf_send      = esOutSend;
590

Rafaël Carré's avatar
Rafaël Carré committed
591 592 593
    p_out->p_sys = malloc(sizeof(*p_out->p_sys));
    if (unlikely(p_out->p_sys == NULL)) {
        free(p_out);
594 595 596 597 598 599
        return NULL;
    }
    p_out->p_sys->p_demux = p_demux;
    return p_out;
}

600 601 602
/*****************************************************************************
 * subpicture_updater_t functions:
 *****************************************************************************/
Rafaël Carré's avatar
Rafaël Carré committed
603
static int subpictureUpdaterValidate(subpicture_t *p_subpic,
604 605
                                      bool b_fmt_src, const video_format_t *p_fmt_src,
                                      bool b_fmt_dst, const video_format_t *p_fmt_dst,
Rafaël Carré's avatar
Rafaël Carré committed
606
                                      mtime_t i_ts)
607
{
Rafaël Carré's avatar
Rafaël Carré committed
608 609 610 611 612
    VLC_UNUSED(b_fmt_src);
    VLC_UNUSED(b_fmt_dst);
    VLC_UNUSED(p_fmt_src);
    VLC_UNUSED(p_fmt_dst);
    VLC_UNUSED(i_ts);
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670

    subpicture_updater_sys_t *p_upd_sys = p_subpic->updater.p_sys;
    bluray_overlay_t         *p_overlay = p_upd_sys->p_overlay;

    vlc_mutex_lock(&p_overlay->lock);
    int res = p_overlay->status == Outdated;
    vlc_mutex_unlock(&p_overlay->lock);
    return res;
}

/* This should probably be moved to subpictures.c afterward */
static subpicture_region_t* subpicture_region_Clone(subpicture_region_t *p_region_src)
{
    if (!p_region_src)
        return NULL;
    subpicture_region_t *p_region_dst = subpicture_region_New(&p_region_src->fmt);
    if (unlikely(!p_region_dst))
        return NULL;

    p_region_dst->i_x      = p_region_src->i_x;
    p_region_dst->i_y      = p_region_src->i_y;
    p_region_dst->i_align  = p_region_src->i_align;
    p_region_dst->i_alpha  = p_region_src->i_alpha;

    p_region_dst->psz_text = p_region_src->psz_text ? strdup(p_region_src->psz_text) : NULL;
    p_region_dst->psz_html = p_region_src->psz_html ? strdup(p_region_src->psz_html) : NULL;
    if (p_region_src->p_style != NULL) {
        p_region_dst->p_style = malloc(sizeof(*p_region_dst->p_style));
        p_region_dst->p_style = text_style_Copy(p_region_dst->p_style,
                                                p_region_src->p_style);
    }

    //Palette is already copied by subpicture_region_New, we just have to duplicate p_pixels
    for (int i = 0; i < p_region_src->p_picture->i_planes; i++)
        memcpy(p_region_dst->p_picture->p[i].p_pixels,
               p_region_src->p_picture->p[i].p_pixels,
               p_region_src->p_picture->p[i].i_lines * p_region_src->p_picture->p[i].i_pitch);
    return p_region_dst;
}

static void subpictureUpdaterUpdate(subpicture_t *p_subpic,
                                    const video_format_t *p_fmt_src,
                                    const video_format_t *p_fmt_dst,
                                    mtime_t i_ts)
{
    VLC_UNUSED(p_fmt_src);
    VLC_UNUSED(p_fmt_dst);
    VLC_UNUSED(i_ts);
    subpicture_updater_sys_t *p_upd_sys = p_subpic->updater.p_sys;
    bluray_overlay_t         *p_overlay = p_upd_sys->p_overlay;

    /*
     * When this function is called, all p_subpic regions are gone.
     * We need to duplicate our regions (stored internaly) to this subpic.
     */
    vlc_mutex_lock(&p_overlay->lock);

    subpicture_region_t *p_src = p_overlay->p_regions;
Rafaël Carré's avatar
Rafaël Carré committed
671
    if (!p_src) {
672
        vlc_mutex_unlock(&p_overlay->lock);
673
        return;
674
    }
675

Rafaël Carré's avatar
Rafaël Carré committed
676
    subpicture_region_t **p_dst = &p_subpic->p_region;
677 678 679
    while (p_src != NULL) {
        *p_dst = subpicture_region_Clone(p_src);
        if (*p_dst == NULL)
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
680
            break;
Rafaël Carré's avatar
Rafaël Carré committed
681
        p_dst = &(*p_dst)->p_next;
682 683 684 685 686 687 688 689
        p_src = p_src->p_next;
    }
    if (*p_dst != NULL)
        (*p_dst)->p_next = NULL;
    p_overlay->status = Displayed;
    vlc_mutex_unlock(&p_overlay->lock);
}

690 691
static void blurayCleanOverlayStruct(bluray_overlay_t *);

692 693
static void subpictureUpdaterDestroy(subpicture_t *p_subpic)
{
694
    blurayCleanOverlayStruct(p_subpic->updater.p_sys->p_overlay);
Rafaël Carré's avatar
Rafaël Carré committed
695
    free(p_subpic->updater.p_sys);
696 697
}

698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720
/*****************************************************************************
 * User input events:
 *****************************************************************************/
static int onMouseEvent(vlc_object_t *p_vout, const char *psz_var, vlc_value_t old,
                        vlc_value_t val, void *p_data)
{
    demux_t     *p_demux = (demux_t*)p_data;
    demux_sys_t *p_sys   = p_demux->p_sys;
    mtime_t     now      = mdate();
    VLC_UNUSED(old);
    VLC_UNUSED(p_vout);

    if (psz_var[6] == 'm')   //Mouse moved
        bd_mouse_select(p_sys->bluray, now, val.coords.x, val.coords.y);
    else if (psz_var[6] == 'c') {
        bd_mouse_select(p_sys->bluray, now, val.coords.x, val.coords.y);
        bd_user_input(p_sys->bluray, now, BD_VK_MOUSE_ACTIVATE);
    } else {
        assert(0);
    }
    return VLC_SUCCESS;
}

721 722 723
static int sendKeyEvent(demux_sys_t *p_sys, unsigned int key)
{
    mtime_t now = mdate();
Rafaël Carré's avatar
Rafaël Carré committed
724
    if (bd_user_input(p_sys->bluray, now, key) < 0)
725
        return VLC_EGENERIC;
Rafaël Carré's avatar
Rafaël Carré committed
726

727 728 729
    return VLC_SUCCESS;
}

730 731 732
/*****************************************************************************
 * libbluray overlay handling:
 *****************************************************************************/
733
static void blurayCleanOverlayStruct(bluray_overlay_t *p_overlay)
734
{
735 736
    if (!atomic_flag_test_and_set(&p_overlay->released_once))
        return;
737 738 739 740 741
    /*
     * This will be called when destroying the picture.
     * Don't delete it again from here!
     */
    vlc_mutex_destroy(&p_overlay->lock);
Rafaël Carré's avatar
Rafaël Carré committed
742
    subpicture_region_ChainDelete(p_overlay->p_regions);
743 744 745
    free(p_overlay);
}

746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
static void blurayCloseOverlay(demux_t *p_demux, int plane)
{
    demux_sys_t *p_sys = p_demux->p_sys;
    bluray_overlay_t *ov = p_sys->p_overlays[plane];

    if (ov != NULL) {
        vout_FlushSubpictureChannel(p_sys->p_vout, ov->p_pic->i_channel);
        blurayCleanOverlayStruct(ov);
        if (p_sys->current_overlay == plane)
            p_sys->current_overlay = -1;
    }

    p_sys->p_overlays[plane] = NULL;
}

761 762 763 764 765
static void blurayCloseAllOverlays(demux_t *p_demux)
{
    demux_sys_t *p_sys = p_demux->p_sys;

    p_demux->p_sys->current_overlay = -1;
766 767 768
    if (!p_sys->p_vout)
        return;

769 770 771
    for (int i = 0; i < MAX_OVERLAY; i++)
        blurayCloseOverlay(p_demux, i);

772 773 774 775
    var_DelCallback(p_sys->p_vout, "mouse-moved", onMouseEvent, p_demux);
    var_DelCallback(p_sys->p_vout, "mouse-clicked", onMouseEvent, p_demux);
    vlc_object_release(p_sys->p_vout);
    p_sys->p_vout = NULL;
776 777 778 779 780 781 782 783 784
}

/*
 * Mark the overlay as "ToDisplay" status.
 * This will not send the overlay to the vout instantly, as the vout
 * may not be acquired (not acquirable) yet.
 * If is has already been acquired, the overlay has already been sent to it,
 * therefore, we only flag the overlay as "Outdated"
 */
785
static void blurayActivateOverlay(demux_t *p_demux, int plane)
786 787
{
    demux_sys_t *p_sys = p_demux->p_sys;
788
    bluray_overlay_t *ov = p_sys->p_overlays[plane];
789 790 791 792 793

    /*
     * If the overlay is already displayed, mark the picture as outdated.
     * We must NOT use vout_PutSubpicture if a picture is already displayed.
     */
794 795 796 797
    vlc_mutex_lock(&ov->lock);
    if (ov->status >= Displayed && p_sys->p_vout) {
        ov->status = Outdated;
        vlc_mutex_unlock(&ov->lock);
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
798
        return;
799
    }
800

801 802 803 804 805
    /*
     * Mark the overlay as available, but don't display it right now.
     * the blurayDemuxMenu will send it to vout, as it may be unavailable when
     * the overlay is computed
     */
806
    p_sys->current_overlay = plane;
807 808
    ov->status = ToDisplay;
    vlc_mutex_unlock(&ov->lock);
809 810
}

811
static void blurayInitOverlay(demux_t *p_demux, int plane, int width, int height)
812 813 814
{
    demux_sys_t *p_sys = p_demux->p_sys;

815
    assert(p_sys->p_overlays[plane] == NULL);
816

817 818
    p_sys->p_overlays[plane] = calloc(1, sizeof(**p_sys->p_overlays));
    if (unlikely(!p_sys->p_overlays[plane]))
819 820
        return;

821 822
    bluray_overlay_t *ov = p_sys->p_overlays[plane];

823 824
    subpicture_updater_sys_t *p_upd_sys = malloc(sizeof(*p_upd_sys));
    if (unlikely(!p_upd_sys)) {
825
        free(ov);
826
        p_sys->p_overlays[plane] = NULL;
827 828
        return;
    }
829
    /* two references: vout + demux */
830
    ov->released_once = ATOMIC_FLAG_INIT;
831

832
    p_upd_sys->p_overlay = ov;
833 834 835 836 837 838
    subpicture_updater_t updater = {
        .pf_validate = subpictureUpdaterValidate,
        .pf_update   = subpictureUpdaterUpdate,
        .pf_destroy  = subpictureUpdaterDestroy,
        .p_sys       = p_upd_sys,
    };
839 840 841 842 843 844
    vlc_mutex_init(&ov->lock);
    ov->p_pic = subpicture_New(&updater);
    ov->p_pic->i_original_picture_width = width;
    ov->p_pic->i_original_picture_height = height;
    ov->p_pic->b_ephemer = true;
    ov->p_pic->b_absolute = true;
845 846 847 848 849 850 851 852 853 854
}

/**
 * Destroy every regions in the subpicture.
 * This is done in two steps:
 * - Wiping our private regions list
 * - Flagging the overlay as outdated, so the changes are replicated from
 *   the subpicture_updater_t::pf_update
 * This doesn't destroy the subpicture, as the overlay may be used again by libbluray.
 */
855
static void blurayClearOverlay(demux_t *p_demux, int plane)
856 857
{
    demux_sys_t *p_sys = p_demux->p_sys;
858 859 860
    bluray_overlay_t *ov = p_sys->p_overlays[plane];

    vlc_mutex_lock(&ov->lock);
861

862 863 864
    subpicture_region_ChainDelete(ov->p_regions);
    ov->p_regions = NULL;
    ov->status = Outdated;
865

866
    vlc_mutex_unlock(&ov->lock);
867 868 869 870 871 872 873 874 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 905 906 907 908 909 910 911 912 913 914
}

/*
 * This will draw to the overlay by adding a region to our region list
 * This will have to be copied to the subpicture used to render the overlay.
 */
static void blurayDrawOverlay(demux_t *p_demux, const BD_OVERLAY* const ov)
{
    demux_sys_t *p_sys = p_demux->p_sys;

    /*
     * Compute a subpicture_region_t.
     * It will be copied and sent to the vout later.
     */
    if (!ov->img)
        return;

    vlc_mutex_lock(&p_sys->p_overlays[ov->plane]->lock);

    /* Find a region to update */
    subpicture_region_t *p_reg = p_sys->p_overlays[ov->plane]->p_regions;
    subpicture_region_t *p_last = NULL;
    while (p_reg != NULL) {
        p_last = p_reg;
        if (p_reg->i_x == ov->x && p_reg->i_y == ov->y &&
                p_reg->fmt.i_width == ov->w && p_reg->fmt.i_height == ov->h)
            break;
        p_reg = p_reg->p_next;
    }

    /* If there is no region to update, create a new one. */
    if (!p_reg) {
        video_format_t fmt;
        video_format_Init(&fmt, 0);
        video_format_Setup(&fmt, VLC_CODEC_YUVP, ov->w, ov->h, 1, 1);

        p_reg = subpicture_region_New(&fmt);
        p_reg->i_x = ov->x;
        p_reg->i_y = ov->y;
        /* Append it to our list. */
        if (p_last != NULL)
            p_last->p_next = p_reg;
        else /* If we don't have a last region, then our list empty */
            p_sys->p_overlays[ov->plane]->p_regions = p_reg;
    }

    /* Now we can update the region, regardless it's an update or an insert */
    const BD_PG_RLE_ELEM *img = ov->img;
Rafaël Carré's avatar
Rafaël Carré committed
915
    for (int y = 0; y < ov->h; y++)
916
        for (int x = 0; x < ov->w;) {
917 918
            plane_t *p = &p_reg->p_picture->p[0];
            memset(&p->p_pixels[y * p->i_pitch + x], img->color, img->len);
919 920 921
            x += img->len;
            img++;
        }
Rafaël Carré's avatar
Rafaël Carré committed
922

923 924 925 926 927 928 929 930 931
    if (ov->palette) {
        p_reg->fmt.p_palette->i_entries = 256;
        for (int i = 0; i < 256; ++i) {
            p_reg->fmt.p_palette->palette[i][0] = ov->palette[i].Y;
            p_reg->fmt.p_palette->palette[i][1] = ov->palette[i].Cb;
            p_reg->fmt.p_palette->palette[i][2] = ov->palette[i].Cr;
            p_reg->fmt.p_palette->palette[i][3] = ov->palette[i].T;
        }
    }
Rafaël Carré's avatar
Rafaël Carré committed
932

933 934 935 936 937 938 939 940 941 942 943 944 945 946 947
    vlc_mutex_unlock(&p_sys->p_overlays[ov->plane]->lock);
    /*
     * /!\ The region is now stored in our internal list, but not in the subpicture /!\
     */
}

static void blurayOverlayProc(void *ptr, const BD_OVERLAY *const overlay)
{
    demux_t *p_demux = (demux_t*)ptr;

    if (!overlay) {
        msg_Info(p_demux, "Closing overlay.");
        blurayCloseAllOverlays(p_demux);
        return;
    }
Rafaël Carré's avatar
Rafaël Carré committed
948

949
    switch (overlay->cmd) {
Rafaël Carré's avatar
Rafaël Carré committed
950 951 952 953
    case BD_OVERLAY_INIT:
        msg_Info(p_demux, "Initializing overlay");
        blurayInitOverlay(p_demux, overlay->plane, overlay->w, overlay->h);
        break;
954 955 956 957
    case BD_OVERLAY_CLOSE:
        blurayClearOverlay(p_demux, overlay->plane);
        blurayCloseOverlay(p_demux, overlay->plane);
        break;
Rafaël Carré's avatar
Rafaël Carré committed
958 959 960 961 962 963 964 965 966 967 968 969
    case BD_OVERLAY_CLEAR:
        blurayClearOverlay(p_demux, overlay->plane);
        break;
    case BD_OVERLAY_FLUSH:
        blurayActivateOverlay(p_demux, overlay->plane);
        break;
    case BD_OVERLAY_DRAW:
        blurayDrawOverlay(p_demux, overlay);
        break;
    default:
        msg_Warn(p_demux, "Unknown BD overlay command: %u", overlay->cmd);
        break;
970 971 972
    }
}

973 974 975 976 977 978 979 980 981
/*
 * ARGB overlay (BD-J)
 */
static void blurayInitArgbOverlay(demux_t *p_demux, int plane, int width, int height)
{
    demux_sys_t *p_sys = p_demux->p_sys;

    blurayInitOverlay(p_demux, plane, width, height);

982
    if (!p_sys->p_overlays[plane]->p_regions) {