README for miragextract v0.2.0
==============================

Description
-----------
A pair of tools for working with CD image files.

miragextract extracts data and audio tracks from any CD image supported
by libmirage. Data tracks are written as-is, and audio tracks can be
written as-is or converted to wav, flag, or ogg/vorbis (via libsndfile).

cuerecover attempts to create a .cue file for .bin files whose .cue
files are missing.

Prerequisites
-------------
Requires GNU make, libmirage >= 3.0.5 and libsndfile (tested with 1.0.26,
other recent-ish versions should work). Since libmirage uses glib2,
you'll need that as well.

For libsndfile to create flac and ogg files, it has to have been
built with support for them, which should only be a concern if you're
building libsndfile yourself (distro packages should have ogg/flac
support already).

If you're on a system that has separate "dev" or "devel" packages
(e.g. libmirage and libmirage-dev), you'll want the "dev" packages.

If you for some reason need to rebuild the man and html pages, you'll
need docutils (I used 0.14).

If you *just* want cuerecover, you don't need libmirage nor libsndfile.
Run "make cuerecover" in this case.

Installation
------------
To build, run "make" (might be spelled "gmake" on your OS). To install,
"make install". Near the top of the Makefile are some variables you
can override on the make command line to control where everything gets
installed.

Supported formats
-----------------
According to the README from libmirage-3.2.4:

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

> Currently supported filter streams:
>  - Apple Disk Image (DMG) container format (readonly)
>  - Apple Disk Image (IMG, SMI) via MacBinary container format (readonly)
>  - GZip (GZ) container format (readonly)
>  - XZ (XZ) container format (readonly)
>  - Compressed ISO (CSO) container format (readonly)
>  - Compressed ISO (ISZ) container format (readonly)
>  - Error Code Modeller (ECM) container format (readonly)
>  - PowerISO (DAA) image format (readonly)
>  - SNDFILE audio files (read-write)

Not all these formats have been tested with miragextract. I have tested
bin/cue (both single-bin and multi-bin), mds, ecm, nrg, and ccd as of
this writing, and all work fine.

Author and Copyright
--------------------
miragextract was written by B. Watson <yalchru@gmail.com>, and is released
under the WTFPL: Do WTF you want with this.

Support
-------
None guaranteed. If you run into problems, first try the latest code
from git, which you can find at:

http://urchlay.naptime.net/repos/miragextract/

If this doesn't help, contact me by email (see above) and I'll see what
I can do.

Acknowledgments
---------------
The idea for miragextract came from John Oyler, who asked "Why do I
need separate utilities for all these different CD image formats? Why
couldn't there be a single tool that knows them all?"

miragextract stands on the shoulders of giants:

Erik de Castro Lopo is the main author of libsndfile, along with a long
list of contributors.

Rok Mandeljc and Henrik Stokseth are the authors of libmirage.