You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
650 lines
28 KiB
650 lines
28 KiB
|
|
/* |
|
API definition of libisoburn. |
|
|
|
Copyright 2007-2008 Vreixo Formoso Lopes <metalpain2002@yahoo.es> |
|
and Thomas Schmitt <scdbackup@gmx.net> |
|
*/ |
|
|
|
/** Overview |
|
|
|
libisoburn is a frontend for libraries libburn and libisofs which enables |
|
creation and expansion of ISO-9660 filesystems on all CD/DVD 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. |
|
|
|
Wrapper functions |
|
|
|
The priciple 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. |
|
|
|
Usage model |
|
|
|
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): |
|
|
|
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. |
|
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 resp. 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. |
|
It may be manipulated 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. |
|
It may be manipulated 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 or Modifying |
|
|
|
There are 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 |
|
be used. It will lead to an add-on session on appendable or overwriteable |
|
media with existing ISO image. With blank media it will produce a first |
|
session. |
|
|
|
Modifying: |
|
If the output drive is not the input drive, then it has to bear blank media |
|
or overwriteable without a valid ISO image. To prepare for such an image |
|
generation run, use isoburn_prepare_new_image(). The run 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. |
|
|
|
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 finalize any |
|
eventual multi-session emulation. |
|
|
|
*/ |
|
|
|
|
|
/* API functions */ |
|
|
|
|
|
/** 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) |
|
@return 1 indicates success, 0 is failure |
|
*/ |
|
int isoburn_initialize(char msg[1024], int flag); |
|
|
|
|
|
/** Obtain the three release version numbers of the library. |
|
@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: |
|
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. |
|
Odd numbers indicate that API upgrades are in progress. |
|
I.e. new features might be already present or they might |
|
be still missing. You need to check before compiling an |
|
application which relies on freshly introduced features. |
|
*/ |
|
void isoburn_version(int *major, int *minor, int *micro); |
|
|
|
|
|
/* >>> isoburn_is_compatible() */ |
|
|
|
|
|
/** Aquire a target drive by its filesystem path resp. libburn persistent |
|
address. |
|
Wrapper for: burn_drive_scan_and_grab() |
|
*/ |
|
int isoburn_drive_scan_and_grab(struct burn_drive_info *drive_infos[], |
|
char* adr, int load); |
|
|
|
|
|
/** 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() |
|
*/ |
|
int isoburn_drive_grab(struct burn_drive *drive, int load); |
|
|
|
|
|
/** Inquire the media 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() |
|
*/ |
|
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() |
|
*/ |
|
int isoburn_disc_erasable(struct burn_drive *d); |
|
|
|
|
|
/** Mark the media 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 media. |
|
In case of success, the media is in status BURN_DISC_BLANK afterwards. |
|
Wrapper for: burn_disc_erase() |
|
*/ |
|
void isoburn_disc_erase(struct burn_drive *drive, int fast); |
|
|
|
|
|
/* ----------------------------------------------------------------------- */ |
|
/* |
|
|
|
Options for image reading. |
|
|
|
An application shall create an option set object by isoburn_ropt_new(), |
|
program it by isoburn_ropt_set_*(), use it with isoburn_read_image(), |
|
and finally delete it by isoburn_ropt_destroy(). |
|
|
|
*/ |
|
/* ----------------------------------------------------------------------- */ |
|
|
|
struct isoburn_read_opts; |
|
|
|
/** Produces a set of image read options, initialized with default values. |
|
@param o the newly created option set object |
|
@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(). |
|
@return 1= **o destroyed , 0= *o was already NULL (harmless) |
|
*/ |
|
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 &. |
|
@param ext Bitfield: |
|
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. |
|
*/ |
|
#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 |
|
int isoburn_ropt_set_extensions(struct isoburn_read_opts *o, int ext); |
|
int isoburn_ropt_get_extensions(struct isoburn_read_opts *o, int *ext); |
|
|
|
|
|
/** Default attributes to use if no RockRidge extension gets loaded. |
|
@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. |
|
*/ |
|
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); |
|
|
|
|
|
/** Input charset for RR file names. NULL to use default locale charset. |
|
>>> what if not NULL ? |
|
*/ |
|
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); |
|
|
|
|
|
/** 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); |
|
@param size Number of image data blocks, 2048 bytes each. |
|
@param has_what Bitfield: |
|
bit0= has_rockridge |
|
RockRidge extension info is available (POSIX filesystem) |
|
bit1= has_joliet |
|
Joliet extension info is available (suitable for MS-Windows) |
|
bit2= has_iso1999 |
|
ISO version 2 Enhanced Volume Descriptor is available |
|
>>> what is ISO 1999 good for ? |
|
bit3= has_el_torito |
|
El-Torito boot record is present |
|
*/ |
|
#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 |
|
int isoburn_ropt_get_size_what(struct isoburn_read_opts *o, |
|
uint32_t *size, int *has_what); |
|
|
|
|
|
/* ----------------------------------------------------------------------- */ |
|
/* End of Options for image reading */ |
|
/* ----------------------------------------------------------------------- */ |
|
|
|
/* ----------------------------------------------------------------------- */ |
|
/* |
|
|
|
Options for image generation by libisofs and image transport to libburn. |
|
|
|
An application shall create an option set by isoburn_igopt_new(), |
|
program it by isoburn_igopt_set_*(), use it with either |
|
isoburn_prepare_new_image() or isoburn_prepare_disc(), and finally delete |
|
it by isoburn_igopt_destroy(). |
|
|
|
*/ |
|
/* ----------------------------------------------------------------------- */ |
|
|
|
struct isoburn_imgen_opts; |
|
|
|
/** Produces a set of generation and transfer options, initialized with default |
|
values. |
|
@param o the newly created option set object |
|
@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(). |
|
@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. |
|
>>> what is an ISO level ? xorriso uses 2. |
|
*/ |
|
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. |
|
@param ext Bitfield: bit0= rockridge, bit1= joliet, bit2= iso1999 |
|
*/ |
|
#define isoburn_igopt_rockridge 1 |
|
#define isoburn_igopt_joliet 2 |
|
#define isoburn_igopt_iso1999 4 |
|
int isoburn_igopt_set_extensions(struct isoburn_imgen_opts *o, int ext); |
|
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. |
|
@param relax Bitfield: |
|
bit0= omit_version_numbers |
|
Omit the version number (";1") at the end of the |
|
ISO-9660 identifiers. Version numbers are usually |
|
not used. |
|
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. |
|
*/ |
|
#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 |
|
int isoburn_igopt_set_relaxed(struct isoburn_imgen_opts *o, int relax); |
|
int isoburn_igopt_get_relaxed(struct isoburn_imgen_opts *o, int *relax); |
|
|
|
|
|
/** Whether and how files should be sorted. |
|
@param value Bitfield: bit0= sort_files_by_weight |
|
files should be sorted based on their weight. |
|
>>> what is weight ? |
|
*/ |
|
#define isoburn_igopt_sort_files_by_weight 1 |
|
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); |
|
|
|
|
|
/** 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. |
|
@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. |
|
*/ |
|
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); |
|
|
|
/** 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. |
|
@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. |
|
*/ |
|
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); |
|
|
|
/** Set this to NULL to use the default charset. |
|
>>> What if not NULL or not want default ? |
|
*/ |
|
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); |
|
|
|
|
|
/** 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). |
|
*/ |
|
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. |
|
@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. |
|
@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() |
|
with the volset from this call and with the intended output |
|
drive. |
|
@param read_opts The read options which can be chosen by the application |
|
@param image the 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. |
|
@return <=0 error , 1 = success |
|
*/ |
|
int isoburn_read_image(struct burn_drive *d, |
|
struct isoburn_read_opts *read_opts, |
|
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 media. |
|
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. |
|
@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 |
|
for iso_image_unref(). |
|
It may have been obtained by appropriate libisofs calls or by |
|
isoburn_read_image() with d==NULL. |
|
@return <=0 error , 1 = success |
|
*/ |
|
int isoburn_attach_image(struct burn_drive *d, IsoImage *image); |
|
|
|
|
|
/** Obtain the start block number of the most recent session on media. In |
|
case of random access media this will always be 0. Succesfull 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. |
|
Wrapper for: burn_disc_get_msc1() |
|
*/ |
|
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() |
|
*/ |
|
int isoburn_disc_track_lba_nwa(struct burn_drive *d, struct burn_write_opts *o, |
|
int trackno, int *lba, int *nwa); |
|
|
|
|
|
/** 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(). |
|
@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. |
|
@return 1=stat_byte is valid, 0=not an emulated appendable, -1=error |
|
*/ |
|
int isoburn_get_min_start_byte(struct burn_drive *d, off_t *start_byte, |
|
int flag); |
|
|
|
|
|
/** 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 media 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(). |
|
@param drive The combined source and target drive, grabbed with |
|
isoburn_drive_scan_and_grab(). . |
|
@param disc Returns the newly created burn_disc object. |
|
@return <=0 error , 1 = success |
|
*/ |
|
int isoburn_prepare_disc(struct burn_drive *d, struct burn_disc **disc, |
|
struct isoburn_imgen_opts *opts); |
|
|
|
|
|
/** 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 any grabbed libburn drive with blank writeable media. |
|
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(). |
|
@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. |
|
@param out_drive The libburn drive which shall be write target. |
|
If the drive was grabbed via libisoburn then it can later |
|
access the libisofs source fifo via |
|
isoburn_get_fifo_status(). |
|
Mere libburn drives cannot obtain this info. |
|
In that case out_drive may be NULL, as well. |
|
@return <=0 error , 1 = success |
|
*/ |
|
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 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() |
|
*/ |
|
void isoburn_disc_write(struct burn_write_opts *o, struct burn_disc *disc); |
|
|
|
|
|
/** 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(). |
|
@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 |
|
@param status_text Returns a pointer to a constant text, see below |
|
@return <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 |
|
*/ |
|
int isoburn_get_fifo_status(struct burn_drive *d, int *size, int *free_bytes, |
|
char **status_text); |
|
|
|
|
|
/** Inquire whether the most recent write run was successful. |
|
Wrapper for: burn_drive_wrote_well() |
|
*/ |
|
int isoburn_drive_wrote_well(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. |
|
*/ |
|
int isoburn_activate_session(struct burn_drive *drive); |
|
|
|
|
|
#if 0 |
|
/* >>> NOT YET IMPLEMENTED <<< */ |
|
/** Write a new session to a disc. |
|
This is a synchronous call equivalent to isoburn_prepare_disc + |
|
isoburn_disc_write + isoburn_activate_session |
|
@param pacifier_func If not NULL: a function to produce appeasing messages. |
|
See burn_abort_pacifier() in libburn.h for an example. |
|
*/ |
|
/* TODO implement this */ |
|
int isoburn_perform_write(struct burn_write_opts *o, |
|
int (*pacifier_func)(void *handle, int patience, |
|
int elapsed)); |
|
#endif /* 0 */ |
|
|
|
|
|
/** Release an aquired drive. |
|
Wrapper for: burn_drive_release() |
|
*/ |
|
void isoburn_drive_release(struct burn_drive *drive, int eject); |
|
|
|
|
|
/** Shutdown all three libraries. |
|
Wrapper for : iso_finish() and burn_finish(). |
|
*/ |
|
void isoburn_finish(void); |
|
|
|
|
|
/* |
|
The following calls are for expert applications only. |
|
An application should have a special reason to use them. |
|
*/ |
|
|
|
|
|
/** Inquire wether the media needs emulation or would be suitable for |
|
generic multi-session via libburn. |
|
@return 0 is generic multi-session |
|
1 is emulated multi-session |
|
-1 is not suitable for isoburn |
|
*/ |
|
int isoburn_needs_emulation(struct burn_drive *drive); |
|
|
|
|
|
|