libburn.h

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

Generated for libburn by  doxygen 1.4.7