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

#include <libbluray/bluray.h>
52
#include <libbluray/keys.h>
53
#include <libbluray/meta_data.h>
54
#include <libbluray/overlay.h>
55 56 57 58 59

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

Rafaël Carré's avatar
Rafaël Carré committed
60 61 62 63 64
#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. "\
65 66 67 68 69 70 71 72
                                "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) */
73

74
/* Callbacks */
Rafaël Carré's avatar
Rafaël Carré committed
75 76
static int  blurayOpen (vlc_object_t *);
static void blurayClose(vlc_object_t *);
77 78

vlc_module_begin ()
Rafaël Carré's avatar
Rafaël Carré committed
79 80
    set_shortname(N_("Blu-ray"))
    set_description(N_("Blu-ray Disc support (libbluray)"))
81

Rafaël Carré's avatar
Rafaël Carré committed
82 83 84 85 86 87
    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)
88

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

Rafaël Carré's avatar
Rafaël Carré committed
91
    set_callbacks(blurayOpen, blurayClose)
92 93
vlc_module_end ()

94 95
/* libbluray's overlay.h defines 2 types of overlay (bd_overlay_plane_e). */
#define MAX_OVERLAY 2
96

97 98 99 100 101 102 103 104
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
105
{
106
    atomic_flag         released_once;
107 108 109 110 111 112 113 114 115
    vlc_mutex_t         lock;
    subpicture_t        *p_pic;
    OverlayStatus       status;
    subpicture_region_t *p_regions;
} bluray_overlay_t;

struct  demux_sys_t
{
    BLURAY              *bluray;
116 117

    /* Titles */
118 119
    unsigned int        i_title;
    unsigned int        i_longest_title;
120
    unsigned int        i_current_clip;
121
    input_title_t       **pp_title;
122

123 124 125
    /* Meta informations */
    const META_DL       *p_meta;

126
    /* Menus */
127 128 129 130 131 132 133
    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;
134

135
    /* TS stream */
136
    es_out_t            *p_out;
137
    vlc_array_t         es;
138
    int                 i_audio_stream; /* Selected audio stream. -1 if default */
139
    int                 i_video_stream;
140
    stream_t            *p_parser;
141 142 143

    /* Used to store bluray disc path */
    char                *psz_bd_path;
144 145 146 147 148
};

struct subpicture_updater_sys_t
{
    bluray_overlay_t    *p_overlay;
149 150
};

151 152 153
/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
Rafaël Carré's avatar
Rafaël Carré committed
154
static es_out_t *esOutNew(demux_t *p_demux);
155

Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
156 157
static int   blurayControl(demux_t *, int, va_list);
static int   blurayDemux(demux_t *);
158

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

Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
162
static void  blurayOverlayProc(void *ptr, const BD_OVERLAY * const overlay);
163
static void  blurayArgbOverlayProc(void *ptr, const BD_ARGB_OVERLAY * const overlay);
164

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

168 169
static void  blurayResetParser(demux_t *p_demux);

170 171 172
#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
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 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
/* */
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
}

220 221 222
/*****************************************************************************
 * blurayOpen: module init function
 *****************************************************************************/
