2 tie-formatting-problem.cc -- implement Tie_formatting_problem6
4 source file of the GNU LilyPond music typesetter
6 (c) 2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
10 #include "tie-formatting-problem.hh"
12 #include "tie-configuration.hh"
13 #include "directional-element-interface.hh"
14 #include "staff-symbol-referencer.hh"
20 #include "note-head.hh"
21 #include "rhythmic-head.hh"
25 Tie_formatting_problem::get_attachment (Real y) const
31 attachments[d] = skyline_height (chord_outlines_[d], y, -d);
33 while (flip (&d) != LEFT);
38 Tie_formatting_problem::Tie_formatting_problem()
43 Tie_formatting_problem::~Tie_formatting_problem ()
45 for (Tie_configuration_map::const_iterator i (possibilities_.begin ());
46 i != possibilities_.end (); i++)
51 Tie_formatting_problem::set_chord_outline (Link_array<Item> bounds,
54 Real staff_space = Staff_symbol_referencer::staff_space (bounds[0]);
59 for (int i = 0; i < bounds.size (); i++)
61 Grob *head = bounds[i];
62 if (!Note_head::has_interface (head))
66 stem = unsmob_grob (head->get_object ("stem"));
68 Real p = Staff_symbol_referencer::get_position (head);
69 Interval y ((p-1) * 0.5 * staff_space,
70 (p+1) * 0.5 * staff_space);
72 Interval x = head->extent (x_refpoint_, X_AXIS);
73 boxes.push (Box (x, y));
75 Grob *dots = Rhythmic_head::get_dots (head);
76 if (d == LEFT && dots)
78 Interval x = dots->extent (x_refpoint_, X_AXIS);
79 Interval y (-0.5, 0.5);
80 int p = int (Staff_symbol_referencer::get_position (dots));
83 dot_positions_.insert (p);
86 y *= staff_space * 0.5;
87 // boxes.push (Box (x, y));
91 chord_outlines_[d] = empty_skyline (-d);
93 if (bounds[0]->break_status_dir ())
95 Real x = robust_relative_extent (bounds[0], x_refpoint_, X_AXIS)[-d];
96 chord_outlines_[d].elem_ref (0).height_ = x;
99 for (int i = 0; i < boxes.size (); i++)
100 insert_extent_into_skyline (&chord_outlines_[d] ,
101 boxes[i], Y_AXIS, -d);
104 && !Stem::is_invisible (stem))
107 x.add_point (stem->relative_coordinate (x_refpoint_, X_AXIS));
108 x.widen (staff_space / 20); // ugh.
110 y.add_point (Stem::stem_end_position (stem) * staff_space * .5);
112 Direction stemdir = get_grob_direction (stem);
113 y.add_point (Stem::head_positions (stem)[-stemdir]
116 insert_extent_into_skyline (&chord_outlines_[d], Box (x,y), Y_AXIS, -d);
122 Box flag_box = Stem::get_translated_flag (stem).extent_box ();
123 flag_box.translate( Offset (x[RIGHT], X_AXIS));
124 insert_extent_into_skyline (&chord_outlines_[d], flag_box,
129 Direction updowndir = DOWN;
136 Box b = boxes.boundary (updowndir, 0);
138 x[-d] = b[X_AXIS].linear_combination (-d / 2);
139 y[-updowndir] = b[Y_AXIS][updowndir];
140 y[updowndir] = updowndir * infinity_f;
144 insert_extent_into_skyline (&chord_outlines_[d],
148 while (flip (&updowndir) != DOWN);
153 Tie_formatting_problem::from_tie (Grob *tie)
155 Link_array<Grob> ties;
160 details_.from_grob (tie);
164 Tie_formatting_problem::common_x_refpoint () const
170 Tie_formatting_problem::from_ties (Link_array<Grob> const &ties)
172 if (ties.is_empty ())
175 x_refpoint_ = ties[0];
176 for (int i = 0; i < ties.size (); i++)
178 x_refpoint_ = dynamic_cast<Spanner*> (ties[i])->get_bound (LEFT)->common_refpoint (x_refpoint_, X_AXIS);
179 x_refpoint_ = dynamic_cast<Spanner*> (ties[i])->get_bound (RIGHT)->common_refpoint (x_refpoint_, X_AXIS);
182 details_.from_grob (ties[0]);
187 Link_array<Item> bounds;
189 for (int i = 0; i < ties.size (); i++)
191 Item *it = dynamic_cast<Spanner*> (ties[i])->get_bound (d);
196 set_chord_outline (bounds, d);
198 while (flip (&d) != LEFT);
201 for (int i = 0; i < ties.size (); i++)
203 Tie_specification spec;
205 if (scm_is_number (ties[i]->get_property_data (ly_symbol2scm ("direction"))))
207 spec.manual_dir_ = to_dir (ties[i]->get_property ("direction"));
208 spec.has_manual_dir_ = true;
211 spec.position_ = Tie::get_position (ties[i]);
213 specifications_.push (spec);
218 Tie_formatting_problem::from_lv_ties (Link_array<Grob> const &lv_ties)
220 if (lv_ties.is_empty ())
223 details_.from_grob (lv_ties[0]);
224 Link_array<Item> heads;
226 for (int i = 0; i < lv_ties.size (); i++)
228 Tie_specification spec;
229 Item *head = unsmob_item (lv_ties[i]->get_object ("note-head"));
232 programming_error ("LV tie without head?!");
236 spec.position_ = int (Staff_symbol_referencer::get_position (head));
242 x_refpoint_ = lv_ties [0];
243 for (int i = 0; i < lv_ties.size (); i++)
245 x_refpoint_ = lv_ties[i]->common_refpoint (x_refpoint_, X_AXIS);
248 set_chord_outline (heads, LEFT);
250 Real right_most = - infinity_f;
252 for (int i = 0; i < chord_outlines_[LEFT].size (); i++)
254 right_most = max (right_most, chord_outlines_[LEFT][i].height_);
257 Skyline_entry right_entry;
258 right_entry.width_.set_full ();
259 right_entry.height_ = right_most + 1.5;
261 chord_outlines_[RIGHT].push (right_entry);
265 Tie_formatting_problem::get_configuration (int pos, Direction dir)
267 pair<int,int> key (pos, dir);
268 Tie_configuration_map::const_iterator f = possibilities_.find (key);
270 if (f != possibilities_.end ())
276 Tie_configuration *conf = generate_configuration (pos,dir);
277 possibilities_[key] = conf;
282 Tie_formatting_problem::generate_configuration (int pos, Direction dir) const
284 Tie_configuration *conf = new Tie_configuration;
285 conf->position_ = pos;
287 Real y = conf->position_ * 0.5 * details_.staff_space_;
289 if (dot_positions_.find (pos) != dot_positions_.end ())
291 conf->delta_y_ += 0.25 * details_.staff_space_;
294 conf->attachment_x_ = get_attachment (y + conf->delta_y_);
296 Real h = conf->height (details_);
299 if (h < 0.5 * details_.staff_space_
300 && !Staff_symbol_referencer::on_staffline (details_.staff_symbol_referencer_, pos))
302 conf->center_tie_vertically (details_);
304 else if (h < 0.5 * details_.staff_space_
305 && Staff_symbol_referencer::on_staffline (details_.staff_symbol_referencer_, pos))
307 conf->delta_y_ += dir * 0.2 * details_.staff_space_;
311 conf->attachment_x_.widen ( - details_.x_gap_);
316 Tie_formatting_problem::score_aptitude (Tie_configuration const &conf,
317 int tie_position) const
319 Real wrong_direction_offset_penalty_;
320 Real distance_penalty_factor_;
322 wrong_direction_offset_penalty_ = 10;
323 distance_penalty_factor_ = 5;
326 Real curve_y = conf.position_ * details_.staff_space_ * 0.5 + conf.delta_y_;
327 Real tie_y = tie_position * details_.staff_space_ * 0.5;
328 if (sign (curve_y - tie_y) != conf.dir_)
329 penalty += wrong_direction_offset_penalty_;
331 penalty += distance_penalty_factor_ * fabs (curve_y - tie_y);
337 Tie_formatting_problem::score_configuration (Tie_configuration const &conf) const
339 Real length_penalty_factor = 1.0;
340 Real min_length = 0.333;
341 Real staff_line_clearance = 0.1;
342 Real staff_line_collision_penalty = 5;
343 Real dot_collision_clearance = 0.25;
344 Real dot_collision_penalty = 10;
348 Real length = conf.attachment_x_.length ();
349 if (length < min_length)
350 penalty += length_penalty_factor / max (0.01, length);
352 Real tip_pos = conf.position_ + conf.delta_y_ / 0.5 * details_.staff_space_;
353 Real tip_y = tip_pos * details_.staff_space_ * 0.5;
354 Real height = conf.height (details_);
356 Real top_y = tip_y + conf.dir_ * height;
357 Real top_pos = 2 * top_y / details_.staff_space_;
358 Real round_top_pos = rint (top_pos);
359 if (fabs (top_pos - round_top_pos) < staff_line_clearance
360 && Staff_symbol_referencer::on_staffline (details_.staff_symbol_referencer_,
362 && Staff_symbol_referencer::staff_radius (details_.staff_symbol_referencer_) > top_y)
364 penalty += staff_line_collision_penalty;
367 if (fabs (tip_pos - rint (tip_pos)) < staff_line_clearance
368 && Staff_symbol_referencer::on_staffline (details_.staff_symbol_referencer_,
369 int (rint (tip_pos))))
371 penalty += staff_line_collision_penalty;
374 if (!dot_x_.is_empty ())
377 Real x = dot_x_.center ();
379 Bezier b = conf.get_transformed_bezier (details_);
380 if (b.control_point_extent (X_AXIS).contains (x))
382 Real y = b.get_other_coordinate (X_AXIS, x);
384 for (set<int>::const_iterator i (dot_positions_.begin ());
385 i != dot_positions_.end (); i ++)
388 if (fabs (dot_pos * details_.staff_space_ * 0.5 - y) < dot_collision_clearance)
390 penalty += dot_collision_penalty;
400 Tie_formatting_problem::find_optimal_tie_configuration (int pos, Direction dir) const
402 Link_array<Tie_configuration> confs;
405 for (int i = 0; i < region_size; i ++)
407 confs.push (generate_configuration (pos + i * dir, dir));
413 Real best_score = 1e6;
414 for (int i = 0; i < confs.size (); i ++)
417 score += score_configuration (*confs[i]);
418 score += score_aptitude (*confs[i], pos);
420 if (score < best_score)
427 Tie_configuration best = *confs[best_idx];
428 for (int i = 0; i < confs.size (); i++)
434 Tie_specification::Tie_specification ()
436 has_manual_position_ = false;
437 has_manual_dir_ = false;
439 manual_position_ = 0;
440 manual_dir_ = CENTER;
445 Tie_formatting_problem::score_ties_aptitude (Ties_configuration const &ties) const
448 if (ties.size () != specifications_.size ())
450 programming_error ("Huh? Mismatch between sizes.");
454 for (int i = 0; i < ties.size (); i++)
455 score += score_aptitude (ties[i], specifications_[i].position_);
461 Tie_formatting_problem::score_ties (Ties_configuration const &ties) const
463 return score_ties_configuration (ties)
464 + score_ties_aptitude (ties);
468 Tie_formatting_problem::score_ties_configuration (Ties_configuration const &ties) const
470 const Real tie_monotonicity_penalty = 100;
471 const Real tie_collision_penalty = 30;
472 const Real tie_collision_distance = 0.25;
475 for (int i = 0; i < ties.size (); i++)
477 score += score_configuration (ties[i]);
481 Real last_edge = 0.0;
482 Real last_center = 0.0;
483 for (int i = 0; i < ties.size (); i++)
485 Bezier b (ties[i].get_transformed_bezier (details_));
487 Real center = b.curve_point (0.5)[Y_AXIS];
488 Real edge = b.curve_point (0.0)[Y_AXIS];
492 if (edge <= last_edge)
493 score += tie_monotonicity_penalty;
494 if (center <= last_center)
495 score += tie_monotonicity_penalty;
498 tie_collision_penalty
499 * max (tie_collision_distance - fabs (center - last_center), 0.0) / tie_collision_distance;
501 tie_collision_penalty
502 * max (tie_collision_distance - fabs (edge - last_edge), 0.0) / tie_collision_distance;
506 last_center = center;
513 Generate with correct X-attachments and beziers, copying delta_y_
514 from TIES_CONFIG if necessary.
517 Tie_formatting_problem::generate_ties_configuration (Ties_configuration const &ties_config)
519 Ties_configuration copy;
520 for (int i = 0; i < ties_config.size (); i++)
522 Tie_configuration * ptr = get_configuration (ties_config[i].position_, ties_config[i].dir_);
523 if (specifications_[i].has_manual_position_)
526 = (specifications_[i].manual_position_ - ties_config[i].position_)
527 * 0.5 * details_.staff_space_;
536 Tie_formatting_problem::generate_base_chord_configuration ()
538 Ties_configuration ties_config;
539 for (int i = 0; i < specifications_.size (); i ++)
541 Tie_configuration conf;
542 if (specifications_[i].has_manual_dir_)
543 conf.dir_ = specifications_[i].manual_dir_;
544 if (specifications_[i].has_manual_position_)
546 conf.position_ = (int) round (specifications_[i].manual_position_);
547 conf.delta_y_ = (specifications_[i].manual_position_ - conf.position_)
548 * 0.5 * details_.staff_space_;
551 conf.position_ = specifications_[i].position_;
553 ties_config.push (conf);
556 set_ties_config_standard_directions (&ties_config);
558 ties_config = generate_ties_configuration (ties_config);
564 Tie_formatting_problem::generate_optimal_chord_configuration ()
566 Ties_configuration base = generate_base_chord_configuration ();
567 Array<Tie_configuration_variation> vars = get_variations (base);
569 Ties_configuration best = base;
570 Real best_score = score_ties_configuration (best);
573 This simply is 1-opt: we have K substitions, and we try applying
574 exactly every one for each.
576 for (int i = 0; i < vars.size (); i++)
578 Ties_configuration variant = base;
579 variant[vars[i].index_] = *vars[i].suggestion_;
581 Real score = (score_ties_configuration (variant)
582 + score_ties_aptitude (variant));
583 if (score < best_score)
594 Tie_formatting_problem::set_ties_config_standard_directions (Ties_configuration *tie_configs)
596 if (!tie_configs->elem (0).dir_)
597 tie_configs->elem_ref (0).dir_ = DOWN;
598 if (!tie_configs->top().dir_)
599 tie_configs->top().dir_ = UP;
604 for (int i = 1; i < tie_configs->size (); i++)
606 Real diff = (tie_configs->elem (i-1).position_
607 - tie_configs->elem (i).position_);
609 if (fabs (diff) <= 1)
611 if (!tie_configs->elem (i-1).dir_)
612 tie_configs->elem_ref (i-1).dir_ = DOWN;
613 if (!tie_configs->elem (i).dir_)
614 tie_configs->elem_ref (i).dir_ = UP;
618 for (int i = 1; i < tie_configs->size() - 1; i++)
620 Tie_configuration &conf = tie_configs->elem_ref (i);
624 Direction position_dir =
625 Direction (sign (conf.position_));
629 conf.dir_ = position_dir;
633 Tie_configuration_variation::Tie_configuration_variation ()
639 Array<Tie_configuration_variation>
640 Tie_formatting_problem::get_variations (Ties_configuration const &ties)
642 Real center_distance_tolerance = 0.25;
644 Array<Tie_configuration_variation> vars;
645 Real last_center = 0.0;
646 for (int i = 0; i < ties.size (); i++)
648 Bezier b (ties[i].get_transformed_bezier (details_));
650 Real center = b.curve_point (0.5)[Y_AXIS];
654 if (center <= last_center + center_distance_tolerance)
656 if (!specifications_[i].has_manual_dir_)
658 Tie_configuration_variation var;
660 var.suggestion_ = get_configuration (ties[i].position_,
666 if (!specifications_[i-1].has_manual_dir_)
668 Tie_configuration_variation var;
670 var.suggestion_ = get_configuration (ties[i-1].position_,
678 last_center = center;
686 Tie_formatting_problem::set_manual_tie_configuration (SCM manual_configs)
689 for (SCM s = manual_configs;
690 scm_is_pair (s) && k < specifications_.size(); s = scm_cdr (s))
692 SCM entry = scm_car (s);
693 if (!scm_is_pair (entry))
696 Tie_specification &spec = specifications_[k];
698 if (scm_is_number (scm_cdr (entry)))
700 spec.has_manual_dir_ = true;
701 spec.manual_dir_ = Direction (scm_to_int (scm_cdr (entry)));
703 if (scm_is_number (scm_car (entry)))
705 spec.has_manual_position_ = true;
706 spec.manual_position_ = scm_to_double (scm_car (entry));