bluray.c 55.1 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>
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
29

30
#if defined (HAVE_MNTENT_H) && defined(HAVE_SYS_STAT_H)
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
31 32
# include <mntent.h>
# include <sys/stat.h>
33
#endif
34

35
#ifdef __APPLE__
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
36 37 38 39
# include <sys/stat.h>
# include <sys/param.h>
# include <sys/ucred.h>
# include <sys/mount.h>
40 41
#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/bluray-version.h>
58
#include <libbluray/keys.h>
59
#include <libbluray/meta_data.h>
60
#include <libbluray/overlay.h>
61 62 63 64 65

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

Rafaël Carré's avatar
Rafaël Carré committed
66 67 68 69 70
#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. "\
71 72 73 74 75 76 77 78
                                "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) */
79
#define LANGUAGE_DEFAULT ("eng")
80

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

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

Rafaël Carré's avatar
Rafaël Carré committed
89 90 91 92 93 94
    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)
95

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

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

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

104 105 106 107 108 109 110 111
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
112
{
113
    atomic_flag         released_once;
114 115 116 117 118 119 120 121 122
    vlc_mutex_t         lock;
    subpicture_t        *p_pic;
    OverlayStatus       status;
    subpicture_region_t *p_regions;
} bluray_overlay_t;

struct  demux_sys_t
{
    BLURAY              *bluray;
123 124

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

129 130 131 132
    vlc_mutex_t             pl_info_lock;
    BLURAY_TITLE_INFO      *p_pl_info;
    const BLURAY_CLIP_INFO *p_clip_info;

133
    /* Meta information */
134 135
    const META_DL       *p_meta;

136
    /* Menus */
137 138 139
    bluray_overlay_t    *p_overlays[MAX_OVERLAY];
    int                 current_overlay; // -1 if no current overlay;
    bool                b_menu;
Petri Hintukainen's avatar
Petri Hintukainen committed
140 141
    bool                b_menu_open;
    bool                b_popup_available;
142
    mtime_t             i_still_end_time;
143 144 145 146

    /* */
    input_thread_t      *p_input;
    vout_thread_t       *p_vout;
147

148
    /* TS stream */
149
    es_out_t            *p_out;
150
    vlc_array_t         es;
151
    int                 i_audio_stream; /* Selected audio stream. -1 if default */
152
    int                 i_spu_stream;   /* Selected subtitle stream. -1 if default */
153
    int                 i_video_stream;
154
    stream_t            *p_parser;
155
    bool                b_flushed;
156 157 158

    /* Used to store bluray disc path */
    char                *psz_bd_path;
159 160 161 162 163
};

