X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fspacing-spanner.cc;h=fd9585f1352e2b8dfe2af52a136b3cacbe2c7b0e;hb=f05cfd7757b31723fe6af2f5c0e2fdbaebea3b85;hp=3cd903f731ac8b6410dbb6ddb53971b09e81ac24;hpb=347426c0c9d2fb8e4e75216f717606f1f2124b1a;p=lilypond.git diff --git a/lily/spacing-spanner.cc b/lily/spacing-spanner.cc index 3cd903f731..fd9585f135 100644 --- a/lily/spacing-spanner.cc +++ b/lily/spacing-spanner.cc @@ -1,394 +1,780 @@ /* - spacing-spanner.cc -- implement Spacing_spanner + spacing-spanner.cc -- implement Spacing_spanner source file of the GNU LilyPond music typesetter - (c) 1999--2000 Han-Wen Nienhuys + (c) 1999--2002 Han-Wen Nienhuys */ -#include "spacing-spanner.hh" -#include "paper-column.hh" -#include "dimensions.hh" -#include "paper-def.hh" -#include "warn.hh" -#include "paper-score.hh" +#include +#include + #include "line-of-score.hh" +#include "paper-score.hh" +#include "paper-column.hh" +#include "item.hh" +#include "moment.hh" +#include "note-spacing.hh" #include "misc.hh" +#include "warn.hh" +#include "staff-spacing.hh" +#include "spring.hh" +#include "paper-column.hh" +#include "spaceable-grob.hh" -void -Spacing_spanner::set_interface (Grob*me) +/* + paper-column: + + Don't be confused by right-items: each spacing wish can also contain + a number of items, with which a spacing constraint may be kept. It's + a little baroque, but it might come in handy later on? + + */ +class Spacing_spanner { - me->set_extent_callback (SCM_EOL, X_AXIS); - me->set_extent_callback (SCM_EOL, Y_AXIS) ; -} +public: + static void standard_breakable_column_spacing (Grob * me, Item*l, Item*r, + Real * fixed, Real * space, Moment); + + + static Real default_bar_spacing (Grob*,Grob*,Grob*,Moment); + static Real note_spacing (Grob*,Grob*,Grob*,Moment, bool*); + static Real get_duration_space (Grob*,Moment dur, Rational shortest, bool*); + static Rational find_shortest (Link_array const &); + static void breakable_column_spacing (Grob*, Item* l, Item *r, Moment); + static void find_loose_columns () {} + static void prune_loose_colunms (Grob*,Link_array *cols, Rational); + static void find_loose_columns (Link_array cols); + static void set_explicit_neighbor_columns (Link_array cols); + static void set_implicit_neighbor_columns (Link_array cols); + static void do_measure (Rational, Grob*me,Link_array *cols); + static void musical_column_spacing (Grob*,Item*,Item*, Real, Rational); + DECLARE_SCHEME_CALLBACK (set_springs, (SCM )); +}; /* + Return whether COL is fixed to its neighbors by some kind of spacing + constraint. +*/ +static bool +loose_column (Grob *l, Grob *c, Grob *r) +{ + SCM rns = c->get_grob_property ("right-neighbors"); + SCM lns = c->get_grob_property ("left-neighbors"); - The algorithm is partly taken from : + /* + If this column doesn't have a proper neighbor, we should really + make it loose, but spacing it correctly is more than we can + currently can handle. - John S. Gourlay. ``Spacing a Line of Music,'' Technical Report - OSU-CISRC-10/87-TR35, Department of Computer and Information - Science, The Ohio State University, 1987. + (this happens in the following situation: - TOO HAIRY. + | + | clef G + * - TODO: write comments - - */ -void -Spacing_spanner::do_measure (Grob*me, Link_array cols) -{ - Moment shortest; - Moment mean_shortest; + | | || + | | || + O O || + + + the column containing the clef is really loose, and should be + attached right to the first column, but that is a lot of work for + such a borderline case.) + + */ + if (!gh_pair_p (lns) || !gh_pair_p (rns)) + return false; + + Item * l_neighbor = dynamic_cast (unsmob_grob (gh_car (lns))); + Item * r_neighbor = dynamic_cast (unsmob_grob (gh_car (rns))); + + if (!l_neighbor || !r_neighbor) + return false; + + l_neighbor = l_neighbor->column_l(); + r_neighbor = dynamic_cast (Note_spacing::right_column (r_neighbor)); + + if (l == l_neighbor && r == r_neighbor) + return false; + + if (!l_neighbor || !r_neighbor) + return false; /* - space as if this duration is present. - */ - Moment base_shortest_duration = *unsmob_moment (me->get_grob_property ("maximum-duration-for-spacing")); - shortest.set_infinite (1); + Only declare loose if the bounds make a little sense. This means + some cases (two isolated, consecutive clef changes) won't be + nicely folded, but hey, then don't do that. + */ + if ((Paper_column::musical_b (l_neighbor) || Item::breakable_b (l_neighbor)) + && (Paper_column::musical_b (r_neighbor) || Item::breakable_b (r_neighbor))) + { + return true; + } - int n = 0; - for (int i =0 ; i < cols.size (); i++) + + /* + If in doubt: we're not loose; the spacing engine should space for + it, risking suboptimal spacing. + + (Otherwise, we might risk core dumps, and other weird stuff.) + + */ + return false; +} + +/* + Remove columns that are not tightly fitting from COLS. In the + removed columns, set 'between-cols to the columns where it is in + between. +*/ +void +Spacing_spanner::prune_loose_colunms (Grob*me,Link_array *cols, Rational shortest) +{ + Link_array newcols; + Real increment = gh_scm2double (me->get_grob_property ("spacing-increment")); + for (int i=0; i < cols->size (); i++) { - if (dynamic_cast (cols[i])->musical_b ()) + if (Item::breakable_b (cols->elem(i)) || Paper_column::musical_b (cols->elem (i))) { - SCM st = cols[i]->get_grob_property ("shortest-starter-duration"); - Moment this_shortest = *unsmob_moment(st); - shortest = shortest elem(i)); + continue; + } + + Grob *c = cols->elem(i); + if (loose_column (cols->elem (i-1), c, cols->elem (i+1))) + { + SCM lns = c->get_grob_property ("left-neighbors"); + lns = gh_pair_p (lns) ? gh_car (lns) : SCM_BOOL_F; + + SCM rns = c->get_grob_property ("right-neighbors"); + rns = gh_pair_p (rns) ? gh_car (rns) : SCM_BOOL_F; + + /* + Either object can be non existent, if the score ends + prematurely. + */ + rns = gh_car (unsmob_grob (rns)->get_grob_property ("right-items")); + c->set_grob_property ("between-cols", gh_cons (lns, + rns)); + + /* + Set distance constraints for loose columns + */ + Drul_array next_door; + next_door[LEFT] =cols->elem (i - 1); + next_door[RIGHT] =cols->elem (i + 1); + Direction d = LEFT; + Drul_array dists(0,0); + + do { - n++; - mean_shortest += this_shortest; + dists[d] = 0.0; + Item *lc = dynamic_cast ((d == LEFT) ? next_door[LEFT] : c); + Item *rc = dynamic_cast (d == LEFT ? c : next_door[RIGHT]); + + for (SCM s = lc->get_grob_property ("spacing-wishes"); + gh_pair_p (s); s = gh_cdr (s)) + { + Grob *sp = unsmob_grob (gh_car (s)); + if (Note_spacing::left_column (sp) != lc + || Note_spacing::right_column (sp) != rc) + continue; + + Real space, fixed; + fixed = 0.0; + bool dummy; + + if (d == LEFT) + { + /* + The note spacing should be taken from the musical + columns. + + */ + Real base = note_spacing (me, lc, rc, shortest, &dummy); + Note_spacing::get_spacing (sp, rc, base, increment, &space, &fixed); + + space -= increment; + + dists[d] = dists[d] >? space; + } + else + { + Real space, fixed_space; + Staff_spacing::get_spacing_params (sp, + &space, &fixed_space); + + dists[d] = dists[d] >? fixed_space; + } + + } } + while (flip (&d) != LEFT); + + Rod r; + r.distance_f_ = dists[LEFT] + dists[RIGHT]; + r.item_l_drul_[LEFT] = dynamic_cast (cols->elem(i-1)); + r.item_l_drul_[RIGHT] = dynamic_cast (cols->elem (i+1)); + + r.add_to_cols (); + } + else + { + newcols.push (c); } } - mean_shortest /= n; + *cols = newcols; +} - for (int i= 0; i < cols.size () - 1; i++) +/* + Set neighboring columns determined by the spacing-wishes grob property. +*/ +void +Spacing_spanner::set_explicit_neighbor_columns (Link_array cols) +{ + for (int i=0; i < cols.size(); i++) { - Item * l = dynamic_cast (cols[i]); - Item * r = dynamic_cast (cols[i+1]); - Item * lb = dynamic_cast ( l->find_prebroken_piece (RIGHT)); - Item * rb = dynamic_cast ( r->find_prebroken_piece (LEFT)); + SCM right_neighbors = SCM_EOL; + int min_rank = 100000; // inf. - Item* combinations[4][2]={{l,r}, {lb,r}, {l,rb},{lb,rb}}; + SCM wishes= cols[i]->get_grob_property ("spacing-wishes"); + for (SCM s =wishes; gh_pair_p (s); s = gh_cdr (s)) + { + Item * wish = dynamic_cast (unsmob_grob (gh_car (s))); - /* - left refers to the space that is associated with items of the left column, so you have + Item * lc = wish->column_l (); + Grob * right = Note_spacing::right_column (wish); - LC <- left_space -><- right_space -> RC - <- total space -> - - - typically, right_space is non-zero when there are - accidentals in RC - - */ - for (int j=0; j < 4; j++) - { - Paper_column * lc = dynamic_cast (combinations[j][0]); - Paper_column *rc = dynamic_cast (combinations[j][1]); - if (!lc || !rc) + if (!right) continue; - Spring s; - s.item_l_drul_[LEFT] = lc; - s.item_l_drul_[RIGHT] = rc; - - SCM hint = lc->get_grob_property ("extra-space"); - SCM next_hint = rc->get_grob_property ("extra-space"); - SCM stretch_hint = lc->get_grob_property ("stretch-distance"); - SCM next_stretch_hint = rc->get_grob_property ("stretch-distance"); + Item * rc = dynamic_cast (right); - Real left_distance = 0; - if (gh_pair_p (hint)) + int right_rank = Paper_column::rank_i (rc); + int left_rank = Paper_column::rank_i (lc); + + /* + update the left column. + */ + if (right_rank <= min_rank) { - left_distance = gh_scm2double (gh_cdr (hint)); + if (right_rank < min_rank) + right_neighbors =SCM_EOL; + + min_rank = right_rank; + right_neighbors = gh_cons (wish->self_scm (), right_neighbors); } - // 2nd condition should be (i+1 < col_count()), ie. not the last column in score. FIXME - else if (!lc->musical_b() && i+1 < cols.size ()) + + /* + update the right column of the wish. + */ + int maxrank = 0; + SCM left_neighs = rc->get_grob_property ("left-neighbors"); + if (gh_pair_p (left_neighs) + && unsmob_grob (gh_car (left_neighs))) { - left_distance= default_bar_spacing (me,lc,rc,shortest (unsmob_grob (gh_car (left_neighs))); + maxrank = Paper_column::rank_i (it->column_l()); } - else if (lc->musical_b()) + + if (left_rank >= maxrank) { - left_distance = note_spacing (me,lc, rc, shortest maxrank) + left_neighs = SCM_EOL; + + left_neighs = gh_cons (wish->self_scm (), left_neighs); + rc->set_grob_property ("left-neighbors", right_neighbors); } - else - programming_error ("uninitialised left_distance"); - - s.distance_f_ = left_distance; + } - /* - Only do tight spaces *after* barlines (breakable columns), - not before. + if (gh_pair_p (right_neighbors)) + { + cols[i]->set_grob_property ("right-neighbors", right_neighbors); + } + } +} - We want the space before barline to be like the note - spacing in the measure. - */ - SCM sfac =lc->get_grob_property ("space-factor"); - if (Item::breakable_b (lc) || lc->original_l_) - { - s.strength_f_ = - gh_scm2double (lc->get_grob_property ("column-space-strength")); - } - else if (gh_number_p (sfac)) - left_distance *= gh_scm2double (sfac); +/* + Set neighboring columns that have no left/right-neighbor set + yet. Only do breakable non-musical columns, and musical columns. +*/ +void +Spacing_spanner::set_implicit_neighbor_columns (Link_array cols) +{ + for (int i = 0; i < cols.size (); i++) + { + Item * it = dynamic_cast(cols[i]); + if (!Item::breakable_b (it) && !Paper_column::musical_b (it)) + continue; + + // it->breakable || it->musical + + /* + sloppy with typnig left/right-neighbors should take list, but paper-column found instead. + */ + SCM ln = cols[i] ->get_grob_property ("left-neighbors"); + if (!gh_pair_p (ln) && i ) + { + cols[i]->set_grob_property ("left-neighbors", gh_cons (cols[i-1]->self_scm(), SCM_EOL)); + } + + SCM rn = cols[i] ->get_grob_property ("right-neighbors"); + if (!gh_pair_p (rn) && i < cols.size () - 1) + { + cols[i]->set_grob_property ("right-neighbors", gh_cons (cols[i + 1]->self_scm(), SCM_EOL)); + } + } +} + + +MAKE_SCHEME_CALLBACK (Spacing_spanner, set_springs,1); +SCM +Spacing_spanner::set_springs (SCM smob) +{ + Grob *me = unsmob_grob (smob); + + Link_array all (me->pscore_l_->line_l_->column_l_arr ()) ; + + set_explicit_neighbor_columns (all); + + Rational global_shortest = find_shortest (all); + prune_loose_colunms (me, &all, global_shortest); + set_implicit_neighbor_columns (all); + + + int j = 0; + for (int i = 1; i < all.size (); i++) + { + Grob *sc = all[i]; + if (Item::breakable_b (sc)) + { + Link_array measure (all.slice (j, i+1)); + do_measure (global_shortest, me, &measure); + j = i; + } + } + + return SCM_UNSPECIFIED; +} + + +/* + We want the shortest note that is also "common" in the piece, so we + find the shortest in each measure, and take the most frequently + found duration. + + This probably gives weird effects with modern music, where every + note has a different duration, but hey, don't write that kind of + stuff, then. + +*/ +Rational +Spacing_spanner::find_shortest (Link_array const &cols) +{ + /* + ascending in duration + */ + Array durations; + Array counts; + + Rational shortest_in_measure; + shortest_in_measure.set_infinite (1); + + for (int i =0 ; i < cols.size (); i++) + { + if (Paper_column::musical_b (cols[i])) + { + Moment *when = unsmob_moment (cols[i]->get_grob_property ("when")); + /* + ignore grace notes for shortest notes. + */ + if (when && when->grace_part_) + continue; - Real right_dist = 0.0; - if (gh_pair_p (next_hint)) + SCM st = cols[i]->get_grob_property ("shortest-starter-duration"); + Moment this_shortest = *unsmob_moment (st); + assert (this_shortest.to_bool()); + shortest_in_measure = shortest_in_measure shortest_in_measure) + { + counts.insert (1, j); + durations.insert (shortest_in_measure, j); + break; + } + else if (durations[j] == shortest_in_measure) + { + counts[j]++; + break; + } } - else + + if (durations.size() == j) { - Interval ext (rc->extent (rc, X_AXIS)); - right_dist = ext.empty_b() ? 0.0 : - ext [LEFT]; + durations.push (shortest_in_measure); + counts.push (1); } + shortest_in_measure.set_infinite(1); + } + } + + int max_idx = -1; + int max_count = 0; + for (int i =durations.size(); i--;) + { + if (counts[i] >= max_count) + { + max_idx = i; + max_count = counts[i]; + } + + // printf ("Den %d/%d, c %d\n", durations[i].num (), durations[i].den (), counts[i]); + } + + /* + TODO: 1/8 should be adjustable? + */ + Rational d = Rational (1,8); + if (max_idx >= 0) + d = d *cols) +{ + + Real headwid = gh_scm2double (me->get_grob_property ("spacing-increment")); + for (int i= 0; i < cols->size () - 1; i++) + { + Item * l = dynamic_cast (cols->elem (i)); + Item * r = dynamic_cast (cols->elem (i+1)); + + Paper_column * lc = dynamic_cast (l); + Paper_column * rc = dynamic_cast (r); + + if (!Paper_column::musical_b (l)) + { + breakable_column_spacing (me, l, r, shortest); + /* - don't want to create too much extra space for accidentals - */ - if (rc->musical_b ()) - { - if (to_boolean (rc->get_grob_property ("contains-grace"))) - right_dist *= gh_scm2double (rc->get_grob_property ("before-grace-spacing-factor")); // fixme. - else - right_dist *= gh_scm2double (lc->get_grob_property ("before-musical-spacing-factor")); - } - - s.distance_f_ = left_distance + right_dist; - Real stretch_dist = 0.; - if (gh_number_p (stretch_hint)) - stretch_dist += gh_scm2double (stretch_hint); - else - stretch_dist += left_distance; + The case that the right part is broken as well is rather + rare, but it is possible, eg. with a single empty measure, + or if one staff finishes a tad earlier than the rest. + + */ + Item *lb = l->find_prebroken_piece (RIGHT); + Item *rb = r->find_prebroken_piece (LEFT); - if (gh_pair_p (next_stretch_hint)) - // see regtest spacing-tight - stretch_dist += - gh_scm2double (gh_car (next_stretch_hint)); - else - stretch_dist += right_dist; + if (lb) + breakable_column_spacing (me, lb,r, shortest); - if (s.distance_f_ <0) - { - programming_error("Negative dist, setting to 1.0 PT"); - s.distance_f_ = 1.0; - } - if (stretch_dist == 0.0) - { - /* - \bar "". We give it 0 space, with high strength. - */ - s.strength_f_ = 20.0; - } - else - s.strength_f_ /= stretch_dist; + if (rb) + breakable_column_spacing (me, l, rb, shortest); + if (lb && rb) + breakable_column_spacing (me, lb, rb, shortest); - s.add_to_cols (); + continue ; } - } - + + + musical_column_spacing (me, lc, rc, headwid, shortest); + if (Item *rb = r->find_prebroken_piece (LEFT)) + musical_column_spacing (me, lc, rb, headwid, shortest); + } } -/** - Do something if breakable column has no spacing hints set. + +/* + Generate the space between two musical columns LC and RC, given spacing parameters INCR and SHRTEST. */ -Real -Spacing_spanner::default_bar_spacing (Grob*me, Grob *lc, Grob *rc, - Moment shortest) +void +Spacing_spanner::musical_column_spacing (Grob *me, Item * lc, Item *rc, Real increment, Rational shortest) { - Real symbol_distance = lc->extent (lc,X_AXIS)[RIGHT] ; - Real durational_distance = 0; - Moment delta_t = Paper_column::when_mom (rc) - Paper_column::when_mom (lc); + bool expand_only = false; + Real base_note_space = note_spacing (me, lc, rc, shortest, &expand_only); + + Real max_note_space = -infinity_f; + Real max_fixed_note_space = -infinity_f; + + SCM seq = lc->get_grob_property ("right-neighbors"); /* - ugh should use shortest_playing distance + We adjust the space following a note only if the next note + happens after the current note (this is set in the grob + property SPACING-SEQUENCE. */ - if (delta_t) + for (SCM s = seq; gh_pair_p (s); s = ly_cdr (s)) + { + Grob * wish = unsmob_grob (gh_car (s)); + + Item *wish_rcol = Note_spacing::right_column (wish); + if (Note_spacing::left_column (wish) != lc + || (wish_rcol != rc && wish_rcol != rc->original_l_)) + continue; + + /* + This is probably a waste of time in the case of polyphonic + music. */ + if (Note_spacing::has_interface (wish)) + { + Real space =0.0; + Real fixed =0.0; + + Note_spacing::get_spacing (wish, rc, base_note_space, increment, &space, &fixed); + max_note_space = max_note_space >? space; + max_fixed_note_space = max_fixed_note_space >? fixed; + } + + } + + if (max_note_space < 0) { - durational_distance = get_duration_space (me, delta_t, shortest); + max_note_space = base_note_space; + max_fixed_note_space = increment; } - return symbol_distance >? durational_distance; + Spaceable_grob::add_spring (lc, rc, max_note_space, 1 / (max_note_space -max_fixed_note_space), expand_only); } +void +Spacing_spanner::standard_breakable_column_spacing (Grob * me, Item*l, Item*r, + Real * fixed, Real * space, + Moment shortest) +{ + *fixed = l->extent (l, X_AXIS)[RIGHT] - r->extent (r, X_AXIS)[LEFT]; + + if (l->breakable_b (l) && r->breakable_b(r)) + { + Moment *dt = unsmob_moment (l->get_grob_property ("measure-length")); + Moment mlen (1); + if (dt) + mlen = *dt; + + Real incr = gh_scm2double (me->get_grob_property ("spacing-increment")); + + *space = *fixed + incr * double (mlen.main_part_ / shortest.main_part_) * 0.8; + } + else + { + Moment dt = Paper_column::when_mom (r) - Paper_column::when_mom (l); + bool dummy; -/** - Get the measure wide ant for arithmetic spacing. + *space = *fixed + get_duration_space (me, dt, shortest.main_part_, &dummy); + } + + +} - @see - John S. Gourlay. ``Spacing a Line of Music,'' Technical Report - OSU-CISRC-10/87-TR35, Department of Computer and Information Science, - The Ohio State University, 1987. - */ -Real -Spacing_spanner::get_duration_space (Grob*me, Moment d, Moment shortest) +/* + Read hints from L and generate springs. + */ +void +Spacing_spanner::breakable_column_spacing (Grob*me, Item* l, Item *r,Moment shortest) { - Real log = log_2 (shortest); - Real k = gh_scm2double (me->get_grob_property ("arithmetic-basicspace")) - - log; + Real max_fixed = -infinity_f; + Real max_space = -infinity_f; + + standard_breakable_column_spacing (me, l, r, &max_fixed, &max_space , + shortest); - return (log_2 (d) + k) * gh_scm2double (me->get_grob_property ("arithmetic-multiplier")); + for (SCM s = l->get_grob_property ("spacing-wishes"); + gh_pair_p (s); s = gh_cdr (s)) + { + Item * spacing_grob = dynamic_cast (unsmob_grob (gh_car (s))); + + if (!spacing_grob || !Staff_spacing::has_interface (spacing_grob)) + continue; + + Real space; + Real fixed_space; + + /* + column for the left one settings should be ok due automatic + pointer munging. + + */ + assert (spacing_grob-> column_l () == l); + + Staff_spacing::get_spacing_params (spacing_grob, + &space, &fixed_space); + if (space > max_space) + { + max_space = space; + max_fixed = fixed_space; + } + } + + + + + if (isinf (max_space)) + { + programming_error ("No pref spacing found"); + max_space = 2.0; + max_fixed = 1.0; + } + + + if (l->break_status_dir() == RIGHT + && Paper_column::when_mom (l) == Paper_column::when_mom (r)) + { + /* Start of line: this space is not stretchable */ + max_fixed = max_space; + } + + /* + Hmm. we do 1/0 in the next thing. Perhaps we should check if this + works on all architectures. + */ + + Spaceable_grob::add_spring (l, r, max_space, 1/(max_space - max_fixed), false); } +/** + Get the measure wide ant for arithmetic spacing. + */ +Real +Spacing_spanner::get_duration_space (Grob*me, Moment d, Rational shortest, bool * expand_only) +{ + Real k = gh_scm2double (me->get_grob_property ("shortest-duration-space")); + + if (d < shortest) + { + Rational ratio = d.main_part_ / shortest; + + *expand_only = true; + return (0.5 + 0.5 * double (ratio)) * k ; + } + else + { + /* + @see + John S. Gourlay. ``Spacing a Line of Music,'' Technical Report + OSU-CISRC-10/87-TR35, Department of Computer and Information Science, + The Ohio State University, 1987. + */ + Real log = log_2 (shortest); + k -= log; + Rational compdur = d.main_part_ + d.grace_part_ /Rational (3); + *expand_only = false; + + return (log_2 (compdur) + k) * gh_scm2double (me->get_grob_property ("spacing-increment")); + } +} + Real Spacing_spanner::note_spacing (Grob*me, Grob *lc, Grob *rc, - Moment shortest) + Moment shortest, bool * expand_only) { Moment shortest_playing_len = 0; SCM s = lc->get_grob_property ("shortest-playing-duration"); - // SCM s = lc->get_grob_property ("mean-playing-duration"); if (unsmob_moment (s)) - shortest_playing_len = *unsmob_moment(s); + shortest_playing_len = *unsmob_moment (s); - if (! shortest_playing_len) + if (! shortest_playing_len.to_bool ()) { programming_error ("can't find a ruling note at " + Paper_column::when_mom (lc).str ()); shortest_playing_len = 1; } - - if (! shortest) + + Moment lwhen = Paper_column::when_mom (lc); + Moment rwhen = Paper_column::when_mom (rc); + + Moment delta_t = rwhen - lwhen; + Real dist = 0.0; + + if (delta_t.main_part_ && !lwhen.grace_part_) { - programming_error ("no minimum in measure at " + Paper_column::when_mom (lc).str ()); - shortest = 1; + dist = get_duration_space (me, shortest_playing_len, shortest.main_part_, expand_only); + dist *= (double) (delta_t.main_part_ / shortest_playing_len.main_part_); + } + else if (delta_t.grace_part_) + { + /* + TODO: figure out how to space grace notes. + */ + dist = get_duration_space (me, shortest, shortest.main_part_, expand_only); + + Real grace_fact = 1.0; + SCM gf = me->get_grob_property ("grace-space-factor"); + if (gh_number_p (gf)) + grace_fact = gh_scm2double (gf); + + dist *= grace_fact; } - Moment delta_t = Paper_column::when_mom (rc) - Paper_column::when_mom (lc); - Real dist = get_duration_space (me, shortest_playing_len, shortest); - dist *= (double)(delta_t / shortest_playing_len); - /* - UGH: KLUDGE! - */ - if (delta_t > Moment (1,32)) - dist += stem_dir_correction (me, lc,rc); return dist; } -/** - 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. - This should be more advanced, since relative heights of the note - heads also influence required correction. +ADD_INTERFACE (Spacing_spanner,"spacing-spanner-interface", + " SPACE = arithmetic_multiplier * ( C + log2 (TIME) )) +The space taken by a note is determined by the formula - Also might not work correctly in case of multi voices or staff - changing voices - TODO: lookup correction distances? More advanced correction? - Possibly turn this off? - TODO: have to check wether the stems are in the same staff. +where TIME is the amount of time a note occupies. The value of C is +chosen such that the smallest space within a measure is +arithmetic_basicspace: - This routine reads the DIR-LIST property of both its L and R arguments. */ -Real -Spacing_spanner::stem_dir_correction (Grob*me, Grob*l, Grob*r) -{ - SCM dl = l->get_grob_property ("dir-list"); - SCM dr = r->get_grob_property ("dir-list"); - - if (scm_ilength (dl) != 1 || scm_ilength (dr) != 1) - return 0.; +C = arithmetic_basicspace - log2 (mininum (SHORTEST, 1/8)) - dl = gh_car (dl); - dr = gh_car (dr); +The smallest space is the one following the shortest note in the +measure, or the space following a hypothetical 1/8 note. Typically +arithmetic_basicspace is set to a value so that the shortest note +takes about two noteheads of space (ie, is followed by a notehead of +space): - assert (gh_number_p (dl) && gh_number_p(dr)); - int d1 = gh_scm2int (dl); - int d2 = gh_scm2int (dr); +@example +2*quartwidth = arithmetic_multiplier * ( C + log2 (SHORTEST) )) - if (d1 == d2) - return 0.0; +@{ using: C = arithmetic_basicspace - log2 (mininum (SHORTEST, 1/8)) @} +@{ assuming: SHORTEST <= 1/8 @} += arithmetic_multiplier * +( arithmetic_basicspace - log2 (SHORTEST) + log2 (SHORTEST) ) - Real correction = 0.0; - Real ssc = gh_scm2double (me->get_grob_property("stem-spacing-correction")); += arithmetic_multiplier * arithmetic_basicspace - if (d1 && d2 && d1 * d2 == -1) - { - correction = d1 * ssc; - } - else - programming_error ("Stem directions not set correctly for optical correction"); - return correction; -} - +@{ choose: arithmetic_multiplier = 1.0*quartwidth (why?) @} -MAKE_SCHEME_CALLBACK(Spacing_spanner, set_springs,1); -SCM -Spacing_spanner::set_springs (SCM smob) -{ - Grob *me = unsmob_grob (smob); - Link_array all (me->pscore_l_->line_l_->column_l_arr ()) ; += quartwidth * arithmetic_basicspace - int j = 0; +=> - for (int i = 1; i < all.size (); i++) - { - Grob *sc = all[i]; - if (Item::breakable_b (sc)) - { - Link_array measure (all.slice (j, i+1)); - do_measure (me, measure); - j = i; - } - } +arithmetic_basicspace = 2/1 = 2 - /* - farewell, cruel world - */ - me->suicide (); - return SCM_UNSPECIFIED; -} +If you want to space your music wider, use something like: +arithmetic_basicspace = 4.; + +@end example", + "spacing-increment shortest-duration-space"); -/* - maximum-duration-for-spacing -From: bf250@freenet.carleton.ca (John Sankey) -To: gnu-music-discuss@gnu.org -Subject: note spacing suggestion -Date: Mon, 10 Jul 2000 11:28:03 -0400 (EDT) - -Currently, Lily spaces notes by starting with a basic distance, -arithmetic_multiplier, which it applies to the minimum duration note -of the bar. Then she adds a logarithmic increment, scaled from -arithmetic_basicspace, for longer notes. (Then, columns are aligned -and justified.) Fundamentally, this matches visual spacing to musical -weight and works well. - -A lot of the time in music, I see a section basically in melodic -notes that occasionally has a rapid ornamental run (scale). So, there -will be a section in 1/4 notes, then a brief passage in 1/32nds, then -a return to long notes. Currently, Lily gives the same horizontal -space to the 1/32nd notes in their bar (even if set in small size as -is commonly done for cadenzii) as she gives to 1/4 notes in bars -where 1/4 note is the minimum duration. The resulting visual weight -does not match the musical weight over the page. - -Looking at the music I am typesetting, I feel that Lily's spacing -could be significantly improved if, with no change in the basic -method used, arithmetic_multiplier could be applied referred to the -same duration throughout a piece. Of course, the current method -should be retained for those who have already set music in it, so I -suggest a property called something like arithmetic_base=16 to fix -1/16 duration as the reference for arithmetic_multiplier; the default -would be a dynamic base is it is now. - -Does anyone else feel that this would be a useful improvement for -their music? (Of course, if arithmetic_multiplier became a regular -property, this could be used to achieve a similar result by -tweaking.) - - */