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

Generated for libisoburn by  doxygen 1.8.3