libburn  1.2.8
libburn.h
Go to the documentation of this file.
1 /* -*- indent-tabs-mode: t; tab-width: 8; c-basic-offset: 8; -*- */
2 
3 /* Copyright (c) 2004 - 2006 Derek Foreman, Ben Jansens
4  Copyright (c) 2006 - 2013 Thomas Schmitt <scdbackup@gmx.net>
5  Provided under GPL version 2 or later.
6 
7  This is the official API definition of libburn.
8 
9 */
10 /* Important: If you add a public API function then add its name to file
11  libburn/libburn.ver
12 */
13 
14 
15 #ifndef LIBBURN_H
16 #define LIBBURN_H
17 
18 /*
19 
20 Applications must use 64 bit off_t. E.g. by defining
21  #define _LARGEFILE_SOURCE
22  #define _FILE_OFFSET_BITS 64
23 or take special precautions to interface with the library by 64 bit integers
24 where this .h files prescribe off_t.
25 
26 To prevent 64 bit file i/o in the library would keep the application from
27 processing tracks of more than 2 GB size.
28 
29 */
30 #include <sys/types.h>
31 
32 #ifndef DOXYGEN
33 
34 #if defined(__cplusplus)
35 #define BURN_BEGIN_DECLS \
36  namespace burn { \
37  extern "C" {
38 #define BURN_END_DECLS \
39  } \
40  }
41 #else
42 #define BURN_BEGIN_DECLS
43 #define BURN_END_DECLS
44 #endif
45 
46 BURN_BEGIN_DECLS
47 
48 #endif
49 
50 /** References a physical drive in the system */
51 struct burn_drive;
52 
53 /** References a whole disc */
54 struct burn_disc;
55 
56 /** References a single session on a disc */
57 struct burn_session;
58 
59 /** References a single track on a disc */
60 struct burn_track;
61 
62 /* ts A61111 */
63 /** References a set of write parameters */
64 struct burn_write_opts;
65 
66 /** Session format for normal audio or data discs */
67 #define BURN_CDROM 0
68 /** Session format for obsolete CD-I discs */
69 #define BURN_CDI 0x10
70 /** Session format for CDROM-XA discs */
71 #define BURN_CDXA 0x20
72 
73 #define BURN_POS_END 100
74 
75 /** Mask for mode bits */
76 #define BURN_MODE_BITS 127
77 
78 /** Track mode - mode 0 data
79  0 bytes of user data. it's all 0s. mode 0. get it? HAH
80 */
81 #define BURN_MODE0 (1 << 0)
82 /** Track mode - mode "raw" - all 2352 bytes supplied by app
83  FOR DATA TRACKS ONLY!
84 */
85 #define BURN_MODE_RAW (1 << 1)
86 /** Track mode - mode 1 data
87  2048 bytes user data, and all the LEC money can buy
88 */
89 #define BURN_MODE1 (1 << 2)
90 /** Track mode - mode 2 data
91  defaults to formless, 2336 bytes of user data, unprotected
92  | with a data form if required.
93 */
94 #define BURN_MODE2 (1 << 3)
95 /** Track mode modifier - Form 1, | with MODE2 for reasonable results
96  2048 bytes of user data, 4 bytes of subheader
97 */
98 #define BURN_FORM1 (1 << 4)
99 /** Track mode modifier - Form 2, | with MODE2 for reasonable results
100  lots of user data. not much LEC.
101 */
102 #define BURN_FORM2 (1 << 5)
103 /** Track mode - audio
104  2352 bytes per sector. may be | with 4ch or preemphasis.
105  NOT TO BE CONFUSED WITH BURN_MODE_RAW
106  Audio data must be 44100Hz 16bit stereo with no riff or other header at
107  beginning. Extra header data will cause pops or clicks. Audio data should
108  also be in little-endian byte order. Big-endian audio data causes static.
109 */
110 #define BURN_AUDIO (1 << 6)
111 /** Track mode modifier - 4 channel audio. */
112 #define BURN_4CH (1 << 7)
113 /** Track mode modifier - Digital copy permitted, can be set on any track.*/
114 #define BURN_COPY (1 << 8)
115 /** Track mode modifier - 50/15uS pre-emphasis */
116 #define BURN_PREEMPHASIS (1 << 9)
117 /** Input mode modifier - subcodes present packed 16 */
118 #define BURN_SUBCODE_P16 (1 << 10)
119 /** Input mode modifier - subcodes present packed 96 */
120 #define BURN_SUBCODE_P96 (1 << 11)
121 /** Input mode modifier - subcodes present raw 96 */
122 #define BURN_SUBCODE_R96 (1 << 12)
123 
124 /* ts B11230 */
125 /** Track mode modifier - Serial Copy Management System, SAO only
126  If this is set and BURN_COPY is not set, then copying the emerging
127  track will be forbidden.
128  @since 1.2.0
129 */
130 #define BURN_SCMS (1 << 13)
131 
132 
133 /** Possible disc writing style/modes */
135 {
136  /** Packet writing.
137  currently unsupported, (for DVD Incremental Streaming use TAO)
138  */
140 
141  /** With CD: Track At Once recording
142  2s gaps between tracks, no fonky lead-ins
143 
144  With sequential DVD-R[W]: Incremental Streaming
145  With DVD+R and BD-R: Track of open size
146  With DVD-RAM, DVD+RW, BD-RE: Random Writeable (used sequentially)
147  With overwriteable DVD-RW: Rigid Restricted Overwrite
148  */
150 
151  /** With CD: Session At Once
152  Block type MUST be BURN_BLOCK_SAO
153  ts A70122: Currently not capable of mixing data and audio tracks.
154 
155  With sequential DVD-R[W]: Disc-at-once, DAO
156  Single session, single track, fixed size mandatory, (-dvd-compat)
157  With other DVD or BD media: same as BURN_WRITE_TAO but may demand
158  that track size is known in advance.
159  */
161 
162  /** With CD: Raw disc at once recording.
163  all subcodes must be provided by lib or user
164  only raw block types are supported
165  With DVD and BD media: not supported.
166 
167  ts A90901: This had been disabled because its implementation
168  relied on code from cdrdao which is not understood
169  currently.
170  A burn run will abort with "FATAL" error message
171  if this mode is attempted.
172  @since 0.7.2
173  ts A91016: Re-implemented according to ECMA-130 Annex A and B.
174  Now understood, explained and not stemming from cdrdao.
175  @since 0.7.4
176  */
178 
179  /** In replies this indicates that not any writing will work.
180  As parameter for inquiries it indicates that no particular write
181  mode shall is specified.
182  Do not use for setting a write mode for burning. It will not work.
183  */
185 };
186 
187 /** Data format to send to the drive */
189 {
190  /** sync, headers, edc/ecc provided by lib/user */
192  /** sync, headers, edc/ecc and p/q subs provided by lib/user */
194  /** sync, headers, edc/ecc and packed p-w subs provided by lib/user */
196  /** sync, headers, edc/ecc and raw p-w subs provided by lib/user */
198  /** only 2048 bytes of user data provided by lib/user */
200  /** 2336 bytes of user data provided by lib/user */
202  /** 2048 bytes of user data provided by lib/user
203  subheader provided in write parameters
204  are we ever going to support this shit? I vote no.
205  (supposed to be supported on all drives...)
206  */
208  /** 2048 bytes of data + 8 byte subheader provided by lib/user
209  hey, this is also dumb
210  */
212  /** 2324 bytes of data provided by lib/user
213  subheader provided in write parameters
214  no sir, I don't like it.
215  */
217  /** 2332 bytes of data supplied by lib/user
218  8 bytes sub header provided in write parameters
219  this is the second least suck mode2, and is mandatory for
220  all drives to support.
221  */
223  /** SAO block sizes are based on cue sheet, so use this. */
225 };
226 
227 /** Possible status of the drive in regard to the disc in it. */
229 {
230  /** The current status is not yet known */
232 
233  /** The drive holds a blank disc. It is ready for writing from scratch.
234  Unused multi-session media:
235  CD-R, CD-RW, DVD-R, DVD-RW, DVD+R, BD-R
236  Blanked multi-session media (i.e. treated by burn_disc_erase())
237  CD-RW, DVD-RW
238  Overwriteable media with or without valid data
239  DVD-RAM, DVD+RW, formatted DVD-RW, BD-RE
240  */
242 
243  /** There is no disc at all in the drive */
245 
246  /** There is an incomplete disc in the drive. It is ready for appending
247  another session.
248  Written but not yet closed multi-session media
249  CD-R, CD-RW, DVD-R, DVD-RW, DVD+R, BD-R
250  */
252 
253  /** There is a disc with data on it in the drive. It is usable only for
254  reading.
255  Written and closed multi-session media
256  CD-R, CD-RW, DVD-R, DVD-RW, DVD+R, BD-R
257  Read-Only media
258  CD-ROM, DVD-ROM, BD-ROM
259  Note that many DVD-ROM drives report any written media
260  as Read-Only media and not by their real media types.
261  */
263 
264  /* ts A61007 */
265  /* @since 0.2.4 */
266  /** The drive was not grabbed when the status was inquired */
268 
269  /* ts A61020 */
270  /* @since 0.2.6 */
271  /** The media seems to be unsuitable for reading and for writing */
273 };
274 
275 
276 /** Possible data source return values */
278 {
279  /** The source is ok */
281  /** The source is at end of file */
283  /** The source is unusable */
285 };
286 
287 
288 /** Possible busy states for a drive */
290 {
291  /** The drive is not in an operation */
293  /** The library is spawning the processes to handle a pending
294  operation (A read/write/etc is about to start but hasn't quite
295  yet) */
297  /** The drive is reading data from a disc */
299  /** The drive is writing data to a disc */
301  /** The drive is writing Lead-In */
303  /** The drive is writing Lead-Out */
305  /** The drive is erasing a disc */
307  /** The drive is being grabbed */
309 
310  /* ts A61102 */
311  /* @since 0.2.6 */
312  /** The drive gets written zeroes before the track payload data */
314  /** The drive is told to close a track (TAO only) */
316  /** The drive is told to close a session (TAO only) */
318 
319  /* ts A61223 */
320  /* @since 0.3.0 */
321  /** The drive is formatting media */
323 
324  /* ts A70822 */
325  /* @since 0.4.0 */
326  /** The drive is busy in synchronous read (if you see this then it
327  has been interrupted) */
329  /** The drive is busy in synchronous write (if you see this then it
330  has been interrupted) */
332 
333 };
334 
335 
336 /** Information about a track on a disc - this is from the q sub channel of the
337  lead-in area of a disc. The documentation here is very terse.
338  See a document such as mmc3 for proper information.
339 
340  CAUTION : This structure is prone to future extension !
341 
342  Do not restrict your application to unsigned char with any counter like
343  "session", "point", "pmin", ...
344  Do not rely on the current size of a burn_toc_entry.
345 
346 */
348 {
349  /** Session the track is in */
350  unsigned char session;
351  /** Type of data. for this struct to be valid, it must be 1 */
352  unsigned char adr;
353  /** Type of data in the track */
354  unsigned char control;
355  /** Zero. Always. Really. */
356  unsigned char tno;
357  /** Track number or special information */
358  unsigned char point;
359  unsigned char min;
360  unsigned char sec;
361  unsigned char frame;
362  unsigned char zero;
363  /** Track start time minutes for normal tracks */
364  unsigned char pmin;
365  /** Track start time seconds for normal tracks */
366  unsigned char psec;
367  /** Track start time frames for normal tracks */
368  unsigned char pframe;
369 
370  /* Indicates whether extension data are valid and eventually override
371  older elements in this structure:
372  bit0= DVD extension is valid @since 0.3.2
373  @since 0.5.2 : DVD extensions are made valid for CD too
374  bit1= LRA extension is valid @since 0.7.2
375  bit2= Track status bits extension is valid @since 1.2.8
376  */
377  unsigned char extensions_valid;
378 
379  /* ts A70201 : DVD extension. extensions_valid:bit0
380  If invalid the members are guaranteed to be 0. */
381  /* @since 0.3.2 */
382  /* Tracks and session numbers are 16 bit. Here are the high bytes. */
383  unsigned char session_msb;
384  unsigned char point_msb;
385  /* pmin, psec, and pframe may be too small if DVD extension is valid */
386  int start_lba;
387  /* min, sec, and frame may be too small if DVD extension is valid */
389 
390  /* ts A90909 : LRA extension. extensions_valid:bit1 */
391  /* @since 0.7.2 */
392  /* MMC-5 6.27.3.18 : The Last Recorded Address is valid for DVD-R,
393  DVD-R DL when LJRS = 00b, DVD-RW, HD DVD-R, and BD-R.
394  This would mean profiles: 0x11, 0x15, 0x13, 0x14, 0x51, 0x41, 0x42
395  */
397 
398  /* ts B30112 : Track status bits extension. extensions_valid:bit2 */
399  /* @since 1.2.8 */
400  /* Names as of READ TRACK INFORMATION, MMC-5 6.27.3 :
401  bit0 - bit3 = Track Mode
402  bit4 = Copy
403  bit5 = Damage
404  bit6 - bit7 = LJRS
405  bit8 - bit11 = Data Mode
406  bit12 = FP
407  bit13 = Packet/Inc
408  bit14 = Blank
409  bit15 = RT
410  bit16 = NWA_V
411  bit17 = LRA_V
412  */
414 
415 };
416 
417 
418 /** Data source interface for tracks.
419  This allows to use arbitrary program code as provider of track input data.
420 
421  Objects compliant to this interface are either provided by the application
422  or by API calls of libburn: burn_fd_source_new() , burn_file_source_new(),
423  and burn_fifo_source_new().
424 
425  The API calls allow to use any file object as data source. Consider to feed
426  an eventual custom data stream asynchronously into a pipe(2) and to let
427  libburn handle the rest.
428  In this case the following rule applies:
429  Call burn_source_free() exactly once for every source obtained from
430  libburn API. You MUST NOT otherwise use or manipulate its components.
431 
432  In general, burn_source objects can be freed as soon as they are attached
433  to track objects. The track objects will keep them alive and dispose them
434  when they are no longer needed. With a fifo burn_source it makes sense to
435  keep the own reference for inquiring its state while burning is in
436  progress.
437 
438  ---
439 
440  The following description of burn_source applies only to application
441  implemented burn_source objects. You need not to know it for API provided
442  ones.
443 
444  If you really implement an own passive data producer by this interface,
445  then beware: it can do anything and it can spoil everything.
446 
447  In this case the functions (*read), (*get_size), (*set_size), (*free_data)
448  MUST be implemented by the application and attached to the object at
449  creation time.
450  Function (*read_sub) is allowed to be NULL or it MUST be implemented and
451  attached.
452 
453  burn_source.refcount MUST be handled properly: If not exactly as many
454  references are freed as have been obtained, then either memory leaks or
455  corrupted memory are the consequence.
456  All objects which are referred to by *data must be kept existent until
457  (*free_data) is called via burn_source_free() by the last referer.
458 */
459 struct burn_source {
460 
461  /** Reference count for the data source. MUST be 1 when a new source
462  is created and thus the first reference is handed out. Increment
463  it to take more references for yourself. Use burn_source_free()
464  to destroy your references to it. */
465  int refcount;
466 
467 
468  /** Read data from the source. Semantics like with read(2), but MUST
469  either deliver the full buffer as defined by size or MUST deliver
470  EOF (return 0) or failure (return -1) at this call or at the
471  next following call. I.e. the only incomplete buffer may be the
472  last one from that source.
473  libburn will read a single sector by each call to (*read).
474  The size of a sector depends on BURN_MODE_*. The known range is
475  2048 to 2352.
476 
477  If this call is reading from a pipe then it will learn
478  about the end of data only when that pipe gets closed on the
479  feeder side. So if the track size is not fixed or if the pipe
480  delivers less than the predicted amount or if the size is not
481  block aligned, then burning will halt until the input process
482  closes the pipe.
483 
484  IMPORTANT:
485  If this function pointer is NULL, then the struct burn_source is of
486  version >= 1 and the job of .(*read)() is done by .(*read_xt)().
487  See below, member .version.
488  */
489  int (*read)(struct burn_source *, unsigned char *buffer, int size);
490 
491 
492  /** Read subchannel data from the source (NULL if lib generated)
493  WARNING: This is an obscure feature with CD raw write modes.
494  Unless you checked the libburn code for correctness in that aspect
495  you should not rely on raw writing with own subchannels.
496  ADVICE: Set this pointer to NULL.
497  */
498  int (*read_sub)(struct burn_source *, unsigned char *buffer, int size);
499 
500 
501  /** Get the size of the source's data. Return 0 means unpredictable
502  size. If application provided (*get_size) allows return 0, then
503  the application MUST provide a fully functional (*set_size).
504  */
505  off_t (*get_size)(struct burn_source *);
506 
507 
508  /* ts A70125 : BROKE BINARY BACKWARD COMPATIBILITY AT libburn-0.3.1. */
509  /* @since 0.3.2 */
510  /** Program the reply of (*get_size) to a fixed value. It is advised
511  to implement this by a attribute off_t fixed_size; in *data .
512  The read() function does not have to take into respect this fake
513  setting. It is rather a note of libburn to itself. Eventually
514  necessary truncation or padding is done in libburn. Truncation
515  is usually considered a misburn. Padding is considered ok.
516 
517  libburn is supposed to work even if (*get_size) ignores the
518  setting by (*set_size). But your application will not be able to
519  enforce fixed track sizes by burn_track_set_size() and possibly
520  even padding might be left out.
521  */
522  int (*set_size)(struct burn_source *source, off_t size);
523 
524 
525  /** Clean up the source specific data. This function will be called
526  once by burn_source_free() when the last referer disposes the
527  source.
528  */
529  void (*free_data)(struct burn_source *);
530 
531 
532  /** Next source, for when a source runs dry and padding is disabled
533  WARNING: This is an obscure feature. Set to NULL at creation and
534  from then on leave untouched and uninterpreted.
535  */
536  struct burn_source *next;
537 
538 
539  /** Source specific data. Here the various source classes express their
540  specific properties and the instance objects store their individual
541  management data.
542  E.g. data could point to a struct like this:
543  struct app_burn_source
544  {
545  struct my_app *app_handle;
546  ... other individual source parameters ...
547  off_t fixed_size;
548  };
549 
550  Function (*free_data) has to be prepared to clean up and free
551  the struct.
552  */
553  void *data;
554 
555 
556  /* ts A71222 : Supposed to be binary backwards compatible extension. */
557  /* @since 0.4.2 */
558  /** Valid only if above member .(*read)() is NULL. This indicates a
559  version of struct burn_source younger than 0.
560  From then on, member .version tells which further members exist
561  in the memory layout of struct burn_source. libburn will only touch
562  those announced extensions.
563 
564  Versions:
565  0 has .(*read)() != NULL, not even .version is present.
566  1 has .version, .(*read_xt)(), .(*cancel)()
567  */
568  int version;
569 
570  /** This substitutes for (*read)() in versions above 0. */
571  int (*read_xt)(struct burn_source *, unsigned char *buffer, int size);
572 
573  /** Informs the burn_source that the consumer of data prematurely
574  ended reading. This call may or may not be issued by libburn
575  before (*free_data)() is called.
576  */
577  int (*cancel)(struct burn_source *source);
578 };
579 
580 
581 /** Information on a drive in the system */
583 {
584  /** Name of the vendor of the drive */
585  char vendor[9];
586  /** Name of the drive */
587  char product[17];
588  /** Revision of the drive */
589  char revision[5];
590 
591  /** Invalid: Was: "Location of the drive in the filesystem." */
592  /** This string has no meaning any more. Once it stored the drive
593  device file address. Now always use function burn_drive_d_get_adr()
594  to inquire a device file address. ^^^^^ ALWAYS ^^^^^^^*/
595  char location[17];
596 
597  /** Can the drive read DVD-RAM discs */
598  unsigned int read_dvdram:1;
599  /** Can the drive read DVD-R discs */
600  unsigned int read_dvdr:1;
601  /** Can the drive read DVD-ROM discs */
602  unsigned int read_dvdrom:1;
603  /** Can the drive read CD-R discs */
604  unsigned int read_cdr:1;
605  /** Can the drive read CD-RW discs */
606  unsigned int read_cdrw:1;
607 
608  /** Can the drive write DVD-RAM discs */
609  unsigned int write_dvdram:1;
610  /** Can the drive write DVD-R discs */
611  unsigned int write_dvdr:1;
612  /** Can the drive write CD-R discs */
613  unsigned int write_cdr:1;
614  /** Can the drive write CD-RW discs */
615  unsigned int write_cdrw:1;
616 
617  /** Can the drive simulate a write */
618  unsigned int write_simulate:1;
619 
620  /** Can the drive report C2 errors */
621  unsigned int c2_errors:1;
622 
623  /** The size of the drive's buffer (in kilobytes) */
625  /**
626  * The supported block types in tao mode.
627  * They should be tested with the desired block type.
628  * See also burn_block_types.
629  */
631  /**
632  * The supported block types in sao mode.
633  * They should be tested with the desired block type.
634  * See also burn_block_types.
635  */
637  /**
638  * The supported block types in raw mode.
639  * They should be tested with the desired block type.
640  * See also burn_block_types.
641  */
643  /**
644  * The supported block types in packet mode.
645  * They should be tested with the desired block type.
646  * See also burn_block_types.
647  */
649 
650  /** The value by which this drive can be indexed when using functions
651  in the library. This is the value to pass to all libbburn functions
652  that operate on a drive. */
653  struct burn_drive *drive;
654 };
655 
656 
657 /** Operation progress report. All values are 0 based indices.
658  * */
660  /** The total number of sessions */
661  int sessions;
662  /** Current session.*/
663  int session;
664  /** The total number of tracks */
665  int tracks;
666  /** Current track. */
667  int track;
668  /** The total number of indices */
669  int indices;
670  /** Curent index. */
671  int index;
672  /** The starting logical block address */
674  /** On write: The number of sectors.
675  On blank: 0x10000 as upper limit for relative progress steps */
676  int sectors;
677  /** On write: The current sector being processed.
678  On blank: Relative progress steps 0 to 0x10000 */
679  int sector;
680 
681  /* ts A61023 */
682  /* @since 0.2.6 */
683  /** The capacity of the drive buffer */
684  unsigned buffer_capacity;
685  /** The free space in the drive buffer (might be slightly outdated) */
687 
688  /* ts A61119 */
689  /* @since 0.2.6 */
690  /** The number of bytes sent to the drive buffer */
692  /** The minimum number of bytes stored in buffer during write.
693  (Caution: Before surely one buffer size of bytes was processed,
694  this value is 0xffffffff.)
695  */
696  unsigned buffer_min_fill;
697 };
698 
699 
700 /* ts A61226 */
701 /* @since 0.3.0 */
702 /** Description of a speed capability as reported by the drive in conjunction
703  with eventually loaded media. There can be more than one such object per
704  drive. So they are chained via .next and .prev , where NULL marks the end
705  of the chain. This list is set up by burn_drive_scan() and gets updated
706  by burn_drive_grab().
707  A copy may be obtained by burn_drive_get_speedlist() and disposed by
708  burn_drive_free_speedlist().
709  For technical background info see SCSI specs MMC and SPC:
710  mode page 2Ah (from SPC 5Ah MODE SENSE) , mmc3r10g.pdf , 6.3.11 Table 364
711  ACh GET PERFORMANCE, Type 03h , mmc5r03c.pdf , 6.8.5.3 Table 312
712 */
714 
715  /** Where this info comes from :
716  0 = misc , 1 = mode page 2Ah , 2 = ACh GET PERFORMANCE */
717  int source;
718 
719  /** The media type that was current at the time of report
720  -2 = state unknown, -1 = no media was loaded , else see
721  burn_disc_get_profile() */
723  char profile_name[80];
724 
725  /** The attributed capacity of appropriate media in logical block units
726  i.e. 2352 raw bytes or 2048 data bytes. -1 = capacity unknown. */
727  int end_lba;
728 
729  /** Speed is given in 1000 bytes/s , 0 = invalid. The numbers
730  are supposed to be usable with burn_drive_set_speed() */
733 
734  /** Expert info from ACh GET PERFORMANCE and/or mode page 2Ah.
735  Expect values other than 0 or 1 to get a meaning in future.*/
736  /* Rotational control: 0 = CLV/default , 1 = CAV */
737  int wrc;
738  /* 1 = drive promises reported performance over full media */
739  int exact;
740  /* 1 = suitable for mixture of read and write */
741  int mrw;
742 
743  /** List chaining. Use .next until NULL to iterate over the list */
746 };
747 
748 
749 /** Initialize the library.
750  This must be called before using any other functions in the library. It
751  may be called more than once with no effect.
752  It is possible to 'restart' the library by shutting it down and
753  re-initializing it. Once this was necessary if you follow the older and
754  more general way of accessing a drive via burn_drive_scan() and
755  burn_drive_grab(). See burn_drive_scan_and_grab() with its strong
756  urges and its explanations.
757  @return Nonzero if the library was able to initialize; zero if
758  initialization failed.
759 */
760 int burn_initialize(void);
761 
762 /** Shutdown the library.
763  This should be called before exiting your application. Make sure that all
764  drives you have grabbed are released <i>before</i> calling this.
765 */
766 void burn_finish(void);
767 
768 
769 /* ts A61002 */
770 /** Abort any running drive operation and eventually call burn_finish().
771 
772  You MUST shut down the busy drives if an aborting event occurs during a
773  burn run. For that you may call this function either from your own signal
774  handling code or indirectly by activating the built-in signal handling:
775  burn_set_signal_handling("my_app_name : ", NULL, 0);
776  Else you may eventually call burn_drive_cancel() on the active drives and
777  wait for them to assume state BURN_DRIVE_IDLE.
778  @param patience Maximum number of seconds to wait for drives to
779  finish.
780  @since 0.7.8 :
781  If this is -1, then only the cancel operations will
782  be performed and no burn_finish() will happen.
783  @param pacifier_func If not NULL: a function to produce appeasing messages.
784  See burn_abort_pacifier() for an example.
785  @param handle Opaque handle to be used with pacifier_func
786  @return 1 ok, all went well
787  0 had to leave a drive in unclean state
788  <0 severe error, do no use libburn again
789  @since 0.2.6
790 */
791 int burn_abort(int patience,
792  int (*pacifier_func)(void *handle, int patience, int elapsed),
793  void *handle);
794 
795 /** A pacifier function suitable for burn_abort.
796  @param handle If not NULL, a pointer to a text suitable for printf("%s")
797  @param patience Maximum number of seconds to wait
798  @param elapsed Elapsed number of seconds
799 */
800 int burn_abort_pacifier(void *handle, int patience, int elapsed);
801 
802 
803 /** ts A61006 : This is for development only. Not suitable for applications.
804  Set the verbosity level of the library. The default value is 0, which means
805  that nothing is output on stderr. The more you increase this, the more
806  debug output should be displayed on stderr for you.
807  @param level The verbosity level desired. 0 for nothing, higher positive
808  values for more information output.
809 */
810 void burn_set_verbosity(int level);
811 
812 /* ts A91111 */
813 /** Enable resp. disable logging of SCSI commands.
814  This call can be made at any time - even before burn_initialize().
815  It is in effect for all active drives and currently not very thread
816  safe for multiple drives.
817  @param flag Bitfield for control purposes. The default is 0.
818  bit0= log to file /tmp/libburn_sg_command_log
819  bit1= log to stderr
820  bit2= flush output after each line
821  @since 0.7.4
822 */
823 void burn_set_scsi_logging(int flag);
824 
825 /* ts A60813 */
826 /** Set parameters for behavior on opening device files. To be called early
827  after burn_initialize() and before any bus scan. But not mandatory at all.
828  Parameter value 1 enables a feature, 0 disables.
829  Default is (1,0,0). Have a good reason before you change it.
830  @param exclusive
831  0 = no attempt to make drive access exclusive.
832  1 = Try to open only devices which are not marked as busy
833  and try to mark them busy if opened sucessfully. (O_EXCL
834  on GNU/Linux , flock(LOCK_EX) on FreeBSD.)
835  2 = in case of a SCSI device, also try to open exclusively
836  the matching /dev/sr, /dev/scd and /dev/st .
837  One may select a device SCSI file family by adding
838  0 = default family
839  4 = /dev/sr%d
840  8 = /dev/scd%d
841  16 = /dev/sg%d
842  Do not use other values !
843  Add 32 to demand on GNU/Linux an exclusive lock by
844  fcntl(,F_SETLK,) after open() has succeeded.
845  @param blocking Try to wait for drives which do not open immediately but
846  also do not return an error as well. (O_NONBLOCK)
847  This might stall indefinitely with /dev/hdX hard disks.
848  @param abort_on_busy Unconditionally abort process when a non blocking
849  exclusive opening attempt indicates a busy drive.
850  Use this only after thorough tests with your app.
851  @since 0.2.2
852 */
853 void burn_preset_device_open(int exclusive, int blocking, int abort_on_busy);
854 
855 
856 /* ts A70223 */
857 /** Allows the use of media types which are implemented in libburn but not yet
858  tested. The list of those untested profiles is subject to change.
859  - Currently no media types are under test reservation -
860  If you really test such media, then please report the outcome on
861  libburn-hackers@pykix.org
862  If ever then this call should be done soon after burn_initialize() before
863  any drive scanning.
864  @param yes 1=allow all implemented profiles, 0=only tested media (default)
865  @since 0.3.4
866 */
867 void burn_allow_untested_profiles(int yes);
868 
869 
870 /* ts A60823 */
871 /** Aquire a drive with known device file address.
872 
873  This is the sysadmin friendly way to open one drive and to leave all
874  others untouched. It bundles the following API calls to form a
875  non-obtrusive way to use libburn:
876  burn_drive_add_whitelist() , burn_drive_scan() , burn_drive_grab()
877  You are *strongly urged* to use this call whenever you know the drive
878  address in advance.
879 
880  If not, then you have to use directly above calls. In that case, you are
881  *strongly urged* to drop any unintended drive which will be exclusively
882  occupied and not closed by burn_drive_scan().
883  This can be done by shutting down the library including a call to
884  burn_finish(). You may later start a new libburn session and should then
885  use the function described here with an address obtained after
886  burn_drive_scan() via burn_drive_d_get_adr(drive_infos[driveno].drive,adr).
887  Another way is to drop the unwanted drives by burn_drive_info_forget().
888 
889  Operating on multiple drives:
890 
891  Different than with burn_drive_scan() it is allowed to call
892  burn_drive_scan_and_grab() without giving up any other scanned drives. So
893  this call can be used to get a collection of more than one aquired drives.
894  The attempt to aquire the same drive twice will fail, though.
895 
896  Pseudo-drives:
897 
898  burn_drive_scan_and_grab() is able to aquire virtual drives which will
899  accept options much like a MMC burner drive. Many of those options will not
900  cause any effect, though. The address of a pseudo-drive begins with
901  prefix "stdio:" followed by a path.
902  Examples: "stdio:/tmp/pseudo_drive" , "stdio:/dev/null" , "stdio:-"
903 
904  If the path is empty, the result is a null-drive = drive role 0.
905  It pretends to have loaded no media and supports no reading or writing.
906 
907  If the path leads to an existing regular file, or to a not yet existing
908  file, or to an existing block device, then the result is a random access
909  stdio-drive capable of reading and writing = drive role 2.
910 
911  If the path leads to an existing file of any type other than directory,
912  then the result is a sequential write-only stdio-drive = drive role 3.
913 
914  The special address form "stdio:/dev/fd/{number}" is interpreted literally
915  as reference to open file descriptor {number}. This address form coincides
916  with real files on some systems, but it is in fact hardcoded in libburn.
917  Special address "stdio:-" means stdout = "stdio:/dev/fd/1".
918  The role of such a drive is determined by the file type obtained via
919  fstat({number}).
920 
921  Roles 2 and 3 perform all their eventual data transfer activities on a file
922  via standard i/o functions open(2), lseek(2), read(2), write(2), close(2).
923  The media profile is reported as 0xffff. Write space information from those
924  media is not necessarily realistic.
925 
926  The capabilities of role 2 resemble DVD-RAM but it can simulate writing.
927  If the path does not exist in the filesystem yet, it is attempted to create
928  it as a regular file as soon as write operations are started.
929 
930  The capabilities of role 3 resemble a blank DVD-R. Nevertheless each
931  burn_disc_write() run may only write a single track.
932 
933  One may distinguish pseudo-drives from MMC drives by call
934  burn_drive_get_drive_role().
935 
936  @param drive_infos On success returns a one element array with the drive
937  (cdrom/burner). Thus use with driveno 0 only. On failure
938  the array has no valid elements at all.
939  The returned array should be freed via burn_drive_info_free()
940  when it is no longer needed.
941  This is a result from call burn_drive_scan(). See there.
942  Use with driveno 0 only.
943  @param adr The device file address of the desired drive. Either once
944  obtained by burn_drive_d_get_adr() or composed skillfully by
945  application resp. its user. E.g. "/dev/sr0".
946  Consider to preprocess it by burn_drive_convert_fs_adr().
947  @param load Nonzero to make the drive attempt to load a disc (close its
948  tray door, etc).
949  @return 1 = success , 0 = drive not found , -1 = other error
950  @since 0.2.2
951 */
952 int burn_drive_scan_and_grab(struct burn_drive_info *drive_infos[],
953  char* adr, int load);
954 
955 
956 /* ts A51221 */
957 /* @since 0.2.2 */
958 /** Maximum number of particularly permissible drive addresses */
959 #define BURN_DRIVE_WHITELIST_LEN 255
960 
961 /** Add a device to the list of permissible drives. As soon as some entry is in
962  the whitelist all non-listed drives are banned from scanning.
963  @return 1 success, <=0 failure
964  @since 0.2.2
965 */
966 int burn_drive_add_whitelist(char *device_address);
967 
968 /** Remove all drives from whitelist. This enables all possible drives. */
969 void burn_drive_clear_whitelist(void);
970 
971 
972 /** Scan for drives. This function MUST be called until it returns nonzero.
973  In case of re-scanning:
974  All pointers to struct burn_drive and all struct burn_drive_info arrays
975  are invalidated by using this function. Do NOT store drive pointers across
976  calls to this function !
977  To avoid invalid pointers one MUST free all burn_drive_info arrays
978  by burn_drive_info_free() before calling burn_drive_scan() a second time.
979  If there are drives left, then burn_drive_scan() will refuse to work.
980 
981  After this call all drives depicted by the returned array are subject
982  to eventual (O_EXCL) locking. See burn_preset_device_open(). This state
983  ends either with burn_drive_info_forget() or with burn_drive_release().
984  It is unfriendly to other processes on the system to hold drives locked
985  which one does not definitely plan to use soon.
986  @param drive_infos Returns an array of drive info items (cdroms/burners).
987  The returned array must be freed by burn_drive_info_free()
988  before burn_finish(), and also before calling this function
989  burn_drive_scan() again.
990  @param n_drives Returns the number of drive items in drive_infos.
991  @return 0 while scanning is not complete
992  >0 when it is finished sucessfully,
993  <0 when finished but failed.
994 */
995 int burn_drive_scan(struct burn_drive_info *drive_infos[],
996  unsigned int *n_drives);
997 
998 /* ts A60904 : ticket 62, contribution by elmom */
999 /** Release memory about a single drive and any exclusive lock on it.
1000  Become unable to inquire or grab it. Expect FATAL consequences if you try.
1001  @param drive_info pointer to a single element out of the array
1002  obtained from burn_drive_scan() : &(drive_infos[driveno])
1003  @param force controls degree of permissible drive usage at the moment this
1004  function is called, and the amount of automatically provided
1005  drive shutdown :
1006  0= drive must be ungrabbed and BURN_DRIVE_IDLE
1007  1= try to release drive resp. accept BURN_DRIVE_GRABBING
1008  Use these two only. Further values are to be defined.
1009  @return 1 on success, 2 if drive was already forgotten,
1010  0 if not permissible, <0 on other failures,
1011  @since 0.2.2
1012 */
1013 int burn_drive_info_forget(struct burn_drive_info *drive_info, int force);
1014 
1015 
1016 /** When no longer needed, free a whole burn_drive_info array which was
1017  returned by burn_drive_scan().
1018  For freeing single drive array elements use burn_drive_info_forget().
1019 */
1020 void burn_drive_info_free(struct burn_drive_info drive_infos[]);
1021 
1022 
1023 /* ts A60823 */
1024 /* @since 0.2.2 */
1025 /** Maximum length+1 to expect with a drive device file address string */
1026 #define BURN_DRIVE_ADR_LEN 1024
1027 
1028 /* ts A70906 */
1029 /** Inquire the device file address of the given drive.
1030  @param drive The drive to inquire.
1031  @param adr An application provided array of at least BURN_DRIVE_ADR_LEN
1032  characters size. The device file address gets copied to it.
1033  @return >0 success , <=0 error (due to libburn internal problem)
1034  @since 0.4.0
1035 */
1036 int burn_drive_d_get_adr(struct burn_drive *drive, char adr[]);
1037 
1038 /* A60823 */
1039 /** Inquire the device file address of a drive via a given drive_info object.
1040  (Note: This is a legacy call.)
1041  @param drive_info The drive to inquire.Usually some &(drive_infos[driveno])
1042  @param adr An application provided array of at least BURN_DRIVE_ADR_LEN
1043  characters size. The device file address gets copied to it.
1044  @return >0 success , <=0 error (due to libburn internal problem)
1045  @since 0.2.6
1046 */
1047 int burn_drive_get_adr(struct burn_drive_info *drive_info, char adr[]);
1048 
1049 
1050 /* ts A60922 ticket 33 */
1051 /** Evaluate whether the given address would be a drive device file address
1052  which could be listed by a run of burn_drive_scan(). No check is made
1053  whether a device file with this address exists or whether it leads
1054  to a usable MMC drive.
1055  @return 1 means yes, 0 means no
1056  @since 0.2.6
1057 */
1058 int burn_drive_is_enumerable_adr(char *adr);
1059 
1060 /* ts A60922 ticket 33 */
1061 /** Try to convert a given existing filesystem address into a drive device file
1062  address. This succeeds with symbolic links or if a hint about the drive's
1063  system address can be read from the filesystem object and a matching drive
1064  is found.
1065  @param path The address of an existing file system object
1066  @param adr An application provided array of at least BURN_DRIVE_ADR_LEN
1067  characters size. The device file address gets copied to it.
1068  @return 1 = success , 0 = failure , -1 = severe error
1069  @since 0.2.6
1070 */
1071 int burn_drive_convert_fs_adr(char *path, char adr[]);
1072 
1073 /* ts A60923 */
1074 /** Try to convert a given SCSI address of bus,host,channel,target,lun into
1075  a drive device file address. If a SCSI address component parameter is < 0
1076  then it is not decisive and the first enumerated address which matches
1077  the >= 0 parameters is taken as result.
1078  Note: bus and (host,channel) are supposed to be redundant.
1079  @param bus_no "Bus Number" (something like a virtual controller)
1080  @param host_no "Host Number" (something like half a virtual controller)
1081  @param channel_no "Channel Number" (other half of "Host Number")
1082  @param target_no "Target Number" or "SCSI Id" (a device)
1083  @param lun_no "Logical Unit Number" (a sub device)
1084  @param adr An application provided array of at least BURN_DRIVE_ADR_LEN
1085  characters size. The device file address gets copied to it.
1086  @return 1 = success , 0 = failure , -1 = severe error
1087  @since 0.2.6
1088 */
1089 int burn_drive_convert_scsi_adr(int bus_no, int host_no, int channel_no,
1090  int target_no, int lun_no, char adr[]);
1091 
1092 /* ts B10728 */
1093 /** Try to convert a given drive device file address into the address of a
1094  symbolic link that points to this drive address.
1095  Modern GNU/Linux systems may shuffle drive addresses from boot to boot.
1096  The udev daemon is supposed to create links which always point to the
1097  same drive, regardless of its system address.
1098  This call tries to find such links.
1099  @param dev_adr Should contain a drive address as returned by
1100  burn_drive_scan().
1101  @param link_adr An application provided array of at least
1102  BURN_DRIVE_ADR_LEN characters size. The found link
1103  address gets copied to it.
1104  @param dir_adr The address of the directory where to look for links.
1105  Normally: "/dev"
1106  @param templ An array of pointers to name templates, which
1107  links have to match. A symbolic link in dir_adr matches
1108  a name template if it begins by that text. E.g.
1109  link address "/dev/dvdrw1" matches template "dvdrw".
1110  If templ is NULL, then the default array gets used:
1111  {"dvdrw", "cdrw", "dvd", "cdrom", "cd"}
1112  If several links would match, then a link will win,
1113  which matches the template with the lowest array index.
1114  Among these candidates, the one with the lowest strcmp()
1115  rank will be chosen as link_adr.
1116  @param num_templ Number of array elements in templ.
1117  @param flag Bitfield for control purposes. Unused yet. Submit 0.
1118  @return <0 severe error, 0 failed to search, 2 nothing found
1119  1 success, link_adr is valid
1120  @since 1.1.4
1121 */
1122 int burn_lookup_device_link(char *dev_adr, char link_adr[],
1123  char *dir_adr, char **templ, int num_templ, int flag);
1124 
1125 /* ts A60923 - A61005 */
1126 /** Try to obtain bus,host,channel,target,lun from path. If there is an SCSI
1127  address at all, then this call should succeed with a drive device file
1128  address obtained via burn_drive_d_get_adr(). It is also supposed to
1129  succeed with any device file of a (possibly emulated) SCSI device.
1130  @return 1 = success , 0 = failure , -1 = severe error
1131  @since 0.2.6
1132 */
1133 int burn_drive_obtain_scsi_adr(char *path, int *bus_no, int *host_no,
1134  int *channel_no, int *target_no, int *lun_no);
1135 
1136 /** Grab a drive. This must be done before the drive can be used (for reading,
1137  writing, etc).
1138  @param drive The drive to grab. This is found in a returned
1139  burn_drive_info struct.
1140  @param load Nonzero to make the drive attempt to load a disc (close its
1141  tray door, etc).
1142  @return 1 if it was possible to grab the drive, else 0
1143 */
1144 int burn_drive_grab(struct burn_drive *drive, int load);
1145 
1146 /* ts B00114 */
1147 /* Probe available CD write modes and block types. In earlier versions this
1148  was done unconditionally on drive examination or aquiration. But it is
1149  lengthy and obtrusive, up to spoiling burn runs on the examined drives.
1150  So now this probing is omitted by default. All drives which announce to be
1151  capable of CD or DVD writing, get blindly attributed the capability for
1152  SAO and TAO. Applications which are interested in RAW modes or want to
1153  rely on the traditional write mode information, may use this call.
1154  @param drive_info drive object to be inquired
1155  @return >0 indicates success, <=0 means failure
1156  @since 0.7.6
1157 */
1158 int burn_drive_probe_cd_write_modes(struct burn_drive_info *drive_info);
1159 
1160 /* ts A90824 */
1161 /** Calm down or alert a drive. Some drives stay alert after reading for
1162  quite some time. This saves time with the startup for the next read
1163  operation but also causes noise and consumes extra energy. It makes
1164  sense to calm down the drive if no read operation is expected for the
1165  next few seconds. The drive will get alert automatically if operations
1166  are required.
1167  @param d The drive to influence.
1168  @param flag Bitfield for control purposes
1169  bit0= become alert (else start snoozing)
1170  This is not mandatory to allow further drive operations
1171  @return 1= success , 0= drive role not suitable for calming
1172  @since 0.7.0
1173 */
1174 int burn_drive_snooze(struct burn_drive *d, int flag);
1175 
1176 
1177 /** Re-assess drive and media status. This should be done after a drive
1178  underwent a status change and shall be further used without intermediate
1179  burn_drive_release(), burn_drive_grab(). E.g. after blanking or burning.
1180  @param drive The already grabbed drive to re-assess.
1181  @param flag Unused yet. Submit 0.
1182  @return 1 success , <= 0 could not determine drive and media state
1183  @since 1.1.8
1184 */
1185 int burn_drive_re_assess(struct burn_drive *d, int flag);
1186 
1187 
1188 /** Release a drive. This should not be done until the drive is no longer
1189  busy (see burn_drive_get_status).
1190  @param drive The drive to release.
1191  @param eject Nonzero to make the drive eject the disc in it.
1192 */
1193 void burn_drive_release(struct burn_drive *drive, int eject);
1194 
1195 
1196 /* ts A70918 */
1197 /** Like burn_drive_release() but keeping the drive tray closed and its
1198  eject button disabled. This physically locked drive state will last until
1199  the drive is grabbed again and released via burn_drive_release().
1200  Programs like eject, cdrecord, growisofs will break that ban too.
1201  @param d The drive to release and leave locked.
1202  @param flag Bitfield for control purposes (unused yet, submit 0)
1203  @return 1 means success, <=0 means failure
1204  @since 0.4.0
1205 */
1206 int burn_drive_leave_locked(struct burn_drive *d, int flag);
1207 
1208 
1209 /** Returns what kind of disc a drive is holding. This function may need to be
1210  called more than once to get a proper status from it. See burn_disc_status
1211  for details.
1212  @param drive The drive to query for a disc.
1213  @return The status of the drive, or what kind of disc is in it.
1214  Note: BURN_DISC_UNGRABBED indicates wrong API usage
1215 */
1216 enum burn_disc_status burn_disc_get_status(struct burn_drive *drive);
1217 
1218 
1219 /* ts A61020 */
1220 /** WARNING: This revives an old bug-like behavior that might be dangerous.
1221  Sets the drive status to BURN_DISC_BLANK if it is BURN_DISC_UNREADY
1222  or BURN_DISC_UNSUITABLE. Thus marking media as writable which actually
1223  failed to declare themselves either blank or (partially) filled.
1224  @return 1 drive status has been set , 0 = unsuitable drive status
1225  @since 0.2.6
1226 */
1227 int burn_disc_pretend_blank(struct burn_drive *drive);
1228 
1229 
1230 /* ts A61106 */
1231 /** WARNING: This overrides the safety measures against unsuitable media.
1232  Sets the drive status to BURN_DISC_FULL if it is BURN_DISC_UNREADY
1233  or BURN_DISC_UNSUITABLE. Thus marking media as blankable which actually
1234  failed to declare themselves either blank or (partially) filled.
1235  @since 0.2.6
1236 */
1237 int burn_disc_pretend_full(struct burn_drive *drive);
1238 
1239 
1240 /* ts A61021 */
1241 /** Reads ATIP information from inserted media. To be obtained via
1242  burn_drive_get_write_speed(), burn_drive_get_min_write_speed(),
1243  burn_drive_get_start_end_lba(). The drive must be grabbed for this call.
1244  @param drive The drive to query.
1245  @return 1=sucess, 0=no valid ATIP info read, -1 severe error
1246  @since 0.2.6
1247 */
1248 int burn_disc_read_atip(struct burn_drive *drive);
1249 
1250 
1251 /* ts A61020 */
1252 /** Returns start and end lba of the media which is currently inserted
1253  in the given drive. The drive has to be grabbed to have hope for reply.
1254  Shortcomming (not a feature): unless burn_disc_read_atip() was called
1255  only blank media will return valid info.
1256  @param drive The drive to query.
1257  @param start_lba Returns the start lba value
1258  @param end_lba Returns the end lba value
1259  @param flag Bitfield for control purposes (unused yet, submit 0)
1260  @return 1 if lba values are valid , 0 if invalid
1261  @since 0.2.6
1262 */
1263 int burn_drive_get_start_end_lba(struct burn_drive *drive,
1264  int *start_lba, int *end_lba, int flag);
1265 
1266 
1267 /* ts A90902 */
1268 /** Guess the manufacturer name of CD media from the ATIP addresses of lead-in
1269  and lead-out. (Currently only lead-in is interpreted. Lead-out may in
1270  future be used to identify the media type in more detail.)
1271  The parameters of this call should be obtained by burn_disc_read_atip(d),
1272  burn_drive_get_start_end_lba(d, &start_lba, &end_lba, 0),
1273  burn_lba_to_msf(start_lba, &m_li, &s_li, &f_li) and
1274  burn_lba_to_msf(end_lba, &m_lo, &s_lo, &f_lo).
1275  @param m_li "minute" part of ATIP lead-in resp. start_lba
1276  @param s_li "second" of lead-in resp. start_lba
1277  @param f_li "frame" of lead-in
1278  @param m_lo "minute" part of ATIP lead-out
1279  @param s_lo "second" of lead-out
1280  @param f_lo "frame" of lead-out
1281  @param flag Bitfield for control purposes,
1282  bit0= append a text "(aka ...)" to reply if other brands or
1283  vendor names are known.
1284  @return Printable text or NULL on memory shortage.
1285  Dispose by free() when no longer needed.
1286  @since 0.7.2
1287 */
1288 char *burn_guess_cd_manufacturer(int m_li, int s_li, int f_li,
1289  int m_lo, int s_lo, int f_lo, int flag);
1290 
1291 /* ts A90909 */
1292 /** Retrieve some media information which is mainly specific to CD. For other
1293  media only the bits in reply parameter valid are supposed to be meaningful.
1294  @param d The drive to query.
1295  @param disc_type A string saying either "CD-DA or CD-ROM", or "CD-I",
1296  or ""CD-ROM XA", or "undefined".
1297  @param disc_id A 32 bit number read from the media. (Meaning unclear yet)
1298  @param bar_code 8 hex digits from a barcode on media read by the drive
1299  (if the drive has a bar code reader built in).
1300  @param app_code The Host Application Code which must be set in the Write
1301  Parameters Page if the media is not unrestricted (URU==0).
1302  @param valid Replies bits which indicate the validity of other reply
1303  parameters or the state of certain CD info bits:
1304  bit0= disc_type is valid
1305  bit1= disc_id is valid
1306  bit2= bar_code is valid
1307  bit3= disc_app_code is valid
1308  bit4= Disc is unrestricted (URU bit, 51h READ DISC INFO)
1309  This seems to be broken with my drives. The bit is
1310  0 and the validity bit for disc_app_code is 0 too.
1311  bit5= Disc is nominally erasable (Erasable bit)
1312  This will be set with overwriteable media which
1313  libburn normally considers to be unerasable blank.
1314  @return 1 success, <= 0 an error occured
1315  @since 0.7.2
1316 */
1317 int burn_disc_get_cd_info(struct burn_drive *d, char disc_type[80],
1318  unsigned int *disc_id, char bar_code[9], int *app_code,
1319  int *valid);
1320 
1321 /* ts B11201 */
1322 /** Read the array of CD-TEXT packs from the Lead-in of an audio CD.
1323  Each pack consists of 18 bytes, of which 4 are header. 12 bytes are pieces
1324  of 0-terminated texts or binary data. 2 bytes hold a CRC.
1325  For a description of the format of the array, see file doc/cdtext.txt.
1326  @param d The drive to query.
1327  @param text_packs Will point to an allocated memory buffer with CD-TEXT.
1328  It will only contain text packs, and not be prepended
1329  by the TOC header of four bytes, which gets stored with
1330  file cdtext.dat by cdrecord -vv -toc. (The first two of
1331  these bytes are supposed to hold the number of CD-TEXT
1332  bytes + 2. The other two bytes are supposed to be 0.)
1333  Dispose this buffer by free(), when no longer needed.
1334  @param num_packs Will tell the number of text packs, i.e. the number of
1335  bytes in text_packs divided by 18.
1336  @param flag Bitfield for control purposes,
1337  Unused yet. Submit 0.
1338  @return 1 success, 0= no CD-TEXT found, < 0 an error occured
1339  @since 1.2.0
1340 */
1341 int burn_disc_get_leadin_text(struct burn_drive *d,
1342  unsigned char **text_packs, int *num_packs,
1343  int flag);
1344 
1345 /* ts B00924 */
1346 /** Read the current usage of the eventual BD Spare Area. This area gets
1347  reserved on BD media during formatting. During writing it is used to
1348  host replacements of blocks which failed the checkread immediately after
1349  writing.
1350  This call applies only to recordable BD media. I.e. profiles 0x41 to 0x43.
1351  @param d The drive to query.
1352  @param alloc_blocks Returns the number of blocks reserved as Spare Area
1353  @param free_blocks Returns the number of yet unused blocks in that area
1354  @param flag Bitfield for control purposes (unused yet, submit 0)
1355  @return 1 = reply prarameters are valid,
1356  <=0 = reply is invalid (e.g. because no BD profile)
1357  @since 0.8.8
1358 */
1359 int burn_disc_get_bd_spare_info(struct burn_drive *d,
1360  int *alloc_blocks, int *free_blocks, int flag);
1361 
1362 /* ts B10801 */
1363 /** Retrieve some media information which is mainly specific to media of
1364  the DVD-R family: DVD-R , DVD-RW , DVD-R DL , HD DVD-R
1365  Currently the information cannot be retrieved from other media types.
1366  @param d The drive to query.
1367  @param disk_category returns DVD Book to which the media complies
1368  @param book_name returns a pointer to the book name of disk_category.
1369  This memory is static. Do not alter or free it !
1370  @param part_version returns the Media Version in the DVD Book
1371  @param num_layers returns the number of media layers
1372  @param num_blocks returns the number of blocks between pysical start
1373  and physical end of the media
1374  @param flag Bitfield for control purposes (unused yet, submit 0)
1375  @return 1 = reply prarameters are valid,
1376  <=0 = reply is invalid (e.g. because no DVD-R)
1377  @since 1.1.4
1378 */
1379 int burn_disc_get_phys_format_info(struct burn_drive *d, int *disk_category,
1380  char **book_name, int *part_version, int *num_layers,
1381  int *num_blocks, int flag);
1382 
1383 /* ts A61110 */
1384 /** Read start lba and Next Writeable Address of a track from media.
1385  Usually a track lba is obtained from the result of burn_track_get_entry().
1386  This call retrieves an updated lba, eventual nwa, and can address the
1387  invisible track to come.
1388  The drive must be grabbed for this call. One may not issue this call
1389  during ongoing burn_disc_write() or burn_disc_erase().
1390  @param d The drive to query.
1391  @param o If not NULL: write parameters to be set on drive before query
1392  @param trackno 0=next track to come, >0 number of existing track
1393  The first existing track on a CD may have a number higher
1394  than 1. Use burn_session_get_start_tno() to inquire this
1395  start number.
1396  @param lba return value: start lba
1397  @param nwa return value: Next Writeable Address
1398  @return 1=nwa is valid , 0=nwa is not valid , -1=error
1399  @since 0.2.6
1400 */
1401 int burn_disc_track_lba_nwa(struct burn_drive *d, struct burn_write_opts *o,
1402  int trackno, int *lba, int *nwa);
1403 
1404 /* ts B10525 */
1405 /** Tells whether a previous attempt to determine the Next Writeable Address
1406  of the upcomming track reveiled that the READ TRACK INFORMATION Damage Bit
1407  is set for this track, resp. that no valid writable address is available.
1408  See MMC-5 6.27.3.7 Damage Bit, 6.27.3.11 NWA_V (NWA valid)
1409  @param d The drive to query.
1410  @param flag Bitfield for control purposes (unused yet, submit 0)
1411  @return 0= Looks ok: Damage Bit is not set, NWA_V is set
1412  1= Damaged and theoretically writable (NWA_V is set)
1413  2= Not writable: NWA_V is not set
1414  3= Damaged and not writable (NWA_V is not set),
1415  @since 1.1.0
1416 */
1417 int burn_disc_next_track_is_damaged(struct burn_drive *d, int flag);
1418 
1419 /* ts B10527 */
1420 /** Try to close the last track and session of media which have bit0 set in
1421  the return value of call burn_disc_next_track_is_damaged().
1422  Whether it helps depends much on the reason why the media is reported
1423  as damaged by the drive.
1424  This call works only for profiles 0x09 CD-R, 0x0a CD-RW, 0x11 DVD-R,
1425  0x14 DVD-RW sequential, 0x1b DVD+R, 0x2b DVD+R DL, 0x41 BD-R sequential.
1426  Note: After writing it is advised to give up the drive and to grab it again
1427  in order to learn about its view on the new media state.
1428  @param o Write options created by burn_write_opts_new() and
1429  manipulated by burn_write_opts_set_multi().
1430  burn_write_opts_set_write_type() should be set to
1431  BURN_WRITE_TAO, burn_write_opts_set_simulate() should be
1432  set to 0.
1433  @param flag Bitfield for control purposes
1434  bit0= force close, even if no damage was seen
1435  @return <=0 media not marked as damaged, or media type not suitable,
1436  or closing attempted but failed
1437  1= attempt finished without error indication
1438  @since 1.1.0
1439 */
1440 int burn_disc_close_damaged(struct burn_write_opts *o, int flag);
1441 
1442 
1443 /* ts A70131 */
1444 /** Read start lba of the first track in the last complete session.
1445  This is the first parameter of mkisofs option -C. The second parameter
1446  is nwa as obtained by burn_disc_track_lba_nwa() with trackno 0.
1447  @param d The drive to query.
1448  @param start_lba returns the start address of that track
1449  @return <= 0 : failure, 1 = ok
1450  @since 0.3.2
1451 */
1452 int burn_disc_get_msc1(struct burn_drive *d, int *start_lba);
1453 
1454 
1455 /* ts A70213 */
1456 /** Return the best possible estimation of the currently available capacity of
1457  the media. This might depend on particular write option settings. For
1458  inquiring the space with such a set of options, the drive has to be
1459  grabbed and BURN_DRIVE_IDLE. If not, then one will only get a canned value
1460  from the most recent automatic inquiry (e.g. during last drive grabbing).
1461  An eventual start address from burn_write_opts_set_start_byte() will be
1462  subtracted from the obtained capacity estimation. Negative results get
1463  defaulted to 0.
1464  If the drive is actually a file in a large filesystem or a large block
1465  device, then the capacity is curbed to a maximum of 0x7ffffff0 blocks
1466  = 4 TB - 32 KB.
1467  @param d The drive to query.
1468  @param o If not NULL: write parameters to be set on drive before query
1469  @return number of most probably available free bytes
1470  @since 0.3.4
1471 */
1472 off_t burn_disc_available_space(struct burn_drive *d,
1473  struct burn_write_opts *o);
1474 
1475 /* ts A61202 */
1476 /** Tells the MMC Profile identifier of the loaded media. The drive must be
1477  grabbed in order to get a non-zero result.
1478  libburn currently writes only to profiles
1479  0x09 "CD-R"
1480  0x0a "CD-RW"
1481  0x11 "DVD-R sequential recording"
1482  0x12 "DVD-RAM"
1483  0x13 "DVD-RW restricted overwrite"
1484  0x14 "DVD-RW sequential recording",
1485  0x15 "DVD-R/DL sequential recording",
1486  0x1a "DVD+RW"
1487  0x1b "DVD+R",
1488  0x2b "DVD+R/DL",
1489  0x41 "BD-R sequential recording",
1490  0x43 "BD-RE",
1491  0xffff "stdio file"
1492  Note: 0xffff is not a MMC profile but a libburn invention.
1493  Read-only are the profiles
1494  0x08 "CD-ROM",
1495  0x10 "DVD-ROM",
1496  0x40 "BD-ROM",
1497  Read-only for now is this BD-R profile (testers wanted)
1498  0x42 "BD-R random recording"
1499  Empty drives are supposed to report
1500  0x00 ""
1501  @param d The drive where the media is inserted.
1502  @param pno Profile Number. See also mmc5r03c.pdf, table 89
1503  @param name Profile Name (see above list, unknown profiles have empty name)
1504  @return 1 profile is valid, 0 no profile info available
1505  @since 0.3.0
1506 */
1507 int burn_disc_get_profile(struct burn_drive *d, int *pno, char name[80]);
1508 
1509 
1510 /* ts A90903 : API */
1511 /** Obtain product id and standards defined media codes.
1512  The product id is a printable string which is supposed to be the same
1513  for identical media but should vary with non-identical media. Some media
1514  do not allow to obtain such an id at all.
1515  The pair (profile_number, product_id) should be the best id to identify
1516  media with identical product specifications.
1517  The reply parameters media_code1 and media_code2 can be used with
1518  burn_guess_manufacturer()
1519  The reply parameters have to be disposed by free() when no longer needed.
1520  @param d The drive where the media is inserted.
1521  @param product_id Reply: Printable text depicting manufacturer and
1522  eventually media id.
1523  @param media_code1 Reply: The eventual manufacturer identification as read
1524  from DVD/BD media or a text "XXmYYsZZf" from CD media
1525  ATIP lead-in.
1526  @param media_code2 The eventual media id as read from DVD+/BD media or a
1527  text "XXmYYsZZf" from CD ATIP lead-out.
1528  @param book_type Book type text for DVD and BD.
1529  Caution: is NULL with CD, even if return value says ok.
1530  @param flag Bitfield for control purposes
1531  bit0= do not escape " _/" (not suitable for
1532  burn_guess_manufacturer())
1533  @return 1= ok, product_id and media codes are valid,
1534  0= no product id_available, reply parameters are NULL
1535  <0= error
1536  @since 0.7.2
1537 */
1538 int burn_disc_get_media_id(struct burn_drive *d,
1539  char **product_id, char **media_code1, char **media_code2,
1540  char **book_type, int flag);
1541 
1542 
1543 /* ts A90904 */
1544 /** Guess the name of a manufacturer by profile number, manufacturer code
1545  and media code. The profile number can be obtained by
1546  burn_disc_get_profile(), the other two parameters can be obtained as
1547  media_code1 and media_code2 by burn_get_media_product_id().
1548  @param profile_no Profile number (submit -1 if not known)
1549  @param manuf_code Manufacturer code from media (e.g. "RICOHJPN")
1550  @param media_code Media ID code from media (e.g. "W11")
1551  @param flag Bitfield for control purposes, submit 0
1552  @return Printable text or NULL on memory shortage.
1553  If the text begins with "Unknown " then no item of the
1554  manufacturer list matched the codes.
1555  Dispose by free() when no longer needed.
1556  @since 0.7.2
1557 */
1558 char *burn_guess_manufacturer(int profile_no,
1559  char *manuf_code, char *media_code, int flag);
1560 
1561 
1562 /** Tells whether a disc can be erased or not
1563  @param d The drive to inquire.
1564  @return Non-zero means erasable
1565 */
1566 int burn_disc_erasable(struct burn_drive *d);
1567 
1568 /** Returns the progress and status of a drive.
1569  @param drive The drive to query busy state for.
1570  @param p Returns the progress of the operation, NULL if you don't care
1571  @return the current status of the drive. See also burn_drive_status.
1572 */
1573 enum burn_drive_status burn_drive_get_status(struct burn_drive *drive,
1574  struct burn_progress *p);
1575 
1576 /** Creates a write_opts struct for burning to the specified drive.
1577  The returned object must later be freed with burn_write_opts_free().
1578  @param drive The drive to write with
1579  @return The write_opts, NULL on error
1580 */
1581 struct burn_write_opts *burn_write_opts_new(struct burn_drive *drive);
1582 
1583 
1584 /* ts A70901 */
1585 /** Inquires the drive associated with a burn_write_opts object.
1586  @param opts object to inquire
1587  @return pointer to drive
1588  @since 0.4.0
1589 */
1590 struct burn_drive *burn_write_opts_get_drive(struct burn_write_opts *opts);
1591 
1592 
1593 /** Frees a write_opts struct created with burn_write_opts_new
1594  @param opts write_opts to free
1595 */
1596 void burn_write_opts_free(struct burn_write_opts *opts);
1597 
1598 /** Creates a read_opts struct for reading from the specified drive
1599  must be freed with burn_read_opts_free
1600  @param drive The drive to read from
1601  @return The read_opts
1602 */
1603 struct burn_read_opts *burn_read_opts_new(struct burn_drive *drive);
1604 
1605 /** Frees a read_opts struct created with burn_read_opts_new
1606  @param opts write_opts to free
1607 */
1608 void burn_read_opts_free(struct burn_read_opts *opts);
1609 
1610 /** Erase a disc in the drive. The drive must be grabbed successfully BEFORE
1611  calling this functions. Always ensure that the drive reports a status of
1612  BURN_DISC_FULL before calling this function. An erase operation is not
1613  cancellable, as control of the operation is passed wholly to the drive and
1614  there is no way to interrupt it safely.
1615  @param drive The drive with which to erase a disc.
1616  Only drive roles 1 (MMC) and 5 (stdio random write-only)
1617  support erasing.
1618  @param fast Nonzero to do a fast erase, where only the disc's headers are
1619  erased; zero to erase the entire disc.
1620  With DVD-RW, fast blanking yields media capable only of DAO.
1621 */
1622 void burn_disc_erase(struct burn_drive *drive, int fast);
1623 
1624 
1625 /* ts A70101 - A70417 */
1626 /** Format media for use with libburn. This currently applies to DVD-RW
1627  in state "Sequential Recording" (profile 0014h) which get formatted to
1628  state "Restricted Overwrite" (profile 0013h). DVD+RW can be "de-iced"
1629  by setting bit2 of flag. DVD-RAM and BD-RE may get formatted initially
1630  or re-formatted to adjust their Defect Managment.
1631  This function usually returns while the drive is still in the process
1632  of formatting. The formatting is done, when burn_drive_get_status()
1633  returns BURN_DRIVE_IDLE. This may be immediately after return or may
1634  need several thousand seconds to occur.
1635  @param drive The drive with the disc to format.
1636  @param size The size in bytes to be used with the format command. It should
1637  be divisible by 32*1024. The effect of this parameter may
1638  depend on the media profile and on parameter flag.
1639  @param flag Bitfield for control purposes:
1640  bit0= after formatting, write the given number of zero-bytes
1641  to the media and eventually perform preliminary closing.
1642  bit1+2: size mode
1643  0 = use parameter size as far as it makes sense
1644  1 = insist in size 0 even if there is a better default known
1645  (on DVD-RAM or BD-R identical to size mode 0,
1646  i.e. they never get formatted with payload size 0)
1647  2 = without bit7: format to maximum available size
1648  with bit7 : take size from indexed format descriptor
1649  3 = without bit7: format to default size
1650  with bit7 : take size from indexed format descriptor
1651  bit3= -reserved-
1652  bit4= enforce re-format of (partly) formatted media
1653  bit5= try to disable eventual defect management
1654  bit6= try to avoid lengthy media certification
1655  bit7, bit8 to bit15 =
1656  bit7 enables MMC expert application mode (else libburn
1657  tries to choose a suitable format type):
1658  If it is set then bit8 to bit15 contain the index of
1659  the format to use. See burn_disc_get_formats(),
1660  burn_disc_get_format_descr().
1661  Acceptable types are: 0x00, 0x01, 0x10, 0x11, 0x13,
1662  0x15, 0x26, 0x30, 0x31, 0x32.
1663  If bit7 is set, then bit4 is set automatically.
1664  bit16= enable POW on blank BD-R
1665  @since 0.3.0
1666 */
1667 void burn_disc_format(struct burn_drive *drive, off_t size, int flag);
1668 
1669 
1670 /* ts A70112 */
1671 /* @since 0.3.0 */
1672 /** Possible formatting status values */
1673 #define BURN_FORMAT_IS_UNFORMATTED 1
1674 #define BURN_FORMAT_IS_FORMATTED 2
1675 #define BURN_FORMAT_IS_UNKNOWN 3
1676 
1677 /* ts A70112 */
1678 /** Inquire the formatting status, the associated sizes and the number of
1679  available formats. The info is media specific and stems from MMC command
1680  23h READ FORMAT CAPACITY. See mmc5r03c.pdf 6.24 for background details.
1681  Media type can be determined via burn_disc_get_profile().
1682  @param drive The drive with the disc to format.
1683  @param status The current formatting status of the inserted media.
1684  See BURN_FORMAT_IS_* macros. Note: "unknown" is the
1685  legal status for quick formatted, yet unwritten DVD-RW.
1686  @param size The size in bytes associated with status.
1687  unformatted: the maximum achievable size of the media
1688  formatted: the currently formatted capacity
1689  unknown: maximum capacity of drive or of media
1690  @param bl_sas Additional info "Block Length/Spare Area Size".
1691  Expected to be constantly 2048 for non-BD media.
1692  @param num_formats The number of available formats. To be used with
1693  burn_disc_get_format_descr() to obtain such a format
1694  and eventually with burn_disc_format() to select one.
1695  @return 1 reply is valid , <=0 failure
1696  @since 0.3.0
1697 */
1698 int burn_disc_get_formats(struct burn_drive *drive, int *status, off_t *size,
1699  unsigned *bl_sas, int *num_formats);
1700 
1701 /* ts A70112 */
1702 /** Inquire parameters of an available media format.
1703  @param drive The drive with the disc to format.
1704  @param index The index of the format item. Beginning with 0 up to reply
1705  parameter from burn_disc_get_formats() : num_formats - 1
1706  @param type The format type. See mmc5r03c.pdf, 6.5, 04h FORMAT UNIT.
1707  0x00=full, 0x10=CD-RW/DVD-RW full, 0x11=CD-RW/DVD-RW grow,
1708  0x15=DVD-RW quick, 0x13=DVD-RW quick grow,
1709  0x26=DVD+RW background, 0x30=BD-RE with spare areas,
1710  0x31=BD-RE without spare areas
1711  @param size The maximum size in bytes achievable with this format.
1712  @param tdp Type Dependent Parameter. See mmc5r03c.pdf.
1713  @return 1 reply is valid , <=0 failure
1714  @since 0.3.0
1715 */
1716 int burn_disc_get_format_descr(struct burn_drive *drive, int index,
1717  int *type, off_t *size, unsigned *tdp);
1718 
1719 
1720 
1721 /* ts A61109 : this was and is defunct */
1722 /** Read a disc from the drive and write it to an fd pair. The drive must be
1723  grabbed successfully BEFORE calling this function. Always ensure that the
1724  drive reports a status of BURN_DISC_FULL before calling this function.
1725  @param drive The drive from which to read a disc.
1726  @param o The options for the read operation.
1727 */
1728 void burn_disc_read(struct burn_drive *drive, const struct burn_read_opts *o);
1729 
1730 
1731 
1732 /* ts A70222 */
1733 /* @since 0.3.4 */
1734 /** The length of a rejection reasons string for burn_precheck_write() and
1735  burn_write_opts_auto_write_type() .
1736 */
1737 #define BURN_REASONS_LEN 4096
1738 
1739 
1740 /* ts A70219 */
1741 /** Examines a completed setup for burn_disc_write() whether it is permissible
1742  with drive and media. This function is called by burn_disc_write() but
1743  an application might be interested in this check in advance.
1744  @param o The options for the writing operation.
1745  @param disc The descrition of the disc to be created
1746  @param reasons Eventually returns a list of rejection reason statements
1747  @param silent 1= do not issue error messages , 0= report problems
1748  @return 1 ok, -1= no recordable media detected, 0= other failure
1749  @since 0.3.4
1750 */
1751 int burn_precheck_write(struct burn_write_opts *o, struct burn_disc *disc,
1752  char reasons[BURN_REASONS_LEN], int silent);
1753 
1754 
1755 /** Write a disc in the drive. The drive must be grabbed successfully before
1756  calling this function. Always ensure that the drive reports a status of
1757  BURN_DISC_BLANK ot BURN_DISC_APPENDABLE before calling this function.
1758  Note: write_type BURN_WRITE_SAO is currently not capable of writing a mix
1759  of data and audio tracks. You must use BURN_WRITE_TAO for such sessions.
1760  To be set by burn_write_opts_set_write_type().
1761  Note: This function is not suitable for overwriting data in the middle of
1762  a valid data area because it is allowed to append trailing data.
1763  For exact random access overwriting use burn_random_access_write().
1764  Note: After writing it is advised to give up the drive and to grab it again
1765  in order to learn about its view on the new media state.
1766  Note: Before mounting the written media it might be necessary to eject
1767  and reload in order to allow the operating system to notice the new
1768  media state.
1769  @param o The options for the writing operation.
1770  @param disc The struct burn_disc * that described the disc to be created
1771 */
1772 void burn_disc_write(struct burn_write_opts *o, struct burn_disc *disc);
1773 
1774 
1775 /* ts A90227 */
1776 /** Control stream recording during the write run and eventually set the start
1777  LBA for stream recording.
1778  Stream recording is set from struct burn_write_opts when the write run
1779  gets started. See burn_write_opts_set_stream_recording().
1780  The call described here can be used later to override this setting and
1781  to program automatic switching at a given LBA. It also affects subsequent
1782  calls to burn_random_access_write().
1783  @param drive The drive which performs the write operation.
1784  @param recmode -1= disable stream recording
1785  0= leave setting as is
1786  1= enable stream recording
1787  @param start The LBA where actual stream recording shall start.
1788  (0 means unconditional stream recording)
1789  @param flag Bitfield for control purposes (unused yet, submit 0).
1790  @return 1=success , <=0 failure
1791  @since 0.6.4
1792 */
1793 int burn_drive_set_stream_recording(struct burn_drive *drive, int recmode,
1794  int start, int flag);
1795 
1796 /** Cancel an operation on a drive.
1797  This will only work when the drive's busy state is BURN_DRIVE_READING or
1798  BURN_DRIVE_WRITING.
1799  @param drive The drive on which to cancel the current operation.
1800 */
1801 void burn_drive_cancel(struct burn_drive *drive);
1802 
1803 
1804 /* ts A61223 */
1805 /** Inquire whether the most recent asynchronous media job was successful.
1806  This applies to burn_disc_erase(), burn_disc_format(), burn_disc_write().
1807  Reasons for non-success may be: rejection of burn parameters, abort due to
1808  fatal errors during write, blank or format, a call to burn_drive_cancel()
1809  by the application thread.
1810  @param d The drive to inquire.
1811  @return 1=burn seems to have went well, 0=burn failed
1812  @since 0.2.6
1813 */
1814 int burn_drive_wrote_well(struct burn_drive *d);
1815 
1816 
1817 /** Convert a minute-second-frame (MSF) value to sector count
1818  @param m Minute component
1819  @param s Second component
1820  @param f Frame component
1821  @return The sector count
1822 */
1823 int burn_msf_to_sectors(int m, int s, int f);
1824 
1825 /** Convert a sector count to minute-second-frame (MSF)
1826  @param sectors The sector count
1827  @param m Returns the minute component
1828  @param s Returns the second component
1829  @param f Returns the frame component
1830 */
1831 void burn_sectors_to_msf(int sectors, int *m, int *s, int *f);
1832 
1833 /** Convert a minute-second-frame (MSF) value to an lba
1834  @param m Minute component
1835  @param s Second component
1836  @param f Frame component
1837  @return The lba
1838 */
1839 int burn_msf_to_lba(int m, int s, int f);
1840 
1841 /** Convert an lba to minute-second-frame (MSF)
1842  @param lba The lba
1843  @param m Returns the minute component
1844  @param s Returns the second component
1845  @param f Returns the frame component
1846 */
1847 void burn_lba_to_msf(int lba, int *m, int *s, int *f);
1848 
1849 /** Create a new disc
1850  @return Pointer to a burn_disc object or NULL on failure.
1851 */
1852 struct burn_disc *burn_disc_create(void);
1853 
1854 /** Delete disc and decrease the reference count on all its sessions
1855  @param d The disc to be freed
1856 */
1857 void burn_disc_free(struct burn_disc *d);
1858 
1859 /** Create a new session
1860  @return Pointer to a burn_session object or NULL on failure.
1861  */
1862 struct burn_session *burn_session_create(void);
1863 
1864 /** Free a session (and decrease reference count on all tracks inside)
1865  @param s Session to be freed
1866 */
1867 void burn_session_free(struct burn_session *s);
1868 
1869 /** Add a session to a disc at a specific position, increasing the
1870  sessions's reference count.
1871  @param d Disc to add the session to
1872  @param s Session to add to the disc
1873  @param pos position to add at (BURN_POS_END is "at the end")
1874  @return 0 for failure, 1 for success
1875 */
1876 int burn_disc_add_session(struct burn_disc *d, struct burn_session *s,
1877  unsigned int pos);
1878 
1879 /** Remove a session from a disc
1880  @param d Disc to remove session from
1881  @param s Session pointer to find and remove
1882 */
1883 int burn_disc_remove_session(struct burn_disc *d, struct burn_session *s);
1884 
1885 
1886 /* ts B11219 */
1887 /** Read a CDRWIN cue sheet file and equip the session object by tracks and
1888  CD-TEXT according to the content of the file.
1889  For a description of CDRWIN file format see
1890  http://digitalx.org/cue-sheet/syntax/
1891  Fully supported commands are:
1892  CATALOG , CDTEXTFILE , FLAGS , INDEX , ISRC , PERFORMER ,
1893  POSTGAP , PREGAP , REM , SONGWRITER , TITLE
1894  Further supported commands introduced by cdrecord (usage like PERFORMER):
1895  ARRANGER , COMPOSER , MESSAGE
1896  Partly supported commands are:
1897  FILE which supports only types BINARY , MOTOROLA , WAVE
1898  TRACK which supports only datatypes AUDIO , MODE1/2048
1899  Unsupported types of FILE or TRACK lead to failure of the call.
1900  libburn does not yet support mixing of AUDIO and MODE1/2048. So this call
1901  will fail if such a mix is found.
1902  CD-TEXT information is allowed only if all tracks are of datatype AUDIO.
1903  Empty lines and lines which start by '#' are ignored.
1904  @param session Session where to attach tracks. It must not yet have
1905  tracks or else this call will fail.
1906  @param path Filesystem address of the CDRWIN cue sheet file.
1907  Normally with suffix .cue
1908  @param fifo_size Number of bytes in fifo. This will be rounded up by
1909  the block size of the track mode. <= 0 means no fifo.
1910  @param fifo Returns a reference to the burn_source object that
1911  was installed as fifo between FILE and the track
1912  burn sources. One may use this to inquire the fifo
1913  state. Dispose it by burn_source_free() when no longer
1914  needed. It is permissible to pass this parameter to
1915  libburn as NULL, in order to immediately drop ownership
1916  on the fifo.
1917  @param text_packs Returns pre-formatted CD-TEXT packs resulting from
1918  cue sheet command CDTEXTFILE. To be used with call
1919  burn_write_opts_set_leadin_text().
1920  It is permissible to pass this parameter to libburn
1921  as NULL, in order to disable CDTEXTFILE.
1922  @param num_packs Returns the number of 18 byte records in text_packs.
1923  @param flag Bitfield for control purposes.
1924  bit0= Do not attach CD-TEXT information to session and
1925  tracks. Do not load text_packs.
1926  bit1= Do not use media catalog string of session or ISRC
1927  strings of tracks for writing to Q sub-channel.
1928  @return > 0 indicates success, <= 0 indicates failure
1929  @since 1.2.0
1930 */
1931 int burn_session_by_cue_file(struct burn_session *session,
1932  char *path, int fifo_size, struct burn_source **fifo,
1933  unsigned char **text_packs, int *num_packs, int flag);
1934 
1935 
1936 /** Create a track */
1937 struct burn_track *burn_track_create(void);
1938 
1939 /** Free a track
1940  @param t Track to free
1941 */
1942 void burn_track_free(struct burn_track *t);
1943 
1944 /** Add a track to a session at specified position
1945  @param s Session to add to
1946  @param t Track to insert in session
1947  @param pos position to add at (BURN_POS_END is "at the end")
1948  @return 0 for failure, 1 for success
1949 */
1950 int burn_session_add_track(struct burn_session *s, struct burn_track *t,
1951  unsigned int pos);
1952 
1953 /** Remove a track from a session
1954  @param s Session to remove track from
1955  @param t Track pointer to find and remove
1956  @return 0 for failure, 1 for success
1957 */
1958 int burn_session_remove_track(struct burn_session *s, struct burn_track *t);
1959 
1960 
1961 /* ts B20107 */
1962 /** Set the number which shall be written as CD track number with the first
1963  track of the session. The following tracks will then get written with
1964  consecutive CD track numbers. The resulting number of the last track
1965  must not exceed 99. The lowest possible start number is 1, which is also
1966  the default. This setting applies only to CD SAO writing.
1967  @param session The session to be manipulated
1968  @param tno A number between 1 and 99
1969  @param flag Bitfield for control purposes. Unused yet. Submit 0.
1970  @return > 0 indicates success, <= 0 indicates failure
1971  @since 1.2.0
1972 */
1973 int burn_session_set_start_tno(struct burn_session *session, int tno,
1974  int flag);
1975 
1976 /* ts B20108 */
1977 /** Inquire the CD track start number, as set by default or by
1978  burn_session_set_start_tno().
1979  @param session The session to be inquired
1980  @return > 0 is the currently set CD track start number
1981  <= 0 indicates failure
1982  @since 1.2.0
1983 */
1984 int burn_session_get_start_tno(struct burn_session *session, int flag);
1985 
1986 
1987 
1988 /* ts B11206 */
1989 /** Set the Character Codes, the Copyright bytes, and the Language Codes
1990  for CD-TEXT blocks 0 to 7. They will be used in the block summaries
1991  of text packs which get generated from text or binary data submitted
1992  by burn_session_set_cdtext() and burn_track_set_cdtext().
1993  Character Code value can be
1994  0x00 = ISO-8859-1
1995  0x01 = 7 bit ASCII
1996  0x80 = MS-JIS (japanesei Kanji, double byte characters)
1997  Copyright byte value can be
1998  0x00 = not copyrighted
1999  0x03 = copyrighted
2000  Language Code value will typically be 0x09 = English or 0x69 = Japanese.
2001  See below macros BURN_CDTEXT_LANGUAGES_0X00 and BURN_CDTEXT_LANGUAGES_0X45,
2002  but be aware that many of these codes have never been seen on CD, and that
2003  many of them do not have a character representation among the above
2004  Character Codes.
2005  Default is 0x09 = English for block 0 and 0x00 = Unknown for block 1 to 7.
2006  Copyright and Character Code are 0x00 for all blocks by default.
2007  See also file doc/cdtext.txt, "Format of a CD-TEXT packs array",
2008  "Pack type 0x8f".
2009 
2010  Parameter value -1 leaves the current setting of the session parameter
2011  unchanged.
2012  @param s Session where to change settings
2013  @param char_codes Character Codes for block 0 to 7
2014  @param copyrights Copyright bytes for block 0 to 7
2015  @param languages Language Codes for block 0 to 7
2016  @param flag Bitfiled for control purposes. Unused yet. Submit 0.
2017  @return <=0 failure, > 0 success
2018  @since 1.2.0
2019 */
2020 int burn_session_set_cdtext_par(struct burn_session *s,
2021  int char_codes[8], int copyrights[8],
2022  int languages[8], int flag);
2023 
2024 /** This is the first list of languages sorted by their Language codes,
2025  which start at 0x00. They stem from from EBU Tech 3264, appendix 3.
2026  E.g. language 0x00 is "Unknown", 0x08 is "German", 0x10 is "Frisian",
2027  0x18 is "Latvian", 0x20 is "Polish", 0x28 is "Swedish", 0x2b is "Wallon".
2028  See also file doc/cdtext.txt.
2029  @since 1.2.0
2030 */
2031 #define BURN_CDTEXT_LANGUAGES_0X00 \
2032  "Unknown", "Albanian", "Breton", "Catalan", \
2033  "Croatian", "Welsh", "Czech", "Danish", \
2034  "German", "English", "Spanish", "Esperanto", \
2035  "Estonian", "Basque", "Faroese", "French", \
2036  "Frisian", "Irish", "Gaelic", "Galician", \
2037  "Icelandic", "Italian", "Lappish", "Latin", \
2038  "Latvian", "Luxembourgian", "Lithuanian", "Hungarian", \
2039  "Maltese", "Dutch", "Norwegian", "Occitan", \
2040  "Polish", "Portuguese", "Romanian", "Romansh", \
2041  "Serbian", "Slovak", "Slovenian", "Finnish", \
2042  "Swedish", "Turkish", "Flemish", "Wallon"
2043 
2044 /** This is the second list of languages sorted by their Language codes,
2045  which start at 0x45. They stem from from EBU Tech 3264, appendix 3.
2046  E.g. language 0x45 is "Zulu", 0x50 is "Sranan Tongo", 0x58 is "Pushtu",
2047  0x60 is "Moldavian", 0x68 is "Kannada", 0x70 is "Greek", 0x78 is "Bengali",
2048  0x7f is "Amharic".
2049  See also file doc/cdtext.txt.
2050  @since 1.2.0
2051 */
2052 #define BURN_CDTEXT_LANGUAGES_0X45 \
2053  "Zulu", "Vietnamese", "Uzbek", \
2054  "Urdu", "Ukrainian", "Thai", "Telugu", \
2055  "Tatar", "Tamil", "Tadzhik", "Swahili", \
2056  "Sranan Tongo", "Somali", "Sinhalese", "Shona", \
2057  "Serbo-croat", "Ruthenian", "Russian", "Quechua", \
2058  "Pushtu", "Punjabi", "Persian", "Papamiento", \
2059  "Oriya", "Nepali", "Ndebele", "Marathi", \
2060  "Moldavian", "Malaysian", "Malagasay", "Macedonian", \
2061  "Laotian", "Korean", "Khmer", "Kazakh", \
2062  "Kannada", "Japanese", "Indonesian", "Hindi", \
2063  "Hebrew", "Hausa", "Gurani", "Gujurati", \
2064  "Greek", "Georgian", "Fulani", "Dari", \
2065  "Churash", "Chinese", "Burmese", "Bulgarian", \
2066  "Bengali", "Bielorussian", "Bambora", "Azerbaijani", \
2067  "Assamese", "Armenian", "Arabic", "Amharic"
2068 
2069 /* This is the list of empty languages names between 0x30 and 0x44.
2070  Together the three macros fill an array of 128 char pointers.
2071  static char *languages[] = {
2072  BURN_CDTEXT_LANGUAGES_0X00,
2073  BURN_CDTEXT_FILLER,
2074  BURN_CDTEXT_LANGUAGES_0X45
2075  };
2076 */
2077 #define BURN_CDTEXT_FILLER \
2078  "", "", "", "", \
2079  "", "", "", "", \
2080  "", "", "", "", \
2081  "", "", "", "", \
2082  "", "", "", "", \
2083  "", "", "", "", \
2084  ""
2085 
2086 /* ts B11206 */
2087 /** Obtain the current settings as of burn_session_set_cdtext_par() resp.
2088  by default.
2089  @param s Session which to inquire
2090  @param char_codes Will return Character Codes for block 0 to 7
2091  @param copyrights Will return Copyright bytes for block 0 to 7
2092  @param languages Will return Language Codes for block 0 to 7
2093  @param flag Bitfiled for control purposes. Unused yet. Submit 0.
2094  @return <=0 failure, reply invalid, > 0 success, reply valid
2095  @since 1.2.0
2096 */
2097 int burn_session_get_cdtext_par(struct burn_session *s,
2098  int char_codes[8], int copyrights[8],
2099  int block_languages[8], int flag);
2100 
2101 
2102 /* ts B11206 */
2103 /** Attach text or binary data as CD-TEXT attributes to a session.
2104  They can be used to generate CD-TEXT packs by burn_cdtext_from_session()
2105  or to write CD-TEXT packs into the lead-in of a CD SAO session.
2106  The latter happens only if no array of CD-TEXT packs is attached to
2107  the write options by burn_write_opts_set_leadin_text().
2108  For details of the CD-TEXT format and of the payload content, see file
2109  doc/cdtext.txt .
2110  @param s Session where to attach CD-TEXT attribute
2111  @param block Number of the language block in which the attribute
2112  shall appear. Possible values: 0 to 7.
2113  @param pack_type Pack type number. 0x80 to 0x8e. Used if pack_type_name
2114  is NULL or empty text. Else submit 0 and a name.
2115  Pack type 0x8f is generated automatically and may not
2116  be set by applications.
2117  @param pack_type_name The pack type by name. Defined names are:
2118  0x80 = "TITLE" 0x81 = "PERFORMER"
2119  0x82 = "SONGWRITER" 0x83 = "COMPOSER"
2120  0x84 = "ARRANGER" 0x85 = "MESSAGE"
2121  0x86 = "DISCID" 0x87 = "GENRE"
2122  0x88 = "TOC" 0x89 = "TOC2"
2123  0x8d = "CLOSED" 0x8e = "UPC_ISRC"
2124  Names are recognized uppercase and lowercase.
2125  @param payload Text or binary bytes. The data will be copied to
2126  session-internal memory.
2127  Pack types 0x80 to 0x85 contain 0-terminated cleartext
2128  encoded according to the block's Character Code.
2129  If double byte characters are used, then two 0-bytes
2130  terminate the cleartext.
2131  Pack type 0x86 is 0-terminated ASCII cleartext.
2132  Pack type 0x87 consists of two byte big-endian
2133  Genre code (see below BURN_CDTEXT_GENRE_LIST), and
2134  0-terminated ASCII cleartext of genre description.
2135  Pack type 0x88 mirrors the session table-of-content.
2136  Pack type 0x89 is not understood yet.
2137  Pack types 0x8a to 0x8c are reserved.
2138  Pack type 0x8d contains ISO-8859-1 cleartext which is
2139  not to be shown by commercial audio CD players.
2140  Pack type 0x8e is ASCII cleartext with UPC/EAN code.
2141  @pram length Number of bytes in payload. Including terminating
2142  0-bytes.
2143  @param flag Bitfield for control purposes.
2144  bit0= payload contains double byte characters
2145  (with character code 0x80 MS-JIS japanese Kanji)
2146  @return > 0 indicates success , <= 0 is failure
2147  @since 1.2.0
2148 */
2149 int burn_session_set_cdtext(struct burn_session *s, int block,
2150  int pack_type, char *pack_type_name,
2151  unsigned char *payload, int length, int flag);
2152 
2153 
2154 /** This is the list of Genres sorted by their Genre codes.
2155  E.g. genre code 0x0000 is "No Used", 0x0008 is "Dance, 0x0010 is "Musical",
2156  0x0018 is "Rhythm & Blues", 0x001b is "World Music".
2157  See also file doc/cdtext.txt.
2158  @since 1.2.0
2159 */
2160 #define BURN_CDTEXT_GENRE_LIST \
2161  "Not Used", "Not Defined", "Adult Contemporary", "Alternative Rock", \
2162  "Childrens Music", "Classical", "Contemporary Christian", "Country", \
2163  "Dance", "Easy Listening", "Erotic", "Folk", \
2164  "Gospel", "Hip Hop", "Jazz", "Latin", \
2165  "Musical", "New Age", "Opera", "Operetta", \
2166  "Pop Music", "Rap", "Reggae", "Rock Music", \
2167  "Rhythm & Blues", "Sound Effects", "Spoken Word", "World Music"
2168 
2169 /* The number of genre names in BURN_CDTEXT_GENRE_LIST.
2170 */
2171 #define BURN_CDTEXT_NUM_GENRES 28
2172 
2173 
2174 /* ts B11206 */
2175 /** Obtain a CD-TEXT attribute that was set by burn_session_set_cdtext()
2176  @param s Session to inquire
2177  @param block Number of the language block to inquire.
2178  @param pack_type Pack type number to inquire. Used if pack_type_name
2179  is NULL or empty text. Else submit 0 and a name.
2180  Pack type 0x8f is generated automatically and may not
2181  be inquire in advance. Use burn_cdtext_from_session()
2182  to generate all packs including type 0x8f packs.
2183  @param pack_type_name The pack type by name.
2184  See above burn_session_set_cdtext().
2185  @param payload Will return a pointer to text or binary bytes.
2186  Not a copy of data. Do not free() this address.
2187  If no text attribute is attached for pack type and
2188  block, then payload is returned as NULL. The return
2189  value will not indicate error in this case.
2190  @pram length Will return the number of bytes pointed to by payload.
2191  Including terminating 0-bytes.
2192  @param flag Bitfield for control purposes. Unused yet. Submit 0.
2193  @return 1 single byte char, 2 double byte char, <=0 error
2194  @since 1.2.0
2195 */
2196 int burn_session_get_cdtext(struct burn_session *s, int block,
2197  int pack_type, char *pack_type_name,
2198  unsigned char **payload, int *length, int flag);
2199 
2200 
2201 /* ts B11215 */
2202 /** Read a Sony CD-TEXT Input Sheet Version 0.7T file and attach its text
2203  attributes to the given session and its tracks for the given CD-TEXT
2204  block number. This overrides previous settings made by
2205  burn_session_set_cdtext(), burn_track_set_cdtext(), burn_track_set_isrc(),
2206  burn_session_set_start_tno(). It can later be overridden by said function
2207  calls.
2208  The media catalog number from purpose specifier "UPC / EAN" gets into
2209  effect only if burn_write_opts_set_has_mediacatalog() is set to 0.
2210  The format of a v07t sheet file is documented in doc/cdtext.txt.
2211  @param s Session where to attach CD-TEXT attributes
2212  @param path Local filesystem address of the sheet file which
2213  shall be read and interpreted.
2214  @param block Number of the language block in which the attributes
2215  shall appear. Possible values: 0 to 7.
2216  @param flag Bitfield for control purposes.
2217  bit1= Do not use media catalog string of session or ISRC
2218  strings of tracks for writing to Q sub-channel.
2219  @return > 0 indicates success , <= 0 is failure
2220  @since 1.2.0
2221 */
2222 int burn_session_input_sheet_v07t(struct burn_session *session,
2223  char *path, int block, int flag);
2224 
2225 
2226 /* ts B11210 */
2227 /** Produce an array of CD-TEXT packs that could be submitted to
2228  burn_write_opts_set_leadin_text() or stored as *.cdt file.
2229  For a description of the format of the array, see file doc/cdtext.txt.
2230  The input data stem from burn_session_set_cdtext_par(),
2231  burn_session_set_cdtext(), and burn_track_set_cdtext().
2232  @param s Session from which to produce CD-TEXT packs.
2233  @param text_packs Will return the buffer with the CD-TEXT packs.
2234  Dispose by free() when no longer needed.
2235  @param num_packs Will return the number of 18 byte text packs.
2236  @param flag Bitfield for control purposes.
2237  bit0= do not return generated CD-TEXT packs,
2238  but check whether production would work and
2239  indicate the number of packs by the call return
2240  value. This happens also if
2241  (text_packs == NULL || num_packs == NULL).
2242  @return Without flag bit0: > 0 is success, <= 0 failure
2243  With flag bit0: > 0 is number of packs,
2244  0 means no packs will be generated,
2245  < 0 means failure
2246  @since 1.2.0
2247 */
2248 int burn_cdtext_from_session(struct burn_session *s,
2249  unsigned char **text_packs, int *num_packs,
2250  int flag);
2251 
2252 
2253 /* ts B11206 */
2254 /** Remove all CD-TEXT attributes of the given block from the session.
2255  They were attached by burn_session_set_cdtext().
2256  @param s Session where to remove the CD-TEXT attribute
2257  @param block Number of the language block in which the attribute
2258  shall appear. Possible values: 0 to 7.
2259  -1 causes text packs of all blocks to be removed.
2260  @return > 0 is success, <= 0 failure
2261  @since 1.2.0
2262 */
2263 int burn_session_dispose_cdtext(struct burn_session *s, int block);
2264 
2265 
2266 /* ts B11221*/
2267 /** Read an array of CD-TEXT packs from a file. This array should be suitable
2268  for burn_write_opts_set_leadin_text().
2269  The function tolerates and removes 4-byte headers as produced by
2270  cdrecord -vv -toc, if this header tells the correct number of bytes which
2271  matches the file size. If no 4-byte header is present, then the function
2272  tolerates and removes a trailing 0-byte as of Sony specs.
2273  @param path Filesystem address of the CD-TEXT pack file.
2274  Normally with suffix .cdt or .dat
2275  @param text_packs Will return the buffer with the CD-TEXT packs.
2276  Dispose by free() when no longer needed.
2277  @param num_packs Will return the number of 18 byte text packs.
2278  @param flag Bitfield for control purposes. Unused yet.Submit 0.
2279  @return 0 is success, <= 0 failure
2280  @since 1.2.0
2281 */
2282 int burn_cdtext_from_packfile(char *path, unsigned char **text_packs,
2283  int *num_packs, int flag);
2284 
2285 
2286 /** Define the data in a track
2287  @param t the track to define
2288  @param offset The lib will write this many 0s before start of data
2289  @param tail The number of extra 0s to write after data
2290  @param pad 1 means the lib should pad the last sector with 0s if the
2291  track isn't exactly sector sized. (otherwise the lib will
2292  begin reading from the next track)
2293  @param mode data format (bitfield)
2294 */
2295 void burn_track_define_data(struct burn_track *t, int offset, int tail,
2296  int pad, int mode);
2297 
2298 
2299 /* ts B11206 */
2300 /** Attach text or binary data as CD-TEXT attributes to a track.
2301  The payload will be used to generate CD-TEXT packs by
2302  burn_cdtext_from_session() or to write CD-TEXT packs into the lead-in
2303  of a CD SAO session. This happens if the CD-TEXT attribute of the session
2304  gets generated, which has the same block number and pack type. In this
2305  case, each track should have such a CD-TEXT attribute, too.
2306  See burn_session_set_cdtext().
2307  Be cautious not to exceed the maximum number of 253 payload packs per
2308  language block. Use burn_cdtext_from_session() to learn whether a valid
2309  array of CD-TEXT packs can be generated from your attributes.
2310  @param t Track where to attach CD-TEXT attribute.
2311  @param block Number of the language block in which the attribute
2312  shall appear. Possible values: 0 to 7.
2313  @param pack_type Pack type number. 0x80 to 0x85 or 0x8e. Used if
2314  pack_type_name is NULL or empty text. Else submit 0
2315  and a name.
2316  @param pack_type_name The pack type by name. Applicable names are:
2317  0x80 = "TITLE" 0x81 = "PERFORMER"
2318  0x82 = "SONGWRITER" 0x83 = "COMPOSER"
2319  0x84 = "ARRANGER" 0x85 = "MESSAGE"
2320  0x8e = "UPC_ISRC"
2321  @param payload 0-terminated cleartext. If double byte characters
2322  are used, then two 0-bytes terminate the cleartext.
2323  @pram length Number of bytes in payload. Including terminating
2324  0-bytes.
2325  @param flag Bitfield for control purposes.
2326  bit0= payload contains double byte characters
2327  (with character code 0x80 MS-JIS japanese Kanji)
2328  @return > 0 indicates success , <= 0 is failure
2329  @since 1.2.0
2330 */
2331 int burn_track_set_cdtext(struct burn_track *t, int block,
2332  int pack_type, char *pack_type_name,
2333  unsigned char *payload, int length, int flag);
2334 
2335 /* ts B11206 */
2336 /** Obtain a CD-TEXT attribute that was set by burn_track_set_cdtext().
2337  @param t Track to inquire
2338  @param block Number of the language block to inquire.
2339  @param pack_type Pack type number to inquire. Used if pack_type_name
2340  is NULL or empty text. Else submit 0 and a name.
2341  @param pack_type_name The pack type by name.
2342  See above burn_track_set_cdtext().
2343  @param payload Will return a pointer to text bytes.
2344  Not a copy of data. Do not free() this address.
2345  If no text attribute is attached for pack type and
2346  block, then payload is returned as NULL. The return
2347  value will not indicate error in this case.
2348  @pram length Will return the number of bytes pointed to by payload.
2349  Including terminating 0-bytes.
2350  @param flag Bitfield for control purposes. Unused yet. Submit 0.
2351  @return 1=single byte char , 2= double byte char , <=0 error
2352  @since 1.2.0
2353 */
2354 int burn_track_get_cdtext(struct burn_track *t, int block,
2355  int pack_type, char *pack_type_name,
2356  unsigned char **payload, int *length, int flag);
2357 
2358 /* ts B11206 */
2359 /** Remove all CD-TEXT attributes of the given block from the track.
2360  They were attached by burn_track_set_cdtext().
2361  @param t Track where to remove the CD-TEXT attribute.
2362  @param block Number of the language block in which the attribute
2363  shall appear. Possible values: 0 to 7.
2364  -1 causes text packs of all blocks to be removed.
2365  @return > 0 is success, <= 0 failure
2366  @since 1.2.0
2367 */
2368 int burn_track_dispose_cdtext(struct burn_track *t, int block);
2369 
2370 
2371 /* ts A90910 */
2372 /** Activates CD XA compatibility modes.
2373  libburn currently writes data only in CD mode 1. Some programs insist in
2374  sending data with additional management bytes. These bytes have to be
2375  stripped in order to make the input suitable for BURN_MODE1.
2376  @param t The track to manipulate
2377  @param value 0= no conversion
2378  1= strip 8 byte sector headers of CD-ROM XA mode 2 form 1
2379  see MMC-5 4.2.3.8.5.3 Block Format for Mode 2 form 1 Data
2380  all other values are reserved
2381  @return 1=success , 0=unacceptable value
2382  @since 0.7.2
2383 */
2384 int burn_track_set_cdxa_conv(struct burn_track *t, int value);
2385 
2386 
2387 /** Set the ISRC details for a track. When writing to CD media, ISRC will get
2388  written into the Q sub-channel.
2389  @param t The track to change
2390  @param country the 2 char country code. Each character must be
2391  only numbers or letters.
2392  @param owner 3 char owner code. Each character must be only numbers
2393  or letters.
2394  @param year 2 digit year. A number in 0-99 (Yep, not Y2K friendly).
2395  @param serial 5 digit serial number. A number in 0-99999.
2396 */
2397 void burn_track_set_isrc(struct burn_track *t, char *country, char *owner,
2398  unsigned char year, unsigned int serial);
2399 
2400 /* ts B11226 */
2401 /** Set the composed ISRC string for a track. This is an alternative to
2402  burn_track_set_isrc().
2403  @param t The track to be manipulated
2404  @param isrc 12 characters which are composed from ISRC details.
2405  Format is CCOOOYYSSSSS, terminated by a 0-byte:
2406  Country, Owner, Year(decimal digits), Serial(decimal digits).
2407  @param flag Bitfield for control purposes. Unused yet. Submit 0.
2408  @return > 0 indicates success, <= 0 means failure
2409  @since 1.2.0
2410 */
2411 int burn_track_set_isrc_string(struct burn_track *t, char isrc[13], int flag);
2412 
2413 /** Disable ISRC parameters for a track
2414  @param t The track to change
2415 */
2416 void burn_track_clear_isrc(struct burn_track *t);
2417 
2418 
2419 /* ts B20103 */
2420 /** Define an index start address within a track. The index numbers inside a
2421  track have to form sequence starting at 0 or 1 with no gaps up to the
2422  highest number used. They affect only writing of CD SAO sessions.
2423  The first index start address of a track must be 0.
2424  Blocks between index 0 and index 1 are considered to be located before the
2425  track start as of the table-of-content.
2426  @param t The track to be manipulated
2427  @param index_number A number between 0 and 99
2428  @param relative_lba The start address relative to the start of the
2429  burn_source of the track. It will get mapped to the
2430  appropriate absolute block address.
2431  @param flag Bitfield for control purposes. Unused yet. Submit 0.
2432  @return > 0 indicates success, <= 0 means failure
2433  @since 1.2.0
2434 */
2435 int burn_track_set_index(struct burn_track *t, int index_number,
2436  unsigned int relative_lba, int flag);
2437 
2438 /* ts B20103 */
2439 /** Remove all index start addresses and reset to the default indexing of
2440  CD SAO sessions. This means index 0 of track 1 reaches from LBA -150
2441  to LBA -1. Index 1 of track 1 reaches from LBA 0 to track end. Index 1
2442  of track 2 follows immediately. The same happens for all further tracks
2443  after the end of their predecessor.
2444  @param t The track to be manipulated
2445  @param flag Bitfield for control purposes. Unused yet. Submit 0.
2446  @return > 0 indicates success, <= 0 means failure
2447  @since 1.2.0
2448 */
2449 int burn_track_clear_indice(struct burn_track *t, int flag);
2450 
2451 
2452 /* ts B20110 */
2453 /** Define whether a pre-gap shall be written before the track and how many
2454  sectors this pre-gap shall have. A pre-gap is written in the range of track
2455  index 0 and contains zeros resp. silence. No bytes from the track source
2456  will be read for writing the pre-gap.
2457  This setting affects only CD SAO write runs.
2458  The first track automatically gets a pre-gap of at least 150 sectors. Its
2459  size may be enlarged by this call. Further pre-gaps are demanded by MMC
2460  for tracks which follow tracks of a different mode. (But Mode mixing in
2461  CD SAO sessions is currently not supported by libburn.)
2462  @param t The track to change
2463  @param size Number of sectors in the pre-gap.
2464  -1 disables pre-gap, except for the first track.
2465  libburn allows 0, but MMC does not propose this.
2466  @param flag Bitfield for control purposes. Unused yet. Submit 0.
2467  @return > 0 indicates success, <= 0 means failure
2468  @since 1.2.0
2469 */
2470 int burn_track_set_pregap_size(struct burn_track *t, int size, int flag);
2471 
2472 /* ts B20111 */
2473 /** Define whether a post-gap shall be written at the end of the track and
2474  how many sectors this gap shall have. A post-gap occupies the range of
2475  an additional index of the track. It contains zeros. No bytes from the
2476  track source will be read for writing the post-gap.
2477  This setting affects only CD SAO write runs.
2478  MMC prescribes to add a post-gap to a data track which is followed by
2479  a non-data track. (But libburn does not yet support mixed mode CD SAO
2480  sessions.)
2481  @param t The track to change
2482  @param size Number of sectors in the post-gap.
2483  -1 disables post-gap.
2484  libburn allows 0, but MMC does not propose this.
2485  @param flag Bitfield for control purposes. Unused yet. Submit 0.
2486  @return > 0 indicates success, <= 0 means failure
2487  @since 1.2.0
2488 */
2489 int burn_track_set_postgap_size(struct burn_track *t, int size, int flag);
2490 
2491 
2492 /* ts A61024 */
2493 /** Define whether a track shall swap bytes of its input stream.
2494  @param t The track to change
2495  @param swap_source_bytes 0=do not swap, 1=swap byte pairs
2496  @return 1=success , 0=unacceptable value
2497  @since 0.2.6
2498 */
2499 int burn_track_set_byte_swap(struct burn_track *t, int swap_source_bytes);
2500 
2501 
2502 /** Hide the first track in the "pre gap" of the disc
2503  @param s session to change
2504  @param onoff 1 to enable hiding, 0 to disable
2505 */
2506 void burn_session_hide_first_track(struct burn_session *s, int onoff);
2507 
2508 /** Get the drive's disc struct - free when done
2509  @param d drive to query
2510  @return the disc struct or NULL on failure
2511 */
2512 struct burn_disc *burn_drive_get_disc(struct burn_drive *d);
2513 
2514 /** Set the track's data source
2515  @param t The track to set the data source for
2516  @param s The data source to use for the contents of the track
2517  @return An error code stating if the source is ready for use for
2518  writing the track, or if an error occured
2519 
2520 */
2521 enum burn_source_status burn_track_set_source(struct burn_track *t,
2522  struct burn_source *s);
2523 
2524 
2525 /* ts A70218 */
2526 /** Set a default track size to be used only if the track turns out to be of
2527  unpredictable length and if the effective write type demands a fixed size.
2528  This can be useful to enable write types CD SAO or DVD DAO together with
2529  a track source like stdin. If the track source delivers fewer bytes than
2530  announced then the track will be padded up with zeros.
2531  @param t The track to change
2532  @param size The size to set
2533  @return 0=failure 1=sucess
2534  @since 0.3.4
2535 */
2536 int burn_track_set_default_size(struct burn_track *t, off_t size);
2537 
2538 /** Free a burn_source (decrease its refcount and maybe free it)
2539  @param s Source to free
2540 */
2541 void burn_source_free(struct burn_source *s);
2542 
2543 /** Creates a data source for an image file (and maybe subcode file)
2544  @param path The file address for the main channel payload.
2545  @param subpath Eventual address for subchannel data. Only used in exotic
2546  raw write modes. Submit NULL for normal tasks.
2547  @return Pointer to a burn_source object, NULL indicates failure
2548 */
2549 struct burn_source *burn_file_source_new(const char *path,
2550  const char *subpath);
2551 
2552 
2553 /* ts A91122 : An interface to open(O_DIRECT) or similar OS tricks. */
2554 
2555 /** Opens a file with eventual acceleration preparations which may depend
2556  on the operating system and on compile time options of libburn.
2557  You may use this call instead of open(2) for opening file descriptors
2558  which shall be handed to burn_fd_source_new().
2559  This should only be done for tracks with BURN_BLOCK_MODE1 (2048 bytes
2560  per block).
2561 
2562  If you use this call then you MUST allocate the buffers which you use
2563  with read(2) by call burn_os_alloc_buffer(). Read sizes MUST be a multiple
2564  of a safe buffer amount. Else you risk that track data get altered during
2565  transmission.
2566  burn_disk_write() will allocate a suitable read/write buffer for its own
2567  operations. A fifo created by burn_fifo_source_new() will allocate
2568  suitable memory for its buffer if called with flag bit0 and a multiple
2569  of a safe buffer amount.
2570  @param path The file address to open
2571  @param open_flags The flags as of man 2 open. Normally just O_RDONLY.
2572  @param flag Bitfield for control purposes (unused yet, submit 0).
2573  @return A file descriptor as of open(2). Finally to be disposed
2574  by close(2).
2575  -1 indicates failure.
2576  @since 0.7.4
2577 */
2578 int burn_os_open_track_src(char *path, int open_flags, int flag);
2579 
2580 /** Allocate a memory area that is suitable for reading with a file descriptor
2581  opened by burn_os_open_track_src().
2582  @param amount Number of bytes to allocate. This should be a multiple
2583  of the operating system's i/o block size. 32 KB is
2584  guaranteed by libburn to be safe.
2585  @param flag Bitfield for control purposes (unused yet, submit 0).
2586  @return The address of the allocated memory, or NULL on failure.
2587  A non-NULL return value has finally to be disposed via
2588  burn_os_free_buffer().
2589  @since 0.7.4
2590 */
2591 void *burn_os_alloc_buffer(size_t amount, int flag);
2592 
2593 /** Dispose a memory area which was obtained by burn_os_alloc_buffer(),
2594  @param buffer Memory address to be freed.
2595  @param amount The number of bytes which was allocated at that
2596  address.
2597  @param flag Bitfield for control purposes (unused yet, submit 0).
2598  @return 1 success , <=0 failure
2599  @since 0.7.4
2600 */
2601 int burn_os_free_buffer(void *buffer, size_t amount, int flag);
2602 
2603 
2604 /** Creates a data source for an image file (a track) from an open
2605  readable filedescriptor, an eventually open readable subcodes file
2606  descriptor and eventually a fixed size in bytes.
2607  @param datafd The source of data.
2608  @param subfd The eventual source of subchannel data. Only used in exotic
2609  raw write modes. Submit -1 for normal tasks.
2610  @param size The eventual fixed size of eventually both fds.
2611  If this value is 0, the size will be determined from datafd.
2612  @return Pointer to a burn_source object, NULL indicates failure
2613 */
2614 struct burn_source *burn_fd_source_new(int datafd, int subfd, off_t size);
2615 
2616 
2617 /* ts B00922 */
2618 /** Creates an offset source which shall provide a byte interval of a stream
2619  to its consumer. It is supposed to be chain-linked with other offset
2620  sources which serve neighboring consumers. The chronological sequence
2621  of consumers and the sequence of offset sources must match. The intervals
2622  of the sources must not overlap.
2623 
2624  A chain of these burn_source objects may be used to feed multiple tracks
2625  from one single stream of input bytes.
2626  Each of the offset sources will skip the bytes up to its start address and
2627  provide the prescribed number of bytes to the track. Skipping takes into
2628  respect the bytes which have been processed by eventual predecessors in the
2629  chain.
2630  Important: It is not allowed to free an offset source before its successor
2631  has ended its work. Best is to keep them all until all tracks
2632  are done.
2633 
2634  @param inp The burn_source object from which to read stream data.
2635  E.g. created by burn_file_source_new().
2636  @param prev The eventual offset source object which shall read data from
2637  inp before the new offset source will begin its own work.
2638  This must either be a result of burn_offst_source_new() or
2639  it must be NULL.
2640  @param start The byte address where to start reading bytes for the
2641  consumer. inp bytes may get skipped to reach this address.
2642  @param size The number of bytes to be delivered to the consumer.
2643  If size is <= 0 then it may be set later by a call of method
2644  set_size(). If it is >= 0, then it can only be changed if
2645  flag bit0 was set with burn_offst_source_new().
2646  @param flag Bitfield for control purposes
2647  bit0 = Prevent set_size() from overriding interval sizes > 0.
2648  If such a size is already set, then the new one will
2649  only affect the reply of get_size().
2650  See also above struct burn_source.
2651  @since 1.2.0
2652  @return Pointer to a burn_source object, later to be freed by
2653  burn_source_free(). NULL indicates failure.
2654  @since 0.8.8
2655 */
2657  struct burn_source *inp, struct burn_source *prev,
2658  off_t start, off_t size, int flag);
2659 
2660 /* ts A70930 */
2661 /** Creates a fifo which acts as proxy for an already existing data source.
2662  The fifo provides a ring buffer which shall smoothen the data stream
2663  between burn_source and writer thread. Each fifo serves only for one
2664  data source. It may be attached to one track as its only data source
2665  by burn_track_set_source(), or it may be used as input for other burn
2666  sources.
2667  A fifo starts its life in "standby" mode with no buffer space allocated.
2668  As soon as its consumer requires bytes, the fifo establishes a worker
2669  thread and allocates its buffer. After input has ended and all buffer
2670  content is consumed, the buffer space gets freed and the worker thread
2671  ends. This happens asynchronously. So expect two buffers and worker threads
2672  to exist for a short time between tracks. Be modest in your size demands if
2673  multiple tracks are to be expected.
2674  @param inp The burn_source for which the fifo shall act as proxy.
2675  It can be disposed by burn_source_free() immediately
2676  after this call.
2677  @param chunksize The size in bytes of a chunk.
2678  Use 2048 for sources suitable for BURN_BLOCK_MODE1,
2679  2352 for sources which deliver for BURN_BLOCK_AUDIO,
2680  2056 for sources which shall get treated by
2681  burn_track_set_cdxa_conv(track, 1).
2682  Some variations of burn_source might work only with
2683  a particular chunksize. E.g. libisofs demands 2048.
2684  @param chunks The number of chunks to be allocated in ring buffer.
2685  This value must be >= 2.
2686  @param flag Bitfield for control purposes:
2687  bit0= The read method of inp is capable of delivering
2688  arbitrary amounts of data per call. Not only one
2689  sector.
2690  Suitable for inp from burn_file_source_new()
2691  and burn_fd_source_new() if not the fd has
2692  exotic limitations on read size.
2693  You MUST use this on inp which uses an fd opened
2694  with burn_os_open_track_src().
2695  Better do not use with other inp types.
2696  @since 0.7.4
2697  @return A pointer to the newly created burn_source.
2698  Later both burn_sources, inp and the returned fifo, have
2699  to be disposed by calling burn_source_free() for each.
2700  inp can be freed immediately, the returned fifo may be
2701  kept as handle for burn_fifo_inquire_status().
2702  @since 0.4.0
2703 */
2704 struct burn_source *burn_fifo_source_new(struct burn_source *inp,
2705  int chunksize, int chunks, int flag);
2706 
2707 /* ts A71003 */
2708 /** Inquires state and fill parameters of a fifo burn_source which was created
2709  by burn_fifo_source_new() . Do not use with other burn_source variants.
2710  @param fifo The fifo object to inquire
2711  @param size The total size of the fifo
2712  @param free_bytes The current free capacity of the fifo
2713  @param status_text Returns a pointer to a constant text, see below
2714  @return <0 reply invalid, >=0 fifo status code:
2715  bit0+1=input status, bit2=consumption status, i.e:
2716  0="standby" : data processing not started yet
2717  1="active" : input and consumption are active
2718  2="ending" : input has ended without error
2719  3="failing" : input had error and ended,
2720  4="unused" : ( consumption has ended before processing start )
2721  5="abandoned" : consumption has ended prematurely
2722  6="ended" : consumption has ended without input error
2723  7="aborted" : consumption has ended after input error
2724  @since 0.4.0
2725 */
2726 int burn_fifo_inquire_status(struct burn_source *fifo, int *size,
2727  int *free_bytes, char **status_text);
2728 
2729 /* ts A91125 */
2730 /** Inquire various counters which reflect the fifo operation.
2731  @param fifo The fifo object to inquire
2732  @param total_min_fill The minimum number of bytes in the fifo. Beginning
2733  from the moment when fifo consumption is enabled.
2734  @param interval_min_fill The minimum byte number beginning from the moment
2735  when fifo consumption is enabled or from the
2736  most recent moment when burn_fifo_next_interval()
2737  was called.
2738  @param put_counter The number of data transactions into the fifo.
2739  @param get_counter The number of data transactions out of the fifo.
2740  @param empty_counter The number of times the fifo was empty.
2741  @param full_counter The number of times the fifo was full.
2742  @since 0.7.4
2743 */
2744 void burn_fifo_get_statistics(struct burn_source *fifo,
2745  int *total_min_fill, int *interval_min_fill,
2746  int *put_counter, int *get_counter,
2747  int *empty_counter, int *full_counter);
2748 
2749 /* ts A91125 */
2750 /** Inquire the fifo minimum fill counter for intervals and reset that counter.
2751  @param fifo The fifo object to inquire
2752  @param interval_min_fill The minimum number of bytes in the fifo. Beginning
2753  from the moment when fifo consumption is enabled
2754  or from the most recent moment when
2755  burn_fifo_next_interval() was called.
2756  @since 0.7.4
2757 */
2758 void burn_fifo_next_interval(struct burn_source *fifo, int *interval_min_fill);
2759 
2760 /* ts A80713 */
2761 /** Obtain a preview of the first input data of a fifo which was created
2762  by burn_fifo_source_new(). The data will later be delivered normally to
2763  the consumer track of the fifo.
2764  bufsize may not be larger than the fifo size (chunk_size * chunks) - 32k.
2765  This call will succeed only if data consumption by the track has not
2766  started yet, i.e. best before the call to burn_disc_write().
2767  It will start the worker thread of the fifo with the expectable side
2768  effects on the external data source. Then it waits either until enough
2769  data have arrived or until it becomes clear that this will not happen.
2770  The call may be repeated with increased bufsize. It will always yield
2771  the bytes beginning from the first one in the fifo.
2772  @param fifo The fifo object to inquire resp. start
2773  @param buf Pointer to memory of at least bufsize bytes where to
2774  deliver the peeked data.
2775  @param bufsize Number of bytes to peek from the start of the fifo data
2776  @param flag Bitfield for control purposes (unused yet, submit 0).
2777  @return <0 on severe error, 0 if not enough data, 1 if bufsize bytes read
2778  @since 0.5.0
2779 */
2780 int burn_fifo_peek_data(struct burn_source *fifo, char *buf, int bufsize,
2781  int flag);
2782 
2783 /* ts A91125 */
2784 /** Start the fifo worker thread and wait either until the requested number
2785  of bytes have arrived or until it becomes clear that this will not happen.
2786  Filling will go on asynchronously after burn_fifo_fill() returned.
2787  This call and burn_fifo_peek_data() do not disturb each other.
2788  @param fifo The fifo object to start
2789  @param fill Number of bytes desired. Expect to get return 1 if
2790  at least fifo size - 32k were read.
2791  @param flag Bitfield for control purposes.
2792  bit0= fill fifo to maximum size
2793  @return <0 on severe error, 0 if not enough data,
2794  1 if desired amount or fifo full
2795  @since 0.7.4
2796 */
2797 int burn_fifo_fill(struct burn_source *fifo, int fill, int flag);
2798 
2799 
2800 /* ts A70328 */
2801 /** Sets a fixed track size after the data source object has already been
2802  created.
2803  @param t The track to operate on
2804  @param size the number of bytes to use as track size
2805  @return <=0 indicates failure , >0 success
2806  @since 0.3.6
2807 */
2808 int burn_track_set_size(struct burn_track *t, off_t size);
2809 
2810 
2811 /** Tells how many sectors a track will have on disc, resp. already has on
2812  disc. This includes offset, payload, tail, and post-gap, but not pre-gap.
2813  The result is NOT RELIABLE with tracks of undefined length
2814 */
2815 int burn_track_get_sectors(struct burn_track *);
2816 
2817 
2818 /* ts A61101 */
2819 /** Tells how many source bytes have been read and how many data bytes have
2820  been written by the track during burn.
2821  @param t The track to inquire
2822  @param read_bytes Number of bytes read from the track source
2823  @param written_bytes Number of bytes written to track
2824  @since 0.2.6
2825 */
2826 int burn_track_get_counters(struct burn_track *t,
2827  off_t *read_bytes, off_t *written_bytes);
2828 
2829 
2830 /** Sets drive read and write speed
2831  Note: "k" is 1000, not 1024. 1xCD = 176.4 k/s, 1xDVD = 1385 k/s.
2832  Fractional speeds should be rounded up. Like 4xCD = 706.
2833  @param d The drive to set speed for
2834  @param read Read speed in k/s (0 is max, -1 is min).
2835  @param write Write speed in k/s (0 is max, -1 is min).
2836 */
2837 void burn_drive_set_speed(struct burn_drive *d, int read, int write);
2838 
2839 
2840 /* ts A70711 */
2841 /** Controls the behavior with writing when the drive buffer is suspected to
2842  be full. To check and wait for enough free buffer space before writing
2843  will move the task of waiting from the operating system's device driver
2844  to libburn. While writing is going on and waiting is enabled, any write
2845  operation will be checked whether it will fill the drive buffer up to
2846  more than max_percent. If so, then waiting will happen until the buffer
2847  fill is predicted with at most min_percent.
2848  Thus: if min_percent < max_percent then transfer rate will oscillate.
2849  This may allow the driver to operate on other devices, e.g. a disk from
2850  which to read the input for writing. On the other hand, this checking might
2851  reduce maximum throughput to the drive or even get misled by faulty buffer
2852  fill replies from the drive.
2853  If a setting parameter is < 0, then this setting will stay unchanged
2854  by the call.
2855  Known burner or media specific pitfalls:
2856  To have max_percent larger than the burner's best reported buffer fill has
2857  the same effect as min_percent==max_percent. Some burners do not report
2858  their full buffer with all media types. Some are not suitable because
2859  they report their buffer fill with delay.
2860  @param d The drive to control
2861  @param enable 0= disable , 1= enable waiting , (-1 = do not change setting)
2862  @param min_usec Shortest possible sleeping period (given in micro seconds)
2863  @param max_usec Longest possible sleeping period (given in micro seconds)
2864  @param timeout_sec If a single write has to wait longer than this number
2865  of seconds, then waiting gets disabled and mindless
2866  writing starts. A value of 0 disables this timeout.
2867  @param min_percent Minimum of desired buffer oscillation: 25 to 100
2868  @param max_percent Maximum of desired buffer oscillation: 25 to 100
2869  @return 1=success , 0=failure
2870  @since 0.3.8
2871 */
2872 int burn_drive_set_buffer_waiting(struct burn_drive *d, int enable,
2873  int min_usec, int max_usec, int timeout_sec,
2874  int min_percent, int max_percent);
2875 
2876 
2877 /* these are for my [Derek Foreman's ?] debugging, they will disappear */
2878 /* ts B11012 :
2879  Of course, API symbols will not disappear. But these functions are of
2880  few use, as they only print DEBUG messages.
2881 */
2882 void burn_structure_print_disc(struct burn_disc *d);
2883 void burn_structure_print_session(struct burn_session *s);
2884 void burn_structure_print_track(struct burn_track *t);
2885 
2886 /** Sets the write type for the write_opts struct.
2887  Note: write_type BURN_WRITE_SAO is currently not capable of writing a mix
2888  of data and audio tracks. You must use BURN_WRITE_TAO for such sessions.
2889  @param opts The write opts to change
2890  @param write_type The write type to use
2891  @param block_type The block type to use
2892  @return Returns 1 on success and 0 on failure.
2893 */
2894 int burn_write_opts_set_write_type(struct burn_write_opts *opts,
2895  enum burn_write_types write_type,
2896  int block_type);
2897 
2898 
2899 /* ts A70207 */
2900 /** As an alternative to burn_write_opts_set_write_type() this function tries
2901  to find a suitable write type and block type for a given write job
2902  described by opts and disc. To be used after all other setups have been
2903  made, i.e. immediately before burn_disc_write().
2904  @param opts The nearly complete write opts to change
2905  @param disc The already composed session and track model
2906  @param reasons This text string collects reasons for decision resp. failure
2907  @param flag Bitfield for control purposes:
2908  bit0= do not choose type but check the one that is already set
2909  bit1= do not issue error messages via burn_msgs queue
2910  (is automatically set with bit0)
2911  @return Chosen write type. BURN_WRITE_NONE on failure.
2912  @since 0.3.2
2913 */
2915  struct burn_write_opts *opts, struct burn_disc *disc,
2916  char reasons[BURN_REASONS_LEN], int flag);
2917 
2918 
2919 /** Supplies toc entries for writing - not normally required for cd mastering
2920  @param opts The write opts to change
2921  @param count The number of entries
2922  @param toc_entries
2923 */
2924 void burn_write_opts_set_toc_entries(struct burn_write_opts *opts,
2925  int count,
2926  struct burn_toc_entry *toc_entries);
2927 
2928 /** Sets the session format for a disc
2929  @param opts The write opts to change
2930  @param format The session format to set
2931 */
2932 void burn_write_opts_set_format(struct burn_write_opts *opts, int format);
2933 
2934 /** Sets the simulate value for the write_opts struct .
2935  This corresponds to the Test Write bit in MMC mode page 05h. Several media
2936  types do not support this. See struct burn_multi_caps.might_simulate for
2937  actual availability of this feature.
2938  If the media is suitable, the drive will perform burn_disc_write() as a
2939  simulation instead of effective write operations. This means that the
2940  media content and burn_disc_get_status() stay unchanged.
2941  Note: With stdio-drives, the target file gets eventually created, opened,
2942  lseeked, and closed, but not written. So there are effects on it.
2943  Warning: Call burn_random_access_write() will never do simulation because
2944  it does not get any burn_write_opts.
2945  @param opts The write opts to change
2946  @param sim Non-zero enables simulation, 0 enables real writing
2947  @return Returns 1 on success and 0 on failure.
2948 */
2949 int burn_write_opts_set_simulate(struct burn_write_opts *opts, int sim);
2950 
2951 /** Controls buffer underrun prevention. This is only needed with CD media
2952  and possibly with old DVD-R drives. All other media types are not
2953  vulnerable to burn failure due to buffer underrun.
2954  @param opts The write opts to change
2955  @param underrun_proof if non-zero, buffer underrun protection is enabled
2956  @return Returns 1 if the drive announces to be capable of underrun
2957  prevention,
2958  Returns 0 if not.
2959 */
2960 int burn_write_opts_set_underrun_proof(struct burn_write_opts *opts,
2961  int underrun_proof);
2962 
2963 /** Sets whether to use opc or not with the write_opts struct
2964  @param opts The write opts to change
2965  @param opc If non-zero, optical power calibration will be performed at
2966  start of burn
2967 
2968 */
2969 void burn_write_opts_set_perform_opc(struct burn_write_opts *opts, int opc);
2970 
2971 
2972 /** The Q sub-channel of a CD may contain a Media Catalog Number of 13 decimal
2973  digits. This call sets the string of digits, but does not yet activate it
2974  for writing.
2975  @param opts The write opts to change
2976  @param mediacatalog The 13 decimal digits as ASCII bytes. I.e. '0' = 0x30.
2977 */
2978 void burn_write_opts_set_mediacatalog(struct burn_write_opts *opts,
2979  unsigned char mediacatalog[13]);
2980 
2981 /** This call activates the Media Catalog Number for writing. The digits of
2982  that number have to be set by call burn_write_opts_set_mediacatalog().
2983  @param opts The write opts to change
2984  @param has_mediacatalog 1= activate writing of catalog to Q sub-channel
2985  0= deactivate it
2986 */
2987 void burn_write_opts_set_has_mediacatalog(struct burn_write_opts *opts,
2988  int has_mediacatalog);
2989 
2990 
2991 /* ts A61106 */
2992 /** Sets the multi flag which eventually marks the emerging session as not
2993  being the last one and thus creating a BURN_DISC_APPENDABLE media.
2994  Note: DVD-R[W] in write mode BURN_WRITE_SAO are not capable of this.
2995  DVD-R DL are not capable of this at all.
2996  libburn will refuse to write if burn_write_opts_set_multi() is
2997  enabled under such conditions.
2998  @param opts The option object to be manipulated
2999  @param multi 1=media will be appendable, 0=media will be closed (default)
3000  @since 0.2.6
3001 */
3002 void burn_write_opts_set_multi(struct burn_write_opts *opts, int multi);
3003 
3004 /* ts B11204 */
3005 /** Submit an array of CD-TEXT packs which shall be written to the Lead-in
3006  of a SAO write run on CD.
3007  @param opts The option object to be manipulated
3008  @param text_packs Array of bytes which form CD-TEXT packs of 18 bytes
3009  each. For a description of the format of the array,
3010  see file doc/cdtext.txt.
3011  No header of 4 bytes must be prepended which would
3012  tell the number of pack bytes + 2.
3013  This parameter may be NULL if the currently attached
3014  array of packs shall be removed.
3015  @param num_packs The number of 18 byte packs in text_packs.
3016  This parameter may be 0 if the currently attached
3017  array of packs shall be removed.
3018  @param flag Bitfield for control purposes.
3019  bit0= do not verify checksums
3020  bit1= repair mismatching checksums
3021  bit2= repair checksums if they are 00 00 with each pack
3022  @return 1 on success, <= 0 on failure
3023  @since 1.2.0
3024 */
3025 int burn_write_opts_set_leadin_text(struct burn_write_opts *opts,
3026  unsigned char *text_packs,
3027  int num_packs, int flag);
3028 
3029 
3030 /* ts A61222 */
3031 /** Sets a start address for writing to media and write modes which allow to
3032  choose this address at all (for now: DVD+RW, DVD-RAM, formatted DVD-RW).
3033  now). The address is given in bytes. If it is not -1 then a write run
3034  will fail if choice of start address is not supported or if the block
3035  alignment of the address is not suitable for media and write mode.
3036  Alignment to 32 kB blocks is supposed to be safe with DVD media.
3037  Call burn_disc_get_multi_caps() can obtain the necessary media info. See
3038  resulting struct burn_multi_caps elements .start_adr , .start_alignment ,
3039  .start_range_low , .start_range_high .
3040  @param opts The write opts to change
3041  @param value The address in bytes (-1 = start at default address)
3042  @since 0.3.0
3043 */
3044 void burn_write_opts_set_start_byte(struct burn_write_opts *opts, off_t value);
3045 
3046 
3047 /* ts A70213 */
3048 /** Caution: still immature and likely to change. Problems arose with
3049  sequential DVD-RW on one drive.
3050 
3051  Controls whether the whole available space of the media shall be filled up
3052  by the last track of the last session.
3053  @param opts The write opts to change
3054  @param fill_up_media If 1 : fill up by last track, if 0 = do not fill up
3055  @since 0.3.4
3056 */
3057 void burn_write_opts_set_fillup(struct burn_write_opts *opts,
3058  int fill_up_media);
3059 
3060 
3061 /* ts A70303 */
3062 /** Eventually makes libburn ignore the failure of some conformance checks:
3063  - the check whether CD write+block type is supported by the drive
3064  - the check whether the media profile supports simulated burning
3065  @param opts The write opts to change
3066  @param use_force 1=ignore above checks, 0=refuse work on failed check
3067  @since 0.3.4
3068 */
3069 void burn_write_opts_set_force(struct burn_write_opts *opts, int use_force);
3070 
3071 
3072 /* ts A80412 */
3073 /** Eventually makes use of the more modern write command AAh WRITE12 and
3074  sets the Streaming bit. With DVD-RAM and BD this can override the
3075  traditional slowdown to half nominal speed. But if it speeds up writing
3076  then it also disables error management and correction. Weigh your
3077  priorities. This affects the write operations of burn_disc_write()
3078  and subsequent calls of burn_random_access_write().
3079  @param opts The write opts to change
3080  @param value 0=use 2Ah WRITE10, 1=use AAh WRITE12 with Streaming bit
3081  @since 0.6.4:
3082  >=16 use WRITE12 but not before the LBA given by value
3083  @since 0.4.6
3084 */
3085 void burn_write_opts_set_stream_recording(struct burn_write_opts *opts,
3086  int value);
3087 
3088 /* ts A91115 */
3089 /** Overrides the write chunk size for DVD and BD media which is normally
3090  determined according to media type and setting of stream recording.
3091  A chunk size of 64 KB may improve throughput with bus systems which show
3092  latency problems.
3093  @param opts The write opts to change
3094  @param obs Number of bytes which shall be sent by a single write command.
3095  0 means automatic size, 32768 and 65336 are the only other
3096  accepted sizes for now.
3097  @since 0.7.4
3098 */
3099 void burn_write_opts_set_dvd_obs(struct burn_write_opts *opts, int obs);
3100 
3101 
3102 /* ts B20406 */
3103 /** Overrides the automatic decision whether to pad up the last write chunk to
3104  its full size. This applies to DVD, BD and stdio: pseudo-drives.
3105  Note: This override may get enabled fixely already at compile time by
3106  defining macro Libburn_dvd_always_obs_paD .
3107  @param opts The write opts to change
3108  @param pad 1 means to pad up in any case, 0 means automatic decision.
3109  @since 1.2.4
3110 */
3111 void burn_write_opts_set_obs_pad(struct burn_write_opts *opts, int pad);
3112 
3113 
3114 /* ts A91115 */
3115 /** Sets the rythm by which stdio pseudo drives force their output data to
3116  be consumed by the receiving storage device. This forcing keeps the memory
3117  from being clogged with lots of pending data for slow devices.
3118  @param opts The write opts to change
3119  @param rythm Number of 2KB output blocks after which fsync(2) is
3120  performed. -1 means no fsync(), 0 means default,
3121  elsewise the value must be >= 32.
3122  Default is currently 8192 = 16 MB.
3123  @since 0.7.4
3124 */
3125 void burn_write_opts_set_stdio_fsync(struct burn_write_opts *opts, int rythm);
3126 
3127 
3128 /** Sets whether to read in raw mode or not
3129  @param opts The read opts to change
3130  @param raw_mode If non-zero, reading will be done in raw mode, so that everything in the data tracks on the
3131  disc is read, including headers.
3132 */
3133 void burn_read_opts_set_raw(struct burn_read_opts *opts, int raw_mode);
3134 
3135 /** Sets whether to report c2 errors or not
3136  @param opts The read opts to change
3137  @param c2errors If non-zero, report c2 errors.
3138 */
3139 void burn_read_opts_set_c2errors(struct burn_read_opts *opts, int c2errors);
3140 
3141 /** Sets whether to read subcodes from audio tracks or not
3142  @param opts The read opts to change
3143  @param subcodes_audio If non-zero, read subcodes from audio tracks on the disc.
3144 */
3145 void burn_read_opts_read_subcodes_audio(struct burn_read_opts *opts,
3146  int subcodes_audio);
3147 
3148 /** Sets whether to read subcodes from data tracks or not
3149  @param opts The read opts to change
3150  @param subcodes_data If non-zero, read subcodes from data tracks on the disc.
3151 */
3152 void burn_read_opts_read_subcodes_data(struct burn_read_opts *opts,
3153  int subcodes_data);
3154 
3155 /** Sets whether to recover errors if possible
3156  @param opts The read opts to change
3157  @param hardware_error_recovery If non-zero, attempt to recover errors if possible.
3158 */
3159 void burn_read_opts_set_hardware_error_recovery(struct burn_read_opts *opts,
3160  int hardware_error_recovery);
3161 
3162 /** Sets whether to report recovered errors or not
3163  @param opts The read opts to change
3164  @param report_recovered_errors If non-zero, recovered errors will be reported.
3165 */
3166 void burn_read_opts_report_recovered_errors(struct burn_read_opts *opts,
3167  int report_recovered_errors);
3168 
3169 /** Sets whether blocks with unrecoverable errors should be read or not
3170  @param opts The read opts to change
3171  @param transfer_damaged_blocks If non-zero, blocks with unrecoverable errors will still be read.
3172 */
3173 void burn_read_opts_transfer_damaged_blocks(struct burn_read_opts *opts,
3174  int transfer_damaged_blocks);
3175 
3176 /** Sets the number of retries to attempt when trying to correct an error
3177  @param opts The read opts to change
3178  @param hardware_error_retries The number of retries to attempt when correcting an error.
3179 */
3180 void burn_read_opts_set_hardware_error_retries(struct burn_read_opts *opts,
3181  unsigned char hardware_error_retries);
3182 
3183 
3184 /* ts A90815 */
3185 /** Gets the list of profile codes supported by the drive.
3186  Profiles depict the feature sets which constitute media types. For
3187  known profile codes and names see burn_disc_get_profile().
3188  @param d is the drive to query
3189  @param num_profiles returns the number of supported profiles
3190  @param profiles returns the profile codes
3191  @param is_current returns the status of the corresponding profile code:
3192  1= current, i.e. the matching media is loaded
3193  0= not current, i.e. the matching media is not loaded
3194  @return always 1 for now
3195  @since 0.7.0
3196 */
3197 int burn_drive_get_all_profiles(struct burn_drive *d, int *num_profiles,
3198  int profiles[64], char is_current[64]);
3199 
3200 
3201 /* ts A90815 */
3202 /** Obtains the profile name associated with a profile code.
3203  @param profile_code the profile code to be translated
3204  @param name returns the profile name (e.g. "DVD+RW")
3205  @return 1= known profile code , 0= unknown profile code
3206  @since 0.7.0
3207 */
3208 int burn_obtain_profile_name(int profile_code, char name[80]);
3209 
3210 
3211 /** Gets the maximum write speed for a drive and eventually loaded media.
3212  The return value might change by the media type of already loaded media,
3213  again by call burn_drive_grab() and again by call burn_disc_read_atip().
3214  @param d Drive to query
3215  @return Maximum write speed in K/s
3216 */
3217 int burn_drive_get_write_speed(struct burn_drive *d);
3218 
3219 
3220 /* ts A61021 */
3221 /** Gets the minimum write speed for a drive and eventually loaded media.
3222  The return value might change by the media type of already loaded media,
3223  again by call burn_drive_grab() and again by call burn_disc_read_atip().
3224  @param d Drive to query
3225  @return Minimum write speed in K/s
3226  @since 0.2.6
3227 */
3228 int burn_drive_get_min_write_speed(struct burn_drive *d);
3229 
3230 
3231 /** Gets the maximum read speed for a drive
3232  @param d Drive to query
3233  @return Maximum read speed in K/s
3234 */
3235 int burn_drive_get_read_speed(struct burn_drive *d);
3236 
3237 
3238 /* ts A61226 */
3239 /** Obtain a copy of the current speed descriptor list. The drive's list gets
3240  updated on various occasions such as burn_drive_grab() but the copy
3241  obtained here stays untouched. It has to be disposed via
3242  burn_drive_free_speedlist() when it is not longer needed. Speeds
3243  may appear several times in the list. The list content depends much on
3244  drive and media type. It seems that .source == 1 applies mostly to CD media
3245  whereas .source == 2 applies to any media.
3246  @param d Drive to query
3247  @param speed_list The copy. If empty, *speed_list gets returned as NULL.
3248  @return 1=success , 0=list empty , <0 severe error
3249  @since 0.3.0
3250 */
3251 int burn_drive_get_speedlist(struct burn_drive *d,
3252  struct burn_speed_descriptor **speed_list);
3253 
3254 /* ts A70713 */
3255 /** Look up the fastest speed descriptor which is not faster than the given
3256  speed_goal. If it is 0, then the fastest one is chosen among the
3257  descriptors with the highest end_lba. If it is -1 then the slowest speed
3258  descriptor is chosen regardless of end_lba. Parameter flag decides whether
3259  the speed goal means write speed or read speed.
3260  @param d Drive to query
3261  @param speed_goal Upper limit for speed,
3262  0=search for maximum speed , -1 search for minimum speed
3263  @param best_descr Result of the search, NULL if no match
3264  @param flag Bitfield for control purposes
3265  bit0= look for best read speed rather than write speed
3266  bit1= look for any source type (else look for source==2 first
3267  and for any other source type only with CD media)
3268  @return >0 indicates a valid best_descr, 0 = no valid best_descr
3269  @since 0.3.8
3270 */
3271 int burn_drive_get_best_speed(struct burn_drive *d, int speed_goal,
3272  struct burn_speed_descriptor **best_descr, int flag);
3273 
3274 
3275 /* ts A61226 */
3276 /** Dispose a speed descriptor list copy which was obtained by
3277  burn_drive_get_speedlist().
3278  @param speed_list The list copy. *speed_list gets set to NULL.
3279  @return 1=list disposed , 0= *speedlist was already NULL
3280  @since 0.3.0
3281 */
3282 int burn_drive_free_speedlist(struct burn_speed_descriptor **speed_list);
3283 
3284 
3285 /* ts A70203 */
3286 /* @since 0.3.2 */
3287 /** The reply structure for burn_disc_get_multi_caps()
3288 */
3290 
3291  /* Multi-session capability allows to keep the media appendable after
3292  writing a session. It also guarantees that the drive will be able
3293  to predict and use the appropriate Next Writeable Address to place
3294  the next session on the media without overwriting the existing ones.
3295  It does not guarantee that the selected write type is able to do
3296  an appending session after the next session. (E.g. CD SAO is capable
3297  of multi-session by keeping a disc appendable. But .might_do_sao
3298  will be 0 afterwards, when checking the appendable media.)
3299  1= media may be kept appendable by burn_write_opts_set_multi(o,1)
3300  0= media will not be appendable
3301  */
3303 
3304  /* Multi-track capability allows to write more than one track source
3305  during a single session. The written tracks can later be found in
3306  libburn's TOC model with their start addresses and sizes.
3307  1= multiple tracks per session are allowed
3308  0= only one track per session allowed
3309  */
3311 
3312  /* Start-address capability allows to set a non-zero address with
3313  burn_write_opts_set_start_byte(). Eventually this has to respect
3314  .start_alignment and .start_range_low, .start_range_high in this
3315  structure.
3316  1= non-zero start address is allowed
3317  0= only start address 0 is allowed (to depict the drive's own idea
3318  about the appropriate write start)
3319  */
3321 
3322  /** The alignment for start addresses.
3323  ( start_address % start_alignment ) must be 0.
3324  */
3326 
3327  /** The lowest permissible start address.
3328  */
3330 
3331  /** The highest addressable start address.
3332  */
3334 
3335  /** Potential availability of write modes
3336  4= needs no size prediction, not to be chosen automatically
3337  3= needs size prediction, not to be chosen automatically
3338  2= available, no size prediction necessary
3339  1= available, needs exact size prediction
3340  0= not available
3341  With CD media (profiles 0x09 and 0x0a) check also the elements
3342  *_block_types of the according write mode.
3343  */
3347 
3348  /** Generally advised write mode.
3349  Not necessarily the one chosen by burn_write_opts_auto_write_type()
3350  because the burn_disc structure might impose particular demands.
3351  */
3353 
3354  /** Write mode as given by parameter wt of burn_disc_get_multi_caps().
3355  */
3357 
3358  /** Profile number which was current when the reply was generated */
3360 
3361  /** Wether the current profile indicates CD media. 1=yes, 0=no */
3363 
3364  /* ts A70528 */
3365  /* @since 0.3.8 */
3366  /** Wether the current profile is able to perform simulated write */
3368 };
3369 
3370 /** Allocates a struct burn_multi_caps (see above) and fills it with values
3371  which are appropriate for the drive and the loaded media. The drive
3372  must be grabbed for this call. The returned structure has to be disposed
3373  via burn_disc_free_multi_caps() when no longer needed.
3374  @param d The drive to inquire
3375  @param wt With BURN_WRITE_NONE the best capabilities of all write modes
3376  get returned. If set to a write mode like BURN_WRITE_SAO the
3377  capabilities with that particular mode are returned and the
3378  return value is 0 if the desired mode is not possible.
3379  @param caps returns the info structure
3380  @param flag Bitfield for control purposes (unused yet, submit 0)
3381  @return < 0 : error , 0 : writing seems impossible , 1 : writing possible
3382  @since 0.3.2
3383 */
3384 int burn_disc_get_multi_caps(struct burn_drive *d, enum burn_write_types wt,
3385  struct burn_multi_caps **caps, int flag);
3386 
3387 /** Removes from memory a multi session info structure which was returned by
3388  burn_disc_get_multi_caps(). The pointer *caps gets set to NULL.
3389  @param caps the info structure to dispose (note: pointer to pointer)
3390  @return 0 : *caps was already NULL, 1 : memory object was disposed
3391  @since 0.3.2
3392 */
3393 int burn_disc_free_multi_caps(struct burn_multi_caps **caps);
3394 
3395 
3396 /** Gets a copy of the toc_entry structure associated with a track
3397  @param t Track to get the entry from
3398  @param entry Struct for the library to fill out
3399 */
3400 void burn_track_get_entry(struct burn_track *t, struct burn_toc_entry *entry);
3401 
3402 /** Gets a copy of the toc_entry structure associated with a session's lead out
3403  @param s Session to get the entry from
3404  @param entry Struct for the library to fill out
3405 */
3406 void burn_session_get_leadout_entry(struct burn_session *s,
3407  struct burn_toc_entry *entry);
3408 
3409 /** Gets an array of all complete sessions for the disc
3410  THIS IS NO LONGER VALID AFTER YOU ADD OR REMOVE A SESSION
3411  The result array contains *num + burn_disc_get_incomplete_sessions()
3412  elements. All above *num are incomplete sessions.
3413  Typically there is at most one incomplete session with one empty track.
3414  DVD+R and BD-R seem to allow more than one track with even readable data.
3415  @param d Disc to get session array for
3416  @param num Returns the number of sessions in the array
3417  @return array of sessions
3418 */
3419 struct burn_session **burn_disc_get_sessions(struct burn_disc *d,
3420  int *num);
3421 
3422 /* ts B30112 */
3423 /* @since 1.2.8 */
3424 /** Obtains the number of incomplete sessions which are recorded in the
3425  result array of burn_disc_get_sessions() after the complete sessions.
3426  See above.
3427  @param d Disc object to inquire
3428  @return Number of incomplete sessions
3429 */
3430 int burn_disc_get_incomplete_sessions(struct burn_disc *d);
3431 
3432 
3433 int burn_disc_get_sectors(struct burn_disc *d);
3434 
3435 /** Gets an array of all the tracks for a session
3436  THIS IS NO LONGER VALID AFTER YOU ADD OR REMOVE A TRACK
3437  @param s session to get track array for
3438  @param num Returns the number of tracks in the array
3439  @return array of tracks
3440 */
3441 struct burn_track **burn_session_get_tracks(struct burn_session *s,
3442  int *num);
3443 
3444 int burn_session_get_sectors(struct burn_session *s);
3445 
3446 /** Gets the mode of a track
3447  @param track the track to query
3448  @return the track's mode
3449 */
3450 int burn_track_get_mode(struct burn_track *track);
3451 
3452 /** Returns whether the first track of a session is hidden in the pregap
3453  @param session the session to query
3454  @return non-zero means the first track is hidden
3455 */
3456 int burn_session_get_hidefirst(struct burn_session *session);
3457 
3458 /** Returns the library's version in its parts.
3459  This is the runtime counterpart of the three build time macros
3460  burn_header_version_* below.
3461  @param major The major version number
3462  @param minor The minor version number
3463  @param micro The micro version number
3464 */
3465 void burn_version(int *major, int *minor, int *micro);
3466 
3467 
3468 /* ts A80129 */
3469 /* @since 0.4.4 */
3470 /** These three release version numbers tell the revision of this header file
3471  and of the API it describes. They are memorized by applications at build
3472  time.
3473  Immediately after burn_initialize() an application should do this check:
3474  burn_version(&major, &minor, &micro);
3475  if(major > burn_header_version_major
3476  || (major == burn_header_version_major
3477  && (minor > burn_header_version_minor
3478  || (minor == burn_header_version_minor
3479  && micro >= burn_header_version_micro)))) {
3480  ... Young enough. Go on with program run ....
3481  } else {
3482  ... Too old. Do not use this libburn version ...
3483  }
3484 
3485 */
3486 #define burn_header_version_major 1
3487 #define burn_header_version_minor 2
3488 #define burn_header_version_micro 8
3489 /** Note:
3490  Above version numbers are also recorded in configure.ac because libtool
3491  wants them as parameters at build time.
3492  For the library compatibility check, BURN_*_VERSION in configure.ac
3493  are not decisive. Only the three numbers above do matter.
3494 */
3495 /** Usage discussion:
3496 
3497 Some developers of the libburnia project have differing
3498 opinions how to ensure the compatibility of libaries
3499 and applications.
3500 
3501 It is about whether to use at compile time and at runtime
3502 the version numbers isoburn_header_version_* provided here.
3503 Thomas Schmitt advises to use them.
3504 Vreixo Formoso advises to use other means.
3505 
3506 At compile time:
3507 
3508 Vreixo Formoso advises to leave proper version matching
3509 to properly programmed checks in the the application's
3510 build system, which will eventually refuse compilation.
3511 
3512 Thomas Schmitt advises to use the macros defined here
3513 for comparison with the application's requirements of
3514 library revisions and to eventually break compilation.
3515 
3516 Both advises are combinable. I.e. be master of your
3517 build system and have #if checks in the source code
3518 of your application, nevertheless.
3519 
3520 At runtime (via *_is_compatible()):
3521 
3522 Vreixo Formoso advises to compare the application's
3523 requirements of library revisions with the runtime
3524 library. This is to allow runtime libraries which are
3525 young enough for the application but too old for
3526 the lib*.h files seen at compile time.
3527 
3528 Thomas Schmitt advises to compare the header
3529 revisions defined here with the runtime library.
3530 This is to enforce a strictly monotonous chain
3531 of revisions from app to header to library,
3532 at the cost of excluding some older libraries.
3533 
3534 These two advises are mutually exclusive.
3535 
3536 */
3537 
3538 /* ts A91226 */
3539 /** Obtain the id string of the SCSI transport interface.
3540  This interface may be a system specific adapter module of libburn or
3541  an adapter to a supporting library like libcdio.
3542  @param flag Bitfield for control puposes, submit 0 for now
3543  @return A pointer to the id string. Do not alter the string content.
3544  @since 0.7.6
3545 */
3546 char *burn_scsi_transport_id(int flag);
3547 
3548 /* ts A60924 : ticket 74 */
3549 /** Control queueing and stderr printing of messages from libburn.
3550  Severity may be one of "NEVER", "ABORT", "FATAL", "FAILURE", "SORRY",
3551  "WARNING", "HINT", "NOTE", "UPDATE", "DEBUG", "ALL".
3552  @param queue_severity Gives the minimum limit for messages to be queued.
3553  Default: "NEVER". If you queue messages then you
3554  must consume them by burn_msgs_obtain().
3555  @param print_severity Does the same for messages to be printed directly
3556  to stderr. Default: "FATAL".
3557  @param print_id A text prefix to be printed before the message.
3558  @return >0 for success, <=0 for error
3559  @since 0.2.6
3560 */
3561 int burn_msgs_set_severities(char *queue_severity,
3562  char *print_severity, char *print_id);
3563 
3564 /* ts A60924 : ticket 74 */
3565 /* @since 0.2.6 */
3566 #define BURN_MSGS_MESSAGE_LEN 4096
3567 
3568 /** Obtain the oldest pending libburn message from the queue which has at
3569  least the given minimum_severity. This message and any older message of
3570  lower severity will get discarded from the queue and is then lost forever.
3571  @param minimum_severity may be one of "NEVER", "ABORT", "FATAL",
3572  "FAILURE", "SORRY", "WARNING", "HINT", "NOTE", "UPDATE",
3573  "DEBUG", "ALL".
3574  To call with minimum_severity "NEVER" will discard the
3575  whole queue.
3576  @param error_code Will become a unique error code as listed in
3577  libburn/libdax_msgs.h
3578  @param msg_text Must provide at least BURN_MSGS_MESSAGE_LEN bytes.
3579  @param os_errno Will become the eventual errno related to the message
3580  @param severity Will become the severity related to the message and
3581  should provide at least 80 bytes.
3582  @return 1 if a matching item was found, 0 if not, <0 for severe errors
3583  @since 0.2.6
3584 */
3585 int burn_msgs_obtain(char *minimum_severity,
3586  int *error_code, char msg_text[], int *os_errno,
3587  char severity[]);
3588 
3589 
3590 /* ts A70922 */
3591 /** Submit a message to the libburn queueing system. It will be queued or
3592  printed as if it was generated by libburn itself.
3593  @param error_code The unique error code of your message.
3594  Submit 0 if you do not have reserved error codes within
3595  the libburnia project.
3596  @param msg_text Not more than BURN_MSGS_MESSAGE_LEN characters of
3597  message text.
3598  @param os_errno Eventual errno related to the message. Submit 0 if
3599  the message is not related to a operating system error.
3600  @param severity One of "ABORT", "FATAL", "FAILURE", "SORRY", "WARNING",
3601  "HINT", "NOTE", "UPDATE", "DEBUG". Defaults to "FATAL".
3602  @param d An eventual drive to which the message shall be related.
3603  Submit NULL if the message is not specific to a
3604  particular drive object.
3605  @return 1 if message was delivered, <=0 if failure
3606  @since 0.4.0
3607 */
3608 int burn_msgs_submit(int error_code, char msg_text[], int os_errno,
3609  char severity[], struct burn_drive *d);
3610 
3611 
3612 /* ts A71016 */
3613 /** Convert a severity name into a severity number, which gives the severity
3614  rank of the name.
3615  @param severity_name A name as with burn_msgs_submit(), e.g. "SORRY".
3616  @param severity_number The rank number: the higher, the more severe.
3617  @param flag Bitfield for control purposes (unused yet, submit 0)
3618  @return >0 success, <=0 failure
3619  @since 0.4.0
3620 */
3621 int burn_text_to_sev(char *severity_name, int *severity_number, int flag);
3622 
3623 
3624 /* ts A80202 */
3625 /** Convert a severity number into a severity name
3626  @param severity_number The rank number: the higher, the more severe.
3627  @param severity_name A name as with burn_msgs_submit(), e.g. "SORRY".
3628  @param flag Bitfield for control purposes (unused yet, submit 0)
3629  @return >0 success, <=0 failure
3630  @since 0.4.4
3631 */
3632 int burn_sev_to_text(int severity_number, char **severity_name, int flag);
3633 
3634 
3635 /* ts B21214 */
3636 /** Return a blank separated list of severity names. Sorted from low
3637  to high severity.
3638  @param flag Bitfield for control purposes (unused yet, submit 0)
3639  @return A constant string with the severity names
3640  @since 1.2.6
3641 */
3642 char *burn_list_sev_texts(int flag);
3643 
3644 
3645 /* ts A70915 */
3646 /** Replace the messenger object handle of libburn by a compatible handle
3647  obtained from a related library.
3648  See also: libisofs, API function iso_get_messenger().
3649  @param messenger The foreign but compatible message handle.
3650  @return 1 : success, <=0 : failure
3651  @since 0.4.0
3652 */
3653 int burn_set_messenger(void *messenger);
3654 
3655 
3656 /* ts A61002 */
3657 /* @since 0.2.6 */
3658 /** The prototype of a handler function suitable for burn_set_signal_handling()
3659  Such a function has to return -2 if it does not want the process to
3660  exit with value 1.
3661 */
3662 typedef int (*burn_abort_handler_t)(void *handle, int signum, int flag);
3663 
3664 /** Control built-in signal handling. Either by setting an own handler or
3665  by activating the built-in signal handler.
3666 
3667  A function parameter handle of NULL activates the built-in abort handler.
3668  Depending on mode it may cancel all drive operations, wait for all drives
3669  to become idle, exit(1). It may also prepare function
3670  burn_drive_get_status() for waiting and performing exit(1).
3671  If parameter handle may be NULL or a text that shall be used as prefix for
3672  pacifier messages of burn_abort_pacifier(). Other than with an application
3673  provided handler, the prefix char array does not have to be kept existing
3674  until the eventual signal event.
3675  Before version 0.7.8 only action 0 was available. I.e. the built-in handler
3676  waited for the drives to become idle and then performed exit(1) directly.
3677  But during burn_disc_write() onto real CD or DVD, FreeBSD 8.0 pauses the
3678  other threads until the signal handler returns.
3679  The new actions try to avoid this deadlock. It is advised to use action 3
3680  at least during burn_disc_write(), burn_disc_erase(), burn_disc_format():
3681  burn_set_signal_handling(text, NULL, 0x30);
3682  and to call burn_is_aborting(0) when the drive is BURN_DRIVE_IDLE.
3683  If burn_is_aborting(0) returns 1, then call burn_abort() and exit(1).
3684 
3685  @param handle Opaque handle eventually pointing to an application
3686  provided memory object
3687  @param handler A function to be called on signals, if the handling bits
3688  in parameter mode are set 0.
3689  It will get parameter handle as argument. flag will be 0.
3690  It should finally call burn_abort(). See there.
3691  If the handler function returns 2 or -2, then the wrapping
3692  signal handler of libburn will return and let the program
3693  continue its operations. Any other return value causes
3694  exit(1).
3695  @param mode : bit0 - bit3: Handling of received signals:
3696  0 Install libburn wrapping signal handler, which will call
3697  handler(handle, signum, 0) on nearly all signals
3698  1 Enable system default reaction on all signals
3699  2 Try to ignore nearly all signals
3700  10 like mode 2 but handle SIGABRT like with mode 0
3701  bit4 - bit7: With handler == NULL :
3702  Action of built-in handler. "control thread" is the one
3703  which called burn_set_signal_handling().
3704  All actions activate receive mode 2 to ignore further
3705  signals.
3706  0 Same as 1 (for pre-0.7.8 backward compatibility)
3707  @since 0.7.8
3708  1 Catch the control thread in abort handler, call
3709  burn_abort(>0) and finally exit(1).
3710  Does not always work with FreeBSD.
3711  2 Call burn_abort(-1) and return from handler. When the
3712  control thread calls burn_drive_get_status(), then do
3713  burn_abort(>0) instead, and finally exit(1).
3714  Does not always work with FreeBSD.
3715  3 Call burn_abort(-1), return from handler. It is duty of
3716  the application to detect a pending abort condition
3717  by calling burn_is_aborting() and to wait for all
3718  drives to become idle. E.g. by calling burn_abort(>0).
3719  4 Like 3, but without calling burn_abort(-1). Only the
3720  indicator of burn_is_aborting() gets set.
3721  @since 0.2.6
3722 */
3723 void burn_set_signal_handling(void *handle, burn_abort_handler_t handler,
3724  int mode);
3725 
3726 
3727 /* ts B00304 */
3728 /* Inquire whether the built-in abort handler was triggered by a signal.
3729  This has to be done to detect pending abort handling if signal handling
3730  was set to the built-in handler and action was set to 2 or 3.
3731  @param flag Bitfield for control purposes (unused yet, submit 0)
3732  @return 0 = no abort was triggered
3733  >0 = action that was triggered (action 0 is reported as 1)
3734  @since 0.7.8
3735 */
3736 int burn_is_aborting(int flag);
3737 
3738 
3739 /* ts A70811 */
3740 /** Write data in random access mode.
3741  The drive must be grabbed successfully before calling this function which
3742  circumvents usual libburn session processing and rather writes data without
3743  preparations or finalizing. This will work only with overwriteable media
3744  which are also suitable for burn_write_opts_set_start_byte(). The same
3745  address alignment restrictions as with this function apply. I.e. for DVD
3746  it is best to align to 32 KiB blocks (= 16 LBA units). The amount of data
3747  to be written is subject to the same media dependent alignment rules.
3748  Again, 32 KiB is most safe.
3749  Call burn_disc_get_multi_caps() can obtain the necessary media info. See
3750  resulting struct burn_multi_caps elements .start_adr , .start_alignment ,
3751  .start_range_low , .start_range_high .
3752  Other than burn_disc_write() this is a synchronous call which returns
3753  only after the write transaction has ended (sucessfully or not). So it is
3754  wise not to transfer giant amounts of data in a single call.
3755  Important: Data have to fit into the already formatted area of the media.
3756  @param d The drive to which to write
3757  @param byte_address The start address of the write in byte
3758  (1 LBA unit = 2048 bytes) (do respect media alignment)
3759  @param data The bytes to be written
3760  @param data_count The number of those bytes (do respect media alignment)
3761  data_count == 0 is permitted (e.g. to flush the
3762  drive buffer without further data transfer).
3763  @param flag Bitfield for control purposes:
3764  bit0 = flush the drive buffer after eventual writing
3765  @return 1=sucessful , <=0 : number of transfered bytes * -1
3766  @since 0.4.0
3767 */
3768 int burn_random_access_write(struct burn_drive *d, off_t byte_address,
3769  char *data, off_t data_count, int flag);
3770 
3771 
3772 /* ts A81215 */
3773 /** Inquire the maximum amount of readable data.
3774  It is supposed that all LBAs in the range from 0 to media_read_acpacity-1
3775  can be read via burn_read_data() although some of them may never have been
3776  recorded. If tracks are recognizable then it is better to only read
3777  LBAs which are part of some track.
3778  If the drive is actually a large file or block device, then the capacity
3779  is curbed to a maximum of 0x7ffffff0 blocks = 4 TB - 32 KB.
3780  @param d The drive from which to read
3781  @param capacity Will return the result if valid
3782  @param flag Bitfield for control purposes: Unused yet, submit 0.
3783  @return 1=sucessful , <=0 an error occured
3784  @since 0.6.0
3785 */
3786 int burn_get_read_capacity(struct burn_drive *d, int *capacity, int flag);
3787 
3788 
3789 /* ts A70812 */
3790 /** Read data in random access mode.
3791  The drive must be grabbed successfully before calling this function.
3792  With all currently supported drives and media the byte_address has to
3793  be aligned to 2048 bytes. Only data tracks with 2048 bytes per sector
3794  can be read this way. I.e. not CD-audio, not CD-video-stream ...
3795  This is a synchronous call which returns only after the full read job
3796  has ended (sucessfully or not). So it is wise not to read giant amounts
3797  of data in a single call.
3798  @param d The drive from which to read
3799  @param byte_address The start address of the read in byte (aligned to 2048)
3800  @param data A memory buffer capable of taking data_size bytes
3801  @param data_size The amount of data to be read. This does not have to
3802  be aligned to any block size.
3803  @param data_count The amount of data actually read (interesting on error)
3804  @param flag Bitfield for control purposes:
3805  bit0= - reserved -
3806  bit1= do not submit error message if read error
3807  bit2= on error do not try to read a second time
3808  with single block steps.
3809  @since 0.5.2
3810  bit3= return -2 on permission denied error rather than
3811  issueing a warning message.
3812  @since 1.0.6
3813  bit4= return -3 on SCSI error
3814  5 64 00 ILLEGAL MODE FOR THIS TRACK
3815  and prevent this error from being reported as
3816  event message. Do not retry reading in this case.
3817  (Useful to try the last two blocks of a CD
3818  track which might be non-data because of TAO.)
3819  @since 1.2.6
3820  @return 1=sucessful , <=0 an error occured
3821  with bit3: -2= permission denied error
3822  @since 0.4.0
3823 */
3824 int burn_read_data(struct burn_drive *d, off_t byte_address,
3825  char data[], off_t data_size, off_t *data_count, int flag);
3826 
3827 
3828 /* ts B21119 */
3829 /** Read CD audio sectors in random access mode.
3830  The drive must be grabbed successfully before calling this function.
3831  Only CD audio tracks with 2352 bytes per sector can be read this way.
3832  I.e. not data tracks, not CD-video-stream, ...
3833 
3834  Note that audio data do not have exact block addressing. If you read a
3835  sequence of successive blocks then you will get a seamless stream
3836  of data. But the actual start and end position of this audio stream
3837  will differ by a few dozens of milliseconds, depending on individual
3838  CD and individual drive.
3839  Expect leading and trailing zeros, as well as slight truncation.
3840 
3841  @param d The drive from which to read.
3842  It must be a real MMC drive (i.e. not a stdio file)
3843  and it must have a CD loaded (i.e. not DVD or BD).
3844  @param sector_no The sector number (Logical Block Address)
3845  It may be slightly below 0, depending on drive and
3846  medium. -150 is a lower limit.
3847  @param data A memory buffer capable of taking data_size bytes
3848  @param data_size The amount of data to be read. This must be aligned
3849  to full multiples of 2352.
3850  @param data_count The amount of data actually read (interesting on error)
3851  @param flag Bitfield for control purposes:
3852  bit0= - reserved -
3853  bit1= do not submit error message if read error
3854  bit2= on error do not try to read a second time
3855  with single block steps.
3856  bit3= Enable DAP : "flaw obscuring mechanisms like
3857  audio data mute and interpolate"
3858  bit4= return -3 on SCSI error
3859  5 64 00 ILLEGAL MODE FOR THIS TRACK
3860  and prevent this error from being reported as
3861  event message. Do not retry reading in this case.
3862  (Useful to try the last two blocks of a CD
3863  track which might be non-audio because of TAO.)
3864  @return 1=sucessful , <=0 an error occured
3865  with bit3: -2= permission denied error
3866  @since 1.2.6
3867 */
3868 int burn_read_audio(struct burn_drive *d, int sector_no,
3869  char data[], off_t data_size, off_t *data_count, int flag);
3870 
3871 
3872 /* ts A70904 */
3873 /** Inquire whether the drive object is a real MMC drive or a pseudo-drive
3874  created by a stdio: address.
3875  @param d The drive to inquire
3876  @return 0= null-drive
3877  1= real MMC drive
3878  2= stdio-drive, random access, read-write
3879  3= stdio-drive, sequential, write-only
3880  4= stdio-drive, random access, read-only
3881  (only if enabled by burn_allow_drive_role_4())
3882  5= stdio-drive, random access, write-only
3883  (only if enabled by burn_allow_drive_role_4())
3884  @since 0.4.0
3885 */
3886 int burn_drive_get_drive_role(struct burn_drive *d);
3887 
3888 
3889 /* ts B10312 */
3890 /** Allow drive role 4 "random access read-only"
3891  and drive role 5 "random access write-only".
3892  By default a random access file assumes drive role 2 "read-write"
3893  regardless whether it is actually readable or writeable.
3894  If enabled, random-access file objects which recognizably allow no
3895  writing will be classified as role 4 and those which allow no reading
3896  will get role 5.
3897  Candidates are drive addresses of the form stdio:/dev/fd/# , where # is
3898  the integer number of an open file descriptor. If this descriptor was
3899  opened read-only resp. write-only, then it gets role 4 resp. role 5.
3900  Other paths may get tested by an attempt to open them for read-write
3901  (role 2) resp. read-only (role 4) resp. write-only (role 5). See bit1.
3902  @param allowed Bitfield for control purposes:
3903  bit0= Enable roles 4 and 5 for drives which get
3904  aquired after this call
3905  bit1= with bit0:
3906  Test whether the file can be opened for
3907  read-write resp. read-only resp. write-only.
3908  Classify as roles 2 resp. 4 resp. 5.
3909  bit2= with bit0 and bit1:
3910  Classify files which cannot be opened at all
3911  as role 0 : useless dummy.
3912  Else classify as role 2.
3913  bit3= Classify non-empty role 5 drives as
3914  BURN_DISC_APPENDABLE with Next Writeable Address
3915  after the end of the file. It is nevertheless
3916  possible to change this address by call
3917  burn_write_opts_set_start_byte().
3918  @since 1.0.6
3919 */
3920 void burn_allow_drive_role_4(int allowed);
3921 
3922 
3923 /* ts A70923 */
3924 /** Find out whether a given address string would lead to the given drive
3925  object. This should be done in advance for track source addresses
3926  with parameter drive_role set to 2.
3927  Although a real MMC drive should hardly exist as two drive objects at
3928  the same time, this can easily happen with stdio-drives. So if more than
3929  one drive is used by the application, then this gesture is advised:
3930  burn_drive_d_get_adr(d2, adr2);
3931  if (burn_drive_equals_adr(d1, adr2, burn_drive_get_drive_role(d2)))
3932  ... Both drive objects point to the same storage facility ...
3933 
3934  @param d1 Existing drive object
3935  @param adr2 Address string to be tested. Prefix "stdio:" overrides
3936  parameter drive_role2 by either 0 or 2 as appropriate.
3937  The string must be shorter than BURN_DRIVE_ADR_LEN.
3938  @param drive_role2 Role as burn_drive_get_drive_role() would attribute
3939  to adr2 if it was a drive. Use value 2 for checking track
3940  sources resp. pseudo-drive addresses without "stdio:".
3941  Use 1 for checking drive addresses including those with
3942  prefix "stdio:".
3943  @return 1= adr2 leads to d1 , 0= adr2 seems not to lead to d1,
3944  -1 = adr2 is bad
3945  @since 0.4.0
3946 */
3947 int burn_drive_equals_adr(struct burn_drive *d1, char *adr2, int drive_role2);
3948 
3949 
3950 
3951 /*
3952  Audio track data extraction facility.
3953 */
3954 
3955 /* Maximum size for address paths and fmt_info strings */
3956 #define LIBDAX_AUDIOXTR_STRLEN 4096
3957 
3958 
3959 /** Extractor object encapsulating intermediate states of extraction.
3960  The clients of libdax_audioxtr shall only allocate pointers to this
3961  struct and get a storage object via libdax_audioxtr_new().
3962  Appropriate initial value for the pointer is NULL.
3963 */
3964 struct libdax_audioxtr;
3965 
3966 
3967 /** Open an audio file, check wether suitable, create extractor object.
3968  @param xtr Opaque handle to extractor. Gets attached extractor object.
3969  @param path Address of the audio file to extract. "-" is stdin (but might
3970  be not suitable for all futurely supported formats).
3971  @param flag Bitfield for control purposes (unused yet, submit 0)
3972  @return >0 success
3973  0 unsuitable format
3974  -1 severe error
3975  -2 path not found
3976  @since 0.2.4
3977 */
3978 int libdax_audioxtr_new(struct libdax_audioxtr **xtr, char *path, int flag);
3979 
3980 
3981 /** Obtain identification parameters of opened audio source.
3982  @param xtr Opaque handle to extractor
3983  @param fmt Gets pointed to the audio file format id text: ".wav" , ".au"
3984  @param fmt_info Gets pointed to a format info text telling parameters
3985  @param num_channels e.g. 1=mono, 2=stereo, etc
3986  @param sample_rate e.g. 11025, 44100
3987  @param bits_per_sample e.g. 8= 8 bits per sample, 16= 16 bits ...
3988  @param msb_first Byte order of samples: 0= Intel = Little Endian
3989  1= Motorola = Big Endian
3990  @param flag Bitfield for control purposes (unused yet, submit 0)
3991  @return >0 success, <=0 failure
3992  @since 0.2.4
3993 */
3994 int libdax_audioxtr_get_id(struct libdax_audioxtr *xtr,
3995  char **fmt, char **fmt_info,
3996  int *num_channels, int *sample_rate,
3997  int *bits_per_sample, int *msb_first, int flag);
3998 
3999 
4000 /** Obtain a prediction about the extracted size based on internal information
4001  of the formatted file.
4002  @param xtr Opaque handle to extractor
4003  @param size Gets filled with the predicted size
4004  @param flag Bitfield for control purposes (unused yet, submit 0)
4005  @return 1 prediction was possible , 0 no prediction could be made
4006  @since 0.2.4
4007 */
4008 int libdax_audioxtr_get_size(struct libdax_audioxtr *o, off_t *size, int flag);
4009 
4010 
4011 /** Obtain next buffer full of extracted data in desired format (only raw audio
4012  for now).
4013  @param xtr Opaque handle to extractor
4014  @param buffer Gets filled with extracted data
4015  @param buffer_size Maximum number of bytes to be filled into buffer
4016  @param flag Bitfield for control purposes
4017  bit0= do not stop at predicted end of data
4018  @return >0 number of valid buffer bytes,
4019  0 End of file
4020  -1 operating system reports error
4021  -2 usage error by application
4022  @since 0.2.4
4023 */
4024 int libdax_audioxtr_read(struct libdax_audioxtr *xtr,
4025  char buffer[], int buffer_size, int flag);
4026 
4027 
4028 /** Try to obtain a file descriptor which will deliver extracted data
4029  to normal calls of read(2). This may fail because the format is
4030  unsuitable for that, but ".wav" is ok. If this call succeeds the xtr
4031  object will have forgotten its file descriptor and libdax_audioxtr_read()
4032  will return a usage error. One may use *fd after libdax_audioxtr_destroy()
4033  and will have to close it via close(2) when done with it.
4034  @param xtr Opaque handle to extractor
4035  @param fd Eventually returns the file descriptor number
4036  @param flag Bitfield for control purposes
4037  bit0= do not dup(2) and close(2) but hand out original fd
4038  @return 1 success, 0 cannot hand out fd , -1 severe error
4039  @since 0.2.4
4040 */
4041 int libdax_audioxtr_detach_fd(struct libdax_audioxtr *o, int *fd, int flag);
4042 
4043 
4044 /** Clean up after extraction and destroy extractor object.
4045  @param xtr Opaque handle to extractor, *xtr is allowed to be NULL,
4046  *xtr is set to NULL by this function
4047  @param flag Bitfield for control purposes (unused yet, submit 0)
4048  @return 1 = destroyed object, 0 = was already destroyed
4049  @since 0.2.4
4050 */
4051 int libdax_audioxtr_destroy(struct libdax_audioxtr **xtr, int flag);
4052 
4053 
4054 #ifndef DOXYGEN
4055 
4056 BURN_END_DECLS
4057 
4058 #endif
4059 
4060 
4061 /* ts A91205 */
4062 /* The following experiments may be interesting in future:
4063 */
4064 
4065 /* Perform OPC explicitely.
4066  # define Libburn_pioneer_dvr_216d_with_opC 1
4067 */
4068 
4069 /* Load mode page 5 and modify it rather than composing from scratch.
4070  # define Libburn_pioneer_dvr_216d_load_mode5 1
4071 */
4072 
4073 /* Inquire drive events and react by reading configuration or starting unit.
4074  # define Libburn_pioneer_dvr_216d_get_evenT 1
4075 */
4076 
4077 /* ts A91112 */
4078 /* Do not probe CD modes but declare only data and audio modes supported.
4079  For other modes resp. real probing one has to call
4080  burn_drive_probe_cd_write_modes().
4081 
4082 */
4083 #define Libburn_dummy_probe_write_modeS 1
4084 
4085 /* ts B30112 */
4086 /* Handle DVD+R with reserved tracks in incomplete first session
4087  by loading info about the incomplete session into struct burn_disc
4088 */
4089 #define Libburn_disc_with_incomplete_sessioN 1
4090 
4091 
4092 /* Early experimental:
4093  Do not define Libburn_develop_quality_scaN unless you want to work
4094  towards a usable implementation.
4095  If it gets enabled, then the call must be published in libburn/libburn.ver
4096 */
4097 #ifdef Libburn_develop_quality_scaN
4098 
4099 /* ts B21108 */
4100 /* Experiments mit quality scan command F3 on Optiarc drive */
4101 int burn_nec_optiarc_rep_err_rate(struct burn_drive *d,
4102  int start_lba, int rate_period, int flag);
4103 
4104 #endif /* Libburn_develop_quality_scaN */
4105 
4106 
4107 
4108 #endif /*LIBBURN_H*/