Go to the source code of this file.
Defines | |
#define | isoburn_libisofs_req_major 1 |
The minimum version of libisofs to be used with this version of libisoburn at compile time. | |
#define | isoburn_libisofs_req_minor 1 |
#define | isoburn_libisofs_req_micro 6 |
#define | isoburn_libburn_req_major 1 |
The minimum version of libburn to be used with this version of libisoburn at compile time. | |
#define | isoburn_libburn_req_minor 1 |
#define | isoburn_libburn_req_micro 8 |
#define | isoburn_header_version_major 1 |
These three release version numbers tell the revision of this header file and of the API it describes. | |
#define | isoburn_header_version_minor 1 |
#define | isoburn_header_version_micro 8 |
#define | isoburn_ropt_norock 1 |
Which existing ISO 9660 extensions in the image to read or not to read. | |
#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_has_rockridge 1 |
After calling function isoburn_read_image() there are informations available in the option set. | |
#define | isoburn_ropt_has_joliet 2 |
#define | isoburn_ropt_has_iso1999 4 |
#define | isoburn_ropt_has_el_torito 8 |
#define | isoburn_igopt_rockridge 1 |
Which extensions to support. | |
#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_omit_version_numbers 1 |
Relaxed constraints. | |
#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_sort_files_by_weight 1 |
Whether and how files should be sorted. | |
Functions | |
int | isoburn_initialize (char msg[1024], int flag) |
Initialize libisoburn, libisofs and libburn. | |
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. | |
void | isoburn_version (int *major, int *minor, int *micro) |
Obtain the three release version numbers of the library. | |
int | isoburn_libisofs_req (int *major, int *minor, int *micro) |
The minimum version of libisofs to be used with this version of libisoburn at runtime. | |
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. | |
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. | |
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) |
Announce to the library an application provided method for immediate delivery of messages. | |
int | isoburn_drive_scan_and_grab (struct burn_drive_info *drive_infos[], char *adr, int load) |
Aquire a target drive by its filesystem path resp. | |
int | isoburn_drive_aquire (struct burn_drive_info *drive_infos[], char *adr, int flag) |
Aquire a target drive by its filesystem path resp. | |
int | isoburn_drive_grab (struct burn_drive *drive, int load) |
Aquire a drive from the burn_drive_info[] array which was obtained by a previous call of burn_drive_scan(). | |
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) |
Attach to a drive an application provided method for immediate delivery of messages. | |
enum burn_disc_status | isoburn_disc_get_status (struct burn_drive *drive) |
Inquire the medium status. | |
int | isoburn_disc_erasable (struct burn_drive *d) |
Tells whether the medium can be treated by isoburn_disc_erase(). | |
void | isoburn_disc_erase (struct burn_drive *drive, int fast) |
Mark the medium as blank. | |
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. | |
isoburn_toc_disc * | isoburn_toc_drive_get_disc (struct burn_drive *d) |
Obtain a master handle for the table of content. | |
int | isoburn_toc_disc_get_sectors (struct isoburn_toc_disc *disc) |
Tell the number of 2048 byte blocks covered by the table of content. | |
isoburn_toc_session ** | isoburn_toc_disc_get_sessions (struct isoburn_toc_disc *disc, int *num) |
Get the array of session handles from the table of content. | |
int | isoburn_toc_session_get_sectors (struct isoburn_toc_session *s) |
Tell the number of 2048 byte blocks covered by a particular session. | |
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. | |
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. | |
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. | |
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. | |
void | isoburn_toc_disc_free (struct isoburn_toc_disc *disc) |
Release the memory associated with a master handle of a medium. | |
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. | |
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. | |
int | isoburn_ropt_new (struct isoburn_read_opts **o, int flag) |
Produces a set of image read options, initialized with default values. | |
int | isoburn_ropt_destroy (struct isoburn_read_opts **o, int flag) |
Deletes an option set which was created by isoburn_ropt_new(). | |
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) |
Default attributes to use if no RockRidge extension gets loaded. | |
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) |
Default attributes to use on directories if no RockRidge extension gets loaded. | |
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) |
Set the character set for reading RR file names from ISO images. | |
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) |
Enable or disable methods to automatically choose an input charset. | |
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) |
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. | |
int | isoburn_ropt_get_displacement (struct isoburn_read_opts *o, uint32_t *displacement, int *displacement_sign) |
int | isoburn_ropt_get_size_what (struct isoburn_read_opts *o, uint32_t *size, int *has_what) |
int | isoburn_igopt_new (struct isoburn_imgen_opts **o, int flag) |
Produces a set of generation and transfer options, initialized with default values. | |
int | isoburn_igopt_destroy (struct isoburn_imgen_opts **o, int flag) |
Deletes an option set which was created by isoburn_igopt_new(). | |
int | isoburn_igopt_set_level (struct isoburn_imgen_opts *o, int level) |
ISO level to write at. | |
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_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. | |
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) |
Set the override values for files and directory permissions. | |
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) |
Set the override values values for group id and user id. | |
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) |
Set the charcter set to use for representing RR filenames in the image. | |
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) |
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. | |
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) |
Obtain after image preparation the block address where the session will start on the medium. | |
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. | |
int | isoburn_igopt_set_scdbackup_tag (struct isoburn_imgen_opts *o, char *name, char *timestamp, char *tag_written) |
Set resp. | |
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) |
Attach 32 kB of binary data which shall get written to the first 32 kB of the ISO image, the System Area. | |
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) |
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. | |
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) |
Explicitely set the four timestamps of the emerging ISO image. | |
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) |
Associate a libjte environment object to the upcomming write run. | |
int | isoburn_igopt_detach_jte (struct isoburn_imgen_opts *opts, void **libjte_handle) |
Remove eventual association to a libjte environment handle. | |
int | isoburn_igopt_set_tail_blocks (struct isoburn_imgen_opts *opts, uint32_t num_blocks) |
Set resp. | |
int | isoburn_igopt_get_tail_blocks (struct isoburn_imgen_opts *opts, uint32_t *num_blocks) |
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. | |
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(). | |
int | isoburn_igopt_set_disc_label (struct isoburn_imgen_opts *opts, char *label) |
Set a name for the system area. | |
int | isoburn_igopt_get_disc_label (struct isoburn_imgen_opts *opts, char **label) |
Inquire the current setting made by isoburn_igopt_set_disc_label(). | |
IsoImage * | isoburn_get_attached_image (struct burn_drive *d) |
Get the image attached to a drive, if any. | |
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. | |
int | isoburn_set_read_pacifier (struct burn_drive *drive, int(*read_pacifier)(IsoImage *, IsoFileSource *), void *app_handle) |
Set a callback function for producing pacifier messages during the lengthy process of image reading. | |
int | isoburn_get_img_partition_offset (struct burn_drive *drive, uint32_t *block_offset_2k) |
Inquire the partition offset of the loaded image. | |
int | isoburn_attach_image (struct burn_drive *d, IsoImage *image) |
Set the IsoImage to be used with a drive. | |
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. | |
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. | |
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. | |
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 overwriteable media. | |
int | isoburn_prepare_disc (struct burn_drive *drive, struct burn_disc **disc, struct isoburn_imgen_opts *opts) |
To choose the expansion 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. | |
int | isoburn_prepare_new_image (struct burn_drive *in_drive, struct burn_disc **disc, struct isoburn_imgen_opts *opts, struct burn_drive *out_drive) |
To choose the expansion method of Modifying: Create a disc object for producing a new image from a previous image plus the changes made by user. | |
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) |
To choose the expansion 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. | |
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(). | |
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. | |
void | isoburn_disc_write (struct burn_write_opts *o, struct burn_disc *disc) |
Start writing of the new session. | |
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. | |
int | isoburn_drive_wrote_well (struct burn_drive *d) |
Inquire whether the most recent write run was successful. | |
int | isoburn_activate_session (struct burn_drive *d) |
Call this after isoburn_disc_write has finished and burn_drive_wrote_well() indicates success. | |
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. | |
void | isoburn_drive_release (struct burn_drive *drive, int eject) |
Release an aquired drive. | |
void | isoburn_finish (void) |
Shutdown all three libraries. | |
int | isoburn_needs_emulation (struct burn_drive *d) |
Inquire wether the medium needs emulation or would be suitable for generic multi-session via libburn. |
|
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.
Definition at line 306 of file libisoburn.h. |
|
Definition at line 308 of file libisoburn.h. |
|
Definition at line 307 of file libisoburn.h. |
|
Definition at line 1067 of file libisoburn.h. |
|
Definition at line 1171 of file libisoburn.h. |
|
Definition at line 1161 of file libisoburn.h. |
|
Definition at line 1174 of file libisoburn.h. |
|
Definition at line 1166 of file libisoburn.h. |
|
Definition at line 1162 of file libisoburn.h. |
|
Definition at line 1165 of file libisoburn.h. |
|
Definition at line 1168 of file libisoburn.h. |
|
Definition at line 1170 of file libisoburn.h. |
|
Definition at line 1069 of file libisoburn.h. |
|
Definition at line 1070 of file libisoburn.h. |
|
Definition at line 1066 of file libisoburn.h. |
|
Definition at line 1065 of file libisoburn.h. |
|
Definition at line 1064 of file libisoburn.h. |
|
Definition at line 1175 of file libisoburn.h. |
|
Definition at line 1167 of file libisoburn.h. |
|
Definition at line 1163 of file libisoburn.h. |
|
Definition at line 1071 of file libisoburn.h. |
|
Definition at line 1164 of file libisoburn.h. |
|
Definition at line 1173 of file libisoburn.h. |
|
Definition at line 1073 of file libisoburn.h. |
|
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.
Definition at line 1160 of file libisoburn.h. |
|
Definition at line 1172 of file libisoburn.h. |
|
Which extensions to support.
Definition at line 1063 of file libisoburn.h. |
|
Definition at line 1169 of file libisoburn.h. |
|
Definition at line 1068 of file libisoburn.h. |
|
Whether and how files should be sorted.
Definition at line 1218 of file libisoburn.h. |
|
Definition at line 1072 of file libisoburn.h. |
|
The minimum version of libburn to be used with this version of libisoburn at compile time.
Definition at line 251 of file libisoburn.h. |
|
Definition at line 253 of file libisoburn.h. |
|
Definition at line 252 of file libisoburn.h. |
|
The minimum version of libisofs to be used with this version of libisoburn at compile time.
Definition at line 243 of file libisoburn.h. |
|
Definition at line 245 of file libisoburn.h. |
|
Definition at line 244 of file libisoburn.h. |
|
Definition at line 940 of file libisoburn.h. |
|
Definition at line 939 of file libisoburn.h. |
|
Definition at line 938 of file libisoburn.h. |
|
After calling function isoburn_read_image() there are informations available in the option set. This info can be obtained as bits in parameter has_what. Like: joliet_available = (has_what & isoburn_ropt_has_joliet);
Definition at line 937 of file libisoburn.h. |
|
Definition at line 813 of file libisoburn.h. |
|
Definition at line 814 of file libisoburn.h. |
|
Definition at line 815 of file libisoburn.h. |
|
Definition at line 816 of file libisoburn.h. |
|
Definition at line 810 of file libisoburn.h. |
|
Definition at line 809 of file libisoburn.h. |
|
Definition at line 817 of file libisoburn.h. |
|
Definition at line 818 of file libisoburn.h. |
|
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 | resp. inquired by &.
Definition at line 808 of file libisoburn.h. |
|
Definition at line 811 of file libisoburn.h. |
|
Definition at line 812 of file libisoburn.h. |
|
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.
|
|
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.
|
|
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.
|
|
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()
|
|
Tells whether the medium can be treated by isoburn_disc_erase(). Wrapper for: burn_disc_erasable()
|
|
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()
|
|
Obtain the start block number of the most recent session on the medium. In case of random access media this will normally be 0. Successfull 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()
|
|
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()
|
|
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()
|
|
Start writing of the new session. This call is asynchrounous. I.e. it returns quite soon and the progress has to be watched by a loop with call burn_drive_get_status() until BURN_DRIVE_IDLE is returned. Wrapper for: burn_disc_write()
|
|
Aquire a target drive by its filesystem path resp. libburn persistent address. This is a modern successor of isoburn_drive_scan_and_grab(). Wrapper for: burn_drive_scan_and_grab()
|
|
Aquire a drive from the burn_drive_info[] array which was obtained by a previous call of burn_drive_scan(). Wrapper for: burn_drive_grab()
|
|
Release an aquired drive. Wrapper for: burn_drive_release()
|
|
Aquire a target drive by its filesystem path resp. libburn persistent address. Wrapper for: burn_drive_scan_and_grab()
|
|
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.
|
|
Inquire whether the most recent write run was successful. Wrapper for: burn_drive_wrote_well()
|
|
Shutdown all three libraries. Wrapper for : iso_finish() and burn_finish().
|
|
Get the image attached to a drive, if any.
|
|
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().
|
|
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().
|
|
Obtain the size which was attributed to an emulated appendable on actually overwriteable media. This value is supposed to be <= 2048 * nwa as of isoburn_disc_track_lba_nwa().
|
|
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.
|
|
Associate a libjte environment object to the upcomming 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.
|
|
Deletes an option set which was created by isoburn_igopt_new().
|
|
Remove eventual association to a libjte environment handle.
|
|
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.
|
|
Inquire the current setting made by isoburn_igopt_set_disc_label().
|
|
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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Inquire the current settings made by isoburn_igopt_set_partition_img().
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Produces a set of generation and transfer options, initialized with default values.
|
|
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"
|
|
|
|
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).
|
|
ISO level to write at.
|
|
Set the charcter set to use for representing RR filenames in the image.
|
|
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.
|
|
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.
|
|
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 will allow 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 resp. 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.
|
|
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.
|
|
Explicitely set the four timestamps of the emerging ISO image. Default with all parameters is 0.
|
|
|
|
Set resp. 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.
|
|
|
|
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.
|
|
Set resp. 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 .
|
|
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.
|
|
Initialize libisoburn, libisofs and libburn. Wrapper for : iso_init() and burn_initialize()
|
|
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...
|
|
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.
|
|
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.
|
|
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.
|
|
Inquire wether the medium needs emulation or would be suitable for generic multi-session via libburn.
|
|
To choose the expansion 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 aquired $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 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().
|
|
To choose the expansion 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 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().
|
|
To choose the expansion 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. 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().
|
|
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.
|
|
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.
|
|
Deletes an option set which was created by isoburn_ropt_new().
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Produces a set of image read options, initialized with default values.
|
|
Enable or disable methods to automatically choose an input charset. This eventually overrides the name set via isoburn_ropt_set_input_charset()
|
|
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 independend permissions for directories, especially to override the automatically added x-permissions.
|
|
Default attributes to use if no RockRidge extension gets loaded.
|
|
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.
|
|
|
|
Set the character set for reading RR file names from ISO images.
|
|
Set up isoburn_disc_get_msc1() to return a fabricated value. This makes only sense between aquiring 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.
|
|
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.
|
|
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.
|
|
Override the truncation setting that was made with flag bit2 during the call of isoburn_drive_aquire. This applies only to stdio pseudo drives.
|
|
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.
|
|
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()
|
|
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().
|
|
Get the array of session handles from the table of content. Wrapper for: burn_disc_get_sessions()
|
|
Obtain a master handle for the table of content. This handle governs allocated resources which have to be released by isoburn_toc_disc_free() when no longer needed. Wrapper for: burn_drive_get_disc()
|
|
Obtain a copy of the entry which describes the end of a particular session. Wrapper for: burn_session_get_leadout_entry()
|
|
Tell the number of 2048 byte blocks covered by a particular session. Wrapper for: burn_session_get_sectors()
|
|
Get the array of track handles from a particular session. Wrapper for: burn_session_get_tracks()
|
|
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.
|
|
Obtain a copy of the entry which describes a particular track. Wrapper for: burn_track_get_entry()
|
|
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().
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.
|