struct subpicture_updater_sys_t
{
    bluray_overlay_t    *p_overlay;
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 194 195 196 197 198 199 200 201 202
/* 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;
}

203 204 205
/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
Rafaël Carré's avatar
Rafaël Carré committed
206
static es_out_t *esOutNew(demux_t *p_demux);
207

Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
208 209
static int   blurayControl(demux_t *, int, va_list);
static int   blurayDemux(demux_t *);
210

211
static void  blurayInitTitles(demux_t *p_demux, int menu_titles);
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
212
static int   bluraySetTitle(demux_t *p_demux, int i_title);
213

Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
214
static void  blurayOverlayProc(void *ptr, const BD_OVERLAY * const overlay);
215
static void  blurayArgbOverlayProc(void *ptr, const BD_ARGB_OVERLAY * const overlay);
216

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

220 221
static void  blurayResetParser(demux_t *p_demux);

222 223 224
#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
225

226 227 228 229 230
/* */
static void FindMountPoint(char **file)
{
    char *device = *file;
#if defined (HAVE_MNTENT_H) && defined (HAVE_SYS_STAT_H)
231 232 233 234 235 236
    /* 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 == NULL)
        return;

237
    struct stat st;
238
    if (lstat (bd_device, &st) == 0 && S_ISBLK (st.st_mode)) {
239 240 241 242 243 244 245 246 247 248 249 250 251
        FILE *mtab = setmntent ("/proc/self/mounts", "r");
        struct mntent *m, mbuf;
        char buf [8192];

        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;
            }
        }
        endmntent (mtab);
    }
252 253
    free(bd_device);

254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
#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
}

274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
/*****************************************************************************
 * cache current playlist (title) information
 *****************************************************************************/

static void setTitleInfo(demux_sys_t *p_sys, BLURAY_TITLE_INFO *info)
{
    vlc_mutex_lock(&p_sys->pl_info_lock);

    if (p_sys->p_pl_info) {
        bd_free_title_info(p_sys->p_pl_info);
    }
    p_sys->p_pl_info   = info;
    p_sys->p_clip_info = NULL;

    if (p_sys->p_pl_info && p_sys->p_pl_info->clip_count) {
        p_sys->p_clip_info = &p_sys->p_pl_info->clips[0];
    }

    vlc_mutex_unlock(&p_sys->pl_info_lock);
}

295 296 297
/*****************************************************************************
 * blurayOpen: module init function
 *****************************************************************************/
Rafaël Carré's avatar
Rafaël Carré committed
298
static int blurayOpen(vlc_object_t *object)
299
{
300 301
    demux_t *p_demux = (demux_t*)object;
    demux_sys_t *p_sys;
302

303
    const char *error_msg = NULL;
304
#define BLURAY_ERROR(s) do { error_msg = s; goto error; } while(0)
305

306
    if (strcmp(p_demux->psz_access, "bluray")) {
307
        // TODO BDMV support, once we figure out what to do in libbluray
308 309 310
        return VLC_EGENERIC;
    }

311
    /* */
312
    p_demux->p_sys = p_sys = calloc(1, sizeof(*p_sys));
Rafaël Carré's avatar
Rafaël Carré committed
313
    if (unlikely(!p_sys))
314
        return VLC_ENOMEM;
Rafaël Carré's avatar
Rafaël Carré committed
315

316
    p_sys->current_overlay = -1;
317
    p_sys->i_audio_stream = -1;
318
    p_sys->i_spu_stream = -1;
319
    p_sys->i_video_stream = -1;
320
    p_sys->i_still_end_time = 0;
321 322 323 324 325

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

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

329
    /* store current bd path */
Rafaël Carré's avatar
Rafaël Carré committed
330 331
    if (p_demux->psz_file)
        p_sys->psz_bd_path = strdup(p_demux->psz_file);
332

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

336
    p_sys->bluray = bd_open(p_sys->psz_bd_path, NULL);
337
    if (!p_sys->bluray) {
338
        free(p_sys->psz_bd_path);
339 340 341 342
        free(p_sys);
        return VLC_EGENERIC;
    }

343 344
    vlc_mutex_init(&p_sys->pl_info_lock);

345 346
    /* Warning the user about AACS/BD+ */
    const BLURAY_DISC_INFO *disc_info = bd_get_disc_info(p_sys->bluray);
347 348

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

352 353
    msg_Info(p_demux, "First play: %i, Top menu: %i\n"
                      "HDMV Titles: %i, BD-J Titles: %i, Other: %i",
354 355 356 357 358 359
             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) {
360
        msg_Dbg(p_demux, "Disc is using AACS");
361 362 363
        if (!disc_info->libaacs_detected)
            BLURAY_ERROR(_("This Blu-ray Disc needs a library for AACS decoding"
                      ", and your system does not have it."));
364
        if (!disc_info->aacs_handled) {
365 366
            if (disc_info->aacs_error_code) {
                switch (disc_info->aacs_error_code) {
367 368 369 370 371 372 373 374 375 376 377 378
                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."));
379 380
                }
            }
381 382 383 384 385
        }
    }

    /* BD+ */
    if (disc_info->bdplus_detected) {
386
        msg_Dbg(p_demux, "Disc is using BD+");
387 388 389 390 391 392
        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?"));
393 394
    }

395 396 397 398 399 400
    /* 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);

401 402 403 404 405 406 407 408
    /* 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);

409
    /* Get titles and chapters */
410 411
    p_sys->p_meta = bd_get_meta(p_sys->bluray);
    if (!p_sys->p_meta)
Rafaël Carré's avatar
Rafaël Carré committed
412
        msg_Warn(p_demux, "Failed to get meta info.");
413

414 415 416
    p_sys->b_menu = var_InheritBool(p_demux, "bluray-menu");

    blurayInitTitles(p_demux, disc_info->num_hdmv_titles + disc_info->num_bdj_titles + 1/*Top Menu*/ + 1/*First Play*/);
417

418 419 420 421 422
    /*
     * Initialize the event queue, so we can receive events in blurayDemux(Menu).
     */
    bd_get_event(p_sys->bluray, NULL);

423 424
    /* Registering overlay event handler */
    bd_register_overlay_proc(p_sys->bluray, p_demux, blurayOverlayProc);
425 426 427 428 429
    p_sys->p_input = demux_GetParentInput(p_demux);
    if (unlikely(!p_sys->p_input)) {
        msg_Err(p_demux, "Could not get parent input");
        goto error;
    }
430

Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
431
    if (p_sys->b_menu) {
432

433
        /* Register ARGB overlay handler for BD-J */
434
        if (disc_info->num_bdj_titles)
435 436
            bd_register_argb_overlay_proc(p_sys->bluray, p_demux, blurayArgbOverlayProc, NULL);

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

Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
441
    } else {
442
        /* set start title number */
443
        if (bluraySetTitle(p_demux, p_sys->i_longest_title) != VLC_SUCCESS) {
Rafaël Carré's avatar
Rafaël Carré committed
444
            msg_Err(p_demux, "Could not set the title %d", p_sys->i_longest_title);
445 446
            goto error;
        }
447 448
    }

449
    vlc_array_init(&p_sys->es);
Rafaël Carré's avatar
Rafaël Carré committed
450
    p_sys->p_out = esOutNew(p_demux);
Rafaël Carré's avatar
Rafaël Carré committed
451
    if (unlikely(p_sys->p_out == NULL))
452 453
        goto error;

Rafaël Carré's avatar
Rafaël Carré committed
454
    blurayResetParser(p_demux);
455 456
    if (!p_sys->p_parser) {
        msg_Err(p_demux, "Failed to create TS demuxer");
457
        goto error;
458 459 460 461
    }

    p_demux->pf_control = blurayControl;
    p_demux->pf_demux   = blurayDemux;
462 463

    return VLC_SUCCESS;
464 465 466

error:
    if (error_msg)
Christoph Miebach's avatar
Christoph Miebach committed
467
        dialog_Fatal(p_demux, _("Blu-ray error"), "%s", error_msg);
468 469
    blurayClose(object);
    return VLC_EGENERIC;
470
#undef BLURAY_ERROR
471 472 473 474 475 476
}


/*****************************************************************************
 * blurayClose: module destroy function
 *****************************************************************************/
Rafaël Carré's avatar
Rafaël Carré committed
477
static void blurayClose(vlc_object_t *object)
478
{
479 480 481
    demux_t *p_demux = (demux_t*)object;
    demux_sys_t *p_sys = p_demux->p_sys;

482 483
    setTitleInfo(p_sys, NULL);

484 485 486
    /*
     * Close libbluray first.
     * This will close all the overlays before we release p_vout
Rafaël Carré's avatar
Rafaël Carré committed
487
     * bd_close(NULL) can crash
488 489 490 491
     */
    assert(p_sys->bluray);
    bd_close(p_sys->bluray);

492
    if (p_sys->p_vout != NULL) {
Rafaël Carré's avatar
Rafaël Carré committed
493 494
        var_DelCallback(p_sys->p_vout, "mouse-moved", onMouseEvent, p_demux);
        var_DelCallback(p_sys->p_vout, "mouse-clicked", onMouseEvent, p_demux);
495
        vlc_object_release(p_sys->p_vout);
496
    }
497 498
    if (p_sys->p_input != NULL)
        vlc_object_release(p_sys->p_input);
499 500
    if (p_sys->p_parser)
        stream_Delete(p_sys->p_parser);
501 502
    if (p_sys->p_out != NULL)
        es_out_Delete(p_sys->p_out);
Rafaël Carré's avatar
Rafaël Carré committed
503 504
    assert(vlc_array_count(&p_sys->es) == 0);
    vlc_array_clear(&p_sys->es);
505

506 507 508
    /* 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
509
    TAB_CLEAN(p_sys->i_title, p_sys->pp_title);
510

511 512
    vlc_mutex_destroy(&p_sys->pl_info_lock);

513
    free(p_sys->psz_bd_path);
514 515 516
    free(p_sys);
}

517 518 519 520 521 522 523 524
/*****************************************************************************
 * Elementary streams handling
 *****************************************************************************/

struct es_out_sys_t {
    demux_t *p_demux;
};

525 526 527 528 529
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
530
static int  findEsPairIndex(demux_sys_t *p_sys, int i_id)
531
{
Rafaël Carré's avatar
Rafaël Carré committed
532 533
    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)
534
            return i;
Rafaël Carré's avatar
Rafaël Carré committed
535

536 537 538
    return -1;
}

Rafaël Carré's avatar
Rafaël Carré committed
539
static int  findEsPairIndexByEs(demux_sys_t *p_sys, es_out_id_t *p_es)
540
{
Rafaël Carré's avatar
Rafaël Carré committed
541 542
    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)
543
            return i;
Rafaël Carré's avatar
Rafaël Carré committed
544

545 546 547
    return -1;
}

548 549 550 551 552 553
static void setStreamLang(es_format_t *p_fmt,
                          const BLURAY_STREAM_INFO *p_streams, int i_stream_count)
{
    for (int i = 0; i < i_stream_count; i++) {
        if (p_fmt->i_id == p_streams[i].pid) {
            free(p_fmt->psz_language);
554
            p_fmt->psz_language = strndup((const char *)p_streams[i].lang, 3);
555 556 557 558 559
            return;
        }
    }
}

Rafaël Carré's avatar
Rafaël Carré committed
560
static es_out_id_t *esOutAdd(es_out_t *p_out, const es_format_t *p_fmt)
561
{
562 563 564 565
    demux_sys_t *p_sys = p_out->p_sys->p_demux->p_sys;
    es_format_t fmt;

    es_format_Copy(&fmt, p_fmt);
566 567 568

    vlc_mutex_lock(&p_sys->pl_info_lock);

Rafaël Carré's avatar
Rafaël Carré committed
569
    switch (fmt.i_cat) {
570
    case VIDEO_ES:
Rafaël Carré's avatar
Rafaël Carré committed
571
        if (p_sys->i_video_stream != -1 && p_sys->i_video_stream != p_fmt->i_id)
572
            fmt.i_priority = ES_PRIORITY_NOT_SELECTABLE;
573 574
        break ;
    case AUDIO_ES:
Rafaël Carré's avatar
Rafaël Carré committed
575
        if (p_sys->i_audio_stream != -1 && p_sys->i_audio_stream != p_fmt->i_id)
576
            fmt.i_priority = ES_PRIORITY_NOT_SELECTABLE;
577 578
        if (p_sys->p_clip_info)
            setStreamLang(&fmt, p_sys->p_clip_info->audio_streams, p_sys->p_clip_info->audio_stream_count);
579 580
        break ;
    case SPU_ES:
581 582
        if (p_sys->i_spu_stream != -1 && p_sys->i_spu_stream != p_fmt->i_id)
            fmt.i_priority = ES_PRIORITY_NOT_SELECTABLE;
583 584
        if (p_sys->p_clip_info)
            setStreamLang(&fmt, p_sys->p_clip_info->pg_streams, p_sys->p_clip_info->pg_stream_count);
585 586 587
        break ;
    }

588
    vlc_mutex_unlock(&p_sys->pl_info_lock);
589

Rafaël Carré's avatar
Rafaël Carré committed
590 591
    es_out_id_t *p_es = es_out_Add(p_out->p_sys->p_demux->out, &fmt);
    if (p_fmt->i_id >= 0) {
592
        /* Ensure we are not overriding anything */
593
        int idx = findEsPairIndex(p_sys, p_fmt->i_id);
Rafaël Carré's avatar
Rafaël Carré committed
594 595 596
        if (idx == -1) {
            fmt_es_pair_t *p_pair = malloc(sizeof(*p_pair));
            if (likely(p_pair != NULL)) {
597 598
                p_pair->i_id = p_fmt->i_id;
                p_pair->p_es = p_es;
Rafaël Carré's avatar
Rafaël Carré committed
599
                msg_Info(p_out->p_sys->p_demux, "Adding ES %d", p_fmt->i_id);
600
                vlc_array_append(&p_sys->es, p_pair);
601 602 603
            }
        }
    }
604
    es_format_Clean(&fmt);
605
    return p_es;
606 607
}

Rafaël Carré's avatar
Rafaël Carré committed
608
static int esOutSend(es_out_t *p_out, es_out_id_t *p_es, block_t *p_block)
609
{
Rafaël Carré's avatar
Rafaël Carré committed
610
    return es_out_Send(p_out->p_sys->p_demux->out, p_es, p_block);
611 612
}

Rafaël Carré's avatar
Rafaël Carré committed
613
static void esOutDel(es_out_t *p_out, es_out_id_t *p_es)
614
{
Rafaël Carré's avatar
Rafaël Carré committed
615 616 617
    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));
