lily/slur.cc

   1 /*
   2   slur.cc -- implement  Slur
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1996,  1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7     Jan Nieuwenhuizen <janneke@gnu.org>
   8 */
   9
  10 /*
  11   [TODO]
  12     * begin and end should be treated as a/acknowledge Scripts.
  13     * broken slur should have uniform trend
  14  */
  15
  16 #include "group-interface.hh"
  17 #include "slur.hh"
  18 #include "lookup.hh"
  19 #include "paper-def.hh"
  20 #include "note-column.hh"
  21 #include "stem.hh"
  22 #include "paper-column.hh"
  23 #include "molecule.hh"
  24 #include "debug.hh"
  25 #include "box.hh"
  26 #include "bezier.hh"
  27 #include "main.hh"
  28 #include "cross-staff.hh"
  29 #include "group-interface.hh"
  30
  31 Slur::Slur ()
  32 {
  33   set_elt_property ("note-columns", SCM_EOL);
  34 }
  35
  36 void
  37 Slur::add_column (Note_column*n)
  38 {
  39   if (!gh_pair_p (n->get_elt_property ("note-heads")))
  40     warning (_ ("Putting slur over rest.  Ignoring."));
  41   else
  42     {
  43       Group_interface gi (this, "note-columns");
  44       gi.add_element (n);
  45       add_dependency (n);
  46     }
  47 }
  48
  49 Direction
  50 Slur::get_default_dir () const
  51 {
  52   Link_array<Note_column> encompass_arr =
  53     Group_interface__extract_elements (this, (Note_column*)0, "note-columns");
  54
  55   Direction d = DOWN;
  56   for (int i=0; i < encompass_arr.size (); i ++)
  57     {
  58       if (encompass_arr[i]->dir () < 0)
  59         {
  60           d = UP;
  61           break;
  62         }
  63     }
  64   return d;
  65 }
  66
  67 void
  68 Slur::do_add_processing ()
  69 {
  70   Link_array<Note_column> encompass_arr =
  71     Group_interface__extract_elements (this, (Note_column*)0, "note-columns");
  72   set_bounds (LEFT, encompass_arr[0]);
  73   if (encompass_arr.size () > 1)
  74     set_bounds (RIGHT, encompass_arr.top ());
  75 }
  76
  77 void
  78 Slur::do_pre_processing ()
  79 {
  80   // don't set directions
  81 }
  82
  83
  84 static int
  85 Note_column_compare (Note_column *const&n1 , Note_column* const&n2)
  86 {
  87   return Item::left_right_compare (n1, n2);
  88 }
  89
  90
  91 Offset
  92 Slur::encompass_offset (Note_column const* col) const
  93 {
  94   Offset o;
  95   Stem* stem_l = col->stem_l ();
  96   if (!stem_l)
  97     {
  98       warning (_ ("Slur over rest?"));
  99       o[X_AXIS] = col->hpos_f ();
 100       o[Y_AXIS] = col->extent (Y_AXIS)[get_direction ()];
 101       return o;
 102     }
 103
 104   o[X_AXIS] = stem_l->hpos_f ();
 105
 106   /*
 107     Simply set x to middle of notehead
 108    */
 109
 110   o[X_AXIS] -= 0.5 * stem_l->get_direction () * col->extent (X_AXIS).length ();
 111
 112   if ((stem_l->get_direction () == get_direction ())
 113       && !stem_l->extent (Y_AXIS).empty_b ())
 114     {
 115       o[Y_AXIS] = stem_l->extent (Y_AXIS)[get_direction ()];
 116     }
 117   else
 118     {
 119       o[Y_AXIS] = col->extent (Y_AXIS)[get_direction ()];
 120     }
 121
 122   /*
 123    leave a gap: slur mustn't touch head/stem
 124    */
 125   o[Y_AXIS] += get_direction () * paper_l ()->get_var ("slur_y_free");
 126   o[Y_AXIS] += calc_interstaff_dist (stem_l, this);
 127   return o;
 128 }
 129
 130 /*
 131   ARGRARGRARGRARGAR!
 132
 133   Fixme
 134  */
 135 void
 136 Slur::do_post_processing ()
 137 {
 138     Link_array<Note_column> encompass_arr =
 139     Group_interface__extract_elements (this, (Note_column*)0, "note-columns");
 140
 141   encompass_arr.sort (Note_column_compare);
 142   if (!get_direction ())
 143     set_direction (get_default_dir ());
 144
 145   /*
 146    Slur and tie placement [OSU]
 147
 148    Slurs:
 149    * x = centre of head - d * x_gap_f
 150
 151    TODO:
 152    * y = length < 5ss : horizontal tangent + d * 0.25 ss
 153      y = length >= 5ss : y next interline - d * 0.25 ss
 154    */
 155
 156   Real interline_f = paper_l ()->get_var ("interline");
 157   Real internote_f = interline_f / 2;
 158
 159   Real x_gap_f = paper_l ()->get_var ("slur_x_gap");
 160   Real y_gap_f = paper_l ()->get_var ("slur_y_gap");
 161
 162   Drul_array<Note_column*> note_column_drul;
 163   note_column_drul[LEFT] = encompass_arr[0];
 164   note_column_drul[RIGHT] = encompass_arr.top ();
 165
 166   bool fix_broken_b = false;
 167   Direction d = LEFT;
 168   do
 169     {
 170       dx_f_drul_[d] = 0;
 171       dy_f_drul_[d] = 0;
 172
 173       if ((note_column_drul[d] == spanned_drul_[d])
 174           && note_column_drul[d]->first_head ()
 175           && (note_column_drul[d]->stem_l ()))
 176         {
 177           Stem* stem_l = note_column_drul[d]->stem_l ();
 178           /*
 179             side directly attached to note head;
 180             no beam getting in the way
 181           */
 182           if ((stem_l->extent (Y_AXIS).empty_b ()
 183                || !((stem_l->get_direction () == get_direction ()) && (get_direction () != d)))
 184               && !((get_direction () == stem_l->get_direction ())
 185                    && stem_l->beam_l () && (stem_l->beam_count (-d) >= 1)))
 186             {
 187               dx_f_drul_[d] = spanned_drul_[d]->extent (X_AXIS).length () / 2;
 188               dx_f_drul_[d] -= d * x_gap_f;
 189
 190               if (stem_l->get_direction () != get_direction ())
 191                 {
 192                   dy_f_drul_[d] = note_column_drul[d]->extent (Y_AXIS)[get_direction ()];
 193                 }
 194               else
 195                 {
 196                   dy_f_drul_[d] = stem_l->chord_start_f ()
 197                     + get_direction () * internote_f;
 198                 }
 199               dy_f_drul_[d] += get_direction () * y_gap_f;
 200             }
 201           /*
 202             side attached to (visible) stem
 203           */
 204           else
 205             {
 206               dx_f_drul_[d] = stem_l->hpos_f ()
 207                 - spanned_drul_[d]->relative_coordinate (0, X_AXIS);
 208               /*
 209                 side attached to beamed stem
 210                */
 211               if (stem_l->beam_l () && (stem_l->beam_count (-d) >= 1))
 212                 {
 213                   dy_f_drul_[d] = stem_l->extent (Y_AXIS)[get_direction ()];
 214                   dy_f_drul_[d] += get_direction () * 2 * y_gap_f;
 215                 }
 216               /*
 217                 side attached to notehead, with stem getting in the way
 218                */
 219               else
 220                 {
 221                   dx_f_drul_[d] -= d * x_gap_f;
 222
 223                   dy_f_drul_[d] = stem_l->chord_start_f ()
 224                     + get_direction () * internote_f;
 225                   dy_f_drul_[d] += get_direction () * y_gap_f;
 226                 }
 227             }
 228         }
 229       /*
 230         loose end
 231       */
 232       else
 233         {
 234           dx_f_drul_[d] = get_broken_left_end_align ();
 235
 236           /*
 237             broken: should get y from other piece, so that slur
 238             continues up/down trend
 239
 240             for now: be horizontal..
 241           */
 242           fix_broken_b = true;
 243         }
 244     }
 245   while (flip (&d) != LEFT);
 246
 247   int cross_count =  cross_staff_count ();
 248   bool interstaff_b = (0 < cross_count) && (cross_count < encompass_arr.size ());
 249
 250   Drul_array<Offset> info_drul;
 251   Drul_array<Real> interstaff_interval;
 252
 253   do
 254     {
 255       info_drul[d] = encompass_offset (encompass_arr.boundary (d, 0));
 256       interstaff_interval[d] = calc_interstaff_dist (encompass_arr.boundary (d,0),
 257                                                      this);
 258     }
 259   while (flip (&d) != LEFT);
 260
 261   Real interstaff_f = interstaff_interval[RIGHT] - interstaff_interval[LEFT];
 262
 263   if (fix_broken_b)
 264     {
 265       Direction d = (encompass_arr.top () != spanned_drul_[RIGHT]) ?
 266         RIGHT : LEFT;
 267       dy_f_drul_[d] = info_drul[d][Y_AXIS];
 268       if (!interstaff_b)
 269         {
 270           dy_f_drul_[d] -= interstaff_interval[d];
 271           if (cross_count)      // interstaff_i  ?
 272             {
 273               dy_f_drul_[LEFT] += interstaff_interval[d];
 274               dy_f_drul_[RIGHT] += interstaff_interval[d];
 275             }
 276         }
 277     }
 278
 279
 280   /*
 281     Now we've got a fine slur
 282     Catch and correct some ugly cases
 283    */
 284   String infix = interstaff_b ? "interstaff_" : "";
 285   Real height_damp_f = paper_l ()->get_var ("slur_"+infix +"height_damping");
 286   Real slope_damp_f = paper_l ()->get_var ("slur_"+infix +"slope_damping");
 287   Real snap_f = paper_l ()->get_var ("slur_"+infix +"snap_to_stem");
 288   Real snap_max_dy_f = paper_l ()->get_var ("slur_"+infix +"snap_max_slope_change");
 289
 290   if (!fix_broken_b)
 291     dy_f_drul_[RIGHT] += interstaff_f;
 292
 293   Real dy_f = dy_f_drul_[RIGHT] - dy_f_drul_[LEFT];
 294   if (!fix_broken_b)
 295     dy_f -= interstaff_f;
 296   Real dx_f = spanner_length ()+ dx_f_drul_[RIGHT] - dx_f_drul_[LEFT];
 297
 298   /*
 299     Avoid too steep slurs.
 300    */
 301   Real slope_ratio_f = abs (dy_f / dx_f);
 302   if (slope_ratio_f > slope_damp_f)
 303     {
 304       Direction d = (Direction)(- get_direction () * (sign (dy_f)));
 305       if (!d)
 306         d = LEFT;
 307       Real damp_f = (slope_ratio_f - slope_damp_f) * dx_f;
 308       /*
 309         must never change sign of dy
 310        */
 311       damp_f = damp_f <? abs (dy_f);
 312       dy_f_drul_[d] += get_direction () * damp_f;
 313     }
 314
 315   /*
 316    Avoid too high slurs
 317
 318    Wierd slurs may look a lot better after they have been
 319    adjusted a bit.
 320    So, we'll do this in 3 steps
 321    */
 322   for (int i = 0; i < 3; i++)
 323     {
 324       Real height_f = curve_extent (Y_AXIS).length ();
 325       Real width_f = curve_extent (X_AXIS).length ();
 326
 327       dy_f = dy_f_drul_[RIGHT] - dy_f_drul_[LEFT];
 328       if (!fix_broken_b)
 329         dy_f -= interstaff_f;
 330
 331       Real height_ratio_f = abs (height_f / width_f);
 332       if (height_ratio_f > height_damp_f)
 333         {
 334           Direction d = (Direction)(- get_direction () * (sign (dy_f)));
 335           if (!d)
 336             d = LEFT;
 337           /* take third step */
 338           Real damp_f = (height_ratio_f - height_damp_f) * width_f / 3;
 339           /*
 340             if y positions at about the same height, correct both ends
 341           */
 342           if (abs (dy_f / dx_f ) < slope_damp_f)
 343             {
 344               dy_f_drul_[-d] += get_direction () * damp_f;
 345               dy_f_drul_[d] += get_direction () * damp_f;
 346             }
 347           /*
 348             don't change slope too much, would have been catched by slope damping
 349           */
 350           else
 351             {
 352               damp_f = damp_f <? abs (dy_f/2);
 353               dy_f_drul_[d] += get_direction () * damp_f;
 354             }
 355         }
 356     }
 357
 358   /*
 359     If, after correcting, we're close to stem-end...
 360   */
 361   Drul_array<Real> snapy_f_drul;
 362   snapy_f_drul[LEFT] = snapy_f_drul[RIGHT] = 0;
 363   Drul_array<Real> snapx_f_drul;
 364   snapx_f_drul[LEFT] = snapx_f_drul[RIGHT] = 0;
 365   Drul_array<bool> snapped_b_drul;
 366   snapped_b_drul[LEFT] = snapped_b_drul[RIGHT] = false;
 367   do
 368     {
 369       Note_column * nc = note_column_drul[d];
 370       if (nc == spanned_drul_[d]
 371           && nc->stem_l ()
 372           && nc->stem_l ()->get_direction () == get_direction ()
 373           && abs (nc->stem_l ()->extent (Y_AXIS)[get_direction ()]
 374                   - dy_f_drul_[d] + (d == LEFT ? 0 : interstaff_f))
 375               <= snap_f)
 376         {
 377           /*
 378             prepare to attach to stem-end
 379           */
 380           snapx_f_drul[d] = nc->stem_l ()->hpos_f ()
 381             - spanned_drul_[d]->relative_coordinate (0, X_AXIS);
 382
 383           snapy_f_drul[d] = nc->stem_l ()->extent (Y_AXIS)[get_direction ()]
 384             + interstaff_interval[d]
 385             + get_direction () * 2 * y_gap_f;
 386
 387           snapped_b_drul[d] = true;
 388         }
 389     }
 390   while (flip (&d) != LEFT);
 391
 392   /*
 393     only use snapped positions if sign (dy) will not change
 394     and dy doesn't change too much
 395     */
 396   if (!fix_broken_b)
 397     dy_f += interstaff_f;
 398
 399
 400   /*
 401     (sigh)
 402
 403     More refactoring could be done.
 404    */
 405   Real maxsnap = abs (dy_f * snap_max_dy_f);
 406   if (snapped_b_drul[LEFT] && snapped_b_drul[RIGHT]
 407       && ((sign (snapy_f_drul[RIGHT] - snapy_f_drul[LEFT]) == sign (dy_f)))
 408       && (!dy_f || (abs (snapy_f_drul[RIGHT] - snapy_f_drul[LEFT] - dy_f)
 409                     < maxsnap)))
 410     {
 411       dy_f_drul_ = snapy_f_drul;
 412       dx_f_drul_ = snapx_f_drul;
 413     }
 414   else
 415     do
 416       {
 417         Direction od = (Direction)-d;
 418         if (snapped_b_drul[d]
 419             && d * sign (snapy_f_drul[d] - dy_f_drul_[od]) == sign (dy_f)
 420             && (!dy_f || (abs (snapy_f_drul[d] - dy_f_drul_[od]  - d * dy_f)
 421                           < maxsnap)))
 422           {
 423             dy_f_drul_[d] = snapy_f_drul[d];
 424             dx_f_drul_[d] = snapx_f_drul[d];
 425           }
 426       }
 427     while (flip (&d) != LEFT);
 428 }
 429
 430
 431 int
 432 Slur::cross_staff_count ()const
 433 {
 434   Link_array<Note_column> encompass_arr =
 435     Group_interface__extract_elements (this, (Note_column*)0, "note-columns");
 436
 437   int k=0;
 438
 439   for (int i = 0; i < encompass_arr.size (); i++)
 440     {
 441       if (calc_interstaff_dist (encompass_arr[i], this))
 442         k++;
 443     }
 444   return k;
 445 }
 446
 447
 448 Array<Offset>
 449 Slur::get_encompass_offset_arr () const
 450 {
 451   Link_array<Note_column> encompass_arr =
 452     Group_interface__extract_elements (this, (Note_column*)0, "note-columns");
 453
 454   Array<Offset> offset_arr;
 455 #if 0
 456   /*
 457     check non-disturbed slur
 458     FIXME: x of ends off by a tiny bit!!
 459   */
 460   offset_arr.push (Offset (0, dy_f_drul_[LEFT]));
 461   offset_arr.push (Offset (0, dy_f_drul_[RIGHT]));
 462   return offset_arr;
 463 #endif
 464
 465   Offset origin (relative_coordinate (0, X_AXIS), 0);
 466
 467   int first = 1;
 468   int last = encompass_arr.size () - 2;
 469
 470   offset_arr.push (Offset (dx_f_drul_[LEFT], dy_f_drul_[LEFT]));
 471
 472   /*
 473     left is broken edge
 474   */
 475
 476   int cross_count  = cross_staff_count ();
 477   bool cross_b = cross_count && cross_count < encompass_arr.size ();
 478   if (encompass_arr[0] != spanned_drul_[LEFT])
 479     {
 480       first--;
 481       Real is   = calc_interstaff_dist (encompass_arr[0], this);
 482       if (cross_b)
 483         offset_arr[0][Y_AXIS] += is;
 484     }
 485
 486   /*
 487     right is broken edge
 488   */
 489   if (encompass_arr.top () != spanned_drul_[RIGHT])
 490     {
 491       last++;
 492     }
 493
 494   for (int i = first; i <= last; i++)
 495     {
 496       Offset o (encompass_offset (encompass_arr[i]));
 497       offset_arr.push (o - origin);
 498     }
 499
 500   offset_arr.push (Offset (spanner_length ()+  dx_f_drul_[RIGHT],
 501                            dy_f_drul_[RIGHT]));
 502
 503   return offset_arr;
 504 }
 505
 506
 507 Array<Rod>
 508 Slur::get_rods () const
 509 {
 510   Array<Rod> a;
 511   Rod r;
 512   r.item_l_drul_ = spanned_drul_;
 513   r.distance_f_ = paper_l ()->get_var ("slur_x_minimum");
 514
 515   a.push (r);
 516   return a;
 517 }
 518
 519