lily/tie.cc

   1 /*
   2   tie.cc -- implement Tie
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "tie.hh"
  10
  11 #include <math.h>
  12
  13 #include "spanner.hh"
  14 #include "lookup.hh"
  15 #include "output-def.hh"
  16 #include "rhythmic-head.hh"
  17 #include "bezier.hh"
  18 #include "paper-column.hh"
  19 #include "warn.hh"
  20 #include "staff-symbol-referencer.hh"
  21 #include "directional-element-interface.hh"
  22 #include "bezier.hh"
  23 #include "stem.hh"
  24 #include "note-head.hh"
  25 #include "tie-column.hh"
  26
  27 /*
  28   tie: Connect two noteheads.
  29
  30   What if we have
  31
  32   c4 ~ \clef bass ; c4 or
  33
  34   c4 \staffchange c4
  35
  36   do we have non-horizontal ties then?
  37 */
  38
  39 void
  40 Tie::set_head (Grob *me, Direction d, Grob *h)
  41 {
  42   dynamic_cast<Spanner *> (me)->set_bound (d, h);
  43   me->add_dependency (h);
  44 }
  45
  46 Grob *
  47 Tie::head (Grob *me, Direction d)
  48 {
  49   Item *it = dynamic_cast<Spanner*> (me)->get_bound (d);
  50   if (Note_head::has_interface (it))
  51     return it;
  52   else
  53     return 0;
  54 }
  55
  56 int
  57 Tie::get_column_rank (Grob *me, Direction d)
  58 {
  59   Spanner *span = dynamic_cast<Spanner *> (me);
  60   Grob *h = head (me, d);
  61   if (!h)
  62     h = span->get_bound (d);
  63
  64   Grob *col = dynamic_cast<Item *> (h)->get_column ();
  65   return Paper_column::get_rank (col);
  66 }
  67
  68 int
  69 Tie::get_position (Grob *me)
  70 {
  71   Direction d = head (me, LEFT) ? LEFT : RIGHT;
  72   return (int) Staff_symbol_referencer::get_position (head (me, d));
  73 }
  74
  75 /*
  76   Default:  Put the tie oppositie of the stem [Wanske p231]
  77
  78   In case of chords: Tie_column takes over
  79
  80   The direction of the Tie is more complicated (See [Ross] p136 and
  81   further).
  82
  83   (what about linebreaks? )
  84 */
  85 Direction
  86 Tie::get_default_dir (Grob *me)
  87 {
  88   Item *sl = head (me, LEFT) ? Rhythmic_head::get_stem (head (me, LEFT)) : 0;
  89   Item *sr = head (me, RIGHT) ? Rhythmic_head::get_stem (head (me, RIGHT)) : 0;
  90   if (sl && sr)
  91     {
  92       if (get_grob_direction (sl) == UP
  93           && get_grob_direction (sr) == UP)
  94         return DOWN;
  95     }
  96   else if (sl || sr)
  97     {
  98       Item *s = sl ? sl : sr;
  99       return -get_grob_direction (s);
 100     }
 101
 102   return UP;
 103 }
 104
 105 void
 106 Tie::set_direction (Grob *me)
 107 {
 108   if (!get_grob_direction (me))
 109     {
 110       if (Tie_column::has_interface (me->get_parent (Y_AXIS)))
 111         Tie_column::set_directions (me->get_parent (Y_AXIS));
 112       else
 113         set_grob_direction (me, Tie::get_default_dir (me));
 114     }
 115 }
 116
 117 Interval
 118 Tie::get_default_attachments (Spanner *me, Grob *common, Real gap,
 119                               int *staff_position,
 120                               bool *in_between
 121                               )
 122 {
 123   Real staff_space = Staff_symbol_referencer::staff_space (me);
 124   Direction dir = get_grob_direction (me);
 125   Interval attachments;
 126   Direction d = LEFT;
 127   do
 128     {
 129       attachments[d]
 130         = robust_relative_extent (me->get_bound (d),
 131                                   common,
 132                                   X_AXIS)[-d]
 133         - gap * d;
 134     }
 135   while (flip (&d) != LEFT);
 136
 137   if (attachments.length () < 0.6 * staff_space)
 138     {
 139       /*
 140         Let short ties start over note heads, instead of between.
 141       */
 142       Drul_array<bool> allow (true, true);
 143
 144       Direction d = LEFT;
 145       do {
 146         if (Note_head::has_interface (me->get_bound (d)))
 147           {
 148             Grob *stem = unsmob_grob (me->get_bound (d)->get_object ("stem"));
 149             if (get_grob_direction (stem) == dir
 150                 && -d == dir)
 151               allow[d] = false;
 152           }
 153       } while (flip (&d) != LEFT);
 154
 155       if (allow[LEFT] && allow[RIGHT])
 156         {
 157           *staff_position += dir;
 158           do
 159             {
 160               if (Note_head::has_interface (me->get_bound (d)))
 161                 {
 162                   Interval extent
 163                     = robust_relative_extent (me->get_bound (d),
 164                                               common, X_AXIS);
 165
 166                   attachments[d] = extent.linear_combination (- 0.5 * d);
 167                   *in_between = false;
 168                 }
 169             }
 170           while (flip (&d) != LEFT);
 171         }
 172     }
 173
 174   return attachments;
 175 }
 176
 177 Interval
 178 get_skyline_attachment (Drul_array< Array < Skyline_entry > > const &skylines,
 179                         Real y)
 180 {
 181   Interval attachments;
 182   Direction d = LEFT;
 183   do
 184     {
 185       attachments[d] = skyline_height (skylines[d], y, -d);
 186     }
 187   while (flip (&d) != LEFT);
 188
 189   return attachments;
 190 }
 191
 192 void
 193 Tie::get_configuration (Grob *me_grob, Grob *common,
 194                         Tie_configuration *conf,
 195                         Drul_array< Array < Skyline_entry > > const *skylines,
 196                         Tie_details const &details
 197                         )
 198 {
 199   Spanner *me = dynamic_cast<Spanner*> (me_grob);
 200   if (!head (me, LEFT) && !head (me, RIGHT))
 201     {
 202       programming_error ("tie without heads");
 203       me->suicide ();
 204       return ;
 205     }
 206
 207   /*
 208     UGH. Don't mirror Tie_configuration.
 209    */
 210   conf->head_position_ = (int) Tie::get_position (me);
 211   if (!conf->dir_)
 212     conf->dir_ = get_grob_direction (me);
 213   if (!conf->dir_)
 214     conf->dir_ = get_default_dir (me);
 215
 216
 217   Real staff_space = details.staff_space_;
 218   bool in_between = true;
 219   Real gap = robust_scm2double (me->get_property ("x-gap"), 0.2);
 220
 221   if (conf->attachment_x_.is_empty())
 222     {
 223       if (!skylines)
 224         conf->attachment_x_ = get_default_attachments (me, common, gap,
 225                                                &conf->position_,
 226                                                &in_between);
 227       else
 228         {
 229           Real y = staff_space * 0.5 * conf->position_;
 230           conf->attachment_x_ = get_skyline_attachment (*skylines, y);
 231           conf->attachment_x_.widen (-gap);
 232         }
 233     }
 234
 235   Bezier b = slur_shape (conf->attachment_x_.length(),
 236                          details.height_limit_,
 237                          details.ratio_);
 238   b.scale (1, conf->dir_);
 239
 240   Offset middle = b.curve_point (0.5);
 241   Offset edge = b.curve_point (0.0);
 242
 243   conf->position_ = int (rint (conf->position_));
 244
 245   Real dy = fabs (middle[Y_AXIS] - edge[Y_AXIS]);
 246   bool in_space = !(Staff_symbol_referencer::on_staffline (me, (int) conf->position_));
 247   bool fits_in_space =
 248     (dy < 0.6 * staff_space);
 249
 250   /*
 251     Avoid dot
 252    */
 253   Grob *left_dot = unsmob_grob (me->get_bound (LEFT)->get_object ("dot"));
 254   int dot_pos = left_dot
 255     ? int (Staff_symbol_referencer::get_position (left_dot))
 256     : 0;
 257   if (left_dot
 258       && (conf->position_ == dot_pos
 259           || conf->position_ + conf->dir_ == dot_pos))
 260     {
 261       conf->position_ += conf->dir_;
 262       in_space = !in_space;
 263
 264       if (skylines)
 265         {
 266           Real y = staff_space * 0.5 * conf->position_;
 267           conf->attachment_x_ = get_skyline_attachment (*skylines, y);
 268           conf->attachment_x_.widen (-gap);
 269           Bezier b = slur_shape (conf->attachment_x_.length(),
 270                                  details.height_limit_,
 271                                  details.ratio_);
 272           Offset middle = b.curve_point (0.5);
 273           Offset edge = b.curve_point (0.0);
 274           dy = fabs (middle[Y_AXIS] - edge[Y_AXIS]);
 275           fits_in_space =
 276             (dy < 0.6 * staff_space);
 277         }
 278     }
 279
 280   /*
 281     Avoid flag.
 282   */
 283   Grob *left_stem = unsmob_grob (me->get_bound (LEFT)->get_object ("stem"));
 284   if (left_stem)
 285     {
 286       Stencil flag = Stem::get_translated_flag (left_stem);
 287       Real y = conf->position_ * staff_space * 0.5;
 288       if (flag.extent (Y_AXIS).contains (y))
 289         {
 290           conf->position_ += conf->dir_;
 291           in_space = !in_space;
 292         }
 293     }
 294
 295   if (in_space != fits_in_space)
 296     {
 297       if (in_space)
 298         {
 299           conf->position_ += conf->dir_;
 300         }
 301       else
 302         {
 303           in_space = true;
 304           conf->position_ += conf->dir_;
 305         }
 306
 307       /*
 308         ugh: code dup.
 309        */
 310       if (skylines)
 311         {
 312           Real y = staff_space * 0.5 * conf->position_;
 313           conf->attachment_x_ = get_skyline_attachment (*skylines, y);
 314           conf->attachment_x_.widen (-gap);
 315
 316           Bezier b = slur_shape (conf->attachment_x_.length(),
 317                                  details.height_limit_,
 318                                  details.ratio_);
 319           Offset middle = b.curve_point (0.5);
 320           Offset edge = b.curve_point (0.0);
 321           dy = fabs (middle[Y_AXIS] - edge[Y_AXIS]);
 322           fits_in_space =
 323             (dy < 0.6 * staff_space);
 324         }
 325     }
 326
 327
 328   /*
 329     Putting larger in-space ties next to the notes forces
 330     the edges to be opposite (Y-wise) to the tie direction.
 331    */
 332   if (conf->position_ == conf->head_position_
 333       && in_space
 334       && Staff_symbol_referencer::staff_radius (me) > fabs (conf->position_) / 2
 335       && dy > 0.3 * staff_space)
 336     {
 337       conf->position_ += 2 * conf->dir_;
 338     }
 339
 340   if (!in_between
 341       && in_space
 342       && fabs (conf->position_ - conf->head_position_) <= 1)
 343     conf->position_ += 2*conf->dir_;
 344
 345
 346   if (in_space)
 347     {
 348       if ((fabs (conf->position_ - conf->head_position_) <= 1
 349            && fabs (dy) < 0.45 * staff_space)
 350           || fabs (dy) < 0.6 * staff_space)
 351         {
 352           /*
 353             vertically center in space.
 354           */
 355           conf->center_tie_vertically (details);
 356         }
 357       else
 358         {
 359           conf->delta_y_ =
 360             conf->dir_ * staff_space * (- 0.3);
 361         }
 362     }
 363   else
 364     {
 365       Real where = 0.5 * conf->dir_;
 366
 367       Real rounding_dy = (where - middle[Y_AXIS]);
 368       conf->delta_y_ = rounding_dy;
 369
 370       if (conf->dir_ * (b.curve_point (0.0)[Y_AXIS]
 371                  + conf->position_ * staff_space * 0.5
 372                  + conf->delta_y_) <
 373           conf->dir_ * conf->head_position_ * 0.5 * staff_space)
 374         {
 375           if (Staff_symbol_referencer::staff_radius (me) >  fabs (conf->head_position_) / 2)
 376             conf->position_ +=  2 * conf->dir_;
 377           else
 378             conf->position_ += conf->dir_;
 379         }
 380     }
 381
 382
 383   if (skylines)
 384     {
 385       Real half_space = 0.5 * staff_space;
 386       Real y = conf->position_ * half_space;
 387
 388       conf->attachment_x_ = get_skyline_attachment (*skylines, y);
 389       conf->attachment_x_.widen (-gap);
 390     }
 391 }
 392
 393
 394 void
 395 Tie::set_default_control_points (Grob *me_grob)
 396 {
 397   Spanner *me = dynamic_cast<Spanner*> (me_grob);
 398   Grob *common  = me;
 399   common = me->get_bound (LEFT)->common_refpoint (common, X_AXIS);
 400   common = me->get_bound (RIGHT)->common_refpoint (common, X_AXIS);
 401
 402   Tie_configuration conf;
 403   if (!get_grob_direction (me))
 404     set_grob_direction (me, get_default_dir (me));
 405
 406   int tie_position = (int) Tie::get_position (me);
 407   conf.position_ = tie_position;
 408
 409   Tie_details details;
 410   details.init (me);
 411   get_configuration (me, common, &conf, 0, details);
 412   set_control_points (me, common, conf, details);
 413 }
 414
 415 void
 416 Tie::set_control_points (Grob *me,
 417                          Grob *common,
 418                          Tie_configuration const &conf,
 419                          Tie_details const &details
 420                          )
 421 {
 422   Bezier b = conf.get_bezier (details);
 423   b.scale (1, conf.dir_);
 424   b.translate (Offset (conf.attachment_x_[LEFT]
 425                        - me->relative_coordinate (common, X_AXIS),
 426                        0.5 * conf.position_ * details.staff_space_
 427                        + conf.delta_y_
 428                        ));
 429
 430   SCM controls = SCM_EOL;
 431   for (int i = 4; i--;)
 432     {
 433       if (!b.control_[i].is_sane ())
 434         programming_error ("Insane offset");
 435       controls = scm_cons (ly_offset2scm (b.control_[i]), controls);
 436     }
 437   me->set_property ("control-points", controls);
 438 }
 439
 440
 441
 442 MAKE_SCHEME_CALLBACK (Tie, print, 1);
 443 SCM
 444 Tie::print (SCM smob)
 445 {
 446   Grob *me = unsmob_grob (smob);
 447
 448   if (CENTER == get_grob_direction (me))
 449     set_direction (me);
 450
 451   if (!get_grob_direction (me))
 452     me->programming_error ("Tie direction not set.");
 453
 454   SCM cp = me->get_property ("control-points");
 455   if (!scm_is_pair (cp))
 456     {
 457       /*
 458         UGH.  dependency tracking!
 459        */
 460       if (Tie_column::has_interface (me->get_parent (Y_AXIS)))
 461         {
 462           Tie_column::set_directions (me->get_parent (Y_AXIS));
 463         }
 464
 465       cp = me->get_property ("control-points");
 466     }
 467
 468   if (!scm_is_pair (cp))
 469     {
 470       set_default_control_points (me);
 471       cp = me->get_property ("control-points");
 472     }
 473
 474   if (!scm_is_pair (cp))
 475     return Stencil ().smobbed_copy ();
 476
 477   Real staff_thick = Staff_symbol_referencer::line_thickness (me);
 478   Real base_thick = robust_scm2double (me->get_property ("thickness"), 1);
 479   Real thick = base_thick * staff_thick;
 480
 481   Bezier b;
 482   int i = 0;
 483   for (SCM s = cp; s != SCM_EOL; s = scm_cdr (s))
 484     {
 485       b.control_[i] = ly_scm2offset (scm_car (s));
 486       i++;
 487     }
 488
 489   Stencil a;
 490
 491   SCM p = me->get_property ("dash-period");
 492   SCM f = me->get_property ("dash-fraction");
 493   if (scm_is_number (p) && scm_is_number (f))
 494     a = Lookup::dashed_slur (b,
 495                              thick,
 496                              robust_scm2double (p, 1.0),
 497                              robust_scm2double (f, 0));
 498   else
 499     a = Lookup::slur (b,
 500                       get_grob_direction (me) * staff_thick,
 501                       thick);
 502
 503   return a.smobbed_copy ();
 504 }
 505
 506 ADD_INTERFACE (Tie,
 507                "tie-interface",
 508
 509                "A tie connecting two noteheads.\n",
 510
 511                /* properties */
 512                "control-points "
 513                "dash-fraction "
 514                "dash-period "
 515                "details "
 516                "direction "
 517                "thickness "
 518                "x-gap ");