618 619
        vlc_array_remove(&p_out->p_sys->p_demux->p_sys->es, idx);
    }
Rafaël Carré's avatar
Rafaël Carré committed
620
    es_out_Del(p_out->p_sys->p_demux->out, p_es);
621 622
}

Rafaël Carré's avatar
Rafaël Carré committed
623
static int esOutControl(es_out_t *p_out, int i_query, va_list args)
624
{
Rafaël Carré's avatar
Rafaël Carré committed
625
    return es_out_vaControl(p_out->p_sys->p_demux->out, i_query, args);
626 627
}

Rafaël Carré's avatar
Rafaël Carré committed
628
static void esOutDestroy(es_out_t *p_out)
629
{
Rafaël Carré's avatar
Rafaël Carré committed
630 631
    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));
632
    vlc_array_clear(&p_out->p_sys->p_demux->p_sys->es);
Rafaël Carré's avatar
Rafaël Carré committed
633 634
    free(p_out->p_sys);
    free(p_out);
635 636
}

Rafaël Carré's avatar
Rafaël Carré committed
637
static es_out_t *esOutNew(demux_t *p_demux)
638
{
Rafaël Carré's avatar
Rafaël Carré committed
639 640 641
    assert(vlc_array_count(&p_demux->p_sys->es) == 0);
    es_out_t    *p_out = malloc(sizeof(*p_out));
    if (unlikely(p_out == NULL))
642 643
        return NULL;

Rafaël Carré's avatar
Rafaël Carré committed
644 645 646 647 648
    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;
649

Rafaël Carré's avatar
Rafaël Carré committed
650 651 652
    p_out->p_sys = malloc(sizeof(*p_out->p_sys));
    if (unlikely(p_out->p_sys == NULL)) {
        free(p_out);
653 654 655 656 657 658
        return NULL;
    }
    p_out->p_sys->p_demux = p_demux;
    return p_out;
}

