-
Notifications
You must be signed in to change notification settings - Fork 87
/
cdparanoia.py
616 lines (503 loc) · 20.7 KB
/
cdparanoia.py
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
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
# -*- Mode: Python; test-case-name: whipper.test.test_program_cdparanoia -*-
# vi:si:et:sw=4:sts=4:ts=4
# Copyright (C) 2009 Thomas Vander Stichele
# This file is part of whipper.
#
# whipper 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 3 of the License, or
# (at your option) any later version.
#
# whipper 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 whipper. If not, see <http://www.gnu.org/licenses/>.
import errno
import os
import re
import shutil
import stat
import subprocess
import tempfile
import time
from whipper.common import common
from whipper.common import task as ctask
from whipper.extern import asyncsub
from whipper.extern.task import task
import logging
logger = logging.getLogger(__name__)
class FileSizeError(Exception):
message = None
"""
The given path does not have the expected size.
"""
def __init__(self, path, message):
self.args = (path, message)
self.path = path
self.message = message
class ReturnCodeError(Exception):
"""
The program had a non-zero return code.
"""
def __init__(self, returncode):
self.args = (returncode, )
self.returncode = returncode
class ChecksumException(Exception):
pass
# example:
# ##: 0 [read] @ 24696
_PROGRESS_RE = re.compile(r"""
^\#\#: (?P<code>.+)\s # function code
\[(?P<function>.*)\]\s@\s # [function name] @
(?P<offset>\d+) # offset in words (2-byte one channel value)
""", re.VERBOSE)
_ERROR_RE = re.compile("^scsi_read error:")
# from reading cdparanoia source code, it looks like offset is reported in
# number of single-channel samples, ie. 2 bytes (word) per unit, and absolute
class ProgressParser:
read = 0 # last [read] frame
wrote = 0 # last [wrote] frame
errors = 0 # count of number of scsi errors
_nframes = None # number of frames read on each [read]
_firstFrames = None # number of frames read on first [read]
reads = 0 # total number of reads
def __init__(self, start, stop):
"""
@param start: first frame to rip
@type start: int
@param stop: last frame to rip (inclusive)
@type stop: int
"""
self.start = start
self.stop = stop
# FIXME: privatize
self.read = start
self._reads = {} # read count for each sector
def parse(self, line):
"""
Parse a line.
"""
m = _PROGRESS_RE.search(line)
if m:
# code = int(m.group('code'))
function = m.group('function')
wordOffset = int(m.group('offset'))
if function == 'read':
self._parse_read(wordOffset)
elif function == 'wrote':
self._parse_wrote(wordOffset)
m = _ERROR_RE.search(line)
if m:
self.errors += 1
def _parse_read(self, wordOffset):
if wordOffset % common.WORDS_PER_FRAME != 0:
logger.debug('THOMAS: not a multiple of %d: %d' % (
common.WORDS_PER_FRAME, wordOffset))
return
frameOffset = wordOffset / common.WORDS_PER_FRAME
# set nframes if not yet set
if self._nframes is None and self.read != 0:
self._nframes = frameOffset - self.read
logger.debug('set nframes to %r', self._nframes)
# set firstFrames if not yet set
if self._firstFrames is None:
self._firstFrames = frameOffset - self.start
logger.debug('set firstFrames to %r', self._firstFrames)
markStart = None
markEnd = None # the next unread frame (half-inclusive)
# verify it either read nframes more or went back for verify
if frameOffset > self.read:
delta = frameOffset - self.read
if self._nframes and delta != self._nframes:
# my drive either reads 7 or 13 frames
pass
# update our read sectors hash
markStart = self.read
markEnd = frameOffset
else:
# went back to verify
# we could use firstFrames as an estimate on how many frames this
# read, but this lowers our track quality needlessly where
# EAC still reports 100% track quality
markStart = frameOffset # - self._firstFrames
markEnd = frameOffset
# FIXME: doing this is way too slow even for a testcase, so disable
if False:
for frame in range(markStart, markEnd):
if frame not in list(self._reads.keys()):
self._reads[frame] = 0
self._reads[frame] += 1
# cdparanoia reads quite a bit beyond the current track before it
# goes back to verify; don't count those
# markStart, markEnd of 0, 21 with stop 0 should give 1 read
if markEnd > self.stop + 1:
markEnd = self.stop + 1
if markStart > self.stop + 1:
markStart = self.stop + 1
self.reads += markEnd - markStart
# update our read pointer
self.read = frameOffset
def _parse_wrote(self, wordOffset):
# cdparanoia outputs most [wrote] calls with one word less than a frame
frameOffset = (wordOffset + 1) / common.WORDS_PER_FRAME
self.wrote = frameOffset
def getTrackQuality(self):
"""
Each frame gets read twice.
More than two reads for a frame reduce track quality.
"""
frames = self.stop - self.start + 1 # + 1 since stop is inclusive
reads = self.reads
logger.debug('getTrackQuality: frames %d, reads %d' % (frames, reads))
# don't go over a 100%; we know cdparanoia reads each frame at least
# twice
try:
return min(frames * 2.0 / reads, 1.0)
except ZeroDivisionError:
return 0
# FIXME: handle errors
class ReadTrackTask(task.Task):
"""
I am a task that reads a track using cdparanoia.
@ivar reads: how many reads were done to rip the track
"""
description = "Reading track"
quality = None # set at end of reading
speed = None
duration = None # in seconds
_MAXERROR = 100 # number of errors detected by parser
def __init__(self, path, table, start, stop, overread, offset=0,
device=None, action="Reading", what="track"):
"""
Read the given track.
@param path: where to store the ripped track
@type path: unicode
@param table: table of contents of CD
@type table: L{table.Table}
@param start: first frame to rip
@type start: int
@param stop: last frame to rip (inclusive); >= start
@type stop: int
@param offset: read offset, in samples
@type offset: int
@param device: the device to rip from
@type device: str
@param action: a string representing the action; e.g. Read/Verify
@type action: str
@param what: a string representing what's being read; e.g. Track
@type what: str
"""
assert isinstance(path, unicode), "%r is not unicode" % path
self.path = path
self._table = table
self._start = start
self._stop = stop
self._offset = offset
self._parser = ProgressParser(start, stop)
self._device = device
self._start_time = None
self._overread = overread
self._buffer = "" # accumulate characters
self._errors = []
self.description = "%s %s" % (action, what)
def start(self, runner):
task.Task.start(self, runner)
# find on which track the range starts and stops
startTrack = 0
startOffset = 0
stopTrack = 0
stopOffset = self._stop
for i, t in enumerate(self._table.tracks):
if self._table.getTrackStart(i + 1) <= self._start:
startTrack = i + 1
startOffset = self._start - self._table.getTrackStart(i + 1)
if self._table.getTrackEnd(i + 1) <= self._stop:
stopTrack = i + 1
stopOffset = self._stop - self._table.getTrackStart(i + 1)
logger.debug('Ripping from %d to %d (inclusive)',
self._start, self._stop)
logger.debug('Starting at track %d, offset %d',
startTrack, startOffset)
logger.debug('Stopping at track %d, offset %d',
stopTrack, stopOffset)
bufsize = 1024
if self._overread:
argv = ["cd-paranoia", "--stderr-progress",
"--sample-offset=%d" % self._offset, "--force-overread", ]
else:
argv = ["cd-paranoia", "--stderr-progress",
"--sample-offset=%d" % self._offset, ]
if self._device:
argv.extend(["--force-cdrom-device", self._device, ])
argv.extend(["%d[%s]-%d[%s]" % (
startTrack, common.framesToHMSF(startOffset),
stopTrack, common.framesToHMSF(stopOffset)),
self.path])
logger.debug('Running %s' % (" ".join(argv), ))
try:
self._popen = asyncsub.Popen(argv,
bufsize=bufsize,
stdin=subprocess.PIPE,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
close_fds=True)
except OSError as e:
import errno
if e.errno == errno.ENOENT:
raise common.MissingDependencyException('cd-paranoia')
raise
self._start_time = time.time()
self.schedule(1.0, self._read, runner)
def _read(self, runner):
ret = self._popen.recv_err()
if not ret:
if self._popen.poll() is not None:
self._done()
return
self.schedule(0.01, self._read, runner)
return
self._buffer += ret
# parse buffer into lines if possible, and parse them
if "\n" in self._buffer:
lines = self._buffer.split('\n')
if lines[-1] != "\n":
# last line didn't end yet
self._buffer = lines[-1]
del lines[-1]
else:
self._buffer = ""
for line in lines:
self._parser.parse(line)
# fail if too many errors
if self._parser.errors > self._MAXERROR:
logger.debug('%d errors, terminating', self._parser.errors)
self._popen.terminate()
num = self._parser.wrote - self._start + 1
den = self._stop - self._start + 1
assert den != 0, "stop %d should be >= start %d" % (
self._stop, self._start)
progress = float(num) / float(den)
if progress < 1.0:
self.setProgress(progress)
# 0 does not give us output before we complete, 1.0 gives us output
# too late
self.schedule(0.01, self._read, runner)
def _poll(self, runner):
if self._popen.poll() is None:
self.schedule(1.0, self._poll, runner)
return
self._done()
def _done(self):
end_time = time.time()
self.setProgress(1.0)
# check if the length matches
size = os.stat(self.path)[stat.ST_SIZE]
# wav header is 44 bytes
offsetLength = self._stop - self._start + 1
expected = offsetLength * common.BYTES_PER_FRAME + 44
if size != expected:
# FIXME: handle errors better
logger.warning('file size %d did not match expected size %d',
size, expected)
if (size - expected) % common.BYTES_PER_FRAME == 0:
logger.warning('%d frames difference' % (
(size - expected) / common.BYTES_PER_FRAME))
else:
logger.warning('non-integral amount of frames difference')
self.setAndRaiseException(FileSizeError(self.path,
"File size %d did not "
"match expected "
"size %d" % (
size, expected)))
if not self.exception and self._popen.returncode != 0:
if self._errors:
print("\n".join(self._errors))
else:
logger.warning('exit code %r', self._popen.returncode)
self.exception = ReturnCodeError(self._popen.returncode)
self.quality = self._parser.getTrackQuality()
self.duration = end_time - self._start_time
self.speed = (offsetLength / 75.0) / self.duration
self.stop()
return
class ReadVerifyTrackTask(task.MultiSeparateTask):
"""
I am a task that reads and verifies a track using cdparanoia.
I also encode the track.
The path where the file is stored can be changed if necessary, for
example if the file name is too long.
@ivar path: the path where the file is to be stored.
@ivar checksum: the checksum of the track; set if they match.
@ivar testchecksum: the test checksum of the track.
@ivar copychecksum: the copy checksum of the track.
@ivar testspeed: the test speed of the track, as a multiple of
track duration.
@ivar copyspeed: the copy speed of the track, as a multiple of
track duration.
@ivar testduration: the test duration of the track, in seconds.
@ivar copyduration: the copy duration of the track, in seconds.
@ivar peak: the peak level of the track
"""
checksum = None
testchecksum = None
copychecksum = None
peak = None
quality = None
testspeed = None
copyspeed = None
testduration = None
copyduration = None
_tmpwavpath = None
_tmppath = None
def __init__(self, path, table, start, stop, overread, offset=0,
device=None, taglist=None, what="track"):
"""
@param path: where to store the ripped track
@type path: str
@param table: table of contents of CD
@type table: L{table.Table}
@param start: first frame to rip
@type start: int
@param stop: last frame to rip (inclusive)
@type stop: int
@param offset: read offset, in samples
@type offset: int
@param device: the device to rip from
@type device: str
@param taglist: a dict of tags
@type taglist: dict
"""
task.MultiSeparateTask.__init__(self)
logger.debug('Creating read and verify task on %r', path)
if taglist:
logger.debug('read and verify with taglist %r', taglist)
# FIXME: choose a dir on the same disk/dir as the final path
fd, tmppath = tempfile.mkstemp(suffix='.whipper.wav')
tmppath = unicode(tmppath)
os.close(fd)
self._tmpwavpath = tmppath
from whipper.common import checksum
self.tasks = []
self.tasks.append(
ReadTrackTask(tmppath, table, start, stop, overread,
offset=offset, device=device, what=what))
self.tasks.append(checksum.CRC32Task(tmppath))
t = ReadTrackTask(tmppath, table, start, stop, overread,
offset=offset, device=device, action="Verifying",
what=what)
self.tasks.append(t)
self.tasks.append(checksum.CRC32Task(tmppath))
# encode to the final path + '.part'
try:
tmpoutpath = path + u'.part'
open(tmpoutpath, 'wb').close()
except IOError as e:
if errno.ENAMETOOLONG != e.errno:
raise
path = common.shrinkPath(path)
tmpoutpath = path + u'.part'
open(tmpoutpath, 'wb').close()
self._tmppath = tmpoutpath
self.path = path
from whipper.common import encode
self.tasks.append(encode.FlacEncodeTask(tmppath, tmpoutpath))
# MerlijnWajer: XXX: We run the CRC32Task on the wav file, because it's
# in general stupid to run the CRC32 on the flac file since it already
# has --verify. We should just get rid of this CRC32 step.
# make sure our encoding is accurate
self.tasks.append(checksum.CRC32Task(tmppath))
self.tasks.append(encode.SoxPeakTask(tmppath))
# TODO: Move tagging outside of cdparanoia
self.tasks.append(encode.TaggingTask(tmpoutpath, taglist))
self.checksum = None
def stop(self):
# FIXME: maybe this kind of try-wrapping to make sure
# we chain up should be handled by a parent class function ?
try:
if not self.exception:
self.quality = max(self.tasks[0].quality,
self.tasks[2].quality)
self.peak = self.tasks[6].peak
logger.debug('peak: %r', self.peak)
self.testspeed = self.tasks[0].speed
self.copyspeed = self.tasks[2].speed
self.testduration = self.tasks[0].duration
self.copyduration = self.tasks[2].duration
self.testchecksum = c1 = self.tasks[1].checksum
self.copychecksum = c2 = self.tasks[3].checksum
if c1 == c2:
logger.info('Checksums match, %08x' % c1)
self.checksum = self.testchecksum
else:
# FIXME: detect this before encoding
logger.info('Checksums do not match, %08x %08x' % (
c1, c2))
self.exception = ChecksumException(
'read and verify failed: test checksum')
if self.tasks[5].checksum != self.checksum:
self.exception = ChecksumException(
'Encoding failed, checksum does not match')
# delete the unencoded file
os.unlink(self._tmpwavpath)
if not self.exception:
try:
logger.debug('Moving to final path %r', self.path)
os.rename(self._tmppath, self.path)
except Exception as e:
logger.debug('Exception while moving to final '
'path %r: %r', self.path, str(e))
self.exception = e
else:
os.unlink(self._tmppath)
else:
logger.debug('stop: exception %r', self.exception)
except Exception as e:
print('WARNING: unhandled exception %r' % (e, ))
task.MultiSeparateTask.stop(self)
_VERSION_RE = re.compile(
"^cdparanoia (?P<version>.+) release (?P<release>.+)")
def getCdParanoiaVersion():
getter = common.VersionGetter('cd-paranoia',
["cd-paranoia", "-V"],
_VERSION_RE,
"%(version)s %(release)s")
return getter.get()
_OK_RE = re.compile(r'Drive tests OK with Paranoia.')
_WARNING_RE = re.compile(r'WARNING! PARANOIA MAY NOT BE')
class AnalyzeTask(ctask.PopenTask):
logCategory = 'AnalyzeTask'
description = 'Analyzing drive caching behaviour'
defeatsCache = None
cwd = None
_output = []
def __init__(self, device=None):
# cdparanoia -A *always* writes cdparanoia.log
self.cwd = tempfile.mkdtemp(suffix='.whipper.cache')
self.command = ['cd-paranoia', '-A']
if device:
self.command += ['-d', device]
def commandMissing(self):
raise common.MissingDependencyException('cd-paranoia')
def readbyteserr(self, bytes):
self._output.append(bytes)
def done(self):
if self.cwd:
shutil.rmtree(self.cwd)
output = "".join(self._output)
m = _OK_RE.search(output)
if m:
self.defeatsCache = True
else:
self.defeatsCache = False
def failed(self):
# cdparanoia exits with return code 1 if it can't determine
# whether it can defeat the audio cache
output = "".join(self._output)
m = _WARNING_RE.search(output)
if m:
self.defeatsCache = False
if self.cwd:
shutil.rmtree(self.cwd)