aboutsummaryrefslogtreecommitdiff
path: root/cuerecover.html
blob: c4c596713f4f65b7b44782f1419f04a9cc6af395 (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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" />
<title>cuerecover</title>
<meta name="date" content="2020-05-13" />
<style type="text/css">

/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
  border: 0 }

table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }

.first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

.subscript {
  vertical-align: sub;
  font-size: smaller }

.superscript {
  vertical-align: super;
  font-size: smaller }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
  overflow: hidden;
}

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em ;
  margin-right: 2em }

div.footer, div.header {
  clear: both;
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin: 0 0 0.5em 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

img.align-left, .figure.align-left, object.align-left, table.align-left {
  clear: left ;
  float: left ;
  margin-right: 1em }

img.align-right, .figure.align-right, object.align-right, table.align-right {
  clear: right ;
  float: right ;
  margin-left: 1em }

img.align-center, .figure.align-center, object.align-center {
  display: block;
  margin-left: auto;
  margin-right: auto;
}

table.align-center {
  margin-left: auto;
  margin-right: auto;
}

.align-left {
  text-align: left }

.align-center {
  clear: both ;
  text-align: center }

.align-right {
  text-align: right }

/* reset inner alignment in figures */
div.align-right {
  text-align: inherit }

/* div.align-center * { */
/*   text-align: left } */

.align-top    {
  vertical-align: top }

.align-middle {
  vertical-align: middle }

.align-bottom {
  vertical-align: bottom }

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font: inherit }

pre.literal-block, pre.doctest-block, pre.math, pre.code {
  margin-left: 2em ;
  margin-right: 2em }

pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }

