libisoburn-0.3.4/libisoburn/libisoburn.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines

#define isoburn_libisofs_req_major   0
 The minimum version of libisofs to be used with this version of libisoburn at compile time.
#define isoburn_libisofs_req_minor   6
#define isoburn_libisofs_req_micro   14
#define isoburn_libburn_req_major   0
 The minimum version of libburn to be used with this version of libisoburn at compile time.
#define isoburn_libburn_req_minor   6
#define isoburn_libburn_req_micro   0
#define isoburn_header_version_major   0
 These three release version numbers tell the revision of this header file and of the API it describes.
#define isoburn_header_version_minor   3
#define isoburn_header_version_micro   4
#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_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_aaip   32
#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_sort_files_by_weight   1
 Whether and how files should be sorted.

Functions

int isoburn_initialize (char msg[1024], int flag)
 Overview.
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_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)
 Note: Above version numbers are also recorded in configure.ac because libtool wants them as parameters at build time.
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 media status.
int isoburn_disc_erasable (struct burn_drive *d)
 Tells whether the media can be treated by isoburn_disc_erase().
void isoburn_disc_erase (struct burn_drive *drive, int fast)
 Mark the media 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.
struct isoburn_toc_discisoburn_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.
struct 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.
struct isoburn_toc_track ** isoburn_toc_session_get_tracks (struct isoburn_toc_session *s, int *num)
 Get the array of track handles from a particular session.
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.
void isoburn_toc_disc_free (struct isoburn_toc_disc *disc)
 Release the memory associated with a master handle of media.
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_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_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 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 media.
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.
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 media 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_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 media.
int isoburn_disc_get_msc1 (struct burn_drive *d, int *start_lba)
 Obtain the start block number of the most recent session on media.
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 media 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 *d, 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().
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 *drive)
 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 *drive)
 Inquire wether the media needs emulation or would be suitable for generic multi-session via libburn.


Define Documentation

#define isoburn_header_version_major   0

These three release version numbers tell the revision of this header file and of the API it describes.

They are memorized by applications at build time.

Since:
0.1.0

Definition at line 261 of file libisoburn.h.

Referenced by isoburn_version().

#define isoburn_header_version_micro   4

Definition at line 263 of file libisoburn.h.

Referenced by isoburn_version().

#define isoburn_header_version_minor   3

Definition at line 262 of file libisoburn.h.

Referenced by isoburn_version().

#define isoburn_igopt_aaip   32

Definition at line 885 of file libisoburn.h.

#define isoburn_igopt_aaip_susp_1_10   2048

Definition at line 960 of file libisoburn.h.

Referenced by isoburn_igopt_set_relaxed().

#define isoburn_igopt_allow_deep_paths   2

Definition at line 950 of file libisoburn.h.

#define isoburn_igopt_allow_full_ascii   64

Definition at line 955 of file libisoburn.h.

#define isoburn_igopt_allow_longer_paths   4

Definition at line 951 of file libisoburn.h.

#define isoburn_igopt_allow_lowercase   32

Definition at line 954 of file libisoburn.h.

#define isoburn_igopt_always_gmt   256

Definition at line 957 of file libisoburn.h.

Referenced by isoburn_igopt_set_relaxed().

#define isoburn_igopt_dir_rec_mtime   1024

Definition at line 959 of file libisoburn.h.

Referenced by isoburn_igopt_set_relaxed().

#define isoburn_igopt_iso1999   4

Definition at line 883 of file libisoburn.h.

#define isoburn_igopt_joliet   2

Definition at line 882 of file libisoburn.h.

#define isoburn_igopt_joliet_longer_paths   128

Definition at line 956 of file libisoburn.h.

#define isoburn_igopt_max_37_char_filenames   8

Definition at line 952 of file libisoburn.h.

#define isoburn_igopt_no_force_dots   16

Definition at line 953 of file libisoburn.h.

#define isoburn_igopt_omit_version_numbers   1

Relaxed constraints.

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

Since:
0.1.0
Parameters:
o The option set to work on
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. bit8= always_gmt Write timestamps as GMT although the specs prescribe local time with eventual non-zero timezone offset. Negative timezones (west of GMT) can trigger bugs in some operating systems which typically appear in mounted ISO images as if the timezone shift from GMT was applied twice (e.g. in New York 22:36 becomes 17:36). bit9= rrip_version_1_10 Write Rock Ridge info as of specification RRIP-1.10 rather than RRIP-1.12: signature "RRIP_1991A" rather than "IEEE_1282", field PX without file serial number. bit10= dir_rec_mtime Store as ECMA-119 Directory Record timestamp the mtime of the source rather than the image creation time. bit11= aaip_susp_1_10 Write AAIP fields without announcing AAIP by an ER field and without distinguishing RRIP fields from the AAIP field by prefixed ES fields. This saves 5 to 10 bytes per file and might avoid problems with readers which only accept RRIP. SUSP-1.10 allows it, SUSP-1.12 frowns on it.
Returns:
1 success, <=0 failure

Definition at line 949 of file libisoburn.h.

#define isoburn_igopt_rockridge   1

Which extensions to support.

Since:
0.1.0
Parameters:
o The option set to work on
ext Bitfield: bit0= rockridge Rock Ridge extensions add POSIX file attributes like owner, group, access permissions, long filenames. Very advisable if the designed audience has Unix style systems. bit1= joliet Longer filenames for Windows systems. Weaker than RockRidge, but also readable with Linux. bit2= iso1999 This is rather exotic. Better do not surprise the readers. bit5= aaip The libisofs specific SUSP based extension of ECMA-119 which can encode ACL and XFS-style Extended Attributes.
Returns:
1 success, <=0 failure

Definition at line 881 of file libisoburn.h.

#define isoburn_igopt_rrip_version_1_10   512

Definition at line 958 of file libisoburn.h.

Referenced by isoburn_igopt_set_relaxed().

#define isoburn_igopt_sort_files_by_weight   1

Whether and how files should be sorted.

Since:
0.1.0
Parameters:
o The option set to work on
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().
Returns:
1 success, <=0 failure

Definition at line 974 of file libisoburn.h.

#define isoburn_libburn_req_major   0

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

Since:
0.1.0

Definition at line 225 of file libisoburn.h.

#define isoburn_libburn_req_micro   0

Definition at line 227 of file libisoburn.h.

#define isoburn_libburn_req_minor   6

Definition at line 226 of file libisoburn.h.

#define isoburn_libisofs_req_major   0

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

Since:
0.1.0

Definition at line 217 of file libisoburn.h.

Referenced by isoburn_initialize().

#define isoburn_libisofs_req_micro   14

Definition at line 219 of file libisoburn.h.

Referenced by isoburn_initialize().

#define isoburn_libisofs_req_minor   6

Definition at line 218 of file libisoburn.h.

Referenced by isoburn_initialize().

#define isoburn_ropt_has_el_torito   8

Definition at line 801 of file libisoburn.h.

#define isoburn_ropt_has_iso1999   4

Definition at line 800 of file libisoburn.h.

#define isoburn_ropt_has_joliet   2

Definition at line 799 of file libisoburn.h.

#define isoburn_ropt_has_rockridge   1

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);

Since:
0.1.0
Parameters:
o The option set to work on
size Number of image data blocks, 2048 bytes each.
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. This is rather exotic. bit3= has_el_torito El-Torito boot record is present
Returns:
1 success, <=0 failure

Definition at line 798 of file libisoburn.h.

#define isoburn_ropt_noaaip   32

Definition at line 723 of file libisoburn.h.

#define isoburn_ropt_noacl   64

Definition at line 724 of file libisoburn.h.

#define isoburn_ropt_noea   128

Definition at line 725 of file libisoburn.h.

#define isoburn_ropt_noiso1999   4

Definition at line 720 of file libisoburn.h.

#define isoburn_ropt_nojoliet   2

Definition at line 719 of file libisoburn.h.

#define isoburn_ropt_norock   1

Which existing ISO 9660 extensions in the image to read or not to read.

Whether to read the content of an existing image at all. The bits can be combined by | resp. inquired by &.

Since:
0.1.0
Parameters:
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. bit5= noaaip
Since:
0.3.4 Do not load AAIP information from image. This information eventually contains ACL or XFS-style Extended Attributes. bit6= noacl

0.3.4 Do not obtain ACL from external filesystem objects (e.g. local filesystem files). bit7= noea

0.3.4 Do not obtain XFS-style Extended Attributes from external filesystem objects (e.g. local filesystem files).

Returns:
1 success, <=0 failure

Definition at line 718 of file libisoburn.h.

#define isoburn_ropt_preferjoliet   8

Definition at line 721 of file libisoburn.h.

#define isoburn_ropt_pretend_blank   16

Definition at line 722 of file libisoburn.h.


Function Documentation

int isoburn_activate_session ( struct burn_drive *  drive  ) 

Call this after isoburn_disc_write has finished and burn_drive_wrote_well() indicates success.

It will eventually complete the emulation of multi-session functionality, if needed at all. Let libisoburn decide. Not a wrapper, but peculiar to libisoburn.

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

Definition at line 281 of file isofs_wrap.c.

References isoburn::emulation_mode, isoburn::fabricated_disc_status, isoburn::fabricated_msc2, isoburn_find_emulator(), Libisoburn_target_head_sizE, isoburn::target_iso_head, and isoburn::zero_nwa.

Referenced by isoburn_invalidate_iso().

00282 {
00283  int ret;
00284  struct isoburn *o;
00285 
00286  ret = isoburn_find_emulator(&o, drive, 0);
00287  if (ret < 0)
00288    return -1;
00289 
00290  if (o->emulation_mode != 1)
00291    return 1; /* don't need to activate session */
00292  if (o->fabricated_msc2 >= 0)
00293    return 1; /* blind growing: do not alter anything outside the session */
00294  
00295  if (!(o->fabricated_disc_status == BURN_DISC_APPENDABLE ||
00296        (o->fabricated_disc_status == BURN_DISC_BLANK &&
00297         o->zero_nwa > 0)))
00298    return 1;
00299  
00300  ret = burn_random_access_write(drive, (off_t) 0, (char*)o->target_iso_head, 
00301                                 Libisoburn_target_head_sizE, 1);
00302 
00303  return ret;
00304 }

int isoburn_attach_image ( struct burn_drive *  d,
IsoImage *  image 
)

Set the IsoImage to be used with a drive.

This eventually releases the reference to the old IsoImage attached to the drive. Caution: Use with care. It hardly makes sense to replace an image that reflects a valid ISO image on 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.

Since:
0.1.0
Parameters:
d The drive which shall be write target of the volset.
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.
Returns:
<=0 error , 1 = success

Definition at line 258 of file isofs_wrap.c.

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

00259 {
00260  int ret;
00261  struct isoburn *o;
00262 
00263  ret = isoburn_find_emulator(&o, d, 0);
00264  if (ret < 0 || o == NULL)
00265    return 0;
00266  if (image == NULL) {
00267    isoburn_msgs_submit(o, 0x00060000,
00268                        "Program error: isoburn_attach_image: image==NULL",
00269                        0, "FATAL", 0);
00270    return -1;
00271  }
00272  if(o->image != NULL)
00273    iso_image_unref(o->image);
00274  o->image = image;
00275  return(1);
00276 }

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

Revoke isoburn_prepare_*() instead of running isoburn_disc_write().

libisofs reserves resources and maybe already starts generating the image stream when one of above three calls is performed. It is mandatory to either run isoburn_disc_write() or to revoke the preparations by the call described here.

Since:
0.1.0
Parameters:
input_drive The drive resp. in_drive which was used with the preparation call.
output_drive The out_drive used with isoburn_prepare_new_image(), NULL if none.
flag Bitfield, submit 0 for now. bit0= -reserved for internal use-
Returns:
<0 error, 0= no pending preparations detectable, 1 = canceled

Definition at line 557 of file isoburn.c.

References isoburn::iso_source, and isoburn_find_emulator().

Referenced by isoburn_sync_after_write().

