xorriso  1.5.4.pl02
About: GNU xorriso creates, loads, manipulates and writes ISO 9660 filesystem images with Rock Ridge extensions. It is suitable for incremental data backup and for production of bootable ISO 9660 images. GNU xorriso is a statical compilation of the libraries libburn, libisofs, libisoburn, and libjte.
  Fossies Dox: xorriso-1.5.4.pl02.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

libisoburn.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define isoburn_libisofs_req_major   1
 
#define isoburn_libisofs_req_minor   5
 
#define isoburn_libisofs_req_micro   4
 
#define isoburn_libburn_req_major   1
 
#define isoburn_libburn_req_minor   5
 
#define isoburn_libburn_req_micro   4
 
#define isoburn_header_version_major   1
 
#define isoburn_header_version_minor   5
 
#define isoburn_header_version_micro   4
 
#define isoburn_ropt_norock   1
 
#define isoburn_ropt_nojoliet   2
 
#define isoburn_ropt_noiso1999   4
 
#define isoburn_ropt_preferjoliet   8
 
#define isoburn_ropt_pretend_blank   16
 
#define isoburn_ropt_noaaip   32
 
#define isoburn_ropt_noacl   64
 
#define isoburn_ropt_noea   128
 
#define isoburn_ropt_noino   256
 
#define isoburn_ropt_nomd5   512
 
#define isoburn_ropt_nomd5tag   1024
 
#define isoburn_ropt_map_unmapped   ( 2048 | 0 )
 
#define isoburn_ropt_map_stripped   ( 2048 | 4096 )
 
#define isoburn_ropt_map_uppercase   ( 2048 | 8192 )
 
#define isoburn_ropt_map_lowercase   ( 2048 | 12288 )
 
#define isoburn_ropt_joliet_unmapped   ( 16384 | 0)
 
#define isoburn_ropt_joliet_stripped   ( 16384 | 32768)
 
#define isoburn_ropt_has_rockridge   1
 
#define isoburn_ropt_has_joliet   2
 
#define isoburn_ropt_has_iso1999   4
 
#define isoburn_ropt_has_el_torito   8
 
#define isoburn_igopt_rockridge   1
 
#define isoburn_igopt_joliet   2
 
#define isoburn_igopt_iso1999   4
 
#define isoburn_igopt_hardlinks   8
 
#define isoburn_igopt_aaip   32
 
#define isoburn_igopt_session_md5   64
 
#define isoburn_igopt_file_md5   128
 
#define isoburn_igopt_file_stability   256
 
#define isoburn_igopt_no_emul_toc   512
 
#define isoburn_igopt_will_cancel   1024
 
#define isoburn_igopt_old_empty   2048
 
#define isoburn_igopt_hfsplus   4096
 
#define isoburn_igopt_fat   8192
 
#define isoburn_igopt_omit_version_numbers   1
 
#define isoburn_igopt_allow_deep_paths   2
 
#define isoburn_igopt_allow_longer_paths   4
 
#define isoburn_igopt_max_37_char_filenames   8
 
#define isoburn_igopt_no_force_dots   16
 
#define isoburn_igopt_allow_lowercase   32
 
#define isoburn_igopt_allow_full_ascii   64
 
#define isoburn_igopt_joliet_longer_paths   128
 
#define isoburn_igopt_always_gmt   256
 
#define isoburn_igopt_rrip_version_1_10   512
 
#define isoburn_igopt_dir_rec_mtime   1024
 
#define isoburn_igopt_aaip_susp_1_10   2048
 
#define isoburn_igopt_only_iso_versions   4096
 
#define isoburn_igopt_no_j_force_dots   8192
 
#define isoburn_igopt_allow_dir_id_ext   16384
 
#define isoburn_igopt_joliet_long_names   32768
 
#define isoburn_igopt_joliet_rec_mtime   0x10000
 
#define isoburn_igopt_iso1999_rec_mtime   0x20000
 
#define isoburn_igopt_allow_7bit_ascii   0x40000
 
#define isoburn_igopt_joliet_utf16   0x80000
 
#define isoburn_igopt_sort_files_by_weight   1
 

Functions

int isoburn_initialize (char msg[1024], int flag)
 
int isoburn_is_compatible (int major, int minor, int micro, int flag)
 
void isoburn_version (int *major, int *minor, int *micro)
 
int isoburn_libisofs_req (int *major, int *minor, int *micro)
 
int isoburn_libjte_req (int *major, int *minor, int *micro)
 
int isoburn_libburn_req (int *major, int *minor, int *micro)
 
int isoburn_set_msgs_submit (int(*msgs_submit)(void *handle, int error_code, char msg_text[], int os_errno, char severity[], int flag), void *submit_handle, int submit_flag, int flag)
 
int isoburn_drive_scan_and_grab (struct burn_drive_info *drive_infos[], char *adr, int load)
 
int isoburn_drive_aquire (struct burn_drive_info *drive_infos[], char *adr, int flag)
 
int isoburn_drive_grab (struct burn_drive *drive, int load)
 
int isoburn_drive_set_msgs_submit (struct burn_drive *d, int(*msgs_submit)(void *handle, int error_code, char msg_text[], int os_errno, char severity[], int flag), void *submit_handle, int submit_flag, int flag)
 
enum burn_disc_status isoburn_disc_get_status (struct burn_drive *drive)
 
int isoburn_disc_pretend_full_uncond (struct burn_drive *drive)
 
int isoburn_disc_erasable (struct burn_drive *d)
 
void isoburn_disc_erase (struct burn_drive *drive, int fast)
 
int isoburn_set_msc1 (struct burn_drive *d, int adr_mode, char *adr_value, int flag)
 
struct isoburn_toc_discisoburn_toc_drive_get_disc (struct burn_drive *d)
 
int isoburn_toc_disc_get_sectors (struct isoburn_toc_disc *disc)
 
struct isoburn_toc_session ** isoburn_toc_disc_get_sessions (struct isoburn_toc_disc *disc, int *num)
 
int isoburn_toc_disc_get_incmpl_sess (struct isoburn_toc_disc *disc)
 
int isoburn_toc_session_get_sectors (struct isoburn_toc_session *s)
 
void isoburn_toc_session_get_leadout_entry (struct isoburn_toc_session *s, struct burn_toc_entry *entry)
 
struct isoburn_toc_track ** isoburn_toc_session_get_tracks (struct isoburn_toc_session *s, int *num)
 
void isoburn_toc_track_get_entry (struct isoburn_toc_track *t, struct burn_toc_entry *entry)
 
int isoburn_toc_track_get_emul (struct isoburn_toc_track *t, int *start_lba, int *image_blocks, char volid[33], int flag)
 
void isoburn_toc_disc_free (struct isoburn_toc_disc *disc)
 
int isoburn_read_iso_head (struct burn_drive *d, int lba, int *image_blocks, char *info, int flag)
 
int isoburn_get_mount_params (struct burn_drive *d, int adr_mode, char *adr_value, int *lba, int *track, int *session, char volid[33], int flag)
 
int isoburn_ropt_new (struct isoburn_read_opts **o, int flag)
 
int isoburn_ropt_destroy (struct isoburn_read_opts **o, int flag)
 
int isoburn_ropt_set_data_cache (struct isoburn_read_opts *o, int cache_tiles, int tile_blocks, int flag)
 
int isoburn_ropt_get_data_cache (struct isoburn_read_opts *o, int *cache_tiles, int *tile_blocks, int *set_flag, int flag)
 
int isoburn_ropt_set_extensions (struct isoburn_read_opts *o, int ext)
 
int isoburn_ropt_get_extensions (struct isoburn_read_opts *o, int *ext)
 
int isoburn_ropt_set_default_perms (struct isoburn_read_opts *o, uid_t uid, gid_t gid, mode_t mode)
 
int isoburn_ropt_get_default_perms (struct isoburn_read_opts *o, uid_t *uid, gid_t *gid, mode_t *mode)
 
int isoburn_ropt_set_default_dirperms (struct isoburn_read_opts *o, mode_t mode)
 
int isoburn_ropt_get_default_dirperms (struct isoburn_read_opts *o, mode_t *mode)
 
int isoburn_ropt_set_input_charset (struct isoburn_read_opts *o, char *input_charset)
 
int isoburn_ropt_get_input_charset (struct isoburn_read_opts *o, char **input_charset)
 
int isoburn_ropt_set_auto_incharset (struct isoburn_read_opts *o, int mode)
 
int isoburn_ropt_get_auto_incharset (struct isoburn_read_opts *o, int *mode)
 
int isoburn_ropt_set_displacement (struct isoburn_read_opts *o, uint32_t displacement, int displacement_sign)
 
int isoburn_ropt_get_displacement (struct isoburn_read_opts *o, uint32_t *displacement, int *displacement_sign)
 
int isoburn_ropt_set_truncate_mode (struct isoburn_read_opts *o, int mode, int length)
 
int isoburn_ropt_get_truncate_mode (struct isoburn_read_opts *o, int *mode, int *length)
 
int isoburn_ropt_get_size_what (struct isoburn_read_opts *o, uint32_t *size, int *has_what)
 
int isoburn_ropt_get_tree_loaded (struct isoburn_read_opts *o, int *tree, int *rr)
 
int isoburn_igopt_new (struct isoburn_imgen_opts **o, int flag)
 
int isoburn_igopt_destroy (struct isoburn_imgen_opts **o, int flag)
 
int isoburn_igopt_set_level (struct isoburn_imgen_opts *o, int level)
 
int isoburn_igopt_get_level (struct isoburn_imgen_opts *o, int *level)
 
int isoburn_igopt_set_extensions (struct isoburn_imgen_opts *o, int ext)
 
int isoburn_igopt_get_extensions (struct isoburn_imgen_opts *o, int *ext)
 
int isoburn_igopt_set_relaxed (struct isoburn_imgen_opts *o, int relax)
 
int isoburn_igopt_get_relaxed (struct isoburn_imgen_opts *o, int *relax)
 
int isoburn_igopt_set_rr_reloc (struct isoburn_imgen_opts *o, char *name, int flags)
 
int isoburn_igopt_get_rr_reloc (struct isoburn_imgen_opts *o, char **name, int *flags)
 
int isoburn_igopt_set_untranslated_name_len (struct isoburn_imgen_opts *o, int len)
 
int isoburn_igopt_get_untranslated_name_len (struct isoburn_imgen_opts *o, int *len)
 
int isoburn_igopt_set_sort_files (struct isoburn_imgen_opts *o, int value)
 
int isoburn_igopt_get_sort_files (struct isoburn_imgen_opts *o, int *value)
 
int isoburn_igopt_set_over_mode (struct isoburn_imgen_opts *o, int replace_dir_mode, int replace_file_mode, mode_t dir_mode, mode_t file_mode)
 
int isoburn_igopt_get_over_mode (struct isoburn_imgen_opts *o, int *replace_dir_mode, int *replace_file_mode, mode_t *dir_mode, mode_t *file_mode)
 
int isoburn_igopt_set_over_ugid (struct isoburn_imgen_opts *o, int replace_uid, int replace_gid, uid_t uid, gid_t gid)
 
int isoburn_igopt_get_over_ugid (struct isoburn_imgen_opts *o, int *replace_uid, int *replace_gid, uid_t *uid, gid_t *gid)
 
int isoburn_igopt_set_out_charset (struct isoburn_imgen_opts *o, char *output_charset)
 
int isoburn_igopt_get_out_charset (struct isoburn_imgen_opts *o, char **output_charset)
 
int isoburn_igopt_set_fifo_size (struct isoburn_imgen_opts *o, int fifo_size)
 
int isoburn_igopt_get_fifo_size (struct isoburn_imgen_opts *o, int *fifo_size)
 
int isoburn_igopt_get_effective_lba (struct isoburn_imgen_opts *o, int *lba)
 
int isoburn_igopt_get_data_start (struct isoburn_imgen_opts *o, int *lba)
 
int isoburn_igopt_set_scdbackup_tag (struct isoburn_imgen_opts *o, char *name, char *timestamp, char *tag_written)
 
int isoburn_igopt_get_scdbackup_tag (struct isoburn_imgen_opts *o, char name[81], char timestamp[19], char **tag_written)
 
int isoburn_igopt_set_system_area (struct isoburn_imgen_opts *o, char data[32768], int options)
 
int isoburn_igopt_get_system_area (struct isoburn_imgen_opts *o, char data[32768], int *options)
 
int isoburn_igopt_set_part_offset (struct isoburn_imgen_opts *opts, uint32_t block_offset_2k, int secs_512_per_head, int heads_per_cyl)
 
int isoburn_igopt_get_part_offset (struct isoburn_imgen_opts *opts, uint32_t *block_offset_2k, int *secs_512_per_head, int *heads_per_cyl)
 
int isoburn_igopt_set_pvd_times (struct isoburn_imgen_opts *opts, time_t creation_time, time_t modification_time, time_t expiration_time, time_t effective_time, char *uuid)
 
int isoburn_igopt_get_pvd_times (struct isoburn_imgen_opts *opts, time_t *creation_time, time_t *modification_time, time_t *expiration_time, time_t *effective_time, char uuid[17])
 
int isoburn_igopt_attach_jte (struct isoburn_imgen_opts *opts, void *libjte_handle)
 
int isoburn_igopt_detach_jte (struct isoburn_imgen_opts *opts, void **libjte_handle)
 
int isoburn_igopt_set_tail_blocks (struct isoburn_imgen_opts *opts, uint32_t num_blocks)
 
int isoburn_igopt_get_tail_blocks (struct isoburn_imgen_opts *opts, uint32_t *num_blocks)
 
int isoburn_igopt_set_prep_partition (struct isoburn_imgen_opts *opts, char *path, int flag)
 
int isoburn_igopt_get_prep_partition (struct isoburn_imgen_opts *opts, char **path, int flag)
 
int isoburn_igopt_set_efi_bootp (struct isoburn_imgen_opts *opts, char *path, int flag)
 
int isoburn_igopt_get_efi_bootp (struct isoburn_imgen_opts *opts, char **path, int flag)
 
int isoburn_igopt_set_partition_img (struct isoburn_imgen_opts *opts, int partition_number, uint8_t partition_type, char *image_path)
 
int isoburn_igopt_get_partition_img (struct isoburn_imgen_opts *opts, int num_entries, uint8_t partition_types[], char *image_paths[])
 
int isoburn_igopt_set_part_flag (struct isoburn_imgen_opts *opts, int partition_number, int flag)
 
int isoburn_igopt_get_part_flags (struct isoburn_imgen_opts *opts, int num_entries, int part_flags[])
 
int isoburn_igopt_set_appended_as_gpt (struct isoburn_imgen_opts *opts, int gpt)
 
int isoburn_igopt_get_appended_as_gpt (struct isoburn_imgen_opts *opts, int *gpt)
 
int isoburn_igopt_set_part_type_guid (struct isoburn_imgen_opts *opts, int partition_number, uint8_t guid[16], int valid)
 
int isoburn_igopt_get_part_type_guid (struct isoburn_imgen_opts *opts, int num_entries, uint8_t guids[][16], int valids[])
 
int isoburn_igopt_set_appended_as_apm (struct isoburn_imgen_opts *opts, int apm)
 
int isoburn_igopt_get_appended_as_apm (struct isoburn_imgen_opts *opts, int *apm)
 
int isoburn_igopt_set_part_like_isohybrid (struct isoburn_imgen_opts *opts, int alike)
 
int isoburn_igopt_get_part_like_isohybrid (struct isoburn_imgen_opts *opts, int *alike)
 
int isoburn_igopt_set_iso_mbr_part_type (struct isoburn_imgen_opts *opts, int part_type)
 
int isoburn_igopt_get_iso_mbr_part_type (struct isoburn_imgen_opts *opts, int *part_type)
 
int isoburn_igopt_set_iso_type_guid (struct isoburn_imgen_opts *opts, uint8_t guid[16], int valid)
 
int isoburn_igopt_get_iso_type_guid (struct isoburn_imgen_opts *opts, uint8_t guid[16])
 
int isoburn_igopt_set_gpt_guid (struct isoburn_imgen_opts *opts, uint8_t guid[16], int mode)
 
int isoburn_igopt_get_gpt_guid (struct isoburn_imgen_opts *opts, uint8_t guid[16], int *mode)
 
int isoburn_igopt_set_disc_label (struct isoburn_imgen_opts *opts, char *label)
 
int isoburn_igopt_get_disc_label (struct isoburn_imgen_opts *opts, char **label)
 
int isoburn_igopt_set_hfsp_serial_number (struct isoburn_imgen_opts *opts, uint8_t serial_number[8])
 
int isoburn_igopt_get_hfsp_serial_number (struct isoburn_imgen_opts *opts, uint8_t serial_number[8])
 
int isoburn_igopt_set_hfsp_block_size (struct isoburn_imgen_opts *opts, int hfsp_block_size, int apm_block_size)
 
int isoburn_igopt_get_hfsp_block_size (struct isoburn_imgen_opts *opts, int *hfsp_block_size, int *apm_block_size)
 
int isoburn_igopt_set_write_type (struct isoburn_imgen_opts *opts, int do_tao)
 
int isoburn_igopt_get_write_type (struct isoburn_imgen_opts *opts, int *do_tao)
 
int isoburn_igopt_set_stdio_endsync (struct isoburn_imgen_opts *opts, int do_sync)
 
int isoburn_igopt_get_stdio_endsync (struct isoburn_imgen_opts *opts, int *do_sync)
 
int isoburn_conv_name_chars (struct isoburn_imgen_opts *opts, char *name, size_t name_len, char **result, size_t *result_len, int flag)
 
IsoImageisoburn_get_attached_image (struct burn_drive *d)
 
int isoburn_get_attached_start_lba (struct burn_drive *d)
 
int isoburn_read_image (struct burn_drive *d, struct isoburn_read_opts *read_opts, IsoImage **image)
 
int isoburn_set_read_pacifier (struct burn_drive *drive, int(*read_pacifier)(IsoImage *, IsoFileSource *), void *app_handle)
 
int isoburn_get_img_partition_offset (struct burn_drive *drive, uint32_t *block_offset_2k)
 
int isoburn_attach_image (struct burn_drive *d, IsoImage *image)
 
int isoburn_attach_start_lba (struct burn_drive *d, int lba, int flag)
 
off_t isoburn_disc_available_space (struct burn_drive *d, struct burn_write_opts *o)
 
int isoburn_disc_get_msc1 (struct burn_drive *d, int *start_lba)
 
int isoburn_disc_track_lba_nwa (struct burn_drive *d, struct burn_write_opts *o, int trackno, int *lba, int *nwa)
 
int isoburn_get_min_start_byte (struct burn_drive *d, off_t *start_byte, int flag)
 
int isoburn_prepare_disc (struct burn_drive *drive, struct burn_disc **disc, struct isoburn_imgen_opts *opts)
 
int isoburn_prepare_new_image (struct burn_drive *in_drive, struct burn_disc **disc, struct isoburn_imgen_opts *opts, struct burn_drive *out_drive)
 
int isoburn_prepare_blind_grow (struct burn_drive *in_drive, struct burn_disc **disc, struct isoburn_imgen_opts *opts, struct burn_drive *out_drive, int nwa)
 
int isoburn_cancel_prepared_write (struct burn_drive *input_drive, struct burn_drive *output_drive, int flag)
 
int isoburn_set_truncate (struct burn_drive *drive, int flag)
 
void isoburn_disc_write (struct burn_write_opts *o, struct burn_disc *disc)
 
int isoburn_get_fifo_status (struct burn_drive *d, int *size, int *free_bytes, char **status_text)
 
int isoburn_drive_wrote_well (struct burn_drive *d)
 
int isoburn_activate_session (struct burn_drive *d)
 
int isoburn_sync_after_write (struct burn_drive *input_drive, struct burn_drive *output_drive, int flag)
 
void isoburn_drive_release (struct burn_drive *drive, int eject)
 
void isoburn_finish (void)
 
int isoburn_needs_emulation (struct burn_drive *d)
 

Macro Definition Documentation

◆ isoburn_header_version_major

