libcdio-osx/lib/_cdio_nrg.c

/*
    $Id: _cdio_nrg.c,v 1.1 2003/03/24 19:01:09 rocky Exp $

    Copyright (C) 2001,2003 Herbert Valerio Riedel <hvr@gnu.org>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/
/*! This code implements low-level access functions for the Nero native
   CD-image format residing inside a disk file (*.nrg).
*/

#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#include "cdio_assert.h"
#include "bytesex.h"
#include "ds.h"
#include "cdio_private.h"
#include "logging.h"
#include "sector.h"
#include "util.h"
#include "_cdio_stdio.h"

static const char _rcsid[] = "$Id: _cdio_nrg.c,v 1.1 2003/03/24 19:01:09 rocky Exp $";

/* structures used */

/* this ugly image format is typical for lazy win32 programmers... at
   least structure were set big endian, so at reverse
   engineering wasn't such a big headache... */

PRAGMA_BEGIN_PACKED
typedef struct {
  uint32_t start      GNUC_PACKED;
  uint32_t length     GNUC_PACKED;
  uint32_t type       GNUC_PACKED; /* only 0x3 seen so far... 
                                      -> MIXED_MODE2 2336 blocksize */
  uint32_t start_lsn  GNUC_PACKED; /* does not include any pre-gaps! */
  uint32_t _unknown   GNUC_PACKED; /* wtf is this for? -- always zero... */
} _etnf_array_t;

/* finally they realized that 32bit offsets are a bit outdated for IA64 *eg* */
typedef struct {
  uint64_t start      GNUC_PACKED;
  uint64_t length     GNUC_PACKED;
  uint32_t type       GNUC_PACKED;
  uint32_t start_lsn  GNUC_PACKED;
  uint64_t _unknown   GNUC_PACKED; /* wtf is this for? -- always zero... */
} _etn2_array_t;

typedef struct {
  uint8_t  _unknown1  GNUC_PACKED; /* 0x41 == 'A' */
  uint8_t  track      GNUC_PACKED; /* binary or BCD?? */
  uint8_t  index      GNUC_PACKED; /* makes 0->1 transitions */
  uint8_t  _unknown2  GNUC_PACKED; /* ?? */
  uint32_t lsn        GNUC_PACKED; 
} _cuex_array_t;

typedef struct {
  uint32_t id                    GNUC_PACKED;
  uint32_t len                   GNUC_PACKED;
  char data[EMPTY_ARRAY_SIZE]    GNUC_PACKED;
} _chunk_t;

PRAGMA_END_PACKED

/* to be converted into BE */
#define CUEX_ID  0x43554558
#define CUES_ID  0x43554553
#define DAOX_ID  0x44414f58
#define DAOI_ID  0x44414f49
#define END1_ID  0x454e4421
#define ETN2_ID  0x45544e32
#define ETNF_ID  0x45544e46
#define NER5_ID  0x4e455235
#define NERO_ID  0x4e45524f
#define SINF_ID  0x53494e46

/* reader */

#define DEFAULT_CDIO_DEVICE "image.nrg"

typedef struct {
  int            blocksize;
  int            track_num; /* Probably is index+1 */
  msf_t          start_msf;
  int            start_index;
  int            secsize;   /* Number of sectors in track. Does not 
			       include pregap before next entry. */
  int            flags;     /* "DCP", "4CH", "PRE" */
  track_format_t track_format;
  bool           track_green;
} track_info_t;

/* 
   Link element of track structure as a linked list.
   Possibly redundant with above track_info_t */
typedef struct {
  uint32_t start_lsn;
  uint32_t secsize;     /* Number of sectors in track. Does not 
			   include pregap before next entry. */
  uint64_t img_offset;  /* Bytes offset from beginning of disk image file.*/
} _mapping_t;