00559 {
00560  int ret;
00561  struct isoburn *o= NULL;
00562 
00563  if(output_drive!=NULL) {
00564    ret= isoburn_find_emulator(&o, output_drive, 0);
00565    if(ret<0 || o==NULL)
00566      o= NULL;
00567    else if(o->iso_source==NULL)
00568      o= NULL;
00569  }
00570  if(o==NULL) {
00571    ret= isoburn_find_emulator(&o, d, 0);
00572    if(ret<0)
00573      return(-1);
00574    if(o==NULL)
00575      return(0);
00576    if(o->iso_source==NULL)
00577      return(0);
00578  }
00579  if(o->iso_source->read!=NULL)
00580    return(0);
00581  if(o->iso_source->version<1)
00582    return(0);
00583  o->iso_source->cancel(o->iso_source);
00584  burn_source_free(o->iso_source);
00585  o->iso_source= NULL;
00586  return(1);
00587 }

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 media.

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

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

Definition at line 561 of file burn_wrap.c.

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

00563 {
00564  int ret;
00565  struct isoburn *o;
00566  struct burn_write_opts *eff_opts= NULL, *local_opts= NULL;
00567  enum burn_disc_status s;
00568  off_t avail;
00569 
00570  eff_opts= opts;
00571  ret= isoburn_find_emulator(&o, d, 0);
00572  if(ret>0 && o!=NULL)
00573    if(o->emulation_mode!=0) {
00574      s= isoburn_disc_get_status(d);
00575      if(s==BURN_DISC_FULL) /* unknown data format in first 64 kB */
00576        return((off_t) 0);
00577      local_opts= burn_write_opts_new(d);
00578      eff_opts= local_opts;
00579      burn_write_opts_set_start_byte(eff_opts, ((off_t) o->nwa) * (off_t) 2048);
00580    }
00581  avail= burn_disc_available_space(d, eff_opts);
00582  if(local_opts!=NULL)
00583    burn_write_opts_free(local_opts);
00584  local_opts= NULL;
00585  return(avail);
00586 }

int isoburn_disc_erasable ( struct burn_drive *  d  ) 

Tells whether the media can be treated by isoburn_disc_erase().

Wrapper for: burn_disc_erasable()

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

Definition at line 516 of file burn_wrap.c.

References isoburn::emulation_mode, and isoburn_find_emulator().

00517 {
00518  int ret;
00519  struct isoburn *o;
00520 
00521  ret= isoburn_find_emulator(&o, d, 0);
00522  if(ret>0)
00523    if(o->emulation_mode==1)
00524      return(1);
00525  return burn_disc_erasable(d);
00526 }

void isoburn_disc_erase ( struct burn_drive *  drive,
int  fast 
)

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()

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

Definition at line 529 of file burn_wrap.c.

References isoburn::emulation_mode, isoburn_disc_get_status(), isoburn_find_emulator(), isoburn_invalidate_iso(), and Libisoburn_target_head_sizE.

00530 {
00531  int ret;
00532  struct isoburn *o;
00533  enum burn_disc_status s;
00534  char zero_buffer[Libisoburn_target_head_sizE];
00535 
00536  ret= isoburn_find_emulator(&o, drive, 0);
00537  if(ret>0) {
00538    if(o->emulation_mode==-1) {
00539      /* To cause a negative reply with burn_drive_wrote_well() */
00540      burn_drive_cancel(drive);
00541      return;
00542    }
00543    if(o->emulation_mode>0) {
00544      s= isoburn_disc_get_status(drive);
00545      if(s==BURN_DISC_FULL) { /* unknown data format in first 64 kB */
00546        memset(zero_buffer, 0, Libisoburn_target_head_sizE);
00547        ret= burn_random_access_write(drive, (off_t) 0, zero_buffer,
00548                                      (off_t) Libisoburn_target_head_sizE, 1);
00549      } else {
00550        ret= isoburn_invalidate_iso(o, 0);
00551      }
00552      if(ret<=0)
00553        burn_drive_cancel(drive); /* mark run as failure */
00554      return;
00555    }
00556  }
00557  burn_disc_erase(drive, fast);
00558 }

int isoburn_disc_get_msc1 ( struct burn_drive *  d,
int *  start_lba 
)

Obtain the start block number of the most recent session on media.

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()

Since:
0.1.0
Parameters:
d The drive to inquire
start_lba Contains on success the start address in 2048 byte blocks
Returns:
<=0 error , 1 = success

Definition at line 589 of file burn_wrap.c.

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

Referenced by isoburn_read_image().

00590 {
00591  int ret;
00592  struct isoburn *o;
00593 
00594 #ifdef Hardcoded_cd_rW
00595  /* <<< A70929 : hardcoded CD-RW with fabricated -msinfo */
00596  *start_lba= Hardcoded_cd_rw_c1;
00597  return(1);
00598 #endif
00599 
00600  if(isoburn_disc_get_status(d)!=BURN_DISC_APPENDABLE &&
00601     isoburn_disc_get_status(d)!=BURN_DISC_FULL) {
00602    isoburn_msgs_submit(NULL, 0x00060000,
00603                        "Media contains no recognizable data", 0, "SORRY", 0);
00604    return(0);
00605  }
00606  ret= isoburn_find_emulator(&o, d, 0);
00607  if(ret<0)
00608    return(0);
00609  if(o->fabricated_msc1>=0) {
00610    *start_lba= o->fabricated_msc1;
00611    return(1);
00612  }
00613  if(ret>0) if(o->emulation_mode>0) {
00614    *start_lba= 0;
00615    return(1);
00616  }
00617  return(burn_disc_get_msc1(d, start_lba));
00618 }

enum burn_disc_status isoburn_disc_get_status ( struct burn_drive *  drive  ) 

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()

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

Definition at line 493 of file burn_wrap.c.

References isoburn::emulation_mode, isoburn::fabricated_disc_status, isoburn_find_emulator(), isoburn::nwa, and isoburn::zero_nwa.

Referenced by isoburn_disc_available_space(), isoburn_disc_erase(), isoburn_disc_get_msc1(), isoburn_is_intermediate_dvd_rw(), isoburn_needs_emulation(), isoburn_prepare_disc_aux(), and isoburn_read_image().

00494 {
00495  int ret;
00496  struct isoburn *o;
00497 
00498  ret= isoburn_find_emulator(&o, drive, 0);
00499  if(ret<0)
00500    return(BURN_DISC_UNSUITABLE);
00501  if(o!=NULL)
00502    if(o->fabricated_disc_status!=BURN_DISC_UNREADY)
00503      return(o->fabricated_disc_status);
00504  if(ret==0)
00505    return(burn_disc_get_status(drive));
00506 
00507  /* emulated status */
00508  if(o->emulation_mode==-1)
00509    return(BURN_DISC_UNSUITABLE);
00510  if(o->nwa>o->zero_nwa)
00511    return(BURN_DISC_APPENDABLE);
00512  return(BURN_DISC_BLANK);
00513 }

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

Use this with trackno==0 to obtain the predicted start block number of the new session.

The interesting number is returned in parameter nwa. Wrapper for: burn_disc_track_lba_nwa()

Since:
0.1.0
Parameters:
d The drive to inquire
o If not NULL: write parameters to be set on drive before query
trackno Submit 0.
lba return value: start lba
nwa return value: Next Writeable Address
Returns:
1=nwa is valid , 0=nwa is not valid , -1=error

Definition at line 621 of file burn_wrap.c.

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

Referenced by isoburn_get_msc2(), and isoburn_prepare_disc_aux().

00624 {
00625  int ret;
00626  struct isoburn *o;
00627 
00628 #ifdef Hardcoded_cd_rW
00629  /* <<< A70929 : hardcoded CD-RW with fabricated -msinfo */
00630  *lba= Hardcoded_cd_rw_c1;
00631  *nwa= Hardcoded_cd_rw_nwA;
00632  return(1);
00633 #endif
00634 
00635  *nwa= *lba= 0;
00636  ret= isoburn_find_emulator(&o, d, 0);
00637  if(ret<0)
00638    return(0);
00639  if(ret>0) if(o->emulation_mode>0) {
00640    *lba= 0;
00641    *nwa= o->nwa;
00642    return(1);
00643  }
00644  if(burn_drive_get_drive_role(d) != 1)
00645    return(1);
00646  return(burn_disc_track_lba_nwa(d, opts, trackno, lba, nwa));
00647 }

void isoburn_disc_write ( struct burn_write_opts *  o,
struct burn_disc *  disc 
)

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()

Since:
0.1.0
Parameters:
o Options which control the burn process. See burnwrite_opts_*() in libburn.h.
disc Disc object created either by isoburn_prepare_disc() or by isoburn_prepare_new_image().

Definition at line 667 of file burn_wrap.c.

References isoburn::emulation_mode, isoburn_find_emulator(), isoburn_is_intermediate_dvd_rw(), isoburn_msgs_submit(), isoburn::nwa, isoburn::truncate, and isoburn::wrote_well.

00668 {
00669  int ret;
00670  off_t nwa= 0;
00671  struct isoburn *o;
00672  struct burn_drive *drive;
00673  char reasons[BURN_REASONS_LEN],msg[160+BURN_REASONS_LEN];
00674  char adr[BURN_DRIVE_ADR_LEN];
00675  enum burn_write_types write_type;
00676  struct stat stbuf;
00677 
00678  drive= burn_write_opts_get_drive(opts);
00679  ret= isoburn_find_emulator(&o, drive, 0);
00680  if(ret<0)
00681    return;
00682  if(o!=NULL) {
00683    o->wrote_well= -1;
00684    if(o->emulation_mode!=0) {
00685      burn_write_opts_set_multi(opts, 0);
00686      if(o->emulation_mode>0 && o->nwa >= 0) {
00687        nwa= o->nwa;
00688 
00689        /* This caters for unwritten formatted DVD-RW. They need to be written
00690           sequentially on the first use. Only written areas are random access.
00691           If the first session is not written to LBA 0, then re-opening of
00692           formatting and padding is needed. 
00693           This can be done. But when the track gets closed after padding,
00694           this lasts a long time. There is a high risk that an app will not
00695           poll the message queue while waiting for  isoburn_disc_write()  to
00696           return. The pacifier loop usually happens only afterwards.
00697           So automatic formatting might cause a nervous clueless user.
00698        */
00699        ret= isoburn_is_intermediate_dvd_rw(drive, 0);
00700        if(ret>0 && nwa>0 && nwa <= o->zero_nwa) {
00701          /* actually this should not happen since such media get recognized
00702             by isoburn_welcome_media and o->zero_nwa gets set to 0
00703          */
00704          sprintf(msg,
00705         "DVD-RW insufficiently formatted. (Intermediate State, size unknown)");
00706          isoburn_msgs_submit(o, 0x00060000, msg, 0, "FAILURE", 0);
00707          sprintf(msg,
00708                 "It might help to first deformat it and then format it again");
00709          isoburn_msgs_submit(o, 0x00060000, msg, 0, "HINT", 0);
00710          burn_drive_cancel(drive); /* mark run as failure */
00711          return;
00712        }
00713        /* end of DVD-RW oriented check */
00714 
00715        burn_write_opts_set_start_byte(opts, nwa * (off_t) 2048);
00716      }
00717    }
00718  }
00719 
00720  write_type= burn_write_opts_auto_write_type(opts, disc, reasons, 0);
00721  if (write_type == BURN_WRITE_NONE) {
00722     sprintf(msg, "Failed to find a suitable write mode:\n%s", reasons);
00723     isoburn_msgs_submit(o, 0x00060000, msg, 0, "FAILURE", 0);
00724     if(o!=NULL)
00725       o->wrote_well= 0;
00726     /* To cause a negative reply with burn_drive_wrote_well() */
00727     burn_drive_cancel(drive);
00728     return;
00729  }
00730 
00731  sprintf(reasons, "%d", (int) write_type);
00732  sprintf(msg, "Write_type = %s\n",
00733               (write_type == BURN_WRITE_SAO ? "SAO" :
00734               (write_type == BURN_WRITE_TAO ? "TAO" : reasons)));
00735  isoburn_msgs_submit(o, 0x00060000, msg, 0, "DEBUG", 0);
00736 
00737 #ifdef Hardcoded_cd_rW
00738  /* <<< A70929 : hardcoded CD-RW with fabricated -msinfo */
00739  fprintf(stderr, "Setting write address to LBA %d\n", Hardcoded_cd_rw_nwA);
00740  burn_write_opts_set_start_byte(opts,
00741                  ((off_t) Hardcoded_cd_rw_nwA) * (off_t) 2048);
00742 #endif
00743 
00744  if(o->truncate) {
00745    ret= burn_drive_get_drive_role(drive);
00746    if(ret==2) {
00747      ret= burn_drive_d_get_adr(drive, adr);
00748      if(ret>0) {
00749        ret= lstat(adr, &stbuf);
00750        if(ret!=-1)
00751          if(S_ISREG(stbuf.st_mode))
00752            truncate(adr, nwa * (off_t) 2048);
00753      }
00754    }
00755  }
00756 
00757  burn_disc_write(opts, disc);
00758 }

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

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()