659 660 661
/*****************************************************************************
 * subpicture_updater_t functions:
 *****************************************************************************/
Rafaël Carré's avatar
Rafaël Carré committed
662
static int subpictureUpdaterValidate(subpicture_t *p_subpic,
663 664
                                      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
665
                                      mtime_t i_ts)
666
{
Rafaël Carré's avatar
Rafaël Carré committed
667 668 669 670 671
    VLC_UNUSED(b_fmt_src);
    VLC_UNUSED(b_fmt_dst);
    VLC_UNUSED(p_fmt_src);
    VLC_UNUSED(p_fmt_dst);
    VLC_UNUSED(i_ts);
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 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729

    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
730
    if (!p_src) {
731
        vlc_mutex_unlock(&p_overlay->lock);
732
        return;
733
    }
734

Rafaël Carré's avatar
Rafaël Carré committed
735
    subpicture_region_t **p_dst = &p_subpic->p_region;
736 737 738
    while (p_src != NULL) {
        *p_dst = subpicture_region_Clone(p_src);
        if (*p_dst == NULL)
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
739
            break;
Rafaël Carré's avatar
Rafaël Carré committed
740
        p_dst = &(*p_dst)->p_next;
741 742 743 744 745 746 747 748
        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);
}

749 750
static void blurayCleanOverlayStruct(bluray_overlay_t *);

