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"
16 #include "note-head.hh"
17 #include "rhythmic-head.hh"
19 #include "staff-symbol-referencer.hh"
21 #include "tie-configuration.hh"
26 0 at threshold, 1 at 0, with 1/x falloff.
28 Real peak_around (Real epsilon, Real threshold, Real x)
32 return max (- epsilon * (x - threshold) / ((x + epsilon) * threshold), 0.0);
36 Tie_formatting_problem::print_ties_configuration (Ties_configuration const *ties)
38 for (vsize i = 0; i < ties->size (); i++)
40 char const *man_pos = (specifications_[i].has_manual_position_) ? "(M)" : "";
41 char const *man_dir = (specifications_[i].has_manual_dir_) ? "(M)" : "";
42 char const *dir = (ties->at (i).dir_ == UP) ? "up" : "dn";
44 printf ("(P%d%s, %s%s) ", ties->at (i).position_, man_pos, dir, man_dir);
50 Tie_formatting_problem::get_attachment (Real y) const
56 attachments[d] = skyline_height (chord_outlines_[d], y, -d);
58 while (flip (&d) != LEFT);
63 Tie_formatting_problem::Tie_formatting_problem()
68 Tie_formatting_problem::~Tie_formatting_problem ()
70 for (Tie_configuration_map::const_iterator i (possibilities_.begin ());
71 i != possibilities_.end (); i++)
76 Tie_formatting_problem::set_chord_outline (vector<Item*> bounds,
79 Real staff_space = Staff_symbol_referencer::staff_space (bounds[0]);
82 vector<Box> head_boxes;
85 for (vsize i = 0; i < bounds.size (); i++)
87 Grob *head = bounds[i];
88 if (!Note_head::has_interface (head))
92 stem = unsmob_grob (head->get_object ("stem"));
94 Real p = Staff_symbol_referencer::get_position (head);
95 Interval y ((p-1) * 0.5 * staff_space,
96 (p+1) * 0.5 * staff_space);
98 Interval x = head->extent (x_refpoint_, X_AXIS);
99 head_boxes.push_back (Box (x, y));
100 boxes.push_back (Box (x, y));
102 Grob *dots = Rhythmic_head::get_dots (head);
103 if (dir == LEFT && dots)
105 Interval x = dots->extent (x_refpoint_, X_AXIS);
106 int p = int (Staff_symbol_referencer::get_position (dots));
108 dot_positions_.insert (p);
111 Interval y (dots->extent (dots, Y_AXIS));
112 y.translate (p * staff_space * 0.5);
114 boxes.push_back (Box (x, y));
118 chord_outlines_[dir] = empty_skyline (-dir);
119 if (bounds[0]->break_status_dir ())
121 Real x = robust_relative_extent (bounds[0], x_refpoint_, X_AXIS)[-dir];
122 chord_outlines_[dir].at (0).height_ = x;
125 for (vsize i = 0; i < boxes.size (); i++)
126 insert_extent_into_skyline (&chord_outlines_[dir] ,
127 boxes[i], Y_AXIS, -dir);
130 && !Stem::is_invisible (stem))
133 x.add_point (stem->relative_coordinate (x_refpoint_, X_AXIS));
134 x.widen (staff_space / 20); // ugh.
136 y.add_point (Stem::stem_end_position (stem) * staff_space * .5);
138 Direction stemdir = get_grob_direction (stem);
139 y.add_point (Stem::head_positions (stem)[-stemdir]
142 insert_extent_into_skyline (&chord_outlines_[dir], Box (x,y), Y_AXIS, -dir);
144 stem_extents_[dir].unite (Box (x,y));
148 Box flag_box = Stem::get_translated_flag (stem).extent_box ();
149 flag_box.translate( Offset (x[RIGHT], X_AXIS));
150 insert_extent_into_skyline (&chord_outlines_[dir], flag_box,
155 Direction updowndir = DOWN;
160 if (head_boxes.size())
162 Box b = boundary (head_boxes, updowndir, 0);
164 x[-dir] = b[X_AXIS].linear_combination (-dir / 2);
165 y[-updowndir] = b[Y_AXIS][updowndir];
166 y[updowndir] = updowndir * infinity_f;
170 insert_extent_into_skyline (&chord_outlines_[dir],
174 while (flip (&updowndir) != DOWN);
176 head_extents_[dir].set_empty ();
177 for (vsize i = 0; i < head_boxes.size (); i++)
179 head_extents_[dir].unite (head_boxes[i]);
185 Tie_formatting_problem::from_tie (Grob *tie)
188 ties.push_back (tie);
191 details_.from_grob (tie);
195 Tie_formatting_problem::common_x_refpoint () const
201 Tie_formatting_problem::from_ties (vector<Grob*> const &ties)
206 x_refpoint_ = ties[0];
207 for (vsize i = 0; i < ties.size (); i++)
209 x_refpoint_ = dynamic_cast<Spanner*> (ties[i])->get_bound (LEFT)->common_refpoint (x_refpoint_, X_AXIS);
210 x_refpoint_ = dynamic_cast<Spanner*> (ties[i])->get_bound (RIGHT)->common_refpoint (x_refpoint_, X_AXIS);
213 details_.from_grob (ties[0]);
218 vector<Item*> bounds;
220 for (vsize i = 0; i < ties.size (); i++)
222 Item *it = dynamic_cast<Spanner*> (ties[i])->get_bound (d);
224 bounds.push_back (it);
227 set_chord_outline (bounds, d);
229 while (flip (&d) != LEFT);
232 for (vsize i = 0; i < ties.size (); i++)
234 Tie_specification spec;
236 if (scm_is_number (ties[i]->get_property_data (ly_symbol2scm ("direction"))))
238 spec.manual_dir_ = to_dir (ties[i]->get_property ("direction"));
239 spec.has_manual_dir_ = true;
242 spec.position_ = Tie::get_position (ties[i]);
246 spec.note_head_drul_[d] = Tie::head (ties[i], d);
248 while (flip (&d) != LEFT);
250 specifications_.push_back (spec);
255 Tie_formatting_problem::from_semi_ties (vector<Grob*> const &lv_ties, Direction head_dir)
257 if (lv_ties.empty ())
260 details_.from_grob (lv_ties[0]);
263 for (vsize i = 0; i < lv_ties.size (); i++)
265 Tie_specification spec;
266 Item *head = unsmob_item (lv_ties[i]->get_object ("note-head"));
269 programming_error ("LV tie without head?!");
273 spec.position_ = int (Staff_symbol_referencer::get_position (head));
276 spec.note_head_drul_[head_dir] = head;
277 heads.push_back (head);
278 specifications_.push_back (spec);
281 x_refpoint_ = lv_ties [0];
282 for (vsize i = 0; i < lv_ties.size (); i++)
283 x_refpoint_ = lv_ties[i]->common_refpoint (x_refpoint_, X_AXIS);
284 for (vsize i = 0; i < heads.size (); i++)
285 x_refpoint_ = heads[i]->common_refpoint (x_refpoint_, X_AXIS);
287 set_chord_outline (heads, head_dir);
289 Real extremal = head_dir * infinity_f;
291 for (vsize i = 0; i < chord_outlines_[head_dir].size (); i++)
293 extremal = head_dir * min (head_dir * extremal,
294 head_dir * chord_outlines_[head_dir][i].height_);
297 Skyline_entry right_entry;
298 right_entry.width_.set_full ();
299 right_entry.height_ = extremal - head_dir * 1.5;
301 chord_outlines_[-head_dir].push_back (right_entry);
306 Tie_formatting_problem::get_tie_specification (int i) const
308 return specifications_[i];
313 Tie_formatting_problem::get_configuration (int pos, Direction dir) const
315 pair<int,int> key (pos, dir);
316 Tie_configuration_map::const_iterator f = possibilities_.find (key);
318 if (f != possibilities_.end ())
324 Tie_configuration *conf = generate_configuration (pos, dir);
325 ((Tie_formatting_problem*) this)->possibilities_[key] = conf;
330 Tie_formatting_problem::generate_configuration (int pos, Direction dir) const
332 Tie_configuration *conf = new Tie_configuration;
333 conf->position_ = pos;
335 Real y = conf->position_ * 0.5 * details_.staff_space_;
339 if (dot_positions_.find (pos) != dot_positions_.end ())
341 conf->delta_y_ += 0.25 * details_.staff_space_;
348 && max (fabs (head_extents_[LEFT][Y_AXIS][dir] - y),
349 fabs (head_extents_[RIGHT][Y_AXIS][dir] - y)) < 0.25
350 && !Staff_symbol_referencer::on_line (details_.staff_symbol_referencer_, pos))
353 (head_extents_[LEFT][Y_AXIS][dir] - y)
354 + dir * details_.outer_tie_vertical_gap_;
359 conf->attachment_x_ = get_attachment (y + conf->delta_y_);
360 Real h = conf->height (details_);
365 - should make sliding criterion, should flatten ties if
367 - they're just the wrong (ie. touching line at top & bottom)
371 if (h < details_.intra_space_threshold_ * 0.5 * details_.staff_space_)
373 if (!Staff_symbol_referencer::on_line (details_.staff_symbol_referencer_, pos)
374 && abs (pos) < 2 * Staff_symbol_referencer::staff_radius (details_.staff_symbol_referencer_))
376 conf->center_tie_vertically (details_);
378 else if (Staff_symbol_referencer::on_line (details_.staff_symbol_referencer_, pos))
380 conf->delta_y_ += dir *
381 details_.tip_staff_line_clearance_ * 0.5 * details_.staff_space_;
386 Real top_y = y + conf->delta_y_ + conf->dir_ * h;
387 Real top_pos = top_y / (0.5*details_.staff_space_);
388 int round_pos = int (my_round (top_pos));
390 /* TODO: should use other variable? */
391 Real clearance = details_.center_staff_line_clearance_;
392 if (fabs (top_pos - round_pos) < clearance
393 && Staff_symbol_referencer::on_staff_line (details_.staff_symbol_referencer_,
396 Real new_y = (round_pos + clearance * conf->dir_) * 0.5 * details_.staff_space_;
397 conf->delta_y_ = (new_y - top_y);
402 conf->attachment_x_ = get_attachment (y + conf->delta_y_);
403 if (conf->height (details_) < details_.intra_space_threshold_ * 0.5 * details_.staff_space_)
406 This is less sensible for long ties, since those are more
409 Interval close_by = get_attachment (y
411 + (dir * details_.intra_space_threshold_ * 0.25
412 * details_.staff_space_));
414 conf->attachment_x_.intersect (close_by);
417 conf->attachment_x_.widen ( - details_.x_gap_);
422 Real y = conf->position_ * details_.staff_space_ * 0.5 + conf->delta_y_;
423 if (stem_extents_[d][X_AXIS].is_empty ()
424 || !stem_extents_[d][Y_AXIS].contains (y))
427 conf->attachment_x_[d] =
428 d* min (d * conf->attachment_x_[d],
429 d * (stem_extents_[d][X_AXIS][-d] - d * details_.stem_gap_));
431 while (flip (&d) != LEFT);
436 TIE_IDX and TIES_CONF are optional.
439 Tie_formatting_problem::score_aptitude (Tie_configuration *conf,
440 Tie_specification const &spec,
441 Ties_configuration *ties_conf, int tie_idx) const
444 Real curve_y = conf->position_ * details_.staff_space_ * 0.5 + conf->delta_y_;
445 Real tie_y = spec.position_ * details_.staff_space_ * 0.5;
446 if (sign (curve_y - tie_y) != conf->dir_)
448 Real p = details_.wrong_direction_offset_penalty_;
450 ties_conf->add_tie_score (p, tie_idx, "wrong dir");
456 Real p = details_.vertical_distance_penalty_factor_ * fabs (curve_y - tie_y);
458 ties_conf->add_tie_score (p, tie_idx, "vdist");
466 if (!spec.note_head_drul_[d])
469 Interval head_x = spec.note_head_drul_[d]->extent (x_refpoint_, X_AXIS);
470 Real dist = head_x.distance (conf->attachment_x_[d]);
473 TODO: flatten with log or sqrt.
475 Real p = details_.horizontal_distance_penalty_factor_ * dist;
477 ties_conf->add_tie_score (p, tie_idx,
478 (d == LEFT) ? "lhdist" : "rhdist");
482 while (flip (&d) != LEFT);
488 Tie_formatting_problem::score_configuration (Tie_configuration *conf) const
495 Real length = conf->attachment_x_.length ();
497 conf->add_score (details_.min_length_penalty_factor_
498 * peak_around (0.33 * details_.min_length_, details_.min_length_, length),
501 Real tip_pos = conf->position_ + conf->delta_y_ / 0.5 * details_.staff_space_;
502 Real tip_y = tip_pos * details_.staff_space_ * 0.5;
503 Real height = conf->height (details_);
505 Real top_y = tip_y + conf->dir_ * height;
506 Real top_pos = 2 * top_y / details_.staff_space_;
507 Real round_top_pos = rint (top_pos);
508 if (Staff_symbol_referencer::on_line (details_.staff_symbol_referencer_,
510 && Staff_symbol_referencer::staff_radius (details_.staff_symbol_referencer_) > top_y)
513 details_.staff_line_collision_penalty_
514 * peak_around (0.1 * details_.center_staff_line_clearance_,
515 details_.center_staff_line_clearance_,
516 fabs (top_pos - round_top_pos)),
520 if (Staff_symbol_referencer::on_line (details_.staff_symbol_referencer_,
521 int (rint (tip_pos))))
523 conf->add_score (details_.staff_line_collision_penalty_
524 * peak_around (0.1 * details_.tip_staff_line_clearance_,
525 details_.tip_staff_line_clearance_,
526 fabs (tip_pos - rint (tip_pos))),
530 if (!dot_x_.is_empty ())
533 Real x = dot_x_.center ();
535 Bezier b = conf->get_transformed_bezier (details_);
536 if (b.control_point_extent (X_AXIS).contains (x))
538 Real y = b.get_other_coordinate (X_AXIS, x);
540 for (set<int>::const_iterator i (dot_positions_.begin ());
541 i != dot_positions_.end (); i ++)
544 conf->add_score (details_.dot_collision_penalty_
545 * peak_around (.1 * details_.dot_collision_clearance_,
546 details_.dot_collision_clearance_,
547 fabs (dot_pos * details_.staff_space_ * 0.5 - y)),
553 conf->scored_ = true;
557 Tie_formatting_problem::find_optimal_tie_configuration (Tie_specification const &spec) const
559 vector<Tie_configuration*> confs;
561 int pos = spec.position_;
562 Direction dir = spec.manual_dir_;
564 for (int i = 0; i < details_.single_tie_region_size_; i ++)
566 confs.push_back (generate_configuration (pos + i * dir, dir));
572 Real best_score = 1e6;
573 for (vsize i = 0; i < confs.size (); i ++)
575 score_configuration (confs[i]);
576 Real score = score_aptitude (confs[i], spec, 0, 0)
577 + confs[i]->score ();
579 if (score < best_score)
586 Tie_configuration best = *confs[best_idx];
587 for (vsize i = 0; i < confs.size (); i++)
593 Tie_specification::Tie_specification ()
595 has_manual_position_ = false;
596 has_manual_dir_ = false;
598 manual_position_ = 0;
599 manual_dir_ = CENTER;
600 note_head_drul_[LEFT] =
601 note_head_drul_[RIGHT] = 0;
606 Tie_formatting_problem::score_ties_aptitude (Ties_configuration *ties) const
608 if (ties->size () != specifications_.size ())
610 programming_error ("Huh? Mismatch between sizes.");
614 for (vsize i = 0; i < ties->size (); i++)
615 score_aptitude (&ties->at (i), specifications_[i],
620 Tie_formatting_problem::score_ties (Ties_configuration *ties) const
625 score_ties_configuration (ties);
626 score_ties_aptitude (ties);
627 ties->scored_ = true;
631 Tie_formatting_problem::score_ties_configuration (Ties_configuration *ties) const
633 for (vsize i = 0; i < ties->size (); i++)
635 score_configuration (&ties->at (i));
636 ties->add_tie_score (ties->at (i).score (), i, "conf");
639 Real last_edge = 0.0;
640 Real last_center = 0.0;
641 for (vsize i = 0; i < ties->size (); i++)
643 Bezier b (ties->at (i).get_transformed_bezier (details_));
645 Real center = b.curve_point (0.5)[Y_AXIS];
646 Real edge = b.curve_point (0.0)[Y_AXIS];
650 if (edge <= last_edge)
651 ties->add_score (details_.tie_column_monotonicity_penalty_, "monoton edge");
652 if (center <= last_center)
653 ties->add_score (details_.tie_column_monotonicity_penalty_, "monoton cent");
655 ties->add_score (details_.tie_tie_collision_penalty_ *
656 peak_around (0.1 * details_.tie_tie_collision_distance_,
657 details_.tie_tie_collision_distance_,
658 fabs (center - last_center)),
660 ties->add_score (details_.tie_tie_collision_penalty_ *
661 peak_around (0.1 * details_.tie_tie_collision_distance_,
662 details_.tie_tie_collision_distance_,
663 fabs (edge - last_edge)), "tietie edge");
667 last_center = center;
670 ties->add_score (details_.outer_tie_length_symmetry_penalty_factor_
671 * fabs (ties->at (0).attachment_x_.length () - ties->back ().attachment_x_.length ()),
674 ties->add_score (details_.outer_tie_vertical_distance_symmetry_penalty_factor_
675 * fabs (fabs (specifications_[0].position_ * 0.5 * details_.staff_space_
676 - (ties->at (0).position_ * 0.5 * details_.staff_space_
677 + ties->at (0).delta_y_))
679 fabs (specifications_.back ().position_ * 0.5 * details_.staff_space_
680 - (ties->back ().position_ * 0.5 * details_.staff_space_
681 + ties->back ().delta_y_))),
686 Generate with correct X-attachments and beziers, copying delta_y_
687 from TIES_CONFIG if necessary.
690 Tie_formatting_problem::generate_ties_configuration (Ties_configuration const &ties_config)
692 Ties_configuration copy;
693 for (vsize i = 0; i < ties_config.size (); i++)
695 Tie_configuration * ptr = get_configuration (ties_config[i].position_, ties_config[i].dir_);
696 if (specifications_[i].has_manual_position_)
699 = (specifications_[i].manual_position_ - ties_config[i].position_)
700 * 0.5 * details_.staff_space_;
702 copy.push_back (*ptr);
709 Tie_formatting_problem::generate_base_chord_configuration ()
711 Ties_configuration ties_config;
712 for (vsize i = 0; i < specifications_.size (); i ++)
714 Tie_configuration conf;
715 if (specifications_[i].has_manual_dir_)
716 conf.dir_ = specifications_[i].manual_dir_;
717 if (specifications_[i].has_manual_position_)
719 conf.position_ = (int) my_round (specifications_[i].manual_position_);
720 conf.delta_y_ = (specifications_[i].manual_position_ - conf.position_)
721 * 0.5 * details_.staff_space_;
725 conf.position_ = specifications_[i].position_;
727 ties_config.push_back (conf);
730 set_ties_config_standard_directions (&ties_config);
731 for (vsize i = 0; i < ties_config.size (); i++)
732 if (!specifications_[i].manual_position_)
733 ties_config[i].position_ += ties_config[i].dir_;
735 ties_config = generate_ties_configuration (ties_config);
741 Tie_formatting_problem::find_best_variation (Ties_configuration const &base,
742 vector<Tie_configuration_variation> vars)
744 Ties_configuration best = base;
747 This simply is 1-opt: we have K substitions, and we try applying
748 exactly every one for each.
750 for (vsize i = 0; i < vars.size (); i++)
752 Ties_configuration variant (base);
753 variant[vars[i].index_] = *vars[i].suggestion_;
755 variant.reset_score ();
756 score_ties (&variant);
758 if (variant.score () < best.score ())
770 Tie_formatting_problem::generate_optimal_chord_configuration ()
773 Ties_configuration base = generate_base_chord_configuration ();
774 vector<Tie_configuration_variation> vars = generate_collision_variations (base);
777 Ties_configuration best = find_best_variation (base, vars);
778 vars = generate_extremal_tie_variations (best);
779 best = find_best_variation (best, vars);
785 Tie_formatting_problem::set_ties_config_standard_directions (Ties_configuration *tie_configs)
787 if (tie_configs->empty ())
790 if (!tie_configs->at (0).dir_)
791 tie_configs->at (0).dir_ = DOWN;
792 if (!tie_configs->back ().dir_)
793 tie_configs->back ().dir_ = UP;
798 for (vsize i = 1; i < tie_configs->size (); i++)
800 Real diff = (tie_configs->at (i-1).position_
801 - tie_configs->at (i).position_);
803 if (fabs (diff) <= 1)
805 if (!tie_configs->at (i-1).dir_)
806 tie_configs->at (i-1).dir_ = DOWN;
807 if (!tie_configs->at (i).dir_)
808 tie_configs->at (i).dir_ = UP;
812 for (vsize i = 1; i < tie_configs->size() - 1; i++)
814 Tie_configuration &conf = tie_configs->at (i);
818 Direction position_dir =
819 Direction (sign (conf.position_));
823 conf.dir_ = position_dir;
827 Tie_configuration_variation::Tie_configuration_variation ()
833 vector<Tie_configuration_variation>
834 Tie_formatting_problem::generate_extremal_tie_variations (Ties_configuration const &ties) const
836 vector<Tie_configuration_variation> vars;
840 if (boundary (ties, d, 0).dir_ == d
841 && !boundary (specifications_, d, 0).has_manual_position_)
842 for (int i = 1; i <= details_.multi_tie_region_size_; i++)
844 Tie_configuration_variation var;
845 var.index_ = (d == DOWN) ? 0 : ties.size () - 1;
846 var.suggestion_ = get_configuration (boundary (ties, d, 0).position_
848 vars.push_back (var);
851 while (flip (&d) != DOWN);
857 vector<Tie_configuration_variation>
858 Tie_formatting_problem::generate_collision_variations (Ties_configuration const &ties) const
860 Real center_distance_tolerance = 0.25;
862 vector<Tie_configuration_variation> vars;
863 Real last_center = 0.0;
864 for (vsize i = 0; i < ties.size (); i++)
866 Bezier b (ties[i].get_transformed_bezier (details_));
868 Real center = b.curve_point (0.5)[Y_AXIS];
872 if (center <= last_center + center_distance_tolerance)
874 if (!specifications_[i].has_manual_dir_)
876 Tie_configuration_variation var;
878 var.suggestion_ = get_configuration (specifications_[i].position_
882 vars.push_back (var);
885 if (!specifications_[i-1].has_manual_dir_)
887 Tie_configuration_variation var;
889 var.suggestion_ = get_configuration (specifications_[i-1].position_
893 vars.push_back (var);
896 if (i == 1 && !specifications_[i-1].has_manual_position_
897 && ties[i-1].dir_ == DOWN)
899 Tie_configuration_variation var;
901 var.suggestion_ = get_configuration (specifications_[i-1].position_
903 vars.push_back (var);
905 if (i == ties.size() && !specifications_[i].has_manual_position_
906 && ties[i].dir_ == UP)
908 Tie_configuration_variation var;
910 var.suggestion_ = get_configuration (specifications_[i].position_
912 vars.push_back (var);
915 else if (dot_positions_.find (ties[i].position_) != dot_positions_.end ()
916 && !specifications_[i].has_manual_position_)
918 Tie_configuration_variation var;
920 var.suggestion_ = get_configuration (ties[i].position_ + ties[i].dir_,
922 vars.push_back (var);
927 last_center = center;
935 Tie_formatting_problem::set_manual_tie_configuration (SCM manual_configs)
938 for (SCM s = manual_configs;
939 scm_is_pair (s) && k < specifications_.size (); s = scm_cdr (s))
941 SCM entry = scm_car (s);
942 if (scm_is_pair (entry))
944 Tie_specification &spec = specifications_[k];
946 if (scm_is_number (scm_car (entry)))
948 spec.has_manual_position_ = true;
949 spec.manual_position_ = scm_to_double (scm_car (entry));
951 if (scm_is_number (scm_cdr (entry)))
953 spec.has_manual_dir_ = true;
954 spec.manual_dir_ = Direction (scm_to_int (scm_cdr (entry)));