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

Generated for libisoburn by  doxygen 1.7.5