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