lily/slur.cc

   1 /*
   2   slur.cc -- implement  Slur
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1996--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7     Jan Nieuwenhuizen <janneke@gnu.org>
   8 */
   9
  10 /*
  11   [TODO]
  12     * should avoid stafflines with horizontal part.
  13     * begin and end should be treated as a/acknowledge Scripts.
  14     * smart changing of endings
  15     * smart changing of (Y-?)offsets to avoid ugly beziers
  16  (along-side-stem)
  17  */
  18
  19 #include "directional-element-interface.hh"
  20 #include "group-interface.hh"
  21 #include "slur.hh"
  22 #include "lookup.hh"
  23 #include "paper-def.hh"
  24 #include "note-column.hh"
  25 #include "stem.hh"
  26 #include "paper-column.hh"
  27 #include "molecule.hh"
  28 #include "debug.hh"
  29 #include "slur-bezier-bow.hh"
  30 #include "main.hh"
  31 #include "group-interface.hh"
  32 #include "staff-symbol-referencer.hh"
  33 #include "spanner.hh"
  34
  35
  36 void
  37 Slur::set_interface (Grob*me)
  38 {
  39   /* Copy to mutable list. */
  40   me->set_grob_property ("attachment",
  41                          ly_deep_copy (me->get_grob_property ("attachment")));
  42 }
  43
  44 void
  45 Slur::add_column (Grob*me, Grob*n)
  46 {
  47   if (!gh_pair_p (n->get_grob_property ("note-heads")))
  48     me->warning (_ ("Putting slur over rest.  Ignoring."));
  49   else
  50     {
  51       Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n);
  52       me->add_dependency (n);
  53     }
  54
  55   add_bound_item (dynamic_cast<Spanner*> (me), dynamic_cast<Item*> (n));
  56 }
  57
  58 void
  59 Slur::de_uglyfy (Grob*me, Slur_bezier_bow* bb, Real default_height)
  60 {
  61   Real length = bb->curve_.control_[3][X_AXIS] ;
  62   Real ff = bb->fit_factor ();
  63   for (int i = 1; i < 3; i++)
  64     {
  65       Real ind = abs (bb->curve_.control_[ (i-1)*3][X_AXIS]
  66                       - bb->curve_.control_[i][X_AXIS]) / length;
  67       Real h = bb->curve_.control_[i][Y_AXIS] * ff / length;
  68
  69       Real f = default_height / length;
  70       SCM up = me->get_grob_property ("de-uglify-parameters");
  71
  72       Real c1 = gh_scm2double (ly_car (up));
  73       Real c2 = gh_scm2double (ly_cadr (up));
  74       Real c3 = gh_scm2double (ly_caddr (up));
  75
  76       if (h > c1 * f)
  77         {
  78           h = c1 * f;
  79         }
  80       else if (h > c2 + c3 * ind)
  81         {
  82           h = c2 + c3 * ind;
  83         }
  84
  85       bb->curve_.control_[i][Y_AXIS] = h * length;
  86     }
  87
  88   bb->curve_.assert_sanity ();
  89 }
  90
  91 Direction
  92 Slur::get_default_dir (Grob*me)
  93 {
  94   Link_array<Grob> encompass_arr =
  95     Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns");
  96
  97   Direction d = DOWN;
  98   for (int i=0; i < encompass_arr.size (); i ++)
  99     {
 100       if (Note_column::dir (encompass_arr[i]) < 0)
 101         {
 102           d = UP;
 103           break;
 104         }
 105     }
 106   return d;
 107 }
 108
 109
 110 MAKE_SCHEME_CALLBACK (Slur, after_line_breaking,1);
 111 SCM
 112 Slur::after_line_breaking (SCM smob)
 113 {
 114   Grob *me = unsmob_grob (smob);
 115   if (!scm_ilength (me->get_grob_property ("note-columns")))
 116     {
 117       me->suicide ();
 118       return SCM_UNSPECIFIED;
 119     }
 120   set_extremities (me);
 121   set_control_points (me);
 122   return SCM_UNSPECIFIED;
 123 }
 124
 125
 126 void
 127 Slur::check_slope (Grob *me)
 128 {
 129   /*
 130     Avoid too steep slurs.
 131    */
 132   SCM s = me->get_grob_property ("slope-limit");
 133   if (gh_number_p (s))
 134     {
 135       Array<Offset> encompass = get_encompass_offset_arr (me);
 136       Drul_array<Offset> attachment;
 137       attachment[LEFT] = encompass[0];
 138       attachment[RIGHT] = encompass.top ();
 139
 140       Real dx = attachment[RIGHT][X_AXIS] - attachment[LEFT][X_AXIS];
 141       Real dy = attachment[RIGHT][Y_AXIS] - attachment[LEFT][Y_AXIS];
 142       if (!dx)
 143         return;
 144
 145       Real slope = slope = abs (dy / dx);
 146
 147       Real limit = gh_scm2double (s);
 148
 149       if (slope > limit)
 150         {
 151           Real staff_space = Staff_symbol_referencer::staff_space ((Grob*)me);
 152           Direction dir = (Direction)gh_scm2int (me->get_grob_property ("direction"));
 153           Direction d = (Direction) (- dir * (sign (dy)));
 154           SCM a = me->get_grob_property ("attachment-offset");
 155           Drul_array<Offset> o;
 156           o[LEFT] = ly_scm2offset (index_cell (a, LEFT));
 157           o[RIGHT] = ly_scm2offset (index_cell (a, RIGHT));
 158           o[d][Y_AXIS] -= (limit - slope) * dx * dir / staff_space;
 159
 160           o[d][Y_AXIS] *= Directional_element_interface::get (me);
 161
 162           me->set_grob_property ("attachment-offset",
 163                                 gh_cons (ly_offset2scm (o[LEFT]),
 164                                          ly_offset2scm (o[RIGHT])));
 165         }
 166     }
 167 }
 168
 169 void
 170 Slur::set_extremities (Grob *me)
 171 {
 172   if (!Directional_element_interface::get (me))
 173     Directional_element_interface::set (me, get_default_dir (me));
 174
 175   Direction dir = LEFT;
 176   do
 177     {
 178       SCM att = me->get_grob_property ("attachment");
 179       /*
 180        */
 181       if (!gh_pair_p (att))
 182         {
 183           programming_error ("attachment is not a cons?!");
 184           att = gh_cons (SCM_EOL, SCM_EOL);
 185           me->set_grob_property ("attachment", att);
 186         }
 187
 188       if (!gh_symbol_p (index_cell (att, dir)))
 189         {
 190           for (SCM s = me->get_grob_property ("extremity-rules");
 191                s != SCM_EOL; s = ly_cdr (s))
 192             {
 193               SCM r = gh_call2 (ly_caar (s), me->self_scm (),
 194                                  gh_int2scm ((int)dir));
 195               if (r != SCM_BOOL_F)
 196                 {
 197                   index_set_cell (att, dir,
 198                                   ly_cdar (s));
 199                   break;
 200                 }
 201             }
 202         }
 203     }
 204   while (flip (&dir) != LEFT);
 205
 206   check_slope (me);
 207 }
 208
 209
 210 Real
 211 Slur::get_first_notecolumn_y (Grob *me, Direction dir)
 212 {
 213   Grob *col = dir == LEFT
 214     ? unsmob_grob (ly_car (scm_reverse (me->get_grob_property
 215  ("note-columns"))))
 216     : unsmob_grob
 217  (ly_car (me->get_grob_property ("note-columns")));
 218
 219   Grob *common[] =
 220   {
 221     0,
 222     me->common_refpoint (col, Y_AXIS)
 223   };
 224   Real y;
 225   if (col == ((Spanner*)me)->get_bound (dir))
 226     {
 227       y = get_attachment (me, dir, common)[Y_AXIS];
 228     }
 229   else
 230     {
 231       y = encompass_offset (me, col, common)[Y_AXIS]
 232         - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
 233     }
 234   return y;
 235 }
 236
 237 Offset
 238 Slur::broken_trend_offset (Grob *me, Direction dir)
 239 {
 240   /*
 241     A broken slur should maintain the same vertical trend
 242     the unbroken slur would have had.
 243   */
 244   Offset o;
 245   if (Spanner *mother =  dynamic_cast<Spanner*> (me->original_l_))
 246     {
 247       for (int i = dir == LEFT ? 0 : mother->broken_into_l_arr_.size () - 1;
 248            dir == LEFT ? i < mother->broken_into_l_arr_.size () : i > 0;
 249            dir == LEFT ? i++ : i--)
 250         {
 251           if (mother->broken_into_l_arr_[i - dir] == me)
 252             {
 253               Grob *neighbour = mother->broken_into_l_arr_[i];
 254               if (dir == RIGHT)
 255                 neighbour->set_grob_property ("direction",
 256                                              me->get_grob_property ("direction"));
 257               Real neighbour_y = get_first_notecolumn_y (neighbour, dir);
 258               Real y = get_first_notecolumn_y (me, -dir);
 259               int neighbour_cols = scm_ilength (neighbour->get_grob_property ("note-columns"));
 260               int cols = scm_ilength (me->get_grob_property ("note-columns"));
 261               o = Offset (0, (y*neighbour_cols + neighbour_y*cols) /
 262  (cols + neighbour_cols));
 263               break;
 264             }
 265         }
 266     }
 267   return o;
 268 }
 269
 270 Offset
 271 Slur::get_attachment (Grob *me, Direction dir,
 272                       Grob **common)
 273 {
 274   SCM s = me->get_grob_property ("attachment");
 275   if (!gh_symbol_p (index_cell (s, dir)))
 276     {
 277       set_extremities (me);
 278       s = me->get_grob_property ("attachment");
 279     }
 280   SCM a = dir == LEFT ? ly_car (s) : ly_cdr (s);
 281   Spanner*sp = dynamic_cast<Spanner*> (me);
 282   String str = ly_symbol2string (a);
 283   Real staff_space = Staff_symbol_referencer::staff_space ((Grob*)me);
 284   Real hs = staff_space / 2.0;
 285   Offset o;
 286
 287   int slurdir = gh_scm2int (me->get_grob_property ("direction"));
 288
 289   Grob *stem = 0;
 290   if (Note_column::has_interface (sp->get_bound (dir)))
 291     {
 292       Grob * n =sp->get_bound (dir);
 293       if ((stem = Note_column::stem_l (n)))
 294         {
 295           Real x_extent;
 296           if (Grob *head = Note_column::first_head (n))
 297             x_extent = head->extent (head, X_AXIS).length ();
 298           else
 299             x_extent = n->extent (n, X_AXIS).length ();
 300
 301           if (str == "head")
 302             {
 303               o = Offset (0, Stem::head_positions (stem)
 304                           [Directional_element_interface::get (me)] * hs);
 305               /*
 306                 Default position is centered in X, on outer side of head Y
 307                */
 308               o += Offset (0.5 * x_extent,
 309                            0.5 * staff_space
 310                            * Directional_element_interface::get (me));
 311             }
 312           else if (str == "alongside-stem")
 313             {
 314               o = Offset (0, Stem::chord_start_f (stem));
 315               /*
 316                 Default position is on stem X, on outer side of head Y
 317                */
 318               o += Offset (x_extent * (1 + Stem::get_direction (stem)),
 319                            0.5 * staff_space
 320                            * Directional_element_interface::get (me));
 321             }
 322           else if (str == "stem")
 323             {
 324               o = Offset (0, Stem::stem_end_position (stem) * hs);
 325               /*
 326                 Default position is on stem X, at stem end Y
 327                */
 328               Real stem_thickness =
 329                 gh_scm2double (stem->get_grob_property ("thickness"))
 330                 * stem->paper_l ()->get_var ("stafflinethickness");
 331               o += Offset (0.5 *
 332                            x_extent * (1 + Stem::get_direction (stem))
 333                            - ((dir + 1)/2) * stem_thickness
 334                            + ((1 - slurdir)/2) * stem_thickness,
 335                            0);
 336             }
 337         }
 338     }
 339   /*
 340     If we're not a note_column, we can't be anything but a loose-end.
 341     But if user has set (attachment . (stem . stem)), our string is
 342     stem, not loose-end.
 343
 344     Hmm, maybe after-line-breaking should set this to loose-end?  */
 345   else // if (str == "loose-end")
 346     {
 347       SCM other_a = dir == LEFT ? ly_cdr (s) : ly_car (s);
 348       if (ly_symbol2string (other_a) != "loose-end")
 349         o = broken_trend_offset (me, dir);
 350     }
 351
 352   SCM alist = me->get_grob_property ("extremity-offset-alist");
 353   int stemdir = stem ? Stem::get_direction (stem) : 1;
 354   SCM l = scm_assoc
 355     (scm_list_n (a,
 356                   gh_int2scm (stemdir * dir),
 357                   gh_int2scm (slurdir * dir),
 358                   SCM_UNDEFINED), alist);
 359
 360   if (l != SCM_BOOL_F)
 361     {
 362       Offset off = ly_scm2offset (ly_cdr (l)) * staff_space;
 363       off[X_AXIS] *= dir;
 364       off[Y_AXIS] *= Directional_element_interface::get (me);
 365       o += off;
 366     }
 367
 368   /*
 369     What if get_bound () is not a note-column?
 370    */
 371   if (str != "loose-end"
 372       && sp->get_bound (dir)->common_refpoint (common[Y_AXIS], Y_AXIS) == common[Y_AXIS])
 373     {
 374       o[Y_AXIS] += sp->get_bound (dir)->relative_coordinate (common[Y_AXIS], Y_AXIS)
 375         - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
 376     }
 377
 378   Offset off = ly_scm2offset (index_cell (me->get_grob_property
 379                                           ("attachment-offset"),
 380                                           dir)) * staff_space;
 381
 382   off[Y_AXIS] *= Directional_element_interface::get (me);
 383   o += off;
 384   return o;
 385 }
 386
 387 Offset
 388 Slur::encompass_offset (Grob*me,
 389                         Grob* col,
 390                         Grob **common)
 391 {
 392   Offset o;
 393   Grob* stem_l = unsmob_grob (col->get_grob_property ("stem"));
 394
 395   Direction dir = Directional_element_interface::get (me);
 396
 397   if (!stem_l)
 398     {
 399       me->warning (_ ("Slur over rest?"));
 400       o[X_AXIS] = col->relative_coordinate (common[X_AXIS], X_AXIS);
 401       o[Y_AXIS] = col->relative_coordinate (common[Y_AXIS], Y_AXIS);
 402       return o;
 403     }
 404   Direction stem_dir = Directional_element_interface::get (stem_l);
 405   o[X_AXIS] = stem_l->relative_coordinate (0, X_AXIS);
 406
 407   /*
 408     Simply set x to middle of notehead
 409    */
 410   Real x_extent;
 411   if (Grob *head = Note_column::first_head (col))
 412     x_extent = head->extent (head, X_AXIS).length ();
 413   else
 414     x_extent = col->extent (col, X_AXIS).length ();
 415   o[X_AXIS] -= 0.5 * stem_dir * x_extent;
 416
 417   if ((stem_dir == dir)
 418       && !stem_l->extent (stem_l, Y_AXIS).empty_b ())
 419     {
 420       o[Y_AXIS] = stem_l->extent (common[Y_AXIS], Y_AXIS)[dir];
 421     }
 422   else
 423     {
 424       o[Y_AXIS] = col->extent (common[Y_AXIS], Y_AXIS)[dir];
 425     }
 426
 427   /*
 428    leave a gap: slur mustn't touch head/stem
 429    */
 430   o[Y_AXIS] += dir * gh_scm2double (me->get_grob_property ("y-free")) *
 431     1.0;
 432   return o;
 433 }
 434
 435 Array<Offset>
 436 Slur::get_encompass_offset_arr (Grob *me)
 437 {
 438   Spanner*sp = dynamic_cast<Spanner*> (me);
 439   SCM eltlist = me->get_grob_property ("note-columns");
 440   Grob *common[] = {me->common_refpoint (eltlist, X_AXIS),
 441                              me->common_refpoint (eltlist, Y_AXIS)};
 442
 443
 444   common[X_AXIS] = common[X_AXIS]->common_refpoint (sp->get_bound (RIGHT), X_AXIS);
 445   common[X_AXIS] = common[X_AXIS]->common_refpoint (sp->get_bound (LEFT), X_AXIS);
 446
 447   Link_array<Grob>  encompass_arr;
 448   while (gh_pair_p (eltlist))
 449     {
 450       encompass_arr.push (unsmob_grob (ly_car (eltlist)));
 451       eltlist =ly_cdr (eltlist);
 452     }
 453   encompass_arr.reverse ();
 454
 455
 456   Array<Offset> offset_arr;
 457
 458   Offset origin (me->relative_coordinate (common[X_AXIS], X_AXIS),
 459                  me->relative_coordinate (common[Y_AXIS], Y_AXIS));
 460
 461   int first = 1;
 462   int last = encompass_arr.size () - 2;
 463
 464   offset_arr.push (get_attachment (me, LEFT, common));
 465
 466   /*
 467     left is broken edge
 468   */
 469
 470   if (encompass_arr[0] != sp->get_bound (LEFT))
 471     {
 472       first--;
 473
 474       // ?
 475       offset_arr[0][Y_AXIS] -=
 476         encompass_arr[0]->relative_coordinate (common[Y_AXIS], Y_AXIS)
 477         - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
 478     }
 479
 480   /*
 481     right is broken edge
 482   */
 483   if (encompass_arr.top () != sp->get_bound (RIGHT))
 484     {
 485       last++;
 486     }
 487
 488   for (int i = first; i <= last; i++)
 489     {
 490       Offset o (encompass_offset (me, encompass_arr[i], common));
 491       offset_arr.push (o - origin);
 492     }
 493
 494   offset_arr.push (Offset (sp->spanner_length (), 0) + get_attachment (me, RIGHT,common));
 495
 496   if (encompass_arr[0] != sp->get_bound (LEFT))
 497     {
 498       offset_arr.top ()[Y_AXIS] -= encompass_arr.top ()->relative_coordinate (common[Y_AXIS], Y_AXIS)
 499         - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
 500     }
 501
 502   return offset_arr;
 503 }
 504
 505
 506
 507
 508 /*
 509   ugh ?
 510  */
 511 MAKE_SCHEME_CALLBACK (Slur, height, 2);
 512 SCM
 513 Slur::height (SCM smob, SCM ax)
 514 {
 515   Axis a = (Axis)gh_scm2int (ax);
 516   Grob * me = unsmob_grob (smob);
 517   assert (a == Y_AXIS);
 518
 519   SCM mol = me->get_uncached_molecule ();
 520   return ly_interval2scm (unsmob_molecule (mol)->extent (a));
 521 }
 522
 523 /*
 524   Ugh should have dash-length + dash-period
 525  */
 526 MAKE_SCHEME_CALLBACK (Slur, brew_molecule,1);
 527 SCM
 528 Slur::brew_molecule (SCM smob)
 529 {
 530   Grob * me = unsmob_grob (smob);
 531   if (!scm_ilength (me->get_grob_property ("note-columns")))
 532     {
 533       me->suicide ();
 534       return SCM_EOL;
 535     }
 536
 537   Real thick = me->paper_l ()->get_var ("stafflinethickness") *
 538     gh_scm2double (me->get_grob_property ("thickness"));
 539   Bezier one = get_curve (me);
 540
 541   // get_curve may suicide
 542   if (!scm_ilength (me->get_grob_property ("note-columns")))
 543     return SCM_EOL;
 544
 545   Molecule a;
 546   SCM d =  me->get_grob_property ("dashed");
 547   if (gh_number_p (d))
 548     a = Lookup::dashed_slur (one, thick, thick * gh_scm2double (d));
 549   else
 550     a = Lookup::slur (one, Directional_element_interface::get (me) * thick, thick);
 551
 552   return a.smobbed_copy ();
 553 }
 554
 555 void
 556 Slur::set_control_points (Grob*me)
 557 {
 558   Real staff_space = Staff_symbol_referencer::staff_space ((Grob*)me);
 559
 560   SCM details = me->get_grob_property ("details");
 561   SCM h_inf_scm = scm_assq (ly_symbol2scm ("height-limit"), details);
 562   SCM r_0_scm = scm_assq (ly_symbol2scm ("ratio"), details);
 563
 564   Real r_0 = gh_scm2double (ly_cdr (r_0_scm));
 565   Real h_inf = staff_space * gh_scm2double (ly_cdr (h_inf_scm));
 566
 567   Slur_bezier_bow bb (get_encompass_offset_arr (me),
 568                       Directional_element_interface::get (me),
 569                       h_inf, r_0);
 570
 571   if (bb.fit_factor () > 1.0)
 572     {
 573       Real length = bb.curve_.control_[3][X_AXIS];
 574       Real default_height = slur_height (length, h_inf, r_0);
 575
 576       SCM ssb = me->get_grob_property ("beautiful");
 577       Real sb = 0;
 578       if (gh_number_p (ssb))
 579         sb = gh_scm2double (ssb);
 580
 581       bb.minimise_enclosed_area (sb, details);
 582       SCM sbf = scm_assq (ly_symbol2scm ("force-blowfit"), details);
 583       Real bff = 1.0;
 584       if (gh_pair_p (sbf) && gh_number_p (ly_cdr (sbf)))
 585           bff = gh_scm2double (ly_cdr (sbf));
 586
 587       bb.curve_.control_[1][Y_AXIS] *= bff;
 588       bb.curve_.control_[2][Y_AXIS] *= bff;
 589       bb.blow_fit ();
 590
 591
 592       Real beautiful = length * default_height * sb;
 593       Real area = bb.enclosed_area_f ();
 594
 595       /*
 596         Slurs that fit beautifully are not ugly
 597       */
 598       if (area > beautiful)
 599         de_uglyfy (me, &bb, default_height);
 600     }
 601
 602   Bezier b = bb.get_bezier ();
 603
 604
 605   SCM controls = SCM_EOL;
 606   for (int i= 4; i--;)
 607     {
 608       controls = gh_cons (ly_offset2scm (b.control_[i]), controls);
 609       /*
 610         BRRR WHURG.
 611         All these null control-points, where do they all come from?
 612       */
 613       if (i && b.control_[i][X_AXIS] == 0)
 614         {
 615           me->suicide ();
 616           return;
 617         }
 618     }
 619
 620   me->set_grob_property ("control-points", controls);
 621 }
 622
 623 Bezier
 624 Slur::get_curve (Grob*me)
 625 {
 626   Bezier b;
 627   int i = 0;
 628
 629   if (!Directional_element_interface::get (me)
 630       || ! gh_symbol_p (index_cell (me->get_grob_property ("attachment"), LEFT))
 631       || ! gh_symbol_p (index_cell (me->get_grob_property ("attachment"), RIGHT)))
 632     set_extremities (me);
 633
 634   if (!gh_pair_p (me->get_grob_property ("control-points")))
 635     set_control_points (me);
 636
 637   // set_control_points may suicide
 638   if (!scm_ilength (me->get_grob_property ("note-columns")))
 639     return b;
 640
 641   for (SCM s= me->get_grob_property ("control-points"); s != SCM_EOL; s = ly_cdr (s))
 642     {
 643       b.control_[i] = ly_scm2offset (ly_car (s));
 644       i++;
 645     }
 646
 647   Array<Offset> enc (get_encompass_offset_arr (me));
 648   Direction dir = Directional_element_interface::get (me);
 649
 650   Real x1 = enc[0][X_AXIS];
 651   Real x2 = enc.top ()[X_AXIS];
 652
 653   Real off = 0.0;
 654   for (int i=1; i < enc.size ()-1; i++)
 655     {
 656       Real x = enc[i][X_AXIS];
 657       if (x > x1 && x <x2)
 658         {
 659           Real y = b.get_other_coordinate (X_AXIS, x);
 660           off = off >? dir * (enc[i][Y_AXIS] - y);
 661         }
 662     }
 663   b.translate (Offset (0, dir * off));
 664   return b;
 665 }
 666
 667
 668 bool
 669 Slur::has_interface (Grob*me)
 670 {
 671   return me->has_interface (ly_symbol2scm ("slur-interface"));
 672 }
 673
 674