X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fspacing-spanner.cc;h=64eecf07586d1a419a2853739e4432c3a3200ab0;hb=4d8e2cf781aced3c294ccfad7179951f8561f856;hp=4e6ac33b70d90a3a5fa9a4b6bbfe4d4c9e2a29da;hpb=d9b43b93f2c885409bafdb157138158f65cc49aa;p=lilypond.git diff --git a/lily/spacing-spanner.cc b/lily/spacing-spanner.cc index 4e6ac33b70..64eecf0758 100644 --- a/lily/spacing-spanner.cc +++ b/lily/spacing-spanner.cc @@ -1,486 +1,939 @@ -/* - spacing-spanner.cc -- implement Spacing_spanner - +/* + spacing-spanner.cc -- implement Spacing_spanner + source file of the GNU LilyPond music typesetter - - (c) 1999--2002 Han-Wen Nienhuys - - */ -#include "spacing-spanner.hh" -#include "paper-column.hh" -#include "dimensions.hh" -#include "paper-def.hh" + (c) 1999--2005 Han-Wen Nienhuys +*/ + +#include +#include + +#include "main.hh" +#include "system.hh" #include "warn.hh" +#include "output-def.hh" #include "paper-score.hh" -#include "line-of-score.hh" +#include "paper-column.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" +#include "break-align-interface.hh" +#include "spacing-interface.hh" +#include "pointer-group-interface.hh" +#include "grob-array.hh" -void -Spacing_spanner::set_interface (Grob*me) +/* + TODO: this file/class is too complex. Should figure out how to chop + this up even more. +*/ + +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 (Grob *, Link_array const &); + static void breakable_column_spacing (Grob *, Item *l, Item *r, Moment); + static void find_loose_columns () {} + static void prune_loose_columns (Grob *, Link_array *cols, Rational); + static void find_loose_columns (Link_array cols); + static void set_explicit_neighbor_columns (Link_array const &cols); + static void set_implicit_neighbor_columns (Link_array const &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)); + static bool has_interface (Grob *); +}; /* + Return whether COL is fixed to its neighbors by some kind of spacing + constraint. - The algorithm is partly taken from : - 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. + If in doubt, then we're not loose; the spacing engine should space + for it, risking suboptimal spacing. - TOO HAIRY. - - TODO: write comments - - */ -void -Spacing_spanner::do_measure (Grob*me, Link_array const & cols) + (Otherwise, we might risk core dumps, and other weird stuff.) +*/ +static bool +loose_column (Grob *l, Grob *c, Grob *r) { - Moment shortest; - Moment mean_shortest; + extract_grob_set (c, "right-neighbors", rns); + extract_grob_set (c, "left-neighbors", lns); + + /* + 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. + + (this happens in the following situation: + + | + | clef G + * + + | | || + | | || + 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 (lns.is_empty () || rns.is_empty ()) + return false; + + Item *l_neighbor = dynamic_cast (lns[0]); + Item *r_neighbor = dynamic_cast (rns[0]); + + if (!l_neighbor || !r_neighbor) + return false; + + l_neighbor = l_neighbor->get_column (); + 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; + + /* + 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::is_musical (l_neighbor) || Item::is_breakable (l_neighbor)) + && (Paper_column::is_musical (r_neighbor) || Item::is_breakable (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); + A rather hairy check, but we really only want to move around + clefs. (anything else?) - int n = 0; - for (int i =0 ; i < cols.size (); i++) + in any case, we don't want to move bar lines. + */ + extract_grob_set (c, "elements", elts); + for (int i = elts.size (); i--; ) { - if (Paper_column::musical_b (cols[i])) + Grob *g = elts[i]; + if (g && Break_align_interface::has_interface (g)) { - Moment *when = unsmob_moment (cols[i]->get_grob_property ("when")); - - /* - ignore grace notes for shortest notes. - */ - if (when && when->grace_part_) - continue; - - SCM st = cols[i]->get_grob_property ("shortest-starter-duration"); - Moment this_shortest = *unsmob_moment (st); - shortest = shortest get_property ("break-align-symbol") == ly_symbol2scm ("staff-bar")) + return false; } } } - mean_shortest /= n; - Array springs; - for (int i= 0; i < cols.size () - 1; i++) + return true; +} + +/* + 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_columns (Grob *me, Link_array *cols, Rational shortest) +{ + Link_array newcols; + Real increment = robust_scm2double (me->get_property ("spacing-increment"), 1.2); + 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)); + if (Item::is_breakable (cols->elem (i)) || Paper_column::is_musical (cols->elem (i))) + { + newcols.push (cols->elem (i)); + continue; + } - Item* combinations[4][2]={{l,r}, {lb,r}, {l,rb},{lb,rb}}; + Grob *c = cols->elem (i); + if (loose_column (cols->elem (i - 1), c, cols->elem (i + 1))) + { + extract_grob_set (c, "right-neighbors", rns_arr); + extract_grob_set (c, "left-neighbors", lns_arr); + + SCM lns = lns_arr.size () ? lns_arr.top()->self_scm () : SCM_BOOL_F; + SCM rns = rns_arr.size () ? rns_arr.top()->self_scm () : SCM_BOOL_F; + + /* + Either object can be non existent, if the score ends + prematurely. + */ + extract_grob_set (unsmob_grob (rns), "right-items", right_items); + c->set_object ("between-cols", scm_cons (lns, + right_items[0]->self_scm ())); - /* - left refers to the space that is associated with items of the left column, so you have + /* + 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); - LC <- left_space -><- right_space -> RC - <- total space -> - + do + { + dists[d] = 0.0; + Item *lc = dynamic_cast ((d == LEFT) ? next_door[LEFT] : c); + Item *rc = dynamic_cast (d == LEFT ? c : next_door[RIGHT]); + + + extract_grob_set (lc, "spacing-wishes", wishes); + for (int k = wishes.size(); k--;) + { + Grob *sp = wishes[k]; + 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] = max (dists[d], space); + } + else + { + Real space, fixed_space; + Staff_spacing::get_spacing_params (sp, + &space, &fixed_space); + + dists[d] = max (dists[d], fixed_space); + } + } + } + while (flip (&d) != LEFT); - typically, right_space is non-zero when there are - accidentals in RC - - */ - for (int j=0; j < 4; j++) + Rod r; + r.distance_ = dists[LEFT] + dists[RIGHT]; + r.item_drul_[LEFT] = dynamic_cast (cols->elem (i - 1)); + r.item_drul_[RIGHT] = dynamic_cast (cols->elem (i + 1)); + + r.add_to_cols (); + } + else { - Paper_column * lc = dynamic_cast (combinations[j][0]); - Paper_column *rc = dynamic_cast (combinations[j][1]); - if (!lc || !rc) + newcols.push (c); + } + } + + *cols = newcols; +} + +/* + Set neighboring columns determined by the spacing-wishes grob property. +*/ +void +Spacing_spanner::set_explicit_neighbor_columns (Link_array const &cols) +{ + for (int i = 0; i < cols.size (); i++) + { + SCM right_neighbors = Grob_array::make_array (); + Grob_array *rn_arr = unsmob_grob_array (right_neighbors); + int min_rank = 100000; // inf. + + extract_grob_set (cols[i], "spacing-wishes", wishes); + for (int k = wishes.size(); k--;) + { + Item *wish = dynamic_cast ( wishes[k]); + + Item *lc = wish->get_column (); + Grob *right = Note_spacing::right_column (wish); + + 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)) - { - left_distance = gh_scm2double (ly_cdr (hint)); - } - // 2nd condition should be (i+1 < col_count ()), ie. not the last column in score. FIXME - else if (!Paper_column::musical_b (lc) && i+1 < cols.size ()) - { - left_distance= default_bar_spacing (me,lc,rc,shortest get_grob_property ("space-factor"); - if (gh_number_p (lc->get_grob_property ("column-space-strength")) - && (Item::breakable_b (lc) || lc->original_l_)) + if (right_rank <= min_rank) { - s.strength_f_ = - gh_scm2double (lc->get_grob_property ("column-space-strength")); - } - else if (gh_number_p (sfac)) - left_distance *= gh_scm2double (sfac); + if (right_rank < min_rank) + rn_arr->clear (); - - Real right_dist = 0.0; - if (gh_pair_p (next_hint)) - { - right_dist += - gh_scm2double (ly_car (next_hint)); - } - else - { - Interval ext (rc->extent (rc, X_AXIS)); - right_dist = ext.empty_b () ? 0.0 : - ext [LEFT]; + min_rank = right_rank; + rn_arr->add (wish); } /* - don't want to create too much extra space for accidentals + update the right column of the wish. */ - if (Paper_column::musical_b (rc)) - 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; - - if (gh_pair_p (next_stretch_hint)) - // see regtest spacing-tight - stretch_dist += - gh_scm2double (ly_car (next_stretch_hint)); - else - stretch_dist += right_dist; + int maxrank = 0; - if (s.distance_f_ <0) + extract_grob_set (rc, "left-neighbors", lns_arr); + if (lns_arr.size ()) { - programming_error ("Negative dist, setting to 1.0 PT"); - s.distance_f_ = 1.0; + Item *it = dynamic_cast (lns_arr.top()); + maxrank = Paper_column::get_rank (it->get_column ()); } - if (stretch_dist == 0.0) + + if (left_rank >= maxrank) { - /* - \bar "". We give it 0 space, with high strength. - */ - s.strength_f_ = 20.0; + + if (left_rank > maxrank) + { + Grob_array *ga = unsmob_grob_array (rc->get_object ("left-neighbors")); + if (ga) + ga->clear (); + } + + Pointer_group_interface::add_grob (rc, ly_symbol2scm ("left-neighbors"), wish); } - else - s.strength_f_ /= stretch_dist; - - springs.push (s); } - } - Spacing_spanner::stretch_to_regularity (me, &springs, cols); - for (int i=springs.size (); i --;) - springs[i].add_to_cols (); + if (rn_arr->size ()) + { + cols[i]->set_object ("right-neighbors", right_neighbors); + } + } } /* - Look at COLS, searching for columns that have 'regular-distance-to - set. A sequence of columns that have this property set should have - an equal distance (an equispaced run). Extract the projected - distance from SPRINGS, and scale SPRINGS for the equispaced run, to the - widest space necessary. + 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 const &cols) +{ + for (int i = 0; i < cols.size (); i++) + { + Item *it = dynamic_cast (cols[i]); + if (!Item::is_breakable (it) && !Paper_column::is_musical (it)) + continue; + // it->breakable || it->musical - TODO: - - -- inefficient code; maybe it is easier to twiddle with the springs - after they've become grob properties (ie. have their - minimum-distances set) + /* + sloppy with typing left/right-neighbors should take list, but paper-column found instead. + */ + extract_grob_set (cols[i], "left-neighbors", lns); + if (lns.is_empty () && i ) + { + SCM ga_scm = Grob_array::make_array(); + Grob_array *ga = unsmob_grob_array (ga_scm); + ga->add (cols[i-1]); + cols[i]->set_object ("left-neighbors", ga_scm); + } + extract_grob_set (cols[i], "right-neighbors", rns); + if (rns.is_empty () && i < cols.size () - 1) + { + SCM ga_scm = Grob_array::make_array(); + Grob_array *ga = unsmob_grob_array (ga_scm); + ga->add (cols[i+1]); + cols[i]->set_object ("right-neighbors", ga_scm); + } + } +} - -- does not adjust strength field of the springs very well: result - awkward spacing at the start of a line. (?) +MAKE_SCHEME_CALLBACK (Spacing_spanner, set_springs, 1); +SCM +Spacing_spanner::set_springs (SCM smob) +{ + Grob *me = unsmob_grob (smob); - -- will be confused when there are multiple equispaced runs in a measure. + /* + can't use get_system() ? --hwn. + */ + Link_array all (me->pscore_->root_system ()->columns ()); - -- dealing with springs for line breaks is a little tricky; in any - case, we will only space per measure. + set_explicit_neighbor_columns (all); - -- we scale to actual distances, not to optical effects. Eg. if the - equispaced run contains optical corrections, then the scaling will - cancel those. + SCM preset_shortest = me->get_property ("common-shortest-duration"); + Rational global_shortest; + if (unsmob_moment (preset_shortest)) + { + global_shortest = unsmob_moment (preset_shortest)->main_part_; + } + else + { + global_shortest = find_shortest (me, all); + if (be_verbose_global) + message (_f ("Global shortest duration is %s", global_shortest.to_string ()) + "\n"); + } + prune_loose_columns (me, &all, global_shortest); + set_implicit_neighbor_columns (all); - -- Regular_spacing_engraver doesn't mark the first column of the - next bar, making the space before a barline too short, in this case + int j = 0; + for (int i = 1; i < all.size (); i++) + { + Grob *sc = all[i]; + if (Item::is_breakable (sc)) + { + Link_array measure (all.slice (j, i + 1)); + do_measure (global_shortest, me, &measure); + j = i; + } + } + return SCM_UNSPECIFIED; +} - x<- 16ths--> x(8th) - x(8th) x(8th) <- equispaced run. - +/* + 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 (Grob *me, 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::is_musical (cols[i])) + { + Moment *when = unsmob_moment (cols[i]->get_property ("when")); + + /* + ignore grace notes for shortest notes. + */ + if (when && when->grace_part_) + continue; + + SCM st = cols[i]->get_property ("shortest-starter-duration"); + Moment this_shortest = *unsmob_moment (st); + assert (this_shortest.to_bool ()); + shortest_in_measure = min (shortest_in_measure, this_shortest.main_part_); + } + else if (!shortest_in_measure.is_infinity () + && Item::is_breakable (cols[i])) + { + int j = 0; + for (; j < durations.size (); j++) + { + if (durations[j] > shortest_in_measure) + { + counts.insert (1, j); + durations.insert (shortest_in_measure, j); + break; + } + else if (durations[j] == shortest_in_measure) + { + counts[j]++; + break; + } + } + + if (durations.size () == j) + { + 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 ("duration %d/%d, count %d\n", durations[i].num (), durations[i].den (), counts[i]); + } + + SCM bsd = me->get_property ("base-shortest-duration"); + Rational d = Rational (1, 8); + if (Moment *m = unsmob_moment (bsd)) + d = m->main_part_; + + if (max_idx >= 0) + d = min (d, durations[max_idx]); + + return d; +} + +/* + Generate spacing for a single measure. We used to have code that did + per-measure spacing. Now we have piecewise spacing. We should fix + this to support "spacing-regions": some regions have different notes + (different time sigs) than others, and should be spaced differently. +*/ void -Spacing_spanner::stretch_to_regularity (Grob *me, - Array * springs, - Link_array const & cols) +Spacing_spanner::do_measure (Rational global_shortest, Grob *me, + Link_array *cols) { - /* - Find the starting column of the run. REGULAR-DISTANCE-TO points - back to a previous column, so we look ahead to find a column - pointing back to the first one. - - */ - Grob * first_regular_spaced_col = 0; - for (int i = 0 ; i < cols.size () && !first_regular_spaced_col; i++) + Real headwid = robust_scm2double (me->get_property ("spacing-increment"), 1); + for (int i = 0; i < cols->size () - 1; i++) { - SCM rdt = cols[i]->get_grob_property ("regular-distance-to"); - if (cols.find_l (unsmob_grob (rdt))) - first_regular_spaced_col = unsmob_grob (rdt); + 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::is_musical (l)) + { + musical_column_spacing (me, lc, rc, headwid, global_shortest); + if (Item *rb = r->find_prebroken_piece (LEFT)) + musical_column_spacing (me, lc, rb, headwid, global_shortest); + } + else + { + /* + 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 (i == 0 && Paper_column::get_rank (l) == 0) + l = 0; + + if (l && r) + breakable_column_spacing (me, l, r, global_shortest); + + if (lb && r) + breakable_column_spacing (me, lb, r, global_shortest); + + if (l && rb) + breakable_column_spacing (me, l, rb, global_shortest); + + if (lb && rb) + breakable_column_spacing (me, lb, rb, global_shortest); + } } - for (int i = springs->size (); i-- ;) - springs->elem (i).set_to_cols (); - - int i; - for (i = 0; i < springs->size () - && springs->elem (i).item_l_drul_[RIGHT] != first_regular_spaced_col; - i++) - ; - - - if (i==springs->size ()) - return ; - - Real maxdist = 0.0; - Real dist =0.0; - Grob *last_col = first_regular_spaced_col; - Grob *last_regular_spaced_col = first_regular_spaced_col; - +} + +/* + Generate the space between two musical columns LC and RC, given + spacing parameters INCR and SHORTEST. +*/ +void +Spacing_spanner::musical_column_spacing (Grob *me, Item *lc, Item *rc, Real increment, Rational global_shortest) +{ + bool expand_only = false; + Real base_note_space = note_spacing (me, lc, rc, global_shortest, &expand_only); + + Real compound_note_space = 0.0; + Real compound_fixed_note_space = 0.0; + int wish_count = 0; + + extract_grob_set (lc, "right-neighbors", neighbors); /* - find the max distance for this run. - */ - for (int j = i; j < springs->size (); j++) + 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. + */ + for (int i = 0; i < neighbors.size (); i++) { - Spring *s = &(springs->elem_ref (j)); - if (s->item_l_drul_[LEFT] != last_col) + Grob *wish = neighbors[i]; + + Item *wish_rcol = Note_spacing::right_column (wish); + if (Note_spacing::left_column (wish) != lc + || (wish_rcol != rc && wish_rcol != rc->original_)) continue; - - dist += s->distance_f_; - last_col = s->item_l_drul_[RIGHT]; - SCM rdt = last_col->get_grob_property ("regular-distance-to"); - if (unsmob_grob (rdt) == last_regular_spaced_col) + /* + This is probably a waste of time in the case of polyphonic + music. */ + if (Note_spacing::has_interface (wish)) { - maxdist = maxdist >? dist; - dist = 0.0; - last_regular_spaced_col = last_col; + Real space = 0.0; + Real fixed = 0.0; + + Note_spacing::get_spacing (wish, rc, base_note_space, increment, &space, &fixed); + + compound_note_space = compound_note_space + space; + compound_fixed_note_space = compound_fixed_note_space + fixed; + wish_count++; } + } + if (Paper_column::when_mom (rc).grace_part_ + && !Paper_column::when_mom (lc).grace_part_) + { + /* + Ugh. 0.8 is arbitrary. + */ + compound_note_space *= 0.8; + } + + if (compound_note_space < 0 || wish_count == 0) + { + compound_note_space = base_note_space; + compound_fixed_note_space = increment; + } + else + { + compound_note_space /= wish_count; + compound_fixed_note_space /= wish_count; } /* - Scale the springs - */ - dist =0.0; - last_col = first_regular_spaced_col; - last_regular_spaced_col = first_regular_spaced_col; - for (int j = i; j < springs->size (); j++) + Whatever we do, the fixed space is smaller than the real + space. + + TODO: this criterion is discontinuous in the derivative. + Maybe it should be continuous? + */ + compound_fixed_note_space = min (compound_fixed_note_space, compound_note_space); + + bool packed = to_boolean (me->get_layout ()->c_variable ("packed")); + Real inverse_strength = 1.0; + Real distance = 1.0; + + /* + TODO: make sure that the space doesn't exceed the right margin. + */ + if (packed) { - Spring *s = &springs->elem_ref (j); - if (s->item_l_drul_[LEFT] != last_col) - continue; - dist += s->distance_f_; + /* + In packed mode, pack notes as tight as possible. This makes + sense mostly in combination with raggedright mode: the notes + are then printed at minimum distance. This is mostly useful + for ancient notation, but may also be useful for some flavours + of contemporary music. If not in raggedright mode, lily will + pack as much bars of music as possible into a line, but the + line will then be stretched to fill the whole linewidth. + */ + inverse_strength = 1.0; + distance = compound_fixed_note_space; + } + else + { + inverse_strength = (compound_note_space - compound_fixed_note_space); + distance = compound_note_space; + } + + Spaceable_grob::add_spring (lc, rc, distance, inverse_strength); +} + +/* + The one-size-fits all spacing. It doesn't take into account + different spacing wishes from one to the next column. +*/ +void +Spacing_spanner::standard_breakable_column_spacing (Grob *me, Item *l, Item *r, + Real *fixed, Real *space, + Moment shortest) +{ + *fixed = 0.0; + Direction d = LEFT; + Drul_array cols (l, r); - last_col = s->item_l_drul_[RIGHT]; - SCM rdt = last_col->get_grob_property ("regular-distance-to"); - if (unsmob_grob (rdt) == last_regular_spaced_col) + do + { + if (!Paper_column::is_musical (cols[d])) { - do { - springs->elem_ref (i).distance_f_ *= maxdist / dist; - springs->elem_ref (i).strength_f_ *= dist / maxdist; - } while (i++ < j); - last_regular_spaced_col = last_col; - dist =0.0; + /* + Tied accidentals over barlines cause problems, so lets see + what happens if we do this for non musical columns only. + */ + Interval lext = cols[d]->extent (cols [d], X_AXIS); + if (!lext.is_empty ()) + *fixed += -d * lext[-d]; + } + } + while (flip (&d) != LEFT); + + if (l->is_breakable (l) && r->is_breakable (r)) + { + Moment *dt = unsmob_moment (l->get_property ("measure-length")); + Moment mlen (1); + if (dt) + mlen = *dt; + + Real incr = robust_scm2double (me->get_property ("spacing-increment"), 1); + + *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); + + if (dt == Moment (0, 0)) + { + /* + In this case, Staff_spacing should handle the job, + using dt when it is 0 is silly. + */ + *space = *fixed + 0.5; + } + else + { + bool dummy; + *space = *fixed + get_duration_space (me, dt, shortest.main_part_, &dummy); } } } -/** - Do something if breakable column has no spacing hints set. - */ -Real -Spacing_spanner::default_bar_spacing (Grob*me, Grob *lc, Grob *rc, - Moment shortest) +/* + Read hints from L and generate springs. +*/ +void +Spacing_spanner::breakable_column_spacing (Grob *me, Item *l, Item *r, Moment 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); + Real compound_fixed = 0.0; + Real compound_space = 0.0; + int wish_count = 0; - /* - ugh should use shortest_playing distance - */ - if (delta_t.to_bool ()) + Moment dt = Paper_column::when_mom (r) - Paper_column::when_mom (l); + + if (dt == Moment (0, 0)) { - durational_distance = get_duration_space (me, delta_t, shortest); + extract_grob_set (l, "spacing-wishes", wishes); + + for (int i = 0; i < wishes.size (); i++) + { + Item *spacing_grob = dynamic_cast (wishes[i]); + + 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->get_column () == l); + + Staff_spacing::get_spacing_params (spacing_grob, + &space, &fixed_space); + + if (Paper_column::when_mom (r).grace_part_) + { + /* + Correct for grace notes. + + Ugh. The 0.8 is arbitrary. + */ + space *= 0.8; + } + + compound_space += space; + compound_fixed += fixed_space; + wish_count++; + } } - return symbol_distance >? durational_distance; -} + if (compound_space <= 0.0 || !wish_count) + { + standard_breakable_column_spacing (me, l, r, &compound_fixed, &compound_space, + shortest); + wish_count = 1; + } + else + { + compound_space /= wish_count; + compound_fixed /= wish_count; + } + assert (!isinf (compound_space)); + compound_space = max (compound_space, compound_fixed); -/** - Get the measure wide ant for arithmetic spacing. + /* + There used to be code that changed spacing depending on + raggedright setting. Ugh. - @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. + Do it more cleanly, or rename the property. */ + Real inverse_strength = (compound_space - compound_fixed); + Real distance = compound_space; + Spaceable_grob::add_spring (l, r, distance, inverse_strength); +} + +/** + Get the measure wide ant for arithmetic spacing. +*/ Real -Spacing_spanner::get_duration_space (Grob*me, Moment d, Moment shortest) +Spacing_spanner::get_duration_space (Grob *me, Moment d, Rational shortest, bool *expand_only) { - Real log = log_2 (shortest.main_part_); - Real k = gh_scm2double (me->get_grob_property ("arithmetic-basicspace")) - - log; + Real k = robust_scm2double (me->get_property ("shortest-duration-space"), 1); + Real incr = robust_scm2double (me->get_property ("spacing-increment"), 1); - Rational compdur = d.main_part_ + d.grace_part_ / Rational (3); - return (log_2 (compdur) + k) * gh_scm2double (me->get_grob_property ("arithmetic-multiplier")); -} + if (d < shortest) + { + /* + We don't space really short notes using the log of the + duration, since it would disproportionally stretches the long + notes in a piece. In stead, we use geometric spacing with constant 0.5 + (i.e. linear.) + This should probably be tunable, to use other base numbers. + + In Mozart hrn3 by EB., we have 8th note = 3.9 mm (total), 16th note = + 3.6 mm (total). head-width = 2.4, so we 1.2mm for 16th, 1.5 + mm for 8th. (white space), suggesting that we use + + (1.2 / 1.5)^{-log2(duration ratio)} + + + */ + Rational ratio = d.main_part_ / shortest; + + return ((k - 1) + double (ratio)) * incr; + } + else + { + /* + 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) * incr; + } +} Real -Spacing_spanner::note_spacing (Grob*me, Grob *lc, Grob *rc, - Moment shortest) +Spacing_spanner::note_spacing (Grob *me, Grob *lc, Grob *rc, + Moment shortest, bool *expand_only) { Moment shortest_playing_len = 0; - SCM s = lc->get_grob_property ("shortest-playing-duration"); + SCM s = lc->get_property ("shortest-playing-duration"); - // SCM s = lc->get_grob_property ("mean-playing-duration"); if (unsmob_moment (s)) shortest_playing_len = *unsmob_moment (s); - + if (! shortest_playing_len.to_bool ()) { - programming_error ("can't find a ruling note at " + Paper_column::when_mom (lc).str ()); + programming_error ("can't find a ruling note at " + Paper_column::when_mom (lc).to_string ()); shortest_playing_len = 1; } - - if (! shortest.to_bool ()) - { - programming_error ("no minimum in measure at " + Paper_column::when_mom (lc).str ()); - shortest = 1; - } - Moment delta_t = Paper_column::when_mom (rc) - Paper_column::when_mom (lc); - Real dist = get_duration_space (me, shortest_playing_len, shortest); + Moment lwhen = Paper_column::when_mom (lc); + Moment rwhen = Paper_column::when_mom (rc); - /* - ugh: 0.1 is an arbitrary distance. - */ - dist *= (double) (delta_t.main_part_ / shortest_playing_len.main_part_) - + 0.1 * (double) (delta_t.grace_part_ / shortest_playing_len.main_part_); + Moment delta_t = rwhen - lwhen; + if (!Paper_column::is_musical (rc)) + { + /* + when toying with mmrests, it is possible to have musical + column on the left and non-musical on the right, spanning + several measures. + */ + Moment *dt = unsmob_moment (rc->get_property ("measure-length")); + if (dt) + { + delta_t = min (delta_t, *dt); + /* + The following is an extra safety measure, such that + the length of a mmrest event doesn't cause havoc. + */ + shortest_playing_len = min (shortest_playing_len, *dt); + } + } + Real dist = 0.0; - Moment *lm = unsmob_moment (lc->get_grob_property ("when")); - Moment *rm = unsmob_moment (rc->get_grob_property ("when")); + /* + In normal situations, the next column is at most + SHORTEST_PLAYING_LEN away. However chord-tremolos do funky faking stuff + with durations, invalidating this assumption. Here we kludge + around to get chord tremolos to behave properly. - if (lm && rm) + */ + shortest_playing_len = max (shortest_playing_len, delta_t); + if (delta_t.main_part_ && !lwhen.grace_part_) { - if (lm->grace_part_ && rm->grace_part_) - dist *= 0.5; - else if (!rm->grace_part_ && lm->grace_part_) - dist *= 0.7; + 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); - - return dist; -} - -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 ()) ; - - int j = 0; + Real grace_fact + = robust_scm2double (me->get_property ("grace-space-factor"), 1); - 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; - } + dist *= grace_fact; } - /* - farewell, cruel world - */ - me->suicide (); - return SCM_UNSPECIFIED; + return dist; } +ADD_INTERFACE (Spacing_spanner, "spacing-spanner-interface", + "The space taken by a note is dependent on its duration. Doubling a\n" + "duration adds spacing-increment to the space. The most common shortest\n" + "note gets @code{shortest-duration-space}. Notes that are even shorter are\n" + "spaced proportonial to their duration.\n" + "\n" + "Typically, the increment is the width of a black note head. In a\n" + "piece with lots of 8th notes, and some 16th notes, the eighth note\n" + "gets 2 note heads width (i.e. the space following a note is 1 note\n" + "head width) A 16th note is followed by 0.5 note head width. The\n" + "quarter note is followed by 3 NHW, the half by 4 NHW, etc.\n", + + "grace-space-factor spacing-increment base-shortest-duration " + "shortest-duration-space common-shortest-duration" + + ); + +ADD_INTERFACE (Spacing_interface, "spacing-interface", + "Something to do with line breaking and spacing. " + "Kill this one after determining line breaks.", + ""); - -/* - 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.) - - */