libisoburn-0.2.2/libisoburn/burn_wrap.c File Reference

#include <stdio.h>
#include <ctype.h>
#include <sys/types.h>
#include <unistd.h>
#include <string.h>
#include <stdlib.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <time.h>
#include <libburn/libburn.h>
#include <libisofs/libisofs.h>
#include "libisoburn.h"
#include "isoburn.h"

Include dependency graph for burn_wrap.c:

Go to the source code of this file.

Defines

#define Isoburn_libburn_dot_h_too_olD   1

Functions

int isoburn_emulate_toc (struct burn_drive *d, int flag)
int isoburn_initialize (char msg[1024], int flag)
 Overview.
int isoburn_libisofs_req (int *major, int *minor, int *micro)
 The minimum version of libisofs to be used with this version of libisoburn at runtime.
int isoburn_libburn_req (int *major, int *minor, int *micro)
 The minimum version of libburn to be used with this version of libisoburn at runtime.
int isoburn_set_msgs_submit (int(*msgs_submit)(void *handle, int error_code, char msg_text[], int os_errno, char severity[], int flag), void *submit_handle, int submit_flag, int flag)
 Note: Above version numbers are also recorded in configure.ac because libtool wants them as parameters at build time.
int isoburn_is_intermediate_dvd_rw (struct burn_drive *d, int flag)
static int isoburn_welcome_media (struct isoburn **o, struct burn_drive *d, int flag)
 Examines the media and sets appropriate emulation if needed.
int isoburn_drive_aquire (struct burn_drive_info *drive_infos[], char *adr, int flag)
 Aquire a target drive by its filesystem path resp.
int isoburn_drive_scan_and_grab (struct burn_drive_info *drive_infos[], char *adr, int load)
 Aquire a target drive by its filesystem path resp.
int isoburn_drive_grab (struct burn_drive *drive, int load)
 Aquire a drive from the burn_drive_info[] array which was obtained by a previous call of burn_drive_scan().
int isoburn_find_emulator (struct isoburn **pt, struct burn_drive *drive, int flag)
 Retrieve media emulation and eventual isoburn emulator of drive.
enum burn_disc_status isoburn_disc_get_status (struct burn_drive *drive)
 Inquire the media status.
int isoburn_disc_erasable (struct burn_drive *d)
 Tells whether the media can be treated by isoburn_disc_erase().
void isoburn_disc_erase (struct burn_drive *drive, int fast)
 Mark the media as blank.
off_t isoburn_disc_available_space (struct burn_drive *d, struct burn_write_opts *opts)
 Return the best possible estimation of the currently available capacity of the media.
int isoburn_disc_get_msc1 (struct burn_drive *d, int *start_lba)
 Obtain the start block number of the most recent session on media.
int isoburn_disc_track_lba_nwa (struct burn_drive *d, struct burn_write_opts *opts, int trackno, int *lba, int *nwa)
 Use this with trackno==0 to obtain the predicted start block number of the new session.
int isoburn_get_msc2 (struct isoburn *o, struct burn_write_opts *opts, int *msc2, int flag)
 Obtains the image address offset to be used with image generation.
void isoburn_disc_write (struct burn_write_opts *opts, struct burn_disc *disc)
 Start writing of the new session.
void isoburn_drive_release (struct burn_drive *drive, int eject)
 Release an aquired drive.
void isoburn_finish (void)
 Shutdown all three libraries.
int isoburn_needs_emulation (struct burn_drive *drive)
 Inquire wether the media needs emulation or would be suitable for generic multi-session via libburn.
int isoburn_set_start_byte (struct isoburn *o, off_t value, int flag)
 Set the start address for an emulated add-on session.
int isoburn_get_min_start_byte (struct burn_drive *d, off_t *start_byte, int flag)
 Obtain the size which was attributed to an emulated appendable on actually overwriteable media.
int isoburn_drive_wrote_well (struct burn_drive *d)
 Inquire whether the most recent write run was successful.
int isoburn_get_fifo_status (struct burn_drive *d, int *size, int *free_bytes, char **status_text)
 Inquire state and fill parameters of the fifo which is attached to the emerging track.
int isoburn__sev_to_text (int severity, char **severity_name, int flag)
int isoburn__text_to_sev (char *severity_name, int *severity_number, int flag)
int isoburn_report_iso_error (int iso_error_code, char msg_text[], int os_errno, char min_severity[], int flag)
int isoburn_read_iso_head_parse (struct burn_drive *d, unsigned char *data, int *image_blocks, char *info, int flag)
int isoburn_read_iso_head (struct burn_drive *d, int lba, int *image_blocks, char *info, int flag)
 Try whether the data at the given address look like a ISO 9660 image header and obtain its alleged size.
int isoburn_toc_new_arrays (struct isoburn_toc_disc *o, int session_count, int track_count, int flag)
int isoburn_toc_destroy_arrays (struct isoburn_toc_disc *o, int flag)
struct isoburn_toc_discisoburn_toc_drive_get_disc (struct burn_drive *d)
 Obtain a master handle for the table of content.
int isoburn_toc_disc_get_sectors (struct isoburn_toc_disc *disc)
 Tell the number of 2048 byte blocks covered by the table of content.
struct isoburn_toc_session ** isoburn_toc_disc_get_sessions (struct isoburn_toc_disc *disc, int *num)
 Get the array of session handles from the table of content.
int isoburn_toc_session_get_sectors (struct isoburn_toc_session *s)
 Tell the number of 2048 byte blocks covered by a particular session.
int isoburn_toc_entry_finish (struct burn_toc_entry *entry, int session_no, int track_no, int flag)
void isoburn_toc_session_get_leadout_entry (struct isoburn_toc_session *s, struct burn_toc_entry *entry)
 Obtain a copy of the entry which describes the end of a particular session.
struct isoburn_toc_track ** isoburn_toc_session_get_tracks (struct isoburn_toc_session *s, int *num)
 Get the array of track handles from a particular session.
void isoburn_toc_track_get_entry (struct isoburn_toc_track *t, struct burn_toc_entry *entry)
 Obtain a copy of the entry which describes a particular itrack.
void isoburn_toc_disc_free (struct isoburn_toc_disc *d)
 Release the memory associated with a master handle of media.
int isoburn_get_track_lba (struct isoburn_toc_track *track, int *lba, int flag)
int isoburn_drive_set_msgs_submit (struct burn_drive *d, int(*msgs_submit)(void *handle, int error_code, char msg_text[], int os_errno, char severity[], int flag), void *submit_handle, int submit_flag, int flag)
 Attach to a drive an application provided method for immediate delivery of messages.
int isoburn_set_msc1 (struct burn_drive *d, int adr_mode, char *adr_value, int flag)
 Set up isoburn_disc_get_msc1() to return a fabricated value.

Variables

struct isoburnisoburn_list_start
int(* libisoburn_default_msgs_submit )(void *handle, int error_code, char msg_text[], int os_errno, char severity[], int flag)
void * libisoburn_default_msgs_submit_handle
int libisoburn_default_msgs_submit_flag


Define Documentation

#define Isoburn_libburn_dot_h_too_olD   1


Function Documentation

int isoburn__sev_to_text ( int  severity,
char **  severity_name,
int  flag 
)

Definition at line 894 of file burn_wrap.c.

Referenced by isoburn_report_iso_error().

00896 {
00897  int ret;
00898    
00899  ret= iso_sev_to_text(severity, severity_name);
00900  if(ret>0)
00901    return(ret);
00902  ret= burn_sev_to_text(severity, severity_name, 0);
00903  return(ret);
00904 }

int isoburn__text_to_sev ( char *  severity_name,
int *  severity_number,
int  flag 
)

Definition at line 907 of file burn_wrap.c.

Referenced by isoburn_report_iso_error().

00908 {
00909  int ret= 1;
00910 
00911  ret= iso_text_to_sev(severity_name, severity_number);
00912  if(ret>0)
00913    return(ret);
00914  ret= burn_text_to_sev(severity_name, severity_number, 0);
00915  return(ret);
00916 }

off_t isoburn_disc_available_space ( struct burn_drive *  d,
struct burn_write_opts *  o 
)

Return the best possible estimation of the currently available capacity of the media.

This might depend on particular write option settings and on drive state. An eventual start address for emulated multi-session will be subtracted from the capacity estimation given by burn_disc_available_space(). Negative results get defaulted to 0. Wrapper for: burn_disc_available_space()

Since:
0.1.0
Parameters:
d The drive to query.
o If not NULL: write parameters to be set on drive before query
Returns:
number of most probably available free bytes

Definition at line 539 of file burn_wrap.c.

References isoburn::emulation_mode, isoburn_disc_get_status(), isoburn_find_emulator(), and isoburn::nwa.

00541 {
00542  int ret;
00543  struct isoburn *o;
00544  struct burn_write_opts *eff_opts= NULL, *local_opts= NULL;
00545  enum burn_disc_status s;
00546  off_t avail;
00547 
00548  eff_opts= opts;
00549  ret= isoburn_find_emulator(&o, d, 0);
00550  if(ret>0 && o!=NULL)
00551    if(o->emulation_mode!=0) {
00552      s= isoburn_disc_get_status(d);
00553      if(s==BURN_DISC_FULL) /* unknown data format in first 64 kB */
00554        return((off_t) 0);
00555      local_opts= burn_write_opts_new(d);
00556      eff_opts= local_opts;
00557      burn_write_opts_set_start_byte(eff_opts, ((off_t) o->nwa) * (off_t) 2048);
00558    }
00559  avail= burn_disc_available_space(d, eff_opts);
00560  if(local_opts!=NULL)
00561    burn_write_opts_free(local_opts);
00562  local_opts= NULL;
00563  return(avail);
00564 }

int isoburn_disc_erasable ( struct burn_drive *  d  ) 

Tells whether the media can be treated by isoburn_disc_erase().

Wrapper for: burn_disc_erasable()

Since:
0.1.0
Parameters:
drive The drive to inquire.
Returns:
0=not erasable , else erasable

Definition at line 494 of file burn_wrap.c.

References isoburn::emulation_mode, and isoburn_find_emulator().

00495 {
00496  int ret;
00497  struct isoburn *o;
00498 
00499  ret= isoburn_find_emulator(&o, d, 0);
00500  if(ret>0)
00501    if(o->emulation_mode==1)
00502      return(1);
00503  return burn_disc_erasable(d);
00504 }

void isoburn_disc_erase ( struct burn_drive *  drive,
int  fast 
)

Mark the media as blank.

With multi-session media this will call burn_disc_erase(). With random access media, an eventual ISO-9660 filesystem will get invalidated by altering its start blocks on media. In case of success, the media is in status BURN_DISC_BLANK afterwards. Wrapper for: burn_disc_erase()

Since:
0.1.0
Parameters:
drive The drive with the media to erase.
fast 1=fast erase, 0=thorough erase With DVD-RW, fast erase yields media incapable of multi-session.

Definition at line 507 of file burn_wrap.c.

References isoburn::emulation_mode, isoburn_disc_get_status(), isoburn_find_emulator(), isoburn_invalidate_iso(), and Libisoburn_target_head_sizE.

00508 {
00509  int ret;
00510  struct isoburn *o;
00511  enum burn_disc_status s;
00512  char zero_buffer[Libisoburn_target_head_sizE];
00513 
00514  ret= isoburn_find_emulator(&o, drive, 0);
00515  if(ret>0) {
00516    if(o->emulation_mode==-1) {
00517      /* To cause a negative reply with burn_drive_wrote_well() */
00518      burn_drive_cancel(drive);
00519      return;
00520    }
00521    if(o->emulation_mode>0) {
00522      s= isoburn_disc_get_status(drive);
00523      if(s==BURN_DISC_FULL) { /* unknown data format in first 64 kB */
00524        memset(zero_buffer, 0, Libisoburn_target_head_sizE);
00525        ret= burn_random_access_write(drive, (off_t) 0, zero_buffer,
00526                                      (off_t) Libisoburn_target_head_sizE, 1);
00527      } else {
00528        ret= isoburn_invalidate_iso(o, 0);
00529      }
00530      if(ret<=0)
00531        burn_drive_cancel(drive); /* mark run as failure */
00532      return;
00533    }
00534  }
00535  burn_disc_erase(drive, fast);
00536 }

