bluray.c 53.7 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

    /* */
    vout_thread_t       *p_vout;
146

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

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

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

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

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

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

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

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

219 220
static void  blurayResetParser(demux_t *p_demux);

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

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

236
    struct stat st;
237
    if (lstat (bd_device, &st) == 0 && S_ISBLK (st.st_mode)) {
238 239 240 241 242 243 244 245 246 247 248 249 250
        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);
    }
251 252
    free(bd_device);

253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
#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
270
    VLC_UNUSED( device );
271 272 273
#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
    if (unlikely(!p_demux->p_input)) {
426 427 428
        msg_Err(p_demux, "Could not get parent input");
        goto error;
    }
429

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

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

436
        /* libbluray will start playback from "First-Title" title */
437 438 439
        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
440
    } else {
441
        /* set start title number */
442
        if (bluraySetTitle(p_demux, p_sys->i_longest_title) != VLC_SUCCESS) {
Rafaël Carré's avatar
Rafaël Carré committed
443
            msg_Err(p_demux, "Could not set the title %d", p_sys->i_longest_title);
444 445
            goto error;
        }
446 447
    }

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

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

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

    return VLC_SUCCESS;
463 464 465

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


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

481 482
    setTitleInfo(p_sys, NULL);

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

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

503 504 505
    /* 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
506
    TAB_CLEAN(p_sys->i_title, p_sys->pp_title);
507

508 509
    vlc_mutex_destroy(&p_sys->pl_info_lock);

510
    free(p_sys->psz_bd_path);
511 512 513
    free(p_sys);
}

514 515 516 517 518 519 520 521
/*****************************************************************************
 * Elementary streams handling
 *****************************************************************************/

struct es_out_sys_t {
    demux_t *p_demux;
};

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

533 534 535
    return -1;
}

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

542 543 544
    return -1;
}

545 546 547 548 549 550
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);
551
            p_fmt->psz_language = strndup((const char *)p_streams[i].lang, 3);
552 553 554 555 556
            return;
        }
    }
}

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

    es_format_Copy(&fmt, p_fmt);
563 564 565

    vlc_mutex_lock(&p_sys->pl_info_lock);

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

585
    vlc_mutex_unlock(&p_sys->pl_info_lock);
586

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

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

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

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

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

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

Rafaël Carré's avatar
Rafaël Carré committed
641 642 643 644 645
    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;
646

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

656 657 658
/*****************************************************************************
 * subpicture_updater_t functions:
 *****************************************************************************/
Rafaël Carré's avatar
Rafaël Carré committed
659
static int subpictureUpdaterValidate(subpicture_t *p_subpic,
660 661
                                      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
662
                                      mtime_t i_ts)
663
{
Rafaël Carré's avatar
Rafaël Carré committed
664 665 666 667 668
    VLC_UNUSED(b_fmt_src);
    VLC_UNUSED(b_fmt_dst);
    VLC_UNUSED(p_fmt_src);
    VLC_UNUSED(p_fmt_dst);
    VLC_UNUSED(i_ts);
669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696

    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;
}

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
697
    if (!p_src) {
698
        vlc_mutex_unlock(&p_overlay->lock);
699
        return;
700
    }
701

Rafaël Carré's avatar
Rafaël Carré committed
702
    subpicture_region_t **p_dst = &p_subpic->p_region;
703
    while (p_src != NULL) {
704
        *p_dst = subpicture_region_Copy(p_src);
705
        if (*p_dst == NULL)
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
706
            break;
Rafaël Carré's avatar
Rafaël Carré committed
707
        p_dst = &(*p_dst)->p_next;
708 709 710 711 712 713 714 715
        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);
}

716 717
static void blurayCleanOverlayStruct(bluray_overlay_t *);

718 719
static void subpictureUpdaterDestroy(subpicture_t *p_subpic)
{
720
    blurayCleanOverlayStruct(p_subpic->updater.p_sys->p_overlay);
Rafaël Carré's avatar
Rafaël Carré committed
721
    free(p_subpic->updater.p_sys);
722 723
}

724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741
/*****************************************************************************
 * 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 {
742
        vlc_assert_unreachable();
743 744 745 746
    }
    return VLC_SUCCESS;
}

747 748 749
static int sendKeyEvent(demux_sys_t *p_sys, unsigned int key)
{
    mtime_t now = mdate();
Rafaël Carré's avatar
Rafaël Carré committed
750
    if (bd_user_input(p_sys->bluray, now, key) < 0)
751
        return VLC_EGENERIC;
Rafaël Carré's avatar
Rafaël Carré committed
752

753 754 755
    return VLC_SUCCESS;
}

756 757 758
/*****************************************************************************
 * libbluray overlay handling:
 *****************************************************************************/