#define isoburn_header_version_major   1

These three release version numbers tell the revision of this header file and of the API it describes. They are memorized by applications at build time.

Since
0.1.0

Definition at line 313 of file libisoburn.h.

◆ isoburn_header_version_micro

#define isoburn_header_version_micro   4

Definition at line 315 of file libisoburn.h.

◆ isoburn_header_version_minor

#define isoburn_header_version_minor   5

Definition at line 314 of file libisoburn.h.

◆ isoburn_igopt_aaip

#define isoburn_igopt_aaip   32

Definition at line 1244 of file libisoburn.h.

◆ isoburn_igopt_aaip_susp_1_10

#define isoburn_igopt_aaip_susp_1_10   2048

Definition at line 1367 of file libisoburn.h.

◆ isoburn_igopt_allow_7bit_ascii

#define isoburn_igopt_allow_7bit_ascii   0x40000

Definition at line 1374 of file libisoburn.h.

◆ isoburn_igopt_allow_deep_paths

#define isoburn_igopt_allow_deep_paths   2

Definition at line 1357 of file libisoburn.h.

◆ isoburn_igopt_allow_dir_id_ext

#define isoburn_igopt_allow_dir_id_ext   16384

Definition at line 1370 of file libisoburn.h.

◆ isoburn_igopt_allow_full_ascii

#define isoburn_igopt_allow_full_ascii   64

Definition at line 1362 of file libisoburn.h.

◆ isoburn_igopt_allow_longer_paths

#define isoburn_igopt_allow_longer_paths   4

Definition at line 1358 of file libisoburn.h.

◆ isoburn_igopt_allow_lowercase

#define isoburn_igopt_allow_lowercase   32

Definition at line 1361 of file libisoburn.h.

◆ isoburn_igopt_always_gmt

#define isoburn_igopt_always_gmt   256

Definition at line 1364 of file libisoburn.h.

◆ isoburn_igopt_dir_rec_mtime

#define isoburn_igopt_dir_rec_mtime   1024

Definition at line 1366 of file libisoburn.h.

◆ isoburn_igopt_fat

#define isoburn_igopt_fat   8192

Definition at line 1252 of file libisoburn.h.

◆ isoburn_igopt_file_md5

#define isoburn_igopt_file_md5   128

Definition at line 1246 of file libisoburn.h.

◆ isoburn_igopt_file_stability

#define isoburn_igopt_file_stability   256

Definition at line 1247 of file libisoburn.h.

◆ isoburn_igopt_hardlinks

#define isoburn_igopt_hardlinks   8

Definition at line 1243 of file libisoburn.h.

◆ isoburn_igopt_hfsplus

#define isoburn_igopt_hfsplus   4096

Definition at line 1251 of file libisoburn.h.

◆ isoburn_igopt_iso1999

#define isoburn_igopt_iso1999   4

Definition at line 1242 of file libisoburn.h.

◆ isoburn_igopt_iso1999_rec_mtime

#define isoburn_igopt_iso1999_rec_mtime   0x20000

Definition at line 1373 of file libisoburn.h.

◆ isoburn_igopt_joliet

#define isoburn_igopt_joliet   2

Definition at line 1241 of file libisoburn.h.

◆ isoburn_igopt_joliet_long_names

#define isoburn_igopt_joliet_long_names   32768

Definition at line 1371 of file libisoburn.h.

◆ isoburn_igopt_joliet_longer_paths

#define isoburn_igopt_joliet_longer_paths   128

Definition at line 1363 of file libisoburn.h.

◆ isoburn_igopt_joliet_rec_mtime

#define isoburn_igopt_joliet_rec_mtime   0x10000

Definition at line 1372 of file libisoburn.h.

◆ isoburn_igopt_joliet_utf16

#define isoburn_igopt_joliet_utf16   0x80000

Definition at line 1375 of file libisoburn.h.

◆ isoburn_igopt_max_37_char_filenames

#define isoburn_igopt_max_37_char_filenames   8

Definition at line 1359 of file libisoburn.h.

◆ isoburn_igopt_no_emul_toc

#define isoburn_igopt_no_emul_toc   512

Definition at line 1248 of file libisoburn.h.

◆ isoburn_igopt_no_force_dots

#define isoburn_igopt_no_force_dots   16

Definition at line 1360 of file libisoburn.h.

◆ isoburn_igopt_no_j_force_dots

#define isoburn_igopt_no_j_force_dots   8192

Definition at line 1369 of file libisoburn.h.

◆ isoburn_igopt_old_empty

#define isoburn_igopt_old_empty   2048

Definition at line 1250 of file libisoburn.h.

◆ isoburn_igopt_omit_version_numbers

#define isoburn_igopt_omit_version_numbers   1

Relaxed constraints. Setting any of the bits to 1 break the specifications, but it is supposed to work on most moderns systems. Use with caution.

Since
0.1.0
Parameters
oThe option set to work on
relaxBitfield: bit0= omit_version_numbers Omit the version number (";1") at the end of the ISO-9660 and Joliet identifiers. Version numbers are usually not used by readers. bit1= allow_deep_paths Allow ISO-9660 directory hierarchy to be deeper than 8 levels. bit2= allow_longer_paths Allow path in the ISO-9660 tree to have more than 255 characters. bit3= max_37_char_filenames Allow a single file or directory hierarchy to have up to 37 characters. This is larger than the 31 characters allowed by ISO level 2, and the extra space is taken from the version number, so this also forces omit_version_numbers. bit4= no_force_dots ISO-9660 forces filenames to have a ".", that separates file name from extension. libisofs adds it if original filename has none. Set this to 1 to prevent this behavior. bit5= allow_lowercase Allow lowercase characters in ISO-9660 filenames. By default, only uppercase characters, numbers and a few other characters are allowed. bit6= allow_full_ascii Allow all ASCII characters to be appear on an ISO-9660 filename. Note that "/" and "\0" characters are never allowed, even in RR names. bit7= joliet_longer_paths Allow paths in the Joliet tree to have more than 240 characters. bit8= always_gmt Write timestamps as GMT although the specs prescribe local time with eventual non-zero timezone offset. Negative timezones (west of GMT) can trigger bugs in some operating systems which typically appear in mounted ISO images as if the timezone shift from GMT was applied twice (e.g. in New York 22:36 becomes 17:36). bit9= rrip_version_1_10 Write Rock Ridge info as of specification RRIP-1.10 rather than RRIP-1.12: signature "RRIP_1991A" rather than "IEEE_1282", field PX without file serial number. bit10= dir_rec_mtime Store as ECMA-119 Directory Record timestamp the mtime of the source rather than the image creation time. bit11= aaip_susp_1_10 Write AAIP fields without announcing AAIP by an ER field and without distinguishing RRIP fields from the AAIP field by prefixed ES fields. This saves 5 to 10 bytes per file and might avoid problems with readers which only accept RRIP. SUSP-1.10 allows it, SUSP-1.12 frowns on it. bit12= only_iso_numbers Same as bit1 omit_version_number but restricted to the names in the eventual Joliet tree.
Since
0.5.4 For reasons of backward compatibility it is not possible yet to disable version numbers for ISO 9660 while enabling them for Joliet. bit13= no_j_force_dots Same as no_force_dots but affecting the names in the eventual Joliet tree rather than the ISO 9660 / ECMA-119 names.
0.5.4 Previous versions added dots to Joliet names unconditionally. bit14= allow_dir_id_ext Convert directory names for ECMA-119 similar to other file names, but do not force a dot or add a version number. This violates ECMA-119 by allowing one "." and especially ISO level 1 by allowing DOS style 8.3 names rather than only 8 characters. (mkisofs and its clones obviously do this violation.)
1.0.0 bit15= joliet_long_names Allow for Joliet leaf names up to 103 characters rather than up to 64.
1.0.6 bit16= joliet_rec_mtime Like dir_rec_mtime, but for the Joliet tree.
1.2.0 bit17= iso1999_rec_mtime Like dir_rec_mtime, but for the ISO 9660:1999 tree.
1.2.0 bit18= allow_7bit_ascii Like allow_full_ascii, but only allowing 7-bit characters. Lowercase letters get mapped to uppercase if not allow_lowercase is set. Gets overridden if allow_full_ascii is enabled. bit19= joliet_utf16 Encode Joliet names by character set UTF-16BE rather than UCS-2. The difference is with characters which are not present in UCS-2 and get encoded in UTF-16 by 2 words of 16 bit each. Both words then stem from a reserved subset of UCS-2.
1.3.6
Returns
1 success, <=0 failure

Definition at line 1356 of file libisoburn.h.

◆ isoburn_igopt_only_iso_versions

#define isoburn_igopt_only_iso_versions   4096

Definition at line 1368 of file libisoburn.h.

◆ isoburn_igopt_rockridge

#define isoburn_igopt_rockridge   1

Which extensions to support.

Since
0.1.0
Parameters
oThe option set to work on
extBitfield: bit0= rockridge Rock Ridge extensions add POSIX file attributes like owner, group, access permissions, long filenames. Very advisable if the designed audience has Unix style systems. bit1= joliet Longer filenames for Windows systems. Weaker than RockRidge, but also readable with GNU/Linux. bit2= iso1999 This is rather exotic. Better do not surprise the readers. bit3= hardlinks Enable hardlink consolidation. IsoNodes which refer to the same source object and have the same properties will get the same ISO image inode numbers. If combined with isoburn_igopt_rrip_version_1_10 below, then the PX entry layout of RRIP-1.12 will be used within RRIP-1.10 (mkisofs does this without causing visible trouble). bit5= aaip The libisofs specific SUSP based extension of ECMA-119 which can encode ACL and XFS-style Extended Attributes. bit6= session_md5
Since
0.4.2 Produce and write MD5 checksum tags of superblock, directory tree, and the whole session stream. bit7= file_md5
0.4.2 Produce and write MD5 checksums for each single IsoFile. bit8= file_stability (only together with file_md5)
0.4.2 Compute MD5 of each file before copying it into the image and compare this with the MD5 of the actual copying. If they do not match then issue MISHAP event. See also libisofs.h iso_write_opts_set_record_md5() bit9= no_emul_toc
0.5.8 On overwritable media or random access files do not write the first session to LBA 32 and do not copy the first 64kB of the first session to LBA 0, but rather write the first session to LBA 0 directly. bit10= will_cancel
0.6.6 Announce to libisofs that only the image size is desired and that the write thread will be cancelled by isoburn_cancel_prepared_write() before actual image writing occurs. Without this, cancellation can cause a MISHAP event. bit11= old_empty
1.0.2 Let symbolic links and device files point to block 0, and let empty data files point to the address of the Volume Descriptor Set Terminator. This was done by libisofs in the past. By default there is now a single dedicated block of zero bytes after the end of the directory trees, of which the address is used for all files without own content. bit12= hfsplus
1.2.4 Produce a HFS+ partition inside the ISO image and announce it by an Apple Partition Map in the System Area. >>> GPT production ? Caution: Interferes with isoburn_igopt_set_system_area() by overwriting the first 8 bytes of the data, and several blocks of 2 KiB after the first one. bit13= fat
1.2.4 >>> Not yet implemented. Planned to co-exist with hfsplus. Produce a FAT32 partition inside the ISO image and announce it by an MBR partition entry in the System Area. Caution: Interferes with isoburn_igopt_set_system_area() by >>> what impact ?
Returns
1 success, <=0 failure

Definition at line 1240 of file libisoburn.h.

◆ isoburn_igopt_rrip_version_1_10

#define isoburn_igopt_rrip_version_1_10   512

Definition at line 1365 of file libisoburn.h.

◆ isoburn_igopt_session_md5

#define isoburn_igopt_session_md5   64

Definition at line 1245 of file libisoburn.h.

◆ isoburn_igopt_sort_files_by_weight

#define isoburn_igopt_sort_files_by_weight   1

Whether and how files should be sorted.

Since
0.1.0
Parameters
oThe option set to work on
valueBitfield: bit0= sort_files_by_weight files should be sorted based on their weight. Weight is attributed to files in the image by libisofs call iso_node_set_sort_weight().
Returns
1 success, <=0 failure

Definition at line 1457 of file libisoburn.h.

◆ isoburn_igopt_will_cancel

#define isoburn_igopt_will_cancel   1024

Definition at line 1249 of file libisoburn.h.

◆ isoburn_libburn_req_major

#define isoburn_libburn_req_major   1

The minimum version of libburn to be used with this version of libisoburn at compile time.

Since
0.1.0

Definition at line 258 of file libisoburn.h.

◆ isoburn_libburn_req_micro

#define isoburn_libburn_req_micro   4

Definition at line 260 of file libisoburn.h.

◆ isoburn_libburn_req_minor

#define isoburn_libburn_req_minor   5

Definition at line 259 of file libisoburn.h.

◆ isoburn_libisofs_req_major

#define isoburn_libisofs_req_major   1

The minimum version of libisofs to be used with this version of libisoburn at compile time.

Since
0.1.0

Definition at line 250 of file libisoburn.h.

◆ isoburn_libisofs_req_micro

#define isoburn_libisofs_req_micro   4

Definition at line 252 of file libisoburn.h.

◆ isoburn_libisofs_req_minor

#define isoburn_libisofs_req_minor   5

Definition at line 251 of file libisoburn.h.

◆ isoburn_ropt_has_el_torito

#define isoburn_ropt_has_el_torito   8

Definition at line 1089 of file libisoburn.h.

◆ isoburn_ropt_has_iso1999

#define isoburn_ropt_has_iso1999   4

Definition at line 1088 of file libisoburn.h.

◆ isoburn_ropt_has_joliet

#define isoburn_ropt_has_joliet   2

Definition at line 1087 of file libisoburn.h.

◆ isoburn_ropt_has_rockridge

#define isoburn_ropt_has_rockridge   1

After calling function isoburn_read_image() there are information available in the option set about the size and the available extra trees and extensions in the ISO filesystem. This info can be obtained as bits in parameter has_what. Like: joliet_available = (has_what & isoburn_ropt_has_joliet);

Since
0.1.0
Parameters
oThe option set to work on
sizeNumber of image data blocks, 2048 bytes each.
has_whatBitfield: bit0= has_rockridge RockRidge extension info is available in the ISO 9660 tree (POSIX filesystem) bit1= has_joliet Joliet tree is available (suitable for MS-Windows) bit2= has_iso1999 ISO version 2 Enhanced Volume Descriptor aka ISO 9660:1999 and its tree is available. This is rather exotic. bit3= has_el_torito El-Torito boot record is present
Returns
1 success, <=0 failure

Definition at line 1086 of file libisoburn.h.

◆ isoburn_ropt_joliet_stripped

#define isoburn_ropt_joliet_stripped   ( 16384 | 32768)

Definition at line 942 of file libisoburn.h.

◆ isoburn_ropt_joliet_unmapped

#define isoburn_ropt_joliet_unmapped   ( 16384 | 0)

Definition at line 941 of file libisoburn.h.

◆ isoburn_ropt_map_lowercase

#define isoburn_ropt_map_lowercase   ( 2048 | 12288 )

Definition at line 940 of file libisoburn.h.

◆ isoburn_ropt_map_stripped

#define isoburn_ropt_map_stripped   ( 2048 | 4096 )

Definition at line 938 of file libisoburn.h.

◆ isoburn_ropt_map_unmapped

#define isoburn_ropt_map_unmapped   ( 2048 | 0 )

Definition at line 937 of file libisoburn.h.

◆ isoburn_ropt_map_uppercase

#define isoburn_ropt_map_uppercase   ( 2048 | 8192 )

Definition at line 939 of file libisoburn.h.

◆ isoburn_ropt_noaaip

#define isoburn_ropt_noaaip   32

Definition at line 931 of file libisoburn.h.

◆ isoburn_ropt_noacl

#define isoburn_ropt_noacl   64

Definition at line 932 of file libisoburn.h.

◆ isoburn_ropt_noea

#define isoburn_ropt_noea   128

Definition at line 933 of file libisoburn.h.

◆ isoburn_ropt_noino

#define isoburn_ropt_noino   256

Definition at line 934 of file libisoburn.h.

◆ isoburn_ropt_noiso1999

#define isoburn_ropt_noiso1999   4

Definition at line 928 of file libisoburn.h.

◆ isoburn_ropt_nojoliet

#define isoburn_ropt_nojoliet   2

Definition at line 927 of file libisoburn.h.

◆ isoburn_ropt_nomd5

#define isoburn_ropt_nomd5   512

Definition at line 935 of file libisoburn.h.

◆ isoburn_ropt_nomd5tag

#define isoburn_ropt_nomd5tag   1024

Definition at line 936 of file libisoburn.h.

◆ isoburn_ropt_norock

#define isoburn_ropt_norock   1

Which existing ISO 9660 extensions in the image to read or not to read. Whether to read the content of an existing image at all. The bits can be combined by | and inquired by &.

Since
0.1.0
Parameters
extBitfield: bit0= norock Do not read Rock Ridge extensions bit1= nojoliet Do not read Joliet extensions bit2= noiso1999 Do not read ISO 9660:1999 enhanced tree bit3= preferjoliet When both Joliet and RR extensions are present, the RR tree is used. If you prefer using Joliet, set this to 1. bit4= pretend_blank Always create empty image.Ignore any image on input drive. bit5= noaaip
Since
0.3.4 Do not load AAIP information from image. This information eventually contains ACL or XFS-style Extended Attributes. bit6= noacl
0.3.4 Do not obtain ACL from external filesystem objects (e.g. local filesystem files). bit7= noea
0.3.4 Do not obtain XFS-style Extended Attributes from external filesystem objects (e.g. local filesystem files). bit8= noino
0.4.0 Do not load eventual inode numbers from RRIP entry PX, but generate a new unique inode number for each imported IsoNode object. PX inode numbers mark families of hardlinks by giving all family members the same inode number. libisofs keeps the PX inode numbers unaltered when IsoNode objects get written into an ISO image. bit9= nomd5
0.4.2 Do not load the possibly present MD5 checksum array. Do not check possibly present session_md5 tags. bit10= nomd5tag
1.0.4 Do not check session_md5 tags although bit9 is not set. bit11= do_ecma119_map
1.4.2 Set iso_read_opts_set_ecma119_map() to map_mode rather than relying on the default setting of libisofs. bit12 - bit13= map_mode
1.4.2 How to convert file names if neither Rock Ridge nor Joliet names are present and acceptable. 0 = unmapped: Take name as recorded in ECMA-119 directory record (not suitable for writing them to a new ISO filesystem) 1 = stripped: Like unmapped, but strip off trailing ";1" or ".;1" 2 = uppercase: Like stripped, but map {a-z} to {A-Z} 3 = lowercase: Like stripped, but map {A-Z} to {a-z} bit14= do_joliet_map
1.5.4 Set iso_read_opts_set_joliet_map() to joliet_map_mode rather than relying on the default setting of libisofs. bit15= joliet_map_mode
1.5.4 How to convert Joliet file names. 0 = unmapped: Take name as recorded in Joliet directory record (not suitable for writing them to a new ISO filesystem) 1 = stripped: strip off trailing ";1" or ".;1"
Returns
1 success, <=0 failure

Definition at line 926 of file libisoburn.h.

◆ isoburn_ropt_preferjoliet

#define isoburn_ropt_preferjoliet   8

Definition at line 929 of file libisoburn.h.

◆ isoburn_ropt_pretend_blank

#define isoburn_ropt_pretend_blank   16

Definition at line 930 of file libisoburn.h.

Function Documentation

◆ isoburn_activate_session()

int isoburn_activate_session ( struct burn_drive d)

Call this after isoburn_disc_write has finished and burn_drive_wrote_well() indicates success. It will eventually complete the emulation of multi-session functionality, if needed at all. Let libisoburn decide. Not a wrapper, but peculiar to libisoburn.

Since
0.1.0
Parameters
dThe output drive to which the session was written
Returns
1 success , <=0 failure

Definition at line 393 of file isofs_wrap.c.

