aboutsummaryrefslogtreecommitdiff
path: root/cuerecover.rst
blob: d4d932b72ef1af4a7b43906ae9035bb8900f4f84 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
.. RST source for cuerecover(1) man page. Convert with:
..   rst2man.py cuerecover.rst > cuerecover.1
.. rst2man.py comes from the SBo development/docutils package.

.. note to self: don't forget to check the generated man and html pages
.. into git since we don't want to require our users to have rst2man.py.

.. |version| replace:: 0.1.0
.. |date| date::

==========
cuerecover
==========

------------------------------------
generate .cue file for CD image .bin
------------------------------------

:Manual section: 1
:Manual group: Urchlay
:Date: |date|
:Version: |version|

SYNOPSIS
========

cuerecover [-s sec] **bin-file** [**bin-file** ...]

DESCRIPTION
===========

cuerecover attempts to generate a usable cue sheet for CD images which
are missing their .cue (or .ccd, .mds, etc) files. The generated cue
sheet is written to standard output [*], so add e.g. "> filename.cue"
to redirect it to a file.

If a single .bin file is given, it's assumed to hold all the tracks (which
might only be one). If multiple .bin files are given, each one is assumed to
represent one track of the same CD image.

For data tracks, the recovered track should be correct, provided the
bin file wasn't truncated or otherwise corrupted.

For audio tracks, silence detection is used to find the start of the track
(the INDEX 01 in the .cue file).

For audio tracks in a single .bin file, silence detection is used to
find the split points between tracks. This means that in cases where
one track segues into another, the two tracks will be combined in the
resulting cue sheet. Also, if there are long periods of silence within
a single track, this track will be split into two or more tracks.

[*] *Only* the .cue file is written to stdout. Status and progress
messages are printed to standard error.

OPTIONS
=======

--help
             Print short usage string.

-s <sec>     Minimum amount of silence for detecting the split point between
             two audio tracks (default: 2). Argument is in seconds, and
             non-integers are allowed. 0 means to disable splitting tracks:
             all the audio tracks will be combined into one in the .cue
             sheet. This option is ignored when multiple .bin file arguments
             are given, since they're already split into tracks.

-t <thresh>  Silence threshold, 0 to 100. Default is 0. This is
             the percentage of non-zero bytes allowed in a sector for it
             to be considered silent. Sometimes audio tracks have random
             data in the pregap (before the INDEX 01), which will fool
             cuerecover into thinking there's no pregap. This option can
             help with those, but don't set it too high.

-v           Verbose mode. Prints (on stderr) some extra messages about what
             cuerecover is doing. Probably only of interest to the author.

Always include a space between an option and its argument (e.g. **-s 1**, not **-s1**).

NOTES
=====

When reading multiple tracks from the same file, cuerecover makes some
assumptions. These are usually valid, but should be mentioned here:

- The tracks are all MODE1 (data), MODE2 (also data, usually video CDs) or
  CD-DA (regular CD audio). Extended format CDs like XA or CD+I are not
  supported, though you might still get listenable audio tracks from them.

- If there's a data track, it will be the only data track, and it will be
  track 1. This is almost always the case, since most operating systems
  from the CD-ROM era (and even modern ones) don't provide access to
  data tracks that aren't the first track on the disc.

- If there's a data track, it's a raw image (2352 bytes per sector, includes
  the sync pulse, address, CRC, ECC, etc). If the data track was stored as
  'cooked' data (2048 bytes/sector, MODE1/2048 in the original .cue file),
  it'll be treated as an audio track. You can check for this by trying to
  mount the .bin file as an ISO or HFS image: if it mounts, the first
  track is 'cooked'. It'll also be obvious if you use the .cue sheet to
  extract the image into files: ISO images don't sound musical at all!

- cuerecover will generate *a* cue file, which will be valid... but it may
  not match the original (missing) one exactly. This is because cuerecover
  has to look for silent sections of the image and use those as split points
  for the tracks. If there's a 3-second silent section between tracks 2 and
  3, is that 1 second of silence at the end of track 2 + 2 seconds of silence
  at the start of track 3, or vice versa, or 1.5 seconds each, or...?

.. other sections we might want, uncomment as needed.

.. FILES
.. =====

.. ENVIRONMENT
.. ===========

EXIT STATUS
===========

As usual, 0 for success, non-zero for failure.

.. BUGS
.. ====

.. EXAMPLES
.. ========

AUTHORS
=======

cuerecover was written by B. Watson <yalhcru@gmail.com> and
released under the WTFPL: Do WTF you want with this.

SEE ALSO
========

miragextract(1)