lily/slur.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1996--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5   Jan Nieuwenhuizen <janneke@gnu.org>
   6
   7   LilyPond is free software: you can redistribute it and/or modify
   8   it under the terms of the GNU General Public License as published by
   9   the Free Software Foundation, either version 3 of the License, or
  10   (at your option) any later version.
  11
  12   LilyPond is distributed in the hope that it will be useful,
  13   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15   GNU General Public License for more details.
  16
  17   You should have received a copy of the GNU General Public License
  18   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include "slur.hh"
  22 #include "grob-info.hh"
  23 #include "grob-array.hh"
  24 #include "beam.hh"
  25 #include "bezier.hh"
  26 #include "directional-element-interface.hh"
  27 #include "font-interface.hh"
  28 #include "item.hh"
  29 #include "pointer-group-interface.hh"
  30 #include "lookup.hh"
  31 #include "main.hh"              // DEBUG_SLUR_SCORING
  32 #include "note-column.hh"
  33 #include "output-def.hh"
  34 #include "spanner.hh"
  35 #include "staff-symbol-referencer.hh"
  36 #include "stem.hh"
  37 #include "text-interface.hh"
  38 #include "tie.hh"
  39 #include "warn.hh"
  40 #include "slur-scoring.hh"
  41 #include "separation-item.hh"
  42 #include "international.hh"
  43
  44 MAKE_SCHEME_CALLBACK (Slur, calc_direction, 1)
  45 SCM
  46 Slur::calc_direction (SCM smob)
  47 {
  48   Grob *me = unsmob_grob (smob);
  49   extract_grob_set (me, "note-columns", encompasses);
  50
  51   if (encompasses.empty ())
  52     {
  53       me->suicide ();
  54       return SCM_BOOL_F;
  55     }
  56
  57   Direction d = DOWN;
  58   for (vsize i = 0; i < encompasses.size (); i++)
  59     {
  60       if (Note_column::dir (encompasses[i]) < 0)
  61         {
  62           d = UP;
  63           break;
  64         }
  65     }
  66   return scm_from_int (d);
  67 }
  68
  69 MAKE_SCHEME_CALLBACK (Slur, pure_height, 3);
  70 SCM
  71 Slur::pure_height (SCM smob, SCM start_scm, SCM end_scm)
  72 {
  73   Grob *me = unsmob_grob (smob);
  74   int start = scm_to_int (start_scm);
  75   int end = scm_to_int (end_scm);
  76   Real height = robust_scm2double (me->get_property ("height-limit"), 2.0);
  77
  78   extract_grob_set (me, "note-columns", encompasses);
  79   Interval ret;
  80
  81   Grob *parent = me->get_parent (Y_AXIS);
  82   if (common_refpoint_of_array (encompasses, me, Y_AXIS) != parent)
  83     /* this could happen if, for example, we are a cross-staff slur.
  84        in this case, we want to be ignored */
  85     return ly_interval2scm (Interval ());
  86
  87   for (vsize i = 0; i < encompasses.size (); i++)
  88     {
  89       Interval d = encompasses[i]->pure_height (parent, start, end);
  90       if (!d.is_empty ())
  91         ret.unite (d);
  92     }
  93
  94   // The +0.5 comes from the fact that we try to place a slur
  95   // 0.5 staff spaces from the note-head.
  96   // (see Slur_score_state.get_base_attachments ())
  97   ret.widen (height * 0.5 + 0.5);
  98   return ly_interval2scm (ret);
  99 }
 100
 101 MAKE_SCHEME_CALLBACK (Slur, height, 1);
 102 SCM
 103 Slur::height (SCM smob)
 104 {
 105   Grob *me = unsmob_grob (smob);
 106
 107   // FIXME uncached
 108   Stencil *m = me->get_stencil ();
 109   return m ? ly_interval2scm (m->extent (Y_AXIS))
 110          : ly_interval2scm (Interval ());
 111 }
 112
 113 MAKE_SCHEME_CALLBACK (Slur, print, 1);
 114 SCM
 115 Slur::print (SCM smob)
 116 {
 117   Grob *me = unsmob_grob (smob);
 118   extract_grob_set (me, "note-columns", encompasses);
 119   if (encompasses.empty ())
 120     {
 121       me->suicide ();
 122       return SCM_EOL;
 123     }
 124
 125   Real staff_thick = Staff_symbol_referencer::line_thickness (me);
 126   Real base_thick = staff_thick
 127                     * robust_scm2double (me->get_property ("thickness"), 1);
 128   Real line_thick = staff_thick
 129                     * robust_scm2double (me->get_property ("line-thickness"), 1);
 130
 131   Bezier one = get_curve (me);
 132   Stencil a;
 133
 134   SCM dash_definition = me->get_property ("dash-definition");
 135   a = Lookup::slur (one,
 136                     get_grob_direction (me) * base_thick,
 137                     line_thick,
 138                     dash_definition);
 139
 140 #if DEBUG_SLUR_SCORING
 141   SCM annotation = me->get_property ("annotation");
 142   if (scm_is_string (annotation))
 143     {
 144       string str;
 145       SCM properties = Font_interface::text_font_alist_chain (me);
 146
 147       if (!scm_is_number (me->get_property ("font-size")))
 148         properties = scm_cons (scm_acons (ly_symbol2scm ("font-size"), scm_from_int (-6), SCM_EOL),
 149                                properties);
 150
 151       Stencil tm = *unsmob_stencil (Text_interface::interpret_markup
 152                                     (me->layout ()->self_scm (), properties,
 153                                      annotation));
 154       a.add_at_edge (Y_AXIS, get_grob_direction (me), tm, 1.0);
 155     }
 156 #endif
 157
 158   return a.smobbed_copy ();
 159 }
 160
 161 /*
 162   it would be better to do this at engraver level, but that is
 163   fragile, as the breakable items are generated on staff level, at
 164   which point slur starts and ends have to be tracked
 165 */
 166 void
 167 Slur::replace_breakable_encompass_objects (Grob *me)
 168 {
 169   extract_grob_set (me, "encompass-objects", extra_objects);
 170   vector<Grob *> new_encompasses;
 171
 172   for (vsize i = 0; i < extra_objects.size (); i++)
 173     {
 174       Grob *g = extra_objects[i];
 175
 176       if (Separation_item::has_interface (g))
 177         {
 178           extract_grob_set (g, "elements", breakables);
 179           for (vsize j = 0; j < breakables.size (); j++)
 180             /* if we encompass a separation-item that spans multiple staves,
 181                we filter out the grobs that don't belong to our staff */
 182             if (me->common_refpoint (breakables[j], Y_AXIS) == me->get_parent (Y_AXIS)
 183                 && breakables[j]->get_property ("avoid-slur") == ly_symbol2scm ("inside"))
 184               new_encompasses.push_back (breakables[j]);
 185         }
 186       else
 187         new_encompasses.push_back (g);
 188     }
 189
 190   SCM encompass_scm = me->get_object ("encompass-objects");
 191   if (Grob_array::unsmob (encompass_scm))
 192     {
 193       vector<Grob *> &arr
 194         = unsmob_grob_array (encompass_scm)->array_reference ();
 195       arr = new_encompasses;
 196     }
 197 }
 198
 199 Bezier
 200 Slur::get_curve (Grob *me)
 201 {
 202   Bezier b;
 203   int i = 0;
 204   for (SCM s = me->get_property ("control-points"); scm_is_pair (s);
 205        s = scm_cdr (s))
 206     b.control_[i++] = ly_scm2offset (scm_car (s));
 207
 208   return b;
 209 }
 210
 211 void
 212 Slur::add_column (Grob *me, Grob *n)
 213 {
 214   Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n);
 215   add_bound_item (dynamic_cast<Spanner *> (me), n);
 216 }
 217
 218 void
 219 Slur::add_extra_encompass (Grob *me, Grob *n)
 220 {
 221   Pointer_group_interface::add_grob (me, ly_symbol2scm ("encompass-objects"), n);
 222 }
 223
 224 MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Slur, pure_outside_slur_callback, 4, 1, "");
 225 SCM
 226 Slur::pure_outside_slur_callback (SCM grob, SCM start_scm, SCM end_scm, SCM offset_scm)
 227 {
 228   int start = robust_scm2int (start_scm, 0);
 229   int end = robust_scm2int (end_scm, 0);
 230   Grob *script = unsmob_grob (grob);
 231   Grob *slur = unsmob_grob (script->get_object ("slur"));
 232   if (!slur)
 233     return offset_scm;
 234
 235   SCM avoid = script->get_property ("avoid-slur");
 236   if (avoid != ly_symbol2scm ("outside") && avoid != ly_symbol2scm ("around"))
 237     return offset_scm;
 238
 239   Real offset = robust_scm2double (offset_scm, 0.0);
 240   Direction dir = get_grob_direction (script);
 241   return scm_from_double (offset + dir * slur->pure_height (slur, start, end).length () / 4);
 242 }
 243
 244 MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Slur, outside_slur_callback, 2, 1, "");
 245 SCM
 246 Slur::outside_slur_callback (SCM grob, SCM offset_scm)
 247 {
 248   Grob *script = unsmob_grob (grob);
 249   Grob *slur = unsmob_grob (script->get_object ("slur"));
 250
 251   if (!slur)
 252     return offset_scm;
 253
 254   SCM avoid = script->get_property ("avoid-slur");
 255   if (avoid != ly_symbol2scm ("outside")
 256       && avoid != ly_symbol2scm ("around"))
 257     return offset_scm;
 258
 259   Direction dir = get_grob_direction (script);
 260   if (dir == CENTER)
 261     return offset_scm;
 262
 263   Grob *cx = script->common_refpoint (slur, X_AXIS);
 264   Grob *cy = script->common_refpoint (slur, Y_AXIS);
 265
 266   Bezier curve = Slur::get_curve (slur);
 267
 268   curve.translate (Offset (slur->relative_coordinate (cx, X_AXIS),
 269                            slur->relative_coordinate (cy, Y_AXIS)));
 270
 271   Interval yext = robust_relative_extent (script, cy, Y_AXIS);
 272   Interval xext = robust_relative_extent (script, cx, X_AXIS);
 273
 274   Real offset = robust_scm2double (offset_scm, 0);
 275   yext.translate (offset);
 276
 277   /* FIXME: slur property, script property?  */
 278   Real slur_padding = robust_scm2double (script->get_property ("slur-padding"),
 279                                          0.0);
 280   yext.widen (slur_padding);
 281
 282   Interval exts[] = {xext, yext};
 283   bool do_shift = false;
 284   Real EPS = 1.0e-5;
 285   if (avoid == ly_symbol2scm ("outside"))
 286     {
 287       Direction d = LEFT;
 288       do
 289         {
 290           Real x = minmax (-d, xext[d], curve.control_[d == LEFT ? 0 : 3][X_AXIS] + -d * EPS);
 291           Real y = curve.get_other_coordinate (X_AXIS, x);
 292           do_shift = y == minmax (dir, yext[-dir], y);
 293           if (do_shift)
 294             break;
 295         }
 296       while (flip (&d) != LEFT);
 297     }
 298   else
 299     {
 300       for (int a = X_AXIS; a < NO_AXES; a++)
 301         {
 302           Direction d = LEFT;
 303           do
 304             {
 305               vector<Real> coords = curve.get_other_coordinates (Axis (a), exts[a][d]);
 306               for (vsize i = 0; i < coords.size (); i++)
 307                 {
 308                   do_shift = exts[(a + 1) % NO_AXES].contains (coords[i]);
 309                   if (do_shift)
 310                     break;
 311                 }
 312               if (do_shift)
 313                 break;
 314             }
 315           while (flip (&d) != LEFT);
 316           if (do_shift)
 317             break;
 318         }
 319     }
 320
 321   Real avoidance_offset = do_shift ? curve.minmax (X_AXIS, max (xext[LEFT], curve.control_[0][X_AXIS] + EPS), min (xext[RIGHT], curve.control_[3][X_AXIS] - EPS), dir) - yext[-dir] : 0.0;
 322
 323   return scm_from_double (offset + avoidance_offset);
 324 }
 325
 326 /*
 327  * Used by Slur_engraver:: and Phrasing_slur_engraver::
 328  */
 329 void
 330 Slur::auxiliary_acknowledge_extra_object (Grob_info const &info,
 331                                           vector<Grob *> &slurs,
 332                                           vector<Grob *> &end_slurs)
 333 {
 334   if (slurs.empty () && end_slurs.empty ())
 335     return;
 336
 337   Grob *e = info.grob ();
 338   SCM avoid = e->get_property ("avoid-slur");
 339   if (Tie::has_interface (e)
 340       || avoid == ly_symbol2scm ("inside"))
 341     {
 342       for (vsize i = slurs.size (); i--;)
 343         add_extra_encompass (slurs[i], e);
 344       for (vsize i = end_slurs.size (); i--;)
 345         add_extra_encompass (end_slurs[i], e);
 346     }
 347   else if (avoid == ly_symbol2scm ("outside")
 348            || avoid == ly_symbol2scm ("around"))
 349     {
 350       Grob *slur;
 351       if (end_slurs.size () && !slurs.size ())
 352         slur = end_slurs[0];
 353       else
 354         slur = slurs[0];
 355
 356       if (slur)
 357         {
 358           chain_offset_callback (e, outside_slur_callback_proc, Y_AXIS);
 359           chain_callback (e, outside_slur_cross_staff_proc, ly_symbol2scm ("cross-staff"));
 360           e->set_object ("slur", slur->self_scm ());
 361         }
 362     }
 363   else if (avoid != ly_symbol2scm ("ignore"))
 364     e->warning (_f ("Ignoring grob for slur: %s. avoid-slur not set?",
 365                     e->name ().c_str ()));
 366 }
 367
 368 /*
 369   A callback that will be chained together with the original cross-staff
 370   value of a grob that is placed 'outside or 'around a slur. This just says
 371   that any grob becomes cross-staff if it is placed 'outside or 'around a
 372   cross-staff slur.
 373 */
 374 MAKE_SCHEME_CALLBACK (Slur, outside_slur_cross_staff, 2)
 375 SCM
 376 Slur::outside_slur_cross_staff (SCM smob, SCM previous)
 377 {
 378   if (previous == SCM_BOOL_T)
 379     return previous;
 380
 381   Grob *me = unsmob_grob (smob);
 382   Grob *slur = unsmob_grob (me->get_object ("slur"));
 383
 384   if (!slur)
 385     return SCM_BOOL_F;
 386   return slur->get_property ("cross-staff");
 387 }
 388
 389 MAKE_SCHEME_CALLBACK (Slur, calc_cross_staff, 1)
 390 SCM
 391 Slur::calc_cross_staff (SCM smob)
 392 {
 393   Grob *me = unsmob_grob (smob);
 394
 395   extract_grob_set (me, "note-columns", cols);
 396   extract_grob_set (me, "encompass-objects", extras);
 397
 398   for (vsize i = 0; i < cols.size (); i++)
 399     {
 400       if (Grob *s = Note_column::get_stem (cols[i]))
 401         if (to_boolean (s->get_property ("cross-staff")))
 402           return SCM_BOOL_T;
 403     }
 404
 405   /* the separation items are dealt with in replace_breakable_encompass_objects
 406      so we can ignore them here */
 407   vector<Grob *> non_sep_extras;
 408   for (vsize i = 0; i < extras.size (); i++)
 409     if (!Separation_item::has_interface (extras[i]))
 410       non_sep_extras.push_back (extras[i]);
 411
 412   Grob *common = common_refpoint_of_array (cols, me, Y_AXIS);
 413   common = common_refpoint_of_array (non_sep_extras, common, Y_AXIS);
 414
 415   return scm_from_bool (common != me->get_parent (Y_AXIS));
 416 }
 417
 418 ADD_INTERFACE (Slur,
 419                "A slur."
 420                "\n"
 421                "The following properties may be set in the @code{details}"
 422                " list.\n"
 423                "\n"
 424                "@table @code\n"
 425                "@item region-size\n"
 426                "Size of region (in staff spaces) for determining"
 427                " potential endpoints in the Y direction.\n"
 428                "@item head-encompass-penalty\n"
 429                "Demerit to apply when note heads collide with a slur.\n"
 430                "@item stem-encompass-penalty\n"
 431                "Demerit to apply when stems collide with a slur.\n"
 432                "@item closeness-factor\n"
 433                "Additional demerit used when scoring encompasses.\n"
 434                "@item edge-attraction-factor\n"
 435                "Factor used to calculate the demerit for distances"
 436                " between slur endpoints and their corresponding base"
 437                " attachments.\n"
 438                "@item same-slope-penalty\n"
 439                "Demerit for slurs with attachment points that are"
 440                " horizontally aligned.\n"
 441                "@item steeper-slope-factor\n"
 442                "Factor used to calculate demerit only if this slur is"
 443                " not broken.\n"
 444                "@item non-horizontal-penalty\n"
 445                "Demerit for slurs with attachment points that are not"
 446                " horizontally aligned.\n"
 447                "@item max-slope\n"
 448                "The maximum slope allowed for this slur.\n"
 449                "@item max-slope-factor\n"
 450                "Factor that calculates demerit based on the max slope.\n"
 451                "@item free-head-distance\n"
 452                "The amount of vertical free space that must exist"
 453                " between a slur and note heads.\n"
 454                "@item absolute-closeness-measure\n"
 455                "Factor to calculate demerit for variance between a note"
 456                " head and slur.\n"
 457                "@item extra-object-collision-penalty\n"
 458                "Factor to calculate demerit for extra objects that the"
 459                " slur encompasses, including accidentals, fingerings, and"
 460                " tuplet numbers.\n"
 461                "@item accidental-collision\n"
 462                "Factor to calculate demerit for @code{Accidental} objects"
 463                " that the slur encompasses.  This property value replaces"
 464                " the value of @code{extra-object-collision-penalty}.\n"
 465                "@item extra-encompass-free-distance\n"
 466                "The amount of vertical free space that must exist"
 467                " between a slur and various objects it encompasses,"
 468                " including accidentals, fingerings, and tuplet numbers.\n"
 469                "@item extra-encompass-collision-distance\n"
 470                "This detail is currently unused.\n"
 471                "@item head-slur-distance-factor\n"
 472                "Factor to calculate demerit for variance between a note"
 473                " head and slur.\n"
 474                "@item head-slur-distance-max-ratio\n"
 475                "The maximum value for the ratio of distance between a"
 476                " note head and slur.\n"
 477                "@item free-slur-distance\n"
 478                "The amount of vertical free space that must exist"
 479                " between adjacent slurs.  This subproperty only works"
 480                " for @code{PhrasingSlur}.\n"
 481                "@item edge-slope-exponent\n"
 482                "Factor used to calculate the demerit for the slope of"
 483                " a slur near its endpoints; a larger value yields a"
 484                " larger demerit.\n"
 485                "@end table\n",
 486
 487                /* properties */
 488                "annotation "
 489                "avoid-slur "    /* UGH. */
 490                "control-points "
 491                "dash-definition "
 492                "details "
 493                "direction "
 494                "eccentricity "
 495                "encompass-objects "
 496                "height-limit "
 497                "inspect-quants "
 498                "inspect-index "
 499                "line-thickness "
 500                "note-columns "
 501                "positions "
 502                "ratio "
 503                "thickness "
 504               );
 505