lily/slur.cc

   1 /*
   2   slur.cc -- implement external interface for Slur
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1996--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7   Jan Nieuwenhuizen <janneke@gnu.org>
   8 */
   9
  10 #include "slur.hh"
  11
  12
  13 #include "beam.hh"
  14 #include "bezier.hh"
  15 #include "directional-element-interface.hh"
  16 #include "font-interface.hh"
  17 #include "pointer-group-interface.hh"
  18 #include "lookup.hh"
  19 #include "main.hh"              // DEBUG_SLUR_SCORING
  20 #include "note-column.hh"
  21 #include "output-def.hh"
  22 #include "spanner.hh"
  23 #include "staff-symbol-referencer.hh"
  24 #include "staff-symbol.hh"
  25 #include "stem.hh"
  26 #include "text-interface.hh"
  27 #include "tie.hh"
  28 #include "warn.hh"
  29 #include "slur-scoring.hh"
  30
  31 #include "script-interface.hh"
  32
  33
  34
  35 MAKE_SCHEME_CALLBACK(Slur, calc_direction, 1)
  36 SCM
  37 Slur::calc_direction (SCM smob)
  38 {
  39   Grob *me = unsmob_grob (smob);
  40   extract_grob_set (me, "note-columns", encompasses);
  41
  42   if (encompasses.empty ())
  43     {
  44       me->suicide ();
  45       return SCM_BOOL_F;
  46     }
  47
  48   Direction d = DOWN;
  49   for (vsize i = 0; i < encompasses.size (); i++)
  50     {
  51       if (Note_column::dir (encompasses[i]) < 0)
  52         {
  53           d = UP;
  54           break;
  55         }
  56     }
  57   return scm_from_int (d);
  58 }
  59
  60 MAKE_SCHEME_CALLBACK (Slur, pure_height, 3);
  61 SCM
  62 Slur::pure_height (SCM smob, SCM start_scm, SCM end_scm)
  63 {
  64   Grob *me = unsmob_grob (smob);
  65   int start = scm_to_int (start_scm);
  66   int end = scm_to_int (end_scm);
  67   Real height = robust_scm2double (me->get_property ("height-limit"), 2.0);
  68
  69   extract_grob_set (me, "note-columns", encompasses);
  70   Interval ret;
  71
  72   Grob *parent = me->get_parent (Y_AXIS);
  73   if (common_refpoint_of_array (encompasses, me, Y_AXIS) != parent)
  74     /* this could happen if, for example, we are a cross-staff slur.
  75        in this case, we want to be ignored */
  76     return ly_interval2scm (Interval ());
  77
  78   for (vsize i = 0; i < encompasses.size (); i++)
  79     {
  80       Interval d = encompasses[i]->pure_height (parent, start, end);
  81       if (!d.is_empty ())
  82         ret.unite (d);
  83     }
  84
  85   ret.widen (height * 0.5);
  86   return ly_interval2scm (ret);
  87 }
  88
  89 MAKE_SCHEME_CALLBACK (Slur, height, 1);
  90 SCM
  91 Slur::height (SCM smob)
  92 {
  93   Grob *me = unsmob_grob (smob);
  94
  95   // FIXME uncached
  96   Stencil *m = me->get_stencil ();
  97   return m ? ly_interval2scm (m->extent (Y_AXIS))
  98     : ly_interval2scm (Interval ());
  99 }
 100
 101 /*
 102   Ugh should have dash-length + dash-period
 103 */
 104 MAKE_SCHEME_CALLBACK (Slur, print, 1);
 105 SCM
 106 Slur::print (SCM smob)
 107 {
 108   Grob *me = unsmob_grob (smob);
 109   extract_grob_set (me, "note-columns", encompasses);
 110   if (encompasses.empty ())
 111     {
 112       me->suicide ();
 113       return SCM_EOL;
 114     }
 115
 116   Real staff_thick = Staff_symbol_referencer::line_thickness (me);
 117   Real base_thick = staff_thick
 118     * robust_scm2double (me->get_property ("thickness"), 1);
 119   Real line_thick = staff_thick
 120     * robust_scm2double (me->get_property ("line-thickness"), 1);
 121
 122   Bezier one = get_curve (me);
 123   Stencil a;
 124
 125   /*
 126     TODO: replace dashed with generic property.
 127   */
 128   SCM p = me->get_property ("dash-period");
 129   SCM f = me->get_property ("dash-fraction");
 130   if (scm_is_number (p) && scm_is_number (f))
 131     a = Lookup::dashed_slur (one, line_thick, robust_scm2double (p, 1.0),
 132                              robust_scm2double (f, 0));
 133   else
 134     a = Lookup::slur (one,
 135                       get_grob_direction (me) * base_thick,
 136                       line_thick);
 137
 138 #if DEBUG_SLUR_SCORING
 139   SCM quant_score = me->get_property ("quant-score");
 140
 141   if (to_boolean (me->layout ()
 142                   ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")))
 143       && scm_is_string (quant_score))
 144     {
 145       string str;
 146       SCM properties = Font_interface::text_font_alist_chain (me);
 147
 148
 149       if (!scm_is_number (me->get_property ("font-size")))
 150         properties = scm_cons (scm_acons (ly_symbol2scm ("font-size"), scm_from_int (-6), SCM_EOL),
 151                              properties);
 152
 153       Stencil tm = *unsmob_stencil (Text_interface::interpret_markup
 154                                     (me->layout ()->self_scm (), properties,
 155                                      quant_score));
 156       a.add_at_edge (Y_AXIS, get_grob_direction (me), tm, 1.0, 0);
 157     }
 158 #endif
 159
 160   return a.smobbed_copy ();
 161 }
 162
 163 Bezier
 164 Slur::get_curve (Grob *me)
 165 {
 166   Bezier b;
 167   int i = 0;
 168   for (SCM s = me->get_property ("control-points"); scm_is_pair (s);
 169        s = scm_cdr (s))
 170     b.control_[i++] = ly_scm2offset (scm_car (s));
 171
 172   return b;
 173 }
 174
 175 void
 176 Slur::add_column (Grob *me, Grob *n)
 177 {
 178   Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n);
 179   add_bound_item (dynamic_cast<Spanner *> (me), dynamic_cast<Item *> (n));
 180 }
 181
 182 void
 183 Slur::add_extra_encompass (Grob *me, Grob *n)
 184 {
 185   Pointer_group_interface::add_grob (me, ly_symbol2scm ("encompass-objects"), n);
 186 }
 187
 188
 189 MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Slur, outside_slur_callback, 2, 1);
 190 SCM
 191 Slur::outside_slur_callback (SCM grob, SCM offset_scm)
 192 {
 193   Grob *script = unsmob_grob (grob);
 194   Grob *slur = unsmob_grob (script->get_object ("slur"));
 195
 196   if (!slur)
 197     return offset_scm;
 198
 199   SCM avoid = script->get_property ("avoid-slur");
 200   if (avoid != ly_symbol2scm ("outside")
 201       && avoid != ly_symbol2scm ("around"))
 202     return offset_scm;
 203
 204   Direction dir = get_grob_direction (script);
 205   if (dir == CENTER)
 206     return offset_scm;
 207
 208   Grob *cx = script->common_refpoint (slur, X_AXIS);
 209   Grob *cy = script->common_refpoint (slur, Y_AXIS);
 210
 211   Bezier curve = Slur::get_curve (slur);
 212
 213   curve.translate (Offset (slur->relative_coordinate (cx, X_AXIS),
 214                            slur->relative_coordinate (cy, Y_AXIS)));
 215
 216   Interval yext = robust_relative_extent (script, cy, Y_AXIS);
 217   Interval xext = robust_relative_extent (script, cx, X_AXIS);
 218
 219   Real offset = robust_scm2double (offset_scm, 0);
 220   yext.translate (offset);
 221
 222   /* FIXME: slur property, script property?  */
 223   Real slur_padding = robust_scm2double (script->get_property ("slur-padding"),
 224                                          0.0);
 225   yext.widen (slur_padding);
 226
 227   Real EPS = 1e-3;
 228   Interval bezext (curve.control_[0][X_AXIS], curve.control_[3][X_AXIS]);
 229   bool consider[] = { false, false, false };
 230   Real ys[] = {0, 0, 0};
 231   bool do_shift = false;
 232
 233   for (int d = LEFT, k = 0; d <= RIGHT; d++, k++)
 234     {
 235       Real x = xext.linear_combination ((Direction) d);
 236       consider[k] = bezext.contains (x);
 237
 238       if (consider[k])
 239         {
 240           ys[k]
 241             = (fabs (bezext[LEFT] - x) < EPS)
 242             ? curve.control_[0][Y_AXIS]
 243             : ((fabs (bezext[RIGHT] - x) < EPS)
 244                ? curve.control_[3][Y_AXIS]
 245                : curve.get_other_coordinate (X_AXIS, x));
 246
 247           /* Request shift if slur is contained script's Y, or if
 248              script is inside slur and avoid == outside.  */
 249           if (yext.contains (ys[k])
 250               || (dir * ys[k] > dir * yext[-dir] && avoid == ly_symbol2scm ("outside")))
 251             do_shift = true;
 252         }
 253     }
 254
 255   Real avoidance_offset = 0.0;
 256   for (int d = LEFT, k = 0; d <= RIGHT; d++, k++)
 257     if (consider[k])
 258       avoidance_offset = dir * (max (dir * avoidance_offset,
 259                                      dir * (ys[k] - yext[-dir] + dir * slur_padding)));
 260
 261   return scm_from_double (offset + avoidance_offset);
 262 }
 263
 264 /*
 265  * Used by Slur_engraver:: and Phrasing_slur_engraver::
 266  */
 267 void
 268 Slur::auxiliary_acknowledge_extra_object (Grob_info info,
 269                                           vector<Grob*> &slurs,
 270                                           vector<Grob*> &end_slurs)
 271 {
 272   if (slurs.empty () && end_slurs.empty ())
 273     return;
 274
 275   Grob *e = info.grob ();
 276   SCM avoid = e->get_property ("avoid-slur");
 277   if (Tie::has_interface (e)
 278       || avoid == ly_symbol2scm ("inside"))
 279     {
 280       for (vsize i = slurs.size (); i--;)
 281         add_extra_encompass (slurs[i], e);
 282       for (vsize i = end_slurs.size (); i--;)
 283         add_extra_encompass (end_slurs[i], e);
 284     }
 285   else if (avoid == ly_symbol2scm ("outside")
 286            || avoid == ly_symbol2scm ("around"))
 287     {
 288       Grob *slur;
 289       if (end_slurs.size () && !slurs.size ())
 290         slur = end_slurs[0];
 291       else
 292         slur = slurs[0];
 293
 294       if (slur)
 295         {
 296           chain_offset_callback (e, outside_slur_callback_proc, Y_AXIS);
 297           e->set_object ("slur", slur->self_scm ());
 298         }
 299     }
 300   else
 301     e->warning ("Ignoring grob for slur. avoid-slur not set?");
 302 }
 303
 304
 305 ADD_INTERFACE (Slur, "slur-interface",
 306
 307                "A slur",
 308
 309                /* properties */
 310                "avoid-slur "    /* UGH. */
 311                "control-points "
 312                "dash-fraction "
 313                "dash-period "
 314                "details "
 315                "direction "
 316                "eccentricity "
 317                "encompass-objects "
 318                "height-limit "
 319                "inspect-quants "
 320                "inspect-index "
 321                "line-thickness "
 322                "note-columns "
 323                "positions "
 324                "quant-score "
 325                "ratio "
 326                "thickness "
 327                );
 328