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 d =  me->get_property ("dashed");
  72   if (scm_is_number (d))
  73     a = Lookup::dashed_slur (one, thick, thick * robust_scm2double (d, 0));
  74   else
  75     a = Lookup::slur (one, get_grob_direction (me) * base_thick * ss / 10.0,
  76                       thick);
  77
  78 #if DEBUG_SLUR_SCORING
  79   SCM quant_score = me->get_property ("quant-score");
  80
  81   if (to_boolean (me->get_layout ()
  82                   ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")))
  83       && scm_is_string (quant_score))
  84     {
  85       String str;
  86       SCM properties = Font_interface::text_font_alist_chain (me);
  87
  88       Stencil tm = *unsmob_stencil (Text_interface::interpret_markup
  89                                     (me->get_layout ()->self_scm (), properties,
  90                                      quant_score));
  91       a.add_at_edge (Y_AXIS, get_grob_direction (me), tm, 1.0, 0);
  92     }
  93 #endif
  94
  95   return a.smobbed_copy ();
  96 }
  97
  98
  99 Bezier
 100 Slur::get_curve (Grob*me)
 101 {
 102   Bezier b;
 103   int i = 0;
 104   for (SCM s = me->get_property ("control-points"); s != SCM_EOL;
 105        s = scm_cdr (s))
 106     b.control_[i++] = ly_scm2offset (scm_car (s));
 107
 108   return b;
 109 }
 110
 111 void
 112 Slur::add_column (Grob*me, Grob*n)
 113 {
 114   Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n);
 115   add_bound_item (dynamic_cast<Spanner*> (me), dynamic_cast<Item*> (n));
 116 }
 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
 126
 127 MAKE_SCHEME_CALLBACK (Slur, outside_slur_callback, 2);
 128 SCM
 129 Slur::outside_slur_callback (SCM grob, SCM axis)
 130 {
 131   Grob *script = unsmob_grob (grob);
 132   Axis a = Axis (scm_to_int (axis));
 133   assert (a == Y_AXIS);
 134
 135   Grob *slur = unsmob_grob (script->get_property ("slur"));
 136
 137   if (!slur)
 138     return scm_from_int (0);
 139
 140   Grob *cx = script->common_refpoint (slur, X_AXIS);
 141   Grob *cy = script->common_refpoint (slur, Y_AXIS);
 142
 143   Bezier curve = Slur::get_curve (slur);
 144
 145   curve.translate (Offset (slur->relative_coordinate (cx, X_AXIS),
 146                            slur->relative_coordinate (cy, Y_AXIS)));
 147
 148   Interval yext = robust_relative_extent (script, cy, Y_AXIS);
 149   Interval xext = robust_relative_extent (script, cx, X_AXIS);
 150
 151
 152   Real slur_padding = robust_scm2double (script->get_property ("slur-padding"),
 153                                          0.0);  // todo: slur property, script property?
 154   yext.widen (slur_padding);
 155   Real EPS = 1e-3;
 156
 157   Interval bezext (curve.control_[0][X_AXIS],
 158                    curve.control_[3][X_AXIS]);
 159
 160   bool consider[] = { false, false, false };
 161   Real ys[] = {0, 0, 0};
 162   int k = 0;
 163   bool do_shift = false;
 164
 165   for (int d = LEFT; d <= RIGHT; d++)
 166     {
 167       Real x = xext.linear_combination ((Direction) d);
 168       consider[k] = bezext.contains (x);
 169
 170       if (consider[k])
 171         {
 172           ys[k]
 173             = (fabs(bezext[LEFT] - x) < EPS)
 174             ? curve.control_[0][Y_AXIS]
 175             : ((fabs(bezext[RIGHT] - x) < EPS)
 176                ? curve.control_[3][Y_AXIS]
 177                : curve.get_other_coordinate (X_AXIS, x));
 178           consider[k] = true;
 179
 180           if (yext.contains (ys[k]))
 181             do_shift = true;
 182         }
 183     }
 184   Real offset = 0.0;
 185   if (do_shift)
 186     {
 187       k = 0;
 188       Direction dir = get_grob_direction (script);
 189       for (int d = LEFT; d <= RIGHT; d++)
 190         {
 191           offset = dir * (dir * offset >? dir
 192                           * (ys[k] - yext[-dir] + dir * slur_padding));
 193           k++;
 194         }
 195     }
 196
 197   return scm_make_real (offset);
 198 }
 199
 200 static Direction
 201 get_default_dir (Grob*me)
 202 {
 203   Link_array<Grob> encompasses
 204     = Pointer_group_interface__extract_grobs (me, (Grob*) 0, "note-columns");
 205
 206   Direction d = DOWN;
 207   for (int i = 0; i < encompasses.size (); i ++)
 208     {
 209       if (Note_column::dir (encompasses[i]) < 0)
 210         {
 211           d = UP;
 212           break;
 213         }
 214     }
 215   return d;
 216 }
 217
 218
 219 MAKE_SCHEME_CALLBACK (Slur, after_line_breaking,1);
 220 SCM
 221 Slur::after_line_breaking (SCM smob)
 222 {
 223   Spanner *me = dynamic_cast<Spanner*> (unsmob_grob (smob));
 224   if (!scm_ilength (me->get_property ("note-columns")))
 225     {
 226       me->suicide ();
 227       return SCM_UNSPECIFIED;
 228     }
 229
 230   if (!get_grob_direction (me))
 231     set_grob_direction (me, get_default_dir (me));
 232
 233   if (scm_ilength (me->get_property ("control-points")) < 4)
 234     set_slur_control_points (me);
 235
 236   return SCM_UNSPECIFIED;
 237 }
 238
 239 ADD_INTERFACE (Slur, "slur-interface",
 240                "A slur",
 241                "positions quant-score excentricity encompass-objects control-points dashed slur-details direction height-limit note-columns ratio thickness");
 242
 243