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     * begin and end should be treated as a/acknowledge Scripts.
  13     * broken slur should have uniform trend
  14  */
  15
  16 #include "directional-element-interface.hh"
  17 #include "group-interface.hh"
  18 #include "slur.hh"
  19 #include "lookup.hh"
  20 #include "paper-def.hh"
  21 #include "note-column.hh"
  22 #include "stem.hh"
  23 #include "paper-column.hh"
  24 #include "molecule.hh"
  25 #include "debug.hh"
  26 #include "box.hh"
  27 #include "bezier-bow.hh"
  28 #include "main.hh"
  29 #include "cross-staff.hh"
  30 #include "group-interface.hh"
  31 #include "staff-symbol-referencer.hh"
  32
  33
  34
  35 class Slur_bezier_bow : public Bezier_bow
  36 {
  37 public:
  38   Slur_bezier_bow (Array<Offset> encompass, Direction dir);
  39   Array<Real> area_x_gradients_array (Real area);
  40   void blow_fit ();
  41   Real enclosed_area_f () const;
  42   Real fit_factor () const;
  43   void minimise_enclosed_area (Paper_def* paper_l, Real default_height);
  44 };
  45
  46 Slur_bezier_bow::Slur_bezier_bow (Array<Offset> encompass, Direction dir)
  47   : Bezier_bow (encompass, dir)
  48 {
  49 }
  50
  51 void
  52 Slur_bezier_bow::blow_fit ()
  53 {
  54   Real len = curve_.control_[3][X_AXIS];
  55   Real h = curve_.control_[1][Y_AXIS] * fit_factor () / len;
  56   curve_.control_[1][Y_AXIS] = h * len;
  57   curve_.control_[2][Y_AXIS] = h * len;
  58   curve_.assert_sanity ();
  59 }
  60
  61
  62 Real
  63 Slur_bezier_bow::enclosed_area_f () const
  64 {
  65   Real a = 0;
  66   for (int i=0; i < encompass_.size (); i++)
  67     {
  68       Interval x;
  69       Interval y;
  70       if (i == 0)
  71         {
  72           x = Interval (0, encompass_[1][X_AXIS] / 2);
  73           y = Interval (0,
  74                         curve_.get_other_coordinate (X_AXIS,
  75                                                      encompass_[1][X_AXIS]
  76                                                      / 2));
  77         }
  78       else if (i == encompass_.size () - 1)
  79         {
  80           x = Interval ((encompass_[i-1][X_AXIS] + encompass_[i][X_AXIS])/2,
  81                         encompass_[i][X_AXIS]);
  82           y = Interval (0,
  83                         (curve_.get_other_coordinate (X_AXIS,
  84                                                       (x[MIN] + x[MAX]) / 2)));
  85         }
  86       else
  87         {
  88           x = Interval ((encompass_[i-1][X_AXIS] + encompass_[i][X_AXIS]) / 2,
  89                         (encompass_[i][X_AXIS] + encompass_[i+1][X_AXIS]) / 2);
  90           y = Interval (encompass_[i][Y_AXIS],
  91                         (curve_.get_other_coordinate (X_AXIS, x[MIN])
  92                          + curve_.get_other_coordinate (X_AXIS,
  93                                                         (x[MIN] + x[MAX]) / 2)
  94                          + curve_.get_other_coordinate (X_AXIS, x[MAX])) / 3);
  95         }
  96
  97       Real da = x.length () * y.length ();
  98       a += da;
  99     }
 100   return a;
 101 }
 102
 103 Array<Real>
 104 Slur_bezier_bow::area_x_gradients_array (Real area)
 105 {
 106   Real len = curve_.control_[3][X_AXIS];
 107   Real grow = len / 10.0;
 108   Array<Real> da (2);
 109   for (int i=0; i < 2; i++)
 110     {
 111       Real r = curve_.control_[i+1][X_AXIS];
 112       curve_.control_[i+1][X_AXIS] += grow;
 113       da[i] = (enclosed_area_f () - area) / grow;
 114       curve_.control_[i+1][X_AXIS] = r;
 115     }
 116   return da;
 117 }
 118
 119 void
 120 Slur_bezier_bow::minimise_enclosed_area (Paper_def* paper_l,
 121                                          Real default_height)
 122 {
 123   Real length = curve_.control_[3][X_AXIS];
 124   Real sb = paper_l->get_var ("slur_beautiful");
 125   Real beautiful = length * default_height * sb;
 126
 127   DEBUG_OUT << to_str ("Beautiful: %f\n", beautiful);
 128   DEBUG_OUT << to_str ("Length: %f\n", length);
 129   DEBUG_OUT << to_str ("D-height: %f\n", default_height);
 130   DEBUG_OUT << to_str ("FitFac: %f\n", fit_factor ());
 131
 132   if (fit_factor () > 1.0)
 133     blow_fit ();
 134
 135   Real pct_c0 = paper_l->get_var ("bezier_pct_c0");
 136   Real pct_c3 = paper_l->get_var ("bezier_pct_c3");
 137   Real pct_in_max = paper_l->get_var ("bezier_pct_in_max");
 138   Real pct_out_max = paper_l->get_var ("bezier_pct_out_max");
 139   Real steps = paper_l->get_var ("bezier_area_steps");
 140
 141   for (int i=0; i < steps; i++)
 142     {
 143       Real area = enclosed_area_f ();
 144       if (!i)
 145         DEBUG_OUT << to_str ("Init area: %f\n", area);
 146
 147       if (area <= beautiful)
 148         break;
 149
 150       Array<Real> da = area_x_gradients_array (area);
 151
 152       // urg
 153       Real pct = pct_c0 + pct_c3 * length * length * length;
 154       pct *= (steps - i) / steps;
 155       if (da[0] > 0 || da[1] < 0)
 156         pct = pct <? pct_out_max;
 157       else
 158         pct = pct <? pct_in_max;
 159
 160       Real u = (abs (curve_.control_[1][X_AXIS] / da[0])
 161                 <? abs ((curve_.control_[3][X_AXIS]
 162                          - curve_.control_[2][X_AXIS]) / da[1]));
 163
 164       DEBUG_OUT << to_str ("pct: %f\n", pct);
 165       DEBUG_OUT << to_str ("u: %f\n", u);
 166
 167       DEBUG_OUT << to_str ("da: (%f, %f)\n", da[0], da[1]);
 168       DEBUG_OUT << to_str ("da*u: (%f, %f)\n", da[0]*u*pct, da[1]*u*pct);
 169       DEBUG_OUT << to_str ("cx: (%f, %f)\n", curve_.control_[1][X_AXIS],
 170                            curve_.control_[2][X_AXIS]);
 171
 172       curve_.control_[1][X_AXIS] -= da[0] * u * pct;
 173       curve_.control_[2][X_AXIS] -= da[1] * u * pct;
 174     }
 175
 176   Real area = enclosed_area_f ();
 177   DEBUG_OUT << to_str ("Exarea: %f\n", area);
 178 }
 179
 180
 181
 182 /*
 183   max ( encompass.y / curve.y )
 184
 185  */
 186 Real
 187 Slur_bezier_bow::fit_factor () const
 188 {
 189   Real x1 = encompass_[0][X_AXIS];
 190   Real x2 = encompass_.top ()[X_AXIS];
 191
 192   Real factor = 0.0;
 193   for (int i=1; i < encompass_.size ()-1; i++)
 194     {
 195       if (encompass_[i][X_AXIS] > x1 && encompass_[i][X_AXIS] < x2)
 196         {
 197          Real y = curve_.get_other_coordinate (X_AXIS, encompass_[i][X_AXIS]);
 198          if (y>0)
 199            {
 200              Real f = encompass_[i][Y_AXIS] / y;
 201              factor = factor >? f;
 202            }
 203         }
 204     }
 205
 206
 207   return factor;
 208 }
 209
 210
 211
 212
 213
 214 /*
 215   Slur
 216 */
 217
 218 Slur::Slur (SCM s)
 219   : Spanner (s)
 220 {
 221   // URG
 222   dy_f_drul_[LEFT] = dy_f_drul_[RIGHT] = 0.0;
 223   dx_f_drul_[LEFT] = dx_f_drul_[RIGHT] = 0.0;
 224
 225   set_elt_pointer ("note-columns", SCM_EOL);
 226   set_elt_property ("control-points", SCM_EOL);
 227 }
 228
 229 void
 230 Slur::add_column (Note_column*n)
 231 {
 232   if (!gh_pair_p (n->get_elt_pointer ("note-heads")))
 233     warning (_ ("Putting slur over rest.  Ignoring."));
 234   else
 235     {
 236       Pointer_group_interface (this, "note-columns").add_element (n);
 237       add_dependency (n);
 238     }
 239 }
 240
 241 void
 242 Slur::de_uglyfy (Slur_bezier_bow* bb, Real default_height)
 243 {
 244   Real length = bb->curve_.control_[3][X_AXIS] ;
 245   Real ff = bb->fit_factor ();
 246   for (int i = 1; i < 3; i++)
 247     {
 248       Real ind = abs (bb->curve_.control_[(i-1)*3][X_AXIS]
 249                       - bb->curve_.control_[i][X_AXIS]) / length;
 250       Real h = bb->curve_.control_[i][Y_AXIS] * ff / length;
 251
 252       Real f = default_height / length;
 253       Real c1 = paper_l ()->get_var ("bezier_control1");
 254       Real c2 = paper_l ()->get_var ("bezier_control2");
 255       Real c3 = paper_l ()->get_var ("bezier_control3");
 256       if (h > c1 * f)
 257         {
 258           h = c1 * f;
 259         }
 260       else if (h > c2 + c3 * ind)
 261         {
 262           h = c2 + c3 * ind;
 263         }
 264
 265       bb->curve_.control_[i][Y_AXIS] = h * length;
 266     }
 267
 268   bb->curve_.assert_sanity ();
 269 }
 270
 271 Direction
 272 Slur::get_default_dir () const
 273 {
 274   Link_array<Note_column> encompass_arr =
 275     Pointer_group_interface__extract_elements (this, (Note_column*)0, "note-columns");
 276
 277   Direction d = DOWN;
 278   for (int i=0; i < encompass_arr.size (); i ++)
 279     {
 280       if (encompass_arr[i]->dir () < 0)
 281         {
 282           d = UP;
 283           break;
 284         }
 285     }
 286   return d;
 287 }
 288
 289 void
 290 Slur::do_add_processing ()
 291 {
 292   Link_array<Note_column> encompass_arr =
 293     Pointer_group_interface__extract_elements (this, (Note_column*)0, "note-columns");
 294
 295   if (encompass_arr.size ())
 296     {
 297       set_bound (LEFT, encompass_arr[0]);
 298       if (encompass_arr.size () > 1)
 299         set_bound (RIGHT, encompass_arr.top ());
 300     }
 301 }
 302
 303
 304
 305 Offset
 306 Slur::encompass_offset (Note_column const* col) const
 307 {
 308   Offset o;
 309   Stem* stem_l = col->stem_l ();
 310   Direction dir = directional_element (this).get ();
 311
 312   if (!stem_l)
 313     {
 314       warning (_ ("Slur over rest?"));
 315      o[X_AXIS] = col->relative_coordinate (0, X_AXIS);
 316       o[Y_AXIS] = col->extent (Y_AXIS)[dir];
 317       return o;
 318     }
 319   Direction stem_dir = directional_element (stem_l).get ();
 320   o[X_AXIS] = stem_l->relative_coordinate (0, X_AXIS);
 321
 322   /*
 323     Simply set x to middle of notehead
 324    */
 325
 326   o[X_AXIS] -= 0.5 * stem_dir * col->extent (X_AXIS).length ();
 327
 328   if ((stem_dir == dir)
 329       && !stem_l->extent (Y_AXIS).empty_b ())
 330     {
 331       o[Y_AXIS] = stem_l->extent (Y_AXIS)[dir];
 332     }
 333   else
 334     {
 335       o[Y_AXIS] = col->extent (Y_AXIS)[dir];
 336     }
 337
 338   /*
 339    leave a gap: slur mustn't touch head/stem
 340    */
 341   o[Y_AXIS] += dir * paper_l ()->get_var ("slur_y_free");
 342   o[Y_AXIS] -= calc_interstaff_dist (stem_l, this);
 343   return o;
 344 }
 345
 346 void
 347 Slur::after_line_breaking ()
 348 {
 349   set_extremities ();
 350   set_control_points ();
 351 }
 352
 353 /*
 354   urg
 355   FIXME
 356  */
 357 void
 358 Slur::set_extremities ()
 359 {
 360   Link_array<Note_column> encompass_arr =
 361     Pointer_group_interface__extract_elements (this, (Note_column*)0, "note-columns");
 362
 363   if (!encompass_arr.size ())
 364     {
 365       set_elt_property ("transparent", SCM_BOOL_T);
 366       set_extent_callback (0, X_AXIS);
 367       set_extent_callback (0, Y_AXIS);
 368       return;
 369     }
 370
 371   if (!directional_element (this).get ())
 372     directional_element (this).set (get_default_dir ());
 373
 374
 375   /*
 376    Slur and tie placement [OSU]
 377
 378    Slurs:
 379    * x = centre of head - d * x_gap_f
 380
 381    TODO:
 382    * y = length < 5ss : horizontal tangent + d * 0.25 ss
 383      y = length >= 5ss : y next interline - d * 0.25 ss
 384    */
 385
 386   Real staff_space = paper_l ()->get_var ("interline");
 387   Real half_staff_space = staff_space / 2;
 388
 389   Real x_gap_f = paper_l ()->get_var ("slur_x_gap");
 390   Real y_gap_f = paper_l ()->get_var ("slur_y_gap");
 391
 392   Drul_array<Note_column*> note_column_drul;
 393   note_column_drul[LEFT] = encompass_arr[0];
 394   note_column_drul[RIGHT] = encompass_arr.top ();
 395
 396   bool fix_broken_b = false;
 397
 398   Direction my_dir = directional_element (this).get ();
 399
 400   Direction d = LEFT;
 401   do
 402     {
 403       dx_f_drul_[d] = 0;
 404       dy_f_drul_[d] = 0;
 405
 406       if ((note_column_drul[d] == get_bound (d))
 407           && note_column_drul[d]->first_head ()
 408           && (note_column_drul[d]->stem_l ()))
 409         {
 410           Stem* stem_l = note_column_drul[d]->stem_l ();
 411           /*
 412             side directly attached to note head;
 413             no beam getting in the way
 414           */
 415           if ((stem_l->extent (Y_AXIS).empty_b ()
 416                || !((stem_l->get_direction () == my_dir) && (my_dir != d)))
 417               && !((my_dir == stem_l->get_direction ())
 418                    && stem_l->beam_l () && (stem_l->beam_count (-d) >= 1)))
 419             {
 420               dx_f_drul_[d] = get_bound (d)->extent (X_AXIS).length () / 2;
 421               dx_f_drul_[d] -= d * x_gap_f;
 422
 423               if (stem_l->get_direction () != my_dir)
 424                 {
 425                   dy_f_drul_[d] = note_column_drul[d]->extent (Y_AXIS)[my_dir];
 426                 }
 427               else
 428                 {
 429                   dy_f_drul_[d] = stem_l->chord_start_f ()
 430                     + my_dir * half_staff_space;
 431                 }
 432               dy_f_drul_[d] += my_dir * y_gap_f;
 433             }
 434           /*
 435             side attached to (visible) stem
 436           */
 437           else
 438             {
 439               dx_f_drul_[d] = stem_l->relative_coordinate (0, X_AXIS)
 440                 - get_bound (d)->relative_coordinate (0, X_AXIS);
 441               /*
 442                 side attached to beamed stem
 443                */
 444               if (stem_l->beam_l () && (stem_l->beam_count (-d) >= 1))
 445                 {
 446                   dy_f_drul_[d] = stem_l->extent (Y_AXIS)[my_dir];
 447                   dy_f_drul_[d] += my_dir * 2 * y_gap_f;
 448                 }
 449               /*
 450                 side attached to notehead, with stem getting in the way
 451                */
 452               else
 453                 {
 454                   dx_f_drul_[d] -= d * x_gap_f;
 455
 456                   dy_f_drul_[d] = stem_l->chord_start_f ()
 457                     + my_dir * half_staff_space;
 458                   dy_f_drul_[d] += my_dir * y_gap_f;
 459                 }
 460             }
 461         }
 462       /*
 463         loose end
 464       */
 465       else
 466         {
 467           dx_f_drul_[d] = get_broken_left_end_align ();
 468
 469           /*
 470             broken: should get y from other piece, so that slur
 471             continues up/down trend
 472
 473             for now: be horizontal..
 474           */
 475           fix_broken_b = true;
 476         }
 477     }
 478   while (flip (&d) != LEFT);
 479
 480   int cross_count =  cross_staff_count ();
 481   bool interstaff_b = (0 < cross_count) && (cross_count < encompass_arr.size ());
 482
 483   Drul_array<Offset> info_drul;
 484   Drul_array<Real> interstaff_interval;
 485
 486   do
 487     {
 488       info_drul[d] = encompass_offset (encompass_arr.boundary (d, 0));
 489       interstaff_interval[d] = - calc_interstaff_dist (encompass_arr.boundary (d,0),
 490                                                      this);
 491     }
 492   while (flip (&d) != LEFT);
 493
 494   Real interstaff_f = interstaff_interval[RIGHT] - interstaff_interval[LEFT];
 495
 496   if (fix_broken_b)
 497     {
 498       Direction d = (encompass_arr.top () != get_bound (RIGHT)) ?
 499         RIGHT : LEFT;
 500       dy_f_drul_[d] = info_drul[d][Y_AXIS];
 501       if (!interstaff_b)
 502         {
 503           dy_f_drul_[d] -= interstaff_interval[d];
 504           if (cross_count)      // interstaff_i  ?
 505             {
 506               dy_f_drul_[LEFT] += interstaff_interval[d];
 507               dy_f_drul_[RIGHT] += interstaff_interval[d];
 508             }
 509         }
 510     }
 511
 512   if (!fix_broken_b)
 513     dy_f_drul_[RIGHT] += interstaff_f;
 514 }
 515
 516
 517 int
 518 Slur::cross_staff_count ()const
 519 {
 520   Link_array<Note_column> encompass_arr =
 521     Pointer_group_interface__extract_elements (this, (Note_column*)0, "note-columns");
 522
 523   int k=0;
 524
 525   for (int i = 0; i < encompass_arr.size (); i++)
 526     {
 527       if (calc_interstaff_dist (encompass_arr[i], this))
 528         k++;
 529     }
 530   return k;
 531 }
 532
 533
 534 Array<Offset>
 535 Slur::get_encompass_offset_arr () const
 536 {
 537   Link_array<Note_column> encompass_arr =
 538     Pointer_group_interface__extract_elements (this, (Note_column*)0, "note-columns");
 539
 540   Array<Offset> offset_arr;
 541
 542 #if 0
 543   /*
 544     check non-disturbed slur
 545     FIXME: x of ends off by a tiny bit!!
 546   */
 547   offset_arr.push (Offset (0, dy_f_drul_[LEFT]));
 548   offset_arr.push (Offset (0, dy_f_drul_[RIGHT]));
 549   return offset_arr;
 550 #endif
 551
 552   Offset origin (relative_coordinate (0, X_AXIS), 0);
 553
 554   int first = 1;
 555   int last = encompass_arr.size () - 2;
 556
 557   offset_arr.push (Offset (dx_f_drul_[LEFT], dy_f_drul_[LEFT]));
 558
 559   /*
 560     left is broken edge
 561   */
 562
 563   int cross_count  = cross_staff_count ();
 564   bool cross_b = cross_count && cross_count < encompass_arr.size ();
 565   if (encompass_arr[0] != get_bound (LEFT))
 566     {
 567       first--;
 568       Real is   = calc_interstaff_dist (encompass_arr[0], this);
 569       if (cross_b)
 570         offset_arr[0][Y_AXIS] += is;
 571     }
 572
 573   /*
 574     right is broken edge
 575   */
 576   if (encompass_arr.top () != get_bound (RIGHT))
 577     {
 578       last++;
 579     }
 580
 581   for (int i = first; i <= last; i++)
 582     {
 583       Offset o (encompass_offset (encompass_arr[i]));
 584       offset_arr.push (o - origin);
 585     }
 586
 587   offset_arr.push (Offset (spanner_length ()+  dx_f_drul_[RIGHT],
 588                            dy_f_drul_[RIGHT]));
 589
 590   return offset_arr;
 591 }
 592
 593
 594 Array<Rod>
 595 Slur::get_rods () const
 596 {
 597   Array<Rod> a;
 598   Rod r;
 599
 600   r.item_l_drul_[LEFT] = get_bound (LEFT);
 601   r.item_l_drul_[RIGHT] = get_bound (RIGHT);
 602   r.distance_f_ = paper_l ()->get_var ("slur_x_minimum");
 603
 604   a.push (r);
 605   return a;
 606 }
 607
 608
 609
 610 /*
 611   Ugh should have dash-length + dash-period
 612  */
 613 Molecule
 614 Slur::do_brew_molecule () const
 615 {
 616   Real thick = paper_l ()->get_var ("slur_thickness");
 617   Bezier one = get_curve ();
 618
 619   Molecule a;
 620   SCM d =  get_elt_property ("dashed");
 621   if (gh_number_p (d))
 622     a = lookup_l ()->dashed_slur (one, thick, thick * gh_scm2double (d));
 623   else
 624     a = lookup_l ()->slur (one, directional_element (this).get () * thick, thick);
 625
 626   return a;
 627 }
 628
 629 void
 630 Slur::set_control_points ()
 631 {
 632   Slur_bezier_bow bb (get_encompass_offset_arr (),
 633                       directional_element (this).get ());
 634
 635   Real staff_space = Staff_symbol_referencer_interface (this).staff_space ();
 636   Real h_inf = paper_l ()->get_var ("slur_height_limit_factor") * staff_space;
 637   Real r_0 = paper_l ()->get_var ("slur_ratio");
 638
 639   bb.set_default_bezier (h_inf, r_0);
 640
 641   if (bb.fit_factor () > 1.0)
 642     {
 643       Real length = bb.curve_.control_[3][X_AXIS];
 644       Real default_height = bb.get_default_height (h_inf, r_0, length);
 645       bb.minimise_enclosed_area (paper_l(), default_height);
 646
 647       Real bff = paper_l ()->get_var ("slur_force_blowfit");
 648       bb.curve_.control_[1][Y_AXIS] *= bff;
 649       bb.curve_.control_[2][Y_AXIS] *= bff;
 650       bb.blow_fit ();
 651
 652       Real sb = paper_l ()->get_var ("slur_beautiful");
 653       Real beautiful = length * default_height * sb;
 654       Real area = bb.enclosed_area_f ();
 655
 656       /*
 657         Slurs that fit beautifully are not ugly
 658       */
 659       if (area > beautiful)
 660         de_uglyfy (&bb, default_height);
 661     }
 662
 663   Bezier b = bb.get_bezier ();
 664
 665
 666   SCM controls = SCM_EOL;
 667   for (int i= 4; i--;)
 668     controls = gh_cons ( ly_offset2scm (b.control_[i]), controls);
 669
 670   set_elt_property ("control-points", controls);
 671 }
 672
 673
 674 Bezier
 675 Slur::get_curve () const
 676 {
 677   Bezier b;
 678   int i = 0;
 679
 680   if (!directional_element (this).get ())
 681     ((Slur*)this)->set_extremities ();
 682
 683   if (!gh_pair_p (get_elt_property ("control-points")))
 684     ((Slur*)this)->set_control_points ();
 685
 686
 687   for (SCM s= get_elt_property ("control-points"); s != SCM_EOL; s = gh_cdr (s))
 688     {
 689       b.control_[i] = ly_scm2offset (gh_car (s));
 690       i++;
 691     }
 692
 693   Array<Offset> enc (get_encompass_offset_arr ());
 694   Direction dir = directional_element (this).get ();
 695
 696   Real x1 = enc[0][X_AXIS];
 697   Real x2 = enc.top ()[X_AXIS];
 698
 699   Real off = 0.0;
 700   for (int i=1; i < enc.size ()-1; i++)
 701     {
 702       Real x = enc[i][X_AXIS];
 703       if (x > x1 && x <x2)
 704         {
 705           Real y = b.get_other_coordinate (X_AXIS, x);
 706           off = off >? dir *  (enc[i][Y_AXIS] - y);
 707         }
 708     }
 709   b.translate (Offset (0, dir * off));
 710   return b;
 711 }
 712