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
 101 Bezier
 102 Slur::get_curve (Grob*me)
 103 {
 104   Bezier b;
 105   int i = 0;
 106   for (SCM s = me->get_property ("control-points"); s != SCM_EOL;
 107        s = scm_cdr (s))
 108     b.control_[i++] = ly_scm2offset (scm_car (s));
 109
 110   return b;
 111 }
 112
 113 void
 114 Slur::add_column (Grob*me, Grob*n)
 115 {
 116   Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n);
 117   add_bound_item (dynamic_cast<Spanner*> (me), dynamic_cast<Item*> (n));
 118 }
 119
 120
 121 void
 122 Slur::add_extra_encompass (Grob*me, Grob*n)
 123 {
 124   Pointer_group_interface::add_grob (me, ly_symbol2scm ("encompass-objects"), n);
 125 }
 126
 127
 128
 129 MAKE_SCHEME_CALLBACK (Slur, outside_slur_callback, 2);
 130 SCM
 131 Slur::outside_slur_callback (SCM grob, SCM axis)
 132 {
 133   Grob *script = unsmob_grob (grob);
 134   Axis a = Axis (scm_to_int (axis));
 135   assert (a == Y_AXIS);
 136
 137   Grob *slur = unsmob_grob (script->get_property ("slur"));
 138
 139   if (!slur)
 140     return scm_from_int (0);
 141
 142   Grob *cx = script->common_refpoint (slur, X_AXIS);
 143   Grob *cy = script->common_refpoint (slur, Y_AXIS);
 144
 145   Bezier curve = Slur::get_curve (slur);
 146
 147   curve.translate (Offset (slur->relative_coordinate (cx, X_AXIS),
 148                            slur->relative_coordinate (cy, Y_AXIS)));
 149
 150   Interval yext = robust_relative_extent (script, cy, Y_AXIS);
 151   Interval xext = robust_relative_extent (script, cx, X_AXIS);
 152
 153
 154   Real slur_padding = robust_scm2double (script->get_property ("slur-padding"),
 155                                          0.0);  // todo: slur property, script property?
 156   yext.widen (slur_padding);
 157   Real EPS = 1e-3;
 158
 159   Interval bezext (curve.control_[0][X_AXIS],
 160                    curve.control_[3][X_AXIS]);
 161
 162   bool consider[] = { false, false, false };
 163   Real ys[] = {0, 0, 0};
 164   int k = 0;
 165   bool do_shift = false;
 166
 167   for (int d = LEFT; d <= RIGHT; d++)
 168     {
 169       Real x = xext.linear_combination ((Direction) d);
 170       consider[k] = bezext.contains (x);
 171
 172       if (consider[k])
 173         {
 174           ys[k]
 175             = (fabs(bezext[LEFT] - x) < EPS)
 176             ? curve.control_[0][Y_AXIS]
 177             : ((fabs(bezext[RIGHT] - x) < EPS)
 178                ? curve.control_[3][Y_AXIS]
 179                : curve.get_other_coordinate (X_AXIS, x));
 180           consider[k] = true;
 181
 182           if (yext.contains (ys[k]))
 183             do_shift = true;
 184         }
 185     }
 186   Real offset = 0.0;
 187   if (do_shift)
 188     {
 189       k = 0;
 190       Direction dir = get_grob_direction (script);
 191       for (int d = LEFT; d <= RIGHT; d++)
 192         {
 193           offset = dir * (dir * offset >? dir
 194                           * (ys[k] - yext[-dir] + dir * slur_padding));
 195           k++;
 196         }
 197     }
 198
 199   return scm_make_real (offset);
 200 }
 201
 202 static Direction
 203 get_default_dir (Grob*me)
 204 {
 205   Link_array<Grob> encompasses
 206     = Pointer_group_interface__extract_grobs (me, (Grob*) 0, "note-columns");
 207
 208   Direction d = DOWN;
 209   for (int i = 0; i < encompasses.size (); i ++)
 210     {
 211       if (Note_column::dir (encompasses[i]) < 0)
 212         {
 213           d = UP;
 214           break;
 215         }
 216     }
 217   return d;
 218 }
 219
 220
 221 MAKE_SCHEME_CALLBACK (Slur, after_line_breaking, 1);
 222 SCM
 223 Slur::after_line_breaking (SCM smob)
 224 {
 225   Spanner *me = dynamic_cast<Spanner*> (unsmob_grob (smob));
 226   if (!scm_ilength (me->get_property ("note-columns")))
 227     {
 228       me->suicide ();
 229       return SCM_UNSPECIFIED;
 230     }
 231
 232   if (!get_grob_direction (me))
 233     set_grob_direction (me, get_default_dir (me));
 234
 235   if (scm_ilength (me->get_property ("control-points")) < 4)
 236     set_slur_control_points (me);
 237
 238   return SCM_UNSPECIFIED;
 239 }
 240
 241 ADD_INTERFACE (Slur, "slur-interface",
 242                "A slur",
 243                "positions quant-score excentricity encompass-objects control-points dash-period dash-fraction slur-details direction height-limit note-columns ratio thickness");
 244
 245