table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
  border: 0px;
  border-top: 2px solid;
  border-bottom: 2px solid;
  border-collapse: collapse;
}
table.docutils.booktabs * {
  border: 0px;
}
table.docutils.booktabs th {
  border-bottom: thin solid;
  text-align: left;
}

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document" id="cuerecover">
<h1 class="title">cuerecover</h1>
<h2 class="subtitle" id="generate-cue-file-for-cd-image-bin">generate .cue file for CD image .bin</h2>
<table class="docinfo" frame="void" rules="none">
<col class="docinfo-name" />
<col class="docinfo-content" />
<tbody valign="top">
<tr class="manual-section field"><th class="docinfo-name">Manual section:</th><td class="field-body">1</td>
</tr>
<tr class="manual-group field"><th class="docinfo-name">Manual group:</th><td class="field-body">Urchlay</td>
</tr>
<tr><th class="docinfo-name">Date:</th>
<td>2020-05-13</td></tr>
<tr><th class="docinfo-name">Version:</th>
<td>0.2.0</td></tr>
</tbody>
</table>
<!-- 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. -->
<div class="section" id="synopsis">
<h1>SYNOPSIS</h1>
<p>cuerecover [-o output] [-s sec] [-t thresh] <strong>bin-file</strong> [<strong>bin-file</strong> ...]</p>
</div>
<div class="section" id="description">
<h1>DESCRIPTION</h1>
<p>cuerecover attempts to generate a usable cue sheet for CD images which
are missing their .cue (or .ccd, .mds, etc) files.</p>
<p>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.</p>
<p>For data tracks, the recovered track should be correct, provided the
bin file wasn't truncated or otherwise corrupted.</p>
<p>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.</p>
</div>
<div class="section" id="options">
<h1>OPTIONS</h1>
<table class="docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group">
<kbd><span class="option">--help</span></kbd></td>
<td>Print short usage string.</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-o <var>&lt;file&gt;</var></span></kbd></td>
<td>Write cue file to <em>file</em> rather than standard output. If
<em>file</em> already exists, cuerecover will refuse to overwrite it,
which makes this safer than redirecting stdout. It's customary
for cue files to have the same filename as their bin file(s),
with the .bin replaced by .cue, but it's not actually required.</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-s <var>&lt;sec&gt;</var></span></kbd></td>
<td>Minimum amount of silence for detecting the split point between
two audio tracks. Argument is in seconds, and decimals
are allowed. The default is 2, which is the standard sized
gap between tracks in the Redbook standard and in most CD
authoring software. 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.</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-t <var>&lt;thresh&gt;</var></span></kbd></td>
<td>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. This option is ignored
when multiple .bin file arguments are given, since they're already
split into tracks.</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-v</span></kbd></td>
<td>Verbose mode. Prints (on stderr) some extra messages about what
cuerecover is doing. Probably only of interest to the author.</td></tr>
</tbody>
</table>
<p>Always include a space between an option and its argument (e.g. <strong>-s 1</strong>, not <strong>-s1</strong>).</p>
</div>
<div class="section" id="notes">
<h1>NOTES</h1>
<p>cuerecover works a lot better when it's reading a split image (one file
per track).</p>
<p>When reading a monolithic image (multiple tracks the same file),
cuerecover has to make some assumptions. These are usually valid, but
should be mentioned here:</p>
<ul class="simple">
<li>The disc image is a single session. Actually multisession discs might
work too, but I have no examples to test with. If you're dealing with
an image of a commercial release (a game, probably), it'll be single
session.</li>
<li>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.</li>
<li>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.</li>
<li>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 (or more likely 20 or 30
audio tracks), and you'll get a warning that it looks like 'cooked'
data. 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'.</li>
<li>If a data track gets mis-identified as a file, it'll be obvious if
you use the .cue sheet to extract the image into files: you'll
probably get way too many tracks, since most filesystem images have
long stretches of &quot;silence&quot; (long runs of zeroes). If you try to listen
to these, you'll notice that ISO images don't sound musical at all!
The last few tracks will be the largest, and these will be valid audio,
if there were any audio tracks.</li>
<li>Audio tracks are separated by at least 2 seconds of silence (or whatever
you set -s to). If not, there's no way to detect where one track ends
and the next begins, so they'll get merged together.</li>
<li>In the best case scenario, cuerecover will generate <em>a</em> 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 and 2 seconds of silence at the start of
track 3, or vice versa, or 1.5 seconds each, or...?</li>
</ul>
<!-- other sections we might want, uncomment as needed. -->
<!-- FILES -->
<!-- ===== -->
<!-- ENVIRONMENT -->
<!-- =========== -->
</div>
<div class="section" id="exit-status">
<h1>EXIT STATUS</h1>
<p>As usual, 0 for success, non-zero for failure.</p>
<!-- BUGS -->
<!-- ==== -->
<!-- EXAMPLES -->
<!-- ======== -->
</div>
<div class="section" id="author">
<h1>AUTHOR</h1>
<p>cuerecover was written by B. Watson &lt;<a class="reference external" href="mailto:yalhcru&#64;gmail.com">yalhcru&#64;gmail.com</a>&gt; and
released under the WTFPL: Do WTF you want with this.</p>
</div>
<div class="section" id="see-also">
<h1>SEE ALSO</h1>
<p>miragextract(1)</p>
<p>The manual for GNU ccd2cue(1) has useful information on the .cue
file format:</p>
<blockquote>
<a class="reference external" href="https://www.gnu.org/software/ccd2cue/manual/html_node/CUE-sheet-format.html">https://www.gnu.org/software/ccd2cue/manual/html_node/CUE-sheet-format.html</a></blockquote>
<p>More information on the CD-ROM data formats:</p>
<blockquote>
<a class="reference external" href="https://wiki.osdev.org/User:Combuster/CDRom_BS">https://wiki.osdev.org/User:Combuster/CDRom_BS</a>
<a class="reference external" href="https://en.wikipedia.org/wiki/CD-ROM">https://en.wikipedia.org/wiki/CD-ROM</a></blockquote>
</div>
</div>
</body>
</html>