lily/slur-quanting.cc

   1 /*
   2   slur-quanting.cc -- Score based slur formatting
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1996--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7   Jan Nieuwenhuizen <janneke@gnu.org>
   8 */
   9
  10 #include <math.h>
  11
  12 #include "accidental-interface.hh"
  13 #include "beam.hh"
  14 #include "directional-element-interface.hh"
  15 #include "group-interface.hh"
  16 #include "lily-guile.hh"
  17 #include "new-slur.hh"
  18 #include "note-column.hh"
  19 #include "output-def.hh"
  20 #include "pitch.hh"
  21 #include "slur-bezier-bow.hh"
  22 #include "spanner.hh"
  23 #include "staff-symbol-referencer.hh"
  24 #include "staff-symbol.hh"
  25 #include "stem.hh"
  26 #include "warn.hh"
  27 #include "paper-column.hh"
  28
  29
  30 struct Slur_score
  31 {
  32   Drul_array<Offset> attachment_;
  33   Real score_;
  34   Bezier curve_;
  35
  36 #if DEBUG_SLUR_QUANTING
  37   String score_card_;
  38 #endif
  39
  40   Slur_score()
  41   {
  42     score_ = 0.0;
  43   }
  44 };
  45
  46 /*
  47   TODO: put in details property.,
  48
  49   use lowercase.
  50 */
  51 struct Slur_score_parameters
  52 {
  53   int SLUR_REGION_SIZE;
  54   Real HEAD_ENCOMPASS_PENALTY;
  55   Real STEM_ENCOMPASS_PENALTY;
  56   Real CLOSENESS_FACTOR;
  57   Real EDGE_ATTRACTION_FACTOR;
  58   Real SAME_SLOPE_PENALTY;
  59   Real STEEPER_SLOPE_FACTOR;
  60   Real NON_HORIZONTAL_PENALTY;
  61   Real HEAD_STRICT_FREE_SPACE;
  62   Real MAX_SLOPE;
  63   Real MAX_SLOPE_FACTOR;
  64   Real EXTRA_OBJECT_COLLISION;
  65   Real ACCIDENTAL_COLLISION;
  66   Real FREE_HEAD_DISTANCE;
  67   Slur_score_parameters ();
  68 };
  69
  70 /*
  71   TODO:
  72
  73   - curve around flag for y coordinate
  74   - better scoring.
  75   - short-cut: try a smaller region first.
  76   - collisions with accidentals
  77   - collisions with articulations (staccato, portato, sforzato, ...)
  78   -
  79 */
  80 struct Encompass_info
  81 {
  82   Real x_;
  83   Real stem_;
  84   Real head_;
  85   Encompass_info ()
  86   {
  87     x_ = 0.0;
  88     stem_ = 0.0;
  89     head_ = 0.0;
  90   }
  91 };
  92
  93 struct Bound_info
  94 {
  95   Box stem_extent_;
  96   Direction stem_dir_;
  97   Item *bound_;
  98   Grob *note_column_;
  99   Grob *slur_head_;
 100   Grob *staff_;
 101   Grob *stem_;
 102   Interval slur_head_extent_;
 103   Real neighbor_y_;
 104   Real staff_space_;
 105
 106   Bound_info ()
 107   {
 108     stem_ = 0;
 109     neighbor_y_ = 0;
 110     staff_ = 0;
 111     slur_head_ = 0;
 112     stem_dir_ = CENTER;
 113     note_column_ = 0;
 114   }
 115 };
 116
 117
 118
 119
 120 static void
 121 score_extra_encompass (Grob *me, Grob *common[],
 122                        Slur_score_parameters *score_param,
 123                        Drul_array<Bound_info> ,
 124                        Drul_array<Offset> ,
 125                        Array<Slur_score> * scores);
 126 static void score_slopes (Grob *me, Grob *common[],
 127                           Slur_score_parameters *score_param,
 128                           Drul_array<Bound_info>,
 129                           Drul_array<Offset> base_attach,
 130                           Array<Slur_score> *scores);
 131
 132 static void score_edges (Grob *me, Grob *common[],
 133                          Slur_score_parameters *score_param,
 134                          Drul_array<Bound_info> extremes,
 135                          Drul_array<Offset> base_attach,
 136                          Array<Slur_score> *scores);
 137 static void score_encompass (Grob *me, Grob *common[],
 138                              Slur_score_parameters*,
 139                              Drul_array<Bound_info>,
 140                              Drul_array<Offset>, Array<Slur_score> *scores);
 141 static Bezier avoid_staff_line (Grob *me, Grob **common,
 142                                 Drul_array<Bound_info> extremes,
 143                                 Bezier bez);
 144
 145 static Encompass_info get_encompass_info (Grob *me,
 146                                           Grob *col,
 147                                           Grob **common);
 148 static Bezier get_bezier (Grob *me, Drul_array<Offset>, Real, Real);
 149 static Direction get_default_dir (Grob *me);
 150
 151 static void set_end_points (Grob *);
 152 static Real broken_trend_y (Grob *me, Grob **, Direction dir);
 153 static Drul_array<Bound_info> get_bound_info (Spanner *me, Grob **common);
 154
 155 static void generate_curves (Grob *me,
 156                              Grob *common[],
 157                              Drul_array<Bound_info> extremes,
 158                              Drul_array<Offset> base_attach,
 159                              Array<Slur_score> *scores);
 160 static Array<Slur_score> enumerate_attachments
 161 (Grob *me, Grob *common[], Slur_score_parameters *score_param,
 162  Drul_array<Bound_info> extremes,
 163  Drul_array<Offset> base_attachment, Drul_array<Real> end_ys);
 164 static Drul_array<Offset> get_base_attachments
 165 (Spanner *sp, Grob **common, Drul_array<Bound_info> extremes);
 166 static Drul_array<Real> get_y_attachment_range
 167 (Spanner *sp, Grob **common, Drul_array<Bound_info> extremes,
 168  Drul_array<Offset> base_attachment);
 169
 170 void
 171 init_score_param (Slur_score_parameters *score_param)
 172 {
 173   score_param->SLUR_REGION_SIZE = 5;
 174   score_param->HEAD_ENCOMPASS_PENALTY = 1000.0;
 175   score_param->STEM_ENCOMPASS_PENALTY = 30.0;
 176   score_param->CLOSENESS_FACTOR = 10;
 177   score_param->EDGE_ATTRACTION_FACTOR = 4;
 178   score_param->SAME_SLOPE_PENALTY = 20;
 179   score_param->STEEPER_SLOPE_FACTOR = 50;
 180   score_param->NON_HORIZONTAL_PENALTY = 15;
 181   score_param->HEAD_STRICT_FREE_SPACE = 0.2;
 182   score_param->MAX_SLOPE = 1.1;
 183   score_param->MAX_SLOPE_FACTOR = 10;
 184   score_param->FREE_HEAD_DISTANCE = 0.3;
 185   score_param->EXTRA_OBJECT_COLLISION = 50;
 186   score_param->ACCIDENTAL_COLLISION = 3;
 187 }
 188
 189 Slur_score_parameters::Slur_score_parameters()
 190 {
 191   init_score_param (this);
 192 }
 193
 194 /* HDIR indicates the direction for the slur.  */
 195 Real
 196 broken_trend_y (Grob *me, Grob **common, Direction hdir)
 197 {
 198   /* A broken slur should maintain the same vertical trend
 199      the unbroken slur would have had.  */
 200   Real by = 0.0;
 201   if (Spanner *mother = dynamic_cast<Spanner*> (me->original_))
 202     {
 203       int k = broken_spanner_index (dynamic_cast<Spanner*> (me));
 204       int j = k + hdir;
 205       if (j < 0 || j >= mother->broken_intos_.size ())
 206         return by;
 207
 208       Grob *neighbor = mother->broken_intos_[j];
 209       if (hdir == RIGHT)
 210         neighbor->set_property ("direction",
 211                                 me->get_property ("direction"));
 212
 213       Spanner *common_mother
 214         = dynamic_cast<Spanner*> (common[Y_AXIS]->original_);
 215       int common_k
 216         = broken_spanner_index (dynamic_cast<Spanner*> (common[Y_AXIS]));
 217       int common_j = common_k + hdir;
 218
 219       if (common_j < 0 || common_j >= common_mother->broken_intos_.size())
 220         return by;
 221
 222       Grob *common_next_system = common_mother->broken_intos_[common_j];
 223       Link_array<Grob> neighbor_cols
 224         = Pointer_group_interface__extract_grobs (neighbor, (Grob *)0,
 225                                                   "note-columns");
 226
 227       Grob *neighbor_col
 228         = (hdir == RIGHT) ? neighbor_cols[0] : neighbor_cols.top ();
 229       Grob *neighbor_common
 230         = common_next_system->common_refpoint (neighbor_col, Y_AXIS);
 231
 232       Direction vdir = get_grob_direction (me);
 233       Real neighbor_y
 234         = neighbor_col->extent (neighbor_common, Y_AXIS)
 235         .linear_combination (int(neighbor_cols.size()==1 ? CENTER : vdir))
 236         - common_next_system->relative_coordinate (neighbor_common, Y_AXIS);
 237
 238       Link_array<Grob> my_cols
 239         = Pointer_group_interface__extract_grobs (me, (Grob *)0,
 240                                                   "note-columns");
 241
 242       Grob *extreme_col = (hdir == RIGHT) ? my_cols.top() : my_cols[0];
 243       Real y = extreme_col->extent (common[Y_AXIS], Y_AXIS)
 244         .linear_combination (int ((my_cols.size() == 1) ? CENTER : vdir));
 245       by = (y*neighbor_cols.size() + neighbor_y*my_cols.size()) /
 246         (my_cols.size() + neighbor_cols.size());
 247     }
 248   return by;
 249 }
 250
 251 Encompass_info
 252 get_encompass_info (Grob *me,
 253                     Grob *col,
 254                     Grob **common)
 255 {
 256   Grob *stem = unsmob_grob (col->get_property ("stem"));
 257   Encompass_info ei;
 258   Direction dir = get_grob_direction (me);
 259
 260   if (!stem)
 261     {
 262       programming_error ("No stem for note column?");
 263       ei.x_ = col->relative_coordinate (common[X_AXIS], X_AXIS);
 264       ei.head_ = ei.stem_ = col->extent (common[Y_AXIS],
 265                                          Y_AXIS)[get_grob_direction (me)];
 266       return ei;
 267     }
 268   Direction stem_dir = get_grob_direction (stem);
 269
 270   if (Grob *head = Note_column::first_head (col))
 271     ei.x_ = head->extent (common[X_AXIS], X_AXIS).center ();
 272   else
 273     ei.x_ = col->extent (common[X_AXIS], X_AXIS).center ();
 274
 275   Grob *h = Stem::extremal_heads (stem)[Direction (dir)];
 276   if (!h)
 277     {
 278       ei.head_ = ei.stem_ = col->extent (common[Y_AXIS], Y_AXIS)[dir];
 279       return ei;
 280     }
 281
 282   ei.head_ = h->extent (common[Y_AXIS], Y_AXIS)[dir];
 283
 284   if ((stem_dir == dir)
 285       && !stem->extent (stem, Y_AXIS).is_empty ())
 286     {
 287       ei.stem_ = stem->extent (common[Y_AXIS], Y_AXIS)[dir];
 288       if (Grob *b = Stem::get_beam (stem))
 289         ei.stem_ += stem_dir * 0.5 * Beam::get_thickness (b);
 290       ei.x_ = stem->extent (common[X_AXIS], X_AXIS).center ();
 291     }
 292   else
 293     ei.stem_ = ei.head_;
 294
 295   return ei;
 296 }
 297
 298
 299 Direction
 300 get_default_dir (Grob*me)
 301 {
 302   Link_array<Grob> encompasses
 303     = Pointer_group_interface__extract_grobs (me, (Grob*) 0, "note-columns");
 304
 305   Direction d = DOWN;
 306   for (int i= 0; i < encompasses.size (); i ++)
 307     {
 308       if (Note_column::dir (encompasses[i]) < 0)
 309         {
 310           d = UP;
 311           break;
 312         }
 313     }
 314   return d;
 315 }
 316
 317 MAKE_SCHEME_CALLBACK (New_slur, after_line_breaking,1);
 318 SCM
 319 New_slur::after_line_breaking (SCM smob)
 320 {
 321   Spanner *me = dynamic_cast<Spanner*> (unsmob_grob (smob));
 322   if (!scm_ilength (me->get_property ("note-columns")))
 323     {
 324       me->suicide ();
 325       return SCM_UNSPECIFIED;
 326     }
 327
 328   if (!get_grob_direction (me))
 329     set_grob_direction (me, get_default_dir (me));
 330
 331   set_end_points (me);
 332
 333   return SCM_UNSPECIFIED;
 334 }
 335
 336 Bezier
 337 get_bezier (Grob *me, Drul_array<Offset> extremes, Real r_0, Real h_inf)
 338 {
 339   Array<Offset> encompasses;
 340   encompasses.push (extremes[LEFT]);
 341   encompasses.push (extremes[RIGHT]);
 342
 343   Slur_bezier_bow bb (encompasses,
 344                       get_grob_direction (me), h_inf, r_0);
 345
 346   return bb.get_bezier ();
 347 }
 348
 349 Drul_array<Bound_info>
 350 get_bound_info (Spanner* me, Grob **common)
 351 {
 352   Drul_array<Bound_info> extremes;
 353   Direction d = LEFT;
 354   Direction dir = get_grob_direction (me);
 355
 356   do
 357     {
 358       extremes[d].bound_ = me->get_bound (d);
 359       if (Note_column::has_interface (extremes[d].bound_))
 360         {
 361           extremes[d].note_column_ = extremes[d].bound_;
 362           extremes[d].stem_ = Note_column::get_stem (extremes[d].note_column_);
 363           extremes[d].stem_dir_ = get_grob_direction (extremes[d].stem_);
 364           extremes[d].stem_extent_[X_AXIS]
 365             = extremes[d].stem_->extent (common[X_AXIS], X_AXIS);
 366           extremes[d].stem_extent_[Y_AXIS]
 367             = extremes[d].stem_->extent (common[Y_AXIS], Y_AXIS);
 368           extremes[d].slur_head_
 369             = Stem::extremal_heads (extremes[d].stem_)[dir];
 370           extremes[d].slur_head_extent_
 371             = extremes[d].slur_head_->extent (common[X_AXIS], X_AXIS);
 372           extremes[d].staff_ = Staff_symbol_referencer
 373             ::get_staff_symbol (extremes[d].slur_head_);
 374           extremes[d].staff_space_ = Staff_symbol_referencer
 375             ::staff_space (extremes[d].slur_head_);
 376         }
 377       else
 378         extremes[d].neighbor_y_ = broken_trend_y (me, common, d);
 379     }
 380   while (flip (&d) != LEFT);
 381   return extremes;
 382 }
 383
 384 void
 385 set_end_points (Grob *me)
 386 {
 387   Link_array<Grob> columns
 388     = Pointer_group_interface__extract_grobs (me, (Grob *) 0, "note-columns");
 389   Slur_score_parameters params;
 390   if (columns.is_empty ())
 391     {
 392       me->suicide ();
 393       return;
 394     }
 395
 396   SCM eltlist = me->get_property ("note-columns");
 397   SCM extra_list = me->get_property ("encompass-objects");
 398   Spanner *sp = dynamic_cast<Spanner*> (me);
 399
 400   Grob *common[] = {0, 0};
 401   for (int i = X_AXIS; i < NO_AXES; i++)
 402     {
 403       Axis a = (Axis)i;
 404       common[a] = common_refpoint_of_list (eltlist, me, a);
 405       common[a] = common_refpoint_of_list (extra_list, common[a], a);
 406     }
 407
 408   common[X_AXIS] = common[X_AXIS]->common_refpoint (sp->get_bound (RIGHT),
 409                                                     X_AXIS);
 410   common[X_AXIS] = common[X_AXIS]->common_refpoint (sp->get_bound (LEFT),
 411                                                     X_AXIS);
 412
 413   Drul_array<Bound_info> extremes = get_bound_info (sp, common);
 414   Drul_array<Offset> base_attachment
 415     = get_base_attachments (sp, common, extremes);
 416   Drul_array<Real> end_ys
 417     = get_y_attachment_range (sp, common, extremes, base_attachment);
 418   Array<Slur_score> scores = enumerate_attachments (me, common, &params,
 419                                                     extremes, base_attachment,
 420                                                     end_ys);
 421
 422   generate_curves (me, common, extremes, base_attachment, &scores);
 423   score_edges (me, common, &params,extremes, base_attachment, &scores);
 424   score_slopes (me, common, &params,extremes, base_attachment, &scores);
 425   score_encompass (me, common, &params,extremes, base_attachment, &scores);
 426   score_extra_encompass (me, common, &params,extremes, base_attachment,
 427                          &scores);
 428
 429   Real opt = 1e6;
 430   int opt_idx = 0;
 431   // why backwards?
 432   for (int i = scores.size (); i--;)
 433     {
 434       if (scores[i].score_ < opt)
 435         {
 436           opt = scores[i].score_;
 437           opt_idx = i;
 438         }
 439     }
 440
 441 #if DEBUG_SLUR_QUANTING
 442   SCM inspect_quants = me->get_property ("inspect-quants");
 443   if (to_boolean (me->get_paper ()
 444                   ->lookup_variable (ly_symbol2scm ("debug-slur-quanting")))
 445       && ly_c_pair_p (inspect_quants))
 446     {
 447       Drul_array<Real> ins = ly_scm2interval (inspect_quants);
 448       Real mindist = 1e6;
 449       for (int i = 0; i < scores.size (); i ++)
 450         {
 451           Real d =fabs (scores[i].attachment_[LEFT][Y_AXIS] - ins[LEFT])
 452             + fabs (scores[i].attachment_[RIGHT][Y_AXIS] - ins[RIGHT]);
 453           if (d < mindist)
 454             {
 455               opt_idx = i;
 456               mindist= d;
 457             }
 458         }
 459       if (mindist > 1e5)
 460         programming_error ("Could not find quant.");
 461     }
 462   scores[opt_idx].score_card_ += to_string ("i%d", opt_idx);
 463
 464   // debug quanting
 465   me->set_property ("quant-score",
 466                     scm_makfrom0str (scores[opt_idx].score_card_.to_str0 ()));
 467 #endif
 468
 469   Bezier b = scores[opt_idx].curve_;
 470   SCM controls = SCM_EOL;
 471   for (int i = 4; i--;)
 472     {
 473       Offset o = b.control_[i]
 474         - Offset (me->relative_coordinate (common[X_AXIS], X_AXIS),
 475                   me->relative_coordinate (common[Y_AXIS], Y_AXIS));
 476       controls = scm_cons (ly_offset2scm (o), controls);
 477     }
 478   me->set_property ("control-points", controls);
 479 }
 480
 481
 482 Drul_array<Real>
 483 get_y_attachment_range (Spanner*me,
 484                         Grob **common,
 485                         Drul_array<Bound_info> extremes,
 486                         Drul_array<Offset> base_attachment)
 487 {
 488   Drul_array<Real> end_ys;
 489   Direction dir = get_grob_direction (me);
 490   Direction d = LEFT;
 491   do
 492     {
 493       if (extremes[d].note_column_)
 494         {
 495           end_ys[d] = dir
 496             * ((dir * (base_attachment[d][Y_AXIS] + 4.0 * dir))
 497                >? (dir * (dir + extremes[d].note_column_->extent(common[Y_AXIS],
 498                                                                  Y_AXIS)[dir]))
 499                >? (dir * base_attachment[-d][Y_AXIS]));
 500         }
 501       else
 502         end_ys[d] = extremes[d].neighbor_y_ + 4.0 * dir;
 503     }
 504   while (flip (&d) != LEFT);
 505
 506   return end_ys;
 507 }
 508
 509 bool
 510 spanner_less (Spanner *s1, Spanner* s2)
 511 {
 512   Slice b1, b2;
 513   Direction d  = LEFT;
 514   do
 515     {
 516       b1[d] = s1->get_bound (d)->get_column ()->rank_;
 517       b2[d] = s2->get_bound (d)->get_column ()->rank_;
 518     } while (flip (&d) != LEFT);
 519
 520   return b2[LEFT] <= b1[LEFT] && b2[RIGHT] >= b1[RIGHT]
 521     && (b2[LEFT] != b1[LEFT] || b2[RIGHT] != b1[RIGHT]);
 522 }
 523
 524
 525 Drul_array<Offset>
 526 get_base_attachments (Spanner *me,
 527                       Grob **common, Drul_array<Bound_info> extremes)
 528 {
 529   Link_array<Grob> columns
 530     = Pointer_group_interface__extract_grobs (me, (Grob *)0, "note-columns");
 531   Drul_array<Offset> base_attachment;
 532   Slur_score_parameters params;
 533   Real staff_space = Staff_symbol_referencer::staff_space ((Grob *) me);
 534   Direction dir = get_grob_direction (me);
 535   Direction d = LEFT;
 536   do
 537     {
 538       Grob *stem = extremes[d].stem_;
 539       Grob *head = extremes[d].slur_head_;
 540
 541       Real x, y;
 542       if (!extremes[d].note_column_)
 543         {
 544           y = extremes[d].neighbor_y_;
 545           if (d== RIGHT)
 546             x = extremes[d].bound_->extent (common[X_AXIS], X_AXIS)[d];
 547           else
 548             x = me->get_broken_left_end_align ();
 549         }
 550       else
 551         {
 552           bool same_beam =
 553             (extremes[d].stem_ && extremes[-d].stem_
 554              && Stem::get_beam (extremes[d].stem_) == Stem::get_beam (extremes[-d].stem_));
 555           if (stem
 556               && extremes[d].stem_dir_ == dir
 557               && Stem::get_beaming (stem, -d)
 558               && (!spanner_less (me, Stem::get_beam (stem))
 559                   || same_beam))
 560             y = extremes[d].stem_extent_[Y_AXIS][dir];
 561           else if (head)
 562             y = head->extent (common[Y_AXIS], Y_AXIS)[dir];
 563           y += dir * 0.5 * staff_space;
 564
 565           Real pos
 566             = (y - extremes[d].staff_->relative_coordinate (common[Y_AXIS],
 567                                                             Y_AXIS))
 568             * 2.0 / Staff_symbol::staff_space (extremes[d].staff_);
 569
 570           /* start off staffline. */
 571           if (fabs (pos - round (pos)) < 0.2
 572               && Staff_symbol_referencer::on_staffline (head, (int) rint (pos))
 573               && Staff_symbol_referencer::line_count (head) - 1 >= rint (pos)
 574               )
 575             // TODO: calc from slur thick & line thick, parameter.
 576             y += 1.5 * staff_space * dir / 10;
 577
 578           Grob * fh = Note_column::first_head (extremes[d].note_column_);
 579           x = fh->extent (common[X_AXIS], X_AXIS).linear_combination (CENTER);
 580         }
 581       base_attachment[d] = Offset (x, y);
 582
 583     } while (flip (&d) != LEFT);
 584
 585   return base_attachment;
 586 }
 587
 588 void
 589 generate_curves (Grob *me, Grob **common,
 590                  Drul_array<Bound_info> extremes,
 591                  Drul_array<Offset>,
 592                  Array<Slur_score> *scores)
 593 {
 594   (void) common;
 595   (void) extremes;
 596   Real staff_space = Staff_symbol_referencer::staff_space ((Grob *) me);
 597   Real r_0 = robust_scm2double (me->get_property ("ratio"), 0.33);
 598   Real h_inf = staff_space * ly_scm2double (me->get_property ("height-limit"));
 599   for (int i = 0; i < scores->size(); i++)
 600     {
 601       Bezier bez= get_bezier (me, (*scores)[i].attachment_, r_0, h_inf);
 602       bez = avoid_staff_line (me, common, extremes, bez);
 603       (*scores)[i].attachment_[LEFT] = bez.control_[0];
 604       (*scores)[i].attachment_[RIGHT] = bez.control_[3];
 605       (*scores)[i].curve_ = bez;
 606     }
 607 }
 608
 609 Bezier
 610 avoid_staff_line (Grob *me, Grob **common,
 611                   Drul_array<Bound_info> extremes,
 612                   Bezier bez)
 613 {
 614   Offset horiz (1,0);
 615   Array<Real> ts = bez.solve_derivative (horiz);
 616   Real lt = me->get_paper ()->get_dimension (ly_symbol2scm ("linethickness"));
 617   Real thick = robust_scm2double (me->get_property ("thickness"), 1.0) *  lt;
 618
 619   /* TODO: handle case of broken slur.  */
 620   if (!ts.is_empty ()
 621       && (extremes[LEFT].staff_ == extremes[RIGHT].staff_)
 622       && extremes[LEFT].staff_ && extremes[RIGHT].staff_)
 623     {
 624       Real y = bez.curve_point (ts[0])[Y_AXIS];
 625
 626       Grob *staff = extremes[LEFT].staff_;
 627
 628       Real staff_space = extremes[LEFT].staff_space_;
 629       Real p = 2 * (y - staff->relative_coordinate (common[Y_AXIS], Y_AXIS))
 630         / staff_space;
 631
 632       Real distance = fabs (round (p) - p);     //  in halfspaces
 633       if (distance < 4 * thick
 634           && (int) fabs (round (p))
 635           <= 2 * Staff_symbol_referencer::staff_radius (staff) + 0.1
 636           && (int (fabs (round (p))) % 2
 637               != Staff_symbol_referencer::line_count (staff) % 2))
 638         {
 639           Direction resolution_dir =
 640             (distance ?  get_grob_direction (me) : Direction (sign (p - round(p))));
 641
 642           // TODO: parameter
 643           Real newp = round (p) + resolution_dir
 644             * 5 * thick;
 645
 646           Real dy = (newp - p) * staff_space / 2.0;
 647 #if 0
 648           bez.translate (Offset (0, dy));
 649 #else
 650           bez.control_[1][Y_AXIS] += dy;
 651           bez.control_[2][Y_AXIS] += dy;
 652
 653 #endif
 654         }
 655     }
 656   return bez;
 657 }
 658
 659 Array<Slur_score>
 660 enumerate_attachments (Grob *me, Grob *common[],
 661                        Slur_score_parameters *score_param,
 662                        Drul_array<Bound_info> extremes,
 663                        Drul_array<Offset> base_attachment,
 664                        Drul_array<Real> end_ys)
 665 {
 666   (void) common;
 667   /*ugh.   */
 668   Array<Slur_score> scores;
 669
 670   Direction dir = get_grob_direction (me);
 671   Real staff_space = Staff_symbol_referencer::staff_space ((Grob *) me);
 672
 673   Drul_array<Offset> os;
 674   os[LEFT] = base_attachment[LEFT];
 675   Real minimum_length = staff_space
 676     * robust_scm2double (me->get_property ("minimum-length"), 2.0);
 677
 678   for (int i = 0; dir * os[LEFT][Y_AXIS] <= dir * end_ys[LEFT]; i++)
 679     {
 680       os[RIGHT] = base_attachment[RIGHT];
 681       for (int j = 0; dir * os[RIGHT][Y_AXIS] <= dir * end_ys[RIGHT]; j++)
 682         {
 683           Slur_score s;
 684           Direction d = LEFT;
 685           Drul_array<bool> attach_to_stem (false, false);
 686           do
 687             {
 688               os[d][X_AXIS] = base_attachment[d][X_AXIS];
 689               if (extremes[d].stem_
 690                   && !Stem::is_invisible (extremes[d].stem_)
 691                   && extremes[d].stem_dir_ == dir
 692                   && dir == -d)
 693                 {
 694                   if (extremes[d].stem_extent_[Y_AXIS].contains (os[d][Y_AXIS]))
 695                     {
 696                       os[d][X_AXIS] =  extremes[d].slur_head_extent_[-d]
 697                         - d * 0.3;
 698                       attach_to_stem[d] = true;
 699                     }
 700                   else if (dir *extremes[d].stem_extent_[Y_AXIS][dir]
 701                            < dir * os[d][Y_AXIS])
 702                     os[d][X_AXIS] = extremes[d].stem_extent_[X_AXIS].center();
 703                 }
 704             }
 705           while (flip (&d) != LEFT);
 706
 707           Offset dz;
 708           dz = os[RIGHT] - os[LEFT];
 709           if (dz[X_AXIS] < minimum_length
 710               || fabs (dz[Y_AXIS] / dz[X_AXIS]) > score_param->MAX_SLOPE
 711               )
 712             {
 713               do
 714                 {
 715                   if (extremes[d].slur_head_)
 716                     {
 717                       os[d][X_AXIS] = extremes[d].slur_head_extent_.center ();
 718                       attach_to_stem[d] = false;
 719                     }
 720                 }
 721               while (flip (&d) != LEFT);
 722             }
 723
 724           dz = os[RIGHT] - os[LEFT];
 725           do
 726             {
 727               if (extremes[d].slur_head_
 728                   && !attach_to_stem[d])
 729                 {
 730                   /* Horizontally move tilted slurs a little.  Move
 731                      more for bigger tilts.
 732
 733                      TODO: parameter */
 734                   os[d][X_AXIS]
 735                     -= dir * extremes[d].slur_head_extent_.length ()
 736                     * sin (dz.arg  ()) / 3;
 737                 }
 738             }
 739           while (flip (&d) != LEFT);
 740
 741           s.attachment_ = os;
 742           scores.push (s);
 743
 744           os[RIGHT][Y_AXIS] += dir * staff_space / 2;
 745         }
 746
 747       os[LEFT][Y_AXIS] += dir * staff_space / 2;
 748     }
 749   return scores;
 750 }
 751
 752 void
 753 score_encompass (Grob *me, Grob *common[],
 754                  Slur_score_parameters *score_param,
 755                  Drul_array<Bound_info> extremes,
 756                  Drul_array<Offset> base_attach,
 757                  Array<Slur_score> *scores)
 758 {
 759   (void) extremes;
 760   (void) base_attach;
 761
 762   Link_array<Grob> encompasses
 763     = Pointer_group_interface__extract_grobs (me, (Grob *)0, "note-columns");
 764   Direction dir = get_grob_direction (me);
 765
 766   Array<Encompass_info> infos;
 767
 768   for (int i = 0; i < encompasses.size(); i++)
 769     infos.push (get_encompass_info (me, encompasses[i], common));
 770
 771   for (int i = 0; i < scores->size (); i++)
 772     {
 773       Bezier const &bez (scores->elem (i).curve_);
 774       Real demerit = 0.0;
 775       for (int j = 0; j < infos.size(); j++)
 776         {
 777           Real x = infos[j].x_;
 778
 779           bool l_edge = j==0;
 780           bool r_edge = j==infos.size()-1;
 781           bool edge =  l_edge || r_edge;
 782
 783           if (!(x < scores->elem (i).attachment_[RIGHT][X_AXIS]
 784                 && x > scores->elem (i).attachment_[LEFT][X_AXIS]))
 785             continue;
 786
 787           Real y = bez.get_other_coordinate (X_AXIS, x);
 788           if (!edge)
 789             {
 790               Real head_dy = (y - infos[j].head_);
 791               if (dir * head_dy < 0)
 792                 demerit += score_param->HEAD_ENCOMPASS_PENALTY;
 793               else
 794                 {
 795                   Real hd = (head_dy)
 796                     ? (1 / fabs (head_dy) - 1 / score_param->FREE_HEAD_DISTANCE)
 797                     : score_param->HEAD_ENCOMPASS_PENALTY;
 798                   hd = (hd >? 0)<? score_param->HEAD_ENCOMPASS_PENALTY;
 799
 800                   demerit += hd;
 801                 }
 802             }
 803
 804           if (dir * (y - infos[j].stem_) < 0)
 805             {
 806               Real stem_dem =score_param->STEM_ENCOMPASS_PENALTY ;
 807               if ((l_edge && dir == UP)
 808                   || (r_edge && dir == DOWN))
 809                 stem_dem /= 5;
 810
 811               demerit +=  stem_dem;
 812             }
 813           else if (!edge)
 814             {
 815               Interval ext;
 816               ext.add_point (infos[j].stem_);
 817               ext.add_point (infos[j].head_);
 818
 819               // ?
 820               demerit += -score_param->CLOSENESS_FACTOR
 821                 * (dir
 822                    * (y - (ext[dir] + dir * score_param->FREE_HEAD_DISTANCE))
 823                    <? 0)
 824                 / infos.size ();
 825             }
 826         }
 827
 828 #if DEBUG_SLUR_QUANTING
 829       (*scores)[i].score_card_ += to_string ("C%.2f", demerit);
 830 #endif
 831
 832       (*scores)[i].score_ += demerit;
 833     }
 834 }
 835
 836 void
 837 score_extra_encompass (Grob *me, Grob *common[],
 838                        Slur_score_parameters *score_param,
 839                        Drul_array<Bound_info> extremes,
 840                        Drul_array<Offset> base_attach,
 841                        Array<Slur_score> *scores)
 842 {
 843   (void) base_attach;
 844   (void) extremes;
 845
 846   Link_array<Grob> encompasses
 847     = Pointer_group_interface__extract_grobs (me, (Grob *)0,
 848                                               "encompass-objects");
 849   Direction dir = get_grob_direction (me);
 850   Real staff_space = Staff_symbol_referencer::staff_space ((Grob *) me);
 851   Real lt =  me->get_paper ()->get_dimension (ly_symbol2scm ("linethickness"));
 852   Real thick = robust_scm2double (me->get_property ("thickness"), 1.0) * lt;
 853
 854   Array<Real> xidxs;
 855   Array<Interval> yexts;
 856   Array<Interval> xexts;
 857   for (int i = 0; i < encompasses.size (); i++)
 858     {
 859       Grob *g = encompasses [i];
 860       Interval xe = g->extent (common[X_AXIS], X_AXIS);
 861       Interval ye = g->extent (common[Y_AXIS], Y_AXIS);
 862
 863       Real xp = 0.0;
 864
 865       if (Accidental_interface::has_interface (g))
 866         {
 867           /* Begin copy accidental.cc */
 868           bool parens = false;
 869           if (to_boolean (g->get_property ("cautionary")))
 870             {
 871               SCM cstyle = g->get_property ("cautionary-style");
 872               parens = ly_c_equal_p (cstyle, ly_symbol2scm ("parentheses"));
 873             }
 874
 875           SCM accs = g->get_property ("accidentals");
 876           SCM scm_style = g->get_property ("style");
 877           if (!ly_c_symbol_p (scm_style)
 878               && !parens
 879               && scm_ilength (accs) == 1)
 880             {
 881               /* End copy accidental.cc */
 882               switch (ly_scm2int (ly_car (accs)))
 883                 {
 884                 case FLAT:
 885                 case DOUBLE_FLAT:
 886                   xp = LEFT;
 887                   break ;
 888                 case SHARP:
 889                   xp = 0.5 * dir;
 890                   break ;
 891                 case NATURAL:
 892                   xp = -dir;
 893                   break;
 894                 }
 895             }
 896         }
 897
 898       xidxs.push (xp);
 899       ye.widen (thick * 0.5);
 900       yexts.push (ye);
 901       xexts.push (xe);
 902     }
 903
 904   for (int i = 0; i < scores->size (); i++)
 905     {
 906       Bezier const &bez (scores->elem (i).curve_);
 907       Real demerit = 0.0;
 908       for (int j = 0; j < xidxs.size(); j++)
 909         {
 910           Drul_array<Offset> at = scores->elem (i).attachment_;
 911           Interval slur_wid (at[LEFT][X_AXIS], at[RIGHT][X_AXIS]);
 912
 913           /*
 914             to prevent numerical inaccuracies in
 915             Bezier::get_other_coordinate().
 916            */
 917           slur_wid.widen (- 0.5 * thick);
 918           Real x = xexts[j].linear_combination (xidxs[j]);
 919           Real y = 0.0;
 920           if (!slur_wid.contains (x))
 921             {
 922               Direction contains_dir = CENTER;
 923               Direction d = LEFT;
 924               do
 925                 {
 926                   if (xexts[j].contains (at[d][X_AXIS]))
 927                     contains_dir = d;
 928                 }
 929               while (flip (&d) != LEFT);
 930
 931               if (!contains_dir)
 932                 continue;
 933               else
 934                 y = at[contains_dir][Y_AXIS];
 935             }
 936           else
 937             {
 938               y = scores->elem (i).curve_.get_other_coordinate (X_AXIS, x);
 939             }
 940
 941           if (yexts[j].contains (y))
 942             {
 943               if (Accidental_interface::has_interface (encompasses[j]))
 944                 demerit += score_param->ACCIDENTAL_COLLISION;
 945               else
 946                 demerit += score_param->EXTRA_OBJECT_COLLISION;
 947             }
 948         }
 949 #if DEBUG_SLUR_QUANTING
 950       (*scores)[i].score_card_ += to_string ("X%.2f", demerit);
 951 #endif
 952       (*scores)[i].score_ += demerit;
 953     }
 954 }
 955
 956 void
 957 score_edges (Grob *me, Grob *common[],
 958              Slur_score_parameters * score_param,
 959              Drul_array<Bound_info> extremes,
 960              Drul_array<Offset> base_attach,
 961              Array<Slur_score> *scores)
 962 {
 963   (void) common;
 964   Direction dir = get_grob_direction (me);
 965
 966   for (int i = 0; i < scores->size (); i++)
 967     {
 968       Direction d = LEFT;
 969       do
 970         {
 971           Real y = scores->elem (i).attachment_[d][Y_AXIS];
 972           Real dy = fabs (y - base_attach[d][Y_AXIS]);
 973
 974           Real factor = score_param->EDGE_ATTRACTION_FACTOR;
 975           Real demerit = factor * dy;
 976           if (extremes[d].stem_
 977               && extremes[d].stem_dir_ == dir
 978               && !Stem::get_beaming (extremes[d].stem_, -d)
 979               )
 980             demerit /= 5;
 981
 982           (*scores)[i].score_ += demerit;
 983 #if DEBUG_SLUR_QUANTING
 984           (*scores)[i].score_card_ += to_string ("E%.2f", demerit);
 985 #endif
 986         }
 987       while (flip (&d) != LEFT);
 988     }
 989 }
 990
 991 void
 992 score_slopes (Grob *me, Grob *common[],
 993               Slur_score_parameters *score_param,
 994               Drul_array<Bound_info> extremes,
 995               Drul_array<Offset> base_attach,
 996               Array<Slur_score> * scores)
 997 {
 998   (void) me;
 999   (void) base_attach;
1000
1001   Drul_array<Real> ys;
1002   Direction d = LEFT;
1003   do
1004     {
1005       if (extremes[d].slur_head_)
1006         ys[d] = extremes[d].slur_head_->relative_coordinate (common[Y_AXIS],
1007                                                               Y_AXIS);
1008       else
1009         ys[d] = extremes[d].neighbor_y_;
1010     }
1011   while (flip (&d) != LEFT);
1012
1013   bool has_beams
1014     = (extremes[LEFT].stem_ && Stem::get_beam (extremes[LEFT].stem_))
1015     || (extremes[RIGHT].stem_ && Stem::get_beam (extremes[RIGHT].stem_));
1016
1017   Real dy = ys[RIGHT] - ys[LEFT];
1018   for (int i = 0; i < scores->size (); i++)
1019     {
1020       Offset slur_dz = (*scores)[i].attachment_[RIGHT]
1021         - (*scores)[i].attachment_[LEFT];
1022       Real slur_dy = slur_dz[Y_AXIS];
1023       Real demerit = 0.0;
1024
1025       demerit += ((fabs (slur_dy / slur_dz[X_AXIS])
1026                    - score_param->MAX_SLOPE) >? 0)
1027         * score_param->MAX_SLOPE_FACTOR;
1028
1029       /* 0.2: account for staffline offset. */
1030       Real max_dy = (fabs (dy) + 0.2);
1031       if (has_beams)
1032         max_dy += 1.0;
1033
1034       demerit += score_param->STEEPER_SLOPE_FACTOR
1035         * ((fabs (slur_dy) -max_dy) >? 0);
1036
1037       demerit += ((fabs (slur_dy/slur_dz[X_AXIS])
1038                    - score_param->MAX_SLOPE) >? 0)
1039         * score_param->MAX_SLOPE_FACTOR;
1040
1041       if (sign (dy) == 0
1042           && sign (slur_dy) != 0)
1043         demerit += score_param->NON_HORIZONTAL_PENALTY;
1044
1045       if (sign (dy)
1046           && sign (slur_dy)
1047           && sign (slur_dy) != sign (dy))
1048         demerit += has_beams
1049           ? score_param->SAME_SLOPE_PENALTY / 10
1050           : score_param->SAME_SLOPE_PENALTY;
1051
1052 #if DEBUG_SLUR_QUANTING
1053       (*scores)[i].score_card_ += to_string ("S%.2f", d);
1054 #endif
1055       (*scores)[i].score_ += demerit;
1056     }
1057 }
1058
1059