X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fbeam.cc;h=ac407546095d11d551fee16afda8eb720c15eced;hb=f2bb61843cdd3e049945c4b56b80089eefb3f7a4;hp=ecc9d0b5a6ea979dcec6546bb7078fe44cf8ebac;hpb=e172d5758ac4e3755640dac9374bd9e7ca0c6ed6;p=lilypond.git diff --git a/lily/beam.cc b/lily/beam.cc index ecc9d0b5a6..ac40754609 100644 --- a/lily/beam.cc +++ b/lily/beam.cc @@ -3,7 +3,7 @@ source file of the GNU LilyPond music typesetter - (c) 1997--2007 Han-Wen Nienhuys + (c) 1997--2009 Han-Wen Nienhuys Jan Nieuwenhuizen */ @@ -82,9 +82,9 @@ Beam::add_stem (Grob *me, Grob *s) } Real -Beam::get_thickness (Grob *me) +Beam::get_beam_thickness (Grob *me) { - return robust_scm2double (me->get_property ("thickness"), 0) + return robust_scm2double (me->get_property ("beam-thickness"), 0) * Staff_symbol_referencer::staff_space (me); } @@ -95,12 +95,12 @@ Beam::get_beam_translation (Grob *me) int beam_count = get_beam_count (me); Real staff_space = Staff_symbol_referencer::staff_space (me); Real line = Staff_symbol_referencer::line_thickness (me); - Real thickness = get_thickness (me); + Real beam_thickness = get_beam_thickness (me); Real fract = robust_scm2double (me->get_property ("length-fraction"), 1.0); Real beam_translation = beam_count < 4 - ? (2 * staff_space + line - thickness) / 2.0 - : (3 * staff_space + line - thickness) / 3.0; + ? (2 * staff_space + line - beam_thickness) / 2.0 + : (3 * staff_space + line - beam_thickness) / 3.0; return fract * beam_translation; } @@ -167,9 +167,15 @@ Beam::calc_direction (SCM smob) Grob *stem = first_normal_stem (me); /* - ugh: stems[0] case happens for chord tremolo. + This happens for chord tremolos. */ - dir = to_dir ((stem ? stem : stems[0])->get_property ("default-direction")); + if (!stem) + stem = stems[0]; + + if (is_direction (stem->get_property_data ("direction"))) + dir = to_dir (stem->get_property_data ("direction")); + else + dir = to_dir (stem->get_property ("default-direction")); } } @@ -233,7 +239,7 @@ position_with_maximal_common_beams (SCM left_beaming, SCM right_beaming, return best_start; } -MAKE_SCHEME_CALLBACK(Beam, calc_beaming, 1) +MAKE_SCHEME_CALLBACK (Beam, calc_beaming, 1) SCM Beam::calc_beaming (SCM smob) { @@ -335,8 +341,13 @@ Beam::get_beam_segments (Grob *me_grob, Grob **common) Position_stem_segments_map stem_segments; Real lt = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness")); + /* There are two concepts of "rank" that are used in the following code. + The beam_rank is the vertical position of the beam (larger numbers are + closer to the noteheads). Beam_stem_segment.rank_, on the other hand, + is the horizontal position of the segment (this is incremented by two + for each stem; the beam segment on the right side of the stem has + a higher rank (by one) than its neighbour to the left). */ Slice ranks; - for (vsize i = 0; i < stems.size (); i++) { Grob *stem = stems[i]; @@ -346,6 +357,10 @@ Beam::get_beam_segments (Grob *me_grob, Grob **common) Direction d = LEFT; do { + // Find the maximum and minimum beam ranks. + // Given that RANKS is never reset to empty, the interval will always be + // smallest for the left beamlet of the first stem, and then it might grow. + // Do we really want this? (It only affects the tremolo gaps) --jneem for (SCM s = index_get_cell (beaming, d); scm_is_pair (s); s = scm_cdr (s)) { @@ -366,7 +381,7 @@ Beam::get_beam_segments (Grob *me_grob, Grob **common) Beam_stem_segment seg; seg.stem_ = stem; seg.stem_x_ = stem_x; - seg.rank_ = 2 * i + (d+1)/2; + seg.rank_ = 2 * i + (d+1)/2; seg.width_ = stem_width; seg.stem_index_ = i; seg.dir_ = d; @@ -395,71 +410,112 @@ Beam::get_beam_segments (Grob *me_grob, Grob **common) Beam_segment current; + // Iterate over all of the segments of the current beam rank, + // merging the adjacent Beam_stem_segments into one Beam_segment + // when appropriate. int vertical_count = (*i).first; for (vsize j = 0; j < segs.size (); j++) { - /* - event_dir == LEFT: left edge of a beamsegment. - */ + // Keeping track of the different directions here is a little tricky. + // segs[j].dir_ is the direction of the beam segment relative to the stem + // (ie. segs[j].dir_ == LEFT if the beam segment sticks out to the left of + // its stem) whereas event_dir refers to the edge of the beam segment that + // we are currently looking at (ie. if segs[j].dir_ == event_dir then we + // are looking at that edge of the beam segment that is furthest from its + // stem). Direction event_dir = LEFT; + Beam_stem_segment const& seg = segs[j]; do { - bool on_bound = (event_dir == LEFT) ? j == 0 : - j == segs.size() - 1; - + Beam_stem_segment const& neighbor_seg = segs[j + event_dir]; + // TODO: make names clearer? --jneem + // on_line_bound: whether the current segment is on the boundary of the WHOLE beam + // on_beam_bound: whether the current segment is on the boundary of just that part + // of the beam with the current beam_rank + bool on_line_bound = (seg.dir_ == LEFT) ? seg.stem_index_ == 0 + : seg.stem_index_ == stems.size() - 1; + bool on_beam_bound = (event_dir == LEFT) ? j == 0 : + j == segs.size () - 1; bool inside_stem = (event_dir == LEFT) - ? segs[j].stem_index_ > 0 - : segs[j].stem_index_ + 1 < stems.size () ; + ? seg.stem_index_ > 0 + : seg.stem_index_ + 1 < stems.size () ; - bool event = on_bound - || abs (segs[j].rank_ - segs[j+event_dir].rank_) > 1 - || (abs (vertical_count) >= segs[j].max_connect_ - || abs (vertical_count) >= segs[j + event_dir].max_connect_); + bool event = on_beam_bound + || abs (seg.rank_ - neighbor_seg.rank_) > 1 + || (abs (vertical_count) >= seg.max_connect_ + || abs (vertical_count) >= neighbor_seg.max_connect_); if (!event) + // Then this edge of the current segment is irrelevent because it will + // be connected with the next segment in the event_dir direction. continue; current.vertical_count_ = vertical_count; - current.horizontal_[event_dir] = segs[j].stem_x_; - if (segs[j].dir_ == event_dir) + current.horizontal_[event_dir] = seg.stem_x_; + if (seg.dir_ == event_dir) + // then we are examining the edge of a beam segment that is furthest + // from its stem. { - if (on_bound + if (on_line_bound && me->get_bound (event_dir)->break_status_dir ()) { current.horizontal_[event_dir] - = (me->get_bound (event_dir)->extent (commonx, X_AXIS)[RIGHT] + = (robust_relative_extent (me->get_bound (event_dir), + commonx, X_AXIS)[RIGHT] + event_dir * break_overshoot[event_dir]); } else { - Real notehead_width = - Stem::duration_log (segs[j].stem_) == 1 - ? 1.98 - : 1.32; // URG. - + Grob *stem = stems[seg.stem_index_]; + Drul_array beamlet_length = + robust_scm2interval (stem->get_property ("beamlet-default-length"), Interval (1.1, 1.1)); + Drul_array max_proportion = + robust_scm2interval (stem->get_property ("beamlet-max-length-proportion"), Interval (0.75, 0.75)); + Real length = beamlet_length[seg.dir_]; if (inside_stem) { - Grob *neighbor_stem = stems[segs[j].stem_index_ + event_dir]; + Grob *neighbor_stem = stems[seg.stem_index_ + event_dir]; Real neighbor_stem_x = neighbor_stem->relative_coordinate (commonx, X_AXIS); - notehead_width = min (notehead_width, - fabs (neighbor_stem_x - segs[j].stem_x_)/2); + length = min (length, + fabs (neighbor_stem_x - seg.stem_x_) * max_proportion[seg.dir_]); } - current.horizontal_[event_dir] += event_dir * notehead_width; + current.horizontal_[event_dir] += event_dir * length; } } else + // we are examining the edge of a beam segment that is closest + // (ie. touching, unless there is a gap) its stem. { - current.horizontal_[event_dir] += event_dir * segs[j].width_/2; - if (segs[j].gapped_) - current.horizontal_[event_dir] -= event_dir * gap_length; + current.horizontal_[event_dir] += event_dir * seg.width_/2; + if (seg.gapped_) + { + current.horizontal_[event_dir] -= event_dir * gap_length; + + if (Stem::is_invisible (seg.stem_)) + { + /* + Need to do this in case of whole notes. We don't want the + heads to collide with the beams. + */ + extract_grob_set (seg.stem_, "note-heads", heads); + + for (vsize k = 0; k < heads.size (); k ++) + current.horizontal_[event_dir] + = event_dir * min (event_dir * current.horizontal_[event_dir], + - gap_length/2 + + event_dir + * heads[k]->extent (commonx, + X_AXIS)[-event_dir]); + } + } } if (event_dir == RIGHT) { segments.push_back (current); - current = Beam_segment(); + current = Beam_segment (); } } while (flip (&event_dir) != LEFT); @@ -470,7 +526,7 @@ Beam::get_beam_segments (Grob *me_grob, Grob **common) return segments; } -MAKE_SCHEME_CALLBACK(Beam, print, 1); +MAKE_SCHEME_CALLBACK (Beam, print, 1); SCM Beam::print (SCM grob) { @@ -508,7 +564,7 @@ Beam::print (SCM grob) Real dy = pos[RIGHT] - pos[LEFT]; Real slope = (dy && span.length ()) ? dy / span.length () : 0; - Real thick = get_thickness (me); + Real beam_thickness = get_beam_thickness (me); Real beam_dy = get_beam_translation (me); Direction feather_dir = to_dir (me->get_property ("grow-direction")); @@ -522,7 +578,7 @@ Beam::print (SCM grob) local_slope += feather_dir * segments[i].vertical_count_ * beam_dy / span.length (); } - Stencil b = Lookup::beam (local_slope, segments[i].horizontal_.length (), thick, blot); + Stencil b = Lookup::beam (local_slope, segments[i].horizontal_.length (), beam_thickness, blot); b.translate_axis (segments[i].horizontal_[LEFT], X_AXIS); @@ -534,9 +590,15 @@ Beam::print (SCM grob) } #if (DEBUG_BEAM_SCORING) - SCM quant_score = me->get_property ("quant-score"); - SCM debug = me->layout ()->lookup_variable (ly_symbol2scm ("debug-beam-scoring")); - if (to_boolean (debug) && scm_is_string (quant_score)) + SCM annotation = me->get_property ("annotation"); + if (!scm_is_string (annotation)) + { + SCM debug = me->layout ()->lookup_variable (ly_symbol2scm ("debug-beam-scoring")); + if (to_boolean (debug)) + annotation = me->get_property ("quant-score"); + } + + if (scm_is_string (annotation)) { extract_grob_set (me, "stems", stems); @@ -551,10 +613,13 @@ Beam::print (SCM grob) Direction stem_dir = stems.size () ? to_dir (stems[0]->get_property ("direction")) : UP; Stencil score = *unsmob_stencil (Text_interface::interpret_markup - (me->layout ()->self_scm (), properties, quant_score)); + (me->layout ()->self_scm (), properties, annotation)); if (!score.is_empty ()) - the_beam.add_at_edge (Y_AXIS, stem_dir, score, 1.0); + { + score.translate_axis (me->relative_coordinate(commonx, X_AXIS), X_AXIS); + the_beam.add_at_edge (Y_AXIS, stem_dir, score, 1.0); + } } #endif @@ -695,7 +760,7 @@ Beam::consider_auto_knees (Grob *me) sets stem directions, a constant shift does not have an influence. */ - head_extents += stem->relative_coordinate (common, Y_AXIS); + head_extents += stem->pure_relative_y_coordinate (common, 0, INT_MAX); if (to_dir (stem->get_property_data ("direction"))) { @@ -729,7 +794,7 @@ Beam::consider_auto_knees (Grob *me) } Real beam_translation = get_beam_translation (me); - Real beam_thickness = Beam::get_thickness (me); + Real beam_thickness = Beam::get_beam_thickness (me); int beam_count = Beam::get_beam_count (me); Real height_of_beams = beam_thickness / 2 + (beam_count - 1) * beam_translation; @@ -777,11 +842,11 @@ set_minimum_dy (Grob *me, Real *dy) */ Real ss = Staff_symbol_referencer::staff_space (me); - Real thickness = Beam::get_thickness (me) / ss; + Real beam_thickness = Beam::get_beam_thickness (me) / ss; Real slt = Staff_symbol_referencer::line_thickness (me) / ss; - Real sit = (thickness - slt) / 2; + Real sit = (beam_thickness - slt) / 2; Real inter = 0.5; - Real hang = 1.0 - (thickness - slt) / 2; + Real hang = 1.0 - (beam_thickness - slt) / 2; *dy = sign (*dy) * max (fabs (*dy), min (min (sit, inter), hang)); @@ -790,7 +855,7 @@ set_minimum_dy (Grob *me, Real *dy) -MAKE_SCHEME_CALLBACK(Beam, calc_stem_shorten, 1) +MAKE_SCHEME_CALLBACK (Beam, calc_stem_shorten, 1) SCM Beam::calc_stem_shorten (SCM smob) { @@ -827,22 +892,44 @@ Beam::calc_stem_shorten (SCM smob) } +Interval +Beam::no_visible_stem_positions (Grob *me, Interval default_value) +{ + extract_grob_set (me, "stems", stems); + if (stems.empty ()) + return default_value; + + Interval head_positions; + Slice multiplicity; + for (vsize i = 0; i < stems.size(); i++) + { + head_positions.unite (Stem::head_positions (stems[i])); + multiplicity.unite (Stem::beam_multiplicity (stems[i])); + } + + Direction dir = get_grob_direction (me); + Real y = head_positions[dir] + * 0.5 * Staff_symbol_referencer::staff_space (me) + + dir * get_beam_translation (me) * (multiplicity.length () + 1); + + y /= Staff_symbol_referencer::staff_space (me); + return Interval (y,y); +} + /* Compute a first approximation to the beam slope. */ MAKE_SCHEME_CALLBACK (Beam, calc_least_squares_positions, 2); SCM -Beam::calc_least_squares_positions (SCM smob, SCM posns) +Beam::calc_least_squares_positions (SCM smob, SCM /* posns */) { - (void) posns; - Grob *me = unsmob_grob (smob); int count = normal_stem_count (me); Interval pos (0,0); if (count < 1) - return ly_interval2scm (pos); + return ly_interval2scm (no_visible_stem_positions (me, pos)); vector x_posns; extract_grob_set (me, "normal-stems", stems); @@ -889,7 +976,7 @@ Beam::calc_least_squares_positions (SCM smob, SCM posns) { /* FIXME. -> UP */ Direction d = (Direction) (sign (chord.delta ()) * UP); - pos[d] = get_thickness (me) / 2; + pos[d] = get_beam_thickness (me) / 2; pos[-d] = -pos[d]; } else @@ -974,7 +1061,6 @@ Beam::shift_region_to_valid (SCM grob, SCM posns) Real dx = lvs->relative_coordinate (commonx, X_AXIS) - x0; Drul_array pos = ly_scm2interval (posns); - scale_drul (&pos, Staff_symbol_referencer::staff_space (me)); @@ -1112,36 +1198,41 @@ where_are_the_whole_beams (SCM beaming) in POS for stem S. This Y position is relative to S. */ Real Beam::calc_stem_y (Grob *me, Grob *stem, Grob **common, - Real xl, Real xr, + Real xl, Real xr, Direction feather_dir, Drul_array pos, bool french) { Real beam_translation = get_beam_translation (me); + Direction stem_dir = get_grob_direction (stem); - Real r = stem->relative_coordinate (common[X_AXIS], X_AXIS) - xl; - Real dy = pos[RIGHT] - pos[LEFT]; Real dx = xr - xl; - Real stem_y_beam0 = (dy && dx - ? r / dx - * dy - : 0) + pos[LEFT]; + Real relx = dx ? (stem->relative_coordinate (common[X_AXIS], X_AXIS) - xl)/dx : 0; + Real xdir = 2*relx-1; + + Real stem_y = linear_combination(pos, xdir); - Direction my_dir = get_grob_direction (stem); SCM beaming = stem->get_property ("beaming"); - Real stem_y = stem_y_beam0; - if (french) - { - Slice bm = where_are_the_whole_beams (beaming); - if (!bm.is_empty ()) - stem_y += beam_translation * bm[-my_dir]; - } - else - { - Slice bm = Stem::beam_multiplicity (stem); - if (!bm.is_empty ()) - stem_y += bm[my_dir] * beam_translation; - } + Slice beam_slice (french + ? where_are_the_whole_beams (beaming) + : Stem::beam_multiplicity (stem)); + if (beam_slice.is_empty ()) + beam_slice = Slice (0,0); + Interval beam_multiplicity(beam_slice[LEFT], + beam_slice[RIGHT]); + /* + feather dir = 1 , relx 0->1 : factor 0 -> 1 + feather dir = 0 , relx 0->1 : factor 1 -> 1 + feather dir = -1, relx 0->1 : factor 1 -> 0 + */ + Real feather_factor = 1; + if (feather_dir > 0) + feather_factor = relx; + else if (feather_dir < 0) + feather_factor = 1 - relx; + + stem_y += feather_factor * beam_translation + * beam_multiplicity[Direction(((french) ? DOWN : UP)*stem_dir)]; Real id = me->relative_coordinate (common[Y_AXIS], Y_AXIS) - stem->relative_coordinate (common[Y_AXIS], Y_AXIS); @@ -1152,7 +1243,7 @@ Beam::calc_stem_y (Grob *me, Grob *stem, Grob **common, Hmm. At this time, beam position and slope are determined. Maybe, stem directions and length should set to relative to the chord's position of the beam. */ -MAKE_SCHEME_CALLBACK(Beam, set_stem_lengths, 1); +MAKE_SCHEME_CALLBACK (Beam, set_stem_lengths, 1); SCM Beam::set_stem_lengths (SCM smob) { @@ -1181,7 +1272,7 @@ Beam::set_stem_lengths (SCM smob) if (robust_scm2int (me->get_property ("gap-count"), 0)) { gap = true; - thick = get_thickness (me); + thick = get_beam_thickness (me); } Grob *fvs = first_normal_stem (me); @@ -1189,6 +1280,7 @@ Beam::set_stem_lengths (SCM smob) Real xl = fvs ? fvs->relative_coordinate (common[X_AXIS], X_AXIS) : 0.0; Real xr = lvs ? lvs->relative_coordinate (common[X_AXIS], X_AXIS) : 0.0; + Direction feather_dir = to_dir (me->get_property ("grow-direction")); for (vsize i = 0; i < stems.size (); i++) { @@ -1196,7 +1288,7 @@ Beam::set_stem_lengths (SCM smob) bool french = to_boolean (s->get_property ("french-beaming")); Real stem_y = calc_stem_y (me, s, common, - xl, xr, + xl, xr, feather_dir, pos, french && s != lvs && s!= fvs); /* @@ -1204,7 +1296,7 @@ Beam::set_stem_lengths (SCM smob) for normal beams, but for tremolo beams it looks silly otherwise. */ if (gap - && !Stem::is_invisible (s)) + && !Stem::is_invisible (s)) stem_y += thick * 0.5 * get_grob_direction (s); /* @@ -1307,7 +1399,7 @@ Beam::last_normal_stem (Grob *me) rest -> stem -> beam -> interpolate_y_position () */ -MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Beam, rest_collision_callback, 2, 1); +MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Beam, rest_collision_callback, 2, 1, ""); SCM Beam::rest_collision_callback (SCM smob, SCM prev_offset) { @@ -1351,7 +1443,7 @@ Beam::rest_collision_callback (SCM smob, SCM prev_offset) + (stem->relative_coordinate (common, X_AXIS) - x0) * slope; Real beam_translation = get_beam_translation (beam); - Real beam_thickness = Beam::get_thickness (beam); + Real beam_thickness = Beam::get_beam_thickness (beam); /* TODO: this is not strictly correct for 16th knee beams. @@ -1421,6 +1513,24 @@ Beam::is_knee (Grob *me) return knee; } +bool +Beam::is_cross_staff (Grob *me) +{ + extract_grob_set (me, "stems", stems); + Grob *staff_symbol = Staff_symbol_referencer::get_staff_symbol (me); + for (vsize i = 0; i < stems.size (); i++) + if (Staff_symbol_referencer::get_staff_symbol (stems[i]) != staff_symbol) + return true; + return false; +} + +MAKE_SCHEME_CALLBACK (Beam, calc_cross_staff, 1) +SCM +Beam::calc_cross_staff (SCM smob) +{ + return scm_from_bool (is_cross_staff (unsmob_grob (smob))); +} + int Beam::get_direction_beam_count (Grob *me, Direction d) { @@ -1440,25 +1550,59 @@ Beam::get_direction_beam_count (Grob *me, Direction d) } ADD_INTERFACE (Beam, - - "A beam. \n\n" - "The @code{thickness} property is the weight of beams, " - "measured in staffspace. The @code{direction} " - "property is not user-serviceable. Use " - "the @code{direction} property of @code{Stem} instead. " - - , + "A beam.\n" + "\n" + "The @code{beam-thickness} property is the weight of beams," + " measured in staffspace. The @code{direction} property is" + " not user-serviceable. Use the @code{direction} property" + " of @code{Stem} instead.\n" + "\n" + "The following properties may be set in the @code{details}" + " list.\n" + "\n" + "@table @code\n" + "@item stem-length-demerit-factor\n" + "Demerit factor used for inappropriate stem lengths.\n" + "@item secondary-beam-demerit\n" + "Demerit used in quanting calculations for multiple" + " beams.\n" + "@item region-size\n" + "Size of region for checking quant scores.\n" + "@item beam-eps\n" + "Epsilon for beam quant code to check for presence" + " in gap.\n" + "@item stem-length-limit-penalty\n" + "Penalty for differences in stem lengths on a beam.\n" + "@item damping-direction-penalty\n" + "Demerit penalty applied when beam direction is different" + " from damping direction.\n" + "@item hint-direction-penalty\n" + "Demerit penalty applied when beam direction is different" + " from damping direction, but damping slope is" + " <= @code{round-to-zero-slope}.\n" + "@item musical-direction-factor\n" + "Demerit scaling factor for difference between" + " beam slope and music slope.\n" + "@item ideal-slope-factor\n" + "Demerit scaling factor for difference between" + " beam slope and damping slope.\n" + "@item round-to-zero-slope\n" + "Damping slope which is considered zero for purposes of" + " calculating direction penalties.\n" + "@end table\n", /* properties */ + "annotation " "auto-knee-gap " "beamed-stem-shorten " "beaming " + "beam-thickness " "break-overshoot " "clip-edges " "concaveness " "damping " "details " - "direction " + "direction " "gap " "gap-count " "grow-direction " @@ -1473,5 +1617,4 @@ ADD_INTERFACE (Beam, "quantized-positions " "shorten " "stems " - "thickness " );