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