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   Direction dir = CENTER;
 211
 212   int tie_position = (int) Tie::get_position (me);
 213   int staff_position = (int) conf->position_;
 214
 215   if (conf->dir_)
 216     {
 217       dir = conf->dir_;
 218     }
 219   else
 220     {
 221       dir = get_grob_direction (me);
 222       if (!dir)
 223         dir = get_default_dir (me);
 224     }
 225
 226   Real staff_space = details.staff_space_;
 227
 228   bool in_between = true;
 229   Interval attachments = conf->attachment_x_;
 230   Real gap = robust_scm2double (me->get_property ("x-gap"), 0.2);
 231   if (attachments.is_empty())
 232     {
 233       if (!skylines)
 234         attachments = get_default_attachments (me, common, gap,
 235                                                &staff_position,
 236                                                &in_between);
 237       else
 238         {
 239           Real y = staff_space * 0.5 * staff_position;
 240           attachments = get_skyline_attachment (*skylines, y);
 241           attachments.widen (-gap);
 242         }
 243     }
 244
 245   Bezier b = slur_shape (attachments.length(),
 246                          details.height_limit_,
 247                          details.ratio_);
 248   b.scale (1, dir);
 249
 250   Offset middle = b.curve_point (0.5);
 251   Offset edge = b.curve_point (0.0);
 252
 253   staff_position = int (rint (staff_position));
 254
 255   Real dy = fabs (middle[Y_AXIS] - edge[Y_AXIS]);
 256   bool in_space = !(Staff_symbol_referencer::on_staffline (me, (int) staff_position));
 257   bool fits_in_space =
 258     (dy < 0.6 * staff_space);
 259
 260   /*
 261     Avoid dot
 262    */
 263   Grob *left_dot = unsmob_grob (me->get_bound (LEFT)->get_object ("dot"));
 264   int dot_pos = left_dot
 265     ? int (Staff_symbol_referencer::get_position (left_dot))
 266     : 0;
 267   if (left_dot
 268       && (staff_position == dot_pos
 269           || staff_position + dir == dot_pos))
 270     {
 271       staff_position += dir;
 272       in_space = !in_space;
 273
 274       if (skylines)
 275         {
 276           Real y = staff_space * 0.5 * staff_position;
 277           attachments = get_skyline_attachment (*skylines, y);
 278           attachments.widen (-gap);
 279           Bezier b = slur_shape (attachments.length(),
 280                                  details.height_limit_,
 281                                  details.ratio_);
 282           Offset middle = b.curve_point (0.5);
 283           Offset edge = b.curve_point (0.0);
 284           dy = fabs (middle[Y_AXIS] - edge[Y_AXIS]);
 285           fits_in_space =
 286             (dy < 0.6 * staff_space);
 287         }
 288     }
 289
 290   /*
 291     Avoid flag.
 292   */
 293   Grob *left_stem = unsmob_grob (me->get_bound (LEFT)->get_object ("stem"));
 294   if (left_stem)
 295     {
 296       Stencil flag = Stem::get_translated_flag (left_stem);
 297       Real y = staff_position * staff_space * 0.5;
 298       if (flag.extent (Y_AXIS).contains (y))
 299         {
 300           staff_position += dir;
 301           in_space = !in_space;
 302         }
 303     }
 304
 305   if (in_space != fits_in_space)
 306     {
 307       if (in_space)
 308         {
 309           staff_position += dir;
 310         }
 311       else
 312         {
 313           in_space = true;
 314           staff_position += dir;
 315         }
 316
 317       /*
 318         ugh: code dup.
 319        */
 320       if (skylines)
 321         {
 322           Real y = staff_space * 0.5 * staff_position;
 323           attachments = get_skyline_attachment (*skylines, y);
 324           attachments.widen (-gap);
 325
 326           Bezier b = slur_shape (attachments.length(),
 327                                  details.height_limit_,
 328                                  details.ratio_);
 329           Offset middle = b.curve_point (0.5);
 330           Offset edge = b.curve_point (0.0);
 331           dy = fabs (middle[Y_AXIS] - edge[Y_AXIS]);
 332           fits_in_space =
 333             (dy < 0.6 * staff_space);
 334         }
 335     }
 336
 337
 338   /*
 339     Putting larger in-space ties next to the notes forces
 340     the edges to be opposite (Y-wise) to the tie direction.
 341    */
 342   if (staff_position == tie_position
 343       && in_space
 344       && Staff_symbol_referencer::staff_radius (me) > fabs (staff_position) / 2
 345       && dy > 0.3 * staff_space)
 346     {
 347       staff_position += 2 * dir;
 348     }
 349
 350   if (!in_between
 351       && in_space
 352       && fabs (staff_position - tie_position) <= 1)
 353     staff_position += 2*dir;
 354
 355
 356   conf->dir_ = dir;
 357   conf->position_ = staff_position;
 358   if (in_space)
 359     {
 360       if ((fabs (staff_position - tie_position) <= 1
 361            && fabs (dy) < 0.45 * staff_space)
 362           || fabs (dy) < 0.6 * staff_space)
 363         {
 364           /*
 365             vertically center in space.
 366           */
 367           conf->dir_ = dir;
 368           conf->position_ = staff_position;
 369           conf->attachment_x_ = attachments;
 370           conf->center_tie_vertically (details);
 371         }
 372       else
 373         {
 374           conf->delta_y_ =
 375             dir * staff_space * (- 0.3);
 376         }
 377     }
 378   else
 379     {
 380       Real where = 0.5 * dir;
 381
 382       Real rounding_dy = (where - middle[Y_AXIS]);
 383       conf->delta_y_ = rounding_dy;
 384
 385       if (dir * (b.curve_point (0.0)[Y_AXIS]
 386                  + conf->position_ * staff_space * 0.5
 387                  + conf->delta_y_) <
 388           dir * tie_position * 0.5 * staff_space)
 389         {
 390           if (Staff_symbol_referencer::staff_radius (me) >  fabs (tie_position) / 2)
 391             conf->position_ +=  2 * dir;
 392           else
 393             conf->position_ += dir;
 394         }
 395     }
 396
 397
 398   if (skylines)
 399     {
 400       Real half_space = 0.5 * staff_space;
 401       Real y = staff_position * half_space;
 402
 403       attachments = get_skyline_attachment (*skylines, y);
 404
 405       attachments.widen (-gap);
 406     }
 407   conf->attachment_x_ = attachments;
 408 }
 409
 410
 411 void
 412 Tie::set_default_control_points (Grob *me_grob)
 413 {
 414   Spanner *me = dynamic_cast<Spanner*> (me_grob);
 415   Grob *common  = me;
 416   common = me->get_bound (LEFT)->common_refpoint (common, X_AXIS);
 417   common = me->get_bound (RIGHT)->common_refpoint (common, X_AXIS);
 418
 419   Tie_configuration conf;
 420   if (!get_grob_direction (me))
 421     set_grob_direction (me, get_default_dir (me));
 422
 423   int tie_position = (int) Tie::get_position (me);
 424   conf.position_ = tie_position;
 425
 426   Tie_details details;
 427   details.init (me);
 428   get_configuration (me, common, &conf, 0, details);
 429   set_control_points (me, common, conf, details);
 430 }
 431
 432 void
 433 Tie::set_control_points (Grob *me,
 434                          Grob *common,
 435                          Tie_configuration const &conf,
 436                          Tie_details const &details
 437                          )
 438 {
 439   Bezier b = conf.get_bezier (details);
 440   b.scale (1, conf.dir_);
 441   b.translate (Offset (conf.attachment_x_[LEFT]
 442                        - me->relative_coordinate (common, X_AXIS),
 443                        0.5 * conf.position_ * details.staff_space_
 444                        + conf.delta_y_
 445                        ));
 446
 447   SCM controls = SCM_EOL;
 448   for (int i = 4; i--;)
 449     {
 450       if (!b.control_[i].is_sane ())
 451         programming_error ("Insane offset");
 452       controls = scm_cons (ly_offset2scm (b.control_[i]), controls);
 453     }
 454   me->set_property ("control-points", controls);
 455 }
 456
 457
 458
 459 MAKE_SCHEME_CALLBACK (Tie, print, 1);
 460 SCM
 461 Tie::print (SCM smob)
 462 {
 463   Grob *me = unsmob_grob (smob);
 464
 465   if (CENTER == get_grob_direction (me))
 466     set_direction (me);
 467
 468   if (!get_grob_direction (me))
 469     me->programming_error ("Tie direction not set.");
 470
 471   SCM cp = me->get_property ("control-points");
 472   if (!scm_is_pair (cp))
 473     {
 474       /*
 475         UGH.  dependency tracking!
 476        */
 477       if (Tie_column::has_interface (me->get_parent (Y_AXIS)))
 478         {
 479           Tie_column::set_directions (me->get_parent (Y_AXIS));
 480         }
 481
 482       cp = me->get_property ("control-points");
 483     }
 484
 485   if (!scm_is_pair (cp))
 486     {
 487       set_default_control_points (me);
 488       cp = me->get_property ("control-points");
 489     }
 490
 491   if (!scm_is_pair (cp))
 492     return Stencil ().smobbed_copy ();
 493
 494   Real staff_thick = Staff_symbol_referencer::line_thickness (me);
 495   Real base_thick = robust_scm2double (me->get_property ("thickness"), 1);
 496   Real thick = base_thick * staff_thick;
 497
 498   Bezier b;
 499   int i = 0;
 500   for (SCM s = cp; s != SCM_EOL; s = scm_cdr (s))
 501     {
 502       b.control_[i] = ly_scm2offset (scm_car (s));
 503       i++;
 504     }
 505
 506   Stencil a;
 507
 508   SCM p = me->get_property ("dash-period");
 509   SCM f = me->get_property ("dash-fraction");
 510   if (scm_is_number (p) && scm_is_number (f))
 511     a = Lookup::dashed_slur (b,
 512                              thick,
 513                              robust_scm2double (p, 1.0),
 514                              robust_scm2double (f, 0));
 515   else
 516     a = Lookup::slur (b,
 517                       get_grob_direction (me) * staff_thick,
 518                       thick);
 519
 520   return a.smobbed_copy ();
 521 }
 522
 523 ADD_INTERFACE (Tie,
 524                "tie-interface",
 525
 526                "A tie connecting two noteheads.\n",
 527
 528                "control-points "
 529                "dash-fraction "
 530                "dash-period "
 531                "details "
 532                "direction "
 533                "thickness "
 534                "x-gap ");