References BURN_DISC_APPENDABLE, BURN_DISC_BLANK, burn_drive_get_drive_role(), burn_random_access_write(), isoburn::do_fsync, isoburn::drive, isoburn::emulation_mode, isoburn::fabricated_disc_status, isoburn::fabricated_msc2, isoburn_find_emulator(), isoburn::target_iso_head, isoburn::target_iso_head_size, and isoburn::zero_nwa.

Referenced by isoburn_invalidate_iso(), and Xorriso_write_session().

◆ isoburn_attach_image()

int isoburn_attach_image ( struct burn_drive d,
IsoImage image 
)

Set the IsoImage to be used with a drive. This eventually releases the reference to the old IsoImage attached to the drive. Caution: Use with care. It hardly makes sense to replace an image that reflects a valid ISO image on the medium. This call is rather intended for writing a newly created and populated image to blank media. The use case in xorriso is to let an image survive the change or demise of the outdev target drive.

Since
0.1.0
Parameters
dThe drive which shall be write target of the volset.
imageThe image that represents the image to be written. This image pointer MUST already be a valid reference suitable for iso_image_unref(). It may have been obtained by appropriate libisofs calls or by isoburn_read_image() with d==NULL.
Returns
<=0 error , 1 = success

Definition at line 351 of file isofs_wrap.c.

References isoburn::image, isoburn::image_start_lba, iso_image_unref(), isoburn_find_emulator(), and isoburn_msgs_submit().

Referenced by Xorriso_aquire_drive().

◆ isoburn_attach_start_lba()

int isoburn_attach_start_lba ( struct burn_drive d,
int  lba,
int  flag 
)

Set the start address of the image that is attached to the drive, if any.

Since
1.2.2
Parameters
dThe drive to inquire
lbaThe logical block address where the System Area of the image starts. <0 means that the address is invalid.
flagBitfield, submit 0 for now.
Returns
<=0 error (e.g. because no image is attached), 1 = success

Definition at line 374 of file isofs_wrap.c.

References isoburn::image, isoburn::image_start_lba, and isoburn_find_emulator().

Referenced by Xorriso_aquire_drive().

◆ isoburn_cancel_prepared_write()

int isoburn_cancel_prepared_write ( struct burn_drive input_drive,
struct burn_drive output_drive,
int  flag 
)

Revoke isoburn_prepare_*() instead of running isoburn_disc_write(). libisofs reserves resources and maybe already starts generating the image stream when one of above three calls is performed. It is mandatory to either run isoburn_disc_write() or to revoke the preparations by the call described here. If this call returns 0 or 1 then the write thread of libisofs has ended.

Since
0.1.0
Parameters
input_driveThe drive or in_drive which was used with the preparation call.
output_driveThe out_drive used with isoburn_prepare_new_image(), NULL if none.
flagBitfield, submit 0 for now. bit0= -reserved for internal use-
Returns
<0 error, 0= no pending preparations detectable, 1 = canceled

Definition at line 767 of file isoburn.c.

References burn_source_free(), burn_source::cancel, isoburn::iso_source, isoburn_find_emulator(), burn_source::read, and burn_source::version.

Referenced by isoburn_sync_after_write(), Xorriso_pacifier_loop(), and Xorriso_write_session().

◆ isoburn_conv_name_chars()

int isoburn_conv_name_chars ( struct isoburn_imgen_opts opts,
char *  name,
size_t  name_len,
char **  result,
size_t *  result_len,
int  flag 
)

Frontend of libisofs call iso_conv_name_chars() controlled by struct isoburn_imgen_opts rather than IsoWriteOpts. See libisofs.h for a more detailed description.

Since
1.3.6
Parameters
optsDefines options like output charset, UCS-2 versus UTF-16 for Joliet, and naming restrictions.
nameThe input text which shall be converted.
name_lenThe number of bytes in input text.
resultWill return the conversion result in case of success. Terminated by a trailing zero byte. Use free() to dispose it when no longer needed.
result_lenWill return the number of bytes in result (excluding trailing zero)
flagBitfield for control purposes. bit0-bit7= Name space 0= generic (to_charset is valid, no reserved characters, no length limits) 1= Rock Ridge (to_charset is valid) 2= Joliet (to_charset gets overridden by UCS-2 or UTF-16) 3= ECMA-119 (to_charset gets overridden by the dull ISO 9660 subset of ASCII) 4= HFS+ (to_charset gets overridden by UTF-16BE) bit8= Treat input text as directory name (matters for Joliet and ECMA-119) bit9= Do not issue error messages bit15= Reverse operation (best to be done only with results of previous conversions)
Returns
1 means success, <=0 means error

Definition at line 2038 of file isoburn.c.

References iso_conv_name_chars(), iso_write_opts_free(), iso_write_opts_new(), isoburn_make_iso_write_opts(), and isoburn_report_iso_error().

Referenced by Xorriso_test_outchar().

◆ isoburn_disc_available_space()

off_t isoburn_disc_available_space ( struct burn_drive d,
struct burn_write_opts o 
)

Return the best possible estimation of the currently available capacity of the medium. This might depend on particular write option settings and on drive state. An eventual start address for emulated multi-session will be subtracted from the capacity estimation given by burn_disc_available_space(). Negative results get defaulted to 0. Wrapper for: burn_disc_available_space()

Since
0.1.0
Parameters
dThe drive to query.
oIf not NULL: write parameters to be set on drive before query
Returns
number of most probably available free bytes

Definition at line 771 of file burn_wrap.c.

References burn_disc_available_space(), BURN_DISC_FULL, burn_write_opts_free(), burn_write_opts_new(), burn_write_opts_set_start_byte(), isoburn::emulation_mode, isoburn_disc_get_status(), isoburn_find_emulator(), and isoburn::nwa.

Referenced by Xorriso_sanitize_image_size(), Xorriso_tell_media_space(), and Xorriso_toc().

◆ isoburn_disc_erasable()

int isoburn_disc_erasable ( struct burn_drive d)

Tells whether the medium can be treated by isoburn_disc_erase(). Wrapper for: burn_disc_erasable()

Since
0.1.0
Parameters
dThe drive to inquire.
Returns
0=not erasable , else erasable

Definition at line 682 of file burn_wrap.c.

References burn_disc_erasable(), isoburn::emulation_mode, and isoburn_find_emulator().

Referenced by Xorriso_blank_media().

◆ isoburn_disc_erase()

void isoburn_disc_erase ( struct burn_drive drive,
int  fast 
)

Mark the medium as blank. With multi-session media this will call burn_disc_erase(). With random access media, an eventual ISO-9660 filesystem will get invalidated by altering its start blocks on the medium. In case of success, the medium is in status BURN_DISC_BLANK afterwards. Wrapper for: burn_disc_erase()

Since
0.1.0
Parameters
driveThe drive with the medium to erase.
fast1=fast erase, 0=thorough erase With DVD-RW, fast erase yields media incapable of multi-session.

Definition at line 710 of file burn_wrap.c.

References burn_disc_erase(), burn_disc_free_multi_caps(), BURN_DISC_FULL, burn_disc_get_multi_caps(), burn_disc_get_status(), burn_drive_cancel(), burn_drive_get_drive_role(), burn_random_access_write(), BURN_WRITE_NONE, isoburn::emulation_mode, isoburn::fabricated_disc_status, isoburn_disc_get_status(), isoburn_find_emulator(), isoburn_invalidate_iso(), isoburn_is_overwritable(), Libisoburn_target_head_sizE, isoburn::nwa, burn_multi_caps::start_adr, and isoburn::zero_nwa.

Referenced by Xorriso_blank_media().

◆ isoburn_disc_get_msc1()

int isoburn_disc_get_msc1 ( struct burn_drive d,
int *  start_lba 
)

Obtain the start block number of the most recent session on the medium. In case of random access media this will normally be 0. Successful return is not a guarantee that there is a ISO-9660 image at all. The call will fail, nevertheless,if isoburn_disc_get_status() returns not BURN_DISC_APPENDABLE or BURN_DISC_FULL. Note: The result of this call may be fabricated by a previous call of isoburn_set_msc1() which can override the rule to load the most recent session. Wrapper for: burn_disc_get_msc1()

Since
0.1.0
Parameters
dThe drive to inquire
start_lbaContains on success the start address in 2048 byte blocks
Returns
<=0 error , 1 = success

Definition at line 799 of file burn_wrap.c.

References BURN_DISC_APPENDABLE, BURN_DISC_FULL, burn_disc_get_msc1(), isoburn::emulation_mode, isoburn::fabricated_msc1, isoburn_disc_get_status(), isoburn_find_emulator(), and isoburn_msgs_submit().

Referenced by isoburn_read_image(), Xorriso_aquire_drive(), Xorriso_msinfo(), Xorriso_set_system_area(), and Xorriso_update_iso_lba0().

◆ isoburn_disc_get_status()

enum burn_disc_status isoburn_disc_get_status ( struct burn_drive drive)

Inquire the medium status. Expect the whole spectrum of libburn BURN_DISC_* with multi-session media. Emulated states with random access media are BURN_DISC_BLANK and BURN_DISC_APPENDABLE. Wrapper for: burn_disc_get_status()

Since
0.1.0
Parameters
driveThe drive to inquire.
Returns
The status of the drive, or what kind of disc is in it. Note: BURN_DISC_UNGRABBED indicates wrong API usage

Definition at line 627 of file burn_wrap.c.

References isoburn::drive, isoburn_find_by_drive(), and isoburn_msgs_submit().

Referenced by isoburn_disc_available_space(), isoburn_disc_erase(), isoburn_disc_get_msc1(), isoburn_disc_track_lba_nwa(), isoburn_is_intermediate_dvd_rw(), isoburn_needs_emulation(), isoburn_prepare_disc_aux(), isoburn_read_image(), isoburn_set_msc1(), Xorriso_aquire_drive(), Xorriso_blank_as_needed(), Xorriso_blank_media(), Xorriso_burn_track(), Xorriso_check_media(), Xorriso_format_media(), Xorriso_make_write_options(), Xorriso_msinfo(), Xorriso_obtain_indev_readsize(), Xorriso_sanitize_image_size(), Xorriso_set_system_area(), Xorriso_toc(), and Xorriso_write_session().

◆ isoburn_disc_pretend_full_uncond()

int isoburn_disc_pretend_full_uncond ( struct burn_drive drive)

Sets the medium status to BURN_DISC_FULL unconditionally.

Since
1.3.8
Parameters
driveThe drive with the medium to be handled as if it was closed. @

Definition at line 669 of file burn_wrap.c.

References BURN_DISC_FULL, burn_disc_pretend_full_uncond(), isoburn::drive, isoburn::fabricated_disc_status, and isoburn_find_emulator().

Referenced by Xorriso_pretend_full_disc().

◆ isoburn_disc_track_lba_nwa()

int isoburn_disc_track_lba_nwa ( struct burn_drive d,
struct burn_write_opts o,
int  trackno,
int *  lba,
int *  nwa 
)

Use this with trackno==0 to obtain the predicted start block number of the new session. The interesting number is returned in parameter nwa. Wrapper for: burn_disc_track_lba_nwa()

Since
0.1.0
Parameters
dThe drive to inquire
oIf not NULL: write parameters to be set on drive before query
tracknoSubmit 0.
lbareturn value: start lba
nwareturn value: Next Writeable Address
Returns
1=nwa is valid , 0=nwa is not valid , -1=error

Definition at line 831 of file burn_wrap.c.

References BURN_DISC_BLANK, burn_disc_track_lba_nwa(), burn_drive_get_drive_role(), isoburn::emulation_mode, isoburn_disc_get_status(), isoburn_find_emulator(), and isoburn::nwa.

Referenced by isoburn_get_msc2(), isoburn_make_iso_write_opts(), Xorriso_burn_track(), Xorriso_msinfo(), Xorriso_sanitize_image_size(), and Xorriso_toc().

◆ isoburn_disc_write()

void isoburn_disc_write ( struct burn_write_opts o,
struct burn_disc disc 
)

◆ isoburn_drive_aquire()

int isoburn_drive_aquire ( struct burn_drive_info drive_infos[],
char *  adr,
int  flag 
)

Acquire a target drive by its filesystem path or libburn persistent address. This is a modern successor of isoburn_drive_scan_and_grab().
Wrapper for: burn_drive_scan_and_grab()

Since
0.1.2
Parameters
drive_infosOn success returns a one element array with the drive (cdrom/burner). Thus use with driveno 0 only. On failure the array has no valid elements at all. The returned array should be freed via burn_drive_info_free() when the drive is no longer needed. But before this is done one has to call isoburn_drive_release(drive_infos[0].drive).
adrThe persistent address of the desired drive or the path to a file object.
flagbit0= attempt to load the disc tray. Else: failure if not loaded. bit1= regard overwritable media as blank bit2= if the drive is a regular disk file: truncate it to the write start address when writing begins bit3= if the drive reports a read-only profile try to read table of content by scanning for ISO image headers. (depending on media type and drive this might help or it might make the resulting toc even worse) bit4= do not emulate table of content on overwritable media bit5= ignore ACL from external filesystems bit6= ignore POSIX Extended Attributes from external filesystems (xattr) bit7= pretend read-only profile and scan for table of content bit8= re-assess already acquired (*drive_infos)[0] rather than acquiring adr
Since
1.1.8 bit9= when scanning for ISO 9660 sessions by bit3: Do not demand a valid superblock at LBA 0, ignore it in favor of one at LBA 32, and scan until end of medium.
1.2.6 bit10= if not bit6: accept all xattr namespaces from external filesystems, not only "user.".
1.5.0
Returns
1 = success , 0 = drive not found , <0 = other error

Please excuse the typo "aquire" in the function name.

Parameters
flagbit0= load bit1= regard overwritable media as blank bit2= if the drive is a regular disk file: truncate it to the write start address bit3= if the drive reports a -ROM profile then try to read table of content by scanning for ISO image headers. (depending on media type and drive state this might help or it might make the resulting toc even worse) bit4= do not emulate TOC on overwritable media bit5= ignore ACL from external filesystems bit6= ignore POSIX Extended Attributes from external filesystems bit7= pretend -ROM profile and scan for table of content bit8= re-assess (*drive_infos)[0] rather than acquiring adr bit9= when scanning for ISO 9660 sessions on overwritable media: Do not demand a valid superblock at LBA 0 and scan until end of medium. bit10= if not bit6: accept all xattr namespaces from external filesystems, not only "user.".

Definition at line 545 of file burn_wrap.c.

References BURN_DRIVE_ADR_LEN, burn_drive_convert_fs_adr(), burn_drive_re_assess(), burn_drive_release(), burn_drive_scan_and_grab(), isoburn::drive, isoburn_destroy(), isoburn_find_emulator(), isoburn_welcome_media(), and isoburn::truncate.

Referenced by isoburn_drive_scan_and_grab(), Xorriso_aquire_drive(), and Xorriso_mount().

◆ isoburn_drive_grab()

int isoburn_drive_grab ( struct burn_drive drive,
int  load 
)

Acquire a drive from the burn_drive_info[] array which was obtained by a previous call of burn_drive_scan(). Wrapper for: burn_drive_grab()

Since
0.1.0
Parameters
driveThe drive to grab. E.g. drive_infos[1].drive . Call isoburn_drive_release(drive) when it it no longer needed.
load1 attempt to load the disc tray. 0 no attempt, rather failure.
Returns
1 success, <=0 failure

Definition at line 604 of file burn_wrap.c.

References burn_drive_grab(), isoburn::drive, isoburn_destroy(), and isoburn_welcome_media().

◆ isoburn_drive_release()

void isoburn_drive_release ( struct burn_drive drive,
int  eject 
)

Release an acquired drive. Wrapper for: burn_drive_release()

Since
0.1.0
Parameters
driveThe drive to be released
eject1= eject medium from drive , 0= do not eject

Definition at line 1039 of file burn_wrap.c.

References burn_drive_release(), isoburn::drive, isoburn_destroy(), and isoburn_find_emulator().

Referenced by Xorriso_give_up_drive(), and Xorriso_mount().

◆ isoburn_drive_scan_and_grab()

int isoburn_drive_scan_and_grab ( struct burn_drive_info drive_infos[],
char *  adr,
int  load 
)

Acquire a target drive by its filesystem path or libburn persistent address. Wrapper for: burn_drive_scan_and_grab()

Since
0.1.0
Parameters
drive_infosOn success returns a one element array with the drive (cdrom/burner). Thus use with driveno 0 only. On failure the array has no valid elements at all. The returned array should be freed via burn_drive_info_free() when the drive is no longer needed. But before this is done one has to call isoburn_drive_release(drive_infos[0].drive).
adrThe persistent address of the desired drive or the path to a file object.
load1 attempt to load the disc tray. 0 no attempt,rather failure.
Returns
1 = success , 0 = drive not found , <0 = other error

Definition at line 594 of file burn_wrap.c.

References isoburn_drive_aquire().

◆ isoburn_drive_set_msgs_submit()

int isoburn_drive_set_msgs_submit ( struct burn_drive d,
int(*)(void *handle, int error_code, char msg_text[], int os_errno, char severity[], int flag)  msgs_submit,
void *  submit_handle,
int  submit_flag,
int  flag 
)

Attach to a drive an application provided method for immediate delivery of messages. If no method is set or if the method is set to NULL then libisoburn delivers messages of the drive through the global msgs_submit() method set by isoburn_set_msgs_submiti() or by the message queue of libburn.

Since
0.2.0
Parameters
dThe drive to which this function, handle and flag shall apply
msgs_submitThe function call which implements the method
submit_handleHandle to be used as first argument of msgs_submit
submit_flagFlag to be used as last argument of msgs_submit
flagUnused yet, submit 0

Definition at line 1915 of file burn_wrap.c.

References isoburn_find_emulator(), isoburn::msgs_submit, isoburn::msgs_submit_flag, and isoburn::msgs_submit_handle.

◆ isoburn_drive_wrote_well()

int isoburn_drive_wrote_well ( struct burn_drive d)

Inquire whether the most recent write run was successful. Wrapper for: burn_drive_wrote_well()

Since
0.1.0
Parameters
dThe drive to inquire
Returns
1=burn seems to have went well, 0=burn failed

Definition at line 1132 of file burn_wrap.c.

References burn_drive_wrote_well(), isoburn_find_emulator(), and isoburn::wrote_well.

Referenced by Xorriso_write_session().

◆ isoburn_finish()

void isoburn_finish ( void  )

Shutdown all three libraries. Wrapper for : iso_finish() and burn_finish().

Since
0.1.0

Definition at line 1054 of file burn_wrap.c.

References burn_finish(), iso_finish(), isoburn_destroy_all(), and isoburn_list_start.

Referenced by Xorriso_detach_libraries().

◆ isoburn_get_attached_image()

IsoImage* isoburn_get_attached_image ( struct burn_drive d)

Get the image attached to a drive, if any.

Since
0.1.0
Parameters
dThe drive to inquire
Returns
A reference to attached image, or NULL if the drive has no image attached. This reference needs to be released via iso_image_unref() when it is not longer needed.

Definition at line 92 of file isofs_wrap.c.

References isoburn::image, iso_image_ref(), and isoburn_find_emulator().

Referenced by Xorriso_aquire_drive(), Xorriso_attach_boot_image(), Xorriso_boot_image_status(), Xorriso_pacifier_loop(), Xorriso_record_boot_info(), Xorriso_set_system_area_path(), Xorriso_show_boot_info(), and Xorriso_write_session().

◆ isoburn_get_attached_start_lba()

int isoburn_get_attached_start_lba ( struct burn_drive d)

Get the start address of the image that is attached to the drive, if any.

Since
1.2.2
Parameters
dThe drive to inquire
Returns
The logical block address where the System Area of the image starts. <0 means that the address is invalid.

Definition at line 109 of file isofs_wrap.c.

References isoburn::image, isoburn::image_start_lba, and isoburn_find_emulator().

Referenced by Xorriso_aquire_drive(), and Xorriso_check_media().

◆ isoburn_get_fifo_status()

int isoburn_get_fifo_status ( struct burn_drive d,
int *  size,
int *  free_bytes,
char **  status_text 
)

