6 ## so we can call directly as buildscripts/output-distance.py
7 me_path = os.path.abspath (os.path.split (sys.argv[0])[0])
8 sys.path.insert (0, me_path + '/../python/')
18 OUTPUT_EXPRESSION_PENALTY = 1
19 ORPHAN_GROB_PENALTY = 1
22 def max_distance (x1, x2):
25 for (p,q) in zip (x1, x2):
26 dist = max (abs (p-q), dist)
31 empty_interval = (INFTY, -INFTY)
32 empty_bbox = (empty_interval, empty_interval)
34 def interval_is_empty (i):
37 def interval_length (i):
38 return max (i[1]-i[0], 0)
40 def interval_union (i1, i2):
41 return (min (i1[0], i2[0]),
44 def interval_intersect (i1, i2):
45 return (max (i1[0], i2[0]),
48 def bbox_is_empty (b):
49 return (interval_is_empty (b[0])
50 or interval_is_empty (b[1]))
52 def bbox_union (b1, b2):
53 return (interval_union (b1[X_AXIS], b2[X_AXIS]),
54 interval_union (b2[Y_AXIS], b2[Y_AXIS]))
56 def bbox_intersection (b1, b2):
57 return (interval_intersect (b1[X_AXIS], b2[X_AXIS]),
58 interval_intersect (b2[Y_AXIS], b2[Y_AXIS]))
61 return interval_length (b[X_AXIS]) * interval_length (b[Y_AXIS])
63 def bbox_diameter (b):
64 return max (interval_length (b[X_AXIS]),
65 interval_length (b[Y_AXIS]))
68 def difference_area (a, b):
69 return bbox_area (a) - bbox_area (bbox_intersection (a,b))
72 def __init__ (self, exp_list):
73 (self.name, self.origin, bbox_x,
74 bbox_y, self.output_expression) = tuple (exp_list)
76 self.bbox = (bbox_x, bbox_y)
77 self.centroid = (bbox_x[0] + bbox_x[1], bbox_y[0] + bbox_y[1])
80 return '%s: (%.2f,%.2f), (%.2f,%.2f)\n' % (self.name,
86 def axis_centroid (self, axis):
87 return apply (sum, self.bbox[axis]) / 2
89 def centroid_distance (self, other, scale):
90 return max_distance (self.centroid, other.centroid) / scale
92 def bbox_distance (self, other):
93 divisor = bbox_area (self.bbox) + bbox_area (other.bbox)
96 return (difference_area (self.bbox, other.bbox) +
97 difference_area (other.bbox, self.bbox)) / divisor
101 def expression_distance (self, other):
102 if self.output_expression == other.output_expression:
107 ################################################################
110 class SystemSignature:
111 def __init__ (self, grob_sigs):
114 val = d.setdefault (g.name, [])
118 self.set_all_bbox (grob_sigs)
120 def set_all_bbox (self, grobs):
121 self.bbox = empty_bbox
123 self.bbox = bbox_union (g.bbox, self.bbox)
125 def closest (self, grob_name, centroid):
129 grobs = self.grob_dict[grob_name]
132 d = max_distance (g.centroid, centroid)
143 return reduce (lambda x,y: x+y, self.grob_dict.values(), [])
145 ################################################################
146 ## comparison of systems.
149 def __init__ (self, system1, system2):
150 self.system1 = system1
151 self.system2 = system2
153 self.link_list_dict = {}
154 self.back_link_dict = {}
161 self.geo_distances = {}
164 self.expression_changed = []
166 self._geometric_distance = None
167 self._expression_change_count = None
168 self._orphan_count = None
170 for g in system1.grobs ():
172 ## skip empty bboxes.
173 if bbox_is_empty (g.bbox):
176 closest = system2.closest (g.name, g.centroid)
178 self.link_list_dict.setdefault (closest, [])
179 self.link_list_dict[closest].append (g)
180 self.back_link_dict[g] = closest
183 def calc_geometric_distance (self):
185 for (g1,g2) in self.back_link_dict.items ():
187 d = g1.bbox_distance (g2)
189 self.geo_distances[(g1,g2)] = d
193 self._geometric_distance = total
195 def calc_orphan_count (self):
197 for (g1, g2) in self.back_link_dict.items ():
199 self.orphans.append ((g1, None))
203 self._orphan_count = count
205 def calc_output_exp_distance (self):
207 for (g1,g2) in self.back_link_dict.items ():
209 d += g1.expression_distance (g2)
211 self._expression_change_count = d
213 def output_expression_details_string (self):
214 return ', '.join ([g1.name for g1 in self.expression_changed])
216 def geo_details_string (self):
217 results = [(d, g1,g2) for ((g1, g2), d) in self.geo_distances.items()]
221 return ', '.join (['%s: %f' % (g1.name, d) for (d, g1, g2) in results])
223 def orphan_details_string (self):
224 return ', '.join (['%s-None' % g1.name for (g1,g2) in self.orphans if g2==None])
226 def geometric_distance (self):
227 if self._geometric_distance == None:
228 self.calc_geometric_distance ()
229 return self._geometric_distance
231 def orphan_count (self):
232 if self._orphan_count == None:
233 self.calc_orphan_count ()
235 return self._orphan_count
237 def output_expression_change_count (self):
238 if self._expression_change_count == None:
239 self.calc_output_exp_distance ()
240 return self._expression_change_count
243 return (self.output_expression_change_count (),
244 self.orphan_count (),
245 self.geometric_distance ())
247 def read_signature_file (name):
248 print 'reading', name
250 entries = open (name).read ().split ('\n')
251 def string_to_tup (s):
252 return tuple (map (float, s.split (' ')))
254 def string_to_entry (s):
255 fields = s.split('@')
256 fields[2] = string_to_tup (fields[2])
257 fields[3] = string_to_tup (fields[3])
259 return tuple (fields)
261 entries = [string_to_entry (e) for e in entries
262 if e and not e.startswith ('#')]
264 grob_sigs = [GrobSignature (e) for e in entries]
265 sig = SystemSignature (grob_sigs)
269 ################################################################
270 # different systems of a .ly file.
273 return os.popen (c).read ()
279 raise Exception ("failed")
282 def compare_png_images (old, new, dir):
284 m = re.search ('([0-9]+) x ([0-9]+)', read_pipe ('file %s' % f))
286 return tuple (map (int, m.groups ()))
288 dest = os.path.join (dir, new.replace ('.png', '.compare.jpeg'))
290 dims1 = png_dims (old)
291 dims2 = png_dims (new)
292 except AttributeError:
294 system ('touch %(dest)s' % locals ())
297 dims = (min (dims1[0], dims2[0]),
298 min (dims1[1], dims2[1]))
300 system ('convert -depth 8 -crop %dx%d+0+0 %s crop1.png' % (dims + (old,)))
301 system ('convert -depth 8 -crop %dx%d+0+0 %s crop2.png' % (dims + (new,)))
303 system ('compare -depth 8 crop1.png crop2.png diff.png')
305 system ("convert -depth 8 diff.png -blur 0x3 -negate -channel alpha,blue -type TrueColorMatte -fx 'intensity' matte.png")
307 system ("composite -quality 65 matte.png %(new)s %(dest)s" % locals ())
311 self.original_name = ''
312 self.base_names = ('','')
313 self.system_links = {}
314 self._distance = None
316 def add_system_link (self, link, number):
317 self.system_links[number] = link
319 def calc_distance (self):
322 orphan_distance = 0.0
323 for l in self.system_links.values ():
324 d = max (d, l.geometric_distance ())
325 orphan_distance += l.orphan_count ()
327 return d + orphan_distance
330 if type (self._distance) != type (0.0):
331 return self.calc_distance ()
333 return self._distance
335 def text_record_string (self):
336 return '%-30f %-20s\n' % (self.distance (),
339 def source_file (self):
340 for ext in ('.ly', '.ly.txt'):
341 if os.path.exists (self.base_names[1] + ext):
342 return self.base_names[1] + ext
345 def add_file_compare (self, f1, f2):
348 def note_system_index (m):
349 system_index.append (int (m.group (1)))
352 base1 = re.sub ("-([0-9]+).signature", note_system_index, f1)
353 base2 = re.sub ("-([0-9]+).signature", note_system_index, f2)
355 self.base_names = (os.path.normpath (base1),
356 os.path.normpath (base2))
358 def note_original (match):
359 self.original_name = match.group (1)
362 if not self.original_name:
363 self.original_name = os.path.split (base1)[1]
365 ## ugh: drop the .ly.txt
366 for ext in ('.ly', '.ly.txt'):
368 re.sub (r'\\sourcefilename "([^"]+)"',
369 note_original, open (base1 + ext).read ())
373 s1 = read_signature_file (f1)
374 s2 = read_signature_file (f2)
376 link = SystemLink (s1, s2)
378 self.add_system_link (link, system_index[0])
380 def link_files_for_html (self, old_dir, new_dir, dest_dir):
381 png_linked = [[], []]
382 for ext in ('.png', '.ly', '-page*png'):
385 for f in glob.glob (self.base_names[oldnew] + ext):
386 dst = dest_dir + '/' + f
389 if f.endswith ('.png'):
390 png_linked[oldnew].append (f)
392 for (old,new) in zip (png_linked[0], png_linked[1]):
393 compare_png_images (old, new, dest_dir)
395 def html_record_string (self, old_dir, new_dir):
396 def img_cell (ly, img, name):
400 name = '<tt>%s</tt>' % name
405 <img src="%(img)s" style="border-style: none; max-width: 500px;">
407 <font size="-2">(<a href="%(ly)s">%(name)s</a>)
412 def multi_img_cell (ly, imgs, name):
416 name = '<tt>%s</tt>' % name
418 imgs_str = '\n'.join (['''<a href="%s">
419 <img src="%s" style="border-style: none; max-width: 500px;">
420 </a><br>''' % (img, img)
427 <font size="-2">(<a href="%(ly)s">%(name)s</a>)
434 def cell (base, name):
435 pat = base + '-page*.png'
436 pages = glob.glob (pat)
439 return multi_img_cell (base + '.ly', sorted (pages), name)
441 return img_cell (base + '.ly', base + '.png', name)
444 html_2 = self.base_names[1] + '.html'
445 name = self.original_name
451 (<a href="%s">details</a>)
457 ''' % (self.distance (), html_2,
458 cell (self.base_names[0], name),
459 cell (self.base_names[1], name).replace ('.png', '.compare.jpeg'))
464 def html_system_details_string (self):
465 systems = self.system_links.items ()
469 for (c, link) in systems:
470 e = '<td>%d</td>' % c
471 for d in link.distance ():
472 e += '<td>%f</td>' % d
474 e = '<tr>%s</tr>' % e
478 e = '<td>%d</td>' % c
479 for s in (link.output_expression_details_string (),
480 link.orphan_details_string (),
481 link.geo_details_string ()):
482 e += "<td>%s</td>" % s
485 e = '<tr>%s</tr>' % e
488 original = self.original_name
491 <title>comparison details for %(original)s</title>
510 def write_html_system_details (self, dir1, dir2, dest_dir):
511 dest_file = os.path.join (dest_dir, self.base_names[1] + '.html')
513 details = open_write_file (dest_file)
514 details.write (self.html_system_details_string ())
516 ################################################################
524 def compare_signature_files (f1, f2):
525 s1 = read_signature_file (f1)
526 s2 = read_signature_file (f2)
528 return SystemLink (s1, s2).distance ()
530 def paired_files (dir1, dir2, pattern):
532 Search DIR1 and DIR2 for PATTERN.
534 Return (PAIRED, MISSING-FROM-2, MISSING-FROM-1)
538 files1 = dict ((os.path.split (f)[1], 1) for f in glob.glob (dir1 + '/' + pattern))
539 files2 = dict ((os.path.split (f)[1], 1) for f in glob.glob (dir2 + '/' + pattern))
543 for f in files1.keys ():
550 return (pairs, files2.keys (), missing)
552 class ComparisonData:
554 self.result_dict = {}
559 def compare_trees (self, dir1, dir2):
560 self.compare_directories (dir1, dir2)
562 (root, dirs, files) = os.walk (dir1).next ()
564 d1 = os.path.join (dir1, d)
565 d2 = os.path.join (dir2, d)
567 if os.path.islink (d1) or os.path.islink (d2):
570 if os.path.isdir (d2):
571 self.compare_trees (d1, d2)
573 def compare_directories (self, dir1, dir2):
575 (paired, m1, m2) = paired_files (dir1, dir2, '*.signature')
577 self.missing += [(dir1, m) for m in m1]
578 self.added += [(dir2, m) for m in m2]
581 if (inspect_max_count
582 and len (self.file_links) > inspect_max_count):
588 self.compare_files (f1, f2)
590 def compare_files (self, f1, f2):
591 name = os.path.split (f1)[1]
592 name = re.sub ('-[0-9]+.signature', '', name)
596 file_link = self.file_links[name]
598 file_link = FileLink ()
599 self.file_links[name] = file_link
601 file_link.add_file_compare (f1,f2)
603 def write_text_result_page (self, filename, threshold):
608 print 'writing "%s"' % filename
609 out = open_write_file (filename)
611 ## todo: support more scores.
612 results = [(link.distance(), link)
613 for link in self.file_links.values ()]
618 for (score, link) in results:
619 if score > threshold:
620 out.write (link.text_record_string ())
623 out.write ('%d below threshold\n' % len ([1 for s,l in results
624 if threshold >= s > 0.0]))
625 out.write ('%d unchanged\n' % len ([1 for (s,l) in results if s == 0.0]))
627 def create_text_result_page (self, dir1, dir2, dest_dir, threshold):
628 self.write_text_result_page (dest_dir + '/index.txt', threshold)
630 def create_html_result_page (self, dir1, dir2, dest_dir, threshold):
631 dir1 = dir1.replace ('//', '/')
632 dir2 = dir2.replace ('//', '/')
634 results = [(link.distance(), link)
635 for link in self.file_links.values ()]
640 old_prefix = os.path.split (dir1)[1]
641 for (score, link) in results:
642 if score <= threshold:
645 link.link_files_for_html (dir1, dir2, dest_dir)
646 link.write_html_system_details (dir1, dir2, dest_dir)
648 html += link.html_record_string (dir1, dir2)
652 <table rules="rows" border bordercolor="blue">
660 </html>''' % locals()
663 below_count =len ([1 for s,l in results
664 if threshold >= s > 0.0])
667 html += ('<p>%d below threshold</p>' % below_count)
669 html += ('<p>%d unchanged</p>'
670 % len ([1 for (s,l) in results if s == 0.0]))
673 dest_file = dest_dir + '/index.html'
674 open_write_file (dest_file).write (html)
676 def print_results (self, threshold):
677 self.write_text_result_page ('', threshold)
679 def compare_trees (dir1, dir2, dest_dir, threshold):
680 data = ComparisonData ()
681 data.compare_trees (dir1, dir2)
682 data.print_results (threshold)
684 if os.path.isdir (dest_dir):
685 system ('rm -rf %s '% dest_dir)
687 data.create_html_result_page (dir1, dir2, dest_dir, threshold)
688 data.create_text_result_page (dir1, dir2, dest_dir, threshold)
690 ################################################################
694 if not os.path.isdir (x):
698 def link_file (x, y):
699 mkdir (os.path.split (y)[0])
703 print 'OSError', x, y, z
706 def open_write_file (x):
707 d = os.path.split (x)[0]
719 def test_paired_files ():
720 print paired_files (os.environ["HOME"] + "/src/lilypond/scripts/",
721 os.environ["HOME"] + "/src/lilypond-stable/buildscripts/", '*.py')
724 def test_compare_trees ():
725 system ('rm -rf dir1 dir2')
726 system ('mkdir dir1 dir2')
727 system ('cp 20{-*.signature,.ly,.png} dir1')
728 system ('cp 20{-*.signature,.ly,.png} dir2')
729 system ('cp 20expr{-*.signature,.ly,.png} dir1')
730 system ('cp 19{-*.signature,.ly,.png} dir2/')
731 system ('cp 19{-*.signature,.ly,.png} dir1/')
732 system ('cp 19-1.signature 19-sub-1.signature')
733 system ('cp 19.ly 19-sub.ly')
734 system ('cp 19.png 19-sub.png')
736 system ('cp 20multipage* dir1')
737 system ('cp 20multipage* dir2')
738 system ('cp 19multipage-1.signature dir2/20multipage-1.signature')
741 system ('mkdir -p dir1/subdir/ dir2/subdir/')
742 system ('cp 19-sub{-*.signature,.ly,.png} dir1/subdir/')
743 system ('cp 19-sub{-*.signature,.ly,.png} dir2/subdir/')
744 system ('cp 20grob{-*.signature,.ly,.png} dir2/')
745 system ('cp 20grob{-*.signature,.ly,.png} dir1/')
747 ## introduce differences
748 system ('cp 19-1.signature dir2/20-1.signature')
749 system ('cp 19.png dir2/20.png')
750 system ('cp 19multipage-page1.png dir2/20multipage-page1.png')
751 system ('cp 20-1.signature dir2/subdir/19-sub-1.signature')
752 system ('cp 20.png dir2/subdir/19-sub.png')
755 system ('cp 19-1.signature dir2/20grob-1.signature')
756 system ('cp 19-1.signature dir2/20grob-2.signature')
758 compare_trees ('dir1', 'dir2', 'compare-dir1dir2', 0.5)
761 def test_basic_compare ():
763 #(set! toplevel-score-handler print-score-with-defaults)
764 #(set! toplevel-music-handler
766 (if (not (eq? (ly:music-property m 'void) #t))
767 (print-score-with-defaults
768 p (scorify-music m p)))))
770 \sourcefilename "my-source.ly"
773 \header { tagline = ##f }
775 \new Staff \relative c {
776 c4^"%(userstring)s" %(extragrob)s
778 \new Staff \relative c {
779 c4^"%(userstring)s" %(extragrob)s
784 dicts = [{ 'papermod' : '',
787 'userstring': 'test' },
788 { 'papermod' : '#(set-global-staff-size 19.5)',
791 'userstring': 'test' },
795 'userstring': 'blabla' },
798 'extragrob': 'r2. \\break c1',
799 'userstring': 'test' },
804 open (d['name'] + '.ly','w').write (ly_template % d)
806 names = [d['name'] for d in dicts]
808 system ('lilypond -ddump-signatures --png -b eps ' + ' '.join (names))
812 #(set-default-paper-size "a6")
816 open ('20multipage', 'w').write (multipage_str)
817 open ('19multipage', 'w').write ('#(set-global-staff-size 19.5)\n' + multipage_str)
818 system ('lilypond -ddump-signatures --png 19multipage 20multipage ')
820 test_compare_signatures (names)
822 def test_compare_signatures (names, timing=False):
833 for t in range (0, times):
834 sigs = dict ((n, read_signature_file ('%s-1.signature' % n)) for n in names)
838 print 'elapsed', (time.clock() - t0)/count
844 for (n1, s1) in sigs.items():
845 for (n2, s2) in sigs.items():
846 combinations['%s-%s' % (n1, n2)] = SystemLink (s1,s2).distance ()
850 print 'elapsed', (time.clock() - t0)/count
852 results = combinations.items ()
857 assert combinations['20-20'] == (0.0,0.0,0.0)
858 assert combinations['20-20expr'][0] > 0.0
859 assert combinations['20-19'][2] < 10.0
860 assert combinations['20-19'][2] > 0.0
864 dir = 'test-output-distance'
866 do_clean = not os.path.exists (dir)
868 print 'test results in ', dir
870 system ('rm -rf ' + dir)
871 system ('mkdir ' + dir)
875 test_basic_compare ()
877 test_compare_trees ()
879 ################################################################
883 p = optparse.OptionParser ("output-distance - compare LilyPond formatting runs")
884 p.usage = 'output-distance.py [options] tree1 tree2'
886 p.add_option ('', '--test-self',
889 help='run test method')
891 p.add_option ('--max-count',
897 help='only analyze COUNT signature pairs')
899 p.add_option ('', '--threshold',
904 help='threshold for geometric distance')
906 (o,a) = p.parse_args ()
916 global inspect_max_count
917 inspect_max_count = o.max_count
919 compare_trees (a[0], a[1], os.path.join (a[1], 'compare-' + a[0]),
922 if __name__ == '__main__':