Rafaël Carré's avatar
Rafaël Carré committed
223
static int blurayOpen(vlc_object_t *object)
224
{
225 226
    demux_t *p_demux = (demux_t*)object;
    demux_sys_t *p_sys;
227

228
    const char *error_msg = NULL;
229
#define BLURAY_ERROR(s) do { error_msg = s; goto error; } while(0)
230

231
    if (strcmp(p_demux->psz_access, "bluray")) {
232
        // TODO BDMV support, once we figure out what to do in libbluray
233 234 235
        return VLC_EGENERIC;
    }

236
    /* */
237
    p_demux->p_sys = p_sys = calloc(1, sizeof(*p_sys));
Rafaël Carré's avatar
Rafaël Carré committed
238
    if (unlikely(!p_sys))
239
        return VLC_ENOMEM;
Rafaël Carré's avatar
Rafaël Carré committed
240

241
    p_sys->current_overlay = -1;
242
    p_sys->i_audio_stream = -1;
243
    p_sys->i_video_stream = -1;
244 245 246 247 248

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

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

252
    /* store current bd path */
Rafaël Carré's avatar
Rafaël Carré committed
253 254
    if (p_demux->psz_file)
        p_sys->psz_bd_path = strdup(p_demux->psz_file);
255

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

259
    p_sys->bluray = bd_open(p_sys->psz_bd_path, NULL);
260
    if (!p_sys->bluray) {
261
        free(p_sys->psz_bd_path);
262 263 264 265
        free(p_sys);
        return VLC_EGENERIC;
    }

266 267
    /* Warning the user about AACS/BD+ */
    const BLURAY_DISC_INFO *disc_info = bd_get_disc_info(p_sys->bluray);
268 269

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

273 274
    msg_Info(p_demux, "First play: %i, Top menu: %i\n"
                      "HDMV Titles: %i, BD-J Titles: %i, Other: %i",
275 276 277 278 279 280
             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) {
281
        msg_Dbg(p_demux, "Disc is using AACS");
282 283 284
        if (!disc_info->libaacs_detected)
            BLURAY_ERROR(_("This Blu-ray Disc needs a library for AACS decoding"
                      ", and your system does not have it."));
285
        if (!disc_info->aacs_handled) {
286 287 288
#ifdef BD_AACS_CORRUPTED_DISC
            if (disc_info->aacs_error_code) {
                switch (disc_info->aacs_error_code) {
289 290 291 292 293 294 295 296 297 298 299 300
                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."));
301 302 303
                }
            }
#else
304 305 306
            /* libbluray < 0.2.3 */
            BLURAY_ERROR(_("Your system AACS decoding library does not work. "
                      "Missing keys?"));
307
#endif /* BD_AACS_CORRUPTED_DISC */
308 309 310 311 312
        }
    }

    /* BD+ */
    if (disc_info->bdplus_detected) {
313
        msg_Dbg(p_demux, "Disc is using BD+");
314 315 316 317 318 319
        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?"));
320 321
    }

322 323 324 325 326 327
    /* 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);

328
    /* Get titles and chapters */
329 330
    p_sys->p_meta = bd_get_meta(p_sys->bluray);
    if (!p_sys->p_meta)
Rafaël Carré's avatar
Rafaël Carré committed
331
        msg_Warn(p_demux, "Failed to get meta info.");
332

333
    blurayInitTitles(p_demux);
334

335 336 337 338 339
    /*
     * 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
340 341
    p_sys->b_menu = var_InheritBool(p_demux, "bluray-menu");
    if (p_sys->b_menu) {
342
        p_sys->p_input = demux_GetParentInput(p_demux);
Rafaël Carré's avatar
Rafaël Carré committed
343
        if (unlikely(!p_sys->p_input)) {
344
            msg_Err(p_demux, "Could not get parent input");
345
            goto error;
Rafaël Carré's avatar
Rafaël Carré committed
346
        }
347

348
        /* Register ARGB overlay handler for BD-J */
349
        if (disc_info->num_bdj_titles)
350 351
            bd_register_argb_overlay_proc(p_sys->bluray, p_demux, blurayArgbOverlayProc, NULL);

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

356 357
        /* Registering overlay event handler */
        bd_register_overlay_proc(p_sys->bluray, p_demux, blurayOverlayProc);
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
358
    } else {
359
        /* set start title number */
360
        if (bluraySetTitle(p_demux, p_sys->i_longest_title) != VLC_SUCCESS) {
Rafaël Carré's avatar
Rafaël Carré committed
361
            msg_Err(p_demux, "Could not set the title %d", p_sys->i_longest_title);
362 363
            goto error;
        }
364 365
    }

366
    vlc_array_init(&p_sys->es);
Rafaël Carré's avatar
Rafaël Carré committed
367
    p_sys->p_out = esOutNew(p_demux);
Rafaël Carré's avatar
Rafaël Carré committed
368
    if (unlikely(p_sys->p_out == NULL))
369 370
        goto error;

Rafaël Carré's avatar
Rafaël Carré committed
371
    blurayResetParser(p_demux);
372 373
    if (!p_sys->p_parser) {
        msg_Err(p_demux, "Failed to create TS demuxer");
374
        goto error;
375 376 377 378
    }

    p_demux->pf_control = blurayControl;
    p_demux->pf_demux   = blurayDemux;