Since:
0.1.2
Parameters:
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. But before this is done one has to call isoburn_drive_release(drive_infos[0].drive).
adr The persistent address of the desired drive.
flag bit0= attempt to load the disc tray. Else: failure if not loaded. bit1= regard overwriteable media as blank bit2= if the drive is a regular disk file: truncate it to the write start address bit3= if the drive reports a read-only profile try to read table of content by scanning for ISO image headers. (depending on media type and drive this might help or it might make the resulting toc even worse) bit4= do not emulate table of content on overwriteable media bit5= ignore ACL from external filesystems bit6= ignore POSIX Extended Attributes from external filesystems
Returns:
1 = success , 0 = drive not found , <0 = other error
Parameters:
flag bit0= load bit1= regard overwriteable media as blank bit2= if the drive is a regular disk file: truncate it to the write start address bit3= if the drive reports a -ROM profile then try to read table of content by scanning for ISO image headers. (depending on media type and drive state this might help or it might make the resulting toc even worse) bit4= do not emulate TOC on overwriteable media bit5= ignore ACL from external filesystems bit6= ignore POSIX Extended Attributes from external filesystems

Definition at line 391 of file burn_wrap.c.

References isoburn::drive, isoburn_destroy(), isoburn_find_emulator(), isoburn_welcome_media(), and isoburn::truncate.

Referenced by isoburn_drive_scan_and_grab().

00393 {
00394  int ret, drive_grabbed= 0;
00395  struct isoburn *o= NULL;
00396 
00397 #ifndef NIX
00398 
00399 /* <<< should be obsolete by new drive addressing of libburn-0.5.2 */
00400 /* >>> but helps with kernel 2.4 to use /dev/sr */
00401 
00402  int conv_ret;
00403  char libburn_drive_adr[BURN_DRIVE_ADR_LEN];
00404 
00405  conv_ret= burn_drive_convert_fs_adr(adr, libburn_drive_adr);
00406  if(conv_ret<=0)
00407    strcpy(libburn_drive_adr, adr);
00408  ret= burn_drive_scan_and_grab(drive_infos, libburn_drive_adr, flag&1);
00409 
00410 #else
00411 
00412  ret= burn_drive_scan_and_grab(drive_infos, adr, flag & 1);
00413 
00414 #endif /* ! NIX */
00415 
00416  if(ret<=0)
00417    goto ex;
00418  drive_grabbed= 1;
00419  ret= isoburn_welcome_media(&o, (*drive_infos)[0].drive,
00420                             (flag & (8 | 16 | 32 | 64)) | !!(flag&2));
00421  if(ret<=0)
00422    goto ex;
00423 
00424  if(flag&4) {
00425    ret= isoburn_find_emulator(&o, (*drive_infos)[0].drive, 0);
00426    if(ret>0 && o!=NULL)
00427      o->truncate= 1;
00428  }
00429 
00430  ret= 1;
00431 ex:
00432  if(ret<=0) {
00433    if(drive_grabbed)
00434      burn_drive_release((*drive_infos)[0].drive, 0);
00435    isoburn_destroy(&o, 0);
00436  }
00437  return(ret);
00438 }

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().

Wrapper for: burn_drive_grab()

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

Definition at line 451 of file burn_wrap.c.

References isoburn_destroy(), and isoburn_welcome_media().

00452 {
00453  int ret;
00454  struct isoburn *o= NULL;
00455 
00456  ret= burn_drive_grab(drive, load);
00457  if(ret<=0)
00458    goto ex;
00459  ret= isoburn_welcome_media(&o, drive, 0);
00460  if(ret<=0)
00461    goto ex;
00462  
00463  ret= 1;
00464 ex:
00465  if(ret<=0)
00466    isoburn_destroy(&o,0);
00467  return(ret);
00468 }

void isoburn_drive_release ( struct burn_drive *  drive,
int  eject 
)

Release an aquired drive.

Wrapper for: burn_drive_release()

Since:
0.1.0
Parameters:
drive The drive to be released
eject 1= eject media from drive , 0= do not eject

Definition at line 761 of file burn_wrap.c.

References isoburn_destroy(), and isoburn_find_emulator().

00762 {
00763  int ret;
00764  struct isoburn *o;
00765 
00766  ret= isoburn_find_emulator(&o, drive, 0);
00767  if(ret<0)
00768    return;
00769  if(o!=NULL) {
00770    isoburn_destroy(&o, 0);
00771  }
00772  burn_drive_release(drive, eject);
00773 }

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.

libburn persistent address. Wrapper for: burn_drive_scan_and_grab()

Since:
0.1.0
Parameters:
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. But before this is done one has to call isoburn_drive_release(drive_infos[0].drive).
adr The persistent address of the desired drive.
load 1 attempt to load the disc tray. 0 no attempt,rather failure.
Returns:
1 = success , 0 = drive not found , <0 = other error

Definition at line 441 of file burn_wrap.c.

References isoburn_drive_aquire().

00443 {
00444  int ret;
00445 
00446  ret= isoburn_drive_aquire(drive_infos, adr, !!load);
00447  return(ret);
00448 }

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

Attach to a drive an application provided method for immediate delivery of messages.

If no method is set or if the method is set to NULL then libisoburn delivers messages of the drive through the global msgs_submit() method set by isoburn_set_msgs_submiti() or by the message queue of libburn.

Since:
0.2.0
Parameters:
d The drive to which this function, handle and flag shall apply
msgs_submit The function call which implements the method
submit_handle Handle to be used as first argument of msgs_submit
submit_flag Flag to be used as last argument of msgs_submit
flag Unused yet, submit 0

Definition at line 1500 of file burn_wrap.c.

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

01505 {
01506  struct isoburn *o;
01507  int ret;
01508 
01509  ret= isoburn_find_emulator(&o, d, 0);
01510  if(ret<0 || o==NULL)
01511    return(-1);
01512  o->msgs_submit= msgs_submit;
01513  o->msgs_submit_handle= submit_handle;
01514  o->msgs_submit_flag= submit_flag;
01515  return(1);
01516 }

int isoburn_drive_wrote_well ( struct burn_drive *  d  ) 

Inquire whether the most recent write run was successful.

Wrapper for: burn_drive_wrote_well()

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

Definition at line 852 of file burn_wrap.c.

References isoburn_find_emulator(), and isoburn::wrote_well.

00853 {
00854  int ret;
00855  struct isoburn *o;
00856  
00857  ret= isoburn_find_emulator(&o, d, 0);
00858  if(ret<0)
00859    return(-1);
00860  if(o!=NULL)
00861    if(o->wrote_well>=0)
00862      return(o->wrote_well);
00863  ret= burn_drive_wrote_well(d);
00864  return ret;
00865 }

void isoburn_finish ( void   ) 

Shutdown all three libraries.

Wrapper for : iso_finish() and burn_finish().

Since:
0.1.0

Definition at line 776 of file burn_wrap.c.

References isoburn_destroy_all().

00777 {
00778  isoburn_destroy_all(&isoburn_list_start, 0);
00779  burn_finish();
00780  iso_finish();
00781 }

IsoImage* isoburn_get_attached_image ( struct burn_drive *  d  ) 

Get the image attached to a drive, if any.

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

Definition at line 89 of file isofs_wrap.c.

References isoburn::image, and isoburn_find_emulator().

00090 {
00091  int ret;
00092  struct isoburn *o= NULL;
00093  ret = isoburn_find_emulator(&o, d, 0);
00094  if (ret < 0)
00095    return NULL;
00096   
00097  if (o == NULL) {
00098    return NULL;
00099  }
00100  iso_image_ref(o->image);
00101  return o->image;
00102 }

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

Inquire state and fill parameters of the fifo which is attached to the emerging track.

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

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

Definition at line 868 of file burn_wrap.c.

References isoburn::iso_source, and isoburn_find_emulator().

00870 {
00871  int ret;
00872  struct isoburn *o;
00873  size_t hsize= 0, hfree_bytes= 0;
00874 
00875  ret= isoburn_find_emulator(&o, d, 0);
00876  if(ret<0)
00877    return(-1);
00878 
00879  if(o==NULL)
00880    return(-1);
00881  if(o->iso_source==NULL)
00882    return(-1);
00883  ret= iso_ring_buffer_get_status(o->iso_source, &hsize, &hfree_bytes);
00884  if(hsize > 1024*1024*1024)
00885    *size= 1024*1024*1024;
00886  else
00887    *size= hsize;
00888  if(hfree_bytes > 1024*1024*1024)
00889    *free_bytes= 1024*1024*1024;
00890  else
00891    *free_bytes= hfree_bytes;
00892  *status_text= "";
00893  if(ret==0)
00894    *status_text= "standby";
00895  else if(ret==1)
00896    *status_text= "active";
00897  else if(ret==2)
00898    *status_text= "ending";
00899  else if(ret==3)
00900    *status_text= "failing";
00901  else if(ret==4)
00902    *status_text= "unused";
00903  else if(ret==5)
00904    *status_text= "abandoned";
00905  else if(ret==6)
00906    *status_text= "ended";
00907  else if(ret==7)
00908    *status_text= "aborted";
00909  return(ret);
00910 }

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.

This value is supposed to be <= 2048 * nwa as of isoburn_disc_track_lba_nwa().

Since:
0.1.0
Parameters:
drive The drive holding the media.
start_byte The reply value counted in bytes, not in sectors.
flag Unused yet. Submit 0.
Returns:
1=stat_byte is valid, 0=not an emulated appendable, -1=error

Definition at line 834 of file burn_wrap.c.

References isoburn_find_emulator(), and isoburn::min_start_byte.

00836 {
00837  int ret;
00838  struct isoburn *o;
00839 
00840  ret= isoburn_find_emulator(&o, d, 0);
00841  if(ret<0)
00842    return(-1);
00843  if(ret==0) 
00844    return(0);
00845  *start_byte= o->min_start_byte;
00846  if(o->min_start_byte<=0)
00847    return(0);
00848  return(1);
00849 }

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

Try to convert the given entity address into various entity addresses which would describe it.

Note: Sessions and tracks are counted beginning with 1, not with 0.

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

Definition at line 1652 of file burn_wrap.c.

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

01656 {
01657  int msc1_mem, ret, total_tracks, num_sessions, num_tracks, i, j, track_lba;
01658  int size, is_iso= 0;
01659  struct isoburn *o;
01660  struct isoburn_toc_disc *disc= NULL;
01661  struct isoburn_toc_session **sessions= NULL;
01662  struct isoburn_toc_track **tracks= NULL;
01663 
01664  *lba= *track= *session= -1;
01665  volid[0]= 0;
01666  ret= isoburn_find_emulator(&o, d, 0);
01667  if(ret < 0 || o == NULL)
01668    return(-1);
01669  msc1_mem= o->fabricated_msc1;
01670  ret= isoburn_set_msc1(d, adr_mode, adr_value, 2 | (flag & 4));
01671  if(ret <= 0)
01672    return(ret);
01673  *lba= o->fabricated_msc1;
01674 
01675  disc= isoburn_toc_drive_get_disc(d);
01676  if(disc==NULL) 
01677    {ret= -1; goto ex;} /* cannot happen because checked by isoburn_set_msc1 */
01678  sessions= isoburn_toc_disc_get_sessions(disc, &num_sessions);
01679  if(sessions==NULL || num_sessions<=0)
01680    {ret= -1; goto ex;} /* cannot happen because checked by isoburn_set_msc1 */
01681  total_tracks= 0;
01682  for(i=0; i<num_sessions && *session < 0; i++) {
01683    tracks= isoburn_toc_session_get_tracks(sessions[i], &num_tracks);
01684    if(tracks==NULL)
01685  continue;
01686    for(j= 0; j<num_tracks && *track < 0; j++) {
01687      total_tracks++;
01688      isoburn_get_track_lba(tracks[j], &track_lba, 0);
01689      if(track_lba == *lba) {
01690        *track= total_tracks;
01691        *session= i + 1;
01692      }
01693    }
01694  }
01695  ret= isoburn_read_iso_head(d, *lba, &size, volid, 1);
01696  if(ret <= 0)
01697    volid[0]= 0;
01698  else
01699    is_iso= 1;
01700 
01701 ex:;
01702  o->fabricated_msc1= msc1_mem;
01703  return(2 - is_iso); 
01704 }

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

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

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

