X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fspacing-basic.cc;h=ff245aa30fdd438b17efced4c3fa1ebc64eb28d2;hb=2bbacb364aa29041af9cbbbd32cfad2e8e387cb3;hp=f5753f948a383c77071eefb9423a81722a5e9510;hpb=2c22efe5a46a37065b10c3f51c5d7db00d07d318;p=lilypond.git diff --git a/lily/spacing-basic.cc b/lily/spacing-basic.cc index f5753f948a..ff245aa30f 100644 --- a/lily/spacing-basic.cc +++ b/lily/spacing-basic.cc @@ -1,143 +1,122 @@ /* - spacing-basic.cc -- implement Spacing_spanner, simplistic spacing routines + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 2005--2015 Han-Wen Nienhuys - (c) 2005 Han-Wen Nienhuys + LilyPond is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + LilyPond is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with LilyPond. If not, see . */ #include "spacing-spanner.hh" + +#include "spacing-options.hh" #include "moment.hh" #include "paper-column.hh" -#include "misc.hh" #include "warn.hh" +#include "pointer-group-interface.hh" +#include "system.hh" +#include "spacing-interface.hh" +#include "spring.hh" /* LilyPond spaces by taking a simple-minded spacing algorithm, and adding subtle adjustments to that. This file does the simple-minded spacing routines. */ - /* - Get the measure wide ant for arithmetic spacing. + The one-size-fits all spacing. It doesn't take into account + different spacing wishes from one to the next column. */ -Real -Spacing_options::get_duration_space (Moment d, - bool *expand_only) const +Spring +Spacing_spanner::standard_breakable_column_spacing (Grob *me, Item *l, Item *r, Spacing_options const *options) { - Real k = shortest_duration_space_; + Real min_dist = max (0.0, Paper_column::minimum_distance (l, r)); - if (d < global_shortest_) + if (Paper_column::is_breakable (l) && Paper_column::is_breakable (r)) { - /* - 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)} + Moment *dt = unsmob (l->get_property ("measure-length")); + Moment mlen (1); + if (dt) + mlen = *dt; + Real incr = robust_scm2double (me->get_property ("spacing-increment"), 1); + Real space = incr * double (mlen.main_part_ / options->global_shortest_) * 0.8; + Spring spring = Spring (min_dist + space, min_dist); + /* + By default, the spring will have an inverse_stretch_strength of space+min_dist. + However, we don't want stretchability to scale with min_dist or else an + empty first measure on a line (which has a large min_dist because of the clef) + will stretch much more than an empty measure later in the line. */ - Rational ratio = d.main_part_ / global_shortest_; - - return ((k - 1) + double (ratio)) * increment_; + spring.set_inverse_stretch_strength (space); + return spring; } - else + + Moment dt = Paper_column::when_mom (r) - Paper_column::when_mom (l); + Real ideal; + + if (dt == Moment (0, 0)) { /* - 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. + In this case, Staff_spacing should handle the job, + using dt when it is 0 is silly. */ - Real log = log_2 (global_shortest_); - k -= log; - Rational compdur = d.main_part_ + d.grace_part_ / Rational (3); - *expand_only = false; - - return (log_2 (compdur) + k) * increment_; + ideal = min_dist + 0.5; } + else + ideal = min_dist + options->get_duration_space (dt.main_part_); + + return Spring (ideal, min_dist); } -/* - 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, - Spacing_options const *options) +Moment * +get_measure_length (Grob *column) { - *fixed = 0.0; - Direction d = LEFT; - Drul_array cols (l, r); + Grob *sys = column->get_parent (X_AXIS); - do - { - if (!Paper_column::is_musical (cols[d])) - { - /* - 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); + extract_grob_set (sys, "columns", cols); - if (l->is_breakable (l) && r->is_breakable (r)) - { - Moment *dt = unsmob_moment (l->get_property ("measure-length")); - Moment mlen (1); - if (dt) - mlen = *dt; - - Real incr = robust_scm2double (me->get_property ("spacing-increment"), 1); + vsize col_idx = Paper_column::get_rank (column); - *space = *fixed + incr * double (mlen.main_part_ / options->global_shortest_) * 0.8; - } - else + do { - Moment dt = Paper_column::when_mom (r) - Paper_column::when_mom (l); - - 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 - { - bool dummy; - *space = *fixed + options->get_duration_space (dt, &dummy); - } + if (Moment *len = unsmob (cols[col_idx]->get_property ("measure-length"))) + { + return len; + } } + while (col_idx-- != 0); + + return 0; } -Real -Spacing_spanner::note_spacing (Grob *me, Grob *lc, Grob *rc, - Spacing_options const *options, - bool *expand_only) +/* Basic spring based on duration alone */ +Spring +Spacing_spanner::note_spacing (Grob * /* me */, + Grob *lc, + Grob *rc, + Spacing_options const *options) { Moment shortest_playing_len = 0; SCM s = lc->get_property ("shortest-playing-duration"); - if (unsmob_moment (s)) - shortest_playing_len = *unsmob_moment (s); + if (unsmob (s)) + shortest_playing_len = *unsmob (s); if (! shortest_playing_len.to_bool ()) { - programming_error ("can't find a ruling note at " + Paper_column::when_mom (lc).to_string ()); + programming_error ("cannot find a ruling note at: " + Paper_column::when_mom (lc).to_string ()); shortest_playing_len = 1; } @@ -145,74 +124,60 @@ Spacing_spanner::note_spacing (Grob *me, Grob *lc, Grob *rc, Moment rwhen = Paper_column::when_mom (rc); Moment delta_t = rwhen - lwhen; - if (!Paper_column::is_musical (rc)) + + /* + when toying with mmrests, it is possible to have musical + column on the left and non-musical on the right, spanning + several measures. + + TODO: efficiency: measure length can be cached, or stored as + property in paper-column. + */ + + if (Moment *measure_len = get_measure_length (lc)) { + delta_t = min (delta_t, *measure_len); + /* - when toying with mmrests, it is possible to have musical - column on the left and non-musical on the right, spanning - several measures. + The following is an extra safety measure, such that + the length of a mmrest event doesn't cause havoc. */ - - Moment *dt = unsmob_moment (rc->get_property ("measure-length")); - if (dt) - { - delta_t = min (delta_t, *dt); - - /* - The following is an extra safety measure, such that - the length of a mmrest event doesn't cause havoc. - */ - shortest_playing_len = min (shortest_playing_len, *dt); - } + shortest_playing_len = min (shortest_playing_len, *measure_len); } - Real dist = 0.0; + Spring ret; if (delta_t.main_part_ && !lwhen.grace_part_) { - dist = options->get_duration_space (shortest_playing_len, - expand_only); - dist *= double (delta_t.main_part_ / shortest_playing_len.main_part_); + // A spring of length and stiffness based on the controlling duration + Real len = options->get_duration_space (shortest_playing_len.main_part_); + Real min = options->increment_; // canonical notehead width + + // The portion of that spring proportional to the time between lc and rc + Real fraction = (delta_t.main_part_ / shortest_playing_len.main_part_); + ret = Spring (fraction * len, fraction * min); + + // Stretch proportional to the space between canonical bare noteheads + ret.set_inverse_stretch_strength (fraction * max (0.1, (len - min))); } else if (delta_t.grace_part_) { - /* - Crude hack for spacing graces: we take the shortest space - available (namely the space for the global shortest note), and - multiply that by grace-space-factor - */ - dist = options->get_duration_space (options->global_shortest_, expand_only); - - Real grace_fact - = robust_scm2double (me->get_property ("grace-space-factor"), 1); - - dist *= grace_fact; + Grob *grace_spacing = unsmob (lc->get_object ("grace-spacing")); + if (grace_spacing) + { + Spacing_options grace_opts; + grace_opts.init_from_grob (grace_spacing); + Real len = grace_opts.get_duration_space (delta_t.grace_part_); + Real min = grace_opts.increment_; + ret = Spring (len, min); + // Grace notes should not stretch very much + ret.set_inverse_stretch_strength (grace_opts.increment_ / 2.0); + } + else // Fallback to the old grace spacing: half that of the shortest note + ret = Spring (options-> + get_duration_space (options->global_shortest_) / 2.0, + options->increment_ / 2.0); } - return dist; -} - -/****************************************************************/ - -void -Spacing_options::init_from_grob (Grob *me) -{ - increment_ = robust_scm2double (me->get_property ("spacing-increment"), 1); - - packed_ = to_boolean (me->get_property ("packed-spacing")); - stretch_uniformly_ = to_boolean (me->get_property ("uniform-stretching")); - float_nonmusical_columns_ - = to_boolean (me->get_property ("strict-note-spacing")); - shortest_duration_space_ = robust_scm2double (me->get_property ("shortest-duration-space"), 1); + return ret; } -void -Spacing_options::init () -{ - increment_ = 1.2; - packed_ = false; - stretch_uniformly_ = false; - float_nonmusical_columns_ = false; - shortest_duration_space_ = 2.0; - - global_shortest_ = Rational (1, 8); -}