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