typedef struct {
  bool sector_2336_flag;
  CdioDataSource *nrg_src;
  char           *source_name;
  track_info_t    tocent[100];     /* entry info for each track */
  track_t         total_tracks;    /* number of tracks in image */
  track_t         first_track_num; /* track number of first track */
  CdioList       *mapping;         /* List of track information */
  uint32_t size;
  bool init;
} _img_private_t;

static bool     _cdio_parse_nero_footer (_img_private_t *_obj);
static uint32_t _cdio_stat_size (void *user_data);

/*!
  Release and free resources used here.
 */
static void
_cdio_free (void *user_data)
{
  _img_private_t *_obj = user_data;

  free(_obj->source_name);

  if (_obj->nrg_src)
    cdio_stream_destroy (_obj->nrg_src);

  _cdio_list_free (_obj->mapping, true);

  free (_obj);
}

/* Updates internal track TOC, so we can later 
   simulate ioctl(CDROMREADTOCENTRY).
 */
static void
_register_mapping (_img_private_t *_obj, lsn_t start_lsn, uint32_t secsize,
		   uint64_t img_offset, uint32_t blocksize)
{
  const int track_num=_obj->total_tracks;
  _mapping_t *_map = _cdio_malloc (sizeof (_mapping_t));

  if (!_obj->mapping)
    _obj->mapping = _cdio_list_new ();

  _cdio_list_append (_obj->mapping, _map);
  _map->start_lsn = start_lsn;
  _map->secsize = secsize;
  _map->img_offset = img_offset;

  _obj->size = MAX (_obj->size, (start_lsn + secsize));

  /* Update _obj->tocent[track_num] and track_num These structures are
     in a sense redundant witht the obj->mapping list. Perhaps one
     or the other can be eliminated.
   */

  cdio_lba_to_msf (cdio_lsn_to_lba(start_lsn), 
		   &_obj->tocent[track_num].start_msf);
  
  _obj->tocent[track_num].track_num   = track_num+1;
  _obj->tocent[track_num].blocksize   = blocksize;
  _obj->tocent[track_num].secsize     = secsize;
  _obj->tocent[track_num].secsize     = secsize;

  _obj->total_tracks++;

  /* FIXME: These are probably not right. Probably we need to look at 
     "type." But this hasn't been reverse engineered yet.
   */
  _obj->tocent[track_num].track_format= TRACK_FORMAT_XA;
  _obj->tocent[track_num].track_green = true;


  /* cdio_debug ("map: %d +%d -> %ld", start_lsn, secsize, img_offset); */
}


/* 
   Disk and track information for a Nero file are located at the end
   of the file. This routine extracts that information.
 */
