lily/beam.cc

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