Inquire state and fill parameters of the fifo which is attached to the emerging track. This should be done in the pacifier loop while isoburn_disc_write() or burn_disc_write() are active. This works only with drives obtained by isoburn_drive_scan_and_grab() or isoburn_drive_grab(). If isoburn_prepare_new_image() was used, then parameter out_drive must have announced the track output drive. Hint: If only burn_write_opts and not burn_drive is known, then the drive can be obtained by burn_write_opts_get_drive().

Since
0.1.0
Parameters
dThe drive to which the track with the fifo gets burned.
sizeThe total size of the fifo
free_bytesThe current free capacity of the fifo
status_textReturns a pointer to a constant text, see below
Returns
<0 reply invalid, >=0 fifo status code: bit0+1=input status, bit2=consumption status, i.e: 0="standby" : data processing not started yet 1="active" : input and consumption are active 2="ending" : input has ended without error 3="failing" : input had error and ended, 4="unused" : ( consumption has ended before processing start ) 5="abandoned" : consumption has ended prematurely 6="ended" : consumption has ended without input error 7="aborted" : consumption has ended after input error

Definition at line 1148 of file burn_wrap.c.

References iso_ring_buffer_get_status(), isoburn::iso_source, and isoburn_find_emulator().

Referenced by Xorriso_pacifier_loop().

◆ isoburn_get_img_partition_offset()

int isoburn_get_img_partition_offset ( struct burn_drive drive,
uint32_t *  block_offset_2k 
)

Inquire the partition offset of the loaded image. The first 512 bytes of the image get examined whether they bear an MBR signature and a first partition table entry which matches the size of the image. In this case the start address is recorded as partition offset and internal buffers get adjusted. See also isoburn_igopt_set_part_offset().

Since
0.6.2
Parameters
driveThe drive with the loaded image
block_offset_2kreturns the recognized partition offset
Returns
<0 = error 0 = no partition offset recognized 1 = acceptable non-zero offset, buffers are adjusted 2 = offset is credible but not acceptable for buffer size

API

Since
0.6.2

Definition at line 424 of file isofs_wrap.c.

References isoburn::drive, isoburn_find_emulator(), Libisoburn_target_head_sizE, isoburn::loaded_partition_offset, and isoburn::target_iso_head_size.

Referenced by Xorriso_aquire_drive(), and Xorriso_set_system_area().

◆ isoburn_get_min_start_byte()

int isoburn_get_min_start_byte ( struct burn_drive d,
off_t *  start_byte,
int  flag 
)

Obtain the size which was attributed to an emulated appendable on actually overwritable media. This value is supposed to be <= 2048 * nwa as of isoburn_disc_track_lba_nwa().

Since
0.1.0
Parameters
dThe drive holding the medium.
start_byteThe reply value counted in bytes, not in sectors.
flagUnused yet. Submit 0.
Returns
1=stat_byte is valid, 0=not an emulated appendable, -1=error

Definition at line 1114 of file burn_wrap.c.

References isoburn_find_emulator(), and isoburn::min_start_byte.

Referenced by Xorriso_toc().

◆ isoburn_get_mount_params()

int isoburn_get_mount_params ( struct burn_drive d,
int  adr_mode,
char *  adr_value,
int *  lba,
int *  track,
int *  session,
char  volid[33],
int  flag 
)

Try to convert the given entity address into various entity addresses which would describe it. Note: Sessions and tracks are counted beginning with 1, not with 0.

Since
0.3.2
Parameters
dThe drive where msc1 is to be set
adr_modeDetermines how to interpret the input adr_value. If adr_value shall represent a number then decimal ASCII digits are expected. 0= start lba of last session in TOC, ignore adr_value 1= start lba of session number given by adr_value 2= start lba of track given number by adr_value 3= adr_value itself is the lba to be used 4= start lba of last session with volume id given by adr_value
adr_valueA string describing the value to be eventually used.
lbareturns the block address of the entity, -1 means invalid
trackreturns the track number of the entity, -1 means invalid
sessionreturns the session number of the entity, -1 means invalid
volidreturns the volume id of the entity if it is a ISO session
flagBitfield for control purposes. bit2= with adr_mode 4: use adr_value as regular expression
Returns
<=0 error , 1 ok, ISO session, 2 ok, not an ISO session

Definition at line 2105 of file burn_wrap.c.

References isoburn_toc_disc::disc, isoburn::fabricated_msc1, isoburn_find_emulator(), isoburn_get_track_lba(), isoburn_read_iso_head(), isoburn_set_msc1(), isoburn_toc_disc_free(), isoburn_toc_disc_get_sessions(), isoburn_toc_drive_get_disc(), isoburn_toc_session_get_tracks(), and isoburn_toc_track::track.

Referenced by Xorriso_aquire_drive(), Xorriso_mount(), and Xorriso_truncate_overwritable().

◆ isoburn_igopt_attach_jte()

int isoburn_igopt_attach_jte ( struct isoburn_imgen_opts opts,
void *  libjte_handle 
)

Associate a libjte environment object to the upcoming write run. libjte implements Jigdo Template Extraction as of Steve McIntyre and Richard Atterer. A non-NULL libjte_handle will cause failure to write if libjte was not enabled in libisofs at compile time.

Since
0.6.4
Parameters
optsThe option set to work on
libjte_handlePointer to a struct libjte_env e.g. created by libjte_new(). It must stay existent from the start of image writing by isoburn_prepare_*() until the write thread has ended. E.g. until libburn indicates the end of its write run.
Returns
1 success, <=0 failure

Definition at line 1621 of file isoburn.c.

References isoburn_imgen_opts::libjte_handle.

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_destroy()

int isoburn_igopt_destroy ( struct isoburn_imgen_opts **  o,
int  flag 
)

Deletes an option set which was created by isoburn_igopt_new().

Since
0.1.0
Parameters
oThe option set to give up
flagBitfield for control purposes. Submit 0 for now.
Returns
1= **o destroyed , 0= *o was already NULL (harmless)

Definition at line 1216 of file isoburn.c.

References Libisoburn_max_appended_partitionS.

Referenced by Xorriso_relax_compliance(), Xorriso_test_outchar(), and Xorriso_write_session().

◆ isoburn_igopt_detach_jte()

int isoburn_igopt_detach_jte ( struct isoburn_imgen_opts opts,
void **  libjte_handle 
)

Remove eventual association to a libjte environment handle.

Since
0.6.4
Parameters
optsThe option set to work on
libjte_handleIf not submitted as NULL, this will return the previously set libjte handle.
Returns
1 success, <=0 failure

Definition at line 1629 of file isoburn.c.

References isoburn_imgen_opts::libjte_handle.

◆ isoburn_igopt_get_appended_as_apm()

int isoburn_igopt_get_appended_as_apm ( struct isoburn_imgen_opts opts,
int *  apm 
)

Inquire the current setting made by isoburn_igopt_set_appended_as_apm().

Since
1.4.4
Parameters
optsThe option set to be inquired.
apmReturns the current value.
Returns
<=0 = error, 1 = success

Definition at line 1854 of file isoburn.c.

References isoburn_imgen_opts::appended_as_apm.

◆ isoburn_igopt_get_appended_as_gpt()

int isoburn_igopt_get_appended_as_gpt ( struct isoburn_imgen_opts opts,
int *  gpt 
)

Inquire the current setting made by isoburn_igopt_set_appended_as_gpt().

Since
1.4.0
Parameters
optsThe option set to be inquired.
gptReturns the current value.
Returns
<=0 = error, 1 = success

Definition at line 1797 of file isoburn.c.

References isoburn_imgen_opts::appended_as_gpt.

◆ isoburn_igopt_get_data_start()

int isoburn_igopt_get_data_start ( struct isoburn_imgen_opts o,
int *  lba 
)

Obtain after image preparation the lowest block address of file content data. Failure can occur if libisofs is too old to provide this information, if the result exceeds 31 bit, or if the call is made before image preparation. This value cannot be set by the application but only be inquired.

Since
0.3.6
Parameters
oThe option set to work on
lbaThe block number of the session start on the medium. <0 means that no address has been determined yet.
Returns
1 success, <=0 failure

Definition at line 1503 of file isoburn.c.

References isoburn_imgen_opts::data_start_lba.

Referenced by Xorriso_write_session().

◆ isoburn_igopt_get_disc_label()

int isoburn_igopt_get_disc_label ( struct isoburn_imgen_opts opts,
char **  label 
)

Inquire the current setting made by isoburn_igopt_set_disc_label().

Since
0.6.6
Parameters
optsThe option set to be inquired.
labelReturns a pointer to the currently set label string. Do not alter this string. Use only as long as the opts object exists.
Returns
<=0 = error, 1 = success

Definition at line 1948 of file isoburn.c.

References isoburn_imgen_opts::ascii_disc_label.

◆ isoburn_igopt_get_effective_lba()

int isoburn_igopt_get_effective_lba ( struct isoburn_imgen_opts o,
int *  lba 
)

Obtain after image preparation the block address where the session will start on the medium. This value cannot be set by the application but only be inquired.

Since
0.1.4
Parameters
oThe option set to work on
lbaThe block number of the session start on the medium. <0 means that no address has been determined yet.
Returns
1 success, <=0 failure

Definition at line 1496 of file isoburn.c.

References isoburn_imgen_opts::effective_lba.

Referenced by Xorriso_write_session().

◆ isoburn_igopt_get_efi_bootp()

int isoburn_igopt_get_efi_bootp ( struct isoburn_imgen_opts opts,
char **  path,
int  flag 
)

◆ isoburn_igopt_get_extensions()

◆ isoburn_igopt_get_fifo_size()

int isoburn_igopt_get_fifo_size ( struct isoburn_imgen_opts o,
int *  fifo_size 
)

Definition at line 1489 of file isoburn.c.

References isoburn_imgen_opts::fifo_size.

◆ isoburn_igopt_get_gpt_guid()

int isoburn_igopt_get_gpt_guid ( struct isoburn_imgen_opts opts,
uint8_t  guid[16],
int *  mode 
)

Inquire the current setting of isoburn_igopt_set_gpt_guid().

Since
1.4.6
Parameters
optsThe option set to be inquired.
guidReturns the current guid if current mode is 1.
modeReturns the current value.
Returns
<=0 = error, 1 = success

Definition at line 1930 of file isoburn.c.

References isoburn_imgen_opts::gpt_guid, and isoburn_imgen_opts::gpt_guid_mode.

◆ isoburn_igopt_get_hfsp_block_size()

int isoburn_igopt_get_hfsp_block_size ( struct isoburn_imgen_opts opts,
int *  hfsp_block_size,
int *  apm_block_size 
)

Inquire the current setting made by isoburn_igopt_set_hfsp_block_size

Since
1.2.4
Parameters
optsThe option set to be inquired.
hfsp_block_sizeWill be set to a value as described above. Except -1.
apm_block_sizeWill be set to a value as described above. Except -1.
Returns
<=0 = error, 1 = success

Definition at line 2000 of file isoburn.c.

References isoburn_imgen_opts::apm_block_size, and isoburn_imgen_opts::hfsp_block_size.

◆ isoburn_igopt_get_hfsp_serial_number()

int isoburn_igopt_get_hfsp_serial_number ( struct isoburn_imgen_opts opts,
uint8_t  serial_number[8] 
)

Inquire the current setting made by isoburn_igopt_set_disc_label()

Since
1.2.4
Parameters
optsThe option set to be inquired.
serial_numberWill get filled with the current setting.
Returns
<=0 = error, 1 = success

Definition at line 1963 of file isoburn.c.

References isoburn_imgen_opts::hfsp_serial_number.

◆ isoburn_igopt_get_iso_mbr_part_type()

int isoburn_igopt_get_iso_mbr_part_type ( struct isoburn_imgen_opts opts,
int *  part_type 
)

Inquire the current setting of isoburn_igopt_set_iso_mbr_part_type().

Since
1.4.8
Parameters
optsThe option set to be inquired.
part_typeReturns the current value: -1, 0x00 to 0xff.
Returns
<=0 = error, 1 = success

Definition at line 1888 of file isoburn.c.

References isoburn_imgen_opts::iso_mbr_part_type.

◆ isoburn_igopt_get_iso_type_guid()

int isoburn_igopt_get_iso_type_guid ( struct isoburn_imgen_opts opts,
uint8_t  guid[16] 
)

Inquire the current setting of isoburn_igopt_set_iso_type_guid().

Since
1.5.2
Parameters
optsThe option set to be inquired.
guidGets filled with the 16 bytes of GUID.
Returns
<= error, 0= guid is invalid, 1 = guid is valid

Definition at line 1906 of file isoburn.c.

References isoburn_imgen_opts::iso_gpt_flag, and isoburn_imgen_opts::iso_gpt_type_guid.

◆ isoburn_igopt_get_level()

int isoburn_igopt_get_level ( struct isoburn_imgen_opts o,
int *  level 
)

Definition at line 1246 of file isoburn.c.

References isoburn_imgen_opts::level.

◆ isoburn_igopt_get_out_charset()

int isoburn_igopt_get_out_charset ( struct isoburn_imgen_opts o,
char **  output_charset 
)

Definition at line 1474 of file isoburn.c.

References isoburn_imgen_opts::output_charset.

◆ isoburn_igopt_get_over_mode()

int isoburn_igopt_get_over_mode ( struct isoburn_imgen_opts o,
int *  replace_dir_mode,
int *  replace_file_mode,
mode_t *  dir_mode,
mode_t *  file_mode 
)

◆ isoburn_igopt_get_over_ugid()

int isoburn_igopt_get_over_ugid ( struct isoburn_imgen_opts o,
int *  replace_uid,
int *  replace_gid,
uid_t *  uid,
gid_t *  gid 
)

◆ isoburn_igopt_get_part_flags()

int isoburn_igopt_get_part_flags ( struct isoburn_imgen_opts opts,
int  num_entries,
int  part_flags[] 
)

Inquire the current settings made by isoburn_igopt_set_part_flags().

Since
1.4.0
Parameters
optsThe option set to be inquired.
num_entriesNumber of array elements in part_flags[].
part_flagsThe array elements 0 to num_entries - 1 will get filled by the flag bits of the images of the corresponding partition.
Returns
<0 = error 0 = no partition image set >0 highest used partition number

Definition at line 1774 of file isoburn.c.

References isoburn_imgen_opts::appended_part_flags, and Libisoburn_max_appended_partitionS.

◆ isoburn_igopt_get_part_like_isohybrid()

int isoburn_igopt_get_part_like_isohybrid ( struct isoburn_imgen_opts opts,
int *  alike 
)

Inquire the current setting of isoburn_igopt_set_part_like_isohybrid().

Since
1.4.4
Parameters
optsThe option set to be inquired.
alikeReturns the current value.
Returns
<=0 = error, 1 = success

Definition at line 1870 of file isoburn.c.

References isoburn_imgen_opts::part_like_isohybrid.

◆ isoburn_igopt_get_part_offset()

int isoburn_igopt_get_part_offset ( struct isoburn_imgen_opts opts,
uint32_t *  block_offset_2k,
int *  secs_512_per_head,
int *  heads_per_cyl 
)

◆ isoburn_igopt_get_part_type_guid()

int isoburn_igopt_get_part_type_guid ( struct isoburn_imgen_opts opts,
int  num_entries,
uint8_t  guids[][16],
int  valids[] 
)

Inquire the current settings made by isoburn_igopt_set_part_type_guid().

Since
1.5.2
Parameters
optsThe option set to be inquired.
num_entriesNumber of array elements in part_flags[].
type_guidsThe array elements 0 to num_entries - 1 will get filled by the 16 flag bits of the images of the corresponding partition.
validsThe array elements 0 to num_entries - 1 will get filled by 1 or 0 to indicate whether the corresponding type_guids element is valid.
Returns
<0 = error 0 = no partition image set >0 highest used partition number

Definition at line 1827 of file isoburn.c.

References isoburn_imgen_opts::appended_part_gpt_flags, isoburn_imgen_opts::appended_part_type_guids, and Libisoburn_max_appended_partitionS.

◆ isoburn_igopt_get_partition_img()

int isoburn_igopt_get_partition_img ( struct isoburn_imgen_opts opts,
int  num_entries,
uint8_t  partition_types[],
char *  image_paths[] 
)

Inquire the current settings made by isoburn_igopt_set_partition_img().

Since
0.6.4
Parameters
optsThe option set to be inquired.
num_entriesNumber of array elements in partition_types[] and image_paths[].
partition_typesThe partition type associated with the partition. Valid only if image_paths[] of the same index is not NULL.
image_pathsIts elements get filled with either NULL or a pointer to a string with a file address or an empty text.
Returns
<0 = error 0 = no partition image set >0 highest used partition number

Definition at line 1735 of file isoburn.c.

References isoburn_imgen_opts::appended_part_types, isoburn_imgen_opts::appended_partitions, and Libisoburn_max_appended_partitionS.

◆ isoburn_igopt_get_prep_partition()

int isoburn_igopt_get_prep_partition ( struct isoburn_imgen_opts opts,
char **  path,
int  flag 
)

◆ isoburn_igopt_get_pvd_times()

int isoburn_igopt_get_pvd_times ( struct isoburn_imgen_opts opts,
time_t *  creation_time,
time_t *  modification_time,
time_t *  expiration_time,
time_t *  effective_time,
char  uuid[17] 
)

◆ isoburn_igopt_get_relaxed()

◆ isoburn_igopt_get_rr_reloc()

int isoburn_igopt_get_rr_reloc ( struct isoburn_imgen_opts o,
char **  name,
int *  flags 
)

Obtain the settings of isoburn_igopt_set_rr_reloc().

Since
1.2.2
Parameters
oThe option set to work on
nameWill return NULL or a pointer to the name of the relocation directory in the root directory. Do not alter or dispose the memory which holds this name.
flagsWill return the flags bitfield.
Returns
> 0 success, <= 0 failure

Definition at line 1351 of file isoburn.c.

References isoburn_imgen_opts::rr_reloc_dir, and isoburn_imgen_opts::rr_reloc_flags.

◆ isoburn_igopt_get_scdbackup_tag()

int isoburn_igopt_get_scdbackup_tag ( struct isoburn_imgen_opts o,
char  name[81],
char  timestamp[19],
char **  tag_written 
)

◆ isoburn_igopt_get_sort_files()

int isoburn_igopt_get_sort_files ( struct isoburn_imgen_opts o,
int *  value 
)

Definition at line 1412 of file isoburn.c.

References isoburn_imgen_opts::sort_files.

◆ isoburn_igopt_get_stdio_endsync()

int isoburn_igopt_get_stdio_endsync ( struct isoburn_imgen_opts opts,
int *  do_sync 
)

Definition at line 2031 of file isoburn.c.

References isoburn_imgen_opts::do_fsync.

◆ isoburn_igopt_get_system_area()

int isoburn_igopt_get_system_area ( struct isoburn_imgen_opts o,
char  data[32768],
int *  options 
)

◆ isoburn_igopt_get_tail_blocks()

int isoburn_igopt_get_tail_blocks ( struct isoburn_imgen_opts opts,
uint32_t *  num_blocks 
)

Definition at line 1646 of file isoburn.c.

References isoburn_imgen_opts::tail_blocks.

◆ isoburn_igopt_get_untranslated_name_len()

int isoburn_igopt_get_untranslated_name_len ( struct isoburn_imgen_opts o,
int *  len 
)

Definition at line 1397 of file isoburn.c.

References isoburn_imgen_opts::untranslated_name_len.

◆ isoburn_igopt_get_write_type()

int isoburn_igopt_get_write_type ( struct isoburn_imgen_opts opts,
int *  do_tao 
)

Definition at line 2018 of file isoburn.c.

References isoburn_imgen_opts::do_tao.

◆ isoburn_igopt_new()

int isoburn_igopt_new ( struct isoburn_imgen_opts **  o,
int  flag 
)

Produces a set of generation and transfer options, initialized with default values.

Since
0.1.0
Parameters
othe newly created option set object
flagBitfield for control purposes. Submit 0 for now.
Returns
1=ok , <0 = failure

Definition at line 1125 of file isoburn.c.

