2 tie-formatting-problem.cc -- implement Tie_formatting_problem
4 source file of the GNU LilyPond music typesetter
6 (c) 2005--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
10 #include "tie-formatting-problem.hh"
13 #include "directional-element-interface.hh"
15 #include "libc-extension.hh"
17 #include "note-head.hh"
18 #include "rhythmic-head.hh"
20 #include "staff-symbol-referencer.hh"
22 #include "tie-configuration.hh"
28 Tie_formatting_problem::print_ties_configuration (Ties_configuration const *ties)
30 for (vsize i = 0; i < ties->size (); i++)
32 char const *man_pos = (specifications_[i].has_manual_position_) ? "(M)" : "";
33 char const *man_dir = (specifications_[i].has_manual_dir_) ? "(M)" : "";
34 char const *dir = (ties->at (i).dir_ == UP) ? "up" : "dn";
36 printf ("(P%d%s, %s%s) ", ties->at (i).position_, man_pos, dir, man_dir);
42 Tie_formatting_problem::get_attachment (Real y) const
48 attachments[d] = skyline_height (chord_outlines_[d], y, -d);
50 while (flip (&d) != LEFT);
55 Tie_formatting_problem::Tie_formatting_problem()
60 Tie_formatting_problem::~Tie_formatting_problem ()
62 for (Tie_configuration_map::const_iterator i (possibilities_.begin ());
63 i != possibilities_.end (); i++)
68 Tie_formatting_problem::set_chord_outline (vector<Item*> bounds,
71 Real staff_space = Staff_symbol_referencer::staff_space (bounds[0]);
74 vector<Box> head_boxes;
77 for (vsize i = 0; i < bounds.size (); i++)
79 Grob *head = bounds[i];
80 if (!Note_head::has_interface (head))
84 stem = unsmob_grob (head->get_object ("stem"));
86 Real p = Staff_symbol_referencer::get_position (head);
87 Interval y ((p-1) * 0.5 * staff_space,
88 (p+1) * 0.5 * staff_space);
90 Interval x = head->extent (x_refpoint_, X_AXIS);
91 head_boxes.push_back (Box (x, y));
92 boxes.push_back (Box (x, y));
94 Grob *dots = Rhythmic_head::get_dots (head);
95 if (dir == LEFT && dots)
97 Interval x = dots->extent (x_refpoint_, X_AXIS);
98 int p = int (Staff_symbol_referencer::get_position (dots));
100 dot_positions_.insert (p);
103 Interval y (dots->extent (dots, Y_AXIS));
104 y.translate (p * staff_space * 0.5);
106 boxes.push_back (Box (x, y));
110 chord_outlines_[dir] = empty_skyline (-dir);
111 if (bounds[0]->break_status_dir ())
113 Real x = robust_relative_extent (bounds[0], x_refpoint_, X_AXIS)[-dir];
114 chord_outlines_[dir].at (0).height_ = x;
117 for (vsize i = 0; i < boxes.size (); i++)
118 insert_extent_into_skyline (&chord_outlines_[dir] ,
119 boxes[i], Y_AXIS, -dir);
122 && !Stem::is_invisible (stem))
125 x.add_point (stem->relative_coordinate (x_refpoint_, X_AXIS));
126 x.widen (staff_space / 20); // ugh.
128 y.add_point (Stem::stem_end_position (stem) * staff_space * .5);
130 Direction stemdir = get_grob_direction (stem);
131 y.add_point (Stem::head_positions (stem)[-stemdir]
134 insert_extent_into_skyline (&chord_outlines_[dir], Box (x,y), Y_AXIS, -dir);
136 stem_extents_[dir].unite (Box (x,y));
140 Box flag_box = Stem::get_translated_flag (stem).extent_box ();
141 flag_box.translate( Offset (x[RIGHT], X_AXIS));
142 insert_extent_into_skyline (&chord_outlines_[dir], flag_box,
147 Direction updowndir = DOWN;
152 if (head_boxes.size())
154 Box b = boundary (head_boxes, updowndir, 0);
156 x[-dir] = b[X_AXIS].linear_combination (-dir / 2);
157 y[-updowndir] = b[Y_AXIS][updowndir];
158 y[updowndir] = updowndir * infinity_f;
162 insert_extent_into_skyline (&chord_outlines_[dir],
166 while (flip (&updowndir) != DOWN);
168 head_extents_[dir].set_empty ();
169 for (vsize i = 0; i < head_boxes.size (); i++)
171 head_extents_[dir].unite (head_boxes[i]);
177 Tie_formatting_problem::from_tie (Grob *tie)
180 ties.push_back (tie);
183 details_.from_grob (tie);
187 Tie_formatting_problem::common_x_refpoint () const
193 Tie_formatting_problem::from_ties (vector<Grob*> const &ties)
198 x_refpoint_ = ties[0];
199 for (vsize i = 0; i < ties.size (); i++)
201 x_refpoint_ = dynamic_cast<Spanner*> (ties[i])->get_bound (LEFT)->common_refpoint (x_refpoint_, X_AXIS);
202 x_refpoint_ = dynamic_cast<Spanner*> (ties[i])->get_bound (RIGHT)->common_refpoint (x_refpoint_, X_AXIS);
205 details_.from_grob (ties[0]);
210 vector<Item*> bounds;
212 for (vsize i = 0; i < ties.size (); i++)
214 Item *it = dynamic_cast<Spanner*> (ties[i])->get_bound (d);
216 bounds.push_back (it);
219 set_chord_outline (bounds, d);
221 while (flip (&d) != LEFT);
224 for (vsize i = 0; i < ties.size (); i++)
226 Tie_specification spec;
228 if (scm_is_number (ties[i]->get_property_data (ly_symbol2scm ("direction"))))
230 spec.manual_dir_ = to_dir (ties[i]->get_property ("direction"));
231 spec.has_manual_dir_ = true;
234 spec.position_ = Tie::get_position (ties[i]);
238 spec.note_head_drul_[d] = Tie::head (ties[i], d);
240 while (flip (&d) != LEFT);
242 specifications_.push_back (spec);
247 Tie_formatting_problem::from_semi_ties (vector<Grob*> const &lv_ties, Direction head_dir)
249 if (lv_ties.empty ())
252 details_.from_grob (lv_ties[0]);
255 for (vsize i = 0; i < lv_ties.size (); i++)
257 Tie_specification spec;
258 Item *head = unsmob_item (lv_ties[i]->get_object ("note-head"));
261 programming_error ("LV tie without head?!");
265 spec.position_ = int (Staff_symbol_referencer::get_position (head));
268 spec.note_head_drul_[head_dir] = head;
269 heads.push_back (head);
270 specifications_.push_back (spec);
273 x_refpoint_ = lv_ties [0];
274 for (vsize i = 0; i < lv_ties.size (); i++)
275 x_refpoint_ = lv_ties[i]->common_refpoint (x_refpoint_, X_AXIS);
276 for (vsize i = 0; i < heads.size (); i++)
277 x_refpoint_ = heads[i]->common_refpoint (x_refpoint_, X_AXIS);
279 set_chord_outline (heads, head_dir);
281 Real extremal = head_dir * infinity_f;
283 for (vsize i = 0; i < chord_outlines_[head_dir].size (); i++)
285 extremal = head_dir * min (head_dir * extremal,
286 head_dir * chord_outlines_[head_dir][i].height_);
289 Skyline_entry right_entry;
290 right_entry.width_.set_full ();
291 right_entry.height_ = extremal - head_dir * 1.5;
293 chord_outlines_[-head_dir].push_back (right_entry);
298 Tie_formatting_problem::get_tie_specification (int i) const
300 return specifications_[i];
305 Tie_formatting_problem::get_configuration (int pos, Direction dir) const
307 pair<int,int> key (pos, dir);
308 Tie_configuration_map::const_iterator f = possibilities_.find (key);
310 if (f != possibilities_.end ())
316 Tie_configuration *conf = generate_configuration (pos, dir);
317 ((Tie_formatting_problem*) this)->possibilities_[key] = conf;
322 Tie_formatting_problem::generate_configuration (int pos, Direction dir) const
324 Tie_configuration *conf = new Tie_configuration;
325 conf->position_ = pos;
327 Real y = conf->position_ * 0.5 * details_.staff_space_;
331 if (dot_positions_.find (pos) != dot_positions_.end ())
333 conf->delta_y_ += 0.25 * details_.staff_space_;
340 && max (fabs (head_extents_[LEFT][Y_AXIS][dir] - y),
341 fabs (head_extents_[RIGHT][Y_AXIS][dir] - y)) < 0.25
342 && !Staff_symbol_referencer::on_line (details_.staff_symbol_referencer_, pos))
345 (head_extents_[LEFT][Y_AXIS][dir] - y)
346 + dir * details_.outer_tie_vertical_gap_;
351 conf->attachment_x_ = get_attachment (y + conf->delta_y_);
352 Real h = conf->height (details_);
357 - should make sliding criterion, should flatten ties if
359 - they're just the wrong (ie. touching line at top & bottom)
363 if (h < details_.intra_space_threshold_ * 0.5 * details_.staff_space_)
365 if (!Staff_symbol_referencer::on_line (details_.staff_symbol_referencer_, pos)
366 && abs (pos) < 2 * Staff_symbol_referencer::staff_radius (details_.staff_symbol_referencer_))
368 conf->center_tie_vertically (details_);
370 else if (Staff_symbol_referencer::on_line (details_.staff_symbol_referencer_, pos))
372 conf->delta_y_ += dir *
373 details_.tip_staff_line_clearance_ * 0.5 * details_.staff_space_;
378 Real top_y = y + conf->delta_y_ + conf->dir_ * h;
379 Real top_pos = top_y / (0.5*details_.staff_space_);
380 int round_pos = int (my_round (top_pos));
382 /* TODO: should use other variable? */
383 Real clearance = details_.center_staff_line_clearance_;
384 if (fabs (top_pos - round_pos) < clearance
385 && Staff_symbol_referencer::on_staff_line (details_.staff_symbol_referencer_,
388 Real new_y = (round_pos + clearance * conf->dir_) * 0.5 * details_.staff_space_;
389 conf->delta_y_ = (new_y - top_y);
394 conf->attachment_x_ = get_attachment (y + conf->delta_y_);
395 if (conf->height (details_) < details_.intra_space_threshold_ * 0.5 * details_.staff_space_)
398 This is less sensible for long ties, since those are more
401 Interval close_by = get_attachment (y
403 + (dir * details_.intra_space_threshold_ * 0.25
404 * details_.staff_space_));
406 conf->attachment_x_.intersect (close_by);
409 conf->attachment_x_.widen ( - details_.x_gap_);
414 Real y = conf->position_ * details_.staff_space_ * 0.5 + conf->delta_y_;
415 if (stem_extents_[d][X_AXIS].is_empty ()
416 || !stem_extents_[d][Y_AXIS].contains (y))
419 conf->attachment_x_[d] =
420 d* min (d * conf->attachment_x_[d],
421 d * (stem_extents_[d][X_AXIS][-d] - d * details_.stem_gap_));
423 while (flip (&d) != LEFT);
428 TIE_IDX and TIES_CONF are optional.
431 Tie_formatting_problem::score_aptitude (Tie_configuration *conf,
432 Tie_specification const &spec,
433 Ties_configuration *ties_conf, int tie_idx) const
436 Real curve_y = conf->position_ * details_.staff_space_ * 0.5 + conf->delta_y_;
437 Real tie_y = spec.position_ * details_.staff_space_ * 0.5;
438 if (sign (curve_y - tie_y) != conf->dir_)
440 Real p = details_.wrong_direction_offset_penalty_;
442 ties_conf->add_tie_score (p, tie_idx, "wrong dir");
448 Real p = details_.vertical_distance_penalty_factor_ * fabs (curve_y - tie_y);
450 ties_conf->add_tie_score (p, tie_idx, "vdist");
458 if (!spec.note_head_drul_[d])
461 Interval head_x = spec.note_head_drul_[d]->extent (x_refpoint_, X_AXIS);
462 Real dist = head_x.distance (conf->attachment_x_[d]);
465 TODO: flatten with log or sqrt.
467 Real p = details_.horizontal_distance_penalty_factor_ * dist;
469 ties_conf->add_tie_score (p, tie_idx,
470 (d == LEFT) ? "lhdist" : "rhdist");
474 while (flip (&d) != LEFT);
480 Tie_formatting_problem::score_configuration (Tie_configuration *conf) const
487 Real length = conf->attachment_x_.length ();
489 conf->add_score (details_.min_length_penalty_factor_
490 * peak_around (0.33 * details_.min_length_, details_.min_length_, length),
493 Real tip_pos = conf->position_ + conf->delta_y_ / 0.5 * details_.staff_space_;
494 Real tip_y = tip_pos * details_.staff_space_ * 0.5;
495 Real height = conf->height (details_);
497 Real top_y = tip_y + conf->dir_ * height;
498 Real top_pos = 2 * top_y / details_.staff_space_;
499 Real round_top_pos = rint (top_pos);
500 if (Staff_symbol_referencer::on_line (details_.staff_symbol_referencer_,
502 && Staff_symbol_referencer::staff_radius (details_.staff_symbol_referencer_) > top_y)
505 details_.staff_line_collision_penalty_
506 * peak_around (0.1 * details_.center_staff_line_clearance_,
507 details_.center_staff_line_clearance_,
508 fabs (top_pos - round_top_pos)),
512 if (Staff_symbol_referencer::on_line (details_.staff_symbol_referencer_,
513 int (rint (tip_pos))))
515 conf->add_score (details_.staff_line_collision_penalty_
516 * peak_around (0.1 * details_.tip_staff_line_clearance_,
517 details_.tip_staff_line_clearance_,
518 fabs (tip_pos - rint (tip_pos))),
522 if (!dot_x_.is_empty ())
525 Real x = dot_x_.center ();
527 Bezier b = conf->get_transformed_bezier (details_);
528 if (b.control_point_extent (X_AXIS).contains (x))
530 Real y = b.get_other_coordinate (X_AXIS, x);
532 for (set<int>::const_iterator i (dot_positions_.begin ());
533 i != dot_positions_.end (); i ++)
536 conf->add_score (details_.dot_collision_penalty_
537 * peak_around (.1 * details_.dot_collision_clearance_,
538 details_.dot_collision_clearance_,
539 fabs (dot_pos * details_.staff_space_ * 0.5 - y)),
545 conf->scored_ = true;
549 Tie_formatting_problem::find_optimal_tie_configuration (Tie_specification const &spec) const
551 vector<Tie_configuration*> confs;
553 int pos = spec.position_;
554 Direction dir = spec.manual_dir_;
556 for (int i = 0; i < details_.single_tie_region_size_; i ++)
558 confs.push_back (generate_configuration (pos + i * dir, dir));
564 Real best_score = 1e6;
565 for (vsize i = 0; i < confs.size (); i ++)
567 score_configuration (confs[i]);
568 Real score = score_aptitude (confs[i], spec, 0, 0)
569 + confs[i]->score ();
571 if (score < best_score)
578 Tie_configuration best = *confs[best_idx];
579 for (vsize i = 0; i < confs.size (); i++)
585 Tie_specification::Tie_specification ()
587 has_manual_position_ = false;
588 has_manual_dir_ = false;
590 manual_position_ = 0;
591 manual_dir_ = CENTER;
592 note_head_drul_[LEFT] =
593 note_head_drul_[RIGHT] = 0;
598 Tie_formatting_problem::score_ties_aptitude (Ties_configuration *ties) const
600 if (ties->size () != specifications_.size ())
602 programming_error ("Huh? Mismatch between sizes.");
606 for (vsize i = 0; i < ties->size (); i++)
607 score_aptitude (&ties->at (i), specifications_[i],
612 Tie_formatting_problem::score_ties (Ties_configuration *ties) const
617 score_ties_configuration (ties);
618 score_ties_aptitude (ties);
619 ties->scored_ = true;
623 Tie_formatting_problem::score_ties_configuration (Ties_configuration *ties) const
625 for (vsize i = 0; i < ties->size (); i++)
627 score_configuration (&ties->at (i));
628 ties->add_tie_score (ties->at (i).score (), i, "conf");
631 Real last_edge = 0.0;
632 Real last_center = 0.0;
633 for (vsize i = 0; i < ties->size (); i++)
635 Bezier b (ties->at (i).get_transformed_bezier (details_));
637 Real center = b.curve_point (0.5)[Y_AXIS];
638 Real edge = b.curve_point (0.0)[Y_AXIS];
642 if (edge <= last_edge)
643 ties->add_score (details_.tie_column_monotonicity_penalty_, "monoton edge");
644 if (center <= last_center)
645 ties->add_score (details_.tie_column_monotonicity_penalty_, "monoton cent");
647 ties->add_score (details_.tie_tie_collision_penalty_ *
648 peak_around (0.1 * details_.tie_tie_collision_distance_,
649 details_.tie_tie_collision_distance_,
650 fabs (center - last_center)),
652 ties->add_score (details_.tie_tie_collision_penalty_ *
653 peak_around (0.1 * details_.tie_tie_collision_distance_,
654 details_.tie_tie_collision_distance_,
655 fabs (edge - last_edge)), "tietie edge");
659 last_center = center;
662 ties->add_score (details_.outer_tie_length_symmetry_penalty_factor_
663 * fabs (ties->at (0).attachment_x_.length () - ties->back ().attachment_x_.length ()),
666 ties->add_score (details_.outer_tie_vertical_distance_symmetry_penalty_factor_
667 * fabs (fabs (specifications_[0].position_ * 0.5 * details_.staff_space_
668 - (ties->at (0).position_ * 0.5 * details_.staff_space_
669 + ties->at (0).delta_y_))
671 fabs (specifications_.back ().position_ * 0.5 * details_.staff_space_
672 - (ties->back ().position_ * 0.5 * details_.staff_space_
673 + ties->back ().delta_y_))),
678 Generate with correct X-attachments and beziers, copying delta_y_
679 from TIES_CONFIG if necessary.
682 Tie_formatting_problem::generate_ties_configuration (Ties_configuration const &ties_config)
684 Ties_configuration copy;
685 for (vsize i = 0; i < ties_config.size (); i++)
687 Tie_configuration * ptr = get_configuration (ties_config[i].position_, ties_config[i].dir_);
688 if (specifications_[i].has_manual_position_)
691 = (specifications_[i].manual_position_ - ties_config[i].position_)
692 * 0.5 * details_.staff_space_;
694 copy.push_back (*ptr);
701 Tie_formatting_problem::generate_base_chord_configuration ()
703 Ties_configuration ties_config;
704 for (vsize i = 0; i < specifications_.size (); i ++)
706 Tie_configuration conf;
707 if (specifications_[i].has_manual_dir_)
708 conf.dir_ = specifications_[i].manual_dir_;
709 if (specifications_[i].has_manual_position_)
711 conf.position_ = (int) my_round (specifications_[i].manual_position_);
712 conf.delta_y_ = (specifications_[i].manual_position_ - conf.position_)
713 * 0.5 * details_.staff_space_;
717 conf.position_ = specifications_[i].position_;
719 ties_config.push_back (conf);
722 set_ties_config_standard_directions (&ties_config);
723 for (vsize i = 0; i < ties_config.size (); i++)
724 if (!specifications_[i].manual_position_)
725 ties_config[i].position_ += ties_config[i].dir_;
727 ties_config = generate_ties_configuration (ties_config);
733 Tie_formatting_problem::find_best_variation (Ties_configuration const &base,
734 vector<Tie_configuration_variation> vars)
736 Ties_configuration best = base;
739 This simply is 1-opt: we have K substitions, and we try applying
740 exactly every one for each.
742 for (vsize i = 0; i < vars.size (); i++)
744 Ties_configuration variant (base);
745 variant[vars[i].index_] = *vars[i].suggestion_;
747 variant.reset_score ();
748 score_ties (&variant);
750 if (variant.score () < best.score ())
762 Tie_formatting_problem::generate_optimal_chord_configuration ()
765 Ties_configuration base = generate_base_chord_configuration ();
766 vector<Tie_configuration_variation> vars = generate_collision_variations (base);
769 Ties_configuration best = find_best_variation (base, vars);
770 vars = generate_extremal_tie_variations (best);
771 best = find_best_variation (best, vars);
777 Tie_formatting_problem::set_ties_config_standard_directions (Ties_configuration *tie_configs)
779 if (tie_configs->empty ())
782 if (!tie_configs->at (0).dir_)
783 tie_configs->at (0).dir_ = DOWN;
784 if (!tie_configs->back ().dir_)
785 tie_configs->back ().dir_ = UP;
790 for (vsize i = 1; i < tie_configs->size (); i++)
792 Real diff = (tie_configs->at (i-1).position_
793 - tie_configs->at (i).position_);
795 if (fabs (diff) <= 1)
797 if (!tie_configs->at (i-1).dir_)
798 tie_configs->at (i-1).dir_ = DOWN;
799 if (!tie_configs->at (i).dir_)
800 tie_configs->at (i).dir_ = UP;
804 for (vsize i = 1; i < tie_configs->size() - 1; i++)
806 Tie_configuration &conf = tie_configs->at (i);
810 Direction position_dir =
811 Direction (sign (conf.position_));
815 conf.dir_ = position_dir;
819 Tie_configuration_variation::Tie_configuration_variation ()
825 vector<Tie_configuration_variation>
826 Tie_formatting_problem::generate_extremal_tie_variations (Ties_configuration const &ties) const
828 vector<Tie_configuration_variation> vars;
832 if (boundary (ties, d, 0).dir_ == d
833 && !boundary (specifications_, d, 0).has_manual_position_)
834 for (int i = 1; i <= details_.multi_tie_region_size_; i++)
836 Tie_configuration_variation var;
837 var.index_ = (d == DOWN) ? 0 : ties.size () - 1;
838 var.suggestion_ = get_configuration (boundary (ties, d, 0).position_
840 vars.push_back (var);
843 while (flip (&d) != DOWN);
849 vector<Tie_configuration_variation>
850 Tie_formatting_problem::generate_collision_variations (Ties_configuration const &ties) const
852 Real center_distance_tolerance = 0.25;
854 vector<Tie_configuration_variation> vars;
855 Real last_center = 0.0;
856 for (vsize i = 0; i < ties.size (); i++)
858 Bezier b (ties[i].get_transformed_bezier (details_));
860 Real center = b.curve_point (0.5)[Y_AXIS];
864 if (center <= last_center + center_distance_tolerance)
866 if (!specifications_[i].has_manual_dir_)
868 Tie_configuration_variation var;
870 var.suggestion_ = get_configuration (specifications_[i].position_
874 vars.push_back (var);
877 if (!specifications_[i-1].has_manual_dir_)
879 Tie_configuration_variation var;
881 var.suggestion_ = get_configuration (specifications_[i-1].position_
885 vars.push_back (var);
888 if (i == 1 && !specifications_[i-1].has_manual_position_
889 && ties[i-1].dir_ == DOWN)
891 Tie_configuration_variation var;
893 var.suggestion_ = get_configuration (specifications_[i-1].position_
895 vars.push_back (var);
897 if (i == ties.size() && !specifications_[i].has_manual_position_
898 && ties[i].dir_ == UP)
900 Tie_configuration_variation var;
902 var.suggestion_ = get_configuration (specifications_[i].position_
904 vars.push_back (var);
907 else if (dot_positions_.find (ties[i].position_) != dot_positions_.end ()
908 && !specifications_[i].has_manual_position_)
910 Tie_configuration_variation var;
912 var.suggestion_ = get_configuration (ties[i].position_ + ties[i].dir_,
914 vars.push_back (var);
919 last_center = center;
927 Tie_formatting_problem::set_manual_tie_configuration (SCM manual_configs)
930 for (SCM s = manual_configs;
931 scm_is_pair (s) && k < specifications_.size (); s = scm_cdr (s))
933 SCM entry = scm_car (s);
934 if (scm_is_pair (entry))
936 Tie_specification &spec = specifications_[k];
938 if (scm_is_number (scm_car (entry)))
940 spec.has_manual_position_ = true;
941 spec.manual_position_ = scm_to_double (scm_car (entry));
943 if (scm_is_number (scm_cdr (entry)))
945 spec.has_manual_dir_ = true;
946 spec.manual_dir_ = Direction (scm_to_int (scm_cdr (entry)));