int isoburn_disc_get_msc1 ( struct burn_drive *  d,
int *  start_lba 
)

Obtain the start block number of the most recent session on media.

In case of random access media this will always be 0. Succesfull return is not a guarantee that there is a ISO-9660 image at all. The call will fail, nevertheless,if isoburn_disc_get_status() returns not BURN_DISC_APPENDABLE. Note: The result of this call may be fabricated by a previous call of isoburn_set_msc1() which can override the rule to load the most recent session. Wrapper for: burn_disc_get_msc1()

Since:
0.1.0
Parameters:
d The drive to inquire
start_lba Contains on success the start address in 2048 byte blocks
Returns:
<=0 error , 1 = success

Definition at line 567 of file burn_wrap.c.

References isoburn::emulation_mode, isoburn::fabricated_msc1, isoburn_disc_get_status(), isoburn_find_emulator(), and isoburn_msgs_submit().

Referenced by isoburn_read_image().

00568 {
00569  int ret;
00570  struct isoburn *o;
00571 
00572 #ifdef Hardcoded_cd_rW
00573  /* <<< A70929 : hardcoded CD-RW with fabricated -msinfo */
00574  *start_lba= Hardcoded_cd_rw_c1;
00575  return(1);
00576 #endif
00577 
00578  if(isoburn_disc_get_status(d)!=BURN_DISC_APPENDABLE &&
00579     isoburn_disc_get_status(d)!=BURN_DISC_FULL) {
00580    isoburn_msgs_submit(NULL, 0x00060000,
00581                        "Media contains no recognizable data", 0, "SORRY", 0);
00582    return(0);
00583  }
00584  ret= isoburn_find_emulator(&o, d, 0);
00585  if(ret<0)
00586    return(0);
00587  if(o->fabricated_msc1>=0) {
00588    *start_lba= o->fabricated_msc1;
00589    return(1);
00590  }
00591  if(ret>0) if(o->emulation_mode>0) {
00592    *start_lba= 0;
00593    return(1);
00594  }
00595  return(burn_disc_get_msc1(d, start_lba));
00596 }

enum burn_disc_status isoburn_disc_get_status ( struct burn_drive *  drive  ) 

Inquire the media status.

Expect the whole spectrum of libburn BURN_DISC_* with multi-session media. Emulated states with random access media are BURN_DISC_BLANK and BURN_DISC_APPENDABLE. Wrapper for: burn_disc_get_status()

Since:
0.1.0
Parameters:
drive The drive to inquire.
Returns:
The status of the drive, or what kind of disc is in it. Note: BURN_DISC_UNGRABBED indicates wrong API usage

Definition at line 471 of file burn_wrap.c.

References isoburn::emulation_mode, isoburn::fabricated_disc_status, isoburn_find_emulator(), isoburn::nwa, and isoburn::zero_nwa.

Referenced by isoburn_disc_available_space(), isoburn_disc_erase(), isoburn_disc_get_msc1(), isoburn_is_intermediate_dvd_rw(), isoburn_needs_emulation(), isoburn_prepare_disc_aux(), and isoburn_read_image().

00472 {
00473  int ret;
00474  struct isoburn *o;
00475 
00476  ret= isoburn_find_emulator(&o, drive, 0);
00477  if(ret<0)
00478    return(BURN_DISC_UNSUITABLE);
00479  if(o!=NULL)
00480    if(o->fabricated_disc_status!=BURN_DISC_UNREADY)
00481      return(o->fabricated_disc_status);
00482  if(ret==0)
00483    return(burn_disc_get_status(drive));
00484 
00485  /* emulated status */
00486  if(o->emulation_mode==-1)
00487    return(BURN_DISC_UNSUITABLE);
00488  if(o->nwa>o->zero_nwa)
00489    return(BURN_DISC_APPENDABLE);
00490  return(BURN_DISC_BLANK);
00491 }

int isoburn_disc_track_lba_nwa ( struct burn_drive *  d,
struct burn_write_opts *  o,
int  trackno,
int *  lba,
int *  nwa 
)

Use this with trackno==0 to obtain the predicted start block number of the new session.

The interesting number is returned in parameter nwa. Wrapper for: burn_disc_track_lba_nwa()

Since:
0.1.0
Parameters:
d The drive to inquire
o If not NULL: write parameters to be set on drive before query
trackno Submit 0.
lba return value: start lba
nwa return value: Next Writeable Address
Returns:
1=nwa is valid , 0=nwa is not valid , -1=error

Definition at line 599 of file burn_wrap.c.

References isoburn::emulation_mode, isoburn_find_emulator(), and isoburn::nwa.

Referenced by isoburn_get_msc2(), and isoburn_prepare_disc_aux().

00602 {
00603  int ret;
00604  struct isoburn *o;
00605 
00606 #ifdef Hardcoded_cd_rW
00607  /* <<< A70929 : hardcoded CD-RW with fabricated -msinfo */
00608  *lba= Hardcoded_cd_rw_c1;
00609  *nwa= Hardcoded_cd_rw_nwA;
00610  return(1);
00611 #endif
00612 
00613  *nwa= *lba= 0;
00614  ret= isoburn_find_emulator(&o, d, 0);
00615  if(ret<0)
00616    return(0);
00617  if(ret>0) if(o->emulation_mode>0) {
00618    *lba= 0;
00619    *nwa= o->nwa;
00620    return(1);
00621  }
00622  if(burn_drive_get_drive_role(d) != 1)
00623    return(1);
00624  return(burn_disc_track_lba_nwa(d, opts, trackno, lba, nwa));
00625 }

void isoburn_disc_write ( struct burn_write_opts *  o,
struct burn_disc *  disc 
)

Start writing of the new session.

This call is asynchrounous. I.e. it returns quite soon and the progress has to be watched by a loop with call burn_drive_get_status() until BURN_DRIVE_IDLE is returned. Wrapper for: burn_disc_write()

Since:
0.1.0
Parameters:
o Options which control the burn process. See burnwrite_opts_*() in libburn.h.
disc Disc object created either by isoburn_prepare_disc() or by isoburn_prepare_new_image().

Definition at line 645 of file burn_wrap.c.

References isoburn::emulation_mode, isoburn_find_emulator(), isoburn_is_intermediate_dvd_rw(), isoburn_msgs_submit(), isoburn::nwa, isoburn::truncate, and isoburn::wrote_well.

00646 {
00647  int ret;
00648  off_t nwa= 0;
00649  struct isoburn *o;
00650  struct burn_drive *drive;
00651  char reasons[BURN_REASONS_LEN],msg[160+BURN_REASONS_LEN];
00652  char adr[BURN_DRIVE_ADR_LEN];
00653  enum burn_write_types write_type;
00654  struct stat stbuf;
00655 
00656  drive= burn_write_opts_get_drive(opts);
00657  ret= isoburn_find_emulator(&o, drive, 0);
00658  if(ret<0)
00659    return;
00660  if(o!=NULL) {
00661    o->wrote_well= -1;
00662    if(o->emulation_mode!=0) {
00663      burn_write_opts_set_multi(opts, 0);
00664      if(o->emulation_mode>0 && o->nwa >= 0) {
00665        nwa= o->nwa;
00666 
00667        /* This caters for unwritten formatted DVD-RW. They need to be written
00668           sequentially on the first use. Only written areas are random access.
00669           If the first session is not written to LBA 0, then re-opening of
00670           formatting and padding is needed. 
00671           This can be done. But when the track gets closed after padding,
00672           this lasts a long time. There is a high risk that an app will not
00673           poll the message queue while waiting for  isoburn_disc_write()  to
00674           return. The pacifier loop usually happens only afterwards.
00675           So automatic formatting might cause a nervous clueless user.
00676        */
00677        ret= isoburn_is_intermediate_dvd_rw(drive, 0);
00678        if(ret>0 && nwa>0 && nwa <= o->zero_nwa) {
00679          /* actually this should not happen since such media get recognized
00680             by isoburn_welcome_media and o->zero_nwa gets set to 0
00681          */
00682          sprintf(msg,
00683         "DVD-RW insufficiently formatted. (Intermediate State, size unknown)");
00684          isoburn_msgs_submit(o, 0x00060000, msg, 0, "FAILURE", 0);
00685          sprintf(msg,
00686                 "It might help to first deformat it and then format it again");
00687          isoburn_msgs_submit(o, 0x00060000, msg, 0, "HINT", 0);
00688          burn_drive_cancel(drive); /* mark run as failure */
00689          return;
00690        }
00691        /* end of DVD-RW oriented check */
00692 
00693        burn_write_opts_set_start_byte(opts, nwa * (off_t) 2048);
00694      }
00695    }
00696  }
00697 
00698  write_type= burn_write_opts_auto_write_type(opts, disc, reasons, 0);
00699  if (write_type == BURN_WRITE_NONE) {
00700     sprintf(msg, "Failed to find a suitable write mode:\n%s", reasons);
00701     isoburn_msgs_submit(o, 0x00060000, msg, 0, "FAILURE", 0);
00702     if(o!=NULL)
00703       o->wrote_well= 0;
00704     /* To cause a negative reply with burn_drive_wrote_well() */
00705     burn_drive_cancel(drive);
00706     return;
00707  }
00708 
00709  sprintf(reasons, "%d", (int) write_type);
00710  sprintf(msg, "Write_type = %s\n",
00711               (write_type == BURN_WRITE_SAO ? "SAO" :
00712               (write_type == BURN_WRITE_TAO ? "TAO" : reasons)));
00713  isoburn_msgs_submit(o, 0x00060000, msg, 0, "DEBUG", 0);
00714 
00715 #ifdef Hardcoded_cd_rW
00716  /* <<< A70929 : hardcoded CD-RW with fabricated -msinfo */
00717  fprintf(stderr, "Setting write address to LBA %d\n", Hardcoded_cd_rw_nwA);
00718  burn_write_opts_set_start_byte(opts,
00719                  ((off_t) Hardcoded_cd_rw_nwA) * (off_t) 2048);
00720 #endif
00721 
00722  if(o->truncate) {
00723    ret= burn_drive_get_drive_role(drive);
00724    if(ret==2) {
00725      ret= burn_drive_d_get_adr(drive, adr);
00726      if(ret>0) {
00727        ret= lstat(adr, &stbuf);
00728        if(ret!=-1)
00729          if(S_ISREG(stbuf.st_mode))
00730            truncate(adr, nwa * (off_t) 2048);
00731      }
00732    }
00733  }
00734 
00735  burn_disc_write(opts, disc);
00736 }

int isoburn_drive_aquire ( struct burn_drive_info *  drive_infos[],
char *  adr,
int  flag 
)

Aquire a target drive by its filesystem path resp.

Parameters:
flag bit0= load bit1= regard overwriteable media as blank bit2= if the drive is a regular disk file: truncate it to the write start address bit3= if the drive reports a -ROM profile then try to read table of content by scanning for ISO image headers. (depending on media type and drive state this might help or it might make the resulting toc even worse)

Definition at line 377 of file burn_wrap.c.

References isoburn::drive, isoburn_destroy(), isoburn_find_emulator(), isoburn_msgs_submit(), isoburn_welcome_media(), and isoburn::truncate.

Referenced by isoburn_drive_scan_and_grab().

