]> git.sesse.net Git - vlc/blob - modules/access/bluray.c
bluray: Filter video tracks to display the main one.
[vlc] / modules / access / bluray.c
1 /*****************************************************************************
2  * bluray.c: Blu-ray disc support plugin
3  *****************************************************************************
4  * Copyright © 2010-2012 VideoLAN, VLC authors and libbluray AUTHORS
5  *
6  * Authors: Jean-Baptiste Kempf <jb@videolan.org>
7  *          Hugo Beauzée-Luyssen <hugo@videolan.org>
8  *
9  * This program is free software; you can redistribute it and/or modify it
10  * under the terms of the GNU Lesser General Public License as published by
11  * the Free Software Foundation; either version 2.1 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 #ifdef HAVE_CONFIG_H
25 # include "config.h"
26 #endif
27
28 #include <assert.h>
29 #include <limits.h>                         /* PATH_MAX */
30 #if defined (HAVE_MNTENT_H) && defined(HAVE_SYS_STAT_H)
31 #include <mntent.h>
32 #include <sys/stat.h>
33 #endif
34
35 #include <vlc_common.h>
36 #include <vlc_plugin.h>
37 #include <vlc_demux.h>                      /* demux_t */
38 #include <vlc_input.h>                      /* Seekpoints, chapters */
39 #include <vlc_dialog.h>                     /* BD+/AACS warnings */
40 #include <vlc_vout.h>                       /* vout_PutSubpicture / subpicture_t */
41
42 #include <libbluray/bluray.h>
43 #include <libbluray/keys.h>
44 #include <libbluray/meta_data.h>
45 #include <libbluray/overlay.h>
46
47 /*****************************************************************************
48  * Module descriptor
49  *****************************************************************************/
50
51 #define BD_MENU_TEXT        N_( "Bluray menus" )
52 #define BD_MENU_LONGTEXT    N_( "Use bluray menus. If disabled, "\
53                                 "the movie will start directly" )
54
55 /* Callbacks */
56 static int  blurayOpen ( vlc_object_t * );
57 static void blurayClose( vlc_object_t * );
58
59 vlc_module_begin ()
60     set_shortname( N_("BluRay") )
61     set_description( N_("Blu-Ray Disc support (libbluray)") )
62
63     set_category( CAT_INPUT )
64     set_subcategory( SUBCAT_INPUT_ACCESS )
65     set_capability( "access_demux", 200)
66     add_bool( "bluray-menu", false, BD_MENU_TEXT, BD_MENU_LONGTEXT, false )
67
68     add_shortcut( "bluray", "file" )
69
70     set_callbacks( blurayOpen, blurayClose )
71 vlc_module_end ()
72
73 /* libbluray's overlay.h defines 2 types of overlay (bd_overlay_plane_e). */
74 #define MAX_OVERLAY 2
75
76 typedef enum OverlayStatus {
77     Closed = 0,
78     ToDisplay,  //Used to mark the overlay to be displayed the first time.
79     Displayed,
80     Outdated    //used to update the overlay after it has been sent to the vout
81 } OverlayStatus;
82
83 typedef struct bluray_overlay_t
84 {
85     VLC_GC_MEMBERS
86
87     vlc_mutex_t         lock;
88     subpicture_t        *p_pic;
89     OverlayStatus       status;
90     subpicture_region_t *p_regions;
91 } bluray_overlay_t;
92
93 struct  demux_sys_t
94 {
95     BLURAY              *bluray;
96
97     /* Titles */
98     unsigned int        i_title;
99     unsigned int        i_longest_title;
100     unsigned int        i_current_clip;
101     input_title_t       **pp_title;
102
103     /* Meta informations */
104     const META_DL       *p_meta;
105
106     /* Menus */
107     bluray_overlay_t    *p_overlays[MAX_OVERLAY];
108     int                 current_overlay; // -1 if no current overlay;
109     bool                b_menu;
110
111     /* */
112     input_thread_t      *p_input;
113     vout_thread_t       *p_vout;
114
115     /* TS stream */
116     es_out_t            *p_out;
117     vlc_array_t         es;
118     int                 i_audio_stream; /* Selected audio stream. -1 if default */
119     int                 i_video_stream;
120     stream_t            *p_parser;
121 };
122
123 struct subpicture_updater_sys_t
124 {
125     bluray_overlay_t    *p_overlay;
126 };
127
128 /*****************************************************************************
129  * Local prototypes
130  *****************************************************************************/
131 static es_out_t *esOutNew( demux_t *p_demux );
132
133 static int   blurayControl(demux_t *, int, va_list);
134 static int   blurayDemux(demux_t *);
135
136 static int   blurayInitTitles(demux_t *p_demux );
137 static int   bluraySetTitle(demux_t *p_demux, int i_title);
138
139 static void  blurayOverlayProc(void *ptr, const BD_OVERLAY * const overlay);
140
141 static int   onMouseEvent(vlc_object_t *p_vout, const char *psz_var,
142                           vlc_value_t old, vlc_value_t val, void *p_data);
143
144 static void  blurayResetParser(demux_t *p_demux);
145
146 #define FROM_TICKS(a) (a*CLOCK_FREQ / INT64_C(90000))
147 #define TO_TICKS(a)   (a*INT64_C(90000)/CLOCK_FREQ)
148 #define CUR_LENGTH    p_sys->pp_title[p_demux->info.i_title]->i_length
149
150 /*****************************************************************************
151  * blurayOpen: module init function
152  *****************************************************************************/
153 static int blurayOpen( vlc_object_t *object )
154 {
155     demux_t *p_demux = (demux_t*)object;
156     demux_sys_t *p_sys;
157
158     char bd_path[PATH_MAX] = { '\0' };
159     const char *error_msg = NULL;
160
161     if (strcmp(p_demux->psz_access, "bluray")) {
162         // TODO BDMV support, once we figure out what to do in libbluray
163         return VLC_EGENERIC;
164     }
165
166     /* */
167     p_demux->p_sys = p_sys = calloc(1, sizeof(*p_sys));
168     if (unlikely(!p_sys)) {
169         return VLC_ENOMEM;
170     }
171     p_sys->current_overlay = -1;
172     p_sys->i_audio_stream = -1;
173     p_sys->i_video_stream = -1;
174
175     /* init demux info fields */
176     p_demux->info.i_update    = 0;
177     p_demux->info.i_title     = 0;
178     p_demux->info.i_seekpoint = 0;
179
180     TAB_INIT( p_sys->i_title, p_sys->pp_title );
181
182     /* store current bd_path */
183     if (p_demux->psz_file) {
184         strncpy(bd_path, p_demux->psz_file, sizeof(bd_path));
185         bd_path[PATH_MAX - 1] = '\0';
186     }
187
188 #if defined (HAVE_MNTENT_H) && defined (HAVE_SYS_STAT_H)
189     /* If we're passed a block device, try to convert it to the mount point. */
190     struct stat st;
191     if ( !stat (bd_path, &st)) {
192         if (S_ISBLK (st.st_mode)) {
193             FILE* mtab = setmntent ("/proc/self/mounts", "r");
194             struct mntent* m;
195             struct mntent mbuf;
196             char buf [8192];
197             while ((m = getmntent_r (mtab, &mbuf, buf, sizeof(buf))) != NULL) {
198                 if (!strcmp (m->mnt_fsname, bd_path)) {
199                     strncpy (bd_path, m->mnt_dir, sizeof(bd_path));
200                     bd_path[sizeof(bd_path) - 1] = '\0';
201                     break;
202                 }
203             }
204             endmntent (mtab);
205         }
206     }
207 #endif /* HAVE_MNTENT_H && HAVE_SYS_STAT_H */
208     p_sys->bluray = bd_open(bd_path, NULL);
209     if (!p_sys->bluray) {
210         free(p_sys);
211         return VLC_EGENERIC;
212     }
213
214     /* Warning the user about AACS/BD+ */
215     const BLURAY_DISC_INFO *disc_info = bd_get_disc_info(p_sys->bluray);
216
217     /* Is it a bluray? */
218     if (!disc_info->bluray_detected) {
219         error_msg = "Path doesn't appear to be a bluray";
220         goto error;
221     }
222
223     msg_Info(p_demux, "First play: %i, Top menu: %i\n"
224                       "HDMV Titles: %i, BD-J Titles: %i, Other: %i",
225              disc_info->first_play_supported, disc_info->top_menu_supported,
226              disc_info->num_hdmv_titles, disc_info->num_bdj_titles,
227              disc_info->num_unsupported_titles);
228
229     /* AACS */
230     if (disc_info->aacs_detected) {
231         if (!disc_info->libaacs_detected) {
232             error_msg = _("This Blu-Ray Disc needs a library for AACS decoding, "
233                       "and your system does not have it.");
234             goto error;
235         }
236         if (!disc_info->aacs_handled) {
237             error_msg = _("Your system AACS decoding library does not work. "
238                       "Missing keys?");
239             goto error;
240         }
241     }
242
243     /* BD+ */
244     if (disc_info->bdplus_detected) {
245         if (!disc_info->libbdplus_detected) {
246             error_msg = _("This Blu-Ray Disc needs a library for BD+ decoding, "
247                       "and your system does not have it.");
248             goto error;
249         }
250         if (!disc_info->bdplus_handled) {
251             error_msg = _("Your system BD+ decoding library does not work. "
252                       "Missing configuration?");
253             goto error;
254         }
255     }
256
257     /* Get titles and chapters */
258     p_sys->p_meta = bd_get_meta(p_sys->bluray);
259     if (!p_sys->p_meta)
260         msg_Warn(p_demux, "Failed to get meta info." );
261
262     if (blurayInitTitles(p_demux) != VLC_SUCCESS) {
263         goto error;
264     }
265
266     /*
267      * Initialize the event queue, so we can receive events in blurayDemux(Menu).
268      */
269     bd_get_event(p_sys->bluray, NULL);
270
271     p_sys->b_menu = var_InheritBool(p_demux, "bluray-menu");
272     if (p_sys->b_menu) {
273         p_sys->p_input = demux_GetParentInput(p_demux);
274         if (unlikely(!p_sys->p_input)) {
275             error_msg = "Could not get parent input";
276             goto error;
277         }
278
279         /* libbluray will start playback from "First-Title" title */
280         if (bd_play(p_sys->bluray) == 0) {
281             error_msg = "Failed to start bluray playback. Please try without menu support.";
282             goto error;
283         }
284         /* Registering overlay event handler */
285         bd_register_overlay_proc(p_sys->bluray, p_demux, blurayOverlayProc);
286     } else {
287         /* set start title number */
288         if (bluraySetTitle(p_demux, p_sys->i_longest_title) != VLC_SUCCESS) {
289             msg_Err( p_demux, "Could not set the title %d", p_sys->i_longest_title );
290             goto error;
291         }
292     }
293
294     vlc_array_init(&p_sys->es);
295     p_sys->p_out = esOutNew( p_demux );
296     if (unlikely(p_sys->p_out == NULL)) {
297         goto error;
298     }
299
300     blurayResetParser( p_demux );
301     if (!p_sys->p_parser) {
302         msg_Err(p_demux, "Failed to create TS demuxer");
303         goto error;
304     }
305
306     p_demux->pf_control = blurayControl;
307     p_demux->pf_demux   = blurayDemux;
308
309     return VLC_SUCCESS;
310
311 error:
312     if (error_msg)
313         dialog_Fatal(p_demux, _("Blu-Ray error"), "%s", error_msg);
314     blurayClose(object);
315     return VLC_EGENERIC;
316 }
317
318
319 /*****************************************************************************
320  * blurayClose: module destroy function
321  *****************************************************************************/
322 static void blurayClose( vlc_object_t *object )
323 {
324     demux_t *p_demux = (demux_t*)object;
325     demux_sys_t *p_sys = p_demux->p_sys;
326
327     /*
328      * Close libbluray first.
329      * This will close all the overlays before we release p_vout
330      * bd_close( NULL ) can crash
331      */
332     assert(p_sys->bluray);
333     bd_close(p_sys->bluray);
334
335     if (p_sys->p_vout != NULL) {
336         var_DelCallback(p_sys->p_vout, "mouse-moved", &onMouseEvent, p_demux);
337         var_DelCallback(p_sys->p_vout, "mouse-clicked", &onMouseEvent, p_demux);
338         vlc_object_release(p_sys->p_vout);
339     }
340     if (p_sys->p_input != NULL)
341         vlc_object_release(p_sys->p_input);
342     if (p_sys->p_parser)
343         stream_Delete(p_sys->p_parser);
344     if (p_sys->p_out != NULL)
345         es_out_Delete(p_sys->p_out);
346     assert( vlc_array_count(&p_sys->es) == 0 );
347     vlc_array_clear( &p_sys->es );
348
349     /* Titles */
350     for (unsigned int i = 0; i < p_sys->i_title; i++)
351         vlc_input_title_Delete(p_sys->pp_title[i]);
352     TAB_CLEAN( p_sys->i_title, p_sys->pp_title );
353
354     free(p_sys);
355 }
356
357 /*****************************************************************************
358  * Elementary streams handling
359  *****************************************************************************/
360
361 struct es_out_sys_t {
362     demux_t *p_demux;
363 };
364
365 typedef struct  fmt_es_pair {
366     int         i_id;
367     es_out_id_t *p_es;
368 }               fmt_es_pair_t;
369
370 static int  findEsPairIndex( demux_sys_t *p_sys, int i_id )
371 {
372     for ( int i = 0; i < vlc_array_count(&p_sys->es); ++i ) {
373         if ( ((fmt_es_pair_t*)vlc_array_item_at_index(&p_sys->es, i))->i_id == i_id )
374             return i;
375     }
376     return -1;
377 }
378
379 static int  findEsPairIndexByEs( demux_sys_t *p_sys, es_out_id_t *p_es )
380 {
381     for ( int i = 0; i < vlc_array_count(&p_sys->es); ++i ) {
382         if ( ((fmt_es_pair_t*)vlc_array_item_at_index(&p_sys->es, i))->p_es == p_es )
383             return i;
384     }
385     return -1;
386 }
387
388 static es_out_id_t *esOutAdd( es_out_t *p_out, const es_format_t *p_fmt )
389 {
390     demux_sys_t *p_sys = p_out->p_sys->p_demux->p_sys;
391     es_format_t fmt;
392
393     es_format_Copy(&fmt, p_fmt);
394     switch (fmt.i_cat)
395     {
396     case VIDEO_ES:
397         if ( p_sys->i_video_stream != -1 && p_sys->i_video_stream != p_fmt->i_id )
398             fmt.i_priority = -2;
399         break ;
400     case AUDIO_ES:
401         if ( p_sys->i_audio_stream != -1 && p_sys->i_audio_stream != p_fmt->i_id )
402             fmt.i_priority = -2;
403         break ;
404     case SPU_ES:
405         break ;
406     }
407
408     es_out_id_t *p_es = es_out_Add( p_out->p_sys->p_demux->out, &fmt );
409     if ( p_fmt->i_id >= 0 ) {
410         /* Ensure we are not overriding anything */
411         int idx = findEsPairIndex(p_sys, p_fmt->i_id);
412         if ( idx == -1 ) {
413             fmt_es_pair_t *p_pair = malloc( sizeof(*p_pair) );
414             if ( likely(p_pair != NULL) ) {
415                 p_pair->i_id = p_fmt->i_id;
416                 p_pair->p_es = p_es;
417                 msg_Err( p_out->p_sys->p_demux, "Adding ES %d", p_fmt->i_id );
418                 vlc_array_append(&p_sys->es, p_pair);
419             }
420         }
421     }
422     es_format_Clean(&fmt);
423     return p_es;
424 }
425
426 static int esOutSend( es_out_t *p_out, es_out_id_t *p_es, block_t *p_block )
427 {
428     return es_out_Send( p_out->p_sys->p_demux->out, p_es, p_block );
429 }
430
431 static void esOutDel( es_out_t *p_out, es_out_id_t *p_es )
432 {
433     int idx = findEsPairIndexByEs( p_out->p_sys->p_demux->p_sys, p_es );
434     if (idx >= 0)
435     {
436         free( vlc_array_item_at_index( &p_out->p_sys->p_demux->p_sys->es, idx) );
437         vlc_array_remove(&p_out->p_sys->p_demux->p_sys->es, idx);
438     }
439     es_out_Del( p_out->p_sys->p_demux->out, p_es );
440 }
441
442 static int esOutControl( es_out_t *p_out, int i_query, va_list args )
443 {
444     return es_out_vaControl( p_out->p_sys->p_demux->out, i_query, args );
445 }
446
447 static void esOutDestroy( es_out_t *p_out )
448 {
449     for ( int i = 0; i < vlc_array_count(&p_out->p_sys->p_demux->p_sys->es); ++i )
450         free( vlc_array_item_at_index(&p_out->p_sys->p_demux->p_sys->es, i) );
451     vlc_array_clear(&p_out->p_sys->p_demux->p_sys->es);
452     free( p_out->p_sys );
453     free( p_out );
454 }
455
456 static es_out_t *esOutNew( demux_t *p_demux )
457 {
458     assert( vlc_array_count(&p_demux->p_sys->es) == 0 );
459     es_out_t    *p_out = malloc( sizeof(*p_out) );
460     if ( unlikely(p_out == NULL) )
461         return NULL;
462
463     p_out->pf_add       = &esOutAdd;
464     p_out->pf_control   = &esOutControl;
465     p_out->pf_del       = &esOutDel;
466     p_out->pf_destroy   = &esOutDestroy;
467     p_out->pf_send      = &esOutSend;
468
469     p_out->p_sys = malloc( sizeof(*p_out->p_sys) );
470     if ( unlikely( p_out->p_sys == NULL ) ) {
471         free( p_out );
472         return NULL;
473     }
474     p_out->p_sys->p_demux = p_demux;
475     return p_out;
476 }
477
478 /*****************************************************************************
479  * subpicture_updater_t functions:
480  *****************************************************************************/
481 static int subpictureUpdaterValidate( subpicture_t *p_subpic,
482                                       bool b_fmt_src, const video_format_t *p_fmt_src,
483                                       bool b_fmt_dst, const video_format_t *p_fmt_dst,
484                                       mtime_t i_ts )
485 {
486     VLC_UNUSED( b_fmt_src );
487     VLC_UNUSED( b_fmt_dst );
488     VLC_UNUSED( p_fmt_src );
489     VLC_UNUSED( p_fmt_dst );
490     VLC_UNUSED( i_ts );
491
492     subpicture_updater_sys_t *p_upd_sys = p_subpic->updater.p_sys;
493     bluray_overlay_t         *p_overlay = p_upd_sys->p_overlay;
494
495     vlc_mutex_lock(&p_overlay->lock);
496     int res = p_overlay->status == Outdated;
497     vlc_mutex_unlock(&p_overlay->lock);
498     return res;
499 }
500
501 /* This should probably be moved to subpictures.c afterward */
502 static subpicture_region_t* subpicture_region_Clone(subpicture_region_t *p_region_src)
503 {
504     if (!p_region_src)
505         return NULL;
506     subpicture_region_t *p_region_dst = subpicture_region_New(&p_region_src->fmt);
507     if (unlikely(!p_region_dst))
508         return NULL;
509
510     p_region_dst->i_x      = p_region_src->i_x;
511     p_region_dst->i_y      = p_region_src->i_y;
512     p_region_dst->i_align  = p_region_src->i_align;
513     p_region_dst->i_alpha  = p_region_src->i_alpha;
514
515     p_region_dst->psz_text = p_region_src->psz_text ? strdup(p_region_src->psz_text) : NULL;
516     p_region_dst->psz_html = p_region_src->psz_html ? strdup(p_region_src->psz_html) : NULL;
517     if (p_region_src->p_style != NULL) {
518         p_region_dst->p_style = malloc(sizeof(*p_region_dst->p_style));
519         p_region_dst->p_style = text_style_Copy(p_region_dst->p_style,
520                                                 p_region_src->p_style);
521     }
522
523     //Palette is already copied by subpicture_region_New, we just have to duplicate p_pixels
524     for (int i = 0; i < p_region_src->p_picture->i_planes; i++)
525         memcpy(p_region_dst->p_picture->p[i].p_pixels,
526                p_region_src->p_picture->p[i].p_pixels,
527                p_region_src->p_picture->p[i].i_lines * p_region_src->p_picture->p[i].i_pitch);
528     return p_region_dst;
529 }
530
531 static void subpictureUpdaterUpdate(subpicture_t *p_subpic,
532                                     const video_format_t *p_fmt_src,
533                                     const video_format_t *p_fmt_dst,
534                                     mtime_t i_ts)
535 {
536     VLC_UNUSED(p_fmt_src);
537     VLC_UNUSED(p_fmt_dst);
538     VLC_UNUSED(i_ts);
539     subpicture_updater_sys_t *p_upd_sys = p_subpic->updater.p_sys;
540     bluray_overlay_t         *p_overlay = p_upd_sys->p_overlay;
541
542     /*
543      * When this function is called, all p_subpic regions are gone.
544      * We need to duplicate our regions (stored internaly) to this subpic.
545      */
546     vlc_mutex_lock(&p_overlay->lock);
547
548     subpicture_region_t *p_src = p_overlay->p_regions;
549     if (!p_src)
550         return;
551
552     subpicture_region_t **p_dst = &(p_subpic->p_region);
553     while (p_src != NULL) {
554         *p_dst = subpicture_region_Clone(p_src);
555         if (*p_dst == NULL)
556             break;
557         p_dst = &((*p_dst)->p_next);
558         p_src = p_src->p_next;
559     }
560     if (*p_dst != NULL)
561         (*p_dst)->p_next = NULL;
562     p_overlay->status = Displayed;
563     vlc_mutex_unlock(&p_overlay->lock);
564 }
565
566 static void subpictureUpdaterDestroy(subpicture_t *p_subpic)
567 {
568     vlc_gc_decref(p_subpic->updater.p_sys->p_overlay);
569 }
570
571 /*****************************************************************************
572  * User input events:
573  *****************************************************************************/
574 static int onMouseEvent(vlc_object_t *p_vout, const char *psz_var, vlc_value_t old,
575                         vlc_value_t val, void *p_data)
576 {
577     demux_t     *p_demux = (demux_t*)p_data;
578     demux_sys_t *p_sys   = p_demux->p_sys;
579     mtime_t     now      = mdate();
580     VLC_UNUSED(old);
581     VLC_UNUSED(p_vout);
582
583     if (psz_var[6] == 'm')   //Mouse moved
584         bd_mouse_select(p_sys->bluray, now, val.coords.x, val.coords.y);
585     else if (psz_var[6] == 'c') {
586         bd_mouse_select(p_sys->bluray, now, val.coords.x, val.coords.y);
587         bd_user_input(p_sys->bluray, now, BD_VK_MOUSE_ACTIVATE);
588     } else {
589         assert(0);
590     }
591     return VLC_SUCCESS;
592 }
593
594 /*****************************************************************************
595  * libbluray overlay handling:
596  *****************************************************************************/
597 static void blurayCleanOverayStruct(gc_object_t *p_gc)
598 {
599     bluray_overlay_t *p_overlay = vlc_priv(p_gc, bluray_overlay_t);
600
601     /*
602      * This will be called when destroying the picture.
603      * Don't delete it again from here!
604      */
605     vlc_mutex_destroy(&p_overlay->lock);
606     subpicture_region_Delete(p_overlay->p_regions);
607     free(p_overlay);
608 }
609
610 static void blurayCloseAllOverlays(demux_t *p_demux)
611 {
612     demux_sys_t *p_sys = p_demux->p_sys;
613
614     p_demux->p_sys->current_overlay = -1;
615     if (p_sys->p_vout != NULL) {
616         for (int i = 0; i < 0; i++) {
617             if (p_sys->p_overlays[i] != NULL) {
618                 vout_FlushSubpictureChannel(p_sys->p_vout,
619                                             p_sys->p_overlays[i]->p_pic->i_channel);
620                 vlc_gc_decref(p_sys->p_overlays[i]);
621                 p_sys->p_overlays[i] = NULL;
622             }
623         }
624         var_DelCallback(p_sys->p_vout, "mouse-moved", &onMouseEvent, p_demux);
625         var_DelCallback(p_sys->p_vout, "mouse-clicked", &onMouseEvent, p_demux);
626         vlc_object_release(p_sys->p_vout);
627         p_sys->p_vout = NULL;
628     }
629 }
630
631 /*
632  * Mark the overlay as "ToDisplay" status.
633  * This will not send the overlay to the vout instantly, as the vout
634  * may not be acquired (not acquirable) yet.
635  * If is has already been acquired, the overlay has already been sent to it,
636  * therefore, we only flag the overlay as "Outdated"
637  */
638 static void blurayActivateOverlay(demux_t *p_demux, const BD_OVERLAY* const ov)
639 {
640     demux_sys_t *p_sys = p_demux->p_sys;
641
642     /*
643      * If the overlay is already displayed, mark the picture as outdated.
644      * We must NOT use vout_PutSubpicture if a picture is already displayed.
645      */
646     vlc_mutex_lock(&p_sys->p_overlays[ov->plane]->lock);
647     if ((p_sys->p_overlays[ov->plane]->status == Displayed ||
648             p_sys->p_overlays[ov->plane]->status == Outdated)
649             && p_sys->p_vout) {
650         p_sys->p_overlays[ov->plane]->status = Outdated;
651         vlc_mutex_unlock(&p_sys->p_overlays[ov->plane]->lock);
652         return;
653     }
654     /*
655      * Mark the overlay as available, but don't display it right now.
656      * the blurayDemuxMenu will send it to vout, as it may be unavailable when
657      * the overlay is computed
658      */
659     p_sys->current_overlay = ov->plane;
660     p_sys->p_overlays[ov->plane]->status = ToDisplay;
661     vlc_mutex_unlock(&p_sys->p_overlays[ov->plane]->lock);
662 }
663
664 static void blurayInitOverlay(demux_t *p_demux, const BD_OVERLAY* const ov)
665 {
666     demux_sys_t *p_sys = p_demux->p_sys;
667
668     assert(p_sys->p_overlays[ov->plane] == NULL);
669
670     p_sys->p_overlays[ov->plane] = calloc(1, sizeof(**p_sys->p_overlays));
671     if (unlikely(!p_sys->p_overlays[ov->plane]))
672         return;
673
674     subpicture_updater_sys_t *p_upd_sys = malloc(sizeof(*p_upd_sys));
675     if (unlikely(!p_upd_sys)) {
676         free(p_sys->p_overlays[ov->plane]);
677         p_sys->p_overlays[ov->plane] = NULL;
678         return;
679     }
680     vlc_gc_init(p_sys->p_overlays[ov->plane], blurayCleanOverayStruct);
681     /* Incrementing refcounter: vout + demux */
682     vlc_gc_incref(p_sys->p_overlays[ov->plane]);
683
684     p_upd_sys->p_overlay = p_sys->p_overlays[ov->plane];
685     subpicture_updater_t updater = {
686         .pf_validate = subpictureUpdaterValidate,
687         .pf_update   = subpictureUpdaterUpdate,
688         .pf_destroy  = subpictureUpdaterDestroy,
689         .p_sys       = p_upd_sys,
690     };
691     p_sys->p_overlays[ov->plane]->p_pic = subpicture_New(&updater);
692     p_sys->p_overlays[ov->plane]->p_pic->i_original_picture_width = ov->w;
693     p_sys->p_overlays[ov->plane]->p_pic->i_original_picture_height = ov->h;
694     p_sys->p_overlays[ov->plane]->p_pic->b_ephemer = true;
695     p_sys->p_overlays[ov->plane]->p_pic->b_absolute = true;
696 }
697
698 /**
699  * Destroy every regions in the subpicture.
700  * This is done in two steps:
701  * - Wiping our private regions list
702  * - Flagging the overlay as outdated, so the changes are replicated from
703  *   the subpicture_updater_t::pf_update
704  * This doesn't destroy the subpicture, as the overlay may be used again by libbluray.
705  */
706 static void blurayClearOverlay(demux_t *p_demux, const BD_OVERLAY* const ov)
707 {
708     demux_sys_t *p_sys = p_demux->p_sys;
709
710     vlc_mutex_lock(&p_sys->p_overlays[ov->plane]->lock);
711
712     subpicture_region_ChainDelete(p_sys->p_overlays[ov->plane]->p_regions);
713     p_sys->p_overlays[ov->plane]->p_regions = NULL;
714     p_sys->p_overlays[ov->plane]->status = Outdated;
715     vlc_mutex_unlock(&p_sys->p_overlays[ov->plane]->lock);
716 }
717
718 /*
719  * This will draw to the overlay by adding a region to our region list
720  * This will have to be copied to the subpicture used to render the overlay.
721  */
722 static void blurayDrawOverlay(demux_t *p_demux, const BD_OVERLAY* const ov)
723 {
724     demux_sys_t *p_sys = p_demux->p_sys;
725
726     /*
727      * Compute a subpicture_region_t.
728      * It will be copied and sent to the vout later.
729      */
730     if (!ov->img)
731         return;
732
733     vlc_mutex_lock(&p_sys->p_overlays[ov->plane]->lock);
734
735     /* Find a region to update */
736     subpicture_region_t *p_reg = p_sys->p_overlays[ov->plane]->p_regions;
737     subpicture_region_t *p_last = NULL;
738     while (p_reg != NULL) {
739         p_last = p_reg;
740         if (p_reg->i_x == ov->x && p_reg->i_y == ov->y &&
741                 p_reg->fmt.i_width == ov->w && p_reg->fmt.i_height == ov->h)
742             break;
743         p_reg = p_reg->p_next;
744     }
745
746     /* If there is no region to update, create a new one. */
747     if (!p_reg) {
748         video_format_t fmt;
749         video_format_Init(&fmt, 0);
750         video_format_Setup(&fmt, VLC_CODEC_YUVP, ov->w, ov->h, 1, 1);
751
752         p_reg = subpicture_region_New(&fmt);
753         p_reg->i_x = ov->x;
754         p_reg->i_y = ov->y;
755         /* Append it to our list. */
756         if (p_last != NULL)
757             p_last->p_next = p_reg;
758         else /* If we don't have a last region, then our list empty */
759             p_sys->p_overlays[ov->plane]->p_regions = p_reg;
760     }
761
762     /* Now we can update the region, regardless it's an update or an insert */
763     const BD_PG_RLE_ELEM *img = ov->img;
764     for (int y = 0; y < ov->h; y++) {
765         for (int x = 0; x < ov->w;) {
766             memset(p_reg->p_picture->p[0].p_pixels +
767                    y * p_reg->p_picture->p[0].i_pitch + x,
768                    img->color, img->len);
769             x += img->len;
770             img++;
771         }
772     }
773     if (ov->palette) {
774         p_reg->fmt.p_palette->i_entries = 256;
775         for (int i = 0; i < 256; ++i) {
776             p_reg->fmt.p_palette->palette[i][0] = ov->palette[i].Y;
777             p_reg->fmt.p_palette->palette[i][1] = ov->palette[i].Cb;
778             p_reg->fmt.p_palette->palette[i][2] = ov->palette[i].Cr;
779             p_reg->fmt.p_palette->palette[i][3] = ov->palette[i].T;
780         }
781     }
782     vlc_mutex_unlock(&p_sys->p_overlays[ov->plane]->lock);
783     /*
784      * /!\ The region is now stored in our internal list, but not in the subpicture /!\
785      */
786 }
787
788 static void blurayOverlayProc(void *ptr, const BD_OVERLAY *const overlay)
789 {
790     demux_t *p_demux = (demux_t*)ptr;
791
792     if (!overlay) {
793         msg_Info(p_demux, "Closing overlay.");
794         blurayCloseAllOverlays(p_demux);
795         return;
796     }
797     switch (overlay->cmd) {
798         case BD_OVERLAY_INIT:
799             msg_Info(p_demux, "Initializing overlay");
800             blurayInitOverlay(p_demux, overlay);
801             break;
802         case BD_OVERLAY_CLEAR:
803             blurayClearOverlay(p_demux, overlay);
804             break;
805         case BD_OVERLAY_FLUSH:
806             blurayActivateOverlay(p_demux, overlay);
807             break;
808         case BD_OVERLAY_DRAW:
809             blurayDrawOverlay(p_demux, overlay);
810             break;
811         default:
812             msg_Warn(p_demux, "Unknown BD overlay command: %u", overlay->cmd);
813             break;
814     }
815 }
816
817 static void bluraySendOverlayToVout(demux_t *p_demux)
818 {
819     demux_sys_t *p_sys = p_demux->p_sys;
820
821     assert(p_sys->current_overlay >= 0 &&
822            p_sys->p_overlays[p_sys->current_overlay] != NULL &&
823            p_sys->p_overlays[p_sys->current_overlay]->p_pic != NULL);
824
825     p_sys->p_overlays[p_sys->current_overlay]->p_pic->i_start =
826         p_sys->p_overlays[p_sys->current_overlay]->p_pic->i_stop = mdate();
827     p_sys->p_overlays[p_sys->current_overlay]->p_pic->i_channel =
828         vout_RegisterSubpictureChannel(p_sys->p_vout);
829     /*
830      * After this point, the picture should not be accessed from the demux thread,
831      * as it is held by the vout thread.
832      * This must be done only once per subpicture, ie. only once between each
833      * blurayInitOverlay & blurayCloseOverlay call.
834      */
835     vout_PutSubpicture(p_sys->p_vout, p_sys->p_overlays[p_sys->current_overlay]->p_pic);
836     /*
837      * Mark the picture as Outdated, as it contains no region for now.
838      * This will make the subpicture_updater_t call pf_update
839      */
840     p_sys->p_overlays[p_sys->current_overlay]->status = Outdated;
841 }
842
843 static int blurayInitTitles(demux_t *p_demux )
844 {
845     demux_sys_t *p_sys = p_demux->p_sys;
846
847     /* get and set the titles */
848     unsigned i_title = bd_get_titles(p_sys->bluray, TITLES_RELEVANT, 60);
849     int64_t duration = 0;
850
851     for (unsigned int i = 0; i < i_title; i++) {
852         input_title_t *t = vlc_input_title_New();
853         if (!t)
854             break;
855
856         BLURAY_TITLE_INFO *title_info = bd_get_title_info(p_sys->bluray, i, 0);
857         if (!title_info)
858             break;
859         t->i_length = FROM_TICKS(title_info->duration);
860
861         if (t->i_length > duration) {
862             duration = t->i_length;
863             p_sys->i_longest_title = i;
864         }
865
866         for ( unsigned int j = 0; j < title_info->chapter_count; j++) {
867             seekpoint_t *s = vlc_seekpoint_New();
868             if (!s)
869                 break;
870             s->i_time_offset = title_info->chapters[j].offset;
871
872             TAB_APPEND( t->i_seekpoint, t->seekpoint, s );
873         }
874         TAB_APPEND( p_sys->i_title, p_sys->pp_title, t );
875         bd_free_title_info(title_info);
876     }
877     return VLC_SUCCESS;
878 }
879
880 static void blurayResetParser( demux_t *p_demux )
881 {
882     /*
883      * This is a hack and will have to be removed.
884      * The parser should be flushed, and not destroy/created each time
885      * we are changing title.
886      */
887     demux_sys_t *p_sys = p_demux->p_sys;
888     if (p_sys->p_parser)
889         stream_Delete(p_sys->p_parser);
890     p_sys->p_parser = stream_DemuxNew(p_demux, "ts", p_sys->p_out);
891     if (!p_sys->p_parser) {
892         msg_Err(p_demux, "Failed to create TS demuxer");
893     }
894 }
895
896 static void blurayUpdateTitle(demux_t *p_demux, unsigned i_title)
897 {
898     blurayResetParser(p_demux);
899     if (i_title >= p_demux->p_sys->i_title)
900         return;
901
902     /* read title info and init some values */
903     p_demux->info.i_title = i_title;
904     p_demux->info.i_seekpoint = 0;
905     p_demux->info.i_update |= INPUT_UPDATE_TITLE | INPUT_UPDATE_SEEKPOINT;
906 }
907
908 /*****************************************************************************
909  * bluraySetTitle: select new BD title
910  *****************************************************************************/
911 static int bluraySetTitle(demux_t *p_demux, int i_title)
912 {
913     demux_sys_t *p_sys = p_demux->p_sys;
914
915     /* Looking for the main title, ie the longest duration */
916     if (i_title < 0)
917         i_title = p_sys->i_longest_title;
918     else if ((unsigned)i_title > p_sys->i_title)
919         return VLC_EGENERIC;
920
921     msg_Dbg( p_demux, "Selecting Title %i", i_title);
922
923     /* Select Blu-Ray title */
924     if (bd_select_title(p_demux->p_sys->bluray, i_title) == 0 ) {
925         msg_Err(p_demux, "cannot select bd title '%d'", p_demux->info.i_title);
926         return VLC_EGENERIC;
927     }
928     blurayUpdateTitle( p_demux, i_title );
929
930     return VLC_SUCCESS;
931 }
932
933
934 /*****************************************************************************
935  * blurayControl: handle the controls
936  *****************************************************************************/
937 static int blurayControl(demux_t *p_demux, int query, va_list args)
938 {
939     demux_sys_t *p_sys = p_demux->p_sys;
940     bool     *pb_bool;
941     int64_t  *pi_64;
942
943     switch (query) {
944         case DEMUX_CAN_SEEK:
945         case DEMUX_CAN_PAUSE:
946         case DEMUX_CAN_CONTROL_PACE:
947              pb_bool = (bool*)va_arg( args, bool * );
948              *pb_bool = true;
949              break;
950
951         case DEMUX_GET_PTS_DELAY:
952             pi_64 = (int64_t*)va_arg( args, int64_t * );
953             *pi_64 =
954                 INT64_C(1000) * var_InheritInteger( p_demux, "disc-caching" );
955             break;
956
957         case DEMUX_SET_PAUSE_STATE:
958             /* Nothing to do */
959             break;
960
961         case DEMUX_SET_TITLE:
962         {
963             int i_title = (int)va_arg( args, int );
964             if (bluraySetTitle(p_demux, i_title) != VLC_SUCCESS)
965                 return VLC_EGENERIC;
966             break;
967         }
968         case DEMUX_SET_SEEKPOINT:
969         {
970             int i_chapter = (int)va_arg( args, int );
971             bd_seek_chapter( p_sys->bluray, i_chapter );
972             p_demux->info.i_update = INPUT_UPDATE_SEEKPOINT;
973             break;
974         }
975
976         case DEMUX_GET_TITLE_INFO:
977         {
978             input_title_t ***ppp_title = (input_title_t***)va_arg( args, input_title_t*** );
979             int *pi_int             = (int*)va_arg( args, int* );
980             int *pi_title_offset    = (int*)va_arg( args, int* );
981             int *pi_chapter_offset  = (int*)va_arg( args, int* );
982
983             /* */
984             *pi_title_offset   = 0;
985             *pi_chapter_offset = 0;
986
987             /* Duplicate local title infos */
988             *pi_int = p_sys->i_title;
989             *ppp_title = calloc( p_sys->i_title, sizeof(input_title_t **) );
990             for( unsigned int i = 0; i < p_sys->i_title; i++ )
991                 (*ppp_title)[i] = vlc_input_title_Duplicate( p_sys->pp_title[i]);
992
993             return VLC_SUCCESS;
994         }
995
996         case DEMUX_GET_LENGTH:
997         {
998             int64_t *pi_length = (int64_t*)va_arg(args, int64_t *);
999             *pi_length = p_demux->info.i_title < p_sys->i_title ? CUR_LENGTH : 0;
1000             return VLC_SUCCESS;
1001         }
1002         case DEMUX_SET_TIME:
1003         {
1004             int64_t i_time = (int64_t)va_arg(args, int64_t);
1005             bd_seek_time(p_sys->bluray, TO_TICKS(i_time));
1006             return VLC_SUCCESS;
1007         }
1008         case DEMUX_GET_TIME:
1009         {
1010             int64_t *pi_time = (int64_t*)va_arg(args, int64_t *);
1011             *pi_time = (int64_t)FROM_TICKS(bd_tell_time(p_sys->bluray));
1012             return VLC_SUCCESS;
1013         }
1014
1015         case DEMUX_GET_POSITION:
1016         {
1017             double *pf_position = (double*)va_arg( args, double * );
1018             *pf_position = p_demux->info.i_title < p_sys->i_title ?
1019                         (double)FROM_TICKS(bd_tell_time(p_sys->bluray))/CUR_LENGTH : 0.0;
1020             return VLC_SUCCESS;
1021         }
1022         case DEMUX_SET_POSITION:
1023         {
1024             double f_position = (double)va_arg(args, double);
1025             bd_seek_time(p_sys->bluray, TO_TICKS(f_position*CUR_LENGTH));
1026             return VLC_SUCCESS;
1027         }
1028
1029         case DEMUX_GET_META:
1030         {
1031             vlc_meta_t *p_meta = (vlc_meta_t *) va_arg (args, vlc_meta_t*);
1032             const META_DL *meta = p_sys->p_meta;
1033             if (meta == NULL)
1034                 return VLC_EGENERIC;
1035
1036             if (!EMPTY_STR(meta->di_name)) vlc_meta_SetTitle(p_meta, meta->di_name);
1037
1038             if (!EMPTY_STR(meta->language_code)) vlc_meta_AddExtra(p_meta, "Language", meta->language_code);
1039             if (!EMPTY_STR(meta->filename)) vlc_meta_AddExtra(p_meta, "Filename", meta->filename);
1040             if (!EMPTY_STR(meta->di_alternative)) vlc_meta_AddExtra(p_meta, "Alternative", meta->di_alternative);
1041
1042             // if (meta->di_set_number > 0) vlc_meta_SetTrackNum(p_meta, meta->di_set_number);
1043             // if (meta->di_num_sets > 0) vlc_meta_AddExtra(p_meta, "Discs numbers in Set", meta->di_num_sets);
1044
1045             if (meta->thumb_count > 0 && meta->thumbnails) {
1046                 vlc_meta_SetArtURL(p_meta, meta->thumbnails[0].path);
1047             }
1048
1049             return VLC_SUCCESS;
1050         }
1051
1052         case DEMUX_CAN_RECORD:
1053         case DEMUX_GET_FPS:
1054         case DEMUX_SET_GROUP:
1055         case DEMUX_HAS_UNSUPPORTED_META:
1056         case DEMUX_GET_ATTACHMENTS:
1057             return VLC_EGENERIC;
1058         default:
1059             msg_Warn( p_demux, "unimplemented query (%d) in control", query );
1060             return VLC_EGENERIC;
1061     }
1062     return VLC_SUCCESS;
1063 }
1064
1065 static void     blurayUpdateCurrentClip( demux_t *p_demux, uint32_t clip )
1066 {
1067     if (clip == 0xFF)
1068         return ;
1069     demux_sys_t *p_sys = p_demux->p_sys;
1070
1071     p_sys->i_current_clip = clip;
1072     BLURAY_TITLE_INFO   *info = bd_get_title_info(p_sys->bluray,
1073                                         bd_get_current_title(p_sys->bluray), 0);
1074     if ( info == NULL )
1075         return ;
1076     /* Let's assume a single video track for now.
1077      * This may brake later, but it's enough for now.
1078      */
1079     assert(info->clips[p_sys->i_current_clip].video_stream_count >= 1);
1080     p_sys->i_video_stream = info->clips[p_sys->i_current_clip].video_streams[0].pid;
1081     bd_free_title_info(info);
1082 }
1083
1084 static void blurayHandleEvent( demux_t *p_demux, const BD_EVENT *e )
1085 {
1086     demux_sys_t     *p_sys = p_demux->p_sys;
1087
1088     switch (e->event)
1089     {
1090         case BD_EVENT_TITLE:
1091             blurayUpdateTitle(p_demux, e->param);
1092             break;
1093         case BD_EVENT_PLAYITEM:
1094             blurayUpdateCurrentClip(p_demux, e->param);
1095             break;
1096         case BD_EVENT_AUDIO_STREAM:
1097         {
1098             if ( e->param == 0xFF )
1099                 break ;
1100             BLURAY_TITLE_INFO   *info = bd_get_title_info(p_sys->bluray,
1101                                        bd_get_current_title(p_sys->bluray), 0);
1102             if ( info == NULL )
1103                 break ;
1104             /* The param we get is the real stream id, not an index, ie. it starts from 1 */
1105             int pid = info->clips[p_sys->i_current_clip].audio_streams[e->param - 1].pid;
1106             int idx = findEsPairIndex( p_sys, pid );
1107             if ( idx >= 0 ) {
1108                 es_out_id_t *p_es = vlc_array_item_at_index(&p_sys->es, idx);
1109                 es_out_Control( p_demux->out, ES_OUT_SET_ES, p_es );
1110             }
1111             bd_free_title_info( info );
1112             p_sys->i_audio_stream = pid;
1113             break ;
1114         }
1115         case BD_EVENT_CHAPTER:
1116             p_demux->info.i_update |= INPUT_UPDATE_SEEKPOINT;
1117             p_demux->info.i_seekpoint = e->param;
1118             break;
1119         case BD_EVENT_ANGLE:
1120         case BD_EVENT_IG_STREAM:
1121         default:
1122             msg_Warn( p_demux, "event: %d param: %d", e->event, e->param );
1123             break;
1124     }
1125 }
1126
1127 static void blurayHandleEvents( demux_t *p_demux )
1128 {
1129     BD_EVENT e;
1130
1131     while (bd_get_event(p_demux->p_sys->bluray, &e))
1132     {
1133         blurayHandleEvent(p_demux, &e);
1134     }
1135 }
1136
1137 #define BD_TS_PACKET_SIZE (192)
1138 #define NB_TS_PACKETS (200)
1139
1140 static int blurayDemux(demux_t *p_demux)
1141 {
1142     demux_sys_t *p_sys = p_demux->p_sys;
1143
1144     block_t *p_block = block_New(p_demux, NB_TS_PACKETS * (int64_t)BD_TS_PACKET_SIZE);
1145     if (!p_block) {
1146         return -1;
1147     }
1148
1149     int nread = -1;
1150     if (p_sys->b_menu == false) {
1151         blurayHandleEvents(p_demux);
1152         nread = bd_read(p_sys->bluray, p_block->p_buffer,
1153                         NB_TS_PACKETS * BD_TS_PACKET_SIZE);
1154         if (nread < 0) {
1155             block_Release(p_block);
1156             return nread;
1157         }
1158     } else {
1159         BD_EVENT e;
1160         nread = bd_read_ext(p_sys->bluray, p_block->p_buffer,
1161                             NB_TS_PACKETS * BD_TS_PACKET_SIZE, &e);
1162         if (nread < 0)
1163         {
1164             block_Release(p_block);
1165             return -1;
1166         }
1167         if (nread == 0) {
1168             if (e.event == BD_EVENT_NONE)
1169                 msg_Info(p_demux, "We reached the end of a title");
1170             else
1171                 blurayHandleEvent(p_demux, &e);
1172             block_Release(p_block);
1173             return 1;
1174         }
1175         if (p_sys->current_overlay != -1) {
1176             vlc_mutex_lock(&p_sys->p_overlays[p_sys->current_overlay]->lock);
1177             if (p_sys->p_overlays[p_sys->current_overlay]->status == ToDisplay) {
1178                 vlc_mutex_unlock(&p_sys->p_overlays[p_sys->current_overlay]->lock);
1179                 if (p_sys->p_vout == NULL)
1180                     p_sys->p_vout = input_GetVout(p_sys->p_input);
1181                 if (p_sys->p_vout != NULL) {
1182                     var_AddCallback(p_sys->p_vout, "mouse-moved", &onMouseEvent, p_demux);
1183                     var_AddCallback(p_sys->p_vout, "mouse-clicked", &onMouseEvent, p_demux);
1184                     bluraySendOverlayToVout(p_demux);
1185                 }
1186             } else
1187                 vlc_mutex_unlock(&p_sys->p_overlays[p_sys->current_overlay]->lock);
1188         }
1189     }
1190
1191     p_block->i_buffer = nread;
1192
1193     stream_DemuxSend(p_sys->p_parser, p_block);
1194
1195     return 1;
1196 }