1 2 #ifndef LIBISOBURN_LIBISOBURN_H_ 3 #define LIBISOBURN_LIBISOBURN_H_ 4 5 /* 6 Lower level API definition of libisoburn. 7 8 Copyright 2007-2018 Vreixo Formoso Lopes <metalpain2002@yahoo.es> 9 and Thomas Schmitt <scdbackup@gmx.net> 10 Provided under GPL version 2 or later. 11 */ 12 13 #ifdef __cplusplus 14 extern "C" { 15 #endif 16 17 /** Overview 18 19 libisoburn is a frontend for libraries libburn and libisofs which enables 20 creation and expansion of ISO-9660 filesystems on all CD/DVD/BD media supported 21 by libburn. This includes media like DVD+RW, which do not support multi-session 22 management on media level and even plain disk files or block devices. 23 24 The price for that is thorough specialization on data files in ISO-9660 25 filesystem images. So libisoburn is not suitable for audio (CD-DA) or any 26 other CD layout which does not entirely consist of ISO-9660 sessions. 27 28 Note that there is a higher level of API: xorriso.h. One should not mix it 29 with the API calls of libisoburn.h, libisofs.h, and libburn.h. 30 31 32 Connector functions 33 34 libisofs and libburn do not depend on each other but share some interfaces 35 by which they can cooperate. 36 libisoburn establishes the connection between both modules by creating the 37 necessary interface objects and attaching them to the right places. 38 39 40 Wrapper functions 41 42 The principle of this frontend is that you may use any call of libisofs or 43 libburn unless it has a isoburn_*() wrapper listed in the following function 44 documentation. 45 46 E.g. call isoburn_initialize() rather than iso_init(); burn_initialize(); 47 and call isoburn_drive_scan_and_grab() rather than burn_drive_scan_and_grab(). 48 But you may call burn_disc_get_profile() directly if you want to display 49 the media type. 50 51 The wrappers will transparently provide the necessary emulations which 52 are appropriate for particular target drives and media states. 53 To learn about them you have to read both API descriptions: the one of 54 the wrapper and the one of the underlying libburn or libisofs call. 55 56 Macros BURN_* and functions burn_*() are documented in <libburn/libburn.h> 57 Macros ISO_* and functions iso_*() are documented in <libisofs/libisofs.h> 58 59 60 Usage model 61 62 There may be an input drive and an output drive. Either of them may be missing 63 with the consequence that no reading or no writing is possible. 64 Both drive roles can be fulfilled by the same drive. 65 66 Input can be a random access readable libburn drive: 67 optical media, regular files, block devices. 68 Output can be any writeable libburn drive: 69 writeable optical media in burner, writeable file objects (no directories). 70 71 libburn demands rw-permissions to drive device file or file object. 72 73 If the input drive provides a suitable ISO RockRidge image, then its tree 74 may be loaded into memory and can then be manipulated by libisofs API calls. 75 The loading is done by isoburn_read_image() under control of 76 struct isoburn_read_opts which the application obtains from libisoburn 77 and manipulates by the family of isoburn_ropt_set_*() functions. 78 79 Writing of result images is controlled by libisofs related parameters 80 in a struct isoburn_imgen_opts which the application obtains from libisoburn 81 and manipulates by the family of isoburn_igopt_set_*() functions. 82 83 All multi-session aspects are handled by libisoburn according to these 84 settings. The application does not have to analyze media state and write 85 job parameters. It rather states its desires which libisoburn tries to 86 fulfill, or else will refuse to start the write run. 87 88 89 Setup for Growing, Modifying or Blind Growing 90 91 The connector function family offers alternative API calls for performing 92 the setup for several alternative image generation strategies. 93 94 Growing: 95 If input and output drive are the same, then isoburn_prepare_disc() is to 96 be used. It will lead to an add-on session on appendable or overwriteable 97 media with existing ISO image. With blank media it will produce a first 98 session. 99 100 Modifying: 101 If the output drive is not the input drive, and if it bears blank media 102 or overwriteable without a valid ISO image, then one may produce a consolidated 103 image with old and new data. This will copy file data from an eventual input 104 drive with valid image, add any newly introduced data from the local 105 filesystem, and produce a first session on output media. 106 To prepare for such an image generation run, use isoburn_prepare_new_image(). 107 108 Blind Growing: 109 This method reads the old image from one drive and writes the add-on session 110 to a different drive. That output drive is nevertheless supposed to 111 finally lead to the same medium from where the session was loaded. Usually it 112 will be stdio:/dev/fd/1 (i.e. stdout) being piped into some burn program 113 like with this classic gesture: 114 mkisofs -M $dev -C $msc1,$nwa | cdrecord -waiti dev=$dev 115 Blind growing is prepared by the call isoburn_prepare_blind_grow(). 116 The input drive should be released immediately after this call in order 117 to allow the consumer of the output stream to access that drive for writing. 118 119 After either of these setups, some peripheral libburn drive parameter settings 120 like burn_write_opts_set_simulate(), burn_write_opts_set_multi(), 121 burn_drive_set_speed(), burn_write_opts_set_underrun_proof() should be made. 122 Do not set the write mode. It will be chosen by libisoburn so it matches job 123 and media state. 124 125 Writing the image 126 127 Then one may start image generation and write threads by isoburn_disc_write(). 128 Progress may be watched at the output drive by burn_drive_get_status() and 129 isoburn_get_fifo_status(). 130 131 At some time, the output drive will be BURN_DRIVE_IDLE indicating that 132 writing has ended. 133 One should inquire isoburn_drive_wrote_well() to learn about overall success. 134 135 Finally one must call isoburn_activate_session() which will complete any 136 eventual multi-session emulation. 137 138 139 Application Constraints 140 141 Applications shall include libisofs/libisofs.h , libburn/libburn.h and this 142 file itself: libisoburn/libisoburn.h . 143 They shall link with -lisofs -lburn -lisoburn or with the .o files emerging 144 from building those libraries from their sources. 145 146 Applications must use 64 bit off_t. 147 E.g. on 32-bit GNU/Linux by defining 148 #define _LARGEFILE_SOURCE 149 #define _FILE_OFFSET_BITS 64 150 The minimum requirement is to interface with the library by 64 bit signed 151 integers where libisofs.h or libisoburn.h prescribe off_t. 152 Failure to do so may result in surprising malfunction or memory faults. 153 154 Application files which include libisofs/libisofs.h or libisoburn/libisoburn.h 155 must provide definitions for uint32_t and uint8_t. 156 This can be achieved either: 157 - by using autotools which will define HAVE_STDINT_H or HAVE_INTTYPES_H 158 according to its ./configure tests, 159 - or by defining the macros HAVE_STDINT_H or HAVE_INTTYPES_H according 160 to the local situation, 161 - or by appropriately defining uint32_t and uint8_t by other means, 162 e.g. by including inttypes.h before including libisofs.h and libisoburn.h 163 164 */ 165 #ifdef HAVE_STDINT_H 166 #include <stdint.h> 167 #else 168 #ifdef HAVE_INTTYPES_H 169 #include <inttypes.h> 170 #endif 171 #endif 172 173 174 /* Important: If you add a public API function then add its name to file 175 libisoburn/libisoburn.ver 176 */ 177 178 179 /* API functions */ 180 181 182 /** Initialize libisoburn, libisofs and libburn. 183 Wrapper for : iso_init() and burn_initialize() 184 @since 0.1.0 185 @param msg A character array for eventual messages (e.g. with errors) 186 @param flag Bitfield for control purposes (unused yet, submit 0) 187 @return 1 indicates success, 0 is failure 188 */ 189 int isoburn_initialize(char msg[1024], int flag); 190 191 192 /** Check whether all features of header file libisoburn.h from the given 193 major.minor.micro revision triple can be delivered by the library version 194 which is performing this call. 195 An application of libisoburn can easily memorize the version of the 196 libisoburn.h header in its own code. Immediately after isoburn_initialize() 197 it should simply do this check: 198 if (! isoburn_is_compatible(isoburn_header_version_major, 199 isoburn_header_version_minor, 200 isoburn_header_version_micro, 0)) 201 ...refuse to start the program with this dynamic library version... 202 @since 0.1.0 203 @param major obtained at build time 204 @param minor obtained at build time 205 @param micro obtained at build time 206 @param flag Bitfield for control purposes. Unused yet. Submit 0. 207 @return 1= library can work for caller 208 0= library is not usable in some aspects. Caller must restrict 209 itself to an earlier API version or must not use this libray 210 at all. 211 */ 212 int isoburn_is_compatible(int major, int minor, int micro, int flag); 213 214 215 /** Obtain the three release version numbers of the library. These are the 216 numbers encountered by the application when linking with libisoburn, 217 i.e. possibly not before run time. 218 Better do not base the fundamental compatibility decision of an application 219 on these numbers. For a reliable check use isoburn_is_compatible(). 220 @since 0.1.0 221 @param major The maturity version (0 for now, as we are still learning) 222 @param minor The development goal version. 223 @param micro The development step version. This has an additional meaning: 224 225 Pare numbers indicate a version with frozen API. I.e. you can 226 rely on the same set of features to be present in all 227 published releases with that major.minor.micro combination. 228 Features of a pare release will stay available and ABI 229 compatible as long as the SONAME of libisoburn stays "1". 230 Currently there are no plans to ever change the SONAME. 231 232 Odd numbers indicate that API upgrades are in progress. 233 I.e. new features might be already present or they might 234 be still missing. Newly introduced features may be changed 235 incompatibly or even be revoked before release of a pare 236 version. 237 So micro revisions {1,3,5,7,9} should never be used for 238 dynamic linking unless the proper library match can be 239 guaranteed by external circumstances. 240 241 @return 1 success, <=0 might in future become an error indication 242 */ 243 void isoburn_version(int *major, int *minor, int *micro); 244 245 246 /** The minimum version of libisofs to be used with this version of libisoburn 247 at compile time. 248 @since 0.1.0 249 */ 250 #define isoburn_libisofs_req_major 1 251 #define isoburn_libisofs_req_minor 5 252 #define isoburn_libisofs_req_micro 0 253 254 /** The minimum version of libburn to be used with this version of libisoburn 255 at compile time. 256 @since 0.1.0 257 */ 258 #define isoburn_libburn_req_major 1 259 #define isoburn_libburn_req_minor 5 260 #define isoburn_libburn_req_micro 0 261 262 /** The minimum compile time requirements of libisoburn towards libjte are 263 the same as of a suitable libisofs towards libjte. 264 So use these macros from libisofs.h : 265 iso_libjte_req_major 266 iso_libjte_req_minor 267 iso_libjte_req_micro 268 @since 0.6.4 269 */ 270 271 /** The minimum version of libisofs to be used with this version of libisoburn 272 at runtime. This is checked already in isoburn_initialize() which will 273 refuse on outdated version. So this call is for information purposes after 274 successful startup only. 275 @since 0.1.0 276 @param major isoburn_libisofs_req_major as seen at build time 277 @param minor as seen at build time 278 @param micro as seen at build time 279 @return 1 success, <=0 might in future become an error indication 280 */ 281 int isoburn_libisofs_req(int *major, int *minor, int *micro); 282 283 284 /** The minimum version of libjte to be used with this version of libisoburn 285 at runtime. The use of libjte is optional and depends on configure 286 tests. It can be prevented by ./configure option --disable-libjte . 287 This is checked already in isoburn_initialize() which will refuse on 288 outdated version. So this call is for information purposes after 289 successful startup only. 290 @since 0.6.4 291 */ 292 int isoburn_libjte_req(int *major, int *minor, int *micro); 293 294 295 /** The minimum version of libburn to be used with this version of libisoburn 296 at runtime. This is checked already in isoburn_initialize() which will 297 refuse on outdated version. So this call is for information purposes after 298 successful startup only. 299 @since 0.1.0 300 @param major isoburn_libburn_req_major as seen at build time 301 @param minor as seen at build time 302 @param micro as seen at build time 303 @return 1 success, <=0 might in future become an error indication 304 */ 305 int isoburn_libburn_req(int *major, int *minor, int *micro); 306 307 308 /** These three release version numbers tell the revision of this header file 309 and of the API it describes. They are memorized by applications at build 310 time. 311 @since 0.1.0 312 */ 313 #define isoburn_header_version_major 1 314 #define isoburn_header_version_minor 5 315 #define isoburn_header_version_micro 0 316 /** Note: 317 Above version numbers are also recorded in configure.ac because libtool 318 wants them as parameters at build time. 319 For the library compatibility check, ISOBURN_*_VERSION in configure.ac 320 are not decisive. Only the three numbers here do matter. 321 */ 322 /** Usage discussion: 323 324 Some developers of the libburnia project have differing 325 opinions how to ensure the compatibility of libaries 326 and applications. 327 328 It is about whether to use at compile time and at runtime 329 the version numbers isoburn_header_version_* provided here. 330 Thomas Schmitt advises to use them. 331 Vreixo Formoso advises to use other means. 332 333 At compile time: 334 335 Vreixo Formoso advises to leave proper version matching 336 to properly programmed checks in the the application's 337 build system, which will eventually refuse compilation. 338 339 Thomas Schmitt advises to use the macros defined here 340 for comparison with the application's requirements of 341 library revisions and to eventually break compilation. 342 343 Both advises are combinable. I.e. be master of your 344 build system and have #if checks in the source code 345 of your application, nevertheless. 346 347 At runtime (via *_is_compatible()): 348 349 Vreixo Formoso advises to compare the application's 350 requirements of library revisions with the runtime 351 library. This is to allow runtime libraries which are 352 young enough for the application but too old for 353 the lib*.h files seen at compile time. 354 355 Thomas Schmitt advises to compare the header 356 revisions defined here with the runtime library. 357 This is to enforce a strictly monotonous chain 358 of revisions from app to header to library, 359 at the cost of excluding some older libraries. 360 361 These two advises are mutually exclusive. 362 363 ----------------------------------------------------- 364 365 For an implementation of the Thomas Schmitt approach, 366 see libisoburn/burn_wrap.c : isoburn_initialize() 367 This connects libisoburn as "application" with libisofs 368 as "library". 369 370 The compatible part of Vreixo Formoso's approach is implemented 371 in configure.ac LIBBURN_REQUIRED, LIBISOFS_REQUIRED. 372 In isoburn_initialize() it would rather test by 373 iso_lib_is_compatible(isoburn_libisofs_req_major,... 374 than by 375 iso_lib_is_compatible(iso_lib_header_version_major,... 376 and would leave out the ugly compile time traps. 377 378 */ 379 380 381 /** Announce to the library an application provided method for immediate 382 delivery of messages. It is used when no drive is affected directly or 383 if the drive has no own msgs_submit() method attached by 384 isoburn_drive_set_msgs_submit. 385 If no method is preset or if the method is set to NULL then libisoburn 386 delivers its messages through the message queue of libburn. 387 @param msgs_submit The function call which implements the method 388 @param submit_handle Handle to be used as first argument of msgs_submit 389 @param submit_flag Flag to be used as last argument of msgs_submit 390 @param flag Unused yet, submit 0 391 @since 0.2.0 392 */ 393 int isoburn_set_msgs_submit(int (*msgs_submit)(void *handle, int error_code, 394 char msg_text[], int os_errno, 395 char severity[], int flag), 396 void *submit_handle, int submit_flag, int flag); 397 398 399 /** Acquire a target drive by its filesystem path or libburn persistent 400 address. 401 Wrapper for: burn_drive_scan_and_grab() 402 @since 0.1.0 403 @param drive_infos On success returns a one element array with the drive 404 (cdrom/burner). Thus use with driveno 0 only. On failure 405 the array has no valid elements at all. 406 The returned array should be freed via burn_drive_info_free() 407 when the drive is no longer needed. But before this is done 408 one has to call isoburn_drive_release(drive_infos[0].drive). 409 @param adr The persistent address of the desired drive or the path 410 to a file object. 411 @param load 1 attempt to load the disc tray. 0 no attempt,rather failure. 412 @return 1 = success , 0 = drive not found , <0 = other error 413 */ 414 int isoburn_drive_scan_and_grab(struct burn_drive_info *drive_infos[], 415 char* adr, int load); 416 417 418 /** Acquire a target drive by its filesystem path or libburn persistent 419 address. This is a modern successor of isoburn_drive_scan_and_grab(). 420 Wrapper for: burn_drive_scan_and_grab() 421 @since 0.1.2 422 @param drive_infos On success returns a one element array with the drive 423 (cdrom/burner). Thus use with driveno 0 only. On failure 424 the array has no valid elements at all. 425 The returned array should be freed via burn_drive_info_free() 426 when the drive is no longer needed. But before this is done 427 one has to call isoburn_drive_release(drive_infos[0].drive). 428 @param adr The persistent address of the desired drive or the path 429 to a file object. 430 @param flag bit0= attempt to load the disc tray. 431 Else: failure if not loaded. 432 bit1= regard overwriteable media as blank 433 bit2= if the drive is a regular disk file: 434 truncate it to the write start address when writing 435 begins 436 bit3= if the drive reports a read-only profile try to read 437 table of content by scanning for ISO image headers. 438 (depending on media type and drive this might 439 help or it might make the resulting toc even worse) 440 bit4= do not emulate table of content on overwriteable media 441 bit5= ignore ACL from external filesystems 442 bit6= ignore POSIX Extended Attributes from external 443 filesystems (xattr) 444 bit7= pretend read-only profile and scan for table of content 445 bit8= re-assess already acquired (*drive_infos)[0] rather 446 than acquiring adr 447 @since 1.1.8 448 bit9= when scanning for ISO 9660 sessions by bit3: 449 Do not demand a valid superblock at LBA 0, ignore it in 450 favor of one at LBA 32, and scan until end of medium. 451 @since 1.2.6 452 bit10= if not bit6: accept all xattr namespaces from external 453 filesystems, not only "user.". 454 @since 1.5.0 455 @return 1 = success , 0 = drive not found , <0 = other error 456 457 Please excuse the typo "aquire" in the function name. 458 */ 459 int isoburn_drive_aquire(struct burn_drive_info *drive_infos[], 460 char* adr, int flag); 461 462 /** Acquire a drive from the burn_drive_info[] array which was obtained by 463 a previous call of burn_drive_scan(). 464 Wrapper for: burn_drive_grab() 465 @since 0.1.0 466 @param drive The drive to grab. E.g. drive_infos[1].drive . 467 Call isoburn_drive_release(drive) when it it no longer needed. 468 @param load 1 attempt to load the disc tray. 0 no attempt, rather failure. 469 @return 1 success, <=0 failure 470 */ 471 int isoburn_drive_grab(struct burn_drive *drive, int load); 472 473 474 /** Attach to a drive an application provided method for immediate 475 delivery of messages. 476 If no method is set or if the method is set to NULL then libisoburn 477 delivers messages of the drive through the global msgs_submit() method 478 set by isoburn_set_msgs_submiti() or by the message queue of libburn. 479 @since 0.2.0 480 @param d The drive to which this function, handle and flag shall apply 481 @param msgs_submit The function call which implements the method 482 @param submit_handle Handle to be used as first argument of msgs_submit 483 @param submit_flag Flag to be used as last argument of msgs_submit 484 @param flag Unused yet, submit 0 485 */ 486 int isoburn_drive_set_msgs_submit(struct burn_drive *d, 487 int (*msgs_submit)(void *handle, int error_code, 488 char msg_text[], int os_errno, 489 char severity[], int flag), 490 void *submit_handle, int submit_flag, int flag); 491 492 493 /** Inquire the medium status. Expect the whole spectrum of libburn BURN_DISC_* 494 with multi-session media. Emulated states with random access media are 495 BURN_DISC_BLANK and BURN_DISC_APPENDABLE. 496 Wrapper for: burn_disc_get_status() 497 @since 0.1.0 498 @param drive The drive to inquire. 499 @return The status of the drive, or what kind of disc is in it. 500 Note: BURN_DISC_UNGRABBED indicates wrong API usage 501 */ 502 #ifdef __cplusplus 503 enum burn::burn_disc_status isoburn_disc_get_status(struct burn_drive *drive); 504 #else 505 enum burn_disc_status isoburn_disc_get_status(struct burn_drive *drive); 506 #endif 507 508 509 /** Sets the medium status to BURN_DISC_FULL unconditionally. 510 @since 1.3.8 511 @param drive The drive with the medium to be handled as if it was closed. 512 @ 513 */ 514 int isoburn_disc_pretend_full_uncond(struct burn_drive *drive); 515 516 517 /** Tells whether the medium can be treated by isoburn_disc_erase(). 518 Wrapper for: burn_disc_erasable() 519 @since 0.1.0 520 @param d The drive to inquire. 521 @return 0=not erasable , else erasable 522 */ 523 int isoburn_disc_erasable(struct burn_drive *d); 524 525 526 /** Mark the medium as blank. With multi-session media this will call 527 burn_disc_erase(). With random access media, an eventual ISO-9660 528 filesystem will get invalidated by altering its start blocks on the medium. 529 In case of success, the medium is in status BURN_DISC_BLANK afterwards. 530 Wrapper for: burn_disc_erase() 531 @since 0.1.0 532 @param drive The drive with the medium to erase. 533 @param fast 1=fast erase, 0=thorough erase 534 With DVD-RW, fast erase yields media incapable of multi-session. 535 */ 536 void isoburn_disc_erase(struct burn_drive *drive, int fast); 537 538 539 /** Set up isoburn_disc_get_msc1() to return a fabricated value. 540 This makes only sense between acquiring the drive and reading the 541 image. After isoburn_read_image() it will confuse the coordination 542 of libisoburn and libisofs. 543 Note: Sessions and tracks are counted beginning with 1, not with 0. 544 @since 0.1.6 545 @param d The drive where msc1 is to be set 546 @param adr_mode Determines how to interpret adr_value and to set msc1. 547 If adr_value shall represent a number then decimal ASCII 548 digits are expected. 549 0= start lba of last session in TOC, ignore adr_value 550 1= start lba of session number given by adr_value 551 2= start lba of track given number by adr_value 552 3= adr_value itself is the lba to be used 553 4= start lba of last session with volume id 554 given by adr_value 555 @param adr_value A string describing the value to be eventually used. 556 @param flag Bitfield for control purposes. 557 bit0= @since 0.2.2 558 with adr_mode 3: adr_value might be 16 blocks too high 559 (e.g. -C stemming from growisofs). Probe for ISO head 560 at adr_value-16 and eventually adjust setting. 561 bit1= insist in seeing a disc object with at least one session 562 bit2= with adr_mode 4: use adr_value as regular expression 563 */ 564 int isoburn_set_msc1(struct burn_drive *d, int adr_mode, char *adr_value, 565 int flag); 566 567 568 /* ----------------------------------------------------------------------- */ 569 /* 570 571 Wrappers for emulation of TOC on overwriteable media 572 573 Media which match the overwriteable usage model lack of a history of sessions 574 and tracks. libburn will not even hand out a burn_disc object for them and 575 always declare them blank. libisoburn checks for a valid ISO filesystem 576 header at LBA 0 and eventually declares them appendable. 577 Nevertheless one can only determine an upper limit of the size of the overall 578 image (by isoburn_get_min_start_byte()) but not a list of stored sessions 579 and their LBAs, as it is possible with true multi-session media. 580 581 The following wrappers add the capability to obtain a session and track TOC 582 from emulated multi-session images on overwriteables if the first session 583 was written by libisoburn-0.1.6 or later (i.e. with a header copy at LBA 32). 584 585 Be aware that the structs emitted by these isoburn calls are not compatible 586 with the libburn structs. I.e. you may use them only with isoburn_toc_* 587 calls. 588 isoburn_toc_disc needs to be freed after use. isoburn_toc_session and 589 isoburn_toc_track vanish together with their isoburn_toc_disc. 590 */ 591 592 /* Opaque handles to media, session, track */ 593 struct isoburn_toc_disc; 594 struct isoburn_toc_session; 595 struct isoburn_toc_track; 596 597 598 /** Obtain a master handle for the table of content. 599 This handle governs allocated resources which have to be released by 600 isoburn_toc_disc_free() when no longer needed. 601 Wrapper for: burn_drive_get_disc() 602 @since 0.1.6 603 @param d The drive with the medium to inspect 604 @return NULL in case there is no content info, else it is a valid handle 605 */ 606 struct isoburn_toc_disc *isoburn_toc_drive_get_disc(struct burn_drive *d); 607 608 609 /** Tell the number of 2048 byte blocks covered by the table of content. 610 This number includes the eventual gaps between sessions and tracks. 611 So this call is not really a wrapper for burn_disc_get_sectors(). 612 @since 0.1.6 613 @param disc The master handle of the medium 614 @return Number of blocks, <=0 indicates unknown or unreadable state 615 */ 616 int isoburn_toc_disc_get_sectors(struct isoburn_toc_disc *disc); 617 618 619 /** Get the array of session handles and the number of complete sessions 620 from the table of content. 621 The result array contains *num + isoburn_toc_disc_get_incmpl_sess() 622 elements. All above *num are incomplete sessions. 623 Typically there is at most one incomplete session with no track. 624 Wrapper for: burn_disc_get_sessions() 625 @since 0.1.6 626 @param disc The master handle of the medium 627 @param num returns the number of sessions in the array 628 @return the address of the array of session handles 629 */ 630 struct isoburn_toc_session **isoburn_toc_disc_get_sessions( 631 struct isoburn_toc_disc *disc, int *num); 632 633 634 /** Obtain the number of incomplete sessions which are recorded in the 635 result array of isoburn_toc_disc_get_sessions() after the complete 636 sessions. See above. 637 @since 1.2.8 638 @param disc The master handle of the medium 639 @return the number of incomplete sessions 640 */ 641 int isoburn_toc_disc_get_incmpl_sess(struct isoburn_toc_disc *disc); 642 643 644 /** Tell the number of 2048 byte blocks covered by a particular session. 645 Wrapper for: burn_session_get_sectors() 646 @since 0.1.6 647 @param s The session handle 648 @return number of blocks, <=0 indicates unknown or unreadable state 649 */ 650 int isoburn_toc_session_get_sectors(struct isoburn_toc_session *s); 651 652 653 /** Obtain a copy of the entry which describes the end of a particular session. 654 Wrapper for: burn_session_get_leadout_entry() 655 @since 0.1.6 656 @param s The session handle 657 @param entry A pointer to memory provided by the caller. It will be filled 658 with info according to struct burn_toc_entry as defined 659 in libburn.h 660 */ 661 void isoburn_toc_session_get_leadout_entry(struct isoburn_toc_session *s, 662 struct burn_toc_entry *entry); 663 664 665 /** Get the array of track handles from a particular session. 666 Wrapper for: burn_session_get_tracks() 667 @since 0.1.6 668 @param s The session handle 669 @param num returns the number of tracks in the array 670 @return the address of the array of track handles, 671 NULL if no tracks are registered with session s 672 */ 673 struct isoburn_toc_track **isoburn_toc_session_get_tracks( 674 struct isoburn_toc_session *s, int *num); 675 676 677 /** Obtain a copy of the entry which describes a particular track. 678 Wrapper for: burn_track_get_entry() 679 @since 0.1.6 680 @param t The track handle 681 @param entry A pointer to memory provided by the caller. It will be filled 682 with info according to struct burn_toc_entry as defined 683 in libburn.h 684 */ 685 void isoburn_toc_track_get_entry(struct isoburn_toc_track *t, 686 struct burn_toc_entry *entry); 687 688 689 /** Obtain eventual ISO image parameters of an emulated track. This info was 690 gained with much effort and thus gets cached in the track object. 691 If this call returns 1 then one can save a call of isoburn_read_iso_head() 692 with return mode 1 which could cause an expensive read operation. 693 @since 0.4.0 694 @param t The track handle 695 @param start_lba Returns the start address of the ISO session 696 @param image_blocks Returns the number of 2048 bytes blocks 697 @param volid Caller provided memory for the volume id 698 @param flag unused yet, submit 0 699 @return 0= not an emulated ISO session , 1= reply is valid 700 */ 701 int isoburn_toc_track_get_emul(struct isoburn_toc_track *t, int *start_lba, 702 int *image_blocks, char volid[33], int flag); 703 704 705 706 /** Release the memory associated with a master handle of a medium. 707 The handle is invalid afterwards and may not be used any more. 708 Wrapper for: burn_disc_free() 709 @since 0.1.6 710 @param disc The master handle of the medium 711 */ 712 void isoburn_toc_disc_free(struct isoburn_toc_disc *disc); 713 714 715 /** Try whether the data at the given address look like a ISO 9660 716 image header and obtain its alleged size. Depending on the info mode 717 one other string of text information can be retrieved too. 718 @since 0.1.6 719 @param d The drive with the medium to inspect 720 @param lba The block number from where to read 721 @param image_blocks Returns the number of 2048 bytes blocks in the session 722 @param info Caller provided memory, enough to take eventual info reply 723 @param flag bit0-7: info return mode 724 0= do not return anything in info (do not even touch it) 725 1= copy volume id to info (info needs 33 bytes) 726 2= @since 0.2.2 : 727 copy 64 kB header to info (needs 65536 bytes) 728 bit13= @since 0.2.2: 729 Do not read head from medium but use first 64 kB from 730 info. 731 In this case it is permissible to submit d == NULL. 732 bit14= check both half buffers (not only second) 733 return 2 if found in first block 734 bit15= return -1 on read error 735 @return >0 seems to be a valid ISO image, 0 format not recognized, <0 error 736 */ 737 int isoburn_read_iso_head(struct burn_drive *d, int lba, 738 int *image_blocks, char *info, int flag); 739 740 741 /** Try to convert the given entity address into various entity addresses 742 which would describe it. 743 Note: Sessions and tracks are counted beginning with 1, not with 0. 744 @since 0.3.2 745 @param d The drive where msc1 is to be set 746 @param adr_mode Determines how to interpret the input adr_value. 747 If adr_value shall represent a number then decimal ASCII 748 digits are expected. 749 0= start lba of last session in TOC, ignore adr_value 750 1= start lba of session number given by adr_value 751 2= start lba of track given number by adr_value 752 3= adr_value itself is the lba to be used 753 4= start lba of last session with volume id 754 given by adr_value 755 @param adr_value A string describing the value to be eventually used. 756 @param lba returns the block address of the entity, -1 means invalid 757 @param track returns the track number of the entity, -1 means invalid 758 @param session returns the session number of the entity, -1 means invalid 759 @param volid returns the volume id of the entity if it is a ISO session 760 @param flag Bitfield for control purposes. 761 bit2= with adr_mode 4: use adr_value as regular expression 762 @return <=0 error , 1 ok, ISO session, 2 ok, not an ISO session 763 */ 764 int isoburn_get_mount_params(struct burn_drive *d, 765 int adr_mode, char *adr_value, 766 int *lba, int *track, int *session, 767 char volid[33], int flag); 768 769 770 /* ----------------------------------------------------------------------- */ 771 /* 772 773 Options for image reading. 774 775 An application shall create an option set object by isoburn_ropt_new(), 776 program it by isoburn_ropt_set_*(), use it with isoburn_read_image(), 777 and finally delete it by isoburn_ropt_destroy(). 778 779 */ 780 /* ----------------------------------------------------------------------- */ 781 782 struct isoburn_read_opts; 783 784 /** Produces a set of image read options, initialized with default values. 785 @since 0.1.0 786 @param o the newly created option set object 787 @param flag Bitfield for control purposes. Submit 0 for now. 788 @return 1=ok , <0 = failure 789 */ 790 int isoburn_ropt_new(struct isoburn_read_opts **o, int flag); 791 792 793 /** Deletes an option set which was created by isoburn_ropt_new(). 794 @since 0.1.0 795 @param o The option set to work on 796 @param flag Bitfield for control purposes. Submit 0 for now. 797 @return 1= **o destroyed , 0= *o was already NULL (harmless) 798 */ 799 int isoburn_ropt_destroy(struct isoburn_read_opts **o, int flag); 800 801 /** Sets the size and granularity of the cache which libisoburn provides to 802 libisofs for reading of ISO image data. This cache consists of several 803 tiles which are buffers of a given size. The ISO image is divided into 804 virtual tiles of that size. A cache tile may hold an in-memory copy 805 of such a virtual image tile. 806 When libisofs requests to read a block, then first the cache is inquired 807 whether it holds that block. If not, then the block is read via libburn 808 together with its neighbors in their virtual image tile into a free 809 cache tile. If no cache tile is free, then the one will be re-used which 810 has the longest time of not being hit by a read attempt. 811 812 A larger cache might speed up image loading by reducing the number of 813 libburn read calls on the directory tree. It might also help with 814 reading the content of many small files, if for some reason it is not an 815 option to sort access by LBA. 816 Caching will not provide much benefit with libburn "stdio:" drives, 817 because the operating system is supposed to provide the same speed-up 818 in a more flexible way. 819 820 @since 1.2.2 821 @param o The option set to work on. 822 It is permissible to submit NULL in order to just 823 have the parameters tested. 824 @param cache_tiles Number of tiles in the cache. Not less than 1. 825 Default is 32. 826 @param tile_blocks Number of blocks per tile. Must be a power of 2. 827 Default is 32. 828 cache_tiles * tile_blocks * 2048 must not exceed 829 1073741824 (= 1 GiB). 830 @param flag Bitfield for control purposes. Unused yet. Submit 0. 831 @return <=0 error , >0 ok 832 */ 833 int isoburn_ropt_set_data_cache(struct isoburn_read_opts *o, 834 int cache_tiles, int tile_blocks, int flag); 835 836 /** Inquire the current settings of isoburn_set_data_cache(). 837 @since 1.2.2 838 @param o The option set to work on. 839 NULL has the same effect as flag bit0. 840 @param cache_tiles Will return the number of tiles in the cache. 841 @param tile_blocks Will return the number of blocks per tile. 842 @param set_flag Will return control bits. None are defined yet. 843 @param flag Bitfield for control purposes 844 bit0= return default values rather than current ones 845 @return <=0 error , >0 reply is valid 846 */ 847 int isoburn_ropt_get_data_cache(struct isoburn_read_opts *o, 848 int *cache_tiles, int *tile_blocks, 849 int *set_flag, int flag); 850 851 852 /** Which existing ISO 9660 extensions in the image to read or not to read. 853 Whether to read the content of an existing image at all. 854 The bits can be combined by | and inquired by &. 855 @since 0.1.0 856 @param ext Bitfield: 857 bit0= norock 858 Do not read Rock Ridge extensions 859 bit1= nojoliet 860 Do not read Joliet extensions 861 bit2= noiso1999 862 Do not read ISO 9660:1999 enhanced tree 863 bit3= preferjoliet 864 When both Joliet and RR extensions are present, the RR 865 tree is used. If you prefer using Joliet, set this to 1. 866 bit4= pretend_blank 867 Always create empty image.Ignore any image on input drive. 868 bit5= noaaip 869 @since 0.3.4 870 Do not load AAIP information from image. This information 871 eventually contains ACL or XFS-style Extended Attributes. 872 bit6= noacl 873 @since 0.3.4 874 Do not obtain ACL from external filesystem objects (e.g. 875 local filesystem files). 876 bit7= noea 877 @since 0.3.4 878 Do not obtain XFS-style Extended Attributes from external 879 filesystem objects (e.g. local filesystem files). 880 bit8= noino 881 @since 0.4.0 882 Do not load eventual inode numbers from RRIP entry PX, 883 but generate a new unique inode number for each imported 884 IsoNode object. 885 PX inode numbers mark families of hardlinks by giving all 886 family members the same inode number. libisofs keeps the 887 PX inode numbers unaltered when IsoNode objects get 888 written into an ISO image. 889 bit9= nomd5 890 @since 0.4.2 891 Do not load the eventual MD5 checksum array. 892 Do not check eventual session_md5 tags. 893 bit10= nomd5tag 894 @since 1.0.4 895 Do not check eventual session_md5 tags although bit9 896 is not set. 897 bit11= do_ecma119_map 898 @since 1.4.2 899 Set iso_read_opts_set_ecma119_map() to map_mode rather 900 than relying on the default setting of libisofs. 901 bit12 - bit13= map_mode 902 @since 1.4.2 903 How to convert file names if neither Rock Ridge nor 904 Joliet names are present and acceptable. 905 0 = unmapped: Take name as recorded in ECMA-119 directory 906 record (not suitable for writing them to 907 a new ISO filesystem) 908 1 = stripped: Like unmapped, but strip off trailing ";1" 909 or ".;1" 910 2 = uppercase: Like stripped, but map {a-z} to {A-Z} 911 3 = lowercase: Like stripped, but map {A-Z} to {a-z} 912 @return 1 success, <=0 failure 913 */ 914 #define isoburn_ropt_norock 1 915 #define isoburn_ropt_nojoliet 2 916 #define isoburn_ropt_noiso1999 4 917 #define isoburn_ropt_preferjoliet 8 918 #define isoburn_ropt_pretend_blank 16 919 #define isoburn_ropt_noaaip 32 920 #define isoburn_ropt_noacl 64 921 #define isoburn_ropt_noea 128 922 #define isoburn_ropt_noino 256 923 #define isoburn_ropt_nomd5 512 924 #define isoburn_ropt_nomd5tag 1024 925 #define isoburn_ropt_map_unmapped ( 2048 | 0 ) 926 #define isoburn_ropt_map_stripped ( 2048 | 4096 ) 927 #define isoburn_ropt_map_uppercase ( 2048 | 8192 ) 928 #define isoburn_ropt_map_lowercase ( 2048 | 12288 ) 929 930 int isoburn_ropt_set_extensions(struct isoburn_read_opts *o, int ext); 931 int isoburn_ropt_get_extensions(struct isoburn_read_opts *o, int *ext); 932 933 934 /** Default attributes to use if no RockRidge extension gets loaded. 935 @since 0.1.0 936 @param o The option set to work on 937 @param uid user id number (see /etc/passwd) 938 @param gid group id number (see /etc/group) 939 @param mode permissions (not file type) as of man 2 stat. 940 With directories, r-permissions will automatically imply 941 x-permissions. See isoburn_ropt_set_default_dirperms() below. 942 @return 1 success, <=0 failure 943 */ 944 int isoburn_ropt_set_default_perms(struct isoburn_read_opts *o, 945 uid_t uid, gid_t gid, mode_t mode); 946 int isoburn_ropt_get_default_perms(struct isoburn_read_opts *o, 947 uid_t *uid, gid_t *gid, mode_t *mode); 948 949 /** Default attributes to use on directories if no RockRidge extension 950 gets loaded. 951 Above call isoburn_ropt_set_default_perms() automatically adds 952 x-permissions to r-permissions for directories. This call here may 953 be done afterwards to set independend permissions for directories, 954 especially to override the automatically added x-permissions. 955 @since 0.1.0 956 @param o The option set to work on 957 @param mode permissions (not file type) as of man 2 stat. 958 @return 1 success, <=0 failure 959 */ 960 int isoburn_ropt_set_default_dirperms(struct isoburn_read_opts *o, 961 mode_t mode); 962 int isoburn_ropt_get_default_dirperms(struct isoburn_read_opts *o, 963 mode_t *mode); 964 965 966 /** Set the character set for reading RR file names from ISO images. 967 @since 0.1.0 968 @param o The option set to work on 969 @param input_charset Set this to NULL to use the default locale charset 970 For selecting a particular character set, submit its 971 name, e.g. as listed by program iconv -l. 972 Example: "UTF-8". 973 @return 1 success, <=0 failure 974 */ 975 int isoburn_ropt_set_input_charset(struct isoburn_read_opts *o, 976 char *input_charset); 977 int isoburn_ropt_get_input_charset(struct isoburn_read_opts *o, 978 char **input_charset); 979 980 981 /** 982 Enable or disable methods to automatically choose an input charset. 983 This eventually overrides the name set via isoburn_ropt_set_input_charset() 984 @since 0.3.8 985 @param o The option set to work on 986 @param mode Bitfield for control purposes: 987 bit0= set the input character set automatically from 988 attribute "isofs.cs" of root directory. 989 Submit any other bits with value 0. 990 @return 1 success, <=0 failure 991 */ 992 int isoburn_ropt_set_auto_incharset(struct isoburn_read_opts *o, int mode); 993 int isoburn_ropt_get_auto_incharset(struct isoburn_read_opts *o, int *mode); 994 995 996 /** Control an offset to be applied to all block address pointers in the ISO 997 image in order to compensate for an eventual displacement of the image 998 relative to the start block address for which it was produced. 999 E.g. if track number 2 from CD gets copied into a disk file and shall then 1000 be loaded as ISO filesystem, then the directory tree and all data file 1001 content of the track copy will become readable by setting the track start 1002 address as displacement and -1 as displacement_sign. 1003 Data file content outside the track will of course not be accessible and 1004 eventually produce read errors. 1005 @since 0.6.6 1006 @param o The option set to work on 1007 @param displacement 0 or a positive number 1008 @param displacement_sign Determines wether to add or subtract displacement 1009 to block addresses before applying them to the 1010 storage object for reading: 1011 +1 = add , -1= subtract , else keep unaltered 1012 */ 1013 int isoburn_ropt_set_displacement(struct isoburn_read_opts *o, 1014 uint32_t displacement, int displacement_sign); 1015 int isoburn_ropt_get_displacement(struct isoburn_read_opts *o, 1016 uint32_t *displacement, int *displacement_sign); 1017 1018 /* If you get here because of a compilation error like 1019 1020 /usr/include/libisoburn/libisoburn.h:895: error: 1021 expected declaration specifiers or '...' before 'uint32_t' 1022 1023 then see above paragraph "Application Constraints" about the definition 1024 of uint32_t. 1025 */ 1026 1027 /** Set the name truncation mode and the maximum name length for imported 1028 file objects. 1029 @since 1.4.2 1030 @param o The option set to work on 1031 @param mode 0= Do not truncate but throw error 1032 ISO_RR_NAME_TOO_LONG if a file name 1033 is longer than parameter length. 1034 1= Truncate to length and overwrite the last 1035 32 bytes of that length by the hex 1036 representation of ithe MD5 of the whole 1037 oversized name. 1038 Potential incomplete UTF-8 characters will 1039 get their leading bytes replaced by '_'. 1040 This is the default. 1041 @param length Maximum byte count of a file name. Permissible 1042 values are 64 to 255. Default is 255. 1043 1044 */ 1045 int isoburn_ropt_set_truncate_mode(struct isoburn_read_opts *o, 1046 int mode, int length); 1047 int isoburn_ropt_get_truncate_mode(struct isoburn_read_opts *o, 1048 int *mode, int *length); 1049 1050 1051 /** After calling function isoburn_read_image() there are informations 1052 available in the option set. 1053 This info can be obtained as bits in parameter has_what. Like: 1054 joliet_available = (has_what & isoburn_ropt_has_joliet); 1055 @since 0.1.0 1056 @param o The option set to work on 1057 @param size Number of image data blocks, 2048 bytes each. 1058 @param has_what Bitfield: 1059 bit0= has_rockridge 1060 RockRidge extension info is available (POSIX filesystem) 1061 bit1= has_joliet 1062 Joliet extension info is available (suitable for MS-Windows) 1063 bit2= has_iso1999 1064 ISO version 2 Enhanced Volume Descriptor is available. 1065 This is rather exotic. 1066 bit3= has_el_torito 1067 El-Torito boot record is present 1068 @return 1 success, <=0 failure 1069 */ 1070 #define isoburn_ropt_has_rockridge 1 1071 #define isoburn_ropt_has_joliet 2 1072 #define isoburn_ropt_has_iso1999 4 1073 #define isoburn_ropt_has_el_torito 8 1074 1075 int isoburn_ropt_get_size_what(struct isoburn_read_opts *o, 1076 uint32_t *size, int *has_what); 1077 1078 /* ts A90122 */ 1079 /* >>> to be implemented: 1080 #define isoburn_ropt_has_acl 64 1081 #define isoburn_ropt_has_ea 128 1082 */ 1083 1084 1085 1086 /* ----------------------------------------------------------------------- */ 1087 /* End of Options for image reading */ 1088 /* ----------------------------------------------------------------------- */ 1089 1090 /* ----------------------------------------------------------------------- */ 1091 /* 1092 1093 Options for image generation by libisofs and image transport to libburn. 1094 1095 An application shall create an option set by isoburn_igopt_new(), 1096 program it by isoburn_igopt_set_*(), use it with either 1097 isoburn_prepare_new_image() or isoburn_prepare_disc(), and finally delete 1098 it by isoburn_igopt_destroy(). 1099 1100 */ 1101 /* ----------------------------------------------------------------------- */ 1102 1103 struct isoburn_imgen_opts; 1104 1105 /** Produces a set of generation and transfer options, initialized with default 1106 values. 1107 @since 0.1.0 1108 @param o the newly created option set object 1109 @param flag Bitfield for control purposes. Submit 0 for now. 1110 @return 1=ok , <0 = failure 1111 */ 1112 int isoburn_igopt_new(struct isoburn_imgen_opts **o, int flag); 1113 1114 1115 /** Deletes an option set which was created by isoburn_igopt_new(). 1116 @since 0.1.0 1117 @param o The option set to give up 1118 @param flag Bitfield for control purposes. Submit 0 for now. 1119 @return 1= **o destroyed , 0= *o was already NULL (harmless) 1120 */ 1121 int isoburn_igopt_destroy(struct isoburn_imgen_opts **o, int flag); 1122 1123 1124 /** ISO level to write at. 1125 @since 0.1.0 1126 @param o The option set to work on 1127 @param level is a term of the ISO 9660 standard. It should be one of: 1128 1= filenames restricted to form 8.3 1129 2= filenames allowed up to 31 characters 1130 3= file content may be larger than 4 GB - 1. 1131 @return 1 success, <=0 failure 1132 */ 1133 int isoburn_igopt_set_level(struct isoburn_imgen_opts *o, int level); 1134 int isoburn_igopt_get_level(struct isoburn_imgen_opts *o, int *level); 1135 1136 1137 /** Which extensions to support. 1138 @since 0.1.0 1139 @param o The option set to work on 1140 @param ext Bitfield: 1141 bit0= rockridge 1142 Rock Ridge extensions add POSIX file attributes like 1143 owner, group, access permissions, long filenames. Very 1144 advisable if the designed audience has Unix style systems. 1145 bit1= joliet 1146 Longer filenames for Windows systems. 1147 Weaker than RockRidge, but also readable with GNU/Linux. 1148 bit2= iso1999 1149 This is rather exotic. Better do not surprise the readers. 1150 bit3= hardlinks 1151 Enable hardlink consolidation. IsoNodes which refer to the 1152 same source object and have the same properties will get 1153 the same ISO image inode numbers. 1154 If combined with isoburn_igopt_rrip_version_1_10 below, 1155 then the PX entry layout of RRIP-1.12 will be used within 1156 RRIP-1.10 (mkisofs does this without causing visible trouble). 1157 bit5= aaip 1158 The libisofs specific SUSP based extension of ECMA-119 which 1159 can encode ACL and XFS-style Extended Attributes. 1160 bit6= session_md5 1161 @since 0.4.2 1162 Produce and write MD5 checksum tags of superblock, directory 1163 tree, and the whole session stream. 1164 bit7= file_md5 1165 @since 0.4.2 1166 Produce and write MD5 checksums for each single IsoFile. 1167 bit8= file_stability (only together with file_md5) 1168 @since 0.4.2 1169 Compute MD5 of each file before copying it into the image and 1170 compare this with the MD5 of the actual copying. If they do 1171 not match then issue MISHAP event. 1172 See also libisofs.h iso_write_opts_set_record_md5() 1173 bit9= no_emul_toc 1174 @since 0.5.8 1175 On overwriteable media or random access files do not write 1176 the first session to LBA 32 and do not copy the first 64kB 1177 of the first session to LBA 0, but rather write the first 1178 session to LBA 0 directly. 1179 bit10= will_cancel 1180 @since 0.6.6 1181 Announce to libisofs that only the image size is desired 1182 and that the write thread will be cancelled by 1183 isoburn_cancel_prepared_write() before actual image writing 1184 occurs. Without this, cancellation can cause a MISHAP event. 1185 bit11= old_empty 1186 @since 1.0.2 1187 Let symbolic links and device files point to block 0, and let 1188 empty data files point to the address of the Volume Descriptor 1189 Set Terminator. This was done by libisofs in the past. 1190 By default there is now a single dedicated block of zero bytes 1191 after the end of the directory trees, of which the address 1192 is used for all files without own content. 1193 bit12= hfsplus 1194 @since 1.2.4 1195 Produce a HFS+ partition inside the ISO image and announce it 1196 by an Apple Partition Map in the System Area. 1197 >>> GPT production ? 1198 Caution: Interferes with isoburn_igopt_set_system_area() by 1199 overwriting the first 8 bytes of the data, and 1200 several blocks of 2 KiB after the first one. 1201 bit13= fat 1202 @since 1.2.4 1203 >>> Not yet implemented. Planned to co-exist with hfsplus. 1204 Produce a FAT32 partition inside the ISO image and announce it 1205 by an MBR partition entry in the System Area. 1206 Caution: Interferes with isoburn_igopt_set_system_area() by 1207 >>> what impact ? 1208 1209 @return 1 success, <=0 failure 1210 */ 1211 #define isoburn_igopt_rockridge 1 1212 #define isoburn_igopt_joliet 2 1213 #define isoburn_igopt_iso1999 4 1214 #define isoburn_igopt_hardlinks 8 1215 #define isoburn_igopt_aaip 32 1216 #define isoburn_igopt_session_md5 64 1217 #define isoburn_igopt_file_md5 128 1218 #define isoburn_igopt_file_stability 256 1219 #define isoburn_igopt_no_emul_toc 512 1220 #define isoburn_igopt_will_cancel 1024 1221 #define isoburn_igopt_old_empty 2048 1222 #define isoburn_igopt_hfsplus 4096 1223 #define isoburn_igopt_fat 8192 1224 int isoburn_igopt_set_extensions(struct isoburn_imgen_opts *o, int ext); 1225 int isoburn_igopt_get_extensions(struct isoburn_imgen_opts *o, int *ext); 1226 1227 /** Relaxed constraints. Setting any of the bits to 1 break the specifications, 1228 but it is supposed to work on most moderns systems. Use with caution. 1229 @since 0.1.0 1230 @param o The option set to work on 1231 @param relax Bitfield: 1232 bit0= omit_version_numbers 1233 Omit the version number (";1") at the end of the 1234 ISO-9660 and Joliet identifiers. 1235 Version numbers are usually not used by readers. 1236 bit1= allow_deep_paths 1237 Allow ISO-9660 directory hierarchy to be deeper 1238 than 8 levels. 1239 bit2= allow_longer_paths 1240 Allow path in the ISO-9660 tree to have more than 1241 255 characters. 1242 bit3= max_37_char_filenames 1243 Allow a single file or directory hierarchy to have 1244 up to 37 characters. This is larger than the 31 1245 characters allowed by ISO level 2, and the extra space 1246 is taken from the version number, so this also forces 1247 omit_version_numbers. 1248 bit4= no_force_dots 1249 ISO-9660 forces filenames to have a ".", that separates 1250 file name from extension. libisofs adds it if original 1251 filename has none. Set this to 1 to prevent this 1252 behavior. 1253 bit5= allow_lowercase 1254 Allow lowercase characters in ISO-9660 filenames. 1255 By default, only uppercase characters, numbers and 1256 a few other characters are allowed. 1257 bit6= allow_full_ascii 1258 Allow all ASCII characters to be appear on an ISO-9660 1259 filename. Note that "/" and "\0" characters are never 1260 allowed, even in RR names. 1261 bit7= joliet_longer_paths 1262 Allow paths in the Joliet tree to have more than 1263 240 characters. 1264 bit8= always_gmt 1265 Write timestamps as GMT although the specs prescribe local 1266 time with eventual non-zero timezone offset. Negative 1267 timezones (west of GMT) can trigger bugs in some operating 1268 systems which typically appear in mounted ISO images as if 1269 the timezone shift from GMT was applied twice 1270 (e.g. in New York 22:36 becomes 17:36). 1271 bit9= rrip_version_1_10 1272 Write Rock Ridge info as of specification RRIP-1.10 rather 1273 than RRIP-1.12: signature "RRIP_1991A" rather than 1274 "IEEE_1282", field PX without file serial number. 1275 bit10= dir_rec_mtime 1276 Store as ECMA-119 Directory Record timestamp the mtime 1277 of the source rather than the image creation time. 1278 bit11= aaip_susp_1_10 1279 Write AAIP fields without announcing AAIP by an ER field and 1280 without distinguishing RRIP fields from the AAIP field by 1281 prefixed ES fields. This saves 5 to 10 bytes per file and 1282 might avoid problems with readers which only accept RRIP. 1283 SUSP-1.10 allows it, SUSP-1.12 frowns on it. 1284 bit12= only_iso_numbers 1285 Same as bit1 omit_version_number but restricted to the names 1286 in the eventual Joliet tree. 1287 @since 0.5.4 1288 For reasons of backward compatibility it is not possible yet 1289 to disable version numbers for ISO 9660 while enabling them 1290 for Joliet. 1291 bit13= no_j_force_dots 1292 Same as no_force_dots but affecting the names in the eventual 1293 Joliet tree rather than the ISO 9660 / ECMA-119 names. 1294 @since 0.5.4 1295 Previous versions added dots to Joliet names unconditionally. 1296 bit14= allow_dir_id_ext 1297 Convert directory names for ECMA-119 similar to other file 1298 names, but do not force a dot or add a version number. 1299 This violates ECMA-119 by allowing one "." and especially 1300 ISO level 1 by allowing DOS style 8.3 names rather than 1301 only 8 characters. 1302 (mkisofs and its clones obviously do this violation.) 1303 @since 1.0.0 1304 bit15= joliet_long_names 1305 Allow for Joliet leaf names up to 103 characters rather than 1306 up to 64. 1307 @since 1.0.6 1308 bit16= joliet_rec_mtime 1309 Like dir_rec_mtime, but for the Joliet tree. 1310 @since 1.2.0 1311 bit17= iso1999_rec_mtime 1312 Like dir_rec_mtime, but for the ISO 9660:1999 tree. 1313 @since 1.2.0 1314 bit18= allow_7bit_ascii 1315 Like allow_full_ascii, but only allowing 7-bit characters. 1316 Lowercase letters get mapped to uppercase if not 1317 allow_lowercase is set. 1318 Gets overridden if allow_full_ascii is enabled. 1319 bit19= joliet_utf16 1320 Encode Joliet names by character set UTF-16BE rather than 1321 UCS-2. The difference is with characters which are not present 1322 in UCS-2 and get encoded in UTF-16 by 2 words of 16 bit each. 1323 Both words then stem from a reserved subset of UCS-2. 1324 @since 1.3.6 1325 @return 1 success, <=0 failure 1326 */ 1327 #define isoburn_igopt_omit_version_numbers 1 1328 #define isoburn_igopt_allow_deep_paths 2 1329 #define isoburn_igopt_allow_longer_paths 4 1330 #define isoburn_igopt_max_37_char_filenames 8 1331 #define isoburn_igopt_no_force_dots 16 1332 #define isoburn_igopt_allow_lowercase 32 1333 #define isoburn_igopt_allow_full_ascii 64 1334 #define isoburn_igopt_joliet_longer_paths 128 1335 #define isoburn_igopt_always_gmt 256 1336 #define isoburn_igopt_rrip_version_1_10 512 1337 #define isoburn_igopt_dir_rec_mtime 1024 1338 #define isoburn_igopt_aaip_susp_1_10 2048 1339 #define isoburn_igopt_only_iso_versions 4096 1340 #define isoburn_igopt_no_j_force_dots 8192 1341 #define isoburn_igopt_allow_dir_id_ext 16384 1342 #define isoburn_igopt_joliet_long_names 32768 1343 #define isoburn_igopt_joliet_rec_mtime 0x10000 1344 #define isoburn_igopt_iso1999_rec_mtime 0x20000 1345 #define isoburn_igopt_allow_7bit_ascii 0x40000 1346 #define isoburn_igopt_joliet_utf16 0x80000 1347 int isoburn_igopt_set_relaxed(struct isoburn_imgen_opts *o, int relax); 1348 int isoburn_igopt_get_relaxed(struct isoburn_imgen_opts *o, int *relax); 1349 1350 1351 /** If not isoburn_igopt_allow_deep_paths is in effect, then it may become 1352 necessary to relocate directories so that no ECMA-119 file path 1353 has more than 8 components. These directories are grafted into either 1354 the root directory of the ISO image or into a dedicated relocation 1355 directory. For details see libisofs.h. 1356 Wrapper for: iso_write_opts_set_rr_reloc() 1357 @since 1.2.2 1358 @param o The option set to work on 1359 @param name The name of the relocation directory in the root directory. 1360 Do not prepend "/". An empty name or NULL will direct 1361 relocated directories into the root directory. This is the 1362 default. 1363 If the given name does not exist in the root directory when 1364 isoburn_disc_write() is called, and if there are directories 1365 at path level 8, then directory /name will be created 1366 automatically. 1367 @param flags Bitfield for control purposes. 1368 bit0= Mark the relocation directory by a Rock Ridge RE entry, 1369 if it gets created during isoburn_disc_write(). This 1370 will make it invisible for most Rock Ridge readers. 1371 bit1= not settable via API (used internally) 1372 @return > 0 success, <= 0 failure 1373 */ 1374 int isoburn_igopt_set_rr_reloc(struct isoburn_imgen_opts *o, char *name, 1375 int flags); 1376 1377 /** Obtain the settings of isoburn_igopt_set_rr_reloc(). 1378 @since 1.2.2 1379 @param o The option set to work on 1380 @param name Will return NULL or a pointer to the name of the relocation 1381 directory in the root directory. Do not alter or dispose the 1382 memory which holds this name. 1383 @param flags Will return the flags bitfield. 1384 @return > 0 success, <= 0 failure 1385 */ 1386 int isoburn_igopt_get_rr_reloc(struct isoburn_imgen_opts *o, char **name, 1387 int *flags); 1388 1389 1390 /** Caution: This option breaks any assumptions about names that 1391 are supported by ECMA-119 specifications. 1392 Try to omit any translation which would make a file name compliant to the 1393 ECMA-119 rules. This includes and exceeds omit_version_numbers, 1394 max_37_char_filenames, no_force_dots bit0, allow_full_ascii. Further it 1395 prevents the conversion from local character set to ASCII. 1396 The maximum name length is given by this call. If a filename exceeds 1397 this length or cannot be recorded untranslated for other reasons, then 1398 image production gets aborted. 1399 Currently the length limit is 96 characters, because an ECMA-119 directory 1400 record may at most have 254 bytes and up to 158 other bytes must fit into 1401 the record. Probably 96 more bytes can be made free for the name in future. 1402 @since 1.0.0 1403 @param o The option set to work on 1404 @param len 0 = disable this feature and perform name translation 1405 according to other settings. 1406 >0 = Omit any translation. Eventually abort image production 1407 if a name is longer than the given value. 1408 -1 = Like >0. Allow maximum possible length. 1409 isoburn_igopt_get_untranslated_name_len() will tell the 1410 effectively resulting value. 1411 @return >0 success, <=0 failure 1412 */ 1413 int isoburn_igopt_set_untranslated_name_len(struct isoburn_imgen_opts *o, 1414 int len); 1415 int isoburn_igopt_get_untranslated_name_len(struct isoburn_imgen_opts *o, 1416 int *len); 1417 1418 1419 /** Whether and how files should be sorted. 1420 @since 0.1.0 1421 @param o The option set to work on 1422 @param value Bitfield: bit0= sort_files_by_weight 1423 files should be sorted based on their weight. 1424 Weight is attributed to files in the image 1425 by libisofs call iso_node_set_sort_weight(). 1426 @return 1 success, <=0 failure 1427 */ 1428 #define isoburn_igopt_sort_files_by_weight 1 1429 int isoburn_igopt_set_sort_files(struct isoburn_imgen_opts *o, int value); 1430 int isoburn_igopt_get_sort_files(struct isoburn_imgen_opts *o, int *value); 1431 1432 1433 /** Set the override values for files and directory permissions. 1434 The parameters replace_* these take one of three values: 0, 1 or 2. 1435 If 0, the corresponding attribute will be kept as set in the IsoNode 1436 at the time of image generation. 1437 If set to 1, the corresponding attrib. will be changed by a default 1438 suitable value. 1439 With value 2, the attrib. will be changed with the value specified 1440 in the corresponding *_mode options. Note that only the permissions 1441 are set, the file type remains unchanged. 1442 @since 0.1.0 1443 @param o The option set to work on 1444 @param replace_dir_mode whether and how to override directories 1445 @param replace_file_mode whether and how to override files of other type 1446 @param dir_mode Mode to use on dirs with replace_dir_mode == 2. 1447 @param file_mode; Mode to use on files with replace_file_mode == 2. 1448 @return 1 success, <=0 failure 1449 */ 1450 int isoburn_igopt_set_over_mode(struct isoburn_imgen_opts *o, 1451 int replace_dir_mode, int replace_file_mode, 1452 mode_t dir_mode, mode_t file_mode); 1453 int isoburn_igopt_get_over_mode(struct isoburn_imgen_opts *o, 1454 int *replace_dir_mode, int *replace_file_mode, 1455 mode_t *dir_mode, mode_t *file_mode); 1456 1457 /** Set the override values values for group id and user id. 1458 The rules are like with above overriding of mode values. replace_* controls 1459 whether and how. The other two parameters provide values for eventual use. 1460 @since 0.1.0 1461 @param o The option set to work on 1462 @param replace_uid whether and how to override user ids 1463 @param replace_gid whether and how to override group ids 1464 @param uid User id to use with replace_uid == 2. 1465 @param gid Group id to use on files with replace_gid == 2. 1466 @return 1 success, <=0 failure 1467 */ 1468 int isoburn_igopt_set_over_ugid(struct isoburn_imgen_opts *o, 1469 int replace_uid, int replace_gid, 1470 uid_t uid, gid_t gid); 1471 int isoburn_igopt_get_over_ugid(struct isoburn_imgen_opts *o, 1472 int *replace_uid, int *replace_gid, 1473 uid_t *uid, gid_t *gid); 1474 1475 /** Set the charcter set to use for representing RR filenames in the image. 1476 @since 0.1.0 1477 @param o The option set to work on 1478 @param output_charset Set this to NULL to use the default output charset. 1479 For selecting a particular character set, submit its 1480 name, e.g. as listed by program iconv -l. 1481 Example: "UTF-8". 1482 @return 1 success, <=0 failure 1483 */ 1484 int isoburn_igopt_set_out_charset(struct isoburn_imgen_opts *o, 1485 char *output_charset); 1486 int isoburn_igopt_get_out_charset(struct isoburn_imgen_opts *o, 1487 char **output_charset); 1488 1489 1490 /** The number of bytes to be used for the fifo which decouples libisofs 1491 and libburn for better throughput and for reducing the risk of 1492 interrupting signals hitting the libburn thread which operates the 1493 MMC drive. 1494 The size will be rounded up to the next full 2048. 1495 Minimum is 64kiB, maximum is 1 GiB (but that is too much anyway). 1496 @since 0.1.0 1497 @param o The option set to work on 1498 @param fifo_size Number of bytes to use 1499 @return 1 success, <=0 failure 1500 */ 1501 int isoburn_igopt_set_fifo_size(struct isoburn_imgen_opts *o, int fifo_size); 1502 int isoburn_igopt_get_fifo_size(struct isoburn_imgen_opts *o, int *fifo_size); 1503 1504 1505 /** Obtain after image preparation the block address where the session will 1506 start on the medium. 1507 This value cannot be set by the application but only be inquired. 1508 @since 0.1.4 1509 @param o The option set to work on 1510 @param lba The block number of the session start on the medium. 1511 <0 means that no address has been determined yet. 1512 @return 1 success, <=0 failure 1513 */ 1514 int isoburn_igopt_get_effective_lba(struct isoburn_imgen_opts *o, int *lba); 1515 1516 1517 /** Obtain after image preparation the lowest block address of file content 1518 data. Failure can occur if libisofs is too old to provide this information, 1519 if the result exceeds 31 bit, or if the call is made before image 1520 preparation. 1521 This value cannot be set by the application but only be inquired. 1522 @since 0.3.6 1523 @param o The option set to work on 1524 @param lba The block number of the session start on the medium. 1525 <0 means that no address has been determined yet. 1526 @return 1 success, <=0 failure 1527 */ 1528 int isoburn_igopt_get_data_start(struct isoburn_imgen_opts *o, int *lba); 1529 1530 1531 /** Set or get parameters "name" and "timestamp" for a scdbackup checksum 1532 tag. It will be appended to the libisofs session tag if the image starts at 1533 LBA 0. See isoburn_disc_track_lba_nwa. The scdbackup tag can be used 1534 to verify the image by command scdbackup_verify $device -auto_end. 1535 See scdbackup/README appendix VERIFY for its inner details. 1536 @since 0.4.4 1537 @param o The option set to work on 1538 @param name The tag name. 80 characters max. 1539 An empty name disables production of an scdbackup tag. 1540 @param timestamp A string of up to 13 characters YYMMDD.hhmmss 1541 A9 = 2009, B0 = 2010, B1 = 2011, ... C0 = 2020, ... 1542 @param tag_written Either NULL or the address of an array with at least 512 1543 characters. In the latter case the eventually produced 1544 scdbackup tag will be copied to this array when the image 1545 gets written. This call sets scdbackup_tag_written[0] = 0 1546 to mark its preliminary invalidity. 1547 @return 1 success, <=0 failure 1548 */ 1549 int isoburn_igopt_set_scdbackup_tag(struct isoburn_imgen_opts *o, char *name, 1550 char *timestamp, char *tag_written); 1551 int isoburn_igopt_get_scdbackup_tag(struct isoburn_imgen_opts *o, 1552 char name[81], char timestamp[19], 1553 char **tag_written); 1554 1555 1556 /** Attach 32 kB of binary data which shall get written to the first 32 kB 1557 of the ISO image, the System Area. 1558 options can cause manipulations of these data before writing happens. 1559 If system area data are giveni or options bit0 is set, then bit1 of 1560 el_torito_set_isolinux_options() is automatically disabled. 1561 @since 0.5.4 1562 @param o The option set to work on 1563 @param data Either NULL or 32 kB of data. Do not submit less bytes ! 1564 @param options Can cause manipulations of submitted data before they 1565 get written: 1566 bit0= apply a --protective-msdos-label as of grub-mkisofs. 1567 This means to patch bytes 446 to 512 of the system 1568 area so that one partition is defined which begins 1569 at the second 512-byte block of the image and ends 1570 where the image ends. 1571 This works with and without system_area_data. 1572 bit1= apply isohybrid MBR patching to the system area. 1573 This works only with system area data from 1574 SYSLINUX plus an ISOLINUX boot image (see 1575 iso_image_set_boot_image()) and only if not bit0 1576 is set. 1577 bit2-7= System area type 1578 0= with bit0 or bit1: MBR 1579 else: unspecified type 1580 @since 0.6.4 1581 1= MIPS Big Endian Volume Header 1582 Submit up to 15 MIPS Big Endian boot files by 1583 iso_image_add_mips_boot_file() of libisofs. 1584 This will overwrite the first 512 bytes of 1585 the submitted data. 1586 2= DEC Boot Block for MIPS Little Endian 1587 The first boot file submitted by 1588 iso_image_add_mips_boot_file() will be activated. 1589 This will overwrite the first 512 bytes of 1590 the submitted data. 1591 @since 0.6.6 1592 3= SUN Disk Label for SUN SPARC 1593 Submit up to 7 SPARC boot images by 1594 isoburn_igopt_set_partition_img() for partition 1595 numbers 2 to 8. 1596 This will overwrite the first 512 bytes of 1597 the submitted data. 1598 @since 1.3.8 1599 4= HP-PA PALO boot sector header version 4 1600 Submit all five parameters of 1601 iso_image_set_hppa_palo() as non-NULL texts. 1602 5= HP-PA PALO boot sector header version 5 1603 Submit all five parameters of 1604 iso_image_set_hppa_palo() as non-NULL texts. 1605 bit8-9= Only with System area type 0 = MBR 1606 @since 1.0.4 1607 Cylinder alignment mode eventually pads the image 1608 to make it end at a cylinder boundary. 1609 0 = auto (align if bit1) 1610 1 = always align to cylinder boundary 1611 2 = never align to cylinder boundary 1612 bit10-13= System area sub type 1613 @since 1.2.4 1614 With type 0 = MBR: 1615 Gets overridden by bit0 and bit1. 1616 0 = no particular sub type 1617 1 = CHRP: A single MBR partition of type 0x96 1618 covers the ISO image. Not compatible with 1619 any other feature which needs to have own 1620 MBR partition entries. 1621 bit14= Only with System area type 0 = MBR 1622 GRUB2 boot provisions: 1623 @since 1.3.0 1624 Patch system area at byte 0x1b0 to 0x1b7 with 1625 (512-block address + 4) of the first boot image file. 1626 Little-endian 8-byte. 1627 Should be combined with options bit0. 1628 Will not be in effect if options bit1 is set. 1629 @return 1 success, 0 no data to get, <0 failure 1630 */ 1631 int isoburn_igopt_set_system_area(struct isoburn_imgen_opts *o, 1632 char data[32768], int options); 1633 int isoburn_igopt_get_system_area(struct isoburn_imgen_opts *o, 1634 char data[32768], int *options); 1635 1636 /** Control production of a second set of volume descriptors (superblock) 1637 and directory trees, together with a partition table in the MBR where the 1638 first partition has non-zero start address and the others are zeroed. 1639 The first partition stretches to the end of the whole ISO image. 1640 The additional volume descriptor set and trees can be used to mount the 1641 ISO image at the start of the first partition, while it is still possible 1642 to mount it via the normal first volume descriptor set and tree at the 1643 start of the image or storage device. 1644 This makes few sense on optical media. But on USB sticks it creates a 1645 conventional partition table which makes it mountable on e.g. Linux via 1646 /dev/sdb and /dev/sdb1 alike. 1647 @since 0.6.2 1648 @param opts 1649 The option set to be manipulated. 1650 @param block_offset_2k 1651 The offset of the partition start relative to device start. 1652 This is counted in 2 kB blocks. The partition table will show the 1653 according number of 512 byte sectors. 1654 Default is 0 which causes no second set and trees. 1655 If it is not 0 then it must not be smaller than 16. 1656 @param secs_512_per_head 1657 Number of 512 byte sectors per head. 1 to 63. 0=automatic. 1658 @param heads_per_cyl 1659 Number of heads per cylinder. 1 to 255. 0=automatic. 1660 @return 1 success, <=0 failure 1661 */ 1662 int isoburn_igopt_set_part_offset(struct isoburn_imgen_opts *opts, 1663 uint32_t block_offset_2k, 1664 int secs_512_per_head, int heads_per_cyl); 1665 int isoburn_igopt_get_part_offset(struct isoburn_imgen_opts *opts, 1666 uint32_t *block_offset_2k, 1667 int *secs_512_per_head, int *heads_per_cyl); 1668 1669 1670 /** Explicitly set the four timestamps of the emerging ISO image. 1671 Default with all parameters is 0. 1672 @since 0.5.4 1673 @param opts 1674 The option set to work on 1675 @param creation_time 1676 ECMA-119 Volume Creation Date and Time 1677 When "the information in the volume was created." 1678 A value of 0 means that the timepoint of write start is to be used. 1679 @param modification_time 1680 ECMA-119 Volume Modification Date and Time 1681 When "the informationin the volume was last modified." 1682 A value of 0 means that the timepoint of write start is to be used. 1683 @param expiration_time 1684 ECMA-119 Volume Expiration Date and Time 1685 When "the information in the volume may be regarded as obsolete." 1686 A value of 0 means that the information never shall expire. 1687 @param effective_time 1688 ECMA-119 Volume Effective Date and Time 1689 When "the information in the volume may be used." 1690 A value of 0 means that not such retention is intended. 1691 @param uuid 1692 If this text is not empty, then it overrides vol_modification_time 1693 by copying the first 16 decimal digits from uuid, eventually 1694 padding up with decimal '1', and writing a NUL-byte as timezone GMT. 1695 It should express a reasonable time in form YYYYMMDDhhmmsscc 1696 E.g.: 2010040711405800 = 7 Apr 2010 11:40:58 (+0 centiseconds) 1697 @return 1 success, <=0 failure 1698 */ 1699 int isoburn_igopt_set_pvd_times(struct isoburn_imgen_opts *opts, 1700 time_t creation_time, time_t modification_time, 1701 time_t expiration_time, time_t effective_time, 1702 char *uuid); 1703 int isoburn_igopt_get_pvd_times(struct isoburn_imgen_opts *opts, 1704 time_t *creation_time, time_t *modification_time, 1705 time_t *expiration_time, time_t *effective_time, 1706 char uuid[17]); 1707 1708 1709 /** Associate a libjte environment object to the upcoming write run. 1710 libjte implements Jigdo Template Extraction as of Steve McIntyre and 1711 Richard Atterer. 1712 A non-NULL libjte_handle will cause failure to write if libjte was not 1713 enabled in libisofs at compile time. 1714 @since 0.6.4 1715 @param opts 1716 The option set to work on 1717 @param libjte_handle 1718 Pointer to a struct libjte_env e.g. created by libjte_new(). 1719 It must stay existent from the start of image writing by 1720 isoburn_prepare_*() until the write thread has ended. 1721 E.g. until libburn indicates the end of its write run. 1722 @return 1 success, <=0 failure 1723 */ 1724 int isoburn_igopt_attach_jte(struct isoburn_imgen_opts *opts, 1725 void *libjte_handle); 1726 1727 /** Remove eventual association to a libjte environment handle. 1728 @since 0.6.4 1729 @param opts 1730 The option set to work on 1731 @param libjte_handle 1732 If not submitted as NULL, this will return the previously set 1733 libjte handle. 1734 @return 1 success, <=0 failure 1735 */ 1736 int isoburn_igopt_detach_jte(struct isoburn_imgen_opts *opts, 1737 void **libjte_handle); 1738 1739 1740 /** Set or get the number of trailing zero byte blocks to be written by 1741 libisofs. The image size counter of the emerging ISO image will include 1742 them. Eventual checksums will take them into respect. 1743 They will be written immediately before the eventual image checksum area 1744 which is at the very end of the image. 1745 For a motivation see iso_write_opts_set_tail_blocks() in libisofs.h . 1746 @since 0.6.4 1747 @param opts 1748 The option set to work on 1749 @param num_blocks 1750 Number of extra 2 kB blocks to be written by libisofs. 1751 @return 1 success, <=0 failure 1752 */ 1753 int isoburn_igopt_set_tail_blocks(struct isoburn_imgen_opts *opts, 1754 uint32_t num_blocks); 1755 int isoburn_igopt_get_tail_blocks(struct isoburn_imgen_opts *opts, 1756 uint32_t *num_blocks); 1757 1758 1759 /** Copy a data file from the local filesystem into the emerging ISO image. 1760 Mark it by an MBR partition entry as PreP partition and also cause 1761 protective MBR partition entries before and after this partition. 1762 See libisofs.h iso_write_opts_set_prep_img(). 1763 @since 1.2.4 1764 @param opts 1765 The option set to be manipulated. 1766 @param path 1767 File address in the local file system. 1768 @param flag 1769 With isoburn_igopt_set_prep_partition(): 1770 Control bits as of iso_write_opts_set_efi_bootp() 1771 bit0= The path contains instructions for the interval libisofs 1772 reader. See libisofs.h. 1773 @since 1.4.0 1774 With isoburn_igopt_get_prep_partition(): 1775 bit0= add the current flag setting & 0x3fffffff to return value 1. 1776 @return 1 success, <=0 failure 1777 */ 1778 int isoburn_igopt_set_prep_partition(struct isoburn_imgen_opts *opts, 1779 char *path, int flag); 1780 int isoburn_igopt_get_prep_partition(struct isoburn_imgen_opts *opts, 1781 char **path, int flag); 1782 1783 /** Copy a data file from the local filesystem into the emerging ISO image 1784 and mark it by a GPT entry as EFI system partition. 1785 @since 1.2.4 1786 @param opts 1787 The option set to be manipulated. 1788 @param path 1789 File address in the local file system. 1790 Instead of a disk path, the word --efi-boot-image may be given. 1791 It exposes in GPT the content of the first El Torito EFI boot image 1792 as EFI system partition. 1793 @param flag 1794 With isoburn_igopt_get_efi_bootp(): 1795 Control bits as of iso_write_opts_set_efi_bootp() 1796 bit0= The path contains instructions for the interval libisofs 1797 reader. See libisofs.h. 1798 @since 1.4.0 1799 With isoburn_igopt_set_efi_bootp(): 1800 bit0= add the current flag setting & 0x3fffffff to return value 1. 1801 @return 1 success, <=0 failure 1802 */ 1803 int isoburn_igopt_set_efi_bootp(struct isoburn_imgen_opts *opts, 1804 char *path, int flag); 1805 int isoburn_igopt_get_efi_bootp(struct isoburn_imgen_opts *opts, 1806 char **path, int flag); 1807 1808 1809 /** Cause an arbitrary data file to be appended to the ISO image and to be 1810 described by a partition table entry in an MBR or SUN Disk Label at the 1811 start of the ISO image. 1812 The partition entry will bear the size of the image file rounded up to 1813 the next multiple of 2048 bytes. 1814 MBR or SUN Disk Label are selected by isoburn_igopt_set_system_area() 1815 system area type: 0 selects MBR partition table. 3 selects a SUN partition 1816 table with 320 kB start alignment. 1817 @since 0.6.4 1818 @param opts 1819 The option set to be manipulated. 1820 @param partition_number 1821 Depicts the partition table entry which shall describe the 1822 appended image. 1823 Range with MBR: 1 to 4. 1 will cause the whole ISO image to be 1824 unclaimable space before partition 1. 1825 @since 0.6.6 1826 Range with SUN Disk Label: 2 to 8. 1827 @param image_path 1828 File address in the local file system. 1829 With SUN Disk Label: an empty name causes the partition to become 1830 a copy of the next lower partition. 1831 @param partition_type 1832 The MBR partition type. E.g. FAT12 = 0x01 , FAT16 = 0x06, 1833 Linux Native Partition = 0x83. See fdisk command L. 1834 This parameter is ignored with SUN Disk Label. 1835 @return 1836 <=0 = error, 1 = success 1837 */ 1838 int isoburn_igopt_set_partition_img(struct isoburn_imgen_opts *opts, 1839 int partition_number, uint8_t partition_type, 1840 char *image_path); 1841 1842 /** Inquire the current settings made by isoburn_igopt_set_partition_img(). 1843 @since 0.6.4 1844 @param opts 1845 The option set to be inquired. 1846 @param num_entries 1847 Number of array elements in partition_types[] and image_paths[]. 1848 @param partition_types 1849 The partition type associated with the partition. Valid only if 1850 image_paths[] of the same index is not NULL. 1851 @param image_paths 1852 Its elements get filled with either NULL or a pointer to a string 1853 with a file address or an empty text. 1854 @return 1855 <0 = error 1856 0 = no partition image set 1857 >0 highest used partition number 1858 */ 1859 int isoburn_igopt_get_partition_img(struct isoburn_imgen_opts *opts, 1860 int num_entries, 1861 uint8_t partition_types[], 1862 char *image_paths[]); 1863 1864 1865 /** Set flag bits for a partition defined by isoburn_igopt_set_partition_img(). 1866 The bits will be forwarded to libisofs iso_write_opts_set_partition_img(). 1867 @since 1.4.0 1868 @param opts 1869 The option set to be manipulated. 1870 @param partition_number 1871 Depicts the partition table entry to which shall the flags bits 1872 shall apply. 1873 @param flag 1874 Control bits as of iso_write_opts_set_partition_img() 1875 bit0= The path contains instructions for the interval libisofs 1876 reader. See libisofs.h. 1877 @since 1.4.0 1878 @return 1879 <=0 = error, 1 = success 1880 */ 1881 int isoburn_igopt_set_part_flag(struct isoburn_imgen_opts *opts, 1882 int partition_number, int flag); 1883 1884 /** Inquire the current settings made by isoburn_igopt_set_part_flags(). 1885 @since 1.4.0 1886 @param opts 1887 The option set to be inquired. 1888 @param num_entries 1889 Number of array elements in part_flags[]. 1890 @param part_flags 1891 The array elements 0 to num_entries - 1 will get filled by the 1892 flag bits of the images of the corresponding partition. 1893 @return 1894 <0 = error 1895 0 = no partition image set 1896 >0 highest used partition number 1897 */ 1898 int isoburn_igopt_get_part_flags(struct isoburn_imgen_opts *opts, 1899 int num_entries, int part_flags[]); 1900 1901 1902 /** Control whether partitions created by iso_write_opts_set_partition_img() 1903 are to be represented in MBR or as GPT partitions. 1904 @since 1.4.0 1905 @param opts 1906 The option set to be manipulated. 1907 @param gpt 1908 0= represent as MBR partition; as GPT only if other GPT partitions 1909 are present 1910 1= represent as GPT partition and cause protective MBR with a single 1911 partition which covers the whole output data. 1912 This may fail if other settings demand MBR partitions. 1913 Do not use other values for now. 1914 @return 1915 <=0 = error, 1 = success 1916 */ 1917 int isoburn_igopt_set_appended_as_gpt(struct isoburn_imgen_opts *opts, 1918 int gpt); 1919 1920 /** Inquire the current setting made by isoburn_igopt_set_appended_as_gpt(). 1921 @since 1.4.0 1922 @param opts 1923 The option set to be inquired. 1924 @param gpt 1925 Returns the current value. 1926 @return 1927 <=0 = error, 1 = success 1928 */ 1929 int isoburn_igopt_get_appended_as_gpt(struct isoburn_imgen_opts *opts, 1930 int *gpt); 1931 1932 1933 /** Control whether partitions created by iso_write_opts_set_partition_img() 1934 are to be represented in Apple Partition Map. 1935 @since 1.4.4 1936 @param opts 1937 The option set to be manipulated. 1938 @param apm 1939 0= do not represent appended partitions in APM 1940 1= represent in APM, even if not 1941 iso_write_opts_set_part_like_isohybrid() enables it and no 1942 other APM partitions emerge. 1943 Do not use other values for now. 1944 @return 1945 <=0 = error, 1 = success 1946 */ 1947 int isoburn_igopt_set_appended_as_apm(struct isoburn_imgen_opts *opts, 1948 int apm); 1949 1950 /** Inquire the current setting made by isoburn_igopt_set_appended_as_apm(). 1951 @since 1.4.4 1952 @param opts 1953 The option set to be inquired. 1954 @param apm 1955 Returns the current value. 1956 @return 1957 <=0 = error, 1 = success 1958 */ 1959 int isoburn_igopt_get_appended_as_apm(struct isoburn_imgen_opts *opts, 1960 int *apm); 1961 1962 1963 /** Control whether bits 2 to 8 of el_torito_set_isolinux_options() 1964 shall apply even if not isohybrid MBR patching is enabled (bit1 of 1965 parameter options of isoburn_igopt_set_system_area()). 1966 For details see iso_write_opts_set_part_like_isohybrid() in libisofs.h. 1967 @since 1.4.4 1968 @param opts 1969 The option set to be manipulated. 1970 @param alike 1971 0= Apply isohybrid behavior only with ISOLINUX isohybrid. 1972 Do not mention appended partitions in APM unless 1973 isoburn_igopt_set_appended_as_apm() is enabled. 1974 1= Apply isohybrid behavior even without ISOLINUX isohybrid. 1975 @return 1976 <=0 = error, 1 = success 1977 */ 1978 int isoburn_igopt_set_part_like_isohybrid(struct isoburn_imgen_opts *opts, 1979 int alike); 1980 1981 /** Inquire the current setting of isoburn_igopt_set_part_like_isohybrid(). 1982 @since 1.4.4 1983 @param opts 1984 The option set to be inquired. 1985 @param alike 1986 Returns the current value. 1987 @return 1988 <=0 = error, 1 = success 1989 */ 1990 int isoburn_igopt_get_part_like_isohybrid(struct isoburn_imgen_opts *opts, 1991 int *alike); 1992 1993 /** Set the partition type of the MBR partition which represents the ISO 1994 filesystem or at least protects it. 1995 This is without effect if no such partition emerges by other settings or 1996 if the partition type is prescribed mandatorily like 0xee for 1997 GPT protective MBR or 0x96 for CHRP. 1998 @since 1.4.8 1999 @param opts 2000 The option set to be manipulated. 2001 @param part_type 2002 0x00 to 0xff as desired partition type. 2003 Any other value (e.g. -1) enables the default types of the various 2004 occasions. 2005 */ 2006 int isoburn_igopt_set_iso_mbr_part_type(struct isoburn_imgen_opts *opts, 2007 int part_type); 2008 2009 /** Inquire the current setting of isoburn_igopt_set_iso_mbr_part_type(). 2010 @since 1.4.8 2011 @param opts 2012 The option set to be inquired. 2013 @param part_type 2014 Returns the current value: -1, 0x00 to 0xff. 2015 @return 2016 <=0 = error, 1 = success 2017 */ 2018 int isoburn_igopt_get_iso_mbr_part_type(struct isoburn_imgen_opts *opts, 2019 int *part_type); 2020 2021 /** Control whether the emerging GPT gets a pseudo-randomly generated disk GUID 2022 or whether it gets a user supplied GUID. 2023 The partition GUIDs will be generated in a reproducible way by exoring a 2024 little-endian 32 bit counter with the disk GUID beginning at byte offset 9. 2025 @since 1.4.6 2026 @param opts 2027 The option set to be manipulated. 2028 @param guid 2029 16 bytes of user supplied GUID. 2030 The upper 4 bit of guid[6] and guid[7] should bear the value 4 to 2031 express the version 4 in both endiannesses. Bit 7 of byte[8] should 2032 be set to 1 and bit 6 be set to 0, in order to express the RFC 4122 2033 variant of GUID, where version 4 means "random". 2034 @param mode 2035 0 = ignore parameter guid and produce the GPT disk GUID by a 2036 pseudo-random algorithm. This is the default setting. 2037 1 = use parameter guid as GPT disk GUID 2038 2 = ignore parameter guid and derive the GPT disk GUID from 2039 parameter uuid of isoburn_igopt_set_pvd_times(). 2040 The 16 bytes of uuid get copied and bytes 6, 7, 8 get their 2041 upper bits changed to comply to RFC 4122. 2042 If no such uuid is given when ISO production starts, then 2043 mode 2 defaults to mode 0. 2044 */ 2045 int isoburn_igopt_set_gpt_guid(struct isoburn_imgen_opts *opts, 2046 uint8_t guid[16], int mode); 2047 2048 /** Inquire the current setting of isoburn_igopt_set_gpt_guid(). 2049 @since 1.4.6 2050 @param opts 2051 The option set to be inquired. 2052 @param guid 2053 Returns the current guid if current mode is 1. 2054 @param mode 2055 Returns the current value. 2056 @return 2057 <=0 = error, 1 = success 2058 */ 2059 int isoburn_igopt_get_gpt_guid(struct isoburn_imgen_opts *opts, 2060 uint8_t guid[16], int *mode); 2061 2062 2063 /** Set a name for the system area. This setting is ignored unless system area 2064 type 3 "SUN Disk Label" is in effect by iso_write_opts_set_system_area(). 2065 In this case it will replace the default text at the start of the image: 2066 "CD-ROM Disc with Sun sparc boot created by libisofs" 2067 @since 0.6.6 2068 @param opts 2069 The option set to be manipulated. 2070 @param label 2071 A text of up to 128 characters. 2072 @return 2073 <=0 = error, 1 = success 2074 */ 2075 int isoburn_igopt_set_disc_label(struct isoburn_imgen_opts *opts, char *label); 2076 2077 /** Inquire the current setting made by isoburn_igopt_set_disc_label(). 2078 @since 0.6.6 2079 @param opts 2080 The option set to be inquired. 2081 @param label 2082 Returns a pointer to the currently set label string. 2083 Do not alter this string. 2084 Use only as long as the opts object exists. 2085 @return 2086 <=0 = error, 1 = success 2087 */ 2088 int isoburn_igopt_get_disc_label(struct isoburn_imgen_opts *opts, 2089 char **label); 2090 2091 /** Set a serial number for the HFS+ extension of the emerging ISO image. 2092 @since 1.2.4 2093 @param opts 2094 The option set to be manipulated. 2095 @param serial_number 2096 8 bytes which should be unique to the image. 2097 If all bytes are 0, then the serial number will be generated as 2098 random number by libisofs. This is the default setting. 2099 @return 2100 <=0 = error, 1 = success 2101 */ 2102 int isoburn_igopt_set_hfsp_serial_number(struct isoburn_imgen_opts *opts, 2103 uint8_t serial_number[8]); 2104 2105 2106 /** Inquire the current setting made by isoburn_igopt_set_disc_label() 2107 @since 1.2.4 2108 @param opts 2109 The option set to be inquired. 2110 @param serial_number 2111 Will get filled with the current setting. 2112 @return 2113 <=0 = error, 1 = success 2114 */ 2115 int isoburn_igopt_get_hfsp_serial_number(struct isoburn_imgen_opts *opts, 2116 uint8_t serial_number[8]); 2117 2118 /** Set the allocation block size for HFS+ production and the block size 2119 for layout and address unit of Apple Partition map. 2120 @since 1.2.4 2121 @param opts 2122 The option set to be manipulated. 2123 @param hfsp_block_size 2124 -1 means that this setting shall be left unchanged 2125 0 allows the automatic default setting 2126 512 and 2048 enforce a size. 2127 @param apm_block_size 2128 -1 means that this setting shall be left unchanged 2129 0 allows the automatic default setting 2130 512 and 2048 enforce a size. 2131 Size 512 cannot be combined with GPT production. 2132 Size 2048 cannot be mounted -t hfsplus by Linux kernels at least up 2133 to 2.6.32. 2134 @return 2135 <=0 = error, 1 = success 2136 */ 2137 int isoburn_igopt_set_hfsp_block_size(struct isoburn_imgen_opts *opts, 2138 int hfsp_block_size, int apm_block_size); 2139 2140 /** Inquire the current setting made by isoburn_igopt_set_hfsp_block_size 2141 @since 1.2.4 2142 @param opts 2143 The option set to be inquired. 2144 @param hfsp_block_size 2145 Will be set to a value as described above. Except -1. 2146 @param apm_block_size 2147 Will be set to a value as described above. Except -1. 2148 @return 2149 <=0 = error, 1 = success 2150 */ 2151 int isoburn_igopt_get_hfsp_block_size(struct isoburn_imgen_opts *opts, 2152 int *hfsp_block_size, int *apm_block_size); 2153 2154 2155 /** Set or inquire the write type for the next write run on optical media. 2156 @since 1.2.4 2157 @param opts 2158 The option set to be manipulated or inquired. 2159 @param do_tao 2160 The value to be set or the variable where to return the current 2161 setting: 2162 0 = Let libburn choose according to other write parameters. 2163 This is advisable unless there are particular reasons not to 2164 use one of the two write types. Be aware that 1 and -1 can 2165 lead to failure if the write type is not appropriate for 2166 the given media situation. 2167 1 = Use BURN_WRITE_TAO which does 2168 TAO on CD, Incremental on DVD-R, 2169 no track reservation on DVD+R and BD-R 2170 -1 = Use BURN_WRITE_SAO which does 2171 SAO on CD, DAO on DVD-R, 2172 track reservation on DVD+R and BD-R 2173 @return 2174 <=0 = error, 1 = success 2175 */ 2176 int isoburn_igopt_set_write_type(struct isoburn_imgen_opts *opts, int do_tao); 2177 int isoburn_igopt_get_write_type(struct isoburn_imgen_opts *opts, int *do_tao); 2178 2179 /** Set or inquire whether a final fsync(2) is performed when updating the 2180 multi-session information of libburn stdio pseudo-drives by 2181 isoburn_activate_session(). 2182 Note: 2183 fsync(2) calls during and at the end of isoburn_disc_write() are controlled 2184 by libburn call burn_write_opts_set_stdio_fsync(). 2185 @since 1.2.4 2186 @param opts 2187 The option set to be manipulated or inquired. 2188 @param do_sync 2189 1= call fsync(2) with stdio drives in isoburn_activate_session() 2190 0= do not 2191 @return 2192 <=0 = error, 1 = success 2193 */ 2194 int isoburn_igopt_set_stdio_endsync(struct isoburn_imgen_opts *opts, 2195 int do_sync); 2196 int isoburn_igopt_get_stdio_endsync(struct isoburn_imgen_opts *opts, 2197 int *do_sync); 2198 2199 /* ----------------------------------------------------------------------- */ 2200 /* End of Options for image generation */ 2201 /* ----------------------------------------------------------------------- */ 2202 2203 2204 /** Frontend of libisofs call iso_conv_name_chars() controlled by 2205 struct isoburn_imgen_opts rather than IsoWriteOpts. 2206 See libisofs.h for a more detailed description. 2207 @since 1.3.6 2208 @param opts 2209 Defines options like output charset, UCS-2 versus UTF-16 for Joliet, 2210 and naming restrictions. 2211 @param name 2212 The input text which shall be converted. 2213 @param name_len 2214 The number of bytes in input text. 2215 @param result 2216 Will return the conversion result in case of success. Terminated by 2217 a trailing zero byte. 2218 Use free() to dispose it when no longer needed. 2219 @param result_len 2220 Will return the number of bytes in result (excluding trailing zero) 2221 @param flag 2222 Bitfield for control purposes. 2223 bit0-bit7= Name space 2224 0= generic (to_charset is valid, 2225 no reserved characters, no length limits) 2226 1= Rock Ridge (to_charset is valid) 2227 2= Joliet (to_charset gets overridden by UCS-2 or UTF-16) 2228 3= ECMA-119 (to_charset gets overridden by the 2229 dull ISO 9660 subset of ASCII) 2230 4= HFS+ (to_charset gets overridden by UTF-16BE) 2231 bit8= Treat input text as directory name 2232 (matters for Joliet and ECMA-119) 2233 bit9= Do not issue error messages 2234 bit15= Reverse operation (best to be done only with results of 2235 previous conversions) 2236 @return 2237 1 means success, <=0 means error 2238 */ 2239 int isoburn_conv_name_chars(struct isoburn_imgen_opts *opts, 2240 char *name, size_t name_len, 2241 char **result, size_t *result_len, int flag); 2242 2243 2244 /** Get the image attached to a drive, if any. 2245 @since 0.1.0 2246 @param d The drive to inquire 2247 @return A reference to attached image, or NULL if the drive has no image 2248 attached. This reference needs to be released via iso_image_unref() 2249 when it is not longer needed. 2250 */ 2251 IsoImage *isoburn_get_attached_image(struct burn_drive *d); 2252 2253 /** Get the start address of the image that is attached to the drive, if any. 2254 @since 1.2.2 2255 @param d The drive to inquire 2256 @return The logical block address where the System Area of the image 2257 starts. <0 means that the address is invalid. 2258 */ 2259 int isoburn_get_attached_start_lba(struct burn_drive *d); 2260 2261 2262 /** Load the ISO filesystem directory tree from the medium in the given drive. 2263 This will give libisoburn the base on which it can let libisofs perform 2264 image growing or image modification. The loaded volset gets attached 2265 to the drive object and handed out to the application. 2266 Not a wrapper, but peculiar to libisoburn. 2267 @since 0.1.0 2268 @param d The drive which holds an existing ISO filesystem or blank media. 2269 d is allowed to be NULL which produces an empty ISO image. In 2270 this case one has to call before writing isoburn_attach_volset() 2271 with the volset from this call and with the intended output 2272 drive. 2273 @param read_opts The read options which can be chosen by the application 2274 @param image the image read, if the disc is blank it will have no files. 2275 This reference needs to be released via iso_image_unref() when 2276 it is not longer needed. The drive, if not NULL, will hold an 2277 own reference which it will release when it gets a new volset 2278 or when it gets released via isoburn_drive_release(). 2279 You can pass NULL if you already have a reference or you plan to 2280 obtain it later with isoburn_get_attached_image(). Of course, if 2281 you haven't specified a valid drive (i.e., if d == NULL), this 2282 parameter can't be NULL. 2283 @return <=0 error , 1 = success 2284 */ 2285 int isoburn_read_image(struct burn_drive *d, 2286 struct isoburn_read_opts *read_opts, 2287 IsoImage **image); 2288 2289 /** Set a callback function for producing pacifier messages during the lengthy 2290 process of image reading. The callback function and the application handle 2291 are stored until they are needed for the underlying call to libisofs. 2292 Other than with libisofs the handle is managed entirely by the application. 2293 An idle .free() function is exposed to libisofs. The handle has to stay 2294 valid until isoburn_read_image() is done. It has to be detached by 2295 isoburn_set_read_pacifier(drive, NULL, NULL); 2296 before it may be removed from memory. 2297 @since 0.1.0 2298 @param drive The drive which will be used with isoburn_read_image() 2299 It has to be acquired by an isoburn_* wrapper call. 2300 @param read_pacifier The callback function 2301 @param app_handle The app handle which the callback function can obtain 2302 via iso_image_get_attached_data() from its IsoImage* 2303 @return 1 success, <=0 failure 2304 */ 2305 int isoburn_set_read_pacifier(struct burn_drive *drive, 2306 int (*read_pacifier)(IsoImage*, IsoFileSource*), 2307 void *app_handle); 2308 2309 /** Inquire the partition offset of the loaded image. The first 512 bytes of 2310 the image get examined whether they bear an MBR signature and a first 2311 partition table entry which matches the size of the image. In this case 2312 the start address is recorded as partition offset and internal buffers 2313 get adjusted. 2314 See also isoburn_igopt_set_part_offset(). 2315 @since 0.6.2 2316 @param drive The drive with the loaded image 2317 @param block_offset_2k returns the recognized partition offset 2318 @return <0 = error 2319 0 = no partition offset recognized 2320 1 = acceptable non-zero offset, buffers are adjusted 2321 2 = offset is credible but not acceptable for buffer size 2322 */ 2323 int isoburn_get_img_partition_offset(struct burn_drive *drive, 2324 uint32_t *block_offset_2k); 2325 2326 2327 /** Set the IsoImage to be used with a drive. This eventually releases 2328 the reference to the old IsoImage attached to the drive. 2329 Caution: Use with care. It hardly makes sense to replace an image that 2330 reflects a valid ISO image on the medium. 2331 This call is rather intended for writing a newly created and populated 2332 image to blank media. The use case in xorriso is to let an image survive 2333 the change or demise of the outdev target drive. 2334 @since 0.1.0 2335 @param d The drive which shall be write target of the volset. 2336 @param image The image that represents the image to be written. 2337 This image pointer MUST already be a valid reference suitable 2338 for iso_image_unref(). 2339 It may have been obtained by appropriate libisofs calls or by 2340 isoburn_read_image() with d==NULL. 2341 @return <=0 error , 1 = success 2342 */ 2343 int isoburn_attach_image(struct burn_drive *d, IsoImage *image); 2344 2345 2346 /** Set the start address of the image that is attached to the drive, if any. 2347 @since 1.2.2 2348 @param d The drive to inquire 2349 @param lba The logical block address where the System Area of the image 2350 starts. <0 means that the address is invalid. 2351 @param flag Bitfield, submit 0 for now. 2352 @return <=0 error (e.g. because no image is attached), 1 = success 2353 */ 2354 int isoburn_attach_start_lba(struct burn_drive *d, int lba, int flag); 2355 2356 2357 /** Return the best possible estimation of the currently available capacity of 2358 the medium. This might depend on particular write option settings and on 2359 drive state. 2360 An eventual start address for emulated multi-session will be subtracted 2361 from the capacity estimation given by burn_disc_available_space(). 2362 Negative results get defaulted to 0. 2363 Wrapper for: burn_disc_available_space() 2364 @since 0.1.0 2365 @param d The drive to query. 2366 @param o If not NULL: write parameters to be set on drive before query 2367 @return number of most probably available free bytes 2368 */ 2369 off_t isoburn_disc_available_space(struct burn_drive *d, 2370 struct burn_write_opts *o); 2371 2372 2373 /** Obtain the start block number of the most recent session on the medium. In 2374 case of random access media this will normally be 0. Successful return is 2375 not a guarantee that there is a ISO-9660 image at all. The call will fail, 2376 nevertheless,if isoburn_disc_get_status() returns not BURN_DISC_APPENDABLE 2377 or BURN_DISC_FULL. 2378 Note: The result of this call may be fabricated by a previous call of 2379 isoburn_set_msc1() which can override the rule to load the most recent 2380 session. 2381 Wrapper for: burn_disc_get_msc1() 2382 @since 0.1.0 2383 @param d The drive to inquire 2384 @param start_lba Contains on success the start address in 2048 byte blocks 2385 @return <=0 error , 1 = success 2386 */ 2387 int isoburn_disc_get_msc1(struct burn_drive *d, int *start_lba); 2388 2389 2390 /** Use this with trackno==0 to obtain the predicted start block number of the 2391 new session. The interesting number is returned in parameter nwa. 2392 Wrapper for: burn_disc_track_lba_nwa() 2393 @since 0.1.0 2394 @param d The drive to inquire 2395 @param o If not NULL: write parameters to be set on drive before query 2396 @param trackno Submit 0. 2397 @param lba return value: start lba 2398 @param nwa return value: Next Writeable Address 2399 @return 1=nwa is valid , 0=nwa is not valid , -1=error 2400 */ 2401 int isoburn_disc_track_lba_nwa(struct burn_drive *d, struct burn_write_opts *o, 2402 int trackno, int *lba, int *nwa); 2403 2404 2405 /** Obtain the size which was attributed to an emulated appendable on actually 2406 overwriteable media. This value is supposed to be <= 2048 * nwa as of 2407 isoburn_disc_track_lba_nwa(). 2408 @since 0.1.0 2409 @param d The drive holding the medium. 2410 @param start_byte The reply value counted in bytes, not in sectors. 2411 @param flag Unused yet. Submit 0. 2412 @return 1=stat_byte is valid, 0=not an emulated appendable, -1=error 2413 */ 2414 int isoburn_get_min_start_byte(struct burn_drive *d, off_t *start_byte, 2415 int flag); 2416 2417 2418 /** Start production of an ISO 9660 image using the method of Growing: 2419 Create a disc object for writing the new session from the created or loaded 2420 iso_volset which has been manipulated via libisofs, to the same medium from 2421 where the image was eventually loaded. 2422 This call starts a libisofs thread which begins to produce the image. 2423 It has to be revoked by isoburn_cancel_prepared_write() if for some reason 2424 this image data stream shall not be consumed. 2425 The returned struct burn_disc is ready for use by a subsequent call to 2426 isoburn_disc_write(). After this asynchronous writing has ended and the 2427 drive is BURN_DRIVE_IDLE again, the burn_disc object has to be disposed 2428 by burn_disc_free(). 2429 @since 0.1.0 2430 @param drive The combined source and target drive, grabbed with 2431 isoburn_drive_scan_and_grab(). . 2432 @param disc Returns the newly created burn_disc object. 2433 @param opts Image generation options, see isoburn_igopt_*() 2434 @return <=0 error , 1 = success 2435 */ 2436 int isoburn_prepare_disc(struct burn_drive *drive, struct burn_disc **disc, 2437 struct isoburn_imgen_opts *opts); 2438 2439 2440 /** Start production of an ISO 9660 image using the method of Modifying: 2441 Create a disc object for producing a new image from a previous image 2442 plus the changes made by user. The generated burn_disc is suitable 2443 to be written to a grabbed drive with blank writeable medium. 2444 But you must not use the same drive for input and output, because data 2445 will be read from the source drive while at the same time the target 2446 drive is already writing. 2447 This call starts a libisofs thread which begins to produce the image. 2448 It has to be revoked by isoburn_cancel_prepared_write() if for some reason 2449 this image data stream shall not be consumed. 2450 The resulting burn_disc object has to be disposed when all its writing 2451 is done and the drive is BURN_DRIVE_IDLE again after asynchronous 2452 burn_disc_write(). 2453 @since 0.1.0 2454 @param in_drive The input drive, grabbed with isoburn_drive_aquire() or 2455 one of its alternatives. 2456 @param disc Returns the newly created burn_disc object. 2457 @param opts Options for image generation and data transport to the 2458 medium. 2459 @param out_drive The output drive, from isoburn_drive_aquire() et.al.. 2460 @return <=0 error , 1 = success 2461 */ 2462 int isoburn_prepare_new_image(struct burn_drive *in_drive, 2463 struct burn_disc **disc, 2464 struct isoburn_imgen_opts *opts, 2465 struct burn_drive *out_drive); 2466 2467 2468 /** Start production of an ISO 9660 image using the method of Blind Growing: 2469 Create a disc object for writing an add-on session from the created or 2470 loaded IsoImage which has been manipulated via libisofs, to a different 2471 drive than the one from where it was loaded. 2472 Usually output will be stdio:/dev/fd/1 (i.e. stdout) being piped 2473 into some burn program like with this classic gesture: 2474 mkisofs -M $dev -C $msc1,$nwa | cdrecord -waiti dev=$dev 2475 Parameter translation into libisoburn: 2476 $dev is the address by which parameter in_drive of this call was 2477 acquired $msc1 was set by isoburn_set_msc1() before image reading 2478 or was detected from the in_drive medium 2479 $nwa is a parameter of this call 2480 or can be used as detected from the in_drive medium 2481 2482 This call starts a libisofs thread which begins to produce the image. 2483 It has to be revoked by isoburn_cancel_prepared_write() if for some reason 2484 this image data stream shall not be consumed. 2485 This call waits for libisofs output to become available and then detaches 2486 the input drive object from the data source object by which libisofs was 2487 reading from the input drive. 2488 So, as far as libisofs is concerned, that drive may be released immediately 2489 after this call in order to allow the consumer to access the drive for 2490 writing. 2491 The consumer should wait for input to become available and only then open 2492 its burn drive. With cdrecord this is caused by option -waiti. 2493 2494 The resulting burn_disc object has to be disposed when all its writing 2495 is done and the drive is BURN_DRIVE_IDLE again after asynchronous 2496 burn_disc_write(). 2497 @since 0.2.2 2498 @param in_drive The input drive,grabbed with isoburn_drive_scan_and_grab(). 2499 @param disc Returns the newly created burn_disc object. 2500 @param opts Options for image generation and data transport to media. 2501 @param out_drive The output drive, from isoburn_drive_aquire() et.al.. 2502 typically stdio:/dev/fd/1 . 2503 @param nwa The address (2048 byte block count) where the add-on 2504 session will be finally stored on a mountable medium 2505 or in a mountable file. 2506 If nwa is -1 then the address is used as determined from 2507 the in_drive medium. 2508 @return <=0 error , 1 = success 2509 */ 2510 int isoburn_prepare_blind_grow(struct burn_drive *in_drive, 2511 struct burn_disc **disc, 2512 struct isoburn_imgen_opts *opts, 2513 struct burn_drive *out_drive, int nwa); 2514 2515 2516 /** 2517 Revoke isoburn_prepare_*() instead of running isoburn_disc_write(). 2518 libisofs reserves resources and maybe already starts generating the 2519 image stream when one of above three calls is performed. It is mandatory to 2520 either run isoburn_disc_write() or to revoke the preparations by the 2521 call described here. 2522 If this call returns 0 or 1 then the write thread of libisofs has ended. 2523 @since 0.1.0 2524 @param input_drive The drive or in_drive which was used with the 2525 preparation call. 2526 @param output_drive The out_drive used with isoburn_prepare_new_image(), 2527 NULL if none. 2528 @param flag Bitfield, submit 0 for now. 2529 bit0= -reserved for internal use- 2530 @return <0 error, 0= no pending preparations detectable, 1 = canceled 2531 */ 2532 int isoburn_cancel_prepared_write(struct burn_drive *input_drive, 2533 struct burn_drive *output_drive, int flag); 2534 2535 2536 /** 2537 Override the truncation setting that was made with flag bit2 during the 2538 call of isoburn_drive_aquire. This applies only to stdio pseudo drives. 2539 @since 0.1.6 2540 @param drive The drive which was acquired and shall be used for writing. 2541 @param flag Bitfield controlling the setting: 2542 bit0= truncate (else do not truncate) 2543 bit1= do not warn if call is inappropriate to drive 2544 bit2= only set if truncation is currently enabled 2545 do not warn if call is inappropriate to drive 2546 @return 1 success, 0 inappropriate drive, <0 severe error 2547 */ 2548 int isoburn_set_truncate(struct burn_drive *drive, int flag); 2549 2550 2551 /** Start writing of the new session. 2552 This call is asynchrounous. I.e. it returns quite soon and the progress has 2553 to be watched by a loop with call burn_drive_get_status() until 2554 BURN_DRIVE_IDLE is returned. 2555 Wrapper for: burn_disc_write() 2556 @since 0.1.0 2557 @param o Options which control the burn process. See burnwrite_opts_*() 2558 in libburn.h. 2559 @param disc Disc object created either by isoburn_prepare_disc() or by 2560 isoburn_prepare_new_image(). 2561 */ 2562 void isoburn_disc_write(struct burn_write_opts *o, struct burn_disc *disc); 2563 2564 2565 /** Inquire state and fill parameters of the fifo which is attached to 2566 the emerging track. This should be done in the pacifier loop while 2567 isoburn_disc_write() or burn_disc_write() are active. 2568 This works only with drives obtained by isoburn_drive_scan_and_grab() 2569 or isoburn_drive_grab(). If isoburn_prepare_new_image() was used, then 2570 parameter out_drive must have announced the track output drive. 2571 Hint: If only burn_write_opts and not burn_drive is known, then the drive 2572 can be obtained by burn_write_opts_get_drive(). 2573 @since 0.1.0 2574 @param d The drive to which the track with the fifo gets burned. 2575 @param size The total size of the fifo 2576 @param free_bytes The current free capacity of the fifo 2577 @param status_text Returns a pointer to a constant text, see below 2578 @return <0 reply invalid, >=0 fifo status code: 2579 bit0+1=input status, bit2=consumption status, i.e: 2580 0="standby" : data processing not started yet 2581 1="active" : input and consumption are active 2582 2="ending" : input has ended without error 2583 3="failing" : input had error and ended, 2584 4="unused" : ( consumption has ended before processing start ) 2585 5="abandoned" : consumption has ended prematurely 2586 6="ended" : consumption has ended without input error 2587 7="aborted" : consumption has ended after input error 2588 */ 2589 int isoburn_get_fifo_status(struct burn_drive *d, int *size, int *free_bytes, 2590 char **status_text); 2591 2592 2593 /** Inquire whether the most recent write run was successful. 2594 Wrapper for: burn_drive_wrote_well() 2595 @since 0.1.0 2596 @param d The drive to inquire 2597 @return 1=burn seems to have went well, 0=burn failed 2598 */ 2599 int isoburn_drive_wrote_well(struct burn_drive *d); 2600 2601 2602 /** Call this after isoburn_disc_write has finished and burn_drive_wrote_well() 2603 indicates success. It will eventually complete the emulation of 2604 multi-session functionality, if needed at all. Let libisoburn decide. 2605 Not a wrapper, but peculiar to libisoburn. 2606 @since 0.1.0 2607 @param d The output drive to which the session was written 2608 @return 1 success , <=0 failure 2609 */ 2610 int isoburn_activate_session(struct burn_drive *d); 2611 2612 2613 /** Wait after normal end of operations until libisofs ended all write 2614 threads and freed resource reservations. 2615 This call is not mandatory. But without it, messages from the ending 2616 threads might appear after the application ended its write procedure. 2617 @since 0.1.0 2618 @param input_drive The drive or in_drive which was used with the 2619 preparation call. 2620 @param output_drive The out_drive used with isoburn_prepare_new_image(), 2621 NULL if none. 2622 @param flag Bitfield, submit 0 for now. 2623 @return <=0 error , 1 = success 2624 */ 2625 int isoburn_sync_after_write(struct burn_drive *input_drive, 2626 struct burn_drive *output_drive, int flag); 2627 2628 2629 /** Release an acquired drive. 2630 Wrapper for: burn_drive_release() 2631 @since 0.1.0 2632 @param drive The drive to be released 2633 @param eject 1= eject medium from drive , 0= do not eject 2634 */ 2635 void isoburn_drive_release(struct burn_drive *drive, int eject); 2636 2637 2638 /** Shutdown all three libraries. 2639 Wrapper for : iso_finish() and burn_finish(). 2640 @since 0.1.0 2641 */ 2642 void isoburn_finish(void); 2643 2644 2645 /* 2646 The following calls are for expert applications only. 2647 An application should have a special reason to use them. 2648 */ 2649 2650 2651 /** Inquire wether the medium needs emulation or would be suitable for 2652 generic multi-session via libburn. 2653 @since 0.1.0 2654 @param d The drive to inquire 2655 @return 0 is generic multi-session 2656 1 is emulated multi-session 2657 -1 is not suitable for isoburn 2658 */ 2659 int isoburn_needs_emulation(struct burn_drive *d); 2660 2661 2662 /* ---------------------------- Test area ----------------------------- */ 2663 2664 /* no tests active, currently */ 2665 2666 #ifdef __cplusplus 2667 } /* extern "C" */ 2668 #endif 2669 2670 #endif /* LIBISOBURN_LIBISOBURN_H_ */ 2671 2672