00379 {
00380  int ret, conv_ret, drive_grabbed= 0;
00381  char libburn_drive_adr[BURN_DRIVE_ADR_LEN];
00382  struct isoburn *o= NULL;
00383  char msg[BURN_MSGS_MESSAGE_LEN+4096];
00384 
00385  conv_ret= burn_drive_convert_fs_adr(adr, libburn_drive_adr);
00386  if(conv_ret<=0) {
00387    sprintf(msg, "Unsuitable drive address: '%s'\n",adr);
00388    msg[BURN_MSGS_MESSAGE_LEN-1]= 0;
00389    isoburn_msgs_submit(NULL, 0x00060000, msg, 0, "FAILURE", 0);
00390    ret= 0; goto ex;
00391  }
00392 
00393  ret= burn_drive_scan_and_grab(drive_infos, libburn_drive_adr, flag&1);
00394  if(ret<=0)
00395    goto ex;
00396  drive_grabbed= 1;
00397  ret= isoburn_welcome_media(&o, (*drive_infos)[0].drive,
00398                             (flag&8) | !!(flag&2));
00399  if(ret<=0)
00400    goto ex;
00401 
00402  if(flag&4) {
00403    ret= isoburn_find_emulator(&o, (*drive_infos)[0].drive, 0);
00404    if(ret>0 && o!=NULL)
00405      o->truncate= 1;
00406  }
00407 
00408  ret= 1;
00409 ex:
00410  if(ret<=0) {
00411    if(drive_grabbed)
00412      burn_drive_release((*drive_infos)[0].drive, 0);
00413    isoburn_destroy(&o, 0);
00414  }
00415  return(ret);
00416 }

int isoburn_drive_grab ( struct burn_drive *  drive,
int  load 
)

Aquire a drive from the burn_drive_info[] array which was obtained by a previous call of burn_drive_scan().

Wrapper for: burn_drive_grab()

Since:
0.1.0
Parameters:
drive The drive to grab. E.g. drive_infos[1].drive .
load 1 attempt to load the disc tray. 0 no attempt, rather failure.
Returns:
1 success, <=0 failure

Definition at line 429 of file burn_wrap.c.

References isoburn_destroy(), and isoburn_welcome_media().

00430 {
00431  int ret;
00432  struct isoburn *o= NULL;
00433 
00434  ret= burn_drive_grab(drive, load);
00435  if(ret<=0)
00436    goto ex;
00437  ret= isoburn_welcome_media(&o, drive, 0);
00438  if(ret<=0)
00439    goto ex;
00440  
00441  ret= 1;
00442 ex:
00443  if(ret<=0)
00444    isoburn_destroy(&o,0);
00445  return(ret);
00446 }

void isoburn_drive_release ( struct burn_drive *  drive,
int  eject 
)

Release an aquired drive.

Wrapper for: burn_drive_release()

Since:
0.1.0
Parameters:
drive The drive to be released
eject 1= eject media from drive , 0= do not eject

Definition at line 739 of file burn_wrap.c.

References isoburn_destroy(), and isoburn_find_emulator().

00740 {
00741  int ret;
00742  struct isoburn *o;
00743 
00744  ret= isoburn_find_emulator(&o, drive, 0);
00745  if(ret<0)
00746    return;
00747  if(o!=NULL) {
00748    isoburn_destroy(&o, 0);
00749  }
00750  burn_drive_release(drive, eject);
00751 }

int isoburn_drive_scan_and_grab ( struct burn_drive_info *  drive_infos[],
char *  adr,
int  load 
)

Aquire a target drive by its filesystem path resp.

libburn persistent address. Wrapper for: burn_drive_scan_and_grab()

Since:
0.1.0
Parameters:
drive_infos On success returns a one element array with the drive (cdrom/burner). Thus use with driveno 0 only. On failure the array has no valid elements at all. The returned array should be freed via burn_drive_info_free() when the drive is no longer needed.
adr The persistent address of the desired drive.
load 1 attempt to load the disc tray. 0 no attempt,rather failure.
Returns:
1 = success , 0 = drive not found , <0 = other error

Definition at line 419 of file burn_wrap.c.

References isoburn_drive_aquire().

00421 {
00422  int ret;
00423 
00424  ret= isoburn_drive_aquire(drive_infos, adr, !!load);
00425  return(ret);
00426 }

int isoburn_drive_set_msgs_submit ( struct burn_drive *  d,
int(*)(void *handle, int error_code, char msg_text[], int os_errno, char severity[], int flag)  msgs_submit,
void *  submit_handle,
int  submit_flag,
int  flag 
)

Attach to a drive an application provided method for immediate delivery of messages.

If no method is set or if the method is set to NULL then libisoburn delivers messages of the drive through the global msgs_submit() method set by isoburn_set_msgs_submiti() or by the message queue of libburn.

Since:
0.2.0
Parameters:
d The drive to which this function, handle and flag shall apply
msgs_submit The function call which implements the method
submit_handle Handle to be used as first argument of msgs_submit
submit_flag Flag to be used as last argument of msgs_submit
flag Unused yet, submit 0

Definition at line 1433 of file burn_wrap.c.

References isoburn_find_emulator(), isoburn::msgs_submit, isoburn::msgs_submit_flag, and isoburn::msgs_submit_handle.

01438 {
01439  struct isoburn *o;
01440  int ret;
01441 
01442  ret= isoburn_find_emulator(&o, d, 0);
01443  if(ret<0 || o==NULL)
01444    return(-1);
01445  o->msgs_submit= msgs_submit;
01446  o->msgs_submit_handle= submit_handle;
01447  o->msgs_submit_flag= submit_flag;
01448  return(1);
01449 }

int isoburn_drive_wrote_well ( struct burn_drive *  d  ) 

Inquire whether the most recent write run was successful.

Wrapper for: burn_drive_wrote_well()

Since:
0.1.0
Parameters:
d The drive to inquire
Returns:
1=burn seems to have went well, 0=burn failed

Definition at line 830 of file burn_wrap.c.

References isoburn_find_emulator(), and isoburn::wrote_well.

00831 {
00832  int ret;
00833  struct isoburn *o;
00834  
00835  ret= isoburn_find_emulator(&o, d, 0);
00836  if(ret<0)
00837    return(-1);
00838  if(o!=NULL)
00839    if(o->wrote_well>=0)
00840      return(o->wrote_well);
00841  ret= burn_drive_wrote_well(d);
00842  return ret;
00843 }

int isoburn_emulate_toc ( struct burn_drive *  d,
int  flag 
)

Definition at line 1036 of file burn_wrap.c.

References isoburn::emulation_mode, isoburn_find_emulator(), isoburn_msgs_submit(), isoburn_read_iso_head(), isoburn_toc_entry_destroy(), isoburn_toc_entry_new(), Libisoburn_nwa_alignemenT, Libisoburn_overwriteable_starT, Libisoburn_toc_scan_max_gaP, isoburn_toc_entry::session, isoburn_toc_entry::start_lba, isoburn::toc, isoburn_toc_entry::track_blocks, and isoburn_toc_entry::track_no.

Referenced by isoburn_welcome_media().

01037 {
01038  int ret, image_size= 0, lba, track_blocks, session_count= 0, read_flag= 0;
01039  int scan_start= 0, scan_count= 0, probe_minus_16= 0, growisofs_nwa;
01040  struct isoburn *o;
01041  struct isoburn_toc_entry *item;
01042  char msg[160], size_text[80], *sev;
01043  time_t start_time, last_pacifier, now;
01044  
01045  /* is the media emulated multi-session ? */
01046  ret= isoburn_find_emulator(&o, d, 0);
01047  if(ret<0)
01048    return(-1);
01049  if(o==NULL)
01050    return(-1);
01051  if(o->emulation_mode<=0 && !(flag&1))
01052    return(0);
01053 
01054  start_time= last_pacifier= time(NULL);
01055  lba= 0;
01056  if(!(flag&2)) {
01057    ret= isoburn_read_iso_head(d, lba, &image_size, NULL, 0);
01058    if(ret<=0)
01059      {ret= 0; goto failure;}
01060    lba= Libisoburn_overwriteable_starT;
01061  }
01062  while(lba<image_size || (flag&2)) {
01063    now= time(NULL);
01064    if(now - last_pacifier >= 5) {
01065      last_pacifier= now;
01066      if(scan_count>=10*512)
01067        sprintf(size_text, "%.f MB", ((double) scan_count) / 512.0);
01068      else
01069        sprintf(size_text, "%.f MB", 2 * (double) scan_count);
01070      sprintf(msg, "Found %d ISO sessions by scanning %s in %.f seconds",
01071              session_count, size_text, (double) (now - start_time));
01072      isoburn_msgs_submit(o, 0x00060000, msg, 0, "UPDATE", 0);
01073    }
01074    read_flag= 0;
01075    if(flag&2)
01076      read_flag|= (1<<15)|((session_count>0)<<14);
01077    else {
01078 
01079      /* growisofs aligns to 16 rather than 32. Overwriteable TOC emulation
01080         relies on not accidentially seeing inter-session trash data.
01081         But one can safely access 16 blocks earlier because a xorriso header
01082         would have overwritten with the unused 16 blocks at its start.
01083         If libisoburn alignment would increase, then this would not be
01084         possible any more.
01085      */
01086 
01087      if(probe_minus_16)
01088        read_flag|= (1<<14);
01089      probe_minus_16= 0;
01090    }
01091 
01092    ret= isoburn_read_iso_head(d, lba, &track_blocks, NULL, read_flag);
01093    if(ret<=0) {
01094      if(session_count>0) {
01095        if(flag&2) {
01096          if(ret==0) {
01097            /* try at next 64 k block (check both 32 k halves) */
01098            lba+= 32;
01099            scan_count+= 32;
01100            if(lba-scan_start <= Libisoburn_toc_scan_max_gaP)
01101  continue;
01102          }
01103  break;
01104        }
01105        sprintf(msg,
01106                "Chain of ISO session headers broken at #%d, LBA %ds",
01107                session_count+1, lba);
01108        isoburn_msgs_submit(o, 0x00060000, msg, 0, "WARNING", 0);
01109      }
01110      {ret= 0; goto failure;}
01111    }
01112    if(ret==2) /* ISO header was found in first half block */
01113      lba-= 16;
01114    ret= isoburn_toc_entry_new(&item, o->toc, 0);
01115    if(ret<=0) {
01116      isoburn_msgs_submit(o, 0x00060000,
01117                          "Not enough memory for emulated TOC entry object",
01118                          0, "FATAL", 0);
01119      ret= -1; goto failure;
01120    }
01121    if(o->toc==NULL)
01122      o->toc= item;
01123    session_count++;
01124    scan_count+= 32;
01125    item->session= session_count;
01126    item->track_no= session_count;
01127    item->start_lba= lba;
01128    item->track_blocks= track_blocks;
01129    lba+= track_blocks;
01130 
01131    /* growisofs aligns to 16 rather than 32 */
01132    growisofs_nwa= lba;
01133    if(growisofs_nwa % 16)
01134      growisofs_nwa+= 16 - (growisofs_nwa % 16);
01135    if(lba % Libisoburn_nwa_alignemenT)
01136      lba+= Libisoburn_nwa_alignemenT - (lba % Libisoburn_nwa_alignemenT);
01137    scan_start= lba;
01138    if(lba - growisofs_nwa == 16)
01139      probe_minus_16= 1;
01140  }
01141  if(last_pacifier != start_time)
01142    sev= "UPDATE";
01143  else
01144    sev= "DEBUG";
01145  now= time(NULL);
01146  if(scan_count>=10*512)
01147    sprintf(size_text, "%.f MB", ((double) scan_count) / 512.0);
01148  else
01149    sprintf(size_text, "%.f kB", 2 * (double) scan_count);
01150  sprintf(msg, "Found %d ISO sessions by scanning %s in %.f seconds",
01151          session_count, size_text, (double) (now - start_time));
01152  isoburn_msgs_submit(o, 0x00060000, msg, 0, sev, 0);
01153  return(1);
01154 failure:;
01155  isoburn_toc_entry_destroy(&(o->toc), 1);
01156  return(ret);
01157 }

int isoburn_find_emulator ( struct isoburn **  pt,
struct burn_drive *  drive,
int  flag 
)

Retrieve media emulation and eventual isoburn emulator of drive.

Get an eventual isoburn object which is wrapped around the drive.

Returns:
-1 unsuitable media, 0 generic media, 1 emulated media.

