source file of the GNU LilyPond music typesetter
- (c) 1999--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1999--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
*/
+#include "spacing-spanner.hh"
+
#include <math.h>
#include <cstdio>
-#include "spacing-spanner.hh"
-#include "paper-column.hh"
-#include "output-def.hh"
-#include "paper-score.hh"
-#include "system.hh"
+#include "spacing-options.hh"
+#include "international.hh"
+#include "main.hh"
#include "moment.hh"
#include "note-spacing.hh"
-#include "main.hh"
-#include "warn.hh"
+#include "output-def.hh"
+#include "paper-column.hh"
+#include "paper-score.hh"
#include "pointer-group-interface.hh"
+#include "separation-item.hh"
+#include "skyline-pair.hh"
#include "spaceable-grob.hh"
-#include "staff-spacing.hh"
#include "spacing-interface.hh"
+#include "staff-spacing.hh"
+#include "system.hh"
+#include "warn.hh"
-
-
-void
-Spacing_options::init (Grob*me)
-{
- packed_ = to_boolean (me->get_layout ()->c_variable ("packed"));
- uniform_ = to_boolean (me->get_property ("uniform-stretching"));
-}
-
-
-Rational
-Spacing_spanner::effective_shortest_duration (Grob *me, Link_array<Grob> const &all)
+vector<Grob*>
+Spacing_spanner::get_columns (Grob *me_grob)
{
- 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");
- }
-
- return global_shortest;
+ 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*>::vector<Grob*> (all.begin () + start,
+ all.begin () + end + 1);
+ return all;
}
-
MAKE_SCHEME_CALLBACK (Spacing_spanner, set_springs, 1);
SCM
Spacing_spanner::set_springs (SCM smob)
{
- Grob *me = unsmob_grob (smob);
+ Spanner *me = unsmob_spanner (smob);
/*
- can't use get_system() ? --hwn.
+ can't use get_system () ? --hwn.
*/
- Link_array<Grob> all (me->pscore_->root_system ()->columns ());
-
- set_explicit_neighbor_columns (all);
-
Spacing_options options;
- options.init (me);
- options.global_shortest_ = effective_shortest_duration (me, all);
-
- prune_loose_columns (me, &all, &options);
- set_implicit_neighbor_columns (all);
+ options.init_from_grob (me);
+ vector<Grob*> cols = Spacing_spanner::get_columns (me);
+ set_explicit_neighbor_columns (cols);
- int j = 0;
- for (int i = 1; i < all.size (); i++)
- {
- Grob *sc = all[i];
- if (Item::is_breakable (sc))
- {
- Link_array<Grob> measure (all.slice (j, i + 1));
- do_measure (me, &measure, &options);
- j = i;
- }
- }
+ prune_loose_columns (me, &cols, &options);
+ set_implicit_neighbor_columns (cols);
+ generate_springs (me, cols, &options);
return SCM_UNSPECIFIED;
}
note has a different duration, but hey, don't write that kind of
stuff, then.
*/
-Rational
-Spacing_spanner::find_shortest (Grob *me, Link_array<Grob> const &cols)
+
+MAKE_SCHEME_CALLBACK (Spacing_spanner, calc_common_shortest_duration, 1);
+SCM
+Spacing_spanner::calc_common_shortest_duration (SCM grob)
{
+ Spanner *me = unsmob_spanner (grob);
+
+ vector<Grob*> cols (get_columns (me));
+
/*
ascending in duration
*/
- Array<Rational> durations;
- Array<int> counts;
+ vector<Rational> durations;
+ vector<int> counts;
Rational shortest_in_measure;
shortest_in_measure.set_infinite (1);
- for (int i = 0; i < cols.size (); i++)
+ for (vsize i = 0; i < cols.size (); i++)
{
if (Paper_column::is_musical (cols[i]))
{
shortest_in_measure = min (shortest_in_measure, this_shortest.main_part_);
}
else if (!shortest_in_measure.is_infinity ()
- && Item::is_breakable (cols[i]))
+ && Paper_column::is_breakable (cols[i]))
{
- int j = 0;
+ vsize j = 0;
for (; j < durations.size (); j++)
{
if (durations[j] > shortest_in_measure)
{
- counts.insert (1, j);
- durations.insert (shortest_in_measure, j);
+ counts.insert (counts.begin () + j, 1);
+ durations.insert (durations.begin () + j, shortest_in_measure);
break;
}
else if (durations[j] == shortest_in_measure)
if (durations.size () == j)
{
- durations.push (shortest_in_measure);
- counts.push (1);
+ durations.push_back (shortest_in_measure);
+ counts.push_back (1);
}
shortest_in_measure.set_infinite (1);
}
}
- int max_idx = -1;
+ vsize max_idx = VPOS;
int max_count = 0;
- for (int i = durations.size (); i--;)
+ 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]);
}
SCM bsd = me->get_property ("base-shortest-duration");
if (Moment *m = unsmob_moment (bsd))
d = m->main_part_;
- if (max_idx >= 0)
+ if (max_idx != VPOS)
d = min (d, durations[max_idx]);
- return d;
+ return Moment (d).smobbed_copy ();
}
-/*
- Generate spacing for a single measure. We used to have code that did
- per-measure spacing. Now we have piecewise spacing. We should fix
- this to support "spacing-regions": some regions have different notes
- (different time sigs) than others, and should be spaced differently.
-*/
void
-Spacing_spanner::do_measure (Grob *me,
- Link_array<Grob> *cols,
- Spacing_options const *options
- )
+Spacing_spanner::generate_pair_spacing (Grob *me,
+ Paper_column *left_col, Paper_column *right_col,
+ Paper_column *after_right_col,
+ Spacing_options const *options)
{
- Real headwid = robust_scm2double (me->get_property ("spacing-increment"), 1);
- for (int i = 0; i < cols->size () - 1; i++)
+ if (Paper_column::is_musical (left_col))
{
- Item *l = dynamic_cast<Item *> (cols->elem (i));
- Item *r = dynamic_cast<Item *> (cols->elem (i + 1));
+ if (!Paper_column::is_musical (right_col)
+ && options->float_nonmusical_columns_
+ && 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);
+
+ 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);
+
+ if (left_col && right_col)
+ breakable_column_spacing (me, left_col, right_col, options);
- Paper_column *lc = dynamic_cast<Paper_column *> (l);
- Paper_column *rc = dynamic_cast<Paper_column *> (r);
+ if (lb && right_col)
+ breakable_column_spacing (me, lb, right_col, options);
- if (Paper_column::is_musical (l))
+ if (left_col && rb)
+ breakable_column_spacing (me, left_col, rb, options);
+
+ if (lb && rb)
+ breakable_column_spacing (me, lb, rb, options);
+ }
+}
+
+static void
+set_column_rods (vector<Grob*> const &cols, Real padding)
+{
+ /* distances[i] will be the minimum distance between column i and column i+1 */
+ vector<Real> distances;
+
+ for (vsize i = 1; i < cols.size (); i++)
+ {
+ assert (distances.size () == i-1);
+
+ Item *r = dynamic_cast<Item*> (cols[i]);
+ Item *rb = r->find_prebroken_piece (LEFT);
+
+ if (Separation_item::is_empty (r) && (!rb || Separation_item::is_empty (rb)))
{
- musical_column_spacing (me, lc, rc, headwid, options);
- if (Item *rb = r->find_prebroken_piece (LEFT))
- musical_column_spacing (me, lc, rb, headwid, options);
+ distances.push_back (0);
+ continue;
}
- else
+
+ Skyline_pair *skys = Skyline_pair::unsmob (r->get_property ("horizontal-skylines"));
+ Real right_stickout = skys ? (*skys)[LEFT].max_height () : 0.0;
+
+ /* min rather than max because right-stickout will be negative if the right-hand column
+ sticks out a lot to the left */
+ right_stickout = min (right_stickout,
+ Separation_item::conditional_skyline (r, cols[i-1]).max_height ());
+
+ Drul_array<Item*> r_cols (r, rb);
+ Drul_array<Real> cur_dist (0.0, 0.0);
+
+ /* 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--;)
{
- /*
- 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 *l = dynamic_cast<Item*> (cols[j]);
Item *lb = l->find_prebroken_piece (RIGHT);
- Item *rb = r->find_prebroken_piece (LEFT);
+ Skyline_pair *skys = Skyline_pair::unsmob (l->get_property ("horizontal-skylines"));
+ Real left_stickout = skys ? (*skys)[RIGHT].max_height () : 0.0;
+ bool done = true;
+
+ Direction d = LEFT;
+ do
+ {
+ if (j < i-1)
+ cur_dist[d] += distances[j];
- if (i == 0 && Paper_column::get_rank (l) == 0)
- l = 0;
+ Item *r_col = r_cols[d];
+ bool touches = right_stickout - left_stickout + cur_dist[d] < 0.0;
+ Real dist = 0.0;
- if (l && r)
- breakable_column_spacing (me, l, r, options);
-
- if (lb && r)
- breakable_column_spacing (me, lb, r, options);
+ /* we set a distance for the line-starter column even if it's non-broken counterpart
+ doesn't touch the right column. */
+ if (lb)
+ Separation_item::set_distance (lb, r_col, padding);
- if (l && rb)
- breakable_column_spacing (me, l, rb, options);
+ if (touches || j == i-1)
+ dist = Separation_item::set_distance (l, r_col, padding);
- if (lb && rb)
- breakable_column_spacing (me, lb, rb, options);
+ if (j == i-1 && d == LEFT)
+ distances.push_back (dist);
+
+ if (j == i-1)
+ cur_dist[d] = distances[j];
+
+ done = done && !touches;
+ }
+ while (flip (&d) != LEFT && rb);
+
+ /* we need the empty check for gregorian notation, where there are a lot of
+ extraneous paper-columns that we need to skip over */
+ if (done && !Separation_item::is_empty (l))
+ break;
}
}
}
+
+void
+Spacing_spanner::generate_springs (Grob *me,
+ vector<Grob*> const &cols,
+ Spacing_options const *options)
+{
+ Paper_column *prev = dynamic_cast<Paper_column*> (cols[0]);
+ for (vsize i = 1; i < cols.size (); i++)
+ {
+ Paper_column *col = dynamic_cast<Paper_column *> (cols[i]);
+ Paper_column *next = (i + 1 < cols.size ()) ? dynamic_cast<Paper_column *> (cols[i+1]) : 0;
+
+ generate_pair_spacing (me, prev, col, next, options);
+
+ prev = col;
+ }
+
+ set_column_rods (cols, 0.1); // FIXME: padding
+}
+
/*
- Generate the space between two musical columns LC and RC, given
- spacing parameters INCR and SHORTEST.
+ Generate the space between two musical columns LEFT_COL and RIGHT_COL.
*/
void
-Spacing_spanner::musical_column_spacing (Grob *me, Item *lc, Item *rc,
- Real increment,
+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, lc, rc, options, &expand_only);
-
- Real compound_note_space = 0.0;
- Real compound_fixed_note_space = 0.0;
+ Real base_note_space = note_spacing (me, left_col, right_col, options);
+ Spring spring;
- if (options->uniform_)
- {
- compound_note_space = base_note_space;
- }
+ if (options->stretch_uniformly_)
+ spring = Spring (base_note_space, 0.0);
else
{
- int wish_count = 0;
-
- extract_grob_set (lc, "right-neighbors", neighbors);
+ vector<Spring> springs;
+ 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 (int i = 0; i < neighbors.size (); i++)
+ for (vsize i = 0; i < neighbors.size (); i++)
{
Grob *wish = neighbors[i];
- Item *wish_rcol = Note_spacing::right_column (wish);
- if (Note_spacing::left_column (wish) != lc
- || (wish_rcol != rc && wish_rcol != rc->original_))
+ Item *wish_rcol = Spacing_interface::right_column (wish);
+ if (Spacing_interface::left_column (wish) != left_col
+ || (wish_rcol != right_col && wish_rcol != right_col->original ()))
continue;
/*
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);
-
- compound_note_space = compound_note_space + space;
- compound_fixed_note_space = compound_fixed_note_space + fixed;
- wish_count++;
+ 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 (Paper_column::when_mom (rc).grace_part_
- && !Paper_column::when_mom (lc).grace_part_)
+ if (springs.empty ())
{
- /*
- Ugh. 0.8 is arbitrary.
- */
- compound_note_space *= 0.8;
- }
- if (compound_note_space < 0 || wish_count == 0)
- {
- compound_note_space = base_note_space;
- compound_fixed_note_space = increment;
+ 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
- {
- compound_note_space /= wish_count;
- compound_fixed_note_space /= wish_count;
- }
+ spring = merge_springs (springs);
+ }
+ if (Paper_column::when_mom (right_col).grace_part_
+ && !Paper_column::when_mom (left_col).grace_part_)
+ {
/*
- 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?
+ Ugh. 0.8 is arbitrary.
*/
- compound_fixed_note_space = min (compound_fixed_note_space,
- compound_note_space);
+ spring *= 0.8;
}
-
- Real inverse_strength = 1.0;
- Real distance = 1.0;
/*
TODO: make sure that the space doesn't exceed the right margin.
{
/*
In packed mode, pack notes as tight as possible. This makes
- sense mostly in combination with raggedright mode: the notes
+ 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 raggedright mode, lily will
- pack as much bars of music as possible into a line, but the
+ 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.
*/
- inverse_strength = 1.0;
- distance = compound_fixed_note_space;
- }
- else
- {
- inverse_strength = (compound_note_space - compound_fixed_note_space);
- distance = compound_note_space;
+ spring.set_distance (max (left_col->extent (left_col, X_AXIS)[RIGHT],
+ spring.min_distance ()));
+ spring.set_inverse_stretch_strength (1.0);
}
- Spaceable_grob::add_spring (lc, rc, distance, inverse_strength);
+ 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;
+
+ if (Paper_column::is_musical (next)
+ || Paper_column::is_musical (left)
+ || !Paper_column::is_musical (col)
+ || !Paper_column::is_used (next))
+ return false;
+
+ Moment dt =
+ Paper_column::when_mom (next) - Paper_column::when_mom (col);
+
+ Moment *len = unsmob_moment (left->get_property ("measure-length"));
+ if (!len)
+ return false;
+
+ /*
+ 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;
+
+ return false;
}
/*
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;
- int wish_count = 0;
+ vector<Spring> springs;
+ Spring spring;
Moment dt = Paper_column::when_mom (r) - Paper_column::when_mom (l);
{
extract_grob_set (l, "spacing-wishes", wishes);
- for (int i = 0; i < wishes.size (); i++)
+ 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 space;
- Real fixed_space;
-
/*
column for the left one settings should be ok due automatic
pointer munging.
-
*/
assert (spacing_grob->get_column () == l);
- Staff_spacing::get_spacing_params (spacing_grob,
- &space, &fixed_space);
-
- if (Paper_column::when_mom (r).grace_part_)
- {
- /*
- Correct for grace notes.
+ springs.push_back (Staff_spacing::get_spacing (spacing_grob, r));
+ }
+ }
- Ugh. The 0.8 is arbitrary.
- */
- space *= 0.8;
- }
+ if (springs.empty ())
+ spring = standard_breakable_column_spacing (me, l, r, options);
+ else
+ spring = merge_springs (springs);
- compound_space += space;
- compound_fixed += fixed_space;
- wish_count++;
- }
+ if (Paper_column::when_mom (r).grace_part_)
+ {
+ /*
+ Correct for grace notes.
+
+ Ugh. The 0.8 is arbitrary.
+ */
+ spring *= 0.8;
}
- if (compound_space <= 0.0 || !wish_count)
+ if (Paper_column::is_musical (r)
+ && l->break_status_dir () == CENTER
+ && fills_measure (me, l, r))
{
- standard_breakable_column_spacing (me, l, r, &compound_fixed, &compound_space,
- options);
- wish_count = 1;
+ spring.set_distance (spring.distance () + 1.0);
+ spring.set_default_strength ();
}
- else
+
+ if (options->stretch_uniformly_ && l->break_status_dir () != RIGHT)
{
- compound_space /= wish_count;
- compound_fixed /= wish_count;
+ spring.set_min_distance (0.0);
+ spring.set_default_strength ();
}
- 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);
+ Spaceable_grob::add_spring (l, r, spring);
}
-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"
+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\n"
- "piece with lots of 8th notes, and some 16th notes, the eighth note\n"
- "gets 2 note heads width (i.e. the space following a note is 1 note\n"
- "head width) A 16th note is followed by 0.5 note head width. The\n"
- "quarter note is followed by 3 NHW, the half by 4 NHW, etc.\n",
-
- "grace-space-factor spacing-increment base-shortest-duration "
- "shortest-duration-space common-shortest-duration uniform-stretching"
-
+ "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 "
);
-ADD_INTERFACE (Spacing_interface, "spacing-interface",
- "Something to do with line breaking and spacing. "
- "Kill this one after determining line breaks.",
- "");
-
projects / lilypond.git / blobdiff