-/*
- spacing-spanner.cc -- implement Spacing_spanner
-
- source file of the GNU LilyPond music typesetter
-
- (c) 1999--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-
- */
+/*
+ This file is part of LilyPond, the GNU music typesetter.
+
+ Copyright (C) 1999--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
+
+ LilyPond is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
+*/
#include "spacing-spanner.hh"
+
+#include <math.h>
+#include <cstdio>
+
+#include "spacing-options.hh"
+#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 "separation-item.hh"
+#include "skyline-pair.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)
+vector<Grob *>
+Spacing_spanner::get_columns (Grob *me_grob)
{
- me->set_extent_callback (SCM_EOL, X_AXIS);
- me->set_extent_callback (SCM_EOL, Y_AXIS) ;
+ Spanner *me = dynamic_cast<Spanner *> (me_grob);
+ vector<Grob *> all (get_root_system (me)->used_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<Grob *> (all.begin () + start,
+ all.begin () + end + 1);
+ return all;
}
-#if 0
-struct Note_run
-{
- Array<int> idxes;
- int start, end;
- Moment duration;
- int count;
-};
-
-int
-column_compare (Grob *const &t1, Grob *const &t2)
+MAKE_SCHEME_CALLBACK (Spacing_spanner, set_springs, 1);
+SCM
+Spacing_spanner::set_springs (SCM smob)
{
- return Moment::compare (Paper_column::when_mom (t1),
- Paper_column::when_mom (t2));
+ Spanner *me = unsmob_spanner (smob);
+
+ /*
+ can't use get_system () ? --hwn.
+ */
+ Spacing_options options;
+ options.init_from_grob (me);
+ vector<Grob *> cols = Spacing_spanner::get_columns (me);
+ set_explicit_neighbor_columns (cols);
+
+ prune_loose_columns (me, &cols, &options);
+ set_implicit_neighbor_columns (cols);
+ generate_springs (me, cols, &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.
-Note_run
-run_length (Moment dt, int i, Array<Moment> const &moms,
- Link_array<Note_run> runs)
+ 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)
{
- int k = 0;
- Array<int> idxes;
+ Spanner *me = unsmob_spanner (grob);
- idxes.push (i);
- while (1)
- {
- Moment next = moms[i] + dt;
- while (i < moms.size () && moms[i] < next)
- i++;
- if (i == moms.size () || moms[i] != next)
- break;
-
- idxes.push (i);
- k++;
- }
+ vector<Grob *> cols (get_columns (me));
- Moment dur = idxes.size ()
-}
+ /*
+ ascending in duration
+ */
+ vector<Rational> durations;
+ vector<int> counts;
-void
-find_runs (Grob*me, Link_array<Grob> cols)
-{
- Link_array<Grob> filter_cols;
- Array<Moment> col_moments;
- for (int i = 0; i < cols.size (); i++)
+ Rational shortest_in_measure;
+ shortest_in_measure.set_infinite (1);
+
+ for (vsize i = 0; i < cols.size (); i++)
{
- Moment w = Paper_column::when_mom (cols[i]);
-
- if (!w.grace_mom_ && Paper_column::musical_b (cols[i]))
- {
- filter_cols.push (cols[i]);
- col_moments.push (w);
- }
+ 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]))
+ {
+ 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);
+ }
}
- Moment end_mom = col_moments.top ();
- for (int i = 0; i < col_moments.size () ; i++)
+ vsize max_idx = VPOS;
+ int max_count = 0;
+ for (vsize i = durations.size (); i--;)
{
- for (int j = i+1; j < col_moments.size (); j++)
- {
- Moment dt = Paper_column::col_momentsfilter_cols
- }
+ if (counts[i] >= max_count)
+ {
+ max_idx = i;
+ max_count = counts[i];
+ }
}
-}
-#endif
-/*
+ SCM bsd = me->get_property ("base-shortest-duration");
+ Rational d = Rational (1, 8);
+ if (Moment *m = unsmob_moment (bsd))
+ d = m->main_part_;
- The algorithm is partly taken from :
+ if (max_idx != VPOS)
+ d = min (d, durations[max_idx]);
- 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.
-
- TOO HAIRY.
+ return Moment (d).smobbed_copy ();
+}
- TODO: write comments
-
- */
void
-Spacing_spanner::do_measure (Grob*me, Link_array<Grob> const & cols)
+Spacing_spanner::generate_pair_spacing (Grob *me,
+ Paper_column *left_col, Paper_column *right_col,
+ Paper_column *after_right_col,
+ Spacing_options const *options)
{
- Moment shortest;
- Moment mean_shortest;
-
- /*
- 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);
-
- int n = 0;
- for (int i =0 ; i < cols.size (); i++)
+ if (Paper_column::is_musical (left_col))
{
- 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_mom_)
- continue;
-
- SCM st = cols[i]->get_grob_property ("shortest-starter-duration");
- Moment this_shortest = *unsmob_moment (st);
- shortest = shortest <? this_shortest;
- if (!mean_shortest.main_part_.infty_b ())
- {
- n++;
- mean_shortest += this_shortest;
- }
- }
- }
- mean_shortest /= n;
+ if (!Paper_column::is_musical (right_col)
+ && (options->float_nonmusical_columns_ || to_boolean (right_col->get_property ("maybe-loose")))
+ && after_right_col
+ && Paper_column::is_musical (after_right_col))
+ {
+ /*
+ 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);
- Array<Spring> springs;
- for (int i= 0; i < cols.size () - 1; i++)
+ if (Item *rb = right_col->find_prebroken_piece (LEFT))
+ musical_column_spacing (me, left_col, rb, options);
+ }
+ else
{
- Item * l = dynamic_cast<Item*> (cols[i]);
- Item * r = dynamic_cast<Item*> (cols[i+1]);
- Item * lb = dynamic_cast<Item*> (l->find_prebroken_piece (RIGHT));
- Item * rb = dynamic_cast<Item*> (r->find_prebroken_piece (LEFT));
+ /*
+ 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);
- Item* combinations[4][2]={{l,r}, {lb,r}, {l,rb},{lb,rb}};
+ if (left_col && right_col)
+ breakable_column_spacing (me, left_col, right_col, options);
+ if (lb && right_col)
+ breakable_column_spacing (me, lb, right_col, options);
- /*
- left refers to the space that is associated with items of the left column, so you have
-
- LC <- left_space -><- right_space -> RC
- <- total space ->
-
-
- typically, right_space is non-zero when there are
- accidentals in RC
-
- */
- for (int j=0; j < 4; j++)
- {
- Paper_column * lc = dynamic_cast<Paper_column*> (combinations[j][0]);
- Paper_column *rc = dynamic_cast<Paper_column*> (combinations[j][1]);
- if (!lc || !rc)
- 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");
-
- 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 (!Paper_column::musical_b (lc) && i+1 < cols.size ())
- {
- left_distance= default_bar_spacing (me,lc,rc,shortest <? base_shortest_duration);
- }
- else if (Paper_column::musical_b ( lc))
- {
- left_distance = note_spacing (me,lc, rc, shortest <? base_shortest_duration);
- }
- else
- programming_error ("uninitialised left_distance");
-
- s.distance_f_ = left_distance;
-
- /*
- Only do tight spaces *after* barlines (breakable columns),
- not before.
-
- We want the space before barline to be like the note
- spacing in the measure.
- */
- SCM sfac =lc->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);
-
-
- 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];
- }
-
- /*
- don't want to create too much extra space for accidentals
- */
- if (Paper_column::musical_b (rc))
- {
- 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;
-
- 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;
-
- springs.push (s);
- }
- }
+ if (left_col && rb)
+ breakable_column_spacing (me, left_col, rb, options);
- Spacing_spanner::stretch_to_regularity (me, &springs, cols);
- for (int i=springs.size (); i --;)
- springs[i].add_to_cols ();
+ if (lb && rb)
+ breakable_column_spacing (me, lb, rb, options);
+ }
}
-/*
- 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.
-
-
- TODO:
-
- -- inefficient code; maybe it is easier to twiddle with the springs
- after they've become grob properties (ie. have their
- minimum-distances set)
+static void
+set_column_rods (vector<Grob *> const &cols, Real padding)
+{
+ /* distances[i] will be the distance betwen cols[i-1] and cols[i], and
+ overhangs[j] the amount by which cols[0 thru j] extend beyond cols[j]
+ when each column is placed as far to the left as possible. */
+ vector<Real> distances (cols.size ());
+ vector<Real> overhangs (cols.size ());
- -- does not adjust strength field of the springs very well: result
- awkward spacing at the start of a line. (?)
+ for (vsize i = 0; i < cols.size (); i++)
+ {
+ Item *r = dynamic_cast<Item *> (cols[i]);
+ Item *rb = r->find_prebroken_piece (LEFT);
- -- will be confused when there are multiple equispaced runs in a measure.
+ if (Separation_item::is_empty (r) && (!rb || Separation_item::is_empty (rb)))
+ continue;
- -- dealing with springs for line breaks is a little tricky; in any
- case, we will only space per measure.
+ Skyline_pair *skys = Skyline_pair::unsmob (r->get_property ("horizontal-skylines"));
+ overhangs[i] = skys ? (*skys)[RIGHT].max_height () : 0.0;
- -- we scale to actual distances, not to optical effects. Eg. if the
- equispaced run contains optical corrections, then the scaling will
- cancel those.
+ if (0 == i) continue;
- -- Regular_spacing_engraver doesn't mark the first column of the
- next bar, making the space before a barline too short, in this case
+ /* min rather than max because stickout will be negative if the right-hand column
+ sticks out a lot to the left */
+ Real stickout = min (skys ? (*skys)[LEFT].max_height () : 0.0,
+ Separation_item::conditional_skyline (r, cols[i - 1]).max_height ());
+ Real prev_distances = 0.0;
- x<- 16ths--> x(8th)
- x(8th) x(8th) <- equispaced run.
-
-*/
+ /* This is an inner loop and hence it is potentially quadratic. However, we only continue
+ as long as there is a rod to insert. Therefore, this loop will usually only execute
+ a constant number of times per iteration of the outer loop. */
+ for (vsize j = i; j--;)
+ {
+ if (overhangs[j] + padding <= prev_distances + distances[i] + stickout)
+ break; // cols[0 thru j] cannot reach cols[i]
+
+ Item *l = dynamic_cast<Item *> (cols[j]);
+ Item *lb = l->find_prebroken_piece (RIGHT);
+
+ Real dist = Separation_item::set_distance (l, r, padding);
+ distances[i] = max (distances[i], dist - prev_distances);
+
+ if (lb)
+ {
+ dist = Separation_item::set_distance (lb, r, padding);
+ // The left-broken version might reach more columns to the
+ // right than the unbroken version, by extending farther and/or
+ // nesting more closely;
+ if (j == i - 1) // check this, the first time we see each lb.
+ overhangs[j] = max (overhangs[j],
+ lb->extent (lb, X_AXIS)[RIGHT]
+ + distances[i] - dist);
+ }
+ if (rb)
+ Separation_item::set_distance (l, rb, padding);
+ if (lb && rb)
+ Separation_item::set_distance (lb, rb, padding);
+
+ prev_distances += distances[j];
+ }
+ overhangs[i] = max (overhangs[i],
+ overhangs[i - 1] - distances[i]);
+ }
+}
void
-Spacing_spanner::stretch_to_regularity (Grob *me,
- Array<Spring> * springs,
- Link_array<Grob> const & cols)
+Spacing_spanner::generate_springs (Grob *me,
+ vector<Grob *> const &cols,
+ Spacing_options const *options)
{
- /*
- 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++)
+ Paper_column *prev = dynamic_cast<Paper_column *> (cols[0]);
+ for (vsize i = 1; i < cols.size (); 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);
- }
- 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;
-
+ Paper_column *col = dynamic_cast<Paper_column *> (cols[i]);
+ Paper_column *next = (i + 1 < cols.size ()) ? dynamic_cast<Paper_column *> (cols[i + 1]) : 0;
- /*
- find the max distance for this run.
- */
- for (int j = i; j < springs->size (); j++)
- {
- Spring *s = &(springs->elem_ref (j));
- if (s->item_l_drul_[LEFT] != last_col)
- 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)
- {
- maxdist = maxdist >? dist;
- dist = 0.0;
- last_regular_spaced_col = last_col;
- }
+ generate_pair_spacing (me, prev, col, next, options);
+ prev = col;
}
- /*
- 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++)
- {
- Spring *s = &springs->elem_ref (j);
- if (s->item_l_drul_[LEFT] != last_col)
- 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)
- {
- 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;
- }
- }
+ Real padding = robust_scm2double (prev->get_property ("padding"), 0.1);
+ set_column_rods (cols, padding);
}
-/**
- 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.
+*/
+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);
+ Real base_note_space = note_spacing (me, left_col, right_col, options);
+ Spring spring;
- /*
- ugh should use shortest_playing distance
- */
- if (delta_t)
+ if (options->stretch_uniformly_)
+ spring = Spring (base_note_space, 0.0);
+ else
{
- durational_distance = get_duration_space (me, delta_t, shortest);
- }
-
- return symbol_distance >? durational_distance;
-}
-
-
-/**
- Get the measure wide ant for arithmetic spacing.
+ vector<Spring> springs;
+ extract_grob_set (left_col, "spacing-wishes", wishes);
- @see
- John S. Gourlay. ``Spacing a Line of Music,'' Technical Report
- OSU-CISRC-10/87-TR35, Department of Computer and Information Science,
- The Ohio State University, 1987.
-
- */
-Real
-Spacing_spanner::get_duration_space (Grob*me, Moment d, Moment shortest)
-{
- 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"));
-}
+ for (vsize i = 0; i < wishes.size (); i++)
+ {
+ Grob *wish = wishes[i];
+ if (Spacing_interface::left_column (wish) != left_col)
+ {
+ /* This shouldn't really happen, but the ancient music
+ stuff really messes up the spacing code, grrr
+ */
+ continue;
+ }
+
+ extract_grob_set (wish, "right-items", right_items);
+ bool found_matching_column = false;
+ for (vsize j = 0; j < right_items.size (); j++)
+ {
+ Item *it = dynamic_cast<Item *> (right_items[j]);
+ if (it && (right_col == it->get_column ()
+ || right_col->original () == it->get_column ()))
+ found_matching_column = true;
+ }
+
+ /*
+ This is probably a waste of time in the case of polyphonic
+ music. */
+ if (found_matching_column && Note_spacing::has_interface (wish))
+ {
+ Real inc = options->increment_;
+ Grob *gsp = unsmob_grob (left_col->get_object ("grace-spacing"));
+ if (gsp && Paper_column::when_mom (left_col).grace_part_)
+ {
+ Spacing_options grace_opts;
+ grace_opts.init_from_grob (gsp);
+ inc = grace_opts.increment_;
+ }
+ springs.push_back (Note_spacing::get_spacing (wish, right_col, base_note_space, inc));
+ }
+ }
+ if (springs.empty ())
+ {
-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");
-
- // SCM s = lc->get_grob_property ("mean-playing-duration");
- if (unsmob_moment (s))
- shortest_playing_len = *unsmob_moment (s);
-
- if (! shortest_playing_len)
- {
- programming_error ("can't find a ruling note at " + Paper_column::when_mom (lc).str ());
- shortest_playing_len = 1;
+ if (!Paper_column::is_musical (right_col))
+ {
+ /*
+ There used to be code that examined left_col->extent
+ (X_AXIS), but this is resulted in unexpected wide
+ spacing, because the width of s^"text" output is also
+ taken into account here.
+ */
+ spring = Spring (max (base_note_space, options->increment_),
+ options->increment_);
+ }
+ else
+ {
+ /*
+ Min distance should be 0.0. If there are no spacing
+ wishes, we're probably dealing with polyphonic spacing
+ of hemiolas.
+ */
+ spring = Spring (base_note_space, 0.0);
+ }
+ }
+ else
+ spring = merge_springs (springs);
}
-
- if (! shortest)
+
+ if (Paper_column::when_mom (right_col).grace_part_
+ && !Paper_column::when_mom (left_col).grace_part_)
{
- programming_error ("no minimum in measure at " + Paper_column::when_mom (lc).str ());
- shortest = 1;
+ /*
+ Ugh. 0.8 is arbitrary.
+ */
+ spring *= 0.8;
}
- Moment delta_t = Paper_column::when_mom (rc) - Paper_column::when_mom (lc);
- Real dist = get_duration_space (me, shortest_playing_len, shortest);
-
-
- /*
- ugh: 0.1 is an arbitrary distance.
- */
- dist *= (double) (delta_t.main_part_ / shortest_playing_len.main_part_)
- + 0.1 * (double) (delta_t.grace_mom_ / shortest_playing_len.main_part_);
-
-
/*
- UGH: KLUDGE!
+ TODO: make sure that the space doesn't exceed the right margin.
*/
-
- if (delta_t > Moment (1,32))
- dist += stem_dir_correction (me, lc,rc);
-
-
- Moment *lm = unsmob_moment (lc->get_grob_property ("when"));
- Moment *rm = unsmob_moment (rc->get_grob_property ("when"));
-
- if (lm && rm)
+ if (options->packed_)
{
- if (lm->grace_mom_ && rm->grace_mom_)
- dist *= 0.5;
- else if (!rm->grace_mom_ && lm->grace_mom_)
- dist *= 0.7;
+ /*
+ In packed mode, pack notes as tight as possible. This makes
+ sense mostly in combination with ragged-right 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 ragged-right mode, lily will
+ pack as many bars of music as possible into a line, but the
+ line will then be stretched to fill the whole linewidth.
+
+ Note that we don't actually pack things as tightly as possible:
+ we don't allow the next column to begin before this one ends.
+ */
+ /* FIXME: the else clause below is the "right" thing to do,
+ but we can't do it because of all the empty columns that the
+ ligature-engravers leave lying around. In that case, the extent of
+ the column is incorrect because it includes note-heads that aren't
+ there. We get around this by only including the column extent if
+ the left-hand column is "genuine". This is a dirty hack and it
+ should be fixed in the ligature-engravers. --jneem
+ */
+ if (Paper_column::is_extraneous_column_from_ligature (left_col))
+ spring.set_distance (spring.min_distance ());
+ else
+ spring.set_distance (max (left_col->extent (left_col, X_AXIS)[RIGHT],
+ spring.min_distance ()));
+
+ spring.set_inverse_stretch_strength (1.0);
}
-
- return dist;
+ Spaceable_grob::add_spring (left_col, right_col, spring);
}
+/*
+ Check if COL fills the whole measure.
+ */
+bool
+Spacing_spanner::fills_measure (Grob *me, Item *left, Item *col)
+{
+ System *sys = get_root_system (me);
+ Item *next = sys->column (col->get_column ()->get_rank () + 1);
+ if (!next)
+ return false;
-/**
- 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.
+ if (Paper_column::is_musical (next)
+ || Paper_column::is_musical (left)
+ || !Paper_column::is_musical (col)
+ || !Paper_column::is_used (next))
+ return false;
- This should be more advanced, since relative heights of the note
- heads also influence required correction.
+ Moment dt
+ = Paper_column::when_mom (next) - Paper_column::when_mom (col);
- Also might not work correctly in case of multi voices or staff
- changing voices
+ Moment *len = unsmob_moment (left->get_property ("measure-length"));
+ if (!len)
+ return false;
- TODO: lookup correction distances? More advanced correction?
- Possibly turn this off?
+ /*
+ Don't check for exact measure length, since ending measures are
+ often shortened due to pickups.
+ */
+ if (dt.main_part_ > len->main_part_ / Rational (2)
+ && (next->is_broken ()
+ || next->break_status_dir ()))
+ return true;
- TODO: have to check wether the stems are in the same staff.
+ return false;
+}
- 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)
+/*
+ Read hints from L and generate springs.
+*/
+void
+Spacing_spanner::breakable_column_spacing (Grob *me, Item *l, Item *r,
+ Spacing_options const *options)
{
- 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.;
+ vector<Spring> springs;
+ Spring spring;
- dl = gh_car (dl);
- dr = gh_car (dr);
+ Real full_measure_space = 0.0;
+ if (Paper_column::is_musical (r)
+ && l->break_status_dir () == CENTER
+ && fills_measure (me, l, r))
+ full_measure_space = robust_scm2double (l->get_property ("full-measure-extra-space"), 1.0);
- assert (gh_number_p (dl) && gh_number_p (dr));
- int d1 = gh_scm2int (dl);
- int d2 = gh_scm2int (dr);
+ Moment dt = Paper_column::when_mom (r) - Paper_column::when_mom (l);
- if (d1 == d2)
- return 0.0;
+ if (dt == Moment (0, 0))
+ {
+ extract_grob_set (l, "spacing-wishes", wishes);
+
+ for (vsize i = 0; i < wishes.size (); i++)
+ {
+ Item *spacing_grob = dynamic_cast<Item *> (wishes[i]);
+ if (!spacing_grob || !Staff_spacing::has_interface (spacing_grob))
+ continue;
- Real correction = 0.0;
- Real ssc = gh_scm2double (me->get_grob_property ("stem-spacing-correction"));
+ /*
+ column for the left one settings should be ok due automatic
+ pointer munging.
+ */
+ assert (spacing_grob->get_column () == l);
- if (d1 && d2 && d1 * d2 == -1)
- {
- correction = d1 * ssc;
+ springs.push_back (Staff_spacing::get_spacing (spacing_grob, r,
+ full_measure_space));
+ }
}
+
+ if (springs.empty ())
+ spring = standard_breakable_column_spacing (me, l, r, options);
else
- programming_error ("Stem directions not set correctly for optical correction");
- return correction;
-}
-
+ spring = merge_springs (springs);
-MAKE_SCHEME_CALLBACK (Spacing_spanner, set_springs,1);
-SCM
-Spacing_spanner::set_springs (SCM smob)
-{
- Grob *me = unsmob_grob (smob);
- Link_array<Grob> all (me->pscore_l_->line_l_->column_l_arr ()) ;
+ if (Paper_column::when_mom (r).grace_part_)
+ {
+ /*
+ Correct for grace notes.
- int j = 0;
+ Ugh. The 0.8 is arbitrary.
+ */
+ spring *= 0.8;
+ }
- for (int i = 1; i < all.size (); i++)
+ if (options->stretch_uniformly_ && l->break_status_dir () != RIGHT)
{
- Grob *sc = all[i];
- if (Item::breakable_b (sc))
- {
- Link_array<Grob> measure (all.slice (j, i+1));
- do_measure (me, measure);
- j = i;
- }
+ spring.set_min_distance (0.0);
+ spring.set_default_strength ();
}
- /*
- farewell, cruel world
- */
- me->suicide ();
- return SCM_UNSPECIFIED;
+ Spaceable_grob::add_spring (l, r, spring);
}
+ADD_INTERFACE (Spacing_spanner,
+ "The space taken by a note is dependent on its duration."
+ " Doubling a duration adds @code{spacing-increment} to the"
+ " space. The most common shortest note gets"
+ " @code{shortest-duration-space}. Notes that are even shorter"
+ " are spaced proportonial to their duration.\n"
+ "\n"
+ "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 a 2@tie{}note heads width (i.e., the space"
+ " following a note is a 1@tie{}note head width). A 16th note"
+ " is followed by 0.5 note head width. The quarter note is"
+ " followed by 3@tie{}NHW, the half by 4@tie{}NHW, etc.",
+
+ /* properties */
+ "average-spacing-wishes "
+ "base-shortest-duration "
+ "common-shortest-duration "
+ "packed-spacing "
+ "shortest-duration-space "
+ "spacing-increment "
+ "strict-grace-spacing "
+ "strict-note-spacing "
+ "uniform-stretching "
+ );
-
-/*
- 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.)
-
- */
projects / lilypond.git / blobdiff