Definition at line 452 of file burn_wrap.c.

References isoburn_find_by_drive(), and isoburn_msgs_submit().

Referenced by isoburn_activate_session(), isoburn_attach_image(), isoburn_cancel_prepared_write(), isoburn_disc_available_space(), isoburn_disc_erasable(), isoburn_disc_erase(), isoburn_disc_get_msc1(), isoburn_disc_get_status(), isoburn_disc_track_lba_nwa(), isoburn_disc_write(), isoburn_drive_aquire(), isoburn_drive_release(), isoburn_drive_set_msgs_submit(), isoburn_drive_wrote_well(), isoburn_emulate_toc(), isoburn_get_attached_image(), isoburn_get_fifo_status(), isoburn_get_min_start_byte(), isoburn_needs_emulation(), isoburn_prepare_blind_grow(), isoburn_prepare_disc_aux(), isoburn_read_image(), isoburn_set_msc1(), isoburn_set_read_pacifier(), and isoburn_toc_drive_get_disc().

00454 {
00455  int ret;
00456 
00457  ret= isoburn_find_by_drive(pt, drive, 0);
00458  if(ret<=0)
00459    return(0);
00460  if((*pt)->emulation_mode==-1) {
00461    isoburn_msgs_submit(*pt, 0x00060000,
00462                     "Unsuitable drive and media state", 0, "FAILURE", 0);
00463    return(-1);
00464  }
00465  if((*pt)->emulation_mode==0)
00466    return(0);
00467  return(1);
00468 } 

void isoburn_finish ( void   ) 

Shutdown all three libraries.

Wrapper for : iso_finish() and burn_finish().

Since:
0.1.0

Definition at line 754 of file burn_wrap.c.

References isoburn_destroy_all().

00755 {
00756  isoburn_destroy_all(&isoburn_list_start, 0);
00757  burn_finish();
00758  iso_finish();
00759 }

int isoburn_get_fifo_status ( struct burn_drive *  d,
int *  size,
int *  free_bytes,
char **  status_text 
)

Inquire state and fill parameters of the fifo which is attached to the emerging track.

This should be done in the pacifier loop while isoburn_disc_write() or burn_disc_write() are active. This works only with drives obtained by isoburn_drive_scan_and_grab() or isoburn_drive_grab(). If isoburn_prepare_new_image() was used, then parameter out_drive must have announced the track output drive. Hint: If only burn_write_opts and not burn_drive is known, then the drive can be obtained by burn_write_opts_get_drive().

Since:
0.1.0 d The drive to which the track with the fifo gets burned.
Parameters:
size The total size of the fifo
free_bytes The current free capacity of the fifo
status_text Returns a pointer to a constant text, see below
Returns:
<0 reply invalid, >=0 fifo status code: bit0+1=input status, bit2=consumption status, i.e: 0="standby" : data processing not started yet 1="active" : input and consumption are active 2="ending" : input has ended without error 3="failing" : input had error and ended, 4="unused" : ( consumption has ended before processing start ) 5="abandoned" : consumption has ended prematurely 6="ended" : consumption has ended without input error 7="aborted" : consumption has ended after input error

Definition at line 846 of file burn_wrap.c.

References isoburn::iso_source, and isoburn_find_emulator().

00848 {
00849  int ret;
00850  struct isoburn *o;
00851  size_t hsize= 0, hfree_bytes= 0;
00852 
00853  ret= isoburn_find_emulator(&o, d, 0);
00854  if(ret<0)
00855    return(-1);
00856 
00857  if(o==NULL)
00858    return(-1);
00859  if(o->iso_source==NULL)
00860    return(-1);
00861  ret= iso_ring_buffer_get_status(o->iso_source, &hsize, &hfree_bytes);
00862  if(hsize > 1024*1024*1024)
00863    *size= 1024*1024*1024;
00864  else
00865    *size= hsize;
00866  if(hfree_bytes > 1024*1024*1024)
00867    *free_bytes= 1024*1024*1024;
00868  else
00869    *free_bytes= hfree_bytes;
00870  *status_text= "";
00871  if(ret==0)
00872    *status_text= "standby";
00873  else if(ret==1)
00874    *status_text= "active";
00875  else if(ret==2)
00876    *status_text= "ending";
00877  else if(ret==3)
00878    *status_text= "failing";
00879  else if(ret==4)
00880    *status_text= "unused";
00881  else if(ret==5)
00882    *status_text= "abandoned";
00883  else if(ret==6)
00884    *status_text= "ended";
00885  else if(ret==7)
00886    *status_text= "aborted";
00887  return(ret);
00888 }

int isoburn_get_min_start_byte ( struct burn_drive *  d,
off_t *  start_byte,
int  flag 
)

Obtain the size which was attributed to an emulated appendable on actually overwriteable media.

This value is supposed to be <= 2048 * nwa as of isoburn_disc_track_lba_nwa().

Since:
0.1.0
Parameters:
drive The drive holding the media.
start_byte The reply value counted in bytes, not in sectors.
flag Unused yet. Submit 0.
Returns:
1=stat_byte is valid, 0=not an emulated appendable, -1=error

Definition at line 812 of file burn_wrap.c.

References isoburn_find_emulator(), and isoburn::min_start_byte.

00814 {
00815  int ret;
00816  struct isoburn *o;
00817 
00818  ret= isoburn_find_emulator(&o, d, 0);
00819  if(ret<0)
00820    return(-1);
00821  if(ret==0) 
00822    return(0);
00823  *start_byte= o->min_start_byte;
00824  if(o->min_start_byte<=0)
00825    return(0);
00826  return(1);
00827 }

int isoburn_get_msc2 ( struct isoburn o,
struct burn_write_opts *  opts,
int *  msc2,
int  flag 
)

Obtains the image address offset to be used with image generation.

This is either the (emulated) drive nwa or a value set by isoburn_prepare_blind_grow(). In any case this is the address to tell to iso_write_opts_set_ms_block().

Parameters:
o The isoburn object to be inquired
opts If not NULL: write parameters to be set on drive before query
msc2 The value to be used with iso_write_opts_set_ms_block()
flag unused yet
Returns:
<=0 is failure , >0 success

Definition at line 628 of file burn_wrap.c.

References isoburn::drive, isoburn::fabricated_msc2, isoburn_disc_track_lba_nwa(), and isoburn::nwa.

Referenced by isoburn_prepare_disc_aux().

00630 {
00631  int ret, lba, nwa;
00632 
00633  if(o->fabricated_msc2>=0)
00634    *msc2= o->fabricated_msc2;
00635  else {
00636    ret= isoburn_disc_track_lba_nwa(o->drive, opts, 0, &lba, &nwa);
00637    if(ret<=0)
00638      return(ret);
00639    *msc2= nwa;
00640  }
00641  return(1);
00642 }

int isoburn_get_track_lba ( struct isoburn_toc_track track,
int *  lba,
int  flag 
)

Definition at line 1420 of file burn_wrap.c.

References isoburn_toc_track_get_entry().

Referenced by isoburn_set_msc1().

01421 {
01422  struct burn_toc_entry entry;
01423 
01424  isoburn_toc_track_get_entry(track, &entry);
01425  if (entry.extensions_valid & 1)
01426    *lba= entry.start_lba;
01427  else
01428    *lba= burn_msf_to_lba(entry.pmin, entry.psec, entry.pframe);
01429  return(1);
01430 }

int isoburn_initialize ( char  msg[1024],
int  flag 
)

Overview.

libisoburn is a frontend for libraries libburn and libisofs which enables creation and expansion of ISO-9660 filesystems on all CD/DVD media supported by libburn. This includes media like DVD+RW, which do not support multi-session management on media level and even plain disk files or block devices.

The price for that is thorough specialization on data files in ISO-9660 filesystem images. So libisoburn is not suitable for audio (CD-DA) or any other CD layout which does not entirely consist of ISO-9660 sessions.

Connector functions

libisofs and libburn do not depend on each other but share some interfaces by which they can cooperate. libisoburn establishes the connection between both modules by creating the necessary interface objects and attaching them to the right places.

Wrapper functions

The priciple of this frontend is that you may use any call of libisofs or libburn unless it has a isoburn_*() wrapper listed in the following function documentation.

E.g. call isoburn_initialize() rather than iso_init(); burn_initialize(); and call isoburn_drive_scan_and_grab() rather than burn_drive_scan_and_grab(). But you may call burn_disc_get_profile() directly if you want to display the media type.

The wrappers will transparently provide the necessary emulations which are appropriate for particular target drives and media states. To learn about them you have to read both API descriptions: the one of the wrapper and the one of the underlying libburn or libisofs call.

Macros BURN_* and functions burn_*() are documented in <libburn/libburn.h> Macros ISO_* and functions iso_*() are documented in <libisofs/libisofs.h>

Usage model

There may be an input drive and an output drive. Either of them may be missing with the consequence that no reading resp. writing is possible. Both drive roles can be fulfilled by the same drive.

Input can be a random access readable libburn drive: optical media, regular files, block devices. Output can be any writeable libburn drive: writeable optical media in burner, writeable file objects (no directories).

libburn demands rw-permissions to drive device file resp. file object.

If the input drive provides a suitable ISO RockRidge image, then its tree may be loaded into memory and can then be manipulated by libisofs API calls. The loading is done by isoburn_read_image() under control of struct isoburn_read_opts which the application obtains from libisoburn and manipulates by the family of isoburn_ropt_set_*() functions.

Writing of result images is controlled by libisofs related parameters in a struct isoburn_imgen_opts which the application obtains from libisoburn and manipulates by the family of isoburn_igopt_set_*() functions.

All multi-session aspects are handled by libisoburn according to these settings. The application does not have to analyze media state and write job parameters. It rather states its desires which libisoburn tries to fulfill, or else will refuse to start the write run.

Setup for Growing, Modifying or Blind Growing

The connector function family offers alternative API calls for performing the setup for several alternative image generation strategies.

Growing: If input and output drive are the same, then isoburn_prepare_disc() is to be used. It will lead to an add-on session on appendable or overwriteable media with existing ISO image. With blank media it will produce a first session.

Modifying: If the output drive is not the input drive, and if it bears blank media or overwriteable without a valid ISO image, then one may produce a consolidated image with old and new data. This will copy file data from an eventual input drive with valid image, add any newly introduced data from the local filesystem, and produce a first session on output media. To prepare for such an image generation run, use isoburn_prepare_new_image().

Blind Growing: This method reads the old image from one drive and writes the add-on session to a different drive. That output drive is nevertheless supposed to finally lead to the same media from where the session was loaded. Usually it will be stdio:/dev/fd/1 (i.e. stdout) being piped into some burn program like with this classic gesture: mkisofs -M $dev -C $msc1,$nwa | cdrecord -waiti dev=$dev Blind growing is prepared by the call isoburn_prepare_blind_grow(). The input drive should be released immediately after this call in order to allow the consumer of the output stream to access that drive for writing.

After either of these setups, some peripheral libburn drive parameter settings like burn_write_opts_set_simulate(), burn_write_opts_set_multi(), burn_drive_set_speed(), burn_write_opts_set_underrun_proof() should be made. Do not set the write mode. It will be chosen by libisoburn so it matches job and media state.

Writing the image

Then one may start image generation and write threads by isoburn_disc_write(). Progress may be watched at the output drive by burn_drive_get_status() and isoburn_get_fifo_status().

At some time, the output drive will be BURN_DRIVE_IDLE indicating that writing has ended. One should inquire isoburn_drive_wrote_well() to learn about overall success.

Finally one must call isoburn_activate_session() which will complete any eventual multi-session emulation. Initialize libisoburn, libisofs and libburn. Wrapper for : iso_init() and burn_initialize()

Since:
0.1.0
Parameters:
msg A character array for eventual messages (e.g. with errors)
flag Bitfield for control purposes (unused yet, submit 0)
Returns:
1 indicates success, 0 is failure

Definition at line 64 of file burn_wrap.c.