References isoburn_imgen_opts::aaip, isoburn_imgen_opts::aaip_susp_1_10, isoburn_imgen_opts::allow_7bit_ascii, isoburn_imgen_opts::allow_deep_paths, isoburn_imgen_opts::allow_dir_id_ext, isoburn_imgen_opts::allow_full_ascii, isoburn_imgen_opts::allow_longer_paths, isoburn_imgen_opts::allow_lowercase, isoburn_imgen_opts::always_gmt, isoburn_imgen_opts::apm_block_size, isoburn_imgen_opts::appended_as_apm, isoburn_imgen_opts::appended_as_gpt, isoburn_imgen_opts::appended_part_flags, isoburn_imgen_opts::appended_part_gpt_flags, isoburn_imgen_opts::appended_part_type_guids, isoburn_imgen_opts::appended_part_types, isoburn_imgen_opts::appended_partitions, isoburn_imgen_opts::data_start_lba, isoburn_imgen_opts::dir_mode, isoburn_imgen_opts::dir_rec_mtime, isoburn_imgen_opts::do_fsync, isoburn_imgen_opts::do_tao, isoburn_imgen_opts::effective_lba, isoburn_imgen_opts::efi_boot_part_flag, isoburn_imgen_opts::efi_boot_partition, isoburn_imgen_opts::fifo_size, isoburn_imgen_opts::file_md5, isoburn_imgen_opts::file_mode, isoburn_imgen_opts::gid, isoburn_imgen_opts::gpt_guid, isoburn_imgen_opts::gpt_guid_mode, isoburn_imgen_opts::hardlinks, isoburn_imgen_opts::hfsp_block_size, isoburn_imgen_opts::hfsp_serial_number, isoburn_imgen_opts::iso1999, isoburn_imgen_opts::iso_mbr_part_type, isoburn_msgs_submit(), isoburn_imgen_opts::joliet, isoburn_imgen_opts::joliet_long_names, isoburn_imgen_opts::joliet_longer_paths, isoburn_imgen_opts::joliet_utf16, isoburn_imgen_opts::level, Libisoburn_max_appended_partitionS, isoburn_imgen_opts::libjte_handle, isoburn_imgen_opts::max_37_char_filenames, isoburn_imgen_opts::no_emul_toc, isoburn_imgen_opts::no_force_dots, isoburn_imgen_opts::old_empty, isoburn_imgen_opts::omit_version_numbers, isoburn_imgen_opts::output_charset, isoburn_imgen_opts::part_like_isohybrid, isoburn_imgen_opts::partition_heads_per_cyl, isoburn_imgen_opts::partition_offset, isoburn_imgen_opts::partition_secs_per_head, isoburn_imgen_opts::prep_part_flag, isoburn_imgen_opts::prep_partition, isoburn_imgen_opts::replace_dir_mode, isoburn_imgen_opts::replace_file_mode, isoburn_imgen_opts::replace_gid, isoburn_imgen_opts::replace_uid, isoburn_imgen_opts::rockridge, isoburn_imgen_opts::rr_reloc_dir, isoburn_imgen_opts::rr_reloc_flags, isoburn_imgen_opts::rrip_version_1_10, isoburn_imgen_opts::session_md5, isoburn_imgen_opts::sort_files, isoburn_imgen_opts::system_area_data, isoburn_imgen_opts::system_area_options, isoburn_imgen_opts::tail_blocks, isoburn_imgen_opts::uid, isoburn_imgen_opts::untranslated_name_len, isoburn_imgen_opts::vol_creation_time, isoburn_imgen_opts::vol_effective_time, isoburn_imgen_opts::vol_expiration_time, and isoburn_imgen_opts::vol_modification_time.

Referenced by Xorriso_relax_compliance(), Xorriso_test_outchar(), and Xorriso_write_session().

◆ isoburn_igopt_set_appended_as_apm()

int isoburn_igopt_set_appended_as_apm ( struct isoburn_imgen_opts opts,
int  apm 
)

Control whether partitions created by iso_write_opts_set_partition_img() are to be represented in Apple Partition Map.

Since
1.4.4
Parameters
optsThe option set to be manipulated.
apm0= do not represent appended partitions in APM 1= represent in APM, even if not iso_write_opts_set_part_like_isohybrid() enables it and no other APM partitions emerge. Do not use other values for now.
Returns
<=0 = error, 1 = success

Definition at line 1847 of file isoburn.c.

References isoburn_imgen_opts::appended_as_apm.

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_set_appended_as_gpt()

int isoburn_igopt_set_appended_as_gpt ( struct isoburn_imgen_opts opts,
int  gpt 
)

Control whether partitions created by iso_write_opts_set_partition_img() are to be represented in MBR or as GPT partitions.

Since
1.4.0
Parameters
optsThe option set to be manipulated.
gpt0= represent as MBR partition; as GPT only if other GPT partitions are present 1= represent as GPT partition and cause protective MBR with a single partition which covers the whole output data. This may fail if other settings demand MBR partitions. Do not use other values for now.
Returns
<=0 = error, 1 = success

Definition at line 1790 of file isoburn.c.

References isoburn_imgen_opts::appended_as_gpt.

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_set_disc_label()

int isoburn_igopt_set_disc_label ( struct isoburn_imgen_opts opts,
char *  label 
)

Set a name for the system area. This setting is ignored unless system area type 3 "SUN Disk Label" is in effect by iso_write_opts_set_system_area(). In this case it will replace the default text at the start of the image: "CD-ROM Disc with Sun sparc boot created by libisofs"

Since
0.6.6
Parameters
optsThe option set to be manipulated.
labelA text of up to 128 characters.
Returns
<=0 = error, 1 = success

Definition at line 1940 of file isoburn.c.

References isoburn_imgen_opts::ascii_disc_label, and Libisoburn_disc_label_sizE.

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_set_efi_bootp()

int isoburn_igopt_set_efi_bootp ( struct isoburn_imgen_opts opts,
char *  path,
int  flag 
)

Copy a data file from the local filesystem into the emerging ISO image and mark it by a GPT entry as EFI system partition.

Since
1.2.4
Parameters
optsThe option set to be manipulated.
pathFile address in the local file system. Instead of a disk path, the word –efi-boot-image may be given. It exposes in GPT the content of the first El Torito EFI boot image as EFI system partition.
flagWith isoburn_igopt_get_efi_bootp(): Control bits as of iso_write_opts_set_efi_bootp() bit0= The path contains instructions for the interval libisofs reader. See libisofs.h.
Since
1.4.0 With isoburn_igopt_set_efi_bootp(): bit0= add the current flag setting & 0x3fffffff to return value 1.
Returns
1 success, <=0 failure

Definition at line 1683 of file isoburn.c.

References isoburn_imgen_opts::efi_boot_part_flag, isoburn_imgen_opts::efi_boot_partition, ISO_OUT_OF_MEM, and isoburn_report_iso_error().

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_set_extensions()

◆ isoburn_igopt_set_fifo_size()

int isoburn_igopt_set_fifo_size ( struct isoburn_imgen_opts o,
int  fifo_size 
)

The number of bytes to be used for the fifo which decouples libisofs and libburn for better throughput and for reducing the risk of interrupting signals hitting the libburn thread which operates the MMC drive. The size will be rounded up to the next full 2048. Minimum is 64kiB, maximum is 1 GiB (but that is too much anyway).

Since
0.1.0
Parameters
oThe option set to work on
fifo_sizeNumber of bytes to use
Returns
1 success, <=0 failure

Definition at line 1482 of file isoburn.c.

References isoburn_imgen_opts::fifo_size.

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_set_gpt_guid()

int isoburn_igopt_set_gpt_guid ( struct isoburn_imgen_opts opts,
uint8_t  guid[16],
int  mode 
)

Control whether the emerging GPT gets a pseudo-randomly generated disk GUID or whether it gets a user supplied GUID. The partition GUIDs will be generated in a reproducible way by exoring a little-endian 32 bit counter with the disk GUID beginning at byte offset 9.

Since
1.4.6
Parameters
optsThe option set to be manipulated.
guid16 bytes of user supplied GUID. Readily byte-swapped from the text form as prescribed by UEFI specs: 4 byte, 2 byte, 2 byte as little-endian. 2 byte, 6 byte as big-endian. The upper 4 bit of guid[6] and guid[7] should bear the value 4 to express the version 4 in both endiannesses. Bit 7 of byte[8] should be set to 1 and bit 6 be set to 0, in order to express the RFC 4122 variant of GUID, where version 4 means "random".
mode0 = ignore parameter guid and produce the GPT disk GUID by a pseudo-random algorithm. This is the default setting. 1 = use parameter guid as GPT disk GUID 2 = ignore parameter guid and derive the GPT disk GUID from parameter uuid of isoburn_igopt_set_pvd_times(). The 16 bytes of uuid get copied and bytes 6, 7, 8 get their upper bits changed to comply to RFC 4122. If no such uuid is given when ISO production starts, then mode 2 defaults to mode 0.

Definition at line 1914 of file isoburn.c.

References isoburn_imgen_opts::gpt_guid, isoburn_imgen_opts::gpt_guid_mode, and isoburn_msgs_submit().

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_set_hfsp_block_size()

int isoburn_igopt_set_hfsp_block_size ( struct isoburn_imgen_opts opts,
int  hfsp_block_size,
int  apm_block_size 
)

Set the allocation block size for HFS+ production and the block size for layout and address unit of Apple Partition map.

Since
1.2.4
Parameters
optsThe option set to be manipulated.
hfsp_block_size-1 means that this setting shall be left unchanged 0 allows the automatic default setting 512 and 2048 enforce a size.
apm_block_size-1 means that this setting shall be left unchanged 0 allows the automatic default setting 512 and 2048 enforce a size. Size 512 cannot be combined with GPT production. Size 2048 cannot be mounted -t hfsplus by Linux kernels at least up to 2.6.32.
Returns
<=0 = error, 1 = success

Definition at line 1971 of file isoburn.c.

References isoburn_imgen_opts::apm_block_size, isoburn_imgen_opts::hfsp_block_size, and isoburn_msgs_submit().

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_set_hfsp_serial_number()

int isoburn_igopt_set_hfsp_serial_number ( struct isoburn_imgen_opts opts,
uint8_t  serial_number[8] 
)

Set a serial number for the HFS+ extension of the emerging ISO image.

Since
1.2.4
Parameters
optsThe option set to be manipulated.
serial_number8 bytes which should be unique to the image. If all bytes are 0, then the serial number will be generated as random number by libisofs. This is the default setting.
Returns
<=0 = error, 1 = success

Definition at line 1955 of file isoburn.c.

References isoburn_imgen_opts::hfsp_serial_number.

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_set_iso_mbr_part_type()

int isoburn_igopt_set_iso_mbr_part_type ( struct isoburn_imgen_opts opts,
int  part_type 
)

Set the partition type of the MBR partition which represents the ISO filesystem or at least protects it. This is without effect if no such partition emerges by other settings or if the partition type is prescribed mandatorily like 0xee for GPT protective MBR or 0x96 for CHRP.

Since
1.4.8
Parameters
optsThe option set to be manipulated.
part_type0x00 to 0xff as desired partition type. Any other value (e.g. -1) enables the default types of the various occasions.

Definition at line 1878 of file isoburn.c.

References isoburn_imgen_opts::iso_mbr_part_type.

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_set_iso_type_guid()

int isoburn_igopt_set_iso_type_guid ( struct isoburn_imgen_opts opts,
uint8_t  guid[16],
int  valid 
)

Set the GPT Type GUID for the partition which represents the ISO 9660 filesystem, if such a partition emerges in GPT.

Since
1.5.2
Parameters
optsThe option set to be manipulated.
guid16 bytes of user supplied GUID. Readily byte-swapped from the text form as prescribed by UEFI specs: 4 byte, 2 byte, 2 byte as little-endian. 2 byte, 6 byte as big-endian.
validSet to 1 to make this Type GUID valid. Set to 0 in order to invalidate a previously made setting. In this case the setting of isoburn_igopt_set_iso_mbr_part_type() or its default gets into effect.
Returns
<=0 = error, 1 = success

Definition at line 1896 of file isoburn.c.

References isoburn_imgen_opts::iso_gpt_flag, and isoburn_imgen_opts::iso_gpt_type_guid.

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_set_level()

int isoburn_igopt_set_level ( struct isoburn_imgen_opts o,
int  level 
)

ISO level to write at.

Since
0.1.0
Parameters
oThe option set to work on
levelis a term of the ISO 9660 standard. It should be one of: 1= filenames restricted to form 8.3 2= filenames allowed up to 31 characters 3= file content may be larger than 4 GB - 1.
Returns
1 success, <=0 failure

Definition at line 1239 of file isoburn.c.

References isoburn_imgen_opts::level.

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_set_out_charset()

int isoburn_igopt_set_out_charset ( struct isoburn_imgen_opts o,
char *  output_charset 
)

Set the character set to use for representing RR filenames in the image.

Since
0.1.0
Parameters
oThe option set to work on
output_charsetSet this to NULL to use the default output charset. For selecting a particular character set, submit its name, e.g. as listed by program iconv -l. Example: "UTF-8".
Returns
1 success, <=0 failure

Definition at line 1466 of file isoburn.c.

References isoburn_imgen_opts::output_charset.

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_set_over_mode()

int isoburn_igopt_set_over_mode ( struct isoburn_imgen_opts o,
int  replace_dir_mode,
int  replace_file_mode,
mode_t  dir_mode,
mode_t  file_mode 
)

Set the override values for files and directory permissions. The parameters replace_* these take one of three values: 0, 1 or 2. If 0, the corresponding attribute will be kept as set in the IsoNode at the time of image generation. If set to 1, the corresponding attrib. will be changed by a default suitable value. With value 2, the attrib. will be changed with the value specified in the corresponding *_mode options. Note that only the permissions are set, the file type remains unchanged.

Since
0.1.0
Parameters
oThe option set to work on
replace_dir_modewhether and how to override directories
replace_file_modewhether and how to override files of other type
dir_modeMode to use on dirs with replace_dir_mode == 2.
file_mode;Mode to use on files with replace_file_mode == 2.
Returns
1 success, <=0 failure

Definition at line 1419 of file isoburn.c.

References isoburn_imgen_opts::dir_mode, isoburn_imgen_opts::file_mode, isoburn_imgen_opts::replace_dir_mode, and isoburn_imgen_opts::replace_file_mode.

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_set_over_ugid()

int isoburn_igopt_set_over_ugid ( struct isoburn_imgen_opts o,
int  replace_uid,
int  replace_gid,
uid_t  uid,
gid_t  gid 
)

Set the override values values for group id and user id. The rules are like with above overriding of mode values. replace_* controls whether and how. The other two parameters provide values for eventual use.

Since
0.1.0
Parameters
oThe option set to work on
replace_uidwhether and how to override user ids
replace_gidwhether and how to override group ids
uidUser id to use with replace_uid == 2.
gidGroup id to use on files with replace_gid == 2.
Returns
1 success, <=0 failure

Definition at line 1443 of file isoburn.c.

References isoburn_imgen_opts::gid, isoburn_imgen_opts::replace_gid, isoburn_imgen_opts::replace_uid, and isoburn_imgen_opts::uid.

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_set_part_flag()

int isoburn_igopt_set_part_flag ( struct isoburn_imgen_opts opts,
int  partition_number,
int  flag 
)

Set flag bits for a partition defined by isoburn_igopt_set_partition_img(). The bits will be forwarded to libisofs iso_write_opts_set_partition_img().

Since
1.4.0
Parameters
optsThe option set to be manipulated.
partition_numberDepicts the partition table entry to which shall the flags bits shall apply.
flagControl bits as of iso_write_opts_set_partition_img() bit0= The path contains instructions for the interval libisofs reader. See libisofs.h.
Since
1.4.0
Returns
<=0 = error, 1 = success

Definition at line 1757 of file isoburn.c.

References isoburn_imgen_opts::appended_part_flags, isoburn_msgs_submit(), and Libisoburn_max_appended_partitionS.

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_set_part_like_isohybrid()

int isoburn_igopt_set_part_like_isohybrid ( struct isoburn_imgen_opts opts,
int  alike 
)

Control whether bits 2 to 8 of el_torito_set_isolinux_options() shall apply even if not isohybrid MBR patching is enabled (bit1 of parameter options of isoburn_igopt_set_system_area()). For details see iso_write_opts_set_part_like_isohybrid() in libisofs.h.

Since
1.4.4
Parameters
optsThe option set to be manipulated.
alike0= Apply isohybrid behavior only with ISOLINUX isohybrid. Do not mention appended partitions in APM unless isoburn_igopt_set_appended_as_apm() is enabled. 1= Apply isohybrid behavior even without ISOLINUX isohybrid.
Returns
<=0 = error, 1 = success

Definition at line 1862 of file isoburn.c.

References isoburn_imgen_opts::part_like_isohybrid.

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_set_part_offset()

int isoburn_igopt_set_part_offset ( struct isoburn_imgen_opts opts,
uint32_t  block_offset_2k,
int  secs_512_per_head,
int  heads_per_cyl 
)

Control production of a second set of volume descriptors (superblock) and directory trees, together with a partition table in the MBR where the first partition has non-zero start address and the others are zeroed. The first partition stretches to the end of the whole ISO image. The additional volume descriptor set and trees can be used to mount the ISO image at the start of the first partition, while it is still possible to mount it via the normal first volume descriptor set and tree at the start of the image or storage device. This makes few sense on optical media. But on USB sticks it creates a conventional partition table which makes it mountable on e.g. Linux via /dev/sdb and /dev/sdb1 alike.

Since
0.6.2
Parameters
optsThe option set to be manipulated.
block_offset_2kThe offset of the partition start relative to device start. This is counted in 2 kB blocks. The partition table will show the according number of 512 byte sectors. Default is 0 which causes no second set and trees. If it is not 0 then it must not be smaller than 16.
secs_512_per_headNumber of 512 byte sectors per head. 1 to 63. 0=automatic.
heads_per_cylNumber of heads per cylinder. 1 to 255. 0=automatic.
Returns
1 success, <=0 failure

Definition at line 1597 of file isoburn.c.

References isoburn_imgen_opts::partition_heads_per_cyl, isoburn_imgen_opts::partition_offset, and isoburn_imgen_opts::partition_secs_per_head.

Referenced by Xorriso_set_system_area().

◆ isoburn_igopt_set_part_type_guid()

int isoburn_igopt_set_part_type_guid ( struct isoburn_imgen_opts opts,
int  partition_number,
uint8_t  guid[16],
int  valid 
)

Set the GPT Type GUID for a partition defined by isoburn_igopt_set_partition_img().

Since
1.5.2
Parameters
optsThe option set to be manipulated.
partition_numberDepicts the partition table entry which shall get the Type GUID.
guid16 bytes of user supplied GUID. Readily byte-swapped from the text form as prescribed by UEFI specs: 4 byte, 2 byte, 2 byte as little-endian. 2 byte, 6 byte as big-endian.
validSet to 1 to make this Type GUID valid. Set to 0 in order to invalidate a previously made setting. In this case MBR type 0xEF will become the EFI Type GUID. All others will become the Basic Data Partition Type GUID.
Returns
<=0 = error, 1 = success

Definition at line 1805 of file isoburn.c.

References isoburn_imgen_opts::appended_part_gpt_flags, isoburn_imgen_opts::appended_part_type_guids, isoburn_msgs_submit(), and Libisoburn_max_appended_partitionS.

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_set_partition_img()

int isoburn_igopt_set_partition_img ( struct isoburn_imgen_opts opts,
int  partition_number,
uint8_t  partition_type,
char *  image_path 
)

Cause an arbitrary data file to be appended to the ISO image and to be described by a partition table entry in an MBR or SUN Disk Label at the start of the ISO image. The partition entry will bear the size of the image file rounded up to the next multiple of 2048 bytes. MBR or SUN Disk Label are selected by isoburn_igopt_set_system_area() system area type: 0 selects MBR partition table. 3 selects a SUN partition table with 320 kB start alignment.

