/*
- spacing-spanner.cc -- implement Spacing_spanner
+ spacing-spanner.cc -- implement Spacing_spanner
source file of the GNU LilyPond music typesetter
- (c) 1999--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1999--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
*/
-#include "spacing-spanner.hh"
-#include "paper-column.hh"
-#include "dimensions.hh"
-#include "paper-def.hh"
+#include <math.h>
+#include <stdio.h>
+
+#include "main.hh"
+#include "system.hh"
#include "warn.hh"
+#include "paper-def.hh"
#include "paper-score.hh"
-#include "line-of-score.hh"
+#include "paper-column.hh"
+#include "item.hh"
+#include "moment.hh"
+#include "note-spacing.hh"
#include "misc.hh"
+#include "warn.hh"
+#include "staff-spacing.hh"
+#include "spring.hh"
+#include "paper-column.hh"
+#include "spaceable-grob.hh"
+#include "break-align-interface.hh"
+#include "spacing-interface.hh"
-void
-Spacing_spanner::set_interface (Grob*me)
-{
- me->set_extent_callback (SCM_EOL, X_AXIS);
- me->set_extent_callback (SCM_EOL, Y_AXIS) ;
-}
-#if 0
-struct Note_run
+/*
+ TODO: this file/class is too complex. Should figure out how to chop
+ this up even more.
+
+ */
+
+class Spacing_spanner
{
- Array<int> idxes;
- int start, end;
- Moment duration;
- int count;
+public:
+ static void standard_breakable_column_spacing (Grob * me, Item*l, Item*r,
+ Real * fixed, Real * space, Moment);
+
+
+ static Real default_bar_spacing (Grob*,Grob*,Grob*,Moment);
+ static Real note_spacing (Grob*,Grob*,Grob*,Moment, bool*);
+ static Real get_duration_space (Grob*,Moment dur, Rational shortest, bool*);
+ static Rational find_shortest (Grob *, Link_array<Grob> const &);
+ static void breakable_column_spacing (Grob*, Item* l, Item *r, Moment);
+ static void find_loose_columns () {}
+ static void prune_loose_columns (Grob*,Link_array<Grob> *cols, Rational);
+ static void find_loose_columns (Link_array<Grob> cols);
+ static void set_explicit_neighbor_columns (Link_array<Grob> cols);
+ static void set_implicit_neighbor_columns (Link_array<Grob> cols);
+ static void do_measure (Rational, Grob*me,Link_array<Grob> *cols);
+ static void musical_column_spacing (Grob*,Item*,Item*, Real, Rational);
+ DECLARE_SCHEME_CALLBACK (set_springs, (SCM ));
+ static bool has_interface (Grob*);
};
-int
-column_compare (Grob *const &t1, Grob *const &t2)
-{
- return Moment::compare (Paper_column::when_mom (t1),
- Paper_column::when_mom (t2));
-}
+/*
+ Return whether COL is fixed to its neighbors by some kind of spacing
+ constraint.
+
+ If in doubt, then we're not loose; the spacing engine should space
+ for it, risking suboptimal spacing.
+
+ (Otherwise, we might risk core dumps, and other weird stuff.)
-Note_run
-run_length (Moment dt, int i, Array<Moment> const &moms,
- Link_array<Note_run> runs)
+*/
+static bool
+loose_column (Grob *l, Grob *c, Grob *r)
{
- int k = 0;
- Array<int> idxes;
+ SCM rns = c->get_grob_property ("right-neighbors");
+ SCM lns = c->get_grob_property ("left-neighbors");
+
+ /*
+ If this column doesn't have a proper neighbor, we should really
+ make it loose, but spacing it correctly is more than we can
+ currently can handle.
+
+ (this happens in the following situation:
+
+ |
+ | clef G
+ *
+
+ | | ||
+ | | ||
+ O O ||
- idxes.push (i);
- while (1)
+
+ the column containing the clef is really loose, and should be
+ attached right to the first column, but that is a lot of work for
+ such a borderline case.)
+
+ */
+ if (!gh_pair_p (lns) || !gh_pair_p (rns))
+ return false;
+
+ Item * l_neighbor = dynamic_cast<Item*> (unsmob_grob (gh_car (lns)));
+ Item * r_neighbor = dynamic_cast<Item*> (unsmob_grob (gh_car (rns)));
+
+ if (!l_neighbor || !r_neighbor)
+ return false;
+
+ l_neighbor = l_neighbor->get_column ();
+ r_neighbor = dynamic_cast<Item*> (Note_spacing::right_column (r_neighbor));
+
+ if (l == l_neighbor && r == r_neighbor)
+ return false;
+
+ if (!l_neighbor || !r_neighbor)
+ return false;
+
+
+
+ /*
+ Only declare loose if the bounds make a little sense. This means
+ some cases (two isolated, consecutive clef changes) won't be
+ nicely folded, but hey, then don't do that.
+ */
+ if(! ((Paper_column::musical_b (l_neighbor) || Item::breakable_b (l_neighbor))
+ && (Paper_column::musical_b (r_neighbor) || Item::breakable_b (r_neighbor))) )
{
- 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++;
+ return false;
}
- Moment dur = idxes.size ()
+
+ /*
+ A rather hairy check, but we really only want to move around clefs. (anything else?)
+
+ in any case, we don't want to move bar lines.
+ */
+ for (SCM e = c->get_grob_property ("elements"); gh_pair_p (e); e = gh_cdr (e))
+ {
+ Grob * g = unsmob_grob (gh_car (e));
+ if (g && Break_align_interface::has_interface (g))
+ {
+ for (SCM s = g->get_grob_property ("elements"); gh_pair_p (s);
+ s = gh_cdr (s))
+ {
+ Grob *h = unsmob_grob (gh_car (s));
+
+ /*
+ ugh. -- fix staff-bar name?
+ */
+ if (h && h->get_grob_property ("break-align-symbol") == ly_symbol2scm ("staff-bar"))
+ return false;
+ }
+ }
+ }
+
+ return true;
}
+/*
+ Remove columns that are not tightly fitting from COLS. In the
+ removed columns, set 'between-cols to the columns where it is in
+ between.
+*/
void
-find_runs (Grob*me, Link_array<Grob> cols)
+Spacing_spanner::prune_loose_columns (Grob*me,Link_array<Grob> *cols, Rational shortest)
{
- Link_array<Grob> filter_cols;
- Array<Moment> col_moments;
- for (int i = 0; i < cols.size (); i++)
+ Link_array<Grob> newcols;
+ Real increment = robust_scm2double (me->get_grob_property ("spacing-increment"), 1.2);
+ for (int i=0; i < cols->size (); i++)
{
- Moment w = Paper_column::when_mom (cols[i]);
-
- if (!w.grace_part_ && Paper_column::musical_b (cols[i]))
+ if (Item::breakable_b (cols->elem(i)) || Paper_column::musical_b (cols->elem (i)))
{
- filter_cols.push (cols[i]);
- col_moments.push (w);
+ newcols.push (cols->elem(i));
+ continue;
+ }
+
+ Grob *c = cols->elem(i);
+ if (loose_column (cols->elem (i-1), c, cols->elem (i+1)))
+ {
+ SCM lns = c->get_grob_property ("left-neighbors");
+ lns = gh_pair_p (lns) ? gh_car (lns) : SCM_BOOL_F;
+
+ SCM rns = c->get_grob_property ("right-neighbors");
+ rns = gh_pair_p (rns) ? gh_car (rns) : SCM_BOOL_F;
+
+ /*
+ Either object can be non existent, if the score ends
+ prematurely.
+ */
+ rns = gh_car (unsmob_grob (rns)->get_grob_property ("right-items"));
+ c->set_grob_property ("between-cols", gh_cons (lns,
+ rns));
+
+ /*
+ Set distance constraints for loose columns
+ */
+ Drul_array<Grob*> next_door;
+ next_door[LEFT] =cols->elem (i - 1);
+ next_door[RIGHT] =cols->elem (i + 1);
+ Direction d = LEFT;
+ Drul_array<Real> dists(0,0);
+
+ do
+ {
+ dists[d] = 0.0;
+ Item *lc = dynamic_cast<Item*> ((d == LEFT) ? next_door[LEFT] : c);
+ Item *rc = dynamic_cast<Item*> (d == LEFT ? c : next_door[RIGHT]);
+
+ for (SCM s = lc->get_grob_property ("spacing-wishes");
+ gh_pair_p (s); s = gh_cdr (s))
+ {
+ Grob *sp = unsmob_grob (gh_car (s));
+ if (Note_spacing::left_column (sp) != lc
+ || Note_spacing::right_column (sp) != rc)
+ continue;
+
+ Real space, fixed;
+ fixed = 0.0;
+ bool dummy;
+
+ if (d == LEFT)
+ {
+ /*
+ The note spacing should be taken from the musical
+ columns.
+
+ */
+ Real base = note_spacing (me, lc, rc, shortest, &dummy);
+ Note_spacing::get_spacing (sp, rc, base, increment, &space, &fixed);
+
+ space -= increment;
+
+ dists[d] = dists[d] >? space;
+ }
+ else
+ {
+ Real space, fixed_space;
+ Staff_spacing::get_spacing_params (sp,
+ &space, &fixed_space);
+
+ dists[d] = dists[d] >? fixed_space;
+ }
+
+ }
+ }
+ while (flip (&d) != LEFT);
+
+ Rod r;
+ r.distance_ = dists[LEFT] + dists[RIGHT];
+ r.item_l_drul_[LEFT] = dynamic_cast<Item*> (cols->elem(i-1));
+ r.item_l_drul_[RIGHT] = dynamic_cast<Item*> (cols->elem (i+1));
+
+ r.add_to_cols ();
+ }
+ else
+ {
+ newcols.push (c);
}
}
- Moment end_mom = col_moments.top ();
- for (int i = 0; i < col_moments.size () ; i++)
+ *cols = newcols;
+}
+
+/*
+ Set neighboring columns determined by the spacing-wishes grob property.
+*/
+void
+Spacing_spanner::set_explicit_neighbor_columns (Link_array<Grob> cols)
+{
+ for (int i=0; i < cols.size(); i++)
{
- for (int j = i+1; j < col_moments.size (); j++)
+ SCM right_neighbors = SCM_EOL;
+ int min_rank = 100000; // inf.
+
+
+ SCM wishes= cols[i]->get_grob_property ("spacing-wishes");
+ for (SCM s =wishes; gh_pair_p (s); s = gh_cdr (s))
+ {
+ Item * wish = dynamic_cast<Item*> (unsmob_grob (gh_car (s)));
+
+ Item * lc = wish->get_column ();
+ Grob * right = Note_spacing::right_column (wish);
+
+ if (!right)
+ continue;
+
+ Item * rc = dynamic_cast<Item*> (right);
+
+ int right_rank = Paper_column::get_rank (rc);
+ int left_rank = Paper_column::get_rank (lc);
+
+ /*
+ update the left column.
+ */
+ if (right_rank <= min_rank)
+ {
+ if (right_rank < min_rank)
+ right_neighbors =SCM_EOL;
+
+ min_rank = right_rank;
+ right_neighbors = gh_cons (wish->self_scm (), right_neighbors);
+ }
+
+ /*
+ update the right column of the wish.
+ */
+ int maxrank = 0;
+ SCM left_neighs = rc->get_grob_property ("left-neighbors");
+ if (gh_pair_p (left_neighs)
+ && unsmob_grob (gh_car (left_neighs)))
+ {
+ Item * it = dynamic_cast<Item*> (unsmob_grob (gh_car (left_neighs)));
+ maxrank = Paper_column::get_rank (it->get_column ());
+ }
+
+ if (left_rank >= maxrank)
+ {
+ if (left_rank > maxrank)
+ left_neighs = SCM_EOL;
+
+ left_neighs = gh_cons (wish->self_scm (), left_neighs);
+ rc->set_grob_property ("left-neighbors", right_neighbors);
+ }
+ }
+
+ if (gh_pair_p (right_neighbors))
{
- Moment dt = Paper_column::col_momentsfilter_cols
+ cols[i]->set_grob_property ("right-neighbors", right_neighbors);
}
}
}
-#endif
/*
+ Set neighboring columns that have no left/right-neighbor set
+ yet. Only do breakable non-musical columns, and musical columns.
+*/
+void
+Spacing_spanner::set_implicit_neighbor_columns (Link_array<Grob> cols)
+{
+ for (int i = 0; i < cols.size (); i++)
+ {
+ Item * it = dynamic_cast<Item*>(cols[i]);
+ if (!Item::breakable_b (it) && !Paper_column::musical_b (it))
+ continue;
+
+ // it->breakable || it->musical
- The algorithm is partly taken from :
+ /*
+ sloppy with typnig left/right-neighbors should take list, but paper-column found instead.
+ */
+ SCM ln = cols[i] ->get_grob_property ("left-neighbors");
+ if (!gh_pair_p (ln) && i )
+ {
+ cols[i]->set_grob_property ("left-neighbors", gh_cons (cols[i-1]->self_scm(), SCM_EOL));
+ }
- 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.
+ SCM rn = cols[i] ->get_grob_property ("right-neighbors");
+ if (!gh_pair_p (rn) && i < cols.size () - 1)
+ {
+ cols[i]->set_grob_property ("right-neighbors", gh_cons (cols[i + 1]->self_scm(), SCM_EOL));
+ }
+ }
+}
- TOO HAIRY.
- TODO: write comments
-
- */
-void
-Spacing_spanner::do_measure (Grob*me, Link_array<Grob> const & cols)
+MAKE_SCHEME_CALLBACK (Spacing_spanner, set_springs,1);
+SCM
+Spacing_spanner::set_springs (SCM smob)
{
- Moment shortest;
- Moment mean_shortest;
+ Grob *me = unsmob_grob (smob);
+
+ Link_array<Grob> all (me->pscore_->system_->columns ());
+
+ set_explicit_neighbor_columns (all);
+
+ SCM preset_shortest = me->get_grob_property ("common-shortest-duration");
+ Rational global_shortest;
+ if (unsmob_moment (preset_shortest))
+ {
+ global_shortest = unsmob_moment (preset_shortest)->main_part_;
+ }
+ else
+ {
+ global_shortest = find_shortest (me, all);
+ if (verbose_global_b)
+ {
+ progress_indication (_f("Global shortest duration is %s\n", global_shortest.to_string ()));
+ }
+ }
+ prune_loose_columns (me, &all, global_shortest);
+ set_implicit_neighbor_columns (all);
+
+
+ int j = 0;
+ for (int i = 1; i < all.size (); i++)
+ {
+ Grob *sc = all[i];
+ if (Item::breakable_b (sc))
+ {
+ Link_array<Grob> measure (all.slice (j, i+1));
+ do_measure (global_shortest, me, &measure);
+ j = i;
+ }
+ }
+
+ return SCM_UNSPECIFIED;
+}
+
+/*
+ We want the shortest note that is also "common" in the piece, so we
+ find the shortest in each measure, and take the most frequently
+ found duration.
+
+ This probably gives weird effects with modern music, where every
+ note has a different duration, but hey, don't write that kind of
+ stuff, then.
+
+*/
+Rational
+Spacing_spanner::find_shortest (Grob *me, Link_array<Grob> const &cols)
+{
/*
- space as if this duration is present.
+ ascending in duration
*/
- Moment base_shortest_duration = *unsmob_moment (me->get_grob_property ("maximum-duration-for-spacing"));
- shortest.set_infinite (1);
-
- int n = 0;
+ Array<Rational> durations;
+ Array<int> counts;
+
+ Rational shortest_in_measure;
+ shortest_in_measure.set_infinite (1);
+
for (int i =0 ; i < cols.size (); i++)
{
if (Paper_column::musical_b (cols[i]))
/*
ignore grace notes for shortest notes.
- */
+ */
if (when && when->grace_part_)
continue;
SCM st = cols[i]->get_grob_property ("shortest-starter-duration");
Moment this_shortest = *unsmob_moment (st);
- shortest = shortest <? this_shortest;
- if (!mean_shortest.main_part_.infty_b ())
+ assert (this_shortest.to_bool());
+ shortest_in_measure = shortest_in_measure <? this_shortest.main_part_;
+ }
+ else if (!shortest_in_measure.is_infinity ()
+ && Item::breakable_b (cols[i]))
+ {
+ int j = 0;
+ for (; j < durations.size(); j++)
{
- n++;
- mean_shortest += this_shortest;
+ if (durations[j] > shortest_in_measure)
+ {
+ counts.insert (1, j);
+ durations.insert (shortest_in_measure, j);
+ break;
+ }
+ else if (durations[j] == shortest_in_measure)
+ {
+ counts[j]++;
+ break;
+ }
}
+
+ if (durations.size() == j)
+ {
+ durations.push (shortest_in_measure);
+ counts.push (1);
+ }
+
+ shortest_in_measure.set_infinite(1);
}
}
- mean_shortest /= n;
- Array<Spring> springs;
- for (int i= 0; i < cols.size () - 1; i++)
+ int max_idx = -1;
+ int max_count = 0;
+ for (int i =durations.size(); i--;)
{
- 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));
-
- Item* combinations[4][2]={{l,r}, {lb,r}, {l,rb},{lb,rb}};
-
-
- /*
- left refers to the space that is associated with items of the left column, so you have
+ if (counts[i] >= max_count)
+ {
+ max_idx = i;
+ max_count = counts[i];
+ }
- LC <- left_space -><- right_space -> RC
- <- total space ->
-
+ // printf ("duration %d/%d, count %d\n", durations[i].num (), durations[i].den (), counts[i]);
+ }
- 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;
+ SCM bsd = me->get_grob_property ("base-shortest-duration");
+ Rational d = Rational (1,8);
+ if (Moment *m = unsmob_moment (bsd))
+ d = m->main_part_;
+
+ if (max_idx >= 0)
+ d = d <? durations[max_idx] ;
- 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");
+ return d;
+}
- Real left_distance = 0;
- if (gh_pair_p (hint))
- {
- left_distance = gh_scm2double (ly_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;
+/*
+ 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 (Rational shortest, Grob*me, Link_array<Grob> *cols)
+{
- /*
- Only do tight spaces *after* barlines (breakable columns),
- not before.
+ Real headwid = robust_scm2double (me->get_grob_property ("spacing-increment"), 1);
+ for (int i= 0; i < cols->size () - 1; i++)
+ {
+ Item * l = dynamic_cast<Item*> (cols->elem (i));
+ Item * r = dynamic_cast<Item*> (cols->elem (i+1));
- 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);
+ Paper_column * lc = dynamic_cast<Paper_column*> (l);
+ Paper_column * rc = dynamic_cast<Paper_column*> (r);
-
- Real right_dist = 0.0;
- if (gh_pair_p (next_hint))
- {
- right_dist += - gh_scm2double (ly_car (next_hint));
- }
- else
- {
- Interval ext (rc->extent (rc, X_AXIS));
- right_dist = ext.empty_b () ? 0.0 : - ext [LEFT];
- }
+ if (!Paper_column::musical_b (l))
+ {
+ breakable_column_spacing (me, l, r, shortest);
/*
- 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;
+ 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 = l->find_prebroken_piece (RIGHT);
+ Item *rb = r->find_prebroken_piece (LEFT);
- if (gh_pair_p (next_stretch_hint))
- // see regtest spacing-tight
- stretch_dist += - gh_scm2double (ly_car (next_stretch_hint));
- else
- stretch_dist += right_dist;
+ if (lb)
+ breakable_column_spacing (me, lb,r, shortest);
- 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;
+ if (rb)
+ breakable_column_spacing (me, l, rb, shortest);
+ if (lb && rb)
+ breakable_column_spacing (me, lb, rb, shortest);
- springs.push (s);
+ continue ;
}
- }
- Spacing_spanner::stretch_to_regularity (me, &springs, cols);
- for (int i=springs.size (); i --;)
- springs[i].add_to_cols ();
+
+ musical_column_spacing (me, lc, rc, headwid, shortest);
+ if (Item *rb = r->find_prebroken_piece (LEFT))
+ musical_column_spacing (me, lc, rb, headwid, shortest);
+ }
}
-/*
- 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.
+/*
+ Generate the space between two musical columns LC and RC, given
+ spacing parameters INCR and SHORTEST.
+ */
+void
+Spacing_spanner::musical_column_spacing (Grob *me, Item * lc, Item *rc, Real increment, Rational shortest)
+{
+ bool expand_only = false;
+ Real base_note_space = note_spacing (me, lc, rc, shortest, &expand_only);
- TODO:
+ Real compound_note_space = 0.0;
+ Real compound_fixed_note_space = 0.0;
+ int wish_count = 0;
- -- inefficient code; maybe it is easier to twiddle with the springs
- after they've become grob properties (ie. have their
- minimum-distances set)
+ SCM seq = lc->get_grob_property ("right-neighbors");
- -- does not adjust strength field of the springs very well: result
- awkward spacing at the start of a line. (?)
+ /*
+ We adjust the space following a note only if the next note
+ happens after the current note (this is set in the grob
+ property SPACING-SEQUENCE.
+ */
+ for (SCM s = seq; gh_pair_p (s); s = ly_cdr (s))
+ {
+ Grob * wish = unsmob_grob (gh_car (s));
- -- will be confused when there are multiple equispaced runs in a measure.
+ Item *wish_rcol = Note_spacing::right_column (wish);
+ if (Note_spacing::left_column (wish) != lc
+ || (wish_rcol != rc && wish_rcol != rc->original_))
+ continue;
- -- dealing with springs for line breaks is a little tricky; in any
- case, we will only space per measure.
+ /*
+ This is probably a waste of time in the case of polyphonic
+ music. */
+ if (Note_spacing::has_interface (wish))
+ {
+ Real space =0.0;
+ Real fixed =0.0;
+
+ Note_spacing::get_spacing (wish, rc, base_note_space, increment, &space, &fixed);
- -- we scale to actual distances, not to optical effects. Eg. if the
- equispaced run contains optical corrections, then the scaling will
- cancel those.
+
+ compound_note_space = compound_note_space + space;
+ compound_fixed_note_space = compound_fixed_note_space + fixed;
+ wish_count ++;
+
+ }
+ }
- -- Regular_spacing_engraver doesn't mark the first column of the
- next bar, making the space before a barline too short, in this case
+ if (Paper_column::when_mom (rc).grace_part_ &&
+ !Paper_column::when_mom (lc).grace_part_)
+ {
+ /*
+ 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;
+ }
+ else
+ {
+ compound_note_space /= wish_count;
+ compound_fixed_note_space /= wish_count;
+ }
+ /*
+ Whatever we do, the fixed space is smaller than the real
+ space.
- x<- 16ths--> x(8th)
- x(8th) x(8th) <- equispaced run.
-
-*/
+ TODO: this criterion is discontinuous in the derivative.
+ Maybe it should be continuous?
+ */
+ compound_fixed_note_space = compound_fixed_note_space <? compound_note_space;
+
+ bool packed = to_boolean (me->get_paper ()->get_scmvar ("packed"));
+ Real strength, distance;
-void
-Spacing_spanner::stretch_to_regularity (Grob *me,
- Array<Spring> * springs,
- Link_array<Grob> const & cols)
-{
/*
- 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.
-
+ TODO: make sure that the space doesn't exceed the right margin.
*/
- Grob * first_regular_spaced_col = 0;
- for (int i = 0 ; i < cols.size () && !first_regular_spaced_col; i++)
+ if (packed)
{
- SCM rdt = cols[i]->get_grob_property ("regular-distance-to");
- if (cols.find_l (unsmob_grob (rdt)))
- first_regular_spaced_col = unsmob_grob (rdt);
+ /*
+ 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.
+ */
+ strength = 1.0;
+ distance = compound_fixed_note_space;
+ }
+ else
+ {
+ strength = 1 / (compound_note_space - compound_fixed_note_space);
+ distance = compound_note_space;
}
- 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++)
- ;
+ // Spaceable_grob::add_spring (lc, rc, distance, strength, expand_only);
- 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;
-
+ Spaceable_grob::add_spring (lc, rc, distance, strength, false);
+}
- /*
- 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)
+/*
+ The one-size-fits all spacing. It doesn't take into account
+ different spacing wishes from one to the next column.
+ */
+void
+Spacing_spanner::standard_breakable_column_spacing (Grob * me, Item*l, Item*r,
+ Real * fixed, Real * space,
+ Moment shortest)
+{
+ *fixed = 0.0;
+ Direction d = LEFT;
+ Drul_array<Item*> cols(l,r);
+
+ do
+ {
+ if (!Paper_column::musical_b (cols[d]))
{
- maxdist = maxdist >? dist;
- dist = 0.0;
- last_regular_spaced_col = last_col;
+ /*
+ Tied accidentals over barlines cause problems, so lets see
+ what happens if we do this for non musical columns only.
+ */
+ Interval lext = cols[d]->extent (cols [d], X_AXIS);
+ if (!lext.is_empty ())
+ *fixed += -d * lext[-d];
}
-
}
+ while (flip (&d) != LEFT);
+
- /*
- 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++)
+ if (l->breakable_b (l) && r->breakable_b(r))
{
- Spring *s = &springs->elem_ref (j);
- if (s->item_l_drul_[LEFT] != last_col)
- continue;
- dist += s->distance_f_;
+ Moment *dt = unsmob_moment (l->get_grob_property ("measure-length"));
+ Moment mlen (1);
+ if (dt)
+ mlen = *dt;
+
+ Real incr = robust_scm2double (me->get_grob_property ("spacing-increment"), 1);
+
+ *space = *fixed + incr * double (mlen.main_part_ / shortest.main_part_) * 0.8;
+ }
+ else
+ {
+ Moment dt = Paper_column::when_mom (r) - Paper_column::when_mom (l);
- 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)
+ if (dt == Moment (0,0))
+ {
+ /*
+ In this case, Staff_spacing should handle the job,
+ using dt when it is 0 is silly.
+ */
+ *space = *fixed + 0.5;
+ }
+ else
{
- 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;
+ bool dummy;
+ *space = *fixed + get_duration_space (me, dt, shortest.main_part_, &dummy);
}
}
}
-/**
- Do something if breakable column has no spacing hints set.
- */
-Real
-Spacing_spanner::default_bar_spacing (Grob*me, Grob *lc, Grob *rc,
- Moment shortest)
+
+/*
+ Read hints from L and generate springs.
+*/
+void
+Spacing_spanner::breakable_column_spacing (Grob*me, Item* l, Item *r,Moment shortest)
{
- 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 compound_fixed = 0.0;
+ Real compound_space = 0.0;
+ int wish_count = 0;
- /*
- ugh should use shortest_playing distance
- */
- if (delta_t.to_bool ())
+ Moment dt = Paper_column::when_mom (r) - Paper_column::when_mom (l);
+
+ if (dt == Moment (0,0))
{
- durational_distance = get_duration_space (me, delta_t, shortest);
- }
+ for (SCM s = l->get_grob_property ("spacing-wishes");
+ gh_pair_p (s); s = gh_cdr (s))
+ {
+ Item * spacing_grob = dynamic_cast<Item*> (unsmob_grob (gh_car (s)));
- return symbol_distance >? durational_distance;
-}
+ if (!spacing_grob || !Staff_spacing::has_interface (spacing_grob))
+ continue;
+ Real space;
+ Real fixed_space;
-/**
- Get the measure wide ant for arithmetic spacing.
+ /*
+ column for the left one settings should be ok due automatic
+ pointer munging.
+
+ */
+ assert (spacing_grob-> get_column () == l);
- @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.
+ Staff_spacing::get_spacing_params (spacing_grob,
+ &space, &fixed_space);
- */
-Real
-Spacing_spanner::get_duration_space (Grob*me, Moment d, Moment shortest)
-{
- Real log = log_2 (shortest.main_part_);
- Real k = gh_scm2double (me->get_grob_property ("arithmetic-basicspace"))
- - log;
+ if (Paper_column::when_mom (r).grace_part_)
+ {
+ /*
+ Correct for grace notes.
- Rational compdur = d.main_part_ + d.grace_part_ / Rational (3);
- return (log_2 (compdur) + k) * gh_scm2double (me->get_grob_property ("arithmetic-multiplier"));
-}
+ Ugh. The 0.8 is arbitrary.
+ */
+ space *= 0.8;
+ }
-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");
+ compound_space += space;
+ compound_fixed += fixed_space;
+ 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.to_bool ())
+ if (compound_space <= 0.0 || !wish_count)
{
- programming_error ("can't find a ruling note at " + Paper_column::when_mom (lc).str ());
- shortest_playing_len = 1;
+ standard_breakable_column_spacing (me, l, r, &compound_fixed, &compound_space ,
+ shortest);
+ wish_count = 1;
}
-
- if (! shortest.to_bool ())
+ else
{
- programming_error ("no minimum in measure at " + Paper_column::when_mom (lc).str ());
- shortest = 1;
+ compound_space /= wish_count;
+ compound_fixed /= wish_count;
}
- Moment delta_t = Paper_column::when_mom (rc) - Paper_column::when_mom (lc);
- Real dist = get_duration_space (me, shortest_playing_len, shortest);
+ assert (!isinf (compound_space));
+ compound_space = compound_space >? compound_fixed;
+
/*
- ugh: 0.1 is an arbitrary distance.
+ Hmm. we do 1/0 in the next thing. Perhaps we should check if this
+ works on all architectures.
*/
- dist *= (double) (delta_t.main_part_ / shortest_playing_len.main_part_)
- + 0.1 * (double) (delta_t.grace_part_ / shortest_playing_len.main_part_);
-
-
/*
- UGH: KLUDGE!
- */
-
- if (delta_t > Moment (Rational (1,32)))
- dist += stem_dir_correction (me, lc,rc);
-
+ There used to be code that changed spacing depending on
+ raggedright setting. Ugh.
- Moment *lm = unsmob_moment (lc->get_grob_property ("when"));
- Moment *rm = unsmob_moment (rc->get_grob_property ("when"));
-
- if (lm && rm)
- {
- if (lm->grace_part_ && rm->grace_part_)
- dist *= 0.5;
- else if (!rm->grace_part_ && lm->grace_part_)
- dist *= 0.7;
- }
-
-
- return dist;
+ Do it more cleanly, or rename the property.
+
+ */
+ Real strength = 1 / (compound_space - compound_fixed);
+ Real distance = compound_space;
+ Spaceable_grob::add_spring (l, r, distance, strength, 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.
-
- This should be more advanced, since relative heights of the note
- heads also influence required correction.
-
- Also might not work correctly in case of multi voices or staff
- changing voices
-
- TODO: lookup correction distances? More advanced correction?
- Possibly turn this off?
-
- TODO: have to check wether the stems are in the same staff.
-
- This routine reads the DIR-LIST property of both its L and R arguments. */
+ Get the measure wide ant for arithmetic spacing.
+ */
Real
-Spacing_spanner::stem_dir_correction (Grob*me, Grob*l, Grob*r)
+Spacing_spanner::get_duration_space (Grob*me, Moment d, Rational shortest, bool * expand_only)
{
- SCM dl = l->get_grob_property ("dir-list");
- SCM dr = r->get_grob_property ("dir-list");
+ Real k = robust_scm2double (me->get_grob_property ("shortest-duration-space"), 1);
+ Real incr = robust_scm2double (me->get_grob_property ("spacing-increment"), 1);
- if (scm_ilength (dl) != 1 || scm_ilength (dr) != 1)
- return 0.;
-
- dl = ly_car (dl);
- dr = ly_car (dr);
+ if (d < shortest)
+ {
+ /*
+ We don't space really short notes using the log of the
+ duration, since it would disproportionally stretches the long
+ notes in a piece. In stead, we use geometric spacing with constant 0.5
+ (i.e. linear.)
- assert (gh_number_p (dl) && gh_number_p (dr));
- int d1 = gh_scm2int (dl);
- int d2 = gh_scm2int (dr);
+ This should probably be tunable, to use other base numbers.
- if (d1 == d2)
- return 0.0;
+ In Mozart hrn3 by EB., we have 8th note = 3.9 mm (total), 16th note =
+ 3.6 mm (total). head-width = 2.4, so we 1.2mm for 16th, 1.5
+ mm for 8th. (white space), suggesting that we use
+ (1.2 / 1.5)^{-log2(duration ratio)}
+
- Real correction = 0.0;
- Real ssc = gh_scm2double (me->get_grob_property ("stem-spacing-correction"));
+ */
+ Rational ratio = d.main_part_ / shortest;
- if (d1 && d2 && d1 * d2 == -1)
- {
- correction = d1 * ssc;
+ return ((k-1) + double (ratio)) * incr;
}
else
- programming_error ("Stem directions not set correctly for optical correction");
- return correction;
+ {
+ /*
+ John S. Gourlay. ``Spacing a Line of Music,'' Technical
+ Report OSU-CISRC-10/87-TR35, Department of Computer and
+ Information Science, The Ohio State University, 1987.
+ */
+ Real log = log_2 (shortest);
+ k -= log;
+ Rational compdur = d.main_part_ + d.grace_part_ /Rational (3);
+ *expand_only = false;
+
+ return (log_2 (compdur) + k) * incr;
+ }
}
-
-MAKE_SCHEME_CALLBACK (Spacing_spanner, set_springs,1);
-SCM
-Spacing_spanner::set_springs (SCM smob)
+Real
+Spacing_spanner::note_spacing (Grob*me, Grob *lc, Grob *rc,
+ Moment shortest, bool * expand_only)
{
- Grob *me = unsmob_grob (smob);
- Link_array<Grob> all (me->pscore_l_->line_l_->column_l_arr ()) ;
+ Moment shortest_playing_len = 0;
+ SCM s = lc->get_grob_property ("shortest-playing-duration");
- int j = 0;
+ if (unsmob_moment (s))
+ shortest_playing_len = *unsmob_moment (s);
+
+ if (! shortest_playing_len.to_bool ())
+ {
+ programming_error ("can't find a ruling note at " + Paper_column::when_mom (lc).to_string ());
+ shortest_playing_len = 1;
+ }
- for (int i = 1; i < all.size (); i++)
+ Moment lwhen = Paper_column::when_mom (lc);
+ Moment rwhen = Paper_column::when_mom (rc);
+
+ Moment delta_t = rwhen - lwhen;
+ if (!Paper_column::musical_b (rc ))
{
- Grob *sc = all[i];
- if (Item::breakable_b (sc))
- {
- Link_array<Grob> measure (all.slice (j, i+1));
- do_measure (me, measure);
- j = i;
- }
+ /*
+ when toying with mmrests, it is possible to have musical
+ column on the left and non-musical on the right, spanning
+ several measures.
+
+ In 2.0.1, this still fucks up in an interesting way:
+
+
+\score {
+{ \property Score.skipBars = ##t
+ \context Staff = clarinet
+ {
+ \notes {
+ \time 3/4 \mark "72"
+<< s1*0^"all" R4*3*11 >>
+ \mark "73"
+ R4*3*11 \mark "74"
+ d2 r4
+
+
+ }}}
+ \paper { raggedright = ##t }
+}
+
+
+ */
+
+ Moment *dt = unsmob_moment (rc->get_grob_property ("measure-length"));
+ if (dt)
+ delta_t = delta_t <? *dt;
}
+ Real dist = 0.0;
/*
- farewell, cruel world
+ In normal situations, the next column is at most
+ SHORTEST_PLAYING_LEN away. However chord-tremolos do funky faking stuff
+ with durations, invalidating this assumption. Here we kludge
+ around to get chord tremolos to behave properly.
+
*/
- me->suicide ();
- return SCM_UNSPECIFIED;
-}
+ shortest_playing_len = shortest_playing_len >? delta_t;
+ if (delta_t.main_part_ && !lwhen.grace_part_)
+ {
+ dist = get_duration_space (me, shortest_playing_len, shortest.main_part_, expand_only);
+ dist *= (double) (delta_t.main_part_ / shortest_playing_len.main_part_);
+ }
+ else if (delta_t.grace_part_)
+ {
+ /*
+ TODO: figure out how to space grace notes.
+ */
+ dist = get_duration_space (me, shortest, shortest.main_part_, expand_only);
+ Real grace_fact
+ = robust_scm2double (me->get_grob_property ("grace-space-factor"), 1);
+ dist *= grace_fact;
+ }
-/*
- 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.)
- */
+ return dist;
+}
+
+
+
+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 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",
+ "grace-space-factor spacing-increment base-shortest-duration shortest-duration-space common-shortest-duration");
+
+
+
+ADD_INTERFACE (Spacing_interface,"spacing-interface",
+ "Something to do with line breaking and spacing. Kill this one after determining line breaks.",
+ "");
+