References isoburn_destroy_all(), isoburn_libisofs_req_major, isoburn_libisofs_req_micro, isoburn_libisofs_req_minor, and isoburn_version().

00065 {
00066  int major, minor, micro, bad_match= 0;
00067 
00068 
00069 /* First two ugly compile time checks for header version compatibility.
00070    If everthing matches, then they produce no C code. In case of mismatch,
00071    intentionally faulty C code will be inserted.
00072 */
00073 
00074 #ifdef iso_lib_header_version_major
00075 /* The minimum requirement of libisoburn towards the libisofs header
00076    at compile time is defined in libisoburn/libisoburn.h :
00077      isoburn_libisofs_req_major
00078      isoburn_libisofs_req_minor
00079      isoburn_libisofs_req_micro
00080    It gets compared against the version macros in libisofs/libisofs.h :
00081      iso_lib_header_version_major
00082      iso_lib_header_version_minor
00083      iso_lib_header_version_micro
00084    If the header is too old then the following code shall cause failure of
00085    cdrskin compilation rather than to allow production of a program with
00086    unpredictable bugs or memory corruption.
00087    The compiler messages supposed to appear in this case are:
00088       error: 'LIBISOFS_MISCONFIGURATION' undeclared (first use in this function)
00089       error: 'INTENTIONAL_ABORT_OF_COMPILATION__HEADERFILE_libisofs_dot_h_TOO_OLD__SEE_libisoburn_dot_h_and_burn_wrap_dot_h' undeclared (first use in this function)
00090       error: 'LIBISOFS_MISCONFIGURATION_' undeclared (first use in this function)
00091 */
00092 /* The indendation is an advise of man gcc to help old compilers ignoring */
00093  #if isoburn_libisofs_req_major > iso_lib_header_version_major
00094  #define Isoburn_libisofs_dot_h_too_olD 1
00095  #endif
00096  #if isoburn_libisofs_req_major == iso_lib_header_version_major && isoburn_libisofs_req_minor > iso_lib_header_version_minor
00097  #define Isoburn_libisofs_dot_h_too_olD 1
00098  #endif
00099  #if isoburn_libisofs_req_minor == iso_lib_header_version_minor && isoburn_libisofs_req_micro > iso_lib_header_version_micro
00100  #define Isoburn_libisofs_dot_h_too_olD 1
00101  #endif
00102 
00103 #ifdef Isoburn_libisofs_dot_h_too_olD
00104 LIBISOFS_MISCONFIGURATION = 0;
00105 INTENTIONAL_ABORT_OF_COMPILATION__HEADERFILE_libisofs_dot_h_TOO_OLD__SEE_libisoburn_dot_h_and_burn_wrap_dot_h = 0;
00106 LIBISOFS_MISCONFIGURATION_ = 0;
00107 #endif
00108 
00109 #endif /* iso_lib_header_version_major */
00110 
00111 /* The minimum requirement of libisoburn towards the libburn header
00112    at compile time is defined in libisoburn/libisoburn.h :
00113      isoburn_libburn_req_major
00114      isoburn_libburn_req_minor
00115      isoburn_libburn_req_micro
00116    It gets compared against the version macros in libburn/libburn.h :
00117      burn_header_version_major
00118      burn_header_version_minor
00119      burn_header_version_micro
00120    If the header is too old then the following code shall cause failure of
00121    cdrskin compilation rather than to allow production of a program with
00122    unpredictable bugs or memory corruption.
00123    The compiler messages supposed to appear in this case are:
00124       error: 'LIBBURN_MISCONFIGURATION' undeclared (first use in this function)
00125       error: 'INTENTIONAL_ABORT_OF_COMPILATION__HEADERFILE_libburn_dot_h_TOO_OLD__SEE_libisoburn_dot_h_and_burn_wrap_dot_h' undeclared (first use in this function)
00126       error: 'LIBBURN_MISCONFIGURATION_' undeclared (first use in this function)
00127 */
00128 
00129 /* The indendation is an advise of man gcc to help old compilers ignoring */
00130  #if isoburn_libburn_req_major > burn_header_version_major
00131  #define Isoburn_libburn_dot_h_too_olD 1
00132  #endif
00133  #if isoburn_libburn_req_major == burn_header_version_major && isoburn_libburn_req_minor > burn_header_version_minor
00134  #define Isoburn_libburn_dot_h_too_olD 1
00135  #endif
00136  #if isoburn_libburn_req_minor == burn_header_version_minor && isoburn_libburn_req_micro > burn_header_version_micro
00137  #define Isoburn_libburn_dot_h_too_olD 1
00138  #endif
00139 
00140 #ifdef Isoburn_libburn_dot_h_too_olD
00141 LIBBURN_MISCONFIGURATION = 0;
00142 INTENTIONAL_ABORT_OF_COMPILATION__HEADERFILE_libburn_dot_h_TOO_OLD__SEE_libisoburn_dot_h_and_burn_wrap_dot_h = 0;
00143 LIBBURN_MISCONFIGURATION_ = 0;
00144 #endif
00145 
00146 /* End of ugly compile time tests (scroll up for explanation) */
00147 
00148 
00149 
00150  msg[0]= 0;
00151  if(iso_init()<0) {
00152    sprintf(msg+strlen(msg), "Cannot initialize libisofs\n");
00153    return(0);
00154  }
00155  iso_lib_version(&major, &minor, &micro);
00156  sprintf(msg+strlen(msg), "libisofs-%d.%d.%d ", major, minor, micro);
00157 #ifdef iso_lib_header_version_major
00158  if(iso_lib_is_compatible(iso_lib_header_version_major,
00159                           iso_lib_header_version_minor,
00160                           iso_lib_header_version_micro)) {
00161    sprintf(msg+strlen(msg), "ok, ");
00162  } else {
00163    sprintf(msg+strlen(msg),"- TOO OLD -, need at least libisofs-%d.%d.%d ,\n",
00164            iso_lib_header_version_major, iso_lib_header_version_minor,
00165            iso_lib_header_version_micro);
00166    bad_match= 1;
00167  }
00168 #else
00169  if(iso_lib_is_compatible(isoburn_libisofs_req_major,
00170                           isoburn_libisofs_req_minor,
00171                           isoburn_libisofs_req_micro)) {
00172    sprintf(msg+strlen(msg), "suspicious, ");
00173  } else {
00174    sprintf(msg+strlen(msg),"- TOO OLD -, need at least libisofs-%d.%d.%d ,\n",
00175            isoburn_libisofs_req_major, isoburn_libisofs_req_minor,
00176            isoburn_libisofs_req_micro);
00177    bad_match= 1;
00178  }
00179 #endif /* ! iso_lib_header_version_major */
00180 
00181  if(!burn_initialize()) {
00182    sprintf(msg+strlen(msg), "Cannot initialize libburn\n");
00183    return(0);
00184  }
00185  burn_version(&major, &minor, &micro);
00186  sprintf(msg+strlen(msg), "libburn-%d.%d.%d ", major, minor, micro);
00187  if(major > burn_header_version_major
00188     || (major == burn_header_version_major
00189         && (minor > burn_header_version_minor
00190             || (minor == burn_header_version_minor
00191                 && micro >= burn_header_version_micro)))) {
00192    sprintf(msg+strlen(msg), "ok, ");
00193  } else {
00194    sprintf(msg+strlen(msg), "- TOO OLD -, need at least libburn-%d.%d.%d ,\n",
00195            burn_header_version_major, burn_header_version_minor,
00196            burn_header_version_micro);
00197    bad_match= 1;
00198  }
00199 
00200  isoburn_version(&major, &minor, &micro);
00201  sprintf(msg+strlen(msg), "for libisoburn-%d.%d.%d", major, minor, micro);
00202  if(bad_match)
00203    return(0);
00204 
00205  isoburn_destroy_all(&isoburn_list_start, 0); /* isoburn_list_start= NULL */
00206  return(1);
00207 }

int isoburn_is_intermediate_dvd_rw ( struct burn_drive *  d,
int  flag 
)

Definition at line 242 of file burn_wrap.c.

References isoburn_disc_get_status().

Referenced by isoburn_disc_write(), and isoburn_welcome_media().

00243 {
00244  int profile, ret= 0, format_status, num_formats;
00245  char profile_name[80];
00246  enum burn_disc_status s;
00247  off_t format_size= -1;
00248  unsigned bl_sas;
00249 
00250  s= isoburn_disc_get_status(d);
00251  ret= burn_disc_get_profile(d, &profile, profile_name);
00252  if(ret>0 && profile==0x13)
00253    ret= burn_disc_get_formats(d, &format_status, &format_size,
00254                               &bl_sas, &num_formats);
00255  if(ret>0 && profile==0x13 && s==BURN_DISC_BLANK &&
00256     format_status==BURN_FORMAT_IS_UNKNOWN)
00257    return(1);
00258  return(0);
00259 }

int isoburn_libburn_req ( int *  major,
int *  minor,
int *  micro 
)

The minimum version of libburn to be used with this version of libisoburn at runtime.

This is checked already in isoburn_initialize() which will refuse on outdated version. So this call is for information purposes after successful startup only.

Since:
0.1.0
Parameters:
major isoburn_libburn_req_major as seen at build time
minor as seen at build time
micro as seen at build time
Returns:
1 success, <=0 might in future become an error indication

Definition at line 221 of file burn_wrap.c.

00222 {
00223  *major= burn_header_version_major;
00224  *minor= burn_header_version_minor;
00225  *micro= burn_header_version_micro;
00226  return(1);
00227 }

int isoburn_libisofs_req ( int *  major,
int *  minor,
int *  micro 
)

The minimum version of libisofs to be used with this version of libisoburn at runtime.

This is checked already in isoburn_initialize() which will refuse on outdated version. So this call is for information purposes after successful startup only.

Since:
0.1.0
Parameters:
major isoburn_libisofs_req_major as seen at build time
minor as seen at build time
micro as seen at build time
Returns:
1 success, <=0 might in future become an error indication

Definition at line 211 of file burn_wrap.c.

00212 {
00213  *major= iso_lib_header_version_major;
00214  *minor= iso_lib_header_version_minor;
00215  *micro= iso_lib_header_version_micro;
00216  return(1);
00217 }

int isoburn_needs_emulation ( struct burn_drive *  drive  ) 

Inquire wether the media needs emulation or would be suitable for generic multi-session via libburn.

Since:
0.1.0
Parameters:
d The drive to inquire
Returns:
0 is generic multi-session 1 is emulated multi-session -1 is not suitable for isoburn

Definition at line 762 of file burn_wrap.c.

References isoburn::emulation_mode, isoburn_disc_get_status(), and isoburn_find_emulator().

00763 {
00764  int ret;
00765  struct isoburn *o;
00766  enum burn_disc_status s;
00767 
00768  s= isoburn_disc_get_status(drive);
00769  if(s!=BURN_DISC_BLANK && s!=BURN_DISC_APPENDABLE)
00770    return(-1);
00771  ret= isoburn_find_emulator(&o, drive, 0);
00772  if(ret<0)
00773    return(-1);
00774  if(ret>0)
00775    if(o->emulation_mode>0)
00776      return(1);
00777  return(0);  
00778 }

int isoburn_read_iso_head ( struct burn_drive *  d,
int  lba,
int *  image_blocks,
char *  info,
int  flag 
)

Try whether the data at the given address look like a ISO 9660 image header and obtain its alleged size.

Depending on the info mode one other string of text information can be retrieved too.

Since:
0.1.6
Parameters:
drive The drive with the media to inspect
lba The block number from where to read
image_blocks The number of 2048 bytes blocks
info Caller provided memory, enough to take eventual info reply
flag bit0-7: info return mode 0= do not return anything in info (do not even touch it) 1= copy volume id to info (info needs 33 bytes) 2=
Since:
0.2.2 : copy 64 kB header to info (needs 65536 bytes) bit13=

0.2.2: do not read head from media but use first 64 kB from info bit14= check both half buffers (not only second) return 2 if found in first block bit15= return-1 on read error

