-/*
- 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--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+*/
#include "spacing-spanner.hh"
-#include "score-column.hh"
-#include "dimensions.hh"
-#include "paper-def.hh"
+
+#include <math.h>
+#include <cstdio>
+using namespace std;
+
+#include "international.hh"
+#include "main.hh"
+#include "moment.hh"
+#include "note-spacing.hh"
+#include "output-def.hh"
+#include "paper-column.hh"
+#include "paper-score.hh"
+#include "pointer-group-interface.hh"
+#include "spaceable-grob.hh"
+#include "spacing-interface.hh"
+#include "staff-spacing.hh"
+#include "system.hh"
#include "warn.hh"
-#include "p-score.hh"
-#include "line-of-score.hh"
-Spacing_spanner::Spacing_spanner ()
-{
- 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
+/*
+ TODO:
+
+ use callback instead?
+
+*/
+Rational
+Spacing_spanner::effective_shortest_duration (Grob *me,
+ vector<Grob*> const &all)
{
- return pscore_l_->line_l_->cols_.size ();
+ 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;
}
-Score_column *
-Spacing_spanner::scol (int i)const
+
+MAKE_SCHEME_CALLBACK (Spacing_spanner, set_springs, 1);
+SCM
+Spacing_spanner::set_springs (SCM smob)
{
- return dynamic_cast<Score_column*> (pscore_l_->line_l_->cols_[i]);
-}
+ Spanner *me = unsmob_spanner (smob);
-/*
- cut 'n paste from spring-spacer.cc
+ /*
+ can't use get_system() ? --hwn.
+ */
+ vector<Grob*> all (get_root_system (me)->columns ());
+ vsize start = binary_search (all, (Grob*)me->get_bound (LEFT),
+ &Paper_column::compare);
+ vsize end = binary_search (all, (Grob*) me->get_bound (RIGHT),
+ &Paper_column::compare);
+
+ all = vector<Grob*>::vector<Grob*> (all.begin () + start,
+ all.begin () + end + 1);
+
+ set_explicit_neighbor_columns (all);
+
+ Spacing_options options;
+ options.init_from_grob (me);
+ options.global_shortest_ = effective_shortest_duration (me, all);
- generate springs between columns.
+ prune_loose_columns (me, &all, &options);
+ set_implicit_neighbor_columns (all);
+ generate_springs (me, all, &options);
+ return SCM_UNSPECIFIED;
+}
- The algorithm is partly taken from :
+/*
+ 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.
- 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.
-
- */
-Array<Spring>
-Spacing_spanner::do_measure (int col1, int col2) const
+ 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, vector<Grob*> const &cols)
{
- for (int i =col1; i < col2; i++)
+ /*
+ ascending in duration
+ */
+ vector<Rational> durations;
+ vector<int> counts;
+
+ Rational shortest_in_measure;
+ shortest_in_measure.set_infinite (1);
+
+ for (vsize i = 0; i < cols.size (); i++)
{
- scol (i)->preprocess ();
- scol (i)->print ();
+ if (Paper_column::is_musical (cols[i]))
+ {
+ Moment *when = unsmob_moment (cols[i]->get_property ("when"));
+
+ /*
+ ignore grace notes for shortest notes.
+ */
+ if (when && when->grace_part_)
+ continue;
+
+ SCM st = cols[i]->get_property ("shortest-starter-duration");
+ Moment this_shortest = *unsmob_moment (st);
+ assert (this_shortest.to_bool ());
+ shortest_in_measure = min (shortest_in_measure, this_shortest.main_part_);
+ }
+ else if (!shortest_in_measure.is_infinity ()
+ && Paper_column::is_breakable (cols[i]))
+ {
+ vsize j = 0;
+ for (; j < durations.size (); j++)
+ {
+ if (durations[j] > shortest_in_measure)
+ {
+ counts.insert (counts.begin () + j, 1);
+ durations.insert (durations.begin () + j, shortest_in_measure);
+ break;
+ }
+ else if (durations[j] == shortest_in_measure)
+ {
+ counts[j]++;
+ break;
+ }
+ }
+
+ if (durations.size () == j)
+ {
+ durations.push_back (shortest_in_measure);
+ counts.push_back (1);
+ }
+
+ shortest_in_measure.set_infinite (1);
+ }
}
- Moment shortest;
- shortest.set_infinite (1);
- for (int i =col1; i < col2; i++)
+ int max_idx = -1;
+ int max_count = 0;
+ for (vsize i = durations.size (); i--;)
{
- if (scol(i)->musical_b ())
+ if (counts[i] >= max_count)
{
- shortest = shortest <? scol(i)->shortest_starter_mom_;
+ max_idx = i;
+ max_count = counts[i];
}
+
+ // printf ("duration %d/%d, count %d\n",
+ // durations[i].num (), durations[i].den (), counts[i]);
}
- Array<Spring> meas_springs;
+ SCM bsd = me->get_property ("base-shortest-duration");
+ Rational d = Rational (1, 8);
+ if (Moment *m = unsmob_moment (bsd))
+ d = m->main_part_;
+
+ if (max_idx >= 0)
+ d = min (d, durations[max_idx]);
+
+ return d;
+}
- Real non_musical_space_strength = paper_l ()->get_var ("non_musical_space_strength");
- for (int i= col1; i < col2; i++)
+void
+Spacing_spanner::generate_pair_spacing (Grob *me,
+ Paper_column *left_col, Paper_column *right_col,
+ Paper_column *after_right_col,
+ Spacing_options const *options)
+{
+ if (Paper_column::is_musical (left_col))
{
- Item * l = scol(i);
- Item * r = scol(i+1);
- Item * lb = l->find_prebroken_piece (RIGHT);
- Item * rb = r->find_prebroken_piece (LEFT);
+ bool skip_unbroken_right = false;
- Item* combinations[4][2]={{l,r}, {lb,r}, {l,rb},{lb,rb}};
+ if (!Paper_column::is_musical (right_col)
+ && options->float_nonmusical_columns_
+ && after_right_col
+ && Paper_column::is_musical (after_right_col))
+ skip_unbroken_right = true;
- for (int i=0; i < 4; i++)
+ if (skip_unbroken_right)
{
- Score_column * lc = dynamic_cast<Score_column*> (combinations[i][0]);
- Score_column *rc = dynamic_cast<Score_column*> (combinations[i][1]);
- if (!lc || !rc)
- continue;
+ /*
+ 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);
- Spring s;
- 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);
-
- if (hint != SCM_BOOL_F)
- {
- hint = SCM_CDDR (hint);
-
- s.distance_f_ = gh_scm2double (hint);
- if (!lc->musical_b ())
- s.strength_f_ = 2.0;
- }
- else if (!lc->musical_b() && i+1 < col_count())
- {
- s.distance_f_ = default_bar_spacing (lc,rc,shortest);
- s.strength_f_ = non_musical_space_strength; // fixed after complaints by michael krause
- }
- else if (lc->musical_b())
- {
- s.distance_f_ = note_spacing (lc, rc, shortest);
-
- }
-
- if (next_hint != SCM_BOOL_F)
- {
- next_hint = SCM_CADR(next_hint);
- s.distance_f_ += gh_scm2double (next_hint);
- }
- else
- {
- Interval ext (rc->extent (X_AXIS));
- Real correction = ext.empty_b() ? 0.0 : - ext [LEFT];
+ 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);
- /*
- don't want to create too much extra space for accidentals
- */
- if (lc->musical_b () && rc->musical_b ())
- correction /= 2.0;
+ if (left_col && right_col)
+ breakable_column_spacing (me, left_col, right_col, options);
- s.distance_f_ += correction;
- }
+ if (lb && right_col)
+ breakable_column_spacing (me, lb, right_col, options);
- if (s.distance_f_ <=0)
- {
- /*
- \bar "". We give it 0 space, with high strength.
- */
- s.distance_f_ = 0.0 PT;
- s.strength_f_ = 20.0;
- }
- meas_springs.push (s);
- }
+ if (left_col && rb)
+ breakable_column_spacing (me, left_col, rb, options);
+
+ if (lb && rb)
+ breakable_column_spacing (me, lb, rb, options);
}
+}
+
+void
+Spacing_spanner::generate_springs (Grob *me,
+ vector<Grob*> const &cols,
+ Spacing_options const *options)
+{
+ Paper_column *prev = 0;
+ for (vsize i = 0; i < cols.size (); i++)
+ {
+ Paper_column *col = dynamic_cast<Paper_column *> (cols[i]);
+ Paper_column *next = (i < cols.size()-1) ? dynamic_cast<Paper_column *> (cols[i+1]) : 0;
+
+ if (i > 0)
+ generate_pair_spacing (me, prev, col, next, options);
- return meas_springs;
+ prev = col;
+ }
}
-/**
- 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
+/*
+ Generate the space between two musical columns LEFT_COL and RIGHT_COL, given
+ spacing parameters INCR and SHORTEST.
+*/
+void
+Spacing_spanner::musical_column_spacing (Grob *me,
+ Item *left_col,
+ Item *right_col,
+ Spacing_options const *options)
{
- 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, left_col, right_col, options, &expand_only);
- /*
- ugh should use shortest_playing distance
- */
- if (delta_t)
+ Real max_fixed = 0;
+ Real max_space = 0;
+ Real compound_note_space = 0.0;
+ Real compound_fixed_note_space = 0.0;
+
+ if (options->stretch_uniformly_)
{
- Real k= paper_l()->arithmetic_constant (shortest);
- durational_distance = paper_l()->length_mom_to_dist (delta_t,k);
+ compound_note_space = base_note_space;
+
+ if (!Paper_column::is_musical (right_col))
+ {
+ /*
+ Crude fix for notes that lead up to barlines and time sigs.
+ */
+ Interval lext = right_col->extent (right_col, X_AXIS);
+ if (!lext.is_empty ())
+ compound_note_space += -lext[LEFT];
+ }
+
}
+ else
+ {
+ int wish_count = 0;
- return symbol_distance >? durational_distance;
-}
+ 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 (vsize i = 0; i < neighbors.size (); i++)
+ {
+ Grob *wish = neighbors[i];
-Real
-Spacing_spanner::note_spacing (Score_column *lc, Score_column *rc, Moment shortest) const
-{
- Moment shortest_playing_len = lc->shortest_playing_mom_;
- if (! shortest_playing_len)
+ Item *wish_rcol = Note_spacing::right_column (wish);
+ if (Note_spacing::left_column (wish) != left_col
+ || (wish_rcol != right_col && wish_rcol != right_col->original ()))
+ 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, right_col, base_note_space, options->increment_, &space, &fixed);
+
+
+ max_space = max (max_space, space);
+ max_fixed = max (max_fixed, fixed);
+
+ compound_note_space += space;
+ compound_fixed_note_space += fixed;
+ wish_count++;
+ }
+ }
+
+ if (Paper_column::when_mom (right_col).grace_part_
+ && !Paper_column::when_mom (left_col).grace_part_)
+ {
+ /*
+ Ugh. 0.8 is arbitrary.
+ */
+ compound_note_space *= 0.8;
+ }
+
+ if (compound_note_space < 0 || wish_count == 0)
+ {
+ /*
+ Fixed should be 0.0. If there are no spacing wishes, we're
+ likely dealing with polyphonic spacing of hemiolas.
+
+ We used to have compound_fixed_note_space = options->increment_
+
+ but this can lead to numeric instability problems when we
+ do
+
+ inverse_strength = (compound_note_space - compound_fixed_note_space)
+
+ */
+
+ compound_note_space = base_note_space;
+ compound_fixed_note_space = 0.0;
+ }
+ else if (to_boolean (me->get_property ("average-spacing-wishes")))
+ {
+ compound_note_space /= wish_count;
+ compound_fixed_note_space /= wish_count;
+ }
+ else
+ {
+ compound_fixed_note_space = max_fixed;
+ compound_note_space = max_space;
+ }
+
+ /*
+ 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?
+ */
+ compound_fixed_note_space = min (compound_fixed_note_space,
+ compound_note_space);
+ }
+
+ Real inverse_strength = 1.0;
+ Real distance = 1.0;
+
+ /*
+ TODO: make sure that the space doesn't exceed the right margin.
+ */
+ if (options->packed_)
{
- warning (_f ("can't find a ruling note at %s",
- lc->when_mom ().str ()));
- shortest_playing_len = 1;
+ /*
+ 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.
+ */
+ inverse_strength = 1.0;
+ distance = compound_fixed_note_space;
}
- if (! shortest)
+ else
{
- warning (_f ("no minimum in measure at %s",
- lc->when_mom ().str ()));
- shortest = 1;
+ inverse_strength = (compound_note_space - compound_fixed_note_space);
+ distance = compound_note_space;
}
- 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);
- dist += stem_dir_correction (lc,rc);
- return dist;
+ Spaceable_grob::add_spring (left_col, right_col, distance, inverse_strength);
}
+/*
+ Read hints from L and generate springs.
+*/
+void
+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;
+ Real max_fixed = 0.0;
+ Real max_space = 0.0;
+
+ int wish_count = 0;
-/**
- 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.
+ Moment dt = Paper_column::when_mom (r) - Paper_column::when_mom (l);
- Also might not work correctly ico. multi voices or staff changing voices
+ if (dt == Moment (0, 0))
+ {
+ extract_grob_set (l, "spacing-wishes", wishes);
- TODO: lookup correction distances? More advanced correction?
- Possibly turn this off?
+ for (vsize i = 0; i < wishes.size (); i++)
+ {
+ Item *spacing_grob = dynamic_cast<Item *> (wishes[i]);
- 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_sym);
- SCM dr = r->get_elt_property (dir_list_scm_sym);
- if (dl == SCM_BOOL_F || dr == SCM_BOOL_F)
- return 0.0;
+ if (!spacing_grob || !Staff_spacing::has_interface (spacing_grob))
+ continue;
- dl = SCM_CDR (dl);
- dr = SCM_CDR (dr);
+ Real space;
+ Real fixed_space;
- if (scm_ilength (dl) != 1 && scm_ilength (dr) != 1)
- return 0.;
+ /*
+ column for the left one settings should be ok due automatic
+ pointer munging.
- dl = SCM_CAR(dl);
- dr = SCM_CAR(dr);
+ */
+ assert (spacing_grob->get_column () == l);
- assert (gh_number_p (dl) && gh_number_p(dr));
- int d1 = gh_scm2int (dl);
- int d2 = gh_scm2int (dr);
+ Staff_spacing::get_spacing_params (spacing_grob,
+ &space, &fixed_space);
- if (d1 == d2)
- return 0.0;
+ if (Paper_column::when_mom (r).grace_part_)
+ {
+ /*
+ Correct for grace notes.
- bool err = false;
- Real correction = 0.0;
- Real ssc = paper_l ()->get_realvar(ly_symbol ("stemSpacingCorrection"));
+ Ugh. The 0.8 is arbitrary.
+ */
+ space *= 0.8;
+ }
+ max_space = max (max_space, space);
+ max_fixed = max (max_fixed, fixed_space);
+
+ compound_space += space;
+ compound_fixed += fixed_space;
+ wish_count++;
+ }
+ }
- if (d1 && d2)
+ if (compound_space <= 0.0 || !wish_count)
{
- if (d1 == 1 && d2 == -1)
- correction = ssc;
- else if (d1 == -1 && d2 == 1)
- correction = -ssc;
- else
- err = true;
+ standard_breakable_column_spacing (me, l, r, &compound_fixed, &compound_space,
+ options);
+ wish_count = 1;
}
-
else
- err = true;
-
- if (err)
- programming_error ("Stem directions not set correctly for optical correction");
- return correction;
-}
-
-
-Array<Spring>
-Spacing_spanner::get_springs () const
-{
- Array<Spring> springs;
- int last_break =0;
- for (int i=1; i < col_count (); i++)
{
- if (scol (i)->breakable_b ())
- {
- springs.concat (do_measure (last_break, i));
- last_break = i;
- }
+ if (to_boolean (me->get_property ("average-spacing-wishes")))
+ {
+ compound_space /= wish_count;
+ compound_fixed /= wish_count;
+ }
+ else
+ {
+ compound_fixed = max_fixed;
+ compound_space = max_space;
+ }
+
}
- return springs;
-}
+ if (options->stretch_uniformly_ && l->break_status_dir () != RIGHT)
+ compound_fixed = 0.0;
+ 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);
+}
+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"
+ "\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",
+
+
+ "average-spacing-wishes "
+ "base-shortest-duration "
+ "common-shortest-duration "
+ "grace-space-factor "
+ "packed-spacing "
+ "shortest-duration-space "
+ "spacing-increment "
+ "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