]> git.donarmstrong.com Git - lilypond.git/blob - lily/beam.cc
* lily/tie-formatting-problem.cc (from_lv_ties): add heads for
[lilypond.git] / lily / beam.cc
1 /*
2   beam.cc -- implement Beam
3
4   source file of the GNU LilyPond music typesetter
5
6   (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
7   Jan Nieuwenhuizen <janneke@gnu.org>
8 */
9
10 /*
11   TODO:
12
13   - Determine auto knees based on positions if it's set by the user.
14
15   - the code is littered with * and / staff_space calls for
16   #'positions. Consider moving to real-world coordinates?
17
18   Problematic issue is user tweaks (user tweaks are in staff-coordinates.)
19
20   Notes:
21
22   - Stems run to the Y-center of the beam.
23
24   - beam_translation is the offset between Y centers of the beam.
25 */
26
27 #include "beam.hh"
28
29 #include "beaming.hh"
30 #include "directional-element-interface.hh"
31 #include "international.hh"
32 #include "interval-set.hh"
33 #include "item.hh"
34 #include "least-squares.hh"
35 #include "lookup.hh"
36 #include "misc.hh"
37 #include "output-def.hh"
38 #include "pointer-group-interface.hh"
39 #include "spanner.hh"
40 #include "staff-symbol-referencer.hh"
41 #include "stem.hh"
42 #include "warn.hh"
43
44 #if DEBUG_QUANTING
45 #include "text-interface.hh" // debug output.
46 #include "font-interface.hh" // debug output.
47 #endif
48
49 void
50 Beam::add_stem (Grob *me, Grob *s)
51 {
52   if (Stem::get_beam (s))
53     {
54       programming_error ("Stem already has beam");
55       return ;
56     }
57
58   Pointer_group_interface::add_grob (me, ly_symbol2scm ("stems"), s);
59   s->set_object ("beam", me->self_scm ());
60   add_bound_item (dynamic_cast<Spanner *> (me), dynamic_cast<Item *> (s));
61 }
62
63 Real
64 Beam::get_thickness (Grob *me)
65 {
66   return robust_scm2double (me->get_property ("thickness"), 0)
67     * Staff_symbol_referencer::staff_space (me);
68 }
69
70 /* Return the translation between 2 adjoining beams. */
71 Real
72 Beam::get_beam_translation (Grob *me)
73 {
74   int beam_count = get_beam_count (me);
75   Real staff_space = Staff_symbol_referencer::staff_space (me);
76   Real line = Staff_symbol_referencer::line_thickness (me);
77   Real thickness = get_thickness (me);
78   Real fract = robust_scm2double (me->get_property ("length-fraction"), 1.0);
79   
80   Real beam_translation = beam_count < 4
81     ? (2 * staff_space + line - thickness) / 2.0
82     : (3 * staff_space + line - thickness) / 3.0;
83
84   return fract * beam_translation;
85 }
86
87 /* Maximum beam_count. */
88 int
89 Beam::get_beam_count (Grob *me)
90 {
91   int m = 0;
92
93   extract_grob_set (me, "stems", stems);
94   for (vsize i = 0; i < stems.size (); i++)
95     {
96       Grob *stem = stems[i];
97       m = max (m, (Stem::beam_multiplicity (stem).length () + 1));
98     }
99   return m;
100 }
101
102
103 MAKE_SCHEME_CALLBACK (Beam, calc_direction, 1);
104 SCM
105 Beam::calc_direction (SCM smob)
106 {
107   Grob *me = unsmob_grob (smob);
108
109   /* Beams with less than 2 two stems don't make much sense, but could happen
110      when you do
111
112      [r8 c8 r8].
113
114      For a beam that  only has one stem, we try to do some disappearance magic:
115      we revert the flag, and move on to The Eternal Engraving Fields. */
116
117   Direction d = CENTER;
118
119   int count = visible_stem_count (me);
120   if (count < 2)
121     {
122       extract_grob_set (me, "stems", stems);
123       if (stems.size () == 1)
124         {
125           me->warning (_ ("removing beam with less than two stems"));
126
127           stems[0]->set_object ("beam", SCM_EOL);
128           me->suicide ();
129
130           return SCM_UNSPECIFIED;
131         }
132       else if (stems.size () == 0)
133         {
134           me->suicide ();
135           return SCM_UNSPECIFIED;
136         }
137       else 
138         {
139           Grob *stem = first_visible_stem (me);
140
141           /*
142             ugh: stems[0] case happens for chord tremolo.
143           */
144           d = to_dir ((stem ? stem : stems[0])->get_property ("default-direction"));
145         }
146     }
147
148   if (count >= 1)
149     {
150       if (!d)
151         d = get_default_dir (me);
152       
153       consider_auto_knees (me);
154     }
155
156   if (d)
157     {
158       set_stem_directions (me, d);
159     }
160   
161   return scm_from_int (d);
162 }
163
164
165
166 /* We want a maximal number of shared beams, but if there is choice, we
167  * take the one that is closest to the end of the stem. This is for
168  * situations like
169  *
170  *        x
171  *       |
172  *       |
173  *   |===|
174  *   |=
175  *   |
176  *  x
177  */
178 int
179 position_with_maximal_common_beams (SCM left_beaming, SCM right_beaming,
180                                     Direction left_dir,
181                                     Direction right_dir)
182 {
183   Slice lslice = int_list_to_slice (scm_cdr (left_beaming));
184
185   int best_count = 0;
186   int best_start = 0;
187   for (int i = lslice[-left_dir];
188        (i - lslice[left_dir]) * left_dir <= 0; i += left_dir)
189     {
190       int count = 0;
191       for (SCM s = scm_car (right_beaming); scm_is_pair (s); s = scm_cdr (s))
192         {
193           int k = -right_dir * scm_to_int (scm_car (s)) + i;
194           if (scm_c_memq (scm_from_int (k), left_beaming) != SCM_BOOL_F)
195             count++;
196         }
197
198       if (count >= best_count)
199         {
200           best_count = count;
201           best_start = i;
202         }
203     }
204
205   return best_start;
206 }
207
208 MAKE_SCHEME_CALLBACK(Beam, calc_beaming, 1)
209 SCM
210 Beam::calc_beaming (SCM smob)
211 {
212   Grob *me = unsmob_grob (smob);
213   
214   extract_grob_set (me, "stems", stems);
215
216   Slice last_int;
217   last_int.set_empty ();
218   
219   SCM last_beaming = scm_cons (SCM_EOL, scm_list_1 (scm_from_int (0)));
220   Direction last_dir = CENTER;
221   for (vsize i = 0; i < stems.size (); i++)
222     {
223       Grob *this_stem = stems[i];
224       SCM this_beaming = this_stem->get_property ("beaming");
225
226       Direction this_dir = get_grob_direction (this_stem);
227       if (scm_is_pair (last_beaming) && scm_is_pair (this_beaming))
228         {
229           int start_point = position_with_maximal_common_beams
230             (last_beaming, this_beaming,
231              last_dir ? last_dir : this_dir,
232              this_dir);
233
234           Direction d = LEFT;
235           Slice new_slice;
236           do
237             {
238               new_slice.set_empty ();
239               SCM s = index_get_cell (this_beaming, d);
240               for (; scm_is_pair (s); s = scm_cdr (s))
241                 {
242                   int new_beam_pos
243                     = start_point - this_dir * scm_to_int (scm_car (s));
244
245                   new_slice.add_point (new_beam_pos);
246                   scm_set_car_x (s, scm_from_int (new_beam_pos));
247                 }
248             }
249           while (flip (&d) != LEFT);
250
251           if (!new_slice.is_empty ())
252             last_int = new_slice;
253         }
254       else
255         {
256           SCM s = scm_cdr (this_beaming);
257           for (; scm_is_pair (s); s = scm_cdr (s))
258             {
259               int np = -this_dir * scm_to_int (scm_car (s));
260               scm_set_car_x (s, scm_from_int (np));
261               last_int.add_point (np);
262             }
263         }
264       
265       if (scm_ilength (scm_cdr (this_beaming)) > 0)
266         {
267           last_beaming = this_beaming;
268           last_dir = this_dir;
269         }
270     }
271
272   return SCM_EOL;
273 }
274
275 /*
276   I really enjoy spaghetti, but spaghetti should be kept on a plate
277   with a little garlic and olive oil. This is too much.
278
279   rewrite-me
280 */
281 MAKE_SCHEME_CALLBACK (Beam, print, 1);
282 SCM
283 Beam::print (SCM grob)
284 {
285   Spanner *me = unsmob_spanner (grob);
286
287   extract_grob_set (me, "stems", stems);
288   Grob *xcommon = common_refpoint_of_array (stems, me, X_AXIS);
289
290   xcommon = me->get_bound (LEFT)->common_refpoint (xcommon, X_AXIS);
291   xcommon = me->get_bound (RIGHT)->common_refpoint (xcommon, X_AXIS);
292
293   Real x0, dx;
294   if (visible_stem_count (me))
295     {
296       // ugh -> use commonx
297       x0 = first_visible_stem (me)->relative_coordinate (xcommon, X_AXIS);
298       dx = last_visible_stem (me)->relative_coordinate (xcommon, X_AXIS) - x0;
299     }
300   else
301     {
302       x0 = stems[0]->relative_coordinate (xcommon, X_AXIS);
303       dx = stems.back ()->relative_coordinate (xcommon, X_AXIS) - x0;
304     }
305
306   SCM posns = me->get_property ("quantized-positions");
307   Drul_array<Real> pos;
308   if (!is_number_pair (posns))
309     {
310       programming_error ("no beam positions?");
311       pos = Interval (0, 0);
312     }
313   else
314     pos = ly_scm2realdrul (posns);
315
316   scale_drul (&pos, Staff_symbol_referencer::staff_space (me));
317
318   Real dy = pos[RIGHT] - pos[LEFT];
319   Real slope = (dy && dx) ? dy / dx : 0;
320
321   Real thick = get_thickness (me);
322   Real bdy = get_beam_translation (me);
323
324   SCM last_beaming = SCM_EOL;
325   Real last_xposn = -1;
326   Real last_stem_width = -1;
327
328   Real gap_length = robust_scm2double (me->get_property ("gap"), 0.0);
329
330   Stencil the_beam;
331   Real lt = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
332
333   for (vsize i = 0; i <= stems.size (); i++)
334     {
335       Grob *stem = (i < stems.size ()) ? stems[i] : 0;
336
337       SCM this_beaming = stem ? stem->get_property ("beaming") : SCM_EOL;
338       Real xposn = stem ? stem->relative_coordinate (xcommon, X_AXIS) : 0.0;
339       Real stem_width = stem ? robust_scm2double (stem->get_property ("thickness"), 1.0) * lt : 0;
340       Direction stem_dir = stem ? to_dir (stem->get_property ("direction")) : CENTER;
341       /*
342         We do the space left of ST, with lfliebertjes pointing to the
343         right from the left stem, and rfliebertjes pointing left from
344         right stem.
345       */
346       SCM left = (i > 0) ? scm_cdr (last_beaming) : SCM_EOL;
347       SCM right = stem ? scm_car (this_beaming) : SCM_EOL;
348
349       vector<int> full_beams;
350       vector<int> lfliebertjes;
351       vector<int> rfliebertjes;
352
353       for (SCM s = left;
354            scm_is_pair (s); s = scm_cdr (s))
355         {
356           int b = scm_to_int (scm_car (s));
357           if (scm_c_memq (scm_car (s), right) != SCM_BOOL_F)
358             full_beams.push_back (b);
359           else
360             lfliebertjes.push_back (b);
361         }
362       for (SCM s = right;
363            scm_is_pair (s); s = scm_cdr (s))
364         {
365           int b = scm_to_int (scm_car (s));
366           if (scm_c_memq (scm_car (s), left) == SCM_BOOL_F)
367             rfliebertjes.push_back (b);
368         }
369
370       Drul_array<Real> break_overshoot
371         = robust_scm2drul (me->get_property ("break-overshoot"),
372                            Drul_array<Real> (-0.5, 0.0));
373
374       Real w = (i > 0 && stem)
375         ? (xposn - last_xposn)
376         : break_overshoot[ (i == 0) ? LEFT : RIGHT];
377
378       Real stem_offset = 0.0;
379       if (i > 0)
380         {
381           w += last_stem_width / 2;
382           stem_offset = -last_stem_width / 2;
383         }
384
385       if (stem)
386         w += stem_width / 2;
387
388       Real blot = me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter"));
389       Stencil whole = Lookup::beam (slope, w, thick, blot);
390       Stencil gapped;
391
392       int gap_count = 0;
393       if (scm_is_number (me->get_property ("gap-count")))
394         {
395           gap_count = scm_to_int (me->get_property ("gap-count"));
396           gapped = Lookup::beam (slope, w - 2 * gap_length, thick, blot);
397
398           vector_sort (full_beams, default_compare);
399           if (stem_dir == UP)
400             reverse (full_beams);
401         }
402
403       int k = 0;
404       for (vsize j = full_beams.size (); j--;)
405         {
406           Stencil b (whole);
407
408           if (k++ < gap_count)
409             {
410               b = gapped;
411               b.translate_axis (gap_length, X_AXIS);
412             }
413           b.translate_axis (last_xposn - x0 + stem_offset, X_AXIS);
414           b.translate_axis (slope * (last_xposn - x0) + bdy * full_beams[j], Y_AXIS);
415
416           the_beam.add_stencil (b);
417         }
418
419       if (lfliebertjes.size () || rfliebertjes.size ())
420         {
421           Real nw_f;
422
423           if (stem)
424             {
425               int t = Stem::duration_log (stem);
426               // ugh. hardcoded.
427               if (t == 1)
428                 nw_f = 1.98;
429               else
430                 nw_f = 1.32;
431             }
432           else
433             nw_f = break_overshoot[RIGHT] / 2;
434
435           /* Half beam should be one note-width,
436              but let's make sure two half-beams never touch */
437           Real lw = nw_f;
438           Real rw = nw_f;
439           if (i > 0)
440             rw = min (nw_f, ((xposn - last_xposn) / 2));
441           else
442             {
443               if (me->get_bound (LEFT)->break_status_dir ())
444                 rw = xposn - me->get_bound (LEFT)->extent (xcommon, X_AXIS)[RIGHT]
445                   + break_overshoot[LEFT];
446               else
447                 rw = 1.0;       // ugh.
448             }
449           
450           if (stem)
451             lw = min (nw_f, ((xposn - last_xposn) / 2));
452           else
453             {
454               lw = me->get_bound (RIGHT)->relative_coordinate (xcommon, X_AXIS)
455                 - last_xposn
456                 + break_overshoot[RIGHT];
457             }
458           rw += stem_width / 2;
459           lw += last_stem_width / 2;
460
461           Stencil rhalf = Lookup::beam (slope, rw, thick, blot);
462           Stencil lhalf = Lookup::beam (slope, lw, thick, blot);
463           for (vsize j = lfliebertjes.size (); j--;)
464             {
465               Stencil b (lhalf);
466               b.translate_axis (last_xposn - x0 - last_stem_width /2,
467                                 X_AXIS);
468               b.translate_axis (slope * (last_xposn - x0)
469                                 + bdy * lfliebertjes[j],
470                                 Y_AXIS);
471               the_beam.add_stencil (b);
472             }
473           for (vsize j = rfliebertjes.size (); j--;)
474             {
475               Stencil b (rhalf);
476               b.translate_axis (xposn - x0 - rw + stem_width / 2, X_AXIS);
477               b.translate_axis (slope * (xposn - x0 - rw)
478                                 + bdy * rfliebertjes[j], Y_AXIS);
479               the_beam.add_stencil (b);
480             }
481         }
482
483       last_xposn = xposn;
484       last_stem_width = stem_width;
485       last_beaming = this_beaming;
486     }
487
488   the_beam.translate_axis (x0 - me->relative_coordinate (xcommon, X_AXIS),
489                            X_AXIS);
490   the_beam.translate_axis (pos[LEFT], Y_AXIS);
491
492 #if (DEBUG_QUANTING)
493   SCM quant_score = me->get_property ("quant-score");
494   SCM debug = me->layout ()->lookup_variable (ly_symbol2scm ("debug-beam-quanting"));
495   if (to_boolean (debug) && scm_is_string (quant_score))
496     {
497
498       /*
499         This code prints the demerits for each beam. Perhaps this
500         should be switchable for those who want to twiddle with the
501         parameters.
502       */
503       string str;
504       SCM properties = Font_interface::text_font_alist_chain (me);
505
506       Direction stem_dir = stems.size () ? to_dir (stems[0]->get_property ("direction")) : UP;
507
508       Stencil score = *unsmob_stencil (Text_interface::interpret_markup
509                                     (me->layout ()->self_scm (), properties, quant_score));
510
511       if (!score.is_empty ())
512         the_beam.add_at_edge (Y_AXIS, stem_dir, score, 1.0, 0);
513     }
514 #endif
515
516   return the_beam.smobbed_copy ();
517 }
518
519 Direction
520 Beam::get_default_dir (Grob *me)
521 {
522   extract_grob_set (me, "stems", stems);
523
524   Drul_array<Real> extremes (0.0, 0.0);
525   for (iterof (s, stems); s != stems.end (); s++)
526     {
527       Interval positions = Stem::head_positions (*s);
528       Direction d = DOWN;
529       do
530         {
531           if (sign (positions[d]) == d)
532             extremes[d] = d * max (d * positions[d], d * extremes[d]);
533         }
534       while (flip (&d) != DOWN);
535     }
536
537   Drul_array<int> total (0, 0);
538   Drul_array<int> count (0, 0);
539
540   bool force_dir = false;
541   for (vsize i = 0; i < stems.size (); i++)
542     {
543       Grob *s = stems[i];
544       Direction stem_dir = CENTER;
545       SCM stem_dir_scm = s->get_property_data (ly_symbol2scm ("direction"));
546       if (is_direction (stem_dir_scm))
547         {
548           stem_dir = to_dir (stem_dir_scm);
549           force_dir = true;
550         }
551       else
552         stem_dir = to_dir (s->get_property ("default-direction"));
553
554       if (!stem_dir)
555         stem_dir = to_dir (s->get_property ("neutral-direction"));
556
557       if (stem_dir)
558         {
559           count[stem_dir] ++;
560           total[stem_dir] += max (int (- stem_dir * Stem::head_positions (s) [-stem_dir]), 0);
561         }
562     }
563
564
565   if (!force_dir)
566     {
567       if (abs (extremes[UP]) > -extremes[DOWN])
568         return DOWN;
569       else if (extremes[UP] < -extremes[DOWN])
570         return UP;
571     }
572   
573   Direction dir = CENTER;
574   Direction d = CENTER;
575   if ((d = (Direction) sign (count[UP] - count[DOWN])))
576     dir = d;
577   else if (count[UP]
578            && count[DOWN]
579            && (d = (Direction)  sign (total[UP] / count[UP] - total[DOWN]/count[DOWN])))
580     dir = d;
581   else if ((d = (Direction)  sign (total[UP] - total[DOWN])))
582     dir = d;
583   else
584     dir = to_dir (me->get_property ("neutral-direction"));
585   
586   return dir;
587 }
588
589 /* Set all stems with non-forced direction to beam direction.
590    Urg: non-forced should become `without/with unforced' direction,
591    once stem gets cleaned-up. */
592 void
593 Beam::set_stem_directions (Grob *me, Direction d)
594 {
595   extract_grob_set (me, "stems", stems);
596
597   for (vsize i = 0; i < stems.size (); i++)
598     {
599       Grob *s = stems[i];
600
601       SCM forcedir = s->get_property_data (ly_symbol2scm ("direction"));
602       if (!to_dir (forcedir))
603         set_grob_direction (s, d);
604     }
605 }
606
607 /*
608   Only try horizontal beams for knees.  No reliable detection of
609   anything else is possible here, since we don't know funky-beaming
610   settings, or X-distances (slopes!)  People that want sloped
611   knee-beams, should set the directions manually.
612
613
614   TODO:
615
616   this routine should take into account the stemlength scoring
617   of a possible knee/nonknee beam.
618 */
619 void
620 Beam::consider_auto_knees (Grob *me)
621 {
622   SCM scm = me->get_property ("auto-knee-gap");
623   if (!scm_is_number (scm))
624     return;
625
626   Interval_set gaps;
627
628   gaps.set_full ();
629
630   extract_grob_set (me, "stems", stems);
631
632   Grob *common = common_refpoint_of_array (stems, me, Y_AXIS);
633   Real staff_space = Staff_symbol_referencer::staff_space (me);
634
635   vector<Interval> head_extents_array;
636   for (vsize i = 0; i < stems.size (); i++)
637     {
638       Grob *stem = stems[i];
639       if (Stem::is_invisible (stem))
640         continue;
641
642       Interval head_extents = Stem::head_positions (stem);
643       if (!head_extents.is_empty ())
644         {
645           head_extents[LEFT] += -1;
646           head_extents[RIGHT] += 1;
647           head_extents *= staff_space * 0.5;
648
649           /*
650             We could subtract beam Y position, but this routine only
651             sets stem directions, a constant shift does not have an
652             influence.
653           */
654           head_extents += stem->relative_coordinate (common, Y_AXIS);
655
656           if (to_dir (stem->get_property_data (ly_symbol2scm ("direction"))))
657             {
658               Direction stemdir = to_dir (stem->get_property ("direction"));
659               head_extents[-stemdir] = -stemdir * infinity_f;
660             }
661         }
662       head_extents_array.push_back (head_extents);
663
664       gaps.remove_interval (head_extents);
665     }
666
667   Interval max_gap;
668   Real max_gap_len = 0.0;
669
670   for (vsize i = gaps.allowed_regions_.size () -1; i != VPOS ;i--)
671     {
672       Interval gap = gaps.allowed_regions_[i];
673
674       /*
675         the outer gaps are not knees.
676       */
677       if (isinf (gap[LEFT]) || isinf (gap[RIGHT]))
678         continue;
679
680       if (gap.length () >= max_gap_len)
681         {
682           max_gap_len = gap.length ();
683           max_gap = gap;
684         }
685     }
686
687   Real beam_translation = get_beam_translation (me);
688   Real beam_thickness = Beam::get_thickness (me);
689   int beam_count = Beam::get_beam_count (me);
690   Real height_of_beams = beam_thickness / 2
691     + (beam_count - 1) * beam_translation;
692   Real threshold = scm_to_double (scm) + height_of_beams;
693
694   if (max_gap_len > threshold)
695     {
696       int j = 0;
697       for (vsize i = 0; i < stems.size (); i++)
698         {
699           Grob *stem = stems[i];
700           if (Stem::is_invisible (stem))
701             continue;
702
703           Interval head_extents = head_extents_array[j++];
704
705           Direction d = (head_extents.center () < max_gap.center ())
706             ? UP : DOWN;
707
708           stem->set_property ("direction", scm_from_int (d));
709
710           head_extents.intersect (max_gap);
711           assert (head_extents.is_empty () || head_extents.length () < 1e-6);
712         }
713     }
714 }
715
716 /* Set stem's shorten property if unset.
717
718 TODO:
719 take some y-position (chord/beam/nearest?) into account
720 scmify forced-fraction
721
722 This is done in beam because the shorten has to be uniform over the
723 entire beam.
724 */
725
726
727
728 void
729 set_minimum_dy (Grob *me, Real *dy)
730 {
731   if (*dy)
732     {
733       /*
734         If dy is smaller than the smallest quant, we
735         get absurd direction-sign penalties.
736       */
737
738       Real ss = Staff_symbol_referencer::staff_space (me);
739       Real thickness = Beam::get_thickness (me) / ss;
740       Real slt = Staff_symbol_referencer::line_thickness (me) / ss;
741       Real sit = (thickness - slt) / 2;
742       Real inter = 0.5;
743       Real hang = 1.0 - (thickness - slt) / 2;
744
745       *dy = sign (*dy) * max (fabs (*dy),
746                               min (min (sit, inter), hang));
747     }
748 }
749
750   
751
752 MAKE_SCHEME_CALLBACK(Beam, calc_stem_shorten, 1)
753 SCM
754 Beam::calc_stem_shorten (SCM smob)
755 {
756   Grob *me = unsmob_grob (smob);
757   
758   /*
759     shortening looks silly for x staff beams
760   */
761   if (is_knee (me))
762     return scm_from_int (0);
763
764   Real forced_fraction = 1.0 * forced_stem_count (me)
765     / visible_stem_count (me);
766
767   int beam_count = get_beam_count (me);
768
769   SCM shorten_list = me->get_property ("beamed-stem-shorten");
770   if (shorten_list == SCM_EOL)
771     return scm_from_int (0);
772
773   Real staff_space = Staff_symbol_referencer::staff_space (me);
774
775   SCM shorten_elt
776     = robust_list_ref (beam_count -1, shorten_list);
777   Real shorten = scm_to_double (shorten_elt) * staff_space;
778
779   shorten *= forced_fraction;
780
781   
782   if (shorten)
783     return scm_from_double (shorten);
784
785   return scm_from_double (0.0);
786 }
787
788
789
790 /*
791   Compute a first approximation to the beam slope.
792 */
793 MAKE_SCHEME_CALLBACK (Beam, calc_least_squares_positions, 2);
794 SCM
795 Beam::calc_least_squares_positions (SCM smob, SCM posns)
796 {
797   (void) posns;
798   
799   Grob *me = unsmob_grob (smob);
800
801   int count = visible_stem_count (me);
802   Interval pos (0,0);
803   if (count < 1)
804     return ly_interval2scm (pos);
805   
806   vector<Real> x_posns;
807   extract_grob_set (me, "stems", stems);
808   Grob *commonx = common_refpoint_of_array (stems, me, X_AXIS);
809   Grob *commony = common_refpoint_of_array (stems, me, Y_AXIS);
810
811   Real my_y = me->relative_coordinate (commony, Y_AXIS);
812
813   Grob *fvs = first_visible_stem (me);
814   Grob *lvs = last_visible_stem (me);
815
816   Interval ideal (Stem::get_stem_info (fvs).ideal_y_
817                   + fvs->relative_coordinate (commony, Y_AXIS) -my_y,
818                   Stem::get_stem_info (lvs).ideal_y_
819                   + lvs->relative_coordinate (commony, Y_AXIS) - my_y);
820
821   Real x0 = first_visible_stem (me)->relative_coordinate (commonx, X_AXIS);
822   for (vsize i = 0; i < stems.size (); i++)
823     {
824       Grob *s = stems[i];
825
826       Real x = s->relative_coordinate (commonx, X_AXIS) - x0;
827       x_posns.push_back (x);
828     }
829   Real dx = last_visible_stem (me)->relative_coordinate (commonx, X_AXIS) - x0;
830
831   Real y = 0;
832   Real slope = 0;
833   Real dy = 0;
834   Real ldy = 0.0;
835   if (!ideal.delta ())
836     {
837       Interval chord (Stem::chord_start_y (first_visible_stem (me)),
838                       Stem::chord_start_y (last_visible_stem (me)));
839
840       /* Simple beams (2 stems) on middle line should be allowed to be
841          slightly sloped.
842
843          However, if both stems reach middle line,
844          ideal[LEFT] == ideal[RIGHT] and ideal.delta () == 0.
845
846          For that case, we apply artificial slope */
847       if (!ideal[LEFT] && chord.delta () && count == 2)
848         {
849           /* FIXME. -> UP */
850           Direction d = (Direction) (sign (chord.delta ()) * UP);
851           pos[d] = get_thickness (me) / 2;
852           pos[-d] = -pos[d];
853         }
854       else
855         pos = ideal;
856
857       /*
858         For broken beams this doesn't work well. In this case, the
859         slope esp. of the first part of a broken beam should predict
860         where the second part goes.
861       */
862       ldy = pos[RIGHT] - pos[LEFT];
863     }
864   else
865     {
866       vector<Offset> ideals;
867       for (vsize i = 0; i < stems.size (); i++)
868         {
869           Grob *s = stems[i];
870           if (Stem::is_invisible (s))
871             continue;
872           ideals.push_back (Offset (x_posns[i],
873                                Stem::get_stem_info (s).ideal_y_
874                                + s->relative_coordinate (commony, Y_AXIS)
875                                - my_y));
876         }
877
878       minimise_least_squares (&slope, &y, ideals);
879
880       dy = slope * dx;
881
882       set_minimum_dy (me, &dy);
883
884       ldy = dy;
885       pos = Interval (y, (y + dy));
886     }
887
888   /*
889     "position" is relative to the staff.
890   */
891   scale_drul (&pos, 1 / Staff_symbol_referencer::staff_space (me));
892
893   me->set_property ("least-squares-dy",  scm_from_double (ldy));
894   return ly_interval2scm (pos);
895 }
896
897 /*
898   We can't combine with previous function, since check concave and
899   slope damping comes first.
900
901   TODO: we should use the concaveness to control the amount of damping
902   applied.
903 */
904 MAKE_SCHEME_CALLBACK (Beam, shift_region_to_valid, 2);
905 SCM
906 Beam::shift_region_to_valid (SCM grob, SCM posns)
907 {
908   Grob *me = unsmob_grob (grob);
909   /*
910     Code dup.
911   */
912   vector<Real> x_posns;
913   extract_grob_set (me, "stems", stems);
914   Grob *commonx = common_refpoint_of_array (stems, me, X_AXIS);
915   Grob *commony = common_refpoint_of_array (stems, me, Y_AXIS);
916
917   Grob *fvs = first_visible_stem (me);
918
919   if (!fvs)
920     return posns;
921
922   Real x0 = fvs->relative_coordinate (commonx, X_AXIS);
923   for (vsize i = 0; i < stems.size (); i++)
924     {
925       Grob *s = stems[i];
926
927       Real x = s->relative_coordinate (commonx, X_AXIS) - x0;
928       x_posns.push_back (x);
929     }
930
931   Grob *lvs = last_visible_stem (me);
932   if (!lvs)
933     return posns;
934
935   Real dx = lvs->relative_coordinate (commonx, X_AXIS) - x0;
936
937   Drul_array<Real> pos = ly_scm2interval (posns);
938   
939
940   scale_drul (&pos, Staff_symbol_referencer::staff_space (me));
941
942   Real dy = pos[RIGHT] - pos[LEFT];
943   Real y = pos[LEFT];
944   Real slope = dx ? (dy / dx) : 0.0;
945
946   /*
947     Shift the positions so that we have a chance of finding good
948     quants (i.e. no short stem failures.)
949   */
950   Interval feasible_left_point;
951   feasible_left_point.set_full ();
952   for (vsize i = 0; i < stems.size (); i++)
953     {
954       Grob *s = stems[i];
955       if (Stem::is_invisible (s))
956         continue;
957
958       Direction d = get_grob_direction (s);
959
960       Real left_y
961         = Stem::get_stem_info (s).shortest_y_
962         - slope * x_posns [i];
963
964       /*
965         left_y is now relative to the stem S. We want relative to
966         ourselves, so translate:
967       */
968       left_y
969         += + s->relative_coordinate (commony, Y_AXIS)
970         - me->relative_coordinate (commony, Y_AXIS);
971
972       Interval flp;
973       flp.set_full ();
974       flp[-d] = left_y;
975
976       feasible_left_point.intersect (flp);
977     }
978
979   if (feasible_left_point.is_empty ())
980     warning (_ ("no viable initial configuration found: may not find good beam slope"));
981   else if (!feasible_left_point.contains (y))
982     {
983       const int REGION_SIZE = 2; // UGH UGH
984       if (isinf (feasible_left_point[DOWN]))
985         y = feasible_left_point[UP] - REGION_SIZE;
986       else if (isinf (feasible_left_point[UP]))
987         y = feasible_left_point[DOWN]+ REGION_SIZE;
988       else
989         y = feasible_left_point.center ();
990     }
991
992   pos = Drul_array<Real> (y, (y + dy));
993   scale_drul (&pos, 1 / Staff_symbol_referencer::staff_space (me));
994
995   return ly_interval2scm (pos);
996 }
997
998 /* This neat trick is by Werner Lemberg,
999    damped = tanh (slope)
1000    corresponds with some tables in [Wanske] CHECKME */
1001 MAKE_SCHEME_CALLBACK (Beam, slope_damping, 2);
1002 SCM
1003 Beam::slope_damping (SCM smob, SCM posns)
1004 {
1005   Grob *me = unsmob_grob (smob);
1006   Drul_array<Real> pos = ly_scm2interval (posns);
1007
1008   if (visible_stem_count (me) <= 1)
1009     return posns;
1010
1011   
1012   SCM s = me->get_property ("damping");
1013   Real damping = scm_to_double (s);
1014   Real concaveness = robust_scm2double (me->get_property ("concaveness"), 0.0);
1015   if (concaveness >= 10000)
1016     {
1017       pos[LEFT] = pos[RIGHT];
1018       me->set_property ("least-squares-dy", scm_from_double (0));
1019       damping = 0;
1020     }
1021   
1022   if (damping)
1023     {
1024       scale_drul (&pos, Staff_symbol_referencer::staff_space (me));
1025
1026       Real dy = pos[RIGHT] - pos[LEFT];
1027
1028       Grob *fvs = first_visible_stem (me);
1029       Grob *lvs = last_visible_stem (me);
1030
1031       Grob *commonx = fvs->common_refpoint (lvs, X_AXIS);
1032
1033       Real dx = last_visible_stem (me)->relative_coordinate (commonx, X_AXIS)
1034         - first_visible_stem (me)->relative_coordinate (commonx, X_AXIS);
1035
1036       Real slope = dy && dx ? dy / dx : 0;
1037
1038       slope = 0.6 * tanh (slope) / (damping + concaveness);
1039
1040       Real damped_dy = slope * dx;
1041
1042       set_minimum_dy (me, &damped_dy);
1043
1044       pos[LEFT] += (dy - damped_dy) / 2;
1045       pos[RIGHT] -= (dy - damped_dy) / 2;
1046
1047       scale_drul (&pos, 1 / Staff_symbol_referencer::staff_space (me));
1048     }
1049
1050   return ly_interval2scm (pos);
1051 }
1052
1053 /*
1054   Report slice containing the numbers that are both in (car BEAMING)
1055   and (cdr BEAMING)
1056 */
1057 Slice
1058 where_are_the_whole_beams (SCM beaming)
1059 {
1060   Slice l;
1061
1062   for (SCM s = scm_car (beaming); scm_is_pair (s); s = scm_cdr (s))
1063     {
1064       if (scm_c_memq (scm_car (s), scm_cdr (beaming)) != SCM_BOOL_F)
1065
1066         l.add_point (scm_to_int (scm_car (s)));
1067     }
1068
1069   return l;
1070 }
1071
1072 /* Return the Y position of the stem-end, given the Y-left, Y-right
1073    in POS for stem S.  This Y position is relative to S. */
1074 Real
1075 Beam::calc_stem_y (Grob *me, Grob *s, Grob ** common,
1076                    Real xl, Real xr,
1077                    Drul_array<Real> pos, bool french)
1078 {
1079   Real beam_translation = get_beam_translation (me);
1080
1081   Real r = s->relative_coordinate (common[X_AXIS], X_AXIS) - xl;
1082   Real dy = pos[RIGHT] - pos[LEFT];
1083   Real dx = xr - xl;
1084   Real stem_y_beam0 = (dy && dx
1085                        ? r / dx
1086                        * dy
1087                        : 0) + pos[LEFT];
1088
1089   Direction my_dir = get_grob_direction (s);
1090   SCM beaming = s->get_property ("beaming");
1091
1092   Real stem_y = stem_y_beam0;
1093   if (french)
1094     {
1095       Slice bm = where_are_the_whole_beams (beaming);
1096       if (!bm.is_empty ())
1097         stem_y += beam_translation * bm[-my_dir];
1098     }
1099   else
1100     {
1101       Slice bm = Stem::beam_multiplicity (s);
1102       if (!bm.is_empty ())
1103         stem_y += bm[my_dir] * beam_translation;
1104     }
1105
1106   Real id = me->relative_coordinate (common[Y_AXIS], Y_AXIS)
1107     - s->relative_coordinate (common[Y_AXIS], Y_AXIS);
1108
1109   return stem_y + id;
1110 }
1111
1112 /*
1113   Hmm.  At this time, beam position and slope are determined.  Maybe,
1114   stem directions and length should set to relative to the chord's
1115   position of the beam.  */
1116 MAKE_SCHEME_CALLBACK(Beam, set_stem_lengths, 1); 
1117 SCM
1118 Beam::set_stem_lengths (SCM smob)
1119 {
1120   Grob *me = unsmob_grob (smob);
1121
1122   /* trigger callback. */
1123   (void) me->get_property ("direction");
1124
1125   SCM posns = me->get_property ("positions");
1126   
1127   extract_grob_set (me, "stems", stems);
1128   if (!stems.size ())
1129     return posns;
1130
1131   Grob *common[2];
1132   for (int a = 2; a--;)
1133     common[a] = common_refpoint_of_array (stems, me, Axis (a));
1134
1135   Drul_array<Real> pos = ly_scm2realdrul (posns);
1136   Real staff_space = Staff_symbol_referencer::staff_space (me);
1137   scale_drul (&pos, staff_space);
1138
1139   bool gap = false;
1140   Real thick = 0.0;
1141   if (scm_is_number (me->get_property ("gap-count"))
1142       && scm_to_int (me->get_property ("gap-count")))
1143     {
1144       gap = true;
1145       thick = get_thickness (me);
1146     }
1147
1148   Grob *fvs = first_visible_stem (me);
1149   Grob *lvs = last_visible_stem (me);
1150
1151   Real xl = fvs ? fvs->relative_coordinate (common[X_AXIS], X_AXIS) : 0.0;
1152   Real xr = lvs ? lvs->relative_coordinate (common[X_AXIS], X_AXIS) : 0.0;
1153
1154   for (vsize i = 0; i < stems.size (); i++)
1155     {
1156       Grob *s = stems[i];
1157       if (Stem::is_invisible (s))
1158         continue;
1159
1160       bool french = to_boolean (s->get_property ("french-beaming"));
1161       Real stem_y = calc_stem_y (me, s, common,
1162                                  xl, xr,
1163                                  pos, french && s != lvs && s!= fvs);
1164
1165       /*
1166         Make the stems go up to the end of the beam. This doesn't matter
1167         for normal beams, but for tremolo beams it looks silly otherwise.
1168       */
1169       if (gap)
1170         stem_y += thick * 0.5 * get_grob_direction (s);
1171
1172       Stem::set_stemend (s, 2 * stem_y / staff_space);
1173     }
1174
1175   return posns;
1176 }
1177
1178 void
1179 Beam::set_beaming (Grob *me, Beaming_info_list const *beaming)
1180 {
1181   extract_grob_set (me, "stems", stems);
1182
1183   Direction d = LEFT;
1184   for (vsize i = 0; i < stems.size (); i++)
1185     {
1186       /*
1187         Don't overwrite user settings.
1188       */
1189       do
1190         {
1191           Grob *stem = stems[i];
1192           SCM beaming_prop = stem->get_property ("beaming");
1193           if (beaming_prop == SCM_EOL
1194               || index_get_cell (beaming_prop, d) == SCM_EOL)
1195             {
1196               int b = beaming->infos_.at (i).beams_i_drul_[d];
1197               if (i > 0
1198                   && i < stems.size () -1
1199                   && Stem::is_invisible (stem))
1200                 b = min (b, beaming->infos_.at (i).beams_i_drul_[-d]);
1201
1202               Stem::set_beaming (stem, b, d);
1203             }
1204         }
1205       while (flip (&d) != LEFT);
1206     }
1207 }
1208
1209 int
1210 Beam::forced_stem_count (Grob *me)
1211 {
1212   extract_grob_set (me, "stems", stems);
1213
1214   int f = 0;
1215   for (vsize i = 0; i < stems.size (); i++)
1216     {
1217       Grob *s = stems[i];
1218
1219       if (Stem::is_invisible (s))
1220         continue;
1221
1222       /* I can imagine counting those boundaries as a half forced stem,
1223          but let's count them full for now. */
1224       Direction defdir = to_dir (s->get_property ("default-direction"));
1225       
1226       if (abs (Stem::chord_start_y (s)) > 0.1
1227           && defdir
1228           && get_grob_direction (s) != defdir)
1229         f++;
1230     }
1231   return f;
1232 }
1233
1234 int
1235 Beam::visible_stem_count (Grob *me)
1236 {
1237   extract_grob_set (me, "stems", stems);
1238   int c = 0;
1239   for (vsize i = stems.size (); i--;)
1240     {
1241       if (!Stem::is_invisible (stems[i]))
1242         c++;
1243     }
1244   return c;
1245 }
1246
1247 Grob *
1248 Beam::first_visible_stem (Grob *me)
1249 {
1250   extract_grob_set (me, "stems", stems);
1251
1252   for (vsize i = 0; i < stems.size (); i++)
1253     {
1254       if (!Stem::is_invisible (stems[i]))
1255         return stems[i];
1256     }
1257   return 0;
1258 }
1259
1260 Grob *
1261 Beam::last_visible_stem (Grob *me)
1262 {
1263   extract_grob_set (me, "stems", stems);
1264
1265   for (vsize i = stems.size (); i--;)
1266     {
1267       if (!Stem::is_invisible (stems[i]))
1268         return stems[i];
1269     }
1270   return 0;
1271 }
1272
1273 /*
1274   [TODO]
1275
1276   handle rest under beam (do_post: beams are calculated now)
1277   what about combination of collisions and rest under beam.
1278
1279   Should lookup
1280
1281   rest -> stem -> beam -> interpolate_y_position ()
1282 */
1283 MAKE_SCHEME_CALLBACK (Beam, rest_collision_callback, 2);
1284 SCM
1285 Beam::rest_collision_callback (SCM smob, SCM prev_offset)
1286 {
1287   Grob *rest = unsmob_grob (smob);
1288   if (scm_is_number (rest->get_property ("staff-position")))
1289     return scm_from_int (0);
1290
1291   Real offset = robust_scm2double (prev_offset, 0.0);
1292   
1293   Grob *st = unsmob_grob (rest->get_object ("stem"));
1294   Grob *stem = st;
1295   if (!stem)
1296     return scm_from_double (0.0);
1297   Grob *beam = unsmob_grob (stem->get_object ("beam"));
1298   if (!beam
1299       || !Beam::has_interface (beam)
1300       || !Beam::visible_stem_count (beam))
1301     return scm_from_double (0.0);
1302
1303   Drul_array<Real> pos (0, 0);
1304   SCM s = beam->get_property ("positions");
1305   if (scm_is_pair (s) && scm_is_number (scm_car (s)))
1306     pos = ly_scm2interval (s);
1307   else
1308     programming_error ("positions property should always be pair of numbers.");
1309
1310   Real staff_space = Staff_symbol_referencer::staff_space (rest);
1311
1312   scale_drul (&pos, staff_space);
1313
1314   Real dy = pos[RIGHT] - pos[LEFT];
1315
1316   Drul_array<Grob*> visible_stems (first_visible_stem (beam),
1317                                    last_visible_stem (beam));
1318   extract_grob_set (beam, "stems", stems);
1319   
1320   Grob *common = common_refpoint_of_array (stems, beam, X_AXIS);
1321   
1322   Real x0 = visible_stems[LEFT]->relative_coordinate (common, X_AXIS);
1323   Real dx = visible_stems[RIGHT]->relative_coordinate (common, X_AXIS) - x0;
1324   Real slope = dy && dx ? dy / dx : 0;
1325
1326   Direction d = get_grob_direction (stem);
1327   Real stem_y = pos[LEFT]
1328     + (stem->relative_coordinate (common, X_AXIS) - x0) * slope;
1329
1330   Real beam_translation = get_beam_translation (beam);
1331   Real beam_thickness = Beam::get_thickness (beam);
1332
1333   /*
1334     TODO: this is not strictly correct for 16th knee beams.
1335   */
1336   int beam_count
1337     = Stem::beam_multiplicity (stem).length () + 1;
1338
1339   Real height_of_my_beams = beam_thickness / 2
1340     + (beam_count - 1) * beam_translation;
1341   Real beam_y = stem_y - d * height_of_my_beams;
1342
1343   Grob *common_y = rest->common_refpoint (beam, Y_AXIS);
1344   Interval rest_extent = rest->extent (common_y, Y_AXIS);
1345   rest_extent.translate (offset);
1346   
1347   Real rest_dim = rest_extent[d];
1348   Real minimum_distance
1349     = staff_space * (robust_scm2double (stem->get_property ("stemlet-length"), 0.0)
1350                      + robust_scm2double (rest->get_property ("minimum-distance"), 0.0));
1351
1352   Real shift = d * min (((beam_y - d * minimum_distance) - rest_dim) * d, 0.0);
1353
1354   shift /= staff_space;
1355   Real rad = Staff_symbol_referencer::line_count (rest) * staff_space / 2;
1356
1357   /* Always move discretely by half spaces */
1358   shift = ceil (fabs (shift * 2.0)) / 2.0 * sign (shift);
1359
1360   /* Inside staff, move by whole spaces*/
1361   if ((rest_extent[d] + staff_space * shift) * d
1362       < rad
1363       || (rest_extent[-d] + staff_space * shift) * -d
1364       < rad)
1365     shift = ceil (fabs (shift)) * sign (shift);
1366
1367   return scm_from_double (staff_space * shift);
1368 }
1369
1370 bool
1371 Beam::is_knee (Grob *me)
1372 {
1373   SCM k = me->get_property ("knee");
1374   if (scm_is_bool (k))
1375     return ly_scm2bool (k);
1376
1377   bool knee = false;
1378   int d = 0;
1379   extract_grob_set (me, "stems", stems);
1380   for (vsize i = stems.size (); i--;)
1381     {
1382       Direction dir = get_grob_direction (stems[i]);
1383       if (d && d != dir)
1384         {
1385           knee = true;
1386           break;
1387         }
1388       d = dir;
1389     }
1390
1391   me->set_property ("knee", ly_bool2scm (knee));
1392
1393   return knee;
1394 }
1395
1396 int
1397 Beam::get_direction_beam_count (Grob *me, Direction d)
1398 {
1399   extract_grob_set (me, "stems", stems);
1400   int bc = 0;
1401
1402   for (vsize i = stems.size (); i--;)
1403     {
1404       /*
1405         Should we take invisible stems into account?
1406       */
1407       if (get_grob_direction (stems[i]) == d)
1408         bc = max (bc, (Stem::beam_multiplicity (stems[i]).length () + 1));
1409     }
1410
1411   return bc;
1412 }
1413
1414 ADD_INTERFACE (Beam,
1415                "beam-interface",
1416
1417                "A beam. \n\n"
1418                "The @code{thickness} property is the weight of beams, "
1419                "measured in staffspace.  The @code{direction} "
1420                "property is not user-serviceable. Use "
1421                "the @code{direction} property of @code{Stem} instead. "
1422
1423                ,
1424                
1425                /* properties */
1426                "auto-knee-gap "
1427                "beamed-stem-shorten "
1428                "beaming "
1429                "break-overshoot "
1430                "chord-tremolo "
1431                "concaveness "
1432                "damping "
1433                "details "
1434                "direction " 
1435                "gap "
1436                "gap-count "
1437                "inspect-quants "
1438                "knee "
1439                "length-fraction "
1440                "least-squares-dy "
1441                "neutral-direction "
1442                "positions "
1443                "quant-score "
1444                "quantized-positions "
1445                "shorten "
1446                "stems "
1447                "thickness "
1448                );