bluray.h

Go to the documentation of this file.

/*
 * This file is part of libbluray
 * Copyright (C) 2009-2010  Obliter0n
 * Copyright (C) 2009-2010  John Stebbins
 * Copyright (C) 2010-2017  Petri Hintukainen
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library. If not, see
 * <http://www.gnu.org/licenses/>.
 */

#ifndef BLURAY_H_
#define BLURAY_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>

#ifdef BLURAY_API_EXPORT
#include "util/attributes.h"
#elif !defined(BD_PUBLIC)
#define BD_PUBLIC
#endif

#define TITLES_ALL              0    
#define TITLES_FILTER_DUP_TITLE 0x01 
#define TITLES_FILTER_DUP_CLIP  0x02 
#define TITLES_RELEVANT \
  (TITLES_FILTER_DUP_TITLE | TITLES_FILTER_DUP_CLIP) 
typedef struct bluray BLURAY;

/*
 * Disc info
 */

/* AACS error codes */
#define BD_AACS_CORRUPTED_DISC  -1  
#define BD_AACS_NO_CONFIG       -2  
#define BD_AACS_NO_PK           -3  
#define BD_AACS_NO_CERT         -4  
#define BD_AACS_CERT_REVOKED    -5  
#define BD_AACS_MMC_FAILED      -6  
typedef struct {
    const char *name;         
    uint8_t     interactive;  
    uint8_t     accessible;   
    uint8_t     hidden;       
    uint8_t     bdj;          
    uint32_t    id_ref;       
} BLURAY_TITLE;

typedef struct {
    uint8_t  bluray_detected;   
    /* Disc ID */
    const char *disc_name;      
    const char *udf_volume_id;  
    uint8_t     disc_id[20];    
    uint8_t  no_menu_support;            
    uint8_t  first_play_supported;       
    uint8_t  top_menu_supported;         
    uint32_t             num_titles;     
    const BLURAY_TITLE  *const *titles;  
    const BLURAY_TITLE  *first_play;     
    const BLURAY_TITLE  *top_menu;       
    uint32_t num_hdmv_titles;            
    uint32_t num_bdj_titles;             
    uint32_t num_unsupported_titles;     
    uint8_t  bdj_detected;     
    uint8_t  bdj_supported;    
    uint8_t  libjvm_detected;  
    uint8_t  bdj_handled;      
    char bdj_org_id[9];        
    char bdj_disc_id[33];      
    /* disc application info */
    uint8_t video_format;                     
    uint8_t frame_rate;                       
    uint8_t content_exist_3D;                 
    uint8_t initial_output_mode_preference;   
    uint8_t provider_data[32];                
    /* AACS info  (valid only if disc uses AACS) */
    uint8_t  aacs_detected;     
    uint8_t  libaacs_detected;  
    uint8_t  aacs_handled;      
    int      aacs_error_code;   
    int      aacs_mkbv;         
    /* BD+ info  (valid only if disc uses BD+) */
    uint8_t  bdplus_detected;     
    uint8_t  libbdplus_detected;  
    uint8_t  bdplus_handled;      
    uint8_t  bdplus_gen;          
    uint32_t bdplus_date;         
    /* disc application info (libbluray > 1.2.0) */
    uint8_t initial_dynamic_range_type; 
} BLURAY_DISC_INFO;

/*
 * Playlist info
 */

