|
|
@ -17,6 +17,15 @@ 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. |
|
|
|
|
|
|
|
|
|
|
|
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 priciple of this frontend is that you may use any call of libisofs or |
|
|
@ -33,10 +42,11 @@ 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. |
|
|
|
|
|
|
|
Usage model |
|
|
|
Macros BURN_* and functions burn_*() are documented in <libburn/libburn.h> |
|
|
|
Macros ISO_* and functions iso_*() are documented in <libisofs/libisofs.h> |
|
|
|
|
|
|
|
|
|
|
|
Additionally there are own libisoburn API calls which allow to implement the |
|
|
|
following usage model (see also man xorriso for a end user's view): |
|
|
|
Usage model |
|
|
|
|
|
|
|
There may be an input drive and an output drive. Either of them may be missing |
|
|
|
with the consequence that no reading resp. writing is possible. |
|
|
@ -64,10 +74,11 @@ 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 or Modifying |
|
|
|
|
|
|
|
There are two alternative API calls for performing the setup for two |
|
|
|
alternative image generation strategies. |
|
|
|
The connector function family offers two alternative API calls for performing |
|
|
|
the setup for two alternative image generation strategies. |
|
|
|
|
|
|
|
Growing: |
|
|
|
If input and output drive is the same, then isoburn_prepare_disc() is to |
|
|
@ -98,7 +109,7 @@ 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 finalize any |
|
|
|
Finally one must call isoburn_activate_session() which will complete any |
|
|
|
eventual multi-session emulation. |
|
|
|
|
|
|
|
*/ |
|
|
@ -109,8 +120,9 @@ eventual multi-session emulation. |
|
|
|
|
|
|
|
/** Initialize libisoburn, libisofs and libburn. |
|
|
|
Wrapper for : iso_init() and burn_initialize() |
|
|
|
@param reason A character array for eventual messages (e.g. with errors) |
|
|
|
@param flag Bitfield for control purposes (unused yet, submit 0) |
|
|
|
@since 0.1.0 |
|
|
|
@param msg A character array for eventual messages (e.g. with errors) |
|
|
|
@param flag Bitfield for control purposes (unused yet, submit 0) |
|
|
|
@return 1 indicates success, 0 is failure |
|
|
|
*/ |
|
|
|
int isoburn_initialize(char msg[1024], int flag); |
|
|
@ -126,6 +138,7 @@ int isoburn_initialize(char msg[1024], int flag); |
|
|
|
isoburn_header_version_minor, |
|
|
|
isoburn_header_version_micro, 0)) |
|
|
|
...refuse to start the program with this dynamic library version... |
|
|
|
@since 0.1.0 |
|
|
|
@param major obtained at build time |
|
|
|
@param minor obtained at build time |
|
|
|
@param micro obtained at build time |
|
|
@ -143,6 +156,7 @@ int isoburn_is_compatible(int major, int minor, int micro, int flag); |
|
|
|
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 |
|
|
|
@param major The maturity version (0 for now, as we are still learning) |
|
|
|
@param minor The development goal version. |
|
|
|
@param micro The development step version. This has an additional meaning: |
|
|
@ -156,11 +170,14 @@ int isoburn_is_compatible(int major, int minor, int micro, int flag); |
|
|
|
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. |
|
|
|
@return 1 success, <=0 might in future become an error indication |
|
|
|
*/ |
|
|
|
void isoburn_version(int *major, int *minor, int *micro); |
|
|
|
|
|
|
|
|
|
|
|
/** The minimum version of libisofs to be used with this version of libisoburn |
|
|
|
at compile time. |
|
|
|
@since 0.1.0 |
|
|
|
*/ |
|
|
|
#define isoburn_libisofs_req_major 0 |
|
|
|
#define isoburn_libisofs_req_minor 6 |
|
|
@ -168,6 +185,7 @@ void isoburn_version(int *major, int *minor, int *micro); |
|
|
|
|
|
|
|
/** The minimum version of libburn to be used with this version of libisoburn |
|
|
|
at compile time. |
|
|
|
@since 0.1.0 |
|
|
|
*/ |
|
|
|
#define isoburn_libburn_req_major 0 |
|
|
|
#define isoburn_libburn_req_minor 4 |
|
|
@ -178,6 +196,11 @@ void isoburn_version(int *major, int *minor, int *micro); |
|
|
|
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 |
|
|
|
@param major isoburn_libisofs_req_major as seen at build time |
|
|
|
@param minor as seen at build time |
|
|
|
@param micro as seen at build time |
|
|
|
@return 1 success, <=0 might in future become an error indication |
|
|
|
*/ |
|
|
|
int isoburn_libisofs_req(int *major, int *minor, int *micro); |
|
|
|
|
|
|
@ -186,14 +209,19 @@ int isoburn_libisofs_req(int *major, int *minor, int *micro); |
|
|
|
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 |
|
|
|
@param major isoburn_libburn_req_major as seen at build time |
|
|
|
@param minor as seen at build time |
|
|
|
@param micro as seen at build time |
|
|
|
@return 1 success, <=0 might in future become an error indication |
|
|
|
*/ |
|
|
|
int isoburn_libburn_req(int *major, int *minor, int *micro); |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** 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 |
|
|
|
*/ |
|
|
|
#define isoburn_header_version_major 0 |
|
|
|
#define isoburn_header_version_minor 0 |
|
|
@ -254,6 +282,15 @@ see libisoburn/burn_wrap.c : isoburn_initialize() |
|
|
|
/** Aquire a target drive by its filesystem path resp. libburn persistent |
|
|
|
address. |
|
|
|
Wrapper for: burn_drive_scan_and_grab() |
|
|
|
@since 0.1.0 |
|
|
|
@param drive_infos On 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. |
|
|
|
@param adr The persistent address of the desired drive. |
|
|
|
@param load 1 attempt to load the disc tray. 0 no attempt,rather failure. |
|
|
|
@return 1 = success , 0 = drive not found , <0 = other error |
|
|
|
*/ |
|
|
|
int isoburn_drive_scan_and_grab(struct burn_drive_info *drive_infos[], |
|
|
|
char* adr, int load); |
|
|
@ -262,6 +299,10 @@ int isoburn_drive_scan_and_grab(struct burn_drive_info *drive_infos[], |
|
|
|
/** 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() |
|
|
|
@since 0.1.0 |
|
|
|
@param drive The drive to grab. E.g. drive_infos[1].drive . |
|
|
|
@param load 1 attempt to load the disc tray. 0 no attempt, rather failure. |
|
|
|
@return 1 success, <=0 failure |
|
|
|
*/ |
|
|
|
int isoburn_drive_grab(struct burn_drive *drive, int load); |
|
|
|
|
|
|
@ -270,12 +311,19 @@ int isoburn_drive_grab(struct burn_drive *drive, int load); |
|
|
|
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 |
|
|
|
@param drive The drive to inquire. |
|
|
|
@return The status of the drive, or what kind of disc is in it. |
|
|
|
Note: BURN_DISC_UNGRABBED indicates wrong API usage |
|
|
|
*/ |
|
|
|
enum burn_disc_status isoburn_disc_get_status(struct burn_drive *drive); |
|
|
|
|
|
|
|
|
|
|
|
/** Tells whether the media can be treated by isoburn_disc_erase(). |
|
|
|
Wrapper for: burn_disc_erasable() |
|
|
|
@since 0.1.0 |
|
|
|
@param drive The drive to inquire. |
|
|
|
@return 0=not erasable , else erasable |
|
|
|
*/ |
|
|
|
int isoburn_disc_erasable(struct burn_drive *d); |
|
|
|
|
|
|
@ -285,6 +333,10 @@ int isoburn_disc_erasable(struct burn_drive *d); |
|
|
|
filesystem will get invalidated by altering its start blocks on media. |
|
|
|
In case of success, the media is in status BURN_DISC_BLANK afterwards. |
|
|
|
Wrapper for: burn_disc_erase() |
|
|
|
@since 0.1.0 |
|
|
|
@param drive The drive with the media to erase. |
|
|
|
@param fast 1=fast erase, 0=thorough erase |
|
|
|
With DVD-RW, fast erase yields media incapable of multi-session. |
|
|
|
*/ |
|
|
|
void isoburn_disc_erase(struct burn_drive *drive, int fast); |
|
|
|
|
|
|
@ -304,13 +356,18 @@ void isoburn_disc_erase(struct burn_drive *drive, int fast); |
|
|
|
struct isoburn_read_opts; |
|
|
|
|
|
|
|
/** Produces a set of image read options, initialized with default values. |
|
|
|
@since 0.1.0 |
|
|
|
@param o the newly created option set object |
|
|
|
@param flag Bitfield for control purposes. Submit 0 for now. |
|
|
|
@return 1=ok , <0 = failure |
|
|
|
*/ |
|
|
|
int isoburn_ropt_new(struct isoburn_read_opts **o, int flag); |
|
|
|
|
|
|
|
|
|
|
|
/** Deletes an option set which was created by isoburn_ropt_new(). |
|
|
|
@since 0.1.0 |
|
|
|
@param o The option set to work on |
|
|
|
@param flag Bitfield for control purposes. Submit 0 for now. |
|
|
|
@return 1= **o destroyed , 0= *o was already NULL (harmless) |
|
|
|
*/ |
|
|
|
int isoburn_ropt_destroy(struct isoburn_read_opts **o, int flag); |
|
|
@ -319,6 +376,7 @@ int isoburn_ropt_destroy(struct isoburn_read_opts **o, int flag); |
|
|
|
/** 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 &. |
|
|
|
@since 0.1.0 |
|
|
|
@param ext Bitfield: |
|
|
|
bit0= norock |
|
|
|
Do not read Rock Ridge extensions |
|
|
@ -331,6 +389,7 @@ int isoburn_ropt_destroy(struct isoburn_read_opts **o, int flag); |
|
|
|
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. |
|
|
|
@return 1 success, <=0 failure |
|
|
|
*/ |
|
|
|
#define isoburn_ropt_norock 1 |
|
|
|
#define isoburn_ropt_nojoliet 2 |
|
|
@ -342,11 +401,14 @@ int isoburn_ropt_get_extensions(struct isoburn_read_opts *o, int *ext); |
|
|
|
|
|
|
|
|
|
|
|
/** Default attributes to use if no RockRidge extension gets loaded. |
|
|
|
@since 0.1.0 |
|
|
|
@param o The option set to work on |
|
|
|
@param uid user id number (see /etc/passwd) |
|
|
|
@param gid group id number (see /etc/group) |
|
|
|
@param mode permissions (not file type) as of man 2 stat. |
|
|
|
With directories, r-permissions will automatically imply |
|
|
|
x-permissions. See isoburn_ropt_set_default_dirperms() below. |
|
|
|
@return 1 success, <=0 failure |
|
|
|
*/ |
|
|
|
int isoburn_ropt_set_default_perms(struct isoburn_read_opts *o, |
|
|
|
uid_t uid, gid_t gid, mode_t mode); |
|
|
@ -359,6 +421,10 @@ int isoburn_ropt_get_default_perms(struct isoburn_read_opts *o, |
|
|
|
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. |
|
|
|
@since 0.1.0 |
|
|
|
@param o The option set to work on |
|
|
|
@param mode permissions (not file type) as of man 2 stat. |
|
|
|
@return 1 success, <=0 failure |
|
|
|
*/ |
|
|
|
int isoburn_ropt_set_default_dirperms(struct isoburn_read_opts *o, |
|
|
|
mode_t mode); |
|
|
@ -368,10 +434,13 @@ int isoburn_ropt_get_default_dirperms(struct isoburn_read_opts *o, |
|
|
|
|
|
|
|
|
|
|
|
/** Set the character set for reading RR file names from ISO images. |
|
|
|
@since 0.1.0 |
|
|
|
@param o The option set to work on |
|
|
|
@param input_charset Set 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". |
|
|
|
@return 1 success, <=0 failure |
|
|
|
*/ |
|
|
|
int isoburn_ropt_set_input_charset(struct isoburn_read_opts *o, |
|
|
|
char *input_charset); |
|
|
@ -383,6 +452,8 @@ int isoburn_ropt_get_input_charset(struct isoburn_read_opts *o, |
|
|
|
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); |
|
|
|
@since 0.1.0 |
|
|
|
@param o The option set to work on |
|
|
|
@param size Number of image data blocks, 2048 bytes each. |
|
|
|
@param has_what Bitfield: |
|
|
|
bit0= has_rockridge |
|
|
@ -394,6 +465,7 @@ int isoburn_ropt_get_input_charset(struct isoburn_read_opts *o, |
|
|
|
This is rather exotic. |
|
|
|
bit3= has_el_torito |
|
|
|
El-Torito boot record is present |
|
|
|
@return 1 success, <=0 failure |
|
|
|
*/ |
|
|
|
#define isoburn_ropt_has_rockridge 1 |
|
|
|
#define isoburn_ropt_has_joliet 2 |
|
|
@ -424,28 +496,38 @@ struct isoburn_imgen_opts; |
|
|
|
|
|
|
|
/** Produces a set of generation and transfer options, initialized with default |
|
|
|
values. |
|
|
|
@since 0.1.0 |
|
|
|
@param o the newly created option set object |
|
|
|
@param flag Bitfield for control purposes. Submit 0 for now. |
|
|
|
@return 1=ok , <0 = failure |
|
|
|
*/ |
|
|
|
int isoburn_igopt_new(struct isoburn_imgen_opts **o, int flag); |
|
|
|
|
|
|
|
|
|
|
|
/** Deletes an option set which was created by isoburn_igopt_new(). |
|
|
|
@since 0.1.0 |
|
|
|
@param o The option set to give up |
|
|
|
@param flag Bitfield for control purposes. Submit 0 for now. |
|
|
|
@return 1= **o destroyed , 0= *o was already NULL (harmless) |
|
|
|
*/ |
|
|
|
int isoburn_igopt_destroy(struct isoburn_imgen_opts **o, int flag); |
|
|
|
|
|
|
|
|
|
|
|
/** ISO level to write at. |
|
|
|
@since 0.1.0 |
|
|
|
@param o The option set to work on |
|
|
|
@param level is 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 |
|
|
|
@return 1 success, <=0 failure |
|
|
|
*/ |
|
|
|
int isoburn_igopt_set_level(struct isoburn_imgen_opts *o, int level); |
|
|
|
int isoburn_igopt_get_level(struct isoburn_imgen_opts *o, int *level); |
|
|
|
|
|
|
|
|
|
|
|
/** Which extensions to support. |
|
|
|
@since 0.1.0 |
|
|
|
@param o The option set to work on |
|
|
|
@param ext Bitfield: |
|
|
|
bit0= rockridge |
|
|
|
Rock Ridge extensions add POSIX file attributes like |
|
|
@ -456,6 +538,7 @@ int isoburn_igopt_get_level(struct isoburn_imgen_opts *o, int *level); |
|
|
|
Weaker than RockRidge, but also readable with Linux. |
|
|
|
bit2= iso1999 |
|
|
|
This is rather exotic. Better do not surprise the readers. |
|
|
|
@return 1 success, <=0 failure |
|
|
|
*/ |
|
|
|
#define isoburn_igopt_rockridge 1 |
|
|
|
#define isoburn_igopt_joliet 2 |
|
|
@ -465,6 +548,8 @@ int isoburn_igopt_get_extensions(struct isoburn_imgen_opts *o, int *ext); |
|
|
|
|
|
|
|
/** 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 |
|
|
|
@param o The option set to work on |
|
|
|
@param relax Bitfield: |
|
|
|
bit0= omit_version_numbers |
|
|
|
Omit the version number (";1") at the end of the |
|
|
@ -498,6 +583,7 @@ int isoburn_igopt_get_extensions(struct isoburn_imgen_opts *o, int *ext); |
|
|
|
bit7= joliet_longer_paths |
|
|
|
Allow paths in the Joliet tree to have more than |
|
|
|
240 characters. |
|
|
|
@return 1 success, <=0 failure |
|
|
|
*/ |
|
|
|
#define isoburn_igopt_omit_version_numbers 1 |
|
|
|
#define isoburn_igopt_allow_deep_paths 2 |
|
|
@ -512,10 +598,13 @@ int isoburn_igopt_get_relaxed(struct isoburn_imgen_opts *o, int *relax); |
|
|
|
|
|
|
|
|
|
|
|
/** Whether and how files should be sorted. |
|
|
|
@since 0.1.0 |
|
|
|
@param o The option set to work on |
|
|
|
@param value Bitfield: 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(). |
|
|
|
@return 1 success, <=0 failure |
|
|
|
*/ |
|
|
|
#define isoburn_igopt_sort_files_by_weight 1 |
|
|
|
int isoburn_igopt_set_sort_files(struct isoburn_imgen_opts *o, int value); |
|
|
@ -531,10 +620,13 @@ int isoburn_igopt_get_sort_files(struct isoburn_imgen_opts *o, int *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 |
|
|
|
@param o The option set to work on |
|
|
|
@param replace_dir_mode whether and how to override directories |
|
|
|
@param replace_file_mode whether and how to override files of other type |
|
|
|
@param dir_mode Mode to use on dirs with replace_dir_mode == 2. |
|
|
|
@param file_mode; Mode to use on files with replace_file_mode == 2. |
|
|
|
@return 1 success, <=0 failure |
|
|
|
*/ |
|
|
|
int isoburn_igopt_set_over_mode(struct isoburn_imgen_opts *o, |
|
|
|
int replace_dir_mode, int replace_file_mode, |
|
|
@ -546,10 +638,13 @@ int isoburn_igopt_get_over_mode(struct isoburn_imgen_opts *o, |
|
|
|
/** 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 |
|
|
|
@param o The option set to work on |
|
|
|
@param replace_uid whether and how to override user ids |
|
|
|
@param replace_gid whether and how to override group ids |
|
|
|
@param uid User id to use with replace_uid == 2. |
|
|
|
@param gid Group id to use on files with replace_gid == 2. |
|
|
|
@return 1 success, <=0 failure |
|
|
|
*/ |
|
|
|
int isoburn_igopt_set_over_ugid(struct isoburn_imgen_opts *o, |
|
|
|
int replace_uid, int replace_gid, |
|
|
@ -559,10 +654,13 @@ int isoburn_igopt_get_over_ugid(struct isoburn_imgen_opts *o, |
|
|
|
uid_t *uid, gid_t *gid); |
|
|
|
|
|
|
|
/** Set the charcter set to use for representing filenames in the image. |
|
|
|
@since 0.1.0 |
|
|
|
@param o The option set to work on |
|
|
|
@param output_charset Set 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". |
|
|
|
@return 1 success, <=0 failure |
|
|
|
*/ |
|
|
|
int isoburn_igopt_set_out_charset(struct isoburn_imgen_opts *o, |
|
|
|
char *output_charset); |
|
|
@ -576,27 +674,36 @@ int isoburn_igopt_get_out_charset(struct isoburn_imgen_opts *o, |
|
|
|
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 |
|
|
|
@param o The option set to work on |
|
|
|
@param fifo_size Number of bytes to use |
|
|
|
@return 1 success, <=0 failure |
|
|
|
*/ |
|
|
|
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); |
|
|
|
|
|
|
|
|
|
|
|
/* ----------------------------------------------------------------------- */ |
|
|
|
/* End of Options for image generation */ |
|
|
|
/* ----------------------------------------------------------------------- */ |
|
|
|
|
|
|
|
|
|
|
|
/** Get the image attached to a drive, if any. |
|
|
|
@since 0.1.0 |
|
|
|
@param d The drive to inquire |
|
|
|
@return 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. |
|
|
|
*/ |
|
|
|
IsoImage *isoburn_get_attached_image(struct burn_drive *d); |
|
|
|
|
|
|
|
|
|
|
|
/** Load the ISO filesystem directory tree from the media 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 |
|
|
|
@param d The 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() |
|
|
@ -618,7 +725,6 @@ int isoburn_read_image(struct burn_drive *d, |
|
|
|
struct isoburn_read_opts *read_opts, |
|
|
|
IsoImage **image); |
|
|
|
|
|
|
|
/* @since 0.1.0 */ |
|
|
|
/** 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. |
|
|
@ -627,15 +733,19 @@ int isoburn_read_image(struct burn_drive *d, |
|
|
|
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 |
|
|
|
@param drive The drive which will be used with isoburn_read_image() |
|
|
|
It has to be aquired by an isoburn_* wrapper call. |
|
|
|
@param read_pacifier The callback function |
|
|
|
@param app_handle The app handle which the callback function can obtain |
|
|
|
via iso_image_get_attached_data() from its IsoImage* |
|
|
|
@return 1 success, <=0 failure |
|
|
|
*/ |
|
|
|
int isoburn_set_read_pacifier(struct burn_drive *drive, |
|
|
|
int (*read_pacifier)(IsoImage*, IsoFileSource*), |
|
|
|
void *app_handle); |
|
|
|
|
|
|
|
|
|
|
|
/** 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 |
|
|
@ -643,6 +753,7 @@ int isoburn_set_read_pacifier(struct burn_drive *drive, |
|
|
|
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 |
|
|
|
@param d The drive which shall be write target of the volset. |
|
|
|
@param image The image that represents the image to be written. |
|
|
|
This image pointer MUST already be a valid reference suitable |
|
|
@ -661,6 +772,7 @@ int isoburn_attach_image(struct burn_drive *d, IsoImage *image); |
|
|
|
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 |
|
|
|
@param d The drive to query. |
|
|
|
@param o If not NULL: write parameters to be set on drive before query |
|
|
|
@return number of most probably available free bytes |
|
|
@ -674,6 +786,10 @@ off_t isoburn_disc_available_space(struct burn_drive *d, |
|
|
|
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. |
|
|
|
Wrapper for: burn_disc_get_msc1() |
|
|
|
@since 0.1.0 |
|
|
|
@param d The drive to inquire |
|
|
|
@param start_lba Contains on success the start address in 2048 byte blocks |
|
|
|
@return <=0 error , 1 = success |
|
|
|
*/ |
|
|
|
int isoburn_disc_get_msc1(struct burn_drive *d, int *start_lba); |
|
|
|
|
|
|
@ -681,6 +797,13 @@ int isoburn_disc_get_msc1(struct burn_drive *d, int *start_lba); |
|
|
|
/** 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 |
|
|
|
@param d The drive to inquire |
|
|
|
@param o If not NULL: write parameters to be set on drive before query |
|
|
|
@param trackno Submit 0. |
|
|
|
@param lba return value: start lba |
|
|
|
@param nwa return value: Next Writeable Address |
|
|
|
@return 1=nwa is valid , 0=nwa is not valid , -1=error |
|
|
|
*/ |
|
|
|
int isoburn_disc_track_lba_nwa(struct burn_drive *d, struct burn_write_opts *o, |
|
|
|
int trackno, int *lba, int *nwa); |
|
|
@ -689,6 +812,7 @@ int isoburn_disc_track_lba_nwa(struct burn_drive *d, struct burn_write_opts *o, |
|
|
|
/** 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(). |
|
|
|
@since 0.1.0 |
|
|
|
@param drive The drive holding the media. |
|
|
|
@param start_byte The reply value counted in bytes, not in sectors. |
|
|
|
@param flag Unused yet. Submit 0. |
|
|
@ -704,9 +828,11 @@ int isoburn_get_min_start_byte(struct burn_drive *d, off_t *start_byte, |
|
|
|
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 |
|
|
|
@param drive The combined source and target drive, grabbed with |
|
|
|
isoburn_drive_scan_and_grab(). . |
|
|
|
@param disc Returns the newly created burn_disc object. |
|
|
|
@param opts Image generation options, see isoburn_igopt_*() |
|
|
|
@return <=0 error , 1 = success |
|
|
|
*/ |
|
|
|
int isoburn_prepare_disc(struct burn_drive *drive, struct burn_disc **disc, |
|
|
@ -722,6 +848,7 @@ int isoburn_prepare_disc(struct burn_drive *drive, struct burn_disc **disc, |
|
|
|
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 |
|
|
|
@param in_drive The input drive,grabbed with isoburn_drive_scan_and_grab(). |
|
|
|
@param disc Returns the newly created burn_disc object. |
|
|
|
@param opts Options for image generation and data transport to media. |
|
|
@ -745,6 +872,7 @@ int isoburn_prepare_new_image(struct burn_drive *in_drive, |
|
|
|
image stream when one of above two calls is performed. It is mandatory to |
|
|
|
either run isoburn_disc_write() or to revoke the preparations by the |
|
|
|
call described here. |
|
|
|
@since 0.1.0 |
|
|
|
@param input_drive The drive resp. in_drive which was used with the |
|
|
|
preparation call. |
|
|
|
@param output_drive The out_drive used with isoburn_prepare_new_image(), |
|
|
@ -762,6 +890,11 @@ int isoburn_cancel_prepared_write(struct burn_drive *input_drive, |
|
|
|
to be watched by a loop with call burn_drive_get_status() until |
|
|
|
BURN_DRIVE_IDLE is returned. |
|
|
|
Wrapper for: burn_disc_write() |
|
|
|
@since 0.1.0 |
|
|
|
@param o Options which control the burn process. See burnwrite_opts_*() |
|
|
|
in libburn.h. |
|
|
|
@param disc Disc object created either by isoburn_prepare_disc() or by |
|
|
|
isoburn_prepare_new_image(). |
|
|
|
*/ |
|
|
|
void isoburn_disc_write(struct burn_write_opts *o, struct burn_disc *disc); |
|
|
|
|
|
|
@ -774,6 +907,7 @@ void isoburn_disc_write(struct burn_write_opts *o, struct burn_disc *disc); |
|
|
|
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 |
|
|
|
@parm d The drive to which the track with the fifo gets burned. |
|
|
|
@param size The total size of the fifo |
|
|
|
@param free_bytes The current free capacity of the fifo |
|
|
@ -795,6 +929,9 @@ int isoburn_get_fifo_status(struct burn_drive *d, int *size, int *free_bytes, |
|
|
|
|
|
|
|
/** Inquire whether the most recent write run was successful. |
|
|
|
Wrapper for: burn_drive_wrote_well() |
|
|
|
@since 0.1.0 |
|
|
|
@param d The drive to inquire |
|
|
|
@return 1=burn seems to have went well, 0=burn failed |
|
|
|
*/ |
|
|
|
int isoburn_drive_wrote_well(struct burn_drive *d); |
|
|
|
|
|
|
@ -803,6 +940,9 @@ int isoburn_drive_wrote_well(struct burn_drive *d); |
|
|
|
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 |
|
|
|
@param d The output drive to which the session was written |
|
|
|
@return 1 success , <=0 failure |
|
|
|
*/ |
|
|
|
int isoburn_activate_session(struct burn_drive *drive); |
|
|
|
|
|
|
@ -812,6 +952,7 @@ int isoburn_activate_session(struct burn_drive *drive); |
|
|
|
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 |
|
|
|
@param input_drive The drive resp. in_drive which was used with the |
|
|
|
preparation call. |
|
|
|
@param output_drive The out_drive used with isoburn_prepare_new_image(), |
|
|
@ -840,12 +981,16 @@ int isoburn_perform_write(struct burn_write_opts *o, |
|
|
|
|
|
|
|
/** Release an aquired drive. |
|
|
|
Wrapper for: burn_drive_release() |
|
|
|
@since 0.1.0 |
|
|
|
@param drive The drive to be released |
|
|
|
@param eject 1= eject media from drive , 0= do not eject |
|
|
|
*/ |
|
|
|
void isoburn_drive_release(struct burn_drive *drive, int eject); |
|
|
|
|
|
|
|
|
|
|
|
/** Shutdown all three libraries. |
|
|
|
Wrapper for : iso_finish() and burn_finish(). |
|
|
|
@since 0.1.0 |
|
|
|
*/ |
|
|
|
void isoburn_finish(void); |
|
|
|
|
|
|
@ -858,6 +1003,8 @@ void isoburn_finish(void); |
|
|
|
|
|
|
|
/** Inquire wether the media needs emulation or would be suitable for |
|
|
|
generic multi-session via libburn. |
|
|
|
@since 0.1.0 |
|
|
|
@param d The drive to inquire |
|
|
|
@return 0 is generic multi-session |
|
|
|
1 is emulated multi-session |
|
|
|
-1 is not suitable for isoburn |
|
|
|