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

Generated for libburn by  doxygen 1.8.7