Definition at line 820 of file isoburn.c.

00821 {
00822  if(*o==NULL)
00823    return(0);
00824  free(*o);
00825  *o= NULL;
00826  return(1);
00827 }

int isoburn_igopt_get_data_start ( struct isoburn_imgen_opts o,
int *  lba 
)

Obtain after image preparation the lowest block address of file content data.

Failure can occur if libisofs is too old to provide this information, if the result exceeds 31 bit, or if the call is made before image preparation. This value cannot be set by the application but only be inquired.

Since:
0.3.4
Parameters:
o The option set to work on
lba The block number of the session start on media. <0 means that no address has been determined yet.
Returns:
1 success, <=0 failure

Definition at line 990 of file isoburn.c.

References isoburn_imgen_opts::data_start_lba.

00991 {
00992  *lba= o->data_start_lba;
00993  return(1);
00994 }

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 media.

This value cannot be set by the application but only be inquired.

Since:
0.1.4
Parameters:
o The option set to work on
lba The block number of the session start on media. <0 means that no address has been determined yet.
Returns:
1 success, <=0 failure

Definition at line 983 of file isoburn.c.

References isoburn_imgen_opts::effective_lba.

00984 {
00985  *lba= o->effective_lba;
00986  return(1);
00987 }

int isoburn_igopt_get_extensions ( struct isoburn_imgen_opts o,
int *  ext 
)

Definition at line 854 of file isoburn.c.

References isoburn_imgen_opts::aaip, isoburn_imgen_opts::iso1999, isoburn_imgen_opts::joliet, and isoburn_imgen_opts::rockridge.

00855 {
00856  *ext= (!!o->rockridge) | ((!!o->joliet)<<1) | ((!!o->iso1999)<<2) |
00857        ((!!o->aaip) << 5);
00858  return(1);
00859 }

int isoburn_igopt_get_fifo_size ( struct isoburn_imgen_opts o,
int *  fifo_size 
)

Definition at line 976 of file isoburn.c.

References isoburn_imgen_opts::fifo_size.

00977 {
00978  *fifo_size= o->fifo_size;
00979  return(1);
00980 }

int isoburn_igopt_get_level ( struct isoburn_imgen_opts o,
int *  level 
)

Definition at line 837 of file isoburn.c.

References isoburn_imgen_opts::level.

00838 {
00839  *level= o->level;
00840  return(1);
00841 }

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

Definition at line 961 of file isoburn.c.

References isoburn_imgen_opts::output_charset.

00963 {
00964  *output_charset= o->output_charset;
00965  return(1);
00966 }

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 
)

Definition at line 918 of file isoburn.c.

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

00921 {
00922  *replace_dir_mode= o->replace_dir_mode%3;
00923  *replace_file_mode= o->replace_file_mode%3;
00924  *dir_mode= o->dir_mode;
00925  *file_mode= o->file_mode;
00926  return(1);
00927 }

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

Definition at line 941 of file isoburn.c.

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

00944 {
00945  *replace_uid= o->replace_uid%3;
00946  *replace_gid= o->replace_gid%3;
00947  *uid= o->uid;
00948  *gid= o->gid;
00949  return(1);
00950 }

int isoburn_igopt_get_relaxed ( struct isoburn_imgen_opts o,
int *  relax 
)

int isoburn_igopt_get_sort_files ( struct isoburn_imgen_opts o,
int *  value 
)

Definition at line 899 of file isoburn.c.

References isoburn_imgen_opts::sort_files.

00900 {
00901  *value= !!o->sort_files;
00902  return(1);
00903 }

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

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

Since:
0.1.0
Parameters:
o the newly created option set object
flag Bitfield for control purposes. Submit 0 for now.
Returns:
1=ok , <0 = failure

Definition at line 776 of file isoburn.c.

References isoburn_imgen_opts::aaip_susp_1_10, isoburn_imgen_opts::allow_deep_paths, isoburn_imgen_opts::allow_full_ascii, isoburn_imgen_opts::allow_longer_paths, isoburn_imgen_opts::allow_lowercase, isoburn_imgen_opts::always_gmt, isoburn_imgen_opts::data_start_lba, isoburn_imgen_opts::dir_mode, isoburn_imgen_opts::dir_rec_mtime, isoburn_imgen_opts::effective_lba, isoburn_imgen_opts::fifo_size, isoburn_imgen_opts::file_mode, isoburn_imgen_opts::gid, isoburn_imgen_opts::iso1999, isoburn_msgs_submit(), isoburn_imgen_opts::joliet, isoburn_imgen_opts::joliet_longer_paths, isoburn_imgen_opts::level, isoburn_imgen_opts::max_37_char_filenames, isoburn_imgen_opts::no_force_dots, isoburn_imgen_opts::omit_version_numbers, isoburn_imgen_opts::output_charset, isoburn_imgen_opts::replace_dir_mode, isoburn_imgen_opts::replace_file_mode, isoburn_imgen_opts::replace_gid, isoburn_imgen_opts::replace_uid, isoburn_imgen_opts::rockridge, isoburn_imgen_opts::rrip_version_1_10, isoburn_imgen_opts::sort_files, and isoburn_imgen_opts::uid.

00777 {
00778  struct isoburn_imgen_opts *o;
00779 
00780  o= (*new_o)= calloc(1, sizeof(struct isoburn_imgen_opts));
00781  if(o==NULL) {
00782    isoburn_msgs_submit(NULL, 0x00060000,
00783                        "Cannot allocate memory for image generation options",
00784                        0, "FATAL", 0);
00785    return(-1);
00786  }
00787  o->level= 2;
00788  o->rockridge= 1;
00789  o->joliet= 0;
00790  o->iso1999= 0;
00791  o->omit_version_numbers= 0;
00792  o->allow_deep_paths= 1;
00793  o->allow_longer_paths= 0;
00794  o->max_37_char_filenames= 0;
00795  o->no_force_dots= 0;
00796  o->allow_lowercase= 0;
00797  o->allow_full_ascii= 0;
00798  o->joliet_longer_paths= 0;
00799  o->always_gmt= 0;
00800  o->rrip_version_1_10= 0;
00801  o->dir_rec_mtime= 0;
00802  o->aaip_susp_1_10= 0;
00803  o->sort_files= 0;
00804  o->replace_dir_mode= 0;
00805  o->replace_file_mode= 0;
00806  o->replace_uid= 0;
00807  o->replace_gid= 0;
00808  o->dir_mode= 0555;
00809  o->file_mode= 0444;
00810  o->uid= 0;
00811  o->gid= 0;
00812  o->output_charset= NULL;
00813  o->fifo_size= 4*1024*1024;
00814  o->effective_lba= -1;
00815  o->data_start_lba= -1;
00816  return(1);
00817 }

int isoburn_igopt_set_extensions ( struct isoburn_imgen_opts o,
int  ext 
)

Definition at line 844 of file isoburn.c.

References isoburn_imgen_opts::aaip, isoburn_imgen_opts::iso1999, isoburn_imgen_opts::joliet, and isoburn_imgen_opts::rockridge.

00845 {
00846  o->rockridge= !!(ext&1);
00847  o->joliet= !!(ext&2);
00848  o->iso1999= !!(ext&4);
00849  o->aaip= !!(ext & 32);
00850  return(1);
00851 }

int isoburn_igopt_set_fifo_size ( struct isoburn_imgen_opts o,
int  fifo_size 
)

The number of bytes to be used for the fifo which decouples libisofs and libburn for better throughput and for reducing the risk of interrupting signals hitting the libburn thread which operates the MMC drive.

The size will be rounded up to the next full 2048. Minimum is 64kiB, maximum is 1 GiB (but that is too much anyway).

Since:
0.1.0
Parameters:
o The option set to work on
fifo_size Number of bytes to use
Returns:
1 success, <=0 failure

Definition at line 969 of file isoburn.c.

References isoburn_imgen_opts::fifo_size.

00970 {
00971  o->fifo_size= fifo_size;
00972  return(1);
00973 }

int isoburn_igopt_set_level ( struct isoburn_imgen_opts o,
int  level 
)

ISO level to write at.

Since:
0.1.0
Parameters:
o The option set to work on
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
Returns:
1 success, <=0 failure

Definition at line 830 of file isoburn.c.

References isoburn_imgen_opts::level.

00831 {
00832  o->level= level;
00833  return(1);
00834 }

int isoburn_igopt_set_out_charset ( struct isoburn_imgen_opts o,
char *  output_charset 
)

Set the charcter set to use for representing filenames in the image.

Since:
0.1.0
Parameters:
o The option set to work on
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".
Returns:
1 success, <=0 failure

Definition at line 953 of file isoburn.c.

References isoburn_imgen_opts::output_charset.

00955 {
00956  o->output_charset= output_charset;
00957  return(1);
00958 }

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

Set the override values for files and directory permissions.

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

Since:
0.1.0
Parameters:
o The option set to work on
replace_dir_mode whether and how to override directories
replace_file_mode whether and how to override files of other type
dir_mode Mode to use on dirs with replace_dir_mode == 2.
file_mode; Mode to use on files with replace_file_mode == 2.
Returns:
1 success, <=0 failure

Definition at line 906 of file isoburn.c.

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

00909 {
00910  o->replace_dir_mode= replace_dir_mode%3;
00911  o->replace_file_mode= replace_file_mode%3;
00912  o->dir_mode= dir_mode;
00913  o->file_mode= file_mode;
00914  return(1);
00915 }

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

Set the override values values for group id and user id.

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

Since:
0.1.0
Parameters:
o The option set to work on
replace_uid whether and how to override user ids
replace_gid whether and how to override group ids
uid User id to use with replace_uid == 2.
gid Group id to use on files with replace_gid == 2.
Returns:
1 success, <=0 failure

Definition at line 930 of file isoburn.c.

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

00933 {
00934  o->replace_uid= replace_uid%3;
00935  o->replace_gid= replace_gid%3;
00936  o->uid= uid;
00937  o->gid= gid;
00938  return(1);
00939 }

int isoburn_igopt_set_relaxed ( struct isoburn_imgen_opts o,
int  relax 
)

int isoburn_igopt_set_sort_files ( struct isoburn_imgen_opts o,
int  value 
)

Definition at line 892 of file isoburn.c.

References isoburn_imgen_opts::sort_files.

00893 {
00894  o->sort_files= !!(value&1);
00895  return(1);
00896 }

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

Overview.

libisoburn is a frontend for libraries libburn and libisofs which enables creation and expansion of ISO-9660 filesystems on all CD/DVD 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.

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 libburn unless it has a isoburn_*() wrapper listed in the following function documentation.

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

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

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

Usage model

There may be an input drive and an output drive. Either of them may be missing with the consequence that no reading 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 and manipulates by the family of isoburn_ropt_set_*() functions.

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

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

Setup for Growing, Modifying or Blind Growing

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

Growing: If input and output drive are the same, then isoburn_prepare_disc() is to be used. It will lead to an add-on session on appendable or 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, and if it bears blank media or overwriteable without a valid ISO image, then one may produce a consolidated image with old and new data. This will copy file data from an eventual input drive with valid image, add any newly introduced data from the local filesystem, and produce a first session on output media. To prepare for such an image generation run, use isoburn_prepare_new_image().

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

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

Writing the image

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

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

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

Application Constraints

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

Applications must use 64 bit off_t, e.g. on 32-bit Linux by defining define _LARGEFILE_SOURCE define _FILE_OFFSET_BITS 64 or take special precautions to interface with the library by 64 bit integers where above .h files prescribe off_t. Not to use 64 bit file i/o will keep the application from producing and processing ISO images of more than 2 GB size. Initialize libisoburn, libisofs and libburn. Wrapper for : iso_init() and burn_initialize()