Since
0.6.4
Parameters
optsThe option set to be manipulated.
partition_numberDepicts the partition table entry which shall describe the appended image. Range with MBR: 1 to 4. 1 will cause the whole ISO image to be unclaimable space before partition 1.
Since
0.6.6 Range with SUN Disk Label: 2 to 8.
Parameters
image_pathFile address in the local file system. With SUN Disk Label: an empty name causes the partition to become a copy of the next lower partition.
partition_typeThe MBR partition type. E.g. FAT12 = 0x01 , FAT16 = 0x06, Linux Native Partition = 0x83. See fdisk command L. This parameter is ignored with SUN Disk Label.
Returns
<=0 = error, 1 = success

Definition at line 1712 of file isoburn.c.

References isoburn_imgen_opts::appended_part_types, isoburn_imgen_opts::appended_partitions, isoburn_msgs_submit(), and Libisoburn_max_appended_partitionS.

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_set_prep_partition()

int isoburn_igopt_set_prep_partition ( struct isoburn_imgen_opts opts,
char *  path,
int  flag 
)

Copy a data file from the local filesystem into the emerging ISO image. Mark it by an MBR partition entry as PreP partition and also cause protective MBR partition entries before and after this partition. See libisofs.h iso_write_opts_set_prep_img().

Since
1.2.4
Parameters
optsThe option set to be manipulated.
pathFile address in the local file system.
flagWith isoburn_igopt_set_prep_partition(): Control bits as of iso_write_opts_set_efi_bootp() bit0= The path contains instructions for the interval libisofs reader. See libisofs.h.
Since
1.4.0 With isoburn_igopt_get_prep_partition(): bit0= add the current flag setting & 0x3fffffff to return value 1.
Returns
1 success, <=0 failure

Definition at line 1654 of file isoburn.c.

References ISO_OUT_OF_MEM, isoburn_report_iso_error(), isoburn_imgen_opts::prep_part_flag, and isoburn_imgen_opts::prep_partition.

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_set_pvd_times()

int isoburn_igopt_set_pvd_times ( struct isoburn_imgen_opts opts,
time_t  creation_time,
time_t  modification_time,
time_t  expiration_time,
time_t  effective_time,
char *  uuid 
)

Explicitly set the four timestamps of the emerging ISO image. Default with all parameters is 0.

Since
0.5.4
Parameters
optsThe option set to work on
creation_timeECMA-119 Volume Creation Date and Time When "the information in the volume was created." A value of 0 means that the timepoint of write start is to be used.
modification_timeECMA-119 Volume Modification Date and Time When "the informationin the volume was last modified." A value of 0 means that the timepoint of write start is to be used.
expiration_timeECMA-119 Volume Expiration Date and Time When "the information in the volume may be regarded as obsolete." A value of 0 means that the information never shall expire.
effective_timeECMA-119 Volume Effective Date and Time When "the information in the volume may be used." A value of 0 means that not such retention is intended.
uuidIf this text is not empty, then it overrides vol_modification_time by copying the first 16 decimal digits from uuid, eventually padding up with decimal '1', and writing a NUL-byte as timezone GMT. It should express a reasonable time in form YYYYMMDDhhmmsscc E.g.: 2010040711405800 = 7 Apr 2010 11:40:58 (+0 centiseconds)
Returns
1 success, <=0 failure

Definition at line 1568 of file isoburn.c.

References isoburn_imgen_opts::vol_creation_time, isoburn_imgen_opts::vol_effective_time, isoburn_imgen_opts::vol_expiration_time, isoburn_imgen_opts::vol_modification_time, and isoburn_imgen_opts::vol_uuid.

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_set_relaxed()

◆ isoburn_igopt_set_rr_reloc()

int isoburn_igopt_set_rr_reloc ( struct isoburn_imgen_opts o,
char *  name,
int  flags 
)

If not isoburn_igopt_allow_deep_paths is in effect, then it may become necessary to relocate directories so that no ECMA-119 file path has more than 8 components. These directories are grafted into either the root directory of the ISO image or into a dedicated relocation directory. For details see libisofs.h. Wrapper for: iso_write_opts_set_rr_reloc()

Since
1.2.2
Parameters
oThe option set to work on
nameThe name of the relocation directory in the root directory. Do not prepend "/". An empty name or NULL will direct relocated directories into the root directory. This is the default. If the given name does not exist in the root directory when isoburn_disc_write() is called, and if there are directories at path level 8, then directory /name will be created automatically.
flagsBitfield for control purposes. bit0= Mark the relocation directory by a Rock Ridge RE entry, if it gets created during isoburn_disc_write(). This will make it invisible for most Rock Ridge readers. bit1= not settable via API (used internally)
Returns
> 0 success, <= 0 failure

Definition at line 1329 of file isoburn.c.

References isoburn_msgs_submit(), isoburn_imgen_opts::rr_reloc_dir, and isoburn_imgen_opts::rr_reloc_flags.

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_set_scdbackup_tag()

int isoburn_igopt_set_scdbackup_tag ( struct isoburn_imgen_opts o,
char *  name,
char *  timestamp,
char *  tag_written 
)

Set or get parameters "name" and "timestamp" for a scdbackup checksum tag. It will be appended to the libisofs session tag if the image starts at LBA 0. See isoburn_disc_track_lba_nwa. The scdbackup tag can be used to verify the image by command scdbackup_verify $device -auto_end. See scdbackup/README appendix VERIFY for its inner details.

Since
0.4.4
Parameters
oThe option set to work on
nameThe tag name. 80 characters max. An empty name disables production of an scdbackup tag.
timestampA string of up to 13 characters YYMMDD.hhmmss A9 = 2009, B0 = 2010, B1 = 2011, ... C0 = 2020, ...
tag_writtenEither NULL or the address of an array with at least 512 characters. In the latter case the eventually produced scdbackup tag will be copied to this array when the image gets written. This call sets scdbackup_tag_written[0] = 0 to mark its preliminary invalidity.
Returns
1 success, <=0 failure

Definition at line 1510 of file isoburn.c.

References isoburn_imgen_opts::scdbackup_tag_name, isoburn_imgen_opts::scdbackup_tag_time, and isoburn_imgen_opts::scdbackup_tag_written.

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_set_sort_files()

int isoburn_igopt_set_sort_files ( struct isoburn_imgen_opts o,
int  value 
)

Definition at line 1405 of file isoburn.c.

References isoburn_imgen_opts::sort_files.

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_set_stdio_endsync()

int isoburn_igopt_set_stdio_endsync ( struct isoburn_imgen_opts opts,
int  do_sync 
)

Set or inquire whether a final fsync(2) is performed when updating the multi-session information of libburn stdio pseudo-drives by isoburn_activate_session(). Note: fsync(2) calls during and at the end of isoburn_disc_write() are controlled by libburn call burn_write_opts_set_stdio_fsync().

Since
1.2.4
Parameters
optsThe option set to be manipulated or inquired.
do_sync1= call fsync(2) with stdio drives in isoburn_activate_session() 0= do not
Returns
<=0 = error, 1 = success

Definition at line 2024 of file isoburn.c.

References isoburn_imgen_opts::do_fsync.

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_set_system_area()

int isoburn_igopt_set_system_area ( struct isoburn_imgen_opts o,
char  data[32768],
int  options 
)

Attach 32 kB of binary data which shall get written to the first 32 kB of the ISO image, the System Area. options can cause manipulations of these data before writing happens. If system area data are giveni or options bit0 is set, then bit1 of el_torito_set_isolinux_options() is automatically disabled.

Since
0.5.4
Parameters
oThe option set to work on
dataEither NULL or 32 kB of data. Do not submit less bytes !
optionsCan cause manipulations of submitted data before they get written: bit0= apply a –protective-msdos-label as of grub-mkisofs. This means to patch bytes 446 to 512 of the system area so that one partition is defined which begins at the second 512-byte block of the image and ends where the image ends. This works with and without system_area_data. bit1= apply isohybrid MBR patching to the system area. This works only with system area data from SYSLINUX plus an ISOLINUX boot image (see iso_image_set_boot_image()) and only if not bit0 is set. bit2-7= System area type 0= with bit0 or bit1: MBR else: unspecified type
Since
0.6.4 1= MIPS Big Endian Volume Header Submit up to 15 MIPS Big Endian boot files by iso_image_add_mips_boot_file() of libisofs. This will overwrite the first 512 bytes of the submitted data. 2= DEC Boot Block for MIPS Little Endian The first boot file submitted by iso_image_add_mips_boot_file() will be activated. This will overwrite the first 512 bytes of the submitted data.
0.6.6 3= SUN Disk Label for SUN SPARC Submit up to 7 SPARC boot images by isoburn_igopt_set_partition_img() for partition numbers 2 to 8. This will overwrite the first 512 bytes of the submitted data.
1.3.8 4= HP-PA PALO boot sector header version 4 Submit all five parameters of iso_image_set_hppa_palo() as non-NULL texts. 5= HP-PA PALO boot sector header version 5 Submit all five parameters of iso_image_set_hppa_palo() as non-NULL texts. bit8-9= Only with System area type 0 = MBR
1.0.4 Cylinder alignment mode eventually pads the image to make it end at a cylinder boundary. 0 = auto (align if bit1) 1 = always align to cylinder boundary 2 = never align to cylinder boundary bit10-13= System area sub type
1.2.4 With type 0 = MBR: Gets overridden by bit0 and bit1. 0 = no particular sub type 1 = CHRP: A single MBR partition of type 0x96 covers the ISO image. Not compatible with any other feature which needs to have own MBR partition entries. bit14= Only with System area type 0 = MBR GRUB2 boot provisions:
1.3.0 Patch system area at byte 0x1b0 to 0x1b7 with (512-block address + 4) of the first boot image file. Little-endian 8-byte. Should be combined with options bit0. Will not be in effect if options bit1 is set.
Returns
1 success, 0 no data to get, <0 failure

Definition at line 1537 of file isoburn.c.

References isoburn_imgen_opts::system_area_data, and isoburn_imgen_opts::system_area_options.

Referenced by Xorriso_set_system_area().

◆ isoburn_igopt_set_tail_blocks()

int isoburn_igopt_set_tail_blocks ( struct isoburn_imgen_opts opts,
uint32_t  num_blocks 
)

Set or get the number of trailing zero byte blocks to be written by libisofs. The image size counter of the emerging ISO image will include them. Eventual checksums will take them into respect. They will be written immediately before the eventual image checksum area which is at the very end of the image. For a motivation see iso_write_opts_set_tail_blocks() in libisofs.h .

Since
0.6.4
Parameters
optsThe option set to work on
num_blocksNumber of extra 2 kB blocks to be written by libisofs.
Returns
1 success, <=0 failure

Definition at line 1639 of file isoburn.c.

References isoburn_imgen_opts::tail_blocks.

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_igopt_set_untranslated_name_len()

int isoburn_igopt_set_untranslated_name_len ( struct isoburn_imgen_opts o,
int  len 
)

Caution: This option breaks any assumptions about names that are supported by ECMA-119 specifications. Try to omit any translation which would make a file name compliant to the ECMA-119 rules. This includes and exceeds omit_version_numbers, max_37_char_filenames, no_force_dots bit0, allow_full_ascii. Further it prevents the conversion from local character set to ASCII. The maximum name length is given by this call. If a filename exceeds this length or cannot be recorded untranslated for other reasons, then image production gets aborted. Currently the length limit is 96 characters, because an ECMA-119 directory record may at most have 254 bytes and up to 158 other bytes must fit into the record. Probably 96 more bytes can be made free for the name in future.

Since
1.0.0
Parameters
oThe option set to work on
len0 = disable this feature and perform name translation according to other settings. >0 = Omit any translation. Eventually abort image production if a name is longer than the given value. -1 = Like >0. Allow maximum possible length. isoburn_igopt_get_untranslated_name_len() will tell the effectively resulting value.
Returns
>0 success, <=0 failure

Definition at line 1360 of file isoburn.c.

References iso_write_opts_free(), iso_write_opts_new(), iso_write_opts_set_untranslated_name_len(), isoburn_msgs_submit(), and isoburn_imgen_opts::untranslated_name_len.

Referenced by Xorriso_make_iso_write_opts(), and Xorriso_relax_compliance().

◆ isoburn_igopt_set_write_type()

int isoburn_igopt_set_write_type ( struct isoburn_imgen_opts opts,
int  do_tao 
)

Set or inquire the write type for the next write run on optical media.

Since
1.2.4
Parameters
optsThe option set to be manipulated or inquired.
do_taoThe value to be set or the variable where to return the current setting: 0 = Let libburn choose according to other write parameters. This is advisable unless there are particular reasons not to use one of the two write types. Be aware that 1 and -1 can lead to failure if the write type is not appropriate for the given media situation. 1 = Use BURN_WRITE_TAO which does TAO on CD, Incremental on DVD-R, no track reservation on DVD+R and BD-R -1 = Use BURN_WRITE_SAO which does SAO on CD, DAO on DVD-R, track reservation on DVD+R and BD-R
Returns
<=0 = error, 1 = success

Definition at line 2009 of file isoburn.c.

References isoburn_imgen_opts::do_tao.

Referenced by Xorriso_make_iso_write_opts().

◆ isoburn_initialize()

int isoburn_initialize ( char  msg[1024],
int  flag 
)

Overview

libisoburn is a frontend for libraries libburn and libisofs which enables creation and expansion of ISO-9660 filesystems on all CD/DVD/BD media supported by libburn. This includes media like DVD+RW, which do not support multi-session management on media level and even plain disk files or block devices.

The price for that is thorough specialization on data files in ISO-9660 filesystem images. So libisoburn is not suitable for audio (CD-DA) or any other CD layout which does not entirely consist of ISO-9660 sessions.

Note that there is a higher level of API: xorriso.h. One should not mix it with the API calls of libisoburn.h, libisofs.h, and libburn.h.

                      Connector functions

libisofs and libburn do not depend on each other but share some interfaces by which they can cooperate. libisoburn establishes the connection between both modules by creating the necessary interface objects and attaching them to the right places.

                      Wrapper functions 

The principle of this frontend is that you may use any call of libisofs or libburn unless it has a isoburn_*() wrapper listed in the following function documentation.

E.g. call isoburn_initialize() rather than iso_init(); burn_initialize(); and call isoburn_drive_scan_and_grab() rather than burn_drive_scan_and_grab(). But you may call burn_disc_get_profile() directly if you want to display the media type.

The wrappers will transparently provide the necessary emulations which are appropriate for particular target drives and media states. To learn about them you have to read both API descriptions: the one of the wrapper and the one of the underlying libburn or libisofs call.

Macros BURN_* and functions burn_*() are documented in <libburn/libburn.h> Macros ISO_* and functions iso_*() are documented in <libisofs/libisofs.h>

                         Usage model

There may be an input drive and an output drive. Either of them may be missing with the consequence that no reading or no writing is possible. Both drive roles can be fulfilled by the same drive.

Input can be a random access readable libburn drive: optical media, regular files, block devices. Output can be any writeable libburn drive: writeable optical media in burner, writeable file objects (no directories).

libburn demands rw-permissions to drive device file or file object.

If the input drive provides a suitable ISO RockRidge image, then its tree may be loaded into memory and can then be manipulated by libisofs API calls. The loading is done by isoburn_read_image() under control of struct isoburn_read_opts which the application obtains from libisoburn and manipulates by the family of isoburn_ropt_set_*() functions.

Writing of result images is controlled by libisofs related parameters in a struct isoburn_imgen_opts which the application obtains from libisoburn and manipulates by the family of isoburn_igopt_set_*() functions.

All multi-session aspects are handled by libisoburn according to these settings. The application does not have to analyze media state and write job parameters. It rather states its desires which libisoburn tries to fulfill, or else will refuse to start the write run.

          Setup for Growing, Modifying or Blind Growing

The connector function family offers alternative API calls for performing the setup for several alternative image generation strategies.

Growing: If input and output drive are the same, then isoburn_prepare_disc() is to be used. It will lead to an add-on session on appendable or overwritable media with existing ISO image. With blank media it will produce a first session.

Modifying: If the output drive is not the input drive, and if it bears blank media or overwritable without a valid ISO image, then one may produce a consolidated image with old and new data. This will copy file data from an eventual input drive with valid image, add any newly introduced data from the local filesystem, and produce a first session on output media. To prepare for such an image generation run, use isoburn_prepare_new_image().

Blind Growing: This method reads the old image from one drive and writes the add-on session to a different drive. That output drive is nevertheless supposed to finally lead to the same medium from where the session was loaded. Usually it will be stdio:/dev/fd/1 (i.e. stdout) being piped into some burn program like with this classic gesture: mkisofs -M $dev -C $msc1,$nwa | cdrecord -waiti dev=$dev Blind growing is prepared by the call isoburn_prepare_blind_grow(). The input drive should be released immediately after this call in order to allow the consumer of the output stream to access that drive for writing.

After either of these setups, some peripheral libburn drive parameter settings like burn_write_opts_set_simulate(), burn_write_opts_set_multi(), burn_drive_set_speed(), burn_write_opts_set_underrun_proof() should be made. Do not set the write mode. It will be chosen by libisoburn so it matches job and media state.

                       Writing the image

Then one may start image generation and write threads by isoburn_disc_write(). Progress may be watched at the output drive by burn_drive_get_status() and isoburn_get_fifo_status().

At some time, the output drive will be BURN_DRIVE_IDLE indicating that writing has ended. One should inquire isoburn_drive_wrote_well() to learn about overall success.

Finally one must call isoburn_activate_session() which will complete any eventual multi-session emulation.

                     Application Constraints

Applications shall include libisofs/libisofs.h , libburn/libburn.h and this file itself: libisoburn/libisoburn.h . They shall link with -lisofs -lburn -lisoburn or with the .o files emerging from building those libraries from their sources.

Applications must use 64 bit off_t. E.g. on 32-bit GNU/Linux by defining #define _LARGEFILE_SOURCE #define _FILE_OFFSET_BITS 64 The minimum requirement is to interface with the library by 64 bit signed integers where libisofs.h or libisoburn.h prescribe off_t. Failure to do so may result in surprising malfunction or memory faults.

Application files which include libisofs/libisofs.h or libisoburn/libisoburn.h must provide definitions for uint32_t and uint8_t. This can be achieved either:

  • by using autotools which will define HAVE_STDINT_H or HAVE_INTTYPES_H according to its ./configure tests,
  • or by defining the macros HAVE_STDINT_H or HAVE_INTTYPES_H according to the local situation,
  • or by appropriately defining uint32_t and uint8_t by other means, e.g. by including inttypes.h before including libisofs.h and libisoburn.h Initialize libisoburn, libisofs and libburn. Wrapper for : iso_init() and burn_initialize()
    Since
    0.1.0
    Parameters
    msgA character array for eventual messages (e.g. with errors)
    flagBitfield for control purposes (unused yet, submit 0)
    Returns
    1 indicates success, 0 is failure

Definition at line 74 of file burn_wrap.c.

References burn_header_version_major, burn_header_version_micro, burn_header_version_minor, burn_initialize(), burn_version(), iso_init(), iso_lib_header_version_major, iso_lib_header_version_micro, iso_lib_header_version_minor, iso_lib_is_compatible(), iso_lib_version(), isoburn_destroy_all(), isoburn_libisofs_req_major, isoburn_libisofs_req_micro, isoburn_libisofs_req_minor, isoburn_list_start, isoburn_version(), libjte__is_compatible(), libjte__version(), LIBJTE_VERSION_MAJOR, LIBJTE_VERSION_MICRO, and LIBJTE_VERSION_MINOR.

Referenced by Xorriso_startup_libraries().

◆ isoburn_is_compatible()

int isoburn_is_compatible ( int  major,
int  minor,
int  micro,
int  flag 
)

Check whether all features of header file libisoburn.h from the given major.minor.micro revision triple can be delivered by the library version which is performing this call. An application of libisoburn can easily memorize the version of the libisoburn.h header in its own code. Immediately after isoburn_initialize() it should simply do this check: if (! isoburn_is_compatible(isoburn_header_version_major, isoburn_header_version_minor, isoburn_header_version_micro, 0)) ...refuse to start the program with this dynamic library version...