379 380

    return VLC_SUCCESS;
381 382 383

error:
    if (error_msg)
Christoph Miebach's avatar
Christoph Miebach committed
384
        dialog_Fatal(p_demux, _("Blu-ray error"), "%s", error_msg);
385 386
    blurayClose(object);
    return VLC_EGENERIC;
387
#undef BLURAY_ERROR
388 389 390 391 392 393
}


/*****************************************************************************
 * blurayClose: module destroy function
 *****************************************************************************/
Rafaël Carré's avatar
Rafaël Carré committed
394
static void blurayClose(vlc_object_t *object)
395
{
396 397 398
    demux_t *p_demux = (demux_t*)object;
    demux_sys_t *p_sys = p_demux->p_sys;

399 400 401
    /*
     * Close libbluray first.
     * This will close all the overlays before we release p_vout
Rafaël Carré's avatar
Rafaël Carré committed
402
     * bd_close(NULL) can crash
403 404 405 406
     */
    assert(p_sys->bluray);
    bd_close(p_sys->bluray);

407
    if (p_sys->p_vout != NULL) {
Rafaël Carré's avatar
Rafaël Carré committed
408 409
        var_DelCallback(p_sys->p_vout, "mouse-moved", onMouseEvent, p_demux);
        var_DelCallback(p_sys->p_vout, "mouse-clicked", onMouseEvent, p_demux);
410
        vlc_object_release(p_sys->p_vout);
411
    }
412 413
    if (p_sys->p_input != NULL)
        vlc_object_release(p_sys->p_input);
414 415
    if (p_sys->p_parser)
        stream_Delete(p_sys->p_parser);
416 417
    if (p_sys->p_out != NULL)
        es_out_Delete(p_sys->p_out);
Rafaël Carré's avatar
Rafaël Carré committed
418 419
    assert(vlc_array_count(&p_sys->es) == 0);
    vlc_array_clear(&p_sys->es);
420

421 422 423
    /* 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
424
    TAB_CLEAN(p_sys->i_title, p_sys->pp_title);
425

426
    free(p_sys->psz_bd_path);
427 428 429
    free(p_sys);
}

430 431 432 433 434 435 436 437
/*****************************************************************************
 * Elementary streams handling
 *****************************************************************************/

struct es_out_sys_t {
    demux_t *p_demux;
};

438 439 440 441 442
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
443
static int  findEsPairIndex(demux_sys_t *p_sys, int i_id)
444
{
Rafaël Carré's avatar
Rafaël Carré committed
445 446
    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)
447
            return i;
Rafaël Carré's avatar
Rafaël Carré committed
448

449 450 451
    return -1;
}

Rafaël Carré's avatar
Rafaël Carré committed
452
static int  findEsPairIndexByEs(demux_sys_t *p_sys, es_out_id_t *p_es)
453
{
Rafaël Carré's avatar
Rafaël Carré committed
454 455
    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)
456
            return i;
Rafaël Carré's avatar
Rafaël Carré committed
457

458 459 460
    return -1;
}

Rafaël Carré's avatar
Rafaël Carré committed
461
static es_out_id_t *esOutAdd(es_out_t *p_out, const es_format_t *p_fmt)
462
{
463 464 465 466
    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
467
    switch (fmt.i_cat) {
468
    case VIDEO_ES:
Rafaël Carré's avatar
Rafaël Carré committed
469
        if (p_sys->i_video_stream != -1 && p_sys->i_video_stream != p_fmt->i_id)
470
            fmt.i_priority = -2;
471 472
        break ;
    case AUDIO_ES:
Rafaël Carré's avatar
Rafaël Carré committed
473
        if (p_sys->i_audio_stream != -1 && p_sys->i_audio_stream != p_fmt->i_id)
474 475 476 477 478 479
            fmt.i_priority = -2;
        break ;
    case SPU_ES:
        break ;
    }

Rafaël Carré's avatar
Rafaël Carré committed
480 481
    es_out_id_t *p_es = es_out_Add(p_out->p_sys->p_demux->out, &fmt);
    if (p_fmt->i_id >= 0) {
482
        /* Ensure we are not overriding anything */
483
        int idx = findEsPairIndex(p_sys, p_fmt->i_id);
Rafaël Carré's avatar
Rafaël Carré committed
484 485 486
        if (idx == -1) {
            fmt_es_pair_t *p_pair = malloc(sizeof(*p_pair));
            if (likely(p_pair != NULL)) {
487 488
                p_pair->i_id = p_fmt->i_id;
                p_pair->p_es = p_es;
Rafaël Carré's avatar
Rafaël Carré committed
489
                msg_Info(p_out->p_sys->p_demux, "Adding ES %d", p_fmt->i_id);
490
                vlc_array_append(&p_sys->es, p_pair);
491 492 493
            }
        }
    }
494
    es_format_Clean(&fmt);
495
    return p_es;
496 497
}