static bool
_cdio_parse_nero_footer (_img_private_t *_obj)
{
  long unsigned int footer_start;
  long unsigned int size;
  char *footer_buf = NULL;

  if (_obj->size)
    return 0;

  size = cdio_stream_stat (_obj->nrg_src);

  {
PRAGMA_BEGIN_PACKED
    union {
      struct {
	uint32_t __x          GNUC_PACKED;
	uint32_t ID           GNUC_PACKED;
	uint32_t footer_ofs   GNUC_PACKED;
      } v50;
      struct {
	uint32_t ID           GNUC_PACKED;
	uint64_t footer_ofs   GNUC_PACKED;
      } v55;
    } buf;
PRAGMA_END_PACKED

    cdio_assert (sizeof (buf) == 12);

    cdio_stream_seek (_obj->nrg_src, size - sizeof (buf));
    cdio_stream_read (_obj->nrg_src, (void *) &buf, sizeof (buf), 1);
    
    if (buf.v50.ID == UINT32_TO_BE (0x4e45524f)) /* "NERO" */
      {
	cdio_info ("detected v50 (32bit offsets) NRG magic");
	footer_start = uint32_to_be (buf.v50.footer_ofs); 
      }
    else if (buf.v55.ID == UINT32_TO_BE (0x4e455235)) /* "NER5" */
      {
	cdio_info ("detected v55 (64bit offsets) NRG magic");
	footer_start = uint64_from_be (buf.v55.footer_ofs);
      }
    else
      {
	cdio_error ("Image not recognized as either v50 or v55 type NRG");
	return -1;
      }

    cdio_debug ("nrg footer start = %ld, length = %ld", 
	       (long) footer_start, (long) (size - footer_start));

    cdio_assert (IN ((size - footer_start), 0, 4096));

    footer_buf = _cdio_malloc (size - footer_start);

    cdio_stream_seek (_obj->nrg_src, footer_start);
    cdio_stream_read (_obj->nrg_src, footer_buf, size - footer_start, 1);
  }

  {
    int pos = 0;

    while (pos < size - footer_start) {
      _chunk_t *chunk = (void *) (footer_buf + pos);
      
      bool break_out = false;
      
      switch (UINT32_FROM_BE (chunk->id)) {
      case CUES_ID: { /* "CUES" */
	unsigned entries = UINT32_FROM_BE (chunk->len);
	_cuex_array_t *_entries = (void *) chunk->data;
	
	cdio_assert (_obj->mapping == NULL);
	
	cdio_assert (sizeof (_cuex_array_t) == 8);
	cdio_assert ( UINT32_FROM_BE(chunk->len) % sizeof(_cuex_array_t) 
		      == 0 );
	
	entries /= sizeof (_cuex_array_t);
	
	cdio_info ("CUES type image detected");
	
	{
	  lsn_t lsn = UINT32_FROM_BE (_entries[0].lsn);
	  int idx;
	  
	  /*cdio_assert (lsn == 0?);*/
	  
	  _obj->total_tracks    = 0;
	  _obj->first_track_num = 1;
	  for (idx = 1; idx < entries-1; idx += 2) {
	    lsn_t lsn2;
	    
	    cdio_assert (_entries[idx].index == 0);
	    cdio_assert (_entries[idx].track == _entries[idx + 1].track);
	    
	    lsn  = UINT32_FROM_BE (_entries[idx].lsn);
	    lsn2 = UINT32_FROM_BE (_entries[idx + 1].lsn);

	    _register_mapping (_obj, lsn, lsn2 - lsn, 
			       (lsn+CDIO_PREGAP_SECTORS) * CD_RAW_SECTOR_SIZE,
			       CD_RAW_SECTOR_SIZE);
	  }
	} 
	break;
      }
	
      case CUEX_ID: /* "CUEX" */ {
	unsigned entries = UINT32_FROM_BE (chunk->len);
	_cuex_array_t *_entries = (void *) chunk->data;
	
	cdio_assert (_obj->mapping == NULL);
	
	cdio_assert ( sizeof (_cuex_array_t) == 8 );
	cdio_assert ( UINT32_FROM_BE (chunk->len) % sizeof(_cuex_array_t) 
		      == 0 );
	
	entries /= sizeof (_cuex_array_t);
	
	cdio_info ("DAO type image detected");
	
	{
	  uint32_t lsn = UINT32_FROM_BE (_entries[0].lsn);
	  int idx;
	  
	  cdio_assert (lsn == 0xffffff6a);
	  
	  for (idx = 2; idx < entries; idx += 2) {
	    lsn_t lsn2;

	    cdio_assert (_entries[idx].index == 1);
	    cdio_assert (_entries[idx].track != _entries[idx + 1].track);
	    
	    lsn = UINT32_FROM_BE (_entries[idx].lsn);
	    lsn2 = UINT32_FROM_BE (_entries[idx + 1].lsn);
	    
	    _register_mapping (_obj, lsn, lsn2 - lsn, 
			       (lsn + CDIO_PREGAP_SECTORS)*M2RAW_SECTOR_SIZE, 
			       M2RAW_SECTOR_SIZE);
	  }
	}    
	break;
      }
	
      case DAOI_ID: /* "DAOI" */
	cdio_debug ("DAOI tag detected...");
	break;
      case DAOX_ID: /* "DAOX" */
	cdio_debug ("DAOX tag detected...");
	break;
	
      case NER5_ID: /* "NER5" */
	cdio_error ("unexpected nrg magic ID NER5 detected");
	return -1;
	break;

      case NERO_ID: /* "NER0" */
	cdio_error ("unexpected nrg magic ID NER0 detected");
	return -1;
	break;
	
      case END1_ID: /* "END!" */
	cdio_debug ("nrg end tag detected");
	break_out = true;
	break;
	
      case ETNF_ID: /* "ETNF" */ {
	unsigned entries = UINT32_FROM_BE (chunk->len);
	_etnf_array_t *_entries = (void *) chunk->data;
	
	cdio_assert (_obj->mapping == NULL);
	
	cdio_assert ( sizeof (_etnf_array_t) == 20 );
	cdio_assert ( UINT32_FROM_BE(chunk->len) % sizeof(_etnf_array_t) 
		      == 0 );
	
	entries /= sizeof (_etnf_array_t);
	
	cdio_info ("SAO type image (ETNF) detected");
	
	_obj->sector_2336_flag = true;

	{
	  int idx;
	  for (idx = 0; idx < entries; idx++) {
	    uint32_t _len = UINT32_FROM_BE (_entries[idx].length);
	    uint32_t _start = UINT32_FROM_BE (_entries[idx].start_lsn);
	    uint32_t _start2 = UINT32_FROM_BE (_entries[idx].start);
	    
	    cdio_assert (UINT32_FROM_BE (_entries[idx].type) == 3);
	    cdio_assert (_len % M2RAW_SECTOR_SIZE == 0);
	    
	    _len /= M2RAW_SECTOR_SIZE;
	    
	    cdio_assert (_start * M2RAW_SECTOR_SIZE == _start2);
	    
	    _start += idx * CDIO_PREGAP_SECTORS;
	    
	    _register_mapping (_obj, _start, _len, _start2, M2RAW_SECTOR_SIZE);
	  }
	}
	break;
      }
      
      case ETN2_ID: { /* "ETN2", same as above, but with 64bit stuff instead */
	unsigned entries = uint32_from_be (chunk->len);
	_etn2_array_t *_entries = (void *) chunk->data;
	
	cdio_assert (_obj->mapping == NULL);
	
	cdio_assert (sizeof (_etn2_array_t) == 32);
	cdio_assert (uint32_from_be (chunk->len) % sizeof (_etn2_array_t) == 0);
	
	entries /= sizeof (_etn2_array_t);
	
	cdio_info ("SAO type image (ETN2) detected");

	_obj->sector_2336_flag = true;
	
	{
	  int idx;
	  for (idx = 0; idx < entries; idx++) {
	    uint32_t _len = uint64_from_be (_entries[idx].length);
	    uint32_t _start = uint32_from_be (_entries[idx].start_lsn);
	    uint32_t _start2 = uint64_from_be (_entries[idx].start);
	    
	    cdio_assert (uint32_from_be (_entries[idx].type) == 3);
	    cdio_assert (_len % M2RAW_SECTOR_SIZE == 0);
	    
	    _len /= M2RAW_SECTOR_SIZE;
	    
	    cdio_assert (_start * M2RAW_SECTOR_SIZE == _start2);
	    
	    _start += idx * CDIO_PREGAP_SECTORS;
	    
	    _register_mapping (_obj, _start, _len, _start2, M2RAW_SECTOR_SIZE);
	  }
	}
	break;
      }
	
      case SINF_ID: { /* "SINF" */
	
	uint32_t *_sessions = (void *) chunk->data;
	
	cdio_assert (UINT32_FROM_BE (chunk->len) == 4);
	
	cdio_debug ("SINF: %d sessions", UINT32_FROM_BE (*_sessions));
      }
	break;
	
      default:
	cdio_warn ("unknown tag %8.8x seen", UINT32_FROM_BE (chunk->id));
	break;
      }
	
      if (break_out)
	break;
      
      pos += 8;
      pos += UINT32_FROM_BE (chunk->len);
    }
  }

  /* Fake out leadout track. */
  /* Don't use _cdio_stat_size since that will lead to recursion since
     we haven't fully initialized things yet.
  */
  cdio_lsn_to_msf (_obj->size, &_obj->tocent[_obj->total_tracks].start_msf);

  return 0;
}

