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, height, 1);
  61 SCM
  62 Slur::height (SCM smob)
  63 {
  64   Grob *me = unsmob_grob (smob);
  65
  66   // FIXME uncached
  67   Stencil *m = me->get_stencil ();
  68   return m ? ly_interval2scm (m->extent (Y_AXIS))
  69     : ly_interval2scm (Interval ());
  70 }
  71
  72 /*
  73   Ugh should have dash-length + dash-period
  74 */
  75 MAKE_SCHEME_CALLBACK (Slur, print, 1);
  76 SCM
  77 Slur::print (SCM smob)
  78 {
  79   Grob *me = unsmob_grob (smob);
  80   extract_grob_set (me, "note-columns", encompasses);
  81   if (encompasses.empty ())
  82     {
  83       me->suicide ();
  84       return SCM_EOL;
  85     }
  86
  87   Real staff_thick = Staff_symbol_referencer::line_thickness (me);
  88   Real base_thick = staff_thick
  89     * robust_scm2double (me->get_property ("thickness"), 1);
  90   Real line_thick = staff_thick
  91     * robust_scm2double (me->get_property ("line-thickness"), 1);
  92
  93   Bezier one = get_curve (me);
  94   Stencil a;
  95
  96   /*
  97     TODO: replace dashed with generic property.
  98   */
  99   SCM p = me->get_property ("dash-period");
 100   SCM f = me->get_property ("dash-fraction");
 101   if (scm_is_number (p) && scm_is_number (f))
 102     a = Lookup::dashed_slur (one, line_thick, robust_scm2double (p, 1.0),
 103                              robust_scm2double (f, 0));
 104   else
 105     a = Lookup::slur (one,
 106                       get_grob_direction (me) * base_thick,
 107                       line_thick);
 108
 109 #if DEBUG_SLUR_SCORING
 110   SCM quant_score = me->get_property ("quant-score");
 111
 112   if (to_boolean (me->layout ()
 113                   ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")))
 114       && scm_is_string (quant_score))
 115     {
 116       string str;
 117       SCM properties = Font_interface::text_font_alist_chain (me);
 118
 119
 120       if (!scm_is_number (me->get_property ("font-size")))
 121         properties = scm_cons (scm_acons (ly_symbol2scm ("font-size"), scm_from_int (-6), SCM_EOL),
 122                              properties);
 123
 124       Stencil tm = *unsmob_stencil (Text_interface::interpret_markup
 125                                     (me->layout ()->self_scm (), properties,
 126                                      quant_score));
 127       a.add_at_edge (Y_AXIS, get_grob_direction (me), tm, 1.0, 0);
 128     }
 129 #endif
 130
 131   return a.smobbed_copy ();
 132 }
 133
 134 Bezier
 135 Slur::get_curve (Grob *me)
 136 {
 137   Bezier b;
 138   int i = 0;
 139   for (SCM s = me->get_property ("control-points"); s != SCM_EOL;
 140        s = scm_cdr (s))
 141     b.control_[i++] = ly_scm2offset (scm_car (s));
 142
 143   return b;
 144 }
 145
 146 void
 147 Slur::add_column (Grob *me, Grob *n)
 148 {
 149   Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n);
 150   add_bound_item (dynamic_cast<Spanner *> (me), dynamic_cast<Item *> (n));
 151 }
 152
 153 void
 154 Slur::add_extra_encompass (Grob *me, Grob *n)
 155 {
 156   Pointer_group_interface::add_grob (me, ly_symbol2scm ("encompass-objects"), n);
 157 }
 158
 159
 160 MAKE_SCHEME_CALLBACK (Slur, outside_slur_callback, 2);
 161 SCM
 162 Slur::outside_slur_callback (SCM grob, SCM offset_scm)
 163 {
 164   Grob *script = unsmob_grob (grob);
 165   Grob *slur = unsmob_grob (script->get_object ("slur"));
 166
 167   if (!slur)
 168     return offset_scm;
 169
 170   SCM avoid = script->get_property ("avoid-slur");
 171   if (avoid != ly_symbol2scm ("outside")
 172       && avoid != ly_symbol2scm ("around"))
 173     return offset_scm;
 174
 175   Direction dir = get_grob_direction (script);
 176   if (dir == CENTER)
 177     return offset_scm;
 178
 179   Grob *cx = script->common_refpoint (slur, X_AXIS);
 180   Grob *cy = script->common_refpoint (slur, Y_AXIS);
 181
 182   Bezier curve = Slur::get_curve (slur);
 183
 184   curve.translate (Offset (slur->relative_coordinate (cx, X_AXIS),
 185                            slur->relative_coordinate (cy, Y_AXIS)));
 186
 187   Interval yext = robust_relative_extent (script, cy, Y_AXIS);
 188   Interval xext = robust_relative_extent (script, cx, X_AXIS);
 189
 190   yext.translate (robust_scm2double (offset_scm, 0));
 191
 192
 193   /* FIXME: slur property, script property?  */
 194   Real slur_padding = robust_scm2double (script->get_property ("slur-padding"),
 195                                          0.0);
 196   yext.widen (slur_padding);
 197
 198   Real EPS = 1e-3;
 199   Interval bezext (curve.control_[0][X_AXIS], curve.control_[3][X_AXIS]);
 200   bool consider[] = { false, false, false };
 201   Real ys[] = {0, 0, 0};
 202   bool do_shift = false;
 203
 204   for (int d = LEFT, k = 0; d <= RIGHT; d++, k++)
 205     {
 206       Real x = xext.linear_combination ((Direction) d);
 207       consider[k] = bezext.contains (x);
 208
 209       if (consider[k])
 210         {
 211           ys[k]
 212             = (fabs (bezext[LEFT] - x) < EPS)
 213             ? curve.control_[0][Y_AXIS]
 214             : ((fabs (bezext[RIGHT] - x) < EPS)
 215                ? curve.control_[3][Y_AXIS]
 216                : curve.get_other_coordinate (X_AXIS, x));
 217
 218           /* Request shift if slur is contained script's Y, or if
 219              script is inside slur and avoid == outside.  */
 220           if (yext.contains (ys[k])
 221               || (dir * ys[k] > dir * yext[-dir] && avoid == ly_symbol2scm ("outside")))
 222             do_shift = true;
 223         }
 224     }
 225
 226   Real avoidance_offset = 0.0;
 227   for (int d = LEFT, k = 0; d <= RIGHT; d++, k++)
 228     if (consider[k])
 229       avoidance_offset = dir * (max (dir * avoidance_offset,
 230                                      dir * (ys[k] - yext[-dir] + dir * slur_padding)));
 231
 232   return scm_from_double (scm_to_double (offset_scm) + avoidance_offset);
 233 }
 234
 235 /*
 236  * Used by Slur_engraver:: and Phrasing_slur_engraver::
 237  */
 238 void
 239 Slur::auxiliary_acknowledge_extra_object (Grob_info info,
 240   vector<Grob*>& slurs, vector<Grob*>& end_slurs)
 241 {
 242   if (slurs.empty () && end_slurs.empty ())
 243     return;
 244
 245   Grob *e = info.grob ();
 246   SCM avoid = e->get_property ("avoid-slur");
 247   if (Tie::has_interface (e)
 248       || avoid == ly_symbol2scm ("inside"))
 249     {
 250       for (vsize i = slurs.size (); i--;)
 251         add_extra_encompass (slurs[i], e);
 252       for (vsize i = end_slurs.size (); i--;)
 253         add_extra_encompass (end_slurs[i], e);
 254     }
 255   else if (avoid == ly_symbol2scm ("outside")
 256            || avoid == ly_symbol2scm ("around"))
 257     {
 258       Grob *slur;
 259       if (end_slurs.size () && !slurs.size ())
 260         slur = end_slurs[0];
 261       else
 262         slur = slurs[0];
 263
 264       if (slur)
 265         {
 266           chain_offset_callback (e, outside_slur_callback_proc, Y_AXIS);
 267           e->set_object ("slur", slur->self_scm ());
 268         }
 269     }
 270   else
 271     e->warning ("Ignoring grob for slur. avoid-slur not set?");
 272 }
 273
 274
 275 ADD_INTERFACE (Slur, "slur-interface",
 276
 277                "A slur",
 278
 279                /* properties */
 280                "avoid-slur "    /* UGH. */
 281                "control-points "
 282                "dash-fraction "
 283                "dash-period "
 284                "details "
 285                "direction "
 286                "eccentricity "
 287                "encompass-objects "
 288                "height-limit "
 289                "line-thickness "
 290                "note-columns "
 291                "positions "
 292                "quant-score "
 293                "ratio "
 294                "thickness "
 295
 296                );
 297