Returns:
>0 seems to be a valid ISO image, 0 format not recognized, <0 error

Definition at line 999 of file burn_wrap.c.

References isoburn_read_iso_head_parse().

Referenced by isoburn_emulate_toc(), isoburn_read_image(), and isoburn_set_msc1().

01001 {
01002  unsigned char buffer[64*1024];
01003  int ret, info_mode;
01004  off_t data_count;
01005 
01006  info_mode= flag&255;
01007  *image_blocks= 0;
01008  if(flag&(1<<13)) {
01009    memcpy(buffer, info, 64*1024);
01010  } else {
01011    ret = burn_read_data(d, ((off_t) lba) * (off_t) 2048, (char *) buffer,
01012                       (off_t) 64*1024, &data_count, 2); /* no error messages */
01013    if(ret<=0)
01014      return(-1*!!(flag&(1<<15)));
01015    if(info_mode==2)
01016      memcpy(info, buffer, 64*1024);
01017  }
01018 
01019  if(flag&(1<<14)) {
01020    ret= isoburn_read_iso_head_parse(d, buffer, image_blocks, info, info_mode);
01021    if(ret<0)
01022      return(ret);
01023    if(ret>0)
01024      return(2);
01025  }
01026  ret= isoburn_read_iso_head_parse(d, buffer+32*1024, image_blocks, info,
01027                                   info_mode);
01028  return(ret);
01029 }

int isoburn_read_iso_head_parse ( struct burn_drive *  d,
unsigned char *  data,
int *  image_blocks,
char *  info,
int  flag 
)

Definition at line 951 of file burn_wrap.c.

References isoburn_msgs_submit().

Referenced by isoburn_read_iso_head().

00953 {
00954  int i, info_mode;
00955 
00956  /* is this an ISO image ? */
00957  if(data[0]!=1)
00958    return(0);
00959  if(strncmp((char *) (data+1),"CD001",5)!=0)
00960    return(0);
00961  /* believe so */
00962 
00963  *image_blocks= data[80] | (data[81]<<8) | (data[82]<<16) | (data[83]<<24);
00964  info_mode= flag&255;
00965  if(info_mode==0) {
00966    ;
00967  } else if(info_mode==1) {
00968    strncpy(info, (char *) (data+40), 32);
00969    info[32]= 0;
00970    for(i= strlen(info)-1; i>=0; i--)
00971      if(info[i]!=' ')
00972    break;
00973      else
00974        info[i]= 0;
00975  } else if(info_mode==2) {
00976    ;
00977  } else {
00978    isoburn_msgs_submit(NULL, 0x00060000,
00979                "Program error: Unknown info mode with isoburn_read_iso_head()",
00980                0, "FATAL", 0);
00981    return(-1);
00982  }
00983  return(1);
00984 }

int isoburn_report_iso_error ( int  iso_error_code,
char  msg_text[],
int  os_errno,
char  min_severity[],
int  flag 
)

Definition at line 919 of file burn_wrap.c.

References isoburn__sev_to_text(), and isoburn__text_to_sev().

Referenced by isoburn_new(), isoburn_prepare_disc_aux(), and isoburn_read_image().

00921 {
00922  int error_code, iso_sev, min_sev, ret;
00923  char *sev_text_pt, *msg_text_pt= NULL;
00924 
00925  error_code= iso_error_get_code(iso_error_code);
00926  if(error_code < 0x00030000 || error_code >= 0x00040000)
00927    error_code= (error_code & 0xffff) | 0x00050000;
00928 
00929  if(iso_error_code<0)
00930    msg_text_pt= (char *) iso_error_to_msg(iso_error_code);
00931  if(msg_text_pt==NULL)
00932    msg_text_pt= msg_text;
00933  iso_sev= iso_error_get_severity(iso_error_code);
00934  sev_text_pt= min_severity;
00935  isoburn__text_to_sev(min_severity, &min_sev, 0);
00936  if(min_sev < iso_sev) 
00937    isoburn__sev_to_text(iso_sev, &sev_text_pt, 0);
00938  ret= iso_msgs_submit(error_code, msg_text_pt, os_errno, sev_text_pt, 0);
00939  return(ret);
00940 }

int isoburn_set_msc1 ( struct burn_drive *  d,
int  adr_mode,
char *  adr_value,
int  flag 
)

Set up isoburn_disc_get_msc1() to return a fabricated value.

This makes only sense between aquiring the drive and reading the image. After isoburn_read_image() it will confuse the coordination of libisoburn and libisofs. Note: Sessions and tracks are counted beginning with 1, not with 0.

Since:
0.1.6
Parameters:
drive The drive where msc1 is to be set
adr_mode Determines how to interpret adr_value and to set msc1. If adr_value shall represent a number then decimal ASCII digits are expected. 0= start lba of last session in TOC, ignore adr_value 1= start lba of session number given by adr_value 2= start lba of track given number by adr_value 3= adr_value itself is the lba to be used 4= start lba of last session with volume id given by adr_value adr_value A string describing the value to be eventually used.
flag Bitfield for control purposes. bit0=
Since:
0.2.2 with adr_mode 3: adr_value might be 16 blocks too high (e.g. -C stemming from growisofs). Probe for ISO head at adr_value-16 and eventually adjust setting.

Definition at line 1454 of file burn_wrap.c.

References isoburn_toc_disc::disc, isoburn::fabricated_msc1, isoburn_find_emulator(), isoburn_get_track_lba(), isoburn_msgs_submit(), isoburn_read_iso_head(), isoburn_toc_disc_free(), isoburn_toc_disc_get_sessions(), isoburn_toc_drive_get_disc(), and isoburn_toc_session_get_tracks().

01456 {
01457  int ret, num_sessions, num_tracks, adr_num, i, j, total_tracks;
01458  int lba, best_lba, size;
01459  char volid[33], msg[160];
01460  struct isoburn *o;
01461  struct isoburn_toc_disc *disc= NULL;
01462  struct isoburn_toc_session **sessions= NULL;
01463  struct isoburn_toc_track **tracks= NULL;
01464  static char mode_names[][20]= {"auto", "session", "track", "lba", "volid"};
01465  static int max_mode_names= 4;
01466 
01467  ret= isoburn_find_emulator(&o, d, 0);
01468  if(ret<0)
01469    return(-1);
01470  if(o==NULL)
01471    return(-1);
01472 
01473  adr_num= atoi(adr_value);
01474  if(adr_mode!=3) {
01475    disc= isoburn_toc_drive_get_disc(d);
01476    if(disc==NULL) {
01477 not_found:;
01478      if(adr_mode<0 || adr_mode>max_mode_names)
01479        goto unknown_mode;
01480      sprintf(msg, "Failed to find %s %s", mode_names[adr_mode],
01481                   strlen(adr_value)<=80 ?  adr_value : "-oversized-string-");
01482      isoburn_msgs_submit(o, 0x00060000, msg, 0, "FAILURE", 0);
01483      ret= 0; goto ex;
01484    }
01485    sessions= isoburn_toc_disc_get_sessions(disc, &num_sessions);
01486    if(sessions==NULL || num_sessions<=0)
01487      goto not_found;
01488  }
01489  if(adr_mode==0) {
01490    /* Set fabricated_msc1 to last session in TOC */
01491    tracks= isoburn_toc_session_get_tracks(sessions[num_sessions-1],
01492                                           &num_tracks);
01493    if(tracks==NULL || num_tracks<=0)
01494      goto not_found;
01495    isoburn_get_track_lba(tracks[0], &(o->fabricated_msc1), 0);
01496 
01497  } else if(adr_mode==1) {
01498    /* Use adr_num as session index (first session is 1, not 0) */
01499    if(adr_num<1 || adr_num>num_sessions)
01500      goto not_found;
01501    tracks= isoburn_toc_session_get_tracks(sessions[adr_num-1], &num_tracks);
01502    if(tracks==NULL || num_tracks<=0)
01503      goto not_found;
01504    isoburn_get_track_lba(tracks[0], &(o->fabricated_msc1), 0);
01505 
01506  } else if(adr_mode==2) {
01507    /* use adr_num as track index */
01508    total_tracks= 0;
01509    for(i=0; i<num_sessions; i++) {
01510      tracks= isoburn_toc_session_get_tracks(sessions[i], &num_tracks);
01511      if(tracks==NULL)
01512    continue;
01513      for(j= 0; j<num_tracks; j++) {
01514        total_tracks++;
01515        if(total_tracks==adr_num) {
01516          isoburn_get_track_lba(tracks[j], &(o->fabricated_msc1), 0);
01517          ret= 1; goto ex;
01518        }
01519      }
01520    }
01521    goto not_found;
01522 
01523  } else if(adr_mode==3) {
01524    o->fabricated_msc1= adr_num;
01525    if((flag & 1) && o->fabricated_msc1 >= 16) {
01526      /* adr_num is possibly 16 blocks too high */
01527      ret= isoburn_read_iso_head(d, o->fabricated_msc1, &size,volid, 1|(1<<14));
01528      if(ret==2)
01529        o->fabricated_msc1-= 16;
01530    }
01531  } else if(adr_mode==4) {
01532    /* search for volume id that is equal to adr_value */
01533    best_lba= -1;
01534    for(i=0; i<num_sessions; i++) {
01535      tracks= isoburn_toc_session_get_tracks(sessions[i], &num_tracks);
01536      if(tracks==NULL)
01537    continue;
01538      for(j= 0; j<num_tracks; j++) {
01539        isoburn_get_track_lba(tracks[0], &lba, 0);
01540        ret= isoburn_read_iso_head(d, lba, &size, volid, 1);
01541        if(ret<=0)
01542      continue;
01543        if(strcmp(volid, adr_value)!=0)
01544      continue;
01545        best_lba= lba;
01546      }
01547    }
01548    if(best_lba<0)
01549      goto not_found;
01550    o->fabricated_msc1= best_lba;
01551 
01552  } else {
01553 unknown_mode:;
01554    sprintf(msg, "Program error: Unknown msc1 address mode %d", adr_mode);
01555    isoburn_msgs_submit(o, 0x00060000, msg, 0, "FATAL", 0);
01556    ret= 0; goto ex;
01557  }
01558  ret= 1;
01559 ex:;
01560  if(disc!=NULL)
01561    isoburn_toc_disc_free(disc);
01562  return(ret);
01563 }

int isoburn_set_msgs_submit ( int(*)(void *handle, int error_code, char msg_text[], int os_errno, char severity[], int flag)  msgs_submit,
void *  submit_handle,
int  submit_flag,
int  flag 
)

Note: Above version numbers are also recorded in configure.ac because libtool wants them as parameters at build time.

For the library compatibility check, ISOBURN_*_VERSION in configure.ac are not decisive. Only the three numbers here do matter. Usage discussion:Some developers of the libburnia project have differing opinions how to ensure the compatibility of libaries and applications.

It is about whether to use at compile time and at runtime the version numbers isoburn_header_version_* provided here. Thomas Schmitt advises to use them. Vreixo Formoso advises to use other means.

At compile time:

Vreixo Formoso advises to leave proper version matching to properly programmed checks in the the application's build system, which will eventually refuse compilation.

Thomas Schmitt advises to use the macros defined here for comparison with the application's requirements of library revisions and to eventually break compilation.

Both advises are combinable. I.e. be master of your build system and have if checks in the source code of your application, nevertheless.

At runtime (via *_is_compatible()):

Vreixo Formoso advises to compare the application's requirements of library revisions with the runtime library. This is to allow runtime libraries which are young enough for the application but too old for the lib*.h files seen at compile time.

Thomas Schmitt advises to compare the header revisions defined here with the runtime library. This is to enforce a strictly monotonous chain of revisions from app to header to library, at the cost of excluding some older libraries.

These two advises are mutually exclusive.

-----------------------------------------------------

For an implementation of the Thomas Schmitt approach, see libisoburn/burn_wrap.c : isoburn_initialize() This connects libisoburn as "application" with libisofs as "library".