/*!
  Initialize image structures.
 */
static bool
_cdio_init (_img_private_t *_obj)
{
  if (_obj->init) {
    cdio_error ("init called more than once");
    return false;
  }
  
  if (!(_obj->nrg_src = cdio_stdio_new (_obj->source_name))) {
    cdio_error ("init failed");
    return false;
  }

  _cdio_parse_nero_footer (_obj);
  _obj->init = true;
  return true;

}

static uint32_t 
_cdio_stat_size (void *user_data)
{
  _img_private_t *_obj = user_data;

  return _obj->size;
}

  static int
_read_mode2_sector (void *user_data, void *data, lsn_t lsn, bool form2)
{
  _img_private_t *_obj = user_data;
  char buf[CD_RAW_SECTOR_SIZE] = { 0, };
  CdioListNode *node;

  if (lsn >= _obj->size)
    {
      cdio_warn ("trying to read beyond image size (%d >= %u)", lsn, 
		_obj->size);
      return -1;
    }

  _CDIO_LIST_FOREACH (node, _obj->mapping)
    {
      _mapping_t *_map = _cdio_list_node_data (node);

      if (IN (lsn, _map->start_lsn, (_map->start_lsn + _map->secsize - 1)))
	{
	  long img_offset = _map->img_offset;
	  int blocksize = _obj->sector_2336_flag 
	    ? M2RAW_SECTOR_SIZE : CD_RAW_SECTOR_SIZE;

	  img_offset += (lsn - _map->start_lsn) * blocksize;
	  
	  cdio_stream_seek (_obj->nrg_src, img_offset); 
	  cdio_stream_read (_obj->nrg_src, 
			    _obj->sector_2336_flag ? (buf + 12 + 4) : buf,
			    blocksize, 1); 
	  
	  break;
	}
    }

  if (!node)
    cdio_warn ("reading into pre gap (lsn %d)", lsn);

  if (form2)
    memcpy (data, buf + 12 + 4, M2RAW_SECTOR_SIZE);
  else
    memcpy (data, buf + 12 + 4 + 8, M2F1_SECTOR_SIZE);

  return 0;
}

