bluray.c 49.3 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
    int                 i_playlist;          /* -1 = no playlist playing */
127
    unsigned int        i_current_clip;
128
    input_title_t       **pp_title;
129

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

133
    /* Menus */
134 135 136 137 138 139 140
    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;
141

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

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

struct subpicture_updater_sys_t
{
    bluray_overlay_t    *p_overlay;
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 194
/* 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;
}

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

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

203
static void  blurayInitTitles(demux_t *p_demux, int menu_titles);
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
204
static int   bluraySetTitle(demux_t *p_demux, int i_title);
205

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

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

212 213
static void  blurayResetParser(demux_t *p_demux);

214 215 216
#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
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 263
/* */
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
}

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

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

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

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

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

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

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

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

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

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

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

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

317 318
    msg_Info(p_demux, "First play: %i, Top menu: %i\n"
                      "HDMV Titles: %i, BD-J Titles: %i, Other: %i",
319 320 321 322 323 324
             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) {
325
        msg_Dbg(p_demux, "Disc is using AACS");
326 327 328
        if (!disc_info->libaacs_detected)
            BLURAY_ERROR(_("This Blu-ray Disc needs a library for AACS decoding"
                      ", and your system does not have it."));
329
        if (!disc_info->aacs_handled) {
330 331 332
#ifdef BD_AACS_CORRUPTED_DISC
            if (disc_info->aacs_error_code) {
                switch (disc_info->aacs_error_code) {
333 334 335 336 337 338 339 340 341 342 343 344
                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."));
345 346 347
                }
            }
#else
348 349 350
            /* libbluray < 0.2.3 */
            BLURAY_ERROR(_("Your system AACS decoding library does not work. "
                      "Missing keys?"));
351
#endif /* BD_AACS_CORRUPTED_DISC */
352 353 354 355 356
        }
    }

    /* BD+ */
    if (disc_info->bdplus_detected) {
357
        msg_Dbg(p_demux, "Disc is using BD+");
358 359 360 361 362 363
        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?"));
364 365
    }

366 367 368 369 370 371
    /* 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);

372 373 374 375 376 377 378 379
    /* 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);

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

385 386 387
    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*/);
388

389 390 391 392 393
    /*
     * 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
394
    if (p_sys->b_menu) {
395
        p_sys->p_input = demux_GetParentInput(p_demux);
Rafaël Carré's avatar
Rafaël Carré committed
396
        if (unlikely(!p_sys->p_input)) {
397
            msg_Err(p_demux, "Could not get parent input");
398
            goto error;
Rafaël Carré's avatar
Rafaël Carré committed
399
        }
400

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

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

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

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

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

    p_demux->pf_control = blurayControl;
    p_demux->pf_demux   = blurayDemux;
432 433

    return VLC_SUCCESS;
434 435 436

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


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

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

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

474 475 476
    /* 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
477
    TAB_CLEAN(p_sys->i_title, p_sys->pp_title);
478

479
    free(p_sys->psz_bd_path);
480 481 482
    free(p_sys);
}

483 484 485 486 487 488 489 490
/*****************************************************************************
 * Elementary streams handling
 *****************************************************************************/

struct es_out_sys_t {
    demux_t *p_demux;
};

491 492 493 494 495
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
496
static int  findEsPairIndex(demux_sys_t *p_sys, int i_id)
497
{
Rafaël Carré's avatar
Rafaël Carré committed
498 499
    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)
500
            return i;
Rafaël Carré's avatar
Rafaël Carré committed
501

502 503 504
    return -1;
}

Rafaël Carré's avatar
Rafaël Carré committed
505
static int  findEsPairIndexByEs(demux_sys_t *p_sys, es_out_id_t *p_es)
506
{
Rafaël Carré's avatar
Rafaël Carré committed
507 508
    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)
509
            return i;
Rafaël Carré's avatar
Rafaël Carré committed
510

511 512 513
    return -1;
}

Rafaël Carré's avatar
Rafaël Carré committed
514
static es_out_id_t *esOutAdd(es_out_t *p_out, const es_format_t *p_fmt)
515
{
516 517 518 519
    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
520
    switch (fmt.i_cat) {
521
    case VIDEO_ES:
Rafaël Carré's avatar
Rafaël Carré committed
522
        if (p_sys->i_video_stream != -1 && p_sys->i_video_stream != p_fmt->i_id)
523
            fmt.i_priority = -2;
524 525
        break ;
    case AUDIO_ES:
Rafaël Carré's avatar
Rafaël Carré committed
526
        if (p_sys->i_audio_stream != -1 && p_sys->i_audio_stream != p_fmt->i_id)
527 528 529 530 531 532
            fmt.i_priority = -2;
        break ;
    case SPU_ES:
        break ;
    }

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

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

Rafaël Carré's avatar
Rafaël Carré committed
556
static void esOutDel(es_out_t *p_out, es_out_id_t *p_es)
557
{
Rafaël Carré's avatar
Rafaël Carré committed
558 559 560
    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));
