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