]> git.donarmstrong.com Git - lilypond.git/blob - lily/beam.cc
(get_default_dir): oops. Take abs () 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 #define iterof(i,s) typeof((s).begin()) i((s).begin())
520
521 Direction
522 Beam::get_default_dir (Grob *me)
523 {
524   extract_grob_set (me, "stems", stems);
525
526   Drul_array<Real> extremes (0.0, 0.0);
527   for (iterof (s, stems); s != stems.end (); s++)
528     {
529       Interval positions = Stem::head_positions (*s);
530       Direction d = DOWN;
531       do
532         {
533           if (sign (positions[d]) == d)
534             extremes[d] = d * max (d * positions[d], d * extremes[d]);
535         }
536       while (flip (&d) != DOWN);
537     }
538
539   Drul_array<int> total (0, 0);
540   Drul_array<int> count (0, 0);
541
542   bool force_dir = false;
543   for (vsize i = 0; i < stems.size (); i++)
544     {
545       Grob *s = stems[i];
546       Direction stem_dir = CENTER;
547       SCM stem_dir_scm = s->get_property_data (ly_symbol2scm ("direction"));
548       if (is_direction (stem_dir_scm))
549         {
550           stem_dir = to_dir (stem_dir_scm);
551           force_dir = true;
552         }
553       else
554         stem_dir = to_dir (s->get_property ("default-direction"));
555
556       if (!stem_dir)
557         stem_dir = to_dir (s->get_property ("neutral-direction"));
558
559       if (stem_dir)
560         {
561           count[stem_dir] ++;
562           total[stem_dir] += max (int (- stem_dir * Stem::head_positions (s) [-stem_dir]), 0);
563         }
564     }
565
566
567   if (!force_dir)
568     {
569       if (abs (extremes[UP]) > -extremes[DOWN])
570         return DOWN;
571       else if (extremes[UP] < -extremes[DOWN])
572         return UP;
573     }
574   
575   Direction dir = CENTER;
576   Direction d = CENTER;
577   if ((d = (Direction) sign (count[UP] - count[DOWN])))
578     dir = d;
579   else if (count[UP]
580            && count[DOWN]
581            && (d = (Direction)  sign (total[UP] / count[UP] - total[DOWN]/count[DOWN])))
582     dir = d;
583   else if ((d = (Direction)  sign (total[UP] - total[DOWN])))
584     dir = d;
585   else
586     dir = to_dir (me->get_property ("neutral-direction"));
587   
588   return dir;
589 }
590
591 /* Set all stems with non-forced direction to beam direction.
592    Urg: non-forced should become `without/with unforced' direction,
593    once stem gets cleaned-up. */
594 void
595 Beam::set_stem_directions (Grob *me, Direction d)
596 {
597   extract_grob_set (me, "stems", stems);
598
599   for (vsize i = 0; i < stems.size (); i++)
600     {
601       Grob *s = stems[i];
602
603       SCM forcedir = s->get_property_data (ly_symbol2scm ("direction"));
604       if (!to_dir (forcedir))
605         set_grob_direction (s, d);
606     }
607 }
608
609 /*
610   Only try horizontal beams for knees.  No reliable detection of
611   anything else is possible here, since we don't know funky-beaming
612   settings, or X-distances (slopes!)  People that want sloped
613   knee-beams, should set the directions manually.
614
615
616   TODO:
617
618   this routine should take into account the stemlength scoring
619   of a possible knee/nonknee beam.
620 */
621 void
622 Beam::consider_auto_knees (Grob *me)
623 {
624   SCM scm = me->get_property ("auto-knee-gap");
625   if (!scm_is_number (scm))
626     return;
627
628   Interval_set gaps;
629
630   gaps.set_full ();
631
632   extract_grob_set (me, "stems", stems);
633
634   Grob *common = common_refpoint_of_array (stems, me, Y_AXIS);
635   Real staff_space = Staff_symbol_referencer::staff_space (me);
636
637   vector<Interval> head_extents_array;
638   for (vsize i = 0; i < stems.size (); i++)
639     {
640       Grob *stem = stems[i];
641       if (Stem::is_invisible (stem))
642         continue;
643
644       Interval head_extents = Stem::head_positions (stem);
645       if (!head_extents.is_empty ())
646         {
647           head_extents[LEFT] += -1;
648           head_extents[RIGHT] += 1;
649           head_extents *= staff_space * 0.5;
650
651           /*
652             We could subtract beam Y position, but this routine only
653             sets stem directions, a constant shift does not have an
654             influence.
655           */
656           head_extents += stem->relative_coordinate (common, Y_AXIS);
657
658           if (to_dir (stem->get_property_data (ly_symbol2scm ("direction"))))
659             {
660               Direction stemdir = to_dir (stem->get_property ("direction"));
661               head_extents[-stemdir] = -stemdir * infinity_f;
662             }
663         }
664       head_extents_array.push_back (head_extents);
665
666       gaps.remove_interval (head_extents);
667     }
668
669   Interval max_gap;
670   Real max_gap_len = 0.0;
671
672   for (vsize i = gaps.allowed_regions_.size () -1; i != VPOS ;i--)
673     {
674       Interval gap = gaps.allowed_regions_[i];
675
676       /*
677         the outer gaps are not knees.
678       */
679       if (isinf (gap[LEFT]) || isinf (gap[RIGHT]))
680         continue;
681
682       if (gap.length () >= max_gap_len)
683         {
684           max_gap_len = gap.length ();
685           max_gap = gap;
686         }
687     }
688
689   Real beam_translation = get_beam_translation (me);
690   Real beam_thickness = Beam::get_thickness (me);
691   int beam_count = Beam::get_beam_count (me);
692   Real height_of_beams = beam_thickness / 2
693     + (beam_count - 1) * beam_translation;
694   Real threshold = scm_to_double (scm) + height_of_beams;
695
696   if (max_gap_len > threshold)
697     {
698       int j = 0;
699       for (vsize i = 0; i < stems.size (); i++)
700         {
701           Grob *stem = stems[i];
702           if (Stem::is_invisible (stem))
703             continue;
704
705           Interval head_extents = head_extents_array[j++];
706
707           Direction d = (head_extents.center () < max_gap.center ())
708             ? UP : DOWN;
709
710           stem->set_property ("direction", scm_from_int (d));
711
712           head_extents.intersect (max_gap);
713           assert (head_extents.is_empty () || head_extents.length () < 1e-6);
714         }
715     }
716 }
717
718 /* Set stem's shorten property if unset.
719
720 TODO:
721 take some y-position (chord/beam/nearest?) into account
722 scmify forced-fraction
723
724 This is done in beam because the shorten has to be uniform over the
725 entire beam.
726 */
727
728
729
730 void
731 set_minimum_dy (Grob *me, Real *dy)
732 {
733   if (*dy)
734     {
735       /*
736         If dy is smaller than the smallest quant, we
737         get absurd direction-sign penalties.
738       */
739
740       Real ss = Staff_symbol_referencer::staff_space (me);
741       Real thickness = Beam::get_thickness (me) / ss;
742       Real slt = Staff_symbol_referencer::line_thickness (me) / ss;
743       Real sit = (thickness - slt) / 2;
744       Real inter = 0.5;
745       Real hang = 1.0 - (thickness - slt) / 2;
746
747       *dy = sign (*dy) * max (fabs (*dy),
748                               min (min (sit, inter), hang));
749     }
750 }
751
752   
753
754 MAKE_SCHEME_CALLBACK(Beam, calc_stem_shorten, 1)
755 SCM
756 Beam::calc_stem_shorten (SCM smob)
757 {
758   Grob *me = unsmob_grob (smob);
759   
760   /*
761     shortening looks silly for x staff beams
762   */
763   if (is_knee (me))
764     return scm_from_int (0);
765
766   Real forced_fraction = 1.0 * forced_stem_count (me)
767     / visible_stem_count (me);
768
769   int beam_count = get_beam_count (me);
770
771   SCM shorten_list = me->get_property ("beamed-stem-shorten");
772   if (shorten_list == SCM_EOL)
773     return scm_from_int (0);
774
775   Real staff_space = Staff_symbol_referencer::staff_space (me);
776
777   SCM shorten_elt
778     = robust_list_ref (beam_count -1, shorten_list);
779   Real shorten = scm_to_double (shorten_elt) * staff_space;
780
781   shorten *= forced_fraction;
782
783   
784   if (shorten)
785     return scm_from_double (shorten);
786
787   return scm_from_double (0.0);
788 }
789
790
791
792 /*
793   Compute a first approximation to the beam slope.
794 */
795 MAKE_SCHEME_CALLBACK (Beam, calc_least_squares_positions, 2);
796 SCM
797 Beam::calc_least_squares_positions (SCM smob, SCM posns)
798 {
799   (void) posns;
800   
801   Grob *me = unsmob_grob (smob);
802
803   int count = visible_stem_count (me);
804   Interval pos (0,0);
805   if (count < 1)
806     return ly_interval2scm (pos);
807   
808   vector<Real> x_posns;
809   extract_grob_set (me, "stems", stems);
810   Grob *commonx = common_refpoint_of_array (stems, me, X_AXIS);
811   Grob *commony = common_refpoint_of_array (stems, me, Y_AXIS);
812
813   Real my_y = me->relative_coordinate (commony, Y_AXIS);
814
815   Grob *fvs = first_visible_stem (me);
816   Grob *lvs = last_visible_stem (me);
817
818   Interval ideal (Stem::get_stem_info (fvs).ideal_y_
819                   + fvs->relative_coordinate (commony, Y_AXIS) -my_y,
820                   Stem::get_stem_info (lvs).ideal_y_
821                   + lvs->relative_coordinate (commony, Y_AXIS) - my_y);
822
823   Real x0 = first_visible_stem (me)->relative_coordinate (commonx, X_AXIS);
824   for (vsize i = 0; i < stems.size (); i++)
825     {
826       Grob *s = stems[i];
827
828       Real x = s->relative_coordinate (commonx, X_AXIS) - x0;
829       x_posns.push_back (x);
830     }
831   Real dx = last_visible_stem (me)->relative_coordinate (commonx, X_AXIS) - x0;
832
833   Real y = 0;
834   Real slope = 0;
835   Real dy = 0;
836   Real ldy = 0.0;
837   if (!ideal.delta ())
838     {
839       Interval chord (Stem::chord_start_y (first_visible_stem (me)),
840                       Stem::chord_start_y (last_visible_stem (me)));
841
842       /* Simple beams (2 stems) on middle line should be allowed to be
843          slightly sloped.
844
845          However, if both stems reach middle line,
846          ideal[LEFT] == ideal[RIGHT] and ideal.delta () == 0.
847
848          For that case, we apply artificial slope */
849       if (!ideal[LEFT] && chord.delta () && count == 2)
850         {
851           /* FIXME. -> UP */
852           Direction d = (Direction) (sign (chord.delta ()) * UP);
853           pos[d] = get_thickness (me) / 2;
854           pos[-d] = -pos[d];
855         }
856       else
857         pos = ideal;
858
859       /*
860         For broken beams this doesn't work well. In this case, the
861         slope esp. of the first part of a broken beam should predict
862         where the second part goes.
863       */
864       ldy = pos[RIGHT] - pos[LEFT];
865     }
866   else
867     {
868       vector<Offset> ideals;
869       for (vsize i = 0; i < stems.size (); i++)
870         {
871           Grob *s = stems[i];
872           if (Stem::is_invisible (s))
873             continue;
874           ideals.push_back (Offset (x_posns[i],
875                                Stem::get_stem_info (s).ideal_y_
876                                + s->relative_coordinate (commony, Y_AXIS)
877                                - my_y));
878         }
879
880       minimise_least_squares (&slope, &y, ideals);
881
882       dy = slope * dx;
883
884       set_minimum_dy (me, &dy);
885
886       ldy = dy;
887       pos = Interval (y, (y + dy));
888     }
889
890   /*
891     "position" is relative to the staff.
892   */
893   scale_drul (&pos, 1 / Staff_symbol_referencer::staff_space (me));
894
895   me->set_property ("least-squares-dy",  scm_from_double (ldy));
896   return ly_interval2scm (pos);
897 }
898
899 /*
900   We can't combine with previous function, since check concave and
901   slope damping comes first.
902
903   TODO: we should use the concaveness to control the amount of damping
904   applied.
905 */
906 MAKE_SCHEME_CALLBACK (Beam, shift_region_to_valid, 2);
907 SCM
908 Beam::shift_region_to_valid (SCM grob, SCM posns)
909 {
910   Grob *me = unsmob_grob (grob);
911   /*
912     Code dup.
913   */
914   vector<Real> x_posns;
915   extract_grob_set (me, "stems", stems);
916   Grob *commonx = common_refpoint_of_array (stems, me, X_AXIS);
917   Grob *commony = common_refpoint_of_array (stems, me, Y_AXIS);
918
919   Grob *fvs = first_visible_stem (me);
920
921   if (!fvs)
922     return posns;
923
924   Real x0 = fvs->relative_coordinate (commonx, X_AXIS);
925   for (vsize i = 0; i < stems.size (); i++)
926     {
927       Grob *s = stems[i];
928
929       Real x = s->relative_coordinate (commonx, X_AXIS) - x0;
930       x_posns.push_back (x);
931     }
932
933   Grob *lvs = last_visible_stem (me);
934   if (!lvs)
935     return posns;
936
937   Real dx = lvs->relative_coordinate (commonx, X_AXIS) - x0;
938
939   Drul_array<Real> pos = ly_scm2interval (posns);
940   
941
942   scale_drul (&pos, Staff_symbol_referencer::staff_space (me));
943
944   Real dy = pos[RIGHT] - pos[LEFT];
945   Real y = pos[LEFT];
946   Real slope = dx ? (dy / dx) : 0.0;
947
948   /*
949     Shift the positions so that we have a chance of finding good
950     quants (i.e. no short stem failures.)
951   */
952   Interval feasible_left_point;
953   feasible_left_point.set_full ();
954   for (vsize i = 0; i < stems.size (); i++)
955     {
956       Grob *s = stems[i];
957       if (Stem::is_invisible (s))
958         continue;
959
960       Direction d = get_grob_direction (s);
961
962       Real left_y
963         = Stem::get_stem_info (s).shortest_y_
964         - slope * x_posns [i];
965
966       /*
967         left_y is now relative to the stem S. We want relative to
968         ourselves, so translate:
969       */
970       left_y
971         += + s->relative_coordinate (commony, Y_AXIS)
972         - me->relative_coordinate (commony, Y_AXIS);
973
974       Interval flp;
975       flp.set_full ();
976       flp[-d] = left_y;
977
978       feasible_left_point.intersect (flp);
979     }
980
981   if (feasible_left_point.is_empty ())
982     warning (_ ("no viable initial configuration found: may not find good beam slope"));
983   else if (!feasible_left_point.contains (y))
984     {
985       const int REGION_SIZE = 2; // UGH UGH
986       if (isinf (feasible_left_point[DOWN]))
987         y = feasible_left_point[UP] - REGION_SIZE;
988       else if (isinf (feasible_left_point[UP]))
989         y = feasible_left_point[DOWN]+ REGION_SIZE;
990       else
991         y = feasible_left_point.center ();
992     }
993
994   pos = Drul_array<Real> (y, (y + dy));
995   scale_drul (&pos, 1 / Staff_symbol_referencer::staff_space (me));
996
997   return ly_interval2scm (pos);
998 }
999
1000 /* This neat trick is by Werner Lemberg,
1001    damped = tanh (slope)
1002    corresponds with some tables in [Wanske] CHECKME */
1003 MAKE_SCHEME_CALLBACK (Beam, slope_damping, 2);
1004 SCM
1005 Beam::slope_damping (SCM smob, SCM posns)
1006 {
1007   Grob *me = unsmob_grob (smob);
1008   Drul_array<Real> pos = ly_scm2interval (posns);
1009
1010   if (visible_stem_count (me) <= 1)
1011     return posns;
1012
1013   
1014   SCM s = me->get_property ("damping");
1015   Real damping = scm_to_double (s);
1016   Real concaveness = robust_scm2double (me->get_property ("concaveness"), 0.0);
1017   if (concaveness >= 10000)
1018     {
1019       pos[LEFT] = pos[RIGHT];
1020       me->set_property ("least-squares-dy", scm_from_double (0));
1021       damping = 0;
1022     }
1023   
1024   if (damping)
1025     {
1026       scale_drul (&pos, Staff_symbol_referencer::staff_space (me));
1027
1028       Real dy = pos[RIGHT] - pos[LEFT];
1029
1030       Grob *fvs = first_visible_stem (me);
1031       Grob *lvs = last_visible_stem (me);
1032
1033       Grob *commonx = fvs->common_refpoint (lvs, X_AXIS);
1034
1035       Real dx = last_visible_stem (me)->relative_coordinate (commonx, X_AXIS)
1036         - first_visible_stem (me)->relative_coordinate (commonx, X_AXIS);
1037
1038       Real slope = dy && dx ? dy / dx : 0;
1039
1040       slope = 0.6 * tanh (slope) / (damping + concaveness);
1041
1042       Real damped_dy = slope * dx;
1043
1044       set_minimum_dy (me, &damped_dy);
1045
1046       pos[LEFT] += (dy - damped_dy) / 2;
1047       pos[RIGHT] -= (dy - damped_dy) / 2;
1048
1049       scale_drul (&pos, 1 / Staff_symbol_referencer::staff_space (me));
1050     }
1051
1052   return ly_interval2scm (pos);
1053 }
1054
1055 /*
1056   Report slice containing the numbers that are both in (car BEAMING)
1057   and (cdr BEAMING)
1058 */
1059 Slice
1060 where_are_the_whole_beams (SCM beaming)
1061 {
1062   Slice l;
1063
1064   for (SCM s = scm_car (beaming); scm_is_pair (s); s = scm_cdr (s))
1065     {
1066       if (scm_c_memq (scm_car (s), scm_cdr (beaming)) != SCM_BOOL_F)
1067
1068         l.add_point (scm_to_int (scm_car (s)));
1069     }
1070
1071   return l;
1072 }
1073
1074 /* Return the Y position of the stem-end, given the Y-left, Y-right
1075    in POS for stem S.  This Y position is relative to S. */
1076 Real
1077 Beam::calc_stem_y (Grob *me, Grob *s, Grob ** common,
1078                    Real xl, Real xr,
1079                    Drul_array<Real> pos, bool french)
1080 {
1081   Real beam_translation = get_beam_translation (me);
1082
1083   Real r = s->relative_coordinate (common[X_AXIS], X_AXIS) - xl;
1084   Real dy = pos[RIGHT] - pos[LEFT];
1085   Real dx = xr - xl;
1086   Real stem_y_beam0 = (dy && dx
1087                        ? r / dx
1088                        * dy
1089                        : 0) + pos[LEFT];
1090
1091   Direction my_dir = get_grob_direction (s);
1092   SCM beaming = s->get_property ("beaming");
1093
1094   Real stem_y = stem_y_beam0;
1095   if (french)
1096     {
1097       Slice bm = where_are_the_whole_beams (beaming);
1098       if (!bm.is_empty ())
1099         stem_y += beam_translation * bm[-my_dir];
1100     }
1101   else
1102     {
1103       Slice bm = Stem::beam_multiplicity (s);
1104       if (!bm.is_empty ())
1105         stem_y += bm[my_dir] * beam_translation;
1106     }
1107
1108   Real id = me->relative_coordinate (common[Y_AXIS], Y_AXIS)
1109     - s->relative_coordinate (common[Y_AXIS], Y_AXIS);
1110
1111   return stem_y + id;
1112 }
1113
1114 /*
1115   Hmm.  At this time, beam position and slope are determined.  Maybe,
1116   stem directions and length should set to relative to the chord's
1117   position of the beam.  */
1118 MAKE_SCHEME_CALLBACK(Beam, set_stem_lengths, 1); 
1119 SCM
1120 Beam::set_stem_lengths (SCM smob)
1121 {
1122   Grob *me = unsmob_grob (smob);
1123
1124   /* trigger callback. */
1125   (void) me->get_property ("direction");
1126
1127   SCM posns = me->get_property ("positions");
1128   
1129   extract_grob_set (me, "stems", stems);
1130   if (!stems.size ())
1131     return posns;
1132
1133   Grob *common[2];
1134   for (int a = 2; a--;)
1135     common[a] = common_refpoint_of_array (stems, me, Axis (a));
1136
1137   Drul_array<Real> pos = ly_scm2realdrul (posns);
1138   Real staff_space = Staff_symbol_referencer::staff_space (me);
1139   scale_drul (&pos, staff_space);
1140
1141   bool gap = false;
1142   Real thick = 0.0;
1143   if (scm_is_number (me->get_property ("gap-count"))
1144       && scm_to_int (me->get_property ("gap-count")))
1145     {
1146       gap = true;
1147       thick = get_thickness (me);
1148     }
1149
1150   Grob *fvs = first_visible_stem (me);
1151   Grob *lvs = last_visible_stem (me);
1152
1153   Real xl = fvs ? fvs->relative_coordinate (common[X_AXIS], X_AXIS) : 0.0;
1154   Real xr = lvs ? lvs->relative_coordinate (common[X_AXIS], X_AXIS) : 0.0;
1155
1156   for (vsize i = 0; i < stems.size (); i++)
1157     {
1158       Grob *s = stems[i];
1159       if (Stem::is_invisible (s))
1160         continue;
1161
1162       bool french = to_boolean (s->get_property ("french-beaming"));
1163       Real stem_y = calc_stem_y (me, s, common,
1164                                  xl, xr,
1165                                  pos, french && s != lvs && s!= fvs);
1166
1167       /*
1168         Make the stems go up to the end of the beam. This doesn't matter
1169         for normal beams, but for tremolo beams it looks silly otherwise.
1170       */
1171       if (gap)
1172         stem_y += thick * 0.5 * get_grob_direction (s);
1173
1174       Stem::set_stemend (s, 2 * stem_y / staff_space);
1175     }
1176
1177   return posns;
1178 }
1179
1180 void
1181 Beam::set_beaming (Grob *me, Beaming_info_list const *beaming)
1182 {
1183   extract_grob_set (me, "stems", stems);
1184
1185   Direction d = LEFT;
1186   for (vsize i = 0; i < stems.size (); i++)
1187     {
1188       /*
1189         Don't overwrite user settings.
1190       */
1191       do
1192         {
1193           Grob *stem = stems[i];
1194           SCM beaming_prop = stem->get_property ("beaming");
1195           if (beaming_prop == SCM_EOL
1196               || index_get_cell (beaming_prop, d) == SCM_EOL)
1197             {
1198               int b = beaming->infos_.at (i).beams_i_drul_[d];
1199               if (i > 0
1200                   && i < stems.size () -1
1201                   && Stem::is_invisible (stem))
1202                 b = min (b, beaming->infos_.at (i).beams_i_drul_[-d]);
1203
1204               Stem::set_beaming (stem, b, d);
1205             }
1206         }
1207       while (flip (&d) != LEFT);
1208     }
1209 }
1210
1211 int
1212 Beam::forced_stem_count (Grob *me)
1213 {
1214   extract_grob_set (me, "stems", stems);
1215
1216   int f = 0;
1217   for (vsize i = 0; i < stems.size (); i++)
1218     {
1219       Grob *s = stems[i];
1220
1221       if (Stem::is_invisible (s))
1222         continue;
1223
1224       /* I can imagine counting those boundaries as a half forced stem,
1225          but let's count them full for now. */
1226       Direction defdir = to_dir (s->get_property ("default-direction"));
1227       
1228       if (abs (Stem::chord_start_y (s)) > 0.1
1229           && defdir
1230           && get_grob_direction (s) != defdir)
1231         f++;
1232     }
1233   return f;
1234 }
1235
1236 int
1237 Beam::visible_stem_count (Grob *me)
1238 {
1239   extract_grob_set (me, "stems", stems);
1240   int c = 0;
1241   for (vsize i = stems.size (); i--;)
1242     {
1243       if (!Stem::is_invisible (stems[i]))
1244         c++;
1245     }
1246   return c;
1247 }
1248
1249 Grob *
1250 Beam::first_visible_stem (Grob *me)
1251 {
1252   extract_grob_set (me, "stems", stems);
1253
1254   for (vsize i = 0; i < stems.size (); i++)
1255     {
1256       if (!Stem::is_invisible (stems[i]))
1257         return stems[i];
1258     }
1259   return 0;
1260 }
1261
1262 Grob *
1263 Beam::last_visible_stem (Grob *me)
1264 {
1265   extract_grob_set (me, "stems", stems);
1266
1267   for (vsize i = stems.size (); i--;)
1268     {
1269       if (!Stem::is_invisible (stems[i]))
1270         return stems[i];
1271     }
1272   return 0;
1273 }
1274
1275 /*
1276   [TODO]
1277
1278   handle rest under beam (do_post: beams are calculated now)
1279   what about combination of collisions and rest under beam.
1280
1281   Should lookup
1282
1283   rest -> stem -> beam -> interpolate_y_position ()
1284 */
1285 MAKE_SCHEME_CALLBACK (Beam, rest_collision_callback, 2);
1286 SCM
1287 Beam::rest_collision_callback (SCM smob, SCM prev_offset)
1288 {
1289   Grob *rest = unsmob_grob (smob);
1290   if (scm_is_number (rest->get_property ("staff-position")))
1291     return scm_from_int (0);
1292
1293   Real offset = robust_scm2double (prev_offset, 0.0);
1294   
1295   Grob *st = unsmob_grob (rest->get_object ("stem"));
1296   Grob *stem = st;
1297   if (!stem)
1298     return scm_from_double (0.0);
1299   Grob *beam = unsmob_grob (stem->get_object ("beam"));
1300   if (!beam
1301       || !Beam::has_interface (beam)
1302       || !Beam::visible_stem_count (beam))
1303     return scm_from_double (0.0);
1304
1305   Drul_array<Real> pos (0, 0);
1306   SCM s = beam->get_property ("positions");
1307   if (scm_is_pair (s) && scm_is_number (scm_car (s)))
1308     pos = ly_scm2interval (s);
1309   else
1310     programming_error ("positions property should always be pair of numbers.");
1311
1312   Real staff_space = Staff_symbol_referencer::staff_space (rest);
1313
1314   scale_drul (&pos, staff_space);
1315
1316   Real dy = pos[RIGHT] - pos[LEFT];
1317
1318   Drul_array<Grob*> visible_stems (first_visible_stem (beam),
1319                                    last_visible_stem (beam));
1320   extract_grob_set (beam, "stems", stems);
1321   
1322   Grob *common = common_refpoint_of_array (stems, beam, X_AXIS);
1323   
1324   Real x0 = visible_stems[LEFT]->relative_coordinate (common, X_AXIS);
1325   Real dx = visible_stems[RIGHT]->relative_coordinate (common, X_AXIS) - x0;
1326   Real slope = dy && dx ? dy / dx : 0;
1327
1328   Direction d = get_grob_direction (stem);
1329   Real stem_y = pos[LEFT]
1330     + (stem->relative_coordinate (common, X_AXIS) - x0) * slope;
1331
1332   Real beam_translation = get_beam_translation (beam);
1333   Real beam_thickness = Beam::get_thickness (beam);
1334
1335   /*
1336     TODO: this is not strictly correct for 16th knee beams.
1337   */
1338   int beam_count
1339     = Stem::beam_multiplicity (stem).length () + 1;
1340
1341   Real height_of_my_beams = beam_thickness / 2
1342     + (beam_count - 1) * beam_translation;
1343   Real beam_y = stem_y - d * height_of_my_beams;
1344
1345   Grob *common_y = rest->common_refpoint (beam, Y_AXIS);
1346   Interval rest_extent = rest->extent (common_y, Y_AXIS);
1347   rest_extent.translate (offset);
1348   
1349   Real rest_dim = rest_extent[d];
1350   Real minimum_distance
1351     = staff_space * (robust_scm2double (stem->get_property ("stemlet-length"), 0.0)
1352                      + robust_scm2double (rest->get_property ("minimum-distance"), 0.0));
1353
1354   Real shift = d * min (((beam_y - d * minimum_distance) - rest_dim) * d, 0.0);
1355
1356   shift /= staff_space;
1357   Real rad = Staff_symbol_referencer::line_count (rest) * staff_space / 2;
1358
1359   /* Always move discretely by half spaces */
1360   shift = ceil (fabs (shift * 2.0)) / 2.0 * sign (shift);
1361
1362   /* Inside staff, move by whole spaces*/
1363   if ((rest_extent[d] + staff_space * shift) * d
1364       < rad
1365       || (rest_extent[-d] + staff_space * shift) * -d
1366       < rad)
1367     shift = ceil (fabs (shift)) * sign (shift);
1368
1369   return scm_from_double (staff_space * shift);
1370 }
1371
1372 bool
1373 Beam::is_knee (Grob *me)
1374 {
1375   SCM k = me->get_property ("knee");
1376   if (scm_is_bool (k))
1377     return ly_scm2bool (k);
1378
1379   bool knee = false;
1380   int d = 0;
1381   extract_grob_set (me, "stems", stems);
1382   for (vsize i = stems.size (); i--;)
1383     {
1384       Direction dir = get_grob_direction (stems[i]);
1385       if (d && d != dir)
1386         {
1387           knee = true;
1388           break;
1389         }
1390       d = dir;
1391     }
1392
1393   me->set_property ("knee", ly_bool2scm (knee));
1394
1395   return knee;
1396 }
1397
1398 int
1399 Beam::get_direction_beam_count (Grob *me, Direction d)
1400 {
1401   extract_grob_set (me, "stems", stems);
1402   int bc = 0;
1403
1404   for (vsize i = stems.size (); i--;)
1405     {
1406       /*
1407         Should we take invisible stems into account?
1408       */
1409       if (get_grob_direction (stems[i]) == d)
1410         bc = max (bc, (Stem::beam_multiplicity (stems[i]).length () + 1));
1411     }
1412
1413   return bc;
1414 }
1415
1416 ADD_INTERFACE (Beam,
1417                "beam-interface",
1418
1419                "A beam. \n\n"
1420                "The @code{thickness} property is the weight of beams, "
1421                "measured in staffspace.  The @code{direction} "
1422                "property is not user-serviceable. Use "
1423                "the @code{direction} property of @code{Stem} instead. "
1424
1425                ,
1426                
1427                /* properties */
1428                "auto-knee-gap "
1429                "beamed-stem-shorten "
1430                "beaming "
1431                "break-overshoot "
1432                "chord-tremolo "
1433                "concaveness "
1434                "damping "
1435                "details "
1436                "direction " 
1437                "gap "
1438                "gap-count "
1439                "inspect-quants "
1440                "knee "
1441                "length-fraction "
1442                "least-squares-dy "
1443                "neutral-direction "
1444                "positions "
1445                "quant-score "
1446                "quantized-positions "
1447                "shorten "
1448                "stems "
1449                "thickness "
1450                );