X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;ds=sidebyside;f=lily%2Fspacing-spanner.cc;h=4cd183f9e4bd5f085d7faa12dde996183a4e23fc;hb=a6ee9dcd388111e842064a8d46ab06c4897a00d2;hp=0f639a3abee1d2337aa7a60a2dc46d4ad797c246;hpb=4fabc68182cab7149d2a4b52502e180f57199831;p=lilypond.git diff --git a/lily/spacing-spanner.cc b/lily/spacing-spanner.cc index 0f639a3abe..4cd183f9e4 100644 --- a/lily/spacing-spanner.cc +++ b/lily/spacing-spanner.cc @@ -1,170 +1,885 @@ /* - spacing-spanner.cc -- implement Spacing_spanner + spacing-spanner.cc -- implement Spacing_spanner source file of the GNU LilyPond music typesetter - (c) 1999 Han-Wen Nienhuys + (c) 1999--2002 Han-Wen Nienhuys */ -#include "spacing-spanner.hh" -#include "score-column.hh" -#include "dimensions.hh" +#include +#include + +#include "main.hh" +#include "system.hh" +#include "warn.hh" #include "paper-def.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 "p-score.hh" -#include "line-of-score.hh" - -Spacing_spanner::Spacing_spanner () -{ - set_elt_property (break_helper_only_scm_sym, SCM_BOOL_T); - set_elt_property (transparent_scm_sym, SCM_BOOL_T); -} +#include "staff-spacing.hh" +#include "spring.hh" +#include "paper-column.hh" +#include "spaceable-grob.hh" +#include "break-align-interface.hh" +#include "spacing-interface.hh" -int -Spacing_spanner::col_count () const +class Spacing_spanner { - return pscore_l_->line_l_->cols_.size (); -} +public: + static void standard_breakable_column_spacing (Grob * me, Item*l, Item*r, + Real * fixed, Real * space, Moment); + -Score_column * -Spacing_spanner::scol (int i)const -{ - return dynamic_cast (pscore_l_->line_l_->cols_[i]); -} + 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_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 )); + static bool has_interface (Grob*); +}; /* - cut 'n paste from spring-spacer.cc - */ -Array -Spacing_spanner::do_measure (int col1, int col2) const + Return whether COL is fixed to its neighbors by some kind of spacing + constraint. + + + If in doubt, then we're not loose; the spacing engine should space + for it, risking suboptimal spacing. + + (Otherwise, we might risk core dumps, and other weird stuff.) + +*/ +static bool +loose_column (Grob *l, Grob *c, Grob *r) { - for (int i =col1; i < col2; i++) + SCM rns = c->get_grob_property ("right-neighbors"); + SCM lns = c->get_grob_property ("left-neighbors"); + + /* + 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 (!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->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::musical_b (l_neighbor) || Item::breakable_b (l_neighbor)) + && (Paper_column::musical_b (r_neighbor) || Item::breakable_b (r_neighbor))) ) { - scol (i)->preprocess (); - scol (i)->print (); + return false; } - Moment shortest; - shortest.set_infinite (1); - for (int i =col1; i < col2; i++) + + /* + A rather hairy check, but we really only want to move around clefs. (anything else?) + + in any case, we don't want to move bar lines. + */ + for (SCM e = c->get_grob_property ("elements"); gh_pair_p (e); e = gh_cdr (e)) { - if (scol(i)->musical_b ()) + Grob * g = unsmob_grob (gh_car (e)); + if (g && Break_align_interface::has_interface (g)) { - shortest = shortest shortest_starter_mom_; + for (SCM s = g->get_grob_property ("elements"); gh_pair_p (s); + s = gh_cdr (s)) + { + Grob *h = unsmob_grob (gh_car (s)); + + /* + ugh. -- fix staff-bar name? + */ + if (h && h->get_grob_property ("break-align-symbol") == ly_symbol2scm ("staff-bar")) + return false; + } } } + + return true; +} - Array meas_springs; - - for (int i= col1; i < col2; i++) +/* + 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 (!scol (i)->musical_b() && i+1 < col_count()) + if (Item::breakable_b (cols->elem(i)) || Paper_column::musical_b (cols->elem (i))) { - Real symbol_distance = scol (i)->extent (X_AXIS)[RIGHT] ; - Real durational_distance = 0; - Moment delta_t = scol (i+1)->when_mom () - scol (i)->when_mom () ; + newcols.push (cols->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)); + /* - ugh should use shortest_playing distance + Set distance constraints for loose columns */ - if (delta_t) + 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 { - Real k= paper_l()->arithmetic_constant (shortest); - durational_distance = paper_l()->length_mom_to_dist (delta_t,k); + 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; + } + + } } - symbol_distance += -scol (i+1)->extent(X_AXIS)[LEFT]; + while (flip (&d) != LEFT); - Spring s ; - s.item_l_drul_[LEFT] = scol (i); - s.item_l_drul_[RIGHT] = scol (i+1); - s.distance_f_ = symbol_distance >? durational_distance; - meas_springs.push (s); + Rod r; + r.distance_ = 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)); - Item *l = s.item_l_drul_[LEFT]->find_prebroken_piece (RIGHT); - Item *r = s.item_l_drul_[RIGHT]->find_prebroken_piece (LEFT); - Spring sp_orig (s); - - if (l) + r.add_to_cols (); + } + else + { + newcols.push (c); + } + } + + *cols = newcols; +} + +/* + 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++) + { + SCM right_neighbors = SCM_EOL; + int min_rank = 100000; // inf. + + + 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))); + + Item * lc = wish->get_column (); + Grob * right = Note_spacing::right_column (wish); + + if (!right) + continue; + + Item * rc = dynamic_cast (right); + + int right_rank = Paper_column::get_rank (rc); + int left_rank = Paper_column::get_rank (lc); + + /* + update the left column. + */ + if (right_rank <= min_rank) { - s = sp_orig; - s.item_l_drul_[LEFT] =l ; - meas_springs.push (s); + if (right_rank < min_rank) + right_neighbors =SCM_EOL; + + min_rank = right_rank; + right_neighbors = gh_cons (wish->self_scm (), right_neighbors); } - if (l && r) + /* + 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))) { - s = sp_orig; - s.item_l_drul_[RIGHT] = r; - s.item_l_drul_[LEFT] = l; - meas_springs.push (s); + Item * it = dynamic_cast (unsmob_grob (gh_car (left_neighs))); + maxrank = Paper_column::get_rank (it->get_column ()); } - + + if (left_rank >= maxrank) + { + if (left_rank > maxrank) + left_neighs = SCM_EOL; + + left_neighs = gh_cons (wish->self_scm (), left_neighs); + rc->set_grob_property ("left-neighbors", right_neighbors); + } + } + + if (gh_pair_p (right_neighbors)) + { + cols[i]->set_grob_property ("right-neighbors", right_neighbors); } } +} - for (int i=col1; i < col2; i++) +/* + 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++) { - if (scol (i)->musical_b()) + 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) { - Moment shortest_playing_len = scol(i)->shortest_playing_mom_; - if (! shortest_playing_len) + 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_->system_->columns ()) ; + + set_explicit_neighbor_columns (all); + + SCM preset_shortest = me->get_grob_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 (verbose_global_b) + { + progress_indication (_f("Global shortest duration is %s\n", global_shortest.string ())); + } + } + 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 (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::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; + + 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 when_mom ().str ())); - shortest_playing_len = 1; + 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 (! shortest) + + if (durations.size() == j) { - warning (_f ("no minimum in measure at %s", - scol (i)->when_mom ().str ())); - shortest = 1; + durations.push (shortest_in_measure); + counts.push (1); } - Moment delta_t = scol (i+1)->when_mom () - scol (i)->when_mom (); - Real k= paper_l()->arithmetic_constant(shortest); - Real dist = paper_l()->length_mom_to_dist (shortest_playing_len, k); - dist *= (double)(delta_t / shortest_playing_len); + 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]; + } - Spring sp; - sp.distance_f_ = dist; - sp.item_l_drul_[LEFT] = scol (i); - sp.item_l_drul_[RIGHT] = scol (i+1); + // printf ("duration %d/%d, count %d\n", durations[i].num (), durations[i].den (), counts[i]); + } + + SCM bsd = me->get_grob_property ("base-shortest-duration"); + Rational d = Rational (1,8); + if (Moment *m = unsmob_moment (bsd)) + d = m->main_part_; + + 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); /* - UGH. TODO: more - advanced spacing here. + + 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. + */ - Spring sp_orig (sp); + Item *lb = l->find_prebroken_piece (RIGHT); + Item *rb = r->find_prebroken_piece (LEFT); + + if (lb) + breakable_column_spacing (me, lb,r, shortest); - Item *r = sp.item_l_drul_[RIGHT]->find_prebroken_piece (LEFT); + if (rb) + breakable_column_spacing (me, l, rb, shortest); + if (lb && rb) + breakable_column_spacing (me, lb, rb, shortest); - if (r) - { - sp = sp_orig; - sp.item_l_drul_[RIGHT] =r ; - meas_springs.push (sp); - } + 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); + } +} + + +/* + 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 shortest) +{ + 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"); + + /* + 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 (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_)) + 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; } } - return meas_springs; + + if (max_note_space < 0) + { + max_note_space = base_note_space; + max_fixed_note_space = increment; + } + + bool ragged = to_boolean (me->get_paper ()->get_scmvar ("raggedright")); + + /* + 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? + */ + max_fixed_note_space = max_fixed_note_space -Spacing_spanner::get_springs () const + +/* + 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) { - Array springs; - int last_break =0; - for (int i=1; i < col_count (); i++) + + *fixed = 0.0; + Direction d = LEFT; + Drul_array cols(l,r); + + do { - if (scol (i)->breakable_b ()) + if (!Paper_column::musical_b (cols[d])) { - springs.concat (do_measure (last_break, i)); - last_break = i; + /* + 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); + *fixed += -d * lext[-d]; } } - return springs; + while (flip (&d) != 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; + + *space = *fixed + get_duration_space (me, dt, shortest.main_part_, &dummy); + } } +/* + Read hints from L and generate springs. + */ +void +Spacing_spanner::breakable_column_spacing (Grob*me, Item* l, Item *r,Moment shortest) +{ + Real max_fixed = -infinity_f; + Real max_space = -infinity_f; + + standard_breakable_column_spacing (me, l, r, &max_fixed, &max_space , + shortest); + + 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-> get_column () == 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)) + { + /* + One situation where this can happen is when there is a column + that only serves as a spanning point for a short staff-symbol. + + ===============X=== + + |=======Y + + + (here no StaffSpacing from Y to X is found.) + */ + programming_error ("No StaffSpacing wishes 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. + */ + + bool ragged = to_boolean (me->get_paper ()->get_scmvar ("raggedright")); + Real strength = (ragged) ? 1.0 : 1 / (max_space - max_fixed); + Real distance = (ragged) ? max_fixed : max_space; + Spaceable_grob::add_spring (l, r, distance, strength, 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")); + Real incr = gh_scm2double (me->get_grob_property ("spacing-increment")); + + 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; + +#if 0 + *expand_only = true; +#endif + 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, bool * expand_only) +{ + Moment shortest_playing_len = 0; + SCM s = lc->get_grob_property ("shortest-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).string ()); + shortest_playing_len = 1; + } + + Moment lwhen = Paper_column::when_mom (lc); + Moment rwhen = Paper_column::when_mom (rc); + + Moment delta_t = rwhen - lwhen; + Real dist = 0.0; + + /* + 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. + + */ + shortest_playing_len = shortest_playing_len >? delta_t; + if (delta_t.main_part_ && !lwhen.grace_part_) + { + 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; + } + + + return dist; +} + + + +ADD_INTERFACE (Spacing_spanner,"spacing-spanner-interface", + " +The space taken by a note is dependent on its duration. Doubling a +duration adds spacing-increment to the space. The most common shortest +note gets shortest-duration-space. Notes that are even shorter are +spaced proportonial to their duration. + +Typically, the increment is the width of a black note head. In a +piece with lots of 8th notes, and some 16th notes, the eighth note +gets 2 note heads width (i.e. the space following a note is 1 note +head width) A 16th note is followed by 0.5 note head width. The +quarter note is followed by 3 NHW, the half by 4 NHW, etc. +", + "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.", + ""); +