759
static void blurayCleanOverlayStruct(bluray_overlay_t *p_overlay)
760
{
761 762
    if (!atomic_flag_test_and_set(&p_overlay->released_once))
        return;
763 764 765 766 767
    /*
     * 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
768
    subpicture_region_ChainDelete(p_overlay->p_regions);
769 770 771
    free(p_overlay);
}

772 773 774 775 776 777
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) {
778 779
        if (p_sys->p_vout)
            vout_FlushSubpictureChannel(p_sys->p_vout, ov->p_pic->i_channel);
780 781 782
        blurayCleanOverlayStruct(ov);
        if (p_sys->current_overlay == plane)
            p_sys->current_overlay = -1;
783

784 785
        p_sys->p_overlays[plane] = NULL;
    }
786

787
    for (int i = 0; i < MAX_OVERLAY; i++)
788 789
        if (p_sys->p_overlays[i])
            return;
790

791
    /* All overlays have been closed */
792 793 794 795 796 797
    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;
    }
798 799 800 801 802 803 804 805 806
}

/*
 * 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"
 */
807
static void blurayActivateOverlay(demux_t *p_demux, int plane)
808 809
{
    demux_sys_t *p_sys = p_demux->p_sys;
810
    bluray_overlay_t *ov = p_sys->p_overlays[plane];
811 812 813 814 815

    /*
     * If the overlay is already displayed, mark the picture as outdated.
     * We must NOT use vout_PutSubpicture if a picture is already displayed.
     */
816 817 818 819
    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
820
        return;
821
    }
822

823 824 825 826 827
    /*
     * 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
     */
828
    p_sys->current_overlay = plane;
829 830
    ov->status = ToDisplay;
    vlc_mutex_unlock(&ov->lock);
831 832
}

833
static void blurayInitOverlay(demux_t *p_demux, int plane, int width, int height)
834 835 836
{
    demux_sys_t *p_sys = p_demux->p_sys;

837
    assert(p_sys->p_overlays[plane] == NULL);
838

839 840
    bluray_overlay_t *ov = calloc(1, sizeof(*ov));
    if (unlikely(ov == NULL))
841 842 843
        return;

    subpicture_updater_sys_t *p_upd_sys = malloc(sizeof(*p_upd_sys));
844
    if (unlikely(p_upd_sys == NULL)) {
845
        free(ov);
846 847
        return;
    }
848
    /* two references: vout + demux */
849
    atomic_flag_clear(&ov->released_once);
850

851
    p_upd_sys->p_overlay = ov;
852 853 854 855 856 857
    subpicture_updater_t updater = {
        .pf_validate = subpictureUpdaterValidate,
        .pf_update   = subpictureUpdaterUpdate,
        .pf_destroy  = subpictureUpdaterDestroy,
        .p_sys       = p_upd_sys,
    };
858

859
    ov->p_pic = subpicture_New(&updater);
860 861 862 863 864 865
    if (ov->p_pic == NULL) {
        free(p_upd_sys);
        free(ov);
        return;
    }

866 867 868 869
    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;
870 871 872 873

    vlc_mutex_init(&ov->lock);

    p_sys->p_overlays[plane] = ov;
874 875 876 877 878 879 880 881 882 883
}

/**
 * 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.
 */
884
static void blurayClearOverlay(demux_t *p_demux, int plane)
885 886
{
    demux_sys_t *p_sys = p_demux->p_sys;
887 888 889
    bluray_overlay_t *ov = p_sys->p_overlays[plane];

    vlc_mutex_lock(&ov->lock);
890

891 892 893
    subpicture_region_ChainDelete(ov->p_regions);
    ov->p_regions = NULL;
    ov->status = Outdated;
894

895
    vlc_mutex_unlock(&ov->lock);
896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929
}

/*
 * 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);
930
        video_format_Setup(&fmt, VLC_CODEC_YUVP, ov->w, ov->h, ov->w, ov->h, 1, 1);
931 932 933 934 935 936 937 938 939 940 941 942 943

        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
944
    for (int y = 0; y < ov->h; y++)
945
        for (int x = 0; x < ov->w;) {
946 947
            plane_t *p = &p_reg->p_picture->p[0];
            memset(&p->p_pixels[y * p->i_pitch + x], img->color, img->len);
948 949 950
            x += img->len;
            img++;
        }
Rafaël Carré's avatar
Rafaël Carré committed
951

952 953 954 955 956 957 958 959 960
    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
961

962 963 964 965 966 967 968 969 970
    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;
971
    demux_sys_t *p_sys = p_demux->p_sys;
972 973

    if (!overlay) {
974 975 976 977 978
        msg_Info(p_demux, "Closing overlays.");
        p_sys->current_overlay = -1;
        if (p_sys->p_vout)
            for (int i = 0; i < MAX_OVERLAY; i++)
                blurayCloseOverlay(p_demux, i);
979 980
        return;
    }
Rafaël Carré's avatar
Rafaël Carré committed
981

982
    switch (overlay->cmd) {
Rafaël Carré's avatar
Rafaël Carré committed
983 984 985 986
    case BD_OVERLAY_INIT:
        msg_Info(p_demux, "Initializing overlay");
        blurayInitOverlay(p_demux, overlay->plane, overlay->w, overlay->h);
        break;
987 988 989 990
    case BD_OVERLAY_CLOSE:
        blurayClearOverlay(p_demux, overlay->plane);
        blurayCloseOverlay(p_demux, overlay->plane);
        break;
Rafaël Carré's avatar
Rafaël Carré committed
991 992 993 994 995 996 997 998 999 1000 1001 1002
    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;