751 752
static void subpictureUpdaterDestroy(subpicture_t *p_subpic)
{
753
    blurayCleanOverlayStruct(p_subpic->updater.p_sys->p_overlay);
Rafaël Carré's avatar
Rafaël Carré committed
754
    free(p_subpic->updater.p_sys);
755 756
}

757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774
/*****************************************************************************
 * 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 {
775
        vlc_assert_unreachable();
776 777 778 779
    }
    return VLC_SUCCESS;
}

780 781 782
static int sendKeyEvent(demux_sys_t *p_sys, unsigned int key)
{
    mtime_t now = mdate();
Rafaël Carré's avatar
Rafaël Carré committed
783
    if (bd_user_input(p_sys->bluray, now, key) < 0)
784
        return VLC_EGENERIC;
Rafaël Carré's avatar
Rafaël Carré committed
785

786 787 788
    return VLC_SUCCESS;
}

789 790 791
/*****************************************************************************
 * libbluray overlay handling:
 *****************************************************************************/
792
static void blurayCleanOverlayStruct(bluray_overlay_t *p_overlay)
793
{
794 795
    if (!atomic_flag_test_and_set(&p_overlay->released_once))
        return;
796 797 798 799 800
    /*
     * 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
801
    subpicture_region_ChainDelete(p_overlay->p_regions);
802 803 804
    free(p_overlay);
}

805 806 807 808 809 810
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) {
811 812
        if (p_sys->p_vout)
            vout_FlushSubpictureChannel(p_sys->p_vout, ov->p_pic->i_channel);
813 814 815
        blurayCleanOverlayStruct(ov);
        if (p_sys->current_overlay == plane)
            p_sys->current_overlay = -1;
816

817 818
        p_sys->p_overlays[plane] = NULL;
    }
819

820
    for (int i = 0; i < MAX_OVERLAY; i++)
821 822
        if (p_sys->p_overlays[i])
            return;
823

824
    /* All overlays have been closed */
825 826 827 828 829 830
    if (p_sys->p_vout != NULL) {
        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;
    }
831 832 833 834 835 836 837 838 839
}

