00001 /* -*- indent-tabs-mode: t; tab-width: 8; c-basic-offset: 8; -*- */ 00002 00003 /* Copyright (c) 2004 - 2006 Derek Foreman, Ben Jansens 00004 Copyright (c) 2006 - 2011 Thomas Schmitt <scdbackup@gmx.net> 00005 Provided under GPL version 2 or later. 00006 00007 This is the official API definition of libburn. 00008 00009 */ 00010 /* Important: If you add a public API function then add its name to file 00011 libburn/libburn.ver 00012 */ 00013 00014 00015 #ifndef LIBBURN_H 00016 #define LIBBURN_H 00017 00018 /* 00019 00020 Applications must use 64 bit off_t. E.g. by defining 00021 #define _LARGEFILE_SOURCE 00022 #define _FILE_OFFSET_BITS 64 00023 or take special precautions to interface with the library by 64 bit integers 00024 where this .h files prescribe off_t. 00025 00026 To prevent 64 bit file i/o in the library would keep the application from 00027 processing tracks of more than 2 GB size. 00028 00029 */ 00030 #include <sys/types.h> 00031 00032 #ifndef DOXYGEN 00033 00034 #if defined(__cplusplus) 00035 #define BURN_BEGIN_DECLS \ 00036 namespace burn { \ 00037 extern "C" { 00038 #define BURN_END_DECLS \ 00039 } \ 00040 } 00041 #else 00042 #define BURN_BEGIN_DECLS 00043 #define BURN_END_DECLS 00044 #endif 00045 00046 BURN_BEGIN_DECLS 00047 00048 #endif 00049 00050 /** References a physical drive in the system */ 00051 struct burn_drive; 00052 00053 /** References a whole disc */ 00054 struct burn_disc; 00055 00056 /** References a single session on a disc */ 00057 struct burn_session; 00058 00059 /** References a single track on a disc */ 00060 struct burn_track; 00061 00062 /* ts A61111 */ 00063 /** References a set of write parameters */ 00064 struct burn_write_opts; 00065 00066 /** Session format for normal audio or data discs */ 00067 #define BURN_CDROM 0 00068 /** Session format for obsolete CD-I discs */ 00069 #define BURN_CDI 0x10 00070 /** Session format for CDROM-XA discs */ 00071 #define BURN_CDXA 0x20 00072 00073 #define BURN_POS_END 100 00074 00075 /** Mask for mode bits */ 00076 #define BURN_MODE_BITS 127 00077 00078 /** Track mode - mode 0 data 00079 0 bytes of user data. it's all 0s. mode 0. get it? HAH 00080 */ 00081 #define BURN_MODE0 (1 << 0) 00082 /** Track mode - mode "raw" - all 2352 bytes supplied by app 00083 FOR DATA TRACKS ONLY! 00084 */ 00085 #define BURN_MODE_RAW (1 << 1) 00086 /** Track mode - mode 1 data 00087 2048 bytes user data, and all the LEC money can buy 00088 */ 00089 #define BURN_MODE1 (1 << 2) 00090 /** Track mode - mode 2 data 00091 defaults to formless, 2336 bytes of user data, unprotected 00092 | with a data form if required. 00093 */ 00094 #define BURN_MODE2 (1 << 3) 00095 /** Track mode modifier - Form 1, | with MODE2 for reasonable results 00096 2048 bytes of user data, 4 bytes of subheader 00097 */ 00098 #define BURN_FORM1 (1 << 4) 00099 /** Track mode modifier - Form 2, | with MODE2 for reasonable results 00100 lots of user data. not much LEC. 00101 */ 00102 #define BURN_FORM2 (1 << 5) 00103 /** Track mode - audio 00104 2352 bytes per sector. may be | with 4ch or preemphasis. 00105 NOT TO BE CONFUSED WITH BURN_MODE_RAW 00106 Audio data must be 44100Hz 16bit stereo with no riff or other header at 00107 beginning. Extra header data will cause pops or clicks. Audio data should 00108 also be in little-endian byte order. Big-endian audio data causes static. 00109 */ 00110 #define BURN_AUDIO (1 << 6) 00111 /** Track mode modifier - 4 channel audio. */ 00112 #define BURN_4CH (1 << 7) 00113 /** Track mode modifier - Digital copy permitted, can be set on any track.*/ 00114 #define BURN_COPY (1 << 8) 00115 /** Track mode modifier - 50/15uS pre-emphasis */ 00116 #define BURN_PREEMPHASIS (1 << 9) 00117 /** Input mode modifier - subcodes present packed 16 */ 00118 #define BURN_SUBCODE_P16 (1 << 10) 00119 /** Input mode modifier - subcodes present packed 96 */ 00120 #define BURN_SUBCODE_P96 (1 << 11) 00121 /** Input mode modifier - subcodes present raw 96 */ 00122 #define BURN_SUBCODE_R96 (1 << 12) 00123 00124 /** Possible disc writing style/modes */ 00125 enum burn_write_types 00126 { 00127 /** Packet writing. 00128 currently unsupported, (for DVD Incremental Streaming use TAO) 00129 */ 00130 BURN_WRITE_PACKET, 00131 00132 /** With CD: Track At Once recording 00133 2s gaps between tracks, no fonky lead-ins 00134 00135 With sequential DVD-R[W]: Incremental Streaming 00136 With DVD+R and BD-R: Track of open size 00137 With DVD-RAM, DVD+RW, BD-RE: Random Writeable (used sequentially) 00138 With overwriteable DVD-RW: Rigid Restricted Overwrite 00139 */ 00140 BURN_WRITE_TAO, 00141 00142 /** With CD: Session At Once 00143 Block type MUST be BURN_BLOCK_SAO 00144 ts A70122: Currently not capable of mixing data and audio tracks. 00145 00146 With sequential DVD-R[W]: Disc-at-once, DAO 00147 Single session, single track, fixed size mandatory, (-dvd-compat) 00148 With other DVD or BD media: same as BURN_WRITE_TAO but may demand 00149 that track size is known in advance. 00150 */ 00151 BURN_WRITE_SAO, 00152 00153 /** With CD: Raw disc at once recording. 00154 all subcodes must be provided by lib or user 00155 only raw block types are supported 00156 With DVD and BD media: not supported. 00157 00158 ts A90901: This had been disabled because its implementation 00159 relied on code from cdrdao which is not understood 00160 currently. 00161 A burn run will abort with "FATAL" error message 00162 if this mode is attempted. 00163 @since 0.7.2 00164 ts A91016: Re-implemented according to ECMA-130 Annex A and B. 00165 Now understood, explained and not stemming from cdrdao. 00166 @since 0.7.4 00167 */ 00168 BURN_WRITE_RAW, 00169 00170 /** In replies this indicates that not any writing will work. 00171 As parameter for inquiries it indicates that no particular write 00172 mode shall is specified. 00173 Do not use for setting a write mode for burning. It will not work. 00174 */ 00175 BURN_WRITE_NONE 00176 }; 00177 00178 /** Data format to send to the drive */ 00179 enum burn_block_types 00180 { 00181 /** sync, headers, edc/ecc provided by lib/user */ 00182 BURN_BLOCK_RAW0 = 1, 00183 /** sync, headers, edc/ecc and p/q subs provided by lib/user */ 00184 BURN_BLOCK_RAW16 = 2, 00185 /** sync, headers, edc/ecc and packed p-w subs provided by lib/user */ 00186 BURN_BLOCK_RAW96P = 4, 00187 /** sync, headers, edc/ecc and raw p-w subs provided by lib/user */ 00188 BURN_BLOCK_RAW96R = 8, 00189 /** only 2048 bytes of user data provided by lib/user */ 00190 BURN_BLOCK_MODE1 = 256, 00191 /** 2336 bytes of user data provided by lib/user */ 00192 BURN_BLOCK_MODE2R = 512, 00193 /** 2048 bytes of user data provided by lib/user 00194 subheader provided in write parameters 00195 are we ever going to support this shit? I vote no. 00196 (supposed to be supported on all drives...) 00197 */ 00198 BURN_BLOCK_MODE2_PATHETIC = 1024, 00199 /** 2048 bytes of data + 8 byte subheader provided by lib/user 00200 hey, this is also dumb 00201 */ 00202 BURN_BLOCK_MODE2_LAME = 2048, 00203 /** 2324 bytes of data provided by lib/user 00204 subheader provided in write parameters 00205 no sir, I don't like it. 00206 */ 00207 BURN_BLOCK_MODE2_OBSCURE = 4096, 00208 /** 2332 bytes of data supplied by lib/user 00209 8 bytes sub header provided in write parameters 00210 this is the second least suck mode2, and is mandatory for 00211 all drives to support. 00212 */ 00213 BURN_BLOCK_MODE2_OK = 8192, 00214 /** SAO block sizes are based on cue sheet, so use this. */ 00215 BURN_BLOCK_SAO = 16384 00216 }; 00217 00218 /** Possible status of the drive in regard to the disc in it. */ 00219 enum burn_disc_status 00220 { 00221 /** The current status is not yet known */ 00222 BURN_DISC_UNREADY, 00223 00224 /** The drive holds a blank disc. It is ready for writing from scratch. 00225 Unused multi-session media: 00226 CD-R, CD-RW, DVD-R, DVD-RW, DVD+R, BD-R 00227 Blanked multi-session media (i.e. treated by burn_disc_erase()) 00228 CD-RW, DVD-RW 00229 Overwriteable media with or without valid data 00230 DVD-RAM, DVD+RW, formatted DVD-RW, BD-RE 00231 */ 00232 BURN_DISC_BLANK, 00233 00234 /** There is no disc at all in the drive */ 00235 BURN_DISC_EMPTY, 00236 00237 /** There is an incomplete disc in the drive. It is ready for appending 00238 another session. 00239 Written but not yet closed multi-session media 00240 CD-R, CD-RW, DVD-R, DVD-RW, DVD+R, BD-R 00241 */ 00242 BURN_DISC_APPENDABLE, 00243 00244 /** There is a disc with data on it in the drive. It is usable only for 00245 reading. 00246 Written and closed multi-session media 00247 CD-R, CD-RW, DVD-R, DVD-RW, DVD+R, BD-R 00248 Read-Only media 00249 CD-ROM, DVD-ROM, BD-ROM 00250 Note that many DVD-ROM drives report any written media 00251 as Read-Only media and not by their real media types. 00252 */ 00253 BURN_DISC_FULL, 00254 00255 /* ts A61007 */ 00256 /* @since 0.2.4 */ 00257 /** The drive was not grabbed when the status was inquired */ 00258 BURN_DISC_UNGRABBED, 00259 00260 /* ts A61020 */ 00261 /* @since 0.2.6 */ 00262 /** The media seems to be unsuitable for reading and for writing */ 00263 BURN_DISC_UNSUITABLE 00264 }; 00265 00266 00267 /** Possible data source return values */ 00268 enum burn_source_status 00269 { 00270 /** The source is ok */ 00271 BURN_SOURCE_OK, 00272 /** The source is at end of file */ 00273 BURN_SOURCE_EOF, 00274 /** The source is unusable */ 00275 BURN_SOURCE_FAILED 00276 }; 00277 00278 00279 /** Possible busy states for a drive */ 00280 enum burn_drive_status 00281 { 00282 /** The drive is not in an operation */ 00283 BURN_DRIVE_IDLE, 00284 /** The library is spawning the processes to handle a pending 00285 operation (A read/write/etc is about to start but hasn't quite 00286 yet) */ 00287 BURN_DRIVE_SPAWNING, 00288 /** The drive is reading data from a disc */ 00289 BURN_DRIVE_READING, 00290 /** The drive is writing data to a disc */ 00291 BURN_DRIVE_WRITING, 00292 /** The drive is writing Lead-In */ 00293 BURN_DRIVE_WRITING_LEADIN, 00294 /** The drive is writing Lead-Out */ 00295 BURN_DRIVE_WRITING_LEADOUT, 00296 /** The drive is erasing a disc */ 00297 BURN_DRIVE_ERASING, 00298 /** The drive is being grabbed */ 00299 BURN_DRIVE_GRABBING, 00300 00301 /* ts A61102 */ 00302 /* @since 0.2.6 */ 00303 /** The drive gets written zeroes before the track payload data */ 00304 BURN_DRIVE_WRITING_PREGAP, 00305 /** The drive is told to close a track (TAO only) */ 00306 BURN_DRIVE_CLOSING_TRACK, 00307 /** The drive is told to close a session (TAO only) */ 00308 BURN_DRIVE_CLOSING_SESSION, 00309 00310 /* ts A61223 */ 00311 /* @since 0.3.0 */ 00312 /** The drive is formatting media */ 00313 BURN_DRIVE_FORMATTING, 00314 00315 /* ts A70822 */ 00316 /* @since 0.4.0 */ 00317 /** The drive is busy in synchronous read (if you see this then it 00318 has been interrupted) */ 00319 BURN_DRIVE_READING_SYNC, 00320 /** The drive is busy in synchronous write (if you see this then it 00321 has been interrupted) */ 00322 BURN_DRIVE_WRITING_SYNC 00323 00324 }; 00325 00326 00327 /** Information about a track on a disc - this is from the q sub channel of the 00328 lead-in area of a disc. The documentation here is very terse. 00329 See a document such as mmc3 for proper information. 00330 00331 CAUTION : This structure is prone to future extension ! 00332 00333 Do not restrict your application to unsigned char with any counter like 00334 "session", "point", "pmin", ... 00335 Do not rely on the current size of a burn_toc_entry. 00336 00337 ts A70201 : DVD extension, see below 00338 */ 00339 struct burn_toc_entry 00340 { 00341 /** Session the track is in */ 00342 unsigned char session; 00343 /** Type of data. for this struct to be valid, it must be 1 */ 00344 unsigned char adr; 00345 /** Type of data in the track */ 00346 unsigned char control; 00347 /** Zero. Always. Really. */ 00348 unsigned char tno; 00349 /** Track number or special information */ 00350 unsigned char point; 00351 unsigned char min; 00352 unsigned char sec; 00353 unsigned char frame; 00354 unsigned char zero; 00355 /** Track start time minutes for normal tracks */ 00356 unsigned char pmin; 00357 /** Track start time seconds for normal tracks */ 00358 unsigned char psec; 00359 /** Track start time frames for normal tracks */ 00360 unsigned char pframe; 00361 00362 /* Indicates whether extension data are valid and eventually override 00363 older elements in this structure: 00364 bit0= DVD extension is valid @since 0.3.2 00365 @since 0.5.2 : DVD extensions are made valid for CD too 00366 */ 00367 unsigned char extensions_valid; 00368 00369 /* ts A70201 : DVD extension. extensions_valid:bit0 00370 If invalid the members are guaranteed to be 0. */ 00371 /* @since 0.3.2 */ 00372 /* Tracks and session numbers are 16 bit. Here are the high bytes. */ 00373 unsigned char session_msb; 00374 unsigned char point_msb; 00375 /* pmin, psec, and pframe may be too small if DVD extension is valid */ 00376 int start_lba; 00377 /* min, sec, and frame may be too small if DVD extension is valid */ 00378 int track_blocks; 00379 00380 /* ts A90909 : LRA extension. extensions_valid:bit1 */ 00381 /* @since 0.7.2 */ 00382 /* MMC-5 6.27.3.18 : The Last Recorded Address is valid for DVD-R, 00383 DVD-R DL when LJRS = 00b, DVD-RW, HD DVD-R, and BD-R. 00384 This would mean profiles: 0x11, 0x15, 0x13, 0x14, 0x51, 0x41, 0x42 00385 */ 00386 int last_recorded_address; 00387 }; 00388 00389 00390 /** Data source interface for tracks. 00391 This allows to use arbitrary program code as provider of track input data. 00392 00393 Objects compliant to this interface are either provided by the application 00394 or by API calls of libburn: burn_fd_source_new() , burn_file_source_new(), 00395 and burn_fifo_source_new(). 00396 00397 The API calls allow to use any file object as data source. Consider to feed 00398 an eventual custom data stream asynchronously into a pipe(2) and to let 00399 libburn handle the rest. 00400 In this case the following rule applies: 00401 Call burn_source_free() exactly once for every source obtained from 00402 libburn API. You MUST NOT otherwise use or manipulate its components. 00403 00404 In general, burn_source objects can be freed as soon as they are attached 00405 to track objects. The track objects will keep them alive and dispose them 00406 when they are no longer needed. With a fifo burn_source it makes sense to 00407 keep the own reference for inquiring its state while burning is in 00408 progress. 00409 00410 --- 00411 00412 The following description of burn_source applies only to application 00413 implemented burn_source objects. You need not to know it for API provided 00414 ones. 00415 00416 If you really implement an own passive data producer by this interface, 00417 then beware: it can do anything and it can spoil everything. 00418 00419 In this case the functions (*read), (*get_size), (*set_size), (*free_data) 00420 MUST be implemented by the application and attached to the object at 00421 creation time. 00422 Function (*read_sub) is allowed to be NULL or it MUST be implemented and 00423 attached. 00424 00425 burn_source.refcount MUST be handled properly: If not exactly as many 00426 references are freed as have been obtained, then either memory leaks or 00427 corrupted memory are the consequence. 00428 All objects which are referred to by *data must be kept existent until 00429 (*free_data) is called via burn_source_free() by the last referer. 00430 */ 00431 struct burn_source { 00432 00433 /** Reference count for the data source. MUST be 1 when a new source 00434 is created and thus the first reference is handed out. Increment 00435 it to take more references for yourself. Use burn_source_free() 00436 to destroy your references to it. */ 00437 int refcount; 00438 00439 00440 /** Read data from the source. Semantics like with read(2), but MUST 00441 either deliver the full buffer as defined by size or MUST deliver 00442 EOF (return 0) or failure (return -1) at this call or at the 00443 next following call. I.e. the only incomplete buffer may be the 00444 last one from that source. 00445 libburn will read a single sector by each call to (*read). 00446 The size of a sector depends on BURN_MODE_*. The known range is 00447 2048 to 2352. 00448 00449 If this call is reading from a pipe then it will learn 00450 about the end of data only when that pipe gets closed on the 00451 feeder side. So if the track size is not fixed or if the pipe 00452 delivers less than the predicted amount or if the size is not 00453 block aligned, then burning will halt until the input process 00454 closes the pipe. 00455 00456 IMPORTANT: 00457 If this function pointer is NULL, then the struct burn_source is of 00458 version >= 1 and the job of .(*read)() is done by .(*read_xt)(). 00459 See below, member .version. 00460 */ 00461 int (*read)(struct burn_source *, unsigned char *buffer, int size); 00462 00463 00464 /** Read subchannel data from the source (NULL if lib generated) 00465 WARNING: This is an obscure feature with CD raw write modes. 00466 Unless you checked the libburn code for correctness in that aspect 00467 you should not rely on raw writing with own subchannels. 00468 ADVICE: Set this pointer to NULL. 00469 */ 00470 int (*read_sub)(struct burn_source *, unsigned char *buffer, int size); 00471 00472 00473 /** Get the size of the source's data. Return 0 means unpredictable 00474 size. If application provided (*get_size) allows return 0, then 00475 the application MUST provide a fully functional (*set_size). 00476 */ 00477 off_t (*get_size)(struct burn_source *); 00478 00479 00480 /* ts A70125 : BROKE BINARY BACKWARD COMPATIBILITY AT libburn-0.3.1. */ 00481 /* @since 0.3.2 */ 00482 /** Program the reply of (*get_size) to a fixed value. It is advised 00483 to implement this by a attribute off_t fixed_size; in *data . 00484 The read() function does not have to take into respect this fake 00485 setting. It is rather a note of libburn to itself. Eventually 00486 necessary truncation or padding is done in libburn. Truncation 00487 is usually considered a misburn. Padding is considered ok. 00488 00489 libburn is supposed to work even if (*get_size) ignores the 00490 setting by (*set_size). But your application will not be able to 00491 enforce fixed track sizes by burn_track_set_size() and possibly 00492 even padding might be left out. 00493 */ 00494 int (*set_size)(struct burn_source *source, off_t size); 00495 00496 00497 /** Clean up the source specific data. This function will be called 00498 once by burn_source_free() when the last referer disposes the 00499 source. 00500 */ 00501 void (*free_data)(struct burn_source *); 00502 00503 00504 /** Next source, for when a source runs dry and padding is disabled 00505 WARNING: This is an obscure feature. Set to NULL at creation and 00506 from then on leave untouched and uninterpreted. 00507 */ 00508 struct burn_source *next; 00509 00510 00511 /** Source specific data. Here the various source classes express their 00512 specific properties and the instance objects store their individual 00513 management data. 00514 E.g. data could point to a struct like this: 00515 struct app_burn_source 00516 { 00517 struct my_app *app_handle; 00518 ... other individual source parameters ... 00519 off_t fixed_size; 00520 }; 00521 00522 Function (*free_data) has to be prepared to clean up and free 00523 the struct. 00524 */ 00525 void *data; 00526 00527 00528 /* ts A71222 : Supposed to be binary backwards compatible extension. */ 00529 /* @since 0.4.2 */ 00530 /** Valid only if above member .(*read)() is NULL. This indicates a 00531 version of struct burn_source younger than 0. 00532 From then on, member .version tells which further members exist 00533 in the memory layout of struct burn_source. libburn will only touch 00534 those announced extensions. 00535 00536 Versions: 00537 0 has .(*read)() != NULL, not even .version is present. 00538 1 has .version, .(*read_xt)(), .(*cancel)() 00539 */ 00540 int version; 00541 00542 /** This substitutes for (*read)() in versions above 0. */ 00543 int (*read_xt)(struct burn_source *, unsigned char *buffer, int size); 00544 00545 /** Informs the burn_source that the consumer of data prematurely 00546 ended reading. This call may or may not be issued by libburn 00547 before (*free_data)() is called. 00548 */ 00549 int (*cancel)(struct burn_source *source); 00550 }; 00551 00552 00553 /** Information on a drive in the system */ 00554 struct burn_drive_info 00555 { 00556 /** Name of the vendor of the drive */ 00557 char vendor[9]; 00558 /** Name of the drive */ 00559 char product[17]; 00560 /** Revision of the drive */ 00561 char revision[5]; 00562 00563 /** Invalid: Was: "Location of the drive in the filesystem." */ 00564 /** This string has no meaning any more. Once it stored the persistent 00565 drive address. Now always use function burn_drive_d_get_adr() to 00566 inquire a persistent address. ^^^^^^ ALWAYS ^^^^^^^^ */ 00567 char location[17]; 00568 00569 /** Can the drive read DVD-RAM discs */ 00570 unsigned int read_dvdram:1; 00571 /** Can the drive read DVD-R discs */ 00572 unsigned int read_dvdr:1; 00573 /** Can the drive read DVD-ROM discs */ 00574 unsigned int read_dvdrom:1; 00575 /** Can the drive read CD-R discs */ 00576 unsigned int read_cdr:1; 00577 /** Can the drive read CD-RW discs */ 00578 unsigned int read_cdrw:1; 00579 00580 /** Can the drive write DVD-RAM discs */ 00581 unsigned int write_dvdram:1; 00582 /** Can the drive write DVD-R discs */ 00583 unsigned int write_dvdr:1; 00584 /** Can the drive write CD-R discs */ 00585 unsigned int write_cdr:1; 00586 /** Can the drive write CD-RW discs */ 00587 unsigned int write_cdrw:1; 00588 00589 /** Can the drive simulate a write */ 00590 unsigned int write_simulate:1; 00591 00592 /** Can the drive report C2 errors */ 00593 unsigned int c2_errors:1; 00594 00595 /** The size of the drive's buffer (in kilobytes) */ 00596 int buffer_size; 00597 /** 00598 * The supported block types in tao mode. 00599 * They should be tested with the desired block type. 00600 * See also burn_block_types. 00601 */ 00602 int tao_block_types; 00603 /** 00604 * The supported block types in sao mode. 00605 * They should be tested with the desired block type. 00606 * See also burn_block_types. 00607 */ 00608 int sao_block_types; 00609 /** 00610 * The supported block types in raw mode. 00611 * They should be tested with the desired block type. 00612 * See also burn_block_types. 00613 */ 00614 int raw_block_types; 00615 /** 00616 * The supported block types in packet mode. 00617 * They should be tested with the desired block type. 00618 * See also burn_block_types. 00619 */ 00620 int packet_block_types; 00621 00622 /** The value by which this drive can be indexed when using functions 00623 in the library. This is the value to pass to all libbburn functions 00624 that operate on a drive. */ 00625 struct burn_drive *drive; 00626 }; 00627 00628 00629 /** Operation progress report. All values are 0 based indices. 00630 * */ 00631 struct burn_progress { 00632 /** The total number of sessions */ 00633 int sessions; 00634 /** Current session.*/ 00635 int session; 00636 /** The total number of tracks */ 00637 int tracks; 00638 /** Current track. */ 00639 int track; 00640 /** The total number of indices */ 00641 int indices; 00642 /** Curent index. */ 00643 int index; 00644 /** The starting logical block address */ 00645 int start_sector; 00646 /** On write: The number of sectors. 00647 On blank: 0x10000 as upper limit for relative progress steps */ 00648 int sectors; 00649 /** On write: The current sector being processed. 00650 On blank: Relative progress steps 0 to 0x10000 */ 00651 int sector; 00652 00653 /* ts A61023 */ 00654 /* @since 0.2.6 */ 00655 /** The capacity of the drive buffer */ 00656 unsigned buffer_capacity; 00657 /** The free space in the drive buffer (might be slightly outdated) */ 00658 unsigned buffer_available; 00659 00660 /* ts A61119 */ 00661 /* @since 0.2.6 */ 00662 /** The number of bytes sent to the drive buffer */ 00663 off_t buffered_bytes; 00664 /** The minimum number of bytes stored in buffer during write. 00665 (Caution: Before surely one buffer size of bytes was processed, 00666 this value is 0xffffffff.) 00667 */ 00668 unsigned buffer_min_fill; 00669 }; 00670 00671 00672 /* ts A61226 */ 00673 /* @since 0.3.0 */ 00674 /** Description of a speed capability as reported by the drive in conjunction 00675 with eventually loaded media. There can be more than one such object per 00676 drive. So they are chained via .next and .prev , where NULL marks the end 00677 of the chain. This list is set up by burn_drive_scan() and gets updated 00678 by burn_drive_grab(). 00679 A copy may be obtained by burn_drive_get_speedlist() and disposed by 00680 burn_drive_free_speedlist(). 00681 For technical background info see SCSI specs MMC and SPC: 00682 mode page 2Ah (from SPC 5Ah MODE SENSE) , mmc3r10g.pdf , 6.3.11 Table 364 00683 ACh GET PERFORMANCE, Type 03h , mmc5r03c.pdf , 6.8.5.3 Table 312 00684 */ 00685 struct burn_speed_descriptor { 00686 00687 /** Where this info comes from : 00688 0 = misc , 1 = mode page 2Ah , 2 = ACh GET PERFORMANCE */ 00689 int source; 00690 00691 /** The media type that was current at the time of report 00692 -2 = state unknown, -1 = no media was loaded , else see 00693 burn_disc_get_profile() */ 00694 int profile_loaded; 00695 char profile_name[80]; 00696 00697 /** The attributed capacity of appropriate media in logical block units 00698 i.e. 2352 raw bytes or 2048 data bytes. -1 = capacity unknown. */ 00699 int end_lba; 00700 00701 /** Speed is given in 1000 bytes/s , 0 = invalid. The numbers 00702 are supposed to be usable with burn_drive_set_speed() */ 00703 int write_speed; 00704 int read_speed; 00705 00706 /** Expert info from ACh GET PERFORMANCE and/or mode page 2Ah. 00707 Expect values other than 0 or 1 to get a meaning in future.*/ 00708 /* Rotational control: 0 = CLV/default , 1 = CAV */ 00709 int wrc; 00710 /* 1 = drive promises reported performance over full media */ 00711 int exact; 00712 /* 1 = suitable for mixture of read and write */ 00713 int mrw; 00714 00715 /** List chaining. Use .next until NULL to iterate over the list */ 00716 struct burn_speed_descriptor *prev; 00717 struct burn_speed_descriptor *next; 00718 }; 00719 00720 00721 /** Initialize the library. 00722 This must be called before using any other functions in the library. It 00723 may be called more than once with no effect. 00724 It is possible to 'restart' the library by shutting it down and 00725 re-initializing it. Once this was necessary if you follow the older and 00726 more general way of accessing a drive via burn_drive_scan() and 00727 burn_drive_grab(). See burn_drive_scan_and_grab() with its strong 00728 urges and its explanations. 00729 @return Nonzero if the library was able to initialize; zero if 00730 initialization failed. 00731 */ 00732 int burn_initialize(void); 00733 00734 /** Shutdown the library. 00735 This should be called before exiting your application. Make sure that all 00736 drives you have grabbed are released <i>before</i> calling this. 00737 */ 00738 void burn_finish(void); 00739 00740 00741 /* ts A61002 */ 00742 /** Abort any running drive operation and eventually call burn_finish(). 00743 00744 You MUST shut down the busy drives if an aborting event occurs during a 00745 burn run. For that you may call this function either from your own signal 00746 handling code or indirectly by activating the built-in signal handling: 00747 burn_set_signal_handling("my_app_name : ", NULL, 0); 00748 Else you may eventually call burn_drive_cancel() on the active drives and 00749 wait for them to assume state BURN_DRIVE_IDLE. 00750 @param patience Maximum number of seconds to wait for drives to 00751 finish. 00752 @since 0.7.8 : 00753 If this is -1, then only the cancel operations will 00754 be performed and no burn_finish() will happen. 00755 @param pacifier_func If not NULL: a function to produce appeasing messages. 00756 See burn_abort_pacifier() for an example. 00757 @param handle Opaque handle to be used with pacifier_func 00758 @return 1 ok, all went well 00759 0 had to leave a drive in unclean state 00760 <0 severe error, do no use libburn again 00761 @since 0.2.6 00762 */ 00763 int burn_abort(int patience, 00764 int (*pacifier_func)(void *handle, int patience, int elapsed), 00765 void *handle); 00766 00767 /** A pacifier function suitable for burn_abort. 00768 @param handle If not NULL, a pointer to a text suitable for printf("%s") 00769 @param patience Maximum number of seconds to wait 00770 @param elapsed Elapsed number of seconds 00771 */ 00772 int burn_abort_pacifier(void *handle, int patience, int elapsed); 00773 00774 00775 /** ts A61006 : This is for development only. Not suitable for applications. 00776 Set the verbosity level of the library. The default value is 0, which means 00777 that nothing is output on stderr. The more you increase this, the more 00778 debug output should be displayed on stderr for you. 00779 @param level The verbosity level desired. 0 for nothing, higher positive 00780 values for more information output. 00781 */ 00782 void burn_set_verbosity(int level); 00783 00784 /* ts A91111 */ 00785 /** Enable resp. disable logging of SCSI commands (currently GNU/Linux only). 00786 This call can be made at any time - even before burn_initialize(). 00787 It is in effect for all active drives and currently not very thread 00788 safe for multiple drives. 00789 @param flag Bitfield for control purposes. The default is 0. 00790 bit0= log to file /tmp/libburn_sg_command_log 00791 bit1= log to stderr 00792 bit2= flush output after each line 00793 @since 0.7.4 00794 */ 00795 void burn_set_scsi_logging(int flag); 00796 00797 /* ts A60813 */ 00798 /** Set parameters for behavior on opening device files. To be called early 00799 after burn_initialize() and before any bus scan. But not mandatory at all. 00800 Parameter value 1 enables a feature, 0 disables. 00801 Default is (1,0,0). Have a good reason before you change it. 00802 @param exclusive 00803 0 = no attempt to make drive access exclusive. 00804 1 = Try to open only devices which are not marked as busy 00805 and try to mark them busy if opened sucessfully. (O_EXCL 00806 on GNU/Linux , flock(LOCK_EX) on FreeBSD.) 00807 2 = in case of a SCSI device, also try to open exclusively 00808 the matching /dev/sr, /dev/scd and /dev/st . 00809 One may select a device SCSI file family by adding 00810 0 = default family 00811 4 = /dev/sr%d 00812 8 = /dev/scd%d 00813 16 = /dev/sg%d 00814 Do not use other values ! 00815 Add 32 to demand on GNU/Linux an exclusive lock by 00816 fcntl(,F_SETLK,) after open() has succeeded. 00817 @param blocking Try to wait for drives which do not open immediately but 00818 also do not return an error as well. (O_NONBLOCK) 00819 This might stall indefinitely with /dev/hdX hard disks. 00820 @param abort_on_busy Unconditionally abort process when a non blocking 00821 exclusive opening attempt indicates a busy drive. 00822 Use this only after thorough tests with your app. 00823 @since 0.2.2 00824 */ 00825 void burn_preset_device_open(int exclusive, int blocking, int abort_on_busy); 00826 00827 00828 /* ts A70223 */ 00829 /** Allows the use of media types which are implemented in libburn but not yet 00830 tested. The list of those untested profiles is subject to change. 00831 - Currently no media types are under test reservation - 00832 If you really test such media, then please report the outcome on 00833 libburn-hackers@pykix.org 00834 If ever then this call should be done soon after burn_initialize() before 00835 any drive scanning. 00836 @param yes 1=allow all implemented profiles, 0=only tested media (default) 00837 @since 0.3.4 00838 */ 00839 void burn_allow_untested_profiles(int yes); 00840 00841 00842 /* ts A60823 */ 00843 /** Aquire a drive with known persistent address. 00844 00845 This is the sysadmin friendly way to open one drive and to leave all 00846 others untouched. It bundles the following API calls to form a 00847 non-obtrusive way to use libburn: 00848 burn_drive_add_whitelist() , burn_drive_scan() , burn_drive_grab() 00849 You are *strongly urged* to use this call whenever you know the drive 00850 address in advance. 00851 00852 If not, then you have to use directly above calls. In that case, you are 00853 *strongly urged* to drop any unintended drive which will be exclusively 00854 occupied and not closed by burn_drive_scan(). 00855 This can be done by shutting down the library including a call to 00856 burn_finish(). You may later start a new libburn session and should then 00857 use the function described here with an address obtained after 00858 burn_drive_scan() via burn_drive_d_get_adr(drive_infos[driveno].drive,adr). 00859 Another way is to drop the unwanted drives by burn_drive_info_forget(). 00860 00861 Operating on multiple drives: 00862 00863 Different than with burn_drive_scan() it is allowed to call 00864 burn_drive_scan_and_grab() without giving up any other scanned drives. So 00865 this call can be used to get a collection of more than one aquired drives. 00866 The attempt to aquire the same drive twice will fail, though. 00867 00868 Pseudo-drives: 00869 00870 burn_drive_scan_and_grab() is able to aquire virtual drives which will 00871 accept options much like a MMC burner drive. Many of those options will not 00872 cause any effect, though. The address of a pseudo-drive begins with 00873 prefix "stdio:" followed by a path. 00874 Examples: "stdio:/tmp/pseudo_drive" , "stdio:/dev/null" , "stdio:-" 00875 00876 If the path is empty, the result is a null-drive = drive role 0. 00877 It pretends to have loaded no media and supports no reading or writing. 00878 00879 If the path leads to an existing regular file, or to a not yet existing 00880 file, or to an existing block device, then the result is a random access 00881 stdio-drive capable of reading and writing = drive role 2. 00882 00883 If the path leads to an existing file of any type other than directory, 00884 then the result is a sequential write-only stdio-drive = drive role 3. 00885 00886 The special address form "stdio:/dev/fd/{number}" is interpreted literally 00887 as reference to open file descriptor {number}. This address form coincides 00888 with real files on some systems, but it is in fact hardcoded in libburn. 00889 Special address "stdio:-" means stdout = "stdio:/dev/fd/1". 00890 The role of such a drive is determined by the file type obtained via 00891 fstat({number}). 00892 00893 Roles 2 and 3 perform all their eventual data transfer activities on a file 00894 via standard i/o functions open(2), lseek(2), read(2), write(2), close(2). 00895 The media profile is reported as 0xffff. Write space information from those 00896 media is not necessarily realistic. 00897 00898 The capabilities of role 2 resemble DVD-RAM but it can simulate writing. 00899 If the path does not exist in the filesystem yet, it is attempted to create 00900 it as a regular file as soon as write operations are started. 00901 00902 The capabilities of role 3 resemble a blank DVD-R. Nevertheless each 00903 burn_disc_write() run may only write a single track. 00904 00905 One may distinguish pseudo-drives from MMC drives by call 00906 burn_drive_get_drive_role(). 00907 00908 @param drive_infos On success returns a one element array with the drive 00909 (cdrom/burner). Thus use with driveno 0 only. On failure 00910 the array has no valid elements at all. 00911 The returned array should be freed via burn_drive_info_free() 00912 when it is no longer needed. 00913 This is a result from call burn_drive_scan(). See there. 00914 Use with driveno 0 only. 00915 @param adr The persistent address of the desired drive. Either once 00916 obtained by burn_drive_d_get_adr() or composed skillfully by 00917 application resp. its user. E.g. "/dev/sr0". 00918 Consider to preprocess it by burn_drive_convert_fs_adr(). 00919 @param load Nonzero to make the drive attempt to load a disc (close its 00920 tray door, etc). 00921 @return 1 = success , 0 = drive not found , -1 = other error 00922 @since 0.2.2 00923 */ 00924 int burn_drive_scan_and_grab(struct burn_drive_info *drive_infos[], 00925 char* adr, int load); 00926 00927 00928 /* ts A51221 */ 00929 /* @since 0.2.2 */ 00930 /** Maximum number of particularly permissible drive addresses */ 00931 #define BURN_DRIVE_WHITELIST_LEN 255 00932 00933 /** Add a device to the list of permissible drives. As soon as some entry is in 00934 the whitelist all non-listed drives are banned from scanning. 00935 @return 1 success, <=0 failure 00936 @since 0.2.2 00937 */ 00938 int burn_drive_add_whitelist(char *device_address); 00939 00940 /** Remove all drives from whitelist. This enables all possible drives. */ 00941 void burn_drive_clear_whitelist(void); 00942 00943 00944 /** Scan for drives. This function MUST be called until it returns nonzero. 00945 In case of re-scanning: 00946 All pointers to struct burn_drive and all struct burn_drive_info arrays 00947 are invalidated by using this function. Do NOT store drive pointers across 00948 calls to this function ! 00949 To avoid invalid pointers one MUST free all burn_drive_info arrays 00950 by burn_drive_info_free() before calling burn_drive_scan() a second time. 00951 If there are drives left, then burn_drive_scan() will refuse to work. 00952 00953 After this call all drives depicted by the returned array are subject 00954 to eventual (O_EXCL) locking. See burn_preset_device_open(). This state 00955 ends either with burn_drive_info_forget() or with burn_drive_release(). 00956 It is unfriendly to other processes on the system to hold drives locked 00957 which one does not definitely plan to use soon. 00958 @param drive_infos Returns an array of drive info items (cdroms/burners). 00959 The returned array must be freed by burn_drive_info_free() 00960 before burn_finish(), and also before calling this function 00961 burn_drive_scan() again. 00962 @param n_drives Returns the number of drive items in drive_infos. 00963 @return 0 while scanning is not complete 00964 >0 when it is finished sucessfully, 00965 <0 when finished but failed. 00966 */ 00967 int burn_drive_scan(struct burn_drive_info *drive_infos[], 00968 unsigned int *n_drives); 00969 00970 /* ts A60904 : ticket 62, contribution by elmom */ 00971 /** Release memory about a single drive and any exclusive lock on it. 00972 Become unable to inquire or grab it. Expect FATAL consequences if you try. 00973 @param drive_info pointer to a single element out of the array 00974 obtained from burn_drive_scan() : &(drive_infos[driveno]) 00975 @param force controls degree of permissible drive usage at the moment this 00976 function is called, and the amount of automatically provided 00977 drive shutdown : 00978 0= drive must be ungrabbed and BURN_DRIVE_IDLE 00979 1= try to release drive resp. accept BURN_DRIVE_GRABBING 00980 Use these two only. Further values are to be defined. 00981 @return 1 on success, 2 if drive was already forgotten, 00982 0 if not permissible, <0 on other failures, 00983 @since 0.2.2 00984 */ 00985 int burn_drive_info_forget(struct burn_drive_info *drive_info, int force); 00986 00987 00988 /** When no longer needed, free a whole burn_drive_info array which was 00989 returned by burn_drive_scan(). 00990 For freeing single drive array elements use burn_drive_info_forget(). 00991 */ 00992 void burn_drive_info_free(struct burn_drive_info drive_infos[]); 00993 00994 00995 /* ts A60823 */ 00996 /* @since 0.2.2 */ 00997 /** Maximum length+1 to expect with a persistent drive address string */ 00998 #define BURN_DRIVE_ADR_LEN 1024 00999 01000 /* ts A70906 */ 01001 /** Inquire the persistent address of the given drive. 01002 @param drive The drive to inquire. 01003 @param adr An application provided array of at least BURN_DRIVE_ADR_LEN 01004 characters size. The persistent address gets copied to it. 01005 @return >0 success , <=0 error (due to libburn internal problem) 01006 @since 0.4.0 01007 */ 01008 int burn_drive_d_get_adr(struct burn_drive *drive, char adr[]); 01009 01010 /* A60823 */ 01011 /** Inquire the persistent address of a drive via a given drive_info object. 01012 (Note: This is a legacy call.) 01013 @param drive_info The drive to inquire.Usually some &(drive_infos[driveno]) 01014 @param adr An application provided array of at least BURN_DRIVE_ADR_LEN 01015 characters size. The persistent address gets copied to it. 01016 @return >0 success , <=0 error (due to libburn internal problem) 01017 @since 0.2.6 01018 */ 01019 int burn_drive_get_adr(struct burn_drive_info *drive_info, char adr[]); 01020 01021 01022 /* ts A60922 ticket 33 */ 01023 /** Evaluate whether the given address would be a possible persistent drive 01024 address of libburn. 01025 @return 1 means yes, 0 means no 01026 @since 0.2.6 01027 */ 01028 int burn_drive_is_enumerable_adr(char *adr); 01029 01030 /* ts A60922 ticket 33 */ 01031 /** Try to convert a given existing filesystem address into a persistent drive 01032 address. This succeeds with symbolic links or if a hint about the drive's 01033 system address can be read from the filesystem object and a matching drive 01034 is found. 01035 @param path The address of an existing file system object 01036 @param adr An application provided array of at least BURN_DRIVE_ADR_LEN 01037 characters size. The persistent address gets copied to it. 01038 @return 1 = success , 0 = failure , -1 = severe error 01039 @since 0.2.6 01040 */ 01041 int burn_drive_convert_fs_adr(char *path, char adr[]); 01042 01043 /* ts A60923 */ 01044 /** Try to convert a given SCSI address of bus,host,channel,target,lun into 01045 a persistent drive address. If a SCSI address component parameter is < 0 01046 then it is not decisive and the first enumerated address which matches 01047 the >= 0 parameters is taken as result. 01048 Note: bus and (host,channel) are supposed to be redundant. 01049 @param bus_no "Bus Number" (something like a virtual controller) 01050 @param host_no "Host Number" (something like half a virtual controller) 01051 @param channel_no "Channel Number" (other half of "Host Number") 01052 @param target_no "Target Number" or "SCSI Id" (a device) 01053 @param lun_no "Logical Unit Number" (a sub device) 01054 @param adr An application provided array of at least BURN_DRIVE_ADR_LEN 01055 characters size. The persistent address gets copied to it. 01056 @return 1 = success , 0 = failure , -1 = severe error 01057 @since 0.2.6 01058 */ 01059 int burn_drive_convert_scsi_adr(int bus_no, int host_no, int channel_no, 01060 int target_no, int lun_no, char adr[]); 01061 01062 /* ts B10728 */ 01063 /** Try to convert a given persistent drive address into the address of a 01064 symbolic link that points to this drive address. 01065 Modern GNU/Linux systems may shuffle drive addresses from boot to boot. 01066 The udev daemon is supposed to create links which always point to the 01067 same drive, regardless of its system address. 01068 This call tries to find such links. 01069 @param dev_adr Should contain a drive address as returned by 01070 burn_drive_scan(). 01071 @param link_adr An application provided array of at least 01072 BURN_DRIVE_ADR_LEN characters size. The found link 01073 address gets copied to it. 01074 @param dir_adr The address of the directory where to look for links. 01075 Normally: "/dev" 01076 @param templ An array of pointers to name templates, which 01077 links have to match. A symbolic link in dir_adr matches 01078 a name template if it begins by that text. E.g. 01079 link address "/dev/dvdrw1" matches template "dvdrw". 01080 If templ is NULL, then the default array gets used: 01081 {"dvdrw", "cdrw", "dvd", "cdrom", "cd"} 01082 If several links would match, then a link will win, 01083 which matches the template with the lowest array index. 01084 Among these candidates, the one with the lowest strcmp() 01085 rank will be chosen as link_adr. 01086 @param num_templ Number of array elements in templ. 01087 @param flag Bitfield for control purposes. Unused yet. Submit 0. 01088 @return <0 severe error, 0 failed to search, 2 nothing found 01089 1 success, link_adr is valid 01090 @since 1.1.4 01091 */ 01092 int burn_lookup_device_link(char *dev_adr, char link_adr[], 01093 char *dir_adr, char **templ, int num_templ, int flag); 01094 01095 /* ts A60923 - A61005 */ 01096 /** Try to obtain bus,host,channel,target,lun from path. If there is an SCSI 01097 address at all, then this call should succeed with a persistent 01098 drive address obtained via burn_drive_d_get_adr(). It is also supposed to 01099 succeed with any device file of a (possibly emulated) SCSI device. 01100 @return 1 = success , 0 = failure , -1 = severe error 01101 @since 0.2.6 01102 */ 01103 int burn_drive_obtain_scsi_adr(char *path, int *bus_no, int *host_no, 01104 int *channel_no, int *target_no, int *lun_no); 01105 01106 /** Grab a drive. This must be done before the drive can be used (for reading, 01107 writing, etc). 01108 @param drive The drive to grab. This is found in a returned 01109 burn_drive_info struct. 01110 @param load Nonzero to make the drive attempt to load a disc (close its 01111 tray door, etc). 01112 @return 1 if it was possible to grab the drive, else 0 01113 */ 01114 int burn_drive_grab(struct burn_drive *drive, int load); 01115 01116 /* ts B00114 */ 01117 /* Probe available CD write modes and block types. In earlier versions this 01118 was done unconditionally on drive examination or aquiration. But it is 01119 lengthy and obtrusive, up to spoiling burn runs on the examined drives. 01120 So now this probing is omitted by default. All drives which announce to be 01121 capable of CD or DVD writing, get blindly attributed the capability for 01122 SAO and TAO. Applications which are interested in RAW modes or want to 01123 rely on the traditional write mode information, may use this call. 01124 @param drive_info drive object to be inquired 01125 @return >0 indicates success, <=0 means failure 01126 @since 0.7.6 01127 */ 01128 int burn_drive_probe_cd_write_modes(struct burn_drive_info *drive_info); 01129 01130 /* ts A90824 */ 01131 /** Calm down or alert a drive. Some drives stay alert after reading for 01132 quite some time. This saves time with the startup for the next read 01133 operation but also causes noise and consumes extra energy. It makes 01134 sense to calm down the drive if no read operation is expected for the 01135 next few seconds. The drive will get alert automatically if operations 01136 are required. 01137 @param d The drive to influence. 01138 @param flag Bitfield for control purposes 01139 bit0= become alert (else start snoozing) 01140 This is not mandatory to allow further drive operations 01141 @return 1= success , 0= drive role not suitable for calming 01142 @since 0.7.0 01143 */ 01144 int burn_drive_snooze(struct burn_drive *d, int flag); 01145 01146 01147 /** Release a drive. This should not be done until the drive is no longer 01148 busy (see burn_drive_get_status). 01149 @param drive The drive to release. 01150 @param eject Nonzero to make the drive eject the disc in it. 01151 */ 01152 void burn_drive_release(struct burn_drive *drive, int eject); 01153 01154 01155 /* ts A70918 */ 01156 /** Like burn_drive_release() but keeping the drive tray closed and its 01157 eject button disabled. This physically locked drive state will last until 01158 the drive is grabbed again and released via burn_drive_release(). 01159 Programs like eject, cdrecord, growisofs will break that ban too. 01160 @param d The drive to release and leave locked. 01161 @param flag Bitfield for control purposes (unused yet, submit 0) 01162 @return 1 means success, <=0 means failure 01163 @since 0.4.0 01164 */ 01165 int burn_drive_leave_locked(struct burn_drive *d, int flag); 01166 01167 01168 /** Returns what kind of disc a drive is holding. This function may need to be 01169 called more than once to get a proper status from it. See burn_disc_status 01170 for details. 01171 @param drive The drive to query for a disc. 01172 @return The status of the drive, or what kind of disc is in it. 01173 Note: BURN_DISC_UNGRABBED indicates wrong API usage 01174 */ 01175 enum burn_disc_status burn_disc_get_status(struct burn_drive *drive); 01176 01177 01178 /* ts A61020 */ 01179 /** WARNING: This revives an old bug-like behavior that might be dangerous. 01180 Sets the drive status to BURN_DISC_BLANK if it is BURN_DISC_UNREADY 01181 or BURN_DISC_UNSUITABLE. Thus marking media as writable which actually 01182 failed to declare themselves either blank or (partially) filled. 01183 @return 1 drive status has been set , 0 = unsuitable drive status 01184 @since 0.2.6 01185 */ 01186 int burn_disc_pretend_blank(struct burn_drive *drive); 01187 01188 01189 /* ts A61106 */ 01190 /** WARNING: This overrides the safety measures against unsuitable media. 01191 Sets the drive status to BURN_DISC_FULL if it is BURN_DISC_UNREADY 01192 or BURN_DISC_UNSUITABLE. Thus marking media as blankable which actually 01193 failed to declare themselves either blank or (partially) filled. 01194 @since 0.2.6 01195 */ 01196 int burn_disc_pretend_full(struct burn_drive *drive); 01197 01198 01199 /* ts A61021 */ 01200 /** Reads ATIP information from inserted media. To be obtained via 01201 burn_drive_get_write_speed(), burn_drive_get_min_write_speed(), 01202 burn_drive_get_start_end_lba(). The drive must be grabbed for this call. 01203 @param drive The drive to query. 01204 @return 1=sucess, 0=no valid ATIP info read, -1 severe error 01205 @since 0.2.6 01206 */ 01207 int burn_disc_read_atip(struct burn_drive *drive); 01208 01209 01210 /* ts A61020 */ 01211 /** Returns start and end lba of the media which is currently inserted 01212 in the given drive. The drive has to be grabbed to have hope for reply. 01213 Shortcomming (not a feature): unless burn_disc_read_atip() was called 01214 only blank media will return valid info. 01215 @param drive The drive to query. 01216 @param start_lba Returns the start lba value 01217 @param end_lba Returns the end lba value 01218 @param flag Bitfield for control purposes (unused yet, submit 0) 01219 @return 1 if lba values are valid , 0 if invalid 01220 @since 0.2.6 01221 */ 01222 int burn_drive_get_start_end_lba(struct burn_drive *drive, 01223 int *start_lba, int *end_lba, int flag); 01224 01225 01226 /* ts A90902 */ 01227 /** Guess the manufacturer name of CD media from the ATIP addresses of lead-in 01228 and lead-out. (Currently only lead-in is interpreted. Lead-out may in 01229 future be used to identify the media type in more detail.) 01230 The parameters of this call should be obtained by burn_disc_read_atip(d), 01231 burn_drive_get_start_end_lba(d, &start_lba, &end_lba, 0), 01232 burn_lba_to_msf(start_lba, &m_li, &s_li, &f_li) and 01233 burn_lba_to_msf(end_lba, &m_lo, &s_lo, &f_lo). 01234 @param m_li "minute" part of ATIP lead-in resp. start_lba 01235 @param s_li "second" of lead-in resp. start_lba 01236 @param f_li "frame" of lead-in 01237 @param m_lo "minute" part of ATIP lead-out 01238 @param s_lo "second" of lead-out 01239 @param f_lo "frame" of lead-out 01240 @param flag Bitfield for control purposes, 01241 bit0= append a text "(aka ...)" to reply if other brands or 01242 vendor names are known. 01243 @return Printable text or NULL on memory shortage. 01244 Dispose by free() when no longer needed. 01245 @since 0.7.2 01246 */ 01247 char *burn_guess_cd_manufacturer(int m_li, int s_li, int f_li, 01248 int m_lo, int s_lo, int f_lo, int flag); 01249 01250 /* ts A90909 */ 01251 /** Retrieve some media information which is mainly specific to CD. For other 01252 media only the bits in reply parameter valid are supposed to be meaningful. 01253 @param d The drive to query. 01254 @param disc_type A string saying either "CD-DA or CD-ROM", or "CD-I", 01255 or ""CD-ROM XA", or "undefined". 01256 @param disc_id A 32 bit number read from the media. (Meaning unclear yet) 01257 @param bar_code 8 hex digits from a barcode on media read by the drive 01258 (if the drive has a bar code reader built in). 01259 @param app_code The Host Application Code which must be set in the Write 01260 Parameters Page if the media is not unrestricted (URU==0). 01261 @param valid Replies bits which indicate the validity of other reply 01262 parameters or the state of certain CD info bits: 01263 bit0= disc_type is valid 01264 bit1= disc_id is valid 01265 bit2= bar_code is valid 01266 bit3= disc_app_code is valid 01267 bit4= Disc is unrestricted (URU bit, 51h READ DISC INFO) 01268 This seems to be broken with my drives. The bit is 01269 0 and the validity bit for disc_app_code is 0 too. 01270 bit5= Disc is nominally erasable (Erasable bit) 01271 This will be set with overwriteable media which 01272 libburn normally considers to be unerasable blank. 01273 @return 1 success, <= 0 an error occured 01274 @since 0.7.2 01275 */ 01276 int burn_disc_get_cd_info(struct burn_drive *d, char disc_type[80], 01277 unsigned int *disc_id, char bar_code[9], int *app_code, 01278 int *valid); 01279 01280 /* ts B00924 */ 01281 /** Read the current usage of the eventual BD Spare Area. This area gets 01282 reserved on BD media during formatting. During writing it is used to 01283 host replacements of blocks which failed the checkread immediately after 01284 writing. 01285 This call applies only to recordable BD media. I.e. profiles 0x41 to 0x43. 01286 @param d The drive to query. 01287 @param alloc_blocks Returns the number of blocks reserved as Spare Area 01288 @param free_blocks Returns the number of yet unused blocks in that area 01289 @param flag Bitfield for control purposes (unused yet, submit 0) 01290 @return 1 = reply prarameters are valid, 01291 <=0 = reply is invalid (e.g. because no BD profile) 01292 @since 0.8.8 01293 */ 01294 int burn_disc_get_bd_spare_info(struct burn_drive *d, 01295 int *alloc_blocks, int *free_blocks, int flag); 01296 01297 /* ts B10801 */ 01298 /** Retrieve some media information which is mainly specific to media of 01299 the DVD-R family: DVD-R , DVD-RW , DVD-R DL , HD DVD-R 01300 Currently the information cannot be retrieved from other media types. 01301 @param d The drive to query. 01302 @param disk_category returns DVD Book to which the media complies 01303 @param book_name returns a pointer to the book name of disk_category. 01304 This memory is static. Do not alter or free it ! 01305 @param part_version returns the Media Version in the DVD Book 01306 @param num_layers returns the number of media layers 01307 @param num_blocks returns the number of blocks between pysical start 01308 and physical end of the media 01309 @param flag Bitfield for control purposes (unused yet, submit 0) 01310 @return 1 = reply prarameters are valid, 01311 <=0 = reply is invalid (e.g. because no DVD-R) 01312 @since 1.1.4 01313 */ 01314 int burn_disc_get_phys_format_info(struct burn_drive *d, int *disk_category, 01315 char **book_name, int *part_version, int *num_layers, 01316 int *num_blocks, int flag); 01317 01318 /* ts A61110 */ 01319 /** Read start lba and Next Writeable Address of a track from media. 01320 Usually a track lba is obtained from the result of burn_track_get_entry(). 01321 This call retrieves an updated lba, eventual nwa, and can address the 01322 invisible track to come. 01323 The drive must be grabbed for this call. One may not issue this call 01324 during ongoing burn_disc_write() or burn_disc_erase(). 01325 @param d The drive to query. 01326 @param o If not NULL: write parameters to be set on drive before query 01327 @param trackno 0=next track to come, >0 number of existing track 01328 @param lba return value: start lba 01329 @param nwa return value: Next Writeable Address 01330 @return 1=nwa is valid , 0=nwa is not valid , -1=error 01331 @since 0.2.6 01332 */ 01333 int burn_disc_track_lba_nwa(struct burn_drive *d, struct burn_write_opts *o, 01334 int trackno, int *lba, int *nwa); 01335 01336 /* ts B10525 */ 01337 /** Tells whether a previous attempt to determine the Next Writeable Address 01338 of the upcomming track reveiled that the READ TRACK INFORMATION Damage Bit 01339 is set for this track, resp. that no valid writable address is available. 01340 See MMC-5 6.27.3.7 Damage Bit, 6.27.3.11 NWA_V (NWA valid) 01341 @param d The drive to query. 01342 @param flag Bitfield for control purposes (unused yet, submit 0) 01343 @return 0= Looks ok: Damage Bit is not set, NWA_V is set 01344 1= Damaged and theoretically writable (NWA_V is set) 01345 2= Not writable: NWA_V is not set 01346 3= Damaged and not writable (NWA_V is not set), 01347 @since 1.1.0 01348 */ 01349 int burn_disc_next_track_is_damaged(struct burn_drive *d, int flag); 01350 01351 /* ts B10527 */ 01352 /** Try to close the last track and session of media which have bit0 set in 01353 the return value of call burn_disc_next_track_is_damaged(). 01354 Whether it helps depends much on the reason why the media is reported 01355 as damaged by the drive. 01356 This call works only for profiles 0x09 CD-R, 0x0a CD-RW, 0x11 DVD-R, 01357 0x14 DVD-RW sequential, 0x1b DVD+R, 0x2b DVD+R DL, 0x41 BD-R sequential. 01358 Note: After writing it is advised to give up the drive and to grab it again 01359 in order to learn about its view on the new media state. 01360 @param o Write options created by burn_write_opts_new() and 01361 manipulated by burn_write_opts_set_multi(). 01362 burn_write_opts_set_write_type() should be set to 01363 BURN_WRITE_TAO, burn_write_opts_set_simulate() should be 01364 set to 0. 01365 @param flag Bitfield for control purposes 01366 bit0= force close, even if no damage was seen 01367 @return <=0 media not marked as damaged, or media type not suitable, 01368 or closing attempted but failed 01369 1= attempt finished without error indication 01370 @since 1.1.0 01371 */ 01372 int burn_disc_close_damaged(struct burn_write_opts *o, int flag); 01373 01374 01375 /* ts A70131 */ 01376 /** Read start lba of the first track in the last complete session. 01377 This is the first parameter of mkisofs option -C. The second parameter 01378 is nwa as obtained by burn_disc_track_lba_nwa() with trackno 0. 01379 @param d The drive to query. 01380 @param start_lba returns the start address of that track 01381 @return <= 0 : failure, 1 = ok 01382 @since 0.3.2 01383 */ 01384 int burn_disc_get_msc1(struct burn_drive *d, int *start_lba); 01385 01386 01387 /* ts A70213 */ 01388 /** Return the best possible estimation of the currently available capacity of 01389 the media. This might depend on particular write option settings. For 01390 inquiring the space with such a set of options, the drive has to be 01391 grabbed and BURN_DRIVE_IDLE. If not, then one will only get a canned value 01392 from the most recent automatic inquiry (e.g. during last drive grabbing). 01393 An eventual start address from burn_write_opts_set_start_byte() will be 01394 subtracted from the obtained capacity estimation. Negative results get 01395 defaulted to 0. 01396 If the drive is actually a file in a large filesystem or a large block 01397 device, then the capacity is curbed to a maximum of 0x7ffffff0 blocks 01398 = 4 TB - 32 KB. 01399 @param d The drive to query. 01400 @param o If not NULL: write parameters to be set on drive before query 01401 @return number of most probably available free bytes 01402 @since 0.3.4 01403 */ 01404 off_t burn_disc_available_space(struct burn_drive *d, 01405 struct burn_write_opts *o); 01406 01407 /* ts A61202 */ 01408 /** Tells the MMC Profile identifier of the loaded media. The drive must be 01409 grabbed in order to get a non-zero result. 01410 libburn currently writes only to profiles 01411 0x09 "CD-R" 01412 0x0a "CD-RW" 01413 0x11 "DVD-R sequential recording" 01414 0x12 "DVD-RAM" 01415 0x13 "DVD-RW restricted overwrite" 01416 0x14 "DVD-RW sequential recording", 01417 0x15 "DVD-R/DL sequential recording", 01418 0x1a "DVD+RW" 01419 0x1b "DVD+R", 01420 0x2b "DVD+R/DL", 01421 0x41 "BD-R sequential recording", 01422 0x43 "BD-RE", 01423 0xffff "stdio file" 01424 Note: 0xffff is not a MMC profile but a libburn invention. 01425 Read-only are the profiles 01426 0x08 "CD-ROM", 01427 0x10 "DVD-ROM", 01428 0x40 "BD-ROM", 01429 Read-only for now is this BD-R profile (testers wanted) 01430 0x42 "BD-R random recording" 01431 @param d The drive where the media is inserted. 01432 @param pno Profile Number. See also mmc5r03c.pdf, table 89 01433 @param name Profile Name (see above list, unknown profiles have empty name) 01434 @return 1 profile is valid, 0 no profile info available 01435 @since 0.3.0 01436 */ 01437 int burn_disc_get_profile(struct burn_drive *d, int *pno, char name[80]); 01438 01439 01440 /* ts A90903 : API */ 01441 /** Obtain product id and standards defined media codes. 01442 The product id is a printable string which is supposed to be the same 01443 for identical media but should vary with non-identical media. Some media 01444 do not allow to obtain such an id at all. 01445 The pair (profile_number, product_id) should be the best id to identify 01446 media with identical product specifications. 01447 The reply parameters media_code1 and media_code2 can be used with 01448 burn_guess_manufacturer() 01449 The reply parameters have to be disposed by free() when no longer needed. 01450 @param d The drive where the media is inserted. 01451 @param product_id Reply: Printable text depicting manufacturer and 01452 eventually media id. 01453 @param media_code1 Reply: The eventual manufacturer identification as read 01454 from DVD/BD media or a text "XXmYYsZZf" from CD media 01455 ATIP lead-in. 01456 @param media_code2 The eventual media id as read from DVD+/BD media or a 01457 text "XXmYYsZZf" from CD ATIP lead-out. 01458 @param book_type Book type text for DVD and BD. 01459 Caution: is NULL with CD, even if return value says ok. 01460 @param flag Bitfield for control purposes 01461 bit0= do not escape " _/" (not suitable for 01462 burn_guess_manufacturer()) 01463 @return 1= ok, product_id and media codes are valid, 01464 0= no product id_available, reply parameters are NULL 01465 <0= error 01466 @since 0.7.2 01467 */ 01468 int burn_disc_get_media_id(struct burn_drive *d, 01469 char **product_id, char **media_code1, char **media_code2, 01470 char **book_type, int flag); 01471 01472 01473 /* ts A90904 */ 01474 /** Guess the name of a manufacturer by profile number, manufacturer code 01475 and media code. The profile number can be obtained by 01476 burn_disc_get_profile(), the other two parameters can be obtained as 01477 media_code1 and media_code2 by burn_get_media_product_id(). 01478 @param profile_no Profile number (submit -1 if not known) 01479 @param manuf_code Manufacturer code from media (e.g. "RICOHJPN") 01480 @param media_code Media ID code from media (e.g. "W11") 01481 @param flag Bitfield for control purposes, submit 0 01482 @return Printable text or NULL on memory shortage. 01483 If the text begins with "Unknown " then no item of the 01484 manufacturer list matched the codes. 01485 Dispose by free() when no longer needed. 01486 @since 0.7.2 01487 */ 01488 char *burn_guess_manufacturer(int profile_no, 01489 char *manuf_code, char *media_code, int flag); 01490 01491 01492 /** Tells whether a disc can be erased or not 01493 @param d The drive to inquire. 01494 @return Non-zero means erasable 01495 */ 01496 int burn_disc_erasable(struct burn_drive *d); 01497 01498 /** Returns the progress and status of a drive. 01499 @param drive The drive to query busy state for. 01500 @param p Returns the progress of the operation, NULL if you don't care 01501 @return the current status of the drive. See also burn_drive_status. 01502 */ 01503 enum burn_drive_status burn_drive_get_status(struct burn_drive *drive, 01504 struct burn_progress *p); 01505 01506 /** Creates a write_opts struct for burning to the specified drive. 01507 The returned object must later be freed with burn_write_opts_free(). 01508 @param drive The drive to write with 01509 @return The write_opts, NULL on error 01510 */ 01511 struct burn_write_opts *burn_write_opts_new(struct burn_drive *drive); 01512 01513 01514 /* ts A70901 */ 01515 /** Inquires the drive associated with a burn_write_opts object. 01516 @param opts object to inquire 01517 @return pointer to drive 01518 @since 0.4.0 01519 */ 01520 struct burn_drive *burn_write_opts_get_drive(struct burn_write_opts *opts); 01521 01522 01523 /** Frees a write_opts struct created with burn_write_opts_new 01524 @param opts write_opts to free 01525 */ 01526 void burn_write_opts_free(struct burn_write_opts *opts); 01527 01528 /** Creates a read_opts struct for reading from the specified drive 01529 must be freed with burn_read_opts_free 01530 @param drive The drive to read from 01531 @return The read_opts 01532 */ 01533 struct burn_read_opts *burn_read_opts_new(struct burn_drive *drive); 01534 01535 /** Frees a read_opts struct created with burn_read_opts_new 01536 @param opts write_opts to free 01537 */ 01538 void burn_read_opts_free(struct burn_read_opts *opts); 01539 01540 /** Erase a disc in the drive. The drive must be grabbed successfully BEFORE 01541 calling this functions. Always ensure that the drive reports a status of 01542 BURN_DISC_FULL before calling this function. An erase operation is not 01543 cancellable, as control of the operation is passed wholly to the drive and 01544 there is no way to interrupt it safely. 01545 @param drive The drive with which to erase a disc. 01546 Only drive roles 1 (MMC) and 5 (stdio random write-only) 01547 support erasing. 01548 @param fast Nonzero to do a fast erase, where only the disc's headers are 01549 erased; zero to erase the entire disc. 01550 With DVD-RW, fast blanking yields media capable only of DAO. 01551 */ 01552 void burn_disc_erase(struct burn_drive *drive, int fast); 01553 01554 01555 /* ts A70101 - A70417 */ 01556 /** Format media for use with libburn. This currently applies to DVD-RW 01557 in state "Sequential Recording" (profile 0014h) which get formatted to 01558 state "Restricted Overwrite" (profile 0013h). DVD+RW can be "de-iced" 01559 by setting bit2 of flag. DVD-RAM and BD-RE may get formatted initially 01560 or re-formatted to adjust their Defect Managment. 01561 This function usually returns while the drive is still in the process 01562 of formatting. The formatting is done, when burn_drive_get_status() 01563 returns BURN_DRIVE_IDLE. This may be immediately after return or may 01564 need several thousand seconds to occur. 01565 @param drive The drive with the disc to format. 01566 @param size The size in bytes to be used with the format command. It should 01567 be divisible by 32*1024. The effect of this parameter may 01568 depend on the media profile and on parameter flag. 01569 @param flag Bitfield for control purposes: 01570 bit0= after formatting, write the given number of zero-bytes 01571 to the media and eventually perform preliminary closing. 01572 bit1+2: size mode 01573 0 = use parameter size as far as it makes sense 01574 1 = insist in size 0 even if there is a better default known 01575 (on DVD-RAM or BD-R identical to size mode 0, 01576 i.e. they never get formatted with payload size 0) 01577 2 = without bit7: format to maximum available size 01578 with bit7 : take size from indexed format descriptor 01579 3 = without bit7: format to default size 01580 with bit7 : take size from indexed format descriptor 01581 bit3= -reserved- 01582 bit4= enforce re-format of (partly) formatted media 01583 bit5= try to disable eventual defect management 01584 bit6= try to avoid lengthy media certification 01585 bit7, bit8 to bit15 = 01586 bit7 enables MMC expert application mode (else libburn 01587 tries to choose a suitable format type): 01588 If it is set then bit8 to bit15 contain the index of 01589 the format to use. See burn_disc_get_formats(), 01590 burn_disc_get_format_descr(). 01591 Acceptable types are: 0x00, 0x01, 0x10, 0x11, 0x13, 01592 0x15, 0x26, 0x30, 0x31, 0x32. 01593 If bit7 is set, then bit4 is set automatically. 01594 bit16= enable POW on blank BD-R 01595 @since 0.3.0 01596 */ 01597 void burn_disc_format(struct burn_drive *drive, off_t size, int flag); 01598 01599 01600 /* ts A70112 */ 01601 /* @since 0.3.0 */ 01602 /** Possible formatting status values */ 01603 #define BURN_FORMAT_IS_UNFORMATTED 1 01604 #define BURN_FORMAT_IS_FORMATTED 2 01605 #define BURN_FORMAT_IS_UNKNOWN 3 01606 01607 /* ts A70112 */ 01608 /** Inquire the formatting status, the associated sizes and the number of 01609 available formats. The info is media specific and stems from MMC command 01610 23h READ FORMAT CAPACITY. See mmc5r03c.pdf 6.24 for background details. 01611 Media type can be determined via burn_disc_get_profile(). 01612 @param drive The drive with the disc to format. 01613 @param status The current formatting status of the inserted media. 01614 See BURN_FORMAT_IS_* macros. Note: "unknown" is the 01615 legal status for quick formatted, yet unwritten DVD-RW. 01616 @param size The size in bytes associated with status. 01617 unformatted: the maximum achievable size of the media 01618 formatted: the currently formatted capacity 01619 unknown: maximum capacity of drive or of media 01620 @param bl_sas Additional info "Block Length/Spare Area Size". 01621 Expected to be constantly 2048 for non-BD media. 01622 @param num_formats The number of available formats. To be used with 01623 burn_disc_get_format_descr() to obtain such a format 01624 and eventually with burn_disc_format() to select one. 01625 @return 1 reply is valid , <=0 failure 01626 @since 0.3.0 01627 */ 01628 int burn_disc_get_formats(struct burn_drive *drive, int *status, off_t *size, 01629 unsigned *bl_sas, int *num_formats); 01630 01631 /* ts A70112 */ 01632 /** Inquire parameters of an available media format. 01633 @param drive The drive with the disc to format. 01634 @param index The index of the format item. Beginning with 0 up to reply 01635 parameter from burn_disc_get_formats() : num_formats - 1 01636 @param type The format type. See mmc5r03c.pdf, 6.5, 04h FORMAT UNIT. 01637 0x00=full, 0x10=CD-RW/DVD-RW full, 0x11=CD-RW/DVD-RW grow, 01638 0x15=DVD-RW quick, 0x13=DVD-RW quick grow, 01639 0x26=DVD+RW background, 0x30=BD-RE with spare areas, 01640 0x31=BD-RE without spare areas 01641 @param size The maximum size in bytes achievable with this format. 01642 @param tdp Type Dependent Parameter. See mmc5r03c.pdf. 01643 @return 1 reply is valid , <=0 failure 01644 @since 0.3.0 01645 */ 01646 int burn_disc_get_format_descr(struct burn_drive *drive, int index, 01647 int *type, off_t *size, unsigned *tdp); 01648 01649 01650 01651 /* ts A61109 : this was and is defunct */ 01652 /** Read a disc from the drive and write it to an fd pair. The drive must be 01653 grabbed successfully BEFORE calling this function. Always ensure that the 01654 drive reports a status of BURN_DISC_FULL before calling this function. 01655 @param drive The drive from which to read a disc. 01656 @param o The options for the read operation. 01657 */ 01658 void burn_disc_read(struct burn_drive *drive, const struct burn_read_opts *o); 01659 01660 01661 01662 /* ts A70222 */ 01663 /* @since 0.3.4 */ 01664 /** The length of a rejection reasons string for burn_precheck_write() and 01665 burn_write_opts_auto_write_type() . 01666 */ 01667 #define BURN_REASONS_LEN 4096 01668 01669 01670 /* ts A70219 */ 01671 /** Examines a completed setup for burn_disc_write() whether it is permissible 01672 with drive and media. This function is called by burn_disc_write() but 01673 an application might be interested in this check in advance. 01674 @param o The options for the writing operation. 01675 @param disc The descrition of the disc to be created 01676 @param reasons Eventually returns a list of rejection reason statements 01677 @param silent 1= do not issue error messages , 0= report problems 01678 @return 1 ok, -1= no recordable media detected, 0= other failure 01679 @since 0.3.4 01680 */ 01681 int burn_precheck_write(struct burn_write_opts *o, struct burn_disc *disc, 01682 char reasons[BURN_REASONS_LEN], int silent); 01683 01684 01685 /** Write a disc in the drive. The drive must be grabbed successfully before 01686 calling this function. Always ensure that the drive reports a status of 01687 BURN_DISC_BLANK ot BURN_DISC_APPENDABLE before calling this function. 01688 Note: write_type BURN_WRITE_SAO is currently not capable of writing a mix 01689 of data and audio tracks. You must use BURN_WRITE_TAO for such sessions. 01690 To be set by burn_write_opts_set_write_type(). 01691 Note: This function is not suitable for overwriting data in the middle of 01692 a valid data area because it is allowed to append trailing data. 01693 For exact random access overwriting use burn_random_access_write(). 01694 Note: After writing it is advised to give up the drive and to grab it again 01695 in order to learn about its view on the new media state. 01696 Note: Before mounting the written media it might be necessary to eject 01697 and reload in order to allow the operating system to notice the new 01698 media state. 01699 @param o The options for the writing operation. 01700 @param disc The struct burn_disc * that described the disc to be created 01701 */ 01702 void burn_disc_write(struct burn_write_opts *o, struct burn_disc *disc); 01703 01704 01705 /* ts A90227 */ 01706 /** Control stream recording during the write run and eventually set the start 01707 LBA for stream recording. 01708 Stream recording is set from struct burn_write_opts when the write run 01709 gets started. See burn_write_opts_set_stream_recording(). 01710 The call described here can be used later to override this setting and 01711 to program automatic switching at a given LBA. It also affects subsequent 01712 calls to burn_random_access_write(). 01713 @param drive The drive which performs the write operation. 01714 @param recmode -1= disable stream recording 01715 0= leave setting as is 01716 1= enable stream recording 01717 @param start The LBA where actual stream recording shall start. 01718 (0 means unconditional stream recording) 01719 @param flag Bitfield for control purposes (unused yet, submit 0). 01720 @return 1=success , <=0 failure 01721 @since 0.6.4 01722 */ 01723 int burn_drive_set_stream_recording(struct burn_drive *drive, int recmode, 01724 int start, int flag); 01725 01726 /** Cancel an operation on a drive. 01727 This will only work when the drive's busy state is BURN_DRIVE_READING or 01728 BURN_DRIVE_WRITING. 01729 @param drive The drive on which to cancel the current operation. 01730 */ 01731 void burn_drive_cancel(struct burn_drive *drive); 01732 01733 01734 /* ts A61223 */ 01735 /** Inquire whether the most recent asynchronous media job was successful. 01736 This applies to burn_disc_erase(), burn_disc_format(), burn_disc_write(). 01737 Reasons for non-success may be: rejection of burn parameters, abort due to 01738 fatal errors during write, blank or format, a call to burn_drive_cancel() 01739 by the application thread. 01740 @param d The drive to inquire. 01741 @return 1=burn seems to have went well, 0=burn failed 01742 @since 0.2.6 01743 */ 01744 int burn_drive_wrote_well(struct burn_drive *d); 01745 01746 01747 /** Convert a minute-second-frame (MSF) value to sector count 01748 @param m Minute component 01749 @param s Second component 01750 @param f Frame component 01751 @return The sector count 01752 */ 01753 int burn_msf_to_sectors(int m, int s, int f); 01754 01755 /** Convert a sector count to minute-second-frame (MSF) 01756 @param sectors The sector count 01757 @param m Returns the minute component 01758 @param s Returns the second component 01759 @param f Returns the frame component 01760 */ 01761 void burn_sectors_to_msf(int sectors, int *m, int *s, int *f); 01762 01763 /** Convert a minute-second-frame (MSF) value to an lba 01764 @param m Minute component 01765 @param s Second component 01766 @param f Frame component 01767 @return The lba 01768 */ 01769 int burn_msf_to_lba(int m, int s, int f); 01770 01771 /** Convert an lba to minute-second-frame (MSF) 01772 @param lba The lba 01773 @param m Returns the minute component 01774 @param s Returns the second component 01775 @param f Returns the frame component 01776 */ 01777 void burn_lba_to_msf(int lba, int *m, int *s, int *f); 01778 01779 /** Create a new disc 01780 @return Pointer to a burn_disc object or NULL on failure. 01781 */ 01782 struct burn_disc *burn_disc_create(void); 01783 01784 /** Delete disc and decrease the reference count on all its sessions 01785 @param d The disc to be freed 01786 */ 01787 void burn_disc_free(struct burn_disc *d); 01788 01789 /** Create a new session 01790 @return Pointer to a burn_session object or NULL on failure. 01791 */ 01792 struct burn_session *burn_session_create(void); 01793 01794 /** Free a session (and decrease reference count on all tracks inside) 01795 @param s Session to be freed 01796 */ 01797 void burn_session_free(struct burn_session *s); 01798 01799 /** Add a session to a disc at a specific position, increasing the 01800 sessions's reference count. 01801 @param d Disc to add the session to 01802 @param s Session to add to the disc 01803 @param pos position to add at (BURN_POS_END is "at the end") 01804 @return 0 for failure, 1 for success 01805 */ 01806 int burn_disc_add_session(struct burn_disc *d, struct burn_session *s, 01807 unsigned int pos); 01808 01809 /** Remove a session from a disc 01810 @param d Disc to remove session from 01811 @param s Session pointer to find and remove 01812 */ 01813 int burn_disc_remove_session(struct burn_disc *d, struct burn_session *s); 01814 01815 01816 /** Create a track (for TAO recording, or to put in a session) */ 01817 struct burn_track *burn_track_create(void); 01818 01819 /** Free a track 01820 @param t Track to free 01821 */ 01822 void burn_track_free(struct burn_track *t); 01823 01824 /** Add a track to a session at specified position 01825 @param s Session to add to 01826 @param t Track to insert in session 01827 @param pos position to add at (BURN_POS_END is "at the end") 01828 @return 0 for failure, 1 for success 01829 */ 01830 int burn_session_add_track(struct burn_session *s, struct burn_track *t, 01831 unsigned int pos); 01832 01833 /** Remove a track from a session 01834 @param s Session to remove track from 01835 @param t Track pointer to find and remove 01836 @return 0 for failure, 1 for success 01837 */ 01838 int burn_session_remove_track(struct burn_session *s, struct burn_track *t); 01839 01840 01841 /** Define the data in a track 01842 @param t the track to define 01843 @param offset The lib will write this many 0s before start of data 01844 @param tail The number of extra 0s to write after data 01845 @param pad 1 means the lib should pad the last sector with 0s if the 01846 track isn't exactly sector sized. (otherwise the lib will 01847 begin reading from the next track) 01848 @param mode data format (bitfield) 01849 */ 01850 void burn_track_define_data(struct burn_track *t, int offset, int tail, 01851 int pad, int mode); 01852 01853 01854 /* ts A61024 */ 01855 /** Define whether a track shall swap bytes of its input stream. 01856 @param t The track to change 01857 @param swap_source_bytes 0=do not swap, 1=swap byte pairs 01858 @return 1=success , 0=unacceptable value 01859 @since 0.2.6 01860 */ 01861 int burn_track_set_byte_swap(struct burn_track *t, int swap_source_bytes); 01862 01863 01864 /* ts A90910 */ 01865 /** Activates CD XA compatibility modes. 01866 libburn currently writes data only in CD mode 1. Some programs insist in 01867 sending data with additional management bytes. These bytes have to be 01868 stripped in order to make the input suitable for BURN_MODE1. 01869 @param t The track to manipulate 01870 @param value 0= no conversion 01871 1= strip 8 byte sector headers of CD-ROM XA mode 2 form 1 01872 see MMC-5 4.2.3.8.5.3 Block Format for Mode 2 form 1 Data 01873 all other values are reserved 01874 @return 1=success , 0=unacceptable value 01875 @since 0.7.2 01876 */ 01877 int burn_track_set_cdxa_conv(struct burn_track *t, int value); 01878 01879 01880 /** Set the ISRC details for a track 01881 @param t The track to change 01882 @param country the 2 char country code. Each character must be 01883 only numbers or letters. 01884 @param owner 3 char owner code. Each character must be only numbers 01885 or letters. 01886 @param year 2 digit year. A number in 0-99 (Yep, not Y2K friendly). 01887 @param serial 5 digit serial number. A number in 0-99999. 01888 */ 01889 void burn_track_set_isrc(struct burn_track *t, char *country, char *owner, 01890 unsigned char year, unsigned int serial); 01891 01892 /** Disable ISRC parameters for a track 01893 @param t The track to change 01894 */ 01895 void burn_track_clear_isrc(struct burn_track *t); 01896 01897 /** Hide the first track in the "pre gap" of the disc 01898 @param s session to change 01899 @param onoff 1 to enable hiding, 0 to disable 01900 */ 01901 void burn_session_hide_first_track(struct burn_session *s, int onoff); 01902 01903 /** Get the drive's disc struct - free when done 01904 @param d drive to query 01905 @return the disc struct or NULL on failure 01906 */ 01907 struct burn_disc *burn_drive_get_disc(struct burn_drive *d); 01908 01909 /** Set the track's data source 01910 @param t The track to set the data source for 01911 @param s The data source to use for the contents of the track 01912 @return An error code stating if the source is ready for use for 01913 writing the track, or if an error occured 01914 01915 */ 01916 enum burn_source_status burn_track_set_source(struct burn_track *t, 01917 struct burn_source *s); 01918 01919 01920 /* ts A70218 */ 01921 /** Set a default track size to be used only if the track turns out to be of 01922 unpredictable length and if the effective write type demands a fixed size. 01923 This can be useful to enable write types CD SAO or DVD DAO together with 01924 a track source like stdin. If the track source delivers fewer bytes than 01925 announced then the track will be padded up with zeros. 01926 @param t The track to change 01927 @param size The size to set 01928 @return 0=failure 1=sucess 01929 @since 0.3.4 01930 */ 01931 int burn_track_set_default_size(struct burn_track *t, off_t size); 01932 01933 /** Free a burn_source (decrease its refcount and maybe free it) 01934 @param s Source to free 01935 */ 01936 void burn_source_free(struct burn_source *s); 01937 01938 /** Creates a data source for an image file (and maybe subcode file) 01939 @param path The file address for the main channel payload. 01940 @param subpath Eventual address for subchannel data. Only used in exotic 01941 raw write modes. Submit NULL for normal tasks. 01942 @return Pointer to a burn_source object, NULL indicates failure 01943 */ 01944 struct burn_source *burn_file_source_new(const char *path, 01945 const char *subpath); 01946 01947 01948 /* ts A91122 : An interface to open(O_DIRECT) or similar OS tricks. */ 01949 01950 /** Opens a file with eventual acceleration preparations which may depend 01951 on the operating system and on compile time options of libburn. 01952 You may use this call instead of open(2) for opening file descriptors 01953 which shall be handed to burn_fd_source_new(). 01954 This should only be done for tracks with BURN_BLOCK_MODE1 (2048 bytes 01955 per block). 01956 01957 If you use this call then you MUST allocate the buffers which you use 01958 with read(2) by call burn_os_alloc_buffer(). Read sizes MUST be a multiple 01959 of a safe buffer amount. Else you risk that track data get altered during 01960 transmission. 01961 burn_disk_write() will allocate a suitable read/write buffer for its own 01962 operations. A fifo created by burn_fifo_source_new() will allocate 01963 suitable memory for its buffer if called with flag bit0 and a multiple 01964 of a safe buffer amount. 01965 @param path The file address to open 01966 @param open_flags The flags as of man 2 open. Normally just O_RDONLY. 01967 @param flag Bitfield for control purposes (unused yet, submit 0). 01968 @return A file descriptor as of open(2). Finally to be disposed 01969 by close(2). 01970 -1 indicates failure. 01971 @since 0.7.4 01972 */ 01973 int burn_os_open_track_src(char *path, int open_flags, int flag); 01974 01975 /** Allocate a memory area that is suitable for reading with a file descriptor 01976 opened by burn_os_open_track_src(). 01977 @param amount Number of bytes to allocate. This should be a multiple 01978 of the operating system's i/o block size. 32 KB is 01979 guaranteed by libburn to be safe. 01980 @param flag Bitfield for control purposes (unused yet, submit 0). 01981 @return The address of the allocated memory, or NULL on failure. 01982 A non-NULL return value has finally to be disposed via 01983 burn_os_free_buffer(). 01984 @since 0.7.4 01985 */ 01986 void *burn_os_alloc_buffer(size_t amount, int flag); 01987 01988 /** Dispose a memory area which was obtained by burn_os_alloc_buffer(), 01989 @param buffer Memory address to be freed. 01990 @param amount The number of bytes which was allocated at that 01991 address. 01992 @param flag Bitfield for control purposes (unused yet, submit 0). 01993 @return 1 success , <=0 failure 01994 @since 0.7.4 01995 */ 01996 int burn_os_free_buffer(void *buffer, size_t amount, int flag); 01997 01998 01999 /** Creates a data source for an image file (a track) from an open 02000 readable filedescriptor, an eventually open readable subcodes file 02001 descriptor and eventually a fixed size in bytes. 02002 @param datafd The source of data. 02003 @param subfd The eventual source of subchannel data. Only used in exotic 02004 raw write modes. Submit -1 for normal tasks. 02005 @param size The eventual fixed size of eventually both fds. 02006 If this value is 0, the size will be determined from datafd. 02007 @return Pointer to a burn_source object, NULL indicates failure 02008 */ 02009 struct burn_source *burn_fd_source_new(int datafd, int subfd, off_t size); 02010 02011 02012 /* ts B00922 */ 02013 /** Creates an offset source which shall provide a byte interval of a stream 02014 to its consumer. It is supposed to be chain-linked with other offset 02015 sources which serve neighboring consumers. The chronological sequence 02016 of consumers and the sequence of offset sources must match. The intervals 02017 of the sources must not overlap. 02018 02019 A chain of these burn_source objects may be used to feed multiple tracks 02020 from one single stream of input bytes. 02021 Each of the offset sources will skip the bytes up to its start address and 02022 provide the prescribed number of bytes to the track. Skipping takes into 02023 respect the bytes which have been processed by eventual predecessors in the 02024 chain. 02025 Important: It is not allowed to free an offset source before its successor 02026 has ended its work. Best is to keep them all until all tracks 02027 are done. 02028 02029 @param inp The burn_source object from which to read stream data. 02030 E.g. created by burn_file_source_new(). 02031 @param prev The eventual offset source object which shall read data from 02032 inp before the new offset source will begin its own work. 02033 This must either be a result of burn_offst_source_new() or 02034 it must be NULL. 02035 @param start The byte address where to start reading bytes for the 02036 consumer. inp bytes may get skipped to reach this address. 02037 @param size The number of bytes to be delivered to the consumer. 02038 @param flag Bitfield for control purposes (unused yet, submit 0). 02039 @return Pointer to a burn_source object, later to be freed by 02040 burn_source_free(). NULL indicates failure. 02041 @since 0.8.8 02042 */ 02043 struct burn_source *burn_offst_source_new( 02044 struct burn_source *inp, struct burn_source *prev, 02045 off_t start, off_t size, int flag); 02046 02047 /* ts A70930 */ 02048 /** Creates a fifo which acts as proxy for an already existing data source. 02049 The fifo provides a ring buffer which shall smoothen the data stream 02050 between burn_source and writer thread. Each fifo serves only for one 02051 data source and gets attached to one track as its only data source 02052 by burn_track_set_source(). 02053 A fifo starts its life in "standby" mode with no buffer space allocated. 02054 As soon as its track requires bytes, the fifo establishes a worker thread 02055 and allocates its buffer. After input has ended and all buffer content is 02056 consumed, the buffer space gets freed and the worker thread ends. 02057 This happens asynchronously. So expect two buffers and worker threads to 02058 exist for a short time between tracks. Be modest in your size demands if 02059 multiple tracks are to be expected. 02060 @param inp The burn_source for which the fifo shall act as proxy. 02061 It can be disposed by burn_source_free() immediately 02062 after this call. 02063 @param chunksize The size in bytes of a chunk. 02064 Use 2048 for sources suitable for BURN_BLOCK_MODE1, 02065 2352 for sources which deliver for BURN_BLOCK_AUDIO, 02066 2056 for sources which shall get treated by 02067 burn_track_set_cdxa_conv(track, 1). 02068 Some variations of burn_source might work only with 02069 a particular chunksize. E.g. libisofs demands 2048. 02070 @param chunks The number of chunks to be allocated in ring buffer. 02071 This value must be >= 2. 02072 @param flag Bitfield for control purposes: 02073 bit0= The read method of inp is capable of delivering 02074 arbitrary amounts of data per call. Not only one 02075 sector. 02076 Suitable for inp from burn_file_source_new() 02077 and burn_fd_source_new() if not the fd has 02078 exotic limitations on read size. 02079 You MUST use this on inp which uses an fd opened 02080 with burn_os_open_track_src(). 02081 Better do not use with other inp types. 02082 @since 0.7.4 02083 @return A pointer to the newly created burn_source. 02084 Later both burn_sources, inp and the returned fifo, have 02085 to be disposed by calling burn_source_free() for each. 02086 inp can be freed immediately, the returned fifo may be 02087 kept as handle for burn_fifo_inquire_status(). 02088 @since 0.4.0 02089 */ 02090 struct burn_source *burn_fifo_source_new(struct burn_source *inp, 02091 int chunksize, int chunks, int flag); 02092 02093 /* ts A71003 */ 02094 /** Inquires state and fill parameters of a fifo burn_source which was created 02095 by burn_fifo_source_new() . Do not use with other burn_source variants. 02096 @param fifo The fifo object to inquire 02097 @param size The total size of the fifo 02098 @param free_bytes The current free capacity of the fifo 02099 @param status_text Returns a pointer to a constant text, see below 02100 @return <0 reply invalid, >=0 fifo status code: 02101 bit0+1=input status, bit2=consumption status, i.e: 02102 0="standby" : data processing not started yet 02103 1="active" : input and consumption are active 02104 2="ending" : input has ended without error 02105 3="failing" : input had error and ended, 02106 4="unused" : ( consumption has ended before processing start ) 02107 5="abandoned" : consumption has ended prematurely 02108 6="ended" : consumption has ended without input error 02109 7="aborted" : consumption has ended after input error 02110 @since 0.4.0 02111 */ 02112 int burn_fifo_inquire_status(struct burn_source *fifo, int *size, 02113 int *free_bytes, char **status_text); 02114 02115 /* ts A91125 */ 02116 /** Inquire various counters which reflect the fifo operation. 02117 @param fifo The fifo object to inquire 02118 @param total_min_fill The minimum number of bytes in the fifo. Beginning 02119 from the moment when fifo consumption is enabled. 02120 @param interval_min_fill The minimum byte number beginning from the moment 02121 when fifo consumption is enabled or from the 02122 most recent moment when burn_fifo_next_interval() 02123 was called. 02124 @param put_counter The number of data transactions into the fifo. 02125 @param get_counter The number of data transactions out of the fifo. 02126 @param empty_counter The number of times the fifo was empty. 02127 @param full_counter The number of times the fifo was full. 02128 @since 0.7.4 02129 */ 02130 void burn_fifo_get_statistics(struct burn_source *fifo, 02131 int *total_min_fill, int *interval_min_fill, 02132 int *put_counter, int *get_counter, 02133 int *empty_counter, int *full_counter); 02134 02135 /* ts A91125 */ 02136 /** Inquire the fifo minimum fill counter for intervals and reset that counter. 02137 @param fifo The fifo object to inquire 02138 @param interval_min_fill The minimum number of bytes in the fifo. Beginning 02139 from the moment when fifo consumption is enabled 02140 or from the most recent moment when 02141 burn_fifo_next_interval() was called. 02142 @since 0.7.4 02143 */ 02144 void burn_fifo_next_interval(struct burn_source *fifo, int *interval_min_fill); 02145 02146 /* ts A80713 */ 02147 /** Obtain a preview of the first input data of a fifo which was created 02148 by burn_fifo_source_new(). The data will later be delivered normally to 02149 the consumer track of the fifo. 02150 bufsize may not be larger than the fifo size (chunk_size * chunks) - 32k. 02151 This call will succeed only if data consumption by the track has not 02152 started yet, i.e. best before the call to burn_disc_write(). 02153 It will start the worker thread of the fifo with the expectable side 02154 effects on the external data source. Then it waits either until enough 02155 data have arrived or until it becomes clear that this will not happen. 02156 The call may be repeated with increased bufsize. It will always yield 02157 the bytes beginning from the first one in the fifo. 02158 @param fifo The fifo object to inquire resp. start 02159 @param buf Pointer to memory of at least bufsize bytes where to 02160 deliver the peeked data. 02161 @param bufsize Number of bytes to peek from the start of the fifo data 02162 @param flag Bitfield for control purposes (unused yet, submit 0). 02163 @return <0 on severe error, 0 if not enough data, 1 if bufsize bytes read 02164 @since 0.5.0 02165 */ 02166 int burn_fifo_peek_data(struct burn_source *fifo, char *buf, int bufsize, 02167 int flag); 02168 02169 /* ts A91125 */ 02170 /** Start the fifo worker thread and wait either until the requested number 02171 of bytes have arrived or until it becomes clear that this will not happen. 02172 Filling will go on asynchronously after burn_fifo_fill() returned. 02173 This call and burn_fifo_peek_data() do not disturb each other. 02174 @param fifo The fifo object to start 02175 @param fill Number of bytes desired. Expect to get return 1 if 02176 at least fifo size - 32k were read. 02177 @param flag Bitfield for control purposes. 02178 bit0= fill fifo to maximum size 02179 @return <0 on severe error, 0 if not enough data, 02180 1 if desired amount or fifo full 02181 @since 0.7.4 02182 */ 02183 int burn_fifo_fill(struct burn_source *fifo, int fill, int flag); 02184 02185 02186 /* ts A70328 */ 02187 /** Sets a fixed track size after the data source object has already been 02188 created. 02189 @param t The track to operate on 02190 @param size the number of bytes to use as track size 02191 @return <=0 indicates failure , >0 success 02192 @since 0.3.6 02193 */ 02194 int burn_track_set_size(struct burn_track *t, off_t size); 02195 02196 02197 /** Tells how long a track will be on disc 02198 >>> NOTE: Not reliable with tracks of undefined length 02199 */ 02200 int burn_track_get_sectors(struct burn_track *); 02201 02202 02203 /* ts A61101 */ 02204 /** Tells how many source bytes have been read and how many data bytes have 02205 been written by the track during burn. 02206 @param t The track to inquire 02207 @param read_bytes Number of bytes read from the track source 02208 @param written_bytes Number of bytes written to track 02209 @since 0.2.6 02210 */ 02211 int burn_track_get_counters(struct burn_track *t, 02212 off_t *read_bytes, off_t *written_bytes); 02213 02214 02215 /** Sets drive read and write speed 02216 Note: "k" is 1000, not 1024. 1xCD = 176.4 k/s, 1xDVD = 1385 k/s. 02217 Fractional speeds should be rounded up. Like 4xCD = 706. 02218 @param d The drive to set speed for 02219 @param read Read speed in k/s (0 is max, -1 is min). 02220 @param write Write speed in k/s (0 is max, -1 is min). 02221 */ 02222 void burn_drive_set_speed(struct burn_drive *d, int read, int write); 02223 02224 02225 /* ts A70711 */ 02226 /** Controls the behavior with writing when the drive buffer is suspected to 02227 be full. To check and wait for enough free buffer space before writing 02228 will move the task of waiting from the operating system's device driver 02229 to libburn. While writing is going on and waiting is enabled, any write 02230 operation will be checked whether it will fill the drive buffer up to 02231 more than max_percent. If so, then waiting will happen until the buffer 02232 fill is predicted with at most min_percent. 02233 Thus: if min_percent < max_percent then transfer rate will oscillate. 02234 This may allow the driver to operate on other devices, e.g. a disk from 02235 which to read the input for writing. On the other hand, this checking might 02236 reduce maximum throughput to the drive or even get misled by faulty buffer 02237 fill replies from the drive. 02238 If a setting parameter is < 0, then this setting will stay unchanged 02239 by the call. 02240 Known burner or media specific pitfalls: 02241 To have max_percent larger than the burner's best reported buffer fill has 02242 the same effect as min_percent==max_percent. Some burners do not report 02243 their full buffer with all media types. Some are not suitable because 02244 they report their buffer fill with delay. 02245 @param d The drive to control 02246 @param enable 0= disable , 1= enable waiting , (-1 = do not change setting) 02247 @param min_usec Shortest possible sleeping period (given in micro seconds) 02248 @param max_usec Longest possible sleeping period (given in micro seconds) 02249 @param timeout_sec If a single write has to wait longer than this number 02250 of seconds, then waiting gets disabled and mindless 02251 writing starts. A value of 0 disables this timeout. 02252 @param min_percent Minimum of desired buffer oscillation: 25 to 100 02253 @param max_percent Maximum of desired buffer oscillation: 25 to 100 02254 @return 1=success , 0=failure 02255 @since 0.3.8 02256 */ 02257 int burn_drive_set_buffer_waiting(struct burn_drive *d, int enable, 02258 int min_usec, int max_usec, int timeout_sec, 02259 int min_percent, int max_percent); 02260 02261 02262 /* these are for my debugging, they will disappear */ 02263 void burn_structure_print_disc(struct burn_disc *d); 02264 void burn_structure_print_session(struct burn_session *s); 02265 void burn_structure_print_track(struct burn_track *t); 02266 02267 /** Sets the write type for the write_opts struct. 02268 Note: write_type BURN_WRITE_SAO is currently not capable of writing a mix 02269 of data and audio tracks. You must use BURN_WRITE_TAO for such sessions. 02270 @param opts The write opts to change 02271 @param write_type The write type to use 02272 @param block_type The block type to use 02273 @return Returns 1 on success and 0 on failure. 02274 */ 02275 int burn_write_opts_set_write_type(struct burn_write_opts *opts, 02276 enum burn_write_types write_type, 02277 int block_type); 02278 02279 02280 /* ts A70207 */ 02281 /** As an alternative to burn_write_opts_set_write_type() this function tries 02282 to find a suitable write type and block type for a given write job 02283 described by opts and disc. To be used after all other setups have been 02284 made, i.e. immediately before burn_disc_write(). 02285 @param opts The nearly complete write opts to change 02286 @param disc The already composed session and track model 02287 @param reasons This text string collects reasons for decision resp. failure 02288 @param flag Bitfield for control purposes: 02289 bit0= do not choose type but check the one that is already set 02290 bit1= do not issue error messages via burn_msgs queue 02291 (is automatically set with bit0) 02292 @return Chosen write type. BURN_WRITE_NONE on failure. 02293 @since 0.3.2 02294 */ 02295 enum burn_write_types burn_write_opts_auto_write_type( 02296 struct burn_write_opts *opts, struct burn_disc *disc, 02297 char reasons[BURN_REASONS_LEN], int flag); 02298 02299 02300 /** Supplies toc entries for writing - not normally required for cd mastering 02301 @param opts The write opts to change 02302 @param count The number of entries 02303 @param toc_entries 02304 */ 02305 void burn_write_opts_set_toc_entries(struct burn_write_opts *opts, 02306 int count, 02307 struct burn_toc_entry *toc_entries); 02308 02309 /** Sets the session format for a disc 02310 @param opts The write opts to change 02311 @param format The session format to set 02312 */ 02313 void burn_write_opts_set_format(struct burn_write_opts *opts, int format); 02314 02315 /** Sets the simulate value for the write_opts struct . 02316 This corresponds to the Test Write bit in MMC mode page 05h. Several media 02317 types do not support this. See struct burn_multi_caps.might_simulate for 02318 actual availability of this feature. 02319 If the media is suitable, the drive will perform burn_disc_write() as a 02320 simulation instead of effective write operations. This means that the 02321 media content and burn_disc_get_status() stay unchanged. 02322 Note: With stdio-drives, the target file gets eventually created, opened, 02323 lseeked, and closed, but not written. So there are effects on it. 02324 Warning: Call burn_random_access_write() will never do simulation because 02325 it does not get any burn_write_opts. 02326 @param opts The write opts to change 02327 @param sim Non-zero enables simulation, 0 enables real writing 02328 @return Returns 1 on success and 0 on failure. 02329 */ 02330 int burn_write_opts_set_simulate(struct burn_write_opts *opts, int sim); 02331 02332 /** Controls buffer underrun prevention 02333 @param opts The write opts to change 02334 @param underrun_proof if non-zero, buffer underrun protection is enabled 02335 @return Returns 1 on success and 0 on failure. 02336 */ 02337 int burn_write_opts_set_underrun_proof(struct burn_write_opts *opts, 02338 int underrun_proof); 02339 02340 /** Sets whether to use opc or not with the write_opts struct 02341 @param opts The write opts to change 02342 @param opc If non-zero, optical power calibration will be performed at 02343 start of burn 02344 02345 */ 02346 void burn_write_opts_set_perform_opc(struct burn_write_opts *opts, int opc); 02347 02348 void burn_write_opts_set_has_mediacatalog(struct burn_write_opts *opts, int has_mediacatalog); 02349 02350 void burn_write_opts_set_mediacatalog(struct burn_write_opts *opts, unsigned char mediacatalog[13]); 02351 02352 02353 /* ts A61106 */ 02354 /** Sets the multi flag which eventually marks the emerging session as not 02355 being the last one and thus creating a BURN_DISC_APPENDABLE media. 02356 Note: DVD-R[W] in write mode BURN_WRITE_SAO are not capable of this. 02357 DVD-R DL are not capable of this at all. 02358 libburn will refuse to write if burn_write_opts_set_multi() is 02359 enabled under such conditions. 02360 @param opts The option object to be manipulated 02361 @param multi 1=media will be appendable, 0=media will be closed (default) 02362 @since 0.2.6 02363 */ 02364 void burn_write_opts_set_multi(struct burn_write_opts *opts, int multi); 02365 02366 02367 /* ts A61222 */ 02368 /** Sets a start address for writing to media and write modes which allow to 02369 choose this address at all (for now: DVD+RW, DVD-RAM, formatted DVD-RW). 02370 now). The address is given in bytes. If it is not -1 then a write run 02371 will fail if choice of start address is not supported or if the block 02372 alignment of the address is not suitable for media and write mode. 02373 Alignment to 32 kB blocks is supposed to be safe with DVD media. 02374 Call burn_disc_get_multi_caps() can obtain the necessary media info. See 02375 resulting struct burn_multi_caps elements .start_adr , .start_alignment , 02376 .start_range_low , .start_range_high . 02377 @param opts The write opts to change 02378 @param value The address in bytes (-1 = start at default address) 02379 @since 0.3.0 02380 */ 02381 void burn_write_opts_set_start_byte(struct burn_write_opts *opts, off_t value); 02382 02383 02384 /* ts A70213 */ 02385 /** Caution: still immature and likely to change. Problems arose with 02386 sequential DVD-RW on one drive. 02387 02388 Controls whether the whole available space of the media shall be filled up 02389 by the last track of the last session. 02390 @param opts The write opts to change 02391 @param fill_up_media If 1 : fill up by last track, if 0 = do not fill up 02392 @since 0.3.4 02393 */ 02394 void burn_write_opts_set_fillup(struct burn_write_opts *opts, 02395 int fill_up_media); 02396 02397 02398 /* ts A70303 */ 02399 /** Eventually makes libburn ignore the failure of some conformance checks: 02400 - the check whether CD write+block type is supported by the drive 02401 - the check whether the media profile supports simulated burning 02402 @param opts The write opts to change 02403 @param use_force 1=ignore above checks, 0=refuse work on failed check 02404 @since 0.3.4 02405 */ 02406 void burn_write_opts_set_force(struct burn_write_opts *opts, int use_force); 02407 02408 02409 /* ts A80412 */ 02410 /** Eventually makes use of the more modern write command AAh WRITE12 and 02411 sets the Streaming bit. With DVD-RAM and BD this can override the 02412 traditional slowdown to half nominal speed. But if it speeds up writing 02413 then it also disables error management and correction. Weigh your 02414 priorities. This affects the write operations of burn_disc_write() 02415 and subsequent calls of burn_random_access_write(). 02416 @param opts The write opts to change 02417 @param value 0=use 2Ah WRITE10, 1=use AAh WRITE12 with Streaming bit 02418 @since 0.6.4: 02419 >=16 use WRITE12 but not before the LBA given by value 02420 @since 0.4.6 02421 */ 02422 void burn_write_opts_set_stream_recording(struct burn_write_opts *opts, 02423 int value); 02424 02425 /* ts A91115 */ 02426 /** Overrides the write chunk size for DVD and BD media which is normally 02427 determined according to media type and setting of stream recording. 02428 A chunk size of 64 KB may improve throughput with bus systems which show 02429 latency problems. 02430 @param opts The write opts to change 02431 @param obs Number of bytes which shall be sent by a single write command. 02432 0 means automatic size, 32768 and 65336 are the only other 02433 accepted sizes for now. 02434 @since 0.7.4 02435 */ 02436 void burn_write_opts_set_dvd_obs(struct burn_write_opts *opts, int obs); 02437 02438 /* ts A91115 */ 02439 /** Sets the rythm by which stdio pseudo drives force their output data to 02440 be consumed by the receiving storage device. This forcing keeps the memory 02441 from being clogged with lots of pending data for slow devices. 02442 @param opts The write opts to change 02443 @param rythm Number of 2KB output blocks after which fsync(2) is 02444 performed. -1 means no fsync(), 0 means default, 02445 elsewise the value must be >= 32. 02446 Default is currently 8192 = 16 MB. 02447 @since 0.7.4 02448 */ 02449 void burn_write_opts_set_stdio_fsync(struct burn_write_opts *opts, int rythm); 02450 02451 02452 /** Sets whether to read in raw mode or not 02453 @param opts The read opts to change 02454 @param raw_mode If non-zero, reading will be done in raw mode, so that everything in the data tracks on the 02455 disc is read, including headers. 02456 */ 02457 void burn_read_opts_set_raw(struct burn_read_opts *opts, int raw_mode); 02458 02459 /** Sets whether to report c2 errors or not 02460 @param opts The read opts to change 02461 @param c2errors If non-zero, report c2 errors. 02462 */ 02463 void burn_read_opts_set_c2errors(struct burn_read_opts *opts, int c2errors); 02464 02465 /** Sets whether to read subcodes from audio tracks or not 02466 @param opts The read opts to change 02467 @param subcodes_audio If non-zero, read subcodes from audio tracks on the disc. 02468 */ 02469 void burn_read_opts_read_subcodes_audio(struct burn_read_opts *opts, 02470 int subcodes_audio); 02471 02472 /** Sets whether to read subcodes from data tracks or not 02473 @param opts The read opts to change 02474 @param subcodes_data If non-zero, read subcodes from data tracks on the disc. 02475 */ 02476 void burn_read_opts_read_subcodes_data(struct burn_read_opts *opts, 02477 int subcodes_data); 02478 02479 /** Sets whether to recover errors if possible 02480 @param opts The read opts to change 02481 @param hardware_error_recovery If non-zero, attempt to recover errors if possible. 02482 */ 02483 void burn_read_opts_set_hardware_error_recovery(struct burn_read_opts *opts, 02484 int hardware_error_recovery); 02485 02486 /** Sets whether to report recovered errors or not 02487 @param opts The read opts to change 02488 @param report_recovered_errors If non-zero, recovered errors will be reported. 02489 */ 02490 void burn_read_opts_report_recovered_errors(struct burn_read_opts *opts, 02491 int report_recovered_errors); 02492 02493 /** Sets whether blocks with unrecoverable errors should be read or not 02494 @param opts The read opts to change 02495 @param transfer_damaged_blocks If non-zero, blocks with unrecoverable errors will still be read. 02496 */ 02497 void burn_read_opts_transfer_damaged_blocks(struct burn_read_opts *opts, 02498 int transfer_damaged_blocks); 02499 02500 /** Sets the number of retries to attempt when trying to correct an error 02501 @param opts The read opts to change 02502 @param hardware_error_retries The number of retries to attempt when correcting an error. 02503 */ 02504 void burn_read_opts_set_hardware_error_retries(struct burn_read_opts *opts, 02505 unsigned char hardware_error_retries); 02506 02507 02508 /* ts A90815 */ 02509 /** Gets the list of profile codes supported by the drive. 02510 Profiles depict the feature sets which constitute media types. For 02511 known profile codes and names see burn_disc_get_profile(). 02512 @param d is the drive to query 02513 @param num_profiles returns the number of supported profiles 02514 @param profiles returns the profile codes 02515 @param is_current returns the status of the corresponding profile code: 02516 1= current, i.e. the matching media is loaded 02517 0= not current, i.e. the matching media is not loaded 02518 @return always 1 for now 02519 @since 0.7.0 02520 */ 02521 int burn_drive_get_all_profiles(struct burn_drive *d, int *num_profiles, 02522 int profiles[64], char is_current[64]); 02523 02524 02525 /* ts A90815 */ 02526 /** Obtains the profile name associated with a profile code. 02527 @param profile_code the profile code to be translated 02528 @param name returns the profile name (e.g. "DVD+RW") 02529 @return 1= known profile code , 0= unknown profile code 02530 @since 0.7.0 02531 */ 02532 int burn_obtain_profile_name(int profile_code, char name[80]); 02533 02534 02535 /** Gets the maximum write speed for a drive and eventually loaded media. 02536 The return value might change by the media type of already loaded media, 02537 again by call burn_drive_grab() and again by call burn_disc_read_atip(). 02538 @param d Drive to query 02539 @return Maximum write speed in K/s 02540 */ 02541 int burn_drive_get_write_speed(struct burn_drive *d); 02542 02543 02544 /* ts A61021 */ 02545 /** Gets the minimum write speed for a drive and eventually loaded media. 02546 The return value might change by the media type of already loaded media, 02547 again by call burn_drive_grab() and again by call burn_disc_read_atip(). 02548 @param d Drive to query 02549 @return Minimum write speed in K/s 02550 @since 0.2.6 02551 */ 02552 int burn_drive_get_min_write_speed(struct burn_drive *d); 02553 02554 02555 /** Gets the maximum read speed for a drive 02556 @param d Drive to query 02557 @return Maximum read speed in K/s 02558 */ 02559 int burn_drive_get_read_speed(struct burn_drive *d); 02560 02561 02562 /* ts A61226 */ 02563 /** Obtain a copy of the current speed descriptor list. The drive's list gets 02564 updated on various occasions such as burn_drive_grab() but the copy 02565 obtained here stays untouched. It has to be disposed via 02566 burn_drive_free_speedlist() when it is not longer needed. Speeds 02567 may appear several times in the list. The list content depends much on 02568 drive and media type. It seems that .source == 1 applies mostly to CD media 02569 whereas .source == 2 applies to any media. 02570 @param d Drive to query 02571 @param speed_list The copy. If empty, *speed_list gets returned as NULL. 02572 @return 1=success , 0=list empty , <0 severe error 02573 @since 0.3.0 02574 */ 02575 int burn_drive_get_speedlist(struct burn_drive *d, 02576 struct burn_speed_descriptor **speed_list); 02577 02578 /* ts A70713 */ 02579 /** Look up the fastest speed descriptor which is not faster than the given 02580 speed_goal. If it is 0, then the fastest one is chosen among the 02581 descriptors with the highest end_lba. If it is -1 then the slowest speed 02582 descriptor is chosen regardless of end_lba. Parameter flag decides whether 02583 the speed goal means write speed or read speed. 02584 @param d Drive to query 02585 @param speed_goal Upper limit for speed, 02586 0=search for maximum speed , -1 search for minimum speed 02587 @param best_descr Result of the search, NULL if no match 02588 @param flag Bitfield for control purposes 02589 bit0= look for best read speed rather than write speed 02590 bit1= look for any source type (else look for source==2 first 02591 and for any other source type only with CD media) 02592 @return >0 indicates a valid best_descr, 0 = no valid best_descr 02593 @since 0.3.8 02594 */ 02595 int burn_drive_get_best_speed(struct burn_drive *d, int speed_goal, 02596 struct burn_speed_descriptor **best_descr, int flag); 02597 02598 02599 /* ts A61226 */ 02600 /** Dispose a speed descriptor list copy which was obtained by 02601 burn_drive_get_speedlist(). 02602 @param speed_list The list copy. *speed_list gets set to NULL. 02603 @return 1=list disposed , 0= *speedlist was already NULL 02604 @since 0.3.0 02605 */ 02606 int burn_drive_free_speedlist(struct burn_speed_descriptor **speed_list); 02607 02608 02609 /* ts A70203 */ 02610 /* @since 0.3.2 */ 02611 /** The reply structure for burn_disc_get_multi_caps() 02612 */ 02613 struct burn_multi_caps { 02614 02615 /* Multi-session capability allows to keep the media appendable after 02616 writing a session. It also guarantees that the drive will be able 02617 to predict and use the appropriate Next Writeable Address to place 02618 the next session on the media without overwriting the existing ones. 02619 It does not guarantee that the selected write type is able to do 02620 an appending session after the next session. (E.g. CD SAO is capable 02621 of multi-session by keeping a disc appendable. But .might_do_sao 02622 will be 0 afterwards, when checking the appendable media.) 02623 1= media may be kept appendable by burn_write_opts_set_multi(o,1) 02624 0= media will not be appendable 02625 */ 02626 int multi_session; 02627 02628 /* Multi-track capability allows to write more than one track source 02629 during a single session. The written tracks can later be found in 02630 libburn's TOC model with their start addresses and sizes. 02631 1= multiple tracks per session are allowed 02632 0= only one track per session allowed 02633 */ 02634 int multi_track; 02635 02636 /* Start-address capability allows to set a non-zero address with 02637 burn_write_opts_set_start_byte(). Eventually this has to respect 02638 .start_alignment and .start_range_low, .start_range_high in this 02639 structure. 02640 1= non-zero start address is allowed 02641 0= only start address 0 is allowed (to depict the drive's own idea 02642 about the appropriate write start) 02643 */ 02644 int start_adr; 02645 02646 /** The alignment for start addresses. 02647 ( start_address % start_alignment ) must be 0. 02648 */ 02649 off_t start_alignment; 02650 02651 /** The lowest permissible start address. 02652 */ 02653 off_t start_range_low; 02654 02655 /** The highest addressable start address. 02656 */ 02657 off_t start_range_high; 02658 02659 /** Potential availability of write modes 02660 4= needs no size prediction, not to be chosen automatically 02661 3= needs size prediction, not to be chosen automatically 02662 2= available, no size prediction necessary 02663 1= available, needs exact size prediction 02664 0= not available 02665 With CD media (profiles 0x09 and 0x0a) check also the elements 02666 *_block_types of the according write mode. 02667 */ 02668 int might_do_tao; 02669 int might_do_sao; 02670 int might_do_raw; 02671 02672 /** Generally advised write mode. 02673 Not necessarily the one chosen by burn_write_opts_auto_write_type() 02674 because the burn_disc structure might impose particular demands. 02675 */ 02676 enum burn_write_types advised_write_mode; 02677 02678 /** Write mode as given by parameter wt of burn_disc_get_multi_caps(). 02679 */ 02680 enum burn_write_types selected_write_mode; 02681 02682 /** Profile number which was current when the reply was generated */ 02683 int current_profile; 02684 02685 /** Wether the current profile indicates CD media. 1=yes, 0=no */ 02686 int current_is_cd_profile; 02687 02688 /* ts A70528 */ 02689 /* @since 0.3.8 */ 02690 /** Wether the current profile is able to perform simulated write */ 02691 int might_simulate; 02692 }; 02693 02694 /** Allocates a struct burn_multi_caps (see above) and fills it with values 02695 which are appropriate for the drive and the loaded media. The drive 02696 must be grabbed for this call. The returned structure has to be disposed 02697 via burn_disc_free_multi_caps() when no longer needed. 02698 @param d The drive to inquire 02699 @param wt With BURN_WRITE_NONE the best capabilities of all write modes 02700 get returned. If set to a write mode like BURN_WRITE_SAO the 02701 capabilities with that particular mode are returned and the 02702 return value is 0 if the desired mode is not possible. 02703 @param caps returns the info structure 02704 @param flag Bitfield for control purposes (unused yet, submit 0) 02705 @return < 0 : error , 0 : writing seems impossible , 1 : writing possible 02706 @since 0.3.2 02707 */ 02708 int burn_disc_get_multi_caps(struct burn_drive *d, enum burn_write_types wt, 02709 struct burn_multi_caps **caps, int flag); 02710 02711 /** Removes from memory a multi session info structure which was returned by 02712 burn_disc_get_multi_caps(). The pointer *caps gets set to NULL. 02713 @param caps the info structure to dispose (note: pointer to pointer) 02714 @return 0 : *caps was already NULL, 1 : memory object was disposed 02715 @since 0.3.2 02716 */ 02717 int burn_disc_free_multi_caps(struct burn_multi_caps **caps); 02718 02719 02720 /** Gets a copy of the toc_entry structure associated with a track 02721 @param t Track to get the entry from 02722 @param entry Struct for the library to fill out 02723 */ 02724 void burn_track_get_entry(struct burn_track *t, struct burn_toc_entry *entry); 02725 02726 /** Gets a copy of the toc_entry structure associated with a session's lead out 02727 @param s Session to get the entry from 02728 @param entry Struct for the library to fill out 02729 */ 02730 void burn_session_get_leadout_entry(struct burn_session *s, 02731 struct burn_toc_entry *entry); 02732 02733 /** Gets an array of all the sessions for the disc 02734 THIS IS NO LONGER VALID AFTER YOU ADD OR REMOVE A SESSION 02735 @param d Disc to get session array for 02736 @param num Returns the number of sessions in the array 02737 @return array of sessions 02738 */ 02739 struct burn_session **burn_disc_get_sessions(struct burn_disc *d, 02740 int *num); 02741 02742 int burn_disc_get_sectors(struct burn_disc *d); 02743 02744 /** Gets an array of all the tracks for a session 02745 THIS IS NO LONGER VALID AFTER YOU ADD OR REMOVE A TRACK 02746 @param s session to get track array for 02747 @param num Returns the number of tracks in the array 02748 @return array of tracks 02749 */ 02750 struct burn_track **burn_session_get_tracks(struct burn_session *s, 02751 int *num); 02752 02753 int burn_session_get_sectors(struct burn_session *s); 02754 02755 /** Gets the mode of a track 02756 @param track the track to query 02757 @return the track's mode 02758 */ 02759 int burn_track_get_mode(struct burn_track *track); 02760 02761 /** Returns whether the first track of a session is hidden in the pregap 02762 @param session the session to query 02763 @return non-zero means the first track is hidden 02764 */ 02765 int burn_session_get_hidefirst(struct burn_session *session); 02766 02767 /** Returns the library's version in its parts. 02768 This is the runtime counterpart of the three build time macros 02769 burn_header_version_* below. 02770 @param major The major version number 02771 @param minor The minor version number 02772 @param micro The micro version number 02773 */ 02774 void burn_version(int *major, int *minor, int *micro); 02775 02776 02777 /* ts A80129 */ 02778 /* @since 0.4.4 */ 02779 /** These three release version numbers tell the revision of this header file 02780 and of the API it describes. They are memorized by applications at build 02781 time. 02782 Immediately after burn_initialize() an application should do this check: 02783 burn_version(&major, &minor, µ); 02784 if(major > burn_header_version_major 02785 || (major == burn_header_version_major 02786 && (minor > burn_header_version_minor 02787 || (minor == burn_header_version_minor 02788 && micro >= burn_header_version_micro)))) { 02789 ... Young enough. Go on with program run .... 02790 } else { 02791 ... Too old. Do not use this libburn version ... 02792 } 02793 02794 */ 02795 #define burn_header_version_major 1 02796 #define burn_header_version_minor 1 02797 #define burn_header_version_micro 6 02798 /** Note: 02799 Above version numbers are also recorded in configure.ac because libtool 02800 wants them as parameters at build time. 02801 For the library compatibility check, BURN_*_VERSION in configure.ac 02802 are not decisive. Only the three numbers above do matter. 02803 */ 02804 /** Usage discussion: 02805 02806 Some developers of the libburnia project have differing 02807 opinions how to ensure the compatibility of libaries 02808 and applications. 02809 02810 It is about whether to use at compile time and at runtime 02811 the version numbers isoburn_header_version_* provided here. 02812 Thomas Schmitt advises to use them. 02813 Vreixo Formoso advises to use other means. 02814 02815 At compile time: 02816 02817 Vreixo Formoso advises to leave proper version matching 02818 to properly programmed checks in the the application's 02819 build system, which will eventually refuse compilation. 02820 02821 Thomas Schmitt advises to use the macros defined here 02822 for comparison with the application's requirements of 02823 library revisions and to eventually break compilation. 02824 02825 Both advises are combinable. I.e. be master of your 02826 build system and have #if checks in the source code 02827 of your application, nevertheless. 02828 02829 At runtime (via *_is_compatible()): 02830 02831 Vreixo Formoso advises to compare the application's 02832 requirements of library revisions with the runtime 02833 library. This is to allow runtime libraries which are 02834 young enough for the application but too old for 02835 the lib*.h files seen at compile time. 02836 02837 Thomas Schmitt advises to compare the header 02838 revisions defined here with the runtime library. 02839 This is to enforce a strictly monotonous chain 02840 of revisions from app to header to library, 02841 at the cost of excluding some older libraries. 02842 02843 These two advises are mutually exclusive. 02844 02845 */ 02846 02847 /* ts A91226 */ 02848 /** Obtain the id string of the SCSI transport interface. 02849 This interface may be a system specific adapter module of libburn or 02850 an adapter to a supporting library like libcdio. 02851 @param flag Bitfield for control puposes, submit 0 for now 02852 @return A pointer to the id string. Do not alter the string content. 02853 @since 0.7.6 02854 */ 02855 char *burn_scsi_transport_id(int flag); 02856 02857 /* ts A60924 : ticket 74 */ 02858 /** Control queueing and stderr printing of messages from libburn. 02859 Severity may be one of "NEVER", "ABORT", "FATAL", "FAILURE", "SORRY", 02860 "WARNING", "HINT", "NOTE", "UPDATE", "DEBUG", "ALL". 02861 @param queue_severity Gives the minimum limit for messages to be queued. 02862 Default: "NEVER". If you queue messages then you 02863 must consume them by burn_msgs_obtain(). 02864 @param print_severity Does the same for messages to be printed directly 02865 to stderr. Default: "FATAL". 02866 @param print_id A text prefix to be printed before the message. 02867 @return >0 for success, <=0 for error 02868 @since 0.2.6 02869 */ 02870 int burn_msgs_set_severities(char *queue_severity, 02871 char *print_severity, char *print_id); 02872 02873 /* ts A60924 : ticket 74 */ 02874 /* @since 0.2.6 */ 02875 #define BURN_MSGS_MESSAGE_LEN 4096 02876 02877 /** Obtain the oldest pending libburn message from the queue which has at 02878 least the given minimum_severity. This message and any older message of 02879 lower severity will get discarded from the queue and is then lost forever. 02880 @param minimum_severity may be one of "NEVER", "ABORT", "FATAL", 02881 "FAILURE", "SORRY", "WARNING", "HINT", "NOTE", "UPDATE", 02882 "DEBUG", "ALL". 02883 To call with minimum_severity "NEVER" will discard the 02884 whole queue. 02885 @param error_code Will become a unique error code as listed in 02886 libburn/libdax_msgs.h 02887 @param msg_text Must provide at least BURN_MSGS_MESSAGE_LEN bytes. 02888 @param os_errno Will become the eventual errno related to the message 02889 @param severity Will become the severity related to the message and 02890 should provide at least 80 bytes. 02891 @return 1 if a matching item was found, 0 if not, <0 for severe errors 02892 @since 0.2.6 02893 */ 02894 int burn_msgs_obtain(char *minimum_severity, 02895 int *error_code, char msg_text[], int *os_errno, 02896 char severity[]); 02897 02898 02899 /* ts A70922 */ 02900 /** Submit a message to the libburn queueing system. It will be queued or 02901 printed as if it was generated by libburn itself. 02902 @param error_code The unique error code of your message. 02903 Submit 0 if you do not have reserved error codes within 02904 the libburnia project. 02905 @param msg_text Not more than BURN_MSGS_MESSAGE_LEN characters of 02906 message text. 02907 @param os_errno Eventual errno related to the message. Submit 0 if 02908 the message is not related to a operating system error. 02909 @param severity One of "ABORT", "FATAL", "FAILURE", "SORRY", "WARNING", 02910 "HINT", "NOTE", "UPDATE", "DEBUG". Defaults to "FATAL". 02911 @param d An eventual drive to which the message shall be related. 02912 Submit NULL if the message is not specific to a 02913 particular drive object. 02914 @return 1 if message was delivered, <=0 if failure 02915 @since 0.4.0 02916 */ 02917 int burn_msgs_submit(int error_code, char msg_text[], int os_errno, 02918 char severity[], struct burn_drive *d); 02919 02920 02921 /* ts A71016 */ 02922 /** Convert a severity name into a severity number, which gives the severity 02923 rank of the name. 02924 @param severity_name A name as with burn_msgs_submit(), e.g. "SORRY". 02925 @param severity_number The rank number: the higher, the more severe. 02926 @param flag Bitfield for control purposes (unused yet, submit 0) 02927 @return >0 success, <=0 failure 02928 @since 0.4.0 02929 */ 02930 int burn_text_to_sev(char *severity_name, int *severity_number, int flag); 02931 02932 02933 /* ts A80202 */ 02934 /** Convert a severity number into a severity name 02935 @since 0.4.4 02936 @param severity_number The rank number: the higher, the more severe. 02937 @param severity_name A name as with burn_msgs_submit(), e.g. "SORRY". 02938 @param flag Bitfield for control purposes (unused yet, submit 0) 02939 @since 0.4.4 02940 */ 02941 int burn_sev_to_text(int severity_number, char **severity_name, int flag); 02942 02943 02944 02945 /* ts A70915 */ 02946 /** Replace the messenger object handle of libburn by a compatible handle 02947 obtained from a related library. 02948 See also: libisofs, API function iso_get_messenger(). 02949 @param messenger The foreign but compatible message handle. 02950 @return 1 : success, <=0 : failure 02951 @since 0.4.0 02952 */ 02953 int burn_set_messenger(void *messenger); 02954 02955 02956 /* ts A61002 */ 02957 /* @since 0.2.6 */ 02958 /** The prototype of a handler function suitable for burn_set_signal_handling() 02959 Such a function has to return -2 if it does not want the process to 02960 exit with value 1. 02961 */ 02962 typedef int (*burn_abort_handler_t)(void *handle, int signum, int flag); 02963 02964 /** Control built-in signal handling. Either by setting an own handler or 02965 by activating the built-in signal handler. 02966 02967 A function parameter handle of NULL activates the built-in abort handler. 02968 Depending on mode it may cancel all drive operations, wait for all drives 02969 to become idle, exit(1). It may also prepare function 02970 burn_drive_get_status() for waiting and performing exit(1). 02971 If parameter handle may be NULL or a text that shall be used as prefix for 02972 pacifier messages of burn_abort_pacifier(). Other than with an application 02973 provided handler, the prefix char array does not have to be kept existing 02974 until the eventual signal event. 02975 Before version 0.7.8 only action 0 was available. I.e. the built-in handler 02976 waited for the drives to become idle and then performed exit(1) directly. 02977 But during burn_disc_write() onto real CD or DVD, FreeBSD 8.0 pauses the 02978 other threads until the signal handler returns. 02979 The new actions try to avoid this deadlock. It is advised to use action 3 02980 at least during burn_disc_write(), burn_disc_erase(), burn_disc_format(): 02981 burn_set_signal_handling(text, NULL, 0x30); 02982 and to call burn_is_aborting(0) when the drive is BURN_DRIVE_IDLE. 02983 If burn_is_aborting(0) returns 1, then call burn_abort() and exit(1). 02984 02985 @param handle Opaque handle eventually pointing to an application 02986 provided memory object 02987 @param handler A function to be called on signals. It will get handle as 02988 argument. flag will be 0. 02989 It should finally call burn_abort(). See there. 02990 @param mode : bit0 - bit3: 02991 Receiving signals: 02992 0 Call handler(handle, signum, 0) on nearly all signals 02993 1 Enable system default reaction on all signals 02994 2 Try to ignore nearly all signals 02995 10 like mode 2 but handle SIGABRT like with mode 0 02996 bit4 - bit7: With handler == NULL : 02997 Action of built-in handler. "control thread" is the one 02998 which called burn_set_signal_handling(). 02999 All actions activate receive mode 2 to ignore further 03000 signals. 03001 0 Same as 1 (for pre-0.7.8 backward compatibility) 03002 @since 0.7.8 03003 1 Catch the control thread in abort handler, call 03004 burn_abort(>0) and finally exit(1). 03005 Does not always work with FreeBSD. 03006 2 Call burn_abort(-1) and return from handler. When the 03007 control thread calls burn_drive_get_status(), then do 03008 burn_abort(>0) instead, and finally exit(1). 03009 Does not always work with FreeBSD. 03010 3 Call burn_abort(-1), return from handler. It is duty of 03011 the application to detect a pending abort condition 03012 by calling burn_is_aborting() and to wait for all 03013 drives to become idle. E.g. by calling burn_abort(>0). 03014 4 Like 3, but without calling burn_abort(-1). Only the 03015 indicator of burn_is_aborting() gets set. 03016 @since 0.2.6 03017 */ 03018 void burn_set_signal_handling(void *handle, burn_abort_handler_t handler, 03019 int mode); 03020 03021 03022 /* ts B00304 */ 03023 /* Inquire whether the built-in abort handler was triggered by a signal. 03024 This has to be done to detect pending abort handling if signal handling 03025 was set to the built-in handler and action was set to 2 or 3. 03026 @param flag Bitfield for control purposes (unused yet, submit 0) 03027 @return 0 = no abort was triggered 03028 >0 = action that was triggered (action 0 is reported as 1) 03029 @since 0.7.8 03030 */ 03031 int burn_is_aborting(int flag); 03032 03033 03034 /* ts A70811 */ 03035 /** Write data in random access mode. 03036 The drive must be grabbed successfully before calling this function which 03037 circumvents usual libburn session processing and rather writes data without 03038 preparations or finalizing. This will work only with overwriteable media 03039 which are also suitable for burn_write_opts_set_start_byte(). The same 03040 address alignment restrictions as with this function apply. I.e. for DVD 03041 it is best to align to 32 KiB blocks (= 16 LBA units). The amount of data 03042 to be written is subject to the same media dependent alignment rules. 03043 Again, 32 KiB is most safe. 03044 Call burn_disc_get_multi_caps() can obtain the necessary media info. See 03045 resulting struct burn_multi_caps elements .start_adr , .start_alignment , 03046 .start_range_low , .start_range_high . 03047 Other than burn_disc_write() this is a synchronous call which returns 03048 only after the write transaction has ended (sucessfully or not). So it is 03049 wise not to transfer giant amounts of data in a single call. 03050 Important: Data have to fit into the already formatted area of the media. 03051 @param d The drive to which to write 03052 @param byte_address The start address of the write in byte 03053 (1 LBA unit = 2048 bytes) (do respect media alignment) 03054 @param data The bytes to be written 03055 @param data_count The number of those bytes (do respect media alignment) 03056 data_count == 0 is permitted (e.g. to flush the 03057 drive buffer without further data transfer). 03058 @param flag Bitfield for control purposes: 03059 bit0 = flush the drive buffer after eventual writing 03060 @return 1=sucessful , <=0 : number of transfered bytes * -1 03061 @since 0.4.0 03062 */ 03063 int burn_random_access_write(struct burn_drive *d, off_t byte_address, 03064 char *data, off_t data_count, int flag); 03065 03066 03067 /* ts A81215 */ 03068 /** Inquire the maximum amount of readable data. 03069 It is supposed that all LBAs in the range from 0 to media_read_acpacity-1 03070 can be read via burn_read_data() although some of them may never have been 03071 recorded. If tracks are recognizable then it is better to only read 03072 LBAs which are part of some track. 03073 If the drive is actually a large file or block device, then the capacity 03074 is curbed to a maximum of 0x7ffffff0 blocks = 4 TB - 32 KB. 03075 @param d The drive from which to read 03076 @param capacity Will return the result if valid 03077 @param flag Bitfield for control purposes: Unused yet, submit 0. 03078 @return 1=sucessful , <=0 an error occured 03079 @since 0.6.0 03080 */ 03081 int burn_get_read_capacity(struct burn_drive *d, int *capacity, int flag); 03082 03083 03084 /* ts A70812 */ 03085 /** Read data in random access mode. 03086 The drive must be grabbed successfully before calling this function. 03087 With all currently supported drives and media the byte_address has to 03088 be aligned to 2048 bytes. Only data tracks with 2048 bytes per sector 03089 can be read this way. I.e. not CD-audio, not CD-video-stream ... 03090 This is a synchronous call which returns only after the full read job 03091 has ended (sucessfully or not). So it is wise not to read giant amounts 03092 of data in a single call. 03093 @param d The drive from which to read 03094 @param byte_address The start address of the read in byte (aligned to 2048) 03095 @param data A memory buffer capable of taking data_size bytes 03096 @param data_size The amount of data to be read. This does not have to 03097 be aligned to any block size. 03098 @param data_count The amount of data actually read (interesting on error) 03099 @param flag Bitfield for control purposes: 03100 bit0= - reserved - 03101 bit1= do not submit error message if read error 03102 bit2= on error do not try to read a second time 03103 with single block steps. 03104 @since 0.5.2 03105 bit3= return -2 on permission denied error rather than 03106 issueing a warning message. 03107 @since 1.0.6 03108 @return 1=sucessful , <=0 an error occured 03109 with bit3: -2= permission denied error 03110 @since 0.4.0 03111 */ 03112 int burn_read_data(struct burn_drive *d, off_t byte_address, 03113 char data[], off_t data_size, off_t *data_count, int flag); 03114 03115 03116 /* ts A70904 */ 03117 /** Inquire whether the drive object is a real MMC drive or a pseudo-drive 03118 created by a stdio: address. 03119 @param d The drive to inquire 03120 @return 0= null-drive 03121 1= real MMC drive 03122 2= stdio-drive, random access, read-write 03123 3= stdio-drive, sequential, write-only 03124 4= stdio-drive, random access, read-only 03125 (only if enabled by burn_allow_drive_role_4()) 03126 5= stdio-drive, random access, write-only 03127 (only if enabled by burn_allow_drive_role_4()) 03128 @since 0.4.0 03129 */ 03130 int burn_drive_get_drive_role(struct burn_drive *d); 03131 03132 03133 /* ts B10312 */ 03134 /** Allow drive role 4 "random access read-only" 03135 and drive role 5 "random access write-only". 03136 By default a random access file assumes drive role 2 "read-write" 03137 regardless whether it is actually readable or writeable. 03138 If enabled, random-access file objects which recognizably allow no 03139 writing will be classified as role 4 and those which allow no reading 03140 will get role 5. 03141 Candidates are drive addresses of the form stdio:/dev/fd/# , where # is 03142 the integer number of an open file descriptor. If this descriptor was 03143 opened read-only resp. write-only, then it gets role 4 resp. role 5. 03144 Other paths may get tested by an attempt to open them for read-write 03145 (role 2) resp. read-only (role 4) resp. write-only (role 5). See bit1. 03146 @param allowed Bitfield for control purposes: 03147 bit0= Enable roles 4 and 5 for drives which get 03148 aquired after this call 03149 bit1= with bit0: 03150 Test whether the file can be opened for 03151 read-write resp. read-only resp. write-only. 03152 Classify as roles 2 resp. 4 resp. 5. 03153 bit2= with bit0 and bit1: 03154 Classify files which cannot be opened at all 03155 as role 0 : useless dummy. 03156 Else classify as role 2. 03157 bit3= Classify non-empty role 5 drives as 03158 BURN_DISC_APPENDABLE with Next Writeable Address 03159 after the end of the file. It is nevertheless 03160 possible to change this address by call 03161 burn_write_opts_set_start_byte(). 03162 @since 1.0.6 03163 */ 03164 void burn_allow_drive_role_4(int allowed); 03165 03166 03167 /* ts A70923 */ 03168 /** Find out whether a given address string would lead to the given drive 03169 object. This should be done in advance for track source addresses 03170 with parameter drive_role set to 2. 03171 Although a real MMC drive should hardly exist as two drive objects at 03172 the same time, this can easily happen with stdio-drives. So if more than 03173 one drive is used by the application, then this gesture is advised: 03174 burn_drive_d_get_adr(d2, adr2); 03175 if (burn_drive_equals_adr(d1, adr2, burn_drive_get_drive_role(d2))) 03176 ... Both drive objects point to the same storage facility ... 03177 03178 @param d1 Existing drive object 03179 @param adr2 Address string to be tested. Prefix "stdio:" overrides 03180 parameter drive_role2 by either 0 or 2 as appropriate. 03181 The string must be shorter than BURN_DRIVE_ADR_LEN. 03182 @param drive_role2 Role as burn_drive_get_drive_role() would attribute 03183 to adr2 if it was a drive. Use value 2 for checking track 03184 sources resp. pseudo-drive addresses without "stdio:". 03185 Use 1 for checking drive addresses including those with 03186 prefix "stdio:". 03187 @return 1= adr2 leads to d1 , 0= adr2 seems not to lead to d1, 03188 -1 = adr2 is bad 03189 @since 0.4.0 03190 */ 03191 int burn_drive_equals_adr(struct burn_drive *d1, char *adr2, int drive_role2); 03192 03193 03194 03195 /* 03196 Audio track data extraction facility. 03197 */ 03198 03199 /* Maximum size for address paths and fmt_info strings */ 03200 #define LIBDAX_AUDIOXTR_STRLEN 4096 03201 03202 03203 /** Extractor object encapsulating intermediate states of extraction. 03204 The clients of libdax_audioxtr shall only allocate pointers to this 03205 struct and get a storage object via libdax_audioxtr_new(). 03206 Appropriate initial value for the pointer is NULL. 03207 */ 03208 struct libdax_audioxtr; 03209 03210 03211 /** Open an audio file, check wether suitable, create extractor object. 03212 @param xtr Opaque handle to extractor. Gets attached extractor object. 03213 @param path Address of the audio file to extract. "-" is stdin (but might 03214 be not suitable for all futurely supported formats). 03215 @param flag Bitfield for control purposes (unused yet, submit 0) 03216 @return >0 success 03217 0 unsuitable format 03218 -1 severe error 03219 -2 path not found 03220 @since 0.2.4 03221 */ 03222 int libdax_audioxtr_new(struct libdax_audioxtr **xtr, char *path, int flag); 03223 03224 03225 /** Obtain identification parameters of opened audio source. 03226 @param xtr Opaque handle to extractor 03227 @param fmt Gets pointed to the audio file format id text: ".wav" , ".au" 03228 @param fmt_info Gets pointed to a format info text telling parameters 03229 @param num_channels e.g. 1=mono, 2=stereo, etc 03230 @param sample_rate e.g. 11025, 44100 03231 @param bits_per_sample e.g. 8= 8 bits per sample, 16= 16 bits ... 03232 @param msb_first Byte order of samples: 0=Intel 1=Motorola 03233 @param flag Bitfield for control purposes (unused yet, submit 0) 03234 @return >0 success, <=0 failure 03235 @since 0.2.4 03236 */ 03237 int libdax_audioxtr_get_id(struct libdax_audioxtr *xtr, 03238 char **fmt, char **fmt_info, 03239 int *num_channels, int *sample_rate, 03240 int *bits_per_sample, int *msb_first, int flag); 03241 03242 03243 /** Obtain a prediction about the extracted size based on internal information 03244 of the formatted file. 03245 @param xtr Opaque handle to extractor 03246 @param size Gets filled with the predicted size 03247 @param flag Bitfield for control purposes (unused yet, submit 0) 03248 @return 1 prediction was possible , 0 no prediction could be made 03249 @since 0.2.4 03250 */ 03251 int libdax_audioxtr_get_size(struct libdax_audioxtr *o, off_t *size, int flag); 03252 03253 03254 /** Obtain next buffer full of extracted data in desired format (only raw audio 03255 for now). 03256 @param xtr Opaque handle to extractor 03257 @param buffer Gets filled with extracted data 03258 @param buffer_size Maximum number of bytes to be filled into buffer 03259 @param flag Bitfield for control purposes 03260 bit0= do not stop at predicted end of data 03261 @return >0 number of valid buffer bytes, 03262 0 End of file 03263 -1 operating system reports error 03264 -2 usage error by application 03265 @since 0.2.4 03266 */ 03267 int libdax_audioxtr_read(struct libdax_audioxtr *xtr, 03268 char buffer[], int buffer_size, int flag); 03269 03270 03271 /** Try to obtain a file descriptor which will deliver extracted data 03272 to normal calls of read(2). This may fail because the format is 03273 unsuitable for that, but ".wav" is ok. If this call succeeds the xtr 03274 object will have forgotten its file descriptor and libdax_audioxtr_read() 03275 will return a usage error. One may use *fd after libdax_audioxtr_destroy() 03276 and will have to close it via close(2) when done with it. 03277 @param xtr Opaque handle to extractor 03278 @param fd Eventually returns the file descriptor number 03279 @param flag Bitfield for control purposes 03280 bit0= do not dup(2) and close(2) but hand out original fd 03281 @return 1 success, 0 cannot hand out fd , -1 severe error 03282 @since 0.2.4 03283 */ 03284 int libdax_audioxtr_detach_fd(struct libdax_audioxtr *o, int *fd, int flag); 03285 03286 03287 /** Clean up after extraction and destroy extractor object. 03288 @param xtr Opaque handle to extractor, *xtr is allowed to be NULL, 03289 *xtr is set to NULL by this function 03290 @param flag Bitfield for control purposes (unused yet, submit 0) 03291 @return 1 = destroyed object, 0 = was already destroyed 03292 @since 0.2.4 03293 */ 03294 int libdax_audioxtr_destroy(struct libdax_audioxtr **xtr, int flag); 03295 03296 03297 03298 #ifndef DOXYGEN 03299 03300 BURN_END_DECLS 03301 03302 #endif 03303 03304 03305 /* ts A91205 */ 03306 /* The following experiments may be interesting in future: 03307 */ 03308 03309 /* Perform OPC explicitely. 03310 # define Libburn_pioneer_dvr_216d_with_opC 1 03311 */ 03312 03313 /* Load mode page 5 and modify it rather than composing from scratch. 03314 # define Libburn_pioneer_dvr_216d_load_mode5 1 03315 */ 03316 03317 /* Inquire drive events and react by reading configuration or starting unit. 03318 # define Libburn_pioneer_dvr_216d_get_evenT 1 03319 */ 03320 03321 /* ts A91112 */ 03322 /* Do not probe CD modes but declare only data and audio modes supported. 03323 For other modes resp. real probing one has to call 03324 burn_drive_probe_cd_write_modes(). 03325 03326 */ 03327 #define Libburn_dummy_probe_write_modeS 1 03328 03329 03330 #endif /*LIBBURN_H*/