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