561 562
        vlc_array_remove(&p_out->p_sys->p_demux->p_sys->es, idx);
    }
Rafaël Carré's avatar
Rafaël Carré committed
563
    es_out_Del(p_out->p_sys->p_demux->out, p_es);
564 565
}

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

Rafaël Carré's avatar
Rafaël Carré committed
571
static void esOutDestroy(es_out_t *p_out)
572
{
Rafaël Carré's avatar
Rafaël Carré committed
573 574
    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));
575
    vlc_array_clear(&p_out->p_sys->p_demux->p_sys->es);
Rafaël Carré's avatar
Rafaël Carré committed
576 577
    free(p_out->p_sys);
    free(p_out);
578 579
}

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

Rafaël Carré's avatar
Rafaël Carré committed
587 588 589 590 591
    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;
592

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

602 603 604
/*****************************************************************************
 * subpicture_updater_t functions:
 *****************************************************************************/
Rafaël Carré's avatar
Rafaël Carré committed
605
static int subpictureUpdaterValidate(subpicture_t *p_subpic,
606 607
                                      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
608
                                      mtime_t i_ts)
609
{
Rafaël Carré's avatar
Rafaël Carré committed
610 611 612 613 614
    VLC_UNUSED(b_fmt_src);
    VLC_UNUSED(b_fmt_dst);
    VLC_UNUSED(p_fmt_src);
    VLC_UNUSED(p_fmt_dst);
    VLC_UNUSED(i_ts);
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 671 672

    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
673
    if (!p_src) {
674
        vlc_mutex_unlock(&p_overlay->lock);
675
        return;
676
    }
677

Rafaël Carré's avatar
Rafaël Carré committed
678
    subpicture_region_t **p_dst = &p_subpic->p_region;
679 680 681
    while (p_src != NULL) {
        *p_dst = subpicture_region_Clone(p_src);
        if (*p_dst == NULL)
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
682
            break;
Rafaël Carré's avatar
Rafaël Carré committed
683
        p_dst = &(*p_dst)->p_next;
684 685 686 687 688 689 690 691
        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);
}

692 693
static void blurayCleanOverlayStruct(bluray_overlay_t *);

694 695
static void subpictureUpdaterDestroy(subpicture_t *p_subpic)
{
696
    blurayCleanOverlayStruct(p_subpic->updater.p_sys->p_overlay);
Rafaël Carré's avatar
Rafaël Carré committed
697
    free(p_subpic->updater.p_sys);
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
/*****************************************************************************
 * 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;
}

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

729 730 731
    return VLC_SUCCESS;
}

732 733 734
/*****************************************************************************
 * libbluray overlay handling:
 *****************************************************************************/
735
static void blurayCleanOverlayStruct(bluray_overlay_t *p_overlay)
736
{
737 738
    if (!atomic_flag_test_and_set(&p_overlay->released_once))
        return;
739 740 741 742 743
    /*
     * 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
744
    subpicture_region_ChainDelete(p_overlay->p_regions);
745 746 747
    free(p_overlay);
}

748 749 750 751 752 753 754 755 756 757 758 759 760 761 762
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;
}

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

    p_demux->p_sys->current_overlay = -1;
768 769 770
    if (!p_sys->p_vout)
        return;

771 772 773
    for (int i = 0; i < MAX_OVERLAY; i++)
        blurayCloseOverlay(p_demux, i);

774 775 776 777
    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;
778 779 780 781 782 783 784 785 786
}

/*
 * 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"
 */
787
static void blurayActivateOverlay(demux_t *p_demux, int plane)
788 789
{
    demux_sys_t *p_sys = p_demux->p_sys;
790
    bluray_overlay_t *ov = p_sys->p_overlays[plane];
791 792 793 794 795

    /*
     * If the overlay is already displayed, mark the picture as outdated.
     * We must NOT use vout_PutSubpicture if a picture is already displayed.
     */
796 797 798 799
    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
800
        return;
801
    }
802

803 804 805 806 807
    /*
     * 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
     */
808
    p_sys->current_overlay = plane;
809 810
    ov->status = ToDisplay;
    vlc_mutex_unlock(&ov->lock);
811 812
}

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

817
    assert(p_sys->p_overlays[plane] == NULL);
818

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

823 824
    bluray_overlay_t *ov = p_sys->p_overlays[plane];

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

834
    p_upd_sys->p_overlay = ov;
835 836 837 838 839 840
    subpicture_updater_t updater = {
        .pf_validate = subpictureUpdaterValidate,
        .pf_update   = subpictureUpdaterUpdate,
        .pf_destroy  = subpictureUpdaterDestroy,
        .p_sys       = p_upd_sys,
    };
841 842 843 844 845 846
    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;
847 848 849 850 851 852 853 854 855 856
}

