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):
61 '-S', options.snapshot_frequency,
63 p = subprocess.Popen(cmd, env=self.env, stdout=subprocess.PIPE, stderr=NULL)
66 def dump_state(self, call_no):
67 '''Get the state dump at the specified call no.'''
73 p = subprocess.Popen(cmd, env=self.env, stdout=subprocess.PIPE, stderr=NULL)
74 state = jsondiff.load(p.stdout)
76 return state.get('parameters', {})
78 def diff_state(self, ref_call_no, src_call_no):
79 '''Compare the state between two calls.'''
81 ref_state = self.dump_state(ref_call_no)
82 src_state = self.dump_state(src_call_no)
85 differ = jsondiff.Differ(sys.stdout)
86 differ.visit(ref_state, src_state)
87 sys.stdout.write('\n')
91 '''Read a PNM from the stream, and return the image object, and the comment.'''
93 magic = stream.readline()
96 assert magic.rstrip() == 'P6'
98 line = stream.readline()
99 while line.startswith('#'):
101 line = stream.readline()
102 width, height = map(int, line.strip().split())
103 maximum = int(stream.readline().strip())
104 assert maximum == 255
105 data = stream.read(height * width * 3)
106 image = Image.frombuffer('RGB', (width, height), data, 'raw', 'RGB', 0, 1)
107 return image, comment
110 def parse_env(optparser, entries):
111 '''Translate a list of NAME=VALUE entries into an environment dictionary.'''
113 env = os.environ.copy()
114 for entry in entries:
116 name, var = entry.split('=', 1)
118 optparser.error('invalid environment entry %r' % entry)
129 # Parse command line options
130 optparser = optparse.OptionParser(
131 usage='\n\t%prog [options] -- [glretrace options] <trace>',
133 optparser.add_option(
134 '-r', '--retrace', metavar='PROGRAM',
135 type='string', dest='retrace', default='glretrace',
136 help='retrace command [default: %default]')
137 optparser.add_option(
138 '--ref-env', metavar='NAME=VALUE',
139 type='string', action='append', dest='ref_env', default=[],
140 help='add variable to reference environment')
141 optparser.add_option(
142 '--src-env', metavar='NAME=VALUE',
143 type='string', action='append', dest='src_env', default=[],
144 help='add variable to source environment')
145 optparser.add_option(
146 '--diff-prefix', metavar='PATH',
147 type='string', dest='diff_prefix', default='.',
148 help='prefix for the difference images')
149 optparser.add_option(
150 '-t', '--threshold', metavar='BITS',
151 type="float", dest="threshold", default=12.0,
152 help="threshold precision [default: %default]")
153 optparser.add_option(
154 '-S', '--snapshot-frequency', metavar='FREQUENCY',
155 type="string", dest="snapshot_frequency", default='draw',
156 help="snapshot frequency: frame, framebuffer, or draw [default: %default]")
158 (options, args) = optparser.parse_args(sys.argv[1:])
159 ref_env = parse_env(optparser, options.ref_env)
160 src_env = parse_env(optparser, options.src_env)
162 optparser.error("incorrect number of arguments")
164 ref_setup = Setup(args, ref_env)
165 src_setup = Setup(args, src_env)
167 highligher = Highlighter(sys.stdout)
169 highligher.write('call\tprecision\n')
173 ref_proc = ref_setup.retrace()
175 src_proc = src_setup.retrace()
178 # Get the reference image
179 ref_image, ref_comment = read_pnm(ref_proc.stdout)
180 if ref_image is None:
183 # Get the source image
184 src_image, src_comment = read_pnm(src_proc.stdout)
185 if src_image is None:
188 assert ref_comment == src_comment
190 call_no = int(ref_comment.strip())
192 # Compare the two images
193 comparer = Comparer(ref_image, src_image)
194 precision = comparer.precision()
196 mismatch = precision < options.threshold
199 highligher.color(highligher.red)
201 highligher.write('%u\t%f\n' % (call_no, precision))
206 if options.diff_prefix:
207 prefix = os.path.join(options.diff_prefix, '%010u' % call_no)
208 prefix_dir = os.path.dirname(prefix)
209 if not os.path.isdir(prefix_dir):
210 os.makedirs(prefix_dir)
211 ref_image.save(prefix + '.ref.png')
212 src_image.save(prefix + '.src.png')
213 comparer.write_diff(prefix + '.diff.png')
214 if last_bad < last_good:
215 src_setup.diff_state(last_good, call_no)
227 if __name__ == '__main__':