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 shorten_string (s):
24 if len (s) > 2*threshold:
25 s = s[:threshold] + '..' + s[-threshold:]
28 def max_distance (x1, x2):
31 for (p,q) in zip (x1, x2):
32 dist = max (abs (p-q), dist)
37 empty_interval = (INFTY, -INFTY)
38 empty_bbox = (empty_interval, empty_interval)
40 def interval_is_empty (i):
43 def interval_length (i):
44 return max (i[1]-i[0], 0)
46 def interval_union (i1, i2):
47 return (min (i1[0], i2[0]),
50 def interval_intersect (i1, i2):
51 return (max (i1[0], i2[0]),
54 def bbox_is_empty (b):
55 return (interval_is_empty (b[0])
56 or interval_is_empty (b[1]))
58 def bbox_union (b1, b2):
59 return (interval_union (b1[X_AXIS], b2[X_AXIS]),
60 interval_union (b2[Y_AXIS], b2[Y_AXIS]))
62 def bbox_intersection (b1, b2):
63 return (interval_intersect (b1[X_AXIS], b2[X_AXIS]),
64 interval_intersect (b2[Y_AXIS], b2[Y_AXIS]))
67 return interval_length (b[X_AXIS]) * interval_length (b[Y_AXIS])
69 def bbox_diameter (b):
70 return max (interval_length (b[X_AXIS]),
71 interval_length (b[Y_AXIS]))
74 def difference_area (a, b):
75 return bbox_area (a) - bbox_area (bbox_intersection (a,b))
78 def __init__ (self, exp_list):
79 (self.name, self.origin, bbox_x,
80 bbox_y, self.output_expression) = tuple (exp_list)
82 self.bbox = (bbox_x, bbox_y)
83 self.centroid = (bbox_x[0] + bbox_x[1], bbox_y[0] + bbox_y[1])
86 return '%s: (%.2f,%.2f), (%.2f,%.2f)\n' % (self.name,
92 def axis_centroid (self, axis):
93 return apply (sum, self.bbox[axis]) / 2
95 def centroid_distance (self, other, scale):
96 return max_distance (self.centroid, other.centroid) / scale
98 def bbox_distance (self, other):
99 divisor = bbox_area (self.bbox) + bbox_area (other.bbox)
102 return (difference_area (self.bbox, other.bbox) +
103 difference_area (other.bbox, self.bbox)) / divisor
107 def expression_distance (self, other):
108 if self.output_expression == other.output_expression:
113 ################################################################
116 class SystemSignature:
117 def __init__ (self, grob_sigs):
120 val = d.setdefault (g.name, [])
124 self.set_all_bbox (grob_sigs)
126 def set_all_bbox (self, grobs):
127 self.bbox = empty_bbox
129 self.bbox = bbox_union (g.bbox, self.bbox)
131 def closest (self, grob_name, centroid):
135 grobs = self.grob_dict[grob_name]
138 d = max_distance (g.centroid, centroid)
149 return reduce (lambda x,y: x+y, self.grob_dict.values(), [])
151 ################################################################
152 ## comparison of systems.
155 def __init__ (self, system1, system2):
156 self.system1 = system1
157 self.system2 = system2
159 self.link_list_dict = {}
160 self.back_link_dict = {}
167 self.geo_distances = {}
170 self.expression_changed = []
172 self._geometric_distance = None
173 self._expression_change_count = None
174 self._orphan_count = None
176 for g in system1.grobs ():
178 ## skip empty bboxes.
179 if bbox_is_empty (g.bbox):
182 closest = system2.closest (g.name, g.centroid)
184 self.link_list_dict.setdefault (closest, [])
185 self.link_list_dict[closest].append (g)
186 self.back_link_dict[g] = closest
189 def calc_geometric_distance (self):
191 for (g1,g2) in self.back_link_dict.items ():
193 d = g1.bbox_distance (g2)
195 self.geo_distances[(g1,g2)] = d
199 self._geometric_distance = total
201 def calc_orphan_count (self):
203 for (g1, g2) in self.back_link_dict.items ():
205 self.orphans.append ((g1, None))
209 self._orphan_count = count
211 def calc_output_exp_distance (self):
213 for (g1,g2) in self.back_link_dict.items ():
215 d += g1.expression_distance (g2)
217 self._expression_change_count = d
219 def output_expression_details_string (self):
220 return ', '.join ([g1.name for g1 in self.expression_changed])
222 def geo_details_string (self):
223 results = [(d, g1,g2) for ((g1, g2), d) in self.geo_distances.items()]
227 return ', '.join (['%s: %f' % (g1.name, d) for (d, g1, g2) in results])
229 def orphan_details_string (self):
230 return ', '.join (['%s-None' % g1.name for (g1,g2) in self.orphans if g2==None])
232 def geometric_distance (self):
233 if self._geometric_distance == None:
234 self.calc_geometric_distance ()
235 return self._geometric_distance
237 def orphan_count (self):
238 if self._orphan_count == None:
239 self.calc_orphan_count ()
241 return self._orphan_count
243 def output_expression_change_count (self):
244 if self._expression_change_count == None:
245 self.calc_output_exp_distance ()
246 return self._expression_change_count
249 return (self.output_expression_change_count (),
250 self.orphan_count (),
251 self.geometric_distance ())
253 def read_signature_file (name):
254 print 'reading', name
256 entries = open (name).read ().split ('\n')
257 def string_to_tup (s):
258 return tuple (map (float, s.split (' ')))
260 def string_to_entry (s):
261 fields = s.split('@')
262 fields[2] = string_to_tup (fields[2])
263 fields[3] = string_to_tup (fields[3])
265 return tuple (fields)
267 entries = [string_to_entry (e) for e in entries
268 if e and not e.startswith ('#')]
270 grob_sigs = [GrobSignature (e) for e in entries]
271 sig = SystemSignature (grob_sigs)
275 ################################################################
276 # different systems of a .ly file.
279 return os.popen (c).read ()
285 raise Exception ("failed")
288 def compare_png_images (old, new, dir):
290 m = re.search ('([0-9]+) x ([0-9]+)', read_pipe ('file %s' % f))
292 return tuple (map (int, m.groups ()))
294 dest = os.path.join (dir, new.replace ('.png', '.compare.jpeg'))
296 dims1 = png_dims (old)
297 dims2 = png_dims (new)
298 except AttributeError:
300 system ('touch %(dest)s' % locals ())
303 dims = (min (dims1[0], dims2[0]),
304 min (dims1[1], dims2[1]))
306 system ('convert -depth 8 -crop %dx%d+0+0 %s crop1.png' % (dims + (old,)))
307 system ('convert -depth 8 -crop %dx%d+0+0 %s crop2.png' % (dims + (new,)))
309 system ('compare -depth 8 crop1.png crop2.png diff.png')
311 system ("convert -depth 8 diff.png -blur 0x3 -negate -channel alpha,blue -type TrueColorMatte -fx 'intensity' matte.png")
313 system ("composite -quality 65 matte.png %(new)s %(dest)s" % locals ())
317 self.original_name = ''
318 self.base_names = ('','')
319 self.system_links = {}
320 self._distance = None
322 def add_system_link (self, link, number):
323 self.system_links[number] = link
325 def calc_distance (self):
328 orphan_distance = 0.0
329 for l in self.system_links.values ():
330 d = max (d, l.geometric_distance ())
331 orphan_distance += l.orphan_count ()
333 return d + orphan_distance
336 if type (self._distance) != type (0.0):
337 return self.calc_distance ()
339 return self._distance
341 def text_record_string (self):
342 return '%-30f %-20s\n' % (self.distance (),
345 def source_file (self):
346 for ext in ('.ly', '.ly.txt'):
347 if os.path.exists (self.base_names[1] + ext):
348 return self.base_names[1] + ext
351 def add_file_compare (self, f1, f2):
354 def note_system_index (m):
355 system_index.append (int (m.group (1)))
358 base1 = re.sub ("-([0-9]+).signature", note_system_index, f1)
359 base2 = re.sub ("-([0-9]+).signature", note_system_index, f2)
361 self.base_names = (os.path.normpath (base1),
362 os.path.normpath (base2))
364 def note_original (match):
365 self.original_name = match.group (1)
368 if not self.original_name:
369 self.original_name = os.path.split (base1)[1]
371 ## ugh: drop the .ly.txt
372 for ext in ('.ly', '.ly.txt'):
374 re.sub (r'\\sourcefilename "([^"]+)"',
375 note_original, open (base1 + ext).read ())
379 s1 = read_signature_file (f1)
380 s2 = read_signature_file (f2)
382 link = SystemLink (s1, s2)
384 self.add_system_link (link, system_index[0])
386 def link_files_for_html (self, old_dir, new_dir, dest_dir):
387 png_linked = [[], []]
388 for ext in ('.png', '.ly', '-page*png'):
391 for f in glob.glob (self.base_names[oldnew] + ext):
392 dst = dest_dir + '/' + f
395 if f.endswith ('.png'):
396 png_linked[oldnew].append (f)
398 for (old,new) in zip (png_linked[0], png_linked[1]):
399 compare_png_images (old, new, dest_dir)
401 def html_record_string (self, old_dir, new_dir):
402 def img_cell (ly, img, name):
406 name = '<tt>%s</tt>' % name
411 <img src="%(img)s" style="border-style: none; max-width: 500px;">
413 <font size="-2">(<a href="%(ly)s">%(name)s</a>)
418 def multi_img_cell (ly, imgs, name):
422 name = '<tt>%s</tt>' % name
424 imgs_str = '\n'.join (['''<a href="%s">
425 <img src="%s" style="border-style: none; max-width: 500px;">
426 </a><br>''' % (img, img)
433 <font size="-2">(<a href="%(ly)s">%(name)s</a>)
440 def cell (base, name):
441 pat = base + '-page*.png'
442 pages = glob.glob (pat)
445 return multi_img_cell (base + '.ly', sorted (pages), name)
447 return img_cell (base + '.ly', base + '.png', name)
450 html_2 = self.base_names[1] + '.html'
451 name = self.original_name
457 (<a href="%s">details</a>)
463 ''' % (self.distance (), html_2,
464 cell (self.base_names[0], name),
465 cell (self.base_names[1], name).replace ('.png', '.compare.jpeg'))
470 def html_system_details_string (self):
471 systems = self.system_links.items ()
475 for (c, link) in systems:
476 e = '<td>%d</td>' % c
477 for d in link.distance ():
478 e += '<td>%f</td>' % d
480 e = '<tr>%s</tr>' % e
484 e = '<td>%d</td>' % c
485 for s in (link.output_expression_details_string (),
486 link.orphan_details_string (),
487 link.geo_details_string ()):
488 e += "<td>%s</td>" % s
491 e = '<tr>%s</tr>' % e
494 original = self.original_name
497 <title>comparison details for %(original)s</title>
516 def write_html_system_details (self, dir1, dir2, dest_dir):
517 dest_file = os.path.join (dest_dir, self.base_names[1] + '.html')
519 details = open_write_file (dest_file)
520 details.write (self.html_system_details_string ())
522 ################################################################
530 def compare_signature_files (f1, f2):
531 s1 = read_signature_file (f1)
532 s2 = read_signature_file (f2)
534 return SystemLink (s1, s2).distance ()
536 def paired_files (dir1, dir2, pattern):
538 Search DIR1 and DIR2 for PATTERN.
540 Return (PAIRED, MISSING-FROM-2, MISSING-FROM-1)
544 files1 = dict ((os.path.split (f)[1], 1) for f in glob.glob (dir1 + '/' + pattern))
545 files2 = dict ((os.path.split (f)[1], 1) for f in glob.glob (dir2 + '/' + pattern))
549 for f in files1.keys ():
556 return (pairs, files2.keys (), missing)
558 class ComparisonData:
560 self.result_dict = {}
565 def compare_trees (self, dir1, dir2):
566 self.compare_directories (dir1, dir2)
568 (root, dirs, files) = os.walk (dir1).next ()
570 d1 = os.path.join (dir1, d)
571 d2 = os.path.join (dir2, d)
573 if os.path.islink (d1) or os.path.islink (d2):
576 if os.path.isdir (d2):
577 self.compare_trees (d1, d2)
579 def compare_directories (self, dir1, dir2):
581 (paired, m1, m2) = paired_files (dir1, dir2, '*.signature')
583 self.missing += [(dir1, m) for m in m1]
584 self.added += [(dir2, m) for m in m2]
587 if (inspect_max_count
588 and len (self.file_links) > inspect_max_count):
594 self.compare_files (f1, f2)
596 def compare_files (self, f1, f2):
597 name = os.path.split (f1)[1]
598 name = re.sub ('-[0-9]+.signature', '', name)
602 file_link = self.file_links[name]
604 file_link = FileLink ()
605 self.file_links[name] = file_link
607 file_link.add_file_compare (f1,f2)
609 def write_text_result_page (self, filename, threshold):
614 print 'writing "%s"' % filename
615 out = open_write_file (filename)
617 ## todo: support more scores.
618 results = [(link.distance(), link)
619 for link in self.file_links.values ()]
624 for (score, link) in results:
625 if score > threshold:
626 out.write (link.text_record_string ())
629 out.write ('%d below threshold\n' % len ([1 for s,l in results
630 if threshold >= s > 0.0]))
631 out.write ('%d unchanged\n' % len ([1 for (s,l) in results if s == 0.0]))
633 def create_text_result_page (self, dir1, dir2, dest_dir, threshold):
634 self.write_text_result_page (dest_dir + '/index.txt', threshold)
636 def create_html_result_page (self, dir1, dir2, dest_dir, threshold):
637 dir1 = dir1.replace ('//', '/')
638 dir2 = dir2.replace ('//', '/')
640 results = [(link.distance(), link)
641 for link in self.file_links.values ()]
646 old_prefix = os.path.split (dir1)[1]
647 for (score, link) in results:
648 if score <= threshold:
651 link.link_files_for_html (dir1, dir2, dest_dir)
652 link.write_html_system_details (dir1, dir2, dest_dir)
654 html += link.html_record_string (dir1, dir2)
657 short_dir1 = shorten_string (dir1)
658 short_dir2 = shorten_string (dir2)
660 <table rules="rows" border bordercolor="blue">
663 <th>%(short_dir1)s</th>
664 <th>%(short_dir2)s</th>
668 </html>''' % locals()
671 below_count =len ([1 for s,l in results
672 if threshold >= s > 0.0])
675 html += ('<p>%d below threshold</p>' % below_count)
677 html += ('<p>%d unchanged</p>'
678 % len ([1 for (s,l) in results if s == 0.0]))
681 dest_file = dest_dir + '/index.html'
682 open_write_file (dest_file).write (html)
684 def print_results (self, threshold):
685 self.write_text_result_page ('', threshold)
687 def compare_trees (dir1, dir2, dest_dir, threshold):
688 data = ComparisonData ()
689 data.compare_trees (dir1, dir2)
690 data.print_results (threshold)
692 if os.path.isdir (dest_dir):
693 system ('rm -rf %s '% dest_dir)
695 data.create_html_result_page (dir1, dir2, dest_dir, threshold)
696 data.create_text_result_page (dir1, dir2, dest_dir, threshold)
698 ################################################################
702 if not os.path.isdir (x):
706 def link_file (x, y):
707 mkdir (os.path.split (y)[0])
711 print 'OSError', x, y, z
714 def open_write_file (x):
715 d = os.path.split (x)[0]
727 def test_paired_files ():
728 print paired_files (os.environ["HOME"] + "/src/lilypond/scripts/",
729 os.environ["HOME"] + "/src/lilypond-stable/buildscripts/", '*.py')
732 def test_compare_trees ():
733 system ('rm -rf dir1 dir2')
734 system ('mkdir dir1 dir2')
735 system ('cp 20{-*.signature,.ly,.png} dir1')
736 system ('cp 20{-*.signature,.ly,.png} dir2')
737 system ('cp 20expr{-*.signature,.ly,.png} dir1')
738 system ('cp 19{-*.signature,.ly,.png} dir2/')
739 system ('cp 19{-*.signature,.ly,.png} dir1/')
740 system ('cp 19-1.signature 19-sub-1.signature')
741 system ('cp 19.ly 19-sub.ly')
742 system ('cp 19.png 19-sub.png')
744 system ('cp 20multipage* dir1')
745 system ('cp 20multipage* dir2')
746 system ('cp 19multipage-1.signature dir2/20multipage-1.signature')
749 system ('mkdir -p dir1/subdir/ dir2/subdir/')
750 system ('cp 19-sub{-*.signature,.ly,.png} dir1/subdir/')
751 system ('cp 19-sub{-*.signature,.ly,.png} dir2/subdir/')
752 system ('cp 20grob{-*.signature,.ly,.png} dir2/')
753 system ('cp 20grob{-*.signature,.ly,.png} dir1/')
755 ## introduce differences
756 system ('cp 19-1.signature dir2/20-1.signature')
757 system ('cp 19.png dir2/20.png')
758 system ('cp 19multipage-page1.png dir2/20multipage-page1.png')
759 system ('cp 20-1.signature dir2/subdir/19-sub-1.signature')
760 system ('cp 20.png dir2/subdir/19-sub.png')
763 system ('cp 19-1.signature dir2/20grob-1.signature')
764 system ('cp 19-1.signature dir2/20grob-2.signature')
766 compare_trees ('dir1', 'dir2', 'compare-dir1dir2', 0.5)
769 def test_basic_compare ():
771 #(set! toplevel-score-handler print-score-with-defaults)
772 #(set! toplevel-music-handler
774 (if (not (eq? (ly:music-property m 'void) #t))
775 (print-score-with-defaults
776 p (scorify-music m p)))))
778 \sourcefilename "my-source.ly"
781 \header { tagline = ##f }
783 \new Staff \relative c {
784 c4^"%(userstring)s" %(extragrob)s
786 \new Staff \relative c {
787 c4^"%(userstring)s" %(extragrob)s
792 dicts = [{ 'papermod' : '',
795 'userstring': 'test' },
796 { 'papermod' : '#(set-global-staff-size 19.5)',
799 'userstring': 'test' },
803 'userstring': 'blabla' },
806 'extragrob': 'r2. \\break c1',
807 'userstring': 'test' },
812 open (d['name'] + '.ly','w').write (ly_template % d)
814 names = [d['name'] for d in dicts]
816 system ('lilypond -ddump-signatures --png -b eps ' + ' '.join (names))
820 #(set-default-paper-size "a6")
824 open ('20multipage', 'w').write (multipage_str)
825 open ('19multipage', 'w').write ('#(set-global-staff-size 19.5)\n' + multipage_str)
826 system ('lilypond -ddump-signatures --png 19multipage 20multipage ')
828 test_compare_signatures (names)
830 def test_compare_signatures (names, timing=False):
841 for t in range (0, times):
842 sigs = dict ((n, read_signature_file ('%s-1.signature' % n)) for n in names)
846 print 'elapsed', (time.clock() - t0)/count
852 for (n1, s1) in sigs.items():
853 for (n2, s2) in sigs.items():
854 combinations['%s-%s' % (n1, n2)] = SystemLink (s1,s2).distance ()
858 print 'elapsed', (time.clock() - t0)/count
860 results = combinations.items ()
865 assert combinations['20-20'] == (0.0,0.0,0.0)
866 assert combinations['20-20expr'][0] > 0.0
867 assert combinations['20-19'][2] < 10.0
868 assert combinations['20-19'][2] > 0.0
872 dir = 'test-output-distance'
874 do_clean = not os.path.exists (dir)
876 print 'test results in ', dir
878 system ('rm -rf ' + dir)
879 system ('mkdir ' + dir)
883 test_basic_compare ()
885 test_compare_trees ()
887 ################################################################
891 p = optparse.OptionParser ("output-distance - compare LilyPond formatting runs")
892 p.usage = 'output-distance.py [options] tree1 tree2'
894 p.add_option ('', '--test-self',
897 help='run test method')
899 p.add_option ('--max-count',
905 help='only analyze COUNT signature pairs')
907 p.add_option ('', '--threshold',
912 help='threshold for geometric distance')
914 (o,a) = p.parse_args ()
924 global inspect_max_count
925 inspect_max_count = o.max_count
927 name = a[0].replace ('/', '')
928 name = shorten_string (name)
930 compare_trees (a[0], a[1], os.path.join (a[1], 'compare-' + name),
933 if __name__ == '__main__':