/**
 * 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.
 */
857
static void blurayClearOverlay(demux_t *p_demux, int plane)
858 859
{
    demux_sys_t *p_sys = p_demux->p_sys;
860 861 862
    bluray_overlay_t *ov = p_sys->p_overlays[plane];

    vlc_mutex_lock(&ov->lock);
863

864 865 866
    subpicture_region_ChainDelete(ov->p_regions);
    ov->p_regions = NULL;
    ov->status = Outdated;
867

868
    vlc_mutex_unlock(&ov->lock);
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 915 916
}

/*
 * 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
917
    for (int y = 0; y < ov->h; y++)
918
        for (int x = 0; x < ov->w;) {
919 920
            plane_t *p = &p_reg->p_picture->p[0];
            memset(&p->p_pixels[y * p->i_pitch + x], img->color, img->len);
921 922 923
            x += img->len;
            img++;
        }
Rafaël Carré's avatar
Rafaël Carré committed
924

925 926 927 928 929 930 931 932 933
    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
934

935 936 937 938 939 940 941 942 943 944 945 946 947 948 949
    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
950

951
    switch (overlay->cmd) {
Rafaël Carré's avatar
Rafaël Carré committed
952 953 954 955
    case BD_OVERLAY_INIT:
        msg_Info(p_demux, "Initializing overlay");
        blurayInitOverlay(p_demux, overlay->plane, overlay->w, overlay->h);
        break;
956 957 958 959
    case BD_OVERLAY_CLOSE:
        blurayClearOverlay(p_demux, overlay->plane);
        blurayCloseOverlay(p_demux, overlay->plane);
        break;
Rafaël Carré's avatar
Rafaël Carré committed
960 961 962 963 964 965 966 967 968 969 970 971
    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;
972 973 974
    }
}

975 976 977 978 979 980 981 982 983
/*
 * 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);

984
    if (!p_sys->p_overlays[plane]->p_regions) {
985 986 987 988
        video_format_t fmt;
        video_format_Init(&fmt, 0);
        video_format_Setup(&fmt, VLC_CODEC_RGBA, width, height, 1, 1);

989
        p_sys->p_overlays[plane]->p_regions = subpicture_region_New(&fmt);
990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
    }
}

static void blurayDrawArgbOverlay(demux_t *p_demux, const BD_ARGB_OVERLAY* const ov)
{
    demux_sys_t *p_sys = p_demux->p_sys;

    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;
    if (!p_reg) {
        vlc_mutex_unlock(&p_sys->p_overlays[ov->plane]->lock);
        return;
    }

    /* Now we can update the region */
    const uint32_t *src0 = ov->argb;
    uint8_t        *dst0 = p_reg->p_picture->p[0].p_pixels +
                           p_reg->p_picture->p[0].i_pitch * ov->y +
                           ov->x * 4;

    for (int y = 0; y < ov->h; y++) {
        // XXX: add support for this format ? Should be possible with OPENGL/VDPAU/...
        // - or add libbluray option to select the format ?
        for (int x = 0; x < ov->w; x++) {
            dst0[x*4  ] = src0[x]>>16; /* R */
            dst0[x*4+1] = src0[x]>>8;  /* G */
            dst0[x*4+2] = src0[x];     /* B */
            dst0[x*4+3] = src0[x]>>24; /* A */
        }

        src0 += ov->stride;
        dst0 += p_reg->p_picture->p[0].i_pitch;
    }

    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 blurayArgbOverlayProc(void *ptr, const BD_ARGB_OVERLAY *const overlay)
{
    demux_t *p_demux = (demux_t*)ptr;

    switch (overlay->cmd) {
Rafaël Carré's avatar
Rafaël Carré committed
1037 1038 1039 1040 1041
    case BD_ARGB_OVERLAY_INIT:
        blurayInitArgbOverlay(p_demux, overlay->plane, overlay->w, overlay->h);
        break;
    case BD_ARGB_OVERLAY_CLOSE:
        blurayClearOverlay(p_demux, overlay->plane);
1042
        blurayCloseOverlay(p_demux, overlay->plane);
Rafaël Carré's avatar
Rafaël Carré committed
1043 1044