Since
0.1.0
Parameters
majorobtained at build time
minorobtained at build time
microobtained at build time
flagBitfield for control purposes. Unused yet. Submit 0.
Returns
1= library can work for caller 0= library is not usable in some aspects. Caller must restrict itself to an earlier API version or must not use this library at all.

Definition at line 824 of file isoburn.c.

References isoburn_version().

Referenced by Xorriso_startup_libraries().

◆ isoburn_libburn_req()

int isoburn_libburn_req ( int *  major,
int *  minor,
int *  micro 
)

The minimum version of libburn to be used with this version of libisoburn at runtime. This is checked already in isoburn_initialize() which will refuse on outdated version. So this call is for information purposes after successful startup only.

Since
0.1.0
Parameters
majorisoburn_libburn_req_major as seen at build time
minoras seen at build time
microas seen at build time
Returns
1 success, <=0 might in future become an error indication

Definition at line 280 of file burn_wrap.c.

References burn_header_version_major, burn_header_version_micro, and burn_header_version_minor.

Referenced by Xorriso_report_lib_versions().

◆ isoburn_libisofs_req()

int isoburn_libisofs_req ( int *  major,
int *  minor,
int *  micro 
)

The minimum compile time requirements of libisoburn towards libjte are the same as of a suitable libisofs towards libjte. So use these macros from libisofs.h : iso_libjte_req_major iso_libjte_req_minor iso_libjte_req_micro

Since
0.6.4 The minimum version of libisofs to be used with this version of libisoburn at runtime. This is checked already in isoburn_initialize() which will refuse on outdated version. So this call is for information purposes after successful startup only.
0.1.0
Parameters
majorisoburn_libisofs_req_major as seen at build time
minoras seen at build time
microas seen at build time
Returns
1 success, <=0 might in future become an error indication

Definition at line 270 of file burn_wrap.c.

References iso_lib_header_version_major, iso_lib_header_version_micro, and iso_lib_header_version_minor.

Referenced by Xorriso_report_lib_versions().

◆ isoburn_libjte_req()

int isoburn_libjte_req ( int *  major,
int *  minor,
int *  micro 
)

The minimum version of libjte to be used with this version of libisoburn at runtime. The use of libjte is optional and depends on configure tests. It can be prevented by ./configure option –disable-libjte . This is checked already in isoburn_initialize() which will refuse on outdated version. So this call is for information purposes after successful startup only.

Since
0.6.4

Definition at line 290 of file burn_wrap.c.

References LIBJTE_VERSION_MAJOR, LIBJTE_VERSION_MICRO, and LIBJTE_VERSION_MINOR.

Referenced by Xorriso_report_lib_versions().

◆ isoburn_needs_emulation()

int isoburn_needs_emulation ( struct burn_drive d)

Inquire whether the medium needs emulation or would be suitable for generic multi-session via libburn.

Since
0.1.0
Parameters
dThe drive to inquire
Returns
0 is generic multi-session 1 is emulated multi-session -1 is not suitable for isoburn

Definition at line 1062 of file burn_wrap.c.

References BURN_DISC_APPENDABLE, BURN_DISC_BLANK, isoburn::drive, isoburn::emulation_mode, isoburn_disc_get_status(), and isoburn_find_emulator().

Referenced by Xorriso_burn_track(), and Xorriso_sanitize_image_size().

◆ isoburn_prepare_blind_grow()

int isoburn_prepare_blind_grow ( struct burn_drive in_drive,
struct burn_disc **  disc,
struct isoburn_imgen_opts opts,
struct burn_drive out_drive,
int  nwa 
)

Start production of an ISO 9660 image using the method of Blind Growing: Create a disc object for writing an add-on session from the created or loaded IsoImage which has been manipulated via libisofs, to a different drive than the one from where it was loaded. Usually output will be stdio:/dev/fd/1 (i.e. stdout) being piped into some burn program like with this classic gesture: mkisofs -M $dev -C $msc1,$nwa | cdrecord -waiti dev=$dev Parameter translation into libisoburn: $dev is the address by which parameter in_drive of this call was acquired $msc1 was set by isoburn_set_msc1() before image reading or was detected from the in_drive medium $nwa is a parameter of this call or can be used as detected from the in_drive medium

This call starts a libisofs thread which begins to produce the image. It has to be revoked by isoburn_cancel_prepared_write() if for some reason this image data stream shall not be consumed. This call waits for libisofs output to become available and then detaches the input drive object from the data source object by which libisofs was reading from the input drive. So, as far as libisofs is concerned, that drive may be released immediately after this call in order to allow the consumer to access the drive for writing. The consumer should wait for input to become available and only then open its burn drive. With cdrecord this is caused by option -waiti.

The resulting burn_disc object has to be disposed when all its writing is done and the drive is BURN_DRIVE_IDLE again after asynchronous burn_disc_write().

Since
0.2.2
Parameters
in_driveThe input drive,grabbed with isoburn_drive_scan_and_grab().
discReturns the newly created burn_disc object.
optsOptions for image generation and data transport to media.
out_driveThe output drive, from isoburn_drive_aquire() et.al.. typically stdio:/dev/fd/1 .
nwaThe address (2048 byte block count) where the add-on session will be finally stored on a mountable medium or in a mountable file. If nwa is -1 then the address is used as determined from the in_drive medium.
Returns
<=0 error , 1 = success

Definition at line 739 of file isoburn.c.

References isoburn::fabricated_msc2, isoburn_find_emulator(), isoburn_prepare_disc_aux(), isoburn::min_start_byte, isoburn::nwa, and isoburn::zero_nwa.

Referenced by Xorriso_write_session().

◆ isoburn_prepare_disc()

int isoburn_prepare_disc ( struct burn_drive drive,
struct burn_disc **  disc,
struct isoburn_imgen_opts opts 
)

Start production of an ISO 9660 image using the method of Growing: Create a disc object for writing the new session from the created or loaded iso_volset which has been manipulated via libisofs, to the same medium from where the image was eventually loaded. This call starts a libisofs thread which begins to produce the image. It has to be revoked by isoburn_cancel_prepared_write() if for some reason this image data stream shall not be consumed. The returned struct burn_disc is ready for use by a subsequent call to isoburn_disc_write(). After this asynchronous writing has ended and the drive is BURN_DRIVE_IDLE again, the burn_disc object has to be disposed by burn_disc_free().

Since
0.1.0
Parameters
driveThe combined source and target drive, grabbed with isoburn_drive_scan_and_grab(). .
discReturns the newly created burn_disc object.
optsImage generation options, see isoburn_igopt_*()
Returns
<=0 error , 1 = success

Definition at line 718 of file isoburn.c.

References isoburn_prepare_disc_aux().

Referenced by Xorriso_write_session().

◆ isoburn_prepare_new_image()

int isoburn_prepare_new_image ( struct burn_drive in_drive,
struct burn_disc **  disc,
struct isoburn_imgen_opts opts,
struct burn_drive out_drive 
)

Start production of an ISO 9660 image using the method of Modifying: Create a disc object for producing a new image from a previous image plus the changes made by user. The generated burn_disc is suitable to be written to a grabbed drive with blank writeable medium. But you must not use the same drive for input and output, because data will be read from the source drive while at the same time the target drive is already writing. This call starts a libisofs thread which begins to produce the image. It has to be revoked by isoburn_cancel_prepared_write() if for some reason this image data stream shall not be consumed. The resulting burn_disc object has to be disposed when all its writing is done and the drive is BURN_DRIVE_IDLE again after asynchronous burn_disc_write().

Since
0.1.0
Parameters
in_driveThe input drive, grabbed with isoburn_drive_aquire() or one of its alternatives.
discReturns the newly created burn_disc object.
optsOptions for image generation and data transport to the medium.
out_driveThe output drive, from isoburn_drive_aquire() et.al..
Returns
<=0 error , 1 = success

Definition at line 725 of file isoburn.c.

References isoburn_prepare_disc_aux().

Referenced by Xorriso_write_session().

◆ isoburn_read_image()

int isoburn_read_image ( struct burn_drive d,
struct isoburn_read_opts read_opts,
IsoImage **  image 
)

Load the ISO filesystem directory tree from the medium in the given drive. This will give libisoburn the base on which it can let libisofs perform image growing or image modification. The loaded volset gets attached to the drive object and handed out to the application. Not a wrapper, but peculiar to libisoburn.

Since
0.1.0
Parameters
dThe drive which holds an existing ISO filesystem or blank media. d is allowed to be NULL which produces an empty ISO image. In this case one has to call before writing isoburn_attach_volset() with the volset from this call and with the intended output drive.
read_optsThe read options which can be chosen by the application
imagethe image read, if the disc is blank it will have no files. This reference needs to be released via iso_image_unref() when it is not longer needed. The drive, if not NULL, will hold an own reference which it will release when it gets a new volset or when it gets released via isoburn_drive_release(). You can pass NULL if you already have a reference or you plan to obtain it later with isoburn_get_attached_image(). Of course, if you haven't specified a valid drive (i.e., if d == NULL), this parameter can't be NULL.
Returns
<=0 error , 1 = success

Definition at line 142 of file isofs_wrap.c.

References isoburn_read_opts::auto_input_charset, BURN_DISC_APPENDABLE, BURN_DISC_BLANK, BURN_DISC_FULL, isoburn_read_opts::cache_tile_blocks, isoburn_read_opts::cache_tiles, isoburn_read_opts::dirmode, isoburn_read_opts::displacement, isoburn_read_opts::displacement_sign, isoburn_read_opts::do_ecma119_map, isoburn_read_opts::do_joliet_map, isoburn_read_opts::gid, isoburn_read_opts::hasElTorito, isoburn_read_opts::hasIso1999, isoburn_read_opts::hasJoliet, isoburn_read_opts::hasRR, isoburn::image, isoburn::image_start_lba, isoburn_read_opts::input_charset, isoburn::iso_data_source, iso_data_source_unref(), iso_image_attach_data(), iso_image_get_ignore_aclea(), iso_image_import(), iso_image_new(), iso_image_ref(), iso_image_set_ignore_aclea(), iso_image_set_truncate_mode(), iso_image_unref(), iso_read_image_features_destroy(), iso_read_image_features_get_size(), iso_read_image_features_has_eltorito(), iso_read_image_features_has_iso1999(), iso_read_image_features_has_joliet(), iso_read_image_features_has_rockridge(), iso_read_image_features_rr_loaded(), iso_read_image_features_tree_loaded(), iso_read_opts_auto_input_charset(), iso_read_opts_free(), iso_read_opts_keep_import_src(), iso_read_opts_load_system_area(), iso_read_opts_new(), iso_read_opts_set_default_gid(), iso_read_opts_set_default_permissions(), iso_read_opts_set_default_uid(), iso_read_opts_set_ecma119_map(), iso_read_opts_set_input_charset(), iso_read_opts_set_joliet_map(), iso_read_opts_set_new_inos(), iso_read_opts_set_no_aaip(), iso_read_opts_set_no_iso1999(), iso_read_opts_set_no_joliet(), iso_read_opts_set_no_md5(), iso_read_opts_set_no_rockridge(), iso_read_opts_set_preferjoliet(), iso_read_opts_set_start_block(), iso_tree_set_report_callback(), isoburn_data_source_new(), isoburn_disc_get_msc1(), isoburn_disc_get_status(), isoburn_find_emulator(), isoburn_idle_free_function(), isoburn_msgs_submit(), isoburn_read_iso_head(), isoburn_report_iso_error(), isoburn_root_defaults(), isoburn_read_opts::joliet_map_mode, isoburn_read_opts::map_mode, isoburn_read_opts::mode, isoburn_read_opts::noaaip, isoburn_read_opts::noino, isoburn_read_opts::noiso1999, isoburn_read_opts::nojoliet, isoburn_read_opts::nomd5, isoburn_read_opts::norock, isoburn_read_opts::preferjoliet, isoburn_read_opts::pretend_blank, isoburn::read_pacifier, isoburn::read_pacifier_handle, isoburn_read_opts::rr_loaded, isoburn_read_opts::size, isoburn_read_opts::tree_loaded, isoburn_read_opts::truncate_length, isoburn_read_opts::truncate_mode, and isoburn_read_opts::uid.

Referenced by Xorriso_aquire_drive(), and Xorriso_create_empty_iso().

◆ isoburn_read_iso_head()

int isoburn_read_iso_head ( struct burn_drive d,
int  lba,
int *  image_blocks,
char *  info,
int  flag 
)

Try whether the data at the given address look like a ISO 9660 image header and obtain its alleged size. Depending on the info mode one other string of text information can be retrieved too.

Since
0.1.6
Parameters
dThe drive with the medium to inspect
lbaThe block number from where to read
image_blocksReturns the number of 2048 bytes blocks in the session
infoCaller provided memory, enough to take possible info reply
flagbit0-7: info return mode 0= do not return anything in info (do not even touch it) 1= copy volume id to info (info needs 33 bytes) 2=
Since
0.2.2 : copy 64 kB header to info (needs 65536 bytes) bit13=
0.2.2: Do not read head from medium but use first 64 kB from info. In this case it is permissible to submit d == NULL. bit14= check both half buffers (not only second) return 2 if found in first block bit15= return -1 on read error
Returns
>0 seems to be a valid ISO image, 0 format not recognized, <0 error

Definition at line 1301 of file burn_wrap.c.

References burn_drive_get_drive_role(), burn_get_read_capacity(), burn_read_data(), isoburn_find_emulator(), isoburn_read_iso_head_parse(), and isoburn::media_read_error.

Referenced by isoburn_emulate_toc(), isoburn_get_mount_params(), isoburn_read_image(), isoburn_set_msc1(), Xorriso_adjust_relocated_sb(), Xorriso_assert_volid(), Xorriso_burn_track(), Xorriso_check_media(), Xorriso_set_system_area(), Xorriso_toc(), Xorriso_truncate_overwritable(), and Xorriso_update_iso_lba0().

◆ isoburn_ropt_destroy()

int isoburn_ropt_destroy ( struct isoburn_read_opts **  o,
int  flag 
)

Deletes an option set which was created by isoburn_ropt_new().

Since
0.1.0
Parameters
oThe option set to work on
flagBitfield for control purposes. Submit 0 for now.
Returns
1= **o destroyed , 0= *o was already NULL (harmless)

Definition at line 886 of file isoburn.c.

Referenced by Xorriso_aquire_drive(), and Xorriso_create_empty_iso().

◆ isoburn_ropt_get_auto_incharset()

int isoburn_ropt_get_auto_incharset ( struct isoburn_read_opts o,
int *  mode 
)

Definition at line 1050 of file isoburn.c.

References isoburn_read_opts::auto_input_charset, and isoburn_read_opts::mode.

◆ isoburn_ropt_get_data_cache()

int isoburn_ropt_get_data_cache ( struct isoburn_read_opts o,
int *  cache_tiles,
int *  tile_blocks,
int *  set_flag,
int  flag 
)

Inquire the current settings of isoburn_set_data_cache().

Since
1.2.2
Parameters
oThe option set to work on. NULL has the same effect as flag bit0.
cache_tilesWill return the number of tiles in the cache.
tile_blocksWill return the number of blocks per tile.
set_flagWill return control bits. None are defined yet.
flagBitfield for control purposes bit0= return default values rather than current ones
Returns
<=0 error , >0 reply is valid

Definition at line 932 of file isoburn.c.

References isoburn_read_opts::cache_tile_blocks, isoburn_read_opts::cache_tiles, Libisoburn_default_cache_tileS, and Libisoburn_default_tile_blockS.

Referenced by Xorriso_set_data_cache().

◆ isoburn_ropt_get_default_dirperms()

int isoburn_ropt_get_default_dirperms ( struct isoburn_read_opts o,
mode_t *  mode 
)

Definition at line 1019 of file isoburn.c.

References isoburn_read_opts::dirmode, and isoburn_read_opts::mode.

◆ isoburn_ropt_get_default_perms()

int isoburn_ropt_get_default_perms ( struct isoburn_read_opts o,
uid_t *  uid,
gid_t *  gid,
mode_t *  mode 
)

◆ isoburn_ropt_get_displacement()

int isoburn_ropt_get_displacement ( struct isoburn_read_opts o,
uint32_t *  displacement,
int *  displacement_sign 
)

◆ isoburn_ropt_get_extensions()

◆ isoburn_ropt_get_input_charset()

int isoburn_ropt_get_input_charset ( struct isoburn_read_opts o,
char **  input_charset 
)

Definition at line 1035 of file isoburn.c.

References isoburn_read_opts::input_charset.

◆ isoburn_ropt_get_size_what()

int isoburn_ropt_get_size_what ( struct isoburn_read_opts o,
uint32_t *  size,
int *  has_what 
)

◆ isoburn_ropt_get_tree_loaded()

int isoburn_ropt_get_tree_loaded ( struct isoburn_read_opts o,
int *  tree,
int *  rr 
)

After calling function isoburn_read_image() there are information available in the option set about which tree was used for image loading and whether Rock Ridge information was actually used.

Since
1.5.4
Parameters
oThe option set to work on
treeThe tree which was loaded: 0= ISO 9660 , 1 = Joliet , 2 = ISO 9660:1999
rr1= Rock Ridge information was used, 0 = No Rock Ridge was used
Returns
1 success, <=0 failure

Definition at line 1109 of file isoburn.c.

References isoburn_read_opts::rr_loaded, and isoburn_read_opts::tree_loaded.

Referenced by Xorriso_aquire_drive().

◆ isoburn_ropt_get_truncate_mode()

int isoburn_ropt_get_truncate_mode ( struct isoburn_read_opts o,
int *  mode,
int *  length 
)

◆ isoburn_ropt_new()

◆ isoburn_ropt_set_auto_incharset()

int isoburn_ropt_set_auto_incharset ( struct isoburn_read_opts o,
int  mode 
)

Enable or disable methods to automatically choose an input charset. This eventually overrides the name set via isoburn_ropt_set_input_charset()

Since
0.3.8
Parameters
oThe option set to work on
modeBitfield for control purposes: bit0= set the input character set automatically from attribute "isofs.cs" of root directory. Submit any other bits with value 0.
Returns
1 success, <=0 failure

Definition at line 1043 of file isoburn.c.

References isoburn_read_opts::auto_input_charset, and isoburn_read_opts::mode.

Referenced by Xorriso_aquire_drive().

◆ isoburn_ropt_set_data_cache()

int isoburn_ropt_set_data_cache ( struct isoburn_read_opts o,
int  cache_tiles,
int  tile_blocks,
int  flag 
)

Sets the size and granularity of the cache which libisoburn provides to libisofs for reading of ISO image data. This cache consists of several tiles which are buffers of a given size. The ISO image is divided into virtual tiles of that size. A cache tile may hold an in-memory copy of such a virtual image tile. When libisofs requests to read a block, then first the cache is inquired whether it holds that block. If not, then the block is read via libburn together with its neighbors in their virtual image tile into a free cache tile. If no cache tile is free, then the one will be re-used which has the longest time of not being hit by a read attempt.

A larger cache might speed up image loading by reducing the number of libburn read calls on the directory tree. It might also help with reading the content of many small files, if for some reason it is not an option to sort access by LBA. Caching will not provide much benefit with libburn "stdio:" drives, because the operating system is supposed to provide the same speed-up in a more flexible way.

Since
1.2.2
Parameters
oThe option set to work on. It is permissible to submit NULL in order to just have the parameters tested.
cache_tilesNumber of tiles in the cache. Not less than 1. Default is 32.
tile_blocksNumber of blocks per tile. Must be a power of 2. Default is 32. cache_tiles * tile_blocks * 2048 must not exceed 1073741824 (= 1 GiB).
flagBitfield for control purposes. Unused yet. Submit 0.
Returns
<=0 error , >0 ok

Definition at line 896 of file isoburn.c.

References isoburn_read_opts::cache_tile_blocks, isoburn_read_opts::cache_tiles, isoburn_msgs_submit(), and Libisoburn_cache_max_sizE.