Since:
0.1.0
Parameters:
msg A character array for eventual messages (e.g. with errors)
flag Bitfield for control purposes (unused yet, submit 0)
Returns:
1 indicates success, 0 is failure

Definition at line 65 of file burn_wrap.c.

References isoburn_destroy_all(), isoburn_libisofs_req_major, isoburn_libisofs_req_micro, isoburn_libisofs_req_minor, and isoburn_version().

00066 {
00067  int major, minor, micro, bad_match= 0;
00068 
00069 
00070 /* First two ugly compile time checks for header version compatibility.
00071    If everthing matches, then they produce no C code. In case of mismatch,
00072    intentionally faulty C code will be inserted.
00073 */
00074 
00075 #ifdef iso_lib_header_version_major
00076 /* The minimum requirement of libisoburn towards the libisofs header
00077    at compile time is defined in libisoburn/libisoburn.h :
00078      isoburn_libisofs_req_major
00079      isoburn_libisofs_req_minor
00080      isoburn_libisofs_req_micro
00081    It gets compared against the version macros in libisofs/libisofs.h :
00082      iso_lib_header_version_major
00083      iso_lib_header_version_minor
00084      iso_lib_header_version_micro
00085    If the header is too old then the following code shall cause failure of
00086    libisoburn compilation rather than to allow production of a program with
00087    unpredictable bugs or memory corruption.
00088    The compiler messages supposed to appear in this case are:
00089       error: 'LIBISOFS_MISCONFIGURATION' undeclared (first use in this function)
00090       error: 'INTENTIONAL_ABORT_OF_COMPILATION__HEADERFILE_libisofs_dot_h_TOO_OLD__SEE_libisoburn_dot_h_AND_burn_wrap_dot_h' undeclared (first use in this function)
00091       error: 'LIBISOFS_MISCONFIGURATION_' undeclared (first use in this function)
00092 */
00093 /* The indendation is an advise of man gcc to help old compilers ignoring */
00094  #if isoburn_libisofs_req_major > iso_lib_header_version_major
00095  #define Isoburn_libisofs_dot_h_too_olD 1
00096  #endif
00097  #if isoburn_libisofs_req_major == iso_lib_header_version_major && isoburn_libisofs_req_minor > iso_lib_header_version_minor
00098  #define Isoburn_libisofs_dot_h_too_olD 1
00099  #endif
00100  #if isoburn_libisofs_req_minor == iso_lib_header_version_minor && isoburn_libisofs_req_micro > iso_lib_header_version_micro
00101  #define Isoburn_libisofs_dot_h_too_olD 1
00102  #endif
00103 
00104 #ifdef Isoburn_libisofs_dot_h_too_olD
00105 LIBISOFS_MISCONFIGURATION = 0;
00106 INTENTIONAL_ABORT_OF_COMPILATION__HEADERFILE_libisofs_dot_h_TOO_OLD__SEE_libisoburn_dot_h_AND_burn_wrap_dot_h = 0;
00107 LIBISOFS_MISCONFIGURATION_ = 0;
00108 #endif
00109 
00110 #endif /* iso_lib_header_version_major */
00111 
00112 /* The minimum requirement of libisoburn towards the libburn header
00113    at compile time is defined in libisoburn/libisoburn.h :
00114      isoburn_libburn_req_major
00115      isoburn_libburn_req_minor
00116      isoburn_libburn_req_micro
00117    It gets compared against the version macros in libburn/libburn.h :
00118      burn_header_version_major
00119      burn_header_version_minor
00120      burn_header_version_micro
00121    If the header is too old then the following code shall cause failure of
00122    cdrskin compilation rather than to allow production of a program with
00123    unpredictable bugs or memory corruption.
00124    The compiler messages supposed to appear in this case are:
00125       error: 'LIBBURN_MISCONFIGURATION' undeclared (first use in this function)
00126       error: 'INTENTIONAL_ABORT_OF_COMPILATION__HEADERFILE_libburn_dot_h_TOO_OLD__SEE_libisoburn_dot_h_and_burn_wrap_dot_h' undeclared (first use in this function)
00127       error: 'LIBBURN_MISCONFIGURATION_' undeclared (first use in this function)
00128 */
00129 
00130 /* The indendation is an advise of man gcc to help old compilers ignoring */
00131  #if isoburn_libburn_req_major > burn_header_version_major
00132  #define Isoburn_libburn_dot_h_too_olD 1
00133  #endif
00134  #if isoburn_libburn_req_major == burn_header_version_major && isoburn_libburn_req_minor > burn_header_version_minor
00135  #define Isoburn_libburn_dot_h_too_olD 1
00136  #endif
00137  #if isoburn_libburn_req_minor == burn_header_version_minor && isoburn_libburn_req_micro > burn_header_version_micro
00138  #define Isoburn_libburn_dot_h_too_olD 1
00139  #endif
00140 
00141 #ifdef Isoburn_libburn_dot_h_too_olD
00142 LIBBURN_MISCONFIGURATION = 0;
00143 INTENTIONAL_ABORT_OF_COMPILATION__HEADERFILE_libburn_dot_h_TOO_OLD__SEE_libisoburn_dot_h_and_burn_wrap_dot_h = 0;
00144 LIBBURN_MISCONFIGURATION_ = 0;
00145 #endif
00146 
00147 /* End of ugly compile time tests (scroll up for explanation) */
00148 
00149 
00150 
00151  msg[0]= 0;
00152  if(iso_init()<0) {
00153    sprintf(msg+strlen(msg), "Cannot initialize libisofs\n");
00154    return(0);
00155  }
00156  iso_lib_version(&major, &minor, &micro);
00157  sprintf(msg+strlen(msg), "libisofs-%d.%d.%d ", major, minor, micro);
00158 #ifdef iso_lib_header_version_major
00159  if(iso_lib_is_compatible(iso_lib_header_version_major,
00160                           iso_lib_header_version_minor,
00161                           iso_lib_header_version_micro)) {
00162    sprintf(msg+strlen(msg), "ok, ");
00163  } else {
00164    sprintf(msg+strlen(msg),"- TOO OLD -, need at least libisofs-%d.%d.%d ,\n",
00165            iso_lib_header_version_major, iso_lib_header_version_minor,
00166            iso_lib_header_version_micro);
00167    bad_match= 1;
00168  }
00169 #else
00170  if(iso_lib_is_compatible(isoburn_libisofs_req_major,
00171                           isoburn_libisofs_req_minor,
00172                           isoburn_libisofs_req_micro)) {
00173    sprintf(msg+strlen(msg), "suspicious, ");
00174  } else {
00175    sprintf(msg+strlen(msg),"- TOO OLD -, need at least libisofs-%d.%d.%d ,\n",
00176            isoburn_libisofs_req_major, isoburn_libisofs_req_minor,
00177            isoburn_libisofs_req_micro);
00178    bad_match= 1;
00179  }
00180 #endif /* ! iso_lib_header_version_major */
00181 
00182  if(!burn_initialize()) {
00183    sprintf(msg+strlen(msg), "Cannot initialize libburn\n");
00184    return(0);
00185  }
00186  burn_version(&major, &minor, &micro);
00187  sprintf(msg+strlen(msg), "libburn-%d.%d.%d ", major, minor, micro);
00188  if(major > burn_header_version_major
00189     || (major == burn_header_version_major
00190         && (minor > burn_header_version_minor
00191             || (minor == burn_header_version_minor
00192                 && micro >= burn_header_version_micro)))) {
00193    sprintf(msg+strlen(msg), "ok, ");
00194  } else {
00195    sprintf(msg+strlen(msg), "- TOO OLD -, need at least libburn-%d.%d.%d ,\n",
00196            burn_header_version_major, burn_header_version_minor,
00197            burn_header_version_micro);
00198    bad_match= 1;
00199  }
00200 
00201  isoburn_version(&major, &minor, &micro);
00202  sprintf(msg+strlen(msg), "for libisoburn-%d.%d.%d", major, minor, micro);
00203  if(bad_match)
00204    return(0);
00205 
00206  isoburn_destroy_all(&isoburn_list_start, 0); /* isoburn_list_start= NULL */
00207  return(1);
00208 }

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

Check whether all features of header file libisoburn.h from the given major.minor.micro revision triple can be delivered by the library version which is performing this call.

An application of libisoburn can easily memorize the version of the libisofs.h header in its own code. Immediately after isoburn_initialize() it should simply do this check: if (! isoburn_is_compatible(isoburn_header_version_major, isoburn_header_version_minor, isoburn_header_version_micro, 0)) ...refuse to start the program with this dynamic library version...

Since:
0.1.0
Parameters:
major obtained at build time
minor obtained at build time
micro obtained at build time
flag Bitfield for control purposes. Unused yet. Submit 0.
Returns:
1= library can work for caller 0= library is not usable in some aspects. Caller must restrict itself to an earlier API version or must not use this libray at all.

Definition at line 614 of file isoburn.c.

References isoburn_version().

00615 {
00616  int own_major, own_minor, own_micro;
00617 
00618  isoburn_version(&own_major, &own_minor, &own_micro);
00619  return(own_major > major ||
00620         (own_major == major && (own_minor > minor ||
00621          (own_minor == minor && own_micro >= micro))));
00622 }

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

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

This is checked already in isoburn_initialize() which will refuse on outdated version. So this call is for information purposes after successful startup only.

Since:
0.1.0
Parameters:
major isoburn_libburn_req_major as seen at build time
minor as seen at build time
micro as seen at build time
Returns:
1 success, <=0 might in future become an error indication

Definition at line 222 of file burn_wrap.c.

00223 {
00224  *major= burn_header_version_major;
00225  *minor= burn_header_version_minor;
00226  *micro= burn_header_version_micro;
00227  return(1);
00228 }

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.

This is checked already in isoburn_initialize() which will refuse on outdated version. So this call is for information purposes after successful startup only.

Since:
0.1.0
Parameters:
major isoburn_libisofs_req_major as seen at build time
minor as seen at build time
micro as seen at build time
Returns:
1 success, <=0 might in future become an error indication

Definition at line 212 of file burn_wrap.c.

00213 {
00214  *major= iso_lib_header_version_major;
00215  *minor= iso_lib_header_version_minor;
00216  *micro= iso_lib_header_version_micro;
00217  return(1);
00218 }

int isoburn_needs_emulation ( struct burn_drive *  drive  ) 

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

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

Definition at line 784 of file burn_wrap.c.

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

00785 {
00786  int ret;
00787  struct isoburn *o;
00788  enum burn_disc_status s;
00789 
00790  s= isoburn_disc_get_status(drive);
00791  if(s!=BURN_DISC_BLANK && s!=BURN_DISC_APPENDABLE)
00792    return(-1);
00793  ret= isoburn_find_emulator(&o, drive, 0);
00794  if(ret<0)
00795    return(-1);
00796  if(ret>0)
00797    if(o->emulation_mode>0)
00798      return(1);
00799  return(0);  
00800 }

