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