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 If you really test such media, then please report the outcome on 00734 libburn-hackers@pykix.org 00735 If ever then this call should be done soon after burn_initialize() before 00736 any drive scanning. 00737 @param yes 1=allow all implemented profiles, 0=only tested media (default) 00738 */ 00739 void burn_allow_untested_profiles(int yes); 00740 00741 00742 /* ts A60823 */ 00743 /** Aquire a drive with known persistent address. 00744 00745 This is the sysadmin friendly way to open one drive and to leave all 00746 others untouched. It bundles the following API calls to form a 00747 non-obtrusive way to use libburn: 00748 burn_drive_add_whitelist() , burn_drive_scan() , burn_drive_grab() 00749 You are *strongly urged* to use this call whenever you know the drive 00750 address in advance. 00751 00752 If not, then you have to use directly above calls. In that case, you are 00753 *strongly urged* to drop any unintended drive which will be exclusively 00754 occupied and not closed by burn_drive_scan(). 00755 This can be done by shutting down the library including a call to 00756 burn_finish(). You may later start a new libburn session and should then 00757 use the function described here with an address obtained after 00758 burn_drive_scan() via burn_drive_d_get_adr(drive_infos[driveno].drive,adr). 00759 Another way is to drop the unwanted drives by burn_drive_info_forget(). 00760 00761 Operating on multiple drives: 00762 00763 Different than with burn_drive_scan() it is allowed to call 00764 burn_drive_scan_and_grab() without giving up any other scanned drives. So 00765 this call can be used to get a collection of more than one aquired drives. 00766 The attempt to aquire the same drive twice will fail, though. 00767 00768 Pseudo-drives: 00769 00770 burn_drive_scan_and_grab() is able to aquire virtual drives which will 00771 accept options much like a MMC burner drive. Many of those options will not 00772 cause any effect, though. The address of a pseudo-drive begins with 00773 prefix "stdio:" followed by a path. 00774 Examples: "stdio:/tmp/pseudo_drive" , "stdio:/dev/null" , "stdio:-" 00775 00776 If the path is empty, the result is a null-drive = drive role 0. 00777 It pretends to have loaded no media and supports no reading or writing. 00778 00779 If the path leads to an existing regular file, or to a not yet existing 00780 file, or to an existing block device, then the result is a random access 00781 stdio-drive capable of reading and writing = drive role 2. 00782 00783 If the path leads to an existing file of any type other than directory, 00784 then the result is a sequential write-only stdio-drive = drive role 3. 00785 00786 The special address form "stdio:/dev/fd/<number>" is interpreted literally 00787 as reference to open file descriptor <number>. This address form coincides 00788 with real files on some systems, but it is in fact hardcoded in libburn. 00789 Special address "stdio:-" means stdout = "stdio:/dev/fd/1". 00790 The role of such a drive is determined by the file type obtained via 00791 fstat(<number>). 00792 00793 Roles 2 and 3 perform all their eventual data transfer activities on a file 00794 via standard i/o functions open(2), lseek(2), read(2), write(2), close(2). 00795 The media profile is reported as 0xffff. Write space information from those 00796 media is not necessarily realistic. 00797 00798 The capabilities of role 2 resemble DVD-RAM but it can simulate writing. 00799 If the path does not exist in the filesystem yet, it is attempted to create 00800 it as a regular file as soon as write operations are started. 00801 00802 The capabilities of role 3 resemble a blank DVD-R. 00803 00804 One may distinguish pseudo-drives from MMC drives by call 00805 burn_drive_get_drive_role(). 00806 00807 @param drive_infos On success returns a one element array with the drive 00808 (cdrom/burner). Thus use with driveno 0 only. On failure 00809 the array has no valid elements at all. 00810 The returned array should be freed via burn_drive_info_free() 00811 when it is no longer needed. 00812 This is a result from call burn_drive_scan(). See there. 00813 Use with driveno 0 only. 00814 @param adr The persistent address of the desired drive. Either once 00815 obtained by burn_drive_d_get_adr() or composed skillfully by 00816 application resp. its user. E.g. "/dev/sr0". 00817 Consider to preprocess it by burn_drive_convert_fs_adr(). 00818 @param load Nonzero to make the drive attempt to load a disc (close its 00819 tray door, etc). 00820 @return 1 = success , 0 = drive not found , -1 = other error 00821 */ 00822 int burn_drive_scan_and_grab(struct burn_drive_info *drive_infos[], 00823 char* adr, int load); 00824 00825 00826 /* ts A51221 */ 00827 /** Maximum number of particularly permissible drive addresses */ 00828 #define BURN_DRIVE_WHITELIST_LEN 255 00829 /** Add a device to the list of permissible drives. As soon as some entry is in 00830 the whitelist all non-listed drives are banned from scanning. 00831 @return 1 success, <=0 failure 00832 */ 00833 int burn_drive_add_whitelist(char *device_address); 00834 00835 /** Remove all drives from whitelist. This enables all possible drives. */ 00836 void burn_drive_clear_whitelist(void); 00837 00838 00839 /** Scan for drives. This function MUST be called until it returns nonzero. 00840 In case of re-scanning: 00841 All pointers to struct burn_drive and all struct burn_drive_info arrays 00842 are invalidated by using this function. Do NOT store drive pointers across 00843 calls to this function ! 00844 To avoid invalid pointers one MUST free all burn_drive_info arrays 00845 by burn_drive_info_free() before calling burn_drive_scan() a second time. 00846 If there are drives left, then burn_drive_scan() will refuse to work. 00847 00848 After this call all drives depicted by the returned array are subject 00849 to eventual (O_EXCL) locking. See burn_preset_device_open(). This state 00850 ends either with burn_drive_info_forget() or with burn_drive_release(). 00851 It is unfriendly to other processes on the system to hold drives locked 00852 which one does not definitely plan to use soon. 00853 @param drive_infos Returns an array of drive info items (cdroms/burners). 00854 The returned array must be freed by burn_drive_info_free() 00855 before burn_finish(), and also before calling this function 00856 burn_drive_scan() again. 00857 @param n_drives Returns the number of drive items in drive_infos. 00858 @return 0 while scanning is not complete 00859 >0 when it is finished sucessfully, 00860 <0 when finished but failed. 00861 */ 00862 int burn_drive_scan(struct burn_drive_info *drive_infos[], 00863 unsigned int *n_drives); 00864 00865 /* ts A60904 : ticket 62, contribution by elmom */ 00866 /** Release memory about a single drive and any exclusive lock on it. 00867 Become unable to inquire or grab it. Expect FATAL consequences if you try. 00868 @param drive_info pointer to a single element out of the array 00869 obtained from burn_drive_scan() : &(drive_infos[driveno]) 00870 @param force controls degree of permissible drive usage at the moment this 00871 function is called, and the amount of automatically provided 00872 drive shutdown : 00873 0= drive must be ungrabbed and BURN_DRIVE_IDLE 00874 1= try to release drive resp. accept BURN_DRIVE_GRABBING 00875 Use these two only. Further values are to be defined. 00876 @return 1 on success, 2 if drive was already forgotten, 00877 0 if not permissible, <0 on other failures, 00878 */ 00879 int burn_drive_info_forget(struct burn_drive_info *drive_info, int force); 00880 00881 00882 /** When no longer needed, free a whole burn_drive_info array which was 00883 returned by burn_drive_scan(). 00884 For freeing single drive array elements use burn_drive_info_forget(). 00885 */ 00886 void burn_drive_info_free(struct burn_drive_info drive_infos[]); 00887 00888 00889 /* ts A60823 */ 00890 /** Maximum length+1 to expect with a persistent drive address string */ 00891 #define BURN_DRIVE_ADR_LEN 1024 00892 00893 /** Inquire the persistent address of the given drive. 00894 @param drive The drive to inquire. 00895 @param adr An application provided array of at least BURN_DRIVE_ADR_LEN 00896 characters size. The persistent address gets copied to it. 00897 @return >0 success , <=0 error (due to libburn internal problem) 00898 */ 00899 int burn_drive_d_get_adr(struct burn_drive *drive, char adr[]); 00900 00901 /** Inquire the persistent address of a drive via a given drive_info object. 00902 (Note: This is a legacy call.) 00903 @param drive_info The drive to inquire.Usually some &(drive_infos[driveno]) 00904 @param adr An application provided array of at least BURN_DRIVE_ADR_LEN 00905 characters size. The persistent address gets copied to it. 00906 @return >0 success , <=0 error (due to libburn internal problem) 00907 */ 00908 int burn_drive_get_adr(struct burn_drive_info *drive_info, char adr[]); 00909 00910 00911 /* ts A60922 ticket 33 */ 00912 /** Evaluate whether the given address would be a possible persistent drive 00913 address of libburn. 00914 @return 1 means yes, 0 means no 00915 */ 00916 int burn_drive_is_enumerable_adr(char *adr); 00917 00918 /* ts A60922 ticket 33 */ 00919 /** Try to convert a given existing filesystem address into a persistent drive 00920 address. This succeeds with symbolic links or if a hint about the drive's 00921 system address can be read from the filesystem object and a matching drive 00922 is found. 00923 @param path The address of an existing file system object 00924 @param adr An application provided array of at least BURN_DRIVE_ADR_LEN 00925 characters size. The persistent address gets copied to it. 00926 @return 1 = success , 0 = failure , -1 = severe error 00927 */ 00928 int burn_drive_convert_fs_adr(char *path, char adr[]); 00929 00930 /* ts A60923 */ 00931 /** Try to convert a given SCSI address of bus,host,channel,target,lun into 00932 a persistent drive address. If a SCSI address component parameter is < 0 00933 then it is not decisive and the first enumerated address which matches 00934 the >= 0 parameters is taken as result. 00935 Note: bus and (host,channel) are supposed to be redundant. 00936 @param bus_no "Bus Number" (something like a virtual controller) 00937 @param host_no "Host Number" (something like half a virtual controller) 00938 @param channel_no "Channel Number" (other half of "Host Number") 00939 @param target_no "Target Number" or "SCSI Id" (a device) 00940 @param lun_no "Logical Unit Number" (a sub device) 00941 @param adr An application provided array of at least BURN_DRIVE_ADR_LEN 00942 characters size. The persistent address gets copied to it. 00943 @return 1 = success , 0 = failure , -1 = severe error 00944 */ 00945 int burn_drive_convert_scsi_adr(int bus_no, int host_no, int channel_no, 00946 int target_no, int lun_no, char adr[]); 00947 00948 /* ts A60923 - A61005 */ 00949 /** Try to obtain bus,host,channel,target,lun from path. If there is an SCSI 00950 address at all, then this call should succeed with a persistent 00951 drive address obtained via burn_drive_d_get_adr(). It is also supposed to 00952 succeed with any device file of a (possibly emulated) SCSI device. 00953 @return 1 = success , 0 = failure , -1 = severe error 00954 */ 00955 int burn_drive_obtain_scsi_adr(char *path, int *bus_no, int *host_no, 00956 int *channel_no, int *target_no, int *lun_no); 00957 00958 /** Grab a drive. This must be done before the drive can be used (for reading, 00959 writing, etc). 00960 @param drive The drive to grab. This is found in a returned 00961 burn_drive_info struct. 00962 @param load Nonzero to make the drive attempt to load a disc (close its 00963 tray door, etc). 00964 @return 1 if it was possible to grab the drive, else 0 00965 */ 00966 int burn_drive_grab(struct burn_drive *drive, int load); 00967 00968 00969 /** Release a drive. This should not be done until the drive is no longer 00970 busy (see burn_drive_get_status). 00971 Linux: The drive device file is not reserved afterwards. (O_EXCL, F_SETLK). 00972 @param drive The drive to release. 00973 @param eject Nonzero to make the drive eject the disc in it. 00974 */ 00975 void burn_drive_release(struct burn_drive *drive, int eject); 00976 00977 00978 /* ts A70918 */ 00979 /** Like burn_drive_release() but keeping the drive tray closed and its 00980 eject button disabled. This physically locked drive state will last until 00981 the drive is grabbed again and released via burn_drive_release(). 00982 Programs like eject, cdrecord, growisofs will break that ban too. 00983 @param drive The drive to release and leave locked. 00984 @param flag Bitfield for control purposes (unused yet, submit 0) 00985 @return 1 means success, <=0 means failure 00986 */ 00987 int burn_drive_leave_locked(struct burn_drive *d, int flag); 00988 00989 00990 /** Returns what kind of disc a drive is holding. This function may need to be 00991 called more than once to get a proper status from it. See burn_disc_status 00992 for details. 00993 @param drive The drive to query for a disc. 00994 @return The status of the drive, or what kind of disc is in it. 00995 Note: BURN_DISC_UNGRABBED indicates wrong API usage 00996 */ 00997 enum burn_disc_status burn_disc_get_status(struct burn_drive *drive); 00998 00999 01000 /* ts A61020 */ 01001 /** WARNING: This revives an old bug-like behavior that might be dangerous. 01002 Sets the drive status to BURN_DISC_BLANK if it is BURN_DISC_UNREADY 01003 or BURN_DISC_UNSUITABLE. Thus marking media as writable which actually 01004 failed to declare themselves either blank or (partially) filled. 01005 @return 1 drive status has been set , 0 = unsuitable drive status 01006 */ 01007 int burn_disc_pretend_blank(struct burn_drive *drive); 01008 01009 01010 /* ts A61106 */ 01011 /** WARNING: This overrides the safety measures against unsuitable media. 01012 Sets the drive status to BURN_DISC_FULL if it is BURN_DISC_UNREADY 01013 or BURN_DISC_UNSUITABLE. Thus marking media as blankable which actually 01014 failed to declare themselves either blank or (partially) filled. 01015 */ 01016 int burn_disc_pretend_full(struct burn_drive *drive); 01017 01018 01019 /* ts A61021 */ 01020 /** Reads ATIP information from inserted media. To be obtained via 01021 burn_drive_get_write_speed(), burn_drive_get_min_write_speed(), 01022 burn_drive_get_start_end_lba(). The drive must be grabbed for this call. 01023 @param drive The drive to query. 01024 @return 1=sucess, 0=no valid ATIP info read, -1 severe error 01025 */ 01026 int burn_disc_read_atip(struct burn_drive *drive); 01027 01028 01029 /* ts A61020 */ 01030 /** Returns start and end lba of the media which is currently inserted 01031 in the given drive. The drive has to be grabbed to have hope for reply. 01032 Shortcomming (not a feature): unless burn_disc_read_atip() was called 01033 only blank media will return valid info. 01034 @param drive The drive to query. 01035 @param start_lba Returns the start lba value 01036 @param end_lba Returns the end lba value 01037 @param flag Bitfield for control purposes (unused yet, submit 0) 01038 @return 1 if lba values are valid , 0 if invalid 01039 */ 01040 int burn_drive_get_start_end_lba(struct burn_drive *drive, 01041 int *start_lba, int *end_lba, int flag); 01042 01043 /* ts A61110 */ 01044 /** Read start lba and Next Writeable Address of a track from media. 01045 Usually a track lba is obtained from the result of burn_track_get_entry(). 01046 This call retrieves an updated lba, eventual nwa, and can address the 01047 invisible track to come. 01048 The drive must be grabbed for this call. One may not issue this call 01049 during ongoing burn_disc_write() or burn_disc_erase(). 01050 @param d The drive to query. 01051 @param o If not NULL: write parameters to be set on drive before query 01052 @param trackno 0=next track to come, >0 number of existing track 01053 @param lba return value: start lba 01054 @param nwa return value: Next Writeable Address 01055 @return 1=nwa is valid , 0=nwa is not valid , -1=error 01056 */ 01057 int burn_disc_track_lba_nwa(struct burn_drive *d, struct burn_write_opts *o, 01058 int trackno, int *lba, int *nwa); 01059 01060 /* ts A70131 */ 01061 /** Read start lba of the first track in the last complete session. 01062 This is the first parameter of mkisofs option -C. The second parameter 01063 is nwa as obtained by burn_disc_track_lba_nwa() with trackno 0. 01064 @param d The drive to query. 01065 @param start_lba returns the start address of that track 01066 @return <= 0 : failure, 1 = ok 01067 */ 01068 int burn_disc_get_msc1(struct burn_drive *d, int *start_lba); 01069 01070 01071 /* ts A70213 */ 01072 /** Return the best possible estimation of the currently available capacity of 01073 the media. This might depend on particular write option settings. For 01074 inquiring the space with such a set of options, the drive has to be 01075 grabbed and BURN_DRIVE_IDLE. If not, then one will only get a canned value 01076 from the most recent automatic inquiry (e.g. during last drive grabbing). 01077 An eventual start address from burn_write_opts_set_start_byte() will be 01078 subtracted from the obtained capacity estimation. Negative results get 01079 defaulted to 0. 01080 @param d The drive to query. 01081 @param o If not NULL: write parameters to be set on drive before query 01082 @return number of most probably available free bytes 01083 */ 01084 off_t burn_disc_available_space(struct burn_drive *d, 01085 struct burn_write_opts *o); 01086 01087 01088 /* ts A61202 */ 01089 /** Tells the MMC Profile identifier of the loaded media. The drive must be 01090 grabbed in order to get a non-zero result. 01091 libburn currently writes only to profiles 01092 0x09 "CD-R", 0x0a "CD-RW", 01093 0x11 "DVD-R sequential recording", 0x12 "DVD-RAM", 01094 0x13 "DVD-RW restricted overwrite", 0x14 "DVD-RW sequential recording", 01095 0x1a "DVD+RW", 0x1b "DVD+R", 01096 0x2b "DVD+R/DL", 0x43 "BD-RE", 01097 0xffff "stdio file" 01098 Note: 0xffff is not a MMC profile but a libburn invention. 01099 If enabled by burn_allow_untested_profiles() it also writes to profiles 01100 0x15 "DVD-R/DL sequential recording", 01101 Read-only are the profiles 01102 0x08 "CD-ROM", 0x10 "DVD-ROM", 01103 0x40 "BD-ROM", 01104 For now read-only are BD-R profiles (testers wanted) 01105 0x41 "BD-R sequential recording", 0x42 "BD-R random recording" 01106 @param d The drive where the media is inserted. 01107 @param pno Profile Number. See also mmc5r03c.pdf, table 89 01108 @param name Profile Name (see above list, unknown profiles have empty name) 01109 @return 1 profile is valid, 0 no profile info available 01110 */ 01111 int burn_disc_get_profile(struct burn_drive *d, int *pno, char name[80]); 01112 01113 /** Tells whether a disc can be erased or not 01114 @param d The drive to inquire. 01115 @return Non-zero means erasable 01116 */ 01117 int burn_disc_erasable(struct burn_drive *d); 01118 01119 /** Returns the progress and status of a drive. 01120 @param drive The drive to query busy state for. 01121 @param p Returns the progress of the operation, NULL if you don't care 01122 @return the current status of the drive. See also burn_drive_status. 01123 */ 01124 enum burn_drive_status burn_drive_get_status(struct burn_drive *drive, 01125 struct burn_progress *p); 01126 01127 /** Creates a write_opts struct for burning to the specified drive 01128 must be freed with burn_write_opts_free 01129 @param drive The drive to write with 01130 @return The write_opts, NULL on error 01131 */ 01132 struct burn_write_opts *burn_write_opts_new(struct burn_drive *drive); 01133 01134 01135 /* ts A70901 */ 01136 /** Inquires the drive associated with a burn_write_opts object. 01137 @param opts object to inquire 01138 @return pointer to drive 01139 */ 01140 struct burn_drive *burn_write_opts_get_drive(struct burn_write_opts *opts); 01141 01142 01143 /** Frees a write_opts struct created with burn_write_opts_new 01144 @param opts write_opts to free 01145 */ 01146 void burn_write_opts_free(struct burn_write_opts *opts); 01147 01148 /** Creates a read_opts struct for reading from the specified drive 01149 must be freed with burn_read_opts_free 01150 @param drive The drive to read from 01151 @return The read_opts 01152 */ 01153 struct burn_read_opts *burn_read_opts_new(struct burn_drive *drive); 01154 01155 /** Frees a read_opts struct created with burn_read_opts_new 01156 @param opts write_opts to free 01157 */ 01158 void burn_read_opts_free(struct burn_read_opts *opts); 01159 01160 /** Erase a disc in the drive. The drive must be grabbed successfully BEFORE 01161 calling this functions. Always ensure that the drive reports a status of 01162 BURN_DISC_FULL before calling this function. An erase operation is not 01163 cancellable, as control of the operation is passed wholly to the drive and 01164 there is no way to interrupt it safely. 01165 @param drive The drive with which to erase a disc. 01166 @param fast Nonzero to do a fast erase, where only the disc's headers are 01167 erased; zero to erase the entire disc. 01168 With DVD-RW, fast blanking yields media capable only of DAO. 01169 */ 01170 void burn_disc_erase(struct burn_drive *drive, int fast); 01171 01172 01173 /* ts A70101 - A70417 */ 01174 /** Format media for use with libburn. This currently applies to DVD-RW 01175 in state "Sequential Recording" (profile 0014h) which get formatted to 01176 state "Restricted Overwrite" (profile 0013h). DVD+RW can be "de-iced" 01177 by setting bit2 of flag. Other media cannot be formatted yet. 01178 This function usually returns while the drive is still in the process 01179 of formatting. The formatting is done, when burn_drive_get_status() 01180 returns BURN_DRIVE_IDLE. This may be immediately after return or may 01181 need several thousand seconds to occur. 01182 @param drive The drive with the disc to format. 01183 @param size The size in bytes to be used with the format command. It should 01184 be divisible by 32*1024. The effect of this parameter may 01185 depend on the media profile and on parameter flag. 01186 @param flag Bitfield for control purposes: 01187 bit0= after formatting, write the given number of zero-bytes 01188 to the media and eventually perform preliminary closing. 01189 bit1+2: size mode 01190 0 = use parameter size as far as it makes sense 01191 1 = insist in size 0 even if there is a better default known 01192 (on DVD-RAM or BD-RE identical to size mode 0) 01193 2 = without bit7: format to maximum available size 01194 with bit7 : take size from indexed format descriptor 01195 3 = without bit7: format to default size 01196 with bit7 : take size from indexed format descriptor 01197 bit3= -reserved- 01198 bit4= enforce re-format of (partly) formatted media 01199 bit5= try to disable eventual defect management 01200 bit6= try to avoid lengthy media certification 01201 bit7= MMC expert application mode (else libburn tries to 01202 choose a suitable format type): 01203 bit8 to bit15 contain the index of the format to use. See 01204 burn_disc_get_formats(), burn_disc_get_format_descr(). 01205 Acceptable types are: 0x00, 0x01, 0x10, 0x11, 0x13, 01206 0x15, 0x26, 0x30, 0x31. 01207 If bit7 is set, bit4 is set automatically. 01208 */ 01209 void burn_disc_format(struct burn_drive *drive, off_t size, int flag); 01210 01211 01212 /* ts A70112 */ 01213 /** Possible formatting status values */ 01214 #define BURN_FORMAT_IS_UNFORMATTED 1 01215 #define BURN_FORMAT_IS_FORMATTED 2 01216 #define BURN_FORMAT_IS_UNKNOWN 3 01217 01218 /** Inquire the formatting status, the associated sizes and the number of 01219 available formats. The info is media specific and stems from MMC command 01220 23h READ FORMAT CAPACITY. See mmc5r03c.pdf 6.24 for background details. 01221 Media type can be determined via burn_disc_get_profile(). 01222 @param drive The drive with the disc to format. 01223 @param status The current formatting status of the inserted media. 01224 See BURN_FORMAT_IS_* macros. Note: "unknown" is the 01225 legal status for quick formatted, yet unwritten DVD-RW. 01226 @param size The size in bytes associated with status. 01227 unformatted: the maximum achievable size of the media 01228 formatted: the currently formatted capacity 01229 unknown: maximum capacity of drive or of media 01230 @param bl_sas Additional info "Block Length/Spare Area Size". 01231 Expected to be constantly 2048 for non-BD media. 01232 @param num_formats The number of available formats. To be used with 01233 burn_disc_get_format_descr() to obtain such a format 01234 and eventually with burn_disc_format() to select one. 01235 @return 1 reply is valid , <=0 failure 01236 */ 01237 int burn_disc_get_formats(struct burn_drive *drive, int *status, off_t *size, 01238 unsigned *bl_sas, int *num_formats); 01239 01240 /** Inquire parameters of an available media format. 01241 @param drive The drive with the disc to format. 01242 @param index The index of the format item. Beginning with 0 up to reply 01243 parameter from burn_disc_get_formats() : num_formats - 1 01244 @param type The format type. See mmc5r03c.pdf, 6.5, 04h FORMAT UNIT. 01245 0x00=full, 0x10=CD-RW/DVD-RW full, 0x11=CD-RW/DVD-RW grow, 01246 0x15=DVD-RW quick, 0x13=DVD-RW quick grow, 01247 0x26=DVD+RW background, 0x30=BD-RE with spare areas, 01248 0x31=BD-RE without spare areas 01249 @param size The maximum size in bytes achievable with this format. 01250 @param tdp Type Dependent Parameter. See mmc5r03c.pdf. 01251 @return 1 reply is valid , <=0 failure 01252 */ 01253 int burn_disc_get_format_descr(struct burn_drive *drive, int index, 01254 int *type, off_t *size, unsigned *tdp); 01255 01256 01257 01258 /* ts A61109 : this was and is defunct */ 01259 /** Read a disc from the drive and write it to an fd pair. The drive must be 01260 grabbed successfully BEFORE calling this function. Always ensure that the 01261 drive reports a status of BURN_DISC_FULL before calling this function. 01262 @param drive The drive from which to read a disc. 01263 @param o The options for the read operation. 01264 */ 01265 void burn_disc_read(struct burn_drive *drive, const struct burn_read_opts *o); 01266 01267 01268 01269 /* ts A70222 */ 01270 /** The length of a rejection reasons string for burn_precheck_write() and 01271 burn_write_opts_auto_write_type() . 01272 */ 01273 #define BURN_REASONS_LEN 4096 01274 01275 01276 /* ts A70219 */ 01277 /** Examines a completed setup for burn_disc_write() whether it is permissible 01278 with drive and media. This function is called by burn_disc_write() but 01279 an application might be interested in this check in advance. 01280 @param o The options for the writing operation. 01281 @param disc The descrition of the disc to be created 01282 @param reasons Eventually returns a list of rejection reason statements 01283 @param silent 1= do not issue error messages , 0= report problems 01284 @return 1 ok, -1= no recordable media detected, 0= other failure 01285 */ 01286 int burn_precheck_write(struct burn_write_opts *o, struct burn_disc *disc, 01287 char reasons[BURN_REASONS_LEN], int silent); 01288 01289 01290 /** Write a disc in the drive. The drive must be grabbed successfully before 01291 calling this function. Always ensure that the drive reports a status of 01292 BURN_DISC_BLANK ot BURN_DISC_APPENDABLE before calling this function. 01293 Note: write_type BURN_WRITE_SAO is currently not capable of writing a mix 01294 of data and audio tracks. You must use BURN_WRITE_TAO for such sessions. 01295 To be set by burn_write_opts_set_write_type(). 01296 Note: This function is not suitable for overwriting data in the middle of 01297 a valid data area because it is allowed to append trailing data. 01298 For exact random access overwriting use burn_random_access_write(). 01299 @param o The options for the writing operation. 01300 @param disc The struct burn_disc * that described the disc to be created 01301 */ 01302 void burn_disc_write(struct burn_write_opts *o, struct burn_disc *disc); 01303 01304 /** Cancel an operation on a drive. 01305 This will only work when the drive's busy state is BURN_DRIVE_READING or 01306 BURN_DRIVE_WRITING. 01307 @param drive The drive on which to cancel the current operation. 01308 */ 01309 void burn_drive_cancel(struct burn_drive *drive); 01310 01311 01312 /* ts A61223 */ 01313 /** Inquire whether the most recent write run was successful. Reasons for 01314 non-success may be: rejection of burn parameters, abort during fatal errors 01315 during write, a call to burn_drive_cancel() by the application thread. 01316 @param d The drive to inquire. 01317 @return 1=burn seems to have went well, 0=burn failed 01318 */ 01319 int burn_drive_wrote_well(struct burn_drive *d); 01320 01321 01322 /** Convert a minute-second-frame (MSF) value to sector count 01323 @param m Minute component 01324 @param s Second component 01325 @param f Frame component 01326 @return The sector count 01327 */ 01328 int burn_msf_to_sectors(int m, int s, int f); 01329 01330 /** Convert a sector count to minute-second-frame (MSF) 01331 @param sectors The sector count 01332 @param m Returns the minute component 01333 @param s Returns the second component 01334 @param f Returns the frame component 01335 */ 01336 void burn_sectors_to_msf(int sectors, int *m, int *s, int *f); 01337 01338 /** Convert a minute-second-frame (MSF) value to an lba 01339 @param m Minute component 01340 @param s Second component 01341 @param f Frame component 01342 @return The lba 01343 */ 01344 int burn_msf_to_lba(int m, int s, int f); 01345 01346 /** Convert an lba to minute-second-frame (MSF) 01347 @param lba The lba 01348 @param m Returns the minute component 01349 @param s Returns the second component 01350 @param f Returns the frame component 01351 */ 01352 void burn_lba_to_msf(int lba, int *m, int *s, int *f); 01353 01354 /** Create a new disc 01355 @return Pointer to a burn_disc object or NULL on failure. 01356 */ 01357 struct burn_disc *burn_disc_create(void); 01358 01359 /** Delete disc and decrease the reference count on all its sessions 01360 @param d The disc to be freed 01361 */ 01362 void burn_disc_free(struct burn_disc *d); 01363 01364 /** Create a new session 01365 @return Pointer to a burn_session object or NULL on failure. 01366 */ 01367 struct burn_session *burn_session_create(void); 01368 01369 /** Free a session (and decrease reference count on all tracks inside) 01370 @param s Session to be freed 01371 */ 01372 void burn_session_free(struct burn_session *s); 01373 01374 /** Add a session to a disc at a specific position, increasing the 01375 sessions's reference count. 01376 @param d Disc to add the session to 01377 @param s Session to add to the disc 01378 @param pos position to add at (BURN_POS_END is "at the end") 01379 @return 0 for failure, 1 for success 01380 */ 01381 int burn_disc_add_session(struct burn_disc *d, struct burn_session *s, 01382 unsigned int pos); 01383 01384 /** Remove a session from a disc 01385 @param d Disc to remove session from 01386 @param s Session pointer to find and remove 01387 */ 01388 int burn_disc_remove_session(struct burn_disc *d, struct burn_session *s); 01389 01390 01391 /** Create a track (for TAO recording, or to put in a session) */ 01392 struct burn_track *burn_track_create(void); 01393 01394 /** Free a track 01395 @param t Track to free 01396 */ 01397 void burn_track_free(struct burn_track *t); 01398 01399 /** Add a track to a session at specified position 01400 @param s Session to add to 01401 @param t Track to insert in session 01402 @param pos position to add at (BURN_POS_END is "at the end") 01403 @return 0 for failure, 1 for success 01404 */ 01405 int burn_session_add_track(struct burn_session *s, struct burn_track *t, 01406 unsigned int pos); 01407 01408 /** Remove a track from a session 01409 @param s Session to remove track from 01410 @param t Track pointer to find and remove 01411 @return 0 for failure, 1 for success 01412 */ 01413 int burn_session_remove_track(struct burn_session *s, struct burn_track *t); 01414 01415 01416 /** Define the data in a track 01417 @param t the track to define 01418 @param offset The lib will write this many 0s before start of data 01419 @param tail The number of extra 0s to write after data 01420 @param pad 1 means the lib should pad the last sector with 0s if the 01421 track isn't exactly sector sized. (otherwise the lib will 01422 begin reading from the next track) 01423 @param mode data format (bitfield) 01424 */ 01425 void burn_track_define_data(struct burn_track *t, int offset, int tail, 01426 int pad, int mode); 01427 01428 01429 /* ts A61024 */ 01430 /** Define whether a track shall swap bytes of its input stream. 01431 @param t The track to change 01432 @param swap_source_bytes 0=do not swap, 1=swap byte pairs 01433 @return 1=success , 0=unacceptable value 01434 */ 01435 int burn_track_set_byte_swap(struct burn_track *t, int swap_source_bytes); 01436 01437 01438 /** Set the ISRC details for a track 01439 @param t The track to change 01440 @param country the 2 char country code. Each character must be 01441 only numbers or letters. 01442 @param owner 3 char owner code. Each character must be only numbers 01443 or letters. 01444 @param year 2 digit year. A number in 0-99 (Yep, not Y2K friendly). 01445 @param serial 5 digit serial number. A number in 0-99999. 01446 */ 01447 void burn_track_set_isrc(struct burn_track *t, char *country, char *owner, 01448 unsigned char year, unsigned int serial); 01449 01450 /** Disable ISRC parameters for a track 01451 @param t The track to change 01452 */ 01453 void burn_track_clear_isrc(struct burn_track *t); 01454 01455 /** Hide the first track in the "pre gap" of the disc 01456 @param s session to change 01457 @param onoff 1 to enable hiding, 0 to disable 01458 */ 01459 void burn_session_hide_first_track(struct burn_session *s, int onoff); 01460 01461 /** Get the drive's disc struct - free when done 01462 @param d drive to query 01463 @return the disc struct or NULL on failure 01464 */ 01465 struct burn_disc *burn_drive_get_disc(struct burn_drive *d); 01466 01467 /** Set the track's data source 01468 @param t The track to set the data source for 01469 @param s The data source to use for the contents of the track 01470 @return An error code stating if the source is ready for use for 01471 writing the track, or if an error occured 01472 01473 */ 01474 enum burn_source_status burn_track_set_source(struct burn_track *t, 01475 struct burn_source *s); 01476 01477 01478 /* ts A70218 */ 01479 /** Set a default track size to be used only if the track turns out to be of 01480 unpredictable length and if the effective write type demands a fixed size. 01481 This can be useful to enable write types CD SAO or DVD DAO together with 01482 a track source like stdin. If the track source delivers fewer bytes than 01483 announced then the track will be padded up with zeros. 01484 @param t The track to change 01485 @param size The size to set 01486 @return 0=failure 1=sucess 01487 */ 01488 int burn_track_set_default_size(struct burn_track *t, off_t size); 01489 01490 /** Free a burn_source (decrease its refcount and maybe free it) 01491 @param s Source to free 01492 */ 01493 void burn_source_free(struct burn_source *s); 01494 01495 /** Creates a data source for an image file (and maybe subcode file) 01496 @param path The file address for the main channel payload. 01497 @param subpath Eventual address for subchannel data. Only used in exotic 01498 raw write modes. Submit NULL for normal tasks. 01499 @return Pointer to a burn_source object, NULL indicates failure 01500 */ 01501 struct burn_source *burn_file_source_new(const char *path, 01502 const char *subpath); 01503 01504 /** Creates a data source for an image file (a track) from an open 01505 readable filedescriptor, an eventually open readable subcodes file 01506 descriptor and eventually a fixed size in bytes. 01507 @param datafd The source of data. 01508 @param subfd The eventual source of subchannel data. Only used in exotic 01509 raw write modes. Submit -1 for normal tasks. 01510 @param size The eventual fixed size of eventually both fds. 01511 If this value is 0, the size will be determined from datafd. 01512 @return Pointer to a burn_source object, NULL indicates failure 01513 */ 01514 struct burn_source *burn_fd_source_new(int datafd, int subfd, off_t size); 01515 01516 01517 /* ts A70930 */ 01518 /** Creates a fifo which acts as proxy for an already existing data source. 01519 The fifo provides a ring buffer which shall smoothen the data stream 01520 between burn_source and writer thread. Each fifo serves only for one 01521 data source and gets attached to one track as its only data source 01522 by burn_track_set_source(). 01523 A fifo starts its life in "standby" mode with no buffer space allocated. 01524 As soon as its track requires bytes, the fifo establishes a worker thread 01525 and allocates its buffer. After input has ended and all buffer content is 01526 consumed, the buffer space gets freed and the worker thread ends. 01527 This happens asynchronously. So expect two buffers and worker threads to 01528 exist for a short time between tracks. Be modest in your size demands if 01529 multiple tracks are to be expected. 01530 @param inp The burn_source for which the fifo shall act as proxy. 01531 It can be disposed by burn_source_free() immediately 01532 after this call. 01533 @param chunksize The size in bytes of a chunk. Use 2048 for sources 01534 suitable for BURN_BLOCK_MODE1 and 2352 for sources 01535 which deliver for BURN_BLOCK_AUDIO. 01536 Some variations of burn_source might work only with 01537 a particular chunksize. E.g. libisofs demands 2048. 01538 @param chunks The number of chunks to be allocated in ring buffer. 01539 This value must be >= 2. 01540 @param flag Bitfield for control purposes (unused yet, submit 0). 01541 @return A pointer to the newly created burn_source. 01542 Later both burn_sources, inp and the returned fifo, have 01543 to be disposed by calling burn_source_free() for each. 01544 inp can be freed immediately, the returned fifo may be 01545 kept as handle for burn_fifo_inquire_status(). 01546 */ 01547 struct burn_source *burn_fifo_source_new(struct burn_source *inp, 01548 int chunksize, int chunks, int flag); 01549 01550 /* ts A71003 */ 01551 /** Inquires state and fill parameters of a fifo burn_source which was created 01552 by burn_fifo_source_new() . Do not use with other burn_source variants. 01553 @param fifo The fifo object to inquire 01554 @param size The total size of the fifo 01555 @param free_bytes The current free capacity of the fifo 01556 @param status_text Returns a pointer to a constant text, see below 01557 @return <0 reply invalid, >=0 fifo status code: 01558 bit0+1=input status, bit2=consumption status, i.e: 01559 0="standby" : data processing not started yet 01560 1="active" : input and consumption are active 01561 2="ending" : input has ended without error 01562 3="failing" : input had error and ended, 01563 4="unused" : ( consumption has ended before processing start ) 01564 5="abandoned" : consumption has ended prematurely 01565 6="ended" : consumption has ended without input error 01566 7="aborted" : consumption has ended after input error 01567 */ 01568 int burn_fifo_inquire_status(struct burn_source *fifo, int *size, 01569 int *free_bytes, char **status_text); 01570 01571 01572 /* ts A70328 */ 01573 /** Sets a fixed track size after the data source object has already been 01574 created. 01575 @param t The track to operate on 01576 @param size the number of bytes to use as track size 01577 @return <=0 indicates failure , >0 success 01578 */ 01579 int burn_track_set_size(struct burn_track *t, off_t size); 01580 01581 01582 /** Tells how long a track will be on disc 01583 >>> NOTE: Not reliable with tracks of undefined length 01584 */ 01585 int burn_track_get_sectors(struct burn_track *); 01586 01587 01588 /* ts A61101 */ 01589 /** Tells how many source bytes have been read and how many data bytes have 01590 been written by the track during burn */ 01591 int burn_track_get_counters(struct burn_track *t, 01592 off_t *read_bytes, off_t *written_bytes); 01593 01594 01595 /** Sets drive read and write speed 01596 Note: "k" is 1000, not 1024. 1xCD = 176.4 k/s, 1xDVD = 1385 k/s. 01597 Fractional speeds should be rounded up. Like 4xCD = 706. 01598 @param d The drive to set speed for 01599 @param read Read speed in k/s (0 is max, -1 is min). 01600 @param write Write speed in k/s (0 is max, -1 is min). 01601 */ 01602 void burn_drive_set_speed(struct burn_drive *d, int read, int write); 01603 01604 01605 /* ts A70711 */ 01606 /** Controls the behavior with writing when the drive buffer is suspected to 01607 be full. To check and wait for enough free buffer space before writing 01608 will move the task of waiting from the operating system's device driver 01609 to libburn. While writing is going on and waiting is enabled, any write 01610 operation will be checked whether it will fill the drive buffer up to 01611 more than max_percent. If so, then waiting will happen until the buffer 01612 fill is predicted with at most min_percent. 01613 Thus: if min_percent < max_percent then transfer rate will oscillate. 01614 This may allow the driver to operate on other devices, e.g. a disk from 01615 which to read the input for writing. On the other hand, this checking might 01616 reduce maximum throughput to the drive or even get misled by faulty buffer 01617 fill replies from the drive. 01618 If a setting parameter is < 0, then this setting will stay unchanged 01619 by the call. 01620 Known burner or media specific pitfalls: 01621 To have max_percent larger than the burner's best reported buffer fill has 01622 the same effect as min_percent==max_percent. Some burners do not report 01623 their full buffer with all media types. Some are not suitable because 01624 they report their buffer fill with delay. 01625 @param d The drive to control 01626 @param enable 0= disable , 1= enable waiting , (-1 = do not change setting) 01627 @param min_usec Shortest possible sleeping period (given in micro seconds) 01628 @param max_usec Longest possible sleeping period (given in micro seconds) 01629 @param timeout_sec If a single write has to wait longer than this number 01630 of seconds, then waiting gets disabled and mindless 01631 writing starts. A value of 0 disables this timeout. 01632 @param min_percent Minimum of desired buffer oscillation: 25 to 100 01633 @param max_percent Maximum of desired buffer oscillation: 25 to 100 01634 @return 1=success , 0=failure 01635 */ 01636 int burn_drive_set_buffer_waiting(struct burn_drive *d, int enable, 01637 int min_usec, int max_usec, int timeout_sec, 01638 int min_percent, int max_percent); 01639 01640 01641 /* these are for my debugging, they will disappear */ 01642 void burn_structure_print_disc(struct burn_disc *d); 01643 void burn_structure_print_session(struct burn_session *s); 01644 void burn_structure_print_track(struct burn_track *t); 01645 01646 /** Sets the write type for the write_opts struct. 01647 Note: write_type BURN_WRITE_SAO is currently not capable of writing a mix 01648 of data and audio tracks. You must use BURN_WRITE_TAO for such sessions. 01649 @param opts The write opts to change 01650 @param write_type The write type to use 01651 @param block_type The block type to use 01652 @return Returns 1 on success and 0 on failure. 01653 */ 01654 int burn_write_opts_set_write_type(struct burn_write_opts *opts, 01655 enum burn_write_types write_type, 01656 int block_type); 01657 01658 01659 /* ts A70207 */ 01660 /** As an alternative to burn_write_opts_set_write_type() this function tries 01661 to find a suitable write type and block type for a given write job 01662 described by opts and disc. To be used after all other setups have been 01663 made, i.e. immediately before burn_disc_write(). 01664 @param opts The nearly complete write opts to change 01665 @param disc The already composed session and track model 01666 @param reasons This text string collects reasons for decision resp. failure 01667 @param flag Bitfield for control purposes: 01668 bit0= do not choose type but check the one that is already set 01669 bit1= do not issue error messages via burn_msgs queue 01670 (is automatically set with bit0) 01671 @return Chosen write type. BURN_WRITE_NONE on failure. 01672 */ 01673 enum burn_write_types burn_write_opts_auto_write_type( 01674 struct burn_write_opts *opts, struct burn_disc *disc, 01675 char reasons[BURN_REASONS_LEN], int flag); 01676 01677 01678 /** Supplies toc entries for writing - not normally required for cd mastering 01679 @param opts The write opts to change 01680 @param count The number of entries 01681 @param toc_entries 01682 */ 01683 void burn_write_opts_set_toc_entries(struct burn_write_opts *opts, 01684 int count, 01685 struct burn_toc_entry *toc_entries); 01686 01687 /** Sets the session format for a disc 01688 @param opts The write opts to change 01689 @param format The session format to set 01690 */ 01691 void burn_write_opts_set_format(struct burn_write_opts *opts, int format); 01692 01693 /** Sets the simulate value for the write_opts struct . 01694 This corresponds to the Test Write bit in MMC mode page 05h. Several media 01695 types do not support this. See struct burn_multi_caps.might_simulate for 01696 actual availability of this feature. 01697 If the media is suitable, the drive will perform burn_write_disc() as a 01698 simulation instead of effective write operations. This means that the 01699 media content and burn_disc_get_status() stay unchanged. 01700 Note: With stdio-drives, the target file gets eventually created, opened, 01701 lseeked, and closed, but not written. So there are effects on it. 01702 Warning: Call burn_random_access_write() will never do simulation because 01703 it does not get any burn_write_opts. 01704 @param opts The write opts to change 01705 @param sim Non-zero enables simulation, 0 enables real writing 01706 @return Returns 1 on success and 0 on failure. 01707 */ 01708 int burn_write_opts_set_simulate(struct burn_write_opts *opts, int sim); 01709 01710 /** Controls buffer underrun prevention 01711 @param opts The write opts to change 01712 @param underrun_proof if non-zero, buffer underrun protection is enabled 01713 @return Returns 1 on success and 0 on failure. 01714 */ 01715 int burn_write_opts_set_underrun_proof(struct burn_write_opts *opts, 01716 int underrun_proof); 01717 01718 /** Sets whether to use opc or not with the write_opts struct 01719 @param opts The write opts to change 01720 @param opc If non-zero, optical power calibration will be performed at 01721 start of burn 01722 01723 */ 01724 void burn_write_opts_set_perform_opc(struct burn_write_opts *opts, int opc); 01725 01726 void burn_write_opts_set_has_mediacatalog(struct burn_write_opts *opts, int has_mediacatalog); 01727 01728 void burn_write_opts_set_mediacatalog(struct burn_write_opts *opts, unsigned char mediacatalog[13]); 01729 01730 01731 /* ts A61106 */ 01732 /** Sets the multi flag which eventually marks the emerging session as not 01733 being the last one and thus creating a BURN_DISC_APPENDABLE media. 01734 @param opts The option object to be manipulated 01735 @param multi 1=media will be appendable, 0=media will be closed (default) 01736 */ 01737 void burn_write_opts_set_multi(struct burn_write_opts *opts, int multi); 01738 01739 01740 /* ts A61222 */ 01741 /** Sets a start address for writing to media and write modes which allow to 01742 choose this address at all (for now: DVD+RW, DVD-RAM, formatted DVD-RW). 01743 now). The address is given in bytes. If it is not -1 then a write run 01744 will fail if choice of start address is not supported or if the block 01745 alignment of the address is not suitable for media and write mode. 01746 Alignment to 32 kB blocks is supposed to be safe with DVD media. 01747 Call burn_disc_get_multi_caps() can obtain the necessary media info. See 01748 resulting struct burn_multi_caps elements .start_adr , .start_alignment , 01749 .start_range_low , .start_range_high . 01750 @param opts The write opts to change 01751 @param value The address in bytes (-1 = start at default address) 01752 */ 01753 void burn_write_opts_set_start_byte(struct burn_write_opts *opts, off_t value); 01754 01755 01756 /* ts A70213 */ 01757 /** Caution: still immature and likely to change. Problems arose with 01758 sequential DVD-RW on one drive. 01759 01760 Controls whether the whole available space of the media shall be filled up 01761 by the last track of the last session. 01762 @param opts The write opts to change 01763 @param fill_up_media If 1 : fill up by last track, if 0 = do not fill up 01764 */ 01765 void burn_write_opts_set_fillup(struct burn_write_opts *opts, 01766 int fill_up_media); 01767 01768 01769 /* ts A70303 */ 01770 /** Eventually makes libburn ignore the failure of some conformance checks: 01771 - the check whether CD write+block type is supported by the drive 01772 - the check whether the media profile supports simulated burning 01773 @param opts The write opts to change 01774 @param use_force 1=ignore above checks, 0=refuse work on failed check 01775 */ 01776 void burn_write_opts_set_force(struct burn_write_opts *opts, int use_force); 01777 01778 01779 /* ts A80412 */ 01780 /** Eventually makes use of the more modern write command AAh WRITE12 and 01781 sets the Streaming bit. With DVD-RAM this can override the traditional 01782 slowdown to half nominal speed. But if it speeds up writing then it also 01783 disables error management and correction. Weigh your priorities. 01784 This only affects the write operations of burn_disc_write(). 01785 @since 0.4.6 01786 @param opts The write opts to change 01787 @param value 0=use 2Ah WRITE10, 1=use AAh WRITE12 with Streaming bit 01788 */ 01789 void burn_write_opts_set_stream_recording(struct burn_write_opts *opts, 01790 int value); 01791 01792 01793 /** Sets whether to read in raw mode or not 01794 @param opts The read opts to change 01795 @param raw_mode If non-zero, reading will be done in raw mode, so that everything in the data tracks on the 01796 disc is read, including headers. 01797 */ 01798 void burn_read_opts_set_raw(struct burn_read_opts *opts, int raw_mode); 01799 01800 /** Sets whether to report c2 errors or not 01801 @param opts The read opts to change 01802 @param c2errors If non-zero, report c2 errors. 01803 */ 01804 void burn_read_opts_set_c2errors(struct burn_read_opts *opts, int c2errors); 01805 01806 /** Sets whether to read subcodes from audio tracks or not 01807 @param opts The read opts to change 01808 @param subcodes_audio If non-zero, read subcodes from audio tracks on the disc. 01809 */ 01810 void burn_read_opts_read_subcodes_audio(struct burn_read_opts *opts, 01811 int subcodes_audio); 01812 01813 /** Sets whether to read subcodes from data tracks or not 01814 @param opts The read opts to change 01815 @param subcodes_data If non-zero, read subcodes from data tracks on the disc. 01816 */ 01817 void burn_read_opts_read_subcodes_data(struct burn_read_opts *opts, 01818 int subcodes_data); 01819 01820 /** Sets whether to recover errors if possible 01821 @param opts The read opts to change 01822 @param hardware_error_recovery If non-zero, attempt to recover errors if possible. 01823 */ 01824 void burn_read_opts_set_hardware_error_recovery(struct burn_read_opts *opts, 01825 int hardware_error_recovery); 01826 01827 /** Sets whether to report recovered errors or not 01828 @param opts The read opts to change 01829 @param report_recovered_errors If non-zero, recovered errors will be reported. 01830 */ 01831 void burn_read_opts_report_recovered_errors(struct burn_read_opts *opts, 01832 int report_recovered_errors); 01833 01834 /** Sets whether blocks with unrecoverable errors should be read or not 01835 @param opts The read opts to change 01836 @param transfer_damaged_blocks If non-zero, blocks with unrecoverable errors will still be read. 01837 */ 01838 void burn_read_opts_transfer_damaged_blocks(struct burn_read_opts *opts, 01839 int transfer_damaged_blocks); 01840 01841 /** Sets the number of retries to attempt when trying to correct an error 01842 @param opts The read opts to change 01843 @param hardware_error_retries The number of retries to attempt when correcting an error. 01844 */ 01845 void burn_read_opts_set_hardware_error_retries(struct burn_read_opts *opts, 01846 unsigned char hardware_error_retries); 01847 01848 /** Gets the maximum write speed for a drive and eventually loaded media. 01849 The return value might change by the media type of already loaded media, 01850 again by call burn_drive_grab() and again by call burn_disc_read_atip(). 01851 @param d Drive to query 01852 @return Maximum write speed in K/s 01853 */ 01854 int burn_drive_get_write_speed(struct burn_drive *d); 01855 01856 01857 /* ts A61021 */ 01858 /** Gets the minimum write speed for a drive and eventually loaded media. 01859 The return value might change by the media type of already loaded media, 01860 again by call burn_drive_grab() and again by call burn_disc_read_atip(). 01861 @param d Drive to query 01862 @return Minimum write speed in K/s 01863 */ 01864 int burn_drive_get_min_write_speed(struct burn_drive *d); 01865 01866 01867 /** Gets the maximum read speed for a drive 01868 @param d Drive to query 01869 @return Maximum read speed in K/s 01870 */ 01871 int burn_drive_get_read_speed(struct burn_drive *d); 01872 01873 01874 /* ts A61226 */ 01875 /** Obtain a copy of the current speed descriptor list. The drive's list gets 01876 updated on various occasions such as burn_drive_grab() but the copy 01877 obtained here stays untouched. It has to be disposed via 01878 burn_drive_free_speedlist() when it is not longer needed. Speeds 01879 may appear several times in the list. The list content depends much on 01880 drive and media type. It seems that .source == 1 applies mostly to CD media 01881 whereas .source == 2 applies to any media. 01882 @param d Drive to query 01883 @param speed_list The copy. If empty, *speed_list gets returned as NULL. 01884 @return 1=success , 0=list empty , <0 severe error 01885 */ 01886 int burn_drive_get_speedlist(struct burn_drive *d, 01887 struct burn_speed_descriptor **speed_list); 01888 01889 /* ts A70713 */ 01890 /** Look up the fastest speed descriptor which is not faster than the given 01891 speed_goal. If it is 0, then the fastest one is chosen among the 01892 descriptors with the highest end_lba. If it is -1 then the slowest speed 01893 descriptor is chosen regardless of end_lba. Parameter flag decides whether 01894 the speed goal means write speed or read speed. 01895 @param d Drive to query 01896 @param speed_goal Upper limit for speed, 01897 0=search for maximum speed , -1 search for minimum speed 01898 @param best_descr Result of the search, NULL if no match 01899 @param flag Bitfield for control purposes 01900 bit0= look for best read speed rather than write speed 01901 bit1= look for any source type (else look for source==2 first 01902 and for any other source type only with CD media) 01903 @return >0 indicates a valid best_descr, 0 = no valid best_descr 01904 */ 01905 int burn_drive_get_best_speed(struct burn_drive *d, int speed_goal, 01906 struct burn_speed_descriptor **best_descr, int flag); 01907 01908 01909 /* ts A61226 */ 01910 /** Dispose a speed descriptor list copy which was obtained by 01911 burn_drive_get_speedlist(). 01912 @param speed_list The list copy. *speed_list gets set to NULL. 01913 @return 1=list disposed , 0= *speedlist was already NULL 01914 */ 01915 int burn_drive_free_speedlist(struct burn_speed_descriptor **speed_list); 01916 01917 01918 /* ts A70203 */ 01919 /** The reply structure for burn_disc_get_multi_caps() 01920 */ 01921 struct burn_multi_caps { 01922 01923 /* Multi-session capability allows to keep the media appendable after 01924 writing a session. It also guarantees that the drive will be able 01925 to predict and use the appropriate Next Writeable Address to place 01926 the next session on the media without overwriting the existing ones. 01927 It does not guarantee that the selected write type is able to do 01928 an appending session after the next session. (E.g. CD SAO is capable 01929 of multi-session by keeping a disc appendable. But .might_do_sao 01930 will be 0 afterwards, when checking the appendable media.) 01931 1= media may be kept appendable by burn_write_opts_set_multi(o,1) 01932 0= media will not be appendable 01933 */ 01934 int multi_session; 01935 01936 /* Multi-track capability allows to write more than one track source 01937 during a single session. The written tracks can later be found in 01938 libburn's TOC model with their start addresses and sizes. 01939 1= multiple tracks per session are allowed 01940 0= only one track per session allowed 01941 */ 01942 int multi_track; 01943 01944 /* Start-address capability allows to set a non-zero address with 01945 burn_write_opts_set_start_byte(). Eventually this has to respect 01946 .start_alignment and .start_range_low, .start_range_high in this 01947 structure. 01948 1= non-zero start address is allowed 01949 0= only start address 0 is allowed (to depict the drive's own idea 01950 about the appropriate write start) 01951 */ 01952 int start_adr; 01953 01954 /** The alignment for start addresses. 01955 ( start_address % start_alignment ) must be 0. 01956 */ 01957 off_t start_alignment; 01958 01959 /** The lowest permissible start address. 01960 */ 01961 off_t start_range_low; 01962 01963 /** The highest addressable start address. 01964 */ 01965 off_t start_range_high; 01966 01967 /** Potential availability of write modes 01968 4= needs no size prediction, not to be chosen automatically 01969 3= needs size prediction, not to be chosen automatically 01970 2= available, no size prediction necessary 01971 1= available, needs exact size prediction 01972 0= not available 01973 With CD media (profiles 0x09 and 0x0a) check also the elements 01974 *_block_types of the according write mode. 01975 */ 01976 int might_do_tao; 01977 int might_do_sao; 01978 int might_do_raw; 01979 01980 /** Generally advised write mode. 01981 Not necessarily the one chosen by burn_write_opts_auto_write_type() 01982 because the burn_disc structure might impose particular demands. 01983 */ 01984 enum burn_write_types advised_write_mode; 01985 01986 /** Write mode as given by parameter wt of burn_disc_get_multi_caps(). 01987 */ 01988 enum burn_write_types selected_write_mode; 01989 01990 /** Profile number which was current when the reply was generated */ 01991 int current_profile; 01992 01993 /** Wether the current profile indicates CD media. 1=yes, 0=no */ 01994 int current_is_cd_profile; 01995 01996 /* ts A70528, added to version 0.3.7 */ 01997 /** Wether the current profile is able to perform simulated write */ 01998 int might_simulate; 01999 }; 02000 02001 /** Allocates a struct burn_multi_caps (see above) and fills it with values 02002 which are appropriate for the drive and the loaded media. The drive 02003 must be grabbed for this call. The returned structure has to be disposed 02004 via burn_disc_free_multi_caps() when no longer needed. 02005 @param d The drive to inquire 02006 @param wt With BURN_WRITE_NONE the best capabilities of all write modes 02007 get returned. If set to a write mode like BURN_WRITE_SAO the 02008 capabilities with that particular mode are returned and the 02009 return value is 0 if the desired mode is not possible. 02010 @param caps returns the info structure 02011 @param flag Bitfield for control purposes (unused yet, submit 0) 02012 @return < 0 : error , 0 : writing seems impossible , 1 : writing possible 02013 */ 02014 int burn_disc_get_multi_caps(struct burn_drive *d, enum burn_write_types wt, 02015 struct burn_multi_caps **caps, int flag); 02016 02017 /** Removes from memory a multi session info structure which was returned by 02018 burn_disc_get_multi_caps(). The pointer *caps gets set to NULL. 02019 @param caps the info structure to dispose (note: pointer to pointer) 02020 @return 0 : *caps was already NULL, 1 : memory object was disposed 02021 */ 02022 int burn_disc_free_multi_caps(struct burn_multi_caps **caps); 02023 02024 02025 /** Gets a copy of the toc_entry structure associated with a track 02026 @param t Track to get the entry from 02027 @param entry Struct for the library to fill out 02028 */ 02029 void burn_track_get_entry(struct burn_track *t, struct burn_toc_entry *entry); 02030 02031 /** Gets a copy of the toc_entry structure associated with a session's lead out 02032 @param s Session to get the entry from 02033 @param entry Struct for the library to fill out 02034 */ 02035 void burn_session_get_leadout_entry(struct burn_session *s, 02036 struct burn_toc_entry *entry); 02037 02038 /** Gets an array of all the sessions for the disc 02039 THIS IS NO LONGER VALID AFTER YOU ADD OR REMOVE A SESSION 02040 @param d Disc to get session array for 02041 @param num Returns the number of sessions in the array 02042 @return array of sessions 02043 */ 02044 struct burn_session **burn_disc_get_sessions(struct burn_disc *d, 02045 int *num); 02046 02047 int burn_disc_get_sectors(struct burn_disc *d); 02048 02049 /** Gets an array of all the tracks for a session 02050 THIS IS NO LONGER VALID AFTER YOU ADD OR REMOVE A TRACK 02051 @param s session to get track array for 02052 @param num Returns the number of tracks in the array 02053 @return array of tracks 02054 */ 02055 struct burn_track **burn_session_get_tracks(struct burn_session *s, 02056 int *num); 02057 02058 int burn_session_get_sectors(struct burn_session *s); 02059 02060 /** Gets the mode of a track 02061 @param track the track to query 02062 @return the track's mode 02063 */ 02064 int burn_track_get_mode(struct burn_track *track); 02065 02066 /** Returns whether the first track of a session is hidden in the pregap 02067 @param session the session to query 02068 @return non-zero means the first track is hidden 02069 */ 02070 int burn_session_get_hidefirst(struct burn_session *session); 02071 02072 /** Returns the library's version in its parts. 02073 This is the runtime counterpart of the three build time macros 02074 burn_header_version_* below. 02075 @param major The major version number 02076 @param minor The minor version number 02077 @param micro The micro version number 02078 */ 02079 void burn_version(int *major, int *minor, int *micro); 02080 02081 02082 /* ts A80129 */ 02083 /** These three release version numbers tell the revision of this header file 02084 and of the API it describes. They are memorized by applications at build 02085 time. 02086 Immediately after burn_initialize() an application should do this check: 02087 burn_version(&major, &minor, µ); 02088 if(major > burn_header_version_major 02089 || (major == burn_header_version_major 02090 && (minor > burn_header_version_minor 02091 || (minor == burn_header_version_minor 02092 && micro >= burn_header_version_micro)))) { 02093 ... Young enough. Go on with program run .... 02094 } else { 02095 ... Too old. Do not use this libburn version ... 02096 } 02097 02098 */ 02099 #define burn_header_version_major 0 02100 #define burn_header_version_minor 4 02101 #define burn_header_version_micro 8 02102 /** Note: 02103 Above version numbers are also recorded in configure.ac because libtool 02104 wants them as parameters at build time. 02105 For the library compatibility check BURN_*_VERSION in configure.ac 02106 are not decisive. Only the three numbers above do matter. 02107 */ 02108 /** Usage discussion: 02109 02110 Some developers of the libburnia project have differing 02111 opinions how to ensure the compatibility of libaries 02112 and applications. 02113 02114 It is about whether to use at compile time and at runtime 02115 the version numbers isoburn_header_version_* provided here. 02116 Thomas Schmitt advises to use them. 02117 Vreixo Formoso advises to use other means. 02118 02119 At compile time: 02120 02121 Vreixo Formoso advises to leave proper version matching 02122 to properly programmed checks in the the application's 02123 build system, which will eventually refuse compilation. 02124 02125 Thomas Schmitt advises to use the macros defined here 02126 for comparison with the application's requirements of 02127 library revisions and to eventually break compilation. 02128 02129 Both advises are combinable. I.e. be master of your 02130 build system and have #if checks in the source code 02131 of your application, nevertheless. 02132 02133 At runtime (via *_is_compatible()): 02134 02135 Vreixo Formoso advises to compare the application's 02136 requirements of library revisions with the runtime 02137 library. This is to allow runtime libraries which are 02138 young enough for the application but too old for 02139 the lib*.h files seen at compile time. 02140 02141 Thomas Schmitt advises to compare the header 02142 revisions defined here with the runtime library. 02143 This is to enforce a strictly monotonous chain 02144 of revisions from app to header to library, 02145 at the cost of excluding some older libraries. 02146 02147 These two advises are mutually exclusive. 02148 02149 */ 02150 02151 02152 /* ts A60924 : ticket 74 */ 02153 /** Control queueing and stderr printing of messages from libburn. 02154 Severity may be one of "NEVER", "ABORT", "FATAL", "FAILURE", "SORRY", 02155 "WARNING", "HINT", "NOTE", "UPDATE", "DEBUG", "ALL". 02156 @param queue_severity Gives the minimum limit for messages to be queued. 02157 Default: "NEVER". If you queue messages then you 02158 must consume them by burn_msgs_obtain(). 02159 @param print_severity Does the same for messages to be printed directly 02160 to stderr. Default: "FATAL". 02161 @param print_id A text prefix to be printed before the message. 02162 @return >0 for success, <=0 for error 02163 02164 */ 02165 int burn_msgs_set_severities(char *queue_severity, 02166 char *print_severity, char *print_id); 02167 02168 /* ts A60924 : ticket 74 */ 02169 #define BURN_MSGS_MESSAGE_LEN 4096 02170 02171 /** Obtain the oldest pending libburn message from the queue which has at 02172 least the given minimum_severity. This message and any older message of 02173 lower severity will get discarded from the queue and is then lost forever. 02174 @param minimum_severity may be one of "NEVER", "ABORT", "FATAL", 02175 "FAILURE", "SORRY", "WARNING", "HINT", "NOTE", "UPDATE", 02176 "DEBUG", "ALL". 02177 To call with minimum_severity "NEVER" will discard the 02178 whole queue. 02179 @param error_code Will become a unique error code as liste in 02180 libburn/libdax_msgs.h 02181 @param msg_text Must provide at least BURN_MSGS_MESSAGE_LEN bytes. 02182 @param os_errno Will become the eventual errno related to the message 02183 @param severity Will become the severity related to the message and 02184 should provide at least 80 bytes. 02185 @return 1 if a matching item was found, 0 if not, <0 for severe errors 02186 */ 02187 int burn_msgs_obtain(char *minimum_severity, 02188 int *error_code, char msg_text[], int *os_errno, 02189 char severity[]); 02190 02191 02192 /* ts A70922 */ 02193 /** Submit a message to the libburn queueing system. It will be queued or 02194 printed as if it was generated by libburn itself. 02195 @param error_code The unique error code of your message. 02196 Submit 0 if you do not have reserved error codes within 02197 the libburnia project. 02198 @param msg_text Not more than BURN_MSGS_MESSAGE_LEN characters of 02199 message text. 02200 @param os_errno Eventual errno related to the message. Submit 0 if 02201 the message is not related to a operating system error. 02202 @param severity One of "ABORT", "FATAL", "FAILURE", "SORRY", "WARNING", 02203 "HINT", "NOTE", "UPDATE", "DEBUG". Defaults to "FATAL". 02204 @param d An eventual drive to which the message shall be related. 02205 Submit NULL if the message is not specific to a 02206 particular drive object. 02207 @return 1 if message was delivered, <=0 if failure 02208 */ 02209 int burn_msgs_submit(int error_code, char msg_text[], int os_errno, 02210 char severity[], struct burn_drive *d); 02211 02212 02213 /* ts A71016 */ 02214 /** Convert a severity name into a severity number, which gives the severity 02215 rank of the name. 02216 @param severity_name A name as with burn_msgs_submit(), e.g. "SORRY". 02217 @param severity_number The rank number: the higher, the more severe. 02218 @param flag Bitfield for control purposes (unused yet, submit 0) 02219 @return >0 success, <=0 failure 02220 */ 02221 int burn_text_to_sev(char *severity_name, int *severity_number, int flag); 02222 02223 02224 /* ts A80202 */ 02225 /** Convert a severity number into a severity name 02226 @since 0.4.4 02227 @param severity_number The rank number: the higher, the more severe. 02228 @param severity_name A name as with burn_msgs_submit(), e.g. "SORRY". 02229 @param flag Bitfield for control purposes (unused yet, submit 0) 02230 */ 02231 int burn_sev_to_text(int severity_number, char **severity_name, int flag); 02232 02233 02234 02235 /* ts A70915 */ 02236 /** Replace the messenger object handle of libburn by a compatible handle 02237 obtained from a related library. 02238 See also: libisofs, API function iso_get_messenger(). 02239 @param messenger The foreign but compatible message handle. 02240 @return 1 : success, <=0 : failure 02241 */ 02242 int burn_set_messenger(void *messenger); 02243 02244 02245 /* ts A61002 */ 02246 /** The prototype of a handler function suitable for burn_set_abort_handling(). 02247 Such a function has to return -2 if it does not want the process to 02248 exit with value 1. 02249 */ 02250 typedef int (*burn_abort_handler_t)(void *handle, int signum, int flag); 02251 02252 /** Control builtin signal handling. See also burn_abort(). 02253 @param handle Opaque handle eventually pointing to an application 02254 provided memory object 02255 @param handler A function to be called on signals. It will get handle as 02256 argument. It should finally call burn_abort(). See there. 02257 @param mode : 0 call handler(handle, signum, 0) on nearly all signals 02258 1 enable system default reaction on all signals 02259 2 try to ignore nearly all signals 02260 10 like mode 2 but handle SIGABRT like with mode 0 02261 Arguments (text, NULL, 0) activate the builtin abort handler. It will 02262 eventually call burn_abort() and then perform exit(1). If text is not NULL 02263 then it is used as prefix for pacifier messages of burn_abort_pacifier(). 02264 */ 02265 void burn_set_signal_handling(void *handle, burn_abort_handler_t handler, 02266 int mode); 02267 02268 02269 /* ts A70811 */ 02270 /** Write data in random access mode. 02271 The drive must be grabbed successfully before calling this function which 02272 circumvents usual libburn session processing and rather writes data without 02273 preparations or finalizing. This will work only with overwriteable media 02274 which are also suitable for burn_write_opts_set_start_byte(). The same 02275 address alignment restrictions as with this function apply. I.e. for DVD 02276 it is best to align to 32 KiB blocks (= 16 LBA units). The amount of data 02277 to be written is subject to the same media dependent alignment rules. 02278 Again, 32 KiB is most safe. 02279 Call burn_disc_get_multi_caps() can obtain the necessary media info. See 02280 resulting struct burn_multi_caps elements .start_adr , .start_alignment , 02281 .start_range_low , .start_range_high . 02282 Other than burn_disc_write() this is a synchronous call which returns 02283 only after the write transaction has ended (sucessfully or not). So it is 02284 wise not to transfer giant amounts of data in a single call. 02285 Important: Data have to fit into the already formatted area of the media. 02286 @param d The drive to which to write 02287 @param byte_address The start address of the write in byte 02288 (1 LBA unit = 2048 bytes) (do respect media alignment) 02289 @param data The bytes to be written 02290 @param data_count The number of those bytes (do respect media alignment) 02291 data_count == 0 is permitted (e.g. to flush the 02292 drive buffer without further data transfer). 02293 @param flag Bitfield for control purposes: 02294 bit0 = flush the drive buffer after eventual writing 02295 @return 1=sucessful , <=0 : number of transfered bytes * -1 02296 */ 02297 int burn_random_access_write(struct burn_drive *d, off_t byte_address, 02298 char *data, off_t data_count, int flag); 02299 02300 02301 /* ts A70812 */ 02302 /** Read data in random access mode. 02303 The drive must be grabbed successfully before calling this function. 02304 With all currently supported drives and media the byte_address has to 02305 be aligned to 2048 bytes. Only data tracks with 2048 bytes per sector 02306 can be read this way. I.e. not CD-audio, not CD-video-stream ... 02307 This is a synchronous call which returns only after the full read job 02308 has ended (sucessfully or not). So it is wise not to read giant amounts 02309 of data in a single call. 02310 @param d The drive to which to write 02311 @param byte_address The start address of the read in byte (aligned to 2048) 02312 @param data A memory buffer capable of taking data_size bytes 02313 @param data_size The amount of data to be read. This does not have to 02314 be aligned to any block size. 02315 @param data_count The amount of data actually read (interesting on error) 02316 @param flag Bitfield for control purposes: 02317 bit0= - reserved - 02318 bit1= do not submit error message if read error 02319 @return 1=sucessful , <=0 an error occured 02320 */ 02321 int burn_read_data(struct burn_drive *d, off_t byte_address, 02322 char data[], off_t data_size, off_t *data_count, int flag); 02323 02324 02325 /* A70904 */ 02326 /** Inquire whether the drive object is a real MMC drive or a pseudo-drive 02327 created by a stdio: address. 02328 @param d The drive to inquire 02329 @return 0= null-drive 02330 1= real MMC drive 02331 2= stdio-drive, random access, read-write 02332 3= stdio-drive, sequential, write-only 02333 */ 02334 int burn_drive_get_drive_role(struct burn_drive *d); 02335 02336 02337 /* ts A70923 */ 02338 /** Find out whether a given address string would lead to the given drive 02339 object. This should be done in advance for track source addresses 02340 with parameter drive_role set to 2. 02341 Although a real MMC drive should hardly exist as two drive objects at 02342 the same time, this can easily happen with stdio-drives. So if more than 02343 one drive is used by the application, then this gesture is advised: 02344 burn_drive_d_get_adr(d2, adr2); 02345 if (burn_drive_equals_adr(d1, adr2, burn_drive_get_drive_role(d2))) 02346 ... Both drive objects point to the same storage facility ... 02347 02348 @param d1 Existing drive object 02349 @param adr2 Address string to be tested. Prefix "stdio:" overrides 02350 parameter drive_role2 by either 0 or 2 as appropriate. 02351 The string must be shorter than BURN_DRIVE_ADR_LEN. 02352 @param drive_role2 Role as burn_drive_get_drive_role() would attribute 02353 to adr2 if it was a drive. Use value 2 for checking track 02354 sources resp. pseudo-drive addresses without "stdio:". 02355 Use 1 for checking drive addresses including those with 02356 prefix "stdio:". 02357 @return 1= adr2 leads to d1 , 0= adr2 seems not to lead to d1, 02358 -1 = adr2 is bad 02359 */ 02360 int burn_drive_equals_adr(struct burn_drive *d1, char *adr2, int drive_role2); 02361 02362 02363 02364 #ifndef DOXYGEN 02365 02366 BURN_END_DECLS 02367 02368 #endif 02369 02370 #endif /*LIBBURN_H*/