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