libbluray
 All Classes Files Functions Macros
bluray.h
Go to the documentation of this file.
1 /*
2  * This file is part of libbluray
3  * Copyright (C) 2009-2010 Obliter0n
4  * Copyright (C) 2009-2010 John Stebbins
5  * Copyright (C) 2010 hpi1
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library. If not, see
19  * <http://www.gnu.org/licenses/>.
20  */
21 
22 #ifndef BLURAY_H_
23 #define BLURAY_H_
24 
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28 
34 #include <stdint.h>
35 
36 #define TITLES_ALL 0
37 #define TITLES_FILTER_DUP_TITLE 0x01
38 #define TITLES_FILTER_DUP_CLIP 0x02
40 #define TITLES_RELEVANT \
41  (TITLES_FILTER_DUP_TITLE | TITLES_FILTER_DUP_CLIP)
44 typedef struct bluray BLURAY;
45 
46 typedef enum {
47  BLURAY_STREAM_TYPE_VIDEO_MPEG1 = 0x01,
48  BLURAY_STREAM_TYPE_VIDEO_MPEG2 = 0x02,
49  BLURAY_STREAM_TYPE_AUDIO_MPEG1 = 0x03,
50  BLURAY_STREAM_TYPE_AUDIO_MPEG2 = 0x04,
51  BLURAY_STREAM_TYPE_AUDIO_LPCM = 0x80,
52  BLURAY_STREAM_TYPE_AUDIO_AC3 = 0x81,
53  BLURAY_STREAM_TYPE_AUDIO_DTS = 0x82,
54  BLURAY_STREAM_TYPE_AUDIO_TRUHD = 0x83,
55  BLURAY_STREAM_TYPE_AUDIO_AC3PLUS = 0x84,
56  BLURAY_STREAM_TYPE_AUDIO_DTSHD = 0x85,
57  BLURAY_STREAM_TYPE_AUDIO_DTSHD_MASTER = 0x86,
58  BLURAY_STREAM_TYPE_VIDEO_VC1 = 0xea,
59  BLURAY_STREAM_TYPE_VIDEO_H264 = 0x1b,
60  BLURAY_STREAM_TYPE_SUB_PG = 0x90,
61  BLURAY_STREAM_TYPE_SUB_IG = 0x91,
62  BLURAY_STREAM_TYPE_SUB_TEXT = 0x92,
63  BLURAY_STREAM_TYPE_AUDIO_AC3PLUS_SECONDARY = 0xa1,
64  BLURAY_STREAM_TYPE_AUDIO_DTSHD_SECONDARY = 0xa2
65 } bd_stream_type_e;
66 
67 typedef enum {
68  BLURAY_VIDEO_FORMAT_480I = 1, // ITU-R BT.601-5
69  BLURAY_VIDEO_FORMAT_576I = 2, // ITU-R BT.601-4
70  BLURAY_VIDEO_FORMAT_480P = 3, // SMPTE 293M
71  BLURAY_VIDEO_FORMAT_1080I = 4, // SMPTE 274M
72  BLURAY_VIDEO_FORMAT_720P = 5, // SMPTE 296M
73  BLURAY_VIDEO_FORMAT_1080P = 6, // SMPTE 274M
74  BLURAY_VIDEO_FORMAT_576P = 7 // ITU-R BT.1358
75 } bd_video_format_e;
76 
77 typedef enum {
78  BLURAY_VIDEO_RATE_24000_1001 = 1, // 23.976
79  BLURAY_VIDEO_RATE_24 = 2,
80  BLURAY_VIDEO_RATE_25 = 3,
81  BLURAY_VIDEO_RATE_30000_1001 = 4, // 29.97
82  BLURAY_VIDEO_RATE_50 = 6,
83  BLURAY_VIDEO_RATE_60000_1001 = 7 // 59.94
84 } bd_video_rate_e;
85 
86 typedef enum {
87  BLURAY_ASPECT_RATIO_4_3 = 2,
88  BLURAY_ASPECT_RATIO_16_9 = 3
89 } bd_video_aspect_e;
90 
91 typedef enum {
92  BLURAY_AUDIO_FORMAT_MONO = 1,
93  BLURAY_AUDIO_FORMAT_STEREO = 3,
94  BLURAY_AUDIO_FORMAT_MULTI_CHAN = 6,
95  BLURAY_AUDIO_FORMAT_COMBO = 12 // Stereo ac3/dts,
96 } bd_audio_format_e;
97  // multi mlp/dts-hd
98 
99 typedef enum {
100  BLURAY_AUDIO_RATE_48 = 1,
101  BLURAY_AUDIO_RATE_96 = 4,
102  BLURAY_AUDIO_RATE_192 = 5,
103  BLURAY_AUDIO_RATE_192_COMBO = 12, // 48 or 96 ac3/dts
104  // 192 mpl/dts-hd
105  BLURAY_AUDIO_RATE_96_COMBO = 14 // 48 ac3/dts
106  // 96 mpl/dts-hd
107 } bd_audio_rate_e;
108 
109 typedef enum {
110  BLURAY_TEXT_CHAR_CODE_UTF8 = 0x01,
111  BLURAY_TEXT_CHAR_CODE_UTF16BE = 0x02,
112  BLURAY_TEXT_CHAR_CODE_SHIFT_JIS = 0x03,
113  BLURAY_TEXT_CHAR_CODE_EUC_KR = 0x04,
114  BLURAY_TEXT_CHAR_CODE_GB18030_20001 = 0x05,
115  BLURAY_TEXT_CHAR_CODE_CN_GB = 0x06,
116  BLURAY_TEXT_CHAR_CODE_BIG5 = 0x07
117 } bd_char_code_e;
118 
119 typedef enum {
120  BLURAY_STILL_NONE = 0x00,
121  BLURAY_STILL_TIME = 0x01,
122  BLURAY_STILL_INFINITE = 0x02,
123 } bd_still_mode_e;
124 
125 typedef struct bd_stream_info {
126  uint8_t coding_type;
127  uint8_t format;
128  uint8_t rate;
129  uint8_t char_code;
130  uint8_t lang[4];
131  uint16_t pid;
132  uint8_t aspect;
133  uint8_t subpath_id;
135 
136 typedef struct bd_clip {
137  uint32_t pkt_count;
138  uint8_t still_mode;
139  uint16_t still_time; /* seconds */
140  uint8_t video_stream_count;
141  uint8_t audio_stream_count;
142  uint8_t pg_stream_count;
143  uint8_t ig_stream_count;
144  uint8_t sec_audio_stream_count;
145  uint8_t sec_video_stream_count;
146  BLURAY_STREAM_INFO *video_streams;
147  BLURAY_STREAM_INFO *audio_streams;
148  BLURAY_STREAM_INFO *pg_streams;
149  BLURAY_STREAM_INFO *ig_streams;
150  BLURAY_STREAM_INFO *sec_audio_streams;
151  BLURAY_STREAM_INFO *sec_video_streams;
152 
153  uint64_t start_time;
154  uint64_t in_time;
155  uint64_t out_time;
157 
158 typedef struct bd_chapter {
159  uint32_t idx;
160  uint64_t start;
161  uint64_t duration;
162  uint64_t offset;
163  unsigned clip_ref;
165 
166 typedef struct bd_mark {
167  uint32_t idx;
168  int type;
169  uint64_t start;
170  uint64_t duration;
171  uint64_t offset;
172  unsigned clip_ref;
174 
175 typedef struct bd_title_info {
176  uint32_t idx;
177  uint32_t playlist;
178  uint64_t duration;
179  uint32_t clip_count;
180  uint8_t angle_count;
181  uint32_t chapter_count;
182  BLURAY_CLIP_INFO *clips;
183  BLURAY_TITLE_CHAPTER *chapters;
184 
185  uint32_t mark_count;
186  BLURAY_TITLE_MARK *marks;
188 
189 typedef struct bd_sound_effect {
190  uint8_t num_channels; /* 1 - mono, 2 - stereo */
191  uint32_t num_frames;
192  const int16_t *samples; /* 48000 Hz, 16 bit LPCM. interleaved if stereo */
194 
199 void bd_get_version(int *major, int *minor, int *micro);
200 
212 uint32_t bd_get_titles(BLURAY *bd, uint8_t flags, uint32_t min_title_length);
213 
222 int bd_get_main_title(BLURAY *bd);
223 
233 BLURAY_TITLE_INFO* bd_get_title_info(BLURAY *bd, uint32_t title_idx, unsigned angle);
234 
244 BLURAY_TITLE_INFO* bd_get_playlist_info(BLURAY *bd, uint32_t playlist, unsigned angle);
245 
252 void bd_free_title_info(BLURAY_TITLE_INFO *title_info);
253 
261 BLURAY *bd_open(const char* device_path, const char* keyfile_path);
262 
268 void bd_close(BLURAY *bd);
269 
277 int64_t bd_seek(BLURAY *bd, uint64_t pos);
278 
287 int64_t bd_seek_time(BLURAY *bd, uint64_t tick);
288 
298 int bd_read(BLURAY *bd, unsigned char *buf, int len);
299 
307 int bd_read_skip_still(BLURAY *bd);
308 
317 int64_t bd_seek_chapter(BLURAY *bd, unsigned chapter);
318 
327 int64_t bd_chapter_pos(BLURAY *bd, unsigned chapter);
328 
336 uint32_t bd_get_current_chapter(BLURAY *bd);
337 
346 int64_t bd_seek_mark(BLURAY *bd, unsigned mark);
347 
356 int64_t bd_seek_playitem(BLURAY *bd, unsigned clip_ref);
357 
366 int bd_select_playlist(BLURAY *bd, uint32_t playlist);
367 
376 int bd_select_title(BLURAY *bd, uint32_t title);
377 
386 int bd_select_angle(BLURAY *bd, unsigned angle);
387 
395 void bd_seamless_angle_change(BLURAY *bd, unsigned angle);
396 
406 uint64_t bd_get_title_size(BLURAY *bd);
407 
415 uint32_t bd_get_current_title(BLURAY *bd);
416 
424 unsigned bd_get_current_angle(BLURAY *bd);
425 
433 uint64_t bd_tell(BLURAY *bd);
434 
442 uint64_t bd_tell_time(BLURAY *bd);
443 
457 #define BLURAY_PG_TEXTST_STREAM 1
458 
459 void bd_select_stream(BLURAY *bd, uint32_t stream_type, uint32_t stream_id, uint32_t enable_flag);
460 
461 /*
462  * Disc info
463  */
464 
465 /* AACS error codes */
466 #define BD_AACS_CORRUPTED_DISC -1
467 #define BD_AACS_NO_CONFIG -2
468 #define BD_AACS_NO_PK -3
469 #define BD_AACS_NO_CERT -4
470 #define BD_AACS_CERT_REVOKED -5
471 #define BD_AACS_MMC_FAILED -6
472 
473 typedef struct {
474  uint8_t bluray_detected;
476  uint8_t first_play_supported;
477  uint8_t top_menu_supported;
478 
479  uint32_t num_hdmv_titles;
480  uint32_t num_bdj_titles;
481  uint32_t num_unsupported_titles;
482 
483  uint8_t aacs_detected;
484  uint8_t libaacs_detected;
485  uint8_t aacs_handled;
486 
487  uint8_t bdplus_detected;
488  uint8_t libbdplus_detected;
489  uint8_t bdplus_handled;
490 
491  /* aacs error code */
492  int aacs_error_code;
493  /* aacs MKB version */
494  int aacs_mkbv;
495 
496  /* Disc ID */
497  uint8_t disc_id[20];
498 
499  uint8_t bdj_detected; /* 1 if disc uses BD-J */
500  uint8_t bdj_supported; /* 1 if BD-J support was compiled in */
501  uint8_t libjvm_detected; /* 1 if usable Java VM was found */
502  uint8_t bdj_handled; /* 1 if usable Java VM + libbluray.jar was found */
503 
504  /* BD+ content code generation */
505  uint8_t bdplus_gen;
506  /* BD+ content code relese date */
507  uint32_t bdplus_date; /* (year << 16) | (month << 8) | day */
509 
517 const BLURAY_DISC_INFO *bd_get_disc_info(BLURAY*);
518 
519 /*
520  * player settings
521  */
522 
523 typedef enum {
524  BLURAY_PLAYER_SETTING_PARENTAL = 13, /* Age for parental control (years) */
525  BLURAY_PLAYER_SETTING_AUDIO_CAP = 15, /* Player capability for audio (bit mask) */
526  BLURAY_PLAYER_SETTING_AUDIO_LANG = 16, /* Initial audio language: ISO 639-2 string, ex. "eng" */
527  BLURAY_PLAYER_SETTING_PG_LANG = 17, /* Initial PG/SPU language: ISO 639-2 string, ex. "eng" */
528  BLURAY_PLAYER_SETTING_MENU_LANG = 18, /* Initial menu language: ISO 639-2 string, ex. "eng" */
529  BLURAY_PLAYER_SETTING_COUNTRY_CODE = 19, /* Player country code: ISO 3166-1 string, ex. "de" */
530  BLURAY_PLAYER_SETTING_REGION_CODE = 20, /* Player region code: 1 - region A, 2 - B, 4 - C */
531  BLURAY_PLAYER_SETTING_OUTPUT_PREFER = 21, /* output mode preference: 0 - 2D, 1 - 3D */
532  BLURAY_PLAYER_SETTING_DISPLAY_CAP = 23, /* Display capability (bit mask) */
533  BLURAY_PLAYER_SETTING_3D_CAP = 24, /* 3D capability (bit mask) */
534  BLURAY_PLAYER_SETTING_VIDEO_CAP = 29, /* Player capability for video (bit mask) */
535  BLURAY_PLAYER_SETTING_TEXT_CAP = 30, /* Player capability for text subtitle (bit mask) */
536  BLURAY_PLAYER_SETTING_PLAYER_PROFILE = 31, /* Profile1: 0, Profile1+: 1, Profile2: 3, Profile3: 8 */
537 
538  BLURAY_PLAYER_SETTING_DECODE_PG = 0x100, /* enable/disable PG (subtitle) decoder */
539 } bd_player_setting;
540 
551 int bd_set_player_setting(BLURAY *bd, uint32_t idx, uint32_t value);
552 int bd_set_player_setting_str(BLURAY *bd, uint32_t idx, const char *s);
553 
554 /*
555  * Java
556  */
557 int bd_start_bdj(BLURAY *bd, const char* start_object); // start BD-J from the specified BD-J object (should be a 5 character string)
558 void bd_stop_bdj(BLURAY *bd); // shutdown BD-J and clean up resources
559 
560 /*
561  * events
562  */
563 
564 typedef enum {
565 
566  BD_EVENT_NONE = 0, /* no pending events */
567 
568  /*
569  * errors
570  */
571 
572  BD_EVENT_ERROR = 1, /* Fatal error. Playback can't be continued. */
573  BD_EVENT_READ_ERROR = 2, /* Reading of .m2ts aligned unit failed. Next call to read will try next block. */
574  BD_EVENT_ENCRYPTED = 3, /* .m2ts file is encrypted and can't be played */
575 
576  /*
577  * current playback position
578  */
579 
580  BD_EVENT_ANGLE = 4, /* current angle, 1...N */
581  BD_EVENT_TITLE = 5, /* current title, 1...N (0 = top menu) */
582  BD_EVENT_PLAYLIST = 6, /* current playlist (xxxxx.mpls) */
583  BD_EVENT_PLAYITEM = 7, /* current play item, 0...N-1 */
584  BD_EVENT_CHAPTER = 8, /* current chapter, 1...N */
585  BD_EVENT_PLAYMARK = 30, /* playmark reached */
586  BD_EVENT_END_OF_TITLE = 9,
587 
588  /*
589  * stream selection
590  */
591 
592  BD_EVENT_AUDIO_STREAM = 10, /* 1..32, 0xff = none */
593  BD_EVENT_IG_STREAM = 11, /* 1..32 */
594  BD_EVENT_PG_TEXTST_STREAM = 12, /* 1..255, 0xfff = none */
595  BD_EVENT_PIP_PG_TEXTST_STREAM = 13, /* 1..255, 0xfff = none */
596  BD_EVENT_SECONDARY_AUDIO_STREAM = 14, /* 1..32, 0xff = none */
597  BD_EVENT_SECONDARY_VIDEO_STREAM = 15, /* 1..32, 0xff = none */
598 
599  BD_EVENT_PG_TEXTST = 16, /* 0 - disable, 1 - enable */
600  BD_EVENT_PIP_PG_TEXTST = 17, /* 0 - disable, 1 - enable */
601  BD_EVENT_SECONDARY_AUDIO = 18, /* 0 - disable, 1 - enable */
602  BD_EVENT_SECONDARY_VIDEO = 19, /* 0 - disable, 1 - enable */
603  BD_EVENT_SECONDARY_VIDEO_SIZE = 20, /* 0 - PIP, 0xf - fullscreen */
604 
605  /*
606  * playback control
607  */
608 
609  /* discontinuity in the stream (non-seamless connection). Reset demuxer PES buffers. */
610  BD_EVENT_DISCONTINUITY = 28, /* new timestamp (45 kHz) */
611 
612  /* HDMV VM or JVM seeked the stream. Next read() will return data from new position. Flush all buffers. */
613  BD_EVENT_SEEK = 21,
614 
615  /* still playback (pause) */
616  BD_EVENT_STILL = 22, /* 0 - off, 1 - on */
617 
618  /* Still playback for n seconds (reached end of still mode play item).
619  * Playback continues by calling bd_read_skip_still(). */
620  BD_EVENT_STILL_TIME = 23, /* 0 = infinite ; 1...300 = seconds */
621 
622  /* Play sound effect */
623  BD_EVENT_SOUND_EFFECT = 24, /* effect ID */
624 
625  /*
626  * status
627  */
628 
629  /* Nothing to do. Playlist is not playing, but title applet is running. */
630  BD_EVENT_IDLE = 29,
631 
632  /* Pop-Up menu available */
633  BD_EVENT_POPUP = 25, /* 0 - no, 1 - yes */
634 
635  /* Interactive menu visible */
636  BD_EVENT_MENU = 26, /* 0 - no, 1 - yes */
637 
638  /* 3D */
639  BD_EVENT_STEREOSCOPIC_STATUS = 27, /* 0 - 2D, 1 - 3D */
640 
641  /*BD_EVENT_LAST = 30, */
642 
643 } bd_event_e;
644 
645 typedef struct {
646  uint32_t event; /* bd_event_e */
647  uint32_t param;
648 } BD_EVENT;
649 
650 /* BD_EVENT_ERROR param values */
651 #define BD_ERROR_HDMV 1
652 #define BD_ERROR_BDJ 2
653 
654 /* BD_EVENT_ENCRYPTED param vlues */
655 #define BD_ERROR_AACS 3
656 #define BD_ERROR_BDPLUS 4
657 
658 
659 #define BLURAY_TITLE_FIRST_PLAY 0xffff
660 #define BLURAY_TITLE_TOP_MENU 0
661 
669 int bd_get_event(BLURAY *bd, BD_EVENT *event);
670 
671 /*
672  * navigaton mode
673  */
674 
684 int bd_play(BLURAY *bd);
685 
698 int bd_read_ext(BLURAY *bd, unsigned char *buf, int len, BD_EVENT *event);
699 
712 int bd_play_title(BLURAY *bd, unsigned title);
713 
724 int bd_menu_call(BLURAY *bd, int64_t pts);
725 
726 /*
727  * User interaction and On-screen display controller
728  */
729 
730 struct bd_overlay_s; /* defined in overlay.h */
731 struct bd_argb_overlay_s; /* defined in overlay.h */
732 struct bd_argb_buffer_s; /* defined in overlay.h */
733 typedef void (*bd_overlay_proc_f)(void *, const struct bd_overlay_s * const);
734 typedef void (*bd_argb_overlay_proc_f)(void *, const struct bd_argb_overlay_s * const);
735 
736 
755 void bd_register_overlay_proc(BLURAY *bd, void *handle, bd_overlay_proc_f func);
756 
772 void bd_register_argb_overlay_proc(BLURAY *bd, void *handle, bd_argb_overlay_proc_f func, struct bd_argb_buffer_s *buf);
773 
781 void bd_set_scr(BLURAY *bd, int64_t pts);
782 
794 int bd_user_input(BLURAY *bd, int64_t pts, uint32_t key);
795 
806 int bd_mouse_select(BLURAY *bd, int64_t pts, uint16_t x, uint16_t y);
807 
817 int bd_get_sound_effect(BLURAY *bd, unsigned sound_id, struct bd_sound_effect *effect);
818 
819 /*
820  *
821  */
822 
823 struct meta_dl;
831 const struct meta_dl *bd_get_meta(BLURAY *bd);
832 
833 
834 struct clpi_cl;
843 struct clpi_cl *bd_get_clpi(BLURAY *bd, unsigned clip_ref);
844 struct clpi_cl *bd_read_clpi(const char *clpi_file);
845 
852 void bd_free_clpi(struct clpi_cl *cl);
853 
854 #ifdef __cplusplus
855 };
856 #endif
857 
858 #endif /* BLURAY_H_ */