X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fspacing-spanner.cc;h=2a86f22ff574a018a15bda50a0cbe41dfce5ea2d;hb=582186f60e5103f11a0cc54cc5dfb3319b9ea114;hp=41f2a7bbd50e42986ad4945c9fa49f2fa19f8a52;hpb=af51453530b95aee167fe02ee3f4cb0c8dcd1fe2;p=lilypond.git diff --git a/lily/spacing-spanner.cc b/lily/spacing-spanner.cc index 41f2a7bbd5..9c48aaec0a 100644 --- a/lily/spacing-spanner.cc +++ b/lily/spacing-spanner.cc @@ -1,395 +1,529 @@ -/* - 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--2006 Han-Wen Nienhuys +*/ #include "spacing-spanner.hh" + +#include +#include +using namespace std; + +#include "international.hh" +#include "main.hh" +#include "moment.hh" +#include "note-spacing.hh" +#include "output-def.hh" #include "paper-column.hh" -#include "dimensions.hh" -#include "paper-def.hh" -#include "warn.hh" #include "paper-score.hh" -#include "line-of-score.hh" -#include "misc.hh" +#include "pointer-group-interface.hh" +#include "spaceable-grob.hh" +#include "spacing-interface.hh" +#include "staff-spacing.hh" +#include "system.hh" +#include "warn.hh" -void -Spacing_spanner::set_interface (Grob*me) -{ - me->set_extent_callback (SCM_EOL, X_AXIS); - me->set_extent_callback (SCM_EOL, Y_AXIS) ; -} /* + TODO: - The algorithm is partly taken from : + use callback instead? - 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. +*/ +Rational +Spacing_spanner::effective_shortest_duration (Grob *me, + vector const &all) +{ + 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 = Spacing_spanner::find_shortest (me, all); + if (be_verbose_global) + message (_f ("Global shortest duration is %s", global_shortest.to_string ()) + "\n"); + } - TOO HAIRY. + return global_shortest; +} - TODO: write comments - - */ -void -Spacing_spanner::do_measure (Grob*me, Link_array cols) + +MAKE_SCHEME_CALLBACK (Spacing_spanner, set_springs, 1); +SCM +Spacing_spanner::set_springs (SCM smob) { - Moment shortest; - Moment mean_shortest; + Spanner *me = unsmob_spanner (smob); /* - 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); + can't use get_system() ? --hwn. + */ + vector all (get_root_system (me)->columns ()); + vsize start = binary_search (all, (Grob*)me->get_bound (LEFT), + &Paper_column::compare); + vsize end = binary_search (all, (Grob*) me->get_bound (RIGHT), + &Paper_column::compare); + + all = vector::vector (all.begin () + start, + all.begin () + end + 1); + + set_explicit_neighbor_columns (all); - int n = 0; - for (int i =0 ; i < cols.size (); i++) + Spacing_options options; + options.init_from_grob (me); + options.global_shortest_ = effective_shortest_duration (me, all); + + prune_loose_columns (me, &all, &options); + set_implicit_neighbor_columns (all); + generate_springs (me, all, &options); + + 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, vector const &cols) +{ + /* + ascending in duration + */ + vector durations; + vector counts; + + Rational shortest_in_measure; + shortest_in_measure.set_infinite (1); + + for (vsize i = 0; i < cols.size (); i++) { - if (dynamic_cast (cols[i])->musical_b ()) + 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 () + && Paper_column::is_breakable (cols[i])) { - SCM st = cols[i]->get_grob_property ("shortest-starter-duration"); - Moment this_shortest = *unsmob_moment(st); - shortest = shortest shortest_in_measure) + { + counts.insert (counts.begin () + j, 1); + durations.insert (durations.begin () + j, shortest_in_measure); + break; + } + else if (durations[j] == shortest_in_measure) + { + counts[j]++; + break; + } } + + if (durations.size () == j) + { + durations.push_back (shortest_in_measure); + counts.push_back (1); + } + + shortest_in_measure.set_infinite (1); } } - mean_shortest /= n; - - for (int i= 0; i < cols.size () - 1; i++) + int max_idx = -1; + int max_count = 0; + for (vsize i = durations.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 (counts[i] >= max_count) + { + max_idx = i; + max_count = counts[i]; + } - Item* combinations[4][2]={{l,r}, {lb,r}, {l,rb},{lb,rb}}; + // 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_; - /* - left refers to the space that is associated with items of the left column, so you have + if (max_idx >= 0) + d = min (d, durations[max_idx]); - LC <- left_space -><- right_space -> RC - <- total space -> - + return d; +} - typically, right_space is non-zero when there are - accidentals in RC - - */ - for (int j=0; j < 4; j++) +void +Spacing_spanner::generate_pair_spacing (Grob *me, + Paper_column *left_col, Paper_column *right_col, + Paper_column *after_right_col, + Spacing_options const *options) +{ + if (Paper_column::is_musical (left_col)) + { + bool skip_unbroken_right = false; + + if (!Paper_column::is_musical (right_col) + && options->float_nonmusical_columns_ + && after_right_col + && Paper_column::is_musical (after_right_col)) + skip_unbroken_right = true; + + if (skip_unbroken_right) { - Paper_column * lc = dynamic_cast (combinations[j][0]); - Paper_column *rc = dynamic_cast (combinations[j][1]); - if (!lc || !rc) - continue; + /* + TODO: should generate rods to prevent collisions. + */ + musical_column_spacing (me, left_col, after_right_col, options); + right_col->set_object ("between-cols", scm_cons (left_col->self_scm (), + after_right_col->self_scm ())); + } + else + musical_column_spacing (me, left_col, right_col, options); - 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"); + if (Item *rb = right_col->find_prebroken_piece (LEFT)) + musical_column_spacing (me, left_col, rb, options); + } + 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 = left_col->find_prebroken_piece (RIGHT); + Item *rb = right_col->find_prebroken_piece (LEFT); - Real left_distance = 0; - if (gh_pair_p (hint)) - { - left_distance = gh_scm2double (gh_cdr (hint)); - } - // 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 ()) - { - left_distance= default_bar_spacing (me,lc,rc,shortest musical_b()) - { - left_distance = note_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_)) - { - s.strength_f_ = - gh_scm2double (lc->get_grob_property ("column-space-strength")); - } - else if (gh_number_p (sfac)) - left_distance *= gh_scm2double (sfac); + if (left_col && rb) + breakable_column_spacing (me, left_col, rb, options); - - Real right_dist = 0.0; - if (gh_pair_p (next_hint)) - { - right_dist += - gh_scm2double (gh_car (next_hint)); - } - else - { - Interval ext (rc->extent (rc, X_AXIS)); - right_dist = ext.empty_b() ? 0.0 : - ext [LEFT]; - } + if (lb && rb) + breakable_column_spacing (me, lb, rb, options); + } +} - /* - 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; - - 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; +void +Spacing_spanner::generate_springs (Grob *me, + vector const &cols, + Spacing_options const *options) +{ + Paper_column *prev = 0; + for (vsize i = 0; i < cols.size (); i++) + { + Paper_column *col = dynamic_cast (cols[i]); + Paper_column *next = (i < cols.size()-1) ? dynamic_cast (cols[i+1]) : 0; + + if (i > 0) + generate_pair_spacing (me, prev, col, next, options); - 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; - - s.add_to_cols (); - } + prev = col; } - } -/** - Do something if breakable column has no spacing hints set. - */ -Real -Spacing_spanner::default_bar_spacing (Grob*me, Grob *lc, Grob *rc, - Moment shortest) +/* + Generate the space between two musical columns LEFT_COL and RIGHT_COL, given + spacing parameters INCR and SHORTEST. +*/ +void +Spacing_spanner::musical_column_spacing (Grob *me, + Item *left_col, + Item *right_col, + Spacing_options const *options) { - 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, left_col, right_col, options, &expand_only); - /* - ugh should use shortest_playing distance - */ - if (delta_t) + Real max_fixed = 0; + Real max_space = 0; + Real compound_note_space = 0.0; + Real compound_fixed_note_space = 0.0; + + if (options->stretch_uniformly_) { - durational_distance = get_duration_space (me, delta_t, shortest); + compound_note_space = base_note_space; + + if (!Paper_column::is_musical (right_col)) + { + /* + Crude fix for notes that lead up to barlines and time sigs. + */ + Interval lext = right_col->extent (right_col, X_AXIS); + if (!lext.is_empty ()) + compound_note_space += -lext[LEFT]; + } + } + else + { + int wish_count = 0; - return symbol_distance >? durational_distance; -} + extract_grob_set (left_col, "right-neighbors", 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 (vsize i = 0; i < neighbors.size (); i++) + { + Grob *wish = neighbors[i]; -/** - Get the measure wide ant for arithmetic spacing. + Item *wish_rcol = Note_spacing::right_column (wish); + if (Note_spacing::left_column (wish) != left_col + || (wish_rcol != right_col && wish_rcol != right_col->original ())) + continue; - @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. + /* + 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; - */ -Real -Spacing_spanner::get_duration_space (Grob*me, Moment d, Moment shortest) -{ - Real log = log_2 (shortest); - Real k = gh_scm2double (me->get_grob_property ("arithmetic-basicspace")) - - log; - - return (log_2 (d) + k) * gh_scm2double (me->get_grob_property ("arithmetic-multiplier")); -} + Note_spacing::get_spacing (wish, right_col, base_note_space, options->increment_, &space, &fixed); -Real -Spacing_spanner::note_spacing (Grob*me, Grob *lc, Grob *rc, - Moment shortest) -{ - Moment shortest_playing_len = 0; - SCM s = lc->get_grob_property ("shortest-playing-duration"); + max_space = max (max_space, space); + max_fixed = max (max_fixed, fixed); + + compound_note_space += space; + compound_fixed_note_space += fixed; + wish_count++; + } + } - // SCM s = lc->get_grob_property ("mean-playing-duration"); - if (unsmob_moment (s)) - shortest_playing_len = *unsmob_moment(s); - - if (! shortest_playing_len) + if (Paper_column::when_mom (right_col).grace_part_ + && !Paper_column::when_mom (left_col).grace_part_) + { + /* + Ugh. 0.8 is arbitrary. + */ + compound_note_space *= 0.8; + } + + if (compound_note_space < 0 || wish_count == 0) + { + /* + Fixed should be 0.0. If there are no spacing wishes, we're + likely dealing with polyphonic spacing of hemiolas. + + We used to have compound_fixed_note_space = options->increment_ + + but this can lead to numeric instability problems when we + do + + inverse_strength = (compound_note_space - compound_fixed_note_space) + + */ + + compound_note_space = base_note_space; + compound_fixed_note_space = 0.0; + } + else if (to_boolean (me->get_property ("average-spacing-wishes"))) + { + compound_note_space /= wish_count; + compound_fixed_note_space /= wish_count; + } + else + { + compound_fixed_note_space = max_fixed; + compound_note_space = max_space; + } + + /* + 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); + } + + Real inverse_strength = 1.0; + Real distance = 1.0; + + /* + TODO: make sure that the space doesn't exceed the right margin. + */ + if (options->packed_) { - programming_error ("can't find a ruling note at " + Paper_column::when_mom (lc).str ()); - shortest_playing_len = 1; + /* + 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; } - - if (! shortest) + else { - programming_error ("no minimum in measure at " + Paper_column::when_mom (lc).str ()); - shortest = 1; + inverse_strength = (compound_note_space - compound_fixed_note_space); + distance = compound_note_space; } - 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; + Spaceable_grob::add_spring (left_col, right_col, distance, inverse_strength); } +/* + Read hints from L and generate springs. +*/ +void +Spacing_spanner::breakable_column_spacing (Grob *me, Item *l, Item *r, + Spacing_options const *options) +{ + Real compound_fixed = 0.0; + Real compound_space = 0.0; + Real max_fixed = 0.0; + Real max_space = 0.0; + + int wish_count = 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. + Moment dt = Paper_column::when_mom (r) - Paper_column::when_mom (l); - This should be more advanced, since relative heights of the note - heads also influence required correction. + if (dt == Moment (0, 0)) + { + extract_grob_set (l, "spacing-wishes", wishes); - Also might not work correctly in case of multi voices or staff - changing voices + for (vsize i = 0; i < wishes.size (); i++) + { + Item *spacing_grob = dynamic_cast (wishes[i]); - TODO: lookup correction distances? More advanced correction? - Possibly turn this off? + if (!spacing_grob || !Staff_spacing::has_interface (spacing_grob)) + continue; - TODO: have to check wether the stems are in the same staff. + Real space; + Real fixed_space; - 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.; + /* + column for the left one settings should be ok due automatic + pointer munging. - dl = gh_car (dl); - dr = gh_car (dr); + */ + assert (spacing_grob->get_column () == l); - assert (gh_number_p (dl) && gh_number_p(dr)); - int d1 = gh_scm2int (dl); - int d2 = gh_scm2int (dr); + Staff_spacing::get_spacing_params (spacing_grob, + &space, &fixed_space); - if (d1 == d2) - return 0.0; + if (Paper_column::when_mom (r).grace_part_) + { + /* + Correct for grace notes. + Ugh. The 0.8 is arbitrary. + */ + space *= 0.8; + } - Real correction = 0.0; - Real ssc = gh_scm2double (me->get_grob_property("stem-spacing-correction")); + max_space = max (max_space, space); + max_fixed = max (max_fixed, fixed_space); + + compound_space += space; + compound_fixed += fixed_space; + wish_count++; + } + } - if (d1 && d2 && d1 * d2 == -1) + if (compound_space <= 0.0 || !wish_count) { - correction = d1 * ssc; + standard_breakable_column_spacing (me, l, r, &compound_fixed, &compound_space, + options); + wish_count = 1; } else - programming_error ("Stem directions not set correctly for optical correction"); - return correction; -} - - -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; - - 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; - } + if (to_boolean (me->get_property ("average-spacing-wishes"))) + { + compound_space /= wish_count; + compound_fixed /= wish_count; + } + else + { + compound_fixed = max_fixed; + compound_space = max_space; + } + } + if (options->stretch_uniformly_ && l->break_status_dir () != RIGHT) + compound_fixed = 0.0; + + assert (!isinf (compound_space)); + compound_space = max (compound_space, compound_fixed); + /* - farewell, cruel world - */ - me->suicide (); - return SCM_UNSPECIFIED; -} + There used to be code that changed spacing depending on + raggedright setting. Ugh. + + 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); +} +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", + + + "average-spacing-wishes " + "base-shortest-duration " + "common-shortest-duration " + "grace-space-factor " + "packed-spacing " + "shortest-duration-space " + "spacing-increment " + "strict-note-spacing " + "uniform-stretching " + + ); + +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.) - - */