2 ##########################################################################
4 # Copyright 2011 Jose Fonseca
7 # Permission is hereby granted, free of charge, to any person obtaining a copy
8 # of this software and associated documentation files (the 'Software'), to deal
9 # in the Software without restriction, including without limitation the rights
10 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 # copies of the Software, and to permit persons to whom the Software is
12 # furnished to do so, subject to the following conditions:
14 # The above copyright notice and this permission notice shall be included in
15 # all copies or substantial portions of the Software.
17 # THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 ##########################################################################/
27 '''Run two retrace instances in parallel, comparing generated snapshots.
39 from snapdiff import Comparer
40 from highlight import Highlighter
44 # Null file, to use when we're not interested in subprocesses output
45 if platform.system() == 'Windows':
46 NULL = open('NUL:', 'wt')
48 NULL = open('/dev/null', 'wt')
53 def __init__(self, args, env=None):
57 def _retrace(self, args):
62 return subprocess.Popen(cmd, env=self.env, stdout=subprocess.PIPE, stderr=NULL)
64 sys.stderr.write('error: failed to execute %s: %s\n' % (cmd[0], ex.strerror))
68 return self._retrace([
70 '-S', options.snapshot_frequency,
73 def dump_state(self, call_no):
74 '''Get the state dump at the specified call no.'''
79 state = jsondiff.load(p.stdout)
81 return state.get('parameters', {})
83 def diff_state(self, ref_call_no, src_call_no):
84 '''Compare the state between two calls.'''
86 ref_state = self.dump_state(ref_call_no)
87 src_state = self.dump_state(src_call_no)
90 differ = jsondiff.Differ(sys.stdout)
91 differ.visit(ref_state, src_state)
92 sys.stdout.write('\n')
96 '''Read a PNM from the stream, and return the image object, and the comment.'''
98 magic = stream.readline()
101 assert magic.rstrip() == 'P6'
103 line = stream.readline()
104 while line.startswith('#'):
106 line = stream.readline()
107 width, height = map(int, line.strip().split())
108 maximum = int(stream.readline().strip())
109 assert maximum == 255
110 data = stream.read(height * width * 3)
111 image = Image.frombuffer('RGB', (width, height), data, 'raw', 'RGB', 0, 1)
112 return image, comment
115 def parse_env(optparser, entries):
116 '''Translate a list of NAME=VALUE entries into an environment dictionary.'''
118 env = os.environ.copy()
119 for entry in entries:
121 name, var = entry.split('=', 1)
123 optparser.error('invalid environment entry %r' % entry)
134 # Parse command line options
135 optparser = optparse.OptionParser(
136 usage='\n\t%prog [options] -- [glretrace options] <trace>',
138 optparser.add_option(
139 '-r', '--retrace', metavar='PROGRAM',
140 type='string', dest='retrace', default='glretrace',
141 help='retrace command [default: %default]')
142 optparser.add_option(
143 '--ref-env', metavar='NAME=VALUE',
144 type='string', action='append', dest='ref_env', default=[],
145 help='add variable to reference environment')
146 optparser.add_option(
147 '--src-env', metavar='NAME=VALUE',
148 type='string', action='append', dest='src_env', default=[],
149 help='add variable to source environment')
150 optparser.add_option(
151 '--diff-prefix', metavar='PATH',
152 type='string', dest='diff_prefix', default='.',
153 help='prefix for the difference images')
154 optparser.add_option(
155 '-t', '--threshold', metavar='BITS',
156 type="float", dest="threshold", default=12.0,
157 help="threshold precision [default: %default]")
158 optparser.add_option(
159 '-S', '--snapshot-frequency', metavar='FREQUENCY',
160 type="string", dest="snapshot_frequency", default='draw',
161 help="snapshot frequency: frame, framebuffer, or draw [default: %default]")
163 (options, args) = optparser.parse_args(sys.argv[1:])
164 ref_env = parse_env(optparser, options.ref_env)
165 src_env = parse_env(optparser, options.src_env)
167 optparser.error("incorrect number of arguments")
169 ref_setup = Setup(args, ref_env)
170 src_setup = Setup(args, src_env)
172 highligher = Highlighter(sys.stdout)
174 highligher.write('call\tprecision\n')
178 ref_proc = ref_setup.retrace()
180 src_proc = src_setup.retrace()
183 # Get the reference image
184 ref_image, ref_comment = read_pnm(ref_proc.stdout)
185 if ref_image is None:
188 # Get the source image
189 src_image, src_comment = read_pnm(src_proc.stdout)
190 if src_image is None:
193 assert ref_comment == src_comment
195 call_no = int(ref_comment.strip())
197 # Compare the two images
198 comparer = Comparer(ref_image, src_image)
199 precision = comparer.precision()
201 mismatch = precision < options.threshold
204 highligher.color(highligher.red)
206 highligher.write('%u\t%f\n' % (call_no, precision))
211 if options.diff_prefix:
212 prefix = os.path.join(options.diff_prefix, '%010u' % call_no)
213 prefix_dir = os.path.dirname(prefix)
214 if not os.path.isdir(prefix_dir):
215 os.makedirs(prefix_dir)
216 ref_image.save(prefix + '.ref.png')
217 src_image.save(prefix + '.src.png')
218 comparer.write_diff(prefix + '.diff.png')
219 if last_bad < last_good:
220 src_setup.diff_state(last_good, call_no)
232 if __name__ == '__main__':