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 "warn.hh"
  28 #include "slur-scoring.hh"
  29
  30 #include "script-interface.hh"
  31
  32
  33
  34 MAKE_SCHEME_CALLBACK(Slur, calc_direction, 1)
  35 SCM
  36 Slur::calc_direction (SCM smob)
  37 {
  38   Grob *me = unsmob_grob (smob);
  39   extract_grob_set (me, "note-columns", encompasses);
  40
  41   if (encompasses.empty ())
  42     {
  43       me->suicide ();
  44       return SCM_BOOL_F;
  45     }
  46
  47   Direction d = DOWN;
  48   for (vsize i = 0; i < encompasses.size (); i++)
  49     {
  50       if (Note_column::dir (encompasses[i]) < 0)
  51         {
  52           d = UP;
  53           break;
  54         }
  55     }
  56   return scm_from_int (d);
  57 }
  58
  59 MAKE_SCHEME_CALLBACK (Slur, height, 1);
  60 SCM
  61 Slur::height (SCM smob)
  62 {
  63   Grob *me = unsmob_grob (smob);
  64
  65   // FIXME uncached
  66   Stencil *m = me->get_stencil ();
  67   return m ? ly_interval2scm (m->extent (Y_AXIS))
  68     : ly_interval2scm (Interval ());
  69 }
  70
  71 /*
  72   Ugh should have dash-length + dash-period
  73 */
  74 MAKE_SCHEME_CALLBACK (Slur, print, 1);
  75 SCM
  76 Slur::print (SCM smob)
  77 {
  78   Grob *me = unsmob_grob (smob);
  79   extract_grob_set (me, "note-columns", encompasses);
  80   if (encompasses.empty ())
  81     {
  82       me->suicide ();
  83       return SCM_EOL;
  84     }
  85
  86   Real staff_thick = Staff_symbol_referencer::line_thickness (me);
  87   Real base_thick = staff_thick
  88     * robust_scm2double (me->get_property ("thickness"), 1);
  89   Real line_thick = staff_thick
  90     * robust_scm2double (me->get_property ("line-thickness"), 1);
  91
  92   Bezier one = get_curve (me);
  93   Stencil a;
  94
  95   /*
  96     TODO: replace dashed with generic property.
  97   */
  98   SCM p = me->get_property ("dash-period");
  99   SCM f = me->get_property ("dash-fraction");
 100   if (scm_is_number (p) && scm_is_number (f))
 101     a = Lookup::dashed_slur (one, line_thick, robust_scm2double (p, 1.0),
 102                              robust_scm2double (f, 0));
 103   else
 104     a = Lookup::slur (one,
 105                       get_grob_direction (me) * base_thick,
 106                       line_thick);
 107
 108 #if DEBUG_SLUR_SCORING
 109   SCM quant_score = me->get_property ("quant-score");
 110
 111   if (to_boolean (me->layout ()
 112                   ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")))
 113       && scm_is_string (quant_score))
 114     {
 115       string str;
 116       SCM properties = Font_interface::text_font_alist_chain (me);
 117
 118       Stencil tm = *unsmob_stencil (Text_interface::interpret_markup
 119                                     (me->layout ()->self_scm (), properties,
 120                                      quant_score));
 121       a.add_at_edge (Y_AXIS, get_grob_direction (me), tm, 1.0, 0);
 122     }
 123 #endif
 124
 125   return a.smobbed_copy ();
 126 }
 127
 128 Bezier
 129 Slur::get_curve (Grob *me)
 130 {
 131   Bezier b;
 132   int i = 0;
 133   for (SCM s = me->get_property ("control-points"); s != SCM_EOL;
 134        s = scm_cdr (s))
 135     b.control_[i++] = ly_scm2offset (scm_car (s));
 136
 137   return b;
 138 }
 139
 140 void
 141 Slur::add_column (Grob *me, Grob *n)
 142 {
 143   Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n);
 144   add_bound_item (dynamic_cast<Spanner *> (me), dynamic_cast<Item *> (n));
 145 }
 146
 147 void
 148 Slur::add_extra_encompass (Grob *me, Grob *n)
 149 {
 150   Pointer_group_interface::add_grob (me, ly_symbol2scm ("encompass-objects"), n);
 151 }
 152
 153
 154 MAKE_SCHEME_CALLBACK (Slur, outside_slur_callback, 2);
 155 SCM
 156 Slur::outside_slur_callback (SCM grob, SCM offset_scm)
 157 {
 158   Grob *script = unsmob_grob (grob);
 159   Grob *slur = unsmob_grob (script->get_object ("slur"));
 160
 161   if (!slur)
 162     return offset_scm;
 163
 164   SCM avoid = script->get_property ("avoid-slur");
 165   if (avoid != ly_symbol2scm ("outside")
 166       && avoid != ly_symbol2scm ("around"))
 167     return offset_scm;
 168
 169   Direction dir = get_grob_direction (script);
 170   if (dir == CENTER)
 171     return offset_scm;
 172
 173   Grob *cx = script->common_refpoint (slur, X_AXIS);
 174   Grob *cy = script->common_refpoint (slur, Y_AXIS);
 175
 176   Bezier curve = Slur::get_curve (slur);
 177
 178   curve.translate (Offset (slur->relative_coordinate (cx, X_AXIS),
 179                            slur->relative_coordinate (cy, Y_AXIS)));
 180
 181   Interval yext = robust_relative_extent (script, cy, Y_AXIS);
 182   Interval xext = robust_relative_extent (script, cx, X_AXIS);
 183
 184   yext.translate (robust_scm2double (offset_scm, 0));
 185
 186
 187   /* FIXME: slur property, script property?  */
 188   Real slur_padding = robust_scm2double (script->get_property ("slur-padding"),
 189                                          0.0);
 190   yext.widen (slur_padding);
 191
 192   Real EPS = 1e-3;
 193   Interval bezext (curve.control_[0][X_AXIS], curve.control_[3][X_AXIS]);
 194   bool consider[] = { false, false, false };
 195   Real ys[] = {0, 0, 0};
 196   bool do_shift = false;
 197
 198   for (int d = LEFT, k = 0; d <= RIGHT; d++, k++)
 199     {
 200       Real x = xext.linear_combination ((Direction) d);
 201       consider[k] = bezext.contains (x);
 202
 203       if (consider[k])
 204         {
 205           ys[k]
 206             = (fabs (bezext[LEFT] - x) < EPS)
 207             ? curve.control_[0][Y_AXIS]
 208             : ((fabs (bezext[RIGHT] - x) < EPS)
 209                ? curve.control_[3][Y_AXIS]
 210                : curve.get_other_coordinate (X_AXIS, x));
 211           consider[k] = true;
 212
 213           /* Request shift if slur is contained script's Y, or if
 214              script is inside slur and avoid == outside.  */
 215           if (yext.contains (ys[k])
 216               || (dir * ys[k] > dir * yext[-dir] && avoid == ly_symbol2scm ("outside")))
 217             do_shift = true;
 218         }
 219     }
 220
 221   Real avoidance_offset = 0.0;
 222   if (do_shift)
 223     {
 224       for (int d = LEFT, k = 0; d <= RIGHT; d++, k++)
 225         avoidance_offset = dir * (max (dir * avoidance_offset,
 226                              dir * (ys[k] - yext[-dir] + dir * slur_padding)));
 227     }
 228
 229   return scm_from_double (scm_to_double (offset_scm) + avoidance_offset);
 230 }
 231
 232
 233
 234 ADD_INTERFACE (Slur, "slur-interface",
 235
 236                "A slur",
 237
 238                /* properties */
 239                "control-points "
 240                "dash-fraction "
 241                "dash-period "
 242                "details "
 243                "direction "
 244                "eccentricity "
 245                "encompass-objects "
 246                "height-limit "
 247                "line-thickness "
 248                "note-columns "
 249                "positions "
 250                "quant-score "
 251                "ratio "
 252                "thickness "
 253
 254                );
 255