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