libisoburn  1.2.2
libisoburn.h
Go to the documentation of this file.
1 
2 /*
3  Lower level API definition of libisoburn.
4 
5  Copyright 2007-2012 Vreixo Formoso Lopes <metalpain2002@yahoo.es>
6  and Thomas Schmitt <scdbackup@gmx.net>
7  Provided under GPL version 2 or later.
8 */
9 
10 /** Overview
11 
12 libisoburn is a frontend for libraries libburn and libisofs which enables
13 creation and expansion of ISO-9660 filesystems on all CD/DVD/BD media supported
14 by libburn. This includes media like DVD+RW, which do not support multi-session
15 management on media level and even plain disk files or block devices.
16 
17 The price for that is thorough specialization on data files in ISO-9660
18 filesystem images. So libisoburn is not suitable for audio (CD-DA) or any
19 other CD layout which does not entirely consist of ISO-9660 sessions.
20 
21 Note that there is a higher level of API: xorriso.h. One should not mix it
22 with the API calls of libisoburn.h, libisofs.h, and libburn.h.
23 
24 
25  Connector functions
26 
27 libisofs and libburn do not depend on each other but share some interfaces
28 by which they can cooperate.
29 libisoburn establishes the connection between both modules by creating the
30 necessary interface objects and attaching them to the right places.
31 
32 
33  Wrapper functions
34 
35 The priciple of this frontend is that you may use any call of libisofs or
36 libburn unless it has a isoburn_*() wrapper listed in the following function
37 documentation.
38 
39 E.g. call isoburn_initialize() rather than iso_init(); burn_initialize();
40 and call isoburn_drive_scan_and_grab() rather than burn_drive_scan_and_grab().
41 But you may call burn_disc_get_profile() directly if you want to display
42 the media type.
43 
44 The wrappers will transparently provide the necessary emulations which
45 are appropriate for particular target drives and media states.
46 To learn about them you have to read both API descriptions: the one of
47 the wrapper and the one of the underlying libburn or libisofs call.
48 
49 Macros BURN_* and functions burn_*() are documented in <libburn/libburn.h>
50 Macros ISO_* and functions iso_*() are documented in <libisofs/libisofs.h>
51 
52 
53  Usage model
54 
55 There may be an input drive and an output drive. Either of them may be missing
56 with the consequence that no reading resp. writing is possible.
57 Both drive roles can be fulfilled by the same drive.
58 
59 Input can be a random access readable libburn drive:
60  optical media, regular files, block devices.
61 Output can be any writeable libburn drive:
62  writeable optical media in burner, writeable file objects (no directories).
63 
64 libburn demands rw-permissions to drive device file resp. file object.
65 
66 If the input drive provides a suitable ISO RockRidge image, then its tree
67 may be loaded into memory and can then be manipulated by libisofs API calls.
68 The loading is done by isoburn_read_image() under control of
69 struct isoburn_read_opts which the application obtains from libisoburn
70 and manipulates by the family of isoburn_ropt_set_*() functions.
71 
72 Writing of result images is controlled by libisofs related parameters
73 in a struct isoburn_imgen_opts which the application obtains from libisoburn
74 and manipulates by the family of isoburn_igopt_set_*() functions.
75 
76 All multi-session aspects are handled by libisoburn according to these
77 settings. The application does not have to analyze media state and write
78 job parameters. It rather states its desires which libisoburn tries to
79 fulfill, or else will refuse to start the write run.
80 
81 
82  Setup for Growing, Modifying or Blind Growing
83 
84 The connector function family offers alternative API calls for performing
85 the setup for several alternative image generation strategies.
86 
87 Growing:
88 If input and output drive are the same, then isoburn_prepare_disc() is to
89 be used. It will lead to an add-on session on appendable or overwriteable
90 media with existing ISO image. With blank media it will produce a first
91 session.
92 
93 Modifying:
94 If the output drive is not the input drive, and if it bears blank media
95 or overwriteable without a valid ISO image, then one may produce a consolidated
96 image with old and new data. This will copy file data from an eventual input
97 drive with valid image, add any newly introduced data from the local
98 filesystem, and produce a first session on output media.
99 To prepare for such an image generation run, use isoburn_prepare_new_image().
100 
101 Blind Growing:
102 This method reads the old image from one drive and writes the add-on session
103 to a different drive. That output drive is nevertheless supposed to
104 finally lead to the same medium from where the session was loaded. Usually it
105 will be stdio:/dev/fd/1 (i.e. stdout) being piped into some burn program
106 like with this classic gesture:
107  mkisofs -M $dev -C $msc1,$nwa | cdrecord -waiti dev=$dev
108 Blind growing is prepared by the call isoburn_prepare_blind_grow().
109 The input drive should be released immediately after this call in order
110 to allow the consumer of the output stream to access that drive for writing.
111 
112 After either of these setups, some peripheral libburn drive parameter settings
113 like burn_write_opts_set_simulate(), burn_write_opts_set_multi(),
114  burn_drive_set_speed(), burn_write_opts_set_underrun_proof() should be made.
115 Do not set the write mode. It will be chosen by libisoburn so it matches job
116 and media state.
117 
118  Writing the image
119 
120 Then one may start image generation and write threads by isoburn_disc_write().
121 Progress may be watched at the output drive by burn_drive_get_status() and
122 isoburn_get_fifo_status().
123 
124 At some time, the output drive will be BURN_DRIVE_IDLE indicating that
125 writing has ended.
126 One should inquire isoburn_drive_wrote_well() to learn about overall success.
127 
128 Finally one must call isoburn_activate_session() which will complete any
129 eventual multi-session emulation.
130 
131 
132  Application Constraints
133 
134 Applications shall include libisofs/libisofs.h , libburn/libburn.h and this
135 file itself: libisoburn/libisoburn.h .
136 They shall link with -lisofs -lburn -lisoburn or with the .o files emerging
137 from building those libraries from their sources.
138 
139 Applications must use 64 bit off_t.
140 E.g. on 32-bit GNU/Linux by defining
141  #define _LARGEFILE_SOURCE
142  #define _FILE_OFFSET_BITS 64
143 The minimum requirement is to interface with the library by 64 bit signed
144 integers where libisofs.h or libisoburn.h prescribe off_t.
145 Failure to do so may result in surprising malfunction or memory faults.
146 
147 Application files which include libisofs/libisofs.h or libisoburn/libisoburn.h
148 must provide definitions for uint32_t and uint8_t.
149 This can be achieved either:
150 - by using autotools which will define HAVE_STDINT_H or HAVE_INTTYPES_H
151  according to its ./configure tests,
152 - or by defining the macros HAVE_STDINT_H resp. HAVE_INTTYPES_H according
153  to the local situation,
154 - or by appropriately defining uint32_t and uint8_t by other means,
155  e.g. by including inttypes.h before including libisofs.h and libisoburn.h
156 
157 */
158 #ifdef HAVE_STDINT_H
159 #include <stdint.h>
160 #else
161 #ifdef HAVE_INTTYPES_H
162 #include <inttypes.h>
163 #endif
164 #endif
165 
166 
167 /* Important: If you add a public API function then add its name to file
168  libisoburn/libisoburn.ver
169 */
170 
171 
172  /* API functions */
173 
174 
175 /** Initialize libisoburn, libisofs and libburn.
176  Wrapper for : iso_init() and burn_initialize()
177  @since 0.1.0
178  @param msg A character array for eventual messages (e.g. with errors)
179  @param flag Bitfield for control purposes (unused yet, submit 0)
180  @return 1 indicates success, 0 is failure
181 */
182 int isoburn_initialize(char msg[1024], int flag);
183 
184 
185 /** Check whether all features of header file libisoburn.h from the given
186  major.minor.micro revision triple can be delivered by the library version
187  which is performing this call.
188  An application of libisoburn can easily memorize the version of the
189  libisoburn.h header in its own code. Immediately after isoburn_initialize()
190  it should simply do this check:
191  if (! isoburn_is_compatible(isoburn_header_version_major,
192  isoburn_header_version_minor,
193  isoburn_header_version_micro, 0))
194  ...refuse to start the program with this dynamic library version...
195  @since 0.1.0
196  @param major obtained at build time
197  @param minor obtained at build time
198  @param micro obtained at build time
199  @param flag Bitfield for control purposes. Unused yet. Submit 0.
200  @return 1= library can work for caller
201  0= library is not usable in some aspects. Caller must restrict
202  itself to an earlier API version or must not use this libray
203  at all.
204 */
205 int isoburn_is_compatible(int major, int minor, int micro, int flag);
206 
207 
208 /** Obtain the three release version numbers of the library. These are the
209  numbers encountered by the application when linking with libisoburn,
210  i.e. possibly not before run time.
211  Better do not base the fundamental compatibility decision of an application
212  on these numbers. For a reliable check use isoburn_is_compatible().
213  @since 0.1.0
214  @param major The maturity version (0 for now, as we are still learning)
215  @param minor The development goal version.
216  @param micro The development step version. This has an additional meaning:
217 
218  Pare numbers indicate a version with frozen API. I.e. you can
219  rely on the same set of features to be present in all
220  published releases with that major.minor.micro combination.
221  Features of a pare release will stay available and ABI
222  compatible as long as the SONAME of libisoburn stays "1".
223  Currently there are no plans to ever change the SONAME.
224 
225  Odd numbers indicate that API upgrades are in progress.
226  I.e. new features might be already present or they might
227  be still missing. Newly introduced features may be changed
228  incompatibly or even be revoked before release of a pare
229  version.
230  So micro revisions {1,3,5,7,9} should never be used for
231  dynamic linking unless the proper library match can be
232  guaranteed by external circumstances.
233 
234  @return 1 success, <=0 might in future become an error indication
235 */
236 void isoburn_version(int *major, int *minor, int *micro);
237 
238 
239 /** The minimum version of libisofs to be used with this version of libisoburn
240  at compile time.
241  @since 0.1.0
242 */
243 #define isoburn_libisofs_req_major 1
244 #define isoburn_libisofs_req_minor 2
245 #define isoburn_libisofs_req_micro 2
246 
247 /** The minimum version of libburn to be used with this version of libisoburn
248  at compile time.
249  @since 0.1.0
250 */
251 #define isoburn_libburn_req_major 1
252 #define isoburn_libburn_req_minor 2
253 #define isoburn_libburn_req_micro 0
254 
255 /** The minimum compile time requirements of libisoburn towards libjte are
256  the same as of a suitable libisofs towards libjte.
257  So use these macros from libisofs.h :
258  iso_libjte_req_major
259  iso_libjte_req_minor
260  iso_libjte_req_micro
261  @since 0.6.4
262 */
263 
264 /** The minimum version of libisofs to be used with this version of libisoburn
265  at runtime. This is checked already in isoburn_initialize() which will
266  refuse on outdated version. So this call is for information purposes after
267  successful startup only.
268  @since 0.1.0
269  @param major isoburn_libisofs_req_major as seen at build time
270  @param minor as seen at build time
271  @param micro as seen at build time
272  @return 1 success, <=0 might in future become an error indication
273 */
274 int isoburn_libisofs_req(int *major, int *minor, int *micro);
275 
276 
277 /** The minimum version of libjte to be used with this version of libisoburn
278  at runtime. The use of libjte is optional and depends on configure
279  tests. It can be prevented by ./configure option --disable-libjte .
280  This is checked already in isoburn_initialize() which will refuse on
281  outdated version. So this call is for information purposes after
282  successful startup only.
283  @since 0.6.4
284 */
285 int isoburn_libjte_req(int *major, int *minor, int *micro);
286 
287 
288 /** The minimum version of libburn to be used with this version of libisoburn
289  at runtime. This is checked already in isoburn_initialize() which will
290  refuse on outdated version. So this call is for information purposes after
291  successful startup only.
292  @since 0.1.0
293  @param major isoburn_libburn_req_major as seen at build time
294  @param minor as seen at build time
295  @param micro as seen at build time
296  @return 1 success, <=0 might in future become an error indication
297 */
298 int isoburn_libburn_req(int *major, int *minor, int *micro);
299 
300 
301 /** These three release version numbers tell the revision of this header file
302  and of the API it describes. They are memorized by applications at build
303  time.
304  @since 0.1.0
305 */
306 #define isoburn_header_version_major 1
307 #define isoburn_header_version_minor 2
308 #define isoburn_header_version_micro 2
309 /** Note:
310  Above version numbers are also recorded in configure.ac because libtool
311  wants them as parameters at build time.
312  For the library compatibility check, ISOBURN_*_VERSION in configure.ac
313  are not decisive. Only the three numbers here do matter.
314 */
315 /** Usage discussion:
316 
317 Some developers of the libburnia project have differing
318 opinions how to ensure the compatibility of libaries
319 and applications.
320 
321 It is about whether to use at compile time and at runtime
322 the version numbers isoburn_header_version_* provided here.
323 Thomas Schmitt advises to use them.
324 Vreixo Formoso advises to use other means.
325 
326 At compile time:
327 
328 Vreixo Formoso advises to leave proper version matching
329 to properly programmed checks in the the application's
330 build system, which will eventually refuse compilation.
331 
332 Thomas Schmitt advises to use the macros defined here
333 for comparison with the application's requirements of
334 library revisions and to eventually break compilation.
335 
336 Both advises are combinable. I.e. be master of your
337 build system and have #if checks in the source code
338 of your application, nevertheless.
339 
340 At runtime (via *_is_compatible()):
341 
342 Vreixo Formoso advises to compare the application's
343 requirements of library revisions with the runtime
344 library. This is to allow runtime libraries which are
345 young enough for the application but too old for
346 the lib*.h files seen at compile time.
347 
348 Thomas Schmitt advises to compare the header
349 revisions defined here with the runtime library.
350 This is to enforce a strictly monotonous chain
351 of revisions from app to header to library,
352 at the cost of excluding some older libraries.
353 
354 These two advises are mutually exclusive.
355 
356 -----------------------------------------------------
357 
358 For an implementation of the Thomas Schmitt approach,
359 see libisoburn/burn_wrap.c : isoburn_initialize()
360 This connects libisoburn as "application" with libisofs
361 as "library".
362 
363 The compatible part of Vreixo Formoso's approach is implemented
364 in configure.ac LIBBURN_REQUIRED, LIBISOFS_REQUIRED.
365 In isoburn_initialize() it would rather test by
366  iso_lib_is_compatible(isoburn_libisofs_req_major,...
367 than by
368  iso_lib_is_compatible(iso_lib_header_version_major,...
369 and would leave out the ugly compile time traps.
370 
371 */
372 
373 
374 /** Announce to the library an application provided method for immediate
375  delivery of messages. It is used when no drive is affected directly or
376  if the drive has no own msgs_submit() method attached by
377  isoburn_drive_set_msgs_submit.
378  If no method is preset or if the method is set to NULL then libisoburn
379  delivers its messages through the message queue of libburn.
380  @param msgs_submit The function call which implements the method
381  @param submit_handle Handle to be used as first argument of msgs_submit
382  @param submit_flag Flag to be used as last argument of msgs_submit
383  @param flag Unused yet, submit 0
384  @since 0.2.0
385 */
386 int isoburn_set_msgs_submit(int (*msgs_submit)(void *handle, int error_code,
387  char msg_text[], int os_errno,
388  char severity[], int flag),
389  void *submit_handle, int submit_flag, int flag);
390 
391 
392 /** Acquire a target drive by its filesystem path resp. libburn persistent
393  address.
394  Wrapper for: burn_drive_scan_and_grab()
395  @since 0.1.0
396  @param drive_infos On success returns a one element array with the drive
397  (cdrom/burner). Thus use with driveno 0 only. On failure
398  the array has no valid elements at all.
399  The returned array should be freed via burn_drive_info_free()
400  when the drive is no longer needed. But before this is done
401  one has to call isoburn_drive_release(drive_infos[0].drive).
402  @param adr The persistent address of the desired drive.
403  @param load 1 attempt to load the disc tray. 0 no attempt,rather failure.
404  @return 1 = success , 0 = drive not found , <0 = other error
405 */
406 int isoburn_drive_scan_and_grab(struct burn_drive_info *drive_infos[],
407  char* adr, int load);
408 
409 
410 /** Acquire a target drive by its filesystem path resp. libburn persistent
411  address. This is a modern successor of isoburn_drive_scan_and_grab().
412  Wrapper for: burn_drive_scan_and_grab()
413  @since 0.1.2
414  @param drive_infos On success returns a one element array with the drive
415  (cdrom/burner). Thus use with driveno 0 only. On failure
416  the array has no valid elements at all.
417  The returned array should be freed via burn_drive_info_free()
418  when the drive is no longer needed. But before this is done
419  one has to call isoburn_drive_release(drive_infos[0].drive).
420  @param adr The persistent address of the desired drive.
421  @param flag bit0= attempt to load the disc tray.
422  Else: failure if not loaded.
423  bit1= regard overwriteable media as blank
424  bit2= if the drive is a regular disk file:
425  truncate it to the write start address when writing
426  begins
427  bit3= if the drive reports a read-only profile try to read
428  table of content by scanning for ISO image headers.
429  (depending on media type and drive this might
430  help or it might make the resulting toc even worse)
431  bit4= do not emulate table of content on overwriteable media
432  bit5= ignore ACL from external filesystems
433  bit6= ignore POSIX Extended Attributes from external
434  filesystems
435  bit7= pretend read-only profile and scan for table of content
436  bit8= re-assess already acquired (*drive_infos)[0] rather
437  than aquiring adr
438  @since 1.1.8
439  @return 1 = success , 0 = drive not found , <0 = other error
440 
441  Please excuse the typo "aquire" in the function name.
442 */
443 int isoburn_drive_aquire(struct burn_drive_info *drive_infos[],
444  char* adr, int flag);
445 
446 /** Acquire a drive from the burn_drive_info[] array which was obtained by
447  a previous call of burn_drive_scan().
448  Wrapper for: burn_drive_grab()
449  @since 0.1.0
450  @param drive The drive to grab. E.g. drive_infos[1].drive .
451  Call isoburn_drive_release(drive) when it it no longer needed.
452  @param load 1 attempt to load the disc tray. 0 no attempt, rather failure.
453  @return 1 success, <=0 failure
454 */
455 int isoburn_drive_grab(struct burn_drive *drive, int load);
456 
457 
458 /** Attach to a drive an application provided method for immediate
459  delivery of messages.
460  If no method is set or if the method is set to NULL then libisoburn
461  delivers messages of the drive through the global msgs_submit() method
462  set by isoburn_set_msgs_submiti() or by the message queue of libburn.
463  @since 0.2.0
464  @param d The drive to which this function, handle and flag shall apply
465  @param msgs_submit The function call which implements the method
466  @param submit_handle Handle to be used as first argument of msgs_submit
467  @param submit_flag Flag to be used as last argument of msgs_submit
468  @param flag Unused yet, submit 0
469 */
470 int isoburn_drive_set_msgs_submit(struct burn_drive *d,
471  int (*msgs_submit)(void *handle, int error_code,
472  char msg_text[], int os_errno,
473  char severity[], int flag),
474  void *submit_handle, int submit_flag, int flag);
475 
476 
477 /** Inquire the medium status. Expect the whole spectrum of libburn BURN_DISC_*
478  with multi-session media. Emulated states with random access media are
479  BURN_DISC_BLANK and BURN_DISC_APPENDABLE.
480  Wrapper for: burn_disc_get_status()
481  @since 0.1.0
482  @param drive The drive to inquire.
483  @return The status of the drive, or what kind of disc is in it.
484  Note: BURN_DISC_UNGRABBED indicates wrong API usage
485 */
486 #ifdef __cplusplus
487 enum burn::burn_disc_status isoburn_disc_get_status(struct burn_drive *drive);
488 #else
489 enum burn_disc_status isoburn_disc_get_status(struct burn_drive *drive);
490 #endif
491 
492 
493 /** Tells whether the medium can be treated by isoburn_disc_erase().
494  Wrapper for: burn_disc_erasable()
495  @since 0.1.0
496  @param d The drive to inquire.
497  @return 0=not erasable , else erasable
498 */
499 int isoburn_disc_erasable(struct burn_drive *d);
500 
501 
502 /** Mark the medium as blank. With multi-session media this will call
503  burn_disc_erase(). With random access media, an eventual ISO-9660
504  filesystem will get invalidated by altering its start blocks on the medium.
505  In case of success, the medium is in status BURN_DISC_BLANK afterwards.
506  Wrapper for: burn_disc_erase()
507  @since 0.1.0
508  @param drive The drive with the medium to erase.
509  @param fast 1=fast erase, 0=thorough erase
510  With DVD-RW, fast erase yields media incapable of multi-session.
511 */
512 void isoburn_disc_erase(struct burn_drive *drive, int fast);
513 
514 
515 /** Set up isoburn_disc_get_msc1() to return a fabricated value.
516  This makes only sense between aquiring the drive and reading the
517  image. After isoburn_read_image() it will confuse the coordination
518  of libisoburn and libisofs.
519  Note: Sessions and tracks are counted beginning with 1, not with 0.
520  @since 0.1.6
521  @param d The drive where msc1 is to be set
522  @param adr_mode Determines how to interpret adr_value and to set msc1.
523  If adr_value shall represent a number then decimal ASCII
524  digits are expected.
525  0= start lba of last session in TOC, ignore adr_value
526  1= start lba of session number given by adr_value
527  2= start lba of track given number by adr_value
528  3= adr_value itself is the lba to be used
529  4= start lba of last session with volume id
530  given by adr_value
531  @param adr_value A string describing the value to be eventually used.
532  @param flag Bitfield for control purposes.
533  bit0= @since 0.2.2
534  with adr_mode 3: adr_value might be 16 blocks too high
535  (e.g. -C stemming from growisofs). Probe for ISO head
536  at adr_value-16 and eventually adjust setting.
537  bit1= insist in seeing a disc object with at least one session
538  bit2= with adr_mode 4: use adr_value as regular expression
539 */
540 int isoburn_set_msc1(struct burn_drive *d, int adr_mode, char *adr_value,
541  int flag);
542 
543 
544 /* ----------------------------------------------------------------------- */
545 /*
546 
547  Wrappers for emulation of TOC on overwriteable media
548 
549  Media which match the overwriteable usage model lack of a history of sessions
550  and tracks. libburn will not even hand out a burn_disc object for them and
551  always declare them blank. libisoburn checks for a valid ISO filesystem
552  header at LBA 0 and eventually declares them appendable.
553  Nevertheless one can only determine an upper limit of the size of the overall
554  image (by isoburn_get_min_start_byte()) but not a list of stored sessions
555  and their LBAs, as it is possible with true multi-session media.
556 
557  The following wrappers add the capability to obtain a session and track TOC
558  from emulated multi-session images on overwriteables if the first session
559  was written by libisoburn-0.1.6 or later (i.e. with a header copy at LBA 32).
560 
561  Be aware that the structs emitted by these isoburn calls are not compatible
562  with the libburn structs. I.e. you may use them only with isoburn_toc_*
563  calls.
564  isoburn_toc_disc needs to be freed after use. isoburn_toc_session and
565  isoburn_toc_track vanish together with their isoburn_toc_disc.
566 */
567 
568 /* Opaque handles to media, session, track */
569 struct isoburn_toc_disc;
570 struct isoburn_toc_session;
571 struct isoburn_toc_track;
572 
573 
574 /** Obtain a master handle for the table of content.
575  This handle governs allocated resources which have to be released by
576  isoburn_toc_disc_free() when no longer needed.
577  Wrapper for: burn_drive_get_disc()
578  @since 0.1.6
579  @param d The drive with the medium to inspect
580  @return NULL in case there is no content info, else it is a valid handle
581 */
582 struct isoburn_toc_disc *isoburn_toc_drive_get_disc(struct burn_drive *d);
583 
584 
585 /** Tell the number of 2048 byte blocks covered by the table of content.
586  This number includes the eventual gaps between sessions and tracks.
587  So this call is not really a wrapper for burn_disc_get_sectors().
588  @since 0.1.6
589  @param disc The master handle of the medium
590  @return Number of blocks, <=0 indicates unknown or unreadable state
591 */
592 int isoburn_toc_disc_get_sectors(struct isoburn_toc_disc *disc);
593 
594 
595 /** Get the array of session handles from the table of content.
596  Wrapper for: burn_disc_get_sessions()
597  @since 0.1.6
598  @param disc The master handle of the medium
599  @param num returns the number of sessions in the array
600  @return the address of the array of session handles
601 */
602 struct isoburn_toc_session **isoburn_toc_disc_get_sessions(
603  struct isoburn_toc_disc *disc, int *num);
604 
605 
606 /** Tell the number of 2048 byte blocks covered by a particular session.
607  Wrapper for: burn_session_get_sectors()
608  @since 0.1.6
609  @param s The session handle
610  @return number of blocks, <=0 indicates unknown or unreadable state
611 */
612 int isoburn_toc_session_get_sectors(struct isoburn_toc_session *s);
613 
614 
615 /** Obtain a copy of the entry which describes the end of a particular session.
616  Wrapper for: burn_session_get_leadout_entry()
617  @since 0.1.6
618  @param s The session handle
619  @param entry A pointer to memory provided by the caller. It will be filled
620  with info according to struct burn_toc_entry as defined
621  in libburn.h
622 */
623 void isoburn_toc_session_get_leadout_entry(struct isoburn_toc_session *s,
624  struct burn_toc_entry *entry);
625 
626 
627 /** Get the array of track handles from a particular session.
628  Wrapper for: burn_session_get_tracks()
629  @since 0.1.6
630  @param s The session handle
631  @param num returns the number of tracks in the array
632  @return the address of the array of track handles,
633  NULL if no tracks are registered with session s
634 */
635 struct isoburn_toc_track **isoburn_toc_session_get_tracks(
636  struct isoburn_toc_session *s, int *num);
637 
638 
639 /** Obtain a copy of the entry which describes a particular track.
640  Wrapper for: burn_track_get_entry()
641  @since 0.1.6
642  @param t The track handle
643  @param entry A pointer to memory provided by the caller. It will be filled
644  with info according to struct burn_toc_entry as defined
645  in libburn.h
646 */
647 void isoburn_toc_track_get_entry(struct isoburn_toc_track *t,
648  struct burn_toc_entry *entry);
649 
650 
651 /** Obtain eventual ISO image parameters of an emulated track. This info was
652  gained with much effort and thus gets cached in the track object.
653  If this call returns 1 then one can save a call of isoburn_read_iso_head()
654  with return mode 1 which could cause an expensive read operation.
655  @since 0.4.0
656  @param t The track handle
657  @param start_lba Returns the start address of the ISO session
658  @param image_blocks Returns the number of 2048 bytes blocks
659  @param volid Caller provided memory for the volume id
660  @param flag unused yet, submit 0
661  @return 0= not an emulated ISO session , 1= reply is valid
662 */
663 int isoburn_toc_track_get_emul(struct isoburn_toc_track *t, int *start_lba,
664  int *image_blocks, char volid[33], int flag);
665 
666 
667 
668 /** Release the memory associated with a master handle of a medium.
669  The handle is invalid afterwards and may not be used any more.
670  Wrapper for: burn_disc_free()
671  @since 0.1.6
672  @param disc The master handle of the medium
673 */
674 void isoburn_toc_disc_free(struct isoburn_toc_disc *disc);
675 
676 
677 /** Try whether the data at the given address look like a ISO 9660
678  image header and obtain its alleged size. Depending on the info mode
679  one other string of text information can be retrieved too.
680  @since 0.1.6
681  @param d The drive with the medium to inspect
682  @param lba The block number from where to read
683  @param image_blocks Returns the number of 2048 bytes blocks in the session
684  @param info Caller provided memory, enough to take eventual info reply
685  @param flag bit0-7: info return mode
686  0= do not return anything in info (do not even touch it)
687  1= copy volume id to info (info needs 33 bytes)
688  2= @since 0.2.2 :
689  copy 64 kB header to info (needs 65536 bytes)
690  bit13= @since 0.2.2:
691  do not read head from medium but use first 64 kB from
692  info
693  bit14= check both half buffers (not only second)
694  return 2 if found in first block
695  bit15= return -1 on read error
696  @return >0 seems to be a valid ISO image, 0 format not recognized, <0 error
697 */
698 int isoburn_read_iso_head(struct burn_drive *d, int lba,
699  int *image_blocks, char *info, int flag);
700 
701 
702 /** Try to convert the given entity address into various entity addresses
703  which would describe it.
704  Note: Sessions and tracks are counted beginning with 1, not with 0.
705  @since 0.3.2
706  @param d The drive where msc1 is to be set
707  @param adr_mode Determines how to interpret the input adr_value.
708  If adr_value shall represent a number then decimal ASCII
709  digits are expected.
710  0= start lba of last session in TOC, ignore adr_value
711  1= start lba of session number given by adr_value
712  2= start lba of track given number by adr_value
713  3= adr_value itself is the lba to be used
714  4= start lba of last session with volume id
715  given by adr_value
716  @param adr_value A string describing the value to be eventually used.
717  @param lba returns the block address of the entity, -1 means invalid
718  @param track returns the track number of the entity, -1 means invalid
719  @param session returns the session number of the entity, -1 means invalid
720  @param volid returns the volume id of the entity if it is a ISO session
721  @param flag Bitfield for control purposes.
722  bit2= with adr_mode 4: use adr_value as regular expression
723  @return <=0 error , 1 ok, ISO session, 2 ok, not an ISO session
724 */
725 int isoburn_get_mount_params(struct burn_drive *d,
726  int adr_mode, char *adr_value,
727  int *lba, int *track, int *session,
728  char volid[33], int flag);
729 
730 
731 /* ----------------------------------------------------------------------- */
732 /*
733 
734  Options for image reading.
735 
736  An application shall create an option set object by isoburn_ropt_new(),
737  program it by isoburn_ropt_set_*(), use it with isoburn_read_image(),
738  and finally delete it by isoburn_ropt_destroy().
739 
740 */
741 /* ----------------------------------------------------------------------- */
742 
743 struct isoburn_read_opts;
744 
745 /** Produces a set of image read options, initialized with default values.
746  @since 0.1.0
747  @param o the newly created option set object
748  @param flag Bitfield for control purposes. Submit 0 for now.
749  @return 1=ok , <0 = failure
750 */
751 int isoburn_ropt_new(struct isoburn_read_opts **o, int flag);
752 
753 
754 /** Deletes an option set which was created by isoburn_ropt_new().
755  @since 0.1.0
756  @param o The option set to work on
757  @param flag Bitfield for control purposes. Submit 0 for now.
758  @return 1= **o destroyed , 0= *o was already NULL (harmless)
759 */
760 int isoburn_ropt_destroy(struct isoburn_read_opts **o, int flag);
761 
762 /** Sets the size and granularity of the cache which libisoburn provides to
763  libisofs for reading of ISO image data. This cache consists of several
764  tiles which are buffers of a given size. The ISO image is divided into
765  virtual tiles of that size. A cache tile may hold an in-memory copy
766  of such a virtual image tile.
767  When libisofs requests to read a block, then first the cache is inquired
768  whether it holds that block. If not, then the block is read via libburn
769  together with its neighbors in their virtual image tile into a free
770  cache tile. If no cache tile is free, then the one will be re-used which
771  has the longest time of not being hit by a read attempt.
772 
773  A larger cache might speed up image loading by reducing the number of
774  libburn read calls on the directory tree. It might also help with
775  reading the content of many small files, if for some reason it is not an
776  option to sort access by LBA.
777  Caching will not provide much benefit with libburn "stdio:" drives,
778  because the operating system is supposed to provide the same speed-up
779  in a more flexible way.
780 
781  @since 1.2.2
782  @param o The option set to work on.
783  It is permissible to submit NULL in order to just
784  have the parameters tested.
785  @param cache_tiles Number of tiles in the cache. Not less than 1.
786  Default is 32.
787  @param tile_blocks Number of blocks per tile. Must be a power of 2.
788  Default is 32.
789  cache_tiles * tile_blocks * 2048 must not exceed
790  1073741824 (= 1 GiB).
791  @param flag Bitfield for control purposes. Unused yet. Submit 0.
792  @return <=0 error , >0 ok
793 */
794 int isoburn_ropt_set_data_cache(struct isoburn_read_opts *o,
795  int cache_tiles, int tile_blocks, int flag);
796 
797 /** Inquire the current settings of isoburn_set_data_cache().
798  @since 1.2.2
799  @param o The option set to work on.
800  NULL has the same effect as flag bit0.
801  @param cache_tiles Will return the number of tiles in the cache.
802  @param tile_blocks Will return the number of blocks per tile.
803  @param set_flag Will return control bits. None are defined yet.
804  @param flag Bitfield for control purposes
805  bit0= return default values rather than current ones
806  @return <=0 error , >0 reply is valid
807 */
808 int isoburn_ropt_get_data_cache(struct isoburn_read_opts *o,
809  int *cache_tiles, int *tile_blocks,
810  int *set_flag, int flag);
811 
812 
813 /** Which existing ISO 9660 extensions in the image to read or not to read.
814  Whether to read the content of an existing image at all.
815  The bits can be combined by | resp. inquired by &.
816  @since 0.1.0
817  @param ext Bitfield:
818  bit0= norock
819  Do not read Rock Ridge extensions
820  bit1= nojoliet
821  Do not read Joliet extensions
822  bit2= noiso1999
823  Do not read ISO 9660:1999 enhanced tree
824  bit3= preferjoliet
825  When both Joliet and RR extensions are present, the RR
826  tree is used. If you prefer using Joliet, set this to 1.
827  bit4= pretend_blank
828  Always create empty image.Ignore any image on input drive.
829  bit5= noaaip
830  @since 0.3.4
831  Do not load AAIP information from image. This information
832  eventually contains ACL or XFS-style Extended Attributes.
833  bit6= noacl
834  @since 0.3.4
835  Do not obtain ACL from external filesystem objects (e.g.
836  local filesystem files).
837  bit7= noea
838  @since 0.3.4
839  Do not obtain XFS-style Extended Attributes from external
840  filesystem objects (e.g. local filesystem files).
841  bit8= noino
842  @since 0.4.0
843  Do not load eventual inode numbers from RRIP entry PX,
844  but generate a new unique inode number for each imported
845  IsoNode object.
846  PX inode numbers allow to mark families of hardlinks by
847  giving all family members the same inode number. libisofs
848  keeps the PX inode numbers unaltered when IsoNode objects
849  get written into an ISO image.
850  bit9= nomd5
851  @since 0.4.2
852  Do not load the eventual MD5 checksum array.
853  Do not check eventual session_md5 tags.
854  bit10= nomd5tag
855  @since 1.0.4
856  Do not check eventual session_md5 tags although bit9
857  is not set.
858  @return 1 success, <=0 failure
859 */
860 #define isoburn_ropt_norock 1
861 #define isoburn_ropt_nojoliet 2
862 #define isoburn_ropt_noiso1999 4
863 #define isoburn_ropt_preferjoliet 8
864 #define isoburn_ropt_pretend_blank 16
865 #define isoburn_ropt_noaaip 32
866 #define isoburn_ropt_noacl 64
867 #define isoburn_ropt_noea 128
868 #define isoburn_ropt_noino 256
869 #define isoburn_ropt_nomd5 512
870 #define isoburn_ropt_nomd5tag 1024
871 
872 int isoburn_ropt_set_extensions(struct isoburn_read_opts *o, int ext);
873 int isoburn_ropt_get_extensions(struct isoburn_read_opts *o, int *ext);
874 
875 
876 /** Default attributes to use if no RockRidge extension gets loaded.
877  @since 0.1.0
878  @param o The option set to work on
879  @param uid user id number (see /etc/passwd)
880  @param gid group id number (see /etc/group)
881  @param mode permissions (not file type) as of man 2 stat.
882  With directories, r-permissions will automatically imply
883  x-permissions. See isoburn_ropt_set_default_dirperms() below.
884  @return 1 success, <=0 failure
885 */
886 int isoburn_ropt_set_default_perms(struct isoburn_read_opts *o,
887  uid_t uid, gid_t gid, mode_t mode);
888 int isoburn_ropt_get_default_perms(struct isoburn_read_opts *o,
889  uid_t *uid, gid_t *gid, mode_t *mode);
890 
891 /** Default attributes to use on directories if no RockRidge extension
892  gets loaded.
893  Above call isoburn_ropt_set_default_perms() automatically adds
894  x-permissions to r-permissions for directories. This call here may
895  be done afterwards to set independend permissions for directories,
896  especially to override the automatically added x-permissions.
897  @since 0.1.0
898  @param o The option set to work on
899  @param mode permissions (not file type) as of man 2 stat.
900  @return 1 success, <=0 failure
901 */
902 int isoburn_ropt_set_default_dirperms(struct isoburn_read_opts *o,
903  mode_t mode);
904 int isoburn_ropt_get_default_dirperms(struct isoburn_read_opts *o,
905  mode_t *mode);
906 
907 
908 /** Set the character set for reading RR file names from ISO images.
909  @since 0.1.0
910  @param o The option set to work on
911  @param input_charset Set this to NULL to use the default locale charset
912  For selecting a particular character set, submit its
913  name, e.g. as listed by program iconv -l.
914  Example: "UTF-8".
915  @return 1 success, <=0 failure
916 */
917 int isoburn_ropt_set_input_charset(struct isoburn_read_opts *o,
918  char *input_charset);
919 int isoburn_ropt_get_input_charset(struct isoburn_read_opts *o,
920  char **input_charset);
921 
922 
923 /**
924  Enable or disable methods to automatically choose an input charset.
925  This eventually overrides the name set via isoburn_ropt_set_input_charset()
926  @since 0.3.8
927  @param o The option set to work on
928  @param mode Bitfield for control purposes:
929  bit0= allow to set the input character set automatically from
930  attribute "isofs.cs" of root directory.
931  Submit any other bits with value 0.
932  @return 1 success, <=0 failure
933  */
934 int isoburn_ropt_set_auto_incharset(struct isoburn_read_opts *o, int mode);
935 int isoburn_ropt_get_auto_incharset(struct isoburn_read_opts *o, int *mode);
936 
937 
938 /** Control an offset to be applied to all block address pointers in the ISO
939  image in order to compensate for an eventual displacement of the image
940  relative to the start block address for which it was produced.
941  E.g. if track number 2 from CD gets copied into a disk file and shall then
942  be loaded as ISO filesystem, then the directory tree and all data file
943  content of the track copy will become readable by setting the track start
944  address as displacement and -1 as displacement_sign.
945  Data file content outside the track will of course not be accessible and
946  eventually produce read errors.
947  @since 0.6.6
948  @param o The option set to work on
949  @param displacement 0 or a positive number
950  @param displacement_sign Determines wether to add or subtract displacement
951  to block addresses before applying them to the
952  storage object for reading:
953  +1 = add , -1= subtract , else keep unaltered
954 */
955 int isoburn_ropt_set_displacement(struct isoburn_read_opts *o,
956  uint32_t displacement, int displacement_sign);
957 int isoburn_ropt_get_displacement(struct isoburn_read_opts *o,
958  uint32_t *displacement, int *displacement_sign);
959 
960 /* If you get here because of a compilation error like
961 
962  /usr/include/libisoburn/libisoburn.h:895: error:
963  expected declaration specifiers or '...' before 'uint32_t'
964 
965  then see above paragraph "Application Constraints" about the definition
966  of uint32_t.
967 */
968 
969 
970 /** After calling function isoburn_read_image() there are informations
971  available in the option set.
972  This info can be obtained as bits in parameter has_what. Like:
973  joliet_available = (has_what & isoburn_ropt_has_joliet);
974  @since 0.1.0
975  @param o The option set to work on
976  @param size Number of image data blocks, 2048 bytes each.
977  @param has_what Bitfield:
978  bit0= has_rockridge
979  RockRidge extension info is available (POSIX filesystem)
980  bit1= has_joliet
981  Joliet extension info is available (suitable for MS-Windows)
982  bit2= has_iso1999
983  ISO version 2 Enhanced Volume Descriptor is available.
984  This is rather exotic.
985  bit3= has_el_torito
986  El-Torito boot record is present
987  @return 1 success, <=0 failure
988 */
989 #define isoburn_ropt_has_rockridge 1
990 #define isoburn_ropt_has_joliet 2
991 #define isoburn_ropt_has_iso1999 4
992 #define isoburn_ropt_has_el_torito 8
993 
994 int isoburn_ropt_get_size_what(struct isoburn_read_opts *o,
995  uint32_t *size, int *has_what);
996 
997 /* ts A90122 */
998 /* >>> to be implemented:
999 #define isoburn_ropt_has_acl 64
1000 #define isoburn_ropt_has_ea 128
1001 */
1002 
1003 
1004 
1005 /* ----------------------------------------------------------------------- */
1006 /* End of Options for image reading */
1007 /* ----------------------------------------------------------------------- */
1008 
1009 /* ----------------------------------------------------------------------- */
1010 /*
1011 
1012  Options for image generation by libisofs and image transport to libburn.
1013 
1014  An application shall create an option set by isoburn_igopt_new(),
1015  program it by isoburn_igopt_set_*(), use it with either
1016  isoburn_prepare_new_image() or isoburn_prepare_disc(), and finally delete
1017  it by isoburn_igopt_destroy().
1018 
1019 */
1020 /* ----------------------------------------------------------------------- */
1021 
1022 struct isoburn_imgen_opts;
1023 
1024 /** Produces a set of generation and transfer options, initialized with default
1025  values.
1026  @since 0.1.0
1027  @param o the newly created option set object
1028  @param flag Bitfield for control purposes. Submit 0 for now.
1029  @return 1=ok , <0 = failure
1030 */
1031 int isoburn_igopt_new(struct isoburn_imgen_opts **o, int flag);
1032 
1033 
1034 /** Deletes an option set which was created by isoburn_igopt_new().
1035  @since 0.1.0
1036  @param o The option set to give up
1037  @param flag Bitfield for control purposes. Submit 0 for now.
1038  @return 1= **o destroyed , 0= *o was already NULL (harmless)
1039 */
1040 int isoburn_igopt_destroy(struct isoburn_imgen_opts **o, int flag);
1041 
1042 
1043 /** ISO level to write at.
1044  @since 0.1.0
1045  @param o The option set to work on
1046  @param level is a term of the ISO 9660 standard. It should be one of:
1047  1= filenames restricted to form 8.3
1048  2= filenames allowed up to 31 characters
1049  3= file content may be larger than 4 GB - 1.
1050  @return 1 success, <=0 failure
1051 */
1052 int isoburn_igopt_set_level(struct isoburn_imgen_opts *o, int level);
1053 int isoburn_igopt_get_level(struct isoburn_imgen_opts *o, int *level);
1054 
1055 
1056 /** Which extensions to support.
1057  @since 0.1.0
1058  @param o The option set to work on
1059  @param ext Bitfield:
1060  bit0= rockridge
1061  Rock Ridge extensions add POSIX file attributes like
1062  owner, group, access permissions, long filenames. Very
1063  advisable if the designed audience has Unix style systems.
1064  bit1= joliet
1065  Longer filenames for Windows systems.
1066  Weaker than RockRidge, but also readable with GNU/Linux.
1067  bit2= iso1999
1068  This is rather exotic. Better do not surprise the readers.
1069  bit3= hardlinks
1070  Enable hardlink consolidation. IsoNodes which refer to the
1071  same source object and have the same properties will get
1072  the same ISO image inode numbers.
1073  If combined with isoburn_igopt_rrip_version_1_10 below,
1074  then the PX entry layout of RRIP-1.12 will be used within
1075  RRIP-1.10 (mkisofs does this without causing visible trouble).
1076  bit5= aaip
1077  The libisofs specific SUSP based extension of ECMA-119 which
1078  can encode ACL and XFS-style Extended Attributes.
1079  bit6= session_md5
1080  @since 0.4.2
1081  Produce and write MD5 checksum tags of superblock, directory
1082  tree, and the whole session stream.
1083  bit7= file_md5
1084  @since 0.4.2
1085  Produce and write MD5 checksums for each single IsoFile.
1086  bit8= file_stability (only together with file_md5)
1087  @since 0.4.2
1088  Compute MD5 of each file before copying it into the image and
1089  compare this with the MD5 of the actual copying. If they do
1090  not match then issue MISHAP event.
1091  See also libisofs.h iso_write_opts_set_record_md5()
1092  bit9= no_emul_toc
1093  @since 0.5.8
1094  On overwriteable media or random access files do not write
1095  the first session to LBA 32 and do not copy the first 64kB
1096  of the first session to LBA 0, but rather write the first
1097  session to LBA 0 directly.
1098  bit10= will_cancel
1099  @since 0.6.6
1100  Announce to libisofs that only the image size is desired
1101  and that the write thread will be cancelled by
1102  isoburn_cancel_prepared_write() before actual image writing
1103  occurs. Without this, cancellation can cause a MISHAP event.
1104  bit11= old_empty
1105  @since 1.0.2
1106  Let symbolic links and device files point to block 0, and let
1107  empty data files point to the address of the Volume Descriptor
1108  Set Terminator. This was done by libisofs in the past.
1109  By default there is now a single dedicated block of zero bytes
1110  after the end of the directory trees, of which the address
1111  is used for all files without own content.
1112 
1113  @return 1 success, <=0 failure
1114 */
1115 #define isoburn_igopt_rockridge 1
1116 #define isoburn_igopt_joliet 2
1117 #define isoburn_igopt_iso1999 4
1118 #define isoburn_igopt_hardlinks 8
1119 #define isoburn_igopt_aaip 32
1120 #define isoburn_igopt_session_md5 64
1121 #define isoburn_igopt_file_md5 128
1122 #define isoburn_igopt_file_stability 256
1123 #define isoburn_igopt_no_emul_toc 512
1124 #define isoburn_igopt_will_cancel 1024
1125 #define isoburn_igopt_old_empty 2048
1126 int isoburn_igopt_set_extensions(struct isoburn_imgen_opts *o, int ext);
1127 int isoburn_igopt_get_extensions(struct isoburn_imgen_opts *o, int *ext);
1128 
1129 /** Relaxed constraints. Setting any of the bits to 1 break the specifications,
1130  but it is supposed to work on most moderns systems. Use with caution.
1131  @since 0.1.0
1132  @param o The option set to work on
1133  @param relax Bitfield:
1134  bit0= omit_version_numbers
1135  Omit the version number (";1") at the end of the
1136  ISO-9660 and Joliet identifiers.
1137  Version numbers are usually not used by readers.
1138  bit1= allow_deep_paths
1139  Allow ISO-9660 directory hierarchy to be deeper
1140  than 8 levels.
1141  bit2= allow_longer_paths
1142  Allow path in the ISO-9660 tree to have more than
1143  255 characters.
1144  bit3= max_37_char_filenames
1145  Allow a single file or directory hierarchy to have
1146  up to 37 characters. This is larger than the 31
1147  characters allowed by ISO level 2, and the extra space
1148  is taken from the version number, so this also forces
1149  omit_version_numbers.
1150  bit4= no_force_dots
1151  ISO-9660 forces filenames to have a ".", that separates
1152  file name from extension. libisofs adds it if original
1153  filename has none. Set this to 1 to prevent this
1154  behavior.
1155  bit5= allow_lowercase
1156  Allow lowercase characters in ISO-9660 filenames.
1157  By default, only uppercase characters, numbers and
1158  a few other characters are allowed.
1159  bit6= allow_full_ascii
1160  Allow all ASCII characters to be appear on an ISO-9660
1161  filename. Note that "/" and "\0" characters are never
1162  allowed, even in RR names.
1163  bit7= joliet_longer_paths
1164  Allow paths in the Joliet tree to have more than
1165  240 characters.
1166  bit8= always_gmt
1167  Write timestamps as GMT although the specs prescribe local
1168  time with eventual non-zero timezone offset. Negative
1169  timezones (west of GMT) can trigger bugs in some operating
1170  systems which typically appear in mounted ISO images as if
1171  the timezone shift from GMT was applied twice
1172  (e.g. in New York 22:36 becomes 17:36).
1173  bit9= rrip_version_1_10
1174  Write Rock Ridge info as of specification RRIP-1.10 rather
1175  than RRIP-1.12: signature "RRIP_1991A" rather than
1176  "IEEE_1282", field PX without file serial number.
1177  bit10= dir_rec_mtime
1178  Store as ECMA-119 Directory Record timestamp the mtime
1179  of the source rather than the image creation time.
1180  bit11= aaip_susp_1_10
1181  Write AAIP fields without announcing AAIP by an ER field and
1182  without distinguishing RRIP fields from the AAIP field by
1183  prefixed ES fields. This saves 5 to 10 bytes per file and
1184  might avoid problems with readers which only accept RRIP.
1185  SUSP-1.10 allows it, SUSP-1.12 frowns on it.
1186  bit12= only_iso_numbers
1187  Same as bit1 omit_version_number but restricted to the names
1188  in the eventual Joliet tree.
1189  @since 0.5.4
1190  For reasons of backward compatibility it is not possible yet
1191  to disable version numbers for ISO 9660 while enabling them
1192  for Joliet.
1193  bit13= no_j_force_dots
1194  Same as no_force_dots but affecting the names in the eventual
1195  Joliet tree rather than the ISO 9660 / ECMA-119 names.
1196  @since 0.5.4
1197  Previous versions added dots to Joliet names unconditionally.
1198  bit14= allow_dir_id_ext
1199  Convert directory names for ECMA-119 similar to other file
1200  names, but do not force a dot or add a version number.
1201  This violates ECMA-119 by allowing one "." and especially
1202  ISO level 1 by allowing DOS style 8.3 names rather than
1203  only 8 characters.
1204  (mkisofs and its clones obviously do this violation.)
1205  @since 1.0.0
1206  bit15= joliet_long_names
1207  Allow for Joliet leaf names up to 103 characters rather than
1208  up to 64.
1209  @since 1.0.6
1210  bit16= joliet_rec_mtime
1211  Like dir_rec_mtime, but for the Joliet tree.
1212  @since 1.2.0
1213  bit17= iso1999_rec_mtime
1214  Like dir_rec_mtime, but for the ISO 9660:1999 tree.
1215  @since 1.2.0
1216  bit18= allow_7bit_ascii
1217  Like allow_full_ascii, but only allowing 7-bit characters.
1218  Lowercase letters get mapped to uppercase if not
1219  allow_lowercase is set.
1220  Gets overridden if allow_full_ascii is enabled.
1221  @return 1 success, <=0 failure
1222 */
1223 #define isoburn_igopt_omit_version_numbers 1
1224 #define isoburn_igopt_allow_deep_paths 2
1225 #define isoburn_igopt_allow_longer_paths 4
1226 #define isoburn_igopt_max_37_char_filenames 8
1227 #define isoburn_igopt_no_force_dots 16
1228 #define isoburn_igopt_allow_lowercase 32
1229 #define isoburn_igopt_allow_full_ascii 64
1230 #define isoburn_igopt_joliet_longer_paths 128
1231 #define isoburn_igopt_always_gmt 256
1232 #define isoburn_igopt_rrip_version_1_10 512
1233 #define isoburn_igopt_dir_rec_mtime 1024
1234 #define isoburn_igopt_aaip_susp_1_10 2048
1235 #define isoburn_igopt_only_iso_versions 4096
1236 #define isoburn_igopt_no_j_force_dots 8192
1237 #define isoburn_igopt_allow_dir_id_ext 16384
1238 #define isoburn_igopt_joliet_long_names 32768
1239 #define isoburn_igopt_joliet_rec_mtime 0x10000
1240 #define isoburn_igopt_iso1999_rec_mtime 0x20000
1241 #define isoburn_igopt_allow_7bit_ascii 0x40000
1242 int isoburn_igopt_set_relaxed(struct isoburn_imgen_opts *o, int relax);
1243 int isoburn_igopt_get_relaxed(struct isoburn_imgen_opts *o, int *relax);
1244 
1245 
1246 /** If not isoburn_igopt_allow_deep_paths is in effect, then it may become
1247  necessary to relocate directories so that no ECMA-119 file path
1248  has more than 8 components. These directories are grafted into either
1249  the root directory of the ISO image or into a dedicated relocation
1250  directory. For details see libisofs.h.
1251  Wrapper for: iso_write_opts_set_rr_reloc()
1252  @since 1.2.2
1253  @param o The option set to work on
1254  @param name The name of the relocation directory in the root directory.
1255  Do not prepend "/". An empty name or NULL will direct
1256  relocated directories into the root directory. This is the
1257  default.
1258  If the given name does not exist in the root directory when
1259  isoburn_disc_write() is called, and if there are directories
1260  at path level 8, then directory /name will be created
1261  automatically.
1262  @param flags Bitfield for control purposes.
1263  bit0= Mark the relocation directory by a Rock Ridge RE entry,
1264  if it gets created during isoburn_disc_write(). This
1265  will make it invisible for most Rock Ridge readers.
1266  bit1= not settable via API (used internally)
1267  @return > 0 success, <= 0 failure
1268 */
1269 int isoburn_igopt_set_rr_reloc(struct isoburn_imgen_opts *o, char *name,
1270  int flags);
1271 
1272 /** Obtain the settings of isoburn_igopt_set_rr_reloc().
1273  @since 1.2.2
1274  @param o The option set to work on
1275  @param name Will return NULL or a pointer to the name of the relocation
1276  directory in the root directory. Do not alter or dispose the
1277  memory which holds this name.
1278  @param flags Will return the flags bitfield.
1279  @return > 0 success, <= 0 failure
1280 */
1281 int isoburn_igopt_get_rr_reloc(struct isoburn_imgen_opts *o, char **name,
1282  int *flags);
1283 
1284 
1285 /** Caution: This option breaks any assumptions about names that
1286  are supported by ECMA-119 specifications.
1287  Try to omit any translation which would make a file name compliant to the
1288  ECMA-119 rules. This includes and exceeds omit_version_numbers,
1289  max_37_char_filenames, no_force_dots bit0, allow_full_ascii. Further it
1290  prevents the conversion from local character set to ASCII.
1291  The maximum name length is given by this call. If a filename exceeds
1292  this length or cannot be recorded untranslated for other reasons, then
1293  image production gets aborted.
1294  Currently the length limit is 96 characters, because an ECMA-119 directory
1295  record may at most have 254 bytes and up to 158 other bytes must fit into
1296  the record. Probably 96 more bytes can be made free for the name in future.
1297  @since 1.0.0
1298  @param o The option set to work on
1299  @param len 0 = disable this feature and perform name translation
1300  according to other settings.
1301  >0 = Omit any translation. Eventually abort image production
1302  if a name is longer than the given value.
1303  -1 = Like >0. Allow maximum possible length.
1304  isoburn_igopt_get_untranslated_name_len() will tell the
1305  effectively resulting value.
1306  @return >0 success, <=0 failure
1307 */
1308 int isoburn_igopt_set_untranslated_name_len(struct isoburn_imgen_opts *o,
1309  int len);
1310 int isoburn_igopt_get_untranslated_name_len(struct isoburn_imgen_opts *o,
1311  int *len);
1312 
1313 
1314 /** Whether and how files should be sorted.
1315  @since 0.1.0
1316  @param o The option set to work on
1317  @param value Bitfield: bit0= sort_files_by_weight
1318  files should be sorted based on their weight.
1319  Weight is attributed to files in the image
1320  by libisofs call iso_node_set_sort_weight().
1321  @return 1 success, <=0 failure
1322 */
1323 #define isoburn_igopt_sort_files_by_weight 1
1324 int isoburn_igopt_set_sort_files(struct isoburn_imgen_opts *o, int value);
1325 int isoburn_igopt_get_sort_files(struct isoburn_imgen_opts *o, int *value);
1326 
1327 
1328 /** Set the override values for files and directory permissions.
1329  The parameters replace_* these take one of three values: 0, 1 or 2.
1330  If 0, the corresponding attribute will be kept as set in the IsoNode
1331  at the time of image generation.
1332  If set to 1, the corresponding attrib. will be changed by a default
1333  suitable value.
1334  With value 2, the attrib. will be changed with the value specified
1335  in the corresponding *_mode options. Note that only the permissions
1336  are set, the file type remains unchanged.
1337  @since 0.1.0
1338  @param o The option set to work on
1339  @param replace_dir_mode whether and how to override directories
1340  @param replace_file_mode whether and how to override files of other type
1341  @param dir_mode Mode to use on dirs with replace_dir_mode == 2.
1342  @param file_mode; Mode to use on files with replace_file_mode == 2.
1343  @return 1 success, <=0 failure
1344 */
1345 int isoburn_igopt_set_over_mode(struct isoburn_imgen_opts *o,
1346  int replace_dir_mode, int replace_file_mode,
1347  mode_t dir_mode, mode_t file_mode);
1348 int isoburn_igopt_get_over_mode(struct isoburn_imgen_opts *o,
1349  int *replace_dir_mode, int *replace_file_mode,
1350  mode_t *dir_mode, mode_t *file_mode);
1351 
1352 /** Set the override values values for group id and user id.
1353  The rules are like with above overriding of mode values. replace_* controls
1354  whether and how. The other two parameters provide values for eventual use.
1355  @since 0.1.0
1356  @param o The option set to work on
1357  @param replace_uid whether and how to override user ids
1358  @param replace_gid whether and how to override group ids
1359  @param uid User id to use with replace_uid == 2.
1360  @param gid Group id to use on files with replace_gid == 2.
1361  @return 1 success, <=0 failure
1362 */
1363 int isoburn_igopt_set_over_ugid(struct isoburn_imgen_opts *o,
1364  int replace_uid, int replace_gid,
1365  uid_t uid, gid_t gid);
1366 int isoburn_igopt_get_over_ugid(struct isoburn_imgen_opts *o,
1367  int *replace_uid, int *replace_gid,
1368  uid_t *uid, gid_t *gid);
1369 
1370 /** Set the charcter set to use for representing RR filenames in the image.
1371  @since 0.1.0
1372  @param o The option set to work on
1373  @param output_charset Set this to NULL to use the default output charset.
1374  For selecting a particular character set, submit its
1375  name, e.g. as listed by program iconv -l.
1376  Example: "UTF-8".
1377  @return 1 success, <=0 failure
1378 */
1379 int isoburn_igopt_set_out_charset(struct isoburn_imgen_opts *o,
1380  char *output_charset);
1381 int isoburn_igopt_get_out_charset(struct isoburn_imgen_opts *o,
1382  char **output_charset);
1383 
1384 
1385 /** The number of bytes to be used for the fifo which decouples libisofs
1386  and libburn for better throughput and for reducing the risk of
1387  interrupting signals hitting the libburn thread which operates the
1388  MMC drive.
1389  The size will be rounded up to the next full 2048.
1390  Minimum is 64kiB, maximum is 1 GiB (but that is too much anyway).
1391  @since 0.1.0
1392  @param o The option set to work on
1393  @param fifo_size Number of bytes to use
1394  @return 1 success, <=0 failure
1395 */
1396 int isoburn_igopt_set_fifo_size(struct isoburn_imgen_opts *o, int fifo_size);
1397 int isoburn_igopt_get_fifo_size(struct isoburn_imgen_opts *o, int *fifo_size);
1398 
1399 
1400 /** Obtain after image preparation the block address where the session will
1401  start on the medium.
1402  This value cannot be set by the application but only be inquired.
1403  @since 0.1.4
1404  @param o The option set to work on
1405  @param lba The block number of the session start on the medium.
1406  <0 means that no address has been determined yet.
1407  @return 1 success, <=0 failure
1408 */
1409 int isoburn_igopt_get_effective_lba(struct isoburn_imgen_opts *o, int *lba);
1410 
1411 
1412 /** Obtain after image preparation the lowest block address of file content
1413  data. Failure can occur if libisofs is too old to provide this information,
1414  if the result exceeds 31 bit, or if the call is made before image
1415  preparation.
1416  This value cannot be set by the application but only be inquired.
1417  @since 0.3.6
1418  @param o The option set to work on
1419  @param lba The block number of the session start on the medium.
1420  <0 means that no address has been determined yet.
1421  @return 1 success, <=0 failure
1422 */
1423 int isoburn_igopt_get_data_start(struct isoburn_imgen_opts *o, int *lba);
1424 
1425 
1426 /** Set resp. get parameters "name" and "timestamp" for a scdbackup checksum
1427  tag. It will be appended to the libisofs session tag if the image starts at
1428  LBA 0. See isoburn_disc_track_lba_nwa. The scdbackup tag can be used
1429  to verify the image by command scdbackup_verify $device -auto_end.
1430  See scdbackup/README appendix VERIFY for its inner details.
1431  @since 0.4.4
1432  @param o The option set to work on
1433  @param name The tag name. 80 characters max.
1434  @param timestamp A string of up to 13 characters YYMMDD.hhmmss
1435  A9 = 2009, B0 = 2010, B1 = 2011, ... C0 = 2020, ...
1436  @param tag_written Either NULL or the address of an array with at least 512
1437  characters. In the latter case the eventually produced
1438  scdbackup tag will be copied to this array when the image
1439  gets written. This call sets scdbackup_tag_written[0] = 0
1440  to mark its preliminary invalidity.
1441  @return 1 success, <=0 failure
1442  */
1443 int isoburn_igopt_set_scdbackup_tag(struct isoburn_imgen_opts *o, char *name,
1444  char *timestamp, char *tag_written);
1445 int isoburn_igopt_get_scdbackup_tag(struct isoburn_imgen_opts *o,
1446  char name[81], char timestamp[19],
1447  char **tag_written);
1448 
1449 
1450 /** Attach 32 kB of binary data which shall get written to the first 32 kB
1451  of the ISO image, the System Area.
1452  options can cause manipulations of these data before writing happens.
1453  If system area data are giveni or options bit0 is set, then bit1 of
1454  el_torito_set_isolinux_options() is automatically disabled.
1455  @since 0.5.4
1456  @param o The option set to work on
1457  @param data Either NULL or 32 kB of data. Do not submit less bytes !
1458  @param options Can cause manipulations of submitted data before they
1459  get written:
1460  bit0= apply a --protective-msdos-label as of grub-mkisofs.
1461  This means to patch bytes 446 to 512 of the system
1462  area so that one partition is defined which begins
1463  at the second 512-byte block of the image and ends
1464  where the image ends.
1465  This works with and without system_area_data.
1466  bit1= apply isohybrid MBR patching to the system area.
1467  This works only with system area data from
1468  SYSLINUX plus an ISOLINUX boot image (see
1469  iso_image_set_boot_image()) and only if not bit0
1470  is set.
1471  bit2-7= System area type
1472  0= with bit0 or bit1: MBR
1473  else: unspecified type
1474  @since 0.6.4
1475  1= MIPS Big Endian Volume Header
1476  Submit up to 15 MIPS Big Endian boot files by
1477  iso_image_add_mips_boot_file() of libisofs.
1478  This will overwrite the first 512 bytes of
1479  the submitted data.
1480  2= DEC Boot Block for MIPS Little Endian
1481  The first boot file submitted by
1482  iso_image_add_mips_boot_file() will be activated.
1483  This will overwrite the first 512 bytes of
1484  the submitted data.
1485  @since 0.6.6
1486  3= SUN Disk Label for SUN SPARC
1487  Submit up to 7 SPARC boot images by
1488  isoburn_igopt_set_partition_img() for partition
1489  numbers 2 to 8.
1490  This will overwrite the first 512 bytes of
1491  the submitted data.
1492  bit8-9= Only with System area type 0 = MBR
1493  @since 1.0.4
1494  Cylinder alignment mode eventually pads the image
1495  to make it end at a cylinder boundary.
1496  0 = auto (align if bit1)
1497  1 = always align to cylinder boundary
1498  2 = never align to cylinder boundary
1499 
1500  @return 1 success, 0 no data to get, <0 failure
1501 */
1502 int isoburn_igopt_set_system_area(struct isoburn_imgen_opts *o,
1503  char data[32768], int options);
1504 int isoburn_igopt_get_system_area(struct isoburn_imgen_opts *o,
1505  char data[32768], int *options);
1506 
1507 /** Control production of a second set of volume descriptors (superblock)
1508  and directory trees, together with a partition table in the MBR where the
1509  first partition has non-zero start address and the others are zeroed.
1510  The first partition stretches to the end of the whole ISO image.
1511  The additional volume descriptor set and trees will allow to mount the
1512  ISO image at the start of the first partition, while it is still possible
1513  to mount it via the normal first volume descriptor set and tree at the
1514  start of the image resp. storage device.
1515  This makes few sense on optical media. But on USB sticks it creates a
1516  conventional partition table which makes it mountable on e.g. Linux via
1517  /dev/sdb and /dev/sdb1 alike.
1518  @since 0.6.2
1519  @param opts
1520  The option set to be manipulated.
1521  @param block_offset_2k
1522  The offset of the partition start relative to device start.
1523  This is counted in 2 kB blocks. The partition table will show the
1524  according number of 512 byte sectors.
1525  Default is 0 which causes no second set and trees.
1526  If it is not 0 then it must not be smaller than 16.
1527  @param secs_512_per_head
1528  Number of 512 byte sectors per head. 1 to 63. 0=automatic.
1529  @param heads_per_cyl
1530  Number of heads per cylinder. 1 to 255. 0=automatic.
1531  @return 1 success, <=0 failure
1532  */
1533 int isoburn_igopt_set_part_offset(struct isoburn_imgen_opts *opts,
1534  uint32_t block_offset_2k,
1535  int secs_512_per_head, int heads_per_cyl);
1536 int isoburn_igopt_get_part_offset(struct isoburn_imgen_opts *opts,
1537  uint32_t *block_offset_2k,
1538  int *secs_512_per_head, int *heads_per_cyl);
1539 
1540 
1541 /** Explicitely set the four timestamps of the emerging ISO image.
1542  Default with all parameters is 0.
1543  @since 0.5.4
1544  @param opts
1545  The option set to work on
1546  @param creation_time
1547  ECMA-119 Volume Creation Date and Time
1548  When "the information in the volume was created."
1549  A value of 0 means that the timepoint of write start is to be used.
1550  @param modification_time
1551  ECMA-119 Volume Modification Date and Time
1552  When "the informationin the volume was last modified."
1553  A value of 0 means that the timepoint of write start is to be used.
1554  @param expiration_time
1555  ECMA-119 Volume Expiration Date and Time
1556  When "the information in the volume may be regarded as obsolete."
1557  A value of 0 means that the information never shall expire.
1558  @param effective_time
1559  ECMA-119 Volume Effective Date and Time
1560  When "the information in the volume may be used."
1561  A value of 0 means that not such retention is intended.
1562  @param uuid
1563  If this text is not empty, then it overrides vol_modification_time
1564  by copying the first 16 decimal digits from uuid, eventually
1565  padding up with decimal '1', and writing a NUL-byte as timezone GMT.
1566  It should express a reasonable time in form YYYYMMDDhhmmsscc
1567  E.g.: 2010040711405800 = 7 Apr 2010 11:40:58 (+0 centiseconds)
1568  @return 1 success, <=0 failure
1569  */
1570 int isoburn_igopt_set_pvd_times(struct isoburn_imgen_opts *opts,
1571  time_t creation_time, time_t modification_time,
1572  time_t expiration_time, time_t effective_time,
1573  char *uuid);
1574 int isoburn_igopt_get_pvd_times(struct isoburn_imgen_opts *opts,
1575  time_t *creation_time, time_t *modification_time,
1576  time_t *expiration_time, time_t *effective_time,
1577  char uuid[17]);
1578 
1579 
1580 /** Associate a libjte environment object to the upcomming write run.
1581  libjte implements Jigdo Template Extraction as of Steve McIntyre and
1582  Richard Atterer.
1583  A non-NULL libjte_handle will cause failure to write if libjte was not
1584  enabled in libisofs at compile time.
1585  @since 0.6.4
1586  @param opts
1587  The option set to work on
1588  @param libjte_handle
1589  Pointer to a struct libjte_env e.g. created by libjte_new().
1590  It must stay existent from the start of image writing by
1591  isoburn_prepare_*() until the write thread has ended.
1592  E.g. until libburn indicates the end of its write run.
1593  @return 1 success, <=0 failure
1594 */
1595 int isoburn_igopt_attach_jte(struct isoburn_imgen_opts *opts,
1596  void *libjte_handle);
1597 
1598 /** Remove eventual association to a libjte environment handle.
1599  @since 0.6.4
1600  @param opts
1601  The option set to work on
1602  @param libjte_handle
1603  If not submitted as NULL, this will return the previously set
1604  libjte handle.
1605  @return 1 success, <=0 failure
1606 */
1607 int isoburn_igopt_detach_jte(struct isoburn_imgen_opts *opts,
1608  void **libjte_handle);
1609 
1610 
1611 /** Set resp. get the number of trailing zero byte blocks to be written by
1612  libisofs. The image size counter of the emerging ISO image will include
1613  them. Eventual checksums will take them into respect.
1614  They will be written immediately before the eventual image checksum area
1615  which is at the very end of the image.
1616  For a motivation see iso_write_opts_set_tail_blocks() in libisofs.h .
1617  @since 0.6.4
1618  @param opts
1619  The option set to work on
1620  @aram num_blocks
1621  Number of extra 2 kB blocks to be written by libisofs.
1622  @return 1 success, <=0 failure
1623 */
1624 int isoburn_igopt_set_tail_blocks(struct isoburn_imgen_opts *opts,
1625  uint32_t num_blocks);
1626 int isoburn_igopt_get_tail_blocks(struct isoburn_imgen_opts *opts,
1627  uint32_t *num_blocks);
1628 
1629 
1630 /** Cause an arbitrary data file to be appended to the ISO image and to be
1631  described by a partition table entry in an MBR or SUN Disk Label at the
1632  start of the ISO image.
1633  The partition entry will bear the size of the image file rounded up to
1634  the next multiple of 2048 bytes.
1635  MBR or SUN Disk Label are selected by isoburn_igopt_set_system_area()
1636  system area type: 0 selects MBR partition table. 3 selects a SUN partition
1637  table with 320 kB start alignment.
1638  @since 0.6.4
1639  @param opts
1640  The option set to be manipulated.
1641  @param partition_number
1642  Depicts the partition table entry which shall describe the
1643  appended image.
1644  Range with MBR: 1 to 4. 1 will cause the whole ISO image to be
1645  unclaimable space before partition 1.
1646  @since 0.6.6
1647  Range with SUN Disk Label: 2 to 8.
1648  @param image_path
1649  File address in the local file system.
1650  With SUN Disk Label: an empty name causes the partition to become
1651  a copy of the next lower partition.
1652  @param image_type
1653  The MBR partition type. E.g. FAT12 = 0x01 , FAT16 = 0x06,
1654  Linux Native Partition = 0x83. See fdisk command L.
1655  This parameter is ignored with SUN Disk Label.
1656  @return
1657  <=0 = error, 1 = success
1658 */
1659 int isoburn_igopt_set_partition_img(struct isoburn_imgen_opts *opts,
1660  int partition_number, uint8_t partition_type,
1661  char *image_path);
1662 
1663 /** Inquire the current settings made by isoburn_igopt_set_partition_img().
1664  @since 0.6.4
1665  @param opts
1666  The option set to be inquired.
1667  @param num_entries
1668  Number of array elements in partition_types[] and image_paths[].
1669  @param partition_types
1670  The partition type associated with the partition. Valid only if
1671  image_paths[] of the same index is not NULL.
1672  @param image_paths
1673  Its elements get filled with either NULL or a pointer to a string
1674  with a file address resp. an empty text.
1675  @return
1676  <0 = error
1677  0 = no partition image set
1678  >0 highest used partition number
1679 */
1680 int isoburn_igopt_get_partition_img(struct isoburn_imgen_opts *opts,
1681  int num_entries,
1682  uint8_t partition_types[],
1683  char *image_paths[]);
1684 
1685 
1686 /** Set a name for the system area. This setting is ignored unless system area
1687  type 3 "SUN Disk Label" is in effect by iso_write_opts_set_system_area().
1688  In this case it will replace the default text at the start of the image:
1689  "CD-ROM Disc with Sun sparc boot created by libisofs"
1690  @since 0.6.6
1691  @param opts
1692  The option set to be manipulated.
1693  @param label
1694  A text of up to 128 characters.
1695  @return
1696  <=0 = error, 1 = success
1697 */
1698 int isoburn_igopt_set_disc_label(struct isoburn_imgen_opts *opts, char *label);
1699 
1700 /** Inquire the current setting made by isoburn_igopt_set_disc_label().
1701  @since 0.6.6
1702  @param opts
1703  The option set to be inquired.
1704  @param label
1705  Returns a pointer to the currently set label string.
1706  Do not alter this string.
1707  Use only as long as the opts object exists.
1708  @return
1709  <=0 = error, 1 = success
1710 */
1711 int isoburn_igopt_get_disc_label(struct isoburn_imgen_opts *opts,
1712  char **label);
1713 
1714 
1715 /* ----------------------------------------------------------------------- */
1716 /* End of Options for image generation */
1717 /* ----------------------------------------------------------------------- */
1718 
1719 
1720 /** Get the image attached to a drive, if any.
1721  @since 0.1.0
1722  @param d The drive to inquire
1723  @return A reference to attached image, or NULL if the drive has no image
1724  attached. This reference needs to be released via iso_image_unref()
1725  when it is not longer needed.
1726 */
1727 IsoImage *isoburn_get_attached_image(struct burn_drive *d);
1728 
1729 /** Get the start address of the image that is attached to the drive, if any.
1730  @since 1.2.2
1731  @param d The drive to inquire
1732  @return The logical block address where the System Area of the image
1733  starts. <0 means that the address is invalid.
1734 */
1735 int isoburn_get_attached_start_lba(struct burn_drive *d);
1736 
1737 
1738 /** Load the ISO filesystem directory tree from the medium in the given drive.
1739  This will give libisoburn the base on which it can let libisofs perform
1740  image growing or image modification. The loaded volset gets attached
1741  to the drive object and handed out to the application.
1742  Not a wrapper, but peculiar to libisoburn.
1743  @since 0.1.0
1744  @param d The drive which holds an existing ISO filesystem or blank media.
1745  d is allowed to be NULL which produces an empty ISO image. In
1746  this case one has to call before writing isoburn_attach_volset()
1747  with the volset from this call and with the intended output
1748  drive.
1749  @param read_opts The read options which can be chosen by the application
1750  @param image the image read, if the disc is blank it will have no files.
1751  This reference needs to be released via iso_image_unref() when
1752  it is not longer needed. The drive, if not NULL, will hold an
1753  own reference which it will release when it gets a new volset
1754  or when it gets released via isoburn_drive_release().
1755  You can pass NULL if you already have a reference or you plan to
1756  obtain it later with isoburn_get_attached_image(). Of course, if
1757  you haven't specified a valid drive (i.e., if d == NULL), this
1758  parameter can't be NULL.
1759  @return <=0 error , 1 = success
1760 */
1761 int isoburn_read_image(struct burn_drive *d,
1762  struct isoburn_read_opts *read_opts,
1763  IsoImage **image);
1764 
1765 /** Set a callback function for producing pacifier messages during the lengthy
1766  process of image reading. The callback function and the application handle
1767  are stored until they are needed for the underlying call to libisofs.
1768  Other than with libisofs the handle is managed entirely by the application.
1769  An idle .free() function is exposed to libisofs. The handle has to stay
1770  valid until isoburn_read_image() is done. It has to be detached by
1771  isoburn_set_read_pacifier(drive, NULL, NULL);
1772  before it may be removed from memory.
1773  @since 0.1.0
1774  @param drive The drive which will be used with isoburn_read_image()
1775  It has to be acquired by an isoburn_* wrapper call.
1776  @param read_pacifier The callback function
1777  @param app_handle The app handle which the callback function can obtain
1778  via iso_image_get_attached_data() from its IsoImage*
1779  @return 1 success, <=0 failure
1780 */
1781 int isoburn_set_read_pacifier(struct burn_drive *drive,
1782  int (*read_pacifier)(IsoImage*, IsoFileSource*),
1783  void *app_handle);
1784 
1785 /** Inquire the partition offset of the loaded image. The first 512 bytes of
1786  the image get examined whether they bear an MBR signature and a first
1787  partition table entry which matches the size of the image. In this case
1788  the start address is recorded as partition offset and internal buffers
1789  get adjusted.
1790  See also isoburn_igopt_set_part_offset().
1791  @since 0.6.2
1792  @param drive The drive with the loaded image
1793  @param block_offset_2k returns the recognized partition offset
1794  @return <0 = error
1795  0 = no partition offset recognized
1796  1 = acceptable non-zero offset, buffers are adjusted
1797  2 = offset is credible but not acceptable for buffer size
1798 */
1799 int isoburn_get_img_partition_offset(struct burn_drive *drive,
1800  uint32_t *block_offset_2k);
1801 
1802 
1803 /** Set the IsoImage to be used with a drive. This eventually releases
1804  the reference to the old IsoImage attached to the drive.
1805  Caution: Use with care. It hardly makes sense to replace an image that
1806  reflects a valid ISO image on the medium.
1807  This call is rather intended for writing a newly created and populated
1808  image to blank media. The use case in xorriso is to let an image survive
1809  the change or demise of the outdev target drive.
1810  @since 0.1.0
1811  @param d The drive which shall be write target of the volset.
1812  @param image The image that represents the image to be written.
1813  This image pointer MUST already be a valid reference suitable
1814  for iso_image_unref().
1815  It may have been obtained by appropriate libisofs calls or by
1816  isoburn_read_image() with d==NULL.
1817  @return <=0 error , 1 = success
1818 */
1819 int isoburn_attach_image(struct burn_drive *d, IsoImage *image);
1820 
1821 
1822 /** Set the start address of the image that is attached to the drive, if any.
1823  @since 1.2.2
1824  @param d The drive to inquire
1825  @param lba The logical block address where the System Area of the image
1826  starts. <0 means that the address is invalid.
1827  @param flag Bitfield, submit 0 for now.
1828  @return <=0 error (e.g. because no image is attached), 1 = success
1829 */
1830 int isoburn_attach_start_lba(struct burn_drive *d, int lba, int flag);
1831 
1832 
1833 /** Return the best possible estimation of the currently available capacity of
1834  the medium. This might depend on particular write option settings and on
1835  drive state.
1836  An eventual start address for emulated multi-session will be subtracted
1837  from the capacity estimation given by burn_disc_available_space().
1838  Negative results get defaulted to 0.
1839  Wrapper for: burn_disc_available_space()
1840  @since 0.1.0
1841  @param d The drive to query.
1842  @param o If not NULL: write parameters to be set on drive before query
1843  @return number of most probably available free bytes
1844 */
1845 off_t isoburn_disc_available_space(struct burn_drive *d,
1846  struct burn_write_opts *o);
1847 
1848 
1849 /** Obtain the start block number of the most recent session on the medium. In
1850  case of random access media this will normally be 0. Successfull return is
1851  not a guarantee that there is a ISO-9660 image at all. The call will fail,
1852  nevertheless,if isoburn_disc_get_status() returns not BURN_DISC_APPENDABLE
1853  or BURN_DISC_FULL.
1854  Note: The result of this call may be fabricated by a previous call of
1855  isoburn_set_msc1() which can override the rule to load the most recent
1856  session.
1857  Wrapper for: burn_disc_get_msc1()
1858  @since 0.1.0
1859  @param d The drive to inquire
1860  @param start_lba Contains on success the start address in 2048 byte blocks
1861  @return <=0 error , 1 = success
1862 */
1863 int isoburn_disc_get_msc1(struct burn_drive *d, int *start_lba);
1864 
1865 
1866 /** Use this with trackno==0 to obtain the predicted start block number of the
1867  new session. The interesting number is returned in parameter nwa.
1868  Wrapper for: burn_disc_track_lba_nwa()
1869  @since 0.1.0
1870  @param d The drive to inquire
1871  @param o If not NULL: write parameters to be set on drive before query
1872  @param trackno Submit 0.
1873  @param lba return value: start lba
1874  @param nwa return value: Next Writeable Address
1875  @return 1=nwa is valid , 0=nwa is not valid , -1=error
1876 */
1877 int isoburn_disc_track_lba_nwa(struct burn_drive *d, struct burn_write_opts *o,
1878  int trackno, int *lba, int *nwa);
1879 
1880 
1881 /** Obtain the size which was attributed to an emulated appendable on actually
1882  overwriteable media. This value is supposed to be <= 2048 * nwa as of
1883  isoburn_disc_track_lba_nwa().
1884  @since 0.1.0
1885  @param d The drive holding the medium.
1886  @param start_byte The reply value counted in bytes, not in sectors.
1887  @param flag Unused yet. Submit 0.
1888  @return 1=stat_byte is valid, 0=not an emulated appendable, -1=error
1889 */
1890 int isoburn_get_min_start_byte(struct burn_drive *d, off_t *start_byte,
1891  int flag);
1892 
1893 
1894 /** To choose the expansion method of Growing:
1895  Create a disc object for writing the new session from the created or loaded
1896  iso_volset which has been manipulated via libisofs, to the same medium from
1897  where the image was eventually loaded. This struct burn_disc is ready for
1898  use by a subsequent call to isoburn_disc_write().
1899  After this asynchronous writing has ended and the drive is BURN_DRIVE_IDLE
1900  again, the burn_disc object has to be disposed by burn_disc_free().
1901  @since 0.1.0
1902  @param drive The combined source and target drive, grabbed with
1903  isoburn_drive_scan_and_grab(). .
1904  @param disc Returns the newly created burn_disc object.
1905  @param opts Image generation options, see isoburn_igopt_*()
1906  @return <=0 error , 1 = success
1907 */
1908 int isoburn_prepare_disc(struct burn_drive *drive, struct burn_disc **disc,
1909  struct isoburn_imgen_opts *opts);
1910 
1911 
1912 /** To choose the expansion method of Modifying:
1913  Create a disc object for producing a new image from a previous image
1914  plus the changes made by user. The generated burn_disc is suitable
1915  to be written to a grabbed drive with blank writeable medium.
1916  But you must not use the same drive for input and output, because data
1917  will be read from the source drive while at the same time the target
1918  drive is already writing.
1919  The resulting burn_disc object has to be disposed when all its writing
1920  is done and the drive is BURN_DRIVE_IDLE again after asynchronous
1921  burn_disc_write().
1922  @since 0.1.0
1923  @param in_drive The input drive, grabbed with isoburn_drive_aquire() or
1924  one of its alternatives.
1925  @param disc Returns the newly created burn_disc object.
1926  @param opts Options for image generation and data transport to the
1927  medium.
1928  @param out_drive The output drive, from isoburn_drive_aquire() et.al..
1929  @return <=0 error , 1 = success
1930 */
1931 int isoburn_prepare_new_image(struct burn_drive *in_drive,
1932  struct burn_disc **disc,
1933  struct isoburn_imgen_opts *opts,
1934  struct burn_drive *out_drive);
1935 
1936 
1937 /** To choose the expansion method of Blind Growing:
1938  Create a disc object for writing an add-on session from the created or
1939  loaded IsoImage which has been manipulated via libisofs, to a different
1940  drive than the one from where it was loaded.
1941  Usually output will be stdio:/dev/fd/1 (i.e. stdout) being piped
1942  into some burn program like with this classic gesture:
1943  mkisofs -M $dev -C $msc1,$nwa | cdrecord -waiti dev=$dev
1944  Parameter translation into libisoburn:
1945  $dev is the address by which parameter in_drive of this call was
1946  acquired $msc1 was set by isoburn_set_msc1() before image reading
1947  or was detected from the in_drive medium
1948  $nwa is a parameter of this call
1949  or can be used as detected from the in_drive medium
1950 
1951  This call waits for libisofs output to become available and then detaches
1952  the input drive object from the data source object by which libisofs was
1953  reading from the input drive.
1954  So, as far as libisofs is concerned, that drive may be released immediately
1955  after this call in order to allow the consumer to access the drive for
1956  writing.
1957  The consumer should wait for input to become available and only then open
1958  its burn drive. With cdrecord this is caused by option -waiti.
1959 
1960  The resulting burn_disc object has to be disposed when all its writing
1961  is done and the drive is BURN_DRIVE_IDLE again after asynchronous
1962  burn_disc_write().
1963  @since 0.2.2
1964  @param in_drive The input drive,grabbed with isoburn_drive_scan_and_grab().
1965  @param disc Returns the newly created burn_disc object.
1966  @param opts Options for image generation and data transport to media.
1967  @param out_drive The output drive, from isoburn_drive_aquire() et.al..
1968  typically stdio:/dev/fd/1 .
1969  @param nwa The address (2048 byte block count) where the add-on
1970  session will be finally stored on a mountable medium
1971  or in a mountable file.
1972  If nwa is -1 then the address is used as determined from
1973  the in_drive medium.
1974  @return <=0 error , 1 = success
1975 */
1976 int isoburn_prepare_blind_grow(struct burn_drive *in_drive,
1977  struct burn_disc **disc,
1978  struct isoburn_imgen_opts *opts,
1979  struct burn_drive *out_drive, int nwa);
1980 
1981 
1982 /**
1983  Revoke isoburn_prepare_*() instead of running isoburn_disc_write().
1984  libisofs reserves resources and maybe already starts generating the
1985  image stream when one of above three calls is performed. It is mandatory to
1986  either run isoburn_disc_write() or to revoke the preparations by the
1987  call described here.
1988  If this call returns 0 or 1 then the write thread of libisofs has ended.
1989  @since 0.1.0
1990  @param input_drive The drive resp. in_drive which was used with the
1991  preparation call.
1992  @param output_drive The out_drive used with isoburn_prepare_new_image(),
1993  NULL if none.
1994  @param flag Bitfield, submit 0 for now.
1995  bit0= -reserved for internal use-
1996  @return <0 error, 0= no pending preparations detectable, 1 = canceled
1997 */
1998 int isoburn_cancel_prepared_write(struct burn_drive *input_drive,
1999  struct burn_drive *output_drive, int flag);
2000 
2001 
2002 /**
2003  Override the truncation setting that was made with flag bit2 during the
2004  call of isoburn_drive_aquire. This applies only to stdio pseudo drives.
2005  @since 0.1.6
2006  @param drive The drive which was acquired and shall be used for writing.
2007  @param flag Bitfield controlling the setting:
2008  bit0= truncate (else do not truncate)
2009  bit1= do not warn if call is inappropriate to drive
2010  bit2= only set if truncation is currently enabled
2011  do not warn if call is inappropriate to drive
2012  @return 1 success, 0 inappropriate drive, <0 severe error
2013 */
2014 int isoburn_set_truncate(struct burn_drive *drive, int flag);
2015 
2016 
2017 /** Start writing of the new session.
2018  This call is asynchrounous. I.e. it returns quite soon and the progress has
2019  to be watched by a loop with call burn_drive_get_status() until
2020  BURN_DRIVE_IDLE is returned.
2021  Wrapper for: burn_disc_write()
2022  @since 0.1.0
2023  @param o Options which control the burn process. See burnwrite_opts_*()
2024  in libburn.h.
2025  @param disc Disc object created either by isoburn_prepare_disc() or by
2026  isoburn_prepare_new_image().
2027 */
2028 void isoburn_disc_write(struct burn_write_opts *o, struct burn_disc *disc);
2029 
2030 
2031 /** Inquire state and fill parameters of the fifo which is attached to
2032  the emerging track. This should be done in the pacifier loop while
2033  isoburn_disc_write() or burn_disc_write() are active.
2034  This works only with drives obtained by isoburn_drive_scan_and_grab()
2035  or isoburn_drive_grab(). If isoburn_prepare_new_image() was used, then
2036  parameter out_drive must have announced the track output drive.
2037  Hint: If only burn_write_opts and not burn_drive is known, then the drive
2038  can be obtained by burn_write_opts_get_drive().
2039  @since 0.1.0
2040  @param d The drive to which the track with the fifo gets burned.
2041  @param size The total size of the fifo
2042  @param free_bytes The current free capacity of the fifo
2043  @param status_text Returns a pointer to a constant text, see below
2044  @return <0 reply invalid, >=0 fifo status code:
2045  bit0+1=input status, bit2=consumption status, i.e:
2046  0="standby" : data processing not started yet
2047  1="active" : input and consumption are active
2048  2="ending" : input has ended without error
2049  3="failing" : input had error and ended,
2050  4="unused" : ( consumption has ended before processing start )
2051  5="abandoned" : consumption has ended prematurely
2052  6="ended" : consumption has ended without input error
2053  7="aborted" : consumption has ended after input error
2054 */
2055 int isoburn_get_fifo_status(struct burn_drive *d, int *size, int *free_bytes,
2056  char **status_text);
2057 
2058 
2059 /** Inquire whether the most recent write run was successful.
2060  Wrapper for: burn_drive_wrote_well()
2061  @since 0.1.0
2062  @param d The drive to inquire
2063  @return 1=burn seems to have went well, 0=burn failed
2064 */
2065 int isoburn_drive_wrote_well(struct burn_drive *d);
2066 
2067 
2068 /** Call this after isoburn_disc_write has finished and burn_drive_wrote_well()
2069  indicates success. It will eventually complete the emulation of
2070  multi-session functionality, if needed at all. Let libisoburn decide.
2071  Not a wrapper, but peculiar to libisoburn.
2072  @since 0.1.0
2073  @param d The output drive to which the session was written
2074  @return 1 success , <=0 failure
2075 */
2076 int isoburn_activate_session(struct burn_drive *d);
2077 
2078 
2079 /** Wait after normal end of operations until libisofs ended all write
2080  threads and freed resource reservations.
2081  This call is not mandatory. But without it, messages from the ending
2082  threads might appear after the application ended its write procedure.
2083  @since 0.1.0
2084  @param input_drive The drive resp. in_drive which was used with the
2085  preparation call.
2086  @param output_drive The out_drive used with isoburn_prepare_new_image(),
2087  NULL if none.
2088  @param flag Bitfield, submit 0 for now.
2089  @return <=0 error , 1 = success
2090 */
2091 int isoburn_sync_after_write(struct burn_drive *input_drive,
2092  struct burn_drive *output_drive, int flag);
2093 
2094 
2095 /** Release an acquired drive.
2096  Wrapper for: burn_drive_release()
2097  @since 0.1.0
2098  @param drive The drive to be released
2099  @param eject 1= eject medium from drive , 0= do not eject
2100 */
2101 void isoburn_drive_release(struct burn_drive *drive, int eject);
2102 
2103 
2104 /** Shutdown all three libraries.
2105  Wrapper for : iso_finish() and burn_finish().
2106  @since 0.1.0
2107 */
2108 void isoburn_finish(void);
2109 
2110 
2111 /*
2112  The following calls are for expert applications only.
2113  An application should have a special reason to use them.
2114 */
2115 
2116 
2117 /** Inquire wether the medium needs emulation or would be suitable for
2118  generic multi-session via libburn.
2119  @since 0.1.0
2120  @param d The drive to inquire
2121  @return 0 is generic multi-session
2122  1 is emulated multi-session
2123  -1 is not suitable for isoburn
2124 */
2125 int isoburn_needs_emulation(struct burn_drive *d);
2126 
2127 
2128 /* ---------------------------- Test area ----------------------------- */
2129 
2130 /* no tests active, currently */
2131