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       Real c1 = me->paper_l ()->get_var ("bezier_control1");
  71       Real c2 = me->paper_l ()->get_var ("bezier_control2");
  72       Real c3 = me->paper_l ()->get_var ("bezier_control3");
  73       if (h > c1 * f)
  74         {
  75           h = c1 * f;
  76         }
  77       else if (h > c2 + c3 * ind)
  78         {
  79           h = c2 + c3 * ind;
  80         }
  81
  82       bb->curve_.control_[i][Y_AXIS] = h * length;
  83     }
  84
  85   bb->curve_.assert_sanity ();
  86 }
  87
  88 Direction
  89 Slur::get_default_dir (Score_element*me)
  90 {
  91   Link_array<Score_element> encompass_arr =
  92     Pointer_group_interface__extract_elements (me, (Score_element*)0, "note-columns");
  93
  94   Direction d = DOWN;
  95   for (int i=0; i < encompass_arr.size (); i ++)
  96     {
  97       if (Note_column::dir (encompass_arr[i]) < 0)
  98         {
  99           d = UP;
 100           break;
 101         }
 102     }
 103   return d;
 104 }
 105
 106
 107
 108
 109
 110 Offset
 111 Slur::encompass_offset (Score_element*me,
 112                         Score_element* col,
 113                         Score_element **common)
 114 {
 115   Offset o;
 116   Score_element* stem_l = unsmob_element (col->get_elt_property ("stem"));
 117
 118   Direction dir = Directional_element_interface (me).get ();
 119
 120   if (!stem_l)
 121     {
 122       warning (_ ("Slur over rest?"));
 123       o[X_AXIS] = col->relative_coordinate (common[X_AXIS], X_AXIS);
 124       o[Y_AXIS] = col->relative_coordinate (common[Y_AXIS], Y_AXIS);
 125       return o;
 126     }
 127   Direction stem_dir = Directional_element_interface (stem_l).get ();
 128   o[X_AXIS] = stem_l->relative_coordinate (0, X_AXIS);
 129
 130   /*
 131     Simply set x to middle of notehead
 132    */
 133
 134   o[X_AXIS] -= 0.5 * stem_dir * col->extent (X_AXIS).length ();
 135
 136   if ((stem_dir == dir)
 137       && !stem_l->extent (Y_AXIS).empty_b ())
 138     {
 139       o[Y_AXIS] = stem_l->relative_coordinate (common[Y_AXIS], Y_AXIS); // iuhg
 140       o[Y_AXIS] += stem_l->extent (Y_AXIS)[dir];
 141     }
 142   else
 143     {
 144       o[Y_AXIS] = col->relative_coordinate (common[Y_AXIS], Y_AXIS);    // ugh
 145       o[Y_AXIS] += col->extent (Y_AXIS)[dir];
 146     }
 147
 148   /*
 149    leave a gap: slur mustn't touch head/stem
 150    */
 151   o[Y_AXIS] += dir * me->paper_l ()->get_var ("slur_y_free");
 152   return o;
 153 }
 154
 155 MAKE_SCHEME_CALLBACK (Slur, after_line_breaking);
 156 SCM
 157 Slur::after_line_breaking (SCM smob)
 158 {
 159   Score_element *me = unsmob_element (smob);
 160   if (!gh_scm2int(scm_length (me->get_elt_property ("note-columns"))))
 161     {
 162       me->suicide ();
 163       return SCM_UNSPECIFIED;
 164     }
 165   set_extremities (me);
 166   set_control_points (me);
 167   return SCM_UNSPECIFIED;
 168 }
 169
 170 void
 171 Slur::set_extremities (Score_element*me)
 172 {
 173   if (!Directional_element_interface (me).get ())
 174     Directional_element_interface (me).set (get_default_dir (me));
 175
 176   Direction dir = LEFT;
 177   do
 178     {
 179       if (!gh_symbol_p (index_cell (me->get_elt_property ("attachment"), dir)))
 180         {
 181
 182           // for (SCM s = get_elt_property ("slur-extremity-rules"); s != SCM_EOL; s = gh_cdr (s))
 183           for (SCM s = scm_eval (ly_symbol2scm ("slur-extremity-rules"));
 184                s != SCM_EOL; s = gh_cdr (s))
 185             {
 186               SCM r = gh_call2 (gh_caar (s), me->self_scm (),
 187                                  gh_int2scm ((int)dir));
 188               if (r != SCM_BOOL_F)
 189                 {
 190                   index_set_cell (me->get_elt_property ("attachment"), dir,
 191                                   gh_cdar (s));
 192                   break;
 193                 }
 194             }
 195         }
 196     }
 197   while (flip (&dir) != LEFT);
 198 }
 199
 200 Offset
 201 Slur::get_attachment (Score_element*me,Direction dir,
 202                       Score_element **common)
 203 {
 204   Spanner*sp = dynamic_cast<Spanner*>(me);
 205   SCM s = me->get_elt_property ("attachment");
 206   SCM a = dir == LEFT ? gh_car (s) : gh_cdr (s);
 207   String str = ly_symbol2string (a);
 208   Real ss = Staff_symbol_referencer::staff_space ((Score_element*)me);
 209   Real hs = ss / 2.0;
 210   Offset o;
 211
 212   Score_element *stem = 0;
 213   if (Note_column::has_interface (sp->get_bound (dir)))
 214     {
 215       Score_element * n =sp->get_bound (dir);
 216       if (Score_element *stem = Note_column::stem_l (n))
 217         {
 218
 219           if (str == "head")
 220             {
 221               o = Offset (0, Stem::chord_start_f (stem));
 222               /*
 223                 Default position is centered in X, on outer side of head Y
 224                */
 225               o += Offset (0.5 * n->extent (X_AXIS).length (),
 226                            0.5 * ss * Directional_element_interface (me).get ());
 227             }
 228           else if (str == "alongside-stem")
 229             {
 230               o = Offset (0, Stem::chord_start_f (stem));
 231               /*
 232                 Default position is on stem X, on outer side of head Y
 233                */
 234               o += Offset (n->extent (X_AXIS).length ()
 235                            * (1 + Stem::get_direction (stem)),
 236                            0.5 * ss * Directional_element_interface (me).get ());
 237             }
 238           else if (str == "stem")
 239             {
 240               o = Offset (0, Stem::stem_end_position (stem) * hs);
 241               /*
 242                 Default position is on stem X, at stem end Y
 243                */
 244               o += Offset (0.5 *
 245                            (n->extent (X_AXIS).length ()
 246                             - stem->extent (X_AXIS).length ())
 247                             * (1 + Stem::get_direction (stem)),
 248                             0);
 249             }
 250         }
 251     }
 252   else if (str == "loose-end")
 253     {
 254       SCM other_a = dir == LEFT ? gh_cdr (s) : gh_car (s);
 255       if (ly_symbol2string (other_a) != "loose-end")
 256         {
 257           o = Offset (0, get_attachment (me, -dir, common)[Y_AXIS]);
 258         }
 259     }
 260
 261   SCM l = scm_assoc
 262     (scm_listify (a,
 263                   gh_int2scm (stem ? Stem::get_direction (stem) : 1 * dir),
 264                   gh_int2scm (Directional_element_interface (me).get () * dir),
 265                   SCM_UNDEFINED),
 266      scm_eval (ly_symbol2scm ("slur-extremity-offset-alist")));
 267
 268   if (l != SCM_BOOL_F)
 269     {
 270       o += ly_scm2offset (gh_cdr (l)) * ss * dir;
 271     }
 272
 273   /*
 274     What if get_bound () is not a note-column?
 275    */
 276   if (str != "loose-end"
 277       && sp->get_bound (dir)->common_refpoint (common[Y_AXIS], Y_AXIS) == common[Y_AXIS])
 278     {
 279       o[Y_AXIS] += sp->get_bound (dir)->relative_coordinate (common[Y_AXIS], Y_AXIS)
 280         - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
 281     }
 282
 283   return o;
 284 }
 285
 286 Array<Offset>
 287 Slur::get_encompass_offset_arr (Score_element*me)
 288 {
 289   Spanner*sp = dynamic_cast<Spanner*>(me);
 290   SCM eltlist = me->get_elt_property ("note-columns");
 291   Score_element *common[] = {me->common_refpoint (eltlist,X_AXIS),
 292                              me->common_refpoint (eltlist,Y_AXIS)};
 293
 294
 295   common[X_AXIS] = common[X_AXIS]->common_refpoint (sp->get_bound (RIGHT), X_AXIS);
 296   common[X_AXIS] = common[X_AXIS]->common_refpoint (sp->get_bound (LEFT), X_AXIS);
 297
 298   Link_array<Score_element>  encompass_arr;
 299   while (gh_pair_p (eltlist))
 300     {
 301       encompass_arr.push (unsmob_element (gh_car (eltlist)));
 302       eltlist =gh_cdr (eltlist);
 303     }
 304   encompass_arr.reverse ();
 305
 306
 307   Array<Offset> offset_arr;
 308
 309   Offset origin (me->relative_coordinate (common[X_AXIS], X_AXIS),
 310                  me->relative_coordinate (common[Y_AXIS], Y_AXIS));
 311
 312   int first = 1;
 313   int last = encompass_arr.size () - 2;
 314
 315   offset_arr.push (get_attachment (me, LEFT, common));
 316
 317   /*
 318     left is broken edge
 319   */
 320
 321   if (encompass_arr[0] != sp->get_bound (LEFT))
 322     {
 323       first--;
 324
 325       // ?
 326       offset_arr[0][Y_AXIS] -=
 327         encompass_arr[0]->relative_coordinate (common[Y_AXIS], Y_AXIS)
 328         - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
 329     }
 330
 331   /*
 332     right is broken edge
 333   */
 334   if (encompass_arr.top () != sp->get_bound (RIGHT))
 335     {
 336       last++;
 337     }
 338
 339   for (int i = first; i <= last; i++)
 340     {
 341       Offset o (encompass_offset (me, encompass_arr[i], common));
 342       offset_arr.push (o - origin);
 343     }
 344
 345   offset_arr.push (Offset (sp->spanner_length (), 0) + get_attachment (me, RIGHT,common));
 346
 347   if (encompass_arr[0] != sp->get_bound (LEFT))
 348     {
 349       offset_arr.top ()[Y_AXIS] -= encompass_arr.top ()->relative_coordinate (common[Y_AXIS], Y_AXIS)
 350         - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
 351     }
 352
 353   return offset_arr;
 354 }
 355
 356
 357 MAKE_SCHEME_CALLBACK(Slur,set_spacing_rods);
 358 SCM
 359 Slur::set_spacing_rods (SCM smob)
 360 {
 361   Score_element*me = unsmob_element (smob);
 362
 363   Rod r;
 364   Spanner*sp = dynamic_cast<Spanner*>(me);
 365   r.item_l_drul_[LEFT] = sp->get_bound (LEFT);
 366   r.item_l_drul_[RIGHT] = sp->get_bound (RIGHT);
 367   r.distance_f_ =
 368     gh_scm2double (me->get_elt_property ("minimum-length"))
 369     * me->paper_l ()->get_var ("staffspace");
 370
 371   r.add_to_cols ();
 372   return SCM_UNSPECIFIED;
 373 }
 374
 375
 376 /*
 377   Ugh should have dash-length + dash-period
 378  */
 379 MAKE_SCHEME_CALLBACK (Slur, brew_molecule);
 380 SCM
 381 Slur::brew_molecule (SCM smob)
 382 {
 383   Score_element * me = unsmob_element (smob);
 384   if (!gh_scm2int(scm_length (me->get_elt_property ("note-columns"))))
 385     {
 386       me->suicide ();
 387       return SCM_EOL;
 388     }
 389
 390   Real thick = me->paper_l ()->get_var ("stafflinethickness") *
 391     gh_scm2double (me->get_elt_property ("thickness"));
 392   Bezier one = get_curve (me);
 393
 394   Molecule a;
 395   SCM d =  me->get_elt_property ("dashed");
 396   if (gh_number_p (d))
 397     a = me->lookup_l ()->dashed_slur (one, thick, thick * gh_scm2double (d));
 398   else
 399     a = me->lookup_l ()->slur (one, Directional_element_interface (me).get () * thick, thick);
 400
 401   return a.create_scheme();
 402 }
 403
 404 void
 405 Slur::set_control_points (Score_element*me)
 406 {
 407   Real staff_space = Staff_symbol_referencer::staff_space ((Score_element*)me);
 408   Real h_inf = me->paper_l ()->get_var ("slur_height_limit_factor") *
 409     staff_space;
 410   Real r_0 = me->paper_l ()->get_var ("slur_ratio");
 411
 412   Slur_bezier_bow bb (get_encompass_offset_arr (me),
 413                       Directional_element_interface (me).get (),
 414                       h_inf, r_0);
 415
 416   if (bb.fit_factor () > 1.0)
 417     {
 418       Real length = bb.curve_.control_[3][X_AXIS];
 419       Real default_height = slur_height (length, h_inf, r_0);
 420       bb.minimise_enclosed_area (me->paper_l());
 421
 422       Real bff = me->paper_l ()->get_var ("slur_force_blowfit");
 423       bb.curve_.control_[1][Y_AXIS] *= bff;
 424       bb.curve_.control_[2][Y_AXIS] *= bff;
 425       bb.blow_fit ();
 426
 427       Real sb = me->paper_l ()->get_var ("slur_beautiful");
 428       Real beautiful = length * default_height * sb;
 429       Real area = bb.enclosed_area_f ();
 430
 431       /*
 432         Slurs that fit beautifully are not ugly
 433       */
 434       if (area > beautiful)
 435         de_uglyfy (me, &bb, default_height);
 436     }
 437
 438   Bezier b = bb.get_bezier ();
 439
 440
 441   SCM controls = SCM_EOL;
 442   for (int i= 4; i--;)
 443     {
 444       controls = gh_cons ( ly_offset2scm (b.control_[i]), controls);
 445       /*
 446         BRRR WHURG.
 447         All these null control-points, where do they all come from?
 448       */
 449       if (i && b.control_[i][X_AXIS] == 0)
 450         me->suicide ();
 451     }
 452
 453   me->set_elt_property ("control-points", controls);
 454 }
 455
 456 Bezier
 457 Slur::get_curve (Score_element*me)
 458 {
 459   Bezier b;
 460   int i = 0;
 461
 462   if (!Directional_element_interface (me).get ()
 463       || ! gh_symbol_p (index_cell (me->get_elt_property ("attachment"), LEFT)))
 464     set_extremities (me);
 465
 466   if (!gh_pair_p (me->get_elt_property ("control-points")))
 467     set_control_points (me);
 468
 469   for (SCM s= me->get_elt_property ("control-points"); s != SCM_EOL; s = gh_cdr (s))
 470     {
 471       b.control_[i] = ly_scm2offset (gh_car (s));
 472       i++;
 473     }
 474
 475   Array<Offset> enc (get_encompass_offset_arr (me));
 476   Direction dir = Directional_element_interface (me).get ();
 477
 478   Real x1 = enc[0][X_AXIS];
 479   Real x2 = enc.top ()[X_AXIS];
 480
 481   Real off = 0.0;
 482   for (int i=1; i < enc.size ()-1; i++)
 483     {
 484       Real x = enc[i][X_AXIS];
 485       if (x > x1 && x <x2)
 486         {
 487           Real y = b.get_other_coordinate (X_AXIS, x);
 488           off = off >? dir *  (enc[i][Y_AXIS] - y);
 489         }
 490     }
 491   b.translate (Offset (0, dir * off));
 492   return b;
 493 }
 494
 495
 496 bool
 497 Slur::has_interface (Score_element*me)
 498 {
 499   return me->has_interface (ly_symbol2scm ("slur-interface"));
 500 }
 501
 502