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