source file of the GNU LilyPond music typesetter
- (c) 1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1999--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
*/
#include "spacing-spanner.hh"
-#include "score-column.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"
-Spacing_spanner::Spacing_spanner ()
+void
+Spacing_spanner::set_interface (Grob*me)
{
- set_elt_property (break_helper_only_scm_sym, SCM_BOOL_T);
- set_elt_property (transparent_scm_sym, SCM_BOOL_T);
-}
-
-int
-Spacing_spanner::col_count () const
-{
- return pscore_l_->line_l_->cols_.size ();
-}
-
-Score_column *
-Spacing_spanner::scol (int i)const
-{
- return dynamic_cast<Score_column*> (pscore_l_->line_l_->cols_[i]);
+ me->set_extent_callback (SCM_EOL, X_AXIS);
+ me->set_extent_callback (SCM_EOL, Y_AXIS) ;
}
/*
- cut 'n paste from spring-spacer.cc
-
- generate springs between columns.
-
The algorithm is partly taken from :
Science, The Ohio State University, 1987.
TOO HAIRY.
+
+ TODO: write comments
*/
-Array<Spring>
-Spacing_spanner::do_measure (int col1, int col2) const
+void
+Spacing_spanner::do_measure (Grob*me, Link_array<Grob> cols)
{
- for (int i =col1; i < col2; i++)
- {
- scol (i)->preprocess ();
- scol (i)->print ();
- }
-
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);
- for (int i =col1; i < col2; i++)
+
+ int n = 0;
+ for (int i =0 ; i < cols.size (); i++)
{
- if (scol(i)->musical_b ())
+ if (dynamic_cast<Paper_column*> (cols[i])->musical_b ())
{
- shortest = shortest <? scol(i)->shortest_starter_mom_;
+ SCM st = cols[i]->get_grob_property ("shortest-starter-duration");
+ Moment this_shortest = *unsmob_moment(st);
+ shortest = shortest <? this_shortest;
+ if (!mean_shortest.infty_b ())
+ {
+ n++;
+ mean_shortest += this_shortest;
+ }
}
}
+ mean_shortest /= n;
- Array<Spring> meas_springs;
- Real non_musical_space_strength = paper_l ()->get_var ("breakable_column_space_strength");
- for (int i= col1; i < col2; i++)
+ for (int i= 0; i < cols.size () - 1; i++)
{
- Item * l = scol(i);
- Item * r = scol(i+1);
- Item * lb = l->find_broken_piece (RIGHT);
- Item * rb = r->find_broken_piece (LEFT);
+ 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
+
+ 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++)
{
- Score_column * lc = dynamic_cast<Score_column*> (combinations[j][0]);
- Score_column *rc = dynamic_cast<Score_column*> (combinations[j][1]);
+ Paper_column * lc = dynamic_cast<Paper_column*> (combinations[j][0]);
+ Paper_column *rc = dynamic_cast<Paper_column*> (combinations[j][1]);
if (!lc || !rc)
continue;
s.item_l_drul_[LEFT] = lc;
s.item_l_drul_[RIGHT] = rc;
- SCM hint = lc->get_elt_property (extra_space_scm_sym);
- SCM next_hint = rc->get_elt_property (extra_space_scm_sym);
- SCM stretch_hint = lc->get_elt_property (stretch_distance_scm_sym);
- SCM next_stretch_hint = rc->get_elt_property (stretch_distance_scm_sym);
+ 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;
- if (hint != SCM_BOOL_F)
+ Real left_distance = 0;
+ if (gh_pair_p (hint))
{
- hint = SCM_CDDR (hint);
-
- left_distance = gh_scm2double (hint);
+ left_distance = gh_scm2double (gh_cdr (hint));
}
- else if (!lc->musical_b() && i+1 < col_count())
+ // 2nd condition should be (i+1 < col_count()), ie. not the last column in score. FIXME
+ else if (!lc->musical_b() && i+1 < cols.size ())
{
- left_distance= default_bar_spacing (lc,rc,shortest);
+ left_distance= default_bar_spacing (me,lc,rc,shortest <? base_shortest_duration);
}
else if (lc->musical_b())
{
- left_distance = note_spacing (lc, rc, shortest);
+ left_distance = note_spacing (me,lc, rc, shortest <? base_shortest_duration);
}
-
+ else
+ programming_error ("uninitialised left_distance");
+
s.distance_f_ = left_distance;
/*
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");
+ 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 (next_hint != SCM_BOOL_F)
+ if (gh_pair_p (next_hint))
{
- next_hint = SCM_CADR(next_hint);
- right_dist += - gh_scm2double (next_hint);
+ right_dist += - gh_scm2double (gh_car (next_hint));
}
else
{
- Interval ext (rc->extent (X_AXIS));
+ 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 (lc->musical_b () && rc->musical_b ())
- {
- if (rc->get_elt_property (contains_grace_scm_sym) == SCM_BOOL_F)
- right_dist *= paper_l ()->get_var ("musical_to_musical_left_spacing_factor");
- }
-
- if (rc->musical_b () && rc->get_elt_property (contains_grace_scm_sym) != SCM_BOOL_F)
- right_dist *= paper_l ()->get_var ("before_grace_spacing_factor");
-
-
- s.distance_f_ = left_distance + right_dist;
+ if (rc->musical_b ())
+ {
+ 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 (stretch_hint != SCM_BOOL_F)
- stretch_dist += gh_scm2double (SCM_CDDR (stretch_hint));
+ if (gh_number_p (stretch_hint))
+ stretch_dist += gh_scm2double (stretch_hint);
else
stretch_dist += left_distance;
- if (next_stretch_hint != SCM_BOOL_F)
+ if (gh_pair_p (next_stretch_hint))
// see regtest spacing-tight
- stretch_dist += - gh_scm2double (SCM_CADR (next_stretch_hint));
+ stretch_dist += - gh_scm2double (gh_car (next_stretch_hint));
else
stretch_dist += right_dist;
if (s.distance_f_ <0)
- programming_error("negative dist");
-
+ {
+ programming_error("Negative dist, setting to 1.0 PT");
+ s.distance_f_ = 1.0;
+ }
if (stretch_dist == 0.0)
{
/*
else
s.strength_f_ /= stretch_dist;
- meas_springs.push (s);
+ s.add_to_cols ();
}
}
-
- return meas_springs;
+
}
/**
Do something if breakable column has no spacing hints set.
*/
Real
-Spacing_spanner::default_bar_spacing (Score_column *lc, Score_column *rc,
- Moment shortest) const
+Spacing_spanner::default_bar_spacing (Grob*me, Grob *lc, Grob *rc,
+ Moment shortest)
{
- Real symbol_distance = lc->extent (X_AXIS)[RIGHT] ;
+ Real symbol_distance = lc->extent (lc,X_AXIS)[RIGHT] ;
Real durational_distance = 0;
- Moment delta_t = rc->when_mom () - lc->when_mom () ;
+ Moment delta_t = Paper_column::when_mom (rc) - Paper_column::when_mom (lc);
/*
ugh should use shortest_playing distance
*/
if (delta_t)
{
- Real k= paper_l()->arithmetic_constant (shortest);
- durational_distance = paper_l()->length_mom_to_dist (delta_t,k);
+ durational_distance = get_duration_space (me, delta_t, shortest);
}
return symbol_distance >? durational_distance;
}
+/**
+ Get the measure wide ant for arithmetic spacing.
+
+ @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::note_spacing (Score_column *lc, Score_column *rc, Moment shortest) const
+Spacing_spanner::get_duration_space (Grob*me, Moment d, Moment shortest)
{
- Moment shortest_playing_len = lc->shortest_playing_mom_;
+ 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"));
+}
+
+
+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 " + lc->when_mom ().str ());
+ programming_error ("can't find a ruling note at " + Paper_column::when_mom (lc).str ());
shortest_playing_len = 1;
}
if (! shortest)
{
- programming_error ("no minimum in measure at " + lc->when_mom ().str ());
+ programming_error ("no minimum in measure at " + Paper_column::when_mom (lc).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);
+ Moment delta_t = Paper_column::when_mom (rc) - Paper_column::when_mom (lc);
+ Real dist = get_duration_space (me, shortest_playing_len, shortest);
dist *= (double)(delta_t / shortest_playing_len);
- dist += stem_dir_correction (lc,rc);
+ /*
+ UGH: KLUDGE!
+ */
+
+ if (delta_t > Moment (1,32))
+ dist += stem_dir_correction (me, lc,rc);
return dist;
}
This should be more advanced, since relative heights of the note
heads also influence required correction.
- Also might not work correctly ico. multi voices or staff changing voices
+ 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?
- This routine reads the DIR_LIST property of both its L and R arguments.
-*/
+ 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. */
Real
-Spacing_spanner::stem_dir_correction (Score_column*l, Score_column*r) const
+Spacing_spanner::stem_dir_correction (Grob*me, Grob*l, Grob*r)
{
- SCM dl = l->get_elt_property (dir_list_scm_sym);
- SCM dr = r->get_elt_property (dir_list_scm_sym);
- if (dl == SCM_BOOL_F || dr == SCM_BOOL_F)
- return 0.0;
-
- dl = SCM_CDR (dl);
- dr = SCM_CDR (dr);
-
- if (scm_ilength (dl) != 1 && scm_ilength (dr) != 1)
+ 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.;
- dl = SCM_CAR(dl);
- dr = SCM_CAR(dr);
+ dl = gh_car (dl);
+ dr = gh_car (dr);
assert (gh_number_p (dl) && gh_number_p(dr));
int d1 = gh_scm2int (dl);
if (d1 == d2)
return 0.0;
- bool err = false;
- Real correction = 0.0;
- Real ssc = paper_l ()->get_realvar(ly_symbol ("stemSpacingCorrection"));
+ Real correction = 0.0;
+ Real ssc = gh_scm2double (me->get_grob_property("stem-spacing-correction"));
- if (d1 && d2)
+ if (d1 && d2 && d1 * d2 == -1)
{
- if (d1 == 1 && d2 == -1)
- correction = ssc;
- else if (d1 == -1 && d2 == 1)
- correction = -ssc;
- else
- err = true;
+ correction = d1 * ssc;
}
-
else
- err = true;
-
- if (err)
programming_error ("Stem directions not set correctly for optical correction");
return correction;
}
-Array<Spring>
-Spacing_spanner::get_springs () const
+MAKE_SCHEME_CALLBACK(Spacing_spanner, set_springs,1);
+SCM
+Spacing_spanner::set_springs (SCM smob)
{
- Array<Spring> springs;
- int last_break =0;
- for (int i=1; i < col_count (); i++)
+ Grob *me = unsmob_grob (smob);
+ Link_array<Grob> all (me->pscore_l_->line_l_->column_l_arr ()) ;
+
+ int j = 0;
+
+ for (int i = 1; i < all.size (); i++)
{
- if (scol (i)->breakable_b ())
+ Grob *sc = all[i];
+ if (Item::breakable_b (sc))
{
- springs.concat (do_measure (last_break, i));
- last_break = i;
+ Link_array<Grob> measure (all.slice (j, i+1));
+ do_measure (me, measure);
+ j = i;
}
}
- return springs;
-}
+ /*
+ farewell, cruel world
+ */
+ me->suicide ();
+ return SCM_UNSPECIFIED;
+}
+/*
+ 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