X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fspacing-spanner.cc;h=2f6e90326ccd06712ed8d48256d13a18706a1c4f;hb=3d3de8e64c3575398be835570b839901f5c68d65;hp=d906f84f562bf32f9d8f046dfe5d1fe74ca30cb3;hpb=19fbc4154436823f3365e0bc42c4420f2233a860;p=lilypond.git diff --git a/lily/spacing-spanner.cc b/lily/spacing-spanner.cc index d906f84f56..2f6e90326c 100644 --- a/lily/spacing-spanner.cc +++ b/lily/spacing-spanner.cc @@ -1,312 +1,526 @@ -/* - 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--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 "pointer-group-interface.hh" +#include "spaceable-grob.hh" +#include "spacing-interface.hh" +#include "staff-spacing.hh" +#include "system.hh" +#include "warn.hh" -Spacing_spanner::Spacing_spanner () +vector +Spacing_spanner::get_columns (Spanner *me) { - set_empty (X_AXIS); - set_empty (Y_AXIS); - set_elt_property ("transparent", SCM_BOOL_T); + vector all (get_root_system (me)->columns ()); + vsize start = binary_search (all, (Grob*)me->get_bound (LEFT), + &Paper_column::less_than); + vsize end = binary_search (all, (Grob*) me->get_bound (RIGHT), + &Paper_column::less_than); + + all = vector::vector (all.begin () + start, + all.begin () + end + 1); + return all; } -/* - cut 'n paste from spring-spacer.cc +MAKE_SCHEME_CALLBACK (Spacing_spanner, set_springs, 1); +SCM +Spacing_spanner::set_springs (SCM smob) +{ + Spanner *me = unsmob_spanner (smob); - generate springs between columns. + /* + can't use get_system() ? --hwn. + */ + vector all (get_columns (me)); + set_explicit_neighbor_columns (all); + Spacing_options options; + options.init_from_grob (me); - The algorithm is partly taken from : + prune_loose_columns (me, &all, &options); + set_implicit_neighbor_columns (all); + generate_springs (me, all, &options); - 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. + return SCM_UNSPECIFIED; +} - TOO HAIRY. - - */ -Array -Spacing_spanner::do_measure (Link_array cols) const +/* + 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. +*/ + +MAKE_SCHEME_CALLBACK (Spacing_spanner, calc_common_shortest_duration, 1); +SCM +Spacing_spanner::calc_common_shortest_duration (SCM grob) { - Moment shortest; - shortest.set_infinite (1); - for (int i =0 ; i < cols.size (); i++) + Spanner *me = unsmob_spanner (grob); + + vector cols (get_columns (me)); + + /* + 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 (cols[i]->musical_b ()) + if (Paper_column::is_musical (cols[i])) { - SCM st = cols[i]->get_elt_property ("shortest-starter"); - - shortest = shortest 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])) + { + vsize j = 0; + for (; j < durations.size (); j++) + { + if (durations[j] > 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); + } + } + + int max_idx = -1; + int max_count = 0; + for (vsize 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]); } - Array meas_springs; + 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 Moment (d).smobbed_copy (); +} - Real non_musical_space_strength = paper_l ()->get_var ("breakable_column_space_strength"); - for (int i= 0; i < cols.size () - 1; i++) +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)) { - Item * l = cols[i]; - Item * r = cols[i+1]; - Item * lb = l->find_broken_piece (RIGHT); - Item * rb = r->find_broken_piece (LEFT); + bool skip_unbroken_right = false; - Item* combinations[4][2]={{l,r}, {lb,r}, {l,rb},{lb,rb}}; + 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; - for (int j=0; j < 4; j++) + 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_elt_property ("extra-space"); - SCM next_hint = rc->get_elt_property ("extra-space"); - SCM stretch_hint = lc->get_elt_property ("stretch-distance"); - SCM next_stretch_hint = rc->get_elt_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; - if (hint != SCM_UNDEFINED) - { - 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 (lc,rc,shortest); - } - else if (lc->musical_b()) - { - left_distance = note_spacing (lc, rc, shortest); - } + if (left_col && right_col) + breakable_column_spacing (me, left_col, right_col, options); - s.distance_f_ = left_distance; + if (lb && right_col) + breakable_column_spacing (me, lb, right_col, options); - /* - Only do tight spaces *after* barlines (breakable columns), - not before. + if (left_col && rb) + breakable_column_spacing (me, left_col, rb, options); + + if (lb && rb) + breakable_column_spacing (me, lb, rb, options); + } +} + +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); + + prev = col; + } +} + +/* + 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) +{ + bool expand_only = false; + Real base_note_space = note_spacing (me, left_col, right_col, options, &expand_only); - We want the space before barline to be like the note - spacing in the measure. + 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_) + { + 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. */ - if (lc->breakable_b () || lc->original_l_) - s.strength_f_ = non_musical_space_strength; - else if (!lc->musical_b ()) - left_distance *= paper_l ()->get_var ("decrease_nonmus_spacing_factor"); + Interval lext = right_col->extent (right_col, X_AXIS); + if (!lext.is_empty ()) + compound_note_space += -lext[LEFT]; + } + } + else + { + int wish_count = 0; + + 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]; - - Real right_dist = 0.0; - if (next_hint != SCM_UNDEFINED) - { - right_dist += - gh_scm2double (gh_car (next_hint)); - } - else + 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; + + /* + This is probably a waste of time in the case of polyphonic + music. */ + if (Note_spacing::has_interface (wish)) { - Interval ext (rc->extent (X_AXIS)); - right_dist = ext.empty_b() ? 0.0 : - ext [LEFT]; + Real space = 0.0; + Real fixed = 0.0; + + Note_spacing::get_spacing (wish, right_col, base_note_space, options->increment_, &space, &fixed); + + + max_space = max (max_space, space); + max_fixed = max (max_fixed, fixed); + + compound_note_space += space; + compound_fixed_note_space += fixed; + wish_count++; } + } + if (Paper_column::when_mom (right_col).grace_part_ + && !Paper_column::when_mom (left_col).grace_part_) + { /* - don't want to create too much extra space for accidentals + Ugh. 0.8 is arbitrary. */ - if (lc->musical_b () && rc->musical_b ()) + compound_note_space *= 0.8; + } + + if (compound_note_space < 0 || wish_count == 0) + { + + if (!Paper_column::is_musical (right_col)) { - if (rc->get_elt_property ("contains-grace") == SCM_UNDEFINED) - right_dist *= paper_l ()->get_var ("musical_to_musical_left_spacing_factor"); - } + Real left_col_stick_out = robust_relative_extent (left_col, left_col, X_AXIS)[RIGHT]; + compound_fixed_note_space = max (left_col_stick_out, options->increment_); - if (rc->musical_b () && rc->get_elt_property ("contains-grace") != SCM_UNDEFINED) - right_dist *= paper_l ()->get_var ("before_grace_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 (next_stretch_hint != SCM_UNDEFINED) - // see regtest spacing-tight - stretch_dist += - gh_scm2double (gh_car (next_stretch_hint)); + compound_note_space = max (base_note_space, + base_note_space - options->increment_ + left_col_stick_out); + } else - stretch_dist += right_dist; - - if (s.distance_f_ <0) - programming_error("negative dist"); - - if (stretch_dist == 0.0) { /* - \bar "". We give it 0 space, with high strength. - */ - s.strength_f_ = 20.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 - s.strength_f_ /= stretch_dist; - - meas_springs.push (s); } - } - - return meas_springs; -} + 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; + } -/** - Do something if breakable column has no spacing hints set. - */ -Real -Spacing_spanner::default_bar_spacing (Paper_column *lc, Paper_column *rc, - Moment shortest) const -{ - Real symbol_distance = lc->extent (X_AXIS)[RIGHT] ; - Real durational_distance = 0; - Moment delta_t = rc->when_mom () - lc->when_mom () ; + /* + Whatever we do, the fixed space is smaller than the real + space. - /* - ugh should use shortest_playing distance - */ - if (delta_t) - { - Real k= paper_l()->arithmetic_constant (shortest); - durational_distance = paper_l()->length_mom_to_dist (delta_t,k); + 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); } - return symbol_distance >? durational_distance; -} - + Real inverse_strength = 1.0; + Real distance = 1.0; -Real -Spacing_spanner::note_spacing (Paper_column *lc, Paper_column *rc, Moment shortest) const -{ - Moment shortest_playing_len = 0; - SCM s = lc->get_elt_property ("shortest-playing"); - if (SMOB_IS_TYPE_B(Moment, s)) - shortest_playing_len = *SMOB_TO_TYPE (Moment, s); - - - if (! shortest_playing_len) + /* + TODO: make sure that the space doesn't exceed the right margin. + */ + if (options->packed_) { - programming_error ("Can't find a ruling note at " + lc->when_mom ().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 " + lc->when_mom ().str ()); - shortest = 1; + inverse_strength = (compound_note_space - compound_fixed_note_space); + distance = compound_note_space; } - Moment delta_t = rc->when_mom () - lc->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); - dist += stem_dir_correction (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. - - This should be more advanced, since relative heights of the note - heads also influence required correction. + Moment dt = Paper_column::when_mom (r) - Paper_column::when_mom (l); - Also might not work correctly ico. multi voices or staff changing voices + if (dt == Moment (0, 0)) + { + extract_grob_set (l, "spacing-wishes", wishes); - TODO: lookup correction distances? More advanced correction? - Possibly turn this off? + for (vsize i = 0; i < wishes.size (); i++) + { + Item *spacing_grob = dynamic_cast (wishes[i]); - This routine reads the DIR_LIST property of both its L and R arguments. -*/ -Real -Spacing_spanner::stem_dir_correction (Paper_column*l, Paper_column*r) const -{ - SCM dl = l->get_elt_property ("dir-list"); - SCM dr = r->get_elt_property ("dir-list"); - if (dl == SCM_UNDEFINED || dr == SCM_UNDEFINED) - return 0.0; + if (!spacing_grob || !Staff_spacing::has_interface (spacing_grob)) + continue; + Real space; + Real fixed_space; - 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. - bool err = false; - Real correction = 0.0; - Real ssc = paper_l ()->get_var("stemSpacingCorrection"); + Ugh. The 0.8 is arbitrary. + */ + space *= 0.8; + } + 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) + if (compound_space <= 0.0 || !wish_count) { - if (d1 == 1 && d2 == -1) - correction = ssc; - else if (d1 == -1 && d2 == 1) - correction = -ssc; - else - err = true; + standard_breakable_column_spacing (me, l, r, &compound_fixed, &compound_space, + options); + wish_count = 1; } - else - err = true; - - if (err) - programming_error ("Stem directions not set correctly for optical correction"); - return correction; -} - - -Array -Spacing_spanner::get_springs () const -{ - Array springs; - - SCM last_col = pscore_l_->line_l_->get_elt_property ("columns"); - Link_array measure; - for (SCM s = last_col; gh_pair_p (s); s = gh_cdr (s)) { - Score_element * elt = unsmob_element (gh_car (s)); - Paper_column* sc = dynamic_cast (elt); - measure.push (sc); - if (sc->breakable_b ()) - { - measure.reverse (); - springs.concat (do_measure (measure)); - measure.clear (); - measure.push (sc); - } + 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; + } + } - return springs; -} + if (options->stretch_uniformly_ && l->break_status_dir () != RIGHT) + compound_fixed = 0.0; + assert (!isinf (compound_space)); + compound_space = max (compound_space, compound_fixed); + /* + 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 " + "packed-spacing " + "shortest-duration-space " + "spacing-increment " + "strict-grace-spacing " + "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.", + + "");