typedef enum {
    BLURAY_STREAM_TYPE_VIDEO_MPEG1              = 0x01,
    BLURAY_STREAM_TYPE_VIDEO_MPEG2              = 0x02,
    BLURAY_STREAM_TYPE_AUDIO_MPEG1              = 0x03,
    BLURAY_STREAM_TYPE_AUDIO_MPEG2              = 0x04,
    BLURAY_STREAM_TYPE_AUDIO_LPCM               = 0x80,
    BLURAY_STREAM_TYPE_AUDIO_AC3                = 0x81,
    BLURAY_STREAM_TYPE_AUDIO_DTS                = 0x82,
    BLURAY_STREAM_TYPE_AUDIO_TRUHD              = 0x83,
    BLURAY_STREAM_TYPE_AUDIO_AC3PLUS            = 0x84,
    BLURAY_STREAM_TYPE_AUDIO_DTSHD              = 0x85,
    BLURAY_STREAM_TYPE_AUDIO_DTSHD_MASTER       = 0x86,
    BLURAY_STREAM_TYPE_VIDEO_VC1                = 0xea,
    BLURAY_STREAM_TYPE_VIDEO_H264               = 0x1b,
    BLURAY_STREAM_TYPE_VIDEO_HEVC               = 0x24,
    BLURAY_STREAM_TYPE_SUB_PG                   = 0x90,
    BLURAY_STREAM_TYPE_SUB_IG                   = 0x91,
    BLURAY_STREAM_TYPE_SUB_TEXT                 = 0x92,
    BLURAY_STREAM_TYPE_AUDIO_AC3PLUS_SECONDARY  = 0xa1,
    BLURAY_STREAM_TYPE_AUDIO_DTSHD_SECONDARY    = 0xa2
} bd_stream_type_e;

typedef enum {
    BLURAY_VIDEO_FORMAT_480I              = 1,  
    BLURAY_VIDEO_FORMAT_576I              = 2,  
    BLURAY_VIDEO_FORMAT_480P              = 3,  
    BLURAY_VIDEO_FORMAT_1080I             = 4,  
    BLURAY_VIDEO_FORMAT_720P              = 5,  
    BLURAY_VIDEO_FORMAT_1080P             = 6,  
    BLURAY_VIDEO_FORMAT_576P              = 7,  
    BLURAY_VIDEO_FORMAT_2160P             = 8,  
} bd_video_format_e;

typedef enum {
    BLURAY_VIDEO_RATE_24000_1001          = 1,  
    BLURAY_VIDEO_RATE_24                  = 2,  
    BLURAY_VIDEO_RATE_25                  = 3,  
    BLURAY_VIDEO_RATE_30000_1001          = 4,  
    BLURAY_VIDEO_RATE_50                  = 6,  
    BLURAY_VIDEO_RATE_60000_1001          = 7   
} bd_video_rate_e;

typedef enum {
    BLURAY_ASPECT_RATIO_4_3               = 2,
    BLURAY_ASPECT_RATIO_16_9              = 3
} bd_video_aspect_e;

typedef enum {
    BLURAY_AUDIO_FORMAT_MONO              = 1,
    BLURAY_AUDIO_FORMAT_STEREO            = 3,
    BLURAY_AUDIO_FORMAT_MULTI_CHAN        = 6,
    BLURAY_AUDIO_FORMAT_COMBO             = 12  // Stereo ac3/dts, 
} bd_audio_format_e;
                                                // multi mlp/dts-hd
typedef enum {
    BLURAY_AUDIO_RATE_48                  = 1,
    BLURAY_AUDIO_RATE_96                  = 4,
    BLURAY_AUDIO_RATE_192                 = 5,
    BLURAY_AUDIO_RATE_192_COMBO           = 12, // 48 or 96 ac3/dts
                                                // 192 mpl/dts-hd
    BLURAY_AUDIO_RATE_96_COMBO            = 14  // 48 ac3/dts
                                                // 96 mpl/dts-hd
} bd_audio_rate_e;

typedef enum {
    BLURAY_TEXT_CHAR_CODE_UTF8            = 0x01,
    BLURAY_TEXT_CHAR_CODE_UTF16BE         = 0x02,
    BLURAY_TEXT_CHAR_CODE_SHIFT_JIS       = 0x03,
    BLURAY_TEXT_CHAR_CODE_EUC_KR          = 0x04,
    BLURAY_TEXT_CHAR_CODE_GB18030_20001   = 0x05,
    BLURAY_TEXT_CHAR_CODE_CN_GB           = 0x06,
    BLURAY_TEXT_CHAR_CODE_BIG5            = 0x07
} bd_char_code_e;

typedef enum {
    BLURAY_STILL_NONE     = 0x00,  
    BLURAY_STILL_TIME     = 0x01,  
    BLURAY_STILL_INFINITE = 0x02,  
} bd_still_mode_e;