/*!
   Reads nblocks of mode2 sectors from cd device into data starting
   from lsn.
   Returns 0 if no error. 
 */
static int
_read_mode2_sectors (void *user_data, void *data, uint32_t lsn, 
		     bool mode2_form2, unsigned nblocks)
{
  _img_private_t *_obj = user_data;
  int i;
  int retval;

  for (i = 0; i < nblocks; i++) {
    if (mode2_form2) {
      if ( (retval = _read_mode2_sector (_obj, 
					  ((char *)data) + (M2RAW_SECTOR_SIZE * i),
					  lsn + i, true)) )
	return retval;
    } else {
      char buf[M2RAW_SECTOR_SIZE] = { 0, };
      if ( (retval = _read_mode2_sector (_obj, buf, lsn + i, true)) )
	return retval;
      
      memcpy (((char *)data) + (M2F1_SECTOR_SIZE * i), buf + 8, 
	      M2F1_SECTOR_SIZE);
    }
  }
  return 0;
}

/*!
  Set the device to use in I/O operations.
*/
static int
_cdio_set_arg (void *user_data, const char key[], const char value[])
{
  _img_private_t *_obj = user_data;

  if (!strcmp (key, "source"))
    {
      free (_obj->source_name);

      if (!value)
	return -2;

      _obj->source_name = strdup (value);
    }
  else
    return -1;

  return 0;
}

/*!
  Eject media -- there's nothing to do here. We always return 2.
  also free obj.
 */
static int 
_cdio_eject_media (void *user_data) {
  /* Sort of a stub here. Perhaps log a message? */
  return 2;
}