The compatible part of Vreixo Formoso's approach is implemented in configure.ac LIBBURN_REQUIRED, LIBISOFS_REQUIRED. In isoburn_initialize() it would rather test by iso_lib_is_compatible(isoburn_libisofs_req_major,... than by iso_lib_is_compatible(iso_lib_header_version_major,... and would leave out the ugly compile time traps. Announce to the library an application provided method for immediate delivery of messages. It is used when no drive is affected directly or if the drive has no own msgs_submit() method attached by isoburn_drive_set_msgs_submit. If no method is preset or if the method is set to NULL then libisoburn delivers its messages through the message queue of libburn.

Parameters:
msgs_submit The function call which implements the method
submit_handle Handle to be used as first argument of msgs_submit
submit_flag Flag to be used as last argument of msgs_submit
flag Unused yet, submit 0
Since:
0.2.0

Definition at line 230 of file burn_wrap.c.

References libisoburn_default_msgs_submit, libisoburn_default_msgs_submit_flag, libisoburn_default_msgs_submit_handle, and isoburn::msgs_submit.

00234 {
00235  libisoburn_default_msgs_submit= msgs_submit;
00236  libisoburn_default_msgs_submit_handle= submit_handle;
00237  libisoburn_default_msgs_submit_flag= submit_flag;
00238  return(1);
00239 }

int isoburn_set_start_byte ( struct isoburn o,
off_t  value,
int  flag 
)

Set the start address for an emulated add-on session.

The value will be rounded up to the alignment necessary for the media. The aligned value will be divided by 2048 and then put into o->nwa .

Parameters:
o The isoburn object to be programmed.
value The start address in bytes
flag unused yet
Returns:
<=0 is failure , >0 success

Definition at line 781 of file burn_wrap.c.

References isoburn::drive, isoburn_msgs_submit(), Libisoburn_nwa_alignemenT, isoburn::min_start_byte, and isoburn::nwa.

Referenced by isoburn_start_emulation().

00782 {
00783  int ret;
00784  struct burn_drive *drive = o->drive;
00785  struct burn_multi_caps *caps= NULL;
00786  
00787  ret= burn_disc_get_multi_caps(drive, BURN_WRITE_NONE, &caps, 0);
00788  if(ret<=0)
00789    goto ex;
00790  if(!caps->start_adr) {
00791    isoburn_msgs_submit(o, 0x00060000,
00792                        "Cannot set start byte address with this type of media",
00793                        0, "FAILURE", 0);
00794    {ret= 0; goto ex;}
00795  }
00796  o->min_start_byte= value;
00797  if(value % caps->start_alignment)
00798    value+= caps->start_alignment - (value % caps->start_alignment);
00799  o->nwa= value/2048;
00800  /* If suitable for media alignment, round up to Libisoburn_nwa_alignemenT */
00801  if((o->nwa % Libisoburn_nwa_alignemenT) &&
00802      ((Libisoburn_nwa_alignemenT*2048) % caps->start_alignment)==0 )
00803    o->nwa+= Libisoburn_nwa_alignemenT - (o->nwa % Libisoburn_nwa_alignemenT);
00804  ret= 1;
00805 ex:
00806  if(caps!=NULL)
00807    burn_disc_free_multi_caps(&caps);
00808  return(ret);
00809 }

int isoburn_toc_destroy_arrays ( struct isoburn_toc_disc o,
int  flag 
)

Definition at line 1193 of file burn_wrap.c.

References isoburn_toc_disc::session_pointers, isoburn_toc_disc::sessions, isoburn_toc_disc::track_pointers, and isoburn_toc_disc::tracks.

Referenced by isoburn_toc_disc_free(), and isoburn_toc_new_arrays().

01194 {
01195  if(o->sessions!=NULL)
01196    free((char *) o->sessions);
01197  o->sessions= NULL;
01198  if(o->session_pointers!=NULL)
01199    free((char *) o->session_pointers);
01200  o->session_pointers= NULL;
01201  if(o->tracks!=NULL)
01202    free((char *) o->tracks);
01203  o->tracks= NULL;
01204  if(o->track_pointers!=NULL)
01205    free((char *) o->track_pointers);
01206  o->track_pointers= NULL;
01207  return(1);
01208 }

void isoburn_toc_disc_free ( struct isoburn_toc_disc disc  ) 

Release the memory associated with a master handle of media.

The handle is invalid afterwards and may not be used any more. Wrapper for: burn_disc_free()

Since:
0.1.6
Parameters:
disc The master handle of the media

Definition at line 1411 of file burn_wrap.c.

References isoburn_toc_disc::disc, and isoburn_toc_destroy_arrays().

Referenced by isoburn_set_msc1().

01412 {
01413  if(d->disc!=NULL)
01414    burn_disc_free(d->disc);
01415  isoburn_toc_destroy_arrays(d, 0);
01416  free((char *) d);
01417 }

int isoburn_toc_disc_get_sectors ( struct isoburn_toc_disc disc  ) 

Tell the number of 2048 byte blocks covered by the table of content.

Wrapper for: burn_disc_get_sectors()

Since:
0.1.6
Parameters:
disc The master handle of the media
Returns:
number of blocks, <=0 indicates unknown or unreadable state

Definition at line 1297 of file burn_wrap.c.

References isoburn_toc_disc::disc, isoburn_toc_entry::next, isoburn_toc_entry::start_lba, isoburn_toc_disc::toc, and isoburn_toc_entry::track_blocks.

01298 {
01299  struct isoburn_toc_entry *t;
01300  int ret= 0;
01301 
01302  if(disc==NULL)
01303    return(0);
01304  if(disc->toc!=NULL) {
01305    for(t= disc->toc; t!=NULL; t= t->next)
01306      ret= t->start_lba + t->track_blocks;
01307  } else if(disc->disc!=NULL)
01308    ret= burn_disc_get_sectors(disc->disc);
01309  return(ret);
01310 }

struct isoburn_toc_session** isoburn_toc_disc_get_sessions ( struct isoburn_toc_disc disc,
int *  num 
) [read]

Get the array of session handles from the table of content.

Wrapper for: burn_disc_get_sessions()

Since:
0.1.6
Parameters:
disc The master handle of the media
num returns the number of sessions in the array
Returns:
the address of the array of session handles

Definition at line 1313 of file burn_wrap.c.

References isoburn_toc_disc::session_count, and isoburn_toc_disc::session_pointers.

Referenced by isoburn_set_msc1().

01315 {
01316  *num= disc->session_count;
01317  return(disc->session_pointers);
01318 }

struct isoburn_toc_disc* isoburn_toc_drive_get_disc ( struct burn_drive *  d  )  [read]

Obtain a master handle for the table of content.

This handle governs allocated resources which have to be released by isoburn_toc_disc_free() when no longer needed. Wrapper for: burn_drive_get_disc()

Since:
0.1.6
Parameters:
drive The drive with the media to inspect
Returns:
NULL in case there is no content info, else it is a valid handle

Definition at line 1211 of file burn_wrap.c.

References isoburn_toc_disc::disc, isoburn_find_emulator(), isoburn_toc_new_arrays(), isoburn_toc_entry::next, isoburn_toc_session::session, isoburn_toc_disc::session_count, isoburn_toc_disc::session_pointers, isoburn_toc_disc::sessions, isoburn::toc, isoburn_toc_disc::toc, isoburn_toc_track::toc_entry, isoburn_toc_session::toc_entry, isoburn_toc_track::track, isoburn_toc_session::track_count, isoburn_toc_disc::track_count, isoburn_toc_session::track_pointers, isoburn_toc_disc::track_pointers, and isoburn_toc_disc::tracks.

Referenced by isoburn_set_msc1().

01212 {
01213  int ret, session_count= 0, track_count= 0, num_tracks= 0, i, j;
01214  struct isoburn *o;
01215  struct isoburn_toc_entry *t;
01216  struct isoburn_toc_disc *toc_disc= NULL;
01217  struct burn_session **s;
01218  struct burn_track **tracks;
01219 
01220  toc_disc= calloc(1, sizeof(struct isoburn_toc_disc));
01221  if(toc_disc==NULL)
01222    return(NULL);
01223  toc_disc->disc= NULL;
01224  toc_disc->sessions= NULL;
01225  toc_disc->session_pointers= NULL;
01226  toc_disc->tracks= NULL;
01227  toc_disc->track_pointers= NULL;
01228  toc_disc->session_count= 0;
01229  toc_disc->track_count= 0;
01230  toc_disc->toc= NULL; 
01231 
01232  /* is the media emulated multi-session ? */
01233  ret= isoburn_find_emulator(&o, d, 0);
01234  if(ret<0)
01235    goto libburn;
01236  if(o->toc==NULL)
01237    goto libburn;
01238 
01239  /* This is an emulated TOC */
01240  toc_disc->toc= o->toc;
01241  for(t= toc_disc->toc; t!=NULL; t= t->next)
01242    session_count++;
01243  ret= isoburn_toc_new_arrays(toc_disc, session_count, session_count, 0);
01244  if(ret<=0)
01245    goto failure;
01246  t= toc_disc->toc;
01247  for(i= 0; i<session_count; i++) {
01248    toc_disc->sessions[i].track_pointers= toc_disc->track_pointers+i;
01249    toc_disc->sessions[i].track_count= 1;
01250    toc_disc->sessions[i].toc_entry= t;
01251    toc_disc->session_pointers[i]= toc_disc->sessions+i;
01252    toc_disc->tracks[i].toc_entry= t;
01253    toc_disc->track_pointers[i]= toc_disc->tracks+i;
01254    t= t->next;
01255  }
01256  toc_disc->session_count= session_count;
01257  toc_disc->track_count= session_count;
01258  return(toc_disc);
01259 
01260 libburn:;
01261  /* This is a libburn provided TOC */
01262  toc_disc->disc= burn_drive_get_disc(d);
01263  if(toc_disc->disc == NULL) {
01264 failure:;
01265    free((char *) toc_disc);
01266    return(NULL);
01267  }
01268  s= burn_disc_get_sessions(toc_disc->disc, &session_count);
01269  for(i= 0; i<session_count; i++) {
01270    tracks = burn_session_get_tracks(s[i], &num_tracks);
01271    track_count+= num_tracks;
01272  }
01273  if(session_count<=0 || track_count<=0)
01274    goto failure;
01275  ret= isoburn_toc_new_arrays(toc_disc, session_count, track_count, 0);
01276  if(ret<=0)
01277    goto failure;
01278  track_count= 0;
01279  for(i= 0; i<session_count; i++) {
01280    tracks = burn_session_get_tracks(s[i], &num_tracks);
01281    toc_disc->sessions[i].session= s[i];
01282    toc_disc->sessions[i].track_pointers= toc_disc->track_pointers+track_count;
01283    toc_disc->sessions[i].track_count= num_tracks;
01284    toc_disc->session_pointers[i]= toc_disc->sessions+i;
01285    for(j= 0; j<num_tracks; j++) {
01286      toc_disc->tracks[track_count+j].track= tracks[j];
01287      toc_disc->track_pointers[track_count+j]= toc_disc->tracks+(track_count+j);
01288    }
01289    track_count+= num_tracks;
01290  }
01291  toc_disc->session_count= session_count;
01292  toc_disc->track_count= track_count;
01293  return(toc_disc);
01294 }

int isoburn_toc_entry_finish ( struct burn_toc_entry *  entry,
int  session_no,
int  track_no,
int  flag 
)

Definition at line 1340 of file burn_wrap.c.

Referenced by isoburn_toc_session_get_leadout_entry(), and isoburn_toc_track_get_entry().

01342 {
01343  int pmin, psec, pframe;
01344 
01345  entry->extensions_valid= 1;
01346  entry->adr= 1;
01347  entry->control= 4;
01348  entry->session= session_no & 255;
01349  entry->session_msb= (session_no >> 8) & 255;
01350  entry->point= track_no & 255;
01351  entry->point_msb= (track_no >> 8) & 255;
01352 
01353  burn_lba_to_msf(entry->start_lba, &pmin, &psec, &pframe);
01354  if(pmin<=255)
01355    entry->pmin= pmin;
01356  else
01357    entry->pmin= 255;
01358  entry->psec= psec;
01359  entry->pframe= pframe; 
01360  return(1);
01361 }