typedef enum {
    BLURAY_MARK_ENTRY     = 0x01,  
    BLURAY_MARK_LINK      = 0x02,  
} bd_mark_type_e;

typedef enum {
    BLURAY_DYNAMIC_RANGE_SDR          = 0,
    BLURAY_DYNAMIC_RANGE_HDR10        = 1,
    BLURAY_DYNAMIC_RANGE_DOLBY_VISION = 2
} bd_dynamic_range_type_e;

typedef struct bd_stream_info {
    uint8_t     coding_type;  
    uint8_t     format;       
    uint8_t     rate;         
    uint8_t     char_code;    
    uint8_t     lang[4];      
    uint16_t    pid;          
    uint8_t     aspect;       
    uint8_t     subpath_id;   
} BLURAY_STREAM_INFO;

typedef struct bd_clip {
    uint32_t           pkt_count;               
    uint8_t            still_mode;              
    uint16_t           still_time;              
    uint8_t            video_stream_count;      
    uint8_t            audio_stream_count;      
    uint8_t            pg_stream_count;         
    uint8_t            ig_stream_count;         
    uint8_t            sec_audio_stream_count;  
    uint8_t            sec_video_stream_count;  
    BLURAY_STREAM_INFO *video_streams;          
    BLURAY_STREAM_INFO *audio_streams;          
    BLURAY_STREAM_INFO *pg_streams;             
    BLURAY_STREAM_INFO *ig_streams;             
    BLURAY_STREAM_INFO *sec_audio_streams;      
    BLURAY_STREAM_INFO *sec_video_streams;      
    uint64_t           start_time;  
    uint64_t           in_time;     
    uint64_t           out_time;    
    char               clip_id[6];  
} BLURAY_CLIP_INFO;

typedef struct bd_chapter {
    uint32_t    idx;       
    uint64_t    start;     
    uint64_t    duration;  
    uint64_t    offset;    
    unsigned    clip_ref;  
} BLURAY_TITLE_CHAPTER;

typedef struct bd_mark {
    uint32_t    idx;       
    int         type;      
    uint64_t    start;     
    uint64_t    duration;  
    uint64_t    offset;    
    unsigned    clip_ref;  
} BLURAY_TITLE_MARK;

typedef struct bd_title_info {
    uint32_t             idx;            
    uint32_t             playlist;       
    uint64_t             duration;       
    uint32_t             clip_count;     
    uint8_t              angle_count;    
    uint32_t             chapter_count;  
    uint32_t             mark_count;     
    BLURAY_CLIP_INFO     *clips;         
    BLURAY_TITLE_CHAPTER *chapters;      
    BLURAY_TITLE_MARK    *marks;         
    uint8_t              mvc_base_view_r_flag;  
} BLURAY_TITLE_INFO;

typedef struct bd_sound_effect {
    uint8_t         num_channels; 
    uint32_t        num_frames;   
    const int16_t  *samples;      
} BLURAY_SOUND_EFFECT;


BD_PUBLIC void bd_get_version(int *major, int *minor, int *micro);

/*
 * Disc functions
 */

struct bd_dir_s;
struct bd_file_s;
struct meta_dl;

BD_PUBLIC BLURAY *bd_open(const char *device_path, const char *keyfile_path);

BD_PUBLIC BLURAY *bd_init(void);

BD_PUBLIC int bd_open_disc(BLURAY *bd, const char *device_path, const char *keyfile_path);

BD_PUBLIC int bd_open_stream(BLURAY *bd,
                   void *read_blocks_handle,
                   int (*read_blocks)(void *handle, void *buf, int lba, int num_blocks));

BD_PUBLIC int bd_open_files(BLURAY *bd,
                  void *handle,
                  struct bd_dir_s *(*open_dir)(void *handle, const char *rel_path),
                  struct bd_file_s *(*open_file)(void *handle, const char *rel_path));

BD_PUBLIC void bd_close(BLURAY *bd);

BD_PUBLIC const BLURAY_DISC_INFO *bd_get_disc_info(BLURAY *bd);

BD_PUBLIC const struct meta_dl *bd_get_meta(BLURAY *bd);

BD_PUBLIC int bd_get_meta_file(BLURAY *bd, const char *file_name, void **data, int64_t *size);


