00001 /* -*- indent-tabs-mode: t; tab-width: 8; c-basic-offset: 8; -*- */ 00002 00003 #ifndef LIBBURN_H 00004 #define LIBBURN_H 00005 00006 /* Needed for off_t which is the (POSIX-ly) appropriate type for 00007 expressing a file or stream size. 00008 00009 XXX we should enforce 64-bitness for off_t 00010 ts A61101 : this is usually done by the build system (if it is not broken) 00011 */ 00012 #include <sys/types.h> 00013 00014 #ifndef DOXYGEN 00015 00016 #if defined(__cplusplus) 00017 #define BURN_BEGIN_DECLS \ 00018 namespace burn { \ 00019 extern "C" { 00020 #define BURN_END_DECLS \ 00021 } \ 00022 } 00023 #else 00024 #define BURN_BEGIN_DECLS 00025 #define BURN_END_DECLS 00026 #endif 00027 00028 BURN_BEGIN_DECLS 00029 00030 #endif 00031 00032 /** References a physical drive in the system */ 00033 struct burn_drive; 00034 00035 /** References a whole disc */ 00036 struct burn_disc; 00037 00038 /** References a single session on a disc */ 00039 struct burn_session; 00040 00041 /** References a single track on a disc */ 00042 struct burn_track; 00043 00044 /* ts A61111 */ 00045 /** References a set of write parameters */ 00046 struct burn_write_opts; 00047 00048 /** Session format for normal audio or data discs */ 00049 #define BURN_CDROM 0 00050 /** Session format for obsolete CD-I discs */ 00051 #define BURN_CDI 0x10 00052 /** Session format for CDROM-XA discs */ 00053 #define BURN_CDXA 0x20 00054 00055 #define BURN_POS_END 100 00056 00057 /** Mask for mode bits */ 00058 #define BURN_MODE_BITS 127 00059 00060 /** Track mode - mode 0 data 00061 0 bytes of user data. it's all 0s. mode 0. get it? HAH 00062 */ 00063 #define BURN_MODE0 (1 << 0) 00064 /** Track mode - mode "raw" - all 2352 bytes supplied by app 00065 FOR DATA TRACKS ONLY! 00066 */ 00067 #define BURN_MODE_RAW (1 << 1) 00068 /** Track mode - mode 1 data 00069 2048 bytes user data, and all the LEC money can buy 00070 */ 00071 #define BURN_MODE1 (1 << 2) 00072 /** Track mode - mode 2 data 00073 defaults to formless, 2336 bytes of user data, unprotected 00074 | with a data form if required. 00075 */ 00076 #define BURN_MODE2 (1 << 3) 00077 /** Track mode modifier - Form 1, | with MODE2 for reasonable results 00078 2048 bytes of user data, 4 bytes of subheader 00079 */ 00080 #define BURN_FORM1 (1 << 4) 00081 /** Track mode modifier - Form 2, | with MODE2 for reasonable results 00082 lots of user data. not much LEC. 00083 */ 00084 #define BURN_FORM2 (1 << 5) 00085 /** Track mode - audio 00086 2352 bytes per sector. may be | with 4ch or preemphasis. 00087 NOT TO BE CONFUSED WITH BURN_MODE_RAW 00088 Audio data must be 44100Hz 16bit stereo with no riff or other header at 00089 beginning. Extra header data will cause pops or clicks. Audio data should 00090 also be in little-endian byte order. Big-endian audio data causes static. 00091 */ 00092 #define BURN_AUDIO (1 << 6) 00093 /** Track mode modifier - 4 channel audio. */ 00094 #define BURN_4CH (1 << 7) 00095 /** Track mode modifier - Digital copy permitted, can be set on any track.*/ 00096 #define BURN_COPY (1 << 8) 00097 /** Track mode modifier - 50/15uS pre-emphasis */ 00098 #define BURN_PREEMPHASIS (1 << 9) 00099 /** Input mode modifier - subcodes present packed 16 */ 00100 #define BURN_SUBCODE_P16 (1 << 10) 00101 /** Input mode modifier - subcodes present packed 96 */ 00102 #define BURN_SUBCODE_P96 (1 << 11) 00103 /** Input mode modifier - subcodes present raw 96 */ 00104 #define BURN_SUBCODE_R96 (1 << 12) 00105 00106 /** Possible disc writing style/modes */ 00107 enum burn_write_types 00108 { 00109 /** Packet writing. 00110 currently unsupported, (for DVD Incremental Streaming use TAO) 00111 */ 00112 BURN_WRITE_PACKET, 00113 00114 /** With CD: Track At Once recording 00115 2s gaps between tracks, no fonky lead-ins 00116 00117 With sequential DVD-R[W]: Incremental Streaming 00118 With DVD-RAM/+RW: Random Writeable (used sequentially) 00119 With overwriteable DVD-RW: Rigid Restricted Overwrite 00120 */ 00121 BURN_WRITE_TAO, 00122 00123 /** With CD: Session At Once 00124 Block type MUST be BURN_BLOCK_SAO 00125 ts A70122: Currently not capable of mixing data and audio tracks. 00126 00127 With sequential DVD-R[W]: Disc-at-once, DAO 00128 Single session, single track, fixed size mandatory, (-dvd-compat) 00129 */ 00130 BURN_WRITE_SAO, 00131 00132 /** With CD: Raw disc at once recording. 00133 all subcodes must be provided by lib or user 00134 only raw block types are supported 00135 */ 00136 BURN_WRITE_RAW, 00137 00138 /** In replies this indicates that not any writing will work. 00139 As parameter for inquiries it indicates that no particular write 00140 mode shall is specified. 00141 Do not use for setting a write mode for burning. It won't work. 00142 */ 00143 BURN_WRITE_NONE 00144 }; 00145 00146 /** Data format to send to the drive */ 00147 enum burn_block_types 00148 { 00149 /** sync, headers, edc/ecc provided by lib/user */ 00150 BURN_BLOCK_RAW0 = 1, 00151 /** sync, headers, edc/ecc and p/q subs provided by lib/user */ 00152 BURN_BLOCK_RAW16 = 2, 00153 /** sync, headers, edc/ecc and packed p-w subs provided by lib/user */ 00154 BURN_BLOCK_RAW96P = 4, 00155 /** sync, headers, edc/ecc and raw p-w subs provided by lib/user */ 00156 BURN_BLOCK_RAW96R = 8, 00157 /** only 2048 bytes of user data provided by lib/user */ 00158 BURN_BLOCK_MODE1 = 256, 00159 /** 2336 bytes of user data provided by lib/user */ 00160 BURN_BLOCK_MODE2R = 512, 00161 /** 2048 bytes of user data provided by lib/user 00162 subheader provided in write parameters 00163 are we ever going to support this shit? I vote no. 00164 (supposed to be supported on all drives...) 00165 */ 00166 BURN_BLOCK_MODE2_PATHETIC = 1024, 00167 /** 2048 bytes of data + 8 byte subheader provided by lib/user 00168 hey, this is also dumb 00169 */ 00170 BURN_BLOCK_MODE2_LAME = 2048, 00171 /** 2324 bytes of data provided by lib/user 00172 subheader provided in write parameters 00173 no sir, I don't like it. 00174 */ 00175 BURN_BLOCK_MODE2_OBSCURE = 4096, 00176 /** 2332 bytes of data supplied by lib/user 00177 8 bytes sub header provided in write parameters 00178 this is the second least suck mode2, and is mandatory for 00179 all drives to support. 00180 */ 00181 BURN_BLOCK_MODE2_OK = 8192, 00182 /** SAO block sizes are based on cue sheet, so use this. */ 00183 BURN_BLOCK_SAO = 16384 00184 }; 00185 00186 /** Possible status' of the drive in regard to the disc in it. */ 00187 enum burn_disc_status 00188 { 00189 /** The current status is not yet known */ 00190 BURN_DISC_UNREADY, 00191 /** The drive holds a blank disc */ 00192 BURN_DISC_BLANK, 00193 /** There is no disc at all in the drive */ 00194 BURN_DISC_EMPTY, 00195 /** There is an incomplete disc in the drive */ 00196 BURN_DISC_APPENDABLE, 00197 /** There is a disc with data on it in the drive */ 00198 BURN_DISC_FULL, 00199 00200 /* ts A61007 */ 00201 /** The drive was not grabbed when the status was inquired */ 00202 BURN_DISC_UNGRABBED, 00203 00204 /* ts A61020 */ 00205 /** The media seems not to be suitable for burning */ 00206 BURN_DISC_UNSUITABLE 00207 }; 00208 00209 00210 /** Possible data source return values */ 00211 enum burn_source_status 00212 { 00213 /** The source is ok */ 00214 BURN_SOURCE_OK, 00215 /** The source is at end of file */ 00216 BURN_SOURCE_EOF, 00217 /** The source is unusable */ 00218 BURN_SOURCE_FAILED 00219 }; 00220 00221 00222 /** Possible busy states for a drive */ 00223 enum burn_drive_status 00224 { 00225 /** The drive is not in an operation */ 00226 BURN_DRIVE_IDLE, 00227 /** The library is spawning the processes to handle a pending 00228 operation (A read/write/etc is about to start but hasn't quite 00229 yet) */ 00230 BURN_DRIVE_SPAWNING, 00231 /** The drive is reading data from a disc */ 00232 BURN_DRIVE_READING, 00233 /** The drive is writing data to a disc */ 00234 BURN_DRIVE_WRITING, 00235 /** The drive is writing Lead-In */ 00236 BURN_DRIVE_WRITING_LEADIN, 00237 /** The drive is writing Lead-Out */ 00238 BURN_DRIVE_WRITING_LEADOUT, 00239 /** The drive is erasing a disc */ 00240 BURN_DRIVE_ERASING, 00241 /** The drive is being grabbed */ 00242 BURN_DRIVE_GRABBING, 00243 00244 /* ts A61102 */ 00245 /** The drive gets written zeroes before the track payload data */ 00246 BURN_DRIVE_WRITING_PREGAP, 00247 /** The drive is told to close a track (TAO only) */ 00248 BURN_DRIVE_CLOSING_TRACK, 00249 /** The drive is told to close a session (TAO only) */ 00250 BURN_DRIVE_CLOSING_SESSION, 00251 00252 /* ts A61223 */ 00253 /** The drive is formatting media */ 00254 BURN_DRIVE_FORMATTING, 00255 00256 /* ts A70822 */ 00257 /** The drive is busy in synchronous read (if you see this then it 00258 has been interrupted) */ 00259 BURN_DRIVE_READING_SYNC, 00260 /** The drive is busy in synchronous write (if you see this then it 00261 has been interrupted) */ 00262 BURN_DRIVE_WRITING_SYNC 00263 00264 }; 00265 00266 00267 /** Information about a track on a disc - this is from the q sub channel of the 00268 lead-in area of a disc. The documentation here is very terse. 00269 See a document such as mmc3 for proper information. 00270 00271 CAUTION : This structure is prone to future extension ! 00272 00273 Do not restrict your application to unsigned char with any counter like 00274 "session", "point", "pmin", ... 00275 Do not rely on the current size of a burn_toc_entry. 00276 00277 ts A70201 : DVD extension, see below 00278 */ 00279 struct burn_toc_entry 00280 { 00281 /** Session the track is in */ 00282 unsigned char session; 00283 /** Type of data. for this struct to be valid, it must be 1 */ 00284 unsigned char adr; 00285 /** Type of data in the track */ 00286 unsigned char control; 00287 /** Zero. Always. Really. */ 00288 unsigned char tno; 00289 /** Track number or special information */ 00290 unsigned char point; 00291 unsigned char min; 00292 unsigned char sec; 00293 unsigned char frame; 00294 unsigned char zero; 00295 /** Track start time minutes for normal tracks */ 00296 unsigned char pmin; 00297 /** Track start time seconds for normal tracks */ 00298 unsigned char psec; 00299 /** Track start time frames for normal tracks */ 00300 unsigned char pframe; 00301 00302 /* Indicates whether extension data are valid and eventually override 00303 older elements in this structure: 00304 bit0= DVD extension is valid 00305 */ 00306 unsigned char extensions_valid; 00307 00308 /* ts A70201 : DVD extension. 00309 If invalid the members are guaranteed to be 0. */ 00310 /* Tracks and session numbers are 16 bit. Here are the high bytes. */ 00311 unsigned char session_msb; 00312 unsigned char point_msb; 00313 /* pmin, psec, and pframe may be too small if DVD extension is valid */ 00314 int start_lba; 00315 /* min, sec, and frame may be too small if DVD extension is valid */ 00316 int track_blocks; 00317 00318 }; 00319 00320 00321 /** Data source interface for tracks. 00322 This allows to use arbitrary program code as provider of track input data. 00323 00324 Objects compliant to this interface are either provided by the application 00325 or by API calls of libburn: burn_fd_source_new() , burn_file_source_new(), 00326 and burn_fifo_source_new(). 00327 00328 The API calls allow to use any file object as data source. Consider to feed 00329 an eventual custom data stream asynchronously into a pipe(2) and to let 00330 libburn handle the rest. 00331 In this case the following rule applies: 00332 Call burn_source_free() exactly once for every source obtained from 00333 libburn API. You MUST NOT otherwise use or manipulate its components. 00334 00335 In general, burn_source objects can be freed as soon as they are attached 00336 to track objects. The track objects will keep them alive and dispose them 00337 when they are no longer needed. With a fifo burn_source it makes sense to 00338 keep the own reference for inquiring its state while burning is in 00339 progress. 00340 00341 --- 00342 00343 The following description of burn_source applies only to application 00344 implemented burn_source objects. You need not to know it for API provided 00345 ones. 00346 00347 If you really implement an own passive data producer by this interface, 00348 then beware: it can do anything and it can spoil everything. 00349 00350 In this case the functions (*read), (*get_size), (*set_size), (*free_data) 00351 MUST be implemented by the application and attached to the object at 00352 creation time. 00353 Function (*read_sub) is allowed to be NULL or it MUST be implemented and 00354 attached. 00355 00356 burn_source.refcount MUST be handled properly: If not exactly as many 00357 references are freed as have been obtained, then either memory leaks or 00358 corrupted memory are the consequence. 00359 All objects which are referred to by *data must be kept existent until 00360 (*free_data) is called via burn_source_free() by the last referer. 00361 */ 00362 struct burn_source { 00363 00364 /** Reference count for the data source. MUST be 1 when a new source 00365 is created and thus the first reference is handed out. Increment 00366 it to take more references for yourself. Use burn_source_free() 00367 to destroy your references to it. */ 00368 int refcount; 00369 00370 00371 /** Read data from the source. Semantics like with read(2), but MUST 00372 either deliver the full buffer as defined by size or MUST deliver 00373 EOF (return 0) or failure (return -1) at this call or at the 00374 next following call. I.e. the only incomplete buffer may be the 00375 last one from that source. 00376 libburn will read a single sector by each call to (*read). 00377 The size of a sector depends on BURN_MODE_*. The known range is 00378 2048 to 2352. 00379 00380 IMPORTANT: 00381 If this function pointer is NULL, then the struct burn_source is of 00382 version >= 1 and the job of .(*read)() is done by .(*read_xt)(). 00383 See below, member .version. 00384 */ 00385 int (*read)(struct burn_source *, unsigned char *buffer, int size); 00386 00387 00388 /** Read subchannel data from the source (NULL if lib generated) 00389 WARNING: This is an obscure feature with CD raw write modes. 00390 Unless you checked the libburn code for correctness in that aspect 00391 you should not rely on raw writing with own subchannels. 00392 ADVICE: Set this pointer to NULL. 00393 */ 00394 int (*read_sub)(struct burn_source *, unsigned char *buffer, int size); 00395 00396 00397 /** Get the size of the source's data. Return 0 means unpredictable 00398 size. If application provided (*get_size) allows return 0, then 00399 the application MUST provide a fully functional (*set_size). 00400 */ 00401 off_t (*get_size)(struct burn_source *); 00402 00403 00404 /* ts A70125 : BROKE BINARY BACKWARD COMPATIBILITY AT libburn-0.3.1. */ 00405 /** Program the reply of (*get_size) to a fixed value. It is advised 00406 to implement this by a attribute off_t fixed_size; in *data . 00407 The read() function does not have to take into respect this fake 00408 setting. It is rather a note of libburn to itself. Eventually 00409 necessary truncation or padding is done in libburn. Truncation 00410 is usually considered a misburn. Padding is considered ok. 00411 00412 libburn is supposed to work even if (*get_size) ignores the 00413 setting by (*set_size). But your application will not be able to 00414 enforce fixed track sizes by burn_track_set_size() and possibly 00415 even padding might be left out. 00416 */ 00417 int (*set_size)(struct burn_source *source, off_t size); 00418 00419 00420 /** Clean up the source specific data. This function will be called 00421 once by burn_source_free() when the last referer disposes the 00422 source. 00423 */ 00424 void (*free_data)(struct burn_source *); 00425 00426 00427 /** Next source, for when a source runs dry and padding is disabled 00428 WARNING: This is an obscure feature. Set to NULL at creation and 00429 from then on leave untouched and uninterpreted. 00430 */ 00431 struct burn_source *next; 00432 00433 00434 /** Source specific data. Here the various source classes express their 00435 specific properties and the instance objects store their individual 00436 management data. 00437 E.g. data could point to a struct like this: 00438 struct app_burn_source 00439 { 00440 struct my_app *app_handle; 00441 ... other individual source parameters ... 00442 off_t fixed_size; 00443 }; 00444 00445 Function (*free_data) has to be prepared to clean up and free 00446 the struct. 00447 */ 00448 void *data; 00449 00450 00451 /* ts A71222 : Supposed to be binary backwards compatible extension. */ 00452 00453 /** Valid only if above member .(*read)() is NULL. This indicates a 00454 version of struct burn_source younger than 0. 00455 From then on, member .version tells which further members exist 00456 in the memory layout of struct burn_source. libburn will only touch 00457 those announced extensions. 00458 00459 Versions: 00460 0 has .(*read)() != NULL, not even .version is present. 00461 1 has .version, .(*read_xt)(), .(*cancel)() 00462 */ 00463 int version; 00464 00465 /** This substitutes for (*read)() in versions above 0. */ 00466 int (*read_xt)(struct burn_source *, unsigned char *buffer, int size); 00467 00468 /** Informs the burn_source that the consumer of data prematurely 00469 ended reading. This call may or may not be issued by libburn 00470 before (*free_data)() is called. 00471 */ 00472 int (*cancel)(struct burn_source *source); 00473 }; 00474 00475 00476 /** Information on a drive in the system */ 00477 struct burn_drive_info 00478 { 00479 /** Name of the vendor of the drive */ 00480 char vendor[9]; 00481 /** Name of the drive */ 00482 char product[17]; 00483 /** Revision of the drive */ 00484 char revision[5]; 00485 00486 /** Invalid: Was: "Location of the drive in the filesystem." */ 00487 /** This string has no meaning any more. Once it stored the persistent 00488 drive address. Now always use function burn_drive_d_get_adr() to 00489 inquire a persistent address. ^^^^^^ ALWAYS ^^^^^^^^ */ 00490 char location[17]; 00491 00492 /** Can the drive read DVD-RAM discs */ 00493 unsigned int read_dvdram:1; 00494 /** Can the drive read DVD-R discs */ 00495 unsigned int read_dvdr:1; 00496 /** Can the drive read DVD-ROM discs */ 00497 unsigned int read_dvdrom:1; 00498 /** Can the drive read CD-R discs */ 00499 unsigned int read_cdr:1; 00500 /** Can the drive read CD-RW discs */ 00501 unsigned int read_cdrw:1; 00502 00503 /** Can the drive write DVD-RAM discs */ 00504 unsigned int write_dvdram:1; 00505 /** Can the drive write DVD-R discs */ 00506 unsigned int write_dvdr:1; 00507 /** Can the drive write CD-R discs */ 00508 unsigned int write_cdr:1; 00509 /** Can the drive write CD-RW discs */ 00510 unsigned int write_cdrw:1; 00511 00512 /** Can the drive simulate a write */ 00513 unsigned int write_simulate:1; 00514 00515 /** Can the drive report C2 errors */ 00516 unsigned int c2_errors:1; 00517 00518 /** The size of the drive's buffer (in kilobytes) */ 00519 int buffer_size; 00520 /** 00521 * The supported block types in tao mode. 00522 * They should be tested with the desired block type. 00523 * See also burn_block_types. 00524 */ 00525 int tao_block_types; 00526 /** 00527 * The supported block types in sao mode. 00528 * They should be tested with the desired block type. 00529 * See also burn_block_types. 00530 */ 00531 int sao_block_types; 00532 /** 00533 * The supported block types in raw mode. 00534 * They should be tested with the desired block type. 00535 * See also burn_block_types. 00536 */ 00537 int raw_block_types; 00538 /** 00539 * The supported block types in packet mode. 00540 * They should be tested with the desired block type. 00541 * See also burn_block_types. 00542 */ 00543 int packet_block_types; 00544 00545 /** The value by which this drive can be indexed when using functions 00546 in the library. This is the value to pass to all libbburn functions 00547 that operate on a drive. */ 00548 struct burn_drive *drive; 00549 }; 00550 00551 00552 /** Operation progress report. All values are 0 based indices. 00553 * */ 00554 struct burn_progress { 00555 /** The total number of sessions */ 00556 int sessions; 00557 /** Current session.*/ 00558 int session; 00559 /** The total number of tracks */ 00560 int tracks; 00561 /** Current track. */ 00562 int track; 00563 /** The total number of indices */ 00564 int indices; 00565 /** Curent index. */ 00566 int index; 00567 /** The starting logical block address */ 00568 int start_sector; 00569 /** On write: The number of sectors. 00570 On blank: 0x10000 as upper limit for relative progress steps */ 00571 int sectors; 00572 /** On write: The current sector being processed. 00573 On blank: Relative progress steps 0 to 0x10000 */ 00574 int sector; 00575 00576 /* ts A61023 */ 00577 /** The capacity of the drive buffer */ 00578 unsigned buffer_capacity; 00579 /** The free space in the drive buffer (might be slightly outdated) */ 00580 unsigned buffer_available; 00581 00582 /* ts A61119 */ 00583 /** The number of bytes sent to the drive buffer */ 00584 off_t buffered_bytes; 00585 /** The minimum number of bytes stored in buffer during write. 00586 (Caution: Before surely one buffer size of bytes was processed, 00587 this value is 0xffffffff.) 00588 */ 00589 unsigned buffer_min_fill; 00590 }; 00591 00592 00593 /* ts A61226 */ 00594 /** Description of a speed capability as reported by the drive in conjunction 00595 with eventually loaded media. There can be more than one such object per 00596 drive. So they are chained via .next and .prev , where NULL marks the end 00597 of the chain. This list is set up by burn_drive_scan() and gets updated 00598 by burn_drive_grab(). 00599 A copy may be obtained by burn_drive_get_speedlist() and disposed by 00600 burn_drive_free_speedlist(). 00601 For technical background info see SCSI specs MMC and SPC: 00602 mode page 2Ah (from SPC 5Ah MODE SENSE) , mmc3r10g.pdf , 6.3.11 Table 364 00603 ACh GET PERFORMANCE, Type 03h , mmc5r03c.pdf , 6.8.5.3 Table 312 00604 */ 00605 struct burn_speed_descriptor { 00606 00607 /** Where this info comes from : 00608 0 = misc , 1 = mode page 2Ah , 2 = ACh GET PERFORMANCE */ 00609 int source; 00610 00611 /** The media type that was current at the time of report 00612 -2 = state unknown, -1 = no media was loaded , else see 00613 burn_disc_get_profile() */ 00614 int profile_loaded; 00615 char profile_name[80]; 00616 00617 /** The attributed capacity of appropriate media in logical block units 00618 i.e. 2352 raw bytes or 2048 data bytes. -1 = capacity unknown. */ 00619 int end_lba; 00620 00621 /** Speed is given in 1000 bytes/s , 0 = invalid. The numbers 00622 are supposed to be usable with burn_drive_set_speed() */ 00623 int write_speed; 00624 int read_speed; 00625 00626 /** Expert info from ACh GET PERFORMANCE and/or mode page 2Ah. 00627 Expect values other than 0 or 1 to get a meaning in future.*/ 00628 /* Rotational control: 0 = CLV/default , 1 = CAV */ 00629 int wrc; 00630 /* 1 = drive promises reported performance over full media */ 00631 int exact; 00632 /* 1 = suitable for mixture of read and write */ 00633 int mrw; 00634 00635 /** List chaining. Use .next until NULL to iterate over the list */ 00636 struct burn_speed_descriptor *prev; 00637 struct burn_speed_descriptor *next; 00638 }; 00639 00640 00641 /** Initialize the library. 00642 This must be called before using any other functions in the library. It 00643 may be called more than once with no effect. 00644 It is possible to 'restart' the library by shutting it down and 00645 re-initializing it. Once this was necessary if you follow the older and 00646 more general way of accessing a drive via burn_drive_scan() and 00647 burn_drive_grab(). See burn_drive_scan_and_grab() with its strong 00648 urges and its explanations. 00649 @return Nonzero if the library was able to initialize; zero if 00650 initialization failed. 00651 */ 00652 int burn_initialize(void); 00653 00654 /** Shutdown the library. 00655 This should be called before exiting your application. Make sure that all 00656 drives you have grabbed are released <i>before</i> calling this. 00657 */ 00658 void burn_finish(void); 00659 00660 00661 /* ts A61002 */ 00662 /** Abort any running drive operation and finally call burn_finish(). 00663 You MUST calm down the busy drive if an aborting event occurs during a 00664 burn run. For that you may call this function either from your own signal 00665 handling code or indirectly by activating the builtin signal handling: 00666 burn_set_signal_handling("my_app_name : ", NULL, 0); 00667 Else you may eventually call burn_drive_cancel() on the active drive and 00668 wait for it to assume state BURN_DRIVE_IDLE. 00669 @param patience Maximum number of seconds to wait for drives to finish 00670 @param pacifier_func If not NULL: a function to produce appeasing messages. 00671 See burn_abort_pacifier() for an example. 00672 @param handle Opaque handle to be used with pacifier_func 00673 @return 1 ok, all went well 00674 0 had to leave a drive in unclean state 00675 <0 severe error, do no use libburn again 00676 */ 00677 int burn_abort(int patience, 00678 int (*pacifier_func)(void *handle, int patience, int elapsed), 00679 void *handle); 00680 00681 /** A pacifier function suitable for burn_abort. 00682 @param handle If not NULL, a pointer to a text suitable for printf("%s") 00683 @param patience Maximum number of seconds to wait 00684 @param elapsed Elapsed number of seconds 00685 */ 00686 int burn_abort_pacifier(void *handle, int patience, int elapsed); 00687 00688 00689 /** ts A61006 : This is for development only. Not suitable for applications. 00690 Set the verbosity level of the library. The default value is 0, which means 00691 that nothing is output on stderr. The more you increase this, the more 00692 debug output should be displayed on stderr for you. 00693 @param level The verbosity level desired. 0 for nothing, higher positive 00694 values for more information output. 00695 */ 00696 void burn_set_verbosity(int level); 00697 00698 /* ts A60813 */ 00699 /** Set parameters for behavior on opening device files. To be called early 00700 after burn_initialize() and before any bus scan. But not mandatory at all. 00701 Parameter value 1 enables a feature, 0 disables. 00702 Default is (1,0,0). Have a good reason before you change it. 00703 @param exclusive Linux only: 00704 0 = no attempt to make drive access exclusive. 00705 1 = Try to open only devices which are not marked as busy 00706 and try to mark them busy if opened sucessfully. (O_EXCL) 00707 There are kernels which simply don't care about O_EXCL. 00708 Some have it off, some have it on, some are switchable. 00709 2 = in case of a SCSI device, also try to open exclusively 00710 the matching /dev/sr, /dev/scd and /dev/st . 00711 One may select a device SCSI file family by adding 00712 0 = default family 00713 4 = /dev/sr%d 00714 8 = /dev/scd%d 00715 16 = /dev/sg%d 00716 Do not use other values ! 00717 Add 32 to demand an exclusive lock by fcntl(,F_SETLK,) 00718 after open() has succeeded. 00719 @param blocking Try to wait for drives which do not open immediately but 00720 also do not return an error as well. (O_NONBLOCK) 00721 This might stall indefinitely with /dev/hdX hard disks. 00722 @param abort_on_busy Unconditionally abort process when a non blocking 00723 exclusive opening attempt indicates a busy drive. 00724 Use this only after thorough tests with your app. 00725 */ 00726 void burn_preset_device_open(int exclusive, int blocking, int abort_on_busy); 00727 00728 00729 /* ts A70223 */ 00730 /** Allows the use of media types which are implemented in libburn but not yet 00731 tested. The list of those untested profiles is subject to change. 00732 Currently it contains: 0x15 "DVD-R/DL sequential recording", 00733 0x43 "BD-RE" 00734 If you really test such media, then please report the outcome on 00735 libburn-hackers@pykix.org 00736 If ever then this call should be done soon after burn_initialize() before 00737 any drive scanning. 00738 @param yes 1=allow all implemented profiles, 0=only tested media (default) 00739 */ 00740 void burn_allow_untested_profiles(int yes); 00741 00742 00743 /* ts A60823 */ 00744 /** Aquire a drive with known persistent address. 00745 00746 This is the sysadmin friendly way to open one drive and to leave all 00747 others untouched. It bundles the following API calls to form a 00748 non-obtrusive way to use libburn: 00749 burn_drive_add_whitelist() , burn_drive_scan() , burn_drive_grab() 00750 You are *strongly urged* to use this call whenever you know the drive 00751 address in advance. 00752 00753 If not, then you have to use directly above calls. In that case, you are 00754 *strongly urged* to drop any unintended drive which will be exclusively 00755 occupied and not closed by burn_drive_scan(). 00756 This can be done by shutting down the library including a call to 00757 burn_finish(). You may later start a new libburn session and should then 00758 use the function described here with an address obtained after 00759 burn_drive_scan() via burn_drive_d_get_adr(drive_infos[driveno].drive,adr). 00760 Another way is to drop the unwanted drives by burn_drive_info_forget(). 00761 00762 Operating on multiple drives: 00763 00764 Different than with burn_drive_scan() it is allowed to call 00765 burn_drive_scan_and_grab() without giving up any other scanned drives. So 00766 this call can be used to get a collection of more than one aquired drives. 00767 The attempt to aquire the same drive twice will fail, though. 00768 00769 Pseudo-drives: 00770 00771 burn_drive_scan_and_grab() is able to aquire virtual drives which will 00772 accept options much like a MMC burner drive. Many of those options will not 00773 cause any effect, though. The address of a pseudo-drive begins with 00774 prefix "stdio:" followed by a path. 00775 Examples: "stdio:/tmp/pseudo_drive" , "stdio:/dev/null" , "stdio:-" 00776 00777 If the path is empty, the result is a null-drive = drive role 0. 00778 It pretends to have loaded no media and supports no reading or writing. 00779 00780 If the path leads to an existing regular file, or to a not yet existing 00781 file, or to an existing block device, then the result is a random access 00782 stdio-drive capable of reading and writing = drive role 2. 00783 00784 If the path leads to an existing file of any type other than directory, 00785 then the result is a sequential write-only stdio-drive = drive role 3. 00786 00787 The special address form "stdio:/dev/fd/<number>" is interpreted literally 00788 as reference to open file descriptor <number>. This address form coincides 00789 with real files on some systems, but it is in fact hardcoded in libburn. 00790 Special address "stdio:-" means stdout = "stdio:/dev/fd/1". 00791 The role of such a drive is determined by the file type obtained via 00792 fstat(<number>). 00793 00794 Roles 2 and 3 perform all their eventual data transfer activities on a file 00795 via standard i/o functions open(2), lseek(2), read(2), write(2), close(2). 00796 The media profile is reported as 0xffff. Write space information from those 00797 media is not necessarily realistic. 00798 00799 The capabilities of role 2 resemble DVD-RAM but it can simulate writing. 00800 If the path does not exist in the filesystem yet, it is attempted to create 00801 it as a regular file as soon as write operations are started. 00802 00803 The capabilities of role 3 resemble a blank DVD-R. 00804 00805 One may distinguish pseudo-drives from MMC drives by call 00806 burn_drive_get_drive_role(). 00807 00808 @param drive_infos On success returns a one element array with the drive 00809 (cdrom/burner). Thus use with driveno 0 only. On failure 00810 the array has no valid elements at all. 00811 The returned array should be freed via burn_drive_info_free() 00812 when it is no longer needed. 00813 This is a result from call burn_drive_scan(). See there. 00814 Use with driveno 0 only. 00815 @param adr The persistent address of the desired drive. Either once 00816 obtained by burn_drive_d_get_adr() or composed skillfully by 00817 application resp. its user. E.g. "/dev/sr0". 00818 Consider to preprocess it by burn_drive_convert_fs_adr(). 00819 @param load Nonzero to make the drive attempt to load a disc (close its 00820 tray door, etc). 00821 @return 1 = success , 0 = drive not found , -1 = other error 00822 */ 00823 int burn_drive_scan_and_grab(struct burn_drive_info *drive_infos[], 00824 char* adr, int load); 00825 00826 00827 /* ts A51221 */ 00828 /** Maximum number of particularly permissible drive addresses */ 00829 #define BURN_DRIVE_WHITELIST_LEN 255 00830 /** Add a device to the list of permissible drives. As soon as some entry is in 00831 the whitelist all non-listed drives are banned from scanning. 00832 @return 1 success, <=0 failure 00833 */ 00834 int burn_drive_add_whitelist(char *device_address); 00835 00836 /** Remove all drives from whitelist. This enables all possible drives. */ 00837 void burn_drive_clear_whitelist(void); 00838 00839 00840 /** Scan for drives. This function MUST be called until it returns nonzero. 00841 In case of re-scanning: 00842 All pointers to struct burn_drive and all struct burn_drive_info arrays 00843 are invalidated by using this function. Do NOT store drive pointers across 00844 calls to this function ! 00845 To avoid invalid pointers one MUST free all burn_drive_info arrays 00846 by burn_drive_info_free() before calling burn_drive_scan() a second time. 00847 If there are drives left, then burn_drive_scan() will refuse to work. 00848 00849 After this call all drives depicted by the returned array are subject 00850 to eventual (O_EXCL) locking. See burn_preset_device_open(). This state 00851 ends either with burn_drive_info_forget() or with burn_drive_release(). 00852 It is unfriendly to other processes on the system to hold drives locked 00853 which one does not definitely plan to use soon. 00854 @param drive_infos Returns an array of drive info items (cdroms/burners). 00855 The returned array must be freed by burn_drive_info_free() 00856 before burn_finish(), and also before calling this function 00857 burn_drive_scan() again. 00858 @param n_drives Returns the number of drive items in drive_infos. 00859 @return 0 while scanning is not complete 00860 >0 when it is finished sucessfully, 00861 <0 when finished but failed. 00862 */ 00863 int burn_drive_scan(struct burn_drive_info *drive_infos[], 00864 unsigned int *n_drives); 00865 00866 /* ts A60904 : ticket 62, contribution by elmom */ 00867 /** Release memory about a single drive and any exclusive lock on it. 00868 Become unable to inquire or grab it. Expect FATAL consequences if you try. 00869 @param drive_info pointer to a single element out of the array 00870 obtained from burn_drive_scan() : &(drive_infos[driveno]) 00871 @param force controls degree of permissible drive usage at the moment this 00872 function is called, and the amount of automatically provided 00873 drive shutdown : 00874 0= drive must be ungrabbed and BURN_DRIVE_IDLE 00875 1= try to release drive resp. accept BURN_DRIVE_GRABBING 00876 Use these two only. Further values are to be defined. 00877 @return 1 on success, 2 if drive was already forgotten, 00878 0 if not permissible, <0 on other failures, 00879 */ 00880 int burn_drive_info_forget(struct burn_drive_info *drive_info, int force); 00881 00882 00883 /** When no longer needed, free a whole burn_drive_info array which was 00884 returned by burn_drive_scan(). 00885 For freeing single drive array elements use burn_drive_info_forget(). 00886 */ 00887 void burn_drive_info_free(struct burn_drive_info drive_infos[]); 00888 00889 00890 /* ts A60823 */ 00891 /** Maximum length+1 to expect with a persistent drive address string */ 00892 #define BURN_DRIVE_ADR_LEN 1024 00893 00894 /** Inquire the persistent address of the given drive. 00895 @param drive The drive to inquire. 00896 @param adr An application provided array of at least BURN_DRIVE_ADR_LEN 00897 characters size. The persistent address gets copied to it. 00898 @return >0 success , <=0 error (due to libburn internal problem) 00899 */ 00900 int burn_drive_d_get_adr(struct burn_drive *drive, char adr[]); 00901 00902 /** Inquire the persistent address of a drive via a given drive_info object. 00903 (Note: This is a legacy call.) 00904 @param drive_info The drive to inquire.Usually some &(drive_infos[driveno]) 00905 @param adr An application provided array of at least BURN_DRIVE_ADR_LEN 00906 characters size. The persistent address gets copied to it. 00907 @return >0 success , <=0 error (due to libburn internal problem) 00908 */ 00909 int burn_drive_get_adr(struct burn_drive_info *drive_info, char adr[]); 00910 00911 00912 /* ts A60922 ticket 33 */ 00913 /** Evaluate whether the given address would be a possible persistent drive 00914 address of libburn. 00915 @return 1 means yes, 0 means no 00916 */ 00917 int burn_drive_is_enumerable_adr(char *adr); 00918 00919 /* ts A60922 ticket 33 */ 00920 /** Try to convert a given existing filesystem address into a persistent drive 00921 address. This succeeds with symbolic links or if a hint about the drive's 00922 system address can be read from the filesystem object and a matching drive 00923 is found. 00924 @param path The address of an existing file system object 00925 @param adr An application provided array of at least BURN_DRIVE_ADR_LEN 00926 characters size. The persistent address gets copied to it. 00927 @return 1 = success , 0 = failure , -1 = severe error 00928 */ 00929 int burn_drive_convert_fs_adr(char *path, char adr[]); 00930 00931 /* ts A60923 */ 00932 /** Try to convert a given SCSI address of bus,host,channel,target,lun into 00933 a persistent drive address. If a SCSI address component parameter is < 0 00934 then it is not decisive and the first enumerated address which matches 00935 the >= 0 parameters is taken as result. 00936 Note: bus and (host,channel) are supposed to be redundant. 00937 @param bus_no "Bus Number" (something like a virtual controller) 00938 @param host_no "Host Number" (something like half a virtual controller) 00939 @param channel_no "Channel Number" (other half of "Host Number") 00940 @param target_no "Target Number" or "SCSI Id" (a device) 00941 @param lun_no "Logical Unit Number" (a sub device) 00942 @param adr An application provided array of at least BURN_DRIVE_ADR_LEN 00943 characters size. The persistent address gets copied to it. 00944 @return 1 = success , 0 = failure , -1 = severe error 00945 */ 00946 int burn_drive_convert_scsi_adr(int bus_no, int host_no, int channel_no, 00947 int target_no, int lun_no, char adr[]); 00948 00949 /* ts A60923 - A61005 */ 00950 /** Try to obtain bus,host,channel,target,lun from path. If there is an SCSI 00951 address at all, then this call should succeed with a persistent 00952 drive address obtained via burn_drive_d_get_adr(). It is also supposed to 00953 succeed with any device file of a (possibly emulated) SCSI device. 00954 @return 1 = success , 0 = failure , -1 = severe error 00955 */ 00956 int burn_drive_obtain_scsi_adr(char *path, int *bus_no, int *host_no, 00957 int *channel_no, int *target_no, int *lun_no); 00958 00959 /** Grab a drive. This must be done before the drive can be used (for reading, 00960 writing, etc). 00961 @param drive The drive to grab. This is found in a returned 00962 burn_drive_info struct. 00963 @param load Nonzero to make the drive attempt to load a disc (close its 00964 tray door, etc). 00965 @return 1 if it was possible to grab the drive, else 0 00966 */ 00967 int burn_drive_grab(struct burn_drive *drive, int load); 00968 00969 00970 /** Release a drive. This should not be done until the drive is no longer 00971 busy (see burn_drive_get_status). 00972 Linux: The drive device file is not reserved afterwards. (O_EXCL, F_SETLK). 00973 @param drive The drive to release. 00974 @param eject Nonzero to make the drive eject the disc in it. 00975 */ 00976 void burn_drive_release(struct burn_drive *drive, int eject); 00977 00978 00979 /* ts A70918 */ 00980 /** Like burn_drive_release() but keeping the drive tray closed and its 00981 eject button disabled. This physically locked drive state will last until 00982 the drive is grabbed again and released via burn_drive_release(). 00983 Programs like eject, cdrecord, growisofs will break that ban too. 00984 @param drive The drive to release and leave locked. 00985 @param flag Bitfield for control purposes (unused yet, submit 0) 00986 @return 1 means success, <=0 means failure 00987 */ 00988 int burn_drive_leave_locked(struct burn_drive *d, int flag); 00989 00990 00991 /** Returns what kind of disc a drive is holding. This function may need to be 00992 called more than once to get a proper status from it. See burn_disc_status 00993 for details. 00994 @param drive The drive to query for a disc. 00995 @return The status of the drive, or what kind of disc is in it. 00996 Note: BURN_DISC_UNGRABBED indicates wrong API usage 00997 */ 00998 enum burn_disc_status burn_disc_get_status(struct burn_drive *drive); 00999 01000 01001 /* ts A61020 */ 01002 /** WARNING: This revives an old bug-like behavior that might be dangerous. 01003 Sets the drive status to BURN_DISC_BLANK if it is BURN_DISC_UNREADY 01004 or BURN_DISC_UNSUITABLE. Thus marking media as writable which actually 01005 failed to declare themselves either blank or (partially) filled. 01006 @return 1 drive status has been set , 0 = unsuitable drive status 01007 */ 01008 int burn_disc_pretend_blank(struct burn_drive *drive); 01009 01010 01011 /* ts A61106 */ 01012 /** WARNING: This overrides the safety measures against unsuitable media. 01013 Sets the drive status to BURN_DISC_FULL if it is BURN_DISC_UNREADY 01014 or BURN_DISC_UNSUITABLE. Thus marking media as blankable which actually 01015 failed to declare themselves either blank or (partially) filled. 01016 */ 01017 int burn_disc_pretend_full(struct burn_drive *drive); 01018 01019 01020 /* ts A61021 */ 01021 /** Reads ATIP information from inserted media. To be obtained via 01022 burn_drive_get_write_speed(), burn_drive_get_min_write_speed(), 01023 burn_drive_get_start_end_lba(). The drive must be grabbed for this call. 01024 @param drive The drive to query. 01025 @return 1=sucess, 0=no valid ATIP info read, -1 severe error 01026 */ 01027 int burn_disc_read_atip(struct burn_drive *drive); 01028 01029 01030 /* ts A61020 */ 01031 /** Returns start and end lba of the media which is currently inserted 01032 in the given drive. The drive has to be grabbed to have hope for reply. 01033 Shortcomming (not a feature): unless burn_disc_read_atip() was called 01034 only blank media will return valid info. 01035 @param drive The drive to query. 01036 @param start_lba Returns the start lba value 01037 @param end_lba Returns the end lba value 01038 @param flag Bitfield for control purposes (unused yet, submit 0) 01039 @return 1 if lba values are valid , 0 if invalid 01040 */ 01041 int burn_drive_get_start_end_lba(struct burn_drive *drive, 01042 int *start_lba, int *end_lba, int flag); 01043 01044 /* ts A61110 */ 01045 /** Read start lba and Next Writeable Address of a track from media. 01046 Usually a track lba is obtained from the result of burn_track_get_entry(). 01047 This call retrieves an updated lba, eventual nwa, and can address the 01048 invisible track to come. 01049 The drive must be grabbed for this call. One may not issue this call 01050 during ongoing burn_disc_write() or burn_disc_erase(). 01051 @param d The drive to query. 01052 @param o If not NULL: write parameters to be set on drive before query 01053 @param trackno 0=next track to come, >0 number of existing track 01054 @param lba return value: start lba 01055 @param nwa return value: Next Writeable Address 01056 @return 1=nwa is valid , 0=nwa is not valid , -1=error 01057 */ 01058 int burn_disc_track_lba_nwa(struct burn_drive *d, struct burn_write_opts *o, 01059 int trackno, int *lba, int *nwa); 01060 01061 /* ts A70131 */ 01062 /** Read start lba of the first track in the last complete session. 01063 This is the first parameter of mkisofs option -C. The second parameter 01064 is nwa as obtained by burn_disc_track_lba_nwa() with trackno 0. 01065 @param d The drive to query. 01066 @param start_lba returns the start address of that track 01067 @return <= 0 : failure, 1 = ok 01068 */ 01069 int burn_disc_get_msc1(struct burn_drive *d, int *start_lba); 01070 01071 01072 /* ts A70213 */ 01073 /** Return the best possible estimation of the currently available capacity of 01074 the media. This might depend on particular write option settings. For 01075 inquiring the space with such a set of options, the drive has to be 01076 grabbed and BURN_DRIVE_IDLE. If not, then one will only get a canned value 01077 from the most recent automatic inquiry (e.g. during last drive grabbing). 01078 An eventual start address from burn_write_opts_set_start_byte() will be 01079 subtracted from the obtained capacity estimation. Negative results get 01080 defaulted to 0. 01081 @param d The drive to query. 01082 @param o If not NULL: write parameters to be set on drive before query 01083 @return number of most probably available free bytes 01084 */ 01085 off_t burn_disc_available_space(struct burn_drive *d, 01086 struct burn_write_opts *o); 01087 01088 01089 /* ts A61202 */ 01090 /** Tells the MMC Profile identifier of the loaded media. The drive must be 01091 grabbed in order to get a non-zero result. 01092 libburn currently writes only to profiles 01093 0x09 "CD-R", 0x0a "CD-RW", 01094 0x11 "DVD-R sequential recording", 0x12 "DVD-RAM", 01095 0x13 "DVD-RW restricted overwrite", 0x14 "DVD-RW sequential recording", 01096 0x1a "DVD+RW", 0x1b "DVD+R" 01097 0x2b "DVD+R/DL" 01098 If enabled by burn_allow_untested_profiles() it also writes to profiles 01099 0x15 "DVD-R/DL sequential recording", 0x43 "BD-RE". 01100 Writeable stdio-drives return this profile: 01101 0xffff "stdio file" 01102 @param d The drive where the media is inserted. 01103 @param pno Profile Number as of mmc5r03c.pdf, table 89 01104 @param name Profile Name (see above list, unknown profiles have empty name) 01105 @return 1 profile is valid, 0 no profile info available 01106 */ 01107 int burn_disc_get_profile(struct burn_drive *d, int *pno, char name[80]); 01108 01109 /** Tells whether a disc can be erased or not 01110 @param d The drive to inquire. 01111 @return Non-zero means erasable 01112 */ 01113 int burn_disc_erasable(struct burn_drive *d); 01114 01115 /** Returns the progress and status of a drive. 01116 @param drive The drive to query busy state for. 01117 @param p Returns the progress of the operation, NULL if you don't care 01118 @return the current status of the drive. See also burn_drive_status. 01119 */ 01120 enum burn_drive_status burn_drive_get_status(struct burn_drive *drive, 01121 struct burn_progress *p); 01122 01123 /** Creates a write_opts struct for burning to the specified drive 01124 must be freed with burn_write_opts_free 01125 @param drive The drive to write with 01126 @return The write_opts, NULL on error 01127 */ 01128 struct burn_write_opts *burn_write_opts_new(struct burn_drive *drive); 01129 01130 01131 /* ts A70901 */ 01132 /** Inquires the drive associated with a burn_write_opts object. 01133 @param opts object to inquire 01134 @return pointer to drive 01135 */ 01136 struct burn_drive *burn_write_opts_get_drive(struct burn_write_opts *opts); 01137 01138 01139 /** Frees a write_opts struct created with burn_write_opts_new 01140 @param opts write_opts to free 01141 */ 01142 void burn_write_opts_free(struct burn_write_opts *opts); 01143 01144 /** Creates a read_opts struct for reading from the specified drive 01145 must be freed with burn_read_opts_free 01146 @param drive The drive to read from 01147 @return The read_opts 01148 */ 01149 struct burn_read_opts *burn_read_opts_new(struct burn_drive *drive); 01150 01151 /** Frees a read_opts struct created with burn_read_opts_new 01152 @param opts write_opts to free 01153 */ 01154 void burn_read_opts_free(struct burn_read_opts *opts); 01155 01156 /** Erase a disc in the drive. The drive must be grabbed successfully BEFORE 01157 calling this functions. Always ensure that the drive reports a status of 01158 BURN_DISC_FULL before calling this function. An erase operation is not 01159 cancellable, as control of the operation is passed wholly to the drive and 01160 there is no way to interrupt it safely. 01161 @param drive The drive with which to erase a disc. 01162 @param fast Nonzero to do a fast erase, where only the disc's headers are 01163 erased; zero to erase the entire disc. 01164 With DVD-RW, fast blanking yields media capable only of DAO. 01165 */ 01166 void burn_disc_erase(struct burn_drive *drive, int fast); 01167 01168 01169 /* ts A70101 - A70112 */ 01170 /** Format media for use with libburn. This currently applies to DVD-RW 01171 in state "Sequential Recording" (profile 0014h) which get formatted to 01172 state "Restricted Overwrite" (profile 0013h). DVD+RW can be "de-iced" 01173 by setting bit2 of flag. Other media cannot be formatted yet. 01174 @param drive The drive with the disc to format. 01175 @param size The size in bytes to be used with the format command. It should 01176 be divisible by 32*1024. The effect of this parameter may 01177 depend on the media profile. 01178 @param flag Bitfield for control purposes: 01179 bit0= after formatting, write the given number of zero-bytes 01180 to the media and eventually perform preliminary closing. 01181 bit1= insist in size 0 even if there is a better default known 01182 bit2= format to maximum available size 01183 bit3= -reserved- 01184 bit4= enforce re-format of (partly) formatted media 01185 bit7= MMC expert application mode (else libburn tries to 01186 choose a suitable format type): 01187 bit8 to bit15 contain the index of the format to use. See 01188 burn_disc_get_formats(), burn_disc_get_format_descr(). 01189 Acceptable types are: 0x00, 0x10, 0x11, 0x13, 0x15, 0x26. 01190 If bit7 is set, bit4 is set automatically. 01191 */ 01192 void burn_disc_format(struct burn_drive *drive, off_t size, int flag); 01193 01194 01195 /* ts A70112 */ 01196 /** Possible formatting status values */ 01197 #define BURN_FORMAT_IS_UNFORMATTED 1 01198 #define BURN_FORMAT_IS_FORMATTED 2 01199 #define BURN_FORMAT_IS_UNKNOWN 3 01200 01201 /** Inquire the formatting status, the associated sizes and the number of 01202 available formats. The info is media specific and stems from MMC command 01203 23h READ FORMAT CAPACITY. See mmc5r03c.pdf 6.24 for background details. 01204 Media type can be determined via burn_disc_get_profile(). 01205 @param drive The drive with the disc to format. 01206 @param status The current formatting status of the inserted media. 01207 See BURN_FORMAT_IS_* macros. Note: "unknown" is the 01208 legal status for quick formatted, yet unwritten DVD-RW. 01209 @param size The size in bytes associated with status. 01210 unformatted: the maximum achievable size of the media 01211 formatted: the currently formatted capacity 01212 unknown: maximum capacity of drive or of media 01213 @param bl_sas Additional info "Block Length/Spare Area Size". 01214 Expected to be constantly 2048 for non-BD media. 01215 @param num_formats The number of available formats. To be used with 01216 burn_disc_get_format_descr() to obtain such a format 01217 and eventually with burn_disc_format() to select one. 01218 @return 1 reply is valid , <=0 failure 01219 */ 01220 int burn_disc_get_formats(struct burn_drive *drive, int *status, off_t *size, 01221 unsigned *bl_sas, int *num_formats); 01222 01223 /** Inquire parameters of an available media format. 01224 @param drive The drive with the disc to format. 01225 @param index The index of the format item. Beginning with 0 up to reply 01226 parameter from burn_disc_get_formats() : num_formats - 1 01227 @param type The format type. See mmc5r03c.pdf, 6.5, 04h FORMAT UNIT. 01228 0x00=full, 0x10=CD-RW/DVD-RW full, 0x11=CD-RW/DVD-RW grow, 01229 0x15=DVD-RW quick, 0x13=DVD-RW quick grow, 01230 0x26=DVD+RW background 01231 @param size The maximum size in bytes achievable with this format. 01232 @param tdp Type Dependent Parameter. See mmc5r03c.pdf. 01233 @return 1 reply is valid , <=0 failure 01234 */ 01235 int burn_disc_get_format_descr(struct burn_drive *drive, int index, 01236 int *type, off_t *size, unsigned *tdp); 01237 01238 01239 01240 /* ts A61109 : this was and is defunct */ 01241 /** Read a disc from the drive and write it to an fd pair. The drive must be 01242 grabbed successfully BEFORE calling this function. Always ensure that the 01243 drive reports a status of BURN_DISC_FULL before calling this function. 01244 @param drive The drive from which to read a disc. 01245 @param o The options for the read operation. 01246 */ 01247 void burn_disc_read(struct burn_drive *drive, const struct burn_read_opts *o); 01248 01249 01250 01251 /* ts A70222 */ 01252 /** The length of a rejection reasons string for burn_precheck_write() and 01253 burn_write_opts_auto_write_type() . 01254 */ 01255 #define BURN_REASONS_LEN 4096 01256 01257 01258 /* ts A70219 */ 01259 /** Examines a completed setup for burn_disc_write() whether it is permissible 01260 with drive and media. This function is called by burn_disc_write() but 01261 an application might be interested in this check in advance. 01262 @param o The options for the writing operation. 01263 @param disc The descrition of the disc to be created 01264 @param reasons Eventually returns a list of rejection reason statements 01265 @param silent 1= do not issue error messages , 0= report problems 01266 @return 1 ok, -1= no recordable media detected, 0= other failure 01267 */ 01268 int burn_precheck_write(struct burn_write_opts *o, struct burn_disc *disc, 01269 char reasons[BURN_REASONS_LEN], int silent); 01270 01271 01272 /** Write a disc in the drive. The drive must be grabbed successfully before 01273 calling this function. Always ensure that the drive reports a status of 01274 BURN_DISC_BLANK ot BURN_DISC_APPENDABLE before calling this function. 01275 Note: write_type BURN_WRITE_SAO is currently not capable of writing a mix 01276 of data and audio tracks. You must use BURN_WRITE_TAO for such sessions. 01277 To be set by burn_write_opts_set_write_type(). 01278 Note: This function is not suitable for overwriting data in the middle of 01279 a valid data area because it is allowed to append trailing data. 01280 For exact random access overwriting use burn_random_access_write(). 01281 @param o The options for the writing operation. 01282 @param disc The struct burn_disc * that described the disc to be created 01283 */ 01284 void burn_disc_write(struct burn_write_opts *o, struct burn_disc *disc); 01285 01286 /** Cancel an operation on a drive. 01287 This will only work when the drive's busy state is BURN_DRIVE_READING or 01288 BURN_DRIVE_WRITING. 01289 @param drive The drive on which to cancel the current operation. 01290 */ 01291 void burn_drive_cancel(struct burn_drive *drive); 01292 01293 01294 /* ts A61223 */ 01295 /** Inquire whether the most recent write run was successful. Reasons for 01296 non-success may be: rejection of burn parameters, abort during fatal errors 01297 during write, a call to burn_drive_cancel() by the application thread. 01298 @param d The drive to inquire. 01299 @return 1=burn seems to have went well, 0=burn failed 01300 */ 01301 int burn_drive_wrote_well(struct burn_drive *d); 01302 01303 01304 /** Convert a minute-second-frame (MSF) value to sector count 01305 @param m Minute component 01306 @param s Second component 01307 @param f Frame component 01308 @return The sector count 01309 */ 01310 int burn_msf_to_sectors(int m, int s, int f); 01311 01312 /** Convert a sector count to minute-second-frame (MSF) 01313 @param sectors The sector count 01314 @param m Returns the minute component 01315 @param s Returns the second component 01316 @param f Returns the frame component 01317 */ 01318 void burn_sectors_to_msf(int sectors, int *m, int *s, int *f); 01319 01320 /** Convert a minute-second-frame (MSF) value to an lba 01321 @param m Minute component 01322 @param s Second component 01323 @param f Frame component 01324 @return The lba 01325 */ 01326 int burn_msf_to_lba(int m, int s, int f); 01327 01328 /** Convert an lba to minute-second-frame (MSF) 01329 @param lba The lba 01330 @param m Returns the minute component 01331 @param s Returns the second component 01332 @param f Returns the frame component 01333 */ 01334 void burn_lba_to_msf(int lba, int *m, int *s, int *f); 01335 01336 /** Create a new disc 01337 @return Pointer to a burn_disc object or NULL on failure. 01338 */ 01339 struct burn_disc *burn_disc_create(void); 01340 01341 /** Delete disc and decrease the reference count on all its sessions 01342 @param d The disc to be freed 01343 */ 01344 void burn_disc_free(struct burn_disc *d); 01345 01346 /** Create a new session 01347 @return Pointer to a burn_session object or NULL on failure. 01348 */ 01349 struct burn_session *burn_session_create(void); 01350 01351 /** Free a session (and decrease reference count on all tracks inside) 01352 @param s Session to be freed 01353 */ 01354 void burn_session_free(struct burn_session *s); 01355 01356 /** Add a session to a disc at a specific position, increasing the 01357 sessions's reference count. 01358 @param d Disc to add the session to 01359 @param s Session to add to the disc 01360 @param pos position to add at (BURN_POS_END is "at the end") 01361 @return 0 for failure, 1 for success 01362 */ 01363 int burn_disc_add_session(struct burn_disc *d, struct burn_session *s, 01364 unsigned int pos); 01365 01366 /** Remove a session from a disc 01367 @param d Disc to remove session from 01368 @param s Session pointer to find and remove 01369 */ 01370 int burn_disc_remove_session(struct burn_disc *d, struct burn_session *s); 01371 01372 01373 /** Create a track (for TAO recording, or to put in a session) */ 01374 struct burn_track *burn_track_create(void); 01375 01376 /** Free a track 01377 @param t Track to free 01378 */ 01379 void burn_track_free(struct burn_track *t); 01380 01381 /** Add a track to a session at specified position 01382 @param s Session to add to 01383 @param t Track to insert in session 01384 @param pos position to add at (BURN_POS_END is "at the end") 01385 @return 0 for failure, 1 for success 01386 */ 01387 int burn_session_add_track(struct burn_session *s, struct burn_track *t, 01388 unsigned int pos); 01389 01390 /** Remove a track from a session 01391 @param s Session to remove track from 01392 @param t Track pointer to find and remove 01393 @return 0 for failure, 1 for success 01394 */ 01395 int burn_session_remove_track(struct burn_session *s, struct burn_track *t); 01396 01397 01398 /** Define the data in a track 01399 @param t the track to define 01400 @param offset The lib will write this many 0s before start of data 01401 @param tail The number of extra 0s to write after data 01402 @param pad 1 means the lib should pad the last sector with 0s if the 01403 track isn't exactly sector sized. (otherwise the lib will 01404 begin reading from the next track) 01405 @param mode data format (bitfield) 01406 */ 01407 void burn_track_define_data(struct burn_track *t, int offset, int tail, 01408 int pad, int mode); 01409 01410 01411 /* ts A61024 */ 01412 /** Define whether a track shall swap bytes of its input stream. 01413 @param t The track to change 01414 @param swap_source_bytes 0=do not swap, 1=swap byte pairs 01415 @return 1=success , 0=unacceptable value 01416 */ 01417 int burn_track_set_byte_swap(struct burn_track *t, int swap_source_bytes); 01418 01419 01420 /** Set the ISRC details for a track 01421 @param t The track to change 01422 @param country the 2 char country code. Each character must be 01423 only numbers or letters. 01424 @param owner 3 char owner code. Each character must be only numbers 01425 or letters. 01426 @param year 2 digit year. A number in 0-99 (Yep, not Y2K friendly). 01427 @param serial 5 digit serial number. A number in 0-99999. 01428 */ 01429 void burn_track_set_isrc(struct burn_track *t, char *country, char *owner, 01430 unsigned char year, unsigned int serial); 01431 01432 /** Disable ISRC parameters for a track 01433 @param t The track to change 01434 */ 01435 void burn_track_clear_isrc(struct burn_track *t); 01436 01437 /** Hide the first track in the "pre gap" of the disc 01438 @param s session to change 01439 @param onoff 1 to enable hiding, 0 to disable 01440 */ 01441 void burn_session_hide_first_track(struct burn_session *s, int onoff); 01442 01443 /** Get the drive's disc struct - free when done 01444 @param d drive to query 01445 @return the disc struct or NULL on failure 01446 */ 01447 struct burn_disc *burn_drive_get_disc(struct burn_drive *d); 01448 01449 /** Set the track's data source 01450 @param t The track to set the data source for 01451 @param s The data source to use for the contents of the track 01452 @return An error code stating if the source is ready for use for 01453 writing the track, or if an error occured 01454 01455 */ 01456 enum burn_source_status burn_track_set_source(struct burn_track *t, 01457 struct burn_source *s); 01458 01459 01460 /* ts A70218 */ 01461 /** Set a default track size to be used only if the track turns out to be of 01462 unpredictable length and if the effective write type demands a fixed size. 01463 This can be useful to enable write types CD SAO or DVD DAO together with 01464 a track source like stdin. If the track source delivers fewer bytes than 01465 announced then the track will be padded up with zeros. 01466 @param t The track to change 01467 @param size The size to set 01468 @return 0=failure 1=sucess 01469 */ 01470 int burn_track_set_default_size(struct burn_track *t, off_t size); 01471 01472 /** Free a burn_source (decrease its refcount and maybe free it) 01473 @param s Source to free 01474 */ 01475 void burn_source_free(struct burn_source *s); 01476 01477 /** Creates a data source for an image file (and maybe subcode file) 01478 @param path The file address for the main channel payload. 01479 @param subpath Eventual address for subchannel data. Only used in exotic 01480 raw write modes. Submit NULL for normal tasks. 01481 @return Pointer to a burn_source object, NULL indicates failure 01482 */ 01483 struct burn_source *burn_file_source_new(const char *path, 01484 const char *subpath); 01485 01486 /** Creates a data source for an image file (a track) from an open 01487 readable filedescriptor, an eventually open readable subcodes file 01488 descriptor and eventually a fixed size in bytes. 01489 @param datafd The source of data. 01490 @param subfd The eventual source of subchannel data. Only used in exotic 01491 raw write modes. Submit -1 for normal tasks. 01492 @param size The eventual fixed size of eventually both fds. 01493 If this value is 0, the size will be determined from datafd. 01494 @return Pointer to a burn_source object, NULL indicates failure 01495 */ 01496 struct burn_source *burn_fd_source_new(int datafd, int subfd, off_t size); 01497 01498 01499 /* ts A70930 */ 01500 /** Creates a fifo which acts as proxy for an already existing data source. 01501 The fifo provides a ring buffer which shall smoothen the data stream 01502 between burn_source and writer thread. Each fifo serves only for one 01503 data source and gets attached to one track as its only data source 01504 by burn_track_set_source(). 01505 A fifo starts its life in "standby" mode with no buffer space allocated. 01506 As soon as its track requires bytes, the fifo establishes a worker thread 01507 and allocates its buffer. After input has ended and all buffer content is 01508 consumed, the buffer space gets freed and the worker thread ends. 01509 This happens asynchronously. So expect two buffers and worker threads to 01510 exist for a short time between tracks. Be modest in your size demands if 01511 multiple tracks are to be expected. 01512 @param inp The burn_source for which the fifo shall act as proxy. 01513 It can be disposed by burn_source_free() immediately 01514 after this call. 01515 @param chunksize The size in bytes of a chunk. Use 2048 for sources 01516 suitable for BURN_BLOCK_MODE1 and 2352 for sources 01517 which deliver for BURN_BLOCK_AUDIO. 01518 Some variations of burn_source might work only with 01519 a particular chunksize. E.g. libisofs demands 2048. 01520 @param chunks The number of chunks to be allocated in ring buffer. 01521 This value must be >= 2. 01522 @param flag Bitfield for control purposes (unused yet, submit 0). 01523 @return A pointer to the newly created burn_source. 01524 Later both burn_sources, inp and the returned fifo, have 01525 to be disposed by calling burn_source_free() for each. 01526 inp can be freed immediately, the returned fifo may be 01527 kept as handle for burn_fifo_inquire_status(). 01528 */ 01529 struct burn_source *burn_fifo_source_new(struct burn_source *inp, 01530 int chunksize, int chunks, int flag); 01531 01532 /* ts A71003 */ 01533 /** Inquires state and fill parameters of a fifo burn_source which was created 01534 by burn_fifo_source_new() . Do not use with other burn_source variants. 01535 @param fifo The fifo object to inquire 01536 @param size The total size of the fifo 01537 @param free_bytes The current free capacity of the fifo 01538 @param status_text Returns a pointer to a constant text, see below 01539 @return <0 reply invalid, >=0 fifo status code: 01540 bit0+1=input status, bit2=consumption status, i.e: 01541 0="standby" : data processing not started yet 01542 1="active" : input and consumption are active 01543 2="ending" : input has ended without error 01544 3="failing" : input had error and ended, 01545 4="unused" : ( consumption has ended before processing start ) 01546 5="abandoned" : consumption has ended prematurely 01547 6="ended" : consumption has ended without input error 01548 7="aborted" : consumption has ended after input error 01549 */ 01550 int burn_fifo_inquire_status(struct burn_source *fifo, int *size, 01551 int *free_bytes, char **status_text); 01552 01553 01554 /* ts A70328 */ 01555 /** Sets a fixed track size after the data source object has already been 01556 created. 01557 @param t The track to operate on 01558 @param size the number of bytes to use as track size 01559 @return <=0 indicates failure , >0 success 01560 */ 01561 int burn_track_set_size(struct burn_track *t, off_t size); 01562 01563 01564 /** Tells how long a track will be on disc 01565 >>> NOTE: Not reliable with tracks of undefined length 01566 */ 01567 int burn_track_get_sectors(struct burn_track *); 01568 01569 01570 /* ts A61101 */ 01571 /** Tells how many source bytes have been read and how many data bytes have 01572 been written by the track during burn */ 01573 int burn_track_get_counters(struct burn_track *t, 01574 off_t *read_bytes, off_t *written_bytes); 01575 01576 01577 /** Sets drive read and write speed 01578 Note: "k" is 1000, not 1024. 1xCD = 176.4 k/s, 1xDVD = 1385 k/s. 01579 Fractional speeds should be rounded up. Like 4xCD = 706. 01580 @param d The drive to set speed for 01581 @param read Read speed in k/s (0 is max, -1 is min). 01582 @param write Write speed in k/s (0 is max, -1 is min). 01583 */ 01584 void burn_drive_set_speed(struct burn_drive *d, int read, int write); 01585 01586 01587 /* ts A70711 */ 01588 /** Controls the behavior with writing when the drive buffer is suspected to 01589 be full. To check and wait for enough free buffer space before writing 01590 will move the task of waiting from the operating system's device driver 01591 to libburn. While writing is going on and waiting is enabled, any write 01592 operation will be checked whether it will fill the drive buffer up to 01593 more than max_percent. If so, then waiting will happen until the buffer 01594 fill is predicted with at most min_percent. 01595 Thus: if min_percent < max_percent then transfer rate will oscillate. 01596 This may allow the driver to operate on other devices, e.g. a disk from 01597 which to read the input for writing. On the other hand, this checking might 01598 reduce maximum throughput to the drive or even get misled by faulty buffer 01599 fill replies from the drive. 01600 If a setting parameter is < 0, then this setting will stay unchanged 01601 by the call. 01602 Known burner or media specific pitfalls: 01603 To have max_percent larger than the burner's best reported buffer fill has 01604 the same effect as min_percent==max_percent. Some burners do not report 01605 their full buffer with all media types. Some are not suitable because 01606 they report their buffer fill with delay. 01607 @param d The drive to control 01608 @param enable 0= disable , 1= enable waiting , (-1 = do not change setting) 01609 @param min_usec Shortest possible sleeping period (given in micro seconds) 01610 @param max_usec Longest possible sleeping period (given in micro seconds) 01611 @param timeout_sec If a single write has to wait longer than this number 01612 of seconds, then waiting gets disabled and mindless 01613 writing starts. A value of 0 disables this timeout. 01614 @param min_percent Minimum of desired buffer oscillation: 25 to 100 01615 @param max_percent Maximum of desired buffer oscillation: 25 to 100 01616 @return 1=success , 0=failure 01617 */ 01618 int burn_drive_set_buffer_waiting(struct burn_drive *d, int enable, 01619 int min_usec, int max_usec, int timeout_sec, 01620 int min_percent, int max_percent); 01621 01622 01623 /* these are for my debugging, they will disappear */ 01624 void burn_structure_print_disc(struct burn_disc *d); 01625 void burn_structure_print_session(struct burn_session *s); 01626 void burn_structure_print_track(struct burn_track *t); 01627 01628 /** Sets the write type for the write_opts struct. 01629 Note: write_type BURN_WRITE_SAO is currently not capable of writing a mix 01630 of data and audio tracks. You must use BURN_WRITE_TAO for such sessions. 01631 @param opts The write opts to change 01632 @param write_type The write type to use 01633 @param block_type The block type to use 01634 @return Returns 1 on success and 0 on failure. 01635 */ 01636 int burn_write_opts_set_write_type(struct burn_write_opts *opts, 01637 enum burn_write_types write_type, 01638 int block_type); 01639 01640 01641 /* ts A70207 */ 01642 /** As an alternative to burn_write_opts_set_write_type() this function tries 01643 to find a suitable write type and block type for a given write job 01644 described by opts and disc. To be used after all other setups have been 01645 made, i.e. immediately before burn_disc_write(). 01646 @param opts The nearly complete write opts to change 01647 @param disc The already composed session and track model 01648 @param reasons This text string collects reasons for decision resp. failure 01649 @param flag Bitfield for control purposes: 01650 bit0= do not choose type but check the one that is already set 01651 bit1= do not issue error messages via burn_msgs queue 01652 (is automatically set with bit0) 01653 @return Chosen write type. BURN_WRITE_NONE on failure. 01654 */ 01655 enum burn_write_types burn_write_opts_auto_write_type( 01656 struct burn_write_opts *opts, struct burn_disc *disc, 01657 char reasons[BURN_REASONS_LEN], int flag); 01658 01659 01660 /** Supplies toc entries for writing - not normally required for cd mastering 01661 @param opts The write opts to change 01662 @param count The number of entries 01663 @param toc_entries 01664 */ 01665 void burn_write_opts_set_toc_entries(struct burn_write_opts *opts, 01666 int count, 01667 struct burn_toc_entry *toc_entries); 01668 01669 /** Sets the session format for a disc 01670 @param opts The write opts to change 01671 @param format The session format to set 01672 */ 01673 void burn_write_opts_set_format(struct burn_write_opts *opts, int format); 01674 01675 /** Sets the simulate value for the write_opts struct . 01676 This corresponds to the Test Write bit in MMC mode page 05h. Several media 01677 types do not support this. See struct burn_multi_caps.might_simulate for 01678 actual availability of this feature. 01679 If the media is suitable, the drive will perform burn_write_disc() as a 01680 simulation instead of effective write operations. This means that the 01681 media content and burn_disc_get_status() stay unchanged. 01682 Note: With stdio-drives, the target file gets eventually created, opened, 01683 lseeked, and closed, but not written. So there are effects on it. 01684 Warning: Call burn_random_access_write() will never do simulation because 01685 it does not get any burn_write_opts. 01686 @param opts The write opts to change 01687 @param sim Non-zero enables simulation, 0 enables real writing 01688 @return Returns 1 on success and 0 on failure. 01689 */ 01690 int burn_write_opts_set_simulate(struct burn_write_opts *opts, int sim); 01691 01692 /** Controls buffer underrun prevention 01693 @param opts The write opts to change 01694 @param underrun_proof if non-zero, buffer underrun protection is enabled 01695 @return Returns 1 on success and 0 on failure. 01696 */ 01697 int burn_write_opts_set_underrun_proof(struct burn_write_opts *opts, 01698 int underrun_proof); 01699 01700 /** Sets whether to use opc or not with the write_opts struct 01701 @param opts The write opts to change 01702 @param opc If non-zero, optical power calibration will be performed at 01703 start of burn 01704 01705 */ 01706 void burn_write_opts_set_perform_opc(struct burn_write_opts *opts, int opc); 01707 01708 void burn_write_opts_set_has_mediacatalog(struct burn_write_opts *opts, int has_mediacatalog); 01709 01710 void burn_write_opts_set_mediacatalog(struct burn_write_opts *opts, unsigned char mediacatalog[13]); 01711 01712 01713 /* ts A61106 */ 01714 /** Sets the multi flag which eventually marks the emerging session as not 01715 being the last one and thus creating a BURN_DISC_APPENDABLE media. 01716 @param opts The option object to be manipulated 01717 @param multi 1=media will be appendable, 0=media will be closed (default) 01718 */ 01719 void burn_write_opts_set_multi(struct burn_write_opts *opts, int multi); 01720 01721 01722 /* ts A61222 */ 01723 /** Sets a start address for writing to media and write modes which allow to 01724 choose this address at all (for now: DVD+RW, DVD-RAM, formatted DVD-RW). 01725 now). The address is given in bytes. If it is not -1 then a write run 01726 will fail if choice of start address is not supported or if the block 01727 alignment of the address is not suitable for media and write mode. 01728 Alignment to 32 kB blocks is supposed to be safe with DVD media. 01729 Call burn_disc_get_multi_caps() can obtain the necessary media info. See 01730 resulting struct burn_multi_caps elements .start_adr , .start_alignment , 01731 .start_range_low , .start_range_high . 01732 @param opts The write opts to change 01733 @param value The address in bytes (-1 = start at default address) 01734 */ 01735 void burn_write_opts_set_start_byte(struct burn_write_opts *opts, off_t value); 01736 01737 01738 /* ts A70213 */ 01739 /** Caution: still immature and likely to change. Problems arose with 01740 sequential DVD-RW on one drive. 01741 01742 Controls whether the whole available space of the media shall be filled up 01743 by the last track of the last session. 01744 @param opts The write opts to change 01745 @param fill_up_media If 1 : fill up by last track, if 0 = do not fill up 01746 */ 01747 void burn_write_opts_set_fillup(struct burn_write_opts *opts, 01748 int fill_up_media); 01749 01750 01751 /* ts A70303 */ 01752 /** Eventually makes libburn ignore the failure of some conformance checks: 01753 - the check whether CD write+block type is supported by the drive 01754 - the check whether the media profile supports simulated burning 01755 @param opts The write opts to change 01756 @param use_force 1=ignore above checks, 0=refuse work on failed check 01757 */ 01758 void burn_write_opts_set_force(struct burn_write_opts *opts, int use_force); 01759 01760 01761 /** Sets whether to read in raw mode or not 01762 @param opts The read opts to change 01763 @param raw_mode If non-zero, reading will be done in raw mode, so that everything in the data tracks on the 01764 disc is read, including headers. 01765 */ 01766 void burn_read_opts_set_raw(struct burn_read_opts *opts, int raw_mode); 01767 01768 /** Sets whether to report c2 errors or not 01769 @param opts The read opts to change 01770 @param c2errors If non-zero, report c2 errors. 01771 */ 01772 void burn_read_opts_set_c2errors(struct burn_read_opts *opts, int c2errors); 01773 01774 /** Sets whether to read subcodes from audio tracks or not 01775 @param opts The read opts to change 01776 @param subcodes_audio If non-zero, read subcodes from audio tracks on the disc. 01777 */ 01778 void burn_read_opts_read_subcodes_audio(struct burn_read_opts *opts, 01779 int subcodes_audio); 01780 01781 /** Sets whether to read subcodes from data tracks or not 01782 @param opts The read opts to change 01783 @param subcodes_data If non-zero, read subcodes from data tracks on the disc. 01784 */ 01785 void burn_read_opts_read_subcodes_data(struct burn_read_opts *opts, 01786 int subcodes_data); 01787 01788 /** Sets whether to recover errors if possible 01789 @param opts The read opts to change 01790 @param hardware_error_recovery If non-zero, attempt to recover errors if possible. 01791 */ 01792 void burn_read_opts_set_hardware_error_recovery(struct burn_read_opts *opts, 01793 int hardware_error_recovery); 01794 01795 /** Sets whether to report recovered errors or not 01796 @param opts The read opts to change 01797 @param report_recovered_errors If non-zero, recovered errors will be reported. 01798 */ 01799 void burn_read_opts_report_recovered_errors(struct burn_read_opts *opts, 01800 int report_recovered_errors); 01801 01802 /** Sets whether blocks with unrecoverable errors should be read or not 01803 @param opts The read opts to change 01804 @param transfer_damaged_blocks If non-zero, blocks with unrecoverable errors will still be read. 01805 */ 01806 void burn_read_opts_transfer_damaged_blocks(struct burn_read_opts *opts, 01807 int transfer_damaged_blocks); 01808 01809 /** Sets the number of retries to attempt when trying to correct an error 01810 @param opts The read opts to change 01811 @param hardware_error_retries The number of retries to attempt when correcting an error. 01812 */ 01813 void burn_read_opts_set_hardware_error_retries(struct burn_read_opts *opts, 01814 unsigned char hardware_error_retries); 01815 01816 /** Gets the maximum write speed for a drive and eventually loaded media. 01817 The return value might change by the media type of already loaded media, 01818 again by call burn_drive_grab() and again by call burn_disc_read_atip(). 01819 @param d Drive to query 01820 @return Maximum write speed in K/s 01821 */ 01822 int burn_drive_get_write_speed(struct burn_drive *d); 01823 01824 01825 /* ts A61021 */ 01826 /** Gets the minimum write speed for a drive and eventually loaded media. 01827 The return value might change by the media type of already loaded media, 01828 again by call burn_drive_grab() and again by call burn_disc_read_atip(). 01829 @param d Drive to query 01830 @return Minimum write speed in K/s 01831 */ 01832 int burn_drive_get_min_write_speed(struct burn_drive *d); 01833 01834 01835 /** Gets the maximum read speed for a drive 01836 @param d Drive to query 01837 @return Maximum read speed in K/s 01838 */ 01839 int burn_drive_get_read_speed(struct burn_drive *d); 01840 01841 01842 /* ts A61226 */ 01843 /** Obtain a copy of the current speed descriptor list. The drive's list gets 01844 updated on various occasions such as burn_drive_grab() but the copy 01845 obtained here stays untouched. It has to be disposed via 01846 burn_drive_free_speedlist() when it is not longer needed. Speeds 01847 may appear several times in the list. The list content depends much on 01848 drive and media type. It seems that .source == 1 applies mostly to CD media 01849 whereas .source == 2 applies to any media. 01850 @param d Drive to query 01851 @param speed_list The copy. If empty, *speed_list gets returned as NULL. 01852 @return 1=success , 0=list empty , <0 severe error 01853 */ 01854 int burn_drive_get_speedlist(struct burn_drive *d, 01855 struct burn_speed_descriptor **speed_list); 01856 01857 /* ts A70713 */ 01858 /** Look up the fastest speed descriptor which is not faster than the given 01859 speed_goal. If it is 0, then the fastest one is chosen among the 01860 descriptors with the highest end_lba. If it is -1 then the slowest speed 01861 descriptor is chosen regardless of end_lba. Parameter flag decides whether 01862 the speed goal means write speed or read speed. 01863 @param d Drive to query 01864 @param speed_goal Upper limit for speed, 01865 0=search for maximum speed , -1 search for minimum speed 01866 @param best_descr Result of the search, NULL if no match 01867 @param flag Bitfield for control purposes 01868 bit0= look for best read speed rather than write speed 01869 bit1= look for any source type (else look for source==2 first 01870 and for any other source type only with CD media) 01871 @return >0 indicates a valid best_descr, 0 = no valid best_descr 01872 */ 01873 int burn_drive_get_best_speed(struct burn_drive *d, int speed_goal, 01874 struct burn_speed_descriptor **best_descr, int flag); 01875 01876 01877 /* ts A61226 */ 01878 /** Dispose a speed descriptor list copy which was obtained by 01879 burn_drive_get_speedlist(). 01880 @param speed_list The list copy. *speed_list gets set to NULL. 01881 @return 1=list disposed , 0= *speedlist was already NULL 01882 */ 01883 int burn_drive_free_speedlist(struct burn_speed_descriptor **speed_list); 01884 01885 01886 /* ts A70203 */ 01887 /** The reply structure for burn_disc_get_multi_caps() 01888 */ 01889 struct burn_multi_caps { 01890 01891 /* Multi-session capability allows to keep the media appendable after 01892 writing a session. It also guarantees that the drive will be able 01893 to predict and use the appropriate Next Writeable Address to place 01894 the next session on the media without overwriting the existing ones. 01895 It does not guarantee that the selected write type is able to do 01896 an appending session after the next session. (E.g. CD SAO is capable 01897 of multi-session by keeping a disc appendable. But .might_do_sao 01898 will be 0 afterwards, when checking the appendable media.) 01899 1= media may be kept appendable by burn_write_opts_set_multi(o,1) 01900 0= media will not be appendable 01901 */ 01902 int multi_session; 01903 01904 /* Multi-track capability allows to write more than one track source 01905 during a single session. The written tracks can later be found in 01906 libburn's TOC model with their start addresses and sizes. 01907 1= multiple tracks per session are allowed 01908 0= only one track per session allowed 01909 */ 01910 int multi_track; 01911 01912 /* Start-address capability allows to set a non-zero address with 01913 burn_write_opts_set_start_byte(). Eventually this has to respect 01914 .start_alignment and .start_range_low, .start_range_high in this 01915 structure. 01916 1= non-zero start address is allowed 01917 0= only start address 0 is allowed (to depict the drive's own idea 01918 about the appropriate write start) 01919 */ 01920 int start_adr; 01921 01922 /** The alignment for start addresses. 01923 ( start_address % start_alignment ) must be 0. 01924 */ 01925 off_t start_alignment; 01926 01927 /** The lowest permissible start address. 01928 */ 01929 off_t start_range_low; 01930 01931 /** The highest addressable start address. 01932 */ 01933 off_t start_range_high; 01934 01935 /** Potential availability of write modes 01936 4= needs no size prediction, not to be chosen automatically 01937 3= needs size prediction, not to be chosen automatically 01938 2= available, no size prediction necessary 01939 1= available, needs exact size prediction 01940 0= not available 01941 With CD media (profiles 0x09 and 0x0a) check also the elements 01942 *_block_types of the according write mode. 01943 */ 01944 int might_do_tao; 01945 int might_do_sao; 01946 int might_do_raw; 01947 01948 /** Generally advised write mode. 01949 Not necessarily the one chosen by burn_write_opts_auto_write_type() 01950 because the burn_disc structure might impose particular demands. 01951 */ 01952 enum burn_write_types advised_write_mode; 01953 01954 /** Write mode as given by parameter wt of burn_disc_get_multi_caps(). 01955 */ 01956 enum burn_write_types selected_write_mode; 01957 01958 /** Profile number which was current when the reply was generated */ 01959 int current_profile; 01960 01961 /** Wether the current profile indicates CD media. 1=yes, 0=no */ 01962 int current_is_cd_profile; 01963 01964 /* ts A70528, added to version 0.3.7 */ 01965 /** Wether the current profile is able to perform simulated write */ 01966 int might_simulate; 01967 }; 01968 01969 /** Allocates a struct burn_multi_caps (see above) and fills it with values 01970 which are appropriate for the drive and the loaded media. The drive 01971 must be grabbed for this call. The returned structure has to be disposed 01972 via burn_disc_free_multi_caps() when no longer needed. 01973 @param d The drive to inquire 01974 @param wt With BURN_WRITE_NONE the best capabilities of all write modes 01975 get returned. If set to a write mode like BURN_WRITE_SAO the 01976 capabilities with that particular mode are returned and the 01977 return value is 0 if the desired mode is not possible. 01978 @param caps returns the info structure 01979 @param flag Bitfield for control purposes (unused yet, submit 0) 01980 @return < 0 : error , 0 : writing seems impossible , 1 : writing possible 01981 */ 01982 int burn_disc_get_multi_caps(struct burn_drive *d, enum burn_write_types wt, 01983 struct burn_multi_caps **caps, int flag); 01984 01985 /** Removes from memory a multi session info structure which was returned by 01986 burn_disc_get_multi_caps(). The pointer *caps gets set to NULL. 01987 @param caps the info structure to dispose (note: pointer to pointer) 01988 @return 0 : *caps was already NULL, 1 : memory object was disposed 01989 */ 01990 int burn_disc_free_multi_caps(struct burn_multi_caps **caps); 01991 01992 01993 /** Gets a copy of the toc_entry structure associated with a track 01994 @param t Track to get the entry from 01995 @param entry Struct for the library to fill out 01996 */ 01997 void burn_track_get_entry(struct burn_track *t, struct burn_toc_entry *entry); 01998 01999 /** Gets a copy of the toc_entry structure associated with a session's lead out 02000 @param s Session to get the entry from 02001 @param entry Struct for the library to fill out 02002 */ 02003 void burn_session_get_leadout_entry(struct burn_session *s, 02004 struct burn_toc_entry *entry); 02005 02006 /** Gets an array of all the sessions for the disc 02007 THIS IS NO LONGER VALID AFTER YOU ADD OR REMOVE A SESSION 02008 @param d Disc to get session array for 02009 @param num Returns the number of sessions in the array 02010 @return array of sessions 02011 */ 02012 struct burn_session **burn_disc_get_sessions(struct burn_disc *d, 02013 int *num); 02014 02015 int burn_disc_get_sectors(struct burn_disc *d); 02016 02017 /** Gets an array of all the tracks for a session 02018 THIS IS NO LONGER VALID AFTER YOU ADD OR REMOVE A TRACK 02019 @param s session to get track array for 02020 @param num Returns the number of tracks in the array 02021 @return array of tracks 02022 */ 02023 struct burn_track **burn_session_get_tracks(struct burn_session *s, 02024 int *num); 02025 02026 int burn_session_get_sectors(struct burn_session *s); 02027 02028 /** Gets the mode of a track 02029 @param track the track to query 02030 @return the track's mode 02031 */ 02032 int burn_track_get_mode(struct burn_track *track); 02033 02034 /** Returns whether the first track of a session is hidden in the pregap 02035 @param session the session to query 02036 @return non-zero means the first track is hidden 02037 */ 02038 int burn_session_get_hidefirst(struct burn_session *session); 02039 02040 /** Returns the library's version in its parts. 02041 This is the runtime counterpart of the three build time macros 02042 burn_header_version_* below. 02043 @param major The major version number 02044 @param minor The minor version number 02045 @param micro The micro version number 02046 */ 02047 void burn_version(int *major, int *minor, int *micro); 02048 02049 02050 /* ts A80129 */ 02051 /** These three release version numbers tell the revision of this header file 02052 and of the API it describes. They are memorized by applications at build 02053 time. 02054 Immediately after burn_initialize() an application should do this check: 02055 burn_version(&major, &minor, µ); 02056 if(major > burn_header_version_major 02057 || (major == burn_header_version_major 02058 && (minor > burn_header_version_minor 02059 || (minor == burn_header_version_minor 02060 && micro >= burn_header_version_micro)))) { 02061 ... Young enough. Go on with program run .... 02062 } else { 02063 ... Too old. Do not use this libburn version ... 02064 } 02065 02066 */ 02067 #define burn_header_version_major 0 02068 #define burn_header_version_minor 4 02069 #define burn_header_version_micro 4 02070 /** Note: 02071 Above version numbers are also recorded in configure.ac because libtool 02072 wants them as parameters at build time. 02073 For the library compatibility check BURN_*_VERSION in configure.ac 02074 are not decisive. Only the three numbers above do matter. 02075 */ 02076 /** Usage discussion: 02077 02078 Some developers of the libburnia project have differing 02079 opinions how to ensure the compatibility of libaries 02080 and applications. 02081 02082 It is about whether to use at compile time and at runtime 02083 the version numbers isoburn_header_version_* provided here. 02084 Thomas Schmitt advises to use them. 02085 Vreixo Formoso advises to use other means. 02086 02087 At compile time: 02088 02089 Vreixo Formoso advises to leave proper version matching 02090 to properly programmed checks in the the application's 02091 build system, which will eventually refuse compilation. 02092 02093 Thomas Schmitt advises to use the macros defined here 02094 for comparison with the application's requirements of 02095 library revisions and to eventually break compilation. 02096 02097 Both advises are combinable. I.e. be master of your 02098 build system and have #if checks in the source code 02099 of your application, nevertheless. 02100 02101 At runtime (via *_is_compatible()): 02102 02103 Vreixo Formoso advises to compare the application's 02104 requirements of library revisions with the runtime 02105 library. This is to allow runtime libraries which are 02106 young enough for the application but too old for 02107 the lib*.h files seen at compile time. 02108 02109 Thomas Schmitt advises to compare the header 02110 revisions defined here with the runtime library. 02111 This is to enforce a strictly monotonous chain 02112 of revisions from app to header to library, 02113 at the cost of excluding some older libraries. 02114 02115 These two advises are mutually exclusive. 02116 02117 */ 02118 02119 02120 /* ts A60924 : ticket 74 */ 02121 /** Control queueing and stderr printing of messages from libburn. 02122 Severity may be one of "NEVER", "ABORT", "FATAL", "FAILURE", "SORRY", 02123 "WARNING", "HINT", "NOTE", "UPDATE", "DEBUG", "ALL". 02124 @param queue_severity Gives the minimum limit for messages to be queued. 02125 Default: "NEVER". If you queue messages then you 02126 must consume them by burn_msgs_obtain(). 02127 @param print_severity Does the same for messages to be printed directly 02128 to stderr. Default: "FATAL". 02129 @param print_id A text prefix to be printed before the message. 02130 @return >0 for success, <=0 for error 02131 02132 */ 02133 int burn_msgs_set_severities(char *queue_severity, 02134 char *print_severity, char *print_id); 02135 02136 /* ts A60924 : ticket 74 */ 02137 #define BURN_MSGS_MESSAGE_LEN 4096 02138 02139 /** Obtain the oldest pending libburn message from the queue which has at 02140 least the given minimum_severity. This message and any older message of 02141 lower severity will get discarded from the queue and is then lost forever. 02142 @param minimum_severity may be one of "NEVER", "ABORT", "FATAL", 02143 "FAILURE", "SORRY", "WARNING", "HINT", "NOTE", "UPDATE", 02144 "DEBUG", "ALL". 02145 To call with minimum_severity "NEVER" will discard the 02146 whole queue. 02147 @param error_code Will become a unique error code as liste in 02148 libburn/libdax_msgs.h 02149 @param msg_text Must provide at least BURN_MSGS_MESSAGE_LEN bytes. 02150 @param os_errno Will become the eventual errno related to the message 02151 @param severity Will become the severity related to the message and 02152 should provide at least 80 bytes. 02153 @return 1 if a matching item was found, 0 if not, <0 for severe errors 02154 */ 02155 int burn_msgs_obtain(char *minimum_severity, 02156 int *error_code, char msg_text[], int *os_errno, 02157 char severity[]); 02158 02159 02160 /* ts A70922 */ 02161 /** Submit a message to the libburn queueing system. It will be queued or 02162 printed as if it was generated by libburn itself. 02163 @param error_code The unique error code of your message. 02164 Submit 0 if you do not have reserved error codes within 02165 the libburnia project. 02166 @param msg_text Not more than BURN_MSGS_MESSAGE_LEN characters of 02167 message text. 02168 @param os_errno Eventual errno related to the message. Submit 0 if 02169 the message is not related to a operating system error. 02170 @param severity One of "ABORT", "FATAL", "FAILURE", "SORRY", "WARNING", 02171 "HINT", "NOTE", "UPDATE", "DEBUG". Defaults to "FATAL". 02172 @param d An eventual drive to which the message shall be related. 02173 Submit NULL if the message is not specific to a 02174 particular drive object. 02175 @return 1 if message was delivered, <=0 if failure 02176 */ 02177 int burn_msgs_submit(int error_code, char msg_text[], int os_errno, 02178 char severity[], struct burn_drive *d); 02179 02180 02181 /* ts A71016 */ 02182 /** Convert a severity name into a severity number, which gives the severity 02183 rank of the name. 02184 @param severity_name A name as with burn_msgs_submit(), e.g. "SORRY". 02185 @param severity_number The rank number: the higher, the more severe. 02186 @param flag Bitfield for control purposes (unused yet, submit 0) 02187 @return >0 success, <=0 failure 02188 */ 02189 int burn_text_to_sev(char *severity_name, int *severity_number, int flag); 02190 02191 02192 /* ts A80202 : @since 0.4.4 */ 02193 /** Convert a severity number into a severity name 02194 @param severity_number The rank number: the higher, the more severe. 02195 @param severity_name A name as with burn_msgs_submit(), e.g. "SORRY". 02196 @param flag Bitfield for control purposes (unused yet, submit 0) 02197 */ 02198 int burn_sev_to_text(int severity_number, char **severity_name, int flag); 02199 02200 02201 02202 /* ts A70915 */ 02203 /** Replace the messenger object handle of libburn by a compatible handle 02204 obtained from a related library. 02205 See also: libisofs, API function iso_get_messenger(). 02206 @param messenger The foreign but compatible message handle. 02207 @return 1 : success, <=0 : failure 02208 */ 02209 int burn_set_messenger(void *messenger); 02210 02211 02212 /* ts A61002 */ 02213 /** The prototype of a handler function suitable for burn_set_abort_handling(). 02214 Such a function has to return -2 if it does not want the process to 02215 exit with value 1. 02216 */ 02217 typedef int (*burn_abort_handler_t)(void *handle, int signum, int flag); 02218 02219 /** Control builtin signal handling. See also burn_abort(). 02220 @param handle Opaque handle eventually pointing to an application 02221 provided memory object 02222 @param handler A function to be called on signals. It will get handle as 02223 argument. It should finally call burn_abort(). See there. 02224 @param mode : 0 call handler(handle, signum, 0) on nearly all signals 02225 1 enable system default reaction on all signals 02226 2 try to ignore nearly all signals 02227 10 like mode 2 but handle SIGABRT like with mode 0 02228 Arguments (text, NULL, 0) activate the builtin abort handler. It will 02229 eventually call burn_abort() and then perform exit(1). If text is not NULL 02230 then it is used as prefix for pacifier messages of burn_abort_pacifier(). 02231 */ 02232 void burn_set_signal_handling(void *handle, burn_abort_handler_t handler, 02233 int mode); 02234 02235 02236 /* ts A70811 */ 02237 /** Write data in random access mode. 02238 The drive must be grabbed successfully before calling this function which 02239 circumvents usual libburn session processing and rather writes data without 02240 preparations or finalizing. This will work only with overwriteable media 02241 which are also suitable for burn_write_opts_set_start_byte(). The same 02242 address alignment restrictions as with this function apply. I.e. for DVD 02243 it is best to align to 32 KiB blocks (= 16 LBA units). The amount of data 02244 to be written is subject to the same media dependent alignment rules. 02245 Again, 32 KiB is most safe. 02246 Call burn_disc_get_multi_caps() can obtain the necessary media info. See 02247 resulting struct burn_multi_caps elements .start_adr , .start_alignment , 02248 .start_range_low , .start_range_high . 02249 Other than burn_disc_write() this is a synchronous call which returns 02250 only after the write transaction has ended (sucessfully or not). So it is 02251 wise not to transfer giant amounts of data in a single call. 02252 Important: Data have to fit into the already formatted area of the media. 02253 @param d The drive to which to write 02254 @param byte_address The start address of the write in byte 02255 (1 LBA unit = 2048 bytes) (do respect media alignment) 02256 @param data The bytes to be written 02257 @param data_count The number of those bytes (do respect media alignment) 02258 data_count == 0 is permitted (e.g. to flush the 02259 drive buffer without further data transfer). 02260 @param flag Bitfield for control purposes: 02261 bit0 = flush the drive buffer after eventual writing 02262 @return 1=sucessful , <=0 : number of transfered bytes * -1 02263 */ 02264 int burn_random_access_write(struct burn_drive *d, off_t byte_address, 02265 char *data, off_t data_count, int flag); 02266 02267 02268 /* ts A70812 */ 02269 /** Read data in random access mode. 02270 The drive must be grabbed successfully before calling this function. 02271 With all currently supported drives and media the byte_address has to 02272 be aligned to 2048 bytes. Only data tracks with 2048 bytes per sector 02273 can be read this way. I.e. not CD-audio, not CD-video-stream ... 02274 This is a synchronous call which returns only after the full read job 02275 has ended (sucessfully or not). So it is wise not to read giant amounts 02276 of data in a single call. 02277 @param d The drive to which to write 02278 @param byte_address The start address of the read in byte (aligned to 2048) 02279 @param data A memory buffer capable of taking data_size bytes 02280 @param data_size The amount of data to be read. This does not have to 02281 be aligned to any block size. 02282 @param data_count The amount of data actually read (interesting on error) 02283 @param flag Bitfield for control purposes: 02284 bit0= - reserved - 02285 bit1= do not submit error message if read error 02286 @return 1=sucessful , <=0 an error occured 02287 */ 02288 int burn_read_data(struct burn_drive *d, off_t byte_address, 02289 char data[], off_t data_size, off_t *data_count, int flag); 02290 02291 02292 /* A70904 */ 02293 /** Inquire whether the drive object is a real MMC drive or a pseudo-drive 02294 created by a stdio: address. 02295 @param d The drive to inquire 02296 @return 0= null-drive 02297 1= real MMC drive 02298 2= stdio-drive, random access, read-write 02299 3= stdio-drive, sequential, write-only 02300 */ 02301 int burn_drive_get_drive_role(struct burn_drive *d); 02302 02303 02304 /* ts A70923 */ 02305 /** Find out whether a given address string would lead to the given drive 02306 object. This should be done in advance for track source addresses 02307 with parameter drive_role set to 2. 02308 Although a real MMC drive should hardly exist as two drive objects at 02309 the same time, this can easily happen with stdio-drives. So if more than 02310 one drive is used by the application, then this gesture is advised: 02311 burn_drive_d_get_adr(d2, adr2); 02312 if (burn_drive_equals_adr(d1, adr2, burn_drive_get_drive_role(d2))) 02313 ... Both drive objects point to the same storage facility ... 02314 02315 @param d1 Existing drive object 02316 @param adr2 Address string to be tested. Prefix "stdio:" overrides 02317 parameter drive_role2 by either 0 or 2 as appropriate. 02318 The string must be shorter than BURN_DRIVE_ADR_LEN. 02319 @param drive_role2 Role as burn_drive_get_drive_role() would attribute 02320 to adr2 if it was a drive. Use value 2 for checking track 02321 sources resp. pseudo-drive addresses without "stdio:". 02322 Use 1 for checking drive addresses including those with 02323 prefix "stdio:". 02324 @return 1= adr2 leads to d1 , 0= adr2 seems not to lead to d1, 02325 -1 = adr2 is bad 02326 */ 02327 int burn_drive_equals_adr(struct burn_drive *d1, char *adr2, int drive_role2); 02328 02329 02330 02331 #ifndef DOXYGEN 02332 02333 BURN_END_DECLS 02334 02335 #endif 02336 02337 #endif /*LIBBURN_H*/