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 - 2013 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 /* ts B11230 */ 00125 /** Track mode modifier - Serial Copy Management System, SAO only 00126 If this is set and BURN_COPY is not set, then copying the emerging 00127 track will be forbidden. 00128 @since 1.2.0 00129 */ 00130 #define BURN_SCMS (1 << 13) 00131 00132 00133 /** Possible disc writing style/modes */ 00134 enum burn_write_types 00135 { 00136 /** Packet writing. 00137 currently unsupported, (for DVD Incremental Streaming use TAO) 00138 */ 00139 BURN_WRITE_PACKET, 00140 00141 /** With CD: Track At Once recording 00142 2s gaps between tracks, no fonky lead-ins 00143 00144 With sequential DVD-R[W]: Incremental Streaming 00145 With DVD+R and BD-R: Track of open size 00146 With DVD-RAM, DVD+RW, BD-RE: Random Writeable (used sequentially) 00147 With overwriteable DVD-RW: Rigid Restricted Overwrite 00148 */ 00149 BURN_WRITE_TAO, 00150 00151 /** With CD: Session At Once 00152 Block type MUST be BURN_BLOCK_SAO 00153 ts A70122: Currently not capable of mixing data and audio tracks. 00154 00155 With sequential DVD-R[W]: Disc-at-once, DAO 00156 Single session, single track, fixed size mandatory, (-dvd-compat) 00157 With other DVD or BD media: same as BURN_WRITE_TAO but may demand 00158 that track size is known in advance. 00159 */ 00160 BURN_WRITE_SAO, 00161 00162 /** With CD: Raw disc at once recording. 00163 all subcodes must be provided by lib or user 00164 only raw block types are supported 00165 With DVD and BD media: not supported. 00166 00167 ts A90901: This had been disabled because its implementation 00168 relied on code from cdrdao which is not understood 00169 currently. 00170 A burn run will abort with "FATAL" error message 00171 if this mode is attempted. 00172 @since 0.7.2 00173 ts A91016: Re-implemented according to ECMA-130 Annex A and B. 00174 Now understood, explained and not stemming from cdrdao. 00175 @since 0.7.4 00176 */ 00177 BURN_WRITE_RAW, 00178 00179 /** In replies this indicates that not any writing will work. 00180 As parameter for inquiries it indicates that no particular write 00181 mode shall is specified. 00182 Do not use for setting a write mode for burning. It will not work. 00183 */ 00184 BURN_WRITE_NONE 00185 }; 00186 00187 /** Data format to send to the drive */ 00188 enum burn_block_types 00189 { 00190 /** sync, headers, edc/ecc provided by lib/user */ 00191 BURN_BLOCK_RAW0 = 1, 00192 /** sync, headers, edc/ecc and p/q subs provided by lib/user */ 00193 BURN_BLOCK_RAW16 = 2, 00194 /** sync, headers, edc/ecc and packed p-w subs provided by lib/user */ 00195 BURN_BLOCK_RAW96P = 4, 00196 /** sync, headers, edc/ecc and raw p-w subs provided by lib/user */ 00197 BURN_BLOCK_RAW96R = 8, 00198 /** only 2048 bytes of user data provided by lib/user */ 00199 BURN_BLOCK_MODE1 = 256, 00200 /** 2336 bytes of user data provided by lib/user */ 00201 BURN_BLOCK_MODE2R = 512, 00202 /** 2048 bytes of user data provided by lib/user 00203 subheader provided in write parameters 00204 are we ever going to support this shit? I vote no. 00205 (supposed to be supported on all drives...) 00206 */ 00207 BURN_BLOCK_MODE2_PATHETIC = 1024, 00208 /** 2048 bytes of data + 8 byte subheader provided by lib/user 00209 hey, this is also dumb 00210 */ 00211 BURN_BLOCK_MODE2_LAME = 2048, 00212 /** 2324 bytes of data provided by lib/user 00213 subheader provided in write parameters 00214 no sir, I don't like it. 00215 */ 00216 BURN_BLOCK_MODE2_OBSCURE = 4096, 00217 /** 2332 bytes of data supplied by lib/user 00218 8 bytes sub header provided in write parameters 00219 this is the second least suck mode2, and is mandatory for 00220 all drives to support. 00221 */ 00222 BURN_BLOCK_MODE2_OK = 8192, 00223 /** SAO block sizes are based on cue sheet, so use this. */ 00224 BURN_BLOCK_SAO = 16384 00225 }; 00226 00227 /** Possible status of the drive in regard to the disc in it. */ 00228 enum burn_disc_status 00229 { 00230 /** The current status is not yet known */ 00231 BURN_DISC_UNREADY, 00232 00233 /** The drive holds a blank disc. It is ready for writing from scratch. 00234 Unused multi-session media: 00235 CD-R, CD-RW, DVD-R, DVD-RW, DVD+R, BD-R 00236 Blanked multi-session media (i.e. treated by burn_disc_erase()) 00237 CD-RW, DVD-RW 00238 Overwriteable media with or without valid data 00239 DVD-RAM, DVD+RW, formatted DVD-RW, BD-RE 00240 */ 00241 BURN_DISC_BLANK, 00242 00243 /** There is no disc at all in the drive */ 00244 BURN_DISC_EMPTY, 00245 00246 /** There is an incomplete disc in the drive. It is ready for appending 00247 another session. 00248 Written but not yet closed multi-session media 00249 CD-R, CD-RW, DVD-R, DVD-RW, DVD+R, BD-R 00250 */ 00251 BURN_DISC_APPENDABLE, 00252 00253 /** There is a disc with data on it in the drive. It is usable only for 00254 reading. 00255 Written and closed multi-session media 00256 CD-R, CD-RW, DVD-R, DVD-RW, DVD+R, BD-R 00257 Read-Only media 00258 CD-ROM, DVD-ROM, BD-ROM 00259 Note that many DVD-ROM drives report any written media 00260 as Read-Only media and not by their real media types. 00261 */ 00262 BURN_DISC_FULL, 00263 00264 /* ts A61007 */ 00265 /* @since 0.2.4 */ 00266 /** The drive was not grabbed when the status was inquired */ 00267 BURN_DISC_UNGRABBED, 00268 00269 /* ts A61020 */ 00270 /* @since 0.2.6 */ 00271 /** The media seems to be unsuitable for reading and for writing */ 00272 BURN_DISC_UNSUITABLE 00273 }; 00274 00275 00276 /** Possible data source return values */ 00277 enum burn_source_status 00278 { 00279 /** The source is ok */ 00280 BURN_SOURCE_OK, 00281 /** The source is at end of file */ 00282 BURN_SOURCE_EOF, 00283 /** The source is unusable */ 00284 BURN_SOURCE_FAILED 00285 }; 00286 00287 00288 /** Possible busy states for a drive */ 00289 enum burn_drive_status 00290 { 00291 /** The drive is not in an operation */ 00292 BURN_DRIVE_IDLE, 00293 /** The library is spawning the processes to handle a pending 00294 operation (A read/write/etc is about to start but hasn't quite 00295 yet) */ 00296 BURN_DRIVE_SPAWNING, 00297 /** The drive is reading data from a disc */ 00298 BURN_DRIVE_READING, 00299 /** The drive is writing data to a disc */ 00300 BURN_DRIVE_WRITING, 00301 /** The drive is writing Lead-In */ 00302 BURN_DRIVE_WRITING_LEADIN, 00303 /** The drive is writing Lead-Out */ 00304 BURN_DRIVE_WRITING_LEADOUT, 00305 /** The drive is erasing a disc */ 00306 BURN_DRIVE_ERASING, 00307 /** The drive is being grabbed */ 00308 BURN_DRIVE_GRABBING, 00309 00310 /* ts A61102 */ 00311 /* @since 0.2.6 */ 00312 /** The drive gets written zeroes before the track payload data */ 00313 BURN_DRIVE_WRITING_PREGAP, 00314 /** The drive is told to close a track (TAO only) */ 00315 BURN_DRIVE_CLOSING_TRACK, 00316 /** The drive is told to close a session (TAO only) */ 00317 BURN_DRIVE_CLOSING_SESSION, 00318 00319 /* ts A61223 */ 00320 /* @since 0.3.0 */ 00321 /** The drive is formatting media */ 00322 BURN_DRIVE_FORMATTING, 00323 00324 /* ts A70822 */ 00325 /* @since 0.4.0 */ 00326 /** The drive is busy in synchronous read (if you see this then it 00327 has been interrupted) */ 00328 BURN_DRIVE_READING_SYNC, 00329 /** The drive is busy in synchronous write (if you see this then it 00330 has been interrupted) */ 00331 BURN_DRIVE_WRITING_SYNC 00332 00333 }; 00334 00335 00336 /** Information about a track on a disc - this is from the q sub channel of the 00337 lead-in area of a disc. The documentation here is very terse. 00338 See a document such as mmc3 for proper information. 00339 00340 CAUTION : This structure is prone to future extension ! 00341 00342 Do not restrict your application to unsigned char with any counter like 00343 "session", "point", "pmin", ... 00344 Do not rely on the current size of a burn_toc_entry. 00345 00346 */ 00347 struct burn_toc_entry 00348 { 00349 /** Session the track is in */ 00350 unsigned char session; 00351 /** Type of data. for this struct to be valid, it must be 1 */ 00352 unsigned char adr; 00353 /** Type of data in the track */ 00354 unsigned char control; 00355 /** Zero. Always. Really. */ 00356 unsigned char tno; 00357 /** Track number or special information */ 00358 unsigned char point; 00359 unsigned char min; 00360 unsigned char sec; 00361 unsigned char frame; 00362 unsigned char zero; 00363 /** Track start time minutes for normal tracks */ 00364 unsigned char pmin; 00365 /** Track start time seconds for normal tracks */ 00366 unsigned char psec; 00367 /** Track start time frames for normal tracks */ 00368 unsigned char pframe; 00369 00370 /* Indicates whether extension data are valid and eventually override 00371 older elements in this structure: 00372 bit0= DVD extension is valid @since 0.3.2 00373 @since 0.5.2 : DVD extensions are made valid for CD too 00374 bit1= LRA extension is valid @since 0.7.2 00375 bit2= Track status bits extension is valid @since 1.2.8 00376 */ 00377 unsigned char extensions_valid; 00378 00379 /* ts A70201 : DVD extension. extensions_valid:bit0 00380 If invalid the members are guaranteed to be 0. */ 00381 /* @since 0.3.2 */ 00382 /* Tracks and session numbers are 16 bit. Here are the high bytes. */ 00383 unsigned char session_msb; 00384 unsigned char point_msb; 00385 /* pmin, psec, and pframe may be too small if DVD extension is valid */ 00386 int start_lba; 00387 /* min, sec, and frame may be too small if DVD extension is valid */ 00388 int track_blocks; 00389 00390 /* ts A90909 : LRA extension. extensions_valid:bit1 */ 00391 /* @since 0.7.2 */ 00392 /* MMC-5 6.27.3.18 : The Last Recorded Address is valid for DVD-R, 00393 DVD-R DL when LJRS = 00b, DVD-RW, HD DVD-R, and BD-R. 00394 This would mean profiles: 0x11, 0x15, 0x13, 0x14, 0x51, 0x41, 0x42 00395 */ 00396 int last_recorded_address; 00397 00398 /* ts B30112 : Track status bits extension. extensions_valid:bit2 */ 00399 /* @since 1.2.8 */ 00400 /* Names as of READ TRACK INFORMATION, MMC-5 6.27.3 : 00401 bit0 - bit3 = Track Mode 00402 bit4 = Copy 00403 bit5 = Damage 00404 bit6 - bit7 = LJRS 00405 bit8 - bit11 = Data Mode 00406 bit12 = FP 00407 bit13 = Packet/Inc 00408 bit14 = Blank 00409 bit15 = RT 00410 bit16 = NWA_V 00411 bit17 = LRA_V 00412 */ 00413 int track_status_bits; 00414 00415 }; 00416 00417 00418 /** Data source interface for tracks. 00419 This allows to use arbitrary program code as provider of track input data. 00420 00421 Objects compliant to this interface are either provided by the application 00422 or by API calls of libburn: burn_fd_source_new() , burn_file_source_new(), 00423 and burn_fifo_source_new(). 00424 00425 The API calls allow to use any file object as data source. Consider to feed 00426 an eventual custom data stream asynchronously into a pipe(2) and to let 00427 libburn handle the rest. 00428 In this case the following rule applies: 00429 Call burn_source_free() exactly once for every source obtained from 00430 libburn API. You MUST NOT otherwise use or manipulate its components. 00431 00432 In general, burn_source objects can be freed as soon as they are attached 00433 to track objects. The track objects will keep them alive and dispose them 00434 when they are no longer needed. With a fifo burn_source it makes sense to 00435 keep the own reference for inquiring its state while burning is in 00436 progress. 00437 00438 --- 00439 00440 The following description of burn_source applies only to application 00441 implemented burn_source objects. You need not to know it for API provided 00442 ones. 00443 00444 If you really implement an own passive data producer by this interface, 00445 then beware: it can do anything and it can spoil everything. 00446 00447 In this case the functions (*read), (*get_size), (*set_size), (*free_data) 00448 MUST be implemented by the application and attached to the object at 00449 creation time. 00450 Function (*read_sub) is allowed to be NULL or it MUST be implemented and 00451 attached. 00452 00453 burn_source.refcount MUST be handled properly: If not exactly as many 00454 references are freed as have been obtained, then either memory leaks or 00455 corrupted memory are the consequence. 00456 All objects which are referred to by *data must be kept existent until 00457 (*free_data) is called via burn_source_free() by the last referer. 00458 */ 00459 struct burn_source { 00460 00461 /** Reference count for the data source. MUST be 1 when a new source 00462 is created and thus the first reference is handed out. Increment 00463 it to take more references for yourself. Use burn_source_free() 00464 to destroy your references to it. */ 00465 int refcount; 00466 00467 00468 /** Read data from the source. Semantics like with read(2), but MUST 00469 either deliver the full buffer as defined by size or MUST deliver 00470 EOF (return 0) or failure (return -1) at this call or at the 00471 next following call. I.e. the only incomplete buffer may be the 00472 last one from that source. 00473 libburn will read a single sector by each call to (*read). 00474 The size of a sector depends on BURN_MODE_*. The known range is 00475 2048 to 2352. 00476 00477 If this call is reading from a pipe then it will learn 00478 about the end of data only when that pipe gets closed on the 00479 feeder side. So if the track size is not fixed or if the pipe 00480 delivers less than the predicted amount or if the size is not 00481 block aligned, then burning will halt until the input process 00482 closes the pipe. 00483 00484 IMPORTANT: 00485 If this function pointer is NULL, then the struct burn_source is of 00486 version >= 1 and the job of .(*read)() is done by .(*read_xt)(). 00487 See below, member .version. 00488 */ 00489 int (*read)(struct burn_source *, unsigned char *buffer, int size); 00490 00491 00492 /** Read subchannel data from the source (NULL if lib generated) 00493 WARNING: This is an obscure feature with CD raw write modes. 00494 Unless you checked the libburn code for correctness in that aspect 00495 you should not rely on raw writing with own subchannels. 00496 ADVICE: Set this pointer to NULL. 00497 */ 00498 int (*read_sub)(struct burn_source *, unsigned char *buffer, int size); 00499 00500 00501 /** Get the size of the source's data. Return 0 means unpredictable 00502 size. If application provided (*get_size) allows return 0, then 00503 the application MUST provide a fully functional (*set_size). 00504 */ 00505 off_t (*get_size)(struct burn_source *); 00506 00507 00508 /* ts A70125 : BROKE BINARY BACKWARD COMPATIBILITY AT libburn-0.3.1. */ 00509 /* @since 0.3.2 */ 00510 /** Program the reply of (*get_size) to a fixed value. It is advised 00511 to implement this by a attribute off_t fixed_size; in *data . 00512 The read() function does not have to take into respect this fake 00513 setting. It is rather a note of libburn to itself. Eventually 00514 necessary truncation or padding is done in libburn. Truncation 00515 is usually considered a misburn. Padding is considered ok. 00516 00517 libburn is supposed to work even if (*get_size) ignores the 00518 setting by (*set_size). But your application will not be able to 00519 enforce fixed track sizes by burn_track_set_size() and possibly 00520 even padding might be left out. 00521 */ 00522 int (*set_size)(struct burn_source *source, off_t size); 00523 00524 00525 /** Clean up the source specific data. This function will be called 00526 once by burn_source_free() when the last referer disposes the 00527 source. 00528 */ 00529 void (*free_data)(struct burn_source *); 00530 00531 00532 /** Next source, for when a source runs dry and padding is disabled 00533 WARNING: This is an obscure feature. Set to NULL at creation and 00534 from then on leave untouched and uninterpreted. 00535 */ 00536 struct burn_source *next; 00537 00538 00539 /** Source specific data. Here the various source classes express their 00540 specific properties and the instance objects store their individual 00541 management data. 00542 E.g. data could point to a struct like this: 00543 struct app_burn_source 00544 { 00545 struct my_app *app_handle; 00546 ... other individual source parameters ... 00547 off_t fixed_size; 00548 }; 00549 00550 Function (*free_data) has to be prepared to clean up and free 00551 the struct. 00552 */ 00553 void *data; 00554 00555 00556 /* ts A71222 : Supposed to be binary backwards compatible extension. */ 00557 /* @since 0.4.2 */ 00558 /** Valid only if above member .(*read)() is NULL. This indicates a 00559 version of struct burn_source younger than 0. 00560 From then on, member .version tells which further members exist 00561 in the memory layout of struct burn_source. libburn will only touch 00562 those announced extensions. 00563 00564 Versions: 00565 0 has .(*read)() != NULL, not even .version is present. 00566 1 has .version, .(*read_xt)(), .(*cancel)() 00567 */ 00568 int version; 00569 00570 /** This substitutes for (*read)() in versions above 0. */ 00571 int (*read_xt)(struct burn_source *, unsigned char *buffer, int size); 00572 00573 /** Informs the burn_source that the consumer of data prematurely 00574 ended reading. This call may or may not be issued by libburn 00575 before (*free_data)() is called. 00576 */ 00577 int (*cancel)(struct burn_source *source); 00578 }; 00579 00580 00581 /** Information on a drive in the system */ 00582 struct burn_drive_info 00583 { 00584 /** Name of the vendor of the drive */ 00585 char vendor[9]; 00586 /** Name of the drive */ 00587 char product[17]; 00588 /** Revision of the drive */ 00589 char revision[5]; 00590 00591 /** Invalid: Was: "Location of the drive in the filesystem." */ 00592 /** This string has no meaning any more. Once it stored the drive 00593 device file address. Now always use function burn_drive_d_get_adr() 00594 to inquire a device file address. ^^^^^ ALWAYS ^^^^^^^*/ 00595 char location[17]; 00596 00597 /** Can the drive read DVD-RAM discs */ 00598 unsigned int read_dvdram:1; 00599 /** Can the drive read DVD-R discs */ 00600 unsigned int read_dvdr:1; 00601 /** Can the drive read DVD-ROM discs */ 00602 unsigned int read_dvdrom:1; 00603 /** Can the drive read CD-R discs */ 00604 unsigned int read_cdr:1; 00605 /** Can the drive read CD-RW discs */ 00606 unsigned int read_cdrw:1; 00607 00608 /** Can the drive write DVD-RAM discs */ 00609 unsigned int write_dvdram:1; 00610 /** Can the drive write DVD-R discs */ 00611 unsigned int write_dvdr:1; 00612 /** Can the drive write CD-R discs */ 00613 unsigned int write_cdr:1; 00614 /** Can the drive write CD-RW discs */ 00615 unsigned int write_cdrw:1; 00616 00617 /** Can the drive simulate a write */ 00618 unsigned int write_simulate:1; 00619 00620 /** Can the drive report C2 errors */ 00621 unsigned int c2_errors:1; 00622 00623 /** The size of the drive's buffer (in kilobytes) */ 00624 int buffer_size; 00625 /** 00626 * The supported block types in tao mode. 00627 * They should be tested with the desired block type. 00628 * See also burn_block_types. 00629 */ 00630 int tao_block_types; 00631 /** 00632 * The supported block types in sao mode. 00633 * They should be tested with the desired block type. 00634 * See also burn_block_types. 00635 */ 00636 int sao_block_types; 00637 /** 00638 * The supported block types in raw mode. 00639 * They should be tested with the desired block type. 00640 * See also burn_block_types. 00641 */ 00642 int raw_block_types; 00643 /** 00644 * The supported block types in packet mode. 00645 * They should be tested with the desired block type. 00646 * See also burn_block_types. 00647 */ 00648 int packet_block_types; 00649 00650 /** The value by which this drive can be indexed when using functions 00651 in the library. This is the value to pass to all libbburn functions 00652 that operate on a drive. */ 00653 struct burn_drive *drive; 00654 }; 00655 00656 00657 /** Operation progress report. All values are 0 based indices. 00658 * */ 00659 struct burn_progress { 00660 /** The total number of sessions */ 00661 int sessions; 00662 /** Current session.*/ 00663 int session; 00664 /** The total number of tracks */ 00665 int tracks; 00666 /** Current track. */ 00667 int track; 00668 /** The total number of indices */ 00669 int indices; 00670 /** Curent index. */ 00671 int index; 00672 /** The starting logical block address */ 00673 int start_sector; 00674 /** On write: The number of sectors. 00675 On blank: 0x10000 as upper limit for relative progress steps */ 00676 int sectors; 00677 /** On write: The current sector being processed. 00678 On blank: Relative progress steps 0 to 0x10000 */ 00679 int sector; 00680 00681 /* ts A61023 */ 00682 /* @since 0.2.6 */ 00683 /** The capacity of the drive buffer */ 00684 unsigned buffer_capacity; 00685 /** The free space in the drive buffer (might be slightly outdated) */ 00686 unsigned buffer_available; 00687 00688 /* ts A61119 */ 00689 /* @since 0.2.6 */ 00690 /** The number of bytes sent to the drive buffer */ 00691 off_t buffered_bytes; 00692 /** The minimum number of bytes stored in buffer during write. 00693 (Caution: Before surely one buffer size of bytes was processed, 00694 this value is 0xffffffff.) 00695 */ 00696 unsigned buffer_min_fill; 00697 }; 00698 00699 00700 /* ts A61226 */ 00701 /* @since 0.3.0 */ 00702 /** Description of a speed capability as reported by the drive in conjunction 00703 with eventually loaded media. There can be more than one such object per 00704 drive. So they are chained via .next and .prev , where NULL marks the end 00705 of the chain. This list is set up by burn_drive_scan() and gets updated 00706 by burn_drive_grab(). 00707 A copy may be obtained by burn_drive_get_speedlist() and disposed by 00708 burn_drive_free_speedlist(). 00709 For technical background info see SCSI specs MMC and SPC: 00710 mode page 2Ah (from SPC 5Ah MODE SENSE) , mmc3r10g.pdf , 6.3.11 Table 364 00711 ACh GET PERFORMANCE, Type 03h , mmc5r03c.pdf , 6.8.5.3 Table 312 00712 */ 00713 struct burn_speed_descriptor { 00714 00715 /** Where this info comes from : 00716 0 = misc , 1 = mode page 2Ah , 2 = ACh GET PERFORMANCE */ 00717 int source; 00718 00719 /** The media type that was current at the time of report 00720 -2 = state unknown, -1 = no media was loaded , else see 00721 burn_disc_get_profile() */ 00722 int profile_loaded; 00723 char profile_name[80]; 00724 00725 /** The attributed capacity of appropriate media in logical block units 00726 i.e. 2352 raw bytes or 2048 data bytes. -1 = capacity unknown. */ 00727 int end_lba; 00728 00729 /** Speed is given in 1000 bytes/s , 0 = invalid. The numbers 00730 are supposed to be usable with burn_drive_set_speed() */ 00731 int write_speed; 00732 int read_speed; 00733 00734 /** Expert info from ACh GET PERFORMANCE and/or mode page 2Ah. 00735 Expect values other than 0 or 1 to get a meaning in future.*/ 00736 /* Rotational control: 0 = CLV/default , 1 = CAV */ 00737 int wrc; 00738 /* 1 = drive promises reported performance over full media */ 00739 int exact; 00740 /* 1 = suitable for mixture of read and write */ 00741 int mrw; 00742 00743 /** List chaining. Use .next until NULL to iterate over the list */ 00744 struct burn_speed_descriptor *prev; 00745 struct burn_speed_descriptor *next; 00746 }; 00747 00748 00749 /** Initialize the library. 00750 This must be called before using any other functions in the library. It 00751 may be called more than once with no effect. 00752 It is possible to 'restart' the library by shutting it down and 00753 re-initializing it. Once this was necessary if you follow the older and 00754 more general way of accessing a drive via burn_drive_scan() and 00755 burn_drive_grab(). See burn_drive_scan_and_grab() with its strong 00756 urges and its explanations. 00757 @return Nonzero if the library was able to initialize; zero if 00758 initialization failed. 00759 */ 00760 int burn_initialize(void); 00761 00762 /** Shutdown the library. 00763 This should be called before exiting your application. Make sure that all 00764 drives you have grabbed are released <i>before</i> calling this. 00765 */ 00766 void burn_finish(void); 00767 00768 00769 /* ts A61002 */ 00770 /** Abort any running drive operation and eventually call burn_finish(). 00771 00772 You MUST shut down the busy drives if an aborting event occurs during a 00773 burn run. For that you may call this function either from your own signal 00774 handling code or indirectly by activating the built-in signal handling: 00775 burn_set_signal_handling("my_app_name : ", NULL, 0); 00776 Else you may eventually call burn_drive_cancel() on the active drives and 00777 wait for them to assume state BURN_DRIVE_IDLE. 00778 @param patience Maximum number of seconds to wait for drives to 00779 finish. 00780 @since 0.7.8 : 00781 If this is -1, then only the cancel operations will 00782 be performed and no burn_finish() will happen. 00783 @param pacifier_func If not NULL: a function to produce appeasing messages. 00784 See burn_abort_pacifier() for an example. 00785 @param handle Opaque handle to be used with pacifier_func 00786 @return 1 ok, all went well 00787 0 had to leave a drive in unclean state 00788 <0 severe error, do no use libburn again 00789 @since 0.2.6 00790 */ 00791 int burn_abort(int patience, 00792 int (*pacifier_func)(void *handle, int patience, int elapsed), 00793 void *handle); 00794 00795 /** A pacifier function suitable for burn_abort. 00796 @param handle If not NULL, a pointer to a text suitable for printf("%s") 00797 @param patience Maximum number of seconds to wait 00798 @param elapsed Elapsed number of seconds 00799 */ 00800 int burn_abort_pacifier(void *handle, int patience, int elapsed); 00801 00802 00803 /** ts A61006 : This is for development only. Not suitable for applications. 00804 Set the verbosity level of the library. The default value is 0, which means 00805 that nothing is output on stderr. The more you increase this, the more 00806 debug output should be displayed on stderr for you. 00807 @param level The verbosity level desired. 0 for nothing, higher positive 00808 values for more information output. 00809 */ 00810 void burn_set_verbosity(int level); 00811 00812 /* ts A91111 */ 00813 /** Enable resp. disable logging of SCSI commands. 00814 This call can be made at any time - even before burn_initialize(). 00815 It is in effect for all active drives and currently not very thread 00816 safe for multiple drives. 00817 @param flag Bitfield for control purposes. The default is 0. 00818 bit0= log to file /tmp/libburn_sg_command_log 00819 bit1= log to stderr 00820 bit2= flush output after each line 00821 @since 0.7.4 00822 */ 00823 void burn_set_scsi_logging(int flag); 00824 00825 /* ts A60813 */ 00826 /** Set parameters for behavior on opening device files. To be called early 00827 after burn_initialize() and before any bus scan. But not mandatory at all. 00828 Parameter value 1 enables a feature, 0 disables. 00829 Default is (1,0,0). Have a good reason before you change it. 00830 @param exclusive 00831 0 = no attempt to make drive access exclusive. 00832 1 = Try to open only devices which are not marked as busy 00833 and try to mark them busy if opened sucessfully. (O_EXCL 00834 on GNU/Linux , flock(LOCK_EX) on FreeBSD.) 00835 2 = in case of a SCSI device, also try to open exclusively 00836 the matching /dev/sr, /dev/scd and /dev/st . 00837 One may select a device SCSI file family by adding 00838 0 = default family 00839 4 = /dev/sr%d 00840 8 = /dev/scd%d 00841 16 = /dev/sg%d 00842 Do not use other values ! 00843 Add 32 to demand on GNU/Linux an exclusive lock by 00844 fcntl(,F_SETLK,) after open() has succeeded. 00845 @param blocking Try to wait for drives which do not open immediately but 00846 also do not return an error as well. (O_NONBLOCK) 00847 This might stall indefinitely with /dev/hdX hard disks. 00848 @param abort_on_busy Unconditionally abort process when a non blocking 00849 exclusive opening attempt indicates a busy drive. 00850 Use this only after thorough tests with your app. 00851 @since 0.2.2 00852 */ 00853 void burn_preset_device_open(int exclusive, int blocking, int abort_on_busy); 00854 00855 00856 /* ts A70223 */ 00857 /** Allows the use of media types which are implemented in libburn but not yet 00858 tested. The list of those untested profiles is subject to change. 00859 - Currently no media types are under test reservation - 00860 If you really test such media, then please report the outcome on 00861 libburn-hackers@pykix.org 00862 If ever then this call should be done soon after burn_initialize() before 00863 any drive scanning. 00864 @param yes 1=allow all implemented profiles, 0=only tested media (default) 00865 @since 0.3.4 00866 */ 00867 void burn_allow_untested_profiles(int yes); 00868 00869 00870 /* ts A60823 */ 00871 /** Aquire a drive with known device file address. 00872 00873 This is the sysadmin friendly way to open one drive and to leave all 00874 others untouched. It bundles the following API calls to form a 00875 non-obtrusive way to use libburn: 00876 burn_drive_add_whitelist() , burn_drive_scan() , burn_drive_grab() 00877 You are *strongly urged* to use this call whenever you know the drive 00878 address in advance. 00879 00880 If not, then you have to use directly above calls. In that case, you are 00881 *strongly urged* to drop any unintended drive which will be exclusively 00882 occupied and not closed by burn_drive_scan(). 00883 This can be done by shutting down the library including a call to 00884 burn_finish(). You may later start a new libburn session and should then 00885 use the function described here with an address obtained after 00886 burn_drive_scan() via burn_drive_d_get_adr(drive_infos[driveno].drive,adr). 00887 Another way is to drop the unwanted drives by burn_drive_info_forget(). 00888 00889 Operating on multiple drives: 00890 00891 Different than with burn_drive_scan() it is allowed to call 00892 burn_drive_scan_and_grab() without giving up any other scanned drives. So 00893 this call can be used to get a collection of more than one aquired drives. 00894 The attempt to aquire the same drive twice will fail, though. 00895 00896 Pseudo-drives: 00897 00898 burn_drive_scan_and_grab() is able to aquire virtual drives which will 00899 accept options much like a MMC burner drive. Many of those options will not 00900 cause any effect, though. The address of a pseudo-drive begins with 00901 prefix "stdio:" followed by a path. 00902 Examples: "stdio:/tmp/pseudo_drive" , "stdio:/dev/null" , "stdio:-" 00903 00904 If the path is empty, the result is a null-drive = drive role 0. 00905 It pretends to have loaded no media and supports no reading or writing. 00906 00907 If the path leads to an existing regular file, or to a not yet existing 00908 file, or to an existing block device, then the result is a random access 00909 stdio-drive capable of reading and writing = drive role 2. 00910 00911 If the path leads to an existing file of any type other than directory, 00912 then the result is a sequential write-only stdio-drive = drive role 3. 00913 00914 The special address form "stdio:/dev/fd/{number}" is interpreted literally 00915 as reference to open file descriptor {number}. This address form coincides 00916 with real files on some systems, but it is in fact hardcoded in libburn. 00917 Special address "stdio:-" means stdout = "stdio:/dev/fd/1". 00918 The role of such a drive is determined by the file type obtained via 00919 fstat({number}). 00920 00921 Roles 2 and 3 perform all their eventual data transfer activities on a file 00922 via standard i/o functions open(2), lseek(2), read(2), write(2), close(2). 00923 The media profile is reported as 0xffff. Write space information from those 00924 media is not necessarily realistic. 00925 00926 The capabilities of role 2 resemble DVD-RAM but it can simulate writing. 00927 If the path does not exist in the filesystem yet, it is attempted to create 00928 it as a regular file as soon as write operations are started. 00929 00930 The capabilities of role 3 resemble a blank DVD-R. Nevertheless each 00931 burn_disc_write() run may only write a single track. 00932 00933 One may distinguish pseudo-drives from MMC drives by call 00934 burn_drive_get_drive_role(). 00935 00936 @param drive_infos On success returns a one element array with the drive 00937 (cdrom/burner). Thus use with driveno 0 only. On failure 00938 the array has no valid elements at all. 00939 The returned array should be freed via burn_drive_info_free() 00940 when it is no longer needed. 00941 This is a result from call burn_drive_scan(). See there. 00942 Use with driveno 0 only. 00943 @param adr The device file address of the desired drive. Either once 00944 obtained by burn_drive_d_get_adr() or composed skillfully by 00945 application resp. its user. E.g. "/dev/sr0". 00946 Consider to preprocess it by burn_drive_convert_fs_adr(). 00947 @param load Nonzero to make the drive attempt to load a disc (close its 00948 tray door, etc). 00949 @return 1 = success , 0 = drive not found , -1 = other error 00950 @since 0.2.2 00951 */ 00952 int burn_drive_scan_and_grab(struct burn_drive_info *drive_infos[], 00953 char* adr, int load); 00954 00955 00956 /* ts A51221 */ 00957 /* @since 0.2.2 */ 00958 /** Maximum number of particularly permissible drive addresses */ 00959 #define BURN_DRIVE_WHITELIST_LEN 255 00960 00961 /** Add a device to the list of permissible drives. As soon as some entry is in 00962 the whitelist all non-listed drives are banned from scanning. 00963 @return 1 success, <=0 failure 00964 @since 0.2.2 00965 */ 00966 int burn_drive_add_whitelist(char *device_address); 00967 00968 /** Remove all drives from whitelist. This enables all possible drives. */ 00969 void burn_drive_clear_whitelist(void); 00970 00971 00972 /** Scan for drives. This function MUST be called until it returns nonzero. 00973 In case of re-scanning: 00974 All pointers to struct burn_drive and all struct burn_drive_info arrays 00975 are invalidated by using this function. Do NOT store drive pointers across 00976 calls to this function ! 00977 To avoid invalid pointers one MUST free all burn_drive_info arrays 00978 by burn_drive_info_free() before calling burn_drive_scan() a second time. 00979 If there are drives left, then burn_drive_scan() will refuse to work. 00980 00981 After this call all drives depicted by the returned array are subject 00982 to eventual (O_EXCL) locking. See burn_preset_device_open(). This state 00983 ends either with burn_drive_info_forget() or with burn_drive_release(). 00984 It is unfriendly to other processes on the system to hold drives locked 00985 which one does not definitely plan to use soon. 00986 @param drive_infos Returns an array of drive info items (cdroms/burners). 00987 The returned array must be freed by burn_drive_info_free() 00988 before burn_finish(), and also before calling this function 00989 burn_drive_scan() again. 00990 @param n_drives Returns the number of drive items in drive_infos. 00991 @return 0 while scanning is not complete 00992 >0 when it is finished sucessfully, 00993 <0 when finished but failed. 00994 */ 00995 int burn_drive_scan(struct burn_drive_info *drive_infos[], 00996 unsigned int *n_drives); 00997 00998 /* ts A60904 : ticket 62, contribution by elmom */ 00999 /** Release memory about a single drive and any exclusive lock on it. 01000 Become unable to inquire or grab it. Expect FATAL consequences if you try. 01001 @param drive_info pointer to a single element out of the array 01002 obtained from burn_drive_scan() : &(drive_infos[driveno]) 01003 @param force controls degree of permissible drive usage at the moment this 01004 function is called, and the amount of automatically provided 01005 drive shutdown : 01006 0= drive must be ungrabbed and BURN_DRIVE_IDLE 01007 1= try to release drive resp. accept BURN_DRIVE_GRABBING 01008 Use these two only. Further values are to be defined. 01009 @return 1 on success, 2 if drive was already forgotten, 01010 0 if not permissible, <0 on other failures, 01011 @since 0.2.2 01012 */ 01013 int burn_drive_info_forget(struct burn_drive_info *drive_info, int force); 01014 01015 01016 /** When no longer needed, free a whole burn_drive_info array which was 01017 returned by burn_drive_scan(). 01018 For freeing single drive array elements use burn_drive_info_forget(). 01019 */ 01020 void burn_drive_info_free(struct burn_drive_info drive_infos[]); 01021 01022 01023 /* ts A60823 */ 01024 /* @since 0.2.2 */ 01025 /** Maximum length+1 to expect with a drive device file address string */ 01026 #define BURN_DRIVE_ADR_LEN 1024 01027 01028 /* ts A70906 */ 01029 /** Inquire the device file address of the given drive. 01030 @param drive The drive to inquire. 01031 @param adr An application provided array of at least BURN_DRIVE_ADR_LEN 01032 characters size. The device file address gets copied to it. 01033 @return >0 success , <=0 error (due to libburn internal problem) 01034 @since 0.4.0 01035 */ 01036 int burn_drive_d_get_adr(struct burn_drive *drive, char adr[]); 01037 01038 /* A60823 */ 01039 /** Inquire the device file address of a drive via a given drive_info object. 01040 (Note: This is a legacy call.) 01041 @param drive_info The drive to inquire.Usually some &(drive_infos[driveno]) 01042 @param adr An application provided array of at least BURN_DRIVE_ADR_LEN 01043 characters size. The device file address gets copied to it. 01044 @return >0 success , <=0 error (due to libburn internal problem) 01045 @since 0.2.6 01046 */ 01047 int burn_drive_get_adr(struct burn_drive_info *drive_info, char adr[]); 01048 01049 01050 /* ts A60922 ticket 33 */ 01051 /** Evaluate whether the given address would be a drive device file address 01052 which could be listed by a run of burn_drive_scan(). No check is made 01053 whether a device file with this address exists or whether it leads 01054 to a usable MMC drive. 01055 @return 1 means yes, 0 means no 01056 @since 0.2.6 01057 */ 01058 int burn_drive_is_enumerable_adr(char *adr); 01059 01060 /* ts A60922 ticket 33 */ 01061 /** Try to convert a given existing filesystem address into a drive device file 01062 address. This succeeds with symbolic links or if a hint about the drive's 01063 system address can be read from the filesystem object and a matching drive 01064 is found. 01065 @param path The address of an existing file system object 01066 @param adr An application provided array of at least BURN_DRIVE_ADR_LEN 01067 characters size. The device file address gets copied to it. 01068 @return 1 = success , 0 = failure , -1 = severe error 01069 @since 0.2.6 01070 */ 01071 int burn_drive_convert_fs_adr(char *path, char adr[]); 01072 01073 /* ts A60923 */ 01074 /** Try to convert a given SCSI address of bus,host,channel,target,lun into 01075 a drive device file address. If a SCSI address component parameter is < 0 01076 then it is not decisive and the first enumerated address which matches 01077 the >= 0 parameters is taken as result. 01078 Note: bus and (host,channel) are supposed to be redundant. 01079 @param bus_no "Bus Number" (something like a virtual controller) 01080 @param host_no "Host Number" (something like half a virtual controller) 01081 @param channel_no "Channel Number" (other half of "Host Number") 01082 @param target_no "Target Number" or "SCSI Id" (a device) 01083 @param lun_no "Logical Unit Number" (a sub device) 01084 @param adr An application provided array of at least BURN_DRIVE_ADR_LEN 01085 characters size. The device file address gets copied to it. 01086 @return 1 = success , 0 = failure , -1 = severe error 01087 @since 0.2.6 01088 */ 01089 int burn_drive_convert_scsi_adr(int bus_no, int host_no, int channel_no, 01090 int target_no, int lun_no, char adr[]); 01091 01092 /* ts B10728 */ 01093 /** Try to convert a given drive device file address into the address of a 01094 symbolic link that points to this drive address. 01095 Modern GNU/Linux systems may shuffle drive addresses from boot to boot. 01096 The udev daemon is supposed to create links which always point to the 01097 same drive, regardless of its system address. 01098 This call tries to find such links. 01099 @param dev_adr Should contain a drive address as returned by 01100 burn_drive_scan(). 01101 @param link_adr An application provided array of at least 01102 BURN_DRIVE_ADR_LEN characters size. The found link 01103 address gets copied to it. 01104 @param dir_adr The address of the directory where to look for links. 01105 Normally: "/dev" 01106 @param templ An array of pointers to name templates, which 01107 links have to match. A symbolic link in dir_adr matches 01108 a name template if it begins by that text. E.g. 01109 link address "/dev/dvdrw1" matches template "dvdrw". 01110 If templ is NULL, then the default array gets used: 01111 {"dvdrw", "cdrw", "dvd", "cdrom", "cd"} 01112 If several links would match, then a link will win, 01113 which matches the template with the lowest array index. 01114 Among these candidates, the one with the lowest strcmp() 01115 rank will be chosen as link_adr. 01116 @param num_templ Number of array elements in templ. 01117 @param flag Bitfield for control purposes. Unused yet. Submit 0. 01118 @return <0 severe error, 0 failed to search, 2 nothing found 01119 1 success, link_adr is valid 01120 @since 1.1.4 01121 */ 01122 int burn_lookup_device_link(char *dev_adr, char link_adr[], 01123 char *dir_adr, char **templ, int num_templ, int flag); 01124 01125 /* ts A60923 - A61005 */ 01126 /** Try to obtain bus,host,channel,target,lun from path. If there is an SCSI 01127 address at all, then this call should succeed with a drive device file 01128 address obtained via burn_drive_d_get_adr(). It is also supposed to 01129 succeed with any device file of a (possibly emulated) SCSI device. 01130 @return 1 = success , 0 = failure , -1 = severe error 01131 @since 0.2.6 01132 */ 01133 int burn_drive_obtain_scsi_adr(char *path, int *bus_no, int *host_no, 01134 int *channel_no, int *target_no, int *lun_no); 01135 01136 /** Grab a drive. This must be done before the drive can be used (for reading, 01137 writing, etc). 01138 @param drive The drive to grab. This is found in a returned 01139 burn_drive_info struct. 01140 @param load Nonzero to make the drive attempt to load a disc (close its 01141 tray door, etc). 01142 @return 1 if it was possible to grab the drive, else 0 01143 */ 01144 int burn_drive_grab(struct burn_drive *drive, int load); 01145 01146 /* ts B00114 */ 01147 /* Probe available CD write modes and block types. In earlier versions this 01148 was done unconditionally on drive examination or aquiration. But it is 01149 lengthy and obtrusive, up to spoiling burn runs on the examined drives. 01150 So now this probing is omitted by default. All drives which announce to be 01151 capable of CD or DVD writing, get blindly attributed the capability for 01152 SAO and TAO. Applications which are interested in RAW modes or want to 01153 rely on the traditional write mode information, may use this call. 01154 @param drive_info drive object to be inquired 01155 @return >0 indicates success, <=0 means failure 01156 @since 0.7.6 01157 */ 01158 int burn_drive_probe_cd_write_modes(struct burn_drive_info *drive_info); 01159 01160 /* ts A90824 */ 01161 /** Calm down or alert a drive. Some drives stay alert after reading for 01162 quite some time. This saves time with the startup for the next read 01163 operation but also causes noise and consumes extra energy. It makes 01164 sense to calm down the drive if no read operation is expected for the 01165 next few seconds. The drive will get alert automatically if operations 01166 are required. 01167 @param d The drive to influence. 01168 @param flag Bitfield for control purposes 01169 bit0= become alert (else start snoozing) 01170 This is not mandatory to allow further drive operations 01171 @return 1= success , 0= drive role not suitable for calming 01172 @since 0.7.0 01173 */ 01174 int burn_drive_snooze(struct burn_drive *d, int flag); 01175 01176 01177 /** Re-assess drive and media status. This should be done after a drive 01178 underwent a status change and shall be further used without intermediate 01179 burn_drive_release(), burn_drive_grab(). E.g. after blanking or burning. 01180 @param d The already grabbed drive to re-assess. 01181 @param flag Unused yet. Submit 0. 01182 @return 1 success , <= 0 could not determine drive and media state 01183 @since 1.1.8 01184 */ 01185 int burn_drive_re_assess(struct burn_drive *d, int flag); 01186 01187 01188 /** Release a drive. This should not be done until the drive is no longer 01189 busy (see burn_drive_get_status). 01190 @param drive The drive to release. 01191 @param eject Nonzero to make the drive eject the disc in it. 01192 */ 01193 void burn_drive_release(struct burn_drive *drive, int eject); 01194 01195 01196 /* ts A70918 */ 01197 /** Like burn_drive_release() but keeping the drive tray closed and its 01198 eject button disabled. This physically locked drive state will last until 01199 the drive is grabbed again and released via burn_drive_release(). 01200 Programs like eject, cdrecord, growisofs will break that ban too. 01201 @param d The drive to release and leave locked. 01202 @param flag Bitfield for control purposes (unused yet, submit 0) 01203 @return 1 means success, <=0 means failure 01204 @since 0.4.0 01205 */ 01206 int burn_drive_leave_locked(struct burn_drive *d, int flag); 01207 01208 01209 /** Returns what kind of disc a drive is holding. This function may need to be 01210 called more than once to get a proper status from it. See burn_disc_status 01211 for details. 01212 @param drive The drive to query for a disc. 01213 @return The status of the drive, or what kind of disc is in it. 01214 Note: BURN_DISC_UNGRABBED indicates wrong API usage 01215 */ 01216 enum burn_disc_status burn_disc_get_status(struct burn_drive *drive); 01217 01218 01219 /* ts A61020 */ 01220 /** WARNING: This revives an old bug-like behavior that might be dangerous. 01221 Sets the drive status to BURN_DISC_BLANK if it is BURN_DISC_UNREADY 01222 or BURN_DISC_UNSUITABLE. Thus marking media as writable which actually 01223 failed to declare themselves either blank or (partially) filled. 01224 @return 1 drive status has been set , 0 = unsuitable drive status 01225 @since 0.2.6 01226 */ 01227 int burn_disc_pretend_blank(struct burn_drive *drive); 01228 01229 01230 /* ts A61106 */ 01231 /** WARNING: This overrides the safety measures against unsuitable media. 01232 Sets the drive status to BURN_DISC_FULL if it is BURN_DISC_UNREADY 01233 or BURN_DISC_UNSUITABLE. Thus marking media as blankable which actually 01234 failed to declare themselves either blank or (partially) filled. 01235 @since 0.2.6 01236 */ 01237 int burn_disc_pretend_full(struct burn_drive *drive); 01238 01239 01240 /* ts B31110 */ 01241 /** WARNING: This overrides the safety measures against unsuitable media. 01242 Sets the drive status to BURN_DISC_FULL unconditionally. 01243 @since 1.3.4 01244 */ 01245 int burn_disc_pretend_full_uncond(struct burn_drive *drive); 01246 01247 01248 /* ts A61021 */ 01249 /** Reads ATIP information from inserted media. To be obtained via 01250 burn_drive_get_write_speed(), burn_drive_get_min_write_speed(), 01251 burn_drive_get_start_end_lba(). The drive must be grabbed for this call. 01252 @param drive The drive to query. 01253 @return 1=sucess, 0=no valid ATIP info read, -1 severe error 01254 @since 0.2.6 01255 */ 01256 int burn_disc_read_atip(struct burn_drive *drive); 01257 01258 01259 /* ts A61020 */ 01260 /** Returns start and end lba of the media which is currently inserted 01261 in the given drive. The drive has to be grabbed to have hope for reply. 01262 Shortcomming (not a feature): unless burn_disc_read_atip() was called 01263 only blank media will return valid info. 01264 @param drive The drive to query. 01265 @param start_lba Returns the start lba value 01266 @param end_lba Returns the end lba value 01267 @param flag Bitfield for control purposes (unused yet, submit 0) 01268 @return 1 if lba values are valid , 0 if invalid 01269 @since 0.2.6 01270 */ 01271 int burn_drive_get_start_end_lba(struct burn_drive *drive, 01272 int *start_lba, int *end_lba, int flag); 01273 01274 01275 /* ts A90902 */ 01276 /** Guess the manufacturer name of CD media from the ATIP addresses of lead-in 01277 and lead-out. (Currently only lead-in is interpreted. Lead-out may in 01278 future be used to identify the media type in more detail.) 01279 The parameters of this call should be obtained by burn_disc_read_atip(d), 01280 burn_drive_get_start_end_lba(d, &start_lba, &end_lba, 0), 01281 burn_lba_to_msf(start_lba, &m_li, &s_li, &f_li) and 01282 burn_lba_to_msf(end_lba, &m_lo, &s_lo, &f_lo). 01283 @param m_li "minute" part of ATIP lead-in resp. start_lba 01284 @param s_li "second" of lead-in resp. start_lba 01285 @param f_li "frame" of lead-in 01286 @param m_lo "minute" part of ATIP lead-out 01287 @param s_lo "second" of lead-out 01288 @param f_lo "frame" of lead-out 01289 @param flag Bitfield for control purposes, 01290 bit0= append a text "(aka ...)" to reply if other brands or 01291 vendor names are known. 01292 @return Printable text or NULL on memory shortage. 01293 Dispose by free() when no longer needed. 01294 @since 0.7.2 01295 */ 01296 char *burn_guess_cd_manufacturer(int m_li, int s_li, int f_li, 01297 int m_lo, int s_lo, int f_lo, int flag); 01298 01299 /* ts A90909 */ 01300 /** Retrieve some media information which is mainly specific to CD. For other 01301 media only the bits in reply parameter valid are supposed to be meaningful. 01302 @param d The drive to query. 01303 @param disc_type A string saying either "CD-DA or CD-ROM", or "CD-I", 01304 or ""CD-ROM XA", or "undefined". 01305 @param disc_id A 32 bit number read from the media. (Meaning unclear yet) 01306 @param bar_code 8 hex digits from a barcode on media read by the drive 01307 (if the drive has a bar code reader built in). 01308 @param app_code The Host Application Code which must be set in the Write 01309 Parameters Page if the media is not unrestricted (URU==0). 01310 @param valid Replies bits which indicate the validity of other reply 01311 parameters or the state of certain CD info bits: 01312 bit0= disc_type is valid 01313 bit1= disc_id is valid 01314 bit2= bar_code is valid 01315 bit3= disc_app_code is valid 01316 bit4= Disc is unrestricted (URU bit, 51h READ DISC INFO) 01317 This seems to be broken with my drives. The bit is 01318 0 and the validity bit for disc_app_code is 0 too. 01319 bit5= Disc is nominally erasable (Erasable bit) 01320 This will be set with overwriteable media which 01321 libburn normally considers to be unerasable blank. 01322 @return 1 success, <= 0 an error occured 01323 @since 0.7.2 01324 */ 01325 int burn_disc_get_cd_info(struct burn_drive *d, char disc_type[80], 01326 unsigned int *disc_id, char bar_code[9], int *app_code, 01327 int *valid); 01328 01329 /* ts B11201 */ 01330 /** Read the array of CD-TEXT packs from the Lead-in of an audio CD. 01331 Each pack consists of 18 bytes, of which 4 are header. 12 bytes are pieces 01332 of 0-terminated texts or binary data. 2 bytes hold a CRC. 01333 For a description of the format of the array, see file doc/cdtext.txt. 01334 @param d The drive to query. 01335 @param text_packs Will point to an allocated memory buffer with CD-TEXT. 01336 It will only contain text packs, and not be prepended 01337 by the TOC header of four bytes, which gets stored with 01338 file cdtext.dat by cdrecord -vv -toc. (The first two of 01339 these bytes are supposed to hold the number of CD-TEXT 01340 bytes + 2. The other two bytes are supposed to be 0.) 01341 Dispose this buffer by free(), when no longer needed. 01342 @param num_packs Will tell the number of text packs, i.e. the number of 01343 bytes in text_packs divided by 18. 01344 @param flag Bitfield for control purposes, 01345 Unused yet. Submit 0. 01346 @return 1 success, 0= no CD-TEXT found, < 0 an error occured 01347 @since 1.2.0 01348 */ 01349 int burn_disc_get_leadin_text(struct burn_drive *d, 01350 unsigned char **text_packs, int *num_packs, 01351 int flag); 01352 01353 /* ts B00924 */ 01354 /** Read the current usage of the eventual BD Spare Area. This area gets 01355 reserved on BD media during formatting. During writing it is used to 01356 host replacements of blocks which failed the checkread immediately after 01357 writing. 01358 This call applies only to recordable BD media. I.e. profiles 0x41 to 0x43. 01359 @param d The drive to query. 01360 @param alloc_blocks Returns the number of blocks reserved as Spare Area 01361 @param free_blocks Returns the number of yet unused blocks in that area 01362 @param flag Bitfield for control purposes (unused yet, submit 0) 01363 @return 1 = reply prarameters are valid, 01364 <=0 = reply is invalid (e.g. because no BD profile) 01365 @since 0.8.8 01366 */ 01367 int burn_disc_get_bd_spare_info(struct burn_drive *d, 01368 int *alloc_blocks, int *free_blocks, int flag); 01369 01370 /* ts B10801 */ 01371 /** Retrieve some media information which is mainly specific to media of 01372 the DVD-R family: DVD-R , DVD-RW , DVD-R DL , HD DVD-R 01373 Currently the information cannot be retrieved from other media types. 01374 @param d The drive to query. 01375 @param disk_category returns DVD Book to which the media complies 01376 @param book_name returns a pointer to the book name of disk_category. 01377 This memory is static. Do not alter or free it ! 01378 @param part_version returns the Media Version in the DVD Book 01379 @param num_layers returns the number of media layers 01380 @param num_blocks returns the number of blocks between pysical start 01381 and physical end of the media 01382 @param flag Bitfield for control purposes (unused yet, submit 0) 01383 @return 1 = reply prarameters are valid, 01384 <=0 = reply is invalid (e.g. because no DVD-R) 01385 @since 1.1.4 01386 */ 01387 int burn_disc_get_phys_format_info(struct burn_drive *d, int *disk_category, 01388 char **book_name, int *part_version, int *num_layers, 01389 int *num_blocks, int flag); 01390 01391 /* ts A61110 */ 01392 /** Read start lba and Next Writeable Address of a track from media. 01393 Usually a track lba is obtained from the result of burn_track_get_entry(). 01394 This call retrieves an updated lba, eventual nwa, and can address the 01395 invisible track to come. 01396 The drive must be grabbed for this call. One may not issue this call 01397 during ongoing burn_disc_write() or burn_disc_erase(). 01398 @param d The drive to query. 01399 @param o If not NULL: write parameters to be set on drive before query 01400 @param trackno 0=next track to come, >0 number of existing track 01401 The first existing track on a CD may have a number higher 01402 than 1. Use burn_session_get_start_tno() to inquire this 01403 start number. 01404 @param lba return value: start lba 01405 @param nwa return value: Next Writeable Address 01406 @return 1=nwa is valid , 0=nwa is not valid , -1=error 01407 @since 0.2.6 01408 */ 01409 int burn_disc_track_lba_nwa(struct burn_drive *d, struct burn_write_opts *o, 01410 int trackno, int *lba, int *nwa); 01411 01412 /* ts B10525 */ 01413 /** Tells whether a previous attempt to determine the Next Writeable Address 01414 of the upcomming track reveiled that the READ TRACK INFORMATION Damage Bit 01415 is set for this track, resp. that no valid writable address is available. 01416 See MMC-5 6.27.3.7 Damage Bit, 6.27.3.11 NWA_V (NWA valid) 01417 @param d The drive to query. 01418 @param flag Bitfield for control purposes (unused yet, submit 0) 01419 @return 0= Looks ok: Damage Bit is not set, NWA_V is set 01420 1= Damaged and theoretically writable (NWA_V is set) 01421 2= Not writable: NWA_V is not set 01422 3= Damaged and not writable (NWA_V is not set), 01423 @since 1.1.0 01424 */ 01425 int burn_disc_next_track_is_damaged(struct burn_drive *d, int flag); 01426 01427 /* ts B10527 */ 01428 /** Try to close the last track and session of media which have bit0 set in 01429 the return value of call burn_disc_next_track_is_damaged(). 01430 Whether it helps depends much on the reason why the media is reported 01431 as damaged by the drive. 01432 This call works only for profiles 0x09 CD-R, 0x0a CD-RW, 0x11 DVD-R, 01433 0x14 DVD-RW sequential, 0x1b DVD+R, 0x2b DVD+R DL, 0x41 BD-R sequential. 01434 Note: After writing it is advised to give up the drive and to grab it again 01435 in order to learn about its view on the new media state. 01436 @param o Write options created by burn_write_opts_new() and 01437 manipulated by burn_write_opts_set_multi(). 01438 burn_write_opts_set_write_type() should be set to 01439 BURN_WRITE_TAO, burn_write_opts_set_simulate() should be 01440 set to 0. 01441 @param flag Bitfield for control purposes 01442 bit0= force close, even if no damage was seen 01443 @return <=0 media not marked as damaged, or media type not suitable, 01444 or closing attempted but failed 01445 1= attempt finished without error indication 01446 @since 1.1.0 01447 */ 01448 int burn_disc_close_damaged(struct burn_write_opts *o, int flag); 01449 01450 01451 /* ts A70131 */ 01452 /** Read start lba of the first track in the last complete session. 01453 This is the first parameter of mkisofs option -C. The second parameter 01454 is nwa as obtained by burn_disc_track_lba_nwa() with trackno 0. 01455 @param d The drive to query. 01456 @param start_lba returns the start address of that track 01457 @return <= 0 : failure, 1 = ok 01458 @since 0.3.2 01459 */ 01460 int burn_disc_get_msc1(struct burn_drive *d, int *start_lba); 01461 01462 01463 /* ts A70213 */ 01464 /** Return the best possible estimation of the currently available capacity of 01465 the media. This might depend on particular write option settings. For 01466 inquiring the space with such a set of options, the drive has to be 01467 grabbed and BURN_DRIVE_IDLE. If not, then one will only get a canned value 01468 from the most recent automatic inquiry (e.g. during last drive grabbing). 01469 An eventual start address from burn_write_opts_set_start_byte() will be 01470 subtracted from the obtained capacity estimation. Negative results get 01471 defaulted to 0. 01472 If the drive is actually a file in a large filesystem or a large block 01473 device, then the capacity is curbed to a maximum of 0x7ffffff0 blocks 01474 = 4 TB - 32 KB. 01475 @param d The drive to query. 01476 @param o If not NULL: write parameters to be set on drive before query 01477 @return number of most probably available free bytes 01478 @since 0.3.4 01479 */ 01480 off_t burn_disc_available_space(struct burn_drive *d, 01481 struct burn_write_opts *o); 01482 01483 /* ts A61202 */ 01484 /** Tells the MMC Profile identifier of the loaded media. The drive must be 01485 grabbed in order to get a non-zero result. 01486 libburn currently writes only to profiles 01487 0x09 "CD-R" 01488 0x0a "CD-RW" 01489 0x11 "DVD-R sequential recording" 01490 0x12 "DVD-RAM" 01491 0x13 "DVD-RW restricted overwrite" 01492 0x14 "DVD-RW sequential recording", 01493 0x15 "DVD-R/DL sequential recording", 01494 0x1a "DVD+RW" 01495 0x1b "DVD+R", 01496 0x2b "DVD+R/DL", 01497 0x41 "BD-R sequential recording", 01498 0x43 "BD-RE", 01499 0xffff "stdio file" 01500 Note: 0xffff is not a MMC profile but a libburn invention. 01501 Read-only are the profiles 01502 0x08 "CD-ROM", 01503 0x10 "DVD-ROM", 01504 0x40 "BD-ROM", 01505 Read-only for now is this BD-R profile (testers wanted) 01506 0x42 "BD-R random recording" 01507 Empty drives are supposed to report 01508 0x00 "" 01509 @param d The drive where the media is inserted. 01510 @param pno Profile Number. See also mmc5r03c.pdf, table 89 01511 @param name Profile Name (see above list, unknown profiles have empty name) 01512 @return 1 profile is valid, 0 no profile info available 01513 @since 0.3.0 01514 */ 01515 int burn_disc_get_profile(struct burn_drive *d, int *pno, char name[80]); 01516 01517 01518 /* ts A90903 : API */ 01519 /** Obtain product id and standards defined media codes. 01520 The product id is a printable string which is supposed to be the same 01521 for identical media but should vary with non-identical media. Some media 01522 do not allow to obtain such an id at all. 01523 The pair (profile_number, product_id) should be the best id to identify 01524 media with identical product specifications. 01525 The reply parameters media_code1 and media_code2 can be used with 01526 burn_guess_manufacturer() 01527 The reply parameters have to be disposed by free() when no longer needed. 01528 @param d The drive where the media is inserted. 01529 @param product_id Reply: Printable text depicting manufacturer and 01530 eventually media id. 01531 @param media_code1 Reply: The eventual manufacturer identification as read 01532 from DVD/BD media or a text "XXmYYsZZf" from CD media 01533 ATIP lead-in. 01534 @param media_code2 The eventual media id as read from DVD+/BD media or a 01535 text "XXmYYsZZf" from CD ATIP lead-out. 01536 @param book_type Book type text for DVD and BD. 01537 Caution: is NULL with CD, even if return value says ok. 01538 @param flag Bitfield for control purposes 01539 bit0= do not escape " _/" (not suitable for 01540 burn_guess_manufacturer()) 01541 @return 1= ok, product_id and media codes are valid, 01542 0= no product id_available, reply parameters are NULL 01543 <0= error 01544 @since 0.7.2 01545 */ 01546 int burn_disc_get_media_id(struct burn_drive *d, 01547 char **product_id, char **media_code1, char **media_code2, 01548 char **book_type, int flag); 01549 01550 01551 /* ts A90904 */ 01552 /** Guess the name of a manufacturer by profile number, manufacturer code 01553 and media code. The profile number can be obtained by 01554 burn_disc_get_profile(), the other two parameters can be obtained as 01555 media_code1 and media_code2 by burn_get_media_product_id(). 01556 @param profile_no Profile number (submit -1 if not known) 01557 @param manuf_code Manufacturer code from media (e.g. "RICOHJPN") 01558 @param media_code Media ID code from media (e.g. "W11") 01559 @param flag Bitfield for control purposes, submit 0 01560 @return Printable text or NULL on memory shortage. 01561 If the text begins with "Unknown " then no item of the 01562 manufacturer list matched the codes. 01563 Dispose by free() when no longer needed. 01564 @since 0.7.2 01565 */ 01566 char *burn_guess_manufacturer(int profile_no, 01567 char *manuf_code, char *media_code, int flag); 01568 01569 01570 /** Tells whether a disc can be erased or not 01571 @param d The drive to inquire. 01572 @return Non-zero means erasable 01573 */ 01574 int burn_disc_erasable(struct burn_drive *d); 01575 01576 /** Returns the progress and status of a drive. 01577 @param drive The drive to query busy state for. 01578 @param p Returns the progress of the operation, NULL if you don't care 01579 @return the current status of the drive. See also burn_drive_status. 01580 */ 01581 enum burn_drive_status burn_drive_get_status(struct burn_drive *drive, 01582 struct burn_progress *p); 01583 01584 /** Creates a write_opts struct for burning to the specified drive. 01585 The returned object must later be freed with burn_write_opts_free(). 01586 @param drive The drive to write with 01587 @return The write_opts, NULL on error 01588 */ 01589 struct burn_write_opts *burn_write_opts_new(struct burn_drive *drive); 01590 01591 01592 /* ts A70901 */ 01593 /** Inquires the drive associated with a burn_write_opts object. 01594 @param opts object to inquire 01595 @return pointer to drive 01596 @since 0.4.0 01597 */ 01598 struct burn_drive *burn_write_opts_get_drive(struct burn_write_opts *opts); 01599 01600 01601 /** Frees a write_opts struct created with burn_write_opts_new 01602 @param opts write_opts to free 01603 */ 01604 void burn_write_opts_free(struct burn_write_opts *opts); 01605 01606 /** Creates a read_opts struct for reading from the specified drive 01607 must be freed with burn_read_opts_free 01608 @param drive The drive to read from 01609 @return The read_opts 01610 */ 01611 struct burn_read_opts *burn_read_opts_new(struct burn_drive *drive); 01612 01613 /** Frees a read_opts struct created with burn_read_opts_new 01614 @param opts write_opts to free 01615 */ 01616 void burn_read_opts_free(struct burn_read_opts *opts); 01617 01618 /** Erase a disc in the drive. The drive must be grabbed successfully BEFORE 01619 calling this functions. Always ensure that the drive reports a status of 01620 BURN_DISC_FULL before calling this function. An erase operation is not 01621 cancellable, as control of the operation is passed wholly to the drive and 01622 there is no way to interrupt it safely. 01623 @param drive The drive with which to erase a disc. 01624 Only drive roles 1 (MMC) and 5 (stdio random write-only) 01625 support erasing. 01626 @param fast Nonzero to do a fast erase, where only the disc's headers are 01627 erased; zero to erase the entire disc. 01628 With DVD-RW, fast blanking yields media capable only of DAO. 01629 */ 01630 void burn_disc_erase(struct burn_drive *drive, int fast); 01631 01632 01633 /* ts A70101 - A70417 */ 01634 /** Format media for use with libburn. This currently applies to DVD-RW 01635 in state "Sequential Recording" (profile 0014h) which get formatted to 01636 state "Restricted Overwrite" (profile 0013h). DVD+RW can be "de-iced" 01637 by setting bit2 of flag. DVD-RAM and BD-RE may get formatted initially 01638 or re-formatted to adjust their Defect Managment. 01639 This function usually returns while the drive is still in the process 01640 of formatting. The formatting is done, when burn_drive_get_status() 01641 returns BURN_DRIVE_IDLE. This may be immediately after return or may 01642 need several thousand seconds to occur. 01643 @param drive The drive with the disc to format. 01644 @param size The size in bytes to be used with the format command. It should 01645 be divisible by 32*1024. The effect of this parameter may 01646 depend on the media profile and on parameter flag. 01647 @param flag Bitfield for control purposes: 01648 bit0= after formatting, write the given number of zero-bytes 01649 to the media and eventually perform preliminary closing. 01650 bit1+2: size mode 01651 0 = use parameter size as far as it makes sense 01652 1 = insist in size 0 even if there is a better default known 01653 (on DVD-RAM or BD-R identical to size mode 0, 01654 i.e. they never get formatted with payload size 0) 01655 2 = without bit7: format to maximum available size 01656 with bit7 : take size from indexed format descriptor 01657 3 = without bit7: format to default size 01658 with bit7 : take size from indexed format descriptor 01659 bit3= -reserved- 01660 bit4= enforce re-format of (partly) formatted media 01661 bit5= try to disable eventual defect management 01662 bit6= try to avoid lengthy media certification 01663 bit7, bit8 to bit15 = 01664 bit7 enables MMC expert application mode (else libburn 01665 tries to choose a suitable format type): 01666 If it is set then bit8 to bit15 contain the index of 01667 the format to use. See burn_disc_get_formats(), 01668 burn_disc_get_format_descr(). 01669 Acceptable types are: 0x00, 0x01, 0x10, 0x11, 0x13, 01670 0x15, 0x26, 0x30, 0x31, 0x32. 01671 If bit7 is set, then bit4 is set automatically. 01672 bit16= enable POW on blank BD-R 01673 @since 0.3.0 01674 */ 01675 void burn_disc_format(struct burn_drive *drive, off_t size, int flag); 01676 01677 01678 /* ts A70112 */ 01679 /* @since 0.3.0 */ 01680 /** Possible formatting status values */ 01681 #define BURN_FORMAT_IS_UNFORMATTED 1 01682 #define BURN_FORMAT_IS_FORMATTED 2 01683 #define BURN_FORMAT_IS_UNKNOWN 3 01684 01685 /* ts A70112 */ 01686 /** Inquire the formatting status, the associated sizes and the number of 01687 available formats. The info is media specific and stems from MMC command 01688 23h READ FORMAT CAPACITY. See mmc5r03c.pdf 6.24 for background details. 01689 Media type can be determined via burn_disc_get_profile(). 01690 @param drive The drive with the disc to format. 01691 @param status The current formatting status of the inserted media. 01692 See BURN_FORMAT_IS_* macros. Note: "unknown" is the 01693 legal status for quick formatted, yet unwritten DVD-RW. 01694 @param size The size in bytes associated with status. 01695 unformatted: the maximum achievable size of the media 01696 formatted: the currently formatted capacity 01697 unknown: maximum capacity of drive or of media 01698 @param bl_sas Additional info "Block Length/Spare Area Size". 01699 Expected to be constantly 2048 for non-BD media. 01700 @param num_formats The number of available formats. To be used with 01701 burn_disc_get_format_descr() to obtain such a format 01702 and eventually with burn_disc_format() to select one. 01703 @return 1 reply is valid , <=0 failure 01704 @since 0.3.0 01705 */ 01706 int burn_disc_get_formats(struct burn_drive *drive, int *status, off_t *size, 01707 unsigned *bl_sas, int *num_formats); 01708 01709 /* ts A70112 */ 01710 /** Inquire parameters of an available media format. 01711 @param drive The drive with the disc to format. 01712 @param index The index of the format item. Beginning with 0 up to reply 01713 parameter from burn_disc_get_formats() : num_formats - 1 01714 @param type The format type. See mmc5r03c.pdf, 6.5, 04h FORMAT UNIT. 01715 0x00=full, 0x10=CD-RW/DVD-RW full, 0x11=CD-RW/DVD-RW grow, 01716 0x15=DVD-RW quick, 0x13=DVD-RW quick grow, 01717 0x26=DVD+RW background, 0x30=BD-RE with spare areas, 01718 0x31=BD-RE without spare areas 01719 @param size The maximum size in bytes achievable with this format. 01720 @param tdp Type Dependent Parameter. See mmc5r03c.pdf. 01721 @return 1 reply is valid , <=0 failure 01722 @since 0.3.0 01723 */ 01724 int burn_disc_get_format_descr(struct burn_drive *drive, int index, 01725 int *type, off_t *size, unsigned *tdp); 01726 01727 01728 01729 /* ts A61109 : this was and is defunct */ 01730 /** Read a disc from the drive and write it to an fd pair. The drive must be 01731 grabbed successfully BEFORE calling this function. Always ensure that the 01732 drive reports a status of BURN_DISC_FULL before calling this function. 01733 @param drive The drive from which to read a disc. 01734 @param o The options for the read operation. 01735 */ 01736 void burn_disc_read(struct burn_drive *drive, const struct burn_read_opts *o); 01737 01738 01739 01740 /* ts A70222 */ 01741 /* @since 0.3.4 */ 01742 /** The length of a rejection reasons string for burn_precheck_write() and 01743 burn_write_opts_auto_write_type() . 01744 */ 01745 #define BURN_REASONS_LEN 4096 01746 01747 01748 /* ts A70219 */ 01749 /** Examines a completed setup for burn_disc_write() whether it is permissible 01750 with drive and media. This function is called by burn_disc_write() but 01751 an application might be interested in this check in advance. 01752 @param o The options for the writing operation. 01753 @param disc The descrition of the disc to be created 01754 @param reasons Eventually returns a list of rejection reason statements 01755 @param silent 1= do not issue error messages , 0= report problems 01756 @return 1 ok, -1= no recordable media detected, 0= other failure 01757 @since 0.3.4 01758 */ 01759 int burn_precheck_write(struct burn_write_opts *o, struct burn_disc *disc, 01760 char reasons[BURN_REASONS_LEN], int silent); 01761 01762 01763 /** Write a disc in the drive. The drive must be grabbed successfully before 01764 calling this function. Always ensure that the drive reports a status of 01765 BURN_DISC_BLANK ot BURN_DISC_APPENDABLE before calling this function. 01766 Note: write_type BURN_WRITE_SAO is currently not capable of writing a mix 01767 of data and audio tracks. You must use BURN_WRITE_TAO for such sessions. 01768 To be set by burn_write_opts_set_write_type(). 01769 Note: This function is not suitable for overwriting data in the middle of 01770 a valid data area because it is allowed to append trailing data. 01771 For exact random access overwriting use burn_random_access_write(). 01772 Note: After writing it is advised to give up the drive and to grab it again 01773 in order to learn about its view on the new media state. 01774 Note: Before mounting the written media it might be necessary to eject 01775 and reload in order to allow the operating system to notice the new 01776 media state. 01777 @param o The options for the writing operation. 01778 @param disc The struct burn_disc * that described the disc to be created 01779 */ 01780 void burn_disc_write(struct burn_write_opts *o, struct burn_disc *disc); 01781 01782 01783 /* ts A90227 */ 01784 /** Control stream recording during the write run and eventually set the start 01785 LBA for stream recording. 01786 Stream recording is set from struct burn_write_opts when the write run 01787 gets started. See burn_write_opts_set_stream_recording(). 01788 The call described here can be used later to override this setting and 01789 to program automatic switching at a given LBA. It also affects subsequent 01790 calls to burn_random_access_write(). 01791 @param drive The drive which performs the write operation. 01792 @param recmode -1= disable stream recording 01793 0= leave setting as is 01794 1= enable stream recording 01795 @param start The LBA where actual stream recording shall start. 01796 (0 means unconditional stream recording) 01797 @param flag Bitfield for control purposes (unused yet, submit 0). 01798 @return 1=success , <=0 failure 01799 @since 0.6.4 01800 */ 01801 int burn_drive_set_stream_recording(struct burn_drive *drive, int recmode, 01802 int start, int flag); 01803 01804 /** Cancel an operation on a drive. 01805 This will only work when the drive's busy state is BURN_DRIVE_READING or 01806 BURN_DRIVE_WRITING. 01807 @param drive The drive on which to cancel the current operation. 01808 */ 01809 void burn_drive_cancel(struct burn_drive *drive); 01810 01811 01812 /* ts A61223 */ 01813 /** Inquire whether the most recent asynchronous media job was successful. 01814 This applies to burn_disc_erase(), burn_disc_format(), burn_disc_write(). 01815 Reasons for non-success may be: rejection of burn parameters, abort due to 01816 fatal errors during write, blank or format, a call to burn_drive_cancel() 01817 by the application thread. 01818 @param d The drive to inquire. 01819 @return 1=burn seems to have went well, 0=burn failed 01820 @since 0.2.6 01821 */ 01822 int burn_drive_wrote_well(struct burn_drive *d); 01823 01824 01825 /* ts B31023 */ 01826 /** Inquire whether a write error occured which is suspected to have happened 01827 due to a false report about DVD-RW capability to be written in write type 01828 BURN_WRITE_TAO. 01829 @param d The drive to inquire. 01830 @return 1= it seems that BURN_WRITE_TAO on DVD-RW caused error, 01831 0= it does not seem so 01832 @since 1.3.4 01833 */ 01834 int burn_drive_was_feat21_failure(struct burn_drive *d); 01835 01836 01837 /** Convert a minute-second-frame (MSF) value to sector count 01838 @param m Minute component 01839 @param s Second component 01840 @param f Frame component 01841 @return The sector count 01842 */ 01843 int burn_msf_to_sectors(int m, int s, int f); 01844 01845 /** Convert a sector count to minute-second-frame (MSF) 01846 @param sectors The sector count 01847 @param m Returns the minute component 01848 @param s Returns the second component 01849 @param f Returns the frame component 01850 */ 01851 void burn_sectors_to_msf(int sectors, int *m, int *s, int *f); 01852 01853 /** Convert a minute-second-frame (MSF) value to an lba 01854 @param m Minute component 01855 @param s Second component 01856 @param f Frame component 01857 @return The lba 01858 */ 01859 int burn_msf_to_lba(int m, int s, int f); 01860 01861 /** Convert an lba to minute-second-frame (MSF) 01862 @param lba The lba 01863 @param m Returns the minute component 01864 @param s Returns the second component 01865 @param f Returns the frame component 01866 */ 01867 void burn_lba_to_msf(int lba, int *m, int *s, int *f); 01868 01869 /** Create a new disc 01870 @return Pointer to a burn_disc object or NULL on failure. 01871 */ 01872 struct burn_disc *burn_disc_create(void); 01873 01874 /** Delete disc and decrease the reference count on all its sessions 01875 @param d The disc to be freed 01876 */ 01877 void burn_disc_free(struct burn_disc *d); 01878 01879 /** Create a new session 01880 @return Pointer to a burn_session object or NULL on failure. 01881 */ 01882 struct burn_session *burn_session_create(void); 01883 01884 /** Free a session (and decrease reference count on all tracks inside) 01885 @param s Session to be freed 01886 */ 01887 void burn_session_free(struct burn_session *s); 01888 01889 /** Add a session to a disc at a specific position, increasing the 01890 sessions's reference count. 01891 @param d Disc to add the session to 01892 @param s Session to add to the disc 01893 @param pos position to add at (BURN_POS_END is "at the end") 01894 @return 0 for failure, 1 for success 01895 */ 01896 int burn_disc_add_session(struct burn_disc *d, struct burn_session *s, 01897 unsigned int pos); 01898 01899 /** Remove a session from a disc 01900 @param d Disc to remove session from 01901 @param s Session pointer to find and remove 01902 */ 01903 int burn_disc_remove_session(struct burn_disc *d, struct burn_session *s); 01904 01905 01906 /* ts B11219 */ 01907 /** Read a CDRWIN cue sheet file and equip the session object by tracks and 01908 CD-TEXT according to the content of the file. 01909 For a description of CDRWIN file format see 01910 http://digitalx.org/cue-sheet/syntax/ 01911 Fully supported commands are: 01912 CATALOG , CDTEXTFILE , FLAGS , INDEX , ISRC , PERFORMER , 01913 POSTGAP , PREGAP , REM , SONGWRITER , TITLE 01914 Further supported commands introduced by cdrecord (usage like PERFORMER): 01915 ARRANGER , COMPOSER , MESSAGE 01916 Partly supported commands are: 01917 FILE which supports only types BINARY , MOTOROLA , WAVE 01918 TRACK which supports only datatypes AUDIO , MODE1/2048 01919 Unsupported types of FILE or TRACK lead to failure of the call. 01920 libburn does not yet support mixing of AUDIO and MODE1/2048. So this call 01921 will fail if such a mix is found. 01922 CD-TEXT information is allowed only if all tracks are of datatype AUDIO. 01923 Empty lines and lines which start by '#' are ignored. 01924 @param session Session where to attach tracks. It must not yet have 01925 tracks or else this call will fail. 01926 @param path Filesystem address of the CDRWIN cue sheet file. 01927 Normally with suffix .cue 01928 @param fifo_size Number of bytes in fifo. This will be rounded up by 01929 the block size of the track mode. <= 0 means no fifo. 01930 @param fifo Returns a reference to the burn_source object that 01931 was installed as fifo between FILE and the track 01932 burn sources. One may use this to inquire the fifo 01933 state. Dispose it by burn_source_free() when no longer 01934 needed. It is permissible to pass this parameter to 01935 libburn as NULL, in order to immediately drop ownership 01936 on the fifo. 01937 @param text_packs Returns pre-formatted CD-TEXT packs resulting from 01938 cue sheet command CDTEXTFILE. To be used with call 01939 burn_write_opts_set_leadin_text(). 01940 It is permissible to pass this parameter to libburn 01941 as NULL, in order to disable CDTEXTFILE. 01942 @param num_packs Returns the number of 18 byte records in text_packs. 01943 @param flag Bitfield for control purposes. 01944 bit0= Do not attach CD-TEXT information to session and 01945 tracks. Do not load text_packs. 01946 bit1= Do not use media catalog string of session or ISRC 01947 strings of tracks for writing to Q sub-channel. 01948 @return > 0 indicates success, <= 0 indicates failure 01949 @since 1.2.0 01950 */ 01951 int burn_session_by_cue_file(struct burn_session *session, 01952 char *path, int fifo_size, struct burn_source **fifo, 01953 unsigned char **text_packs, int *num_packs, int flag); 01954 01955 01956 /** Create a track */ 01957 struct burn_track *burn_track_create(void); 01958 01959 /** Free a track 01960 @param t Track to free 01961 */ 01962 void burn_track_free(struct burn_track *t); 01963 01964 /** Add a track to a session at specified position 01965 @param s Session to add to 01966 @param t Track to insert in session 01967 @param pos position to add at (BURN_POS_END is "at the end") 01968 @return 0 for failure, 1 for success 01969 */ 01970 int burn_session_add_track(struct burn_session *s, struct burn_track *t, 01971 unsigned int pos); 01972 01973 /** Remove a track from a session 01974 @param s Session to remove track from 01975 @param t Track pointer to find and remove 01976 @return 0 for failure, 1 for success 01977 */ 01978 int burn_session_remove_track(struct burn_session *s, struct burn_track *t); 01979 01980 01981 /* ts B20107 */ 01982 /** Set the number which shall be written as CD track number with the first 01983 track of the session. The following tracks will then get written with 01984 consecutive CD track numbers. The resulting number of the last track 01985 must not exceed 99. The lowest possible start number is 1, which is also 01986 the default. This setting applies only to CD SAO writing. 01987 @param session The session to be manipulated 01988 @param tno A number between 1 and 99 01989 @param flag Bitfield for control purposes. Unused yet. Submit 0. 01990 @return > 0 indicates success, <= 0 indicates failure 01991 @since 1.2.0 01992 */ 01993 int burn_session_set_start_tno(struct burn_session *session, int tno, 01994 int flag); 01995 01996 /* ts B20108 */ 01997 /** Inquire the CD track start number, as set by default or by 01998 burn_session_set_start_tno(). 01999 @param session The session to be inquired 02000 @param flag Bitfield for control purposes. Unused yet. Submit 0. 02001 @return > 0 is the currently set CD track start number 02002 <= 0 indicates failure 02003 @since 1.2.0 02004 */ 02005 int burn_session_get_start_tno(struct burn_session *session, int flag); 02006 02007 02008 02009 /* ts B11206 */ 02010 /** Set the Character Codes, the Copyright bytes, and the Language Codes 02011 for CD-TEXT blocks 0 to 7. They will be used in the block summaries 02012 of text packs which get generated from text or binary data submitted 02013 by burn_session_set_cdtext() and burn_track_set_cdtext(). 02014 Character Code value can be 02015 0x00 = ISO-8859-1 02016 0x01 = 7 bit ASCII 02017 0x80 = MS-JIS (japanesei Kanji, double byte characters) 02018 Copyright byte value can be 02019 0x00 = not copyrighted 02020 0x03 = copyrighted 02021 Language Code value will typically be 0x09 = English or 0x69 = Japanese. 02022 See below macros BURN_CDTEXT_LANGUAGES_0X00 and BURN_CDTEXT_LANGUAGES_0X45, 02023 but be aware that many of these codes have never been seen on CD, and that 02024 many of them do not have a character representation among the above 02025 Character Codes. 02026 Default is 0x09 = English for block 0 and 0x00 = Unknown for block 1 to 7. 02027 Copyright and Character Code are 0x00 for all blocks by default. 02028 See also file doc/cdtext.txt, "Format of a CD-TEXT packs array", 02029 "Pack type 0x8f". 02030 02031 Parameter value -1 leaves the current setting of the session parameter 02032 unchanged. 02033 @param s Session where to change settings 02034 @param char_codes Character Codes for block 0 to 7 02035 @param copyrights Copyright bytes for block 0 to 7 02036 @param languages Language Codes for block 0 to 7 02037 @param flag Bitfiled for control purposes. Unused yet. Submit 0. 02038 @return <=0 failure, > 0 success 02039 @since 1.2.0 02040 */ 02041 int burn_session_set_cdtext_par(struct burn_session *s, 02042 int char_codes[8], int copyrights[8], 02043 int languages[8], int flag); 02044 02045 /** This is the first list of languages sorted by their Language codes, 02046 which start at 0x00. They stem from from EBU Tech 3264, appendix 3. 02047 E.g. language 0x00 is "Unknown", 0x08 is "German", 0x10 is "Frisian", 02048 0x18 is "Latvian", 0x20 is "Polish", 0x28 is "Swedish", 0x2b is "Wallon". 02049 See also file doc/cdtext.txt. 02050 @since 1.2.0 02051 */ 02052 #define BURN_CDTEXT_LANGUAGES_0X00 \ 02053 "Unknown", "Albanian", "Breton", "Catalan", \ 02054 "Croatian", "Welsh", "Czech", "Danish", \ 02055 "German", "English", "Spanish", "Esperanto", \ 02056 "Estonian", "Basque", "Faroese", "French", \ 02057 "Frisian", "Irish", "Gaelic", "Galician", \ 02058 "Icelandic", "Italian", "Lappish", "Latin", \ 02059 "Latvian", "Luxembourgian", "Lithuanian", "Hungarian", \ 02060 "Maltese", "Dutch", "Norwegian", "Occitan", \ 02061 "Polish", "Portuguese", "Romanian", "Romansh", \ 02062 "Serbian", "Slovak", "Slovenian", "Finnish", \ 02063 "Swedish", "Turkish", "Flemish", "Wallon" 02064 02065 /** This is the second list of languages sorted by their Language codes, 02066 which start at 0x45. They stem from from EBU Tech 3264, appendix 3. 02067 E.g. language 0x45 is "Zulu", 0x50 is "Sranan Tongo", 0x58 is "Pushtu", 02068 0x60 is "Moldavian", 0x68 is "Kannada", 0x70 is "Greek", 0x78 is "Bengali", 02069 0x7f is "Amharic". 02070 See also file doc/cdtext.txt. 02071 @since 1.2.0 02072 */ 02073 #define BURN_CDTEXT_LANGUAGES_0X45 \ 02074 "Zulu", "Vietnamese", "Uzbek", \ 02075 "Urdu", "Ukrainian", "Thai", "Telugu", \ 02076 "Tatar", "Tamil", "Tadzhik", "Swahili", \ 02077 "Sranan Tongo", "Somali", "Sinhalese", "Shona", \ 02078 "Serbo-croat", "Ruthenian", "Russian", "Quechua", \ 02079 "Pushtu", "Punjabi", "Persian", "Papamiento", \ 02080 "Oriya", "Nepali", "Ndebele", "Marathi", \ 02081 "Moldavian", "Malaysian", "Malagasay", "Macedonian", \ 02082 "Laotian", "Korean", "Khmer", "Kazakh", \ 02083 "Kannada", "Japanese", "Indonesian", "Hindi", \ 02084 "Hebrew", "Hausa", "Gurani", "Gujurati", \ 02085 "Greek", "Georgian", "Fulani", "Dari", \ 02086 "Churash", "Chinese", "Burmese", "Bulgarian", \ 02087 "Bengali", "Bielorussian", "Bambora", "Azerbaijani", \ 02088 "Assamese", "Armenian", "Arabic", "Amharic" 02089 02090 /* This is the list of empty languages names between 0x30 and 0x44. 02091 Together the three macros fill an array of 128 char pointers. 02092 static char *languages[] = { 02093 BURN_CDTEXT_LANGUAGES_0X00, 02094 BURN_CDTEXT_FILLER, 02095 BURN_CDTEXT_LANGUAGES_0X45 02096 }; 02097 */ 02098 #define BURN_CDTEXT_FILLER \ 02099 "", "", "", "", \ 02100 "", "", "", "", \ 02101 "", "", "", "", \ 02102 "", "", "", "", \ 02103 "", "", "", "", \ 02104 "", "", "", "", \ 02105 "" 02106 02107 /* ts B11206 */ 02108 /** Obtain the current settings as of burn_session_set_cdtext_par() resp. 02109 by default. 02110 @param s Session which to inquire 02111 @param char_codes Will return Character Codes for block 0 to 7 02112 @param copyrights Will return Copyright bytes for block 0 to 7 02113 @param block_languages Will return Language Codes for block 0 to 7 02114 @param flag Bitfiled for control purposes. Unused yet. Submit 0. 02115 @return <=0 failure, reply invalid, > 0 success, reply valid 02116 @since 1.2.0 02117 */ 02118 int burn_session_get_cdtext_par(struct burn_session *s, 02119 int char_codes[8], int copyrights[8], 02120 int block_languages[8], int flag); 02121 02122 02123 /* ts B11206 */ 02124 /** Attach text or binary data as CD-TEXT attributes to a session. 02125 They can be used to generate CD-TEXT packs by burn_cdtext_from_session() 02126 or to write CD-TEXT packs into the lead-in of a CD SAO session. 02127 The latter happens only if no array of CD-TEXT packs is attached to 02128 the write options by burn_write_opts_set_leadin_text(). 02129 For details of the CD-TEXT format and of the payload content, see file 02130 doc/cdtext.txt . 02131 @param s Session where to attach CD-TEXT attribute 02132 @param block Number of the language block in which the attribute 02133 shall appear. Possible values: 0 to 7. 02134 @param pack_type Pack type number. 0x80 to 0x8e. Used if pack_type_name 02135 is NULL or empty text. Else submit 0 and a name. 02136 Pack type 0x8f is generated automatically and may not 02137 be set by applications. 02138 @param pack_type_name The pack type by name. Defined names are: 02139 0x80 = "TITLE" 0x81 = "PERFORMER" 02140 0x82 = "SONGWRITER" 0x83 = "COMPOSER" 02141 0x84 = "ARRANGER" 0x85 = "MESSAGE" 02142 0x86 = "DISCID" 0x87 = "GENRE" 02143 0x88 = "TOC" 0x89 = "TOC2" 02144 0x8d = "CLOSED" 0x8e = "UPC_ISRC" 02145 Names are recognized uppercase and lowercase. 02146 @param payload Text or binary bytes. The data will be copied to 02147 session-internal memory. 02148 Pack types 0x80 to 0x85 contain 0-terminated cleartext 02149 encoded according to the block's Character Code. 02150 If double byte characters are used, then two 0-bytes 02151 terminate the cleartext. 02152 Pack type 0x86 is 0-terminated ASCII cleartext. 02153 Pack type 0x87 consists of two byte big-endian 02154 Genre code (see below BURN_CDTEXT_GENRE_LIST), and 02155 0-terminated ASCII cleartext of genre description. 02156 Pack type 0x88 mirrors the session table-of-content. 02157 Pack type 0x89 is not understood yet. 02158 Pack types 0x8a to 0x8c are reserved. 02159 Pack type 0x8d contains ISO-8859-1 cleartext which is 02160 not to be shown by commercial audio CD players. 02161 Pack type 0x8e is ASCII cleartext with UPC/EAN code. 02162 @param length Number of bytes in payload. Including terminating 02163 0-bytes. 02164 @param flag Bitfield for control purposes. 02165 bit0= payload contains double byte characters 02166 (with character code 0x80 MS-JIS japanese Kanji) 02167 @return > 0 indicates success , <= 0 is failure 02168 @since 1.2.0 02169 */ 02170 int burn_session_set_cdtext(struct burn_session *s, int block, 02171 int pack_type, char *pack_type_name, 02172 unsigned char *payload, int length, int flag); 02173 02174 02175 /** This is the list of Genres sorted by their Genre codes. 02176 E.g. genre code 0x0000 is "No Used", 0x0008 is "Dance, 0x0010 is "Musical", 02177 0x0018 is "Rhythm & Blues", 0x001b is "World Music". 02178 See also file doc/cdtext.txt. 02179 @since 1.2.0 02180 */ 02181 #define BURN_CDTEXT_GENRE_LIST \ 02182 "Not Used", "Not Defined", "Adult Contemporary", "Alternative Rock", \ 02183 "Childrens Music", "Classical", "Contemporary Christian", "Country", \ 02184 "Dance", "Easy Listening", "Erotic", "Folk", \ 02185 "Gospel", "Hip Hop", "Jazz", "Latin", \ 02186 "Musical", "New Age", "Opera", "Operetta", \ 02187 "Pop Music", "Rap", "Reggae", "Rock Music", \ 02188 "Rhythm & Blues", "Sound Effects", "Spoken Word", "World Music" 02189 02190 /* The number of genre names in BURN_CDTEXT_GENRE_LIST. 02191 */ 02192 #define BURN_CDTEXT_NUM_GENRES 28 02193 02194 02195 /* ts B11206 */ 02196 /** Obtain a CD-TEXT attribute that was set by burn_session_set_cdtext() 02197 @param s Session to inquire 02198 @param block Number of the language block to inquire. 02199 @param pack_type Pack type number to inquire. Used if pack_type_name 02200 is NULL or empty text. Else submit 0 and a name. 02201 Pack type 0x8f is generated automatically and may not 02202 be inquire in advance. Use burn_cdtext_from_session() 02203 to generate all packs including type 0x8f packs. 02204 @param pack_type_name The pack type by name. 02205 See above burn_session_set_cdtext(). 02206 @param payload Will return a pointer to text or binary bytes. 02207 Not a copy of data. Do not free() this address. 02208 If no text attribute is attached for pack type and 02209 block, then payload is returned as NULL. The return 02210 value will not indicate error in this case. 02211 @param length Will return the number of bytes pointed to by payload. 02212 Including terminating 0-bytes. 02213 @param flag Bitfield for control purposes. Unused yet. Submit 0. 02214 @return 1 single byte char, 2 double byte char, <=0 error 02215 @since 1.2.0 02216 */ 02217 int burn_session_get_cdtext(struct burn_session *s, int block, 02218 int pack_type, char *pack_type_name, 02219 unsigned char **payload, int *length, int flag); 02220 02221 02222 /* ts B11215 */ 02223 /** Read a Sony CD-TEXT Input Sheet Version 0.7T file and attach its text 02224 attributes to the given session and its tracks for the given CD-TEXT 02225 block number. This overrides previous settings made by 02226 burn_session_set_cdtext(), burn_track_set_cdtext(), burn_track_set_isrc(), 02227 burn_session_set_start_tno(). It can later be overridden by said function 02228 calls. 02229 The media catalog number from purpose specifier "UPC / EAN" gets into 02230 effect only if burn_write_opts_set_has_mediacatalog() is set to 0. 02231 The format of a v07t sheet file is documented in doc/cdtext.txt. 02232 @param session Session where to attach CD-TEXT attributes 02233 @param path Local filesystem address of the sheet file which 02234 shall be read and interpreted. 02235 @param block Number of the language block in which the attributes 02236 shall appear. Possible values: 0 to 7. 02237 @param flag Bitfield for control purposes. 02238 bit0= Permission to read multiple blocks from the 02239 given sheet file. Each block is supposed to begin 02240 by a line "Input Sheet Version = 0.7T". Therefore 02241 this permission is only valid if the input file 02242 begins by such a line. 02243 @since 1.3.2 02244 bit1= Do not use media catalog string of session or ISRC 02245 strings of tracks for writing to Q sub-channel. 02246 @since 1.2.0 02247 @return > 0 indicates success and the number of interpreted 02248 blocks (1 if not flag bit0 is set). 02249 <= 0 indicates failure 02250 @since 1.2.0 02251 */ 02252 int burn_session_input_sheet_v07t(struct burn_session *session, 02253 char *path, int block, int flag); 02254 02255 02256 /* ts B11210 */ 02257 /** Produce an array of CD-TEXT packs that could be submitted to 02258 burn_write_opts_set_leadin_text(), or stored as *.cdt file, 02259 or submitted to burn_make_input_sheet_v07t(). 02260 For a description of the format of the array, see file doc/cdtext.txt. 02261 The input data stem from burn_session_set_cdtext_par(), 02262 burn_session_set_cdtext(), and burn_track_set_cdtext(). 02263 @param s Session from which to produce CD-TEXT packs. 02264 @param text_packs Will return the buffer with the CD-TEXT packs. 02265 Dispose by free() when no longer needed. 02266 @param num_packs Will return the number of 18 byte text packs. 02267 @param flag Bitfield for control purposes. 02268 bit0= do not return generated CD-TEXT packs, 02269 but check whether production would work and 02270 indicate the number of packs by the call return 02271 value. This happens also if 02272 (text_packs == NULL || num_packs == NULL). 02273 @return Without flag bit0: > 0 is success, <= 0 failure 02274 With flag bit0: > 0 is number of packs, 02275 0 means no packs will be generated, 02276 < 0 means failure 02277 @since 1.2.0 02278 */ 02279 int burn_cdtext_from_session(struct burn_session *s, 02280 unsigned char **text_packs, int *num_packs, 02281 int flag); 02282 02283 02284 /* ts B30519 */ 02285 /** Convert an array of CD-TEXT packs into the text format of 02286 Sony CD-TEXT Input Sheet Version 0.7T . 02287 02288 @param text_packs Array of bytes which form CD-TEXT packs of 18 bytes 02289 each. For a description of the format of the array, 02290 see file doc/cdtext.txt. 02291 No header of 4 bytes must be prepended which would 02292 tell the number of pack bytes + 2. 02293 This parameter may be NULL if the currently attached 02294 array of packs shall be removed. 02295 @param num_packs The number of 18 byte packs in text_packs. 02296 @param start_tno The start number of track counting, if known from 02297 CD table-of-content or other sources. 02298 Submit 0 to enable the attempt to read it and the 02299 track_count from pack type 0x8f. 02300 @param track_count The number of tracks, if known from CD table-of-content 02301 or orther sources. 02302 @param result Will return the buffer with Sheet text. 02303 Dispose by free() when no longer needed. 02304 It will be filled by the text for the v07t sheet file 02305 plus a trailing 0-byte. (Be aware that double-byte 02306 characters might contain 0-bytes, too.) 02307 Each CD-TEXT language block starts by the line 02308 "Input Sheet Version = 0.7T" 02309 and a "Remarks" line that tells the block number. 02310 @param char_code Returns the character code of the pack array: 02311 0x00 = ISO-8859-1 02312 0x01 = 7 bit ASCII 02313 0x80 = MS-JIS (japanese Kanji, double byte characters) 02314 The presence of a code value that is not in this list 02315 will cause this function to fail. 02316 @param flag Bitfield for control purposes. Unused yet. Submit 0. 02317 @return > 0 tells the number of valid text bytes in result. 02318 This does not include the trailing 0-byte. 02319 <= 0 indicates failure. 02320 @since 1.3.2 02321 */ 02322 int burn_make_input_sheet_v07t(unsigned char *text_packs, int num_packs, 02323 int start_tno, int track_count, 02324 char **result, int *char_code, int flag); 02325 02326 02327 /* ts B11206 */ 02328 /** Remove all CD-TEXT attributes of the given block from the session. 02329 They were attached by burn_session_set_cdtext(). 02330 @param s Session where to remove the CD-TEXT attribute 02331 @param block Number of the language block in which the attribute 02332 shall appear. Possible values: 0 to 7. 02333 -1 causes text packs of all blocks to be removed. 02334 @return > 0 is success, <= 0 failure 02335 @since 1.2.0 02336 */ 02337 int burn_session_dispose_cdtext(struct burn_session *s, int block); 02338 02339 02340 /* ts B11221*/ 02341 /** Read an array of CD-TEXT packs from a file. This array should be suitable 02342 for burn_write_opts_set_leadin_text(). 02343 The function tolerates and removes 4-byte headers as produced by 02344 cdrecord -vv -toc, if this header tells the correct number of bytes which 02345 matches the file size. If no 4-byte header is present, then the function 02346 tolerates and removes a trailing 0-byte as of Sony specs. 02347 @param path Filesystem address of the CD-TEXT pack file. 02348 Normally with suffix .cdt or .dat 02349 @param text_packs Will return the buffer with the CD-TEXT packs. 02350 Dispose by free() when no longer needed. 02351 @param num_packs Will return the number of 18 byte text packs. 02352 @param flag Bitfield for control purposes. Unused yet.Submit 0. 02353 @return 0 is success, <= 0 failure 02354 @since 1.2.0 02355 */ 02356 int burn_cdtext_from_packfile(char *path, unsigned char **text_packs, 02357 int *num_packs, int flag); 02358 02359 02360 /** Define the data in a track 02361 @param t the track to define 02362 @param offset The lib will write this many 0s before start of data 02363 @param tail The number of extra 0s to write after data 02364 @param pad 1 means the lib should pad the last sector with 0s if the 02365 track isn't exactly sector sized. (otherwise the lib will 02366 begin reading from the next track) 02367 @param mode data format (bitfield) 02368 */ 02369 void burn_track_define_data(struct burn_track *t, int offset, int tail, 02370 int pad, int mode); 02371 02372 02373 /* ts B11206 */ 02374 /** Attach text or binary data as CD-TEXT attributes to a track. 02375 The payload will be used to generate CD-TEXT packs by 02376 burn_cdtext_from_session() or to write CD-TEXT packs into the lead-in 02377 of a CD SAO session. This happens if the CD-TEXT attribute of the session 02378 gets generated, which has the same block number and pack type. In this 02379 case, each track should have such a CD-TEXT attribute, too. 02380 See burn_session_set_cdtext(). 02381 Be cautious not to exceed the maximum number of 253 payload packs per 02382 language block. Use burn_cdtext_from_session() to learn whether a valid 02383 array of CD-TEXT packs can be generated from your attributes. 02384 @param t Track where to attach CD-TEXT attribute. 02385 @param block Number of the language block in which the attribute 02386 shall appear. Possible values: 0 to 7. 02387 @param pack_type Pack type number. 0x80 to 0x85 or 0x8e. Used if 02388 pack_type_name is NULL or empty text. Else submit 0 02389 and a name. 02390 @param pack_type_name The pack type by name. Applicable names are: 02391 0x80 = "TITLE" 0x81 = "PERFORMER" 02392 0x82 = "SONGWRITER" 0x83 = "COMPOSER" 02393 0x84 = "ARRANGER" 0x85 = "MESSAGE" 02394 0x8e = "UPC_ISRC" 02395 @param payload 0-terminated cleartext. If double byte characters 02396 are used, then two 0-bytes terminate the cleartext. 02397 @param length Number of bytes in payload. Including terminating 02398 0-bytes. 02399 @param flag Bitfield for control purposes. 02400 bit0= payload contains double byte characters 02401 (with character code 0x80 MS-JIS japanese Kanji) 02402 @return > 0 indicates success , <= 0 is failure 02403 @since 1.2.0 02404 */ 02405 int burn_track_set_cdtext(struct burn_track *t, int block, 02406 int pack_type, char *pack_type_name, 02407 unsigned char *payload, int length, int flag); 02408 02409 /* ts B11206 */ 02410 /** Obtain a CD-TEXT attribute that was set by burn_track_set_cdtext(). 02411 @param t Track to inquire 02412 @param block Number of the language block to inquire. 02413 @param pack_type Pack type number to inquire. Used if pack_type_name 02414 is NULL or empty text. Else submit 0 and a name. 02415 @param pack_type_name The pack type by name. 02416 See above burn_track_set_cdtext(). 02417 @param payload Will return a pointer to text bytes. 02418 Not a copy of data. Do not free() this address. 02419 If no text attribute is attached for pack type and 02420 block, then payload is returned as NULL. The return 02421 value will not indicate error in this case. 02422 @param length Will return the number of bytes pointed to by payload. 02423 Including terminating 0-bytes. 02424 @param flag Bitfield for control purposes. Unused yet. Submit 0. 02425 @return 1=single byte char , 2= double byte char , <=0 error 02426 @since 1.2.0 02427 */ 02428 int burn_track_get_cdtext(struct burn_track *t, int block, 02429 int pack_type, char *pack_type_name, 02430 unsigned char **payload, int *length, int flag); 02431 02432 /* ts B11206 */ 02433 /** Remove all CD-TEXT attributes of the given block from the track. 02434 They were attached by burn_track_set_cdtext(). 02435 @param t Track where to remove the CD-TEXT attribute. 02436 @param block Number of the language block in which the attribute 02437 shall appear. Possible values: 0 to 7. 02438 -1 causes text packs of all blocks to be removed. 02439 @return > 0 is success, <= 0 failure 02440 @since 1.2.0 02441 */ 02442 int burn_track_dispose_cdtext(struct burn_track *t, int block); 02443 02444 02445 /* ts A90910 */ 02446 /** Activates CD XA compatibility modes. 02447 libburn currently writes data only in CD mode 1. Some programs insist in 02448 sending data with additional management bytes. These bytes have to be 02449 stripped in order to make the input suitable for BURN_MODE1. 02450 @param t The track to manipulate 02451 @param value 0= no conversion 02452 1= strip 8 byte sector headers of CD-ROM XA mode 2 form 1 02453 see MMC-5 4.2.3.8.5.3 Block Format for Mode 2 form 1 Data 02454 all other values are reserved 02455 @return 1=success , 0=unacceptable value 02456 @since 0.7.2 02457 */ 02458 int burn_track_set_cdxa_conv(struct burn_track *t, int value); 02459 02460 02461 /** Set the ISRC details for a track. When writing to CD media, ISRC will get 02462 written into the Q sub-channel. 02463 @param t The track to change 02464 @param country the 2 char country code. Each character must be 02465 only numbers or letters. 02466 @param owner 3 char owner code. Each character must be only numbers 02467 or letters. 02468 @param year 2 digit year. A number in 0-99 (Yep, not Y2K friendly). 02469 @param serial 5 digit serial number. A number in 0-99999. 02470 */ 02471 void burn_track_set_isrc(struct burn_track *t, char *country, char *owner, 02472 unsigned char year, unsigned int serial); 02473 02474 /* ts B11226 */ 02475 /** Set the composed ISRC string for a track. This is an alternative to 02476 burn_track_set_isrc(). 02477 @param t The track to be manipulated 02478 @param isrc 12 characters which are composed from ISRC details. 02479 Format is CCOOOYYSSSSS, terminated by a 0-byte: 02480 Country, Owner, Year(decimal digits), Serial(decimal digits). 02481 @param flag Bitfield for control purposes. Unused yet. Submit 0. 02482 @return > 0 indicates success, <= 0 means failure 02483 @since 1.2.0 02484 */ 02485 int burn_track_set_isrc_string(struct burn_track *t, char isrc[13], int flag); 02486 02487 /** Disable ISRC parameters for a track 02488 @param t The track to change 02489 */ 02490 void burn_track_clear_isrc(struct burn_track *t); 02491 02492 02493 /* ts B20103 */ 02494 /** Define an index start address within a track. The index numbers inside a 02495 track have to form sequence starting at 0 or 1 with no gaps up to the 02496 highest number used. They affect only writing of CD SAO sessions. 02497 The first index start address of a track must be 0. 02498 Blocks between index 0 and index 1 are considered to be located before the 02499 track start as of the table-of-content. 02500 @param t The track to be manipulated 02501 @param index_number A number between 0 and 99 02502 @param relative_lba The start address relative to the start of the 02503 burn_source of the track. It will get mapped to the 02504 appropriate absolute block address. 02505 @param flag Bitfield for control purposes. Unused yet. Submit 0. 02506 @return > 0 indicates success, <= 0 means failure 02507 @since 1.2.0 02508 */ 02509 int burn_track_set_index(struct burn_track *t, int index_number, 02510 unsigned int relative_lba, int flag); 02511 02512 /* ts B20103 */ 02513 /** Remove all index start addresses and reset to the default indexing of 02514 CD SAO sessions. This means index 0 of track 1 reaches from LBA -150 02515 to LBA -1. Index 1 of track 1 reaches from LBA 0 to track end. Index 1 02516 of track 2 follows immediately. The same happens for all further tracks 02517 after the end of their predecessor. 02518 @param t The track to be manipulated 02519 @param flag Bitfield for control purposes. Unused yet. Submit 0. 02520 @return > 0 indicates success, <= 0 means failure 02521 @since 1.2.0 02522 */ 02523 int burn_track_clear_indice(struct burn_track *t, int flag); 02524 02525 02526 /* ts B20110 */ 02527 /** Define whether a pre-gap shall be written before the track and how many 02528 sectors this pre-gap shall have. A pre-gap is written in the range of track 02529 index 0 and contains zeros resp. silence. No bytes from the track source 02530 will be read for writing the pre-gap. 02531 This setting affects only CD SAO write runs. 02532 The first track automatically gets a pre-gap of at least 150 sectors. Its 02533 size may be enlarged by this call. Further pre-gaps are demanded by MMC 02534 for tracks which follow tracks of a different mode. (But Mode mixing in 02535 CD SAO sessions is currently not supported by libburn.) 02536 @param t The track to change 02537 @param size Number of sectors in the pre-gap. 02538 -1 disables pre-gap, except for the first track. 02539 libburn allows 0, but MMC does not propose this. 02540 @param flag Bitfield for control purposes. Unused yet. Submit 0. 02541 @return > 0 indicates success, <= 0 means failure 02542 @since 1.2.0 02543 */ 02544 int burn_track_set_pregap_size(struct burn_track *t, int size, int flag); 02545 02546 /* ts B20111 */ 02547 /** Define whether a post-gap shall be written at the end of the track and 02548 how many sectors this gap shall have. A post-gap occupies the range of 02549 an additional index of the track. It contains zeros. No bytes from the 02550 track source will be read for writing the post-gap. 02551 This setting affects only CD SAO write runs. 02552 MMC prescribes to add a post-gap to a data track which is followed by 02553 a non-data track. (But libburn does not yet support mixed mode CD SAO 02554 sessions.) 02555 @param t The track to change 02556 @param size Number of sectors in the post-gap. 02557 -1 disables post-gap. 02558 libburn allows 0, but MMC does not propose this. 02559 @param flag Bitfield for control purposes. Unused yet. Submit 0. 02560 @return > 0 indicates success, <= 0 means failure 02561 @since 1.2.0 02562 */ 02563 int burn_track_set_postgap_size(struct burn_track *t, int size, int flag); 02564 02565 02566 /* ts A61024 */ 02567 /** Define whether a track shall swap bytes of its input stream. 02568 @param t The track to change 02569 @param swap_source_bytes 0=do not swap, 1=swap byte pairs 02570 @return 1=success , 0=unacceptable value 02571 @since 0.2.6 02572 */ 02573 int burn_track_set_byte_swap(struct burn_track *t, int swap_source_bytes); 02574 02575 02576 /** Hide the first track in the "pre gap" of the disc 02577 @param s session to change 02578 @param onoff 1 to enable hiding, 0 to disable 02579 */ 02580 void burn_session_hide_first_track(struct burn_session *s, int onoff); 02581 02582 /** Get the drive's disc struct - free when done 02583 @param d drive to query 02584 @return the disc struct or NULL on failure 02585 */ 02586 struct burn_disc *burn_drive_get_disc(struct burn_drive *d); 02587 02588 /** Set the track's data source 02589 @param t The track to set the data source for 02590 @param s The data source to use for the contents of the track 02591 @return An error code stating if the source is ready for use for 02592 writing the track, or if an error occured 02593 02594 */ 02595 enum burn_source_status burn_track_set_source(struct burn_track *t, 02596 struct burn_source *s); 02597 02598 02599 /* ts A70218 */ 02600 /** Set a default track size to be used only if the track turns out to be of 02601 unpredictable length and if the effective write type demands a fixed size. 02602 This can be useful to enable write types CD SAO or DVD DAO together with 02603 a track source like stdin. If the track source delivers fewer bytes than 02604 announced then the track will be padded up with zeros. 02605 @param t The track to change 02606 @param size The size to set 02607 @return 0=failure 1=sucess 02608 @since 0.3.4 02609 */ 02610 int burn_track_set_default_size(struct burn_track *t, off_t size); 02611 02612 /** Free a burn_source (decrease its refcount and maybe free it) 02613 @param s Source to free 02614 */ 02615 void burn_source_free(struct burn_source *s); 02616 02617 /** Creates a data source for an image file (and maybe subcode file) 02618 @param path The file address for the main channel payload. 02619 @param subpath Eventual address for subchannel data. Only used in exotic 02620 raw write modes. Submit NULL for normal tasks. 02621 @return Pointer to a burn_source object, NULL indicates failure 02622 */ 02623 struct burn_source *burn_file_source_new(const char *path, 02624 const char *subpath); 02625 02626 02627 /* ts A91122 : An interface to open(O_DIRECT) or similar OS tricks. */ 02628 02629 /** Opens a file with eventual acceleration preparations which may depend 02630 on the operating system and on compile time options of libburn. 02631 You may use this call instead of open(2) for opening file descriptors 02632 which shall be handed to burn_fd_source_new(). 02633 This should only be done for tracks with BURN_BLOCK_MODE1 (2048 bytes 02634 per block). 02635 02636 If you use this call then you MUST allocate the buffers which you use 02637 with read(2) by call burn_os_alloc_buffer(). Read sizes MUST be a multiple 02638 of a safe buffer amount. Else you risk that track data get altered during 02639 transmission. 02640 burn_disk_write() will allocate a suitable read/write buffer for its own 02641 operations. A fifo created by burn_fifo_source_new() will allocate 02642 suitable memory for its buffer if called with flag bit0 and a multiple 02643 of a safe buffer amount. 02644 @param path The file address to open 02645 @param open_flags The flags as of man 2 open. Normally just O_RDONLY. 02646 @param flag Bitfield for control purposes (unused yet, submit 0). 02647 @return A file descriptor as of open(2). Finally to be disposed 02648 by close(2). 02649 -1 indicates failure. 02650 @since 0.7.4 02651 */ 02652 int burn_os_open_track_src(char *path, int open_flags, int flag); 02653 02654 /** Allocate a memory area that is suitable for reading with a file descriptor 02655 opened by burn_os_open_track_src(). 02656 @param amount Number of bytes to allocate. This should be a multiple 02657 of the operating system's i/o block size. 32 KB is 02658 guaranteed by libburn to be safe. 02659 @param flag Bitfield for control purposes (unused yet, submit 0). 02660 @return The address of the allocated memory, or NULL on failure. 02661 A non-NULL return value has finally to be disposed via 02662 burn_os_free_buffer(). 02663 @since 0.7.4 02664 */ 02665 void *burn_os_alloc_buffer(size_t amount, int flag); 02666 02667 /** Dispose a memory area which was obtained by burn_os_alloc_buffer(), 02668 @param buffer Memory address to be freed. 02669 @param amount The number of bytes which was allocated at that 02670 address. 02671 @param flag Bitfield for control purposes (unused yet, submit 0). 02672 @return 1 success , <=0 failure 02673 @since 0.7.4 02674 */ 02675 int burn_os_free_buffer(void *buffer, size_t amount, int flag); 02676 02677 02678 /** Creates a data source for an image file (a track) from an open 02679 readable filedescriptor, an eventually open readable subcodes file 02680 descriptor and eventually a fixed size in bytes. 02681 @param datafd The source of data. 02682 @param subfd The eventual source of subchannel data. Only used in exotic 02683 raw write modes. Submit -1 for normal tasks. 02684 @param size The eventual fixed size of eventually both fds. 02685 If this value is 0, the size will be determined from datafd. 02686 @return Pointer to a burn_source object, NULL indicates failure 02687 */ 02688 struct burn_source *burn_fd_source_new(int datafd, int subfd, off_t size); 02689 02690 02691 /* ts B00922 */ 02692 /** Creates an offset source which shall provide a byte interval of a stream 02693 to its consumer. It is supposed to be chain-linked with other offset 02694 sources which serve neighboring consumers. The chronological sequence 02695 of consumers and the sequence of offset sources must match. The intervals 02696 of the sources must not overlap. 02697 02698 A chain of these burn_source objects may be used to feed multiple tracks 02699 from one single stream of input bytes. 02700 Each of the offset sources will skip the bytes up to its start address and 02701 provide the prescribed number of bytes to the track. Skipping takes into 02702 respect the bytes which have been processed by eventual predecessors in the 02703 chain. 02704 Important: It is not allowed to free an offset source before its successor 02705 has ended its work. Best is to keep them all until all tracks 02706 are done. 02707 02708 @param inp The burn_source object from which to read stream data. 02709 E.g. created by burn_file_source_new(). 02710 @param prev The eventual offset source object which shall read data from 02711 inp before the new offset source will begin its own work. 02712 This must either be a result of burn_offst_source_new() or 02713 it must be NULL. 02714 @param start The byte address where to start reading bytes for the 02715 consumer. inp bytes may get skipped to reach this address. 02716 @param size The number of bytes to be delivered to the consumer. 02717 If size is <= 0 then it may be set later by a call of method 02718 set_size(). If it is >= 0, then it can only be changed if 02719 flag bit0 was set with burn_offst_source_new(). 02720 @param flag Bitfield for control purposes 02721 bit0 = Prevent set_size() from overriding interval sizes > 0. 02722 If such a size is already set, then the new one will 02723 only affect the reply of get_size(). 02724 See also above struct burn_source. 02725 @since 1.2.0 02726 @return Pointer to a burn_source object, later to be freed by 02727 burn_source_free(). NULL indicates failure. 02728 @since 0.8.8 02729 */ 02730 struct burn_source *burn_offst_source_new( 02731 struct burn_source *inp, struct burn_source *prev, 02732 off_t start, off_t size, int flag); 02733 02734 /* ts A70930 */ 02735 /** Creates a fifo which acts as proxy for an already existing data source. 02736 The fifo provides a ring buffer which shall smoothen the data stream 02737 between burn_source and writer thread. Each fifo serves only for one 02738 data source. It may be attached to one track as its only data source 02739 by burn_track_set_source(), or it may be used as input for other burn 02740 sources. 02741 A fifo starts its life in "standby" mode with no buffer space allocated. 02742 As soon as its consumer requires bytes, the fifo establishes a worker 02743 thread and allocates its buffer. After input has ended and all buffer 02744 content is consumed, the buffer space gets freed and the worker thread 02745 ends. This happens asynchronously. So expect two buffers and worker threads 02746 to exist for a short time between tracks. Be modest in your size demands if 02747 multiple tracks are to be expected. 02748 @param inp The burn_source for which the fifo shall act as proxy. 02749 It can be disposed by burn_source_free() immediately 02750 after this call. 02751 @param chunksize The size in bytes of a chunk. 02752 Use 2048 for sources suitable for BURN_BLOCK_MODE1, 02753 2352 for sources which deliver for BURN_BLOCK_AUDIO, 02754 2056 for sources which shall get treated by 02755 burn_track_set_cdxa_conv(track, 1). 02756 Some variations of burn_source might work only with 02757 a particular chunksize. E.g. libisofs demands 2048. 02758 @param chunks The number of chunks to be allocated in ring buffer. 02759 This value must be >= 2. 02760 @param flag Bitfield for control purposes: 02761 bit0= The read method of inp is capable of delivering 02762 arbitrary amounts of data per call. Not only one 02763 sector. 02764 Suitable for inp from burn_file_source_new() 02765 and burn_fd_source_new() if not the fd has 02766 exotic limitations on read size. 02767 You MUST use this on inp which uses an fd opened 02768 with burn_os_open_track_src(). 02769 Better do not use with other inp types. 02770 @since 0.7.4 02771 @return A pointer to the newly created burn_source. 02772 Later both burn_sources, inp and the returned fifo, have 02773 to be disposed by calling burn_source_free() for each. 02774 inp can be freed immediately, the returned fifo may be 02775 kept as handle for burn_fifo_inquire_status(). 02776 @since 0.4.0 02777 */ 02778 struct burn_source *burn_fifo_source_new(struct burn_source *inp, 02779 int chunksize, int chunks, int flag); 02780 02781 /* ts A71003 */ 02782 /** Inquires state and fill parameters of a fifo burn_source which was created 02783 by burn_fifo_source_new() . Do not use with other burn_source variants. 02784 @param fifo The fifo object to inquire 02785 @param size The total size of the fifo 02786 @param free_bytes The current free capacity of the fifo 02787 @param status_text Returns a pointer to a constant text, see below 02788 @return <0 reply invalid, >=0 fifo status code: 02789 bit0+1=input status, bit2=consumption status, i.e: 02790 0="standby" : data processing not started yet 02791 1="active" : input and consumption are active 02792 2="ending" : input has ended without error 02793 3="failing" : input had error and ended, 02794 4="unused" : ( consumption has ended before processing start ) 02795 5="abandoned" : consumption has ended prematurely 02796 6="ended" : consumption has ended without input error 02797 7="aborted" : consumption has ended after input error 02798 @since 0.4.0 02799 */ 02800 int burn_fifo_inquire_status(struct burn_source *fifo, int *size, 02801 int *free_bytes, char **status_text); 02802 02803 /* ts A91125 */ 02804 /** Inquire various counters which reflect the fifo operation. 02805 @param fifo The fifo object to inquire 02806 @param total_min_fill The minimum number of bytes in the fifo. Beginning 02807 from the moment when fifo consumption is enabled. 02808 @param interval_min_fill The minimum byte number beginning from the moment 02809 when fifo consumption is enabled or from the 02810 most recent moment when burn_fifo_next_interval() 02811 was called. 02812 @param put_counter The number of data transactions into the fifo. 02813 @param get_counter The number of data transactions out of the fifo. 02814 @param empty_counter The number of times the fifo was empty. 02815 @param full_counter The number of times the fifo was full. 02816 @since 0.7.4 02817 */ 02818 void burn_fifo_get_statistics(struct burn_source *fifo, 02819 int *total_min_fill, int *interval_min_fill, 02820 int *put_counter, int *get_counter, 02821 int *empty_counter, int *full_counter); 02822 02823 /* ts A91125 */ 02824 /** Inquire the fifo minimum fill counter for intervals and reset that counter. 02825 @param fifo The fifo object to inquire 02826 @param interval_min_fill The minimum number of bytes in the fifo. Beginning 02827 from the moment when fifo consumption is enabled 02828 or from the most recent moment when 02829 burn_fifo_next_interval() was called. 02830 @since 0.7.4 02831 */ 02832 void burn_fifo_next_interval(struct burn_source *fifo, int *interval_min_fill); 02833 02834 /* ts A80713 */ 02835 /** Obtain a preview of the first input data of a fifo which was created 02836 by burn_fifo_source_new(). The data will later be delivered normally to 02837 the consumer track of the fifo. 02838 bufsize may not be larger than the fifo size (chunk_size * chunks) - 32k. 02839 This call will succeed only if data consumption by the track has not 02840 started yet, i.e. best before the call to burn_disc_write(). 02841 It will start the worker thread of the fifo with the expectable side 02842 effects on the external data source. Then it waits either until enough 02843 data have arrived or until it becomes clear that this will not happen. 02844 The call may be repeated with increased bufsize. It will always yield 02845 the bytes beginning from the first one in the fifo. 02846 @param fifo The fifo object to inquire resp. start 02847 @param buf Pointer to memory of at least bufsize bytes where to 02848 deliver the peeked data. 02849 @param bufsize Number of bytes to peek from the start of the fifo data 02850 @param flag Bitfield for control purposes (unused yet, submit 0). 02851 @return <0 on severe error, 0 if not enough data, 1 if bufsize bytes read 02852 @since 0.5.0 02853 */ 02854 int burn_fifo_peek_data(struct burn_source *fifo, char *buf, int bufsize, 02855 int flag); 02856 02857 /* ts A91125 */ 02858 /** Start the fifo worker thread and wait either until the requested number 02859 of bytes have arrived or until it becomes clear that this will not happen. 02860 Filling will go on asynchronously after burn_fifo_fill() returned. 02861 This call and burn_fifo_peek_data() do not disturb each other. 02862 @param fifo The fifo object to start 02863 @param fill Number of bytes desired. Expect to get return 1 if 02864 at least fifo size - 32k were read. 02865 @param flag Bitfield for control purposes. 02866 bit0= fill fifo to maximum size 02867 @return <0 on severe error, 0 if not enough data, 02868 1 if desired amount or fifo full 02869 @since 0.7.4 02870 */ 02871 int burn_fifo_fill(struct burn_source *fifo, int fill, int flag); 02872 02873 02874 /* ts A70328 */ 02875 /** Sets a fixed track size after the data source object has already been 02876 created. 02877 @param t The track to operate on 02878 @param size the number of bytes to use as track size 02879 @return <=0 indicates failure , >0 success 02880 @since 0.3.6 02881 */ 02882 int burn_track_set_size(struct burn_track *t, off_t size); 02883 02884 02885 /** Tells how many sectors a track will have on disc, resp. already has on 02886 disc. This includes offset, payload, tail, and post-gap, but not pre-gap. 02887 The result is NOT RELIABLE with tracks of undefined length 02888 */ 02889 int burn_track_get_sectors(struct burn_track *); 02890 02891 02892 /* ts A61101 */ 02893 /** Tells how many source bytes have been read and how many data bytes have 02894 been written by the track during burn. 02895 @param t The track to inquire 02896 @param read_bytes Number of bytes read from the track source 02897 @param written_bytes Number of bytes written to track 02898 @since 0.2.6 02899 */ 02900 int burn_track_get_counters(struct burn_track *t, 02901 off_t *read_bytes, off_t *written_bytes); 02902 02903 02904 /** Sets drive read and write speed 02905 Note: "k" is 1000, not 1024. 1xCD = 176.4 k/s, 1xDVD = 1385 k/s. 02906 Fractional speeds should be rounded up. Like 4xCD = 706. 02907 @param d The drive to set speed for 02908 @param read Read speed in k/s (0 is max, -1 is min). 02909 @param write Write speed in k/s (0 is max, -1 is min). 02910 */ 02911 void burn_drive_set_speed(struct burn_drive *d, int read, int write); 02912 02913 02914 /* ts A70711 */ 02915 /** Controls the behavior with writing when the drive buffer is suspected to 02916 be full. To check and wait for enough free buffer space before writing 02917 will move the task of waiting from the operating system's device driver 02918 to libburn. While writing is going on and waiting is enabled, any write 02919 operation will be checked whether it will fill the drive buffer up to 02920 more than max_percent. If so, then waiting will happen until the buffer 02921 fill is predicted with at most min_percent. 02922 Thus: if min_percent < max_percent then transfer rate will oscillate. 02923 This may allow the driver to operate on other devices, e.g. a disk from 02924 which to read the input for writing. On the other hand, this checking might 02925 reduce maximum throughput to the drive or even get misled by faulty buffer 02926 fill replies from the drive. 02927 If a setting parameter is < 0, then this setting will stay unchanged 02928 by the call. 02929 Known burner or media specific pitfalls: 02930 To have max_percent larger than the burner's best reported buffer fill has 02931 the same effect as min_percent==max_percent. Some burners do not report 02932 their full buffer with all media types. Some are not suitable because 02933 they report their buffer fill with delay. 02934 @param d The drive to control 02935 @param enable 0= disable , 1= enable waiting , (-1 = do not change setting) 02936 @param min_usec Shortest possible sleeping period (given in micro seconds) 02937 @param max_usec Longest possible sleeping period (given in micro seconds) 02938 @param timeout_sec If a single write has to wait longer than this number 02939 of seconds, then waiting gets disabled and mindless 02940 writing starts. A value of 0 disables this timeout. 02941 @param min_percent Minimum of desired buffer oscillation: 25 to 100 02942 @param max_percent Maximum of desired buffer oscillation: 25 to 100 02943 @return 1=success , 0=failure 02944 @since 0.3.8 02945 */ 02946 int burn_drive_set_buffer_waiting(struct burn_drive *d, int enable, 02947 int min_usec, int max_usec, int timeout_sec, 02948 int min_percent, int max_percent); 02949 02950 02951 /* these are for my [Derek Foreman's ?] debugging, they will disappear */ 02952 /* ts B11012 : 02953 Of course, API symbols will not disappear. But these functions are of 02954 few use, as they only print DEBUG messages. 02955 */ 02956 void burn_structure_print_disc(struct burn_disc *d); 02957 void burn_structure_print_session(struct burn_session *s); 02958 void burn_structure_print_track(struct burn_track *t); 02959 02960 /** Sets the write type for the write_opts struct. 02961 Note: write_type BURN_WRITE_SAO is currently not capable of writing a mix 02962 of data and audio tracks. You must use BURN_WRITE_TAO for such sessions. 02963 @param opts The write opts to change 02964 @param write_type The write type to use 02965 @param block_type The block type to use 02966 @return Returns 1 on success and 0 on failure. 02967 */ 02968 int burn_write_opts_set_write_type(struct burn_write_opts *opts, 02969 enum burn_write_types write_type, 02970 int block_type); 02971 02972 02973 /* ts A70207 */ 02974 /** As an alternative to burn_write_opts_set_write_type() this function tries 02975 to find a suitable write type and block type for a given write job 02976 described by opts and disc. To be used after all other setups have been 02977 made, i.e. immediately before burn_disc_write(). 02978 @param opts The nearly complete write opts to change 02979 @param disc The already composed session and track model 02980 @param reasons This text string collects reasons for decision resp. failure 02981 @param flag Bitfield for control purposes: 02982 bit0= do not choose type but check the one that is already set 02983 bit1= do not issue error messages via burn_msgs queue 02984 (is automatically set with bit0) 02985 @return Chosen write type. BURN_WRITE_NONE on failure. 02986 @since 0.3.2 02987 */ 02988 enum burn_write_types burn_write_opts_auto_write_type( 02989 struct burn_write_opts *opts, struct burn_disc *disc, 02990 char reasons[BURN_REASONS_LEN], int flag); 02991 02992 02993 /** Supplies toc entries for writing - not normally required for cd mastering 02994 @param opts The write opts to change 02995 @param count The number of entries 02996 @param toc_entries 02997 */ 02998 void burn_write_opts_set_toc_entries(struct burn_write_opts *opts, 02999 int count, 03000 struct burn_toc_entry *toc_entries); 03001 03002 /** Sets the session format for a disc 03003 @param opts The write opts to change 03004 @param format The session format to set 03005 */ 03006 void burn_write_opts_set_format(struct burn_write_opts *opts, int format); 03007 03008 /** Sets the simulate value for the write_opts struct . 03009 This corresponds to the Test Write bit in MMC mode page 05h. Several media 03010 types do not support this. See struct burn_multi_caps.might_simulate for 03011 actual availability of this feature. 03012 If the media is suitable, the drive will perform burn_disc_write() as a 03013 simulation instead of effective write operations. This means that the 03014 media content and burn_disc_get_status() stay unchanged. 03015 Note: With stdio-drives, the target file gets eventually created, opened, 03016 lseeked, and closed, but not written. So there are effects on it. 03017 Warning: Call burn_random_access_write() will never do simulation because 03018 it does not get any burn_write_opts. 03019 @param opts The write opts to change 03020 @param sim Non-zero enables simulation, 0 enables real writing 03021 @return Returns 1 on success and 0 on failure. 03022 */ 03023 int burn_write_opts_set_simulate(struct burn_write_opts *opts, int sim); 03024 03025 /** Controls buffer underrun prevention. This is only needed with CD media 03026 and possibly with old DVD-R drives. All other media types are not 03027 vulnerable to burn failure due to buffer underrun. 03028 @param opts The write opts to change 03029 @param underrun_proof if non-zero, buffer underrun protection is enabled 03030 @return Returns 1 if the drive announces to be capable of underrun 03031 prevention, 03032 Returns 0 if not. 03033 */ 03034 int burn_write_opts_set_underrun_proof(struct burn_write_opts *opts, 03035 int underrun_proof); 03036 03037 /** Sets whether to use opc or not with the write_opts struct 03038 @param opts The write opts to change 03039 @param opc If non-zero, optical power calibration will be performed at 03040 start of burn 03041 03042 */ 03043 void burn_write_opts_set_perform_opc(struct burn_write_opts *opts, int opc); 03044 03045 03046 /** The Q sub-channel of a CD may contain a Media Catalog Number of 13 decimal 03047 digits. This call sets the string of digits, but does not yet activate it 03048 for writing. 03049 @param opts The write opts to change 03050 @param mediacatalog The 13 decimal digits as ASCII bytes. I.e. '0' = 0x30. 03051 */ 03052 void burn_write_opts_set_mediacatalog(struct burn_write_opts *opts, 03053 unsigned char mediacatalog[13]); 03054 03055 /** This call activates the Media Catalog Number for writing. The digits of 03056 that number have to be set by call burn_write_opts_set_mediacatalog(). 03057 @param opts The write opts to change 03058 @param has_mediacatalog 1= activate writing of catalog to Q sub-channel 03059 0= deactivate it 03060 */ 03061 void burn_write_opts_set_has_mediacatalog(struct burn_write_opts *opts, 03062 int has_mediacatalog); 03063 03064 03065 /* ts A61106 */ 03066 /** Sets the multi flag which eventually marks the emerging session as not 03067 being the last one and thus creating a BURN_DISC_APPENDABLE media. 03068 Note: DVD-R[W] in write mode BURN_WRITE_SAO are not capable of this. 03069 DVD-R DL are not capable of this at all. 03070 libburn will refuse to write if burn_write_opts_set_multi() is 03071 enabled under such conditions. 03072 @param opts The option object to be manipulated 03073 @param multi 1=media will be appendable, 0=media will be closed (default) 03074 @since 0.2.6 03075 */ 03076 void burn_write_opts_set_multi(struct burn_write_opts *opts, int multi); 03077 03078 03079 /* ts B31024 */ 03080 /** Set the severity to be used with write error messages which are potentially 03081 caused by not using write type BURN_WRITE_SAO on fast blanked DVD-RW. 03082 03083 Normally the call burn_write_opts_auto_write_type() can prevent such 03084 errors by looking for MMC feature 21h "Incremental Streaming Writable" 03085 which anounnces the capability for BURN_WRITE_TAO and multi session. 03086 Regrettable many drives announce feature 21h even if they only can do 03087 BURN_WRITE_SAO. This mistake becomes obvious by an early write error. 03088 03089 If you plan to call burn_drive_was_feat21_failure() and to repeat the 03090 burn attempt with BURN_WRITE_SAO, then set the severity of the error 03091 message low enough, so that the application does not see reason to abort. 03092 03093 @param opts The option object to be manipulated 03094 @param severity Severity as with burn_msgs_set_severities(). 03095 "ALL" or empty text means the default severity that 03096 is attributed to other kinds of write errors. 03097 */ 03098 void burn_write_opts_set_fail21h_sev(struct burn_write_opts *opts, 03099 char *severity); 03100 03101 /* ts B11204 */ 03102 /** Submit an array of CD-TEXT packs which shall be written to the Lead-in 03103 of a SAO write run on CD. 03104 @param opts The option object to be manipulated 03105 @param text_packs Array of bytes which form CD-TEXT packs of 18 bytes 03106 each. For a description of the format of the array, 03107 see file doc/cdtext.txt. 03108 No header of 4 bytes must be prepended which would 03109 tell the number of pack bytes + 2. 03110 This parameter may be NULL if the currently attached 03111 array of packs shall be removed. 03112 @param num_packs The number of 18 byte packs in text_packs. 03113 This parameter may be 0 if the currently attached 03114 array of packs shall be removed. 03115 @param flag Bitfield for control purposes. 03116 bit0= do not verify checksums 03117 bit1= repair mismatching checksums 03118 bit2= repair checksums if they are 00 00 with each pack 03119 @return 1 on success, <= 0 on failure 03120 @since 1.2.0 03121 */ 03122 int burn_write_opts_set_leadin_text(struct burn_write_opts *opts, 03123 unsigned char *text_packs, 03124 int num_packs, int flag); 03125 03126 03127 /* ts A61222 */ 03128 /** Sets a start address for writing to media and write modes which allow to 03129 choose this address at all (for now: DVD+RW, DVD-RAM, formatted DVD-RW). 03130 now). The address is given in bytes. If it is not -1 then a write run 03131 will fail if choice of start address is not supported or if the block 03132 alignment of the address is not suitable for media and write mode. 03133 Alignment to 32 kB blocks is supposed to be safe with DVD media. 03134 Call burn_disc_get_multi_caps() can obtain the necessary media info. See 03135 resulting struct burn_multi_caps elements .start_adr , .start_alignment , 03136 .start_range_low , .start_range_high . 03137 @param opts The write opts to change 03138 @param value The address in bytes (-1 = start at default address) 03139 @since 0.3.0 03140 */ 03141 void burn_write_opts_set_start_byte(struct burn_write_opts *opts, off_t value); 03142 03143 03144 /* ts A70213 */ 03145 /** Caution: still immature and likely to change. Problems arose with 03146 sequential DVD-RW on one drive. 03147 03148 Controls whether the whole available space of the media shall be filled up 03149 by the last track of the last session. 03150 @param opts The write opts to change 03151 @param fill_up_media If 1 : fill up by last track, if 0 = do not fill up 03152 @since 0.3.4 03153 */ 03154 void burn_write_opts_set_fillup(struct burn_write_opts *opts, 03155 int fill_up_media); 03156 03157 03158 /* ts A70303 */ 03159 /** Eventually makes libburn ignore the failure of some conformance checks: 03160 - the check whether CD write+block type is supported by the drive 03161 - the check whether the media profile supports simulated burning 03162 @param opts The write opts to change 03163 @param use_force 1=ignore above checks, 0=refuse work on failed check 03164 @since 0.3.4 03165 */ 03166 void burn_write_opts_set_force(struct burn_write_opts *opts, int use_force); 03167 03168 03169 /* ts A80412 */ 03170 /** Eventually makes use of the more modern write command AAh WRITE12 and 03171 sets the Streaming bit. With DVD-RAM and BD this can override the 03172 traditional slowdown to half nominal speed. But if it speeds up writing 03173 then it also disables error management and correction. Weigh your 03174 priorities. This affects the write operations of burn_disc_write() 03175 and subsequent calls of burn_random_access_write(). 03176 @param opts The write opts to change 03177 @param value 0=use 2Ah WRITE10, 1=use AAh WRITE12 with Streaming bit 03178 @since 0.6.4: 03179 >=16 use WRITE12 but not before the LBA given by value 03180 @since 0.4.6 03181 */ 03182 void burn_write_opts_set_stream_recording(struct burn_write_opts *opts, 03183 int value); 03184 03185 /* ts A91115 */ 03186 /** Overrides the write chunk size for DVD and BD media which is normally 03187 determined according to media type and setting of stream recording. 03188 A chunk size of 64 KB may improve throughput with bus systems which show 03189 latency problems. 03190 @param opts The write opts to change 03191 @param obs Number of bytes which shall be sent by a single write command. 03192 0 means automatic size, 32768 and 65336 are the only other 03193 accepted sizes for now. 03194 @since 0.7.4 03195 */ 03196 void burn_write_opts_set_dvd_obs(struct burn_write_opts *opts, int obs); 03197 03198 03199 /* ts B20406 */ 03200 /** Overrides the automatic decision whether to pad up the last write chunk to 03201 its full size. This applies to DVD, BD and stdio: pseudo-drives. 03202 Note: This override may get enabled fixely already at compile time by 03203 defining macro Libburn_dvd_always_obs_paD . 03204 @param opts The write opts to change 03205 @param pad 1 means to pad up in any case, 0 means automatic decision. 03206 @since 1.2.4 03207 */ 03208 void burn_write_opts_set_obs_pad(struct burn_write_opts *opts, int pad); 03209 03210 03211 /* ts A91115 */ 03212 /** Sets the rythm by which stdio pseudo drives force their output data to 03213 be consumed by the receiving storage device. This forcing keeps the memory 03214 from being clogged with lots of pending data for slow devices. 03215 @param opts The write opts to change 03216 @param rythm Number of 2KB output blocks after which fsync(2) is 03217 performed. -1 means no fsync(), 0 means default, 03218 elsewise the value must be >= 32. 03219 Default is currently 8192 = 16 MB. 03220 @since 0.7.4 03221 */ 03222 void burn_write_opts_set_stdio_fsync(struct burn_write_opts *opts, int rythm); 03223 03224 03225 /** Sets whether to read in raw mode or not 03226 @param opts The read opts to change 03227 @param raw_mode If non-zero, reading will be done in raw mode, so that everything in the data tracks on the 03228 disc is read, including headers. 03229 */ 03230 void burn_read_opts_set_raw(struct burn_read_opts *opts, int raw_mode); 03231 03232 /** Sets whether to report c2 errors or not 03233 @param opts The read opts to change 03234 @param c2errors If non-zero, report c2 errors. 03235 */ 03236 void burn_read_opts_set_c2errors(struct burn_read_opts *opts, int c2errors); 03237 03238 /** Sets whether to read subcodes from audio tracks or not 03239 @param opts The read opts to change 03240 @param subcodes_audio If non-zero, read subcodes from audio tracks on the disc. 03241 */ 03242 void burn_read_opts_read_subcodes_audio(struct burn_read_opts *opts, 03243 int subcodes_audio); 03244 03245 /** Sets whether to read subcodes from data tracks or not 03246 @param opts The read opts to change 03247 @param subcodes_data If non-zero, read subcodes from data tracks on the disc. 03248 */ 03249 void burn_read_opts_read_subcodes_data(struct burn_read_opts *opts, 03250 int subcodes_data); 03251 03252 /** Sets whether to recover errors if possible 03253 @param opts The read opts to change 03254 @param hardware_error_recovery If non-zero, attempt to recover errors if possible. 03255 */ 03256 void burn_read_opts_set_hardware_error_recovery(struct burn_read_opts *opts, 03257 int hardware_error_recovery); 03258 03259 /** Sets whether to report recovered errors or not 03260 @param opts The read opts to change 03261 @param report_recovered_errors If non-zero, recovered errors will be reported. 03262 */ 03263 void burn_read_opts_report_recovered_errors(struct burn_read_opts *opts, 03264 int report_recovered_errors); 03265 03266 /** Sets whether blocks with unrecoverable errors should be read or not 03267 @param opts The read opts to change 03268 @param transfer_damaged_blocks If non-zero, blocks with unrecoverable errors will still be read. 03269 */ 03270 void burn_read_opts_transfer_damaged_blocks(struct burn_read_opts *opts, 03271 int transfer_damaged_blocks); 03272 03273 /** Sets the number of retries to attempt when trying to correct an error 03274 @param opts The read opts to change 03275 @param hardware_error_retries The number of retries to attempt when correcting an error. 03276 */ 03277 void burn_read_opts_set_hardware_error_retries(struct burn_read_opts *opts, 03278 unsigned char hardware_error_retries); 03279 03280 03281 /* ts A90815 */ 03282 /** Gets the list of profile codes supported by the drive. 03283 Profiles depict the feature sets which constitute media types. For 03284 known profile codes and names see burn_disc_get_profile(). 03285 @param d is the drive to query 03286 @param num_profiles returns the number of supported profiles 03287 @param profiles returns the profile codes 03288 @param is_current returns the status of the corresponding profile code: 03289 1= current, i.e. the matching media is loaded 03290 0= not current, i.e. the matching media is not loaded 03291 @return always 1 for now 03292 @since 0.7.0 03293 */ 03294 int burn_drive_get_all_profiles(struct burn_drive *d, int *num_profiles, 03295 int profiles[64], char is_current[64]); 03296 03297 03298 /* ts A90815 */ 03299 /** Obtains the profile name associated with a profile code. 03300 @param profile_code the profile code to be translated 03301 @param name returns the profile name (e.g. "DVD+RW") 03302 @return 1= known profile code , 0= unknown profile code 03303 @since 0.7.0 03304 */ 03305 int burn_obtain_profile_name(int profile_code, char name[80]); 03306 03307 03308 /** Gets the maximum write speed for a drive and eventually loaded media. 03309 The return value might change by the media type of already loaded media, 03310 again by call burn_drive_grab() and again by call burn_disc_read_atip(). 03311 @param d Drive to query 03312 @return Maximum write speed in K/s 03313 */ 03314 int burn_drive_get_write_speed(struct burn_drive *d); 03315 03316 03317 /* ts A61021 */ 03318 /** Gets the minimum write speed for a drive and eventually loaded media. 03319 The return value might change by the media type of already loaded media, 03320 again by call burn_drive_grab() and again by call burn_disc_read_atip(). 03321 @param d Drive to query 03322 @return Minimum write speed in K/s 03323 @since 0.2.6 03324 */ 03325 int burn_drive_get_min_write_speed(struct burn_drive *d); 03326 03327 03328 /** Gets the maximum read speed for a drive 03329 @param d Drive to query 03330 @return Maximum read speed in K/s 03331 */ 03332 int burn_drive_get_read_speed(struct burn_drive *d); 03333 03334 03335 /* ts A61226 */ 03336 /** Obtain a copy of the current speed descriptor list. The drive's list gets 03337 updated on various occasions such as burn_drive_grab() but the copy 03338 obtained here stays untouched. It has to be disposed via 03339 burn_drive_free_speedlist() when it is not longer needed. Speeds 03340 may appear several times in the list. The list content depends much on 03341 drive and media type. It seems that .source == 1 applies mostly to CD media 03342 whereas .source == 2 applies to any media. 03343 @param d Drive to query 03344 @param speed_list The copy. If empty, *speed_list gets returned as NULL. 03345 @return 1=success , 0=list empty , <0 severe error 03346 @since 0.3.0 03347 */ 03348 int burn_drive_get_speedlist(struct burn_drive *d, 03349 struct burn_speed_descriptor **speed_list); 03350 03351 /* ts A70713 */ 03352 /** Look up the fastest speed descriptor which is not faster than the given 03353 speed_goal. If it is 0, then the fastest one is chosen among the 03354 descriptors with the highest end_lba. If it is -1 then the slowest speed 03355 descriptor is chosen regardless of end_lba. Parameter flag decides whether 03356 the speed goal means write speed or read speed. 03357 @param d Drive to query 03358 @param speed_goal Upper limit for speed, 03359 0=search for maximum speed , -1 search for minimum speed 03360 @param best_descr Result of the search, NULL if no match 03361 @param flag Bitfield for control purposes 03362 bit0= look for best read speed rather than write speed 03363 bit1= look for any source type (else look for source==2 first 03364 and for any other source type only with CD media) 03365 @return >0 indicates a valid best_descr, 0 = no valid best_descr 03366 @since 0.3.8 03367 */ 03368 int burn_drive_get_best_speed(struct burn_drive *d, int speed_goal, 03369 struct burn_speed_descriptor **best_descr, int flag); 03370 03371 03372 /* ts A61226 */ 03373 /** Dispose a speed descriptor list copy which was obtained by 03374 burn_drive_get_speedlist(). 03375 @param speed_list The list copy. *speed_list gets set to NULL. 03376 @return 1=list disposed , 0= *speedlist was already NULL 03377 @since 0.3.0 03378 */ 03379 int burn_drive_free_speedlist(struct burn_speed_descriptor **speed_list); 03380 03381 03382 /* ts A70203 */ 03383 /* @since 0.3.2 */ 03384 /** The reply structure for burn_disc_get_multi_caps() 03385 */ 03386 struct burn_multi_caps { 03387 03388 /* Multi-session capability allows to keep the media appendable after 03389 writing a session. It also guarantees that the drive will be able 03390 to predict and use the appropriate Next Writeable Address to place 03391 the next session on the media without overwriting the existing ones. 03392 It does not guarantee that the selected write type is able to do 03393 an appending session after the next session. (E.g. CD SAO is capable 03394 of multi-session by keeping a disc appendable. But .might_do_sao 03395 will be 0 afterwards, when checking the appendable media.) 03396 1= media may be kept appendable by burn_write_opts_set_multi(o,1) 03397 0= media will not be appendable 03398 */ 03399 int multi_session; 03400 03401 /* Multi-track capability allows to write more than one track source 03402 during a single session. The written tracks can later be found in 03403 libburn's TOC model with their start addresses and sizes. 03404 1= multiple tracks per session are allowed 03405 0= only one track per session allowed 03406 */ 03407 int multi_track; 03408 03409 /* Start-address capability allows to set a non-zero address with 03410 burn_write_opts_set_start_byte(). Eventually this has to respect 03411 .start_alignment and .start_range_low, .start_range_high in this 03412 structure. 03413 1= non-zero start address is allowed 03414 0= only start address 0 is allowed (to depict the drive's own idea 03415 about the appropriate write start) 03416 */ 03417 int start_adr; 03418 03419 /** The alignment for start addresses. 03420 ( start_address % start_alignment ) must be 0. 03421 */ 03422 off_t start_alignment; 03423 03424 /** The lowest permissible start address. 03425 */ 03426 off_t start_range_low; 03427 03428 /** The highest addressable start address. 03429 */ 03430 off_t start_range_high; 03431 03432 /** Potential availability of write modes 03433 4= needs no size prediction, not to be chosen automatically 03434 3= needs size prediction, not to be chosen automatically 03435 2= available, no size prediction necessary 03436 1= available, needs exact size prediction 03437 0= not available 03438 With CD media (profiles 0x09 and 0x0a) check also the elements 03439 *_block_types of the according write mode. 03440 */ 03441 int might_do_tao; 03442 int might_do_sao; 03443 int might_do_raw; 03444 03445 /** Generally advised write mode. 03446 Not necessarily the one chosen by burn_write_opts_auto_write_type() 03447 because the burn_disc structure might impose particular demands. 03448 */ 03449 enum burn_write_types advised_write_mode; 03450 03451 /** Write mode as given by parameter wt of burn_disc_get_multi_caps(). 03452 */ 03453 enum burn_write_types selected_write_mode; 03454 03455 /** Profile number which was current when the reply was generated */ 03456 int current_profile; 03457 03458 /** Wether the current profile indicates CD media. 1=yes, 0=no */ 03459 int current_is_cd_profile; 03460 03461 /* ts A70528 */ 03462 /* @since 0.3.8 */ 03463 /** Wether the current profile is able to perform simulated write */ 03464 int might_simulate; 03465 }; 03466 03467 /** Allocates a struct burn_multi_caps (see above) and fills it with values 03468 which are appropriate for the drive and the loaded media. The drive 03469 must be grabbed for this call. The returned structure has to be disposed 03470 via burn_disc_free_multi_caps() when no longer needed. 03471 @param d The drive to inquire 03472 @param wt With BURN_WRITE_NONE the best capabilities of all write modes 03473 get returned. If set to a write mode like BURN_WRITE_SAO the 03474 capabilities with that particular mode are returned and the 03475 return value is 0 if the desired mode is not possible. 03476 @param caps returns the info structure 03477 @param flag Bitfield for control purposes (unused yet, submit 0) 03478 @return < 0 : error , 0 : writing seems impossible , 1 : writing possible 03479 @since 0.3.2 03480 */ 03481 int burn_disc_get_multi_caps(struct burn_drive *d, enum burn_write_types wt, 03482 struct burn_multi_caps **caps, int flag); 03483 03484 /** Removes from memory a multi session info structure which was returned by 03485 burn_disc_get_multi_caps(). The pointer *caps gets set to NULL. 03486 @param caps the info structure to dispose (note: pointer to pointer) 03487 @return 0 : *caps was already NULL, 1 : memory object was disposed 03488 @since 0.3.2 03489 */ 03490 int burn_disc_free_multi_caps(struct burn_multi_caps **caps); 03491 03492 03493 /** Gets a copy of the toc_entry structure associated with a track 03494 @param t Track to get the entry from 03495 @param entry Struct for the library to fill out 03496 */ 03497 void burn_track_get_entry(struct burn_track *t, struct burn_toc_entry *entry); 03498 03499 /** Gets a copy of the toc_entry structure associated with a session's lead out 03500 @param s Session to get the entry from 03501 @param entry Struct for the library to fill out 03502 */ 03503 void burn_session_get_leadout_entry(struct burn_session *s, 03504 struct burn_toc_entry *entry); 03505 03506 /** Gets an array of all complete sessions for the disc 03507 THIS IS NO LONGER VALID AFTER YOU ADD OR REMOVE A SESSION 03508 The result array contains *num + burn_disc_get_incomplete_sessions() 03509 elements. All above *num are incomplete sessions. 03510 Typically there is at most one incomplete session with one empty track. 03511 DVD+R and BD-R seem to allow more than one track with even readable data. 03512 @param d Disc to get session array for 03513 @param num Returns the number of sessions in the array 03514 @return array of sessions 03515 */ 03516 struct burn_session **burn_disc_get_sessions(struct burn_disc *d, 03517 int *num); 03518 03519 /* ts B30112 */ 03520 /* @since 1.2.8 */ 03521 /** Obtains the number of incomplete sessions which are recorded in the 03522 result array of burn_disc_get_sessions() after the complete sessions. 03523 See above. 03524 @param d Disc object to inquire 03525 @return Number of incomplete sessions 03526 */ 03527 int burn_disc_get_incomplete_sessions(struct burn_disc *d); 03528 03529 03530 int burn_disc_get_sectors(struct burn_disc *d); 03531 03532 /** Gets an array of all the tracks for a session 03533 THIS IS NO LONGER VALID AFTER YOU ADD OR REMOVE A TRACK 03534 @param s session to get track array for 03535 @param num Returns the number of tracks in the array 03536 @return array of tracks 03537 */ 03538 struct burn_track **burn_session_get_tracks(struct burn_session *s, 03539 int *num); 03540 03541 int burn_session_get_sectors(struct burn_session *s); 03542 03543 /** Gets the mode of a track 03544 @param track the track to query 03545 @return the track's mode 03546 */ 03547 int burn_track_get_mode(struct burn_track *track); 03548 03549 /** Returns whether the first track of a session is hidden in the pregap 03550 @param session the session to query 03551 @return non-zero means the first track is hidden 03552 */ 03553 int burn_session_get_hidefirst(struct burn_session *session); 03554 03555 /** Returns the library's version in its parts. 03556 This is the runtime counterpart of the three build time macros 03557 burn_header_version_* below. 03558 @param major The major version number 03559 @param minor The minor version number 03560 @param micro The micro version number 03561 */ 03562 void burn_version(int *major, int *minor, int *micro); 03563 03564 03565 /* ts A80129 */ 03566 /* @since 0.4.4 */ 03567 /** These three release version numbers tell the revision of this header file 03568 and of the API it describes. They are memorized by applications at build 03569 time. 03570 Immediately after burn_initialize() an application should do this check: 03571 burn_version(&major, &minor, µ); 03572 if(major > burn_header_version_major 03573 || (major == burn_header_version_major 03574 && (minor > burn_header_version_minor 03575 || (minor == burn_header_version_minor 03576 && micro >= burn_header_version_micro)))) { 03577 ... Young enough. Go on with program run .... 03578 } else { 03579 ... Too old. Do not use this libburn version ... 03580 } 03581 03582 */ 03583 #define burn_header_version_major 1 03584 #define burn_header_version_minor 3 03585 #define burn_header_version_micro 4 03586 /** Note: 03587 Above version numbers are also recorded in configure.ac because libtool 03588 wants them as parameters at build time. 03589 For the library compatibility check, BURN_*_VERSION in configure.ac 03590 are not decisive. Only the three numbers above do matter. 03591 */ 03592 /** Usage discussion: 03593 03594 Some developers of the libburnia project have differing 03595 opinions how to ensure the compatibility of libaries 03596 and applications. 03597 03598 It is about whether to use at compile time and at runtime 03599 the version numbers isoburn_header_version_* provided here. 03600 Thomas Schmitt advises to use them. 03601 Vreixo Formoso advises to use other means. 03602 03603 At compile time: 03604 03605 Vreixo Formoso advises to leave proper version matching 03606 to properly programmed checks in the the application's 03607 build system, which will eventually refuse compilation. 03608 03609 Thomas Schmitt advises to use the macros defined here 03610 for comparison with the application's requirements of 03611 library revisions and to eventually break compilation. 03612 03613 Both advises are combinable. I.e. be master of your 03614 build system and have #if checks in the source code 03615 of your application, nevertheless. 03616 03617 At runtime (via *_is_compatible()): 03618 03619 Vreixo Formoso advises to compare the application's 03620 requirements of library revisions with the runtime 03621 library. This is to allow runtime libraries which are 03622 young enough for the application but too old for 03623 the lib*.h files seen at compile time. 03624 03625 Thomas Schmitt advises to compare the header 03626 revisions defined here with the runtime library. 03627 This is to enforce a strictly monotonous chain 03628 of revisions from app to header to library, 03629 at the cost of excluding some older libraries. 03630 03631 These two advises are mutually exclusive. 03632 03633 */ 03634 03635 /* ts A91226 */ 03636 /** Obtain the id string of the SCSI transport interface. 03637 This interface may be a system specific adapter module of libburn or 03638 an adapter to a supporting library like libcdio. 03639 @param flag Bitfield for control puposes, submit 0 for now 03640 @return A pointer to the id string. Do not alter the string content. 03641 @since 0.7.6 03642 */ 03643 char *burn_scsi_transport_id(int flag); 03644 03645 /* ts A60924 : ticket 74 */ 03646 /** Control queueing and stderr printing of messages from libburn. 03647 Severity may be one of "NEVER", "ABORT", "FATAL", "FAILURE", "SORRY", 03648 "WARNING", "HINT", "NOTE", "UPDATE", "DEBUG", "ALL". 03649 @param queue_severity Gives the minimum limit for messages to be queued. 03650 Default: "NEVER". If you queue messages then you 03651 must consume them by burn_msgs_obtain(). 03652 @param print_severity Does the same for messages to be printed directly 03653 to stderr. Default: "FATAL". 03654 @param print_id A text prefix to be printed before the message. 03655 @return >0 for success, <=0 for error 03656 @since 0.2.6 03657 */ 03658 int burn_msgs_set_severities(char *queue_severity, 03659 char *print_severity, char *print_id); 03660 03661 /* ts A60924 : ticket 74 */ 03662 /* @since 0.2.6 */ 03663 #define BURN_MSGS_MESSAGE_LEN 4096 03664 03665 /** Obtain the oldest pending libburn message from the queue which has at 03666 least the given minimum_severity. This message and any older message of 03667 lower severity will get discarded from the queue and is then lost forever. 03668 @param minimum_severity may be one of "NEVER", "ABORT", "FATAL", 03669 "FAILURE", "SORRY", "WARNING", "HINT", "NOTE", "UPDATE", 03670 "DEBUG", "ALL". 03671 To call with minimum_severity "NEVER" will discard the 03672 whole queue. 03673 @param error_code Will become a unique error code as listed in 03674 libburn/libdax_msgs.h 03675 @param msg_text Must provide at least BURN_MSGS_MESSAGE_LEN bytes. 03676 @param os_errno Will become the eventual errno related to the message 03677 @param severity Will become the severity related to the message and 03678 should provide at least 80 bytes. 03679 @return 1 if a matching item was found, 0 if not, <0 for severe errors 03680 @since 0.2.6 03681 */ 03682 int burn_msgs_obtain(char *minimum_severity, 03683 int *error_code, char msg_text[], int *os_errno, 03684 char severity[]); 03685 03686 03687 /* ts A70922 */ 03688 /** Submit a message to the libburn queueing system. It will be queued or 03689 printed as if it was generated by libburn itself. 03690 @param error_code The unique error code of your message. 03691 Submit 0 if you do not have reserved error codes within 03692 the libburnia project. 03693 @param msg_text Not more than BURN_MSGS_MESSAGE_LEN characters of 03694 message text. 03695 @param os_errno Eventual errno related to the message. Submit 0 if 03696 the message is not related to a operating system error. 03697 @param severity One of "ABORT", "FATAL", "FAILURE", "SORRY", "WARNING", 03698 "HINT", "NOTE", "UPDATE", "DEBUG". Defaults to "FATAL". 03699 @param d An eventual drive to which the message shall be related. 03700 Submit NULL if the message is not specific to a 03701 particular drive object. 03702 @return 1 if message was delivered, <=0 if failure 03703 @since 0.4.0 03704 */ 03705 int burn_msgs_submit(int error_code, char msg_text[], int os_errno, 03706 char severity[], struct burn_drive *d); 03707 03708 03709 /* ts A71016 */ 03710 /** Convert a severity name into a severity number, which gives the severity 03711 rank of the name. 03712 @param severity_name A name as with burn_msgs_submit(), e.g. "SORRY". 03713 @param severity_number The rank number: the higher, the more severe. 03714 @param flag Bitfield for control purposes (unused yet, submit 0) 03715 @return >0 success, <=0 failure 03716 @since 0.4.0 03717 */ 03718 int burn_text_to_sev(char *severity_name, int *severity_number, int flag); 03719 03720 03721 /* ts A80202 */ 03722 /** Convert a severity number into a severity name 03723 @param severity_number The rank number: the higher, the more severe. 03724 @param severity_name A name as with burn_msgs_submit(), e.g. "SORRY". 03725 @param flag Bitfield for control purposes (unused yet, submit 0) 03726 @return >0 success, <=0 failure 03727 @since 0.4.4 03728 */ 03729 int burn_sev_to_text(int severity_number, char **severity_name, int flag); 03730 03731 03732 /* ts B21214 */ 03733 /** Return a blank separated list of severity names. Sorted from low 03734 to high severity. 03735 @param flag Bitfield for control purposes (unused yet, submit 0) 03736 @return A constant string with the severity names 03737 @since 1.2.6 03738 */ 03739 char *burn_list_sev_texts(int flag); 03740 03741 03742 /* ts A70915 */ 03743 /** Replace the messenger object handle of libburn by a compatible handle 03744 obtained from a related library. 03745 See also: libisofs, API function iso_get_messenger(). 03746 @param messenger The foreign but compatible message handle. 03747 @return 1 : success, <=0 : failure 03748 @since 0.4.0 03749 */ 03750 int burn_set_messenger(void *messenger); 03751 03752 03753 /* ts A61002 */ 03754 /* @since 0.2.6 */ 03755 /** The prototype of a handler function suitable for burn_set_signal_handling() 03756 Such a function has to return -2 if it does not want the process to 03757 exit with value 1. 03758 */ 03759 typedef int (*burn_abort_handler_t)(void *handle, int signum, int flag); 03760 03761 /** Control built-in signal handling. Either by setting an own handler or 03762 by activating the built-in signal handler. 03763 03764 A function parameter handle of NULL activates the built-in abort handler. 03765 Depending on mode it may cancel all drive operations, wait for all drives 03766 to become idle, exit(1). It may also prepare function 03767 burn_drive_get_status() for waiting and performing exit(1). 03768 If parameter handle may be NULL or a text that shall be used as prefix for 03769 pacifier messages of burn_abort_pacifier(). Other than with an application 03770 provided handler, the prefix char array does not have to be kept existing 03771 until the eventual signal event. 03772 Before version 0.7.8 only action 0 was available. I.e. the built-in handler 03773 waited for the drives to become idle and then performed exit(1) directly. 03774 But during burn_disc_write() onto real CD or DVD, FreeBSD 8.0 pauses the 03775 other threads until the signal handler returns. 03776 The new actions try to avoid this deadlock. It is advised to use action 3 03777 at least during burn_disc_write(), burn_disc_erase(), burn_disc_format(): 03778 burn_set_signal_handling(text, NULL, 0x30); 03779 and to call burn_is_aborting(0) when the drive is BURN_DRIVE_IDLE. 03780 If burn_is_aborting(0) returns 1, then call burn_abort() and exit(1). 03781 03782 @param handle Opaque handle eventually pointing to an application 03783 provided memory object 03784 @param handler A function to be called on signals, if the handling bits 03785 in parameter mode are set 0. 03786 It will get parameter handle as argument. flag will be 0. 03787 It should finally call burn_abort(). See there. 03788 If the handler function returns 2 or -2, then the wrapping 03789 signal handler of libburn will return and let the program 03790 continue its operations. Any other return value causes 03791 exit(1). 03792 @param mode : bit0 - bit3: Handling of received signals: 03793 0 Install libburn wrapping signal handler, which will call 03794 handler(handle, signum, 0) on nearly all signals 03795 1 Enable system default reaction on all signals 03796 2 Try to ignore nearly all signals 03797 10 like mode 2 but handle SIGABRT like with mode 0 03798 bit4 - bit7: With handler == NULL : 03799 Action of built-in handler. "control thread" is the one 03800 which called burn_set_signal_handling(). 03801 All actions activate receive mode 2 to ignore further 03802 signals. 03803 0 Same as 1 (for pre-0.7.8 backward compatibility) 03804 @since 0.7.8 03805 1 Catch the control thread in abort handler, call 03806 burn_abort() with a patience value > 0 and 03807 finally exit(1). Does not always work with FreeBSD. 03808 2 Call burn_abort() with patience -1 and return from 03809 handler. When the control thread calls 03810 burn_drive_get_status(), then call burn_abort() 03811 with patience 1 instead, and finally exit(1). 03812 Does not always work with FreeBSD. 03813 3 Call burn_abort() with patience -1, return from handler. 03814 It is duty of the application to detect a pending abort 03815 condition by calling burn_is_aborting() and to wait for 03816 all drives to become idle. E.g. by calling burn_abort() 03817 with patience >0. 03818 4 Like 3, but without calling burn_abort() with -1. Only 03819 the indicator of burn_is_aborting() gets set. 03820 bit8: @since 1.3.2 03821 try to ignore SIGPIPE (regardless of bit0 - bit3) 03822 03823 @since 0.2.6 03824 */ 03825 void burn_set_signal_handling(void *handle, burn_abort_handler_t handler, 03826 int mode); 03827 03828 03829 /* ts B00304 */ 03830 /* Inquire whether the built-in abort handler was triggered by a signal. 03831 This has to be done to detect pending abort handling if signal handling 03832 was set to the built-in handler and action was set to 2 or 3. 03833 @param flag Bitfield for control purposes (unused yet, submit 0) 03834 @return 0 = no abort was triggered 03835 >0 = action that was triggered (action 0 is reported as 1) 03836 @since 0.7.8 03837 */ 03838 int burn_is_aborting(int flag); 03839 03840 03841 /* ts A70811 */ 03842 /** Write data in random access mode. 03843 The drive must be grabbed successfully before calling this function which 03844 circumvents usual libburn session processing and rather writes data without 03845 preparations or finalizing. This will work only with overwriteable media 03846 which are also suitable for burn_write_opts_set_start_byte(). The same 03847 address alignment restrictions as with this function apply. I.e. for DVD 03848 it is best to align to 32 KiB blocks (= 16 LBA units). The amount of data 03849 to be written is subject to the same media dependent alignment rules. 03850 Again, 32 KiB is most safe. 03851 Call burn_disc_get_multi_caps() can obtain the necessary media info. See 03852 resulting struct burn_multi_caps elements .start_adr , .start_alignment , 03853 .start_range_low , .start_range_high . 03854 Other than burn_disc_write() this is a synchronous call which returns 03855 only after the write transaction has ended (sucessfully or not). So it is 03856 wise not to transfer giant amounts of data in a single call. 03857 Important: Data have to fit into the already formatted area of the media. 03858 @param d The drive to which to write 03859 @param byte_address The start address of the write in byte 03860 (1 LBA unit = 2048 bytes) (do respect media alignment) 03861 @param data The bytes to be written 03862 @param data_count The number of those bytes (do respect media alignment) 03863 data_count == 0 is permitted (e.g. to flush the 03864 drive buffer without further data transfer). 03865 @param flag Bitfield for control purposes: 03866 bit0 = flush the drive buffer after eventual writing 03867 @return 1=sucessful , <=0 : number of transfered bytes * -1 03868 @since 0.4.0 03869 */ 03870 int burn_random_access_write(struct burn_drive *d, off_t byte_address, 03871 char *data, off_t data_count, int flag); 03872 03873 03874 /* ts A81215 */ 03875 /** Inquire the maximum amount of readable data. 03876 It is supposed that all LBAs in the range from 0 to media_read_acpacity-1 03877 can be read via burn_read_data() although some of them may never have been 03878 recorded. If tracks are recognizable then it is better to only read 03879 LBAs which are part of some track. 03880 If the drive is actually a large file or block device, then the capacity 03881 is curbed to a maximum of 0x7ffffff0 blocks = 4 TB - 32 KB. 03882 @param d The drive from which to read 03883 @param capacity Will return the result if valid 03884 @param flag Bitfield for control purposes: Unused yet, submit 0. 03885 @return 1=sucessful , <=0 an error occured 03886 @since 0.6.0 03887 */ 03888 int burn_get_read_capacity(struct burn_drive *d, int *capacity, int flag); 03889 03890 03891 /* ts A70812 */ 03892 /** Read data in random access mode. 03893 The drive must be grabbed successfully before calling this function. 03894 With all currently supported drives and media the byte_address has to 03895 be aligned to 2048 bytes. Only data tracks with 2048 bytes per sector 03896 can be read this way. I.e. not CD-audio, not CD-video-stream ... 03897 This is a synchronous call which returns only after the full read job 03898 has ended (sucessfully or not). So it is wise not to read giant amounts 03899 of data in a single call. 03900 @param d The drive from which to read 03901 @param byte_address The start address of the read in byte (aligned to 2048) 03902 @param data A memory buffer capable of taking data_size bytes 03903 @param data_size The amount of data to be read. This does not have to 03904 be aligned to any block size. 03905 @param data_count The amount of data actually read (interesting on error) 03906 @param flag Bitfield for control purposes: 03907 bit0= - reserved - 03908 bit1= do not submit error message if read error 03909 bit2= on error do not try to read a second time 03910 with single block steps. 03911 @since 0.5.2 03912 bit3= return -2 on permission denied error rather than 03913 issueing a warning message. 03914 @since 1.0.6 03915 bit4= return -3 on SCSI error 03916 5 64 00 ILLEGAL MODE FOR THIS TRACK 03917 and prevent this error from being reported as 03918 event message. Do not retry reading in this case. 03919 (Useful to try the last two blocks of a CD 03920 track which might be non-data because of TAO.) 03921 @since 1.2.6 03922 @return 1=sucessful , <=0 an error occured 03923 with bit3: -2= permission denied error 03924 @since 0.4.0 03925 */ 03926 int burn_read_data(struct burn_drive *d, off_t byte_address, 03927 char data[], off_t data_size, off_t *data_count, int flag); 03928 03929 03930 /* ts B21119 */ 03931 /** Read CD audio sectors in random access mode. 03932 The drive must be grabbed successfully before calling this function. 03933 Only CD audio tracks with 2352 bytes per sector can be read this way. 03934 I.e. not data tracks, not CD-video-stream, ... 03935 03936 Note that audio data do not have exact block addressing. If you read a 03937 sequence of successive blocks then you will get a seamless stream 03938 of data. But the actual start and end position of this audio stream 03939 will differ by a few dozens of milliseconds, depending on individual 03940 CD and individual drive. 03941 Expect leading and trailing zeros, as well as slight truncation. 03942 03943 @param d The drive from which to read. 03944 It must be a real MMC drive (i.e. not a stdio file) 03945 and it must have a CD loaded (i.e. not DVD or BD). 03946 @param sector_no The sector number (Logical Block Address) 03947 It may be slightly below 0, depending on drive and 03948 medium. -150 is a lower limit. 03949 @param data A memory buffer capable of taking data_size bytes 03950 @param data_size The amount of data to be read. This must be aligned 03951 to full multiples of 2352. 03952 @param data_count The amount of data actually read (interesting on error) 03953 @param flag Bitfield for control purposes: 03954 bit0= - reserved - 03955 bit1= do not submit error message if read error 03956 bit2= on error do not try to read a second time 03957 with single block steps. 03958 bit3= Enable DAP : "flaw obscuring mechanisms like 03959 audio data mute and interpolate" 03960 bit4= return -3 on SCSI error 03961 5 64 00 ILLEGAL MODE FOR THIS TRACK 03962 and prevent this error from being reported as 03963 event message. Do not retry reading in this case. 03964 (Useful to try the last two blocks of a CD 03965 track which might be non-audio because of TAO.) 03966 @return 1=sucessful , <=0 an error occured 03967 with bit3: -2= permission denied error 03968 @since 1.2.6 03969 */ 03970 int burn_read_audio(struct burn_drive *d, int sector_no, 03971 char data[], off_t data_size, off_t *data_count, int flag); 03972 03973 03974 /* ts B30522 */ 03975 /** Extract an interval of audio sectors from CD and store it as a WAVE 03976 audio file on hard disk. 03977 03978 @param drive The drive from which to read. 03979 @param start_sector The logical block address of the first audio sector 03980 which shall be read. 03981 @param sector_count The number of audio sectors to be read. 03982 Each sector consists of 2352 bytes. 03983 @param target_path The address of the file where to store the extracted 03984 audio data. Will be opened O_WRONLY | O_CREAT. 03985 The file name should have suffix ".wav". 03986 @param flag Bitfield for control purposes: 03987 bit0= Report about progress by UPDATE messages 03988 bit3= Enable DAP : "flaw obscuring mechanisms like 03989 audio data mute and interpolate" 03990 @since 1.3.2 03991 */ 03992 int burn_drive_extract_audio(struct burn_drive *drive, 03993 int start_sector, int sector_count, 03994 char *target_path, int flag); 03995 03996 03997 /* ts B30522 */ 03998 /** Extract all audio sectors of a track from CD and store them as a WAVE 03999 audio file on hard disk. 04000 04001 @param drive The drive from which to read. 04002 @param track The track which shall be extracted. 04003 @param target_path The address of the file where to store the extracted 04004 audio data. Will be opened O_WRONLY | O_CREAT. 04005 The file name should have suffix ".wav". 04006 @param flag Bitfield for control purposes: 04007 bit0= Report about progress by UPDATE messages 04008 bit3= Enable DAP : "flaw obscuring mechanisms like 04009 audio data mute and interpolate" 04010 @since 1.3.2 04011 */ 04012 int burn_drive_extract_audio_track(struct burn_drive *drive, 04013 struct burn_track *track, 04014 char *target_path, int flag); 04015 04016 04017 /* ts A70904 */ 04018 /** Inquire whether the drive object is a real MMC drive or a pseudo-drive 04019 created by a stdio: address. 04020 @param d The drive to inquire 04021 @return 0= null-drive 04022 1= real MMC drive 04023 2= stdio-drive, random access, read-write 04024 3= stdio-drive, sequential, write-only 04025 4= stdio-drive, random access, read-only 04026 (only if enabled by burn_allow_drive_role_4()) 04027 5= stdio-drive, random access, write-only 04028 (only if enabled by burn_allow_drive_role_4()) 04029 @since 0.4.0 04030 */ 04031 int burn_drive_get_drive_role(struct burn_drive *d); 04032 04033 04034 /* ts B10312 */ 04035 /** Allow drive role 4 "random access read-only" 04036 and drive role 5 "random access write-only". 04037 By default a random access file assumes drive role 2 "read-write" 04038 regardless whether it is actually readable or writeable. 04039 If enabled, random-access file objects which recognizably allow no 04040 writing will be classified as role 4 and those which allow no reading 04041 will get role 5. 04042 Candidates are drive addresses of the form stdio:/dev/fd/# , where # is 04043 the integer number of an open file descriptor. If this descriptor was 04044 opened read-only resp. write-only, then it gets role 4 resp. role 5. 04045 Other paths may get tested by an attempt to open them for read-write 04046 (role 2) resp. read-only (role 4) resp. write-only (role 5). See bit1. 04047 @param allowed Bitfield for control purposes: 04048 bit0= Enable roles 4 and 5 for drives which get 04049 aquired after this call 04050 bit1= with bit0: 04051 Test whether the file can be opened for 04052 read-write resp. read-only resp. write-only. 04053 Classify as roles 2 resp. 4 resp. 5. 04054 bit2= with bit0 and bit1: 04055 Classify files which cannot be opened at all 04056 as role 0 : useless dummy. 04057 Else classify as role 2. 04058 bit3= Classify non-empty role 5 drives as 04059 BURN_DISC_APPENDABLE with Next Writeable Address 04060 after the end of the file. It is nevertheless 04061 possible to change this address by call 04062 burn_write_opts_set_start_byte(). 04063 @since 1.0.6 04064 */ 04065 void burn_allow_drive_role_4(int allowed); 04066 04067 04068 /* ts A70923 */ 04069 /** Find out whether a given address string would lead to the given drive 04070 object. This should be done in advance for track source addresses 04071 with parameter drive_role set to 2. 04072 Although a real MMC drive should hardly exist as two drive objects at 04073 the same time, this can easily happen with stdio-drives. So if more than 04074 one drive is used by the application, then this gesture is advised: 04075 burn_drive_d_get_adr(d2, adr2); 04076 if (burn_drive_equals_adr(d1, adr2, burn_drive_get_drive_role(d2))) 04077 ... Both drive objects point to the same storage facility ... 04078 04079 @param d1 Existing drive object 04080 @param adr2 Address string to be tested. Prefix "stdio:" overrides 04081 parameter drive_role2 by either 0 or 2 as appropriate. 04082 The string must be shorter than BURN_DRIVE_ADR_LEN. 04083 @param drive_role2 Role as burn_drive_get_drive_role() would attribute 04084 to adr2 if it was a drive. Use value 2 for checking track 04085 sources resp. pseudo-drive addresses without "stdio:". 04086 Use 1 for checking drive addresses including those with 04087 prefix "stdio:". 04088 @return 1= adr2 leads to d1 , 0= adr2 seems not to lead to d1, 04089 -1 = adr2 is bad 04090 @since 0.4.0 04091 */ 04092 int burn_drive_equals_adr(struct burn_drive *d1, char *adr2, int drive_role2); 04093 04094 04095 04096 /* 04097 Audio track data extraction facility. 04098 */ 04099 04100 /* Maximum size for address paths and fmt_info strings */ 04101 #define LIBDAX_AUDIOXTR_STRLEN 4096 04102 04103 04104 /** Extractor object encapsulating intermediate states of extraction. 04105 The clients of libdax_audioxtr shall only allocate pointers to this 04106 struct and get a storage object via libdax_audioxtr_new(). 04107 Appropriate initial value for the pointer is NULL. 04108 */ 04109 struct libdax_audioxtr; 04110 04111 04112 /** Open an audio file, check wether suitable, create extractor object. 04113 @param xtr Opaque handle to extractor. Gets attached extractor object. 04114 @param path Address of the audio file to extract. "-" is stdin (but might 04115 be not suitable for all futurely supported formats). 04116 @param flag Bitfield for control purposes (unused yet, submit 0) 04117 @return >0 success 04118 0 unsuitable format 04119 -1 severe error 04120 -2 path not found 04121 @since 0.2.4 04122 */ 04123 int libdax_audioxtr_new(struct libdax_audioxtr **xtr, char *path, int flag); 04124 04125 04126 /** Obtain identification parameters of opened audio source. 04127 @param xtr Opaque handle to extractor 04128 @param fmt Gets pointed to the audio file format id text: ".wav" , ".au" 04129 @param fmt_info Gets pointed to a format info text telling parameters 04130 @param num_channels e.g. 1=mono, 2=stereo, etc 04131 @param sample_rate e.g. 11025, 44100 04132 @param bits_per_sample e.g. 8= 8 bits per sample, 16= 16 bits ... 04133 @param msb_first Byte order of samples: 0= Intel = Little Endian 04134 1= Motorola = Big Endian 04135 @param flag Bitfield for control purposes (unused yet, submit 0) 04136 @return >0 success, <=0 failure 04137 @since 0.2.4 04138 */ 04139 int libdax_audioxtr_get_id(struct libdax_audioxtr *xtr, 04140 char **fmt, char **fmt_info, 04141 int *num_channels, int *sample_rate, 04142 int *bits_per_sample, int *msb_first, int flag); 04143 04144 04145 /** Obtain a prediction about the extracted size based on internal information 04146 of the formatted file. 04147 @param xtr Opaque handle to extractor 04148 @param size Gets filled with the predicted size 04149 @param flag Bitfield for control purposes (unused yet, submit 0) 04150 @return 1 prediction was possible , 0 no prediction could be made 04151 @since 0.2.4 04152 */ 04153 int libdax_audioxtr_get_size(struct libdax_audioxtr *o, off_t *size, int flag); 04154 04155 04156 /** Obtain next buffer full of extracted data in desired format (only raw audio 04157 for now). 04158 @param xtr Opaque handle to extractor 04159 @param buffer Gets filled with extracted data 04160 @param buffer_size Maximum number of bytes to be filled into buffer 04161 @param flag Bitfield for control purposes 04162 bit0= do not stop at predicted end of data 04163 @return >0 number of valid buffer bytes, 04164 0 End of file 04165 -1 operating system reports error 04166 -2 usage error by application 04167 @since 0.2.4 04168 */ 04169 int libdax_audioxtr_read(struct libdax_audioxtr *xtr, 04170 char buffer[], int buffer_size, int flag); 04171 04172 04173 /** Try to obtain a file descriptor which will deliver extracted data 04174 to normal calls of read(2). This may fail because the format is 04175 unsuitable for that, but WAVE (.wav) is ok. If this call succeeds the xtr 04176 object will have forgotten its file descriptor and libdax_audioxtr_read() 04177 will return a usage error. One may use *fd after libdax_audioxtr_destroy() 04178 and will have to close it via close(2) when done with it. 04179 @param xtr Opaque handle to extractor 04180 @param fd Eventually returns the file descriptor number 04181 @param flag Bitfield for control purposes 04182 bit0= do not dup(2) and close(2) but hand out original fd 04183 @return 1 success, 0 cannot hand out fd , -1 severe error 04184 @since 0.2.4 04185 */ 04186 int libdax_audioxtr_detach_fd(struct libdax_audioxtr *o, int *fd, int flag); 04187 04188 04189 /** Clean up after extraction and destroy extractor object. 04190 @param xtr Opaque handle to extractor, *xtr is allowed to be NULL, 04191 *xtr is set to NULL by this function 04192 @param flag Bitfield for control purposes (unused yet, submit 0) 04193 @return 1 = destroyed object, 0 = was already destroyed 04194 @since 0.2.4 04195 */ 04196 int libdax_audioxtr_destroy(struct libdax_audioxtr **xtr, int flag); 04197 04198 04199 #ifndef DOXYGEN 04200 04201 BURN_END_DECLS 04202 04203 #endif 04204 04205 04206 /* ts A91205 */ 04207 /* The following experiments may be interesting in future: 04208 */ 04209 04210 /* Perform OPC explicitely. 04211 # define Libburn_pioneer_dvr_216d_with_opC 1 04212 */ 04213 04214 /* Load mode page 5 and modify it rather than composing from scratch. 04215 # define Libburn_pioneer_dvr_216d_load_mode5 1 04216 */ 04217 04218 /* Inquire drive events and react by reading configuration or starting unit. 04219 # define Libburn_pioneer_dvr_216d_get_evenT 1 04220 */ 04221 04222 /* ts A91112 */ 04223 /* Do not probe CD modes but declare only data and audio modes supported. 04224 For other modes resp. real probing one has to call 04225 burn_drive_probe_cd_write_modes(). 04226 04227 */ 04228 #define Libburn_dummy_probe_write_modeS 1 04229 04230 /* ts B30112 */ 04231 /* Handle DVD+R with reserved tracks in incomplete first session 04232 by loading info about the incomplete session into struct burn_disc 04233 */ 04234 #define Libburn_disc_with_incomplete_sessioN 1 04235 04236 04237 /* Early experimental: 04238 Do not define Libburn_develop_quality_scaN unless you want to work 04239 towards a usable implementation. 04240 If it gets enabled, then the call must be published in libburn/libburn.ver 04241 */ 04242 #ifdef Libburn_develop_quality_scaN 04243 04244 /* ts B21108 */ 04245 /* Experiments mit quality scan command F3 on Optiarc drive */ 04246 int burn_nec_optiarc_rep_err_rate(struct burn_drive *d, 04247 int start_lba, int rate_period, int flag); 04248 04249 #endif /* Libburn_develop_quality_scaN */ 04250 04251 04252 04253 #endif /*LIBBURN_H*/