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 /*
 170   Set 'attachment grob property, and return it.
 171 */
 172 SCM
 173 Slur::set_extremities (Grob *me)
 174 {
 175   if (!Directional_element_interface::get (me))
 176     Directional_element_interface::set (me, get_default_dir (me));
 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   Direction dir = LEFT;
 189   do
 190     {
 191
 192       if (!gh_symbol_p (index_cell (att, dir)))
 193         {
 194           for (SCM s = me->get_grob_property ("extremity-rules");
 195                s != SCM_EOL; s = ly_cdr (s))
 196             {
 197               SCM r = gh_call2 (ly_caar (s), me->self_scm (),
 198                                  gh_int2scm ((int)dir));
 199               if (r != SCM_BOOL_F)
 200                 {
 201                   index_set_cell (att, dir,
 202                                   ly_cdar (s));
 203                   break;
 204                 }
 205             }
 206         }
 207     }
 208   while (flip (&dir) != LEFT);
 209
 210   check_slope (me);
 211
 212   return att;
 213 }
 214
 215
 216 Real
 217 Slur::get_first_notecolumn_y (Grob *me, Direction dir)
 218 {
 219   Grob *col = dir == LEFT
 220     ? unsmob_grob (ly_car (scm_reverse (me->get_grob_property
 221  ("note-columns"))))
 222     : unsmob_grob
 223  (ly_car (me->get_grob_property ("note-columns")));
 224
 225   Grob *common[] =
 226   {
 227     0,
 228     me->common_refpoint (col, Y_AXIS)
 229   };
 230   Real y;
 231   if (col == ((Spanner*)me)->get_bound (dir))
 232     {
 233       y = get_attachment (me, dir, common)[Y_AXIS];
 234     }
 235   else
 236     {
 237       y = encompass_offset (me, col, common)[Y_AXIS]
 238         - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
 239     }
 240   return y;
 241 }
 242
 243 Offset
 244 Slur::broken_trend_offset (Grob *me, Direction dir)
 245 {
 246   /*
 247     A broken slur should maintain the same vertical trend
 248     the unbroken slur would have had.
 249   */
 250   Offset o;
 251   if (Spanner *mother =  dynamic_cast<Spanner*> (me->original_l_))
 252     {
 253       for (int i = dir == LEFT ? 0 : mother->broken_into_l_arr_.size () - 1;
 254            dir == LEFT ? i < mother->broken_into_l_arr_.size () : i > 0;
 255            dir == LEFT ? i++ : i--)
 256         {
 257           if (mother->broken_into_l_arr_[i - dir] == me)
 258             {
 259               Grob *neighbour = mother->broken_into_l_arr_[i];
 260               if (dir == RIGHT)
 261                 neighbour->set_grob_property ("direction",
 262                                              me->get_grob_property ("direction"));
 263               Real neighbour_y = get_first_notecolumn_y (neighbour, dir);
 264               Real y = get_first_notecolumn_y (me, -dir);
 265               int neighbour_cols = scm_ilength (neighbour->get_grob_property ("note-columns"));
 266               int cols = scm_ilength (me->get_grob_property ("note-columns"));
 267               o = Offset (0, (y*neighbour_cols + neighbour_y*cols) /
 268  (cols + neighbour_cols));
 269               break;
 270             }
 271         }
 272     }
 273   return o;
 274 }
 275
 276 Offset
 277 Slur::get_attachment (Grob *me, Direction dir,
 278                       Grob **common)
 279 {
 280   SCM s = me->get_grob_property ("attachment");
 281   if (!gh_symbol_p (index_cell (s, dir)))
 282     {
 283       s = set_extremities (me);
 284     }
 285
 286   SCM a = dir == LEFT ? ly_car (s) : ly_cdr (s);
 287   Spanner*sp = dynamic_cast<Spanner*> (me);
 288   String str = ly_symbol2string (a);
 289   Real staff_space = Staff_symbol_referencer::staff_space ((Grob*)me);
 290   Real hs = staff_space / 2.0;
 291   Offset o;
 292
 293   int slurdir = gh_scm2int (me->get_grob_property ("direction"));
 294
 295   Grob *stem = 0;
 296   if (Note_column::has_interface (sp->get_bound (dir)))
 297     {
 298       Grob * n =sp->get_bound (dir);
 299       if ((stem = Note_column::stem_l (n)))
 300         {
 301           Real x_extent;
 302           if (Grob *head = Note_column::first_head (n))
 303             x_extent = head->extent (head, X_AXIS).length ();
 304           else
 305             x_extent = n->extent (n, X_AXIS).length ();
 306
 307           if (str == "head")
 308             {
 309               o = Offset (0, Stem::head_positions (stem)
 310                           [Directional_element_interface::get (me)] * hs);
 311               /*
 312                 Default position is centered in X, on outer side of head Y
 313                */
 314               o += Offset (0.5 * x_extent,
 315                            0.5 * staff_space
 316                            * Directional_element_interface::get (me));
 317             }
 318           else if (str == "alongside-stem")
 319             {
 320               o = Offset (0, Stem::chord_start_f (stem));
 321               /*
 322                 Default position is on stem X, on outer side of head Y
 323                */
 324               o += Offset (x_extent * (1 + Stem::get_direction (stem)),
 325                            0.5 * staff_space
 326                            * Directional_element_interface::get (me));
 327             }
 328           else if (str == "stem")
 329             {
 330               o = Offset (0, Stem::stem_end_position (stem) * hs);
 331               /*
 332                 Default position is on stem X, at stem end Y
 333                */
 334               Real stem_thickness =
 335                 gh_scm2double (stem->get_grob_property ("thickness"))
 336                 * stem->paper_l ()->get_var ("stafflinethickness");
 337               o += Offset (0.5 *
 338                            x_extent * (1 + Stem::get_direction (stem))
 339                            - ((dir + 1)/2) * stem_thickness
 340                            + ((1 - slurdir)/2) * stem_thickness,
 341                            0);
 342             }
 343         }
 344     }
 345   /*
 346     If we're not a note_column, we can't be anything but a loose-end.
 347     But if user has set (attachment . (stem . stem)), our string is
 348     stem, not loose-end.
 349
 350     Hmm, maybe after-line-breaking should set this to loose-end?  */
 351   else // if (str == "loose-end")
 352     {
 353       SCM other_a = dir == LEFT ? ly_cdr (s) : ly_car (s);
 354       if (ly_symbol2string (other_a) != "loose-end")
 355         o = broken_trend_offset (me, dir);
 356     }
 357
 358   SCM alist = me->get_grob_property ("extremity-offset-alist");
 359   int stemdir = stem ? Stem::get_direction (stem) : 1;
 360   SCM l = scm_assoc
 361     (scm_list_n (a,
 362                   gh_int2scm (stemdir * dir),
 363                   gh_int2scm (slurdir * dir),
 364                   SCM_UNDEFINED), alist);
 365
 366   if (l != SCM_BOOL_F)
 367     {
 368       Offset off = ly_scm2offset (ly_cdr (l)) * staff_space;
 369       off[X_AXIS] *= dir;
 370       off[Y_AXIS] *= Directional_element_interface::get (me);
 371       o += off;
 372     }
 373
 374   /*
 375     What if get_bound () is not a note-column?
 376    */
 377   if (str != "loose-end"
 378       && sp->get_bound (dir)->common_refpoint (common[Y_AXIS], Y_AXIS) == common[Y_AXIS])
 379     {
 380       o[Y_AXIS] += sp->get_bound (dir)->relative_coordinate (common[Y_AXIS], Y_AXIS)
 381         - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
 382     }
 383
 384   Offset off = ly_scm2offset (index_cell (me->get_grob_property
 385                                           ("attachment-offset"),
 386                                           dir)) * staff_space;
 387
 388   off[Y_AXIS] *= Directional_element_interface::get (me);
 389   o += off;
 390   return o;
 391 }
 392
 393 Offset
 394 Slur::encompass_offset (Grob*me,
 395                         Grob* col,
 396                         Grob **common)
 397 {
 398   Offset o;
 399   Grob* stem_l = unsmob_grob (col->get_grob_property ("stem"));
 400
 401   Direction dir = Directional_element_interface::get (me);
 402
 403   if (!stem_l)
 404     {
 405       me->warning (_ ("Slur over rest?"));
 406       o[X_AXIS] = col->relative_coordinate (common[X_AXIS], X_AXIS);
 407       o[Y_AXIS] = col->relative_coordinate (common[Y_AXIS], Y_AXIS);
 408       return o;
 409     }
 410   Direction stem_dir = Directional_element_interface::get (stem_l);
 411   o[X_AXIS] = stem_l->relative_coordinate (0, X_AXIS);
 412
 413   /*
 414     Simply set x to middle of notehead
 415    */
 416   Real x_extent;
 417   if (Grob *head = Note_column::first_head (col))
 418     x_extent = head->extent (head, X_AXIS).length ();
 419   else
 420     x_extent = col->extent (col, X_AXIS).length ();
 421   o[X_AXIS] -= 0.5 * stem_dir * x_extent;
 422
 423   if ((stem_dir == dir)
 424       && !stem_l->extent (stem_l, Y_AXIS).empty_b ())
 425     {
 426       o[Y_AXIS] = stem_l->extent (common[Y_AXIS], Y_AXIS)[dir];
 427     }
 428   else
 429     {
 430       o[Y_AXIS] = col->extent (common[Y_AXIS], Y_AXIS)[dir];
 431     }
 432
 433   /*
 434    leave a gap: slur mustn't touch head/stem
 435    */
 436   o[Y_AXIS] += dir * gh_scm2double (me->get_grob_property ("y-free")) *
 437     1.0;
 438   return o;
 439 }
 440
 441 Array<Offset>
 442 Slur::get_encompass_offset_arr (Grob *me)
 443 {
 444   Spanner*sp = dynamic_cast<Spanner*> (me);
 445   SCM eltlist = me->get_grob_property ("note-columns");
 446   Grob *common[] = {me->common_refpoint (eltlist, X_AXIS),
 447                              me->common_refpoint (eltlist, Y_AXIS)};
 448
 449
 450   common[X_AXIS] = common[X_AXIS]->common_refpoint (sp->get_bound (RIGHT), X_AXIS);
 451   common[X_AXIS] = common[X_AXIS]->common_refpoint (sp->get_bound (LEFT), X_AXIS);
 452
 453   Link_array<Grob>  encompass_arr;
 454   while (gh_pair_p (eltlist))
 455     {
 456       encompass_arr.push (unsmob_grob (ly_car (eltlist)));
 457       eltlist =ly_cdr (eltlist);
 458     }
 459   encompass_arr.reverse ();
 460
 461
 462   Array<Offset> offset_arr;
 463
 464   Offset origin (me->relative_coordinate (common[X_AXIS], X_AXIS),
 465                  me->relative_coordinate (common[Y_AXIS], Y_AXIS));
 466
 467   int first = 1;
 468   int last = encompass_arr.size () - 2;
 469
 470   offset_arr.push (get_attachment (me, LEFT, common));
 471
 472   /*
 473     left is broken edge
 474   */
 475
 476   if (encompass_arr[0] != sp->get_bound (LEFT))
 477     {
 478       first--;
 479
 480       // ?
 481       offset_arr[0][Y_AXIS] -=
 482         encompass_arr[0]->relative_coordinate (common[Y_AXIS], Y_AXIS)
 483         - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
 484     }
 485
 486   /*
 487     right is broken edge
 488   */
 489   if (encompass_arr.top () != sp->get_bound (RIGHT))
 490     {
 491       last++;
 492     }
 493
 494   for (int i = first; i <= last; i++)
 495     {
 496       Offset o (encompass_offset (me, encompass_arr[i], common));
 497       offset_arr.push (o - origin);
 498     }
 499
 500   offset_arr.push (Offset (sp->spanner_length (), 0) + get_attachment (me, RIGHT,common));
 501
 502   if (encompass_arr[0] != sp->get_bound (LEFT))
 503     {
 504       offset_arr.top ()[Y_AXIS] -= encompass_arr.top ()->relative_coordinate (common[Y_AXIS], Y_AXIS)
 505         - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
 506     }
 507
 508   return offset_arr;
 509 }
 510
 511
 512
 513
 514 /*
 515   ugh ?
 516  */
 517 MAKE_SCHEME_CALLBACK (Slur, height, 2);
 518 SCM
 519 Slur::height (SCM smob, SCM ax)
 520 {
 521   Axis a = (Axis)gh_scm2int (ax);
 522   Grob * me = unsmob_grob (smob);
 523   assert (a == Y_AXIS);
 524
 525   SCM mol = me->get_uncached_molecule ();
 526   return ly_interval2scm (unsmob_molecule (mol)->extent (a));
 527 }
 528
 529 /*
 530   Ugh should have dash-length + dash-period
 531  */
 532 MAKE_SCHEME_CALLBACK (Slur, brew_molecule,1);
 533 SCM
 534 Slur::brew_molecule (SCM smob)
 535 {
 536   Grob * me = unsmob_grob (smob);
 537   if (!scm_ilength (me->get_grob_property ("note-columns")))
 538     {
 539       me->suicide ();
 540       return SCM_EOL;
 541     }
 542
 543   Real thick = me->paper_l ()->get_var ("stafflinethickness") *
 544     gh_scm2double (me->get_grob_property ("thickness"));
 545   Bezier one = get_curve (me);
 546
 547   // get_curve may suicide
 548   if (!scm_ilength (me->get_grob_property ("note-columns")))
 549     return SCM_EOL;
 550
 551   Molecule a;
 552   SCM d =  me->get_grob_property ("dashed");
 553   if (gh_number_p (d))
 554     a = Lookup::dashed_slur (one, thick, thick * gh_scm2double (d));
 555   else
 556     a = Lookup::slur (one, Directional_element_interface::get (me) * thick, thick);
 557
 558   return a.smobbed_copy ();
 559 }
 560
 561 void
 562 Slur::set_control_points (Grob*me)
 563 {
 564   Real staff_space = Staff_symbol_referencer::staff_space ((Grob*)me);
 565
 566   SCM details = me->get_grob_property ("details");
 567   SCM h_inf_scm = scm_assq (ly_symbol2scm ("height-limit"), details);
 568   SCM r_0_scm = scm_assq (ly_symbol2scm ("ratio"), details);
 569
 570   Real r_0 = gh_scm2double (ly_cdr (r_0_scm));
 571   Real h_inf = staff_space * gh_scm2double (ly_cdr (h_inf_scm));
 572
 573   Slur_bezier_bow bb (get_encompass_offset_arr (me),
 574                       Directional_element_interface::get (me),
 575                       h_inf, r_0);
 576
 577   if (bb.fit_factor () > 1.0)
 578     {
 579       Real length = bb.curve_.control_[3][X_AXIS];
 580       Real default_height = slur_height (length, h_inf, r_0);
 581
 582       SCM ssb = me->get_grob_property ("beautiful");
 583       Real sb = 0;
 584       if (gh_number_p (ssb))
 585         sb = gh_scm2double (ssb);
 586
 587       bb.minimise_enclosed_area (sb, details);
 588       SCM sbf = scm_assq (ly_symbol2scm ("force-blowfit"), details);
 589       Real bff = 1.0;
 590       if (gh_pair_p (sbf) && gh_number_p (ly_cdr (sbf)))
 591           bff = gh_scm2double (ly_cdr (sbf));
 592
 593       bb.curve_.control_[1][Y_AXIS] *= bff;
 594       bb.curve_.control_[2][Y_AXIS] *= bff;
 595       bb.blow_fit ();
 596
 597
 598       Real beautiful = length * default_height * sb;
 599       Real area = bb.enclosed_area_f ();
 600
 601       /*
 602         Slurs that fit beautifully are not ugly
 603       */
 604       if (area > beautiful)
 605         de_uglyfy (me, &bb, default_height);
 606     }
 607
 608   Bezier b = bb.get_bezier ();
 609
 610
 611   SCM controls = SCM_EOL;
 612   for (int i= 4; i--;)
 613     {
 614       controls = gh_cons (ly_offset2scm (b.control_[i]), controls);
 615       /*
 616         BRRR WHURG.
 617         All these null control-points, where do they all come from?
 618       */
 619       if (i && b.control_[i][X_AXIS] == 0)
 620         {
 621           me->suicide ();
 622           return;
 623         }
 624     }
 625
 626   me->set_grob_property ("control-points", controls);
 627 }
 628
 629 Bezier
 630 Slur::get_curve (Grob*me)
 631 {
 632   Bezier b;
 633   int i = 0;
 634
 635   SCM attach = me->get_grob_property ("attachment");
 636   if (!gh_pair_p (attach))
 637     attach = set_extremities(me);
 638
 639
 640   if (!Directional_element_interface::get (me)
 641       || ! gh_symbol_p (index_cell (attach, LEFT))
 642       || ! gh_symbol_p (index_cell (attach, RIGHT)))
 643     set_extremities (me);
 644
 645   if (!gh_pair_p (me->get_grob_property ("control-points")))
 646     set_control_points (me);
 647
 648   // set_control_points may suicide
 649   if (!scm_ilength (me->get_grob_property ("note-columns")))
 650     return b;
 651
 652   for (SCM s= me->get_grob_property ("control-points"); s != SCM_EOL; s = ly_cdr (s))
 653     {
 654       b.control_[i] = ly_scm2offset (ly_car (s));
 655       i++;
 656     }
 657
 658   Array<Offset> enc (get_encompass_offset_arr (me));
 659   Direction dir = Directional_element_interface::get (me);
 660
 661   Real x1 = enc[0][X_AXIS];
 662   Real x2 = enc.top ()[X_AXIS];
 663
 664   Real off = 0.0;
 665   for (int i=1; i < enc.size ()-1; i++)
 666     {
 667       Real x = enc[i][X_AXIS];
 668       if (x > x1 && x <x2)
 669         {
 670           Real y = b.get_other_coordinate (X_AXIS, x);
 671           off = off >? dir * (enc[i][Y_AXIS] - y);
 672         }
 673     }
 674   b.translate (Offset (0, dir * off));
 675   return b;
 676 }
 677
 678
 679 bool
 680 Slur::has_interface (Grob*me)
 681 {
 682   return me->has_interface (ly_symbol2scm ("slur-interface"));
 683 }
 684
 685