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