/*
 * 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"
 */
840
static void blurayActivateOverlay(demux_t *p_demux, int plane)
841 842
{
    demux_sys_t *p_sys = p_demux->p_sys;
843
    bluray_overlay_t *ov = p_sys->p_overlays[plane];
844 845 846 847 848

    /*
     * If the overlay is already displayed, mark the picture as outdated.
     * We must NOT use vout_PutSubpicture if a picture is already displayed.
     */
849 850 851 852
    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
853
        return;
854
    }
855

856 857 858 859 860
    /*
     * 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
     */
861
    p_sys->current_overlay = plane;
862 863
    ov->status = ToDisplay;
    vlc_mutex_unlock(&ov->lock);
864 865
}

866
static void blurayInitOverlay(demux_t *p_demux, int plane, int width, int height)
867 868 869
{
    demux_sys_t *p_sys = p_demux->p_sys;

870
    assert(p_sys->p_overlays[plane] == NULL);
871

872 873
    bluray_overlay_t *ov = calloc(1, sizeof(*ov));
    if (unlikely(ov == NULL))
874 875 876
        return;

    subpicture_updater_sys_t *p_upd_sys = malloc(sizeof(*p_upd_sys));
877
    if (unlikely(p_upd_sys == NULL)) {
878
        free(ov);
879 880
        return;
    }
881
    /* two references: vout + demux */
882
    atomic_flag_clear(&ov->released_once);
883

884
    p_upd_sys->p_overlay = ov;
885 886 887 888 889 890
    subpicture_updater_t updater = {
        .pf_validate = subpictureUpdaterValidate,
        .pf_update   = subpictureUpdaterUpdate,
        .pf_destroy  = subpictureUpdaterDestroy,
        .p_sys       = p_upd_sys,
    };
891

892
    ov->p_pic = subpicture_New(&updater);
893 894 895 896 897 898
    if (ov->p_pic == NULL) {
        free(p_upd_sys);
        free(ov);
        return;
    }

899 900 901 902
    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;
903 904 905 906

    vlc_mutex_init(&ov->lock);

    p_sys->p_overlays[plane] = ov;
907 908 909 910 911 912 913 914 915 916
}

/**
 * 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.
 */
917
static void blurayClearOverlay(demux_t *p_demux, int plane)
918 919
{
    demux_sys_t *p_sys = p_demux->p_sys;
920 921 922
    bluray_overlay_t *ov = p_sys->p_overlays[plane];

    vlc_mutex_lock(&ov->lock);
923

924 925 926
    subpicture_region_ChainDelete(ov->p_regions);
    ov->p_regions = NULL;
    ov->status = Outdated;
927

928
    vlc_mutex_unlock(&ov->lock);
929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962
}

/*
 * 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);
963
        video_format_Setup(&fmt, VLC_CODEC_YUVP, ov->w, ov->h, ov->w, ov->h, 1, 1);
964 965 966 967 968 969 970 971 972 973 974 975 976

        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
977
    for (int y = 0; y < ov->h; y++)
978
        for (int x = 0; x < ov->w;) {
979 980
            plane_t *p = &p_reg->p_picture->p[0];
            memset(&p->p_pixels[y * p->i_pitch + x], img->color, img->len);
Hugo Beauzée-Luyssen's avatar