libMirage
2.0.0
~~~~~


Table of Contents:
~~~~~~~~~~~~~~~~~~

1. Introduction
2. Requirements
3. Installation
4. Contact information


1. Introduction
~~~~~~~~~~~~~~~

This is libMirage library, a CD-ROM image access library, and part of the
userspace-cdemu suite, a free, GPL CD/DVD-ROM device emulator for linux. It is
written in C and based on GLib.

The aim of libMirage is to provide uniform access to the data stored in
different image formats, by creating a representation of disc stored in image
file, which is based on GObjects. There are various objects that represent
different parts of the disc; disc, session, track, sector, etc. In addition to
providing access to data provided by the image file, libMirage is also capable
of generating some of the data that might not be present in image file. For
instance, ISO image provides only user data from sector, without sync pattern,
header, ECC/EDC codes or subchannel. When this missing data is requested,
libMirage will transparently generate it.

Currently supported image formats:
 - BlindWrite 5/6 (B5T, B6T) file format
 - Roxio / WinOnCD (C2D) file format
 - CloneCD (CCD, SUB, IMG) image format
 - DiscJuggler (CDI) file format
 - Easy CD Creator (CIF) file format
 - CDRwin (CUE, BIN) image format
 - Raw track loader (ISO, UDF etc.) image format
 - Alcohol 120% (MDS) image format
 - Daemon Tools (MDX) image format
 - Nero Burning ROM (NRG) image format
 - ReadCD (TOC, BIN) image format
 - Cdrdao's (TOC, BIN) image format
 - XCDRoast (TOC, BIN) image format

Currently supported file filters:
 - Apple Disk Image (DMG) container format
 - GZip (GZ) container format
 - XZ (XZ) container format
 - Compressed ISO (CSO) container format
 - Compressed ISO (ISZ) container format
 - Error Code Modeller (ECM) container format
 - PowerISO (DAA) image format

libMirage has a plug-in based system, which allows a simple addition of new
image format parsers or data-file access fragments. It also supports runtime
debugging via debug traces; there are special debug context objects that can
be attached to other objects and used to control the amount of verbosity.


2. Requirements:
~~~~~~~~~~~~~~~~
 - GLib 2.28 or newer
 - libsndfile 1.0.0 or newer
 - zlib

 - gtk-doc (optional)


3. Installation:
~~~~~~~~~~~~~~~~

Installation process is generic ./configure, make, make install as described in
INSTALL file.


4. Contact information:
~~~~~~~~~~~~~~~~~~~~~~~

CDEmu project's web page: http://cdemu.sourceforge.net
CDEmu project's mailing list: cdemu-devel@lists.sourceforge.net

Author can be directly contacted via e-mail address listed in AUTHORS file.
