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--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7   Jan Nieuwenhuizen <janneke@gnu.org>
   8 */
   9
  10 #include "slur.hh"
  11
  12 #include <math.h>
  13
  14 #include "beam.hh"
  15 #include "bezier.hh"
  16 #include "directional-element-interface.hh"
  17 #include "font-interface.hh"
  18 #include "group-interface.hh"
  19 #include "lookup.hh"
  20 #include "main.hh"              // DEBUG_SLUR_SCORING
  21 #include "note-column.hh"
  22 #include "output-def.hh"
  23 #include "spanner.hh"
  24 #include "staff-symbol-referencer.hh"
  25 #include "staff-symbol.hh"
  26 #include "stem.hh"
  27 #include "text-item.hh"
  28 #include "warn.hh"
  29 #include "slur-scoring.hh"
  30
  31 MAKE_SCHEME_CALLBACK (Slur, height, 2);
  32 SCM
  33 Slur::height (SCM smob, SCM ax)
  34 {
  35   Axis a = (Axis)scm_to_int (ax);
  36   Grob *me = unsmob_grob (smob);
  37   assert (a == Y_AXIS);
  38
  39   SCM mol = me->get_uncached_stencil ();
  40   Interval ext;
  41   if (Stencil *m = unsmob_stencil (mol))
  42     ext = m->extent (a);
  43   return ly_interval2scm (ext);
  44 }
  45
  46 /*
  47   Ugh should have dash-length + dash-period
  48 */
  49 MAKE_SCHEME_CALLBACK (Slur, print, 1);
  50 SCM
  51 Slur::print (SCM smob)
  52 {
  53   Grob *me = unsmob_grob (smob);
  54   if (!scm_ilength (me->get_property ("note-columns")))
  55     {
  56       me->suicide ();
  57       return SCM_EOL;
  58     }
  59
  60   Real base_thick = robust_scm2double (me->get_property ("thickness"), 1);
  61   Real thick = base_thick * Staff_symbol_referencer::line_thickness (me);
  62
  63   Real ss = Staff_symbol_referencer::staff_space (me);
  64   Bezier one = get_curve (me);
  65
  66   Stencil a;
  67
  68   /*
  69     TODO: replace dashed with generic property.
  70   */
  71   SCM p = me->get_property ("dash-period");
  72   SCM f = me->get_property ("dash-fraction");
  73   if (scm_is_number (p) && scm_is_number (f))
  74     a = Lookup::dashed_slur (one, thick, robust_scm2double (p, 1.0),
  75                              robust_scm2double (f, 0));
  76   else
  77     a = Lookup::slur (one, get_grob_direction (me) * base_thick * ss / 10.0,
  78                       thick);
  79
  80 #if DEBUG_SLUR_SCORING
  81   SCM quant_score = me->get_property ("quant-score");
  82
  83   if (to_boolean (me->get_layout ()
  84                   ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")))
  85       && scm_is_string (quant_score))
  86     {
  87       String str;
  88       SCM properties = Font_interface::text_font_alist_chain (me);
  89
  90       Stencil tm = *unsmob_stencil (Text_interface::interpret_markup
  91                                     (me->get_layout ()->self_scm (), properties,
  92                                      quant_score));
  93       a.add_at_edge (Y_AXIS, get_grob_direction (me), tm, 1.0, 0);
  94     }
  95 #endif
  96
  97   return a.smobbed_copy ();
  98 }
  99
 100 Bezier
 101 Slur::get_curve (Grob *me)
 102 {
 103   Bezier b;
 104   int i = 0;
 105   for (SCM s = me->get_property ("control-points"); s != SCM_EOL;
 106        s = scm_cdr (s))
 107     b.control_[i++] = ly_scm2offset (scm_car (s));
 108
 109   return b;
 110 }
 111
 112 void
 113 Slur::add_column (Grob *me, Grob *n)
 114 {
 115   Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n);
 116   add_bound_item (dynamic_cast<Spanner *> (me), dynamic_cast<Item *> (n));
 117 }
 118
 119 void
 120 Slur::add_extra_encompass (Grob *me, Grob *n)
 121 {
 122   Pointer_group_interface::add_grob (me, ly_symbol2scm ("encompass-objects"), n);
 123 }
 124
 125 MAKE_SCHEME_CALLBACK (Slur, outside_slur_callback, 2);
 126 SCM
 127 Slur::outside_slur_callback (SCM grob, SCM axis)
 128 {
 129   Grob *script = unsmob_grob (grob);
 130   Axis a = Axis (scm_to_int (axis));
 131   assert (a == Y_AXIS);
 132
 133   Grob *slur = unsmob_grob (script->get_property ("slur"));
 134
 135   if (!slur)
 136     return scm_from_int (0);
 137
 138   Grob *cx = script->common_refpoint (slur, X_AXIS);
 139   Grob *cy = script->common_refpoint (slur, Y_AXIS);
 140
 141   Bezier curve = Slur::get_curve (slur);
 142
 143   curve.translate (Offset (slur->relative_coordinate (cx, X_AXIS),
 144                            slur->relative_coordinate (cy, Y_AXIS)));
 145
 146   Interval yext = robust_relative_extent (script, cy, Y_AXIS);
 147   Interval xext = robust_relative_extent (script, cx, X_AXIS);
 148
 149   Real slur_padding = robust_scm2double (script->get_property ("slur-padding"),
 150                                          0.0);  // todo: slur property, script property?
 151   yext.widen (slur_padding);
 152   Real EPS = 1e-3;
 153
 154   Interval bezext (curve.control_[0][X_AXIS],
 155                    curve.control_[3][X_AXIS]);
 156
 157   bool consider[] = { false, false, false };
 158   Real ys[] = {0, 0, 0};
 159   int k = 0;
 160   bool do_shift = false;
 161
 162   for (int d = LEFT; d <= RIGHT; d++)
 163     {
 164       Real x = xext.linear_combination ((Direction) d);
 165       consider[k] = bezext.contains (x);
 166
 167       if (consider[k])
 168         {
 169           ys[k]
 170             = (fabs (bezext[LEFT] - x) < EPS)
 171             ? curve.control_[0][Y_AXIS]
 172             : ((fabs (bezext[RIGHT] - x) < EPS)
 173                ? curve.control_[3][Y_AXIS]
 174                : curve.get_other_coordinate (X_AXIS, x));
 175           consider[k] = true;
 176
 177           if (yext.contains (ys[k]))
 178             do_shift = true;
 179         }
 180     }
 181   Real offset = 0.0;
 182   if (do_shift)
 183     {
 184       k = 0;
 185       Direction dir = get_grob_direction (script);
 186       for (int d = LEFT; d <= RIGHT; d++)
 187         {
 188           offset = dir * (dir * offset >? dir
 189                           * (ys[k] - yext[-dir] + dir * slur_padding));
 190           k++;
 191         }
 192     }
 193
 194   return scm_make_real (offset);
 195 }
 196
 197 static Direction
 198 get_default_dir (Grob *me)
 199 {
 200   Link_array<Grob> encompasses
 201     = extract_grob_array (me, ly_symbol2scm ("note-columns"));
 202
 203   Direction d = DOWN;
 204   for (int i = 0; i < encompasses.size (); i++)
 205     {
 206       if (Note_column::dir (encompasses[i]) < 0)
 207         {
 208           d = UP;
 209           break;
 210         }
 211     }
 212   return d;
 213 }
 214
 215 MAKE_SCHEME_CALLBACK (Slur, after_line_breaking, 1);
 216 SCM
 217 Slur::after_line_breaking (SCM smob)
 218 {
 219   Spanner *me = dynamic_cast<Spanner *> (unsmob_grob (smob));
 220   if (!scm_ilength (me->get_property ("note-columns")))
 221     {
 222       me->suicide ();
 223       return SCM_UNSPECIFIED;
 224     }
 225
 226   if (!get_grob_direction (me))
 227     set_grob_direction (me, get_default_dir (me));
 228
 229   if (scm_ilength (me->get_property ("control-points")) < 4)
 230     set_slur_control_points (me);
 231
 232   return SCM_UNSPECIFIED;
 233 }
 234
 235 ADD_INTERFACE (Slur, "slur-interface",
 236                "A slur",
 237                "positions quant-score excentricity encompass-objects control-points dash-period dash-fraction slur-details direction height-limit note-columns ratio thickness");
 238