lily/beam.cc

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