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