Referenced by Xorriso_create_empty_iso(), and Xorriso_set_data_cache().

◆ isoburn_ropt_set_default_dirperms()

int isoburn_ropt_set_default_dirperms ( struct isoburn_read_opts o,
mode_t  mode 
)

Default attributes to use on directories if no RockRidge extension gets loaded. Above call isoburn_ropt_set_default_perms() automatically adds x-permissions to r-permissions for directories. This call here may be done afterwards to set independent permissions for directories, especially to override the automatically added x-permissions.

Since
0.1.0
Parameters
oThe option set to work on
modepermissions (not file type) as of man 2 stat.
Returns
1 success, <=0 failure

Definition at line 1011 of file isoburn.c.

References isoburn_read_opts::dirmode, and isoburn_read_opts::mode.

◆ isoburn_ropt_set_default_perms()

int isoburn_ropt_set_default_perms ( struct isoburn_read_opts o,
uid_t  uid,
gid_t  gid,
mode_t  mode 
)

Default attributes to use if no RockRidge extension gets loaded.

Since
0.1.0
Parameters
oThe option set to work on
uiduser id number (see /etc/passwd)
gidgroup id number (see /etc/group)
modepermissions (not file type) as of man 2 stat. With directories, r-permissions will automatically imply x-permissions. See isoburn_ropt_set_default_dirperms() below.
Returns
1 success, <=0 failure

Definition at line 981 of file isoburn.c.

References isoburn_read_opts::dirmode, isoburn_read_opts::gid, isoburn_read_opts::mode, and isoburn_read_opts::uid.

Referenced by Xorriso_aquire_drive().

◆ isoburn_ropt_set_displacement()

int isoburn_ropt_set_displacement ( struct isoburn_read_opts o,
uint32_t  displacement,
int  displacement_sign 
)

Control an offset to be applied to all block address pointers in the ISO image in order to compensate for an eventual displacement of the image relative to the start block address for which it was produced. E.g. if track number 2 from CD gets copied into a disk file and shall then be loaded as ISO filesystem, then the directory tree and all data file content of the track copy will become readable by setting the track start address as displacement and -1 as displacement_sign. Data file content outside the track will of course not be accessible and eventually produce read errors.

Since
0.6.6
Parameters
oThe option set to work on
displacement0 or a positive number
displacement_signDetermines whether to add or subtract displacement to block addresses before applying them to the storage object for reading: +1 = add , -1= subtract , else keep unaltered

Definition at line 1057 of file isoburn.c.

References isoburn_read_opts::displacement, and isoburn_read_opts::displacement_sign.

Referenced by Xorriso_aquire_drive().

◆ isoburn_ropt_set_extensions()

◆ isoburn_ropt_set_input_charset()

int isoburn_ropt_set_input_charset ( struct isoburn_read_opts o,
char *  input_charset 
)

Set the character set for reading RR file names from ISO images.

Since
0.1.0
Parameters
oThe option set to work on
input_charsetSet this to NULL to use the default locale charset For selecting a particular character set, submit its name, e.g. as listed by program iconv -l. Example: "UTF-8".
Returns
1 success, <=0 failure

Definition at line 1027 of file isoburn.c.

References isoburn_read_opts::input_charset.

Referenced by Xorriso_aquire_drive(), and Xorriso_create_empty_iso().

◆ isoburn_ropt_set_truncate_mode()

int isoburn_ropt_set_truncate_mode ( struct isoburn_read_opts o,
int  mode,
int  length 
)

Set the name truncation mode and the maximum name length for imported file objects.

Since
1.4.2
Parameters
oThe option set to work on
mode0= Do not truncate but throw error ISO_RR_NAME_TOO_LONG if a file name is longer than parameter length. 1= Truncate to length and overwrite the last 32 bytes of that length by the hex representation of the MD5 of the whole oversized name. Potential incomplete UTF-8 characters will get their leading bytes replaced by '_'. This is the default.
lengthMaximum byte count of a file name. Permissible values are 64 to 255. Default is 255.

Definition at line 1075 of file isoburn.c.

References isoburn_read_opts::mode, isoburn_read_opts::truncate_length, and isoburn_read_opts::truncate_mode.

Referenced by Xorriso_aquire_drive(), and Xorriso_create_empty_iso().

◆ isoburn_set_msc1()

int isoburn_set_msc1 ( struct burn_drive d,
int  adr_mode,
char *  adr_value,
int  flag 
)

Set up isoburn_disc_get_msc1() to return a fabricated value. This makes only sense between acquiring the drive and reading the image. After isoburn_read_image() it will confuse the coordination of libisoburn and libisofs. Note: Sessions and tracks are counted beginning with 1, not with 0.

Since
0.1.6
Parameters
dThe drive where msc1 is to be set
adr_modeDetermines how to interpret adr_value and to set msc1. If adr_value shall represent a number then decimal ASCII digits are expected. 0= start lba of last session in TOC, ignore adr_value 1= start lba of session number given by adr_value 2= start lba of track number given by adr_value 3= adr_value itself is the lba to be used 4= start lba of last session with volume id given by adr_value
adr_valueA string describing the value to be eventually used.
flagBitfield for control purposes. bit0=
Since
0.2.2 with adr_mode 3: adr_value might be 16 blocks too high (e.g. -C stemming from growisofs). Probe for ISO head at adr_value-16 and eventually adjust setting. bit1= insist in seeing a disc object with at least one session bit2= with adr_mode 4: use adr_value as regular expression

Definition at line 1938 of file burn_wrap.c.

References BURN_DISC_APPENDABLE, BURN_DISC_FULL, isoburn_toc_disc::disc, isoburn::fabricated_msc1, isoburn_disc_get_status(), isoburn_find_emulator(), isoburn_get_track_lba(), isoburn_msgs_submit(), isoburn_read_iso_head(), isoburn_toc_disc_free(), isoburn_toc_disc_get_sessions(), isoburn_toc_drive_get_disc(), isoburn_toc_session_get_tracks(), and isoburn_toc_track_get_emul().

Referenced by isoburn_get_mount_params(), and Xorriso_aquire_drive().

◆ isoburn_set_msgs_submit()

int isoburn_set_msgs_submit ( int(*)(void *handle, int error_code, char msg_text[], int os_errno, char severity[], int flag)  msgs_submit,
void *  submit_handle,
int  submit_flag,
int  flag 
)

Note: Above version numbers are also recorded in configure.ac because libtool wants them as parameters at build time. For the library compatibility check, ISOBURN_*_VERSION in configure.ac are not decisive. Only the three numbers here do matter. Usage discussion:

Some developers of the libburnia project have differing opinions how to ensure the compatibility of libraries and applications.

It is about whether to use at compile time and at runtime the version numbers isoburn_header_version_* provided here. Thomas Schmitt advises to use them. Vreixo Formoso advises to use other means.

At compile time:

Vreixo Formoso advises to leave proper version matching to properly programmed checks in the the application's build system, which will eventually refuse compilation.

Thomas Schmitt advises to use the macros defined here for comparison with the application's requirements of library revisions and to eventually break compilation.

Both advises are combinable. I.e. be master of your build system and have #if checks in the source code of your application, nevertheless.

At runtime (via *_is_compatible()):

Vreixo Formoso advises to compare the application's requirements of library revisions with the runtime library. This is to allow runtime libraries which are young enough for the application but too old for the lib*.h files seen at compile time.

Thomas Schmitt advises to compare the header revisions defined here with the runtime library. This is to enforce a strictly monotonous chain of revisions from app to header to library, at the cost of excluding some older libraries.

These two advises are mutually exclusive.


For an implementation of the Thomas Schmitt approach, see libisoburn/burn_wrap.c : isoburn_initialize() This connects libisoburn as "application" with libisofs as "library".

The compatible part of Vreixo Formoso's approach is implemented in configure.ac LIBBURN_REQUIRED, LIBISOFS_REQUIRED. In isoburn_initialize() it would rather test by iso_lib_is_compatible(isoburn_libisofs_req_major,... than by iso_lib_is_compatible(iso_lib_header_version_major,... and would leave out the ugly compile time traps. Announce to the library an application provided method for immediate delivery of messages. It is used when no drive is affected directly or if the drive has no own msgs_submit() method attached by isoburn_drive_set_msgs_submit. If no method is preset or if the method is set to NULL then libisoburn delivers its messages through the message queue of libburn.

Parameters
msgs_submitThe function call which implements the method
submit_handleHandle to be used as first argument of msgs_submit
submit_flagFlag to be used as last argument of msgs_submit
flagUnused yet, submit 0
Since
0.2.0

Definition at line 303 of file burn_wrap.c.

References libisoburn_default_msgs_submit, libisoburn_default_msgs_submit_flag, libisoburn_default_msgs_submit_handle, and isoburn::msgs_submit.

Referenced by Xorriso_startup_libraries().

◆ isoburn_set_read_pacifier()

int isoburn_set_read_pacifier ( struct burn_drive drive,
int(*)(IsoImage *, IsoFileSource *)  read_pacifier,
void *  app_handle 
)

Set a callback function for producing pacifier messages during the lengthy process of image reading. The callback function and the application handle are stored until they are needed for the underlying call to libisofs. Other than with libisofs the handle is managed entirely by the application. An idle .free() function is exposed to libisofs. The handle has to stay valid until isoburn_read_image() is done. It has to be detached by isoburn_set_read_pacifier(drive, NULL, NULL); before it may be removed from memory.

Since
0.1.0
Parameters
driveThe drive which will be used with isoburn_read_image() It has to be acquired by an isoburn_* wrapper call.
read_pacifierThe callback function
app_handleThe app handle which the callback function can obtain via iso_image_get_attached_data() from its IsoImage*
Returns
1 success, <=0 failure

Definition at line 706 of file isofs_wrap.c.

References isoburn::drive, isoburn_find_emulator(), isoburn::read_pacifier, and isoburn::read_pacifier_handle.

Referenced by Xorriso_aquire_drive(), and Xorriso_create_empty_iso().

◆ isoburn_set_truncate()

int isoburn_set_truncate ( struct burn_drive drive,
int  flag 
)

Override the truncation setting that was made with flag bit2 during the call of isoburn_drive_aquire. This applies only to stdio pseudo drives.

Since
0.1.6
Parameters
driveThe drive which was acquired and shall be used for writing.
flagBitfield controlling the setting: bit0= truncate (else do not truncate) bit1= do not warn if call is inappropriate to drive bit2= only set if truncation is currently enabled do not warn if call is inappropriate to drive
Returns
1 success, 0 inappropriate drive, <0 severe error

Definition at line 885 of file burn_wrap.c.

References isoburn::drive, isoburn_find_emulator(), isoburn_msgs_submit(), and isoburn::truncate.

Referenced by Xorriso_write_session().

◆ isoburn_sync_after_write()

int isoburn_sync_after_write ( struct burn_drive input_drive,
struct burn_drive output_drive,
int  flag 
)

Wait after normal end of operations until libisofs ended all write threads and freed resource reservations. This call is not mandatory. But without it, messages from the ending threads might appear after the application ended its write procedure.

Since
0.1.0
Parameters
input_driveThe drive or in_drive which was used with the preparation call.
output_driveThe out_drive used with isoburn_prepare_new_image(), NULL if none.
flagBitfield, submit 0 for now.
Returns
<=0 error , 1 = success

Definition at line 801 of file isoburn.c.

References isoburn_cancel_prepared_write().

Referenced by Xorriso_write_session().

◆ isoburn_toc_disc_free()

void isoburn_toc_disc_free ( struct isoburn_toc_disc disc)

Release the memory associated with a master handle of a medium. The handle is invalid afterwards and may not be used any more. Wrapper for: burn_disc_free()

Since
0.1.6
Parameters
discThe master handle of the medium

Definition at line 1893 of file burn_wrap.c.

References burn_disc_free(), isoburn_toc_disc::disc, and isoburn_toc_destroy_arrays().

Referenced by isoburn_get_mount_params(), isoburn_set_msc1(), isoburn_welcome_media(), Xorriso_check_media(), and Xorriso_toc().

◆ isoburn_toc_disc_get_incmpl_sess()

int isoburn_toc_disc_get_incmpl_sess ( struct isoburn_toc_disc disc)

Obtain the number of incomplete sessions which are recorded in the result array of isoburn_toc_disc_get_sessions() after the complete sessions. See above.

Since
1.2.8
Parameters
discThe master handle of the medium
Returns
the number of incomplete sessions

Definition at line 1782 of file burn_wrap.c.

References isoburn_toc_disc::incomplete_session_count.

Referenced by Xorriso_toc().

◆ isoburn_toc_disc_get_sectors()

int isoburn_toc_disc_get_sectors ( struct isoburn_toc_disc disc)

Tell the number of 2048 byte blocks covered by the table of content. This number includes the eventual gaps between sessions and tracks. So this call is not really a wrapper for burn_disc_get_sectors().

Since
0.1.6
Parameters
discThe master handle of the medium
Returns
Number of blocks, <=0 indicates unknown or unreadable state

Definition at line 1728 of file burn_wrap.c.

References burn_disc_get_incomplete_sessions(), burn_disc_get_sessions(), burn_session_get_tracks(), burn_track_get_entry(), isoburn_toc_disc::disc, burn_toc_entry::extensions_valid, isoburn_toc_entry::next, burn_toc_entry::start_lba, isoburn_toc_entry::start_lba, isoburn_toc_disc::toc, burn_toc_entry::track_blocks, and isoburn_toc_entry::track_blocks.

Referenced by Xorriso_check_media().

◆ isoburn_toc_disc_get_sessions()

struct isoburn_toc_session** isoburn_toc_disc_get_sessions ( struct isoburn_toc_disc disc,
int *  num 
)

Get the array of session handles and the number of complete sessions from the table of content. The result array contains *num + isoburn_toc_disc_get_incmpl_sess() elements. All above *num are incomplete sessions. Typically there is at most one incomplete session with no track. Wrapper for: burn_disc_get_sessions()

Since
0.1.6
Parameters
discThe master handle of the medium
numreturns the number of sessions in the array
Returns
the address of the array of session handles

Definition at line 1774 of file burn_wrap.c.

References isoburn_toc_disc::session_count, and isoburn_toc_disc::session_pointers.

Referenced by isoburn_get_mount_params(), isoburn_set_msc1(), isoburn_welcome_media(), Xorriso_check_media(), and Xorriso_toc().

◆ isoburn_toc_drive_get_disc()

◆ isoburn_toc_session_get_leadout_entry()

void isoburn_toc_session_get_leadout_entry ( struct isoburn_toc_session s,
struct burn_toc_entry entry 
)

Obtain a copy of the entry which describes the end of a particular session. Wrapper for: burn_session_get_leadout_entry()

Since
0.1.6
Parameters
sThe session handle
entryA pointer to memory provided by the caller. It will be filled with info according to struct burn_toc_entry as defined in libburn.h

Definition at line 1831 of file burn_wrap.c.

References burn_session_get_leadout_entry(), isoburn_toc_entry_finish(), isoburn_toc_entry::session, isoburn_toc_session::session, burn_toc_entry::start_lba, isoburn_toc_entry::start_lba, isoburn_toc_track::toc_entry, isoburn_toc_session::toc_entry, burn_toc_entry::track_blocks, isoburn_toc_entry::track_blocks, isoburn_toc_session::track_count, isoburn_toc_entry::track_no, and isoburn_toc_session::track_pointers.

Referenced by Xorriso_toc().

◆ isoburn_toc_session_get_sectors()

int isoburn_toc_session_get_sectors ( struct isoburn_toc_session s)

Tell the number of 2048 byte blocks covered by a particular session. Wrapper for: burn_session_get_sectors()

Since
0.1.6
Parameters
sThe session handle
Returns
number of blocks, <=0 indicates unknown or unreadable state

Definition at line 1788 of file burn_wrap.c.

References burn_session_get_sectors(), isoburn_toc_entry::next, isoburn_toc_session::session, isoburn_toc_session::toc_entry, isoburn_toc_entry::track_blocks, and isoburn_toc_session::track_count.

◆ isoburn_toc_session_get_tracks()

struct isoburn_toc_track** isoburn_toc_session_get_tracks ( struct isoburn_toc_session s,
int *  num 
)

Get the array of track handles from a particular session. Wrapper for: burn_session_get_tracks()

Since
0.1.6
Parameters
sThe session handle
numreturns the number of tracks in the array
Returns
the address of the array of track handles, NULL if no tracks are registered with session s

Definition at line 1852 of file burn_wrap.c.

References isoburn_toc_session::track_count, and isoburn_toc_session::track_pointers.

Referenced by isoburn_get_mount_params(), isoburn_set_msc1(), isoburn_welcome_media(), Xorriso_check_media(), and Xorriso_toc().

◆ isoburn_toc_track_get_emul()

int isoburn_toc_track_get_emul ( struct isoburn_toc_track t,
int *  start_lba,
int *  image_blocks,
char  volid[33],
int  flag 
)

Obtain eventual ISO image parameters of an emulated track. This info was gained with much effort and thus gets cached in the track object. If this call returns 1 then one can save a call of isoburn_read_iso_head() with return mode 1 which could cause an expensive read operation.

Since
0.4.0
Parameters
tThe track handle
start_lbaReturns the start address of the ISO session
image_blocksReturns the number of 2048 bytes blocks
volidCaller provided memory for the volume id
flagunused yet, submit 0
Returns
0= not an emulated ISO session , 1= reply is valid

Definition at line 1878 of file burn_wrap.c.

References isoburn_toc_entry::start_lba, isoburn_toc_track::toc_entry, isoburn_toc_entry::track_blocks, and isoburn_toc_entry::volid.

Referenced by isoburn_set_msc1(), and Xorriso_toc().

◆ isoburn_toc_track_get_entry()

void isoburn_toc_track_get_entry ( struct isoburn_toc_track t,
struct burn_toc_entry entry 
)

Obtain a copy of the entry which describes a particular track. Wrapper for: burn_track_get_entry()

Since
0.1.6
Parameters
tThe track handle
entryA pointer to memory provided by the caller. It will be filled with info according to struct burn_toc_entry as defined in libburn.h

Definition at line 1860 of file burn_wrap.c.

References burn_track_get_entry(), isoburn_toc_entry_finish(), isoburn_toc_entry::session, burn_toc_entry::start_lba, isoburn_toc_entry::start_lba, isoburn_toc_track::toc_entry, isoburn_toc_track::track, burn_toc_entry::track_blocks, isoburn_toc_entry::track_blocks, and isoburn_toc_entry::track_no.

Referenced by isoburn_get_track_lba(), Xorriso_check_media(), and Xorriso_toc().

◆ isoburn_version()

void isoburn_version ( int *  major,
int *  minor,
int *  micro 
)

Obtain the three release version numbers of the library. These are the numbers encountered by the application when linking with libisoburn, i.e. possibly not before run time. Better do not base the fundamental compatibility decision of an application on these numbers. For a reliable check use isoburn_is_compatible().

Since
0.1.0
Parameters
majorThe maturity version (0 for now, as we are still learning)
minorThe development goal version.
microThe development step version. This has an additional meaning:
         Pare numbers indicate a version with frozen API. I.e. you can
         rely on the same set of features to be present in all
         published releases with that major.minor.micro combination.
         Features of a pare release will stay available and ABI
         compatible as long as the SONAME of libisoburn stays "1".
         Currently there are no plans to ever change the SONAME.

         Odd numbers indicate that API upgrades are in progress.
         I.e. new features might be already present or they might
         be still missing. Newly introduced features may be changed
         incompatibly or even be revoked before release of a pare
         version.
         So micro revisions {1,3,5,7,9} should never be used for
         dynamic linking unless the proper library match can be
         guaranteed by external circumstances.
Returns
1 success, <=0 might in future become an error indication

Definition at line 808 of file isoburn.c.

References isoburn_header_version_major, isoburn_header_version_micro, and isoburn_header_version_minor.

Referenced by isoburn_initialize(), isoburn_is_compatible(), main(), Xorriso_preparer_string(), Xorriso_report_lib_versions(), and Xorriso_startup_libraries().