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           for (SCM s = me->get_elt_property ("extremity-rules");
 137                s != SCM_EOL; s = gh_cdr (s))
 138             {
 139               SCM r = gh_call2 (gh_caar (s), me->self_scm (),
 140                                  gh_int2scm ((int)dir));
 141               if (r != SCM_BOOL_F)
 142                 {
 143                   index_set_cell (me->get_elt_property ("attachment"), dir,
 144                                   gh_cdar (s));
 145                   break;
 146                 }
 147             }
 148         }
 149     }
 150   while (flip (&dir) != LEFT);
 151 }
 152
 153 Real
 154 Slur::get_first_notecolumn_y (Score_element *me, Direction dir)
 155 {
 156   Score_element *col = dir == LEFT
 157     ? unsmob_element (gh_car (scm_reverse (me->get_elt_property
 158                                            ("note-columns"))))
 159     : unsmob_element
 160     (gh_car (me->get_elt_property ("note-columns")));
 161
 162   Score_element *common[] =
 163   {
 164     0,
 165     me->common_refpoint (col, Y_AXIS)
 166   };
 167   Real y;
 168   if (col == ((Spanner*)me)->get_bound (dir))
 169     {
 170       y = get_attachment (me, dir, common)[Y_AXIS];
 171     }
 172   else
 173     {
 174       y = encompass_offset (me, col, common)[Y_AXIS]
 175         - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
 176     }
 177   return y;
 178 }
 179
 180 Offset
 181 Slur::broken_trend_offset (Score_element *me, Direction dir)
 182 {
 183   /*
 184     A broken slur should maintain the same vertical trend
 185     the unbroken slur would have had.
 186   */
 187   Offset o;
 188   if (Spanner *mother =  dynamic_cast<Spanner*> (me->original_l_))
 189     {
 190       for (int i = dir == LEFT ? 0 : mother->broken_into_l_arr_.size () - 1;
 191            dir == LEFT ? i < mother->broken_into_l_arr_.size () : i > 0;
 192            dir == LEFT ? i++ : i--)
 193         {
 194           if (mother->broken_into_l_arr_[i - dir] == me)
 195             {
 196               Score_element *neighbour = mother->broken_into_l_arr_[i];
 197               if (dir == RIGHT)
 198                 neighbour->set_elt_property ("direction",
 199                                              me->get_elt_property ("direction"));
 200               Real neighbour_y = get_first_notecolumn_y (neighbour, dir);
 201               Real y = get_first_notecolumn_y (me, -dir);
 202               o = Offset (0, (y + neighbour_y) / 2);
 203               break;
 204             }
 205         }
 206     }
 207   return o;
 208 }
 209
 210 Offset
 211 Slur::get_attachment (Score_element*me,Direction dir,
 212                       Score_element **common)
 213 {
 214   SCM s = me->get_elt_property ("attachment");
 215   if (!gh_symbol_p (index_cell (s, dir)))
 216     {
 217       set_extremities (me);
 218       s = me->get_elt_property ("attachment");
 219     }
 220   SCM a = dir == LEFT ? gh_car (s) : gh_cdr (s);
 221   Spanner*sp = dynamic_cast<Spanner*>(me);
 222   String str = ly_symbol2string (a);
 223   Real ss = Staff_symbol_referencer::staff_space ((Score_element*)me);
 224   Real hs = ss / 2.0;
 225   Offset o;
 226
 227   Score_element *stem = 0;
 228   if (Note_column::has_interface (sp->get_bound (dir)))
 229     {
 230       Score_element * n =sp->get_bound (dir);
 231       if ((stem = Note_column::stem_l (n)))
 232         {
 233
 234           if (str == "head")
 235             {
 236               o = Offset (0, Stem::head_positions (stem)
 237                           [Directional_element_interface::get (me)] * hs);
 238               /*
 239                 Default position is centered in X, on outer side of head Y
 240                */
 241               o += Offset (0.5 * n->extent (X_AXIS).length (),
 242                            0.5 * ss * Directional_element_interface::get (me));
 243             }
 244           else if (str == "alongside-stem")
 245             {
 246               o = Offset (0, Stem::chord_start_f (stem));
 247               /*
 248                 Default position is on stem X, on outer side of head Y
 249                */
 250               o += Offset (n->extent (X_AXIS).length ()
 251                            * (1 + Stem::get_direction (stem)),
 252                            0.5 * ss * Directional_element_interface::get (me));
 253             }
 254           else if (str == "stem")
 255             {
 256               o = Offset (0, Stem::stem_end_position (stem) * hs);
 257               /*
 258                 Default position is on stem X, at stem end Y
 259                */
 260               o += Offset (0.5 *
 261                            (n->extent (X_AXIS).length ()
 262                             - stem->extent (X_AXIS).length ())
 263                             * (1 + Stem::get_direction (stem)),
 264                             0);
 265             }
 266         }
 267     }
 268   else if (str == "loose-end")
 269     {
 270       SCM other_a = dir == LEFT ? gh_cdr (s) : gh_car (s);
 271       if (ly_symbol2string (other_a) != "loose-end")
 272         {
 273 #if 0
 274           /*
 275             The braindead way: horizontal
 276           */
 277           o = Offset (0, get_attachment (me, -dir, common)[Y_AXIS]);
 278 #else
 279           o = broken_trend_offset (me, dir);
 280 #endif
 281
 282
 283         }
 284
 285     }
 286
 287   SCM alist = me->get_elt_property ("extremity-offset-alist");
 288 int stemdir = stem ? Stem::get_direction (stem) : 1;
 289   int slurdir = gh_scm2int (me->get_elt_property ("direction"));
 290   SCM l = scm_assoc
 291       (scm_listify (a,
 292                 gh_int2scm (stemdir * dir),
 293                 gh_int2scm (slurdir * dir),
 294                   SCM_UNDEFINED), alist);
 295
 296   if (l != SCM_BOOL_F)
 297     {
 298       o += ly_scm2offset (gh_cdr (l)) * ss * dir;
 299     }
 300
 301   /*
 302     What if get_bound () is not a note-column?
 303    */
 304   if (str != "loose-end"
 305       && sp->get_bound (dir)->common_refpoint (common[Y_AXIS], Y_AXIS) == common[Y_AXIS])
 306     {
 307       o[Y_AXIS] += sp->get_bound (dir)->relative_coordinate (common[Y_AXIS], Y_AXIS)
 308         - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
 309     }
 310
 311   return o;
 312 }
 313
 314 Offset
 315 Slur::encompass_offset (Score_element*me,
 316                         Score_element* col,
 317                         Score_element **common)
 318 {
 319   Offset o;
 320   Score_element* stem_l = unsmob_element (col->get_elt_property ("stem"));
 321
 322   Direction dir = Directional_element_interface::get (me);
 323
 324   if (!stem_l)
 325     {
 326       warning (_ ("Slur over rest?"));
 327       o[X_AXIS] = col->relative_coordinate (common[X_AXIS], X_AXIS);
 328       o[Y_AXIS] = col->relative_coordinate (common[Y_AXIS], Y_AXIS);
 329       return o;
 330     }
 331   Direction stem_dir = Directional_element_interface::get (stem_l);
 332   o[X_AXIS] = stem_l->relative_coordinate (0, X_AXIS);
 333
 334   /*
 335     Simply set x to middle of notehead
 336    */
 337
 338   o[X_AXIS] -= 0.5 * stem_dir * col->extent (X_AXIS).length ();
 339
 340   if ((stem_dir == dir)
 341       && !stem_l->extent (Y_AXIS).empty_b ())
 342     {
 343       o[Y_AXIS] = stem_l->relative_coordinate (common[Y_AXIS], Y_AXIS); // iuhg
 344       o[Y_AXIS] += stem_l->extent (Y_AXIS)[dir];
 345     }
 346   else
 347     {
 348       o[Y_AXIS] = col->relative_coordinate (common[Y_AXIS], Y_AXIS);    // ugh
 349       o[Y_AXIS] += col->extent (Y_AXIS)[dir];
 350     }
 351
 352   /*
 353    leave a gap: slur mustn't touch head/stem
 354    */
 355   o[Y_AXIS] += dir * gh_scm2double (me->get_elt_property ("y-free")) *
 356     me->paper_l ()->get_var ("staffspace");
 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
 483   SCM details = me->get_elt_property ("details");
 484   SCM h_inf_scm = scm_assq (ly_symbol2scm ("height-limit"), details);
 485   SCM r_0_scm = scm_assq (ly_symbol2scm ("ratio"), details);
 486
 487   Real r_0 = gh_scm2double (gh_cdr (r_0_scm));
 488   Real h_inf = staff_space * gh_scm2double (gh_cdr (h_inf_scm));
 489
 490   Slur_bezier_bow bb (get_encompass_offset_arr (me),
 491                       Directional_element_interface::get (me),
 492                       h_inf, r_0);
 493
 494   if (bb.fit_factor () > 1.0)
 495     {
 496       Real length = bb.curve_.control_[3][X_AXIS];
 497       Real default_height = slur_height (length, h_inf, r_0);
 498
 499       SCM ssb = scm_assq (ly_symbol2scm ("beautiful"), details);
 500       Real sb =gh_scm2double (gh_cdr (ssb));
 501
 502       bb.minimise_enclosed_area (me->paper_l(), sb);
 503       SCM sbf = scm_assq (ly_symbol2scm ("force-blowfit"), details);
 504       Real bff = 1.0;
 505       if (gh_pair_p (sbf) && gh_number_p (gh_cdr (sbf)))
 506           bff = gh_scm2double (gh_cdr (sbf));
 507
 508       bb.curve_.control_[1][Y_AXIS] *= bff;
 509       bb.curve_.control_[2][Y_AXIS] *= bff;
 510       bb.blow_fit ();
 511
 512
 513       Real beautiful = length * default_height * sb;
 514       Real area = bb.enclosed_area_f ();
 515
 516       /*
 517         Slurs that fit beautifully are not ugly
 518       */
 519       if (area > beautiful)
 520         de_uglyfy (me, &bb, default_height);
 521     }
 522
 523   Bezier b = bb.get_bezier ();
 524
 525
 526   SCM controls = SCM_EOL;
 527   for (int i= 4; i--;)
 528     {
 529       controls = gh_cons ( ly_offset2scm (b.control_[i]), controls);
 530       /*
 531         BRRR WHURG.
 532         All these null control-points, where do they all come from?
 533       */
 534       if (i && b.control_[i][X_AXIS] == 0)
 535         me->suicide ();
 536     }
 537
 538   me->set_elt_property ("control-points", controls);
 539 }
 540
 541 Bezier
 542 Slur::get_curve (Score_element*me)
 543 {
 544   Bezier b;
 545   int i = 0;
 546
 547   if (!Directional_element_interface::get (me)
 548       || ! gh_symbol_p (index_cell (me->get_elt_property ("attachment"), LEFT)))
 549     set_extremities (me);
 550
 551   if (!gh_pair_p (me->get_elt_property ("control-points")))
 552     set_control_points (me);
 553
 554   for (SCM s= me->get_elt_property ("control-points"); s != SCM_EOL; s = gh_cdr (s))
 555     {
 556       b.control_[i] = ly_scm2offset (gh_car (s));
 557       i++;
 558     }
 559
 560   Array<Offset> enc (get_encompass_offset_arr (me));
 561   Direction dir = Directional_element_interface::get (me);
 562
 563   Real x1 = enc[0][X_AXIS];
 564   Real x2 = enc.top ()[X_AXIS];
 565
 566   Real off = 0.0;
 567   for (int i=1; i < enc.size ()-1; i++)
 568     {
 569       Real x = enc[i][X_AXIS];
 570       if (x > x1 && x <x2)
 571         {
 572           Real y = b.get_other_coordinate (X_AXIS, x);
 573           off = off >? dir *  (enc[i][Y_AXIS] - y);
 574         }
 575     }
 576   b.translate (Offset (0, dir * off));
 577   return b;
 578 }
 579
 580
 581 bool
 582 Slur::has_interface (Score_element*me)
 583 {
 584   return me->has_interface (ly_symbol2scm ("slur-interface"));
 585 }
 586
 587