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