/*
 * Title selection without on-disc menus
 */

BD_PUBLIC uint32_t bd_get_titles(BLURAY *bd, uint8_t flags, uint32_t min_title_length);

BD_PUBLIC int bd_get_main_title(BLURAY *bd);

BD_PUBLIC BLURAY_TITLE_INFO* bd_get_title_info(BLURAY *bd, uint32_t title_idx, unsigned angle);

BD_PUBLIC void bd_free_title_info(BLURAY_TITLE_INFO *title_info);

BD_PUBLIC int bd_select_title(BLURAY *bd, uint32_t title);

BD_PUBLIC int bd_select_playlist(BLURAY *bd, uint32_t playlist);

BD_PUBLIC uint32_t bd_get_current_title(BLURAY *bd);

BD_PUBLIC int bd_read(BLURAY *bd, unsigned char *buf, int len);


/*
 * Playback control functions
 */

BD_PUBLIC int64_t bd_seek(BLURAY *bd, uint64_t pos);

BD_PUBLIC int64_t bd_seek_time(BLURAY *bd, uint64_t tick);

BD_PUBLIC int64_t bd_seek_chapter(BLURAY *bd, unsigned chapter);

BD_PUBLIC int64_t bd_seek_mark(BLURAY *bd, unsigned mark);

BD_PUBLIC int64_t bd_seek_playitem(BLURAY *bd, unsigned clip_ref);

BD_PUBLIC int bd_select_angle(BLURAY *bd, unsigned angle);

BD_PUBLIC void bd_seamless_angle_change(BLURAY *bd, unsigned angle);

BD_PUBLIC void bd_select_stream(BLURAY *bd, uint32_t stream_type, uint32_t stream_id, uint32_t enable_flag);

#define BLURAY_AUDIO_STREAM      0   
#define BLURAY_PG_TEXTST_STREAM  1   
/*
 * Playback status functions
 */

BD_PUBLIC int64_t bd_chapter_pos(BLURAY *bd, unsigned chapter);

BD_PUBLIC uint32_t bd_get_current_chapter(BLURAY *bd);

BD_PUBLIC uint64_t bd_get_title_size(BLURAY *bd);

BD_PUBLIC unsigned bd_get_current_angle(BLURAY *bd);

BD_PUBLIC uint64_t bd_tell(BLURAY *bd);

BD_PUBLIC uint64_t bd_tell_time(BLURAY *bd);


/*
 * player settings
 */

typedef enum {
    BLURAY_PLAYER_SETTING_AUDIO_LANG     = 16,    
    BLURAY_PLAYER_SETTING_PG_LANG        = 17,    
    BLURAY_PLAYER_SETTING_MENU_LANG      = 18,    
    BLURAY_PLAYER_SETTING_COUNTRY_CODE   = 19,    
    BLURAY_PLAYER_SETTING_REGION_CODE    = 20,    
    BLURAY_PLAYER_SETTING_OUTPUT_PREFER  = 21,    
    BLURAY_PLAYER_SETTING_PARENTAL       = 13,    
    BLURAY_PLAYER_SETTING_AUDIO_CAP      = 15,    
    BLURAY_PLAYER_SETTING_VIDEO_CAP      = 29,    
    BLURAY_PLAYER_SETTING_DISPLAY_CAP    = 23,    
    BLURAY_PLAYER_SETTING_3D_CAP         = 24,    
    BLURAY_PLAYER_SETTING_UHD_CAP         = 25,   
    BLURAY_PLAYER_SETTING_UHD_DISPLAY_CAP = 26,   
    BLURAY_PLAYER_SETTING_HDR_PREFERENCE  = 27,   
    BLURAY_PLAYER_SETTING_SDR_CONV_PREFER = 28,   
    BLURAY_PLAYER_SETTING_TEXT_CAP       = 30,    
    BLURAY_PLAYER_SETTING_PLAYER_PROFILE = 31,    
    BLURAY_PLAYER_SETTING_DECODE_PG          = 0x100, 
    BLURAY_PLAYER_SETTING_PERSISTENT_STORAGE = 0x101, 
    BLURAY_PLAYER_PERSISTENT_ROOT            = 0x200, 
    BLURAY_PLAYER_CACHE_ROOT                 = 0x201, 
    BLURAY_PLAYER_JAVA_HOME                  = 0x202, 
} bd_player_setting;