Rafaël Carré's avatar
Rafaël Carré committed
498
static int esOutSend(es_out_t *p_out, es_out_id_t *p_es, block_t *p_block)
499
{
Rafaël Carré's avatar
Rafaël Carré committed
500
    return es_out_Send(p_out->p_sys->p_demux->out, p_es, p_block);
501 502
}

Rafaël Carré's avatar
Rafaël Carré committed
503
static void esOutDel(es_out_t *p_out, es_out_id_t *p_es)
504
{
Rafaël Carré's avatar
Rafaël Carré committed
505 506 507
    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));
508 509
        vlc_array_remove(&p_out->p_sys->p_demux->p_sys->es, idx);
    }
Rafaël Carré's avatar
Rafaël Carré committed
510
    es_out_Del(p_out->p_sys->p_demux->out, p_es);
511 512
}

Rafaël Carré's avatar
Rafaël Carré committed
513
static int esOutControl(es_out_t *p_out, int i_query, va_list args)
514
{
Rafaël Carré's avatar
Rafaël Carré committed
515
    return es_out_vaControl(p_out->p_sys->p_demux->out, i_query, args);
516 517
}

Rafaël Carré's avatar
Rafaël Carré committed
518
static void esOutDestroy(es_out_t *p_out)
519
{
Rafaël Carré's avatar
Rafaël Carré committed
520 521
    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));
522
    vlc_array_clear(&p_out->p_sys->p_demux->p_sys->es);
Rafaël Carré's avatar
Rafaël Carré committed
523 524
    free(p_out->p_sys);
    free(p_out);
525 526
}

Rafaël Carré's avatar
Rafaël Carré committed
527
static es_out_t *esOutNew(demux_t *p_demux)
528
{
Rafaël Carré's avatar
Rafaël Carré committed
529 530 531
    assert(vlc_array_count(&p_demux->p_sys->es) == 0);
    es_out_t    *p_out = malloc(sizeof(*p_out));
    if (unlikely(p_out == NULL))
532 533
        return NULL;

Rafaël Carré's avatar
Rafaël Carré committed
534 535 536 537 538
    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;
539

Rafaël Carré's avatar
Rafaël Carré committed
540 541 542
    p_out->p_sys = malloc(sizeof(*p_out->p_sys));
    if (unlikely(p_out->p_sys == NULL)) {
        free(p_out);
543 544 545 546 547 548
        return NULL;
    }
    p_out->p_sys->p_demux = p_demux;
    return p_out;
}

549 550 551
/*****************************************************************************
 * subpicture_updater_t functions:
 *****************************************************************************/
Rafaël Carré's avatar
Rafaël Carré committed
552
static int subpictureUpdaterValidate(subpicture_t *p_subpic,
553 554
                                      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
555
                                      mtime_t i_ts)
556
{
Rafaël Carré's avatar
Rafaël Carré committed
557 558 559 560 561
    VLC_UNUSED(b_fmt_src);
    VLC_UNUSED(b_fmt_dst);
    VLC_UNUSED(p_fmt_src);
    VLC_UNUSED(p_fmt_dst);
    VLC_UNUSED(i_ts);
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619

    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
620
    if (!p_src) {
621
        vlc_mutex_unlock(&p_overlay->lock);
622
        return;
623
    }
624

Rafaël Carré's avatar
Rafaël Carré committed
625
    subpicture_region_t **p_dst = &p_subpic->p_region;
626 627 628
    while (p_src != NULL) {
        *p_dst = subpicture_region_Clone(p_src);
        if (*p_dst == NULL)
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
629
            break;
Rafaël Carré's avatar
Rafaël Carré committed
630
        p_dst = &(*p_dst)->p_next;
631 632 633 634 635 636 637 638
        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);
}

