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