lily/slur.cc

   1 /*
   2   slur.cc -- implement  Slur
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1996--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7     Jan Nieuwenhuizen <janneke@gnu.org>
   8 */
   9
  10 /*
  11   [TODO]
  12     * fix broken interstaff slurs
  13     * begin and end should be treated as a/acknowledge Scripts.
  14     * broken slur should have uniform trend
  15     * smart changing of endings
  16     * smart changing of (Y-?)offsets to avoid ugly beziers
  17        (along-side-stem)
  18  */
  19
  20 #include "directional-element-interface.hh"
  21 #include "group-interface.hh"
  22 #include "slur.hh"
  23 #include "lookup.hh"
  24 #include "paper-def.hh"
  25 #include "note-column.hh"
  26 #include "stem.hh"
  27 #include "paper-column.hh"
  28 #include "molecule.hh"
  29 #include "debug.hh"
  30 #include "slur-bezier-bow.hh"
  31 #include "main.hh"
  32 #include "group-interface.hh"
  33 #include "staff-symbol-referencer.hh"
  34 #include "spanner.hh"
  35
  36
  37 void
  38 Slur::set_interface (Score_element*me)
  39 {
  40   me->set_elt_property ("attachment", gh_cons (SCM_BOOL_F, SCM_BOOL_F));
  41   me->set_interface (ly_symbol2scm ("slur-interface"));
  42 }
  43
  44 void
  45 Slur::add_column (Score_element*me, Score_element*n)
  46 {
  47   if (!gh_pair_p (n->get_elt_property ("note-heads")))
  48     warning (_ ("Putting slur over rest.  Ignoring."));
  49   else
  50     {
  51       Pointer_group_interface (me, "note-columns").add_element (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 (Score_element*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_elt_property ("de-uglify-parameters");
  71
  72       Real c1 = gh_scm2double (gh_car (up));
  73       Real c2 = gh_scm2double (gh_cadr (up));
  74       Real c3 = gh_scm2double (gh_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 (Score_element*me)
  93 {
  94   Link_array<Score_element> encompass_arr =
  95     Pointer_group_interface__extract_elements (me, (Score_element*)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);
 111 SCM
 112 Slur::after_line_breaking (SCM smob)
 113 {
 114   Score_element *me = unsmob_element (smob);
 115   if (!scm_ilength (me->get_elt_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 void
 126 Slur::set_extremities (Score_element*me)
 127 {
 128   if (!Directional_element_interface::get (me))
 129     Directional_element_interface ::set (me,get_default_dir (me));
 130
 131   Direction dir = LEFT;
 132   do
 133     {
 134       if (!gh_symbol_p (index_cell (me->get_elt_property ("attachment"), dir)))
 135         {
 136
 137           // for (SCM s = get_elt_property ("slur-extremity-rules"); s != SCM_EOL; s = gh_cdr (s))
 138           for (SCM s = scm_eval2 (ly_symbol2scm ("slur-extremity-rules"),
 139                                   SCM_EOL);
 140                s != SCM_EOL; s = gh_cdr (s))
 141             {
 142               SCM r = gh_call2 (gh_caar (s), me->self_scm (),
 143                                  gh_int2scm ((int)dir));
 144               if (r != SCM_BOOL_F)
 145                 {
 146                   index_set_cell (me->get_elt_property ("attachment"), dir,
 147                                   gh_cdar (s));
 148                   break;
 149                 }
 150             }
 151         }
 152     }
 153   while (flip (&dir) != LEFT);
 154 }
 155
 156 Real
 157 Slur::get_first_notecolumn_y (Score_element *me, Direction dir)
 158 {
 159   Score_element *col = dir == LEFT
 160     ? unsmob_element (gh_car (scm_reverse (me->get_elt_property
 161                                            ("note-columns"))))
 162     : unsmob_element
 163     (gh_car (me->get_elt_property ("note-columns")));
 164
 165   Score_element *common[] =
 166   {
 167     0,
 168     me->common_refpoint (col, Y_AXIS)
 169   };
 170   Real y;
 171   if (col == ((Spanner*)me)->get_bound (dir))
 172     {
 173       y = get_attachment (me, dir, common)[Y_AXIS];
 174     }
 175   else
 176     {
 177       y = encompass_offset (me, col, common)[Y_AXIS]
 178         - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
 179     }
 180   return y;
 181 }
 182
 183 Offset
 184 Slur::broken_trend_offset (Score_element *me, Direction dir)
 185 {
 186   /*
 187     A broken slur should maintain the same vertical trend
 188     the unbroken slur would have had.
 189   */
 190   Offset o;
 191   if (Spanner *mother =  dynamic_cast<Spanner*> (me->original_l_))
 192     {
 193       for (int i = dir == LEFT ? 0 : mother->broken_into_l_arr_.size ();
 194            dir == LEFT ? i < mother->broken_into_l_arr_.size () : i;
 195            dir == LEFT ? i++ : --i)
 196         {
 197           if (mother->broken_into_l_arr_[i - dir] == me)
 198             {
 199               Score_element *neighbour = mother->broken_into_l_arr_[i];
 200               if (dir == RIGHT)
 201                 neighbour->set_elt_property ("direction",
 202                                              me->get_elt_property ("direction"));
 203               Real neighbour_y = get_first_notecolumn_y (neighbour, dir);
 204               Real y = get_first_notecolumn_y (me, -dir);
 205               o = Offset (0, (y + neighbour_y) / 2);
 206               break;
 207             }
 208         }
 209     }
 210   return o;
 211 }
 212
 213 Offset
 214 Slur::get_attachment (Score_element*me,Direction dir,
 215                       Score_element **common)
 216 {
 217   SCM s = me->get_elt_property ("attachment");
 218   if (!gh_symbol_p (index_cell (s, dir)))
 219     {
 220       set_extremities (me);
 221       s = me->get_elt_property ("attachment");
 222     }
 223   SCM a = dir == LEFT ? gh_car (s) : gh_cdr (s);
 224   Spanner*sp = dynamic_cast<Spanner*>(me);
 225   String str = ly_symbol2string (a);
 226   Real ss = Staff_symbol_referencer::staff_space ((Score_element*)me);
 227   Real hs = ss / 2.0;
 228   Offset o;
 229
 230   Score_element *stem = 0;
 231   if (Note_column::has_interface (sp->get_bound (dir)))
 232     {
 233       Score_element * n =sp->get_bound (dir);
 234       if (Score_element *stem = Note_column::stem_l (n))
 235         {
 236
 237           if (str == "head")
 238             {
 239               o = Offset (0, Stem::head_positions (stem)
 240                           [Directional_element_interface::get (me)] * hs);
 241               /*
 242                 Default position is centered in X, on outer side of head Y
 243                */
 244               o += Offset (0.5 * n->extent (X_AXIS).length (),
 245                            0.5 * ss * Directional_element_interface::get (me));
 246             }
 247           else if (str == "alongside-stem")
 248             {
 249               o = Offset (0, Stem::chord_start_f (stem));
 250               /*
 251                 Default position is on stem X, on outer side of head Y
 252                */
 253               o += Offset (n->extent (X_AXIS).length ()
 254                            * (1 + Stem::get_direction (stem)),
 255                            0.5 * ss * Directional_element_interface::get (me));
 256             }
 257           else if (str == "stem")
 258             {
 259               o = Offset (0, Stem::stem_end_position (stem) * hs);
 260               /*
 261                 Default position is on stem X, at stem end Y
 262                */
 263               o += Offset (0.5 *
 264                            (n->extent (X_AXIS).length ()
 265                             - stem->extent (X_AXIS).length ())
 266                             * (1 + Stem::get_direction (stem)),
 267                             0);
 268             }
 269         }
 270     }
 271   else if (str == "loose-end")
 272     {
 273       SCM other_a = dir == LEFT ? gh_cdr (s) : gh_car (s);
 274       if (ly_symbol2string (other_a) != "loose-end")
 275         {
 276 #if 0
 277           /*
 278             The braindead way: horizontal
 279           */
 280           o = Offset (0, get_attachment (me, -dir, common)[Y_AXIS]);
 281 #else
 282           o = broken_trend_offset (me, dir);
 283 #endif
 284
 285
 286         }
 287
 288     }
 289
 290   SCM l = scm_assoc
 291     (scm_listify (a,
 292                   gh_int2scm (stem ? Stem::get_direction (stem) : 1 * dir),
 293                   gh_int2scm (Directional_element_interface::get (me) * dir),
 294                   SCM_UNDEFINED),
 295      scm_eval2 (ly_symbol2scm ("slur-extremity-offset-alist"), SCM_EOL));
 296
 297   if (l != SCM_BOOL_F)
 298     {
 299       o += ly_scm2offset (gh_cdr (l)) * ss * dir;
 300     }
 301
 302   /*
 303     What if get_bound () is not a note-column?
 304    */
 305   if (str != "loose-end"
 306       && sp->get_bound (dir)->common_refpoint (common[Y_AXIS], Y_AXIS) == common[Y_AXIS])
 307     {
 308       o[Y_AXIS] += sp->get_bound (dir)->relative_coordinate (common[Y_AXIS], Y_AXIS)
 309         - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
 310     }
 311
 312   return o;
 313 }
 314
 315 Offset
 316 Slur::encompass_offset (Score_element*me,
 317                         Score_element* col,
 318                         Score_element **common)
 319 {
 320   Offset o;
 321   Score_element* stem_l = unsmob_element (col->get_elt_property ("stem"));
 322
 323   Direction dir = Directional_element_interface::get (me);
 324
 325   if (!stem_l)
 326     {
 327       warning (_ ("Slur over rest?"));
 328       o[X_AXIS] = col->relative_coordinate (common[X_AXIS], X_AXIS);
 329       o[Y_AXIS] = col->relative_coordinate (common[Y_AXIS], Y_AXIS);
 330       return o;
 331     }
 332   Direction stem_dir = Directional_element_interface::get (stem_l);
 333   o[X_AXIS] = stem_l->relative_coordinate (0, X_AXIS);
 334
 335   /*
 336     Simply set x to middle of notehead
 337    */
 338
 339   o[X_AXIS] -= 0.5 * stem_dir * col->extent (X_AXIS).length ();
 340
 341   if ((stem_dir == dir)
 342       && !stem_l->extent (Y_AXIS).empty_b ())
 343     {
 344       o[Y_AXIS] = stem_l->relative_coordinate (common[Y_AXIS], Y_AXIS); // iuhg
 345       o[Y_AXIS] += stem_l->extent (Y_AXIS)[dir];
 346     }
 347   else
 348     {
 349       o[Y_AXIS] = col->relative_coordinate (common[Y_AXIS], Y_AXIS);    // ugh
 350       o[Y_AXIS] += col->extent (Y_AXIS)[dir];
 351     }
 352
 353   /*
 354    leave a gap: slur mustn't touch head/stem
 355    */
 356   o[Y_AXIS] += dir * me->paper_l ()->get_var ("slur_y_free");
 357   return o;
 358 }
 359
 360 Array<Offset>
 361 Slur::get_encompass_offset_arr (Score_element*me)
 362 {
 363   Spanner*sp = dynamic_cast<Spanner*>(me);
 364   SCM eltlist = me->get_elt_property ("note-columns");
 365   Score_element *common[] = {me->common_refpoint (eltlist,X_AXIS),
 366                              me->common_refpoint (eltlist,Y_AXIS)};
 367
 368
 369   common[X_AXIS] = common[X_AXIS]->common_refpoint (sp->get_bound (RIGHT), X_AXIS);
 370   common[X_AXIS] = common[X_AXIS]->common_refpoint (sp->get_bound (LEFT), X_AXIS);
 371
 372   Link_array<Score_element>  encompass_arr;
 373   while (gh_pair_p (eltlist))
 374     {
 375       encompass_arr.push (unsmob_element (gh_car (eltlist)));
 376       eltlist =gh_cdr (eltlist);
 377     }
 378   encompass_arr.reverse ();
 379
 380
 381   Array<Offset> offset_arr;
 382
 383   Offset origin (me->relative_coordinate (common[X_AXIS], X_AXIS),
 384                  me->relative_coordinate (common[Y_AXIS], Y_AXIS));
 385
 386   int first = 1;
 387   int last = encompass_arr.size () - 2;
 388
 389   offset_arr.push (get_attachment (me, LEFT, common));
 390
 391   /*
 392     left is broken edge
 393   */
 394
 395   if (encompass_arr[0] != sp->get_bound (LEFT))
 396     {
 397       first--;
 398
 399       // ?
 400       offset_arr[0][Y_AXIS] -=
 401         encompass_arr[0]->relative_coordinate (common[Y_AXIS], Y_AXIS)
 402         - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
 403     }
 404
 405   /*
 406     right is broken edge
 407   */
 408   if (encompass_arr.top () != sp->get_bound (RIGHT))
 409     {
 410       last++;
 411     }
 412
 413   for (int i = first; i <= last; i++)
 414     {
 415       Offset o (encompass_offset (me, encompass_arr[i], common));
 416       offset_arr.push (o - origin);
 417     }
 418
 419   offset_arr.push (Offset (sp->spanner_length (), 0) + get_attachment (me, RIGHT,common));
 420
 421   if (encompass_arr[0] != sp->get_bound (LEFT))
 422     {
 423       offset_arr.top ()[Y_AXIS] -= encompass_arr.top ()->relative_coordinate (common[Y_AXIS], Y_AXIS)
 424         - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
 425     }
 426
 427   return offset_arr;
 428 }
 429
 430
 431 MAKE_SCHEME_CALLBACK(Slur,set_spacing_rods);
 432 SCM
 433 Slur::set_spacing_rods (SCM smob)
 434 {
 435   Score_element*me = unsmob_element (smob);
 436
 437   Rod r;
 438   Spanner*sp = dynamic_cast<Spanner*>(me);
 439   r.item_l_drul_[LEFT] = sp->get_bound (LEFT);
 440   r.item_l_drul_[RIGHT] = sp->get_bound (RIGHT);
 441   r.distance_f_ =
 442     gh_scm2double (me->get_elt_property ("minimum-length"))
 443     * me->paper_l ()->get_var ("staffspace");
 444
 445   r.add_to_cols ();
 446   return SCM_UNSPECIFIED;
 447 }
 448
 449
 450 /*
 451   Ugh should have dash-length + dash-period
 452  */
 453 MAKE_SCHEME_CALLBACK (Slur, brew_molecule);
 454 SCM
 455 Slur::brew_molecule (SCM smob)
 456 {
 457   Score_element * me = unsmob_element (smob);
 458   if (!scm_ilength (me->get_elt_property ("note-columns")))
 459     {
 460       me->suicide ();
 461       return SCM_EOL;
 462     }
 463
 464   Real thick = me->paper_l ()->get_var ("stafflinethickness") *
 465     gh_scm2double (me->get_elt_property ("thickness"));
 466   Bezier one = get_curve (me);
 467
 468   Molecule a;
 469   SCM d =  me->get_elt_property ("dashed");
 470   if (gh_number_p (d))
 471     a = me->lookup_l ()->dashed_slur (one, thick, thick * gh_scm2double (d));
 472   else
 473     a = me->lookup_l ()->slur (one, Directional_element_interface::get (me) * thick, thick);
 474
 475   return a.create_scheme();
 476 }
 477
 478 void
 479 Slur::set_control_points (Score_element*me)
 480 {
 481   Real staff_space = Staff_symbol_referencer::staff_space ((Score_element*)me);
 482   Real h_inf = me->paper_l ()->get_var ("slur_height_limit_factor") *
 483     staff_space;
 484   Real r_0 = me->paper_l ()->get_var ("slur_ratio");
 485
 486   Slur_bezier_bow bb (get_encompass_offset_arr (me),
 487                       Directional_element_interface::get (me),
 488                       h_inf, r_0);
 489
 490   if (bb.fit_factor () > 1.0)
 491     {
 492       Real length = bb.curve_.control_[3][X_AXIS];
 493       Real default_height = slur_height (length, h_inf, r_0);
 494       bb.minimise_enclosed_area (me->paper_l());
 495
 496       Real bff = me->paper_l ()->get_var ("slur_force_blowfit");
 497       bb.curve_.control_[1][Y_AXIS] *= bff;
 498       bb.curve_.control_[2][Y_AXIS] *= bff;
 499       bb.blow_fit ();
 500
 501       Real sb = me->paper_l ()->get_var ("slur_beautiful");
 502       Real beautiful = length * default_height * sb;
 503       Real area = bb.enclosed_area_f ();
 504
 505       /*
 506         Slurs that fit beautifully are not ugly
 507       */
 508       if (area > beautiful)
 509         de_uglyfy (me, &bb, default_height);
 510     }
 511
 512   Bezier b = bb.get_bezier ();
 513
 514
 515   SCM controls = SCM_EOL;
 516   for (int i= 4; i--;)
 517     {
 518       controls = gh_cons ( ly_offset2scm (b.control_[i]), controls);
 519       /*
 520         BRRR WHURG.
 521         All these null control-points, where do they all come from?
 522       */
 523       if (i && b.control_[i][X_AXIS] == 0)
 524         me->suicide ();
 525     }
 526
 527   me->set_elt_property ("control-points", controls);
 528 }
 529
 530 Bezier
 531 Slur::get_curve (Score_element*me)
 532 {
 533   Bezier b;
 534   int i = 0;
 535
 536   if (!Directional_element_interface::get (me)
 537       || ! gh_symbol_p (index_cell (me->get_elt_property ("attachment"), LEFT)))
 538     set_extremities (me);
 539
 540   if (!gh_pair_p (me->get_elt_property ("control-points")))
 541     set_control_points (me);
 542
 543   for (SCM s= me->get_elt_property ("control-points"); s != SCM_EOL; s = gh_cdr (s))
 544     {
 545       b.control_[i] = ly_scm2offset (gh_car (s));
 546       i++;
 547     }
 548
 549   Array<Offset> enc (get_encompass_offset_arr (me));
 550   Direction dir = Directional_element_interface::get (me);
 551
 552   Real x1 = enc[0][X_AXIS];
 553   Real x2 = enc.top ()[X_AXIS];
 554
 555   Real off = 0.0;
 556   for (int i=1; i < enc.size ()-1; i++)
 557     {
 558       Real x = enc[i][X_AXIS];
 559       if (x > x1 && x <x2)
 560         {
 561           Real y = b.get_other_coordinate (X_AXIS, x);
 562           off = off >? dir *  (enc[i][Y_AXIS] - y);
 563         }
 564     }
 565   b.translate (Offset (0, dir * off));
 566   return b;
 567 }
 568
 569
 570 bool
 571 Slur::has_interface (Score_element*me)
 572 {
 573   return me->has_interface (ly_symbol2scm ("slur-interface"));
 574 }
 575
 576