lily/slur.cc

   1 /*
   2   slur.cc -- implement  Slur
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1996,  1997--1998, 1998 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7     Jan Nieuwenhuizen <janneke@gnu.org>
   8 */
   9
  10 /*
  11   [TODO]
  12     * URG: share code with tie
  13     * begin and end should be treated as a Script.
  14     * damping
  15     * slur from notehead to stemend: c''()b''
  16  */
  17
  18 #include "slur.hh"
  19 #include "scalar.hh"
  20 #include "lookup.hh"
  21 #include "paper-def.hh"
  22 #include "note-column.hh"
  23 #include "stem.hh"
  24 #include "p-col.hh"
  25 #include "molecule.hh"
  26 #include "debug.hh"
  27 #include "box.hh"
  28 #include "bezier.hh"
  29 #include "encompass-info.hh"
  30 #include "main.hh"
  31
  32
  33 Slur::Slur ()
  34 {
  35 }
  36
  37 void
  38 Slur::add_column (Note_column*n)
  39 {
  40   if (!n->head_l_arr_.size ())
  41     warning (_ ("Putting slur over rest."));
  42   encompass_arr_.push (n);
  43   n->stem_l_->slur_l_ = this;
  44   add_dependency (n);
  45 }
  46
  47 void
  48 Slur::set_default_dir ()
  49 {
  50   dir_ = DOWN;
  51   for (int i=0; i < encompass_arr_.size (); i ++)
  52     {
  53       if (encompass_arr_[i]->dir_ < 0)
  54         {
  55           dir_ = UP;
  56           break;
  57         }
  58     }
  59 }
  60
  61 void
  62 Slur::do_add_processing ()
  63 {
  64   set_bounds (LEFT, encompass_arr_[0]);
  65   if (encompass_arr_.size () > 1)
  66     set_bounds (RIGHT, encompass_arr_.top ());
  67 }
  68
  69 void
  70 Slur::do_pre_processing ()
  71 {
  72   // don't set directions
  73 }
  74
  75 void
  76 Slur::do_substitute_dependency (Score_element*o, Score_element*n)
  77 {
  78   int i;
  79   while ((i = encompass_arr_.find_i (dynamic_cast<Note_column *> (o))) >=0)
  80     {
  81       if (n)
  82         encompass_arr_[i] = dynamic_cast<Note_column *> (n);
  83       else
  84         encompass_arr_.del (i);
  85     }
  86 }
  87
  88 static int
  89 Note_column_compare (Note_column *const&n1 , Note_column* const&n2)
  90 {
  91   return Item::left_right_compare (n1, n2);
  92 }
  93
  94 void
  95 Slur::do_post_processing ()
  96 {
  97   encompass_arr_.sort (Note_column_compare);
  98   if (!dir_)
  99     set_default_dir ();
 100
 101   Real interline_f = paper ()->interline_f ();
 102   Real internote_f = interline_f / 2;
 103   // URG
 104   Real notewidth_f = paper ()->note_width () * 0.8;
 105   Real slur_min = paper ()->get_var ("slur_x_minimum");
 106
 107   /*
 108    [OSU]: slur and tie placement
 109
 110    slurs:
 111    * x = centre of head (upside-down: inner raakpunt stem) - d * gap
 112
 113    * y = length < 5ss : horizontal raakpunt + d * 0.25 ss
 114      y = length >= 5ss : y next interline - d * 0.25 ss
 115      --> height <= 5 length ?? we use <= 3 length, now...
 116    */
 117
 118   Real gap_f = paper ()->get_var ("slur_x_gap");
 119
 120   Drul_array<Note_column*> extrema;
 121   extrema[LEFT] = encompass_arr_[0];
 122   extrema[RIGHT] = encompass_arr_.top ();
 123
 124   Direction d=LEFT;
 125
 126   do
 127     {
 128       /*
 129         broken slur
 130        */
 131       if (extrema[d] != spanned_drul_[d])
 132         {
 133           // ugh -- check if needed
 134           dx_f_drul_[d] = -d
 135             *(spanned_drul_[d]->extent (X_AXIS).length () - 0.5 * notewidth_f);
 136
 137           // prebreak
 138           if (d == RIGHT)
 139             {
 140               dx_f_drul_[LEFT] = spanned_drul_[LEFT]->extent (X_AXIS).length ();
 141
 142               // urg -- check if needed
 143               if (encompass_arr_.size () > 1)
 144                 dx_f_drul_[RIGHT] += notewidth_f;
 145             }
 146         }
 147       /*
 148         normal slur
 149        */
 150       else if (extrema[d]->stem_l_ && !extrema[d]->stem_l_->transparent_b_
 151                && extrema[d]->head_l_arr_.size ())
 152         {
 153           Real notewidth_f = extrema[d]->extent (X_AXIS).length ();
 154           dy_f_drul_[d] = (int)rint (extrema[d]->stem_l_-> extent (Y_AXIS)[dir_]);
 155           dx_f_drul_[d] += 0.5 * notewidth_f - d * gap_f;
 156           if (dir_ == extrema[d]->stem_l_->dir_)
 157             {
 158               if (dir_ == d)
 159                 dx_f_drul_[d] += 0.5 * (dir_ * d) * d * notewidth_f;
 160               else
 161                 dx_f_drul_[d] += 0.25 * (dir_ * d) * d * notewidth_f;
 162             }
 163         }
 164         else
 165           {
 166             Real notewidth_f = extrema[d]->extent (X_AXIS).length ();
 167             dy_f_drul_[d] = (int)rint (extrema[d]->head_positions_interval ()
 168                                        [dir_]) * internote_f;
 169             dx_f_drul_[d] += 0.5 * notewidth_f - d * gap_f;
 170         }
 171         dy_f_drul_[d] += dir_ * interline_f;
 172         if (extrema[d]->stem_l_ && (dir_ == extrema[d]->stem_l_->dir_))
 173           dy_f_drul_[d] -= dir_ * internote_f;
 174       }
 175   while (flip(&d) != LEFT);
 176
 177   // now that both are set, do dependent
 178   do
 179     {
 180       /*
 181         broken slur
 182        */
 183       if (extrema[d] != spanned_drul_[d])
 184         {
 185           Direction u = d;
 186           flip(&u);
 187
 188           // postbreak
 189           if (d == LEFT)
 190             dy_f_drul_[u] += dir_ * internote_f;
 191
 192           dy_f_drul_[d] = dy_f_drul_[(Direction)-d];
 193
 194         /*
 195          urg, this is broken
 196          but who *is* going to assure that dx >= slur_min?
 197          */
 198 #if 0
 199
 200           if (dx_f_drul_[RIGHT] - dx_f_drul_[LEFT] < slur_min)
 201             {
 202             // huh? what was this supposed to do?
 203 //            dx_f_drul_[d] -= d * slur_min
 204 //              - (dx_f_drul_[RIGHT] - dx_f_drul_[LEFT]);
 205               dx_f_drul_[d] = dx_f_drul_[(Direction)-d] + d * slur_min;
 206             }
 207 #endif
 208         }
 209      }
 210   while (flip(&d) != LEFT);
 211
 212   /*
 213     Avoid too steep slurs.
 214       * slur from notehead to stemend: c''()b''
 215    */
 216   Real damp_f = paper ()->get_var ("slur_slope_damping");
 217   Offset d_off = Offset (dx_f_drul_[RIGHT] - dx_f_drul_[LEFT],
 218     dy_f_drul_[RIGHT] - dy_f_drul_[LEFT]);
 219   d_off.x () += extent (X_AXIS).length ();
 220
 221   Real ratio_f = abs (d_off.y () / d_off.x ());
 222   if (ratio_f > damp_f)
 223     dy_f_drul_[(Direction)(- dir_ * sign (d_off.y ()))] -=
 224       dir_ * (damp_f - ratio_f) * d_off.x ();
 225 }
 226
 227 Array<Offset>
 228 Slur::get_encompass_offset_arr () const
 229 {
 230   Real notewidth = paper ()->note_width () * 0.8;
 231   Real gap = paper ()->get_var ("slur_x_gap");
 232   Real internote = paper ()->internote_f ();
 233
 234   Offset left = Offset (dx_f_drul_[LEFT], dy_f_drul_[LEFT]);
 235   left.x () += encompass_arr_[0]->stem_l_->hpos_f ();
 236
 237   /*
 238     <URG>
 239     i don't understand these two, but *must* for symmetry
 240     look at encompass array:
 241        lilypond -D input/test/slur-symmetry*.ly
 242        lilypond -D input/test/sleur.ly
 243
 244     do_post_processing should have calculated these into
 245     dx_f_drul_[], no??
 246
 247    */
 248
 249   if (dir_ != encompass_arr_[0]->stem_l_->dir_)
 250     left.x () += - 0.5 * notewidth * encompass_arr_[0]->stem_l_->dir_
 251       + gap;
 252   else if (encompass_arr_[0]->stem_l_->dir_ == UP)
 253     left.x () -= notewidth;
 254
 255   if ((dir_ == encompass_arr_[0]->stem_l_->dir_)
 256     && (encompass_arr_[0]->stem_l_->dir_ == DOWN))
 257     left.y () -= internote * encompass_arr_[0]->stem_l_->dir_;
 258   /* </URG> */
 259
 260   Offset d = Offset (dx_f_drul_[RIGHT] - dx_f_drul_[LEFT],
 261     dy_f_drul_[RIGHT] - dy_f_drul_[LEFT]);
 262   d.x () += extent (X_AXIS).length ();
 263
 264   int first = 1;
 265   int last = encompass_arr_.size () - 1;
 266
 267   // prebreak
 268   if (encompass_arr_.top () != spanned_drul_[RIGHT])
 269     last++;
 270
 271   // postbreak
 272   if (encompass_arr_[0] != spanned_drul_[LEFT])
 273     first--;
 274
 275   Array<Offset> notes;
 276   notes.push (Offset (0,0));
 277
 278   for (int i = first; i < last; i++)
 279     {
 280       Encompass_info info (encompass_arr_[i], dir_);
 281       notes.push (info.o_ - left);
 282     }
 283   Encompass_info info (encompass_arr_[encompass_arr_.size () - 1], dir_);
 284   // urg:
 285   Slur* urg = (Slur*)this;
 286   urg->interstaff_f_ = info.interstaff_f_;
 287   d.y () += interstaff_f_;
 288
 289   // prebreak
 290   if (interstaff_f_ && (encompass_arr_.top () != spanned_drul_[RIGHT]))
 291     {
 292       Encompass_info info (encompass_arr_[encompass_arr_.size () - 1], dir_);
 293       d.y () -= info.o_.y () - interstaff_f_;
 294     }
 295
 296   notes.push (d);
 297
 298   return notes;
 299 }
 300