X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fnote-spacing.cc;h=a894be25394c9a41ba44a5db8870e79e686c574b;hb=2bbacb364aa29041af9cbbbd32cfad2e8e387cb3;hp=b4d85287d20dbd53b2c6e76cbb9ce40d5f919f5e;hpb=58bcc84c9480dae1b21bc24d8396b91fe19e0131;p=lilypond.git diff --git a/lily/note-spacing.cc b/lily/note-spacing.cc index b4d85287d2..a894be2539 100644 --- a/lily/note-spacing.cc +++ b/lily/note-spacing.cc @@ -1,246 +1,210 @@ /* - note-spacing.cc -- implement Note_spacing + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 2001--2015 Han-Wen Nienhuys - (c) 2001--2005 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 "note-spacing.hh" -#include "paper-column.hh" +#include "accidental-placement.hh" +#include "bar-line.hh" +#include "directional-element-interface.hh" +#include "grob-array.hh" #include "moment.hh" #include "note-column.hh" -#include "warn.hh" -#include "stem.hh" +#include "output-def.hh" +#include "paper-column.hh" +#include "pointer-group-interface.hh" #include "separation-item.hh" +#include "spacing-interface.hh" #include "staff-spacing.hh" -#include "accidental-placement.hh" -#include "output-def.hh" +#include "staff-symbol-referencer.hh" +#include "stem.hh" +#include "warn.hh" /* - TODO: detect hshifts due to collisions, and account for them in - spacing? + Adjust the ideal and minimum distance between note columns, + based on the notehead size, skylines, and optical illusions. */ - -void +Spring Note_spacing::get_spacing (Grob *me, Item *right_col, - Real base_space, Real increment, Real *space, Real *fixed) + Spring base, Real increment) { + vector note_columns = Spacing_interface::left_note_columns (me); + Real left_head_end = 0; - Drul_array props (me->get_property ("left-items"), - me->get_property ("right-items")); - Direction d = LEFT; - Direction col_dir = right_col->break_status_dir (); - Drul_array extents; - - Interval left_head_wid; - do + for (vsize i = 0; i < note_columns.size (); i++) { - for (SCM s = props[d]; scm_is_pair (s); s = scm_cdr (s)) - { - Item *it = dynamic_cast (unsmob_grob (scm_car (s))); - - if (d == RIGHT && it->break_status_dir () != col_dir) - { - it = it -> find_prebroken_piece (col_dir); - - } - /* - some kind of mismatch, eg. a note column, that is behind a - linebreak. - */ - if (!it) - continue; - - Item *it_col = it->get_column (); - if (d == RIGHT && right_col != it_col) - continue; - - if (Separation_item::has_interface (it)) - { - extents[d].unite (Separation_item::width (it)); - continue; - } - - if (d == LEFT) - { - SCM r = it->get_property ("rest"); - Grob *g = unsmob_grob (r); - if (!g) - g = Note_column::first_head (it); - - /* - Ugh. If Stem is switched off, we don't know what the - first note head will be. - */ - if (g) - left_head_wid = g->extent (it_col, X_AXIS); - } - - extents[d].unite (it->extent (it_col, X_AXIS)); - if (d == RIGHT) - { - Grob *accs = Note_column::accidentals (it); - if (!accs) - accs = Note_column::accidentals (it->get_parent (X_AXIS)); - - if (accs) - { - Interval v - = Accidental_placement::get_relevant_accidental_extent (accs, it_col, me); - - extents[d].unite (v); - } - } - } - - if (extents[d].is_empty ()) - extents[d] = Interval (0, 0); + SCM r = note_columns[i]->get_object ("rest"); + Grob *g = unsmob (r); + Grob *col = note_columns[i]->get_column (); + + if (!g) + g = Note_column::first_head (note_columns[i]); + + /* + Ugh. If Stem is switched off, we don't know what the + first note head will be. + */ + if (g) + { + if (g->common_refpoint (col, X_AXIS) != col) + programming_error ("Note_spacing::get_spacing (): Common refpoint incorrect"); + else + left_head_end = g->extent (col, X_AXIS)[RIGHT]; + } } - while (flip (&d) != LEFT); /* - We look at the width of the note head, since smaller heads get less space - eg. a quarter rest gets almost 0.5 ss less horizontal space than a note. + The main factor that determines the amount of space is the width of the + note head (or the rest). For example, a quarter rest gets almost 0.5 ss + less horizontal space than a note. + */ + Real ideal = base.distance () - increment + left_head_end; + Drul_array skys = Spacing_interface::skylines (me, right_col); + Real distance = skys[LEFT].distance (skys[RIGHT], robust_scm2double (right_col->get_property ("skyline-vertical-padding"), 0.0)); + Real min_dist = max (0.0, distance); + base.set_min_distance (min_dist); + + /* If we have a NonMusical column on the right, we measure the ideal distance + to the bar-line (if present), not the start of the column. */ + if (!Paper_column::is_musical (right_col) + && !skys[RIGHT].is_empty () + && to_boolean (me->get_property ("space-to-barline"))) + { + Grob *bar = Pointer_group_interface::find_grob (right_col, + ly_symbol2scm ("elements"), + Bar_line::non_empty_barline); - What is sticking out of the note head (eg. a flag), doesn't get - the full amount of space. + if (bar) + ideal -= bar->extent (right_col, X_AXIS)[LEFT]; + else + { + /* Measure ideal distance to the right side of the NonMusical column + but keep at least half the gap we would have had to a note */ + Real min_desired_space = (ideal + min_dist) / 2.0; + ideal -= right_col->extent (right_col, X_AXIS)[RIGHT]; + ideal = max (ideal, min_desired_space); + } + } - FIXED also includes the left part of the right object. - */ - *fixed - = (left_head_wid.is_empty () ? increment : - /* - Size of the head: - */ - (left_head_wid[RIGHT]+ - - /* - What's sticking out of the head, eg. a flag: - */ - (extents[LEFT][RIGHT] - left_head_wid[RIGHT]) / 2)) - - /* - What is sticking out of the right note: - */ - + (extents[RIGHT].is_empty () ? 0.0 : - extents[RIGHT][LEFT] / 2); + stem_dir_correction (me, right_col, increment, &ideal); - /* - We don't do complicated stuff: (base_space - increment) is the - normal amount of white, which also determines the amount of - stretch. Upon (extreme) stretching, notes with accidentals should - stretch as much as notes without accidentals. - */ - *space = (base_space - increment) + *fixed; + base.set_distance (max (0.0, ideal)); + return base; +} - if (!extents[RIGHT].is_empty () - && (Item::is_breakable (right_col) - || right_col->original_)) - { - /* - This is for the situation +static Real +knee_correction (Grob *note_spacing, Grob *right_stem, Real increment) +{ + Real note_head_width = increment; + Grob *head = right_stem ? Stem::support_head (right_stem) : 0; + Grob *rcolumn = dynamic_cast (head)->get_column (); - rest | 3/4 (eol) + Interval head_extent; + if (head) + { + head_extent = head->extent (rcolumn, X_AXIS); - Since we only take half of the right-object space above, the - barline will bump into the notes preceding it, if the right - thing is big. We add the rest of the extents here: - */ + if (!head_extent.is_empty ()) + note_head_width = head_extent[RIGHT]; - *space += -extents[RIGHT][LEFT] / 2; - *fixed += -extents[RIGHT][LEFT] / 2; + note_head_width -= Stem::thickness (right_stem); } - stem_dir_correction (me, right_col, increment, space, fixed); + return -note_head_width * get_grob_direction (right_stem) + * robust_scm2double (note_spacing->get_property ("knee-spacing-correction"), 0); } -Item * -Note_spacing::left_column (Grob *me) +static Real +different_directions_correction (Grob *note_spacing, + Drul_array stem_posns, + Direction left_stem_dir) { - if (!me->is_live ()) - return 0; + Real ret = 0.0; + Interval intersect = stem_posns[LEFT]; + intersect.intersect (stem_posns[RIGHT]); - return dynamic_cast (me)->get_column (); + if (!intersect.is_empty ()) + { + ret = abs (intersect.length ()); + + /* + Ugh. 7 is hardcoded. + */ + ret = min (ret / 7, 1.0) + * left_stem_dir + * robust_scm2double (note_spacing->get_property ("stem-spacing-correction"), 0); + } + return ret; } -/* - Compute the column of the right-items. This is a big function, - since RIGHT-ITEMS may span more columns (eg. if a clef if inserted, - this will add a new columns to RIGHT-ITEMS. Here we look at the - columns, and return the left-most. If there are multiple columns, we - prune RIGHT-ITEMS. -*/ -Item * -Note_spacing::right_column (Grob *me) +static Real +same_direction_correction (Grob *note_spacing, Drul_array head_posns) { - if (!me->is_live ()) - return 0; + /* + Correct for the following situation: - SCM right = me->get_property ("right-items"); - Item *mincol = 0; - int min_rank = INT_MAX; - bool prune = false; - for (SCM s = right; scm_is_pair (s); s = scm_cdr (s)) - { - Item *ri = unsmob_item (scm_car (s)); + X X + | | + | | + | X | + | | | + ======== - Item *col = ri->get_column (); - int rank = Paper_column::get_rank (col); + ^ move the center one to the left. - if (rank < min_rank) - { - min_rank = rank; - if (mincol) - prune = true; - mincol = col; - } - } + this effect seems to be much more subtle than the + stem-direction stuff (why?), and also does not scale with the + difference in stem length. - if (prune) - { - // I'm a lazy bum. We could do this in-place. - SCM newright = SCM_EOL; - for (SCM s = right; scm_is_pair (s); s = scm_cdr (s)) - { - if (unsmob_item (scm_car (s))->get_column () == mincol) - newright = scm_cons (scm_car (s), newright); - } - - me->set_property ("right-items", newright); - } + */ - if (!mincol) - { - /* - int r = Paper_column::get_rank (dynamic_cast(me)->get_column ()); - programming_error (_f ("Spacing wish column %d has no right item.", r)); - */ + Interval hp = head_posns[LEFT]; + hp.intersect (head_posns[RIGHT]); + if (!hp.is_empty ()) + return 0; - return 0; - } + Direction lowest + = (head_posns[LEFT][DOWN] > head_posns[RIGHT][UP]) ? RIGHT : LEFT; - return mincol; + Real delta = head_posns[-lowest][DOWN] - head_posns[lowest][UP]; + Real corr = robust_scm2double (note_spacing->get_property ("same-direction-correction"), 0); + + return (delta > 1) ? -lowest * corr : 0; } -/** - Correct for optical illusions. See [Wanske] p. 138. The combination - up-stem + down-stem should get extra space, the combination - down-stem + up-stem less. +/* + Correct for optical illusions. See [Wanske] p. 138. The combination + up-stem + down-stem should get extra space, the combination + down-stem + up-stem less. - TODO: have to check wether the stems are in the same staff. + TODO: have to check whether the stems are in the same staff. */ void Note_spacing::stem_dir_correction (Grob *me, Item *rcolumn, - Real increment, - Real *space, Real *fixed) + Real increment, + Real *space) { Drul_array stem_dirs (CENTER, CENTER); Drul_array stem_posns; Drul_array head_posns; - Drul_array props (me->get_property ("left-items"), - me->get_property ("right-items")); + Drul_array props (me->get_object ("left-items"), + me->get_object ("right-items")); Drul_array beams_drul (0, 0); Drul_array stems_drul (0, 0); @@ -250,86 +214,62 @@ Note_spacing::stem_dir_correction (Grob *me, Item *rcolumn, Interval bar_xextent; Interval bar_yextent; - bool correct_stem_dirs = true; - Direction d = LEFT; bool acc_right = false; - do + Grob *bar = Spacing_interface::extremal_break_aligned_grob (me, RIGHT, + rcolumn->break_status_dir (), + &bar_xextent); + if (bar && dynamic_cast (bar)->get_column () == rcolumn) + bar_yextent = Staff_spacing::bar_y_positions (bar); + + for (LEFT_and_RIGHT (d)) { - for (SCM s = props[d]; scm_is_pair (s); s = scm_cdr (s)) - { - Item *it = dynamic_cast (unsmob_grob (scm_car (s))); - - if (d == RIGHT) - acc_right = acc_right || Note_column::accidentals (it); - - Grob *stem = Note_column::get_stem (it); - - if (!stem || !stem->is_live ()) - { - if (d == RIGHT && Separation_item::has_interface (it)) - { - if (it->get_column () != rcolumn) - { - it = it->find_prebroken_piece (rcolumn->break_status_dir ()); - } - - Grob *last = Separation_item::extremal_break_aligned_grob (it, LEFT, &bar_xextent); - - if (last) - bar_yextent = Staff_spacing::bar_y_positions (last); - - break; - } - - return; - } - - if (Stem::is_invisible (stem)) - { - correct_stem_dirs = false; - continue; - } - - stems_drul[d] = stem; - beams_drul[d] = Stem::get_beam (stem); - - Direction sd = Stem::get_direction (stem); - if (stem_dirs[d] && stem_dirs[d] != sd) - { - correct_stem_dirs = false; - continue; - } - stem_dirs[d] = sd; - - /* - Correction doesn't seem appropriate when there is a large flag - hanging from the note. - */ - if (d == LEFT - && Stem::duration_log (stem) > 2 && !Stem::get_beam (stem)) - { - correct_stem_dirs = false; - } - - Interval hp = Stem::head_positions (stem); - if (!hp.is_empty ()) - { - Real chord_start = hp[sd]; - Real stem_end = Stem::stem_end_position (stem); - - stem_posns[d] = Interval (chord_start ? stem_end); - head_posns[d].unite (hp); - } - } + vector const &items (ly_scm2link_array (props [d])); + for (vsize i = 0; i < items.size (); i++) + { + Item *it = dynamic_cast (items[i]); + if (!has_interface (it)) + continue; + if (d == RIGHT && it->get_column () != rcolumn) + continue; + + /* + Find accidentals which are sticking out of the right side. + */ + if (d == RIGHT) + acc_right = acc_right || Note_column::accidentals (it); + + Grob *stem = Note_column::get_stem (it); + + if (!stem || !stem->is_live () || Stem::is_invisible (stem)) + return; + + stems_drul[d] = stem; + beams_drul[d] = Stem::get_beam (stem); + + Direction stem_dir = get_grob_direction (stem); + if (stem_dirs[d] && stem_dirs[d] != stem_dir) + return; + + stem_dirs[d] = stem_dir; + + /* + Correction doesn't seem appropriate when there is a large flag + hanging from the note. + */ + if (d == LEFT + && Stem::duration_log (stem) > 2 && !Stem::get_beam (stem)) + return; + + Interval hp = Stem::head_positions (stem); + if (!hp.is_empty ()) + { + Real ss = Staff_symbol_referencer::staff_space (stem); + stem_posns[d] = stem->pure_y_extent (stem, 0, INT_MAX) * (2 / ss); + head_posns[d].unite (hp); + } + } } - while (flip (&d) != LEFT); - - /* - don't correct if accidentals are sticking out of the right side. - */ - if (acc_right) - return; Real correction = 0.0; @@ -337,111 +277,47 @@ Note_spacing::stem_dir_correction (Grob *me, Item *rcolumn, { stem_dirs[RIGHT] = -stem_dirs[LEFT]; stem_posns[RIGHT] = bar_yextent; + stem_posns[RIGHT] *= 2; } - if (correct_stem_dirs && stem_dirs[LEFT] *stem_dirs[RIGHT] == -1) + if (stem_dirs[LEFT] * stem_dirs[RIGHT] == -1) { if (beams_drul[LEFT] && beams_drul[LEFT] == beams_drul[RIGHT]) - { - - /* - this is a knee: maximal correction. - */ - Real note_head_width = increment; - Grob *st = stems_drul[RIGHT]; - Grob *head = st ? Stem::support_head (st) : 0; - - Interval head_extent; - if (head) - { - head_extent = head->extent (rcolumn, X_AXIS); - - if (!head_extent.is_empty ()) - note_head_width = head_extent[RIGHT]; - - if (st) - { - Real thick = Stem::thickness (st); - - note_head_width -= thick; - } - } - - correction = note_head_width* stem_dirs[LEFT]; - correction *= robust_scm2double (me->get_property ("knee-spacing-correction"), 0); - *fixed += correction; - } + { + correction = knee_correction (me, stems_drul[RIGHT], increment); + } else - { - intersect = stem_posns[LEFT]; - intersect.intersect (stem_posns[RIGHT]); - correct_stem_dirs = correct_stem_dirs && !intersect.is_empty (); - - if (correct_stem_dirs) - { - correction = abs (intersect.length ()); - - /* - Ugh. 7 is hardcoded. - */ - correction = (correction / 7) get_property ("stem-spacing-correction"), 0); - } - - if (!bar_yextent.is_empty ()) - { - correction *= 0.5; - } - } - } - else if (correct_stem_dirs && stem_dirs[LEFT] *stem_dirs[RIGHT] == UP) - { - /* - Correct for the following situation: - - X X - | | - | | - | X | - | | | - ======== - - ^ move the center one to the left. - - - this effect seems to be much more subtle than the - stem-direction stuff (why?), and also does not scale with the - difference in stem length. + { + correction = different_directions_correction (me, stem_posns, stem_dirs[LEFT]); - */ - - Interval hp = head_posns[LEFT]; - hp.intersect (head_posns[RIGHT]); - if (!hp.is_empty ()) - return; - - Direction lowest - = (head_posns[LEFT][DOWN] > head_posns[RIGHT][UP]) ? RIGHT : LEFT; - - Real delta = head_posns[-lowest][DOWN] - head_posns[lowest][UP]; - Real corr = robust_scm2double (me->get_property ("stem-spacing-correction"), 0); - corr = (delta <= 1) ? 0.0 : 0.25; - - correction = -lowest * corr; + if (!bar_yextent.is_empty ()) + correction *= 0.5; + } } + /* + Only apply same direction correction if there are no + accidentals sticking out of the right hand side. + */ + else if (stem_dirs[LEFT] * stem_dirs[RIGHT] == 1 + && !acc_right) + correction = same_direction_correction (me, head_posns); *space += correction; /* there used to be a correction for bar_xextent () here, but it's unclear what that was good for ? */ - } - -ADD_INTERFACE (Note_spacing, "note-spacing-interface", - "This object calculates spacing wishes for individual voices.", - "left-items right-items stem-spacing-correction knee-spacing-correction"); +ADD_INTERFACE (Note_spacing, + "This object calculates spacing wishes for individual voices.", + + /* properties */ + "knee-spacing-correction " + "left-items " + "right-items " + "same-direction-correction " + "stem-spacing-correction " + "space-to-barline " + );