lily/slur.cc

   1 /*
   2   slur.cc -- implement  Slur
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1996,  1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7     Jan Nieuwenhuizen <janneke@gnu.org>
   8 */
   9
  10 /*
  11   [TODO]
  12     * begin and end should be treated as a/acknowledge Scripts.
  13     * broken slur should have uniform trend
  14  */
  15
  16 #include "slur.hh"
  17 #include "scalar.hh"
  18 #include "lookup.hh"
  19 #include "paper-def.hh"
  20 #include "note-column.hh"
  21 #include "stem.hh"
  22 #include "paper-column.hh"
  23 #include "molecule.hh"
  24 #include "debug.hh"
  25 #include "box.hh"
  26 #include "bezier.hh"
  27 #include "encompass-info.hh"
  28 #include "main.hh"
  29
  30
  31 Slur::Slur ()
  32 {
  33 }
  34
  35 void
  36 Slur::add_column (Note_column*n)
  37 {
  38   if (!n->head_l_arr_.size ())
  39     warning (_ ("Putting slur over rest. Ignoring"));
  40   else
  41     {
  42       encompass_arr_.push (n);
  43       add_dependency (n);
  44     }
  45 }
  46
  47 Direction
  48 Slur::get_default_dir () const
  49 {
  50   Direction d = DOWN;
  51   for (int i=0; i < encompass_arr_.size (); i ++)
  52     {
  53       if (encompass_arr_[i]->dir () < 0)
  54         {
  55           d = UP;
  56           break;
  57         }
  58     }
  59   return d;
  60 }
  61
  62 void
  63 Slur::do_add_processing ()
  64 {
  65   set_bounds (LEFT, encompass_arr_[0]);
  66   if (encompass_arr_.size () > 1)
  67     set_bounds (RIGHT, encompass_arr_.top ());
  68 }
  69
  70 void
  71 Slur::do_pre_processing ()
  72 {
  73   // don't set directions
  74 }
  75
  76 void
  77 Slur::do_substitute_element_pointer (Score_element*o, Score_element*n)
  78 {
  79   int i;
  80   while ((i = encompass_arr_.find_i (dynamic_cast<Note_column *> (o))) >=0)
  81     {
  82       if (n)
  83         encompass_arr_[i] = dynamic_cast<Note_column *> (n);
  84       else
  85         encompass_arr_.del (i);
  86     }
  87 }
  88
  89 static int
  90 Note_column_compare (Note_column *const&n1 , Note_column* const&n2)
  91 {
  92   return Item::left_right_compare (n1, n2);
  93 }
  94
  95 void
  96 Slur::do_post_processing ()
  97 {
  98   encompass_arr_.sort (Note_column_compare);
  99   if (!dir_)
 100     dir_ = get_default_dir ();
 101
 102   /*
 103    Slur and tie placement [OSU]
 104
 105    Slurs:
 106    * x = centre of head - d * x_gap_f
 107
 108    TODO:
 109    * y = length < 5ss : horizontal tangent + d * 0.25 ss
 110      y = length >= 5ss : y next interline - d * 0.25 ss
 111    */
 112
 113   Real interline_f = paper_l ()->get_realvar (interline_scm_sym);
 114   Real internote_f = interline_f / 2;
 115
 116   Real x_gap_f = paper_l ()->get_var ("slur_x_gap");
 117   Real y_gap_f = paper_l ()->get_var ("slur_y_gap");
 118
 119   Drul_array<Note_column*> note_column_drul;
 120   note_column_drul[LEFT] = encompass_arr_[0];
 121   note_column_drul[RIGHT] = encompass_arr_.top ();
 122
 123   bool fix_broken_b = false;
 124   Direction d = LEFT;
 125   do
 126     {
 127       dx_f_drul_[d] = dy_f_drul_[d] = 0;
 128       if ((note_column_drul[d] == spanned_drul_[d])
 129           && note_column_drul[d]->head_l_arr_.size ()
 130           && (note_column_drul[d]->stem_l_))
 131         {
 132           Stem* stem_l = note_column_drul[d]->stem_l_;
 133           /*
 134             side directly attached to note head;
 135             no beam getting in the way
 136           */
 137           if (((stem_l->get_elt_property (transparent_scm_sym) != SCM_BOOL_F)
 138                || !((stem_l->dir_ == dir_) && (dir_ != d)))
 139               && !((dir_ == stem_l->dir_)
 140                    && stem_l->beam_l_ && (stem_l->beams_i_drul_[-d] >= 1)))
 141             {
 142               dx_f_drul_[d] = spanned_drul_[d]->extent (X_AXIS).length () / 2;
 143               dx_f_drul_[d] -= d * x_gap_f;
 144
 145               if (stem_l->dir_ != dir_)
 146                 {
 147                   dy_f_drul_[d] = note_column_drul[d]->extent (Y_AXIS)[dir_];
 148                 }
 149               else
 150                 {
 151                   dy_f_drul_[d] = stem_l->chord_start_f ()
 152                     + dir_ * internote_f;
 153                 }
 154               dy_f_drul_[d] += dir_ * y_gap_f;
 155             }
 156           /*
 157             side attached to (visible) stem
 158           */
 159           else
 160             {
 161               dx_f_drul_[d] = stem_l->hpos_f ()
 162                 - spanned_drul_[d]->absolute_coordinate (X_AXIS);
 163               /*
 164                 side attached to beamed stem
 165                */
 166               if (stem_l->beam_l_ && (stem_l->beams_i_drul_[-d] >= 1))
 167                 {
 168                   dy_f_drul_[d] = stem_l->extent (Y_AXIS)[dir_];
 169                   dy_f_drul_[d] += dir_ * 2 * y_gap_f;
 170                 }
 171               /*
 172                 side attached to notehead, with stem getting in the way
 173                */
 174               else
 175                 {
 176                   dx_f_drul_[d] -= d * x_gap_f;
 177
 178                   dy_f_drul_[d] = stem_l->chord_start_f ()
 179                     + dir_ * internote_f;
 180                   dy_f_drul_[d] += dir_ * y_gap_f;
 181                 }
 182             }
 183         }
 184       /*
 185         loose end
 186       */
 187       else
 188         {
 189           dx_f_drul_[d] -= d * x_gap_f;
 190           /*
 191             broken: should get y from other piece, so that slur
 192             continues up/down trend
 193
 194             for now: be horizontal..
 195           */
 196           fix_broken_b = true;
 197         }
 198     }
 199   while (flip (&d) != LEFT);
 200
 201   int interstaff_i = 0;
 202   for (int i = 0; i < encompass_arr_.size (); i++)
 203     {
 204       Encompass_info info (encompass_arr_[i], dir_, this);
 205       if (info.interstaff_f_)
 206         {
 207           interstaff_i++;
 208         }
 209     }
 210   bool interstaff_b = interstaff_i && (interstaff_i < encompass_arr_.size ());
 211
 212   Drul_array<Encompass_info> info_drul;
 213   info_drul[LEFT] = Encompass_info (encompass_arr_[0], dir_, this);
 214   info_drul[RIGHT] = Encompass_info (encompass_arr_.top (), dir_, this);
 215   Real interstaff_f = info_drul[RIGHT].interstaff_f_
 216     - info_drul[LEFT].interstaff_f_;
 217
 218   if (fix_broken_b)
 219     {
 220       Direction d = (encompass_arr_.top () != spanned_drul_[RIGHT]) ?
 221         RIGHT : LEFT;
 222       dy_f_drul_[d] = info_drul[d].o_[Y_AXIS];
 223       if (!interstaff_b)
 224         {
 225           dy_f_drul_[d] -= info_drul[d].interstaff_f_;
 226
 227           if (interstaff_i)
 228             {
 229               dy_f_drul_[LEFT] += info_drul[d].interstaff_f_;
 230               dy_f_drul_[RIGHT] += info_drul[d].interstaff_f_;
 231             }
 232         }
 233     }
 234
 235
 236   /*
 237     Now we've got a fine slur
 238     Catch and correct some ugly cases
 239    */
 240
 241   Real height_damp_f;
 242   Real slope_damp_f;
 243   Real snap_f;
 244   Real ratio_f;
 245
 246   if (!fix_broken_b)
 247     dy_f_drul_[RIGHT] += interstaff_f;
 248   Real dy_f = dy_f_drul_[RIGHT] - dy_f_drul_[LEFT];
 249
 250   Real dx_f = do_width ().length () + dx_f_drul_[RIGHT] - dx_f_drul_[LEFT];
 251   Real height_f = do_height ().length ();
 252
 253   if (!interstaff_b)
 254     {
 255       height_damp_f = paper_l ()->get_var ("slur_height_damping");
 256       slope_damp_f = paper_l ()->get_var ("slur_slope_damping");
 257       snap_f = paper_l ()->get_var ("slur_snap_to_stem");
 258     }
 259   else
 260     {
 261       height_damp_f = paper_l ()->get_var ("slur_interstaff_height_damping");
 262       slope_damp_f = paper_l ()->get_var ("slur_interstaff_slope_damping");
 263       snap_f = paper_l ()->get_var ("slur_interstaff_snap_to_stem");
 264     }
 265
 266
 267   /*
 268     Avoid too steep slurs.
 269    */
 270   ratio_f = abs (dy_f / dx_f);
 271   if (ratio_f > slope_damp_f)
 272     {
 273       Direction d = (Direction)(- dir_ * (sign (dy_f)));
 274       if (!d)
 275         d = LEFT;
 276       dy_f_drul_[d] += dir_ * (ratio_f - slope_damp_f) * dx_f;
 277     }
 278
 279   /*
 280    Avoid too high slurs
 281    */
 282   ratio_f = abs (height_f / dx_f);
 283   if (ratio_f > height_damp_f)
 284     {
 285       Direction d = (Direction)(- dir_ * (sign (dy_f)));
 286       if (!d)
 287         d = LEFT;
 288       Real damp_f = dir_ * (ratio_f - height_damp_f) * dx_f;
 289       dy_f_drul_[d] += damp_f;
 290       /*
 291         if y positions at about the same height, correct both ends
 292        */
 293       if (abs (dy_f / dx_f ) < slope_damp_f)
 294         {
 295           dy_f_drul_[-d] += damp_f;
 296         }
 297     }
 298
 299   /*
 300     If, after correcting, we're close to stem-end...
 301   */
 302   do
 303     {
 304       if ((note_column_drul[d] == spanned_drul_[d])
 305           && (note_column_drul[d]->stem_l_)
 306           && (note_column_drul[d]->stem_l_->dir_ == dir_)
 307           && (abs (note_column_drul[d]->stem_l_->extent (Y_AXIS)[dir_]
 308                    - dy_f_drul_[d] + (d == LEFT ? 0 : interstaff_f))
 309               <= snap_f))
 310         {
 311           /*
 312             attach to stem-end
 313           */
 314           Stem* stem_l = note_column_drul[d]->stem_l_;
 315           dx_f_drul_[d] = stem_l->hpos_f ()
 316             - spanned_drul_[d]->absolute_coordinate (X_AXIS);
 317           dy_f_drul_[d] = stem_l->extent (Y_AXIS)[dir_];
 318           dy_f_drul_[d] += info_drul[d].interstaff_f_;
 319           dy_f_drul_[d] += dir_ * 2 * y_gap_f;
 320         }
 321     }
 322   while (flip (&d) != LEFT);
 323 }
 324
 325 Array<Offset>
 326 Slur::get_encompass_offset_arr () const
 327 {
 328   Array<Offset> offset_arr;
 329 #if 0
 330   /*
 331     check non-disturbed slur
 332     FIXME: x of ends off by a tiny bit!!
 333   */
 334   offset_arr.push (Offset (0, dy_f_drul_[LEFT]));
 335   offset_arr.push (Offset (0, dy_f_drul_[RIGHT]));
 336   return offset_arr;
 337 #endif
 338
 339   int interstaff_i = 0;
 340   for (int i = 0; i < encompass_arr_.size (); i++)
 341     {
 342       Encompass_info info (encompass_arr_[i], dir_, this);
 343       if (info.interstaff_f_)
 344         {
 345           interstaff_i++;
 346         }
 347     }
 348   bool interstaff_b = interstaff_i && (interstaff_i < encompass_arr_.size ());
 349
 350   Offset origin (absolute_coordinate (X_AXIS), 0);
 351
 352   int first = 1;
 353   int last = encompass_arr_.size () - 2;
 354
 355   offset_arr.push (Offset (dx_f_drul_[LEFT], dy_f_drul_[LEFT]));
 356   /*
 357     left is broken edge
 358   */
 359   if (encompass_arr_[0] != spanned_drul_[LEFT])
 360     {
 361       first--;
 362       Encompass_info left_info (encompass_arr_[0], dir_, this);
 363       if (interstaff_b)
 364         offset_arr[0][Y_AXIS] += left_info.interstaff_f_;
 365     }
 366
 367   /*
 368     right is broken edge
 369   */
 370   if (encompass_arr_.top () != spanned_drul_[RIGHT])
 371     {
 372       last++;
 373     }
 374
 375   for (int i = first; i <= last; i++)
 376     {
 377       Encompass_info info (encompass_arr_[i], dir_, this);
 378       offset_arr.push (info.o_ - origin);
 379     }
 380
 381   offset_arr.push (Offset (do_width ().length () + dx_f_drul_[RIGHT],
 382                            dy_f_drul_[RIGHT]));
 383
 384   return offset_arr;
 385 }
 386
 387
 388 Array<Rod>
 389 Slur::get_rods () const
 390 {
 391   Array<Rod> a;
 392   Rod r;
 393   r.item_l_drul_ = spanned_drul_;
 394   r.distance_f_ = paper_l ()->get_var ("slur_x_minimum");
 395
 396   a.push (r);
 397   return a;
 398 }
 399