639 640
static void blurayCleanOverlayStruct(bluray_overlay_t *);

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

670 671 672
static int sendKeyEvent(demux_sys_t *p_sys, unsigned int key)
{
    mtime_t now = mdate();
Rafaël Carré's avatar
Rafaël Carré committed
673
    if (bd_user_input(p_sys->bluray, now, key) < 0)
674
        return VLC_EGENERIC;
Rafaël Carré's avatar
Rafaël Carré committed
675

676 677 678
    return VLC_SUCCESS;
}

679 680 681
/*****************************************************************************
 * libbluray overlay handling:
 *****************************************************************************/
682
static void blurayCleanOverlayStruct(bluray_overlay_t *p_overlay)
683
{
684 685
    if (!atomic_flag_test_and_set(&p_overlay->released_once))
        return;
686 687 688 689 690
    /*
     * 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
691
    subpicture_region_ChainDelete(p_overlay->p_regions);
692 693 694
    free(p_overlay);
}

695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
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;
}

710 711 712 713 714
static void blurayCloseAllOverlays(demux_t *p_demux)
{
    demux_sys_t *p_sys = p_demux->p_sys;

    p_demux->p_sys->current_overlay = -1;
715 716 717
    if (!p_sys->p_vout)
        return;

718 719 720
    for (int i = 0; i < MAX_OVERLAY; i++)
        blurayCloseOverlay(p_demux, i);

721 722 723 724
    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;
725 726 727 728 729 730 731 732 733
}

/*
 * 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"
 */
734
static void blurayActivateOverlay(demux_t *p_demux, int plane)
735 736
{
    demux_sys_t *p_sys = p_demux->p_sys;
737
    bluray_overlay_t *ov = p_sys->p_overlays[plane];
738 739 740 741 742

    /*
     * If the overlay is already displayed, mark the picture as outdated.
     * We must NOT use vout_PutSubpicture if a picture is already displayed.
     */
743 744 745 746
    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
747
        return;
748
    }
749

750 751 752 753 754
    /*
     * 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
     */
755
    p_sys->current_overlay = plane;
756 757
    ov->status = ToDisplay;
    vlc_mutex_unlock(&ov->lock);
758 759
}

760
static void blurayInitOverlay(demux_t *p_demux, int plane, int width, int height)
761 762 763
{
    demux_sys_t *p_sys = p_demux->p_sys;

764
    assert(p_sys->p_overlays[plane] == NULL);
765

766 767
    p_sys->p_overlays[plane] = calloc(1, sizeof(**p_sys->p_overlays));
    if (unlikely(!p_sys->p_overlays[plane]))
768 769
        return;

770 771
    bluray_overlay_t *ov = p_sys->p_overlays[plane];

772 773
    subpicture_updater_sys_t *p_upd_sys = malloc(sizeof(*p_upd_sys));
    if (unlikely(!p_upd_sys)) {
774
        free(ov);
775
        p_sys->p_overlays[plane] = NULL;
776 777
        return;
    }
778
    /* two references: vout + demux */
779
    ov->released_once = ATOMIC_FLAG_INIT;
780

781
    p_upd_sys->p_overlay = ov;
782 783 784 785 786 787
    subpicture_updater_t updater = {
        .pf_validate = subpictureUpdaterValidate,
        .pf_update   = subpictureUpdaterUpdate,
        .pf_destroy  = subpictureUpdaterDestroy,
        .p_sys       = p_upd_sys,
    };
788 789 790 791 792 793
    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;
794 795 796 797 798 799 800 801 802 803
}

/**
 * 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.
 */
