/*
- 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 <hanwen@cs.uu.nl>
+ (c) 1999--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
*/
-#include "spacing-spanner.hh"
-#include "score-column.hh"
-#include "dimensions.hh"
+#include <math.h>
+#include <stdio.h>
+
+#include "system.hh"
#include "paper-def.hh"
-#include "warn.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"
+
-Spacing_spanner::Spacing_spanner ()
-{
- set_elt_property ("transparent", SCM_BOOL_T);
-}
-int
-Spacing_spanner::col_count () const
-{
- return pscore_l_->line_l_->cols_.size ();
-}
-Score_column *
-Spacing_spanner::scol (int i)const
+/*
+ paper-column:
+ */
+class Spacing_spanner
{
- return dynamic_cast<Score_column*> (pscore_l_->line_l_->cols_[i]);
-}
+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_colunms (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*);
+};
/*
- cut 'n paste from spring-spacer.cc
+ Return whether COL is fixed to its neighbors by some kind of spacing
+ constraint.
+*/
+static bool
+loose_column (Grob *l, Grob *c, Grob *r)
+{
+ 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.
- generate springs between columns.
+ (this happens in the following situation:
+ |
+ | clef G
+ *
- The algorithm is partly taken from :
+ | | ||
+ | | ||
+ O O ||
- 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.
+ 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->column_l();
+ 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;
+
+
+ /*
+ 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));
+
+ if (h && h->get_grob_property ("break-align-symbol") == ly_symbol2scm ("bar-line"))
+ return false;
+ }
+ }
+ }
- */
-Array<Spring>
-Spacing_spanner::do_measure (int col1, int col2) const
-{
- for (int i =col1; i < col2; i++)
+ /*
+ 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)))
{
- scol (i)->preprocess ();
- scol (i)->print ();
+ return true;
}
- Moment shortest;
- shortest.set_infinite (1);
- for (int i =col1; i < col2; i++)
+
+ /*
+ If in doubt: we're not loose; the spacing engine should space for
+ it, risking suboptimal spacing.
+
+ (Otherwise, we might risk core dumps, and other weird stuff.)
+
+ */
+ return false;
+}
+
+/*
+ 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
+Spacing_spanner::prune_loose_colunms (Grob*me,Link_array<Grob> *cols, Rational shortest)
+{
+ Link_array<Grob> newcols;
+ Real increment = gh_scm2double (me->get_grob_property ("spacing-increment"));
+ for (int i=0; i < cols->size (); i++)
{
- if (scol(i)->musical_b ())
+ if (Item::breakable_b (cols->elem(i)) || Paper_column::musical_b (cols->elem (i)))
+ {
+ 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_f_ = 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
{
- shortest = shortest <? scol(i)->shortest_starter_mom_;
+ newcols.push (c);
}
}
- Array<Spring> meas_springs;
+ *cols = newcols;
+}
- Real non_musical_space_strength = paper_l ()->get_var ("breakable_column_space_strength");
- for (int i= col1; i < col2; i++)
+/*
+ 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++)
{
- Item * l = scol(i);
- Item * r = scol(i+1);
- Item * lb = l->find_broken_piece (RIGHT);
- Item * rb = r->find_broken_piece (LEFT);
+ SCM right_neighbors = SCM_EOL;
+ int min_rank = 100000; // inf.
- Item* combinations[4][2]={{l,r}, {lb,r}, {l,rb},{lb,rb}};
- for (int j=0; j < 4; j++)
+ SCM wishes= cols[i]->get_grob_property ("spacing-wishes");
+ for (SCM s =wishes; gh_pair_p (s); s = gh_cdr (s))
{
- Score_column * lc = dynamic_cast<Score_column*> (combinations[j][0]);
- Score_column *rc = dynamic_cast<Score_column*> (combinations[j][1]);
- if (!lc || !rc)
+ Item * wish = dynamic_cast<Item*> (unsmob_grob (gh_car (s)));
+
+ Item * lc = wish->column_l ();
+ Grob * right = Note_spacing::right_column (wish);
+
+ if (!right)
continue;
- 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");
+ Item * rc = dynamic_cast<Item*> (right);
+
+ int right_rank = Paper_column::rank_i (rc);
+ int left_rank = Paper_column::rank_i (lc);
- Real left_distance;
- if (hint != SCM_UNDEFINED)
+ /*
+ update the left column.
+ */
+ if (right_rank <= min_rank)
{
- left_distance = gh_scm2double (gh_cdr (hint));
+ if (right_rank < min_rank)
+ right_neighbors =SCM_EOL;
+
+ min_rank = right_rank;
+ right_neighbors = gh_cons (wish->self_scm (), right_neighbors);
}
- else if (!lc->musical_b() && i+1 < col_count())
+
+ /*
+ 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)))
{
- left_distance= default_bar_spacing (lc,rc,shortest);
+ Item * it = dynamic_cast<Item*> (unsmob_grob (gh_car (left_neighs)));
+ maxrank = Paper_column::rank_i (it->column_l());
}
- else if (lc->musical_b())
+
+ if (left_rank >= maxrank)
{
- left_distance = note_spacing (lc, rc, shortest);
+ 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);
}
+ }
- s.distance_f_ = left_distance;
+ if (gh_pair_p (right_neighbors))
+ {
+ cols[i]->set_grob_property ("right-neighbors", right_neighbors);
+ }
+ }
+}
- /*
- Only do tight spaces *after* barlines (breakable columns),
- not before.
+/*
+ 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;
- We want the space before barline to be like the note
- spacing in the measure.
- */
- 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");
+ // it->breakable || it->musical
+ /*
+ 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));
+ }
+
+ 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));
+ }
+ }
+}
+
+
+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 ()) ;
+
+ set_explicit_neighbor_columns (all);
+
+ Rational global_shortest = find_shortest (me, all);
+ prune_loose_colunms (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)
+{
+ /*
+ ascending in duration
+ */
+ 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]))
+ {
+ Moment *when = unsmob_moment (cols[i]->get_grob_property ("when"));
+
+ /*
+ ignore grace notes for shortest notes.
+ */
+ if (when && when->grace_part_)
+ continue;
- Real right_dist = 0.0;
- if (next_hint != SCM_UNDEFINED)
- {
- right_dist += - gh_scm2double (gh_car (next_hint));
- }
- else
+ SCM st = cols[i]->get_grob_property ("shortest-starter-duration");
+ Moment this_shortest = *unsmob_moment (st);
+ assert (this_shortest.to_bool());
+ shortest_in_measure = shortest_in_measure <? this_shortest.main_part_;
+ }
+ else if (!shortest_in_measure.infty_b()
+ && Item::breakable_b (cols[i]))
+ {
+ int j = 0;
+ for (; j < durations.size(); j++)
{
- Interval ext (rc->extent (X_AXIS));
- right_dist = ext.empty_b() ? 0.0 : - ext [LEFT];
+ 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;
+ }
}
- /*
- don't want to create too much extra space for accidentals
- */
- if (lc->musical_b () && rc->musical_b ())
+ if (durations.size() == j)
{
- if (rc->get_elt_property ("contains-grace") == SCM_UNDEFINED)
- right_dist *= paper_l ()->get_var ("musical_to_musical_left_spacing_factor");
+ durations.push (shortest_in_measure);
+ counts.push (1);
}
- 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;
+ shortest_in_measure.set_infinite(1);
+ }
+ }
+
+ int max_idx = -1;
+ int max_count = 0;
+ for (int 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_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] ;
+
+ return d;
+}
+
+/*
+ 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)
+{
+
+ Real headwid = gh_scm2double (me->get_grob_property ("spacing-increment"));
+ 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));
+
+ Paper_column * lc = dynamic_cast<Paper_column*> (l);
+ Paper_column * rc = dynamic_cast<Paper_column*> (r);
+
+ if (!Paper_column::musical_b (l))
+ {
+ breakable_column_spacing (me, l, r, shortest);
+
+ /*
- 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 (SCM_CAR (next_stretch_hint));
- else
- stretch_dist += right_dist;
-
- if (s.distance_f_ <0)
- programming_error("negative dist");
+ 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 (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 (lb)
+ breakable_column_spacing (me, lb,r, shortest);
+
+ if (rb)
+ breakable_column_spacing (me, l, rb, shortest);
+ if (lb && rb)
+ breakable_column_spacing (me, lb, rb, shortest);
- meas_springs.push (s);
+ continue ;
}
- }
- return meas_springs;
+
+ musical_column_spacing (me, lc, rc, headwid, shortest);
+ if (Item *rb = r->find_prebroken_piece (LEFT))
+ musical_column_spacing (me, lc, rb, headwid, shortest);
+ }
}
-/**
- Do something if breakable column has no spacing hints set.
+
+/*
+ Generate the space between two musical columns LC and RC, given
+ spacing parameters INCR and SHORTEST.
*/
-Real
-Spacing_spanner::default_bar_spacing (Score_column *lc, Score_column *rc,
- Moment shortest) const
+void
+Spacing_spanner::musical_column_spacing (Grob *me, Item * lc, Item *rc, Real increment, Rational shortest)
{
- Real symbol_distance = lc->extent (X_AXIS)[RIGHT] ;
- Real durational_distance = 0;
- Moment delta_t = rc->when_mom () - lc->when_mom () ;
+ bool expand_only = false;
+ Real base_note_space = note_spacing (me, lc, rc, shortest, &expand_only);
+
+ Real max_note_space = -infinity_f;
+ Real max_fixed_note_space = -infinity_f;
+
+ SCM seq = lc->get_grob_property ("right-neighbors");
/*
- ugh should use shortest_playing distance
+ 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.
*/
- if (delta_t)
+ for (SCM s = seq; gh_pair_p (s); s = ly_cdr (s))
+ {
+ Grob * wish = unsmob_grob (gh_car (s));
+
+ Item *wish_rcol = Note_spacing::right_column (wish);
+ if (Note_spacing::left_column (wish) != lc
+ || (wish_rcol != rc && wish_rcol != rc->original_l_))
+ continue;
+
+ /*
+ 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);
+ max_note_space = max_note_space >? space;
+ max_fixed_note_space = max_fixed_note_space >? fixed;
+ }
+ }
+
+ if (max_note_space < 0)
{
- Real k= paper_l()->arithmetic_constant (shortest);
- durational_distance = paper_l()->length_mom_to_dist (delta_t,k);
+ max_note_space = base_note_space;
+ max_fixed_note_space = increment;
}
- return symbol_distance >? durational_distance;
+ bool ragged = to_boolean (me->paper_l ()->get_scmvar ("raggedright"));
+
+ /*
+ 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?
+ */
+ max_fixed_note_space = max_fixed_note_space <? max_note_space;
+
+ Real strength = (ragged) ? 1.0 : 1 / (max_note_space - max_fixed_note_space);
+ Real distance = (ragged) ? max_fixed_note_space : max_note_space;
+ // Spaceable_grob::add_spring (lc, rc, distance, strength, expand_only);
+
+ Spaceable_grob::add_spring (lc, rc, distance, strength, false);
}
-Real
-Spacing_spanner::note_spacing (Score_column *lc, Score_column *rc, Moment shortest) const
+/*
+ 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)
{
- Moment shortest_playing_len = lc->shortest_playing_mom_;
- if (! shortest_playing_len)
+ *fixed = l->extent (l, X_AXIS)[RIGHT] - r->extent (r, X_AXIS)[LEFT];
+
+ if (l->breakable_b (l) && r->breakable_b(r))
{
- programming_error ("Can't find a ruling note at " + lc->when_mom ().str ());
- shortest_playing_len = 1;
+ Moment *dt = unsmob_moment (l->get_grob_property ("measure-length"));
+ Moment mlen (1);
+ if (dt)
+ mlen = *dt;
+
+ Real incr = gh_scm2double (me->get_grob_property ("spacing-increment"));
+
+ *space = *fixed + incr * double (mlen.main_part_ / shortest.main_part_) * 0.8;
}
-
- if (! shortest)
+ else
{
- programming_error ("no minimum in measure at " + lc->when_mom ().str ());
- shortest = 1;
- }
- 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);
+ Moment dt = Paper_column::when_mom (r) - Paper_column::when_mom (l);
+ bool dummy;
- dist += stem_dir_correction (lc,rc);
- return dist;
+ *space = *fixed + get_duration_space (me, dt, shortest.main_part_, &dummy);
+ }
+
+
}
-/**
- 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.
+/*
+ Read hints from L and generate springs.
+ */
+void
+Spacing_spanner::breakable_column_spacing (Grob*me, Item* l, Item *r,Moment shortest)
+{
+ Real max_fixed = -infinity_f;
+ Real max_space = -infinity_f;
- This should be more advanced, since relative heights of the note
- heads also influence required correction.
+ standard_breakable_column_spacing (me, l, r, &max_fixed, &max_space ,
+ 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)));
- Also might not work correctly ico. multi voices or staff changing voices
+ if (!spacing_grob || !Staff_spacing::has_interface (spacing_grob))
+ continue;
- TODO: lookup correction distances? More advanced correction?
- Possibly turn this off?
+ Real space;
+ Real fixed_space;
- This routine reads the DIR_LIST property of both its L and R arguments.
-*/
-Real
-Spacing_spanner::stem_dir_correction (Score_column*l, Score_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;
+ /*
+ column for the left one settings should be ok due automatic
+ pointer munging.
+ */
+ assert (spacing_grob-> column_l () == l);
- if (scm_ilength (dl) != 1 && scm_ilength (dr) != 1)
- return 0.;
+ Staff_spacing::get_spacing_params (spacing_grob,
+ &space, &fixed_space);
+ if (space > max_space)
+ {
+ max_space = space;
+ max_fixed = fixed_space;
+ }
+ }
- dl = SCM_CAR(dl);
- dr = SCM_CAR(dr);
+
+
+
+ if (isinf (max_space))
+ {
+ /*
+ One situation where this can happen is when there is a column
+ that only serves as a spanning point for a short staff-symbol.
- assert (gh_number_p (dl) && gh_number_p(dr));
- int d1 = gh_scm2int (dl);
- int d2 = gh_scm2int (dr);
+ ===============X===
- if (d1 == d2)
- return 0.0;
+ |=======Y
- bool err = false;
- Real correction = 0.0;
- Real ssc = paper_l ()->get_var("stemSpacingCorrection");
+ (here no StaffSpacing from Y to X is found.)
+ */
+ programming_error ("No StaffSpacing wishes found");
+ max_space = 2.0;
+ max_fixed = 1.0;
+ }
- if (d1 && d2)
+
+ if (l->break_status_dir() == RIGHT
+ && Paper_column::when_mom (l) == Paper_column::when_mom (r))
{
- if (d1 == 1 && d2 == -1)
- correction = ssc;
- else if (d1 == -1 && d2 == 1)
- correction = -ssc;
- else
- err = true;
+ /* Start of line: this space is not stretchable */
+ max_fixed = max_space;
}
-
- else
- err = true;
- if (err)
- programming_error ("Stem directions not set correctly for optical correction");
- return correction;
+ /*
+ Hmm. we do 1/0 in the next thing. Perhaps we should check if this
+ works on all architectures.
+ */
+
+ bool ragged = to_boolean (me->paper_l ()->get_scmvar ("raggedright"));
+ Real strength = (ragged) ? 1.0 : 1 / (max_space - max_fixed);
+ Real distance = (ragged) ? max_fixed : max_space;
+ Spaceable_grob::add_spring (l, r, distance, strength, false);
}
+
+
+/**
+ Get the measure wide ant for arithmetic spacing.
+ */
+Real
+Spacing_spanner::get_duration_space (Grob*me, Moment d, Rational shortest, bool * expand_only)
+{
+ Real k = gh_scm2double (me->get_grob_property ("shortest-duration-space"));
+ Real incr = gh_scm2double (me->get_grob_property ("spacing-increment"));
+ 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.)
+
+ This should probably be tunable, to use other base numbers.
+
+ 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)}
+
+
+ */
+ Rational ratio = d.main_part_ / shortest;
+
+ *expand_only = true;
+ return ((k-1) + double (ratio)) * incr;
+ }
+ else
+ {
+ /*
+ 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;
+ }
+}
-Array<Spring>
-Spacing_spanner::get_springs () const
+Real
+Spacing_spanner::note_spacing (Grob*me, Grob *lc, Grob *rc,
+ Moment shortest, bool * expand_only)
{
- Array<Spring> springs;
- int last_break =0;
- for (int i=1; i < col_count (); i++)
+ Moment shortest_playing_len = 0;
+ SCM s = lc->get_grob_property ("shortest-playing-duration");
+
+ if (unsmob_moment (s))
+ shortest_playing_len = *unsmob_moment (s);
+
+ if (! shortest_playing_len.to_bool ())
{
- if (scol (i)->breakable_b ())
- {
- springs.concat (do_measure (last_break, i));
- last_break = i;
- }
+ programming_error ("can't find a ruling note at " + Paper_column::when_mom (lc).str ());
+ shortest_playing_len = 1;
+ }
+
+ Moment lwhen = Paper_column::when_mom (lc);
+ Moment rwhen = Paper_column::when_mom (rc);
+
+ Moment delta_t = rwhen - lwhen;
+ Real dist = 0.0;
+
+ /*
+ 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.
+
+ */
+ 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_);
}
- return springs;
+ 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 = 1.0;
+ SCM gf = me->get_grob_property ("grace-space-factor");
+ if (gh_number_p (gf))
+ grace_fact = gh_scm2double (gf);
+
+ dist *= grace_fact;
+ }
+
+
+ return dist;
}
+ADD_INTERFACE (Spacing_spanner,"spacing-spanner-interface",
+ "
+The space taken by a note is dependent on its duration. Doubling a
+duration adds spacing-increment to the space. The most common shortest
+note gets shortest-duration-space. Notes that are even shorter are
+spaced proportonial to their duration.
+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 2 note heads width (i.e. the space following a note is 1 note
+head width) A 16th note is followed by 0.5 note head width. The
+quarter note is followed by 3 NHW, the half by 4 NHW, etc.
+",
+ "grace-space-factor spacing-increment base-shortest-duration shortest-duration-space");
projects / lilypond.git / blobdiff