BD_PUBLIC int bd_set_player_setting(BLURAY *bd, uint32_t idx, uint32_t value);

BD_PUBLIC int bd_set_player_setting_str(BLURAY *bd, uint32_t idx, const char *value);


/*
 * events
 */

typedef enum {

    BD_EVENT_NONE         = 0,  
    /*
     * errors
     */

    BD_EVENT_ERROR        = 1,  
    BD_EVENT_READ_ERROR   = 2,  
    BD_EVENT_ENCRYPTED    = 3,  
    /*
     * current playback position
     */

    BD_EVENT_ANGLE        = 4,  
    BD_EVENT_TITLE        = 5,  
    BD_EVENT_PLAYLIST     = 6,  
    BD_EVENT_PLAYITEM     = 7,  
    BD_EVENT_CHAPTER      = 8,  
    BD_EVENT_PLAYMARK     = 9,  
    BD_EVENT_END_OF_TITLE = 10, 
    /*
     * stream selection
     */

    BD_EVENT_AUDIO_STREAM           = 11,  
    BD_EVENT_IG_STREAM              = 12,  
    BD_EVENT_PG_TEXTST_STREAM       = 13,  
    BD_EVENT_PIP_PG_TEXTST_STREAM   = 14,  
    BD_EVENT_SECONDARY_AUDIO_STREAM = 15,  
    BD_EVENT_SECONDARY_VIDEO_STREAM = 16,  
    BD_EVENT_PG_TEXTST              = 17,  
    BD_EVENT_PIP_PG_TEXTST          = 18,  
    BD_EVENT_SECONDARY_AUDIO        = 19,  
    BD_EVENT_SECONDARY_VIDEO        = 20,  
    BD_EVENT_SECONDARY_VIDEO_SIZE   = 21,  
    /*
     * playback control
     */

    BD_EVENT_PLAYLIST_STOP          = 22,

    BD_EVENT_DISCONTINUITY          = 23,  
    BD_EVENT_SEEK                   = 24,  
    BD_EVENT_STILL                  = 25,  
    BD_EVENT_STILL_TIME             = 26,  
    BD_EVENT_SOUND_EFFECT           = 27,  
    /*
     * status
     */

    BD_EVENT_IDLE                   = 28,

    BD_EVENT_POPUP                  = 29,  
    BD_EVENT_MENU                   = 30,  
    BD_EVENT_STEREOSCOPIC_STATUS    = 31,  
    BD_EVENT_KEY_INTEREST_TABLE     = 32,  
    BD_EVENT_UO_MASK_CHANGED        = 33,  
    /*BD_EVENT_LAST = 33, */

} bd_event_e;

typedef struct {
    uint32_t   event;  
    uint32_t   param;  
} BD_EVENT;

/* BD_EVENT_ERROR param values */
#define BD_ERROR_HDMV    1                
#define BD_ERROR_BDJ     2                
/* BD_EVENT_ENCRYPTED param vlues */
#define BD_ERROR_AACS    3                
#define BD_ERROR_BDPLUS  4                
/* BD_EVENT_TITLE special titles */
#define BLURAY_TITLE_FIRST_PLAY  0xffff   
#define BLURAY_TITLE_TOP_MENU    0        
/* BD_EVENT_KEY_INTEREST flags */
#define BLURAY_KIT_PLAY          0x1      
#define BLURAY_KIT_STOP          0x2      
#define BLURAY_KIT_FFW           0x4      
#define BLURAY_KIT_REW           0x8      
#define BLURAY_KIT_TRACK_NEXT    0x10     
#define BLURAY_KIT_TRACK_PREV    0x20     
#define BLURAY_KIT_PAUSE         0x40     
#define BLURAY_KIT_STILL_OFF     0x80     
#define BLURAY_KIT_SEC_AUDIO     0x100    
#define BLURAY_KIT_SEC_VIDEO     0x200    
#define BLURAY_KIT_PG_TEXTST     0x400    
/* BD_EVENT_UO_MASK flags */
#define BLURAY_UO_MENU_CALL      0x1      
#define BLURAY_UO_TITLE_SEARCH   0x2      
BD_PUBLIC int  bd_get_event(BLURAY *bd, BD_EVENT *event);

