libisoburn 1.1.2
libisoburn-1.1.2/libisoburn/libisoburn.h
Go to the documentation of this file.
00001 
00002 /*
00003   Lower level API definition of libisoburn.
00004 
00005   Copyright 2007-2011 Vreixo Formoso Lopes <metalpain2002@yahoo.es>
00006                   and Thomas Schmitt <scdbackup@gmx.net>
00007   Provided under GPL version 2 or later.
00008 */
00009 
00010 /**                           Overview
00011 
00012 libisoburn is a frontend for libraries libburn and libisofs which enables
00013 creation and expansion of ISO-9660 filesystems on all CD/DVD media supported
00014 by libburn. This includes media like DVD+RW, which do not support multi-session
00015 management on media level and even plain disk files or block devices.
00016 
00017 The price for that is thorough specialization on data files in ISO-9660
00018 filesystem images. So libisoburn is not suitable for audio (CD-DA) or any
00019 other CD layout which does not entirely consist of ISO-9660 sessions.
00020 
00021 Note that there is a higher level of API: xorriso.h. One should not mix it
00022 with the API calls of libisoburn.h, libisofs.h, and libburn.h.
00023 
00024 
00025                           Connector functions
00026 
00027 libisofs and libburn do not depend on each other but share some interfaces
00028 by which they can cooperate.
00029 libisoburn establishes the connection between both modules by creating the
00030 necessary interface objects and attaching them to the right places.
00031 
00032 
00033                           Wrapper functions 
00034 
00035 The priciple of this frontend is that you may use any call of libisofs or
00036 libburn unless it has a  isoburn_*()  wrapper listed in the following function
00037 documentation.
00038 
00039 E.g. call isoburn_initialize() rather than iso_init(); burn_initialize();
00040 and call isoburn_drive_scan_and_grab() rather than burn_drive_scan_and_grab().
00041 But you may call  burn_disc_get_profile()  directly if you want to display
00042 the media type.
00043 
00044 The wrappers will transparently provide the necessary emulations which
00045 are appropriate for particular target drives and media states.
00046 To learn about them you have to read both API descriptions: the one of
00047 the wrapper and the one of the underlying libburn or libisofs call.
00048 
00049 Macros BURN_* and functions burn_*() are documented in <libburn/libburn.h>
00050 Macros ISO_* and functions iso_*() are documented in <libisofs/libisofs.h>
00051 
00052 
00053                              Usage model
00054 
00055 There may be an input drive and an output drive. Either of them may be missing
00056 with the consequence that no reading resp. writing is possible.
00057 Both drive roles can be fulfilled by the same drive.
00058 
00059 Input can be a random access readable libburn drive:
00060   optical media, regular files, block devices.
00061 Output can be any writeable libburn drive:
00062   writeable optical media in burner, writeable file objects (no directories).
00063 
00064 libburn demands rw-permissions to drive device file resp. file object.
00065 
00066 If the input drive provides a suitable ISO RockRidge image, then its tree
00067 may be loaded into memory and can then be manipulated by libisofs API calls.
00068 The loading is done by isoburn_read_image() under control of
00069 struct isoburn_read_opts which the application obtains from libisoburn
00070 and manipulates by the family of isoburn_ropt_set_*() functions.
00071 
00072 Writing of result images is controlled by libisofs related parameters
00073 in a struct isoburn_imgen_opts which the application obtains from libisoburn
00074 and manipulates by the family of isoburn_igopt_set_*() functions.
00075 
00076 All multi-session aspects are handled by libisoburn according to these
00077 settings. The application does not have to analyze media state and write
00078 job parameters. It rather states its desires which libisoburn tries to
00079 fulfill, or else will refuse to start the write run.
00080 
00081 
00082               Setup for Growing, Modifying or Blind Growing
00083 
00084 The connector function family offers alternative API calls for performing
00085 the setup for several alternative image generation strategies.
00086 
00087 Growing:
00088 If input and output drive are the same, then isoburn_prepare_disc() is to
00089 be used. It will lead to an add-on session on appendable or overwriteable
00090 media with existing ISO image. With blank media it will produce a first
00091 session.
00092 
00093 Modifying:
00094 If the output drive is not the input drive, and if it bears blank media
00095 or overwriteable without a valid ISO image, then one may produce a consolidated
00096 image with old and new data. This will copy file data from an eventual input
00097 drive with valid image, add any newly introduced data from the local
00098 filesystem, and produce a first session on output media.
00099 To prepare for such an image generation run, use isoburn_prepare_new_image().
00100 
00101 Blind Growing:
00102 This method reads the old image from one drive and writes the add-on session
00103 to a different drive. That output drive is nevertheless supposed to
00104 finally lead to the same media from where the session was loaded. Usually it
00105 will be stdio:/dev/fd/1 (i.e. stdout) being piped into some burn program
00106 like with this classic gesture:
00107   mkisofs -M $dev -C $msc1,$nwa | cdrecord -waiti dev=$dev
00108 Blind growing is prepared by the call isoburn_prepare_blind_grow().
00109 The input drive should be released immediately after this call in order
00110 to allow the consumer of the output stream to access that drive for writing.
00111 
00112 After either of these setups, some peripheral libburn drive parameter settings
00113 like  burn_write_opts_set_simulate(),  burn_write_opts_set_multi(),
00114  burn_drive_set_speed(),  burn_write_opts_set_underrun_proof()  should be made.
00115 Do not set the write mode. It will be chosen by libisoburn so it matches job
00116 and media state.
00117 
00118                            Writing the image
00119 
00120 Then one may start image generation and write threads by isoburn_disc_write().
00121 Progress may be watched at the output drive by burn_drive_get_status() and
00122 isoburn_get_fifo_status().
00123 
00124 At some time, the output drive will be BURN_DRIVE_IDLE indicating that
00125 writing has ended.
00126 One should inquire isoburn_drive_wrote_well() to learn about overall success.
00127 
00128 Finally one must call isoburn_activate_session() which will complete any
00129 eventual multi-session emulation.
00130 
00131 
00132                          Application Constraints
00133 
00134 Applications shall include libisofs/libisofs.h , libburn/libburn.h and this
00135 file itself: libisoburn/libisoburn.h .
00136 They shall link with -lisofs -lburn -lisoburn or with the .o files emerging
00137 from building those libraries from their sources.
00138 
00139 Applications must use 64 bit off_t.
00140 E.g. on 32-bit GNU/Linux by defining
00141   #define _LARGEFILE_SOURCE
00142   #define _FILE_OFFSET_BITS 64
00143 The minimum requirement is to interface with the library by 64 bit signed
00144 integers where libisofs.h or libisoburn.h prescribe off_t.
00145 Failure to do so may result in surprising malfunction or memory faults.
00146 
00147 Application files which include libisofs/libisofs.h or libisoburn/libisoburn.h
00148 must provide definitions for uint32_t and uint8_t.
00149 This can be achieved either:
00150 - by using autotools which will define HAVE_STDINT_H or HAVE_INTTYPES_H 
00151   according to its ./configure tests,
00152 - or by defining the macros HAVE_STDINT_H resp. HAVE_INTTYPES_H according
00153   to the local situation,
00154 - or by appropriately defining uint32_t and uint8_t by other means,
00155   e.g. by including inttypes.h before including libisofs.h and libisoburn.h
00156 
00157 */
00158 #ifdef HAVE_STDINT_H
00159 #include <stdint.h>
00160 #else
00161 #ifdef HAVE_INTTYPES_H
00162 #include <inttypes.h>
00163 #endif
00164 #endif
00165 
00166 
00167 /* Important: If you add a public API function then add its name to file
00168                   libisoburn/libisoburn.ver
00169 */
00170 
00171 
00172                           /* API functions */
00173 
00174 
00175 /** Initialize libisoburn, libisofs and libburn.
00176     Wrapper for : iso_init() and burn_initialize()
00177     @since 0.1.0
00178     @param msg  A character array for eventual messages (e.g. with errors)
00179     @param flag Bitfield for control purposes (unused yet, submit 0) 
00180     @return 1 indicates success, 0 is failure
00181 */
00182 int isoburn_initialize(char msg[1024], int flag);
00183 
00184 
00185 /** Check whether all features of header file libisoburn.h from the given
00186     major.minor.micro revision triple can be delivered by the library version
00187     which is performing this call.
00188     An application of libisoburn can easily memorize the version of the
00189     libisoburn.h header in its own code. Immediately after isoburn_initialize()
00190     it should simply do this check:
00191         if (! isoburn_is_compatible(isoburn_header_version_major,
00192                                     isoburn_header_version_minor,
00193                                     isoburn_header_version_micro, 0))
00194            ...refuse to start the program with this dynamic library version...
00195     @since 0.1.0
00196     @param major obtained at build time
00197     @param minor obtained at build time
00198     @param micro obtained at build time
00199     @param flag Bitfield for control purposes. Unused yet. Submit 0.
00200     @return 1= library can work for caller
00201             0= library is not usable in some aspects. Caller must restrict
00202                itself to an earlier API version or must not use this libray
00203                at all.
00204 */
00205 int isoburn_is_compatible(int major, int minor, int micro, int flag);
00206 
00207 
00208 /** Obtain the three release version numbers of the library. These are the
00209     numbers encountered by the application when linking with libisoburn,
00210     i.e. possibly not before run time.
00211     Better do not base the fundamental compatibility decision of an application
00212     on these numbers. For a reliable check use isoburn_is_compatible().
00213     @since 0.1.0
00214     @param major The maturity version (0 for now, as we are still learning)
00215     @param minor The development goal version.
00216     @param micro The development step version. This has an additional meaning:
00217 
00218                  Pare numbers indicate a version with frozen API. I.e. you can
00219                  rely on the same set of features to be present in all
00220                  published releases with that major.minor.micro combination.
00221                  Features of a pare release will stay available and ABI
00222                  compatible as long as the SONAME of libisoburn stays "1".
00223                  Currently there are no plans to ever change the SONAME.
00224                  
00225                  Odd numbers indicate that API upgrades are in progress.
00226                  I.e. new features might be already present or they might
00227                  be still missing. Newly introduced features may be changed
00228                  incompatibly or even be revoked before release of a pare
00229                  version.
00230                  So micro revisions {1,3,5,7,9} should never be used for
00231                  dynamic linking unless the proper library match can be
00232                  guaranteed by external circumstances.
00233 
00234     @return 1 success, <=0 might in future become an error indication
00235 */
00236 void isoburn_version(int *major, int *minor, int *micro);
00237 
00238 
00239 /** The minimum version of libisofs to be used with this version of libisoburn
00240     at compile time.
00241     @since 0.1.0
00242 */
00243 #define isoburn_libisofs_req_major  1
00244 #define isoburn_libisofs_req_minor  1
00245 #define isoburn_libisofs_req_micro  2 
00246 
00247 /** The minimum version of libburn to be used with this version of libisoburn
00248     at compile time.
00249     @since 0.1.0
00250 */
00251 #define isoburn_libburn_req_major  1
00252 #define isoburn_libburn_req_minor  1
00253 #define isoburn_libburn_req_micro  0
00254 
00255 /** The minimum compile time requirements of libisoburn towards libjte are
00256     the same as of a suitable libisofs towards libjte.
00257     So use these macros from libisofs.h :
00258       iso_libjte_req_major
00259       iso_libjte_req_minor
00260       iso_libjte_req_micro
00261     @since 0.6.4
00262 */
00263 
00264 /** The minimum version of libisofs to be used with this version of libisoburn
00265     at runtime. This is checked already in isoburn_initialize() which will
00266     refuse on outdated version. So this call is for information purposes after
00267     successful startup only.
00268     @since 0.1.0
00269     @param major isoburn_libisofs_req_major as seen at build time
00270     @param minor as seen at build time
00271     @param micro as seen at build time
00272     @return 1 success, <=0 might in future become an error indication
00273 */
00274 int isoburn_libisofs_req(int *major, int *minor, int *micro);
00275 
00276 
00277 /** The minimum version of libjte to be used with this version of libisoburn
00278     at runtime. The use of libjte is optional and depends on configure
00279     tests. It can be prevented by ./configure option --disable-libjte .
00280     This is checked already in isoburn_initialize() which will refuse on
00281     outdated version. So this call is for information purposes after
00282     successful startup only.
00283     @since 0.6.4
00284 */
00285 int isoburn_libjte_req(int *major, int *minor, int *micro);
00286 
00287 
00288 /** The minimum version of libburn to be used with this version of libisoburn
00289     at runtime. This is checked already in isoburn_initialize() which will
00290     refuse on outdated version. So this call is for information purposes after
00291     successful startup only.
00292     @since 0.1.0
00293     @param major isoburn_libburn_req_major as seen at build time
00294     @param minor as seen at build time
00295     @param micro as seen at build time
00296     @return 1 success, <=0 might in future become an error indication
00297 */
00298 int isoburn_libburn_req(int *major, int *minor, int *micro);
00299 
00300 
00301 /** These three release version numbers tell the revision of this header file
00302     and of the API it describes. They are memorized by applications at build
00303     time.
00304     @since 0.1.0
00305 */
00306 #define isoburn_header_version_major  1
00307 #define isoburn_header_version_minor  1
00308 #define isoburn_header_version_micro  2
00309 /** Note:
00310     Above version numbers are also recorded in configure.ac because libtool
00311     wants them as parameters at build time.
00312     For the library compatibility check, ISOBURN_*_VERSION in configure.ac
00313     are not decisive. Only the three numbers here do matter.
00314 */
00315 /** Usage discussion:
00316 
00317 Some developers of the libburnia project have differing
00318 opinions how to ensure the compatibility of libaries
00319 and applications.
00320 
00321 It is about whether to use at compile time and at runtime
00322 the version numbers isoburn_header_version_* provided here.
00323 Thomas Schmitt advises to use them.
00324 Vreixo Formoso advises to use other means.
00325 
00326 At compile time:
00327 
00328 Vreixo Formoso advises to leave proper version matching
00329 to properly programmed checks in the the application's
00330 build system, which will eventually refuse compilation.
00331 
00332 Thomas Schmitt advises to use the macros defined here
00333 for comparison with the application's requirements of
00334 library revisions and to eventually break compilation.
00335 
00336 Both advises are combinable. I.e. be master of your
00337 build system and have #if checks in the source code
00338 of your application, nevertheless.
00339 
00340 At runtime (via *_is_compatible()):
00341 
00342 Vreixo Formoso advises to compare the application's
00343 requirements of library revisions with the runtime
00344 library. This is to allow runtime libraries which are
00345 young enough for the application but too old for
00346 the lib*.h files seen at compile time.
00347 
00348 Thomas Schmitt advises to compare the header
00349 revisions defined here with the runtime library.
00350 This is to enforce a strictly monotonous chain
00351 of revisions from app to header to library,
00352 at the cost of excluding some older libraries.
00353 
00354 These two advises are mutually exclusive.
00355 
00356 -----------------------------------------------------
00357 
00358 For an implementation of the Thomas Schmitt approach,
00359 see libisoburn/burn_wrap.c : isoburn_initialize()
00360 This connects libisoburn as "application" with libisofs
00361 as "library".
00362 
00363 The compatible part of Vreixo Formoso's approach is implemented
00364 in configure.ac LIBBURN_REQUIRED, LIBISOFS_REQUIRED.
00365 In isoburn_initialize() it would rather test by
00366   iso_lib_is_compatible(isoburn_libisofs_req_major,...
00367 than by
00368   iso_lib_is_compatible(iso_lib_header_version_major,...
00369 and would leave out the ugly compile time traps.
00370 
00371 */
00372 
00373 
00374 /** Announce to the library an application provided method for immediate
00375     delivery of messages. It is used when no drive is affected directly or
00376     if the drive has no own msgs_submit() method attached by
00377     isoburn_drive_set_msgs_submit.
00378     If no method is preset or if the method is set to NULL then libisoburn
00379     delivers its messages through the message queue of libburn.
00380     @param msgs_submit   The function call which implements the method
00381     @param submit_handle Handle to be used as first argument of msgs_submit
00382     @param submit_flag   Flag to be used as last argument of msgs_submit
00383     @param flag          Unused yet, submit 0
00384     @since 0.2.0
00385 */
00386 int isoburn_set_msgs_submit(int (*msgs_submit)(void *handle, int error_code,
00387                                                   char msg_text[], int os_errno,
00388                                                   char severity[], int flag),
00389                                void *submit_handle, int submit_flag, int flag);
00390 
00391 
00392 /** Aquire a target drive by its filesystem path resp. libburn persistent
00393     address.
00394     Wrapper for: burn_drive_scan_and_grab()
00395     @since 0.1.0
00396     @param drive_infos On success returns a one element array with the drive
00397                   (cdrom/burner). Thus use with driveno 0 only. On failure
00398                   the array has no valid elements at all.
00399                   The returned array should be freed via burn_drive_info_free()
00400                   when the drive is no longer needed. But before this is done
00401                   one has to call isoburn_drive_release(drive_infos[0].drive).
00402     @param adr    The persistent address of the desired drive.
00403     @param load   1 attempt to load the disc tray. 0 no attempt,rather failure.
00404     @return       1 = success , 0 = drive not found , <0 = other error
00405 */
00406 int isoburn_drive_scan_and_grab(struct burn_drive_info *drive_infos[],
00407                                 char* adr, int load);
00408 
00409 
00410 /** Aquire a target drive by its filesystem path resp. libburn persistent
00411     address. This is a modern successor of isoburn_drive_scan_and_grab().  
00412     Wrapper for: burn_drive_scan_and_grab()
00413     @since 0.1.2
00414     @param drive_infos On success returns a one element array with the drive
00415                   (cdrom/burner). Thus use with driveno 0 only. On failure
00416                   the array has no valid elements at all.
00417                   The returned array should be freed via burn_drive_info_free()
00418                   when the drive is no longer needed. But before this is done
00419                   one has to call isoburn_drive_release(drive_infos[0].drive).
00420     @param adr    The persistent address of the desired drive.
00421     @param flag   bit0= attempt to load the disc tray.
00422                         Else: failure if not loaded.
00423                   bit1= regard overwriteable media as blank
00424                   bit2= if the drive is a regular disk file:
00425                         truncate it to the write start address when writing
00426                         begins
00427                   bit3= if the drive reports a read-only profile try to read
00428                         table of content by scanning for ISO image headers.
00429                         (depending on media type and drive this might
00430                          help or it might make the resulting toc even worse)
00431                   bit4= do not emulate table of content on overwriteable media
00432                   bit5= ignore ACL from external filesystems
00433                   bit6= ignore POSIX Extended Attributes from external
00434                         filesystems
00435                   bit7= pretend read-only profile and scan for table of content
00436     @return       1 = success , 0 = drive not found , <0 = other error
00437 */
00438 int isoburn_drive_aquire(struct burn_drive_info *drive_infos[],
00439                          char* adr, int flag);
00440 
00441 /** Aquire a drive from the burn_drive_info[] array which was obtained by
00442     a previous call of burn_drive_scan(). 
00443     Wrapper for: burn_drive_grab()
00444     @since 0.1.0
00445     @param drive The drive to grab. E.g. drive_infos[1].drive .
00446                  Call isoburn_drive_release(drive) when it it no longer needed.
00447     @param load  1 attempt to load the disc tray. 0 no attempt, rather failure.
00448     @return      1 success, <=0 failure
00449 */
00450 int isoburn_drive_grab(struct burn_drive *drive, int load);
00451 
00452 
00453 /** Attach to a drive an application provided method for immediate
00454     delivery of messages.
00455     If no method is set or if the method is set to NULL then libisoburn
00456     delivers messages of the drive through the global msgs_submit() method
00457     set by isoburn_set_msgs_submiti() or by the message queue of libburn.
00458     @since 0.2.0
00459     @param d     The drive to which this function, handle and flag shall apply
00460     @param msgs_submit   The function call which implements the method
00461     @param submit_handle Handle to be used as first argument of msgs_submit
00462     @param submit_flag   Flag to be used as last argument of msgs_submit
00463     @param flag          Unused yet, submit 0
00464 */
00465 int isoburn_drive_set_msgs_submit(struct burn_drive *d,
00466                             int (*msgs_submit)(void *handle, int error_code,
00467                                                char msg_text[], int os_errno,
00468                                                char severity[], int flag),
00469                             void *submit_handle, int submit_flag, int flag);
00470 
00471 
00472 /** Inquire the media status. Expect the whole spectrum of libburn BURN_DISC_*
00473     with multi-session media. Emulated states with random access media are
00474     BURN_DISC_BLANK and BURN_DISC_APPENDABLE.
00475     Wrapper for: burn_disc_get_status()
00476     @since 0.1.0
00477     @param drive The drive to inquire.
00478     @return The status of the drive, or what kind of disc is in it.
00479             Note: BURN_DISC_UNGRABBED indicates wrong API usage
00480 */
00481 #ifdef __cplusplus
00482 enum burn::burn_disc_status isoburn_disc_get_status(struct burn_drive *drive);
00483 #else
00484 enum burn_disc_status isoburn_disc_get_status(struct burn_drive *drive);
00485 #endif
00486 
00487 
00488 /** Tells whether the media can be treated by isoburn_disc_erase().
00489     Wrapper for: burn_disc_erasable()
00490     @since 0.1.0
00491     @param d     The drive to inquire.
00492     @return      0=not erasable , else erasable
00493 */
00494 int isoburn_disc_erasable(struct burn_drive *d);
00495 
00496 
00497 /** Mark the media as blank. With multi-session media this will call
00498     burn_disc_erase(). With random access media, an eventual ISO-9660
00499     filesystem will get invalidated by altering its start blocks on media.
00500     In case of success, the media is in status BURN_DISC_BLANK afterwards.
00501     Wrapper for: burn_disc_erase()
00502     @since 0.1.0
00503     @param drive The drive with the media to erase.
00504     @param fast 1=fast erase, 0=thorough erase
00505                With DVD-RW, fast erase yields media incapable of multi-session.
00506 */
00507 void isoburn_disc_erase(struct burn_drive *drive, int fast);
00508 
00509 
00510 /** Set up isoburn_disc_get_msc1() to return a fabricated value.
00511     This makes only sense between aquiring the drive and reading the
00512     image. After isoburn_read_image() it will confuse the coordination
00513     of libisoburn and libisofs.
00514     Note: Sessions and tracks are counted beginning with 1, not with 0.
00515     @since 0.1.6
00516     @param d        The drive where msc1 is to be set
00517     @param adr_mode Determines how to interpret adr_value and to set msc1.
00518                     If adr_value shall represent a number then decimal ASCII
00519                     digits are expected.
00520                     0= start lba of last session in TOC, ignore adr_value
00521                     1= start lba of session number given by adr_value
00522                     2= start lba of track given number by adr_value
00523                     3= adr_value itself is the lba to be used
00524                     4= start lba of last session with volume id
00525                        given by adr_value
00526     @param adr_value A string describing the value to be eventually used.
00527     @param flag Bitfield for control purposes.
00528                 bit0= @since 0.2.2
00529                       with adr_mode 3: adr_value might be 16 blocks too high
00530                       (e.g. -C stemming from growisofs). Probe for ISO head
00531                       at adr_value-16 and eventually adjust setting. 
00532                 bit1= insist in seeing a disc object with at least one session
00533                 bit2= with adr_mode 4: use adr_value as regular expression
00534 */
00535 int isoburn_set_msc1(struct burn_drive *d, int adr_mode, char *adr_value,
00536                      int flag);
00537 
00538 
00539 /* ----------------------------------------------------------------------- */
00540 /* 
00541 
00542   Wrappers for emulation of TOC on overwriteable media
00543 
00544   Media which match the overwriteable usage model lack of a history of sessions
00545   and tracks. libburn will not even hand out a burn_disc object for them and
00546   always declare them blank. libisoburn checks for a valid ISO filesystem
00547   header at LBA 0 and eventually declares them appendable.
00548   Nevertheless one can only determine an upper limit of the size of the overall
00549   image (by isoburn_get_min_start_byte()) but not a list of stored sessions
00550   and their LBAs, as it is possible with true multi-session media.
00551 
00552   The following wrappers add the capability to obtain a session and track TOC
00553   from emulated multi-session images on overwriteables if the first session
00554   was written by libisoburn-0.1.6 or later (i.e. with a header copy at LBA 32).
00555 
00556   Be aware that the structs emitted by these isoburn calls are not compatible
00557   with the libburn structs. I.e. you may use them only with isoburn_toc_*
00558   calls. 
00559   isoburn_toc_disc needs to be freed after use. isoburn_toc_session and
00560   isoburn_toc_track vanish together with their isoburn_toc_disc.
00561 */
00562 
00563 /* Opaque handles to media, session, track */
00564 struct isoburn_toc_disc;
00565 struct isoburn_toc_session;
00566 struct isoburn_toc_track;
00567 
00568 
00569 /** Obtain a master handle for the table of content.
00570     This handle governs allocated resources which have to be released by
00571     isoburn_toc_disc_free() when no longer needed.
00572     Wrapper for: burn_drive_get_disc()
00573     @since 0.1.6
00574     @param d   The drive with the media to inspect
00575     @return    NULL in case there is no content info, else it is a valid handle
00576 */
00577 struct isoburn_toc_disc *isoburn_toc_drive_get_disc(struct burn_drive *d);
00578 
00579 
00580 /** Tell the number of 2048 byte blocks covered by the table of content.
00581     This number includes the eventual gaps between sessions and tracks.
00582     So this call is not really a wrapper for burn_disc_get_sectors().
00583     @since 0.1.6
00584     @param disc  The master handle of the media
00585     @return      Number of blocks, <=0 indicates unknown or unreadable state
00586 */
00587 int isoburn_toc_disc_get_sectors(struct isoburn_toc_disc *disc);
00588 
00589 
00590 /** Get the array of session handles from the table of content.
00591     Wrapper for: burn_disc_get_sessions()
00592     @since 0.1.6
00593     @param disc The master handle of the media
00594     @param num returns the number of sessions in the array
00595     @return the address of the array of session handles
00596 */
00597 struct isoburn_toc_session **isoburn_toc_disc_get_sessions(
00598                                       struct isoburn_toc_disc *disc, int *num);
00599 
00600 
00601 /** Tell the number of 2048 byte blocks covered by a particular session.
00602     Wrapper for: burn_session_get_sectors()
00603     @since 0.1.6
00604     @param s The session handle
00605     @return number of blocks, <=0 indicates unknown or unreadable state
00606 */
00607 int isoburn_toc_session_get_sectors(struct isoburn_toc_session *s);
00608 
00609 
00610 /** Obtain a copy of the entry which describes the end of a particular session.
00611     Wrapper for: burn_session_get_leadout_entry()
00612     @since 0.1.6
00613     @param s The session handle
00614     @param entry A pointer to memory provided by the caller. It will be filled
00615                  with info according to struct burn_toc_entry as defined
00616                  in libburn.h
00617 */
00618 void isoburn_toc_session_get_leadout_entry(struct isoburn_toc_session *s,
00619                                        struct burn_toc_entry *entry);
00620 
00621 
00622 /** Get the array of track handles from a particular session.
00623     Wrapper for: burn_session_get_tracks()
00624     @since 0.1.6
00625     @param s The session handle
00626     @param num returns the number of tracks in the array
00627     @return the address of the array of track handles,
00628             NULL if no tracks are registered with session s
00629 */
00630 struct isoburn_toc_track **isoburn_toc_session_get_tracks(
00631                                       struct isoburn_toc_session *s, int *num);
00632 
00633 
00634 /** Obtain a copy of the entry which describes a particular track.
00635     Wrapper for: burn_track_get_entry()
00636     @since 0.1.6
00637     @param t The track handle
00638     @param entry A pointer to memory provided by the caller. It will be filled
00639                  with info according to struct burn_toc_entry as defined
00640                  in libburn.h
00641 */
00642 void isoburn_toc_track_get_entry(struct isoburn_toc_track *t,
00643                                  struct burn_toc_entry *entry);
00644 
00645 
00646 /** Obtain eventual ISO image parameters of an emulated track. This info was
00647     gained with much effort and thus gets cached in the track object.
00648     If this call returns 1 then one can save a call of isoburn_read_iso_head()
00649     with return mode 1 which could cause an expensive read operation.
00650     @since 0.4.0
00651     @param t            The track handle
00652     @param start_lba    Returns the start address of the ISO session
00653     @param image_blocks Returns the number of 2048 bytes blocks
00654     @param volid        Caller provided memory for the volume id
00655     @param flag         unused yet, submit 0
00656     @return             0= not an emulated ISO session , 1= reply is valid
00657 */
00658 int isoburn_toc_track_get_emul(struct isoburn_toc_track *t, int *start_lba,
00659                                int *image_blocks, char volid[33], int flag);
00660 
00661 
00662 
00663 /** Release the memory associated with a master handle of media.
00664     The handle is invalid afterwards and may not be used any more.
00665     Wrapper for: burn_disc_free()
00666     @since 0.1.6
00667     @param disc The master handle of the media
00668 */
00669 void isoburn_toc_disc_free(struct isoburn_toc_disc *disc);
00670 
00671 
00672 /** Try whether the data at the given address look like a ISO 9660
00673     image header and obtain its alleged size. Depending on the info mode
00674     one other string of text information can be retrieved too.
00675     @since 0.1.6
00676     @param d     The drive with the media to inspect
00677     @param lba   The block number from where to read
00678     @param image_blocks  Returns the number of 2048 bytes blocks in the session
00679     @param info  Caller provided memory, enough to take eventual info reply
00680     @param flag bit0-7: info return mode
00681                  0= do not return anything in info (do not even touch it)
00682                  1= copy volume id to info (info needs 33 bytes)
00683                  2= @since 0.2.2 :
00684                     copy 64 kB header to info (needs 65536 bytes) 
00685                 bit13= @since 0.2.2:
00686                       do not read head from media but use first 64 kB from info
00687                 bit14= check both half buffers (not only second)
00688                        return 2 if found in first block
00689                 bit15= return -1 on read error
00690     @return >0 seems to be a valid ISO image, 0 format not recognized, <0 error
00691 */
00692 int isoburn_read_iso_head(struct burn_drive *d, int lba,
00693                           int *image_blocks, char *info, int flag);
00694 
00695 
00696 /** Try to convert the given entity address into various entity addresses
00697     which would describe it.
00698     Note: Sessions and tracks are counted beginning with 1, not with 0.
00699     @since 0.3.2
00700     @param d        The drive where msc1 is to be set
00701     @param adr_mode Determines how to interpret the input adr_value.
00702                     If adr_value shall represent a number then decimal ASCII
00703                     digits are expected.
00704                     0= start lba of last session in TOC, ignore adr_value
00705                     1= start lba of session number given by adr_value
00706                     2= start lba of track given number by adr_value
00707                     3= adr_value itself is the lba to be used
00708                     4= start lba of last session with volume id
00709                        given by adr_value
00710     @param adr_value A string describing the value to be eventually used.
00711     @param lba       returns the block address of the entity, -1 means invalid
00712     @param track     returns the track number of the entity, -1 means invalid
00713     @param session   returns the session number of the entity, -1 means invalid
00714     @param volid     returns the volume id of the entity if it is a ISO session
00715     @param flag      Bitfield for control purposes.
00716                      bit2= with adr_mode 4: use adr_value as regular expression
00717     @return          <=0 error , 1 ok, ISO session, 2 ok, not an ISO session
00718 */
00719 int isoburn_get_mount_params(struct burn_drive *d,
00720                              int adr_mode, char *adr_value,
00721                              int *lba, int *track, int *session,
00722                              char volid[33], int flag);
00723 
00724 
00725 /* ----------------------------------------------------------------------- */
00726 /*
00727 
00728   Options for image reading.
00729 
00730   An application shall create an option set object by isoburn_ropt_new(),
00731   program it by isoburn_ropt_set_*(), use it with isoburn_read_image(),
00732   and finally delete it by isoburn_ropt_destroy().
00733 
00734 */
00735 /* ----------------------------------------------------------------------- */
00736 
00737 struct isoburn_read_opts;
00738 
00739 /** Produces a set of image read options, initialized with default values.
00740     @since 0.1.0
00741     @param o the newly created option set object
00742     @param flag  Bitfield for control purposes. Submit 0 for now.
00743     @return 1=ok , <0 = failure
00744 */
00745 int isoburn_ropt_new(struct isoburn_read_opts **o, int flag);
00746 
00747 
00748 /** Deletes an option set which was created by isoburn_ropt_new().
00749     @since 0.1.0
00750     @param o The option set to work on
00751     @param flag  Bitfield for control purposes. Submit 0 for now.
00752     @return 1= **o destroyed , 0= *o was already NULL (harmless)
00753 */
00754 int isoburn_ropt_destroy(struct isoburn_read_opts **o, int flag);
00755 
00756 
00757 /** Which existing ISO 9660 extensions in the image to read or not to read.
00758     Whether to read the content of an existing image at all.
00759     The bits can be combined by | resp. inquired by &.
00760     @since 0.1.0
00761     @param ext Bitfield:
00762                bit0= norock
00763                      Do not read Rock Ridge extensions
00764                bit1= nojoliet
00765                      Do not read Joliet extensions
00766                bit2= noiso1999
00767                      Do not read ISO 9660:1999 enhanced tree
00768                bit3= preferjoliet
00769                      When both Joliet and RR extensions are present, the RR
00770                      tree is used. If you prefer using Joliet, set this to 1.
00771                bit4= pretend_blank
00772                      Always create empty image.Ignore any image on input drive.
00773                bit5= noaaip
00774                      @since 0.3.4
00775                      Do not load AAIP information from image. This information
00776                      eventually contains ACL or XFS-style Extended Attributes.
00777                bit6= noacl
00778                      @since 0.3.4
00779                      Do not obtain ACL from external filesystem objects (e.g.
00780                      local filesystem files).
00781                bit7= noea
00782                      @since 0.3.4
00783                      Do not obtain XFS-style Extended Attributes from external
00784                      filesystem objects (e.g.  local filesystem files).
00785                bit8= noino
00786                      @since 0.4.0
00787                      Do not load eventual inode numbers from RRIP entry PX,
00788                      but generate a new unique inode number for each imported
00789                      IsoNode object.
00790                      PX inode numbers allow to mark families of hardlinks by
00791                      giving all family members the same inode number. libisofs
00792                      keeps the PX inode numbers unaltered when IsoNode objects
00793                      get written into an ISO image.
00794                bit9= nomd5
00795                      @since 0.4.2
00796                      Do not load the eventual MD5 checksum array.
00797                      Do not check eventual session_md5 tags.
00798               bit10= nomd5tag
00799                      @since 1.0.4
00800                      Do not check eventual session_md5 tags although bit9
00801                      is not set.
00802     @return    1 success, <=0 failure
00803 */
00804 #define isoburn_ropt_norock         1
00805 #define isoburn_ropt_nojoliet       2
00806 #define isoburn_ropt_noiso1999      4
00807 #define isoburn_ropt_preferjoliet   8
00808 #define isoburn_ropt_pretend_blank 16
00809 #define isoburn_ropt_noaaip        32
00810 #define isoburn_ropt_noacl         64
00811 #define isoburn_ropt_noea         128
00812 #define isoburn_ropt_noino        256
00813 #define isoburn_ropt_nomd5        512
00814 #define isoburn_ropt_nomd5tag    1024
00815 
00816 int isoburn_ropt_set_extensions(struct isoburn_read_opts *o, int ext);
00817 int isoburn_ropt_get_extensions(struct isoburn_read_opts *o, int *ext);
00818 
00819 
00820 /** Default attributes to use if no RockRidge extension gets loaded.
00821     @since 0.1.0
00822     @param o    The option set to work on
00823     @param uid  user id number (see /etc/passwd)
00824     @param gid  group id number (see /etc/group)
00825     @param mode  permissions (not file type) as of man 2 stat.
00826                  With directories, r-permissions will automatically imply
00827                  x-permissions. See isoburn_ropt_set_default_dirperms() below.
00828     @return      1 success, <=0 failure
00829 */
00830 int isoburn_ropt_set_default_perms(struct isoburn_read_opts *o,
00831                                    uid_t uid, gid_t gid, mode_t mode);
00832 int isoburn_ropt_get_default_perms(struct isoburn_read_opts *o,
00833                                    uid_t *uid, gid_t *gid, mode_t *mode);
00834 
00835 /** Default attributes to use on directories if no RockRidge extension
00836     gets loaded.
00837     Above call isoburn_ropt_set_default_perms() automatically adds
00838     x-permissions to r-permissions for directories. This call here may
00839     be done afterwards to set independend permissions for directories,
00840     especially to override the automatically added x-permissions.
00841     @since 0.1.0
00842     @param o    The option set to work on
00843     @param mode permissions (not file type) as of man 2 stat.
00844     @return     1 success, <=0 failure
00845 */
00846 int isoburn_ropt_set_default_dirperms(struct isoburn_read_opts *o,
00847                                       mode_t mode);
00848 int isoburn_ropt_get_default_dirperms(struct isoburn_read_opts *o,
00849                                       mode_t *mode);
00850 
00851 
00852 /** Set the character set for reading RR file names from ISO images.
00853     @since 0.1.0
00854     @param o             The option set to work on
00855     @param input_charset Set this to NULL to use the default locale charset
00856                          For selecting a particular character set, submit its
00857                          name, e.g. as listed by program iconv -l.
00858                          Example: "UTF-8". 
00859     @return              1 success, <=0 failure
00860 */
00861 int isoburn_ropt_set_input_charset(struct isoburn_read_opts *o,
00862                                    char *input_charset);
00863 int isoburn_ropt_get_input_charset(struct isoburn_read_opts *o,
00864                                    char **input_charset);
00865 
00866 
00867 /**
00868     Enable or disable methods to automatically choose an input charset.
00869     This eventually overrides the name set via isoburn_ropt_set_input_charset()
00870     @since 0.3.8
00871     @param o      The option set to work on
00872     @param mode   Bitfield for control purposes:
00873                   bit0= allow to set the input character set automatically from
00874                         attribute "isofs.cs" of root directory.
00875                   Submit any other bits with value 0.
00876     @return       1 success, <=0 failure
00877  */
00878 int isoburn_ropt_set_auto_incharset(struct isoburn_read_opts *o, int mode);
00879 int isoburn_ropt_get_auto_incharset(struct isoburn_read_opts *o, int *mode);
00880 
00881 
00882 /** Control an offset to be applied to all block address pointers in the ISO
00883     image in order to compensate for an eventual displacement of the image
00884     relative to the start block address for which it was produced.
00885     E.g. if track number 2 from CD gets copied into a disk file and shall then
00886     be loaded as ISO filesystem, then the directory tree and all data file
00887     content of the track copy will become readable by setting the track start
00888     address as displacement and -1 as displacement_sign.
00889     Data file content outside the track will of course not be accessible and
00890     eventually produce read errors.
00891     @since 0.6.6
00892     @param o                  The option set to work on
00893     @param displacement       0 or a positive number
00894     @param displacement_sign  Determines wether to add or subtract displacement
00895                               to block addresses before applying them to the
00896                               storage object for reading:
00897                               +1 = add , -1= subtract , else keep unaltered
00898 */
00899 int isoburn_ropt_set_displacement(struct isoburn_read_opts *o,
00900                                uint32_t displacement, int displacement_sign);
00901 int isoburn_ropt_get_displacement(struct isoburn_read_opts *o,
00902                                uint32_t *displacement, int *displacement_sign);
00903 
00904 /* If you get here because of a compilation error like
00905 
00906        /usr/include/libisoburn/libisoburn.h:895: error:
00907        expected declaration specifiers or '...' before 'uint32_t'
00908 
00909    then see above paragraph "Application Constraints" about the definition
00910    of uint32_t.
00911 */
00912 
00913 
00914 /** After calling function isoburn_read_image() there are informations
00915     available in the option set.
00916     This info can be obtained as bits in parameter has_what. Like:
00917       joliet_available = (has_what & isoburn_ropt_has_joliet);
00918     @since 0.1.0
00919     @param o     The option set to work on
00920     @param size  Number of image data blocks, 2048 bytes each.
00921     @param has_what Bitfield:
00922            bit0= has_rockridge
00923                  RockRidge extension info is available (POSIX filesystem)
00924            bit1= has_joliet
00925                  Joliet extension info is available (suitable for MS-Windows)
00926            bit2= has_iso1999
00927                  ISO version 2 Enhanced Volume Descriptor is available.
00928                  This is rather exotic.
00929            bit3= has_el_torito
00930                  El-Torito boot record is present
00931     @return  1 success, <=0 failure
00932 */
00933 #define isoburn_ropt_has_rockridge 1
00934 #define isoburn_ropt_has_joliet    2
00935 #define isoburn_ropt_has_iso1999   4
00936 #define isoburn_ropt_has_el_torito 8
00937 
00938 int isoburn_ropt_get_size_what(struct isoburn_read_opts *o,
00939                                uint32_t *size, int *has_what);
00940 
00941 /* ts A90122 */
00942 /* >>> to be implemented:
00943 #define isoburn_ropt_has_acl          64
00944 #define isoburn_ropt_has_ea          128
00945 */
00946 
00947 
00948 
00949 /* ----------------------------------------------------------------------- */
00950 /*                      End of Options for image reading                   */
00951 /* ----------------------------------------------------------------------- */
00952 
00953 /* ----------------------------------------------------------------------- */
00954 /*
00955 
00956   Options for image generation by libisofs and image transport to libburn.
00957 
00958   An application shall create an option set by isoburn_igopt_new(),
00959   program it by isoburn_igopt_set_*(), use it with either
00960   isoburn_prepare_new_image() or isoburn_prepare_disc(), and finally delete
00961   it by isoburn_igopt_destroy().
00962 
00963 */
00964 /* ----------------------------------------------------------------------- */
00965 
00966 struct isoburn_imgen_opts;
00967 
00968 /** Produces a set of generation and transfer options, initialized with default
00969     values.
00970     @since 0.1.0
00971     @param o the newly created option set object
00972     @param flag  Bitfield for control purposes. Submit 0 for now.
00973     @return 1=ok , <0 = failure
00974 */
00975 int isoburn_igopt_new(struct isoburn_imgen_opts **o, int flag);
00976 
00977 
00978 /** Deletes an option set which was created by isoburn_igopt_new().
00979     @since 0.1.0
00980     @param o     The option set to give up
00981     @param flag  Bitfield for control purposes. Submit 0 for now.
00982     @return 1= **o destroyed , 0= *o was already NULL (harmless)
00983 */
00984 int isoburn_igopt_destroy(struct isoburn_imgen_opts **o, int flag);
00985 
00986 
00987 /** ISO level to write at.
00988     @since 0.1.0
00989     @param o     The option set to work on
00990     @param level is a term of the ISO 9660 standard. It should be one of:
00991                  1= filenames restricted to form 8.3
00992                  2= filenames allowed up to 31 characters
00993                  3= file content may be larger than 4 GB - 1.
00994     @return      1 success, <=0 failure
00995 */
00996 int isoburn_igopt_set_level(struct isoburn_imgen_opts *o, int level);
00997 int isoburn_igopt_get_level(struct isoburn_imgen_opts *o, int *level);
00998 
00999 
01000 /** Which extensions to support.
01001     @since 0.1.0
01002     @param o     The option set to work on
01003     @param ext Bitfield:
01004            bit0= rockridge
01005                  Rock Ridge extensions add POSIX file attributes like
01006                  owner, group, access permissions, long filenames. Very
01007                  advisable if the designed audience has Unix style systems.
01008            bit1= joliet
01009                  Longer filenames for Windows systems.
01010                  Weaker than RockRidge, but also readable with GNU/Linux.
01011            bit2= iso1999
01012                  This is rather exotic. Better do not surprise the readers.
01013            bit3= hardlinks
01014                  Enable hardlink consolidation. IsoNodes which refer to the
01015                  same source object and have the same properties will get
01016                  the same ISO image inode numbers.
01017                  If combined with isoburn_igopt_rrip_version_1_10 below,
01018                  then the PX entry layout of RRIP-1.12 will be used within
01019                  RRIP-1.10 (mkisofs does this without causing visible trouble).
01020            bit5= aaip
01021                  The libisofs specific SUSP based extension of ECMA-119 which
01022                  can encode ACL and XFS-style Extended Attributes.
01023            bit6= session_md5
01024                  @since 0.4.2
01025                  Produce and write MD5 checksum tags of superblock, directory
01026                  tree, and the whole session stream.
01027            bit7= file_md5
01028                  @since 0.4.2
01029                  Produce and write MD5 checksums for each single IsoFile.
01030            bit8= file_stability (only together with file_md5)
01031                  @since 0.4.2
01032                  Compute MD5 of each file before copying it into the image and
01033                  compare this with the MD5 of the actual copying. If they do
01034                  not match then issue MISHAP event.
01035                  See also libisofs.h  iso_write_opts_set_record_md5()
01036            bit9= no_emul_toc
01037                  @since 0.5.8
01038                  On overwriteable media or random access files do not write
01039                  the first session to LBA 32 and do not copy the first 64kB
01040                  of the first session to LBA 0, but rather write the first
01041                  session to LBA 0 directly.
01042           bit10= will_cancel
01043                  @since 0.6.6
01044                  Announce to libisofs that only the image size is desired
01045                  and that the write thread will be cancelled by
01046                  isoburn_cancel_prepared_write() before actual image writing
01047                  occurs. Without this, cancellation can cause a MISHAP event.
01048           bit11= old_empty
01049                  @since 1.0.2
01050                  Let symbolic links and device files point to block 0, and let
01051                  empty data files point to the address of the Volume Descriptor
01052                  Set Terminator. This was done by libisofs in the past.
01053                  By default there is now a single dedicated block of zero bytes
01054                  after the end of the directory trees, of which the address
01055                  is used for all files without own content.
01056 
01057     @return 1 success, <=0 failure
01058 */
01059 #define isoburn_igopt_rockridge         1
01060 #define isoburn_igopt_joliet            2
01061 #define isoburn_igopt_iso1999           4
01062 #define isoburn_igopt_hardlinks         8
01063 #define isoburn_igopt_aaip             32
01064 #define isoburn_igopt_session_md5      64
01065 #define isoburn_igopt_file_md5        128
01066 #define isoburn_igopt_file_stability  256
01067 #define isoburn_igopt_no_emul_toc     512
01068 #define isoburn_igopt_will_cancel    1024
01069 #define isoburn_igopt_old_empty      2048
01070 int isoburn_igopt_set_extensions(struct isoburn_imgen_opts *o, int ext);
01071 int isoburn_igopt_get_extensions(struct isoburn_imgen_opts *o, int *ext);
01072 
01073 /** Relaxed constraints. Setting any of the bits to 1 break the specifications,
01074     but it is supposed to work on most moderns systems. Use with caution.
01075     @since 0.1.0
01076     @param o     The option set to work on
01077     @param relax Bitfield:
01078            bit0= omit_version_numbers
01079                  Omit the version number (";1") at the end of the
01080                  ISO-9660 and Joliet identifiers.
01081                  Version numbers are usually not used by readers.
01082            bit1= allow_deep_paths
01083                  Allow ISO-9660 directory hierarchy to be deeper
01084                  than 8 levels.
01085            bit2= allow_longer_paths
01086                  Allow path in the ISO-9660 tree to have more than
01087                  255 characters.
01088            bit3= max_37_char_filenames
01089                  Allow a single file or directory hierarchy to have
01090                  up to 37 characters. This is larger than the 31
01091                  characters allowed by ISO level 2, and the extra space
01092                  is taken from the version number, so this also forces
01093                  omit_version_numbers.
01094            bit4= no_force_dots
01095                  ISO-9660 forces filenames to have a ".", that separates
01096                  file name from extension. libisofs adds it if original
01097                  filename has none. Set this to 1 to prevent this
01098                  behavior.
01099            bit5= allow_lowercase 
01100                  Allow lowercase characters in ISO-9660 filenames.
01101                  By default, only uppercase characters, numbers and
01102                  a few other characters are allowed.
01103            bit6= allow_full_ascii
01104                  Allow all ASCII characters to be appear on an ISO-9660
01105                  filename. Note * that "/" and "\0" characters are never
01106                  allowed, even in RR names.
01107            bit7= joliet_longer_paths
01108                  Allow paths in the Joliet tree to have more than
01109                  240 characters.
01110            bit8= always_gmt
01111                  Write timestamps as GMT although the specs prescribe local
01112                  time with eventual non-zero timezone offset. Negative
01113                  timezones (west of GMT) can trigger bugs in some operating
01114                  systems which typically appear in mounted ISO images as if
01115                  the timezone shift from GMT was applied twice
01116                  (e.g. in New York 22:36 becomes 17:36).
01117            bit9= rrip_version_1_10
01118                  Write Rock Ridge info as of specification RRIP-1.10 rather
01119                  than RRIP-1.12: signature "RRIP_1991A" rather than
01120                  "IEEE_1282", field PX without file serial number.
01121           bit10= dir_rec_mtime
01122                  Store as ECMA-119 Directory Record timestamp the mtime
01123                  of the source rather than the image creation time.
01124           bit11= aaip_susp_1_10
01125                  Write AAIP fields without announcing AAIP by an ER field and
01126                  without distinguishing RRIP fields from the AAIP field by
01127                  prefixed ES fields. This saves 5 to 10 bytes per file and
01128                  might avoid problems with readers which only accept RRIP.
01129                  SUSP-1.10 allows it, SUSP-1.12 frowns on it.
01130           bit12= only_iso_numbers
01131                  Same as bit1 omit_version_number but restricted to the names
01132                  in the eventual Joliet tree.
01133                  @since 0.5.4
01134                  For reasons of backward compatibility it is not possible yet
01135                  to disable version numbers for ISO 9660 while enabling them
01136                  for Joliet. 
01137           bit13= no_j_force_dots
01138                  Same as no_force_dots but affecting the names in the eventual
01139                  Joliet tree rather than the ISO 9660 / ECMA-119 names.
01140                  @since 0.5.4
01141                  Previous versions added dots to Joliet names unconditionally.
01142           bit14= allow_dir_id_ext
01143                  Convert directory names for ECMA-119 similar to other file
01144                  names, but do not force a dot or add a version number.
01145                  This violates ECMA-119 by allowing one "." and especially
01146                  ISO level 1 by allowing DOS style 8.3 names rather than
01147                  only 8 characters.
01148                  (mkisofs and its clones obviously do this violation.)
01149                  @since 1.0.0
01150           bit15= joliet_long_names
01151                  Allow for Joliet leaf names up to 103 characters rather than
01152                  up to 64.
01153                  @since 1.0.6
01154     @return 1 success, <=0 failure
01155 */
01156 #define isoburn_igopt_omit_version_numbers       1
01157 #define isoburn_igopt_allow_deep_paths           2
01158 #define isoburn_igopt_allow_longer_paths         4
01159 #define isoburn_igopt_max_37_char_filenames      8
01160 #define isoburn_igopt_no_force_dots             16
01161 #define isoburn_igopt_allow_lowercase           32
01162 #define isoburn_igopt_allow_full_ascii          64
01163 #define isoburn_igopt_joliet_longer_paths      128
01164 #define isoburn_igopt_always_gmt               256
01165 #define isoburn_igopt_rrip_version_1_10        512
01166 #define isoburn_igopt_dir_rec_mtime           1024
01167 #define isoburn_igopt_aaip_susp_1_10          2048
01168 #define isoburn_igopt_only_iso_versions       4096
01169 #define isoburn_igopt_no_j_force_dots         8192
01170 #define isoburn_igopt_allow_dir_id_ext       16384
01171 #define isoburn_igopt_joliet_long_names      32768
01172 int isoburn_igopt_set_relaxed(struct isoburn_imgen_opts *o, int relax);
01173 int isoburn_igopt_get_relaxed(struct isoburn_imgen_opts *o, int *relax);
01174 
01175 
01176 /** Caution: This option breaks any assumptions about names that
01177              are supported by ECMA-119 specifications.
01178     Try to omit any translation which would make a file name compliant to the
01179     ECMA-119 rules. This includes and exceeds omit_version_numbers,
01180     max_37_char_filenames, no_force_dots bit0, allow_full_ascii. Further it
01181     prevents the conversion from local character set to ASCII.
01182     The maximum name length is given by this call. If a filename exceeds
01183     this length or cannot be recorded untranslated for other reasons, then
01184     image production gets aborted.
01185     Currently the length limit is 96 characters, because an ECMA-119 directory
01186     record may at most have 254 bytes and up to 158 other bytes must fit into
01187     the record. Probably 96 more bytes can be made free for the name in future.
01188     @since 1.0.0
01189     @param o    The option set to work on
01190     @param len  0 = disable this feature and perform name translation
01191                     according to other settings.
01192                >0 = Omit any translation. Eventually abort image production
01193                     if a name is longer than the given value.
01194                -1 = Like >0. Allow maximum possible length.
01195                     isoburn_igopt_get_untranslated_name_len() will tell the
01196                     effectively resulting value.
01197     @return >0 success, <=0 failure
01198 */
01199 int isoburn_igopt_set_untranslated_name_len(struct isoburn_imgen_opts *o,
01200                                             int len);
01201 int isoburn_igopt_get_untranslated_name_len(struct isoburn_imgen_opts *o,
01202                                             int *len);
01203 
01204 
01205 /** Whether and how files should be sorted.
01206     @since 0.1.0
01207     @param o     The option set to work on
01208     @param value Bitfield: bit0= sort_files_by_weight
01209                                  files should be sorted based on their weight.
01210                                  Weight is attributed to files in the image
01211                                  by libisofs call iso_node_set_sort_weight().
01212     @return 1 success, <=0 failure
01213 */
01214 #define isoburn_igopt_sort_files_by_weight        1
01215 int isoburn_igopt_set_sort_files(struct isoburn_imgen_opts *o, int value);
01216 int isoburn_igopt_get_sort_files(struct isoburn_imgen_opts *o, int *value);
01217 
01218 
01219 /** Set the override values for files and directory permissions.
01220     The parameters replace_* these take one of three values: 0, 1 or 2.
01221     If 0, the corresponding attribute will be kept as set in the IsoNode
01222     at the time of image generation.
01223     If set to 1, the corresponding attrib. will be changed by a default
01224     suitable value.
01225     With value 2, the attrib. will be changed with the value specified
01226     in the corresponding *_mode options. Note that only the permissions
01227     are set, the file type remains unchanged.
01228     @since 0.1.0
01229     @param o                 The option set to work on
01230     @param replace_dir_mode  whether and how to override directories
01231     @param replace_file_mode whether and how to override files of other type
01232     @param dir_mode          Mode to use on dirs with replace_dir_mode == 2.
01233     @param file_mode;        Mode to use on files with replace_file_mode == 2.
01234     @return 1 success, <=0 failure
01235 */
01236 int isoburn_igopt_set_over_mode(struct isoburn_imgen_opts *o,
01237                                int replace_dir_mode, int replace_file_mode,
01238                                mode_t dir_mode, mode_t file_mode);
01239 int isoburn_igopt_get_over_mode(struct isoburn_imgen_opts *o,
01240                                int *replace_dir_mode, int *replace_file_mode,
01241                                mode_t *dir_mode, mode_t *file_mode);
01242 
01243 /** Set the override values values for group id and user id.
01244     The rules are like with above overriding of mode values. replace_* controls
01245     whether and how. The other two parameters provide values for eventual use.
01246     @since 0.1.0
01247     @param o                 The option set to work on
01248     @param replace_uid       whether and how to override user ids
01249     @param replace_gid       whether and how to override group ids
01250     @param uid               User id to use with replace_uid == 2.
01251     @param gid               Group id to use on files with replace_gid == 2.
01252     @return 1 success, <=0 failure
01253 */
01254 int isoburn_igopt_set_over_ugid(struct isoburn_imgen_opts *o,
01255                                int replace_uid, int replace_gid,
01256                                uid_t uid, gid_t gid);
01257 int isoburn_igopt_get_over_ugid(struct isoburn_imgen_opts *o,
01258                                int *replace_uid, int *replace_gid,
01259                                uid_t *uid, gid_t *gid);
01260 
01261 /** Set the charcter set to use for representing RR filenames in the image.
01262     @since 0.1.0
01263     @param o              The option set to work on
01264     @param output_charset Set this to NULL to use the default output charset.
01265                           For selecting a particular character set, submit its
01266                           name, e.g. as listed by program iconv -l.
01267                           Example: "UTF-8". 
01268     @return 1 success, <=0 failure
01269 */
01270 int isoburn_igopt_set_out_charset(struct isoburn_imgen_opts *o,
01271                                  char *output_charset);
01272 int isoburn_igopt_get_out_charset(struct isoburn_imgen_opts *o,
01273                                  char **output_charset);
01274 
01275 
01276 /** The number of bytes to be used for the fifo which decouples libisofs
01277     and libburn for better throughput and for reducing the risk of
01278     interrupting signals hitting the libburn thread which operates the
01279     MMC drive.
01280     The size will be rounded up to the next full 2048.
01281     Minimum is 64kiB, maximum is 1 GiB (but that is too much anyway).
01282     @since 0.1.0
01283     @param o          The option set to work on
01284     @param fifo_size  Number of bytes to use
01285     @return 1 success, <=0 failure
01286 */
01287 int isoburn_igopt_set_fifo_size(struct isoburn_imgen_opts *o, int fifo_size);
01288 int isoburn_igopt_get_fifo_size(struct isoburn_imgen_opts *o, int *fifo_size);
01289 
01290 
01291 /** Obtain after image preparation the block address where the session will
01292     start on media.
01293     This value cannot be set by the application but only be inquired.
01294     @since 0.1.4
01295     @param o          The option set to work on
01296     @param lba        The block number of the session start on media.
01297                       <0 means that no address has been determined yet.
01298     @return 1 success, <=0 failure
01299 */
01300 int isoburn_igopt_get_effective_lba(struct isoburn_imgen_opts *o, int *lba);
01301 
01302 
01303 /** Obtain after image preparation the lowest block address of file content
01304     data. Failure can occur if libisofs is too old to provide this information,
01305     if the result exceeds 31 bit, or if the call is made before image
01306     preparation.
01307     This value cannot be set by the application but only be inquired.
01308     @since 0.3.6
01309     @param o          The option set to work on
01310     @param lba        The block number of the session start on media.
01311                       <0 means that no address has been determined yet.
01312     @return 1 success, <=0 failure
01313 */
01314 int isoburn_igopt_get_data_start(struct isoburn_imgen_opts *o, int *lba);
01315 
01316 
01317 /** Set resp. get parameters "name" and "timestamp" for a scdbackup checksum
01318     tag. It will be appended to the libisofs session tag if the image starts at
01319     LBA 0. See isoburn_disc_track_lba_nwa. The scdbackup tag can be used
01320     to verify the image by command scdbackup_verify $device -auto_end.
01321     See scdbackup/README appendix VERIFY for its inner details.
01322     @since 0.4.4
01323     @param o          The option set to work on
01324     @param name       The tag name. 80 characters max.
01325     @param timestamp  A string of up to 13 characters YYMMDD.hhmmss
01326                       A9 = 2009, B0 = 2010, B1 = 2011, ... C0 = 2020, ...
01327     @param tag_written Either NULL or the address of an array with at least 512
01328                       characters. In the latter case the eventually produced
01329                       scdbackup tag will be copied to this array when the image
01330                       gets written. This call sets scdbackup_tag_written[0] = 0
01331                       to mark its preliminary invalidity.
01332     @return 1 success, <=0 failure
01333  */
01334 int isoburn_igopt_set_scdbackup_tag(struct isoburn_imgen_opts *o, char *name,
01335                                     char *timestamp, char *tag_written);
01336 int isoburn_igopt_get_scdbackup_tag(struct isoburn_imgen_opts *o,
01337                                     char name[81], char timestamp[19],
01338                                     char **tag_written);
01339 
01340 
01341 /** Attach 32 kB of binary data which shall get written to the first 32 kB
01342     of the ISO image, the System Area.
01343     options can cause manipulations of these data before writing happens.
01344     If system area data are giveni or options bit0 is set, then bit1 of
01345     el_torito_set_isolinux_options() is automatically disabled.
01346     @since 0.5.4
01347     @param o        The option set to work on
01348     @param data     Either NULL or 32 kB of data. Do not submit less bytes !
01349     @param options  Can cause manipulations of submitted data before they
01350                     get written:
01351                     bit0= apply a --protective-msdos-label as of grub-mkisofs.
01352                           This means to patch bytes 446 to 512 of the system
01353                           area so that one partition is defined which begins
01354                           at the second 512-byte block of the image and ends
01355                           where the image ends.
01356                           This works with and without system_area_data.
01357                     bit1= apply isohybrid MBR patching to the system area.
01358                           This works only with system area data from
01359                           SYSLINUX plus an ISOLINUX boot image (see
01360                           iso_image_set_boot_image()) and only if not bit0
01361                           is set.
01362                     bit2-7= System area type
01363                           0= with bit0 or bit1: MBR
01364                              else: unspecified type 
01365                           @since 0.6.4
01366                           1= MIPS Big Endian Volume Header
01367                              Submit up to 15 MIPS Big Endian boot files by
01368                              iso_image_add_mips_boot_file() of libisofs.
01369                              This will overwrite the first 512 bytes of
01370                              the submitted data.
01371                           2= DEC Boot Block for MIPS Little Endian
01372                              The first boot file submitted by
01373                              iso_image_add_mips_boot_file() will be activated.
01374                              This will overwrite the first 512 bytes of
01375                              the submitted data.
01376                           @since 0.6.6
01377                           3= SUN Disk Label for SUN SPARC
01378                              Submit up to 7 SPARC boot images by
01379                              isoburn_igopt_set_partition_img() for partition
01380                              numbers 2 to 8.
01381                              This will overwrite the first 512 bytes of
01382                              the submitted data.
01383                     bit8-9= Only with System area type 0 = MBR
01384                           @since 1.0.4
01385                           Cylinder alignment mode eventually pads the image
01386                           to make it end at a cylinder boundary.
01387                           0 = auto (align if bit1)
01388                           1 = always align to cylinder boundary
01389                           2 = never align to cylinder boundary
01390 
01391     @return 1 success, 0 no data to get, <0 failure
01392 */
01393 int isoburn_igopt_set_system_area(struct isoburn_imgen_opts *o,
01394                                   char data[32768], int options);
01395 int isoburn_igopt_get_system_area(struct isoburn_imgen_opts *o,
01396                                   char data[32768], int *options);
01397 
01398 /** Control production of a second set of volume descriptors (superblock)
01399     and directory trees, together with a partition table in the MBR where the
01400     first partition has non-zero start address and the others are zeroed.
01401     The first partition stretches to the end of the whole ISO image.
01402     The additional volume descriptor set and trees will allow to mount the
01403     ISO image at the start of the first partition, while it is still possible
01404     to mount it via the normal first volume descriptor set and tree at the
01405     start of the image resp. storage device.
01406     This makes few sense on optical media. But on USB sticks it creates a
01407     conventional partition table which makes it mountable on e.g. Linux via
01408     /dev/sdb and /dev/sdb1 alike.
01409     @since 0.6.2
01410     @param opts
01411            The option set to be manipulated.
01412     @param block_offset_2k
01413            The offset of the partition start relative to device start.
01414            This is counted in 2 kB blocks. The partition table will show the
01415            according number of 512 byte sectors.
01416            Default is 0 which causes no second set and trees.
01417            If it is not 0 then it must not be smaller than 16.
01418     @param secs_512_per_head
01419            Number of 512 byte sectors per head. 1 to 63. 0=automatic.
01420     @param heads_per_cyl
01421            Number of heads per cylinder. 1 to 255. 0=automatic.
01422     @return 1 success, <=0 failure
01423  */
01424 int isoburn_igopt_set_part_offset(struct isoburn_imgen_opts  *opts,
01425                                   uint32_t block_offset_2k,
01426                                   int secs_512_per_head, int heads_per_cyl);
01427 int isoburn_igopt_get_part_offset(struct isoburn_imgen_opts *opts,
01428                                   uint32_t *block_offset_2k,
01429                                   int *secs_512_per_head, int *heads_per_cyl);
01430 
01431 
01432 /** Explicitely set the four timestamps of the emerging ISO image.
01433     Default with all parameters is 0.
01434     @since 0.5.4
01435     @param opts
01436            The option set to work on
01437     @param creation_time
01438            ECMA-119 Volume Creation Date and Time
01439            When "the information in the volume was created."
01440            A value of 0 means that the timepoint of write start is to be used.
01441     @param modification_time
01442            ECMA-119 Volume Modification Date and Time
01443            When "the informationin the volume was last modified."
01444            A value of 0 means that the timepoint of write start is to be used.
01445     @param expiration_time
01446            ECMA-119 Volume Expiration Date and Time
01447            When "the information in the volume may be regarded as obsolete."
01448            A value of 0 means that the information never shall expire.
01449     @param effective_time
01450            ECMA-119 Volume Effective Date and Time
01451            When "the information in the volume may be used."
01452            A value of 0 means that not such retention is intended.
01453     @param uuid
01454            If this text is not empty, then it overrides vol_modification_time
01455            by copying the first 16 decimal digits from uuid, eventually
01456            padding up with decimal '1', and writing a NUL-byte as timezone GMT.
01457            It should express a reasonable time in form  YYYYMMDDhhmmsscc
01458            E.g.:  2010040711405800 = 7 Apr 2010 11:40:58 (+0 centiseconds)
01459     @return 1 success, <=0 failure
01460  */
01461 int isoburn_igopt_set_pvd_times(struct isoburn_imgen_opts *opts,
01462                         time_t creation_time, time_t modification_time,
01463                         time_t expiration_time, time_t effective_time,
01464                         char *uuid);
01465 int isoburn_igopt_get_pvd_times(struct isoburn_imgen_opts *opts,
01466                       time_t *creation_time, time_t *modification_time,
01467                       time_t *expiration_time, time_t *effective_time,
01468                       char uuid[17]);
01469 
01470 
01471 /** Associate a libjte environment object to the upcomming write run.
01472     libjte implements Jigdo Template Extraction as of Steve McIntyre and
01473     Richard Atterer.
01474     A non-NULL libjte_handle will cause failure to write if libjte was not
01475     enabled in libisofs at compile time.
01476     @since 0.6.4
01477     @param opts
01478            The option set to work on
01479     @param libjte_handle
01480            Pointer to a struct libjte_env e.g. created by libjte_new().
01481            It must stay existent from the start of image writing by
01482            isoburn_prepare_*() until the write thread has ended.
01483            E.g. until libburn indicates the end of its write run.
01484     @return 1 success, <=0 failure
01485 */
01486 int isoburn_igopt_attach_jte(struct isoburn_imgen_opts *opts,
01487                              void *libjte_handle);
01488 
01489 /** Remove eventual association to a libjte environment handle.
01490     @since 0.6.4
01491     @param opts
01492            The option set to work on
01493     @param libjte_handle
01494            If not submitted as NULL, this will return the previously set
01495            libjte handle. 
01496     @return 1 success, <=0 failure
01497 */
01498 int isoburn_igopt_detach_jte(struct isoburn_imgen_opts *opts,
01499                              void **libjte_handle);
01500 
01501 
01502 /** Set resp. get the number of trailing zero byte blocks to be written by
01503     libisofs. The image size counter of the emerging ISO image will include
01504     them. Eventual checksums will take them into respect.
01505     They will be written immediately before the eventual image checksum area
01506     which is at the very end of the image.
01507     For a motivation see iso_write_opts_set_tail_blocks() in libisofs.h .
01508     @since 0.6.4
01509     @param opts
01510            The option set to work on
01511     @aram num_blocks
01512            Number of extra 2 kB blocks to be written by libisofs.
01513     @return 1 success, <=0 failure
01514 */
01515 int isoburn_igopt_set_tail_blocks(struct isoburn_imgen_opts *opts,
01516                                   uint32_t num_blocks);
01517 int isoburn_igopt_get_tail_blocks(struct isoburn_imgen_opts *opts,
01518                                   uint32_t *num_blocks);
01519 
01520 
01521 /** Cause an arbitrary data file to be appended to the ISO image and to be
01522     described by a partition table entry in an MBR or SUN Disk Label at the
01523     start of the ISO image.
01524     The partition entry will bear the size of the image file rounded up to
01525     the next multiple of 2048 bytes.
01526     MBR or SUN Disk Label are selected by isoburn_igopt_set_system_area()
01527     system area type: 0 selects MBR partition table. 3 selects a SUN partition
01528     table with 320 kB start alignment.
01529     @since 0.6.4
01530     @param opts
01531            The option set to be manipulated.
01532     @param partition_number
01533            Depicts the partition table entry which shall describe the
01534            appended image.
01535            Range with MBR: 1 to 4. 1 will cause the whole ISO image to be
01536                            unclaimable space before partition 1.
01537            @since 0.6.6
01538            Range with SUN Disk Label: 2 to 8.
01539     @param image_path 
01540            File address in the local file system.
01541            With SUN Disk Label: an empty name causes the partition to become
01542            a copy of the next lower partition.
01543     @param image_type
01544            The MBR partition type. E.g. FAT12 = 0x01 , FAT16 = 0x06,
01545            Linux Native Partition = 0x83. See fdisk command L.
01546            This parameter is ignored with SUN Disk Label.
01547     @return
01548            <=0 = error, 1 = success
01549 */
01550 int isoburn_igopt_set_partition_img(struct isoburn_imgen_opts *opts,
01551                                   int partition_number, uint8_t partition_type,
01552                                   char *image_path);
01553 
01554 /** Inquire the current settings made by isoburn_igopt_set_partition_img().
01555     @since 0.6.4
01556     @param opts
01557            The option set to be inquired.
01558     @param num_entries
01559            Number of array elements in partition_types[] and image_paths[].
01560     @param partition_types
01561            The partition type associated with the partition. Valid only if
01562            image_paths[] of the same index is not NULL.
01563     @param image_paths
01564            Its elements get filled with either NULL or a pointer to a string
01565            with a file address resp. an empty text.
01566     @return
01567            <0 = error
01568             0 = no partition image set
01569            >0 highest used partition number
01570 */
01571 int isoburn_igopt_get_partition_img(struct isoburn_imgen_opts *opts,
01572                                     int num_entries,
01573                                     uint8_t partition_types[],
01574                                     char *image_paths[]);
01575 
01576 
01577 /** Set a name for the system area. This setting is ignored unless system area
01578     type 3 "SUN Disk Label" is in effect by iso_write_opts_set_system_area().
01579     In this case it will replace the default text at the start of the image:
01580       "CD-ROM Disc with Sun sparc boot created by libisofs"
01581     @since 0.6.6
01582     @param opts
01583            The option set to be manipulated.
01584     @param label
01585            A text of up to 128 characters.
01586     @return
01587            <=0 = error, 1 = success
01588 */ 
01589 int isoburn_igopt_set_disc_label(struct isoburn_imgen_opts *opts, char *label);
01590 
01591 /** Inquire the current setting made by isoburn_igopt_set_disc_label().
01592     @since 0.6.6
01593     @param opts
01594            The option set to be inquired.
01595     @param label
01596            Returns a pointer to the currently set label string.
01597            Do not alter this string.
01598            Use only as long as the opts object exists.
01599     @return
01600            <=0 = error, 1 = success
01601 */
01602 int isoburn_igopt_get_disc_label(struct isoburn_imgen_opts *opts,
01603                                  char **label);
01604 
01605 
01606 /* ----------------------------------------------------------------------- */
01607 /*                      End of Options for image generation                */
01608 /* ----------------------------------------------------------------------- */
01609 
01610 
01611 /** Get the image attached to a drive, if any.
01612     @since 0.1.0
01613     @param d The drive to inquire
01614     @return A reference to attached image, or NULL if the drive has no image
01615             attached. This reference needs to be released via iso_image_unref()
01616             when it is not longer needed.
01617 */
01618 IsoImage *isoburn_get_attached_image(struct burn_drive *d);
01619 
01620 
01621 /** Load the ISO filesystem directory tree from the media in the given drive.
01622     This will give libisoburn the base on which it can let libisofs perform
01623     image growing or image modification. The loaded volset gets attached
01624     to the drive object and handed out to the application.
01625     Not a wrapper, but peculiar to libisoburn.
01626     @since 0.1.0
01627     @param d The drive which holds an existing ISO filesystem or blank media.
01628              d is allowed to be NULL which produces an empty ISO image. In
01629              this case one has to call before writing isoburn_attach_volset()
01630              with the volset from this call and with the intended output
01631              drive.
01632     @param read_opts The read options which can be chosen by the application
01633     @param image the image read, if the disc is blank it will have no files.
01634              This reference needs to be released via iso_image_unref() when
01635              it is not longer needed. The drive, if not NULL, will hold an
01636              own reference which it will release when it gets a new volset
01637              or when it gets released via isoburn_drive_release().
01638              You can pass NULL if you already have a reference or you plan to
01639              obtain it later with isoburn_get_attached_image(). Of course, if
01640              you haven't specified a valid drive (i.e., if d == NULL), this
01641              parameter can't be NULL.
01642     @return <=0 error , 1 = success
01643 */
01644 int isoburn_read_image(struct burn_drive *d,
01645                        struct isoburn_read_opts *read_opts,
01646                        IsoImage **image);
01647 
01648 /** Set a callback function for producing pacifier messages during the lengthy
01649     process of image reading. The callback function and the application handle
01650     are stored until they are needed for the underlying call to libisofs.
01651     Other than with libisofs the handle is managed entirely by the application.
01652     An idle .free() function is exposed to libisofs. The handle has to stay
01653     valid until isoburn_read_image() is done. It has to be detached by
01654       isoburn_set_read_pacifier(drive, NULL, NULL);
01655     before it may be removed from memory.
01656     @since 0.1.0
01657     @param drive  The drive which will be used with isoburn_read_image()
01658                   It has to be aquired by an isoburn_* wrapper call.
01659     @param read_pacifier  The callback function
01660     @param app_handle  The app handle which the callback function can obtain
01661                        via iso_image_get_attached_data() from its IsoImage*
01662     @return 1 success, <=0 failure
01663 */
01664 int isoburn_set_read_pacifier(struct burn_drive *drive,
01665                               int (*read_pacifier)(IsoImage*, IsoFileSource*),
01666                               void *app_handle);
01667 
01668 /** Inquire the partition offset of the loaded image. The first 512 bytes of
01669     the image get examined whether they bear an MBR signature and a first
01670     partition table entry which matches the size of the image. In this case
01671     the start address is recorded as partition offset and internal buffers
01672     get adjusted.
01673     See also isoburn_igopt_set_part_offset().
01674     @since 0.6.2
01675     @param drive           The drive with the loaded image
01676     @param block_offset_2k returns the recognized partition offset
01677     @return <0 = error
01678              0 = no partition offset recognized
01679              1 = acceptable non-zero offset, buffers are adjusted
01680              2 = offset is credible but not acceptable for buffer size
01681 */ 
01682 int isoburn_get_img_partition_offset(struct burn_drive *drive,
01683                                      uint32_t *block_offset_2k);
01684 
01685 
01686 /** Set the IsoImage to be used with a drive. This eventually releases
01687     the reference to the old IsoImage attached to the drive.
01688     Caution: Use with care. It hardly makes sense to replace an image that
01689              reflects a valid ISO image on media.
01690     This call is rather intended for writing a newly created and populated
01691     image to blank media. The use case in xorriso is to let an image survive
01692     the change or demise of the outdev target drive. 
01693     @since 0.1.0
01694     @param d The drive which shall be write target of the volset.
01695     @param image The image that represents the image to be written.
01696              This image pointer MUST already be a valid reference suitable
01697              for iso_image_unref().
01698              It may have been obtained by appropriate libisofs calls or by
01699              isoburn_read_image() with d==NULL.
01700     @return <=0 error , 1 = success
01701 */ 
01702 int isoburn_attach_image(struct burn_drive *d, IsoImage *image);
01703 
01704 
01705 /** Return the best possible estimation of the currently available capacity of
01706     the media. This might depend on particular write option settings and on
01707     drive state.
01708     An eventual start address for emulated multi-session will be subtracted
01709     from the capacity estimation given by burn_disc_available_space().
01710     Negative results get defaulted to 0.
01711     Wrapper for: burn_disc_available_space()
01712     @since 0.1.0
01713     @param d The drive to query.
01714     @param o If not NULL: write parameters to be set on drive before query
01715     @return number of most probably available free bytes
01716 */
01717 off_t isoburn_disc_available_space(struct burn_drive *d,
01718                                    struct burn_write_opts *o);
01719 
01720 
01721 /** Obtain the start block number of the most recent session on media. In
01722     case of random access media this will normally be 0. Successfull return is
01723     not a guarantee that there is a ISO-9660 image at all. The call will fail,
01724     nevertheless,if isoburn_disc_get_status() returns not BURN_DISC_APPENDABLE
01725     or BURN_DISC_FULL.
01726     Note: The result of this call may be fabricated by a previous call of
01727     isoburn_set_msc1() which can override the rule to load the most recent
01728     session.
01729     Wrapper for: burn_disc_get_msc1()
01730     @since 0.1.0
01731     @param d         The drive to inquire
01732     @param start_lba Contains on success the start address in 2048 byte blocks
01733     @return <=0 error , 1 = success
01734 */
01735 int isoburn_disc_get_msc1(struct burn_drive *d, int *start_lba);
01736 
01737 
01738 /** Use this with trackno==0 to obtain the predicted start block number of the
01739     new session. The interesting number is returned in parameter nwa.
01740     Wrapper for: burn_disc_track_lba_nwa()
01741     @since 0.1.0
01742     @param d         The drive to inquire
01743     @param o If not NULL: write parameters to be set on drive before query
01744     @param trackno Submit 0.
01745     @param lba return value: start lba
01746     @param nwa return value: Next Writeable Address
01747     @return 1=nwa is valid , 0=nwa is not valid , -1=error
01748 */
01749 int isoburn_disc_track_lba_nwa(struct burn_drive *d, struct burn_write_opts *o,
01750                                int trackno, int *lba, int *nwa);
01751 
01752 
01753 /** Obtain the size which was attributed to an emulated appendable on actually
01754     overwriteable media. This value is supposed to be <= 2048 * nwa as of
01755     isoburn_disc_track_lba_nwa().
01756     @since 0.1.0
01757     @param d     The drive holding the media.
01758     @param start_byte The reply value counted in bytes, not in sectors.
01759     @param flag  Unused yet. Submit 0.
01760     @return 1=stat_byte is valid, 0=not an emulated appendable, -1=error 
01761 */
01762 int isoburn_get_min_start_byte(struct burn_drive *d, off_t *start_byte,
01763                                int flag);
01764 
01765 
01766 /** To choose the expansion method of Growing:
01767     Create a disc object for writing the new session from the created or loaded
01768     iso_volset which has been manipulated via libisofs, to the same media from
01769     where the image was eventually loaded. This struct burn_disc is ready for
01770     use by a subsequent call to isoburn_disc_write().
01771     After this asynchronous writing has ended and the drive is BURN_DRIVE_IDLE
01772     again, the burn_disc object has to be disposed by burn_disc_free().
01773     @since 0.1.0
01774     @param drive The combined source and target drive, grabbed with
01775                  isoburn_drive_scan_and_grab(). .
01776     @param disc Returns the newly created burn_disc object.
01777     @param opts Image generation options, see isoburn_igopt_*()
01778     @return <=0 error , 1 = success
01779 */
01780 int isoburn_prepare_disc(struct burn_drive *drive, struct burn_disc **disc,
01781                          struct isoburn_imgen_opts *opts);
01782 
01783 
01784 /** To choose the expansion method of Modifying:
01785     Create a disc object for producing a new image from a previous image
01786     plus the changes made by user. The generated burn_disc is suitable
01787     to be written to a grabbed drive with blank writeable media.
01788     But you must not use the same drive for input and output, because data
01789     will be read from the source drive while at the same time the target
01790     drive is already writing.
01791     The resulting burn_disc object has to be disposed when all its writing
01792     is done and the drive is BURN_DRIVE_IDLE again after asynchronous
01793     burn_disc_write().
01794     @since 0.1.0
01795     @param in_drive The input drive, grabbed with isoburn_drive_aquire() or
01796                     one of its alternatives.
01797     @param disc     Returns the newly created burn_disc object.
01798     @param opts     Options for image generation and data transport to media.
01799     @param out_drive The output drive, from isoburn_drive_aquire() et.al..
01800     @return <=0 error , 1 = success
01801 */
01802 int isoburn_prepare_new_image(struct burn_drive *in_drive,
01803                               struct burn_disc **disc,
01804                               struct isoburn_imgen_opts *opts,
01805                               struct burn_drive *out_drive);
01806 
01807 
01808 /** To choose the expansion method of Blind Growing:
01809     Create a disc object for writing an add-on session from the created or
01810     loaded IsoImage which has been manipulated via libisofs, to a different
01811     drive than the one from where it was loaded.
01812     Usually output will be stdio:/dev/fd/1 (i.e. stdout) being piped
01813     into some burn program like with this classic gesture:
01814       mkisofs -M $dev -C $msc1,$nwa | cdrecord -waiti dev=$dev
01815     Parameter translation into libisoburn:
01816       $dev  is the address by which parameter in_drive of this call was aquired
01817       $msc1 was set by isoburn_set_msc1() before image reading
01818             or was detected from the in_drive media
01819       $nwa  is a parameter of this call
01820             or can be used as detected from the in_drive media
01821 
01822     This call waits for libisofs output to become available and then detaches
01823     the input drive object from the data source object by which libisofs was
01824     reading from the input drive.
01825     So, as far as libisofs is concerned, that drive may be released immediately
01826     after this call in order to allow the consumer to access the drive for
01827     writing.
01828     The consumer should wait for input to become available and only then open
01829     its burn drive. With cdrecord this is caused by option -waiti.
01830   
01831     The resulting burn_disc object has to be disposed when all its writing
01832     is done and the drive is BURN_DRIVE_IDLE again after asynchronous
01833     burn_disc_write().
01834     @since 0.2.2
01835     @param in_drive The input drive,grabbed with isoburn_drive_scan_and_grab().
01836     @param disc     Returns the newly created burn_disc object.
01837     @param opts     Options for image generation and data transport to media.
01838     @param out_drive The output drive, from isoburn_drive_aquire() et.al..
01839                     typically stdio:/dev/fd/1 .
01840     @param nwa      The address (2048 byte block count) where the add-on
01841                     session will be finally stored on a mountable media
01842                     or in a mountable file.
01843                     If nwa is -1 then the address is used as determined from
01844                     the in_drive media.
01845     @return <=0 error , 1 = success
01846 */
01847 int isoburn_prepare_blind_grow(struct burn_drive *in_drive,
01848                                struct burn_disc **disc,
01849                                struct isoburn_imgen_opts *opts,
01850                                struct burn_drive *out_drive, int nwa);
01851 
01852 
01853 /**
01854     Revoke isoburn_prepare_*() instead of running isoburn_disc_write().
01855     libisofs reserves resources and maybe already starts generating the
01856     image stream when one of above three calls is performed. It is mandatory to
01857     either run isoburn_disc_write() or to revoke the preparations by the
01858     call described here.
01859     If this call returns 0 or 1 then the write thread of libisofs has ended.
01860     @since 0.1.0
01861     @param input_drive   The drive resp. in_drive which was used with the
01862                          preparation call.
01863     @param output_drive  The out_drive used with isoburn_prepare_new_image(),
01864                          NULL if none.
01865     @param flag Bitfield, submit 0 for now.
01866                 bit0= -reserved for internal use-
01867     @return     <0 error, 0= no pending preparations detectable, 1 = canceled
01868 */
01869 int isoburn_cancel_prepared_write(struct burn_drive *input_drive,
01870                                   struct burn_drive *output_drive, int flag);
01871 
01872 
01873 /**
01874     Override the truncation setting that was made with flag bit2 during the
01875     call of isoburn_drive_aquire. This applies only to stdio pseudo drives.
01876     @since 0.1.6
01877     @param drive The drive which was aquired and shall be used for writing.
01878     @param flag Bitfield controlling the setting:
01879                 bit0= truncate (else do not truncate)
01880                 bit1= do not warn if call is inappropriate to drive
01881                 bit2= only set if truncation is currently enabled
01882                       do not warn if call is inappropriate to drive
01883     @return     1 success, 0 inappropriate drive, <0 severe error
01884 */
01885 int isoburn_set_truncate(struct burn_drive *drive, int flag);
01886 
01887 
01888 /** Start writing of the new session.
01889     This call is asynchrounous. I.e. it returns quite soon and the progress has
01890     to be watched by a loop with call burn_drive_get_status() until
01891     BURN_DRIVE_IDLE is returned.
01892     Wrapper for: burn_disc_write()
01893     @since 0.1.0
01894     @param o    Options which control the burn process. See burnwrite_opts_*()
01895                 in libburn.h.
01896     @param disc Disc object created either by isoburn_prepare_disc() or by
01897                 isoburn_prepare_new_image().
01898 */
01899 void isoburn_disc_write(struct burn_write_opts *o, struct burn_disc *disc);
01900 
01901 
01902 /** Inquire state and fill parameters of the fifo which is attached to
01903     the emerging track. This should be done in the pacifier loop while
01904     isoburn_disc_write() or burn_disc_write() are active.
01905     This works only with drives obtained by isoburn_drive_scan_and_grab()
01906     or isoburn_drive_grab(). If isoburn_prepare_new_image() was used, then
01907     parameter out_drive must have announced the track output drive.
01908     Hint: If only burn_write_opts and not burn_drive is known, then the drive
01909           can be obtained by burn_write_opts_get_drive().
01910     @since 0.1.0
01911     @param d     The drive to which the track with the fifo gets burned.
01912     @param size  The total size of the fifo
01913     @param free_bytes  The current free capacity of the fifo
01914     @param status_text  Returns a pointer to a constant text, see below
01915     @return  <0 reply invalid, >=0 fifo status code:
01916              bit0+1=input status, bit2=consumption status, i.e:
01917              0="standby"   : data processing not started yet
01918              1="active"    : input and consumption are active
01919              2="ending"    : input has ended without error
01920              3="failing"   : input had error and ended,
01921              4="unused"    : ( consumption has ended before processing start )
01922              5="abandoned" : consumption has ended prematurely
01923              6="ended"     : consumption has ended without input error
01924              7="aborted"   : consumption has ended after input error
01925 */
01926 int isoburn_get_fifo_status(struct burn_drive *d, int *size, int *free_bytes,
01927                             char **status_text);
01928 
01929 
01930 /** Inquire whether the most recent write run was successful.
01931     Wrapper for: burn_drive_wrote_well()
01932     @since 0.1.0
01933     @param d  The drive to inquire
01934     @return   1=burn seems to have went well, 0=burn failed
01935 */
01936 int isoburn_drive_wrote_well(struct burn_drive *d);
01937 
01938 
01939 /** Call this after isoburn_disc_write has finished and burn_drive_wrote_well()
01940     indicates success. It will eventually complete the emulation of
01941     multi-session functionality, if needed at all. Let libisoburn decide.
01942     Not a wrapper, but peculiar to libisoburn.
01943     @since 0.1.0
01944     @param d  The output drive to which the session was written
01945     @return   1 success , <=0 failure
01946 */
01947 int isoburn_activate_session(struct burn_drive *d);
01948 
01949 
01950 /** Wait after normal end of operations until libisofs ended all write
01951     threads and freed resource reservations.
01952     This call is not mandatory. But without it, messages from the ending
01953     threads might appear after the application ended its write procedure.
01954     @since 0.1.0
01955     @param input_drive   The drive resp. in_drive which was used with the
01956                          preparation call.
01957     @param output_drive  The out_drive used with isoburn_prepare_new_image(),
01958                          NULL if none.
01959     @param flag Bitfield, submit 0 for now.
01960     @return     <=0 error , 1 = success
01961 */
01962 int isoburn_sync_after_write(struct burn_drive *input_drive,
01963                              struct burn_drive *output_drive, int flag);
01964 
01965 
01966 /** Release an aquired drive.
01967     Wrapper for: burn_drive_release()
01968     @since 0.1.0
01969     @param drive The drive to be released
01970     @param eject 1= eject media from drive , 0= do not eject
01971 */
01972 void isoburn_drive_release(struct burn_drive *drive, int eject);
01973 
01974 
01975 /** Shutdown all three libraries.
01976     Wrapper for : iso_finish() and burn_finish().
01977     @since 0.1.0
01978 */
01979 void isoburn_finish(void);
01980 
01981 
01982 /*
01983     The following calls are for expert applications only.
01984     An application should have a special reason to use them.
01985 */
01986 
01987 
01988 /** Inquire wether the media needs emulation or would be suitable for
01989     generic multi-session via libburn.
01990     @since 0.1.0
01991     @param d  The drive to inquire
01992     @return 0 is generic multi-session 
01993             1 is emulated multi-session
01994            -1 is not suitable for isoburn
01995 */
01996 int isoburn_needs_emulation(struct burn_drive *d);
01997  
01998 
01999 /* ---------------------------- Test area ----------------------------- */
02000 
02001 /* no tests active, currently */
02002