X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Faccidental-placement.cc;h=6bf1a74b26b7e08e01ee2c5d3b31d17c8cbb9ecd;hb=5bbfc22fce036b9b69df5e420de93e11da23c05e;hp=cbc1478608fba2bc42ddf31c34ae5a5b59157da4;hpb=f9214bac21e9926dc3248416f58190c98c4167a9;p=lilypond.git diff --git a/lily/accidental-placement.cc b/lily/accidental-placement.cc index cbc1478608..6bf1a74b26 100644 --- a/lily/accidental-placement.cc +++ b/lily/accidental-placement.cc @@ -1,47 +1,66 @@ /* - accidental-placement.cc -- implement Accidental_placement + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 2002--2014 Han-Wen Nienhuys - (c) 2002--2007 Han-Wen Nienhuys -*/ + LilyPond is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + LilyPond is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + You should have received a copy of the GNU General Public License + along with LilyPond. If not, see . +*/ #include "accidental-placement.hh" -#include "item.hh" -#include "rhythmic-head.hh" #include "accidental-interface.hh" +#include "item.hh" #include "music.hh" #include "note-collision.hh" #include "note-column.hh" #include "pointer-group-interface.hh" +#include "rhythmic-head.hh" #include "skyline.hh" +#include "skyline-pair.hh" #include "stream-event.hh" #include "warn.hh" - -void -Accidental_placement::add_accidental (Grob *me, Grob *a) +static Pitch * +accidental_pitch (Grob *acc) { - a->set_parent (me, X_AXIS); - a->set_property ("X-offset", Grob::x_parent_positioning_proc); - SCM cause = a->get_parent (Y_AXIS)->get_property ("cause"); + SCM cause = acc->get_parent (Y_AXIS)->get_property ("cause"); Stream_event *mcause = unsmob_stream_event (cause); if (!mcause) { programming_error ("note head has no event cause"); - return; + return 0; } - Pitch *p = unsmob_pitch (mcause->get_property ("pitch")); + return Pitch::unsmob (mcause->get_property ("pitch")); +} + +void +Accidental_placement::add_accidental (Grob *me, Grob *a, bool stagger, long context_hash) +{ + Pitch *p = accidental_pitch (a); + if (!p) + return; - int n = p->get_notename (); + a->set_parent (me, X_AXIS); + a->set_property ("X-offset", Grob::x_parent_positioning_proc); + long n = p->get_notename (); SCM accs = me->get_object ("accidental-grobs"); - SCM key = scm_from_int (n); - SCM entry = scm_assq (key, accs); + SCM key = scm_cons (scm_from_int (n), scm_from_long (stagger ? context_hash : 1)); + // assoc because we're dealing with pairs + SCM entry = scm_assoc (key, accs); if (entry == SCM_BOOL_F) entry = SCM_EOL; else @@ -49,7 +68,7 @@ Accidental_placement::add_accidental (Grob *me, Grob *a) entry = scm_cons (a->self_scm (), entry); - accs = scm_assq_set_x (accs, key, entry); + accs = scm_assoc_set_x (accs, key, entry); me->set_object ("accidental-grobs", accs); } @@ -59,404 +78,442 @@ Accidental_placement::add_accidental (Grob *me, Grob *a) */ void Accidental_placement::split_accidentals (Grob *accs, - vector *break_reminder, - vector *real_acc) + vector *break_reminder, + vector *real_acc) { for (SCM acs = accs->get_object ("accidental-grobs"); scm_is_pair (acs); acs = scm_cdr (acs)) for (SCM s = scm_cdar (acs); scm_is_pair (s); s = scm_cdr (s)) { - Grob *a = unsmob_grob (scm_car (s)); + Grob *a = Grob::unsmob (scm_car (s)); - if (unsmob_grob (a->get_object ("tie"))) - break_reminder->push_back (a); - else - real_acc->push_back (a); + if (Grob::unsmob (a->get_object ("tie")) + && !to_boolean (a->get_property ("forced"))) + break_reminder->push_back (a); + else + real_acc->push_back (a); } } -vector -Accidental_placement::get_break_reminder_accidentals (vector const &elts, Grob *left) +vector +Accidental_placement::get_relevant_accidentals (vector const &elts, Grob *left) { - vector br; - vector ra; - vector ret; - - if (dynamic_cast (left)->break_status_dir () != RIGHT) - return vector (); + vector br; + vector ra; + vector ret; + bool right = dynamic_cast (left)->break_status_dir () == RIGHT; for (vsize i = 0; i < elts.size (); i++) { split_accidentals (elts[i], &br, &ra); - ret.insert (ret.end (), br.begin (), br.end ()); - } - return ret; -} - -/* - Accidentals are special, because they appear and disappear after - ties at will. -*/ -Interval -Accidental_placement::get_relevant_accidental_extent (Grob *me, - Item *item_col, - Grob *left_object) -{ - vector br, ra; - vector *which = 0; - - Accidental_placement::split_accidentals (me, &br, &ra); - concat (br, ra); - if (dynamic_cast (left_object)->break_status_dir () == RIGHT) - which = &br; - else - which = &ra; - - Interval extent; - for (vsize i = 0; i < which->size (); i++) - extent.unite (which->at (i)->extent (item_col, X_AXIS)); + ret.insert (ret.end (), ra.begin (), ra.end ()); - if (!extent.is_empty ()) - { - Real p = robust_scm2double (me->get_property ("left-padding"), 0.2); - extent[LEFT] -= p; + if (right) + ret.insert (ret.end (), br.begin (), br.end ()); } - - return extent; + return ret; } struct Accidental_placement_entry { - Skyline left_skyline_; - Skyline right_skyline_; - Interval vertical_extent_; - vector extents_; - vector grobs_; - Real offset_; - int notename_; - Accidental_placement_entry () - { - offset_ = 0.0; - notename_ = -1; - } + Skyline_pair horizontal_skylines_; + vector grobs_; }; -static Interval all_accidental_vertical_extent; Real ape_priority (Accidental_placement_entry const *a) { - return a->vertical_extent_[UP]; -} - -int ape_compare (Accidental_placement_entry *const &a, - Accidental_placement_entry *const &b) -{ - return sign (ape_priority (a) - ape_priority (b)); + // right is up because we're horizontal + return a->horizontal_skylines_.right (); } bool ape_less (Accidental_placement_entry *const &a, - Accidental_placement_entry *const &b) + Accidental_placement_entry *const &b) { + vsize size_a = a->grobs_.size (); + vsize size_b = b->grobs_.size (); + if (size_a != size_b) + return size_b < size_a; + return ape_priority (a) < ape_priority (b); } -int ape_rcompare (Accidental_placement_entry *const &a, - Accidental_placement_entry *const &b) +/* + This function provides a method for sorting accidentals that belong to the + same note. The accidentals that this function considers to be "smallest" + will be placed to the left of the "larger" accidentals. + + Naturals are the largest (so that they don't get confused with cancellation + naturals); apart from that, we order according to the alteration (so + double-flats are the smallest). + + Precondition: the accidentals are attached to NoteHeads of the same note + name -- the octaves, however, may be different. +*/ +static bool +acc_less (Grob *const &a, Grob *const &b) { - return -sign (ape_priority (a) - ape_priority (b)); + Pitch *p = accidental_pitch (a); + Pitch *q = accidental_pitch (b); + + if (!p || !q) + { + programming_error ("these accidentals do not have a pitch"); + return false; + } + + if (p->get_octave () != q->get_octave ()) + return p->get_octave () < q->get_octave (); + + if (p->get_alteration () == Rational (0)) + return false; + if (q->get_alteration () == Rational (0)) + return true; + + return p->get_alteration () < q->get_alteration (); } /* TODO: should favor - b - b + * b + * b placement */ void -stagger_apes (vector *apes) +stagger_apes (vector *apes) { - vector asc = *apes; + vector asc = *apes; vector_sort (asc, &ape_less); + // we do the staggering below based on size + // this ensures that if a placement has 4 entries, it will + // always be closer to the NoteColumn than a placement with 1 + // this allows accidentals to be on-average closer to notes + // while still preserving octave alignment + vector > ascs; + + vsize sz = INT_MAX; + for (vsize i = 0; i < asc.size (); i++) + { + vsize my_sz = asc[i]->grobs_.size (); + if (sz != my_sz) + ascs.push_back (vector ()); + ascs.back ().push_back (asc[i]); + sz = my_sz; + } apes->clear (); - int parity = 1; - for (vsize i = 0; i < asc.size ();) + for (vsize i = 0; i < ascs.size (); i++) { - Accidental_placement_entry *a = 0; - if (parity) - { - a = asc.back (); - asc.pop_back (); - } - else - a = asc[i++]; - - apes->push_back (a); - parity = !parity; + int parity = 1; + for (vsize j = 0; j < ascs[i].size ();) + { + Accidental_placement_entry *a = 0; + if (parity) + { + a = ascs[i].back (); + ascs[i].pop_back (); + } + else + a = ascs[i][j++]; + + apes->push_back (a); + parity = !parity; + } } reverse (*apes); } -/* - This routine computes placements of accidentals. During - add_accidental (), accidentals are already grouped by note, so that - octaves are placed above each other; they form columns. Then the - columns are sorted: the biggest columns go closest to the note. - Then the columns are spaced as closely as possible (using skyline - spacing). - - - TODO: more advanced placement. Typically, the accs should be placed - to form a C shape, like this - - - ## - b b - # # - b - b b - - The naturals should be left of the C as well; they should - be separate accs. - - Note that this placement problem looks NP hard, so we just use a - simple strategy, not an optimal choice. -*/ - -/* - TODO: there should be more space in the following situation - - - Natural + downstem - - * - * |_ - * | | X - * |_| | - * | | - * - -*/ - -MAKE_SCHEME_CALLBACK(Accidental_placement, calc_positioning_done, 1); -SCM -Accidental_placement::calc_positioning_done (SCM smob) +static vector +build_apes (SCM accs) { - Grob *me = unsmob_grob (smob); - if (!me->is_live ()) - return SCM_BOOL_T; - - SCM accs = me->get_object ("accidental-grobs"); - if (!scm_is_pair (accs)) - return SCM_BOOL_T; - - /* - TODO: there is a bug in this code. If two accs are on the same - Y-position, they share an Ape, and will be printed in overstrike. - */ - vector apes; + vector apes; for (SCM s = accs; scm_is_pair (s); s = scm_cdr (s)) { Accidental_placement_entry *ape = new Accidental_placement_entry; - ape->notename_ = scm_to_int (scm_caar (s)); for (SCM t = scm_cdar (s); scm_is_pair (t); t = scm_cdr (t)) - ape->grobs_.push_back (unsmob_grob (scm_car (t))); + ape->grobs_.push_back (Grob::unsmob (scm_car (t))); apes.push_back (ape); } - Grob *common[] = {me, 0}; + return apes; +} + +static void +set_ape_skylines (Accidental_placement_entry *ape, + Grob **common, Real padding) +{ + vector accs (ape->grobs_); + vector_sort (accs, &acc_less); + + /* We know that each accidental has the same note name and we assume that + accidentals in different octaves won't collide. If two or more + accidentals are in the same octave: + 1) if they are the same accidental, print them in overstrike + 2) otherwise, shift one to the left so they don't overlap. */ + int last_octave = 0; + Real offset = 0; + Real last_offset = 0; + Rational last_alteration (0); + for (vsize i = accs.size (); i--;) + { + Grob *a = accs[i]; + Pitch *p = accidental_pitch (a); + + if (!p) + continue; + + if (i == accs.size () - 1 || p->get_octave () != last_octave) + { + last_offset = 0; + offset = a->extent (a, X_AXIS)[LEFT] - padding; + } + else if (p->get_alteration () == last_alteration) + a->translate_axis (last_offset, X_AXIS); + else /* Our alteration is different from the last one */ + { + Real this_offset = offset - a->extent (a, X_AXIS)[RIGHT]; + a->translate_axis (this_offset, X_AXIS); + + last_offset = this_offset; + offset -= a->extent (a, X_AXIS).length () + padding; + } + + if (Skyline_pair *sky = Skyline_pair::unsmob (a->get_property ("horizontal-skylines"))) + { + Skyline_pair copy (*sky); + copy.raise (a->relative_coordinate (common[X_AXIS], X_AXIS)); + copy.shift (a->relative_coordinate (common[Y_AXIS], Y_AXIS)); + ape->horizontal_skylines_.merge (copy); + } + + last_octave = p->get_octave (); + last_alteration = p->get_alteration (); + } +} + +static vector +extract_heads_and_stems (vector const &apes) +{ + vector note_cols; + vector ret; - /* - First we must extract *all* pointers. We can only determine - extents if we're sure that we've found the right common refpoint - */ - vector note_cols, heads; for (vsize i = apes.size (); i--;) { Accidental_placement_entry *ape = apes[i]; for (vsize j = ape->grobs_.size (); j--;) - { - Grob *a = ape->grobs_[j]; - - if (common[Y_AXIS]) - common[Y_AXIS] = common[Y_AXIS]->common_refpoint (a, Y_AXIS); - else - common[Y_AXIS] = a; - - Grob *head = a->get_parent (Y_AXIS); - - Grob *col = head->get_parent (X_AXIS); - if (Note_column::has_interface (col)) - note_cols.push_back (col); - else - heads.push_back (head); - } + { + Grob *acc = ape->grobs_[j]; + Grob *head = acc->get_parent (Y_AXIS); + Grob *col = head->get_parent (X_AXIS); + + if (Note_column::has_interface (col)) + note_cols.push_back (col); + else + ret.push_back (head); + } } /* - This is a little kludgy: to get all notes, we look if there are - collisions as well. + This is a little kludgy: in case there are note columns without + accidentals, we get them from the Note_collision objects. */ for (vsize i = note_cols.size (); i--;) { Grob *c = note_cols[i]->get_parent (X_AXIS); if (Note_collision_interface::has_interface (c)) - { - extract_grob_set (c, "elements", gs); - - concat (note_cols, gs); - } + { + extract_grob_set (c, "elements", columns); + concat (note_cols, columns); + } } + /* Now that we have all of the columns, grab all of the note-heads */ for (vsize i = note_cols.size (); i--;) - concat (heads, extract_grob_array (note_cols[i], "note-heads")); - - vector_sort (heads, less ()); - uniq (heads); - - vector stems; - for (vsize i = 0; i < heads.size (); i++) - { - if (Grob *s = Rhythmic_head::get_stem (heads[i])) - stems.push_back (s); - } - - vector_sort (stems, less ()); - uniq (stems); - - common[Y_AXIS] = common_refpoint_of_array (heads, common[Y_AXIS], Y_AXIS); - common[Y_AXIS] = common_refpoint_of_array (stems, common[Y_AXIS], Y_AXIS); - - for (vsize i = 0; i < heads.size (); i++) - { - if (Grob *s = Rhythmic_head::get_stem (heads[i])) - { - stems.push_back (s); - common[Y_AXIS] = s->common_refpoint (common[Y_AXIS], Y_AXIS); - } - } + concat (ret, extract_grob_array (note_cols[i], "note-heads")); - vector_sort (stems, less ()); - uniq (stems); + /* Now that we have all of the heads, grab all of the stems */ + for (vsize i = ret.size (); i--;) + if (Grob *s = Rhythmic_head::get_stem (ret[i])) + ret.push_back (s); + uniquify (ret); + return ret; +} - for (vsize i = apes.size (); i--;) - { - Accidental_placement_entry *ape = apes[i]; - - for (vsize j = apes[i]->grobs_.size (); j--;) - { - Grob *a = apes[i]->grobs_[j]; - vector boxes = Accidental_interface::accurate_boxes (a, common); - - ape->extents_.insert (ape->extents_.end (), boxes.begin (), boxes.end ()); - } - ape->left_skyline_ = Skyline (ape->extents_, 0, Y_AXIS, LEFT); - ape->right_skyline_ = Skyline (ape->extents_, 0, Y_AXIS, RIGHT); - } +static Grob * +common_refpoint_of_accidentals (vector const &apes, Axis a) +{ + Grob *ret = 0; - Interval total; for (vsize i = apes.size (); i--;) - { - Interval y; + for (vsize j = apes[i]->grobs_.size (); j--;) + { + if (!ret) + ret = apes[i]->grobs_[j]; + else + ret = ret->common_refpoint (apes[i]->grobs_[j], a); + } - for (vsize j = apes[i]->extents_.size (); j--;) - y.unite (apes[i]->extents_[j][Y_AXIS]); - apes[i]->vertical_extent_ = y; - total.unite (y); - } - all_accidental_vertical_extent = total; - stagger_apes (&apes); + return ret; +} - Accidental_placement_entry *head_ape = new Accidental_placement_entry; - common[X_AXIS] = common_refpoint_of_array (heads, common[X_AXIS], X_AXIS); - +static Skyline +build_heads_skyline (vector const &heads_and_stems, + Grob **common) +{ vector head_extents; - for (vsize i = heads.size (); i--;) - head_extents.push_back (Box (heads[i]->extent (common[X_AXIS], X_AXIS), - heads[i]->extent (common[Y_AXIS], Y_AXIS))); + for (vsize i = heads_and_stems.size (); i--;) + head_extents.push_back (Box (heads_and_stems[i]->extent (common[X_AXIS], X_AXIS), + heads_and_stems[i]->pure_height (common[Y_AXIS], 0, INT_MAX))); - for (vsize i = 0; i < stems.size (); i ++) - { - int very_large = INT_MAX; - - head_extents.push_back (Box (stems[i]->extent (common[X_AXIS], X_AXIS), - stems[i]->pure_height (common[Y_AXIS], 0, very_large))); - } - - head_ape->left_skyline_ = Skyline (head_extents, 0, Y_AXIS, LEFT); - head_ape->offset_ = 0.0; + return Skyline (head_extents, Y_AXIS, LEFT); +} +/* + Position the apes, starting from the right, so that they don't collide. + Return the total width. +*/ +static Interval +position_apes (Grob *me, + vector const &apes, + Skyline const &heads_skyline) +{ Real padding = robust_scm2double (me->get_property ("padding"), 0.2); - - Skyline left_skyline = head_ape->left_skyline_; + Skyline left_skyline = heads_skyline; left_skyline.raise (-robust_scm2double (me->get_property ("right-padding"), 0)); - + /* Add accs entries right-to-left. */ + Interval width; + Real last_offset = 0.0; for (vsize i = apes.size (); i-- > 0;) { - Real offset = -apes[i]->right_skyline_.distance (left_skyline); + Accidental_placement_entry *ape = apes[i]; + + Real offset = -ape->horizontal_skylines_[RIGHT] + .distance (left_skyline, 0.1); if (isinf (offset)) - offset = (i + 1 < apes.size ()) ? apes[i + 1]->offset_ : 0.0; + offset = last_offset; else - offset -= padding; + offset -= padding; - apes[i]->offset_ = offset; - - Skyline new_left_skyline = apes[i]->left_skyline_; - new_left_skyline.raise (apes[i]->offset_); + Skyline new_left_skyline = ape->horizontal_skylines_[LEFT]; + new_left_skyline.raise (offset); new_left_skyline.merge (left_skyline); left_skyline = new_left_skyline; - } - for (vsize i = apes.size (); i--;) - { - Accidental_placement_entry *ape = apes[i]; + /* Shift all of the accidentals in this ape */ for (vsize j = ape->grobs_.size (); j--;) - ape->grobs_[j]->translate_axis (ape->offset_, X_AXIS); + ape->grobs_[j]->translate_axis (offset, X_AXIS); + + for (LEFT_and_RIGHT (d)) + { + Real mh = ape->horizontal_skylines_[d].max_height (); + if (!isinf (mh)) + width.add_point (mh + offset); + } + + last_offset = offset; } - Interval left_extent, right_extent; - Accidental_placement_entry *ape = apes[0]; + return width; +} + +/* + This routine computes placements of accidentals. During + add_accidental (), accidentals are already grouped by note, so that + octaves are placed above each other; they form columns. Then the + columns are sorted: the biggest columns go closest to the note. + Then the columns are spaced as closely as possible (using skyline + spacing). + + + TODO: more advanced placement. Typically, the accs should be placed + to form a C shape, like this + + * ## + * b b + * # # + * b + * b b + + The naturals should be left of the C as well; they should + be separate accs. + + Note that this placement problem looks NP hard, so we just use a + simple strategy, not an optimal choice. +*/ + +/* + TODO: there should be more space in the following situation + + + Natural + downstem + + * + * |_ + * | | X + * |_| | + * | | + * +*/ + +MAKE_SCHEME_CALLBACK (Accidental_placement, calc_positioning_done, 1); +SCM +Accidental_placement::calc_positioning_done (SCM smob) +{ + Grob *me = Grob::unsmob (smob); + if (!me->is_live ()) + return SCM_BOOL_T; - for (vsize i = ape->extents_.size (); i--;) - left_extent.unite (ape->offset_ + ape->extents_[i][X_AXIS]); + me->set_property ("positioning-done", SCM_BOOL_T); - ape = apes.back (); - for (vsize i = ape->extents_.size (); i--;) - right_extent.unite (ape->offset_ + ape->extents_[i][X_AXIS]); + SCM accs = me->get_object ("accidental-grobs"); + if (!scm_is_pair (accs)) + return SCM_BOOL_T; - left_extent[LEFT] -= robust_scm2double (me->get_property ("left-padding"), 0); - Interval width (left_extent[LEFT], right_extent[RIGHT]); + vector apes = build_apes (accs); + + Grob *common[] = {me, 0}; + + vector heads_and_stems = extract_heads_and_stems (apes); + + common[Y_AXIS] = common_refpoint_of_accidentals (apes, Y_AXIS); + common[Y_AXIS] = common_refpoint_of_array (heads_and_stems, common[Y_AXIS], Y_AXIS); + common[X_AXIS] = common_refpoint_of_array (heads_and_stems, me, X_AXIS); + Real padding = robust_scm2double (me->get_property ("padding"), 0.2); + + for (vsize i = apes.size (); i--;) + set_ape_skylines (apes[i], common, padding); + Skyline heads_skyline = build_heads_skyline (heads_and_stems, common); + + stagger_apes (&apes); + Interval width = position_apes (me, apes, heads_skyline); - SCM scm_width = ly_interval2scm (width); me->flush_extent_cache (X_AXIS); - me->set_property ("X-extent", scm_width); + me->set_property ("X-extent", ly_interval2scm (width)); junk_pointers (apes); - delete head_ape; - return SCM_BOOL_T; } ADD_INTERFACE (Accidental_placement, - "Resolve accidental collisions.", - - /* properties */ - "accidental-grobs " - "left-padding " - "padding " - "positioning-done " - "right-padding " - "script-priority " - ) + "Resolve accidental collisions.", + + /* properties */ + "accidental-grobs " + "direction " + "padding " + "positioning-done " + "right-padding " + "script-priority " + );