/*!
  Return the value associated with the key "arg".
*/
static const char *
_cdio_get_arg (void *user_data, const char key[])
{
  _img_private_t *_obj = user_data;

  if (!strcmp (key, "source")) {
    return _obj->source_name;
  } 
  return NULL;
}

/*!
  Return a string containing the default VCD device if none is specified.
 */
static char *
_cdio_get_default_device()
{
  return strdup(DEFAULT_CDIO_DEVICE);
}

/*!
  Return the number of of the first track. 
  CDIO_INVALID_TRACK is returned on error.
*/
static track_t
_cdio_get_first_track_num(void *user_data) 
{
  _img_private_t *_obj = user_data;
  
  return _obj->first_track_num;
}

/*!
  Return the number of tracks. We fake it an just say there's
  one big track. 
*/
static track_t
_cdio_get_num_tracks(void *user_data) 
{
  _img_private_t *_obj = user_data;

  return _obj->total_tracks;
}

/*!
  Return the number of tracks in the current medium.
  CDIO_INVALID_TRACK is returned on error.
*/
static track_format_t
_cdio_get_track_format(void *user_data, track_t track_num) 
{
  _img_private_t *_obj = user_data;
  
  if (track_num > _obj->total_tracks || track_num == 0) 
    return TRACK_FORMAT_ERROR;

  return _obj->tocent[track_num-1].track_format;
}

/*!
  Return true if we have XA data (green, mode2 form1) or
  XA data (green, mode2 form2). That is track begins:
  sync - header - subheader
  12     4      -  8
  
  FIXME: there's gotta be a better design for this and get_track_format?
*/
static bool
_cdio_get_track_green(void *user_data, track_t track_num) 
{
  _img_private_t *_obj = user_data;
  
  if (track_num > _obj->total_tracks || track_num == 0) 
    return false;

  return _obj->tocent[track_num-1].track_green;
}

/*!  
  Return the starting MSF (minutes/secs/frames) for the track number
  track_num in obj.  Tracks numbers start at 1.
*/
static bool
_cdio_get_track_msf(void *user_data, track_t track_num, msf_t *msf)
{
  _img_private_t *_obj = user_data;

  if (NULL == msf) return 1;

  if (track_num == CDIO_LEADOUT_TRACK) track_num = _obj->total_tracks+1;

  if (track_num <= _obj->total_tracks+1 && track_num != 0) {
    *msf = _obj->tocent[track_num-1].start_msf;
    return true;
  } else 
    return false;
}

CdIo *
cdio_open_nrg (const char *source_name)
{
  CdIo *ret;
  _img_private_t *_data;

  cdio_funcs _funcs = {
    .eject_media        = _cdio_eject_media,
    .free               = _cdio_free,
    .get_arg            = _cdio_get_arg,
    .get_default_device = _cdio_get_default_device,
    .get_first_track_num= _cdio_get_first_track_num,
    .get_num_tracks     = _cdio_get_num_tracks,
    .get_track_format   = _cdio_get_track_format,
    .get_track_green    = _cdio_get_track_green,
    .get_track_lba      = NULL, /* This could be implemented if need be. */
    .get_track_msf      = _cdio_get_track_msf,
    .read_mode2_sector  = _read_mode2_sector,
    .read_mode2_sectors = _read_mode2_sectors,
    .set_arg            = _cdio_set_arg,
    .stat_size          = _cdio_stat_size,
  };

  _data                 = _cdio_malloc (sizeof (_img_private_t));
  _data->init           = false;


  _data->total_tracks   = 0;
  _data->first_track_num= 1;
  _data->sector_2336_flag  = false;

  _cdio_set_arg(_data, "source", (NULL == source_name) 
		? DEFAULT_CDIO_DEVICE: source_name);

  ret = cdio_new (_data, &_funcs);
  if (ret == NULL) return NULL;

  if (_cdio_init(_data))
    return ret;
  else {
    _cdio_free (_data);
    return NULL;
  }

}

bool
cdio_have_nrg (void)
{
  return true;
}