libisoburn  1.3.8
libisoburn.h
Go to the documentation of this file.
1 
2 /*
3  Lower level API definition of libisoburn.
4 
5  Copyright 2007-2014 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 3
245 #define isoburn_libisofs_req_micro 8
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 3
253 #define isoburn_libburn_req_micro 8
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 3
308 #define isoburn_header_version_micro 8
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  bit9= when scanning for ISO 9660 sessions by bit3:
440  Do not demand a valid superblock at LBA 0, ignore it in
441  favor of one at LBA 32, and scan until end of medium.
442  @since 1.2.6
443  @return 1 = success , 0 = drive not found , <0 = other error
444 
445  Please excuse the typo "aquire" in the function name.
446 */
447 int isoburn_drive_aquire(struct burn_drive_info *drive_infos[],
448  char* adr, int flag);
449 
450 /** Acquire a drive from the burn_drive_info[] array which was obtained by
451  a previous call of burn_drive_scan().
452  Wrapper for: burn_drive_grab()
453  @since 0.1.0
454  @param drive The drive to grab. E.g. drive_infos[1].drive .
455  Call isoburn_drive_release(drive) when it it no longer needed.
456  @param load 1 attempt to load the disc tray. 0 no attempt, rather failure.
457  @return 1 success, <=0 failure
458 */
459 int isoburn_drive_grab(struct burn_drive *drive, int load);
460 
461 
462 /** Attach to a drive an application provided method for immediate
463  delivery of messages.
464  If no method is set or if the method is set to NULL then libisoburn
465  delivers messages of the drive through the global msgs_submit() method
466  set by isoburn_set_msgs_submiti() or by the message queue of libburn.
467  @since 0.2.0
468  @param d The drive to which this function, handle and flag shall apply
469  @param msgs_submit The function call which implements the method
470  @param submit_handle Handle to be used as first argument of msgs_submit
471  @param submit_flag Flag to be used as last argument of msgs_submit
472  @param flag Unused yet, submit 0
473 */
474 int isoburn_drive_set_msgs_submit(struct burn_drive *d,
475  int (*msgs_submit)(void *handle, int error_code,
476  char msg_text[], int os_errno,
477  char severity[], int flag),
478  void *submit_handle, int submit_flag, int flag);
479 
480 
481 /** Inquire the medium status. Expect the whole spectrum of libburn BURN_DISC_*
482  with multi-session media. Emulated states with random access media are
483  BURN_DISC_BLANK and BURN_DISC_APPENDABLE.
484  Wrapper for: burn_disc_get_status()
485  @since 0.1.0
486  @param drive The drive to inquire.
487  @return The status of the drive, or what kind of disc is in it.
488  Note: BURN_DISC_UNGRABBED indicates wrong API usage
489 */
490 #ifdef __cplusplus
491 enum burn::burn_disc_status isoburn_disc_get_status(struct burn_drive *drive);
492 #else
493 enum burn_disc_status isoburn_disc_get_status(struct burn_drive *drive);
494 #endif
495 
496 
497 /** Sets the medium status to BURN_DISC_FULL unconditionally.
498  @since 1.3.8
499  @param drive The drive with the medium to be handled as if it was closed.
500  @
501 */
502 int isoburn_disc_pretend_full_uncond(struct burn_drive *drive);
503 
504 
505 /** Tells whether the medium can be treated by isoburn_disc_erase().
506  Wrapper for: burn_disc_erasable()
507  @since 0.1.0
508  @param d The drive to inquire.
509  @return 0=not erasable , else erasable
510 */
511 int isoburn_disc_erasable(struct burn_drive *d);
512 
513 
514 /** Mark the medium as blank. With multi-session media this will call
515  burn_disc_erase(). With random access media, an eventual ISO-9660
516  filesystem will get invalidated by altering its start blocks on the medium.
517  In case of success, the medium is in status BURN_DISC_BLANK afterwards.
518  Wrapper for: burn_disc_erase()
519  @since 0.1.0
520  @param drive The drive with the medium to erase.
521  @param fast 1=fast erase, 0=thorough erase
522  With DVD-RW, fast erase yields media incapable of multi-session.
523 */
524 void isoburn_disc_erase(struct burn_drive *drive, int fast);
525 
526 
527 /** Set up isoburn_disc_get_msc1() to return a fabricated value.
528  This makes only sense between aquiring the drive and reading the
529  image. After isoburn_read_image() it will confuse the coordination
530  of libisoburn and libisofs.
531  Note: Sessions and tracks are counted beginning with 1, not with 0.
532  @since 0.1.6
533  @param d The drive where msc1 is to be set
534  @param adr_mode Determines how to interpret adr_value and to set msc1.
535  If adr_value shall represent a number then decimal ASCII
536  digits are expected.
537  0= start lba of last session in TOC, ignore adr_value
538  1= start lba of session number given by adr_value
539  2= start lba of track given number by adr_value
540  3= adr_value itself is the lba to be used
541  4= start lba of last session with volume id
542  given by adr_value
543  @param adr_value A string describing the value to be eventually used.
544  @param flag Bitfield for control purposes.
545  bit0= @since 0.2.2
546  with adr_mode 3: adr_value might be 16 blocks too high
547  (e.g. -C stemming from growisofs). Probe for ISO head
548  at adr_value-16 and eventually adjust setting.
549  bit1= insist in seeing a disc object with at least one session
550  bit2= with adr_mode 4: use adr_value as regular expression
551 */
552 int isoburn_set_msc1(struct burn_drive *d, int adr_mode, char *adr_value,
553  int flag);
554 
555 
556 /* ----------------------------------------------------------------------- */
557 /*
558 
559  Wrappers for emulation of TOC on overwriteable media
560 
561  Media which match the overwriteable usage model lack of a history of sessions
562  and tracks. libburn will not even hand out a burn_disc object for them and
563  always declare them blank. libisoburn checks for a valid ISO filesystem
564  header at LBA 0 and eventually declares them appendable.
565  Nevertheless one can only determine an upper limit of the size of the overall
566  image (by isoburn_get_min_start_byte()) but not a list of stored sessions
567  and their LBAs, as it is possible with true multi-session media.
568 
569  The following wrappers add the capability to obtain a session and track TOC
570  from emulated multi-session images on overwriteables if the first session
571  was written by libisoburn-0.1.6 or later (i.e. with a header copy at LBA 32).
572 
573  Be aware that the structs emitted by these isoburn calls are not compatible
574  with the libburn structs. I.e. you may use them only with isoburn_toc_*
575  calls.
576  isoburn_toc_disc needs to be freed after use. isoburn_toc_session and
577  isoburn_toc_track vanish together with their isoburn_toc_disc.
578 */
579 
580 /* Opaque handles to media, session, track */
581 struct isoburn_toc_disc;
582 struct isoburn_toc_session;
583 struct isoburn_toc_track;
584 
585 
586 /** Obtain a master handle for the table of content.
587  This handle governs allocated resources which have to be released by
588  isoburn_toc_disc_free() when no longer needed.
589  Wrapper for: burn_drive_get_disc()
590  @since 0.1.6
591  @param d The drive with the medium to inspect
592  @return NULL in case there is no content info, else it is a valid handle
593 */
594 struct isoburn_toc_disc *isoburn_toc_drive_get_disc(struct burn_drive *d);
595 
596 
597 /** Tell the number of 2048 byte blocks covered by the table of content.
598  This number includes the eventual gaps between sessions and tracks.
599  So this call is not really a wrapper for burn_disc_get_sectors().
600  @since 0.1.6
601  @param disc The master handle of the medium
602  @return Number of blocks, <=0 indicates unknown or unreadable state
603 */
604 int isoburn_toc_disc_get_sectors(struct isoburn_toc_disc *disc);
605 
606 
607 /** Get the array of session handles and the number of complete sessions
608  from the table of content.
609  The result array contains *num + isoburn_toc_disc_get_incmpl_sess()
610  elements. All above *num are incomplete sessions.
611  Typically there is at most one incomplete session with no track.
612  Wrapper for: burn_disc_get_sessions()
613  @since 0.1.6
614  @param disc The master handle of the medium
615  @param num returns the number of sessions in the array
616  @return the address of the array of session handles
617 */
618 struct isoburn_toc_session **isoburn_toc_disc_get_sessions(
619  struct isoburn_toc_disc *disc, int *num);
620 
621 
622 /** Obtain the number of incomplete sessions which are recorded in the
623  result array of isoburn_toc_disc_get_sessions() after the complete
624  sessions. See above.
625  @since 1.2.8
626  @param disc The master handle of the medium
627  @return the number of incomplete sessions
628 */
629 int isoburn_toc_disc_get_incmpl_sess(struct isoburn_toc_disc *disc);
630 
631 
632 /** Tell the number of 2048 byte blocks covered by a particular session.
633  Wrapper for: burn_session_get_sectors()
634  @since 0.1.6
635  @param s The session handle
636  @return number of blocks, <=0 indicates unknown or unreadable state
637 */
638 int isoburn_toc_session_get_sectors(struct isoburn_toc_session *s);
639 
640 
641 /** Obtain a copy of the entry which describes the end of a particular session.
642  Wrapper for: burn_session_get_leadout_entry()
643  @since 0.1.6
644  @param s The session handle
645  @param entry A pointer to memory provided by the caller. It will be filled
646  with info according to struct burn_toc_entry as defined
647  in libburn.h
648 */
649 void isoburn_toc_session_get_leadout_entry(struct isoburn_toc_session *s,
650  struct burn_toc_entry *entry);
651 
652 
653 /** Get the array of track handles from a particular session.
654  Wrapper for: burn_session_get_tracks()
655  @since 0.1.6
656  @param s The session handle
657  @param num returns the number of tracks in the array
658  @return the address of the array of track handles,
659  NULL if no tracks are registered with session s
660 */
661 struct isoburn_toc_track **isoburn_toc_session_get_tracks(
662  struct isoburn_toc_session *s, int *num);
663 
664 
665 /** Obtain a copy of the entry which describes a particular track.
666  Wrapper for: burn_track_get_entry()
667  @since 0.1.6
668  @param t The track handle
669  @param entry A pointer to memory provided by the caller. It will be filled
670  with info according to struct burn_toc_entry as defined
671  in libburn.h
672 */
673 void isoburn_toc_track_get_entry(struct isoburn_toc_track *t,
674  struct burn_toc_entry *entry);
675 
676 
677 /** Obtain eventual ISO image parameters of an emulated track. This info was
678  gained with much effort and thus gets cached in the track object.
679  If this call returns 1 then one can save a call of isoburn_read_iso_head()
680  with return mode 1 which could cause an expensive read operation.
681  @since 0.4.0
682  @param t The track handle
683  @param start_lba Returns the start address of the ISO session
684  @param image_blocks Returns the number of 2048 bytes blocks
685  @param volid Caller provided memory for the volume id
686  @param flag unused yet, submit 0
687  @return 0= not an emulated ISO session , 1= reply is valid
688 */
689 int isoburn_toc_track_get_emul(struct isoburn_toc_track *t, int *start_lba,
690  int *image_blocks, char volid[33], int flag);
691 
692 
693 
694 /** Release the memory associated with a master handle of a medium.
695  The handle is invalid afterwards and may not be used any more.
696  Wrapper for: burn_disc_free()
697  @since 0.1.6
698  @param disc The master handle of the medium
699 */
700 void isoburn_toc_disc_free(struct isoburn_toc_disc *disc);
701 
702 
703 /** Try whether the data at the given address look like a ISO 9660
704  image header and obtain its alleged size. Depending on the info mode
705  one other string of text information can be retrieved too.
706  @since 0.1.6
707  @param d The drive with the medium to inspect
708  @param lba The block number from where to read
709  @param image_blocks Returns the number of 2048 bytes blocks in the session
710  @param info Caller provided memory, enough to take eventual info reply
711  @param flag bit0-7: info return mode
712  0= do not return anything in info (do not even touch it)
713  1= copy volume id to info (info needs 33 bytes)
714  2= @since 0.2.2 :
715  copy 64 kB header to info (needs 65536 bytes)
716  bit13= @since 0.2.2:
717  Do not read head from medium but use first 64 kB from
718  info.
719  In this case it is permissible to submit d == NULL.
720  bit14= check both half buffers (not only second)
721  return 2 if found in first block
722  bit15= return -1 on read error
723  @return >0 seems to be a valid ISO image, 0 format not recognized, <0 error
724 */
725 int isoburn_read_iso_head(struct burn_drive *d, int lba,
726  int *image_blocks, char *info, int flag);
727 
728 
729 /** Try to convert the given entity address into various entity addresses
730  which would describe it.
731  Note: Sessions and tracks are counted beginning with 1, not with 0.
732  @since 0.3.2
733  @param d The drive where msc1 is to be set
734  @param adr_mode Determines how to interpret the input adr_value.
735  If adr_value shall represent a number then decimal ASCII
736  digits are expected.
737  0= start lba of last session in TOC, ignore adr_value
738  1= start lba of session number given by adr_value
739  2= start lba of track given number by adr_value
740  3= adr_value itself is the lba to be used
741  4= start lba of last session with volume id
742  given by adr_value
743  @param adr_value A string describing the value to be eventually used.
744  @param lba returns the block address of the entity, -1 means invalid
745  @param track returns the track number of the entity, -1 means invalid
746  @param session returns the session number of the entity, -1 means invalid
747  @param volid returns the volume id of the entity if it is a ISO session
748  @param flag Bitfield for control purposes.
749  bit2= with adr_mode 4: use adr_value as regular expression
750  @return <=0 error , 1 ok, ISO session, 2 ok, not an ISO session
751 */
752 int isoburn_get_mount_params(struct burn_drive *d,
753  int adr_mode, char *adr_value,
754  int *lba, int *track, int *session,
755  char volid[33], int flag);
756 
757 
758 /* ----------------------------------------------------------------------- */
759 /*
760 
761  Options for image reading.
762 
763  An application shall create an option set object by isoburn_ropt_new(),
764  program it by isoburn_ropt_set_*(), use it with isoburn_read_image(),
765  and finally delete it by isoburn_ropt_destroy().
766 
767 */
768 /* ----------------------------------------------------------------------- */
769 
770 struct isoburn_read_opts;
771 
772 /** Produces a set of image read options, initialized with default values.
773  @since 0.1.0
774  @param o the newly created option set object
775  @param flag Bitfield for control purposes. Submit 0 for now.
776  @return 1=ok , <0 = failure
777 */
778 int isoburn_ropt_new(struct isoburn_read_opts **o, int flag);
779 
780 
781 /** Deletes an option set which was created by isoburn_ropt_new().
782  @since 0.1.0
783  @param o The option set to work on
784  @param flag Bitfield for control purposes. Submit 0 for now.
785  @return 1= **o destroyed , 0= *o was already NULL (harmless)
786 */
787 int isoburn_ropt_destroy(struct isoburn_read_opts **o, int flag);
788 
789 /** Sets the size and granularity of the cache which libisoburn provides to
790  libisofs for reading of ISO image data. This cache consists of several
791  tiles which are buffers of a given size. The ISO image is divided into
792  virtual tiles of that size. A cache tile may hold an in-memory copy
793  of such a virtual image tile.
794  When libisofs requests to read a block, then first the cache is inquired
795  whether it holds that block. If not, then the block is read via libburn
796  together with its neighbors in their virtual image tile into a free
797  cache tile. If no cache tile is free, then the one will be re-used which
798  has the longest time of not being hit by a read attempt.
799 
800  A larger cache might speed up image loading by reducing the number of
801  libburn read calls on the directory tree. It might also help with
802  reading the content of many small files, if for some reason it is not an
803  option to sort access by LBA.
804  Caching will not provide much benefit with libburn "stdio:" drives,
805  because the operating system is supposed to provide the same speed-up
806  in a more flexible way.
807 
808  @since 1.2.2
809  @param o The option set to work on.
810  It is permissible to submit NULL in order to just
811  have the parameters tested.
812  @param cache_tiles Number of tiles in the cache. Not less than 1.
813  Default is 32.
814  @param tile_blocks Number of blocks per tile. Must be a power of 2.
815  Default is 32.
816  cache_tiles * tile_blocks * 2048 must not exceed
817  1073741824 (= 1 GiB).
818  @param flag Bitfield for control purposes. Unused yet. Submit 0.
819  @return <=0 error , >0 ok
820 */
821 int isoburn_ropt_set_data_cache(struct isoburn_read_opts *o,
822  int cache_tiles, int tile_blocks, int flag);
823 
824 /** Inquire the current settings of isoburn_set_data_cache().
825  @since 1.2.2
826  @param o The option set to work on.
827  NULL has the same effect as flag bit0.
828  @param cache_tiles Will return the number of tiles in the cache.
829  @param tile_blocks Will return the number of blocks per tile.
830  @param set_flag Will return control bits. None are defined yet.
831  @param flag Bitfield for control purposes
832  bit0= return default values rather than current ones
833  @return <=0 error , >0 reply is valid
834 */
835 int isoburn_ropt_get_data_cache(struct isoburn_read_opts *o,
836  int *cache_tiles, int *tile_blocks,
837  int *set_flag, int flag);
838 
839 
840 /** Which existing ISO 9660 extensions in the image to read or not to read.
841  Whether to read the content of an existing image at all.
842  The bits can be combined by | resp. inquired by &.
843  @since 0.1.0
844  @param ext Bitfield:
845  bit0= norock
846  Do not read Rock Ridge extensions
847  bit1= nojoliet
848  Do not read Joliet extensions
849  bit2= noiso1999
850  Do not read ISO 9660:1999 enhanced tree
851  bit3= preferjoliet
852  When both Joliet and RR extensions are present, the RR
853  tree is used. If you prefer using Joliet, set this to 1.
854  bit4= pretend_blank
855  Always create empty image.Ignore any image on input drive.
856  bit5= noaaip
857  @since 0.3.4
858  Do not load AAIP information from image. This information
859  eventually contains ACL or XFS-style Extended Attributes.
860  bit6= noacl
861  @since 0.3.4
862  Do not obtain ACL from external filesystem objects (e.g.
863  local filesystem files).
864  bit7= noea
865  @since 0.3.4
866  Do not obtain XFS-style Extended Attributes from external
867  filesystem objects (e.g. local filesystem files).
868  bit8= noino
869  @since 0.4.0
870  Do not load eventual inode numbers from RRIP entry PX,
871  but generate a new unique inode number for each imported
872  IsoNode object.
873  PX inode numbers allow to mark families of hardlinks by
874  giving all family members the same inode number. libisofs
875  keeps the PX inode numbers unaltered when IsoNode objects
876  get written into an ISO image.
877  bit9= nomd5
878  @since 0.4.2
879  Do not load the eventual MD5 checksum array.
880  Do not check eventual session_md5 tags.
881  bit10= nomd5tag
882  @since 1.0.4
883  Do not check eventual session_md5 tags although bit9
884  is not set.
885  @return 1 success, <=0 failure
886 */
887 #define isoburn_ropt_norock 1
888 #define isoburn_ropt_nojoliet 2
889 #define isoburn_ropt_noiso1999 4
890 #define isoburn_ropt_preferjoliet 8
891 #define isoburn_ropt_pretend_blank 16
892 #define isoburn_ropt_noaaip 32
893 #define isoburn_ropt_noacl 64
894 #define isoburn_ropt_noea 128
895 #define isoburn_ropt_noino 256
896 #define isoburn_ropt_nomd5 512
897 #define isoburn_ropt_nomd5tag 1024
898 
899 int isoburn_ropt_set_extensions(struct isoburn_read_opts *o, int ext);
900 int isoburn_ropt_get_extensions(struct isoburn_read_opts *o, int *ext);
901 
902 
903 /** Default attributes to use if no RockRidge extension gets loaded.
904  @since 0.1.0
905  @param o The option set to work on
906  @param uid user id number (see /etc/passwd)
907  @param gid group id number (see /etc/group)
908  @param mode permissions (not file type) as of man 2 stat.
909  With directories, r-permissions will automatically imply
910  x-permissions. See isoburn_ropt_set_default_dirperms() below.
911  @return 1 success, <=0 failure
912 */
913 int isoburn_ropt_set_default_perms(struct isoburn_read_opts *o,
914  uid_t uid, gid_t gid, mode_t mode);
915 int isoburn_ropt_get_default_perms(struct isoburn_read_opts *o,
916  uid_t *uid, gid_t *gid, mode_t *mode);
917 
918 /** Default attributes to use on directories if no RockRidge extension
919  gets loaded.
920  Above call isoburn_ropt_set_default_perms() automatically adds
921  x-permissions to r-permissions for directories. This call here may
922  be done afterwards to set independend permissions for directories,
923  especially to override the automatically added x-permissions.
924  @since 0.1.0
925  @param o The option set to work on
926  @param mode permissions (not file type) as of man 2 stat.
927  @return 1 success, <=0 failure
928 */
929 int isoburn_ropt_set_default_dirperms(struct isoburn_read_opts *o,
930  mode_t mode);
931 int isoburn_ropt_get_default_dirperms(struct isoburn_read_opts *o,
932  mode_t *mode);
933 
934 
935 /** Set the character set for reading RR file names from ISO images.
936  @since 0.1.0
937  @param o The option set to work on
938  @param input_charset Set this to NULL to use the default locale charset
939  For selecting a particular character set, submit its
940  name, e.g. as listed by program iconv -l.
941  Example: "UTF-8".
942  @return 1 success, <=0 failure
943 */
944 int isoburn_ropt_set_input_charset(struct isoburn_read_opts *o,
945  char *input_charset);
946 int isoburn_ropt_get_input_charset(struct isoburn_read_opts *o,
947  char **input_charset);
948 
949 
950 /**
951  Enable or disable methods to automatically choose an input charset.
952  This eventually overrides the name set via isoburn_ropt_set_input_charset()
953  @since 0.3.8
954  @param o The option set to work on
955  @param mode Bitfield for control purposes:
956  bit0= allow to set the input character set automatically from
957  attribute "isofs.cs" of root directory.
958  Submit any other bits with value 0.
959  @return 1 success, <=0 failure
960  */
961 int isoburn_ropt_set_auto_incharset(struct isoburn_read_opts *o, int mode);
962 int isoburn_ropt_get_auto_incharset(struct isoburn_read_opts *o, int *mode);
963 
964 
965 /** Control an offset to be applied to all block address pointers in the ISO
966  image in order to compensate for an eventual displacement of the image
967  relative to the start block address for which it was produced.
968  E.g. if track number 2 from CD gets copied into a disk file and shall then
969  be loaded as ISO filesystem, then the directory tree and all data file
970  content of the track copy will become readable by setting the track start
971  address as displacement and -1 as displacement_sign.
972  Data file content outside the track will of course not be accessible and
973  eventually produce read errors.
974  @since 0.6.6
975  @param o The option set to work on
976  @param displacement 0 or a positive number
977  @param displacement_sign Determines wether to add or subtract displacement
978  to block addresses before applying them to the
979  storage object for reading:
980  +1 = add , -1= subtract , else keep unaltered
981 */
982 int isoburn_ropt_set_displacement(struct isoburn_read_opts *o,
983  uint32_t displacement, int displacement_sign);
984 int isoburn_ropt_get_displacement(struct isoburn_read_opts *o,
985  uint32_t *displacement, int *displacement_sign);
986 
987 /* If you get here because of a compilation error like
988 
989  /usr/include/libisoburn/libisoburn.h:895: error:
990  expected declaration specifiers or '...' before 'uint32_t'
991 
992  then see above paragraph "Application Constraints" about the definition
993  of uint32_t.
994 */
995 
996 
997 /** After calling function isoburn_read_image() there are informations
998  available in the option set.
999  This info can be obtained as bits in parameter has_what. Like:
1000  joliet_available = (has_what & isoburn_ropt_has_joliet);
1001  @since 0.1.0
1002  @param o The option set to work on
1003  @param size Number of image data blocks, 2048 bytes each.
1004  @param has_what Bitfield:
1005  bit0= has_rockridge
1006  RockRidge extension info is available (POSIX filesystem)
1007  bit1= has_joliet
1008  Joliet extension info is available (suitable for MS-Windows)
1009  bit2= has_iso1999
1010  ISO version 2 Enhanced Volume Descriptor is available.
1011  This is rather exotic.
1012  bit3= has_el_torito
1013  El-Torito boot record is present
1014  @return 1 success, <=0 failure
1015 */
1016 #define isoburn_ropt_has_rockridge 1
1017 #define isoburn_ropt_has_joliet 2
1018 #define isoburn_ropt_has_iso1999 4
1019 #define isoburn_ropt_has_el_torito 8
1020 
1021 int isoburn_ropt_get_size_what(struct isoburn_read_opts *o,
1022  uint32_t *size, int *has_what);
1023 
1024 /* ts A90122 */
1025 /* >>> to be implemented:
1026 #define isoburn_ropt_has_acl 64
1027 #define isoburn_ropt_has_ea 128
1028 */
1029 
1030 
1031 
1032 /* ----------------------------------------------------------------------- */
1033 /* End of Options for image reading */
1034 /* ----------------------------------------------------------------------- */
1035 
1036 /* ----------------------------------------------------------------------- */
1037 /*
1038 
1039  Options for image generation by libisofs and image transport to libburn.
1040 
1041  An application shall create an option set by isoburn_igopt_new(),
1042  program it by isoburn_igopt_set_*(), use it with either
1043  isoburn_prepare_new_image() or isoburn_prepare_disc(), and finally delete
1044  it by isoburn_igopt_destroy().
1045 
1046 */
1047 /* ----------------------------------------------------------------------- */
1048 
1049 struct isoburn_imgen_opts;
1050 
1051 /** Produces a set of generation and transfer options, initialized with default
1052  values.
1053  @since 0.1.0
1054  @param o the newly created option set object
1055  @param flag Bitfield for control purposes. Submit 0 for now.
1056  @return 1=ok , <0 = failure
1057 */
1058 int isoburn_igopt_new(struct isoburn_imgen_opts **o, int flag);
1059 
1060 
1061 /** Deletes an option set which was created by isoburn_igopt_new().
1062  @since 0.1.0
1063  @param o The option set to give up
1064  @param flag Bitfield for control purposes. Submit 0 for now.
1065  @return 1= **o destroyed , 0= *o was already NULL (harmless)
1066 */
1067 int isoburn_igopt_destroy(struct isoburn_imgen_opts **o, int flag);
1068 
1069 
1070 /** ISO level to write at.
1071  @since 0.1.0
1072  @param o The option set to work on
1073  @param level is a term of the ISO 9660 standard. It should be one of:
1074  1= filenames restricted to form 8.3
1075  2= filenames allowed up to 31 characters
1076  3= file content may be larger than 4 GB - 1.
1077  @return 1 success, <=0 failure
1078 */
1079 int isoburn_igopt_set_level(struct isoburn_imgen_opts *o, int level);
1080 int isoburn_igopt_get_level(struct isoburn_imgen_opts *o, int *level);
1081 
1082 
1083 /** Which extensions to support.
1084  @since 0.1.0
1085  @param o The option set to work on
1086  @param ext Bitfield:
1087  bit0= rockridge
1088  Rock Ridge extensions add POSIX file attributes like
1089  owner, group, access permissions, long filenames. Very
1090  advisable if the designed audience has Unix style systems.
1091  bit1= joliet
1092  Longer filenames for Windows systems.
1093  Weaker than RockRidge, but also readable with GNU/Linux.
1094  bit2= iso1999
1095  This is rather exotic. Better do not surprise the readers.
1096  bit3= hardlinks
1097  Enable hardlink consolidation. IsoNodes which refer to the
1098  same source object and have the same properties will get
1099  the same ISO image inode numbers.
1100  If combined with isoburn_igopt_rrip_version_1_10 below,
1101  then the PX entry layout of RRIP-1.12 will be used within
1102  RRIP-1.10 (mkisofs does this without causing visible trouble).
1103  bit5= aaip
1104  The libisofs specific SUSP based extension of ECMA-119 which
1105  can encode ACL and XFS-style Extended Attributes.
1106  bit6= session_md5
1107  @since 0.4.2
1108  Produce and write MD5 checksum tags of superblock, directory
1109  tree, and the whole session stream.
1110  bit7= file_md5
1111  @since 0.4.2
1112  Produce and write MD5 checksums for each single IsoFile.
1113  bit8= file_stability (only together with file_md5)
1114  @since 0.4.2
1115  Compute MD5 of each file before copying it into the image and
1116  compare this with the MD5 of the actual copying. If they do
1117  not match then issue MISHAP event.
1118  See also libisofs.h iso_write_opts_set_record_md5()
1119  bit9= no_emul_toc
1120  @since 0.5.8
1121  On overwriteable media or random access files do not write
1122  the first session to LBA 32 and do not copy the first 64kB
1123  of the first session to LBA 0, but rather write the first
1124  session to LBA 0 directly.
1125  bit10= will_cancel
1126  @since 0.6.6
1127  Announce to libisofs that only the image size is desired
1128  and that the write thread will be cancelled by
1129  isoburn_cancel_prepared_write() before actual image writing
1130  occurs. Without this, cancellation can cause a MISHAP event.
1131  bit11= old_empty
1132  @since 1.0.2
1133  Let symbolic links and device files point to block 0, and let
1134  empty data files point to the address of the Volume Descriptor
1135  Set Terminator. This was done by libisofs in the past.
1136  By default there is now a single dedicated block of zero bytes
1137  after the end of the directory trees, of which the address
1138  is used for all files without own content.
1139  bit12= hfsplus
1140  @since 1.2.4
1141  Produce a HFS+ partition inside the ISO image and announce it
1142  by an Apple Partition Map in the System Area.
1143  >>> GPT production ?
1144  Caution: Interferes with isoburn_igopt_set_system_area() by
1145  overwriting the first 8 bytes of the data, and
1146  several blocks of 2 KiB after the first one.
1147  bit13= fat
1148  @since 1.2.4
1149  >>> Not yet implemented. Planned to co-exist with hfsplus.
1150  Produce a FAT32 partition inside the ISO image and announce it
1151  by an MBR partition entry in the System Area.
1152  Caution: Interferes with isoburn_igopt_set_system_area() by
1153  >>> what impact ?
1154 
1155  @return 1 success, <=0 failure
1156 */
1157 #define isoburn_igopt_rockridge 1
1158 #define isoburn_igopt_joliet 2
1159 #define isoburn_igopt_iso1999 4
1160 #define isoburn_igopt_hardlinks 8
1161 #define isoburn_igopt_aaip 32
1162 #define isoburn_igopt_session_md5 64
1163 #define isoburn_igopt_file_md5 128
1164 #define isoburn_igopt_file_stability 256
1165 #define isoburn_igopt_no_emul_toc 512
1166 #define isoburn_igopt_will_cancel 1024
1167 #define isoburn_igopt_old_empty 2048
1168 #define isoburn_igopt_hfsplus 4096
1169 #define isoburn_igopt_fat 8192
1170 int isoburn_igopt_set_extensions(struct isoburn_imgen_opts *o, int ext);
1171 int isoburn_igopt_get_extensions(struct isoburn_imgen_opts *o, int *ext);
1172 
1173 /** Relaxed constraints. Setting any of the bits to 1 break the specifications,
1174  but it is supposed to work on most moderns systems. Use with caution.
1175  @since 0.1.0
1176  @param o The option set to work on
1177  @param relax Bitfield:
1178  bit0= omit_version_numbers
1179  Omit the version number (";1") at the end of the
1180  ISO-9660 and Joliet identifiers.
1181  Version numbers are usually not used by readers.
1182  bit1= allow_deep_paths
1183  Allow ISO-9660 directory hierarchy to be deeper
1184  than 8 levels.
1185  bit2= allow_longer_paths
1186  Allow path in the ISO-9660 tree to have more than
1187  255 characters.
1188  bit3= max_37_char_filenames
1189  Allow a single file or directory hierarchy to have
1190  up to 37 characters. This is larger than the 31
1191  characters allowed by ISO level 2, and the extra space
1192  is taken from the version number, so this also forces
1193  omit_version_numbers.
1194  bit4= no_force_dots
1195  ISO-9660 forces filenames to have a ".", that separates
1196  file name from extension. libisofs adds it if original
1197  filename has none. Set this to 1 to prevent this
1198  behavior.
1199  bit5= allow_lowercase
1200  Allow lowercase characters in ISO-9660 filenames.
1201  By default, only uppercase characters, numbers and
1202  a few other characters are allowed.
1203  bit6= allow_full_ascii
1204  Allow all ASCII characters to be appear on an ISO-9660
1205  filename. Note that "/" and "\0" characters are never
1206  allowed, even in RR names.
1207  bit7= joliet_longer_paths
1208  Allow paths in the Joliet tree to have more than
1209  240 characters.
1210  bit8= always_gmt
1211  Write timestamps as GMT although the specs prescribe local
1212  time with eventual non-zero timezone offset. Negative
1213  timezones (west of GMT) can trigger bugs in some operating
1214  systems which typically appear in mounted ISO images as if
1215  the timezone shift from GMT was applied twice
1216  (e.g. in New York 22:36 becomes 17:36).
1217  bit9= rrip_version_1_10
1218  Write Rock Ridge info as of specification RRIP-1.10 rather
1219  than RRIP-1.12: signature "RRIP_1991A" rather than
1220  "IEEE_1282", field PX without file serial number.
1221  bit10= dir_rec_mtime
1222  Store as ECMA-119 Directory Record timestamp the mtime
1223  of the source rather than the image creation time.
1224  bit11= aaip_susp_1_10
1225  Write AAIP fields without announcing AAIP by an ER field and
1226  without distinguishing RRIP fields from the AAIP field by
1227  prefixed ES fields. This saves 5 to 10 bytes per file and
1228  might avoid problems with readers which only accept RRIP.
1229  SUSP-1.10 allows it, SUSP-1.12 frowns on it.
1230  bit12= only_iso_numbers
1231  Same as bit1 omit_version_number but restricted to the names
1232  in the eventual Joliet tree.
1233  @since 0.5.4
1234  For reasons of backward compatibility it is not possible yet
1235  to disable version numbers for ISO 9660 while enabling them
1236  for Joliet.
1237  bit13= no_j_force_dots
1238  Same as no_force_dots but affecting the names in the eventual
1239  Joliet tree rather than the ISO 9660 / ECMA-119 names.
1240  @since 0.5.4
1241  Previous versions added dots to Joliet names unconditionally.
1242  bit14= allow_dir_id_ext
1243  Convert directory names for ECMA-119 similar to other file
1244  names, but do not force a dot or add a version number.
1245  This violates ECMA-119 by allowing one "." and especially
1246  ISO level 1 by allowing DOS style 8.3 names rather than
1247  only 8 characters.
1248  (mkisofs and its clones obviously do this violation.)
1249  @since 1.0.0
1250  bit15= joliet_long_names
1251  Allow for Joliet leaf names up to 103 characters rather than
1252  up to 64.
1253  @since 1.0.6
1254  bit16= joliet_rec_mtime
1255  Like dir_rec_mtime, but for the Joliet tree.
1256  @since 1.2.0
1257  bit17= iso1999_rec_mtime
1258  Like dir_rec_mtime, but for the ISO 9660:1999 tree.
1259  @since 1.2.0
1260  bit18= allow_7bit_ascii
1261  Like allow_full_ascii, but only allowing 7-bit characters.
1262  Lowercase letters get mapped to uppercase if not
1263  allow_lowercase is set.
1264  Gets overridden if allow_full_ascii is enabled.
1265  bit19= joliet_utf16
1266  Encode Joliet names by character set UTF-16BE rather than
1267  UCS-2. The difference is with characters which are not present
1268  in UCS-2 and get encoded in UTF-16 by 2 words of 16 bit each.
1269  Both words then stem from a reserved subset of UCS-2.
1270  @since 1.3.6
1271  @return 1 success, <=0 failure
1272 */
1273 #define isoburn_igopt_omit_version_numbers 1
1274 #define isoburn_igopt_allow_deep_paths 2
1275 #define isoburn_igopt_allow_longer_paths 4
1276 #define isoburn_igopt_max_37_char_filenames 8
1277 #define isoburn_igopt_no_force_dots 16
1278 #define isoburn_igopt_allow_lowercase 32
1279 #define isoburn_igopt_allow_full_ascii 64
1280 #define isoburn_igopt_joliet_longer_paths 128
1281 #define isoburn_igopt_always_gmt 256
1282 #define isoburn_igopt_rrip_version_1_10 512
1283 #define isoburn_igopt_dir_rec_mtime 1024
1284 #define isoburn_igopt_aaip_susp_1_10 2048
1285 #define isoburn_igopt_only_iso_versions 4096
1286 #define isoburn_igopt_no_j_force_dots 8192
1287 #define isoburn_igopt_allow_dir_id_ext 16384
1288 #define isoburn_igopt_joliet_long_names 32768
1289 #define isoburn_igopt_joliet_rec_mtime 0x10000
1290 #define isoburn_igopt_iso1999_rec_mtime 0x20000
1291 #define isoburn_igopt_allow_7bit_ascii 0x40000
1292 #define isoburn_igopt_joliet_utf16 0x80000
1293 int isoburn_igopt_set_relaxed(struct isoburn_imgen_opts *o, int relax);
1294 int isoburn_igopt_get_relaxed(struct isoburn_imgen_opts *o, int *relax);
1295 
1296 
1297 /** If not isoburn_igopt_allow_deep_paths is in effect, then it may become
1298  necessary to relocate directories so that no ECMA-119 file path
1299  has more than 8 components. These directories are grafted into either
1300  the root directory of the ISO image or into a dedicated relocation
1301  directory. For details see libisofs.h.
1302  Wrapper for: iso_write_opts_set_rr_reloc()
1303  @since 1.2.2
1304  @param o The option set to work on
1305  @param name The name of the relocation directory in the root directory.
1306  Do not prepend "/". An empty name or NULL will direct
1307  relocated directories into the root directory. This is the
1308  default.
1309  If the given name does not exist in the root directory when
1310  isoburn_disc_write() is called, and if there are directories
1311  at path level 8, then directory /name will be created
1312  automatically.
1313  @param flags Bitfield for control purposes.
1314  bit0= Mark the relocation directory by a Rock Ridge RE entry,
1315  if it gets created during isoburn_disc_write(). This
1316  will make it invisible for most Rock Ridge readers.
1317  bit1= not settable via API (used internally)
1318  @return > 0 success, <= 0 failure
1319 */
1320 int isoburn_igopt_set_rr_reloc(struct isoburn_imgen_opts *o, char *name,
1321  int flags);
1322 
1323 /** Obtain the settings of isoburn_igopt_set_rr_reloc().
1324  @since 1.2.2
1325  @param o The option set to work on
1326  @param name Will return NULL or a pointer to the name of the relocation
1327  directory in the root directory. Do not alter or dispose the
1328  memory which holds this name.
1329  @param flags Will return the flags bitfield.
1330  @return > 0 success, <= 0 failure
1331 */
1332 int isoburn_igopt_get_rr_reloc(struct isoburn_imgen_opts *o, char **name,
1333  int *flags);
1334 
1335 
1336 /** Caution: This option breaks any assumptions about names that
1337  are supported by ECMA-119 specifications.
1338  Try to omit any translation which would make a file name compliant to the
1339  ECMA-119 rules. This includes and exceeds omit_version_numbers,
1340  max_37_char_filenames, no_force_dots bit0, allow_full_ascii. Further it
1341  prevents the conversion from local character set to ASCII.
1342  The maximum name length is given by this call. If a filename exceeds
1343  this length or cannot be recorded untranslated for other reasons, then
1344  image production gets aborted.
1345  Currently the length limit is 96 characters, because an ECMA-119 directory
1346  record may at most have 254 bytes and up to 158 other bytes must fit into
1347  the record. Probably 96 more bytes can be made free for the name in future.
1348  @since 1.0.0
1349  @param o The option set to work on
1350  @param len 0 = disable this feature and perform name translation
1351  according to other settings.
1352  >0 = Omit any translation. Eventually abort image production
1353  if a name is longer than the given value.
1354  -1 = Like >0. Allow maximum possible length.
1355  isoburn_igopt_get_untranslated_name_len() will tell the
1356  effectively resulting value.
1357  @return >0 success, <=0 failure
1358 */
1359 int isoburn_igopt_set_untranslated_name_len(struct isoburn_imgen_opts *o,
1360  int len);
1361 int isoburn_igopt_get_untranslated_name_len(struct isoburn_imgen_opts *o,
1362  int *len);
1363 
1364 
1365 /** Whether and how files should be sorted.
1366  @since 0.1.0
1367  @param o The option set to work on
1368  @param value Bitfield: bit0= sort_files_by_weight
1369  files should be sorted based on their weight.
1370  Weight is attributed to files in the image
1371  by libisofs call iso_node_set_sort_weight().
1372  @return 1 success, <=0 failure
1373 */
1374 #define isoburn_igopt_sort_files_by_weight 1
1375 int isoburn_igopt_set_sort_files(struct isoburn_imgen_opts *o, int value);
1376 int isoburn_igopt_get_sort_files(struct isoburn_imgen_opts *o, int *value);
1377 
1378 
1379 /** Set the override values for files and directory permissions.
1380  The parameters replace_* these take one of three values: 0, 1 or 2.
1381  If 0, the corresponding attribute will be kept as set in the IsoNode
1382  at the time of image generation.
1383  If set to 1, the corresponding attrib. will be changed by a default
1384  suitable value.
1385  With value 2, the attrib. will be changed with the value specified
1386  in the corresponding *_mode options. Note that only the permissions
1387  are set, the file type remains unchanged.
1388  @since 0.1.0
1389  @param o The option set to work on
1390  @param replace_dir_mode whether and how to override directories
1391  @param replace_file_mode whether and how to override files of other type
1392  @param dir_mode Mode to use on dirs with replace_dir_mode == 2.
1393  @param file_mode; Mode to use on files with replace_file_mode == 2.
1394  @return 1 success, <=0 failure
1395 */
1396 int isoburn_igopt_set_over_mode(struct isoburn_imgen_opts *o,
1397  int replace_dir_mode, int replace_file_mode,
1398  mode_t dir_mode, mode_t file_mode);
1399 int isoburn_igopt_get_over_mode(struct isoburn_imgen_opts *o,
1400  int *replace_dir_mode, int *replace_file_mode,
1401  mode_t *dir_mode, mode_t *file_mode);
1402 
1403 /** Set the override values values for group id and user id.
1404  The rules are like with above overriding of mode values. replace_* controls
1405  whether and how. The other two parameters provide values for eventual use.
1406  @since 0.1.0
1407  @param o The option set to work on
1408  @param replace_uid whether and how to override user ids
1409  @param replace_gid whether and how to override group ids
1410  @param uid User id to use with replace_uid == 2.
1411  @param gid Group id to use on files with replace_gid == 2.
1412  @return 1 success, <=0 failure
1413 */
1414 int isoburn_igopt_set_over_ugid(struct isoburn_imgen_opts *o,
1415  int replace_uid, int replace_gid,
1416  uid_t uid, gid_t gid);
1417 int isoburn_igopt_get_over_ugid(struct isoburn_imgen_opts *o,
1418  int *replace_uid, int *replace_gid,
1419  uid_t *uid, gid_t *gid);
1420 
1421 /** Set the charcter set to use for representing RR filenames in the image.
1422  @since 0.1.0
1423  @param o The option set to work on
1424  @param output_charset Set this to NULL to use the default output charset.
1425  For selecting a particular character set, submit its
1426  name, e.g. as listed by program iconv -l.
1427  Example: "UTF-8".
1428  @return 1 success, <=0 failure
1429 */
1430 int isoburn_igopt_set_out_charset(struct isoburn_imgen_opts *o,
1431  char *output_charset);
1432 int isoburn_igopt_get_out_charset(struct isoburn_imgen_opts *o,
1433  char **output_charset);
1434 
1435 
1436 /** The number of bytes to be used for the fifo which decouples libisofs
1437  and libburn for better throughput and for reducing the risk of
1438  interrupting signals hitting the libburn thread which operates the
1439  MMC drive.
1440  The size will be rounded up to the next full 2048.
1441  Minimum is 64kiB, maximum is 1 GiB (but that is too much anyway).
1442  @since 0.1.0
1443  @param o The option set to work on
1444  @param fifo_size Number of bytes to use
1445  @return 1 success, <=0 failure
1446 */
1447 int isoburn_igopt_set_fifo_size(struct isoburn_imgen_opts *o, int fifo_size);
1448 int isoburn_igopt_get_fifo_size(struct isoburn_imgen_opts *o, int *fifo_size);
1449 
1450 
1451 /** Obtain after image preparation the block address where the session will
1452  start on the medium.
1453  This value cannot be set by the application but only be inquired.
1454  @since 0.1.4
1455  @param o The option set to work on
1456  @param lba The block number of the session start on the medium.
1457  <0 means that no address has been determined yet.
1458  @return 1 success, <=0 failure
1459 */
1460 int isoburn_igopt_get_effective_lba(struct isoburn_imgen_opts *o, int *lba);
1461 
1462 
1463 /** Obtain after image preparation the lowest block address of file content
1464  data. Failure can occur if libisofs is too old to provide this information,
1465  if the result exceeds 31 bit, or if the call is made before image
1466  preparation.
1467  This value cannot be set by the application but only be inquired.
1468  @since 0.3.6
1469  @param o The option set to work on
1470  @param lba The block number of the session start on the medium.
1471  <0 means that no address has been determined yet.
1472  @return 1 success, <=0 failure
1473 */
1474 int isoburn_igopt_get_data_start(struct isoburn_imgen_opts *o, int *lba);
1475 
1476 
1477 /** Set resp. get parameters "name" and "timestamp" for a scdbackup checksum
1478  tag. It will be appended to the libisofs session tag if the image starts at
1479  LBA 0. See isoburn_disc_track_lba_nwa. The scdbackup tag can be used
1480  to verify the image by command scdbackup_verify $device -auto_end.
1481  See scdbackup/README appendix VERIFY for its inner details.
1482  @since 0.4.4
1483  @param o The option set to work on
1484  @param name The tag name. 80 characters max.
1485  @param timestamp A string of up to 13 characters YYMMDD.hhmmss
1486  A9 = 2009, B0 = 2010, B1 = 2011, ... C0 = 2020, ...
1487  @param tag_written Either NULL or the address of an array with at least 512
1488  characters. In the latter case the eventually produced
1489  scdbackup tag will be copied to this array when the image
1490  gets written. This call sets scdbackup_tag_written[0] = 0
1491  to mark its preliminary invalidity.
1492  @return 1 success, <=0 failure
1493  */
1494 int isoburn_igopt_set_scdbackup_tag(struct isoburn_imgen_opts *o, char *name,
1495  char *timestamp, char *tag_written);
1496 int isoburn_igopt_get_scdbackup_tag(struct isoburn_imgen_opts *o,
1497  char name[81], char timestamp[19],
1498  char **tag_written);
1499 
1500 
1501 /** Attach 32 kB of binary data which shall get written to the first 32 kB
1502  of the ISO image, the System Area.
1503  options can cause manipulations of these data before writing happens.
1504  If system area data are giveni or options bit0 is set, then bit1 of
1505  el_torito_set_isolinux_options() is automatically disabled.
1506  @since 0.5.4
1507  @param o The option set to work on
1508  @param data Either NULL or 32 kB of data. Do not submit less bytes !
1509  @param options Can cause manipulations of submitted data before they
1510  get written:
1511  bit0= apply a --protective-msdos-label as of grub-mkisofs.
1512  This means to patch bytes 446 to 512 of the system
1513  area so that one partition is defined which begins
1514  at the second 512-byte block of the image and ends
1515  where the image ends.
1516  This works with and without system_area_data.
1517  bit1= apply isohybrid MBR patching to the system area.
1518  This works only with system area data from
1519  SYSLINUX plus an ISOLINUX boot image (see
1520  iso_image_set_boot_image()) and only if not bit0
1521  is set.
1522  bit2-7= System area type
1523  0= with bit0 or bit1: MBR
1524  else: unspecified type
1525  @since 0.6.4
1526  1= MIPS Big Endian Volume Header
1527  Submit up to 15 MIPS Big Endian boot files by
1528  iso_image_add_mips_boot_file() of libisofs.
1529  This will overwrite the first 512 bytes of
1530  the submitted data.
1531  2= DEC Boot Block for MIPS Little Endian
1532  The first boot file submitted by
1533  iso_image_add_mips_boot_file() will be activated.
1534  This will overwrite the first 512 bytes of
1535  the submitted data.
1536  @since 0.6.6
1537  3= SUN Disk Label for SUN SPARC
1538  Submit up to 7 SPARC boot images by
1539  isoburn_igopt_set_partition_img() for partition
1540  numbers 2 to 8.
1541  This will overwrite the first 512 bytes of
1542  the submitted data.
1543  @since 1.3.8
1544  4= HP-PA PALO boot sector header version 4
1545  Submit all five parameters of
1546  iso_image_set_hppa_palo() as non-NULL texts.
1547  5= HP-PA PALO boot sector header version 5
1548  Submit all five parameters of
1549  iso_image_set_hppa_palo() as non-NULL texts.
1550  bit8-9= Only with System area type 0 = MBR
1551  @since 1.0.4
1552  Cylinder alignment mode eventually pads the image
1553  to make it end at a cylinder boundary.
1554  0 = auto (align if bit1)
1555  1 = always align to cylinder boundary
1556  2 = never align to cylinder boundary
1557  bit10-13= System area sub type
1558  @since 1.2.4
1559  With type 0 = MBR:
1560  Gets overridden by bit0 and bit1.
1561  0 = no particular sub type
1562  1 = CHRP: A single MBR partition of type 0x96
1563  covers the ISO image. Not compatible with
1564  any other feature which needs to have own
1565  MBR partition entries.
1566  bit14= Only with System area type 0 = MBR
1567  GRUB2 boot provisions:
1568  @since 1.3.0
1569  Patch system area at byte 0x1b0 to 0x1b7 with
1570  (512-block address + 4) of the first boot image file.
1571  Little-endian 8-byte.
1572  Should be combined with options bit0.
1573  Will not be in effect if options bit1 is set.
1574  @return 1 success, 0 no data to get, <0 failure
1575 */
1576 int isoburn_igopt_set_system_area(struct isoburn_imgen_opts *o,
1577  char data[32768], int options);
1578 int isoburn_igopt_get_system_area(struct isoburn_imgen_opts *o,
1579  char data[32768], int *options);
1580 
1581 /** Control production of a second set of volume descriptors (superblock)
1582  and directory trees, together with a partition table in the MBR where the
1583  first partition has non-zero start address and the others are zeroed.
1584  The first partition stretches to the end of the whole ISO image.
1585  The additional volume descriptor set and trees will allow to mount the
1586  ISO image at the start of the first partition, while it is still possible
1587  to mount it via the normal first volume descriptor set and tree at the
1588  start of the image resp. storage device.
1589  This makes few sense on optical media. But on USB sticks it creates a
1590  conventional partition table which makes it mountable on e.g. Linux via
1591  /dev/sdb and /dev/sdb1 alike.
1592  @since 0.6.2
1593  @param opts
1594  The option set to be manipulated.
1595  @param block_offset_2k
1596  The offset of the partition start relative to device start.
1597  This is counted in 2 kB blocks. The partition table will show the
1598  according number of 512 byte sectors.
1599  Default is 0 which causes no second set and trees.
1600  If it is not 0 then it must not be smaller than 16.
1601  @param secs_512_per_head
1602  Number of 512 byte sectors per head. 1 to 63. 0=automatic.
1603  @param heads_per_cyl
1604  Number of heads per cylinder. 1 to 255. 0=automatic.
1605  @return 1 success, <=0 failure
1606  */
1607 int isoburn_igopt_set_part_offset(struct isoburn_imgen_opts *opts,
1608  uint32_t block_offset_2k,
1609  int secs_512_per_head, int heads_per_cyl);
1610 int isoburn_igopt_get_part_offset(struct isoburn_imgen_opts *opts,
1611  uint32_t *block_offset_2k,
1612  int *secs_512_per_head, int *heads_per_cyl);
1613 
1614 
1615 /** Explicitely set the four timestamps of the emerging ISO image.
1616  Default with all parameters is 0.
1617  @since 0.5.4
1618  @param opts
1619  The option set to work on
1620  @param creation_time
1621  ECMA-119 Volume Creation Date and Time
1622  When "the information in the volume was created."
1623  A value of 0 means that the timepoint of write start is to be used.
1624  @param modification_time
1625  ECMA-119 Volume Modification Date and Time
1626  When "the informationin the volume was last modified."
1627  A value of 0 means that the timepoint of write start is to be used.
1628  @param expiration_time
1629  ECMA-119 Volume Expiration Date and Time
1630  When "the information in the volume may be regarded as obsolete."
1631  A value of 0 means that the information never shall expire.
1632  @param effective_time
1633  ECMA-119 Volume Effective Date and Time
1634  When "the information in the volume may be used."
1635  A value of 0 means that not such retention is intended.
1636  @param uuid
1637  If this text is not empty, then it overrides vol_modification_time
1638  by copying the first 16 decimal digits from uuid, eventually
1639  padding up with decimal '1', and writing a NUL-byte as timezone GMT.
1640  It should express a reasonable time in form YYYYMMDDhhmmsscc
1641  E.g.: 2010040711405800 = 7 Apr 2010 11:40:58 (+0 centiseconds)
1642  @return 1 success, <=0 failure
1643  */
1644 int isoburn_igopt_set_pvd_times(struct isoburn_imgen_opts *opts,
1645  time_t creation_time, time_t modification_time,
1646  time_t expiration_time, time_t effective_time,
1647  char *uuid);
1648 int isoburn_igopt_get_pvd_times(struct isoburn_imgen_opts *opts,
1649  time_t *creation_time, time_t *modification_time,
1650  time_t *expiration_time, time_t *effective_time,
1651  char uuid[17]);
1652 
1653 
1654 /** Associate a libjte environment object to the upcomming write run.
1655  libjte implements Jigdo Template Extraction as of Steve McIntyre and
1656  Richard Atterer.
1657  A non-NULL libjte_handle will cause failure to write if libjte was not
1658  enabled in libisofs at compile time.
1659  @since 0.6.4
1660  @param opts
1661  The option set to work on
1662  @param libjte_handle
1663  Pointer to a struct libjte_env e.g. created by libjte_new().
1664  It must stay existent from the start of image writing by
1665  isoburn_prepare_*() until the write thread has ended.
1666  E.g. until libburn indicates the end of its write run.
1667  @return 1 success, <=0 failure
1668 */
1669 int isoburn_igopt_attach_jte(struct isoburn_imgen_opts *opts,
1670  void *libjte_handle);
1671 
1672 /** Remove eventual association to a libjte environment handle.
1673  @since 0.6.4
1674  @param opts
1675  The option set to work on
1676  @param libjte_handle
1677  If not submitted as NULL, this will return the previously set
1678  libjte handle.
1679  @return 1 success, <=0 failure
1680 */
1681 int isoburn_igopt_detach_jte(struct isoburn_imgen_opts *opts,
1682  void **libjte_handle);
1683 
1684 
1685 /** Set resp. get the number of trailing zero byte blocks to be written by
1686  libisofs. The image size counter of the emerging ISO image will include
1687  them. Eventual checksums will take them into respect.
1688  They will be written immediately before the eventual image checksum area
1689  which is at the very end of the image.
1690  For a motivation see iso_write_opts_set_tail_blocks() in libisofs.h .
1691  @since 0.6.4
1692  @param opts
1693  The option set to work on
1694  @aram num_blocks
1695  Number of extra 2 kB blocks to be written by libisofs.
1696  @return 1 success, <=0 failure
1697 */
1698 int isoburn_igopt_set_tail_blocks(struct isoburn_imgen_opts *opts,
1699  uint32_t num_blocks);
1700 int isoburn_igopt_get_tail_blocks(struct isoburn_imgen_opts *opts,
1701  uint32_t *num_blocks);
1702 
1703 
1704 /** Copy a data file from the local filesystem into the emerging ISO image.
1705  Mark it by an MBR partition entry as PreP partition and also cause
1706  protective MBR partition entries before and after this partition.
1707  See libisofs.h iso_write_opts_set_prep_img().
1708  @since 1.2.4
1709  @param opts
1710  The option set to be manipulated.
1711  @param path
1712  File address in the local file system.
1713  @param flag
1714  Reserved for future usage, set to 0.
1715  @return 1 success, <=0 failure
1716 */
1717 int isoburn_igopt_set_prep_partition(struct isoburn_imgen_opts *opts,
1718  char *path, int flag);
1719 int isoburn_igopt_get_prep_partition(struct isoburn_imgen_opts *opts,
1720  char **path, int flag);
1721 
1722 /** Copy a data file from the local filesystem into the emerging ISO image.
1723  @since 1.2.4
1724  @param opts
1725  The option set to be manipulated.
1726  @param path
1727  File address in the local file system.
1728  @param flag
1729  Reserved for future usage, set to 0.
1730  @return 1 success, <=0 failure
1731 */
1732 int isoburn_igopt_set_efi_bootp(struct isoburn_imgen_opts *opts,
1733  char *path, int flag);
1734 int isoburn_igopt_get_efi_bootp(struct isoburn_imgen_opts *opts,
1735  char **path, int flag);
1736 
1737 
1738 /** Cause an arbitrary data file to be appended to the ISO image and to be
1739  described by a partition table entry in an MBR or SUN Disk Label at the
1740  start of the ISO image.
1741  The partition entry will bear the size of the image file rounded up to
1742  the next multiple of 2048 bytes.
1743  MBR or SUN Disk Label are selected by isoburn_igopt_set_system_area()
1744  system area type: 0 selects MBR partition table. 3 selects a SUN partition
1745  table with 320 kB start alignment.
1746  @since 0.6.4
1747  @param opts
1748  The option set to be manipulated.
1749  @param partition_number
1750  Depicts the partition table entry which shall describe the
1751  appended image.
1752  Range with MBR: 1 to 4. 1 will cause the whole ISO image to be
1753  unclaimable space before partition 1.
1754  @since 0.6.6
1755  Range with SUN Disk Label: 2 to 8.
1756  @param image_path
1757  File address in the local file system.
1758  With SUN Disk Label: an empty name causes the partition to become
1759  a copy of the next lower partition.
1760  @param image_type
1761  The MBR partition type. E.g. FAT12 = 0x01 , FAT16 = 0x06,
1762  Linux Native Partition = 0x83. See fdisk command L.
1763  This parameter is ignored with SUN Disk Label.
1764  @return
1765  <=0 = error, 1 = success
1766 */
1767 int isoburn_igopt_set_partition_img(struct isoburn_imgen_opts *opts,
1768  int partition_number, uint8_t partition_type,
1769  char *image_path);
1770 
1771 /** Inquire the current settings made by isoburn_igopt_set_partition_img().
1772  @since 0.6.4
1773  @param opts
1774  The option set to be inquired.
1775  @param num_entries
1776  Number of array elements in partition_types[] and image_paths[].
1777  @param partition_types
1778  The partition type associated with the partition. Valid only if
1779  image_paths[] of the same index is not NULL.
1780  @param image_paths
1781  Its elements get filled with either NULL or a pointer to a string
1782  with a file address resp. an empty text.
1783  @return
1784  <0 = error
1785  0 = no partition image set
1786  >0 highest used partition number
1787 */
1788 int isoburn_igopt_get_partition_img(struct isoburn_imgen_opts *opts,
1789  int num_entries,
1790  uint8_t partition_types[],
1791  char *image_paths[]);
1792 
1793 
1794 /** Set a name for the system area. This setting is ignored unless system area
1795  type 3 "SUN Disk Label" is in effect by iso_write_opts_set_system_area().
1796  In this case it will replace the default text at the start of the image:
1797  "CD-ROM Disc with Sun sparc boot created by libisofs"
1798  @since 0.6.6
1799  @param opts
1800  The option set to be manipulated.
1801  @param label
1802  A text of up to 128 characters.
1803  @return
1804  <=0 = error, 1 = success
1805 */
1806 int isoburn_igopt_set_disc_label(struct isoburn_imgen_opts *opts, char *label);
1807 
1808 /** Inquire the current setting made by isoburn_igopt_set_disc_label().
1809  @since 0.6.6
1810  @param opts
1811  The option set to be inquired.
1812  @param label
1813  Returns a pointer to the currently set label string.
1814  Do not alter this string.
1815  Use only as long as the opts object exists.
1816  @return
1817  <=0 = error, 1 = success
1818 */
1819 int isoburn_igopt_get_disc_label(struct isoburn_imgen_opts *opts,
1820  char **label);
1821 
1822 /** Set a serial number for the HFS+ extension of the emerging ISO image.
1823  @since 1.2.4
1824  @param opts
1825  The option set to be manipulated.
1826  @param serial_number
1827  8 bytes which should be unique to the image.
1828  If all bytes are 0, then the serial number will be generated as
1829  random number by libisofs. This is the default setting.
1830  @return
1831  <=0 = error, 1 = success
1832 */
1833 int isoburn_igopt_set_hfsp_serial_number(struct isoburn_imgen_opts *opts,
1834  uint8_t serial_number[8]);
1835 
1836 
1837 /** Inquire the current setting made by isoburn_igopt_set_disc_label()
1838  @since 1.2.4
1839  @param opts
1840  The option set to be inquired.
1841  @param serial_number
1842  Will get filled with the current setting.
1843  @return
1844  <=0 = error, 1 = success
1845 */
1846 int isoburn_igopt_get_hfsp_serial_number(struct isoburn_imgen_opts *opts,
1847  uint8_t serial_number[8]);
1848 
1849 /** Set the allocation block size for HFS+ production and the block size
1850  for layout and address unit of Apple Partition map.
1851  @since 1.2.4
1852  @param opts
1853  The option set to be manipulated.
1854  @param hfsp_block_size
1855  -1 means that this setting shall be left unchanged
1856  0 allows the automatic default setting
1857  512 and 2048 enforce a size.
1858  @param apm_block_size
1859  -1 means that this setting shall be left unchanged
1860  0 allows the automatic default setting
1861  512 and 2048 enforce a size.
1862  Size 512 cannot be combined with GPT production.
1863  Size 2048 cannot be mounted -t hfsplus by Linux kernels at least up
1864  to 2.6.32.
1865  @return
1866  <=0 = error, 1 = success
1867 */
1868 int isoburn_igopt_set_hfsp_block_size(struct isoburn_imgen_opts *opts,
1869  int hfsp_block_size, int apm_block_size);
1870 
1871 /** Inquire the current setting made by isoburn_igopt_set_hfsp_block_size
1872  @since 1.2.4
1873  @param opts
1874  The option set to be inquired.
1875  @param hfsp_block_size
1876  Will be set to a value as described above. Except -1.
1877  @param apm_block_size
1878  Will be set to a value as described above. Except -1.
1879  @return
1880  <=0 = error, 1 = success
1881 */
1882 int isoburn_igopt_get_hfsp_block_size(struct isoburn_imgen_opts *opts,
1883  int *hfsp_block_size, int *apm_block_size);
1884 
1885 
1886 /** Set or inquire the write type for the next write run on optical media.
1887  @since 1.2.4
1888  @param opts
1889  The option set to be manipulated or inquired.
1890  @param do_tao
1891  The value to be set or the variable where to return the current
1892  setting:
1893  0 = Let libburn choose according to other write parameters.
1894  This is advisable unless there are particular reasons not to
1895  use one of the two write types. Be aware that 1 and -1 can
1896  lead to failure if the write type is not appropriate for
1897  the given media situation.
1898  1 = Use BURN_WRITE_TAO which does
1899  TAO on CD, Incremental on DVD-R,
1900  no track reservation on DVD+R and BD-R
1901  -1 = Use BURN_WRITE_SAO which does
1902  SAO on CD, DAO on DVD-R,
1903  track reservation on DVD+R and BD-R
1904  @return
1905  <=0 = error, 1 = success
1906 */
1907 int isoburn_igopt_set_write_type(struct isoburn_imgen_opts *opts, int do_tao);
1908 int isoburn_igopt_get_write_type(struct isoburn_imgen_opts *opts, int *do_tao);
1909 
1910 /** Set or inquire whether a final fsync(2) is performed when updating the
1911  multi-session information of libburn stdio pseudo-drives by
1912  isoburn_activate_session().
1913  Note:
1914  fsync(2) calls during and at the end of isoburn_disc_write() are controlled
1915  by libburn call burn_write_opts_set_stdio_fsync().
1916  @since 1.2.4
1917  @param opts
1918  The option set to be manipulated or inquired.
1919  @parm do_sync
1920  1= call fsync(2) with stdio drives in isoburn_activate_session()
1921  0= do not
1922  @return
1923  <=0 = error, 1 = success
1924  */
1925 int isoburn_igopt_set_stdio_endsync(struct isoburn_imgen_opts *opts,
1926  int do_sync);
1927 int isoburn_igopt_get_stdio_endsync(struct isoburn_imgen_opts *opts,
1928  int *do_sync);
1929 
1930 /* ----------------------------------------------------------------------- */
1931 /* End of Options for image generation */
1932 /* ----------------------------------------------------------------------- */
1933 
1934 
1935 /** Frontend of libisofs call iso_conv_name_chars() controlled by
1936  struct isoburn_imgen_opts rather than IsoWriteOpts.
1937  See libisofs.h for a more detailed description.
1938  @since 1.3.6
1939  @param opts
1940  Defines options like output charset, UCS-2 versus UTF-16 for Joliet,
1941  and naming restrictions.
1942  @param name
1943  The input text which shall be converted.
1944  @param name_len
1945  The number of bytes in input text.
1946  @param result
1947  Will return the conversion result in case of success. Terminated by
1948  a trailing zero byte.
1949  Use free() to dispose it when no longer needed.
1950  @param result_len
1951  Will return the number of bytes in result (excluding trailing zero)
1952  @param flag
1953  Bitfield for control purposes.
1954  bit0-bit7= Name space
1955  0= generic (to_charset is valid,
1956  no reserved characters, no length limits)
1957  1= Rock Ridge (to_charset is valid)
1958  2= Joliet (to_charset gets overridden by UCS-2 or UTF-16)
1959  3= ECMA-119 (to_charset gets overridden by the
1960  dull ISO 9660 subset of ASCII)
1961  4= HFS+ (to_charset gets overridden by UTF-16BE)
1962  bit8= Treat input text as directory name
1963  (matters for Joliet and ECMA-119)
1964  bit9= Do not issue error messages
1965  bit15= Reverse operation (best to be done only with results of
1966  previous conversions)
1967  @return
1968  1 means success, <=0 means error
1969 */
1970 int isoburn_conv_name_chars(struct isoburn_imgen_opts *opts,
1971  char *name, size_t name_len,
1972  char **result, size_t *result_len, int flag);
1973 
1974 
1975 /** Get the image attached to a drive, if any.
1976  @since 0.1.0
1977  @param d The drive to inquire
1978  @return A reference to attached image, or NULL if the drive has no image
1979  attached. This reference needs to be released via iso_image_unref()
1980  when it is not longer needed.
1981 */
1982 IsoImage *isoburn_get_attached_image(struct burn_drive *d);
1983 
1984 /** Get the start address of the image that is attached to the drive, if any.
1985  @since 1.2.2
1986  @param d The drive to inquire
1987  @return The logical block address where the System Area of the image
1988  starts. <0 means that the address is invalid.
1989 */
1990 int isoburn_get_attached_start_lba(struct burn_drive *d);
1991 
1992 
1993 /** Load the ISO filesystem directory tree from the medium in the given drive.
1994  This will give libisoburn the base on which it can let libisofs perform
1995  image growing or image modification. The loaded volset gets attached
1996  to the drive object and handed out to the application.
1997  Not a wrapper, but peculiar to libisoburn.
1998  @since 0.1.0
1999  @param d The drive which holds an existing ISO filesystem or blank media.
2000  d is allowed to be NULL which produces an empty ISO image. In
2001  this case one has to call before writing isoburn_attach_volset()
2002  with the volset from this call and with the intended output
2003  drive.
2004  @param read_opts The read options which can be chosen by the application
2005  @param image the image read, if the disc is blank it will have no files.
2006  This reference needs to be released via iso_image_unref() when
2007  it is not longer needed. The drive, if not NULL, will hold an
2008  own reference which it will release when it gets a new volset
2009  or when it gets released via isoburn_drive_release().
2010  You can pass NULL if you already have a reference or you plan to
2011  obtain it later with isoburn_get_attached_image(). Of course, if
2012  you haven't specified a valid drive (i.e., if d == NULL), this
2013  parameter can't be NULL.
2014  @return <=0 error , 1 = success
2015 */
2016 int isoburn_read_image(struct burn_drive *d,
2017  struct isoburn_read_opts *read_opts,
2018  IsoImage **image);
2019 
2020 /** Set a callback function for producing pacifier messages during the lengthy
2021  process of image reading. The callback function and the application handle
2022  are stored until they are needed for the underlying call to libisofs.
2023  Other than with libisofs the handle is managed entirely by the application.
2024  An idle .free() function is exposed to libisofs. The handle has to stay
2025  valid until isoburn_read_image() is done. It has to be detached by
2026  isoburn_set_read_pacifier(drive, NULL, NULL);
2027  before it may be removed from memory.
2028  @since 0.1.0
2029  @param drive The drive which will be used with isoburn_read_image()
2030  It has to be acquired by an isoburn_* wrapper call.
2031  @param read_pacifier The callback function
2032  @param app_handle The app handle which the callback function can obtain
2033  via iso_image_get_attached_data() from its IsoImage*
2034  @return 1 success, <=0 failure
2035 */
2036 int isoburn_set_read_pacifier(struct burn_drive *drive,
2037  int (*read_pacifier)(IsoImage*, IsoFileSource*),
2038  void *app_handle);
2039 
2040 /** Inquire the partition offset of the loaded image. The first 512 bytes of
2041  the image get examined whether they bear an MBR signature and a first
2042  partition table entry which matches the size of the image. In this case
2043  the start address is recorded as partition offset and internal buffers
2044  get adjusted.
2045  See also isoburn_igopt_set_part_offset().
2046  @since 0.6.2
2047  @param drive The drive with the loaded image
2048  @param block_offset_2k returns the recognized partition offset
2049  @return <0 = error
2050  0 = no partition offset recognized
2051  1 = acceptable non-zero offset, buffers are adjusted
2052  2 = offset is credible but not acceptable for buffer size
2053 */
2054 int isoburn_get_img_partition_offset(struct burn_drive *drive,
2055  uint32_t *block_offset_2k);
2056 
2057 
2058 /** Set the IsoImage to be used with a drive. This eventually releases
2059  the reference to the old IsoImage attached to the drive.
2060  Caution: Use with care. It hardly makes sense to replace an image that
2061  reflects a valid ISO image on the medium.
2062  This call is rather intended for writing a newly created and populated
2063  image to blank media. The use case in xorriso is to let an image survive
2064  the change or demise of the outdev target drive.
2065  @since 0.1.0
2066  @param d The drive which shall be write target of the volset.
2067  @param image The image that represents the image to be written.
2068  This image pointer MUST already be a valid reference suitable
2069  for iso_image_unref().
2070  It may have been obtained by appropriate libisofs calls or by
2071  isoburn_read_image() with d==NULL.
2072  @return <=0 error , 1 = success
2073 */
2074 int isoburn_attach_image(struct burn_drive *d, IsoImage *image);
2075 
2076 
2077 /** Set the start address of the image that is attached to the drive, if any.
2078  @since 1.2.2
2079  @param d The drive to inquire
2080  @param lba The logical block address where the System Area of the image
2081  starts. <0 means that the address is invalid.
2082  @param flag Bitfield, submit 0 for now.
2083  @return <=0 error (e.g. because no image is attached), 1 = success
2084 */
2085 int isoburn_attach_start_lba(struct burn_drive *d, int lba, int flag);
2086 
2087 
2088 /** Return the best possible estimation of the currently available capacity of
2089  the medium. This might depend on particular write option settings and on
2090  drive state.
2091  An eventual start address for emulated multi-session will be subtracted
2092  from the capacity estimation given by burn_disc_available_space().
2093  Negative results get defaulted to 0.
2094  Wrapper for: burn_disc_available_space()
2095  @since 0.1.0
2096  @param d The drive to query.
2097  @param o If not NULL: write parameters to be set on drive before query
2098  @return number of most probably available free bytes
2099 */
2100 off_t isoburn_disc_available_space(struct burn_drive *d,
2101  struct burn_write_opts *o);
2102 
2103 
2104 /** Obtain the start block number of the most recent session on the medium. In
2105  case of random access media this will normally be 0. Successfull return is
2106  not a guarantee that there is a ISO-9660 image at all. The call will fail,
2107  nevertheless,if isoburn_disc_get_status() returns not BURN_DISC_APPENDABLE
2108  or BURN_DISC_FULL.
2109  Note: The result of this call may be fabricated by a previous call of
2110  isoburn_set_msc1() which can override the rule to load the most recent
2111  session.
2112  Wrapper for: burn_disc_get_msc1()
2113  @since 0.1.0
2114  @param d The drive to inquire
2115  @param start_lba Contains on success the start address in 2048 byte blocks
2116  @return <=0 error , 1 = success
2117 */
2118 int isoburn_disc_get_msc1(struct burn_drive *d, int *start_lba);
2119 
2120 
2121 /** Use this with trackno==0 to obtain the predicted start block number of the
2122  new session. The interesting number is returned in parameter nwa.
2123  Wrapper for: burn_disc_track_lba_nwa()
2124  @since 0.1.0
2125  @param d The drive to inquire
2126  @param o If not NULL: write parameters to be set on drive before query
2127  @param trackno Submit 0.
2128  @param lba return value: start lba
2129  @param nwa return value: Next Writeable Address
2130  @return 1=nwa is valid , 0=nwa is not valid , -1=error
2131 */
2132 int isoburn_disc_track_lba_nwa(struct burn_drive *d, struct burn_write_opts *o,
2133  int trackno, int *lba, int *nwa);
2134 
2135 
2136 /** Obtain the size which was attributed to an emulated appendable on actually
2137  overwriteable media. This value is supposed to be <= 2048 * nwa as of
2138  isoburn_disc_track_lba_nwa().
2139  @since 0.1.0
2140  @param d The drive holding the medium.
2141  @param start_byte The reply value counted in bytes, not in sectors.
2142  @param flag Unused yet. Submit 0.
2143  @return 1=stat_byte is valid, 0=not an emulated appendable, -1=error
2144 */
2145 int isoburn_get_min_start_byte(struct burn_drive *d, off_t *start_byte,
2146  int flag);
2147 
2148 
2149 /** Start production of an ISO 9660 image using the method of Growing:
2150  Create a disc object for writing the new session from the created or loaded
2151  iso_volset which has been manipulated via libisofs, to the same medium from
2152  where the image was eventually loaded.
2153  This call starts a libisofs thread which begins to produce the image.
2154  It has to be revoked by isoburn_cancel_prepared_write() if for some reason
2155  this image data stream shall not be consumed.
2156  The returned struct burn_disc is ready for use by a subsequent call to
2157  isoburn_disc_write(). After this asynchronous writing has ended and the
2158  drive is BURN_DRIVE_IDLE again, the burn_disc object has to be disposed
2159  by burn_disc_free().
2160  @since 0.1.0
2161  @param drive The combined source and target drive, grabbed with
2162  isoburn_drive_scan_and_grab(). .
2163  @param disc Returns the newly created burn_disc object.
2164  @param opts Image generation options, see isoburn_igopt_*()
2165  @return <=0 error , 1 = success
2166 */
2167 int isoburn_prepare_disc(struct burn_drive *drive, struct burn_disc **disc,
2168  struct isoburn_imgen_opts *opts);
2169 
2170 
2171 /** Start production of an ISO 9660 image using the method of Modifying:
2172  Create a disc object for producing a new image from a previous image
2173  plus the changes made by user. The generated burn_disc is suitable
2174  to be written to a grabbed drive with blank writeable medium.
2175  But you must not use the same drive for input and output, because data
2176  will be read from the source drive while at the same time the target
2177  drive is already writing.
2178  This call starts a libisofs thread which begins to produce the image.
2179  It has to be revoked by isoburn_cancel_prepared_write() if for some reason
2180  this image data stream shall not be consumed.
2181  The resulting burn_disc object has to be disposed when all its writing
2182  is done and the drive is BURN_DRIVE_IDLE again after asynchronous
2183  burn_disc_write().
2184  @since 0.1.0
2185  @param in_drive The input drive, grabbed with isoburn_drive_aquire() or
2186  one of its alternatives.
2187  @param disc Returns the newly created burn_disc object.
2188  @param opts Options for image generation and data transport to the
2189  medium.
2190  @param out_drive The output drive, from isoburn_drive_aquire() et.al..
2191  @return <=0 error , 1 = success
2192 */
2193 int isoburn_prepare_new_image(struct burn_drive *in_drive,
2194  struct burn_disc **disc,
2195  struct isoburn_imgen_opts *opts,
2196  struct burn_drive *out_drive);
2197 
2198 
2199 /** Start production of an ISO 9660 image using the method of Blind Growing:
2200  Create a disc object for writing an add-on session from the created or
2201  loaded IsoImage which has been manipulated via libisofs, to a different
2202  drive than the one from where it was loaded.
2203  Usually output will be stdio:/dev/fd/1 (i.e. stdout) being piped
2204  into some burn program like with this classic gesture:
2205  mkisofs -M $dev -C $msc1,$nwa | cdrecord -waiti dev=$dev
2206  Parameter translation into libisoburn:
2207  $dev is the address by which parameter in_drive of this call was
2208  acquired $msc1 was set by isoburn_set_msc1() before image reading
2209  or was detected from the in_drive medium
2210  $nwa is a parameter of this call
2211  or can be used as detected from the in_drive medium
2212 
2213  This call starts a libisofs thread which begins to produce the image.
2214  It has to be revoked by isoburn_cancel_prepared_write() if for some reason
2215  this image data stream shall not be consumed.
2216  This call waits for libisofs output to become available and then detaches
2217  the input drive object from the data source object by which libisofs was
2218  reading from the input drive.
2219  So, as far as libisofs is concerned, that drive may be released immediately
2220  after this call in order to allow the consumer to access the drive for
2221  writing.
2222  The consumer should wait for input to become available and only then open
2223  its burn drive. With cdrecord this is caused by option -waiti.
2224 
2225  The resulting burn_disc object has to be disposed when all its writing
2226  is done and the drive is BURN_DRIVE_IDLE again after asynchronous
2227  burn_disc_write().
2228  @since 0.2.2
2229  @param in_drive The input drive,grabbed with isoburn_drive_scan_and_grab().
2230  @param disc Returns the newly created burn_disc object.
2231  @param opts Options for image generation and data transport to media.
2232  @param out_drive The output drive, from isoburn_drive_aquire() et.al..
2233  typically stdio:/dev/fd/1 .
2234  @param nwa The address (2048 byte block count) where the add-on
2235  session will be finally stored on a mountable medium
2236  or in a mountable file.
2237  If nwa is -1 then the address is used as determined from
2238  the in_drive medium.
2239  @return <=0 error , 1 = success
2240 */
2241 int isoburn_prepare_blind_grow(struct burn_drive *in_drive,
2242  struct burn_disc **disc,
2243  struct isoburn_imgen_opts *opts,
2244  struct burn_drive *out_drive, int nwa);
2245 
2246 
2247 /**
2248  Revoke isoburn_prepare_*() instead of running isoburn_disc_write().
2249  libisofs reserves resources and maybe already starts generating the
2250  image stream when one of above three calls is performed. It is mandatory to
2251  either run isoburn_disc_write() or to revoke the preparations by the
2252  call described here.
2253  If this call returns 0 or 1 then the write thread of libisofs has ended.
2254  @since 0.1.0
2255  @param input_drive The drive resp. in_drive which was used with the
2256  preparation call.
2257  @param output_drive The out_drive used with isoburn_prepare_new_image(),
2258  NULL if none.
2259  @param flag Bitfield, submit 0 for now.
2260  bit0= -reserved for internal use-
2261  @return <0 error, 0= no pending preparations detectable, 1 = canceled
2262 */
2263 int isoburn_cancel_prepared_write(struct burn_drive *input_drive,
2264  struct burn_drive *output_drive, int flag);
2265 
2266 
2267 /**
2268  Override the truncation setting that was made with flag bit2 during the
2269  call of isoburn_drive_aquire. This applies only to stdio pseudo drives.
2270  @since 0.1.6
2271  @param drive The drive which was acquired and shall be used for writing.
2272  @param flag Bitfield controlling the setting:
2273  bit0= truncate (else do not truncate)
2274  bit1= do not warn if call is inappropriate to drive
2275  bit2= only set if truncation is currently enabled
2276  do not warn if call is inappropriate to drive
2277  @return 1 success, 0 inappropriate drive, <0 severe error
2278 */
2279 int isoburn_set_truncate(struct burn_drive *drive, int flag);
2280 
2281 
2282 /** Start writing of the new session.
2283  This call is asynchrounous. I.e. it returns quite soon and the progress has
2284  to be watched by a loop with call burn_drive_get_status() until
2285  BURN_DRIVE_IDLE is returned.
2286  Wrapper for: burn_disc_write()
2287  @since 0.1.0
2288  @param o Options which control the burn process. See burnwrite_opts_*()
2289  in libburn.h.
2290  @param disc Disc object created either by isoburn_prepare_disc() or by
2291  isoburn_prepare_new_image().
2292 */
2293 void isoburn_disc_write(struct burn_write_opts *o, struct burn_disc *disc);
2294 
2295 
2296 /** Inquire state and fill parameters of the fifo which is attached to
2297  the emerging track. This should be done in the pacifier loop while
2298  isoburn_disc_write() or burn_disc_write() are active.
2299  This works only with drives obtained by isoburn_drive_scan_and_grab()
2300  or isoburn_drive_grab(). If isoburn_prepare_new_image() was used, then
2301  parameter out_drive must have announced the track output drive.
2302  Hint: If only burn_write_opts and not burn_drive is known, then the drive
2303  can be obtained by burn_write_opts_get_drive().
2304  @since 0.1.0
2305  @param d The drive to which the track with the fifo gets burned.
2306  @param size The total size of the fifo
2307  @param free_bytes The current free capacity of the fifo
2308  @param status_text Returns a pointer to a constant text, see below
2309  @return <0 reply invalid, >=0 fifo status code:
2310  bit0+1=input status, bit2=consumption status, i.e:
2311  0="standby" : data processing not started yet
2312  1="active" : input and consumption are active
2313  2="ending" : input has ended without error
2314  3="failing" : input had error and ended,
2315  4="unused" : ( consumption has ended before processing start )
2316  5="abandoned" : consumption has ended prematurely
2317  6="ended" : consumption has ended without input error
2318  7="aborted" : consumption has ended after input error
2319 */
2320 int isoburn_get_fifo_status(struct burn_drive *d, int *size, int *free_bytes,
2321  char **status_text);
2322 
2323 
2324 /** Inquire whether the most recent write run was successful.
2325  Wrapper for: burn_drive_wrote_well()
2326  @since 0.1.0
2327  @param d The drive to inquire
2328  @return 1=burn seems to have went well, 0=burn failed
2329 */
2330 int isoburn_drive_wrote_well(struct burn_drive *d);
2331 
2332 
2333 /** Call this after isoburn_disc_write has finished and burn_drive_wrote_well()
2334  indicates success. It will eventually complete the emulation of
2335  multi-session functionality, if needed at all. Let libisoburn decide.
2336  Not a wrapper, but peculiar to libisoburn.
2337  @since 0.1.0
2338  @param d The output drive to which the session was written
2339  @return 1 success , <=0 failure
2340 */
2341 int isoburn_activate_session(struct burn_drive *d);
2342 
2343 
2344 /** Wait after normal end of operations until libisofs ended all write
2345  threads and freed resource reservations.
2346  This call is not mandatory. But without it, messages from the ending
2347  threads might appear after the application ended its write procedure.
2348  @since 0.1.0
2349  @param input_drive The drive resp. in_drive which was used with the
2350  preparation call.
2351  @param output_drive The out_drive used with isoburn_prepare_new_image(),
2352  NULL if none.
2353  @param flag Bitfield, submit 0 for now.
2354  @return <=0 error , 1 = success
2355 */
2356 int isoburn_sync_after_write(struct burn_drive *input_drive,
2357  struct burn_drive *output_drive, int flag);
2358 
2359 
2360 /** Release an acquired drive.
2361  Wrapper for: burn_drive_release()
2362  @since 0.1.0
2363  @param drive The drive to be released
2364  @param eject 1= eject medium from drive , 0= do not eject
2365 */
2366 void isoburn_drive_release(struct burn_drive *drive, int eject);
2367 
2368 
2369 /** Shutdown all three libraries.
2370  Wrapper for : iso_finish() and burn_finish().
2371  @since 0.1.0
2372 */
2373 void isoburn_finish(void);
2374 
2375 
2376 /*
2377  The following calls are for expert applications only.
2378  An application should have a special reason to use them.
2379 */
2380 
2381 
2382 /** Inquire wether the medium needs emulation or would be suitable for
2383  generic multi-session via libburn.
2384  @since 0.1.0
2385  @param d The drive to inquire
2386  @return 0 is generic multi-session
2387  1 is emulated multi-session
2388  -1 is not suitable for isoburn
2389 */
2390 int isoburn_needs_emulation(struct burn_drive *d);
2391 
2392 
2393 /* ---------------------------- Test area ----------------------------- */
2394 
2395 /* no tests active, currently */
2396 
int isoburn_attach_start_lba(struct burn_drive *d, int lba, int flag)
Set the start address of the image that is attached to the drive, if any.
void isoburn_disc_erase(struct burn_drive *drive, int fast)
Mark the medium as blank.
int isoburn_igopt_get_effective_lba(struct isoburn_imgen_opts *o, int *lba)
Obtain after image preparation the block address where the session will start on the medium...
int isoburn_set_read_pacifier(struct burn_drive *drive, int(*read_pacifier)(IsoImage *, IsoFileSource *), void *app_handle)
Set a callback function for producing pacifier messages during the lengthy process of image reading...
int isoburn_igopt_get_rr_reloc(struct isoburn_imgen_opts *o, char **name, int *flags)
Obtain the settings of isoburn_igopt_set_rr_reloc().
int isoburn_igopt_get_over_ugid(struct isoburn_imgen_opts *o, int *replace_uid, int *replace_gid, uid_t *uid, gid_t *gid)
void isoburn_drive_release(struct burn_drive *drive, int eject)
Release an acquired drive.
int isoburn_igopt_get_system_area(struct isoburn_imgen_opts *o, char data[32768], int *options)
int isoburn_sync_after_write(struct burn_drive *input_drive, struct burn_drive *output_drive, int flag)
Wait after normal end of operations until libisofs ended all write threads and freed resource reserva...
int isoburn_prepare_disc(struct burn_drive *drive, struct burn_disc **disc, struct isoburn_imgen_opts *opts)
Start production of an ISO 9660 image using the method of Growing: Create a disc object for writing t...
int isoburn_igopt_get_relaxed(struct isoburn_imgen_opts *o, int *relax)
int isoburn_igopt_get_level(struct isoburn_imgen_opts *o, int *level)
int isoburn_igopt_get_sort_files(struct isoburn_imgen_opts *o, int *value)
int isoburn_get_mount_params(struct burn_drive *d, int adr_mode, char *adr_value, int *lba, int *track, int *session, char volid[33], int flag)
Try to convert the given entity address into various entity addresses which would describe it...
void isoburn_finish(void)
Shutdown all three libraries.
int isoburn_ropt_get_default_perms(struct isoburn_read_opts *o, uid_t *uid, gid_t *gid, mode_t *mode)
int isoburn_ropt_set_data_cache(struct isoburn_read_opts *o, int cache_tiles, int tile_blocks, int flag)
Sets the size and granularity of the cache which libisoburn provides to libisofs for reading of ISO i...
void isoburn_disc_write(struct burn_write_opts *o, struct burn_disc *disc)
Start writing of the new session.
int isoburn_igopt_set_sort_files(struct isoburn_imgen_opts *o, int value)
struct isoburn_toc_session ** isoburn_toc_disc_get_sessions(struct isoburn_toc_disc *disc, int *num)
Get the array of session handles and the number of complete sessions from the table of content...
int isoburn_disc_pretend_full_uncond(struct burn_drive *drive)
Sets the medium status to BURN_DISC_FULL unconditionally.
int isoburn_activate_session(struct burn_drive *d)
Call this after isoburn_disc_write has finished and burn_drive_wrote_well() indicates success...
void isoburn_toc_disc_free(struct isoburn_toc_disc *disc)
Release the memory associated with a master handle of a medium.
int isoburn_cancel_prepared_write(struct burn_drive *input_drive, struct burn_drive *output_drive, int flag)
Revoke isoburn_prepare_*() instead of running isoburn_disc_write().
int isoburn_read_iso_head(struct burn_drive *d, int lba, int *image_blocks, char *info, int flag)
Try whether the data at the given address look like a ISO 9660 image header and obtain its alleged si...
int isoburn_drive_scan_and_grab(struct burn_drive_info *drive_infos[], char *adr, int load)
Acquire a target drive by its filesystem path resp.
enum burn_disc_status isoburn_disc_get_status(struct burn_drive *drive)
Inquire the medium status.
void isoburn_version(int *major, int *minor, int *micro)
Obtain the three release version numbers of the library.
int isoburn_igopt_set_rr_reloc(struct isoburn_imgen_opts *o, char *name, int flags)
If not isoburn_igopt_allow_deep_paths is in effect, then it may become necessary to relocate director...
int isoburn_igopt_get_over_mode(struct isoburn_imgen_opts *o, int *replace_dir_mode, int *replace_file_mode, mode_t *dir_mode, mode_t *file_mode)
int isoburn_igopt_get_pvd_times(struct isoburn_imgen_opts *opts, time_t *creation_time, time_t *modification_time, time_t *expiration_time, time_t *effective_time, char uuid[17])
int isoburn_set_msc1(struct burn_drive *d, int adr_mode, char *adr_value, int flag)
Set up isoburn_disc_get_msc1() to return a fabricated value.
int isoburn_ropt_get_data_cache(struct isoburn_read_opts *o, int *cache_tiles, int *tile_blocks, int *set_flag, int flag)
Inquire the current settings of isoburn_set_data_cache().
int isoburn_ropt_new(struct isoburn_read_opts **o, int flag)
Produces a set of image read options, initialized with default values.
int isoburn_toc_disc_get_sectors(struct isoburn_toc_disc *disc)
Tell the number of 2048 byte blocks covered by the table of content.
int isoburn_igopt_set_fifo_size(struct isoburn_imgen_opts *o, int fifo_size)
The number of bytes to be used for the fifo which decouples libisofs and libburn for better throughpu...
int isoburn_igopt_get_hfsp_block_size(struct isoburn_imgen_opts *opts, int *hfsp_block_size, int *apm_block_size)
Inquire the current setting made by isoburn_igopt_set_hfsp_block_size.
int isoburn_ropt_set_extensions(struct isoburn_read_opts *o, int ext)
int isoburn_igopt_set_hfsp_block_size(struct isoburn_imgen_opts *opts, int hfsp_block_size, int apm_block_size)
Set the allocation block size for HFS+ production and the block size for layout and address unit of A...
int isoburn_igopt_set_system_area(struct isoburn_imgen_opts *o, char data[32768], int options)
Attach 32 kB of binary data which shall get written to the first 32 kB of the ISO image...
int isoburn_initialize(char msg[1024], int flag)
Overview.
int isoburn_ropt_set_default_perms(struct isoburn_read_opts *o, uid_t uid, gid_t gid, mode_t mode)
Default attributes to use if no RockRidge extension gets loaded.
int isoburn_drive_grab(struct burn_drive *drive, int load)
Acquire a drive from the burn_drive_info[] array which was obtained by a previous call of burn_drive_...
int isoburn_igopt_get_efi_bootp(struct isoburn_imgen_opts *opts, char **path, int flag)
int isoburn_disc_get_msc1(struct burn_drive *d, int *start_lba)
Obtain the start block number of the most recent session on the medium.
off_t isoburn_disc_available_space(struct burn_drive *d, struct burn_write_opts *o)
Return the best possible estimation of the currently available capacity of the medium.
void isoburn_toc_track_get_entry(struct isoburn_toc_track *t, struct burn_toc_entry *entry)
Obtain a copy of the entry which describes a particular track.
int isoburn_igopt_set_scdbackup_tag(struct isoburn_imgen_opts *o, char *name, char *timestamp, char *tag_written)
Set resp.
int isoburn_igopt_set_tail_blocks(struct isoburn_imgen_opts *opts, uint32_t num_blocks)
Set resp.
int isoburn_attach_image(struct burn_drive *d, IsoImage *image)
Set the IsoImage to be used with a drive.
int isoburn_igopt_get_scdbackup_tag(struct isoburn_imgen_opts *o, char name[81], char timestamp[19], char **tag_written)
int isoburn_igopt_get_data_start(struct isoburn_imgen_opts *o, int *lba)
Obtain after image preparation the lowest block address of file content data.
struct isoburn_toc_disc * isoburn_toc_drive_get_disc(struct burn_drive *d)
Obtain a master handle for the table of content.
int isoburn_igopt_new(struct isoburn_imgen_opts **o, int flag)
Produces a set of generation and transfer options, initialized with default values.
int isoburn_igopt_set_untranslated_name_len(struct isoburn_imgen_opts *o, int len)
Caution: This option breaks any assumptions about names that are supported by ECMA-119 specifications...
int isoburn_ropt_get_default_dirperms(struct isoburn_read_opts *o, mode_t *mode)
int isoburn_igopt_set_relaxed(struct isoburn_imgen_opts *o, int relax)
int isoburn_igopt_set_pvd_times(struct isoburn_imgen_opts *opts, time_t creation_time, time_t modification_time, time_t expiration_time, time_t effective_time, char *uuid)
Explicitely set the four timestamps of the emerging ISO image.
int isoburn_conv_name_chars(struct isoburn_imgen_opts *opts, char *name, size_t name_len, char **result, size_t *result_len, int flag)
Frontend of libisofs call iso_conv_name_chars() controlled by struct isoburn_imgen_opts rather than I...
int isoburn_igopt_set_level(struct isoburn_imgen_opts *o, int level)
ISO level to write at.
int isoburn_ropt_get_displacement(struct isoburn_read_opts *o, uint32_t *displacement, int *displacement_sign)
int isoburn_libisofs_req(int *major, int *minor, int *micro)
The minimum compile time requirements of libisoburn towards libjte are the same as of a suitable libi...
int isoburn_set_truncate(struct burn_drive *drive, int flag)
Override the truncation setting that was made with flag bit2 during the call of isoburn_drive_aquire...
int isoburn_ropt_get_auto_incharset(struct isoburn_read_opts *o, int *mode)
int isoburn_disc_erasable(struct burn_drive *d)
Tells whether the medium can be treated by isoburn_disc_erase().
int isoburn_igopt_set_over_mode(struct isoburn_imgen_opts *o, int replace_dir_mode, int replace_file_mode, mode_t dir_mode, mode_t file_mode)
Set the override values for files and directory permissions.
int isoburn_ropt_set_displacement(struct isoburn_read_opts *o, uint32_t displacement, int displacement_sign)
Control an offset to be applied to all block address pointers in the ISO image in order to compensate...
void isoburn_toc_session_get_leadout_entry(struct isoburn_toc_session *s, struct burn_toc_entry *entry)
Obtain a copy of the entry which describes the end of a particular session.
int isoburn_igopt_set_write_type(struct isoburn_imgen_opts *opts, int do_tao)
Set or inquire the write type for the next write run on optical media.
int isoburn_ropt_get_input_charset(struct isoburn_read_opts *o, char **input_charset)
int isoburn_igopt_get_untranslated_name_len(struct isoburn_imgen_opts *o, int *len)
int isoburn_get_fifo_status(struct burn_drive *d, int *size, int *free_bytes, char **status_text)
Inquire state and fill parameters of the fifo which is attached to the emerging track.
int isoburn_igopt_get_stdio_endsync(struct isoburn_imgen_opts *opts, int *do_sync)
int isoburn_igopt_get_out_charset(struct isoburn_imgen_opts *o, char **output_charset)
int isoburn_prepare_blind_grow(struct burn_drive *in_drive, struct burn_disc **disc, struct isoburn_imgen_opts *opts, struct burn_drive *out_drive, int nwa)
Start production of an ISO 9660 image using the method of Blind Growing: Create a disc object for wri...
int isoburn_get_img_partition_offset(struct burn_drive *drive, uint32_t *block_offset_2k)
Inquire the partition offset of the loaded image.
int isoburn_igopt_set_prep_partition(struct isoburn_imgen_opts *opts, char *path, int flag)
Copy a data file from the local filesystem into the emerging ISO image.
int isoburn_igopt_get_prep_partition(struct isoburn_imgen_opts *opts, char **path, int flag)
int isoburn_drive_aquire(struct burn_drive_info *drive_infos[], char *adr, int flag)
Acquire a target drive by its filesystem path resp.
int isoburn_igopt_get_disc_label(struct isoburn_imgen_opts *opts, char **label)
Inquire the current setting made by isoburn_igopt_set_disc_label().
int isoburn_igopt_get_hfsp_serial_number(struct isoburn_imgen_opts *opts, uint8_t serial_number[8])
Inquire the current setting made by isoburn_igopt_set_disc_label()
int isoburn_ropt_get_size_what(struct isoburn_read_opts *o, uint32_t *size, int *has_what)
int isoburn_ropt_set_auto_incharset(struct isoburn_read_opts *o, int mode)
Enable or disable methods to automatically choose an input charset.
int isoburn_igopt_set_stdio_endsync(struct isoburn_imgen_opts *opts, int do_sync)
Set or inquire whether a final fsync(2) is performed when updating the multi-session information of l...
int isoburn_disc_track_lba_nwa(struct burn_drive *d, struct burn_write_opts *o, int trackno, int *lba, int *nwa)
Use this with trackno==0 to obtain the predicted start block number of the new session.
int isoburn_igopt_set_part_offset(struct isoburn_imgen_opts *opts, uint32_t block_offset_2k, int secs_512_per_head, int heads_per_cyl)
Control production of a second set of volume descriptors (superblock) and directory trees...
int isoburn_igopt_get_tail_blocks(struct isoburn_imgen_opts *opts, uint32_t *num_blocks)
int isoburn_ropt_set_input_charset(struct isoburn_read_opts *o, char *input_charset)
Set the character set for reading RR file names from ISO images.
int isoburn_needs_emulation(struct burn_drive *d)
Inquire wether the medium needs emulation or would be suitable for generic multi-session via libburn...
int isoburn_igopt_destroy(struct isoburn_imgen_opts **o, int flag)
Deletes an option set which was created by isoburn_igopt_new().
int isoburn_read_image(struct burn_drive *d, struct isoburn_read_opts *read_opts, IsoImage **image)
Load the ISO filesystem directory tree from the medium in the given drive.
int isoburn_igopt_set_efi_bootp(struct isoburn_imgen_opts *opts, char *path, int flag)
Copy a data file from the local filesystem into the emerging ISO image.
int isoburn_drive_wrote_well(struct burn_drive *d)
Inquire whether the most recent write run was successful.
int isoburn_ropt_get_extensions(struct isoburn_read_opts *o, int *ext)
int isoburn_igopt_attach_jte(struct isoburn_imgen_opts *opts, void *libjte_handle)
Associate a libjte environment object to the upcomming write run.
int isoburn_igopt_set_disc_label(struct isoburn_imgen_opts *opts, char *label)
Set a name for the system area.
int isoburn_igopt_get_fifo_size(struct isoburn_imgen_opts *o, int *fifo_size)
int isoburn_is_compatible(int major, int minor, int micro, int flag)
Check whether all features of header file libisoburn.h from the given major.minor.micro revision triple can be delivered by the library version which is performing this call.
int isoburn_igopt_set_hfsp_serial_number(struct isoburn_imgen_opts *opts, uint8_t serial_number[8])
Set a serial number for the HFS+ extension of the emerging ISO image.
int isoburn_get_min_start_byte(struct burn_drive *d, off_t *start_byte, int flag)
Obtain the size which was attributed to an emulated appendable on actually overwriteable media...
int isoburn_igopt_get_write_type(struct isoburn_imgen_opts *opts, int *do_tao)
int isoburn_igopt_get_extensions(struct isoburn_imgen_opts *o, int *ext)
int isoburn_libburn_req(int *major, int *minor, int *micro)
The minimum version of libburn to be used with this version of libisoburn at runtime.
int isoburn_igopt_get_partition_img(struct isoburn_imgen_opts *opts, int num_entries, uint8_t partition_types[], char *image_paths[])
Inquire the current settings made by isoburn_igopt_set_partition_img().
struct isoburn_toc_track ** isoburn_toc_session_get_tracks(struct isoburn_toc_session *s, int *num)
Get the array of track handles from a particular session.
int isoburn_get_attached_start_lba(struct burn_drive *d)
Get the start address of the image that is attached to the drive, if any.
int isoburn_toc_disc_get_incmpl_sess(struct isoburn_toc_disc *disc)
Obtain the number of incomplete sessions which are recorded in the result array of isoburn_toc_disc_g...
int isoburn_igopt_set_partition_img(struct isoburn_imgen_opts *opts, int partition_number, uint8_t partition_type, char *image_path)
Cause an arbitrary data file to be appended to the ISO image and to be described by a partition table...
int isoburn_libjte_req(int *major, int *minor, int *micro)
The minimum version of libjte to be used with this version of libisoburn at runtime.
int isoburn_igopt_set_out_charset(struct isoburn_imgen_opts *o, char *output_charset)
Set the charcter set to use for representing RR filenames in the image.
int isoburn_prepare_new_image(struct burn_drive *in_drive, struct burn_disc **disc, struct isoburn_imgen_opts *opts, struct burn_drive *out_drive)
Start production of an ISO 9660 image using the method of Modifying: Create a disc object for produci...
int isoburn_igopt_set_extensions(struct isoburn_imgen_opts *o, int ext)
int isoburn_toc_session_get_sectors(struct isoburn_toc_session *s)
Tell the number of 2048 byte blocks covered by a particular session.
int isoburn_igopt_get_part_offset(struct isoburn_imgen_opts *opts, uint32_t *block_offset_2k, int *secs_512_per_head, int *heads_per_cyl)
int isoburn_drive_set_msgs_submit(struct burn_drive *d, int(*msgs_submit)(void *handle, int error_code, char msg_text[], int os_errno, char severity[], int flag), void *submit_handle, int submit_flag, int flag)
Attach to a drive an application provided method for immediate delivery of messages.
int isoburn_toc_track_get_emul(struct isoburn_toc_track *t, int *start_lba, int *image_blocks, char volid[33], int flag)
Obtain eventual ISO image parameters of an emulated track.
int isoburn_igopt_detach_jte(struct isoburn_imgen_opts *opts, void **libjte_handle)
Remove eventual association to a libjte environment handle.
int isoburn_igopt_set_over_ugid(struct isoburn_imgen_opts *o, int replace_uid, int replace_gid, uid_t uid, gid_t gid)
Set the override values values for group id and user id.
int isoburn_set_msgs_submit(int(*msgs_submit)(void *handle, int error_code, char msg_text[], int os_errno, char severity[], int flag), void *submit_handle, int submit_flag, int flag)
Note: Above version numbers are also recorded in configure.ac because libtool wants them as parameter...
IsoImage * isoburn_get_attached_image(struct burn_drive *d)
Get the image attached to a drive, if any.
int isoburn_ropt_destroy(struct isoburn_read_opts **o, int flag)
Deletes an option set which was created by isoburn_ropt_new().
int isoburn_ropt_set_default_dirperms(struct isoburn_read_opts *o, mode_t mode)
Default attributes to use on directories if no RockRidge extension gets loaded.

Generated for libisoburn by  doxygen 1.8.6