import optparse
import os.path
-import re
-import shutil
import subprocess
import platform
import sys
-import tempfile
from PIL import Image
from snapdiff import Comparer
+from highlight import AutoHighlighter
import jsondiff
# Null file, to use when we're not interested in subprocesses output
if platform.system() == 'Windows':
- NULL = open('NUL:', 'wt')
+ NULL = open('NUL:', 'wb')
else:
- NULL = open('/dev/null', 'wt')
+ NULL = open('/dev/null', 'wb')
-class Setup:
+class RetraceRun:
- def __init__(self, args, env=None):
+ def __init__(self, process):
+ self.process = process
+
+ def nextSnapshot(self):
+ image, comment = read_pnm(self.process.stdout)
+ if image is None:
+ return None, None
+
+ callNo = int(comment.strip())
+
+ return image, callNo
+
+ def terminate(self):
+ try:
+ self.process.terminate()
+ except OSError:
+ # Avoid http://bugs.python.org/issue14252
+ pass
+
+
+class Retracer:
+
+ def __init__(self, retraceExe, args, env=None):
+ self.retraceExe = retraceExe
self.args = args
self.env = env
- def retrace(self):
+ def _retrace(self, args, stdout=subprocess.PIPE):
cmd = [
- options.retrace,
+ self.retraceExe,
+ ] + args + self.args
+ if self.env:
+ for name, value in self.env.iteritems():
+ sys.stderr.write('%s=%s ' % (name, value))
+ sys.stderr.write(' '.join(cmd) + '\n')
+ try:
+ return subprocess.Popen(cmd, env=self.env, stdout=stdout, stderr=NULL)
+ except OSError, ex:
+ sys.stderr.write('error: failed to execute %s: %s\n' % (cmd[0], ex.strerror))
+ sys.exit(1)
+
+ def retrace(self, args):
+ p = self._retrace([])
+ p.wait()
+ return p.returncode
+
+ def snapshot(self, call_nos):
+ process = self._retrace([
'-s', '-',
- '-S', options.snapshot_frequency,
- ] + self.args
- p = subprocess.Popen(cmd, env=self.env, stdout=subprocess.PIPE, stderr=NULL)
- return p
+ '-S', call_nos,
+ ])
+ return RetraceRun(process)
def dump_state(self, call_no):
'''Get the state dump at the specified call no.'''
- cmd = [
- options.retrace,
+ p = self._retrace([
'-D', str(call_no),
- ] + self.args
- p = subprocess.Popen(cmd, env=self.env, stdout=subprocess.PIPE, stderr=NULL)
+ ])
state = jsondiff.load(p.stdout)
p.wait()
- return state
+ return state.get('parameters', {})
+
+ def diff_state(self, ref_call_no, src_call_no, stream):
+ '''Compare the state between two calls.'''
+
+ ref_state = self.dump_state(ref_call_no)
+ src_state = self.dump_state(src_call_no)
+
+ stream.flush()
+ differ = jsondiff.Differ(stream)
+ differ.visit(ref_state, src_state)
+ stream.write('\n')
def read_pnm(stream):
magic = stream.readline()
if not magic:
return None, None
- assert magic.rstrip() == 'P6'
+ magic = magic.rstrip()
+ if magic == 'P5':
+ channels = 1
+ bytesPerChannel = 1
+ mode = 'L'
+ elif magic == 'P6':
+ channels = 3
+ bytesPerChannel = 1
+ mode = 'RGB'
+ elif magic == 'Pf':
+ channels = 1
+ bytesPerChannel = 4
+ mode = 'R'
+ elif magic == 'PF':
+ channels = 3
+ bytesPerChannel = 4
+ mode = 'RGB'
+ elif magic == 'PX':
+ channels = 4
+ bytesPerChannel = 4
+ mode = 'RGB'
+ else:
+ raise Exception('Unsupported magic `%s`' % magic)
comment = ''
line = stream.readline()
while line.startswith('#'):
line = stream.readline()
width, height = map(int, line.strip().split())
maximum = int(stream.readline().strip())
- assert maximum == 255
- data = stream.read(height * width * 3)
- image = Image.frombuffer('RGB', (width, height), data, 'raw', 'RGB', 0, 1)
+ if bytesPerChannel == 1:
+ assert maximum == 255
+ else:
+ assert maximum == 1
+ data = stream.read(height * width * channels * bytesPerChannel)
+ if bytesPerChannel == 4:
+ # Image magic only supports single channel floating point images, so
+ # represent the image as numpy arrays
+
+ import numpy
+ pixels = numpy.fromstring(data, dtype=numpy.float32)
+ pixels.resize((height, width, channels))
+ return pixels, comment
+
+ image = Image.frombuffer(mode, (width, height), data, 'raw', mode, 0, 1)
return image, comment
-def diff_state(setup, ref_call_no, src_call_no):
- '''Compare the state between two calls.'''
-
- ref_state = setup.dump_state(ref_call_no)
- src_state = setup.dump_state(src_call_no)
- sys.stdout.flush()
- differ = jsondiff.Differ(sys.stdout)
- differ.visit(ref_state, src_state)
- sys.stdout.write('\n')
-
-
def parse_env(optparser, entries):
'''Translate a list of NAME=VALUE entries into an environment dictionary.'''
+ if not entries:
+ return None
+
env = os.environ.copy()
for entry in entries:
try:
'-r', '--retrace', metavar='PROGRAM',
type='string', dest='retrace', default='glretrace',
help='retrace command [default: %default]')
+ optparser.add_option(
+ '--ref-driver', metavar='DRIVER',
+ type='string', dest='ref_driver', default=None,
+ help='force reference driver')
+ optparser.add_option(
+ '--src-driver', metavar='DRIVER',
+ type='string', dest='src_driver', default=None,
+ help='force source driver')
+ optparser.add_option(
+ '--ref-arg', metavar='OPTION',
+ type='string', action='append', dest='ref_args', default=[],
+ help='pass argument to reference retrace')
+ optparser.add_option(
+ '--src-arg', metavar='OPTION',
+ type='string', action='append', dest='src_args', default=[],
+ help='pass argument to source retrace')
optparser.add_option(
'--ref-env', metavar='NAME=VALUE',
type='string', action='append', dest='ref_env', default=[],
type="float", dest="threshold", default=12.0,
help="threshold precision [default: %default]")
optparser.add_option(
- '-S', '--snapshot-frequency', metavar='FREQUENCY',
+ '-S', '--snapshot-frequency', metavar='CALLSET',
type="string", dest="snapshot_frequency", default='draw',
- help="snapshot frequency: frame, framebuffer, or draw [default: %default]")
+ help="calls to compare [default: %default]")
+ optparser.add_option(
+ '--diff-state',
+ action='store_true', dest='diff_state', default=False,
+ help='diff state between failing calls')
+ optparser.add_option(
+ '-o', '--output', metavar='FILE',
+ type="string", dest="output",
+ help="output file [default: stdout]")
(options, args) = optparser.parse_args(sys.argv[1:])
ref_env = parse_env(optparser, options.ref_env)
src_env = parse_env(optparser, options.src_env)
if not args:
optparser.error("incorrect number of arguments")
+
+ if options.ref_driver:
+ options.ref_args.insert(0, '--driver=' + options.ref_driver)
+ if options.src_driver:
+ options.src_args.insert(0, '--driver=' + options.src_driver)
+
+ refRetracer = Retracer(options.retrace, options.ref_args + args, ref_env)
+ srcRetracer = Retracer(options.retrace, options.src_args + args, src_env)
+
+ if options.output:
+ output = open(options.output, 'wt')
+ else:
+ output = sys.stdout
- ref_setup = Setup(args, ref_env)
- src_setup = Setup(args, src_env)
+ highligher = AutoHighlighter(output)
- image_re = re.compile('^Wrote (.*\.png)$')
+ highligher.write('call\tprecision\n')
- last_good = -1
last_bad = -1
- ref_proc = ref_setup.retrace()
+ last_good = 0
+ refRun = refRetracer.snapshot(options.snapshot_frequency)
try:
- src_proc = src_setup.retrace()
+ srcRun = srcRetracer.snapshot(options.snapshot_frequency)
try:
while True:
# Get the reference image
- ref_image, ref_comment = read_pnm(ref_proc.stdout)
- if ref_image is None:
+ refImage, refCallNo = refRun.nextSnapshot()
+ if refImage is None:
break
# Get the source image
- src_image, src_comment = read_pnm(src_proc.stdout)
- if src_image is None:
+ srcImage, srcCallNo = srcRun.nextSnapshot()
+ if srcImage is None:
break
- assert ref_comment == src_comment
-
- call_no = int(ref_comment.strip())
+ assert refCallNo == srcCallNo
+ callNo = refCallNo
# Compare the two images
- comparer = Comparer(ref_image, src_image)
- precision = comparer.precision()
-
- sys.stdout.write('%u %f\n' % (call_no, precision))
-
- if precision < options.threshold:
- if options.diff_prefix:
- prefix = os.path.join(options.diff_prefix, '%010u' % call_no)
+ if isinstance(refImage, Image.Image) and isinstance(srcImage, Image.Image):
+ # Using PIL
+ numpyImages = False
+ comparer = Comparer(refImage, srcImage)
+ precision = comparer.precision()
+ else:
+ # Using numpy (for floating point images)
+ # TODO: drop PIL when numpy path becomes general enough
+ import numpy
+ assert not isinstance(refImage, Image.Image)
+ assert not isinstance(srcImage, Image.Image)
+ numpyImages = True
+ assert refImage.shape == srcImage.shape
+ diffImage = numpy.square(srcImage - refImage)
+ match = numpy.all(diffImage == 0)
+ if match:
+ precision = 24
+ else:
+ precision = 0
+
+ mismatch = precision < options.threshold
+
+ if mismatch:
+ highligher.color(highligher.red)
+ highligher.bold()
+ highligher.write('%u\t%f\n' % (callNo, precision))
+ if mismatch:
+ highligher.normal()
+
+ if mismatch:
+ if options.diff_prefix and not numpyImages:
+ prefix = os.path.join(options.diff_prefix, '%010u' % callNo)
prefix_dir = os.path.dirname(prefix)
if not os.path.isdir(prefix_dir):
os.makedirs(prefix_dir)
- ref_image.save(prefix + '.ref.png')
- src_image.save(prefix + '.src.png')
+ refImage.save(prefix + '.ref.png')
+ srcImage.save(prefix + '.src.png')
comparer.write_diff(prefix + '.diff.png')
- if last_bad < last_good:
- diff_state(src_setup, last_good, call_no)
- last_bad = call_no
+ if last_bad < last_good and options.diff_state:
+ srcRetracer.diff_state(last_good, callNo, output)
+ last_bad = callNo
else:
- last_good = call_no
+ last_good = callNo
- sys.stdout.flush()
+ highligher.flush()
finally:
- src_proc.terminate()
+ srcRun.terminate()
finally:
- ref_proc.terminate()
+ refRun.terminate()
if __name__ == '__main__':
projects / apitrace / blobdiff