int isoburn_prepare_blind_grow ( struct burn_drive *  d,
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.

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 media $nwa is a parameter of this call or can be used as detected from the in_drive media

This call waits for libisofs output to become available and then detaches the input drive object from the data source object by which libisofs was reading from the input drive. So, as far as libisofs is concerned, that drive may be released immediately after this call in order to allow the consumer to access the drive for writing. The consumer should wait for input to become available and only then open its burn drive. With cdrecord this is caused by option -waiti.

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

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

Definition at line 530 of file isoburn.c.

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

00533 {  
00534  int ret;
00535  struct isoburn *o= NULL;
00536 
00537  ret= isoburn_find_emulator(&o, out_drive, 0);
00538  if(ret<0 || o==NULL)
00539    return(-1);
00540  if(nwa >= 0)
00541    o->fabricated_msc2= nwa;
00542  if(o->nwa == o->zero_nwa)
00543    o->nwa= o->zero_nwa= 0;
00544  else
00545    o->zero_nwa= 0;
00546  ret= isoburn_prepare_disc_aux(d, out_drive, disc, opts, 2);
00547  if (ret<=0)
00548    return ret;
00549  return(1);
00550 }

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 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().

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

Definition at line 509 of file isoburn.c.

References isoburn_prepare_disc_aux().

00511 {
00512  return isoburn_prepare_disc_aux(d, d, disc, opts, 0);
00513 }

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.

The generated burn_disc is suitable to be written to a grabbed 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().

Since:
0.1.0
Parameters:
in_drive The input drive, grabbed with isoburn_drive_aquire() or one of its alternatives.
disc Returns the newly created burn_disc object.
opts Options for image generation and data transport to media.
out_drive The output drive, from isoburn_drive_aquire() et.al..
Returns:
<=0 error , 1 = success

Definition at line 516 of file isoburn.c.

References isoburn_prepare_disc_aux().

00519 {
00520  int ret;
00521 
00522  ret= isoburn_prepare_disc_aux(d, out_drive, disc, opts, 1);
00523  if (ret<=0)
00524    return ret;
00525  return 1; 
00526 }

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

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
Parameters:
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.
read_opts The read options which can be chosen by the application
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.
Returns:
<=0 error , 1 = success

Definition at line 113 of file isofs_wrap.c.

References isoburn_read_opts::dirmode, isoburn_read_opts::gid, isoburn_read_opts::hasElTorito, isoburn_read_opts::hasIso1999, isoburn_read_opts::hasJoliet, isoburn_read_opts::hasRR, isoburn::image, isoburn_read_opts::input_charset, isoburn::iso_data_source, isoburn_data_source_new(), isoburn_disc_get_msc1(), isoburn_disc_get_status(), isoburn_find_emulator(), isoburn_idle_free_function(), isoburn_msgs_submit(), isoburn_read_iso_head(), isoburn_report_iso_error(), isoburn_read_opts::mode, isoburn_read_opts::noaaip, isoburn_read_opts::noacl, isoburn_read_opts::noea, isoburn_read_opts::noiso1999, isoburn_read_opts::nojoliet, isoburn_read_opts::norock, isoburn_read_opts::preferjoliet, isoburn_read_opts::pretend_blank, isoburn::read_pacifier, isoburn::read_pacifier_handle, isoburn_read_opts::size, and isoburn_read_opts::uid.

00116 {
00117  int ret, int_num, dummy;
00118  IsoReadOpts *ropts= NULL;
00119  IsoReadImageFeatures *features= NULL;
00120  uint32_t ms_block;
00121  char msg[160];
00122  enum burn_disc_status status= BURN_DISC_BLANK;
00123  IsoDataSource *ds= NULL;
00124  struct isoburn *o= NULL;
00125 
00126  if(d != NULL) {
00127    ret = isoburn_find_emulator(&o, d, 0);
00128    if (ret < 0 || o == NULL)
00129      return 0;
00130    status = isoburn_disc_get_status(d);
00131  }
00132  if(read_opts==NULL) {
00133    isoburn_msgs_submit(o, 0x00060000,
00134                        "Program error: isoburn_read_image: read_opts==NULL",
00135                        0, "FATAL", 0);
00136    return(-1);
00137  }
00138  if (d == NULL || status == BURN_DISC_BLANK || read_opts->pretend_blank) {
00139 create_blank_image:;
00140    /*
00141     * Blank disc, we create a new image without files.
00142     */
00143    
00144    if (d == NULL) {
00145      /* New empty image without relation to a drive */
00146      if (image==NULL) {
00147        isoburn_msgs_submit(o, 0x00060000,
00148                            "Program error: isoburn_read_image: image==NULL",
00149                            0, "FATAL", 0);
00150        return -1;
00151      }
00152      /* create a new image */
00153      ret = iso_image_new("ISOIMAGE", image);
00154      if (ret < 0) {
00155        isoburn_report_iso_error(ret, "Cannot create image", 0, "FATAL", 0);
00156        return ret;
00157      }
00158    } else {
00159      /* Blank new image for the drive */
00160      iso_image_unref(o->image);
00161      ret = iso_image_new("ISOIMAGE", &o->image);
00162      if (ret < 0) {
00163        isoburn_report_iso_error(ret, "Cannot create image", 0, "FATAL", 0);
00164        return ret;
00165      }
00166      if (image) {
00167        *image = o->image;
00168        iso_image_ref(*image); /*protects object from premature free*/
00169      }
00170    }
00171    iso_image_set_ignore_aclea(*image,
00172                          (!!(read_opts->noacl)) | ((!!read_opts->noea) << 1) );
00173    return 1;
00174  }
00175  
00176  if (status != BURN_DISC_APPENDABLE && status != BURN_DISC_FULL) {
00177    isoburn_msgs_submit(o, 0x00060000,
00178                     "Program error: isoburn_read_image: incorrect disc status",
00179                     0, "FATAL", 0);
00180    return -4;   
00181  }
00182  
00183  memset((char *) &ropts, 0, sizeof(ropts));
00184 
00185  ret = isoburn_disc_get_msc1(d, &int_num);
00186  if (ret <= 0)
00187    return -2;
00188  ms_block= int_num;
00189  ret = isoburn_read_iso_head(d, int_num, &dummy, NULL, 0);
00190  if (ret <= 0) {
00191    sprintf(msg, "No ISO 9660 image at LBA %d. Creating blank image.", int_num);
00192    isoburn_msgs_submit(o, 0x00060000, msg, 0, "WARNING", 0);
00193    goto create_blank_image;
00194  }
00195 
00196  /* create the data source */
00197  ret = iso_read_opts_new(&ropts, 0);
00198  if (ret < 0) {
00199    isoburn_report_iso_error(ret, "Cannot create write opts", 0, "FATAL", 0);
00200    return ret;
00201  }
00202  /* Important: do not return until iso_read_opts_free() */
00203  iso_read_opts_set_start_block(ropts, ms_block);
00204  iso_read_opts_set_no_rockridge(ropts, read_opts->norock);
00205 
00206 #ifdef Libisoburn_with_aaiP
00207  iso_read_opts_set_no_aaip(ropts, read_opts->noaaip);
00208 #endif /* Libisoburn_with_aaiP */
00209 
00210  iso_read_opts_set_no_joliet(ropts, read_opts->nojoliet);
00211  iso_read_opts_set_no_iso1999(ropts, read_opts->noiso1999);
00212  iso_read_opts_set_preferjoliet(ropts, read_opts->preferjoliet);
00213  iso_read_opts_set_default_permissions(ropts,
00214                                        read_opts->mode, read_opts->dirmode);
00215  iso_read_opts_set_default_uid(ropts, read_opts->uid);
00216  iso_read_opts_set_default_gid(ropts, read_opts->gid);
00217  iso_read_opts_set_input_charset(ropts, read_opts->input_charset);
00218 
00219  /* <<< experimental API call of libisofs
00220  iso_read_opts_set_error_behavior(ropts, 1);
00221  */
00222 
00223  ds = isoburn_data_source_new(d);
00224  if(o->iso_data_source!=NULL)
00225    iso_data_source_unref(o->iso_data_source);
00226  o->iso_data_source= ds;
00227  iso_image_attach_data(o->image, o->read_pacifier_handle,
00228                        isoburn_idle_free_function);
00229  if(o->read_pacifier_handle==NULL)
00230    iso_tree_set_report_callback(o->image, NULL);
00231  else
00232    iso_tree_set_report_callback(o->image, o->read_pacifier);
00233  ret = iso_image_import(o->image, ds, ropts, &features);
00234  iso_tree_set_report_callback(o->image, NULL);
00235  iso_read_opts_free(ropts);
00236 
00237  if (ret < 0) {
00238    isoburn_report_iso_error(ret, "Cannot import image", 0, "FAILURE", 0);
00239    return ret;
00240  }
00241  /* Important: do not return until free(features) */
00242  if (image!=NULL) {
00243    *image = o->image;
00244    iso_image_ref(*image); /*protects object from premature free*/
00245  }
00246  read_opts->hasRR = iso_read_image_features_has_rockridge(features);
00247  read_opts->hasJoliet = iso_read_image_features_has_joliet(features);
00248  read_opts->hasIso1999 = iso_read_image_features_has_iso1999(features);
00249  read_opts->hasElTorito = iso_read_image_features_has_eltorito(features);
00250  read_opts->size = iso_read_image_features_get_size(features);
00251  iso_read_image_features_destroy(features);
00252  return 1;
00253 }

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

Try whether the data at the given address look like a ISO 9660 image header and obtain its alleged size.

Depending on the info mode one other string of text information can be retrieved too.

Since:
0.1.6
Parameters:
drive The drive with the media to inspect
lba The block number from where to read
image_blocks The number of 2048 bytes blocks
info Caller provided memory, enough to take eventual info reply
flag bit0-7: info return mode 0= do not return anything in info (do not even touch it) 1= copy volume id to info (info needs 33 bytes) 2=
Since:
0.2.2 : copy 64 kB header to info (needs 65536 bytes) bit13=

0.2.2: do not read head from media but use first 64 kB from info bit14= check both half buffers (not only second) return 2 if found in first block bit15= return-1 on read error

Returns:
>0 seems to be a valid ISO image, 0 format not recognized, <0 error

Definition at line 1021 of file burn_wrap.c.

References isoburn_read_iso_head_parse().

Referenced by isoburn_emulate_toc(), isoburn_get_mount_params(), isoburn_read_image(), and isoburn_set_msc1().

01023 {
01024  unsigned char buffer[64*1024];
01025  int ret, info_mode;
01026  off_t data_count;
01027 
01028  info_mode= flag&255;
01029  *image_blocks= 0;
01030  if(flag&(1<<13)) {
01031    memcpy(buffer, info, 64*1024);
01032  } else {
01033    ret = burn_read_data(d, ((off_t) lba) * (off_t) 2048, (char *) buffer,
01034                       (off_t) 64*1024, &data_count, 2); /* no error messages */
01035    if(ret<=0)
01036      return(-1*!!(flag&(1<<15)));
01037    if(info_mode==2)
01038      memcpy(info, buffer, 64*1024);
01039  }
01040 
01041  if(flag&(1<<14)) {
01042    ret= isoburn_read_iso_head_parse(d, buffer, image_blocks, info, info_mode);
01043    if(ret<0)
01044      return(ret);
01045    if(ret>0)
01046      return(2);
01047  }
01048  ret= isoburn_read_iso_head_parse(d, buffer+32*1024, image_blocks, info,
01049                                   info_mode);
01050  if(ret<=0)
01051    return(ret);
01052  return(1);
01053 }

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

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

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

Definition at line 664 of file isoburn.c.

00665 {
00666  if(*o==NULL)
00667    return(0);
00668  free(*o);
00669  *o= NULL;
00670  return(1);
00671 }

int isoburn_ropt_get_default_dirperms ( struct isoburn_read_opts o,
mode_t *  mode 
)

Definition at line 735 of file isoburn.c.

References isoburn_read_opts::dirmode.

00737 {
00738  *mode= o->dirmode;
00739  return(1);
00740 }

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

Definition at line 717 of file isoburn.c.

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

00719 {
00720  *uid= o->uid;
00721  *gid= o->gid;
00722  *mode= o->mode;
00723  return(1);
00724 }

int isoburn_ropt_get_extensions ( struct isoburn_read_opts o,
int *  ext 
)

Definition at line 688 of file isoburn.c.

References isoburn_read_opts::noaaip, isoburn_read_opts::noacl, isoburn_read_opts::noea, isoburn_read_opts::noiso1999, isoburn_read_opts::nojoliet, isoburn_read_opts::norock, isoburn_read_opts::preferjoliet, and isoburn_read_opts::pretend_blank.

00689 {
00690  *ext= (!!o->norock) | ((!!o->nojoliet)<<1) | ((!!o->noiso1999)<<2) |
00691        ((!!o->preferjoliet)<<3) | ((!!o->pretend_blank)<<4) |
00692        ((!!o->noaaip) << 5) | ((!!o->noacl) << 6) | ((!!o->noea) << 7);
00693  return(1);
00694 }

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

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

Definition at line 759 of file isoburn.c.

References isoburn_read_opts::hasElTorito, isoburn_read_opts::hasIso1999, isoburn_read_opts::hasJoliet, isoburn_read_opts::hasRR, and isoburn_read_opts::size.

00761 {
00762  *size= o->size;
00763  *has_what= (!!o->hasRR) | ((!!o->hasJoliet)<<1) |
00764             ((!!o->hasIso1999)<<2) | ((!!o->hasElTorito)<<3); 
00765  return(1);
00766 }

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

Produces a set of image read options, initialized with default values.

Since:
0.1.0
Parameters:
o the newly created option set object
flag Bitfield for control purposes. Submit 0 for now.
Returns:
1=ok , <0 = failure

Definition at line 632 of file isoburn.c.

References isoburn_read_opts::dirmode, isoburn_read_opts::gid, isoburn_read_opts::hasElTorito, isoburn_read_opts::hasIso1999, isoburn_read_opts::hasJoliet, isoburn_read_opts::hasRR, isoburn_read_opts::input_charset, isoburn_msgs_submit(), isoburn_read_opts::mode, isoburn_read_opts::noaaip, isoburn_read_opts::noacl, isoburn_read_opts::noea, isoburn_read_opts::noiso1999, isoburn_read_opts::nojoliet, isoburn_read_opts::norock, isoburn_read_opts::preferjoliet, isoburn_read_opts::pretend_blank, isoburn_read_opts::size, and isoburn_read_opts::uid.

00633 {
00634  struct isoburn_read_opts *o;
00635 
00636  o= (*new_o)= calloc(1, sizeof(struct isoburn_read_opts));
00637  if(o==NULL) {
00638    isoburn_msgs_submit(NULL, 0x00060000,
00639                      "Cannot allocate memory for read options", 0, "FATAL", 0);
00640    return(-1);
00641  }
00642  o->norock= 0;
00643  o->nojoliet= 0;
00644  o->noiso1999= 1;
00645  o->noaaip= 1;
00646  o->noacl= 1;
00647  o->noea= 1;
00648  o->preferjoliet= 0;
00649  o->uid= geteuid();
00650  o->gid= getegid();
00651  o->mode= 0444;
00652  o->dirmode= 0555;
00653  o->input_charset= NULL;
00654  o->hasRR= 0;
00655  o->hasJoliet= 0;
00656  o->hasIso1999= 0;
00657  o->hasElTorito= 0;
00658  o->size= 0;
00659  o->pretend_blank= 1;
00660  return(1);
00661 }

int isoburn_ropt_set_default_dirperms ( struct isoburn_read_opts o,
mode_t  mode 
)

Default attributes to use on directories if no RockRidge extension gets loaded.

Above call isoburn_ropt_set_default_perms() automatically adds x-permissions to r-permissions for directories. This call here may be done afterwards to set independend permissions for directories, especially to override the automatically added x-permissions.

Since:
0.1.0
Parameters:
o The option set to work on
mode permissions (not file type) as of man 2 stat.
Returns:
1 success, <=0 failure

Definition at line 727 of file isoburn.c.

References isoburn_read_opts::dirmode.

00729 {
00730  o->dirmode= mode;
00731  return(1);
00732 }

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

Default attributes to use if no RockRidge extension gets loaded.

Since:
0.1.0
Parameters:
o The option set to work on
uid user id number (see /etc/passwd)
gid group id number (see /etc/group)
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.
Returns:
1 success, <=0 failure

Definition at line 697 of file isoburn.c.

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

00699 {
00700  mode_t dirmode;
00701 
00702  o->uid= uid;
00703  o->gid= gid;
00704  o->mode= mode;
00705  dirmode= mode;
00706  if(dirmode & S_IRUSR)
00707    dirmode|= S_IXUSR;
00708  if(dirmode & S_IRGRP)
00709    dirmode|= S_IXGRP;
00710  if(dirmode & S_IROTH)
00711    dirmode|= S_IXOTH;
00712  o->dirmode= dirmode;
00713  return(1);
00714 }

int isoburn_ropt_set_extensions ( struct isoburn_read_opts o,
int  ext 
)

Definition at line 674 of file isoburn.c.

References isoburn_read_opts::noaaip, isoburn_read_opts::noacl, isoburn_read_opts::noea, isoburn_read_opts::noiso1999, isoburn_read_opts::nojoliet, isoburn_read_opts::norock, isoburn_read_opts::preferjoliet, and isoburn_read_opts::pretend_blank.

00675 {
00676  o->norock= !!(ext&1);
00677  o->nojoliet= !!(ext&2);
00678  o->noiso1999= !!(ext&4);
00679  o->preferjoliet= !!(ext&8);
00680  o->pretend_blank= !!(ext&16);
00681  o->noaaip= !!(ext & 32);
00682  o->noacl= !!(ext & 64);
00683  o->noea= !!(ext & 128);
00684  return(1);
00685 }

int isoburn_ropt_set_input_charset ( struct isoburn_read_opts o,
char *  input_charset 
)

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

Since:
0.1.0
Parameters:
o The option set to work on
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".
Returns:
1 success, <=0 failure

Definition at line 743 of file isoburn.c.

References isoburn_read_opts::input_charset.

00745 {
00746  o->input_charset= input_charset;
00747  return(1);
00748 }

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

Set up isoburn_disc_get_msc1() to return a fabricated value.

This makes only sense between 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.

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

Definition at line 1523 of file burn_wrap.c.

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

Referenced by isoburn_get_mount_params().

01525 {
01526  int ret, num_sessions, num_tracks, adr_num, i, j, total_tracks;
01527  int lba, best_lba, size, re_valid= 0;
01528  char volid[33], msg[160];
01529  struct isoburn *o;
01530  struct isoburn_toc_disc *disc= NULL;
01531  struct isoburn_toc_session **sessions= NULL;
01532  struct isoburn_toc_track **tracks= NULL;
01533  static char mode_names[][20]= {"auto", "session", "track", "lba", "volid"};
01534  static int max_mode_names= 4;
01535  regex_t re;
01536  regmatch_t match[1];
01537 
01538  ret= isoburn_find_emulator(&o, d, 0);
01539  if(ret<0)
01540    return(-1);
01541  if(o==NULL)
01542    return(-1);
01543 
01544  adr_num= atoi(adr_value);
01545  if(adr_mode!=3 || (flag & 2)) {
01546    disc= isoburn_toc_drive_get_disc(d);
01547    if(disc==NULL) {
01548 not_found:;
01549      if(adr_mode<0 || adr_mode>max_mode_names)
01550        goto unknown_mode;
01551      sprintf(msg, "Failed to find %s %s", mode_names[adr_mode],
01552                   strlen(adr_value)<=80 ?  adr_value : "-oversized-string-");
01553      isoburn_msgs_submit(o, 0x00060000, msg, 0, "FAILURE", 0);
01554      ret= 0; goto ex;
01555    }
01556    sessions= isoburn_toc_disc_get_sessions(disc, &num_sessions);
01557    if(sessions==NULL || num_sessions<=0)
01558      goto not_found;
01559  }
01560  if(adr_mode==0) {
01561    /* Set fabricated_msc1 to last session in TOC */
01562    tracks= isoburn_toc_session_get_tracks(sessions[num_sessions-1],
01563                                           &num_tracks);
01564    if(tracks==NULL || num_tracks<=0)
01565      goto not_found;
01566    isoburn_get_track_lba(tracks[0], &(o->fabricated_msc1), 0);
01567 
01568  } else if(adr_mode==1) {
01569    /* Use adr_num as session index (first session is 1, not 0) */
01570    if(adr_num<1 || adr_num>num_sessions)
01571      goto not_found;
01572    tracks= isoburn_toc_session_get_tracks(sessions[adr_num-1], &num_tracks);
01573    if(tracks==NULL || num_tracks<=0)
01574      goto not_found;
01575    isoburn_get_track_lba(tracks[0], &(o->fabricated_msc1), 0);
01576 
01577  } else if(adr_mode==2) {
01578    /* use adr_num as track index */
01579    total_tracks= 0;
01580    for(i=0; i<num_sessions; i++) {
01581      tracks= isoburn_toc_session_get_tracks(sessions[i], &num_tracks);
01582      if(tracks==NULL)
01583    continue;
01584      for(j= 0; j<num_tracks; j++) {
01585        total_tracks++;
01586        if(total_tracks==adr_num) {
01587          isoburn_get_track_lba(tracks[j], &(o->fabricated_msc1), 0);
01588          ret= 1; goto ex;
01589        }
01590      }
01591    }
01592    goto not_found;
01593 
01594  } else if(adr_mode==3) {
01595    o->fabricated_msc1= adr_num;
01596    if((flag & 1) && o->fabricated_msc1 >= 16) {
01597      /* adr_num is possibly 16 blocks too high */
01598      ret= isoburn_read_iso_head(d, o->fabricated_msc1, &size,volid, 1|(1<<14));
01599      if(ret==2)
01600        o->fabricated_msc1-= 16;
01601    }
01602  } else if(adr_mode==4) {
01603    /* search for volume id that is equal to adr_value */
01604    if(flag & 4) {
01605      ret= regcomp(&re, adr_value, 0);
01606      if(ret != 0)
01607        flag&= ~4;
01608      else
01609        re_valid= 1;
01610    }
01611    best_lba= -1;
01612    for(i=0; i<num_sessions; i++) {
01613      tracks= isoburn_toc_session_get_tracks(sessions[i], &num_tracks);
01614      if(tracks==NULL)
01615    continue;
01616      for(j= 0; j<num_tracks; j++) {
01617        isoburn_get_track_lba(tracks[0], &lba, 0);
01618        ret= isoburn_read_iso_head(d, lba, &size, volid, 1);
01619        if(ret<=0)
01620      continue;
01621        if(flag & 4) {
01622          ret= regexec(&re, volid, 1, match, 0);
01623          if(ret != 0)
01624      continue;
01625        } else {
01626          if(strcmp(volid, adr_value)!=0)
01627      continue;
01628        }
01629        best_lba= lba;
01630      }
01631    }
01632    if(best_lba<0)
01633      goto not_found;
01634    o->fabricated_msc1= best_lba;
01635 
01636  } else {
01637 unknown_mode:;
01638    sprintf(msg, "Program error: Unknown msc1 address mode %d", adr_mode);
01639    isoburn_msgs_submit(o, 0x00060000, msg, 0, "FATAL", 0);
01640    ret= 0; goto ex;
01641  }
01642  ret= 1;
01643 ex:;
01644  if(disc!=NULL)
01645    isoburn_toc_disc_free(disc);
01646  if((flag & 4) && re_valid)
01647    regfree(&re);
01648  return(ret);
01649 }

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

Note: Above version numbers are also recorded in configure.ac because libtool wants them as parameters at build time.

For the library compatibility check, ISOBURN_*_VERSION in configure.ac are not decisive. Only the three numbers here do matter. Usage discussion:Some developers of the libburnia project have differing opinions how to ensure the compatibility of libaries and applications.

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

At compile time:

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

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

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

At runtime (via *_is_compatible()):

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

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

These two advises are mutually exclusive.

-----------------------------------------------------

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

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

Parameters:
msgs_submit The function call which implements the method
submit_handle Handle to be used as first argument of msgs_submit
submit_flag Flag to be used as last argument of msgs_submit
flag Unused yet, submit 0
Since:
0.2.0

Definition at line 231 of file burn_wrap.c.

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

00235 {
00236  libisoburn_default_msgs_submit= msgs_submit;
00237  libisoburn_default_msgs_submit_handle= submit_handle;
00238  libisoburn_default_msgs_submit_flag= submit_flag;
00239  return(1);
00240 }

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

Set a callback function for producing pacifier messages during the lengthy process of image reading.

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

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

Definition at line 402 of file isofs_wrap.c.

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

00405 {
00406  int ret;
00407  struct isoburn *o;
00408 
00409  ret = isoburn_find_emulator(&o, drive, 0);
00410  if(ret < 0 || o == NULL)
00411    return -1;
00412  o->read_pacifier_handle= read_handle;
00413  o->read_pacifier= read_pacifier;
00414  return(1);
00415 }

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

Wait after normal end of operations until libisofs ended all write threads and freed resource reservations.

This call is not mandatory. But without it, messages from the ending threads might appear after the application ended its write procedure.

Since:
0.1.0
Parameters:
input_drive The drive resp. in_drive which was used with the preparation call.
output_drive The out_drive used with isoburn_prepare_new_image(), NULL if none.
flag Bitfield, submit 0 for now.
Returns:
<=0 error , 1 = success

Definition at line 591 of file isoburn.c.

References isoburn_cancel_prepared_write().

00593 {
00594  return isoburn_cancel_prepared_write(d, output_drive, 1);
00595 }

void isoburn_toc_disc_free ( struct isoburn_toc_disc disc  ) 

Release the memory associated with a master handle of media.

The handle is invalid afterwards and may not be used any more. Wrapper for: burn_disc_free()

Since:
0.1.6
Parameters:
disc The master handle of the media

Definition at line 1478 of file burn_wrap.c.

References isoburn_toc_disc::disc, and isoburn_toc_destroy_arrays().

Referenced by isoburn_set_msc1().

01479 {
01480  if(d->disc!=NULL)
01481    burn_disc_free(d->disc);
01482  isoburn_toc_destroy_arrays(d, 0);
01483  free((char *) d);
01484 }

int isoburn_toc_disc_get_sectors ( struct isoburn_toc_disc disc  ) 

Tell the number of 2048 byte blocks covered by the table of content.

This number includes the eventual gaps between sessions and tracks. So this call is not really a wrapper for burn_disc_get_sectors().

Since:
0.1.6
Parameters:
disc The master handle of the media
Returns:
number of blocks, <=0 indicates unknown or unreadable state

Definition at line 1348 of file burn_wrap.c.

References isoburn_toc_disc::disc, isoburn_toc_entry::next, isoburn_toc_entry::start_lba, isoburn_toc_disc::toc, and isoburn_toc_entry::track_blocks.

01349 {
01350  struct isoburn_toc_entry *t;
01351  int ret= 0, num_sessions, num_tracks;
01352  struct burn_session **sessions;
01353  struct burn_track **tracks;
01354  struct burn_toc_entry entry;
01355 
01356  if(disc==NULL)
01357    return(0);
01358  if(disc->toc!=NULL) {
01359    for(t= disc->toc; t!=NULL; t= t->next)
01360      ret= t->start_lba + t->track_blocks;
01361  } else if(disc->disc!=NULL) {
01362    sessions= burn_disc_get_sessions(disc->disc, &num_sessions);
01363    if(num_sessions > 0) {
01364      tracks = burn_session_get_tracks(sessions[num_sessions - 1],
01365                                       &num_tracks);
01366      if(num_tracks > 0) {
01367        burn_track_get_entry(tracks[num_tracks - 1], &entry);
01368        if(entry.extensions_valid & 1)
01369          ret= entry.start_lba + entry.track_blocks;
01370      }
01371    }
01372 /*
01373    ret= burn_disc_get_sectors(disc->disc);
01374 */
01375  }
01376  return(ret);
01377 }

struct isoburn_toc_session** isoburn_toc_disc_get_sessions ( struct isoburn_toc_disc disc,
int *  num 
) [read]

Get the array of session handles from the table of content.

Wrapper for: burn_disc_get_sessions()

Since:
0.1.6
Parameters:
disc The master handle of the media
num returns the number of sessions in the array
Returns:
the address of the array of session handles

Definition at line 1380 of file burn_wrap.c.

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

Referenced by isoburn_get_mount_params(), and isoburn_set_msc1().

01382 {
01383  *num= disc->session_count;
01384  return(disc->session_pointers);
01385 }

struct isoburn_toc_disc* isoburn_toc_drive_get_disc ( struct burn_drive *  d  )  [read]

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()

Since:
0.1.6
Parameters:
drive The drive with the media to inspect
Returns:
NULL in case there is no content info, else it is a valid handle

Definition at line 1262 of file burn_wrap.c.

References isoburn_toc_disc::disc, isoburn_find_emulator(), isoburn_toc_new_arrays(), isoburn_toc_entry::next, isoburn_toc_session::session, isoburn_toc_disc::session_count, isoburn_toc_disc::session_pointers, isoburn_toc_disc::sessions, isoburn::toc, isoburn_toc_disc::toc, isoburn_toc_track::toc_entry, isoburn_toc_session::toc_entry, isoburn_toc_track::track, isoburn_toc_session::track_count, isoburn_toc_disc::track_count, isoburn_toc_session::track_pointers, isoburn_toc_disc::track_pointers, and isoburn_toc_disc::tracks.

Referenced by isoburn_get_mount_params(), and isoburn_set_msc1().

01263 {
01264  int ret, session_count= 0, track_count= 0, num_tracks= 0, i, j;
01265  struct isoburn *o;
01266  struct isoburn_toc_entry *t;
01267  struct isoburn_toc_disc *toc_disc= NULL;
01268  struct burn_session **s;
01269  struct burn_track **tracks;
01270 
01271  toc_disc= calloc(1, sizeof(struct isoburn_toc_disc));
01272  if(toc_disc==NULL)
01273    return(NULL);
01274  toc_disc->disc= NULL;
01275  toc_disc->sessions= NULL;
01276  toc_disc->session_pointers= NULL;
01277  toc_disc->tracks= NULL;
01278  toc_disc->track_pointers= NULL;
01279  toc_disc->session_count= 0;
01280  toc_disc->track_count= 0;
01281  toc_disc->toc= NULL; 
01282 
01283  /* is the media emulated multi-session ? */
01284  ret= isoburn_find_emulator(&o, d, 0);
01285  if(ret<0)
01286    goto libburn;
01287  if(o->toc==NULL)
01288    goto libburn;
01289 
01290  /* This is an emulated TOC */
01291  toc_disc->toc= o->toc;
01292  for(t= toc_disc->toc; t!=NULL; t= t->next)
01293    session_count++;
01294  ret= isoburn_toc_new_arrays(toc_disc, session_count, session_count, 0);
01295  if(ret<=0)
01296    goto failure;
01297  t= toc_disc->toc;
01298  for(i= 0; i<session_count; i++) {
01299    toc_disc->sessions[i].track_pointers= toc_disc->track_pointers+i;
01300    toc_disc->sessions[i].track_count= 1;
01301    toc_disc->sessions[i].toc_entry= t;
01302    toc_disc->session_pointers[i]= toc_disc->sessions+i;
01303    toc_disc->tracks[i].toc_entry= t;
01304    toc_disc->track_pointers[i]= toc_disc->tracks+i;
01305    t= t->next;
01306  }
01307  toc_disc->session_count= session_count;
01308  toc_disc->track_count= session_count;
01309  return(toc_disc);
01310 
01311 libburn:;
01312  /* This is a libburn provided TOC */
01313  toc_disc->disc= burn_drive_get_disc(d);
01314  if(toc_disc->disc == NULL) {
01315 failure:;
01316    free((char *) toc_disc);
01317    return(NULL);
01318  }
01319  s= burn_disc_get_sessions(toc_disc->disc, &session_count);
01320  for(i= 0; i<session_count; i++) {
01321    tracks = burn_session_get_tracks(s[i], &num_tracks);
01322    track_count+= num_tracks;
01323  }
01324  if(session_count<=0 || track_count<=0)
01325    goto failure;
01326  ret= isoburn_toc_new_arrays(toc_disc, session_count, track_count, 0);
01327  if(ret<=0)
01328    goto failure;
01329  track_count= 0;
01330  for(i= 0; i<session_count; i++) {
01331    tracks = burn_session_get_tracks(s[i], &num_tracks);
01332    toc_disc->sessions[i].session= s[i];
01333    toc_disc->sessions[i].track_pointers= toc_disc->track_pointers+track_count;
01334    toc_disc->sessions[i].track_count= num_tracks;
01335    toc_disc->session_pointers[i]= toc_disc->sessions+i;
01336    for(j= 0; j<num_tracks; j++) {
01337      toc_disc->tracks[track_count+j].track= tracks[j];
01338      toc_disc->track_pointers[track_count+j]= toc_disc->tracks+(track_count+j);
01339    }
01340    track_count+= num_tracks;
01341  }
01342  toc_disc->session_count= session_count;
01343  toc_disc->track_count= track_count;
01344  return(toc_disc);
01345 }

void isoburn_toc_session_get_leadout_entry ( struct isoburn_toc_session s,
struct burn_toc_entry *  entry 
)

Obtain a copy of the entry which describes the end of a particular session.

Wrapper for: burn_session_get_leadout_entry()

Since:
0.1.6
Parameters:
s The session handle
entry A pointer to memory provided by the caller. It will be filled with info according to struct burn_toc_entry as defined in libburn.h

Definition at line 1431 of file burn_wrap.c.

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

01433 {
01434  struct isoburn_toc_track *t;
01435 
01436  if(s==NULL)
01437    return;
01438  if(s->session!=NULL && s->toc_entry==NULL) {
01439    burn_session_get_leadout_entry(s->session, entry);
01440    return;
01441  }
01442  if(s->track_count<=0 || s->track_pointers==NULL || s->toc_entry==NULL)
01443    return;
01444  t= s->track_pointers[s->track_count-1];
01445  entry->start_lba= t->toc_entry->start_lba + t->toc_entry->track_blocks;
01446  entry->track_blocks= 0;
01447  isoburn_toc_entry_finish(entry, s->toc_entry->session, t->toc_entry->track_no,
01448                           0);
01449 }

int isoburn_toc_session_get_sectors ( struct isoburn_toc_session s  ) 

Tell the number of 2048 byte blocks covered by a particular session.

Wrapper for: burn_session_get_sectors()

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

Definition at line 1388 of file burn_wrap.c.

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

01389 {
01390  struct isoburn_toc_entry *t;
01391  int count= 0, i;
01392 
01393  if(s==NULL)
01394    return(0);
01395  if(s->toc_entry!=NULL) {
01396    t= s->toc_entry;
01397    for(i= 0; i<s->track_count; i++) {
01398      count+= t->track_blocks;
01399      t= t->next;
01400    }
01401  } else if(s->session!=NULL)
01402    count= burn_session_get_sectors(s->session);
01403  return(count);
01404 }

struct isoburn_toc_track** isoburn_toc_session_get_tracks ( struct isoburn_toc_session s,
int *  num 
) [read]

Get the array of track handles from a particular session.

Wrapper for: burn_session_get_tracks()

Since:
0.1.6
Parameters:
s The session handle
num returns the number of tracks in the array
Returns:
the address of the array of track handles

Definition at line 1452 of file burn_wrap.c.

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

Referenced by isoburn_get_mount_params(), and isoburn_set_msc1().

01454 {
01455  *num= s->track_count;
01456  return(s->track_pointers);
01457 }

void isoburn_toc_track_get_entry ( struct isoburn_toc_track t,
struct burn_toc_entry *  entry 
)

Obtain a copy of the entry which describes a particular track.

Wrapper for: burn_track_get_entry()

Since:
0.1.6
Parameters:
s The track handle
entry A pointer to memory provided by the caller. It will be filled with info according to struct burn_toc_entry as defined in libburn.h

Definition at line 1460 of file burn_wrap.c.

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

Referenced by isoburn_get_track_lba().

01462 {
01463  if(t==0)
01464    return;
01465  if(t->track!=NULL && t->toc_entry==NULL) {
01466    burn_track_get_entry(t->track, entry);
01467    return;
01468  }
01469  if(t->toc_entry==NULL)
01470    return;
01471  entry->start_lba= t->toc_entry->start_lba;
01472  entry->track_blocks= t->toc_entry->track_blocks;
01473  isoburn_toc_entry_finish(entry, t->toc_entry->session, t->toc_entry->track_no,
01474                           0);
01475 }

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

Obtain the three release version numbers of the library.

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

Since:
0.1.0
Parameters:
major The maturity version (0 for now, as we are still learning)
minor The development goal version.
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. Features of a pare release will stay available and ABI compatible as long as the SONAME of libisoburn stays "1". Currently there are no plans to ever change the SONAME.

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

Returns:
1 success, <=0 might in future become an error indication

Definition at line 598 of file isoburn.c.

References isoburn_header_version_major, isoburn_header_version_micro, and isoburn_header_version_minor.

Referenced by isoburn_initialize(), and isoburn_is_compatible().

00599 {
00600  *major= isoburn_header_version_major;
00601  *minor= isoburn_header_version_minor;
00602  *micro= isoburn_header_version_micro;
00603 
00604 /* No more: values from version.h generated from version.h.in and
00605             macro values defined in configure.ac
00606 
00607  *major = ISOBURN_MAJOR_VERSION;
00608  *minor = ISOBURN_MINOR_VERSION;
00609  *micro = ISOBURN_MICRO_VERSION;
00610 */
00611 }


Generated on Fri May 1 12:03:19 2009 for libisoburn by  doxygen 1.5.8