2 beam.cc -- implement Beam
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
7 Jan Nieuwenhuizen <janneke@gnu.org>
13 - Determine auto knees based on positions if it's set by the user.
15 - the code is littered with * and / staff_space calls for
16 #'positions. Consider moving to real-world coordinates?
18 Problematic issue is user tweaks (user tweaks are in staff-coordinates.)
22 - Stems run to the Y-center of the beam.
24 - beam_translation is the offset between Y centers of the beam.
28 #include "interval-set.hh"
29 #include "directional-element-interface.hh"
32 #include "least-squares.hh"
34 #include "output-def.hh"
36 #include "pointer-group-interface.hh"
37 #include "staff-symbol-referencer.hh"
43 #include "text-interface.hh" // debug output.
44 #include "font-interface.hh" // debug output.
48 Beam::add_stem (Grob *me, Grob *s)
50 if (Stem::get_beam (s))
52 programming_error ("Stem already has beam");
56 Pointer_group_interface::add_grob (me, ly_symbol2scm ("stems"), s);
57 s->set_object ("beam", me->self_scm ());
58 add_bound_item (dynamic_cast<Spanner *> (me), dynamic_cast<Item *> (s));
62 Beam::get_thickness (Grob *me)
64 return robust_scm2double (me->get_property ("thickness"), 0)
65 * Staff_symbol_referencer::staff_space (me);
68 /* Return the translation between 2 adjoining beams. */
70 Beam::get_beam_translation (Grob *me)
72 int beam_count = get_beam_count (me);
73 Real staff_space = Staff_symbol_referencer::staff_space (me);
74 Real line = Staff_symbol_referencer::line_thickness (me);
75 Real thickness = get_thickness (me);
76 Real fract = robust_scm2double (me->get_property ("length-fraction"), 1.0);
78 Real beam_translation = beam_count < 4
79 ? (2 * staff_space + line - thickness) / 2.0
80 : (3 * staff_space + line - thickness) / 3.0;
82 return fract * beam_translation;
85 /* Maximum beam_count. */
87 Beam::get_beam_count (Grob *me)
91 extract_grob_set (me, "stems", stems);
92 for (int i = 0; i < stems.size (); i++)
94 Grob *stem = stems[i];
95 m = max (m, (Stem::beam_multiplicity (stem).length () + 1));
101 /* After pre-processing all directions should be set.
102 Several post-processing routines (stem, slur, script) need stem/beam
104 Currenly, this means that beam has set all stem's directions.
105 [Alternatively, stems could set its own directions, according to
106 their beam, during 'final-pre-processing'.] */
107 MAKE_SCHEME_CALLBACK (Beam, calc_direction, 1);
109 Beam::calc_direction (SCM smob)
111 Grob *me = unsmob_grob (smob);
113 /* Beams with less than 2 two stems don't make much sense, but could happen
118 For a beam that only has one stem, we try to do some disappearance magic:
119 we revert the flag, and move on to The Eternal Engraving Fields. */
121 Direction d = CENTER;
123 int count = visible_stem_count (me);
126 extract_grob_set (me, "stems", stems);
127 if (stems.size () == 1)
129 me->warning (_ ("removing beam with less than two stems"));
131 stems[0]->set_object ("beam", SCM_EOL);
134 return SCM_UNSPECIFIED;
136 else if (stems.size () == 0)
139 return SCM_UNSPECIFIED;
143 d = to_dir (stems[0]->get_property ("default-direction"));
150 d = get_default_dir (me);
151 consider_auto_knees (me);
156 set_stem_directions (me, d);
159 return scm_from_int (d);
164 /* We want a maximal number of shared beams, but if there is choice, we
165 * take the one that is closest to the end of the stem. This is for
177 position_with_maximal_common_beams (SCM left_beaming, SCM right_beaming,
181 Slice lslice = int_list_to_slice (scm_cdr (left_beaming));
185 for (int i = lslice[-left_dir];
186 (i - lslice[left_dir]) * left_dir <= 0; i += left_dir)
189 for (SCM s = scm_car (right_beaming); scm_is_pair (s); s = scm_cdr (s))
191 int k = -right_dir * scm_to_int (scm_car (s)) + i;
192 if (scm_c_memq (scm_from_int (k), left_beaming) != SCM_BOOL_F)
196 if (count >= best_count)
206 MAKE_SCHEME_CALLBACK(Beam, calc_beaming, 1)
208 Beam::calc_beaming (SCM smob)
210 Grob *me = unsmob_grob (smob);
212 extract_grob_set (me, "stems", stems);
215 last_int.set_empty ();
217 SCM last_beaming = scm_cons (SCM_EOL, scm_list_1 (scm_from_int (0)));
218 Direction last_dir = CENTER;
219 for (int i = 0; i < stems.size (); i++)
221 Grob *this_stem = stems[i];
222 SCM this_beaming = this_stem->get_property ("beaming");
224 Direction this_dir = get_grob_direction (this_stem);
225 if (scm_is_pair (last_beaming) && scm_is_pair (this_beaming))
227 int start_point = position_with_maximal_common_beams
228 (last_beaming, this_beaming,
229 last_dir ? last_dir : this_dir,
236 new_slice.set_empty ();
237 SCM s = index_get_cell (this_beaming, d);
238 for (; scm_is_pair (s); s = scm_cdr (s))
241 = start_point - this_dir * scm_to_int (scm_car (s));
243 new_slice.add_point (new_beam_pos);
244 scm_set_car_x (s, scm_from_int (new_beam_pos));
247 while (flip (&d) != LEFT);
249 if (!new_slice.is_empty ())
250 last_int = new_slice;
254 SCM s = scm_cdr (this_beaming);
255 for (; scm_is_pair (s); s = scm_cdr (s))
257 int np = -this_dir * scm_to_int (scm_car (s));
258 scm_set_car_x (s, scm_from_int (np));
259 last_int.add_point (np);
263 if (scm_ilength (scm_cdr (this_beaming)) > 0)
265 last_beaming = this_beaming;
274 I really enjoy spaghetti, but spaghetti should be kept on a plate
275 with a little garlic and olive oil. This is too much.
279 MAKE_SCHEME_CALLBACK (Beam, print, 1);
281 Beam::print (SCM grob)
283 Spanner *me = unsmob_spanner (grob);
285 extract_grob_set (me, "stems", stems);
286 Grob *xcommon = common_refpoint_of_array (stems, me, X_AXIS);
288 xcommon = me->get_bound (LEFT)->common_refpoint (xcommon, X_AXIS);
289 xcommon = me->get_bound (RIGHT)->common_refpoint (xcommon, X_AXIS);
292 if (visible_stem_count (me))
294 // ugh -> use commonx
295 x0 = first_visible_stem (me)->relative_coordinate (xcommon, X_AXIS);
296 dx = last_visible_stem (me)->relative_coordinate (xcommon, X_AXIS) - x0;
300 x0 = stems[0]->relative_coordinate (xcommon, X_AXIS);
301 dx = stems.top ()->relative_coordinate (xcommon, X_AXIS) - x0;
304 SCM posns = me->get_property ("quantized-positions");
305 Drul_array<Real> pos;
306 if (!is_number_pair (posns))
308 programming_error ("no beam positions?");
309 pos = Interval (0, 0);
312 pos = ly_scm2realdrul (posns);
314 scale_drul (&pos, Staff_symbol_referencer::staff_space (me));
316 Real dy = pos[RIGHT] - pos[LEFT];
317 Real slope = (dy && dx) ? dy / dx : 0;
319 Real thick = get_thickness (me);
320 Real bdy = get_beam_translation (me);
322 SCM last_beaming = SCM_EOL;
323 Real last_xposn = -1;
324 Real last_stem_width = -1;
326 Real gap_length = robust_scm2double (me->get_property ("gap"), 0.0);
329 Real lt = me->layout ()->get_dimension (ly_symbol2scm ("linethickness"));
331 for (int i = 0; i <= stems.size (); i++)
333 Grob *stem = (i < stems.size ()) ? stems[i] : 0;
335 SCM this_beaming = stem ? stem->get_property ("beaming") : SCM_EOL;
336 Real xposn = stem ? stem->relative_coordinate (xcommon, X_AXIS) : 0.0;
337 Real stem_width = stem ? robust_scm2double (stem->get_property ("thickness"), 1.0) * lt : 0;
338 Direction stem_dir = stem ? to_dir (stem->get_property ("direction")) : CENTER;
340 We do the space left of ST, with lfliebertjes pointing to the
341 right from the left stem, and rfliebertjes pointing left from
344 SCM left = (i > 0) ? scm_cdr (last_beaming) : SCM_EOL;
345 SCM right = stem ? scm_car (this_beaming) : SCM_EOL;
347 Array<int> full_beams;
348 Array<int> lfliebertjes;
349 Array<int> rfliebertjes;
352 scm_is_pair (s); s = scm_cdr (s))
354 int b = scm_to_int (scm_car (s));
355 if (scm_c_memq (scm_car (s), right) != SCM_BOOL_F)
358 lfliebertjes.push (b);
361 scm_is_pair (s); s = scm_cdr (s))
363 int b = scm_to_int (scm_car (s));
364 if (scm_c_memq (scm_car (s), left) == SCM_BOOL_F)
365 rfliebertjes.push (b);
368 Drul_array<Real> break_overshoot
369 = robust_scm2drul (me->get_property ("break-overshoot"),
370 Drul_array<Real> (-0.5, 0.0));
372 Real w = (i > 0 && stem)
373 ? (xposn - last_xposn)
374 : break_overshoot[ (i == 0) ? LEFT : RIGHT];
376 Real stem_offset = 0.0;
379 w += last_stem_width / 2;
380 stem_offset = -last_stem_width / 2;
386 Real blot = me->layout ()->get_dimension (ly_symbol2scm ("blotdiameter"));
387 Stencil whole = Lookup::beam (slope, w, thick, blot);
391 if (scm_is_number (me->get_property ("gap-count")))
393 gap_count = scm_to_int (me->get_property ("gap-count"));
394 gapped = Lookup::beam (slope, w - 2 * gap_length, thick, blot);
396 full_beams.sort (default_compare);
398 full_beams.reverse ();
402 for (int j = full_beams.size (); j--;)
409 b.translate_axis (gap_length, X_AXIS);
411 b.translate_axis (last_xposn - x0 + stem_offset, X_AXIS);
412 b.translate_axis (slope * (last_xposn - x0) + bdy * full_beams[j], Y_AXIS);
414 the_beam.add_stencil (b);
417 if (lfliebertjes.size () || rfliebertjes.size ())
423 int t = Stem::duration_log (stem);
431 nw_f = break_overshoot[RIGHT] / 2;
433 /* Half beam should be one note-width,
434 but let's make sure two half-beams never touch */
438 rw = min (nw_f, ((xposn - last_xposn) / 2));
441 if (me->get_bound (LEFT)->break_status_dir ())
442 rw = xposn - me->get_bound (LEFT)->extent (xcommon, X_AXIS)[RIGHT]
443 + break_overshoot[LEFT];
449 lw = min (nw_f, ((xposn - last_xposn) / 2));
452 lw = me->get_bound (RIGHT)->relative_coordinate (xcommon, X_AXIS)
454 + break_overshoot[RIGHT];
456 rw += stem_width / 2;
457 lw += last_stem_width / 2;
459 Stencil rhalf = Lookup::beam (slope, rw, thick, blot);
460 Stencil lhalf = Lookup::beam (slope, lw, thick, blot);
461 for (int j = lfliebertjes.size (); j--;)
464 b.translate_axis (last_xposn - x0 - last_stem_width /2,
466 b.translate_axis (slope * (last_xposn - x0)
467 + bdy * lfliebertjes[j],
469 the_beam.add_stencil (b);
471 for (int j = rfliebertjes.size (); j--;)
474 b.translate_axis (xposn - x0 - rw + stem_width / 2, X_AXIS);
475 b.translate_axis (slope * (xposn - x0 - rw)
476 + bdy * rfliebertjes[j], Y_AXIS);
477 the_beam.add_stencil (b);
482 last_stem_width = stem_width;
483 last_beaming = this_beaming;
486 the_beam.translate_axis (x0 - me->relative_coordinate (xcommon, X_AXIS),
488 the_beam.translate_axis (pos[LEFT], Y_AXIS);
491 SCM quant_score = me->get_property ("quant-score");
492 SCM debug = me->layout ()->lookup_variable (ly_symbol2scm ("debug-beam-quanting"));
493 if (to_boolean (debug) && scm_is_string (quant_score))
497 This code prints the demerits for each beam. Perhaps this
498 should be switchable for those who want to twiddle with the
502 SCM properties = Font_interface::text_font_alist_chain (me);
504 Direction stem_dir = stems.size () ? to_dir (stems[0]->get_property ("direction")) : UP;
506 Stencil score = *unsmob_stencil (Text_interface::interpret_markup
507 (me->layout ()->self_scm (), properties, quant_score));
509 if (!score.is_empty ())
510 the_beam.add_at_edge (Y_AXIS, stem_dir, score, 1.0, 0);
514 return the_beam.smobbed_copy ();
518 Beam::get_default_dir (Grob *me)
520 Drul_array<int> total;
521 total[UP] = total[DOWN] = 0;
522 Drul_array<int> count;
523 count[UP] = count[DOWN] = 0;
525 extract_grob_set (me, "stems", stems);
527 for (int i = 0; i < stems.size (); i++)
530 Direction stem_dir = CENTER;
531 SCM stem_dir_scm = s->get_property_data (ly_symbol2scm ("direction"));
532 if (is_direction (stem_dir_scm))
533 stem_dir = to_dir (stem_dir_scm);
535 stem_dir = to_dir (s->get_property ("default-direction"));
538 stem_dir = to_dir (s->get_property ("neutral-direction"));
543 total[stem_dir] += max (int (- stem_dir * Stem::head_positions (s) [-stem_dir]), 0);
547 Direction dir = CENTER;
548 Direction d = CENTER;
549 if ((d = (Direction) sign (count[UP] - count[DOWN])))
553 && (d = (Direction) sign (total[UP] / count[UP] - total[DOWN]/count[DOWN])))
555 else if ((d = (Direction) sign (total[UP] - total[DOWN])))
558 dir = to_dir (me->get_property ("neutral-direction"));
563 /* Set all stems with non-forced direction to beam direction.
564 Urg: non-forced should become `without/with unforced' direction,
565 once stem gets cleaned-up. */
567 Beam::set_stem_directions (Grob *me, Direction d)
569 extract_grob_set (me, "stems", stems);
571 for (int i = 0; i < stems.size (); i++)
575 SCM forcedir = s->get_property_data (ly_symbol2scm ("direction"));
576 if (!to_dir (forcedir))
577 set_grob_direction (s, d);
582 Only try horizontal beams for knees. No reliable detection of
583 anything else is possible here, since we don't know funky-beaming
584 settings, or X-distances (slopes!) People that want sloped
585 knee-beams, should set the directions manually.
590 this routine should take into account the stemlength scoring
591 of a possible knee/nonknee beam.
594 Beam::consider_auto_knees (Grob *me)
596 SCM scm = me->get_property ("auto-knee-gap");
597 if (!scm_is_number (scm))
604 extract_grob_set (me, "stems", stems);
606 Grob *common = common_refpoint_of_array (stems, me, Y_AXIS);
607 Real staff_space = Staff_symbol_referencer::staff_space (me);
609 Array<Interval> head_extents_array;
610 for (int i = 0; i < stems.size (); i++)
612 Grob *stem = stems[i];
613 if (Stem::is_invisible (stem))
616 Interval head_extents = Stem::head_positions (stem);
617 if (!head_extents.is_empty ())
619 head_extents[LEFT] += -1;
620 head_extents[RIGHT] += 1;
621 head_extents *= staff_space * 0.5;
624 We could subtract beam Y position, but this routine only
625 sets stem directions, a constant shift does not have an
628 head_extents += stem->relative_coordinate (common, Y_AXIS);
630 if (to_dir (stem->get_property_data (ly_symbol2scm ("direction"))))
632 Direction stemdir = to_dir (stem->get_property ("direction"));
633 head_extents[-stemdir] = -stemdir * infinity_f;
636 head_extents_array.push (head_extents);
638 gaps.remove_interval (head_extents);
642 Real max_gap_len = 0.0;
644 for (int i = gaps.allowed_regions_.size () -1; i >= 0; i--)
646 Interval gap = gaps.allowed_regions_[i];
649 the outer gaps are not knees.
651 if (isinf (gap[LEFT]) || isinf (gap[RIGHT]))
654 if (gap.length () >= max_gap_len)
656 max_gap_len = gap.length ();
661 Real beam_translation = get_beam_translation (me);
662 Real beam_thickness = Beam::get_thickness (me);
663 int beam_count = Beam::get_beam_count (me);
664 Real height_of_beams = beam_thickness / 2
665 + (beam_count - 1) * beam_translation;
666 Real threshold = scm_to_double (scm) + height_of_beams;
668 if (max_gap_len > threshold)
671 for (int i = 0; i < stems.size (); i++)
673 Grob *stem = stems[i];
674 if (Stem::is_invisible (stem))
677 Interval head_extents = head_extents_array[j++];
679 Direction d = (head_extents.center () < max_gap.center ())
682 stem->set_property ("direction", scm_from_int (d));
684 head_extents.intersect (max_gap);
685 assert (head_extents.is_empty () || head_extents.length () < 1e-6);
690 /* Set stem's shorten property if unset.
693 take some y-position (chord/beam/nearest?) into account
694 scmify forced-fraction
696 This is done in beam because the shorten has to be uniform over the
703 set_minimum_dy (Grob *me, Real *dy)
708 If dy is smaller than the smallest quant, we
709 get absurd direction-sign penalties.
712 Real ss = Staff_symbol_referencer::staff_space (me);
713 Real thickness = Beam::get_thickness (me) / ss;
714 Real slt = Staff_symbol_referencer::line_thickness (me) / ss;
715 Real sit = (thickness - slt) / 2;
717 Real hang = 1.0 - (thickness - slt) / 2;
719 *dy = sign (*dy) * max (fabs (*dy),
720 min (min (sit, inter), hang));
726 MAKE_SCHEME_CALLBACK(Beam, calc_stem_shorten, 1)
728 Beam::calc_stem_shorten (SCM smob)
730 Grob *me = unsmob_grob (smob);
733 shortening looks silly for x staff beams
736 return scm_from_int (0);
738 Real forced_fraction = 1.0 * forced_stem_count (me)
739 / visible_stem_count (me);
741 int beam_count = get_beam_count (me);
743 SCM shorten_list = me->get_property ("beamed-stem-shorten");
744 if (shorten_list == SCM_EOL)
745 return scm_from_int (0);
747 Real staff_space = Staff_symbol_referencer::staff_space (me);
750 = robust_list_ref (beam_count -1, shorten_list);
751 Real shorten = scm_to_double (shorten_elt) * staff_space;
753 shorten *= forced_fraction;
757 return scm_from_double (shorten);
759 return scm_from_double (0.0);
765 Compute a first approximation to the beam slope.
767 MAKE_SCHEME_CALLBACK (Beam, calc_least_squares_positions, 2);
769 Beam::calc_least_squares_positions (SCM smob, SCM posns)
773 Grob *me = unsmob_grob (smob);
775 int count = visible_stem_count (me);
778 return ly_interval2scm (pos);
781 extract_grob_set (me, "stems", stems);
782 Grob *commonx = common_refpoint_of_array (stems, me, X_AXIS);
783 Grob *commony = common_refpoint_of_array (stems, me, Y_AXIS);
785 Real my_y = me->relative_coordinate (commony, Y_AXIS);
787 Grob *fvs = first_visible_stem (me);
788 Grob *lvs = last_visible_stem (me);
790 Interval ideal (Stem::get_stem_info (fvs).ideal_y_
791 + fvs->relative_coordinate (commony, Y_AXIS) -my_y,
792 Stem::get_stem_info (lvs).ideal_y_
793 + lvs->relative_coordinate (commony, Y_AXIS) - my_y);
795 Real x0 = first_visible_stem (me)->relative_coordinate (commonx, X_AXIS);
796 for (int i = 0; i < stems.size (); i++)
800 Real x = s->relative_coordinate (commonx, X_AXIS) - x0;
803 Real dx = last_visible_stem (me)->relative_coordinate (commonx, X_AXIS) - x0;
811 Interval chord (Stem::chord_start_y (first_visible_stem (me)),
812 Stem::chord_start_y (last_visible_stem (me)));
814 /* Simple beams (2 stems) on middle line should be allowed to be
817 However, if both stems reach middle line,
818 ideal[LEFT] == ideal[RIGHT] and ideal.delta () == 0.
820 For that case, we apply artificial slope */
821 if (!ideal[LEFT] && chord.delta () && count == 2)
824 Direction d = (Direction) (sign (chord.delta ()) * UP);
825 pos[d] = get_thickness (me) / 2;
832 For broken beams this doesn't work well. In this case, the
833 slope esp. of the first part of a broken beam should predict
834 where the second part goes.
836 ldy = pos[RIGHT] - pos[LEFT];
840 Array<Offset> ideals;
841 for (int i = 0; i < stems.size (); i++)
844 if (Stem::is_invisible (s))
846 ideals.push (Offset (x_posns[i],
847 Stem::get_stem_info (s).ideal_y_
848 + s->relative_coordinate (commony, Y_AXIS)
852 minimise_least_squares (&slope, &y, ideals);
856 set_minimum_dy (me, &dy);
859 pos = Interval (y, (y + dy));
863 "position" is relative to the staff.
865 scale_drul (&pos, 1 / Staff_symbol_referencer::staff_space (me));
867 me->set_property ("least-squares-dy", scm_from_double (ldy));
868 return ly_interval2scm (pos);
872 We can't combine with previous function, since check concave and
873 slope damping comes first.
875 TODO: we should use the concaveness to control the amount of damping
878 MAKE_SCHEME_CALLBACK (Beam, shift_region_to_valid, 2);
880 Beam::shift_region_to_valid (SCM grob, SCM posns)
882 Grob *me = unsmob_grob (grob);
887 extract_grob_set (me, "stems", stems);
888 Grob *commonx = common_refpoint_of_array (stems, me, X_AXIS);
889 Grob *commony = common_refpoint_of_array (stems, me, Y_AXIS);
891 Grob *fvs = first_visible_stem (me);
896 Real x0 = fvs->relative_coordinate (commonx, X_AXIS);
897 for (int i = 0; i < stems.size (); i++)
901 Real x = s->relative_coordinate (commonx, X_AXIS) - x0;
905 Grob *lvs = last_visible_stem (me);
909 Real dx = lvs->relative_coordinate (commonx, X_AXIS) - x0;
911 Drul_array<Real> pos = ly_scm2interval (posns);
914 scale_drul (&pos, Staff_symbol_referencer::staff_space (me));
916 Real dy = pos[RIGHT] - pos[LEFT];
918 Real slope = dx ? (dy / dx) : 0.0;
921 Shift the positions so that we have a chance of finding good
922 quants (i.e. no short stem failures.)
924 Interval feasible_left_point;
925 feasible_left_point.set_full ();
926 for (int i = 0; i < stems.size (); i++)
929 if (Stem::is_invisible (s))
932 Direction d = get_grob_direction (s);
935 = Stem::get_stem_info (s).shortest_y_
936 - slope * x_posns [i];
939 left_y is now relative to the stem S. We want relative to
940 ourselves, so translate:
943 += + s->relative_coordinate (commony, Y_AXIS)
944 - me->relative_coordinate (commony, Y_AXIS);
950 feasible_left_point.intersect (flp);
953 if (feasible_left_point.is_empty ())
954 warning (_ ("no viable initial configuration found: may not find good beam slope"));
955 else if (!feasible_left_point.contains (y))
957 const int REGION_SIZE = 2; // UGH UGH
958 if (isinf (feasible_left_point[DOWN]))
959 y = feasible_left_point[UP] - REGION_SIZE;
960 else if (isinf (feasible_left_point[UP]))
961 y = feasible_left_point[DOWN]+ REGION_SIZE;
963 y = feasible_left_point.center ();
966 pos = Drul_array<Real> (y, (y + dy));
967 scale_drul (&pos, 1 / Staff_symbol_referencer::staff_space (me));
969 return ly_interval2scm (pos);
972 /* This neat trick is by Werner Lemberg,
973 damped = tanh (slope)
974 corresponds with some tables in [Wanske] CHECKME */
975 MAKE_SCHEME_CALLBACK (Beam, slope_damping, 2);
977 Beam::slope_damping (SCM smob, SCM posns)
979 Grob *me = unsmob_grob (smob);
980 Drul_array<Real> pos = ly_scm2interval (posns);
982 if (visible_stem_count (me) <= 1)
986 SCM s = me->get_property ("damping");
987 Real damping = scm_to_double (s);
988 Real concaveness = robust_scm2double (me->get_property ("concaveness"), 0.0);
989 if (concaveness >= 10000)
991 pos[LEFT] = pos[RIGHT];
992 me->set_property ("least-squares-dy", scm_from_double (0));
998 scale_drul (&pos, Staff_symbol_referencer::staff_space (me));
1000 Real dy = pos[RIGHT] - pos[LEFT];
1002 Grob *fvs = first_visible_stem (me);
1003 Grob *lvs = last_visible_stem (me);
1005 Grob *commonx = fvs->common_refpoint (lvs, X_AXIS);
1007 Real dx = last_visible_stem (me)->relative_coordinate (commonx, X_AXIS)
1008 - first_visible_stem (me)->relative_coordinate (commonx, X_AXIS);
1010 Real slope = dy && dx ? dy / dx : 0;
1012 slope = 0.6 * tanh (slope) / (damping + concaveness);
1014 Real damped_dy = slope * dx;
1016 set_minimum_dy (me, &damped_dy);
1018 pos[LEFT] += (dy - damped_dy) / 2;
1019 pos[RIGHT] -= (dy - damped_dy) / 2;
1021 scale_drul (&pos, 1 / Staff_symbol_referencer::staff_space (me));
1024 return ly_interval2scm (pos);
1028 Report slice containing the numbers that are both in (car BEAMING)
1032 where_are_the_whole_beams (SCM beaming)
1036 for (SCM s = scm_car (beaming); scm_is_pair (s); s = scm_cdr (s))
1038 if (scm_c_memq (scm_car (s), scm_cdr (beaming)) != SCM_BOOL_F)
1040 l.add_point (scm_to_int (scm_car (s)));
1046 /* Return the Y position of the stem-end, given the Y-left, Y-right
1047 in POS for stem S. This Y position is relative to S. */
1049 Beam::calc_stem_y (Grob *me, Grob *s, Grob ** common,
1051 Drul_array<Real> pos, bool french)
1053 Real beam_translation = get_beam_translation (me);
1055 Real r = s->relative_coordinate (common[X_AXIS], X_AXIS) - xl;
1056 Real dy = pos[RIGHT] - pos[LEFT];
1058 Real stem_y_beam0 = (dy && dx
1063 Direction my_dir = get_grob_direction (s);
1064 SCM beaming = s->get_property ("beaming");
1066 Real stem_y = stem_y_beam0;
1069 Slice bm = where_are_the_whole_beams (beaming);
1070 if (!bm.is_empty ())
1071 stem_y += beam_translation * bm[-my_dir];
1075 Slice bm = Stem::beam_multiplicity (s);
1076 if (!bm.is_empty ())
1077 stem_y += bm[my_dir] * beam_translation;
1080 Real id = me->relative_coordinate (common[Y_AXIS], Y_AXIS)
1081 - s->relative_coordinate (common[Y_AXIS], Y_AXIS);
1087 Hmm. At this time, beam position and slope are determined. Maybe,
1088 stem directions and length should set to relative to the chord's
1089 position of the beam. */
1090 MAKE_SCHEME_CALLBACK(Beam, set_stem_lengths, 1);
1092 Beam::set_stem_lengths (SCM smob)
1094 Grob *me = unsmob_grob (smob);
1096 /* trigger callback. */
1097 (void) me->get_property ("direction");
1099 SCM posns = me->get_property ("positions");
1101 extract_grob_set (me, "stems", stems);
1106 for (int a = 2; a--;)
1107 common[a] = common_refpoint_of_array (stems, me, Axis (a));
1109 Drul_array<Real> pos = ly_scm2realdrul (posns);
1110 Real staff_space = Staff_symbol_referencer::staff_space (me);
1111 scale_drul (&pos, staff_space);
1115 if (scm_is_number (me->get_property ("gap-count"))
1116 && scm_to_int (me->get_property ("gap-count")))
1119 thick = get_thickness (me);
1122 Grob *fvs = first_visible_stem (me);
1123 Grob *lvs = last_visible_stem (me);
1125 Real xl = fvs ? fvs->relative_coordinate (common[X_AXIS], X_AXIS) : 0.0;
1126 Real xr = lvs ? lvs->relative_coordinate (common[X_AXIS], X_AXIS) : 0.0;
1128 for (int i = 0; i < stems.size (); i++)
1131 if (Stem::is_invisible (s))
1134 bool french = to_boolean (s->get_property ("french-beaming"));
1135 Real stem_y = calc_stem_y (me, s, common,
1137 pos, french && s != lvs && s!= fvs);
1140 Make the stems go up to the end of the beam. This doesn't matter
1141 for normal beams, but for tremolo beams it looks silly otherwise.
1144 stem_y += thick * 0.5 * get_grob_direction (s);
1146 Stem::set_stemend (s, 2 * stem_y / staff_space);
1153 Beam::set_beaming (Grob *me, Beaming_info_list const *beaming)
1155 extract_grob_set (me, "stems", stems);
1158 for (int i = 0; i < stems.size (); i++)
1161 Don't overwrite user settings.
1165 Grob *stem = stems[i];
1166 SCM beaming_prop = stem->get_property ("beaming");
1167 if (beaming_prop == SCM_EOL
1168 || index_get_cell (beaming_prop, d) == SCM_EOL)
1170 int b = beaming->infos_.elem (i).beams_i_drul_[d];
1172 && i < stems.size () -1
1173 && Stem::is_invisible (stem))
1174 b = min (b, beaming->infos_.elem (i).beams_i_drul_[-d]);
1176 Stem::set_beaming (stem, b, d);
1179 while (flip (&d) != LEFT);
1184 Beam::forced_stem_count (Grob *me)
1186 extract_grob_set (me, "stems", stems);
1189 for (int i = 0; i < stems.size (); i++)
1193 if (Stem::is_invisible (s))
1196 /* I can imagine counting those boundaries as a half forced stem,
1197 but let's count them full for now. */
1198 Direction defdir = to_dir (s->get_property ("default-direction"));
1200 if (abs (Stem::chord_start_y (s)) > 0.1
1202 && get_grob_direction (s) != defdir)
1209 Beam::visible_stem_count (Grob *me)
1211 extract_grob_set (me, "stems", stems);
1213 for (int i = stems.size (); i--;)
1215 if (!Stem::is_invisible (stems[i]))
1222 Beam::first_visible_stem (Grob *me)
1224 extract_grob_set (me, "stems", stems);
1226 for (int i = 0; i < stems.size (); i++)
1228 if (!Stem::is_invisible (stems[i]))
1235 Beam::last_visible_stem (Grob *me)
1237 extract_grob_set (me, "stems", stems);
1239 for (int i = stems.size (); i--;)
1241 if (!Stem::is_invisible (stems[i]))
1250 handle rest under beam (do_post: beams are calculated now)
1251 what about combination of collisions and rest under beam.
1255 rest -> stem -> beam -> interpolate_y_position ()
1257 MAKE_SCHEME_CALLBACK (Beam, rest_collision_callback, 2);
1259 Beam::rest_collision_callback (SCM smob, SCM prev_offset)
1261 Grob *rest = unsmob_grob (smob);
1262 if (scm_is_number (rest->get_property ("staff-position")))
1263 return scm_from_int (0);
1265 Real offset = robust_scm2double (prev_offset, 0.0);
1267 Grob *st = unsmob_grob (rest->get_object ("stem"));
1270 return scm_from_double (0.0);
1271 Grob *beam = unsmob_grob (stem->get_object ("beam"));
1273 || !Beam::has_interface (beam)
1274 || !Beam::visible_stem_count (beam))
1275 return scm_from_double (0.0);
1277 Drul_array<Real> pos (0, 0);
1278 SCM s = beam->get_property ("positions");
1279 if (scm_is_pair (s) && scm_is_number (scm_car (s)))
1280 pos = ly_scm2interval (s);
1282 programming_error ("positions property should always be pair of numbers.");
1284 Real staff_space = Staff_symbol_referencer::staff_space (rest);
1286 scale_drul (&pos, staff_space);
1288 Real dy = pos[RIGHT] - pos[LEFT];
1290 Drul_array<Grob*> visible_stems (first_visible_stem (beam),
1291 last_visible_stem (beam));
1292 extract_grob_set (beam, "stems", stems);
1294 Grob *common = common_refpoint_of_array (stems, beam, X_AXIS);
1296 Real x0 = visible_stems[LEFT]->relative_coordinate (common, X_AXIS);
1297 Real dx = visible_stems[RIGHT]->relative_coordinate (common, X_AXIS) - x0;
1298 Real slope = dy && dx ? dy / dx : 0;
1300 Direction d = get_grob_direction (stem);
1301 Real stem_y = pos[LEFT]
1302 + (stem->relative_coordinate (common, X_AXIS) - x0) * slope;
1304 Real beam_translation = get_beam_translation (beam);
1305 Real beam_thickness = Beam::get_thickness (beam);
1308 TODO: this is not strictly correct for 16th knee beams.
1311 = Stem::beam_multiplicity (stem).length () + 1;
1313 Real height_of_my_beams = beam_thickness / 2
1314 + (beam_count - 1) * beam_translation;
1315 Real beam_y = stem_y - d * height_of_my_beams;
1317 Grob *common_y = rest->common_refpoint (beam, Y_AXIS);
1318 Interval rest_extent = rest->extent (common_y, Y_AXIS);
1319 rest_extent.translate (offset);
1321 Real rest_dim = rest_extent[d];
1322 Real minimum_distance
1323 = staff_space * (robust_scm2double (stem->get_property ("stemlet-length"), 0.0)
1324 + robust_scm2double (rest->get_property ("minimum-distance"), 0.0));
1326 Real shift = d * min (((beam_y - d * minimum_distance) - rest_dim) * d, 0.0);
1328 shift /= staff_space;
1329 Real rad = Staff_symbol_referencer::line_count (rest) * staff_space / 2;
1331 /* Always move discretely by half spaces */
1332 shift = ceil (fabs (shift * 2.0)) / 2.0 * sign (shift);
1334 /* Inside staff, move by whole spaces*/
1335 if ((rest_extent[d] + staff_space * shift) * d
1337 || (rest_extent[-d] + staff_space * shift) * -d
1339 shift = ceil (fabs (shift)) * sign (shift);
1341 return scm_from_double (staff_space * shift);
1345 Beam::is_knee (Grob *me)
1347 SCM k = me->get_property ("knee");
1348 if (scm_is_bool (k))
1349 return ly_scm2bool (k);
1353 extract_grob_set (me, "stems", stems);
1354 for (int i = stems.size (); i--;)
1356 Direction dir = get_grob_direction (stems[i]);
1365 me->set_property ("knee", ly_bool2scm (knee));
1371 Beam::get_direction_beam_count (Grob *me, Direction d)
1373 extract_grob_set (me, "stems", stems);
1376 for (int i = stems.size (); i--;)
1379 Should we take invisible stems into account?
1381 if (get_grob_direction (stems[i]) == d)
1382 bc = max (bc, (Stem::beam_multiplicity (stems[i]).length () + 1));
1388 ADD_INTERFACE (Beam,
1392 "The @code{thickness} property is the weight of beams, "
1393 "measured in staffspace. The @code{direction} "
1394 "property is not user-serviceable. Use "
1395 "the @code{direction} property of @code{Stem} instead. "
1401 "beamed-stem-shorten "
1415 "neutral-direction "
1418 "quantized-positions "