804
static void blurayClearOverlay(demux_t *p_demux, int plane)
805 806
{
    demux_sys_t *p_sys = p_demux->p_sys;
807 808 809
    bluray_overlay_t *ov = p_sys->p_overlays[plane];

    vlc_mutex_lock(&ov->lock);
810

811 812 813
    subpicture_region_ChainDelete(ov->p_regions);
    ov->p_regions = NULL;
    ov->status = Outdated;
814

815
    vlc_mutex_unlock(&ov->lock);
816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
}

/*
 * 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
864
    for (int y = 0; y < ov->h; y++)
865
        for (int x = 0; x < ov->w;) {
866 867
            plane_t *p = &p_reg->p_picture->p[0];
            memset(&p->p_pixels[y * p->i_pitch + x], img->color, img->len);
868 869 870
            x += img->len;
            img++;
        }
Rafaël Carré's avatar
Rafaël Carré committed
871

872 873 874 875 876 877 878 879 880
    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
881

882 883 884 885 886 887 888 889 890 891 892 893 894 895 896
    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
897

898
    switch (overlay->cmd) {
Rafaël Carré's avatar
Rafaël Carré committed
899 900 901 902
    case BD_OVERLAY_INIT:
        msg_Info(p_demux, "Initializing overlay");
        blurayInitOverlay(p_demux, overlay->plane, overlay->w, overlay->h);
        break;
903 904 905 906
    case BD_OVERLAY_CLOSE:
        blurayClearOverlay(p_demux, overlay->plane);
        blurayCloseOverlay(p_demux, overlay->plane);
        break;
Rafaël Carré's avatar
Rafaël Carré committed
907 908 909 910 911 912 913 914 915 916 917 918
    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;
919 920 921
    }
}

922 923 924 925 926 927 928 929 930
/*
 * 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);

931
    if (!p_sys->p_overlays[plane]->p_regions) {
932 933 934 935
        video_format_t fmt;
        video_format_Init(&fmt, 0);
        video_format_Setup(&fmt, VLC_CODEC_RGBA, width, height, 1, 1);

936
        p_sys->p_overlays[plane]->p_regions = subpicture_region_New(&fmt);
937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983
    }
}

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
984 985 986 987 988
    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);
989
        blurayCloseOverlay(p_demux, overlay->plane);
Rafaël Carré's avatar
Rafaël Carré committed
990 991 992 993 994 995 996 997 998 999
        break;
    case BD_ARGB_OVERLAY_FLUSH:
        blurayActivateOverlay(p_demux, overlay->plane);
        break;
    case BD_ARGB_OVERLAY_DRAW:
        blurayDrawArgbOverlay(p_demux, overlay);
        break;
    default:
        msg_Warn(p_demux, "Unknown BD ARGB overlay command: %u", overlay->cmd);
        break;
1000 1001 1002
    }
}

1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
static void bluraySendOverlayToVout(demux_t *p_demux)
{
    demux_sys_t *p_sys = p_demux->p_sys;

    assert(p_sys->current_overlay >= 0 &&
           p_sys->p_overlays[p_sys->current_overlay] != NULL &&
           p_sys->p_overlays[p_sys->current_overlay]->p_pic != NULL);

    p_sys->p_overlays[p_sys->current_overlay]->p_pic->i_start =
        p_sys->p_overlays[p_sys->current_overlay]->p_pic->i_stop = mdate();
    p_sys->p_overlays[p_sys->current_overlay]->p_pic->i_channel =
        vout_RegisterSubpictureChannel(p_sys->p_vout);
    /*
     * After this point, the picture should not be accessed from the demux thread,
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
1017
     * as it is held by the vout thread.
1018 1019 1020 1021 1022 1023 1024 1025 1026 1027
     * This must be done only once per subpicture, ie. only once between each
     * blurayInitOverlay & blurayCloseOverlay call.
     */
    vout_PutSubpicture(p_sys->p_vout, p_sys->p_overlays[p_sys->current_overlay]->p_pic);
    /*
     * Mark the picture as Outdated, as it contains no region for now.
     * This will make the subpicture_updater_t call pf_update
     */
    p_sys->p_overlays[p_sys->current_overlay]->status = Outdated;
}
1028

Rafaël Carré's avatar
Rafaël Carré committed
1029
static void blurayInitTitles(demux_t *p_demux)
1030
{
1031
    demux_sys_t *p_sys = p_demux->p_sys;