BD_PUBLIC const char *bd_event_name(uint32_t /* bd_event_e */ event);

/*
 * On-screen display
 */

struct bd_overlay_s;      /* defined in overlay.h */
struct bd_argb_overlay_s; /* defined in overlay.h */
struct bd_argb_buffer_s;  /* defined in overlay.h */

typedef void (*bd_overlay_proc_f)(void *handle, const struct bd_overlay_s * const event);

typedef void (*bd_argb_overlay_proc_f)(void *handle, const struct bd_argb_overlay_s * const event);

BD_PUBLIC void bd_register_overlay_proc(BLURAY *bd, void *handle, bd_overlay_proc_f func);

BD_PUBLIC void bd_register_argb_overlay_proc(BLURAY *bd, void *handle, bd_argb_overlay_proc_f func, struct bd_argb_buffer_s *buf);


/*
 * Playback with on-disc menus
 */

BD_PUBLIC int  bd_play(BLURAY *bd);

BD_PUBLIC int  bd_play_title(BLURAY *bd, unsigned title);

BD_PUBLIC int  bd_menu_call(BLURAY *bd, int64_t pts);

BD_PUBLIC int  bd_read_ext(BLURAY *bd, unsigned char *buf, int len, BD_EVENT *event);

BD_PUBLIC int bd_read_skip_still(BLURAY *bd);

BD_PUBLIC BLURAY_TITLE_INFO* bd_get_playlist_info(BLURAY *bd, uint32_t playlist, unsigned angle);

BD_PUBLIC int bd_get_sound_effect(BLURAY *bd, unsigned sound_id, struct bd_sound_effect *effect);


/*
 * User interaction
 */

BD_PUBLIC void bd_set_scr(BLURAY *bd, int64_t pts);

BD_PUBLIC int bd_set_rate(BLURAY *bd, uint32_t rate);

#define BLURAY_RATE_PAUSED  0      
#define BLURAY_RATE_NORMAL  90000  
BD_PUBLIC int bd_user_input(BLURAY *bd, int64_t pts, uint32_t key);

BD_PUBLIC int bd_mouse_select(BLURAY *bd, int64_t pts, uint16_t x, uint16_t y);


/*
 * Testing and debugging
 *
 * Note: parsing functions can't be used with UDF images.
 */

/* access to internal information */

struct clpi_cl;
struct mpls_pl;
struct bdjo_data;
struct mobj_objects;

BD_PUBLIC struct clpi_cl *bd_get_clpi(BLURAY *bd, unsigned clip_ref);

BD_PUBLIC struct clpi_cl *bd_read_clpi(const char *clpi_file);

BD_PUBLIC void bd_free_clpi(struct clpi_cl *cl);


BD_PUBLIC struct mpls_pl *bd_read_mpls(const char *mpls_file);
BD_PUBLIC void bd_free_mpls(struct mpls_pl *);

BD_PUBLIC struct mobj_objects *bd_read_mobj(const char *mobj_file);
BD_PUBLIC void bd_free_mobj(struct mobj_objects *);

BD_PUBLIC struct bdjo_data *bd_read_bdjo(const char *bdjo_file);
BD_PUBLIC void bd_free_bdjo(struct bdjo_data *);

/* BD-J testing */

BD_PUBLIC int  bd_start_bdj(BLURAY *bd, const char* start_object);
BD_PUBLIC void bd_stop_bdj(BLURAY *bd);

BD_PUBLIC int bd_read_file(BLURAY *bd, const char *path, void **data, int64_t *size);

BD_PUBLIC struct bd_dir_s *bd_open_dir(BLURAY *bd, const char *dir);

BD_PUBLIC struct bd_file_s *bd_open_file_dec(BLURAY *bd, const char *path);

#ifdef __cplusplus
}
#endif

#endif /* BLURAY_H_ */