int isoburn_toc_new_arrays ( struct isoburn_toc_disc o,
int  session_count,
int  track_count,
int  flag 
)

Definition at line 1160 of file burn_wrap.c.

References isoburn_toc_destroy_arrays(), isoburn_toc_session::session, isoburn_toc_disc::session_pointers, isoburn_toc_disc::sessions, isoburn_toc_track::toc_entry, isoburn_toc_session::toc_entry, isoburn_toc_track::track, isoburn_toc_session::track_count, isoburn_toc_session::track_pointers, isoburn_toc_disc::track_pointers, and isoburn_toc_disc::tracks.

Referenced by isoburn_toc_drive_get_disc().

01162 {
01163  int i;
01164  int isoburn_toc_destroy_arrays(struct isoburn_toc_disc *o, int flag);
01165 
01166  o->sessions= calloc(session_count, sizeof(struct isoburn_toc_session));
01167  o->session_pointers=
01168                    calloc(session_count, sizeof(struct isoburn_toc_session *));
01169  o->tracks= calloc(track_count, sizeof(struct isoburn_toc_track));
01170  o->track_pointers= calloc(track_count, sizeof(struct isoburn_toc_track *));
01171  if(o->sessions!=NULL && o->session_pointers!=NULL &&
01172     o->tracks!=NULL && o->track_pointers!=NULL) {
01173    for(i= 0; i<session_count; i++) {
01174      o->sessions[i].session= NULL;
01175      o->sessions[i].track_pointers= NULL;
01176      o->sessions[i].track_count= 0;
01177      o->sessions[i].toc_entry= NULL;
01178      o->session_pointers[i]= NULL;
01179    }
01180    for(i= 0; i<track_count; i++) {
01181      o->tracks[i].track= NULL;
01182      o->tracks[i].toc_entry= NULL;
01183      o->track_pointers[i]= NULL;
01184    }
01185    return(1);
01186  }
01187  /* failed */
01188  isoburn_toc_destroy_arrays(o, 0);
01189  return(-1);
01190 }

void isoburn_toc_session_get_leadout_entry ( struct isoburn_toc_session s,
struct burn_toc_entry *  entry 
)

Obtain a copy of the entry which describes the end of a particular session.

Wrapper for: burn_session_get_leadout_entry()

Since:
0.1.6
Parameters:
s The session handle
entry A pointer to memory provided by the caller. It will be filled with info according to struct burn_toc_entry as defined in libburn.h

Definition at line 1364 of file burn_wrap.c.

References isoburn_toc_entry_finish(), isoburn_toc_entry::session, isoburn_toc_session::session, isoburn_toc_entry::start_lba, isoburn_toc_track::toc_entry, isoburn_toc_session::toc_entry, isoburn_toc_entry::track_blocks, isoburn_toc_session::track_count, isoburn_toc_entry::track_no, and isoburn_toc_session::track_pointers.

01366 {
01367  struct isoburn_toc_track *t;
01368 
01369  if(s==NULL)
01370    return;
01371  if(s->session!=NULL && s->toc_entry==NULL) {
01372    burn_session_get_leadout_entry(s->session, entry);
01373    return;
01374  }
01375  if(s->track_count<=0 || s->track_pointers==NULL || s->toc_entry==NULL)
01376    return;
01377  t= s->track_pointers[s->track_count-1];
01378  entry->start_lba= t->toc_entry->start_lba + t->toc_entry->track_blocks;
01379  entry->track_blocks= 0;
01380  isoburn_toc_entry_finish(entry, s->toc_entry->session, t->toc_entry->track_no,
01381                           0);
01382 }

int isoburn_toc_session_get_sectors ( struct isoburn_toc_session s  ) 

Tell the number of 2048 byte blocks covered by a particular session.

Wrapper for: burn_session_get_sectors()

Since:
0.1.6
Parameters:
s The session handle
Returns:
number of blocks, <=0 indicates unknown or unreadable state

Definition at line 1321 of file burn_wrap.c.

References isoburn_toc_entry::next, isoburn_toc_session::session, isoburn_toc_session::toc_entry, isoburn_toc_entry::track_blocks, and isoburn_toc_session::track_count.

01322 {
01323  struct isoburn_toc_entry *t;
01324  int count= 0, i;
01325 
01326  if(s==NULL)
01327    return(0);
01328  if(s->toc_entry!=NULL) {
01329    t= s->toc_entry;
01330    for(i= 0; i<s->track_count; i++) {
01331      count+= t->track_blocks;
01332      t= t->next;
01333    }
01334  } else if(s->session!=NULL)
01335    count= burn_session_get_sectors(s->session);
01336  return(count);
01337 }

struct isoburn_toc_track** isoburn_toc_session_get_tracks ( struct isoburn_toc_session s,
int *  num 
) [read]

Get the array of track handles from a particular session.

Wrapper for: burn_session_get_tracks()

Since:
0.1.6
Parameters:
s The session handle
num returns the number of tracks in the array
Returns:
the address of the array of track handles

Definition at line 1385 of file burn_wrap.c.

References isoburn_toc_session::track_count, and isoburn_toc_session::track_pointers.

Referenced by isoburn_set_msc1().

01387 {
01388  *num= s->track_count;
01389  return(s->track_pointers);
01390 }

void isoburn_toc_track_get_entry ( struct isoburn_toc_track t,
struct burn_toc_entry *  entry 
)

Obtain a copy of the entry which describes a particular itrack.

Wrapper for: burn_track_get_entry()

Since:
0.1.6
Parameters:
s The track handle
entry A pointer to memory provided by the caller. It will be filled with info according to struct burn_toc_entry as defined in libburn.h

Definition at line 1393 of file burn_wrap.c.

References isoburn_toc_entry_finish(), isoburn_toc_entry::session, isoburn_toc_entry::start_lba, isoburn_toc_track::toc_entry, isoburn_toc_track::track, isoburn_toc_entry::track_blocks, and isoburn_toc_entry::track_no.

Referenced by isoburn_get_track_lba().

01395 {
01396  if(t==0)
01397    return;
01398  if(t->track!=NULL && t->toc_entry==NULL) {
01399    burn_track_get_entry(t->track, entry);
01400    return;
01401  }
01402  if(t->toc_entry==NULL)
01403    return;
01404  entry->start_lba= t->toc_entry->start_lba;
01405  entry->track_blocks= t->toc_entry->track_blocks;
01406  isoburn_toc_entry_finish(entry, t->toc_entry->session, t->toc_entry->track_no,
01407                           0);
01408 }

static int isoburn_welcome_media ( struct isoburn **  o,
struct burn_drive *  d,
int  flag 
) [static]

Examines the media and sets appropriate emulation if needed.

Parameters:
flag bit0= pretent blank on overwriteable media bit3= if the drive reports a -ROM profile then try to read table of content by scanning for ISO image headers.

Definition at line 267 of file burn_wrap.c.

References isoburn_emulate_toc(), isoburn_is_intermediate_dvd_rw(), isoburn_new(), isoburn_start_emulation(), libisoburn_default_msgs_submit, libisoburn_default_msgs_submit_flag, libisoburn_default_msgs_submit_handle, isoburn_toc_entry::next, isoburn::nwa, and isoburn_toc_entry::start_lba.

Referenced by isoburn_drive_aquire(), and isoburn_drive_grab().

00269 {
00270  int ret, lba, nwa, profile, readonly= 0;
00271  struct burn_multi_caps *caps= NULL;
00272  struct isoburn_toc_entry *t;
00273  char profile_name[80];
00274 
00275  profile_name[0]= 0;
00276  ret= burn_disc_get_profile(d, &profile, profile_name);
00277  if(ret<=0)
00278    profile= 0x00;
00279  ret= burn_disc_get_multi_caps(d, BURN_WRITE_NONE, &caps, 0);
00280  if(ret<0) /* == 0 is read-only media, but it is too early to reject it here */
00281    goto ex;
00282  if(ret==0)
00283    readonly= 1;
00284  ret= isoburn_new(o, 0);
00285  if(ret<=0)
00286    goto ex;
00287  (*o)->drive= d;
00288  (*o)->msgs_submit= libisoburn_default_msgs_submit;
00289  (*o)->msgs_submit_handle= libisoburn_default_msgs_submit_handle;
00290  (*o)->msgs_submit_flag= libisoburn_default_msgs_submit_flag;
00291 
00292 #ifdef Hardcoded_cd_rW
00293  /* <<< A70929 : hardcoded CD-RW with fabricated -msinfo */
00294  caps->start_adr= 0;
00295  (*o)->fabricated_disc_status= BURN_DISC_APPENDABLE;
00296 #endif
00297 
00298  if(caps->start_adr) {         /* set emulation to overwriteable */
00299    (*o)->emulation_mode= 1;
00300    ret= isoburn_is_intermediate_dvd_rw(d, 0);
00301    if(ret>0) {
00302      (*o)->min_start_byte= 0;
00303      (*o)->nwa= 0;
00304      (*o)->zero_nwa= 0;
00305    }
00306    if(flag&1) {
00307      (*o)->nwa= (*o)->zero_nwa;
00308      (*o)->fabricated_disc_status= BURN_DISC_BLANK;
00309    } else {
00310      ret= isoburn_start_emulation(*o, 0);
00311      if(ret<=0) {
00312        (*o)->emulation_mode= -1;
00313        goto ex;
00314      }
00315      /* try to read emulated toc */
00316      ret= isoburn_emulate_toc(d, 0);
00317      if(ret<0) {
00318        (*o)->emulation_mode= -1;
00319        goto ex;
00320      }
00321    }
00322 
00323  } else {
00324 
00325     /* >>> recognize unsuitable media (but allow read-only media) */;
00326 
00327    if(readonly) {
00328      /* This might be overwriteable media in a -ROM drive */
00329      ret= isoburn_emulate_toc(d, 1);
00330      if(ret<0)
00331        goto ex;
00332      if(ret==0 && profile !=0x08 && (flag&8)) {
00333        /* This might also be multi-session media which do not
00334           get shown with a decent TOC.
00335           CD-R TOC (profile 0x08) can be trusted. Others not.
00336           Do a scan search of ISO headers.
00337        */
00338        ret= isoburn_emulate_toc(d, 1|2);
00339        if(ret<0)
00340          goto ex;
00341        if(ret>0) { /* point msc1 to last session */
00342          if((*o)->toc!=NULL) {
00343            for(t= (*o)->toc; t->next!=NULL; t= t->next);
00344             (*o)->fabricated_msc1= t->start_lba;
00345          }
00346        }
00347      }
00348    }
00349 #ifdef Hardcoded_cd_rW
00350    (*o)->nwa= Hardcoded_cd_rw_nwA;
00351 #else
00352    ret= burn_disc_track_lba_nwa(d, NULL, 0, &lba, &nwa);
00353    if(ret>0)
00354      (*o)->nwa= nwa;
00355 #endif
00356 
00357  }
00358 
00359  ret= 1;
00360 ex:
00361  if(caps!=NULL)
00362    burn_disc_free_multi_caps(&caps);
00363  return(ret);
00364 }


Variable Documentation

Definition at line 103 of file isoburn.c.

int(* libisoburn_default_msgs_submit)(void *handle, int error_code, char msg_text[], int os_errno, char severity[], int flag)

Definition at line 48 of file isoburn.c.

Referenced by isoburn_msgs_submit(), isoburn_set_msgs_submit(), and isoburn_welcome_media().

Definition at line 47 of file isoburn.c.

Referenced by isoburn_msgs_submit(), isoburn_set_msgs_submit(), and isoburn_welcome_media().


Generated on Sat Nov 8 02:08:48 2008 for libisoburn by  doxygen 1.5.6