lily/lookup.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   Jan Nieuwenhuizen <janneke@gnu.org>
   7
   8   LilyPond is free software: you can redistribute it and/or modify
   9   it under the terms of the GNU General Public License as published by
  10   the Free Software Foundation, either version 3 of the License, or
  11   (at your option) any later version.
  12
  13   LilyPond is distributed in the hope that it will be useful,
  14   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16   GNU General Public License for more details.
  17
  18   You should have received a copy of the GNU General Public License
  19   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 #include "lookup.hh"
  23
  24 #include <cmath>
  25 #include <cctype>
  26 using namespace std;
  27
  28 #include "line-interface.hh"
  29 #include "warn.hh"
  30 #include "international.hh"
  31 #include "dimensions.hh"
  32 #include "bezier.hh"
  33 #include "file-path.hh"
  34 #include "main.hh"
  35 #include "lily-guile.hh"
  36
  37 Stencil
  38 Lookup::beam (Real slope, Real width, Real thick, Real blot)
  39 {
  40   Box b;
  41
  42   Offset p;
  43
  44   p = Offset (0, thick / 2);
  45   b.add_point (p);
  46   p += Offset (1, -1) * (blot / 2);
  47
  48   SCM points = SCM_EOL;
  49
  50   points = scm_cons (scm_from_double (p[X_AXIS]),
  51                      scm_cons (scm_from_double (p[Y_AXIS]),
  52                                points));
  53
  54   p = Offset (0, -thick / 2);
  55   b.add_point (p);
  56   p += Offset (1, 1) * (blot / 2);
  57
  58   points = scm_cons (scm_from_double (p[X_AXIS]),
  59                      scm_cons (scm_from_double (p[Y_AXIS]),
  60                                points));
  61
  62   p = Offset (width, width * slope - thick / 2);
  63   b.add_point (p);
  64   p += Offset (-1, 1) * (blot / 2);
  65
  66   points = scm_cons (scm_from_double (p[X_AXIS]),
  67                      scm_cons (scm_from_double (p[Y_AXIS]),
  68                                points));
  69
  70   p = Offset (width, width * slope + thick / 2);
  71   b.add_point (p);
  72   p += Offset (-1, -1) * (blot / 2);
  73
  74   points = scm_cons (scm_from_double (p[X_AXIS]),
  75                      scm_cons (scm_from_double (p[Y_AXIS]),
  76                                points));
  77
  78   SCM expr = scm_list_n (ly_symbol2scm ("polygon"),
  79                          ly_quote_scm (points),
  80                          scm_from_double (blot),
  81                          SCM_BOOL_T,
  82                          SCM_UNDEFINED);
  83
  84   return Stencil (b, expr);
  85 }
  86
  87 Stencil
  88 Lookup::rotated_box (Real slope, Real width, Real thick, Real blot)
  89 {
  90   vector<Offset> pts;
  91   Offset rot = Offset (1, slope).direction ();
  92
  93   pts.push_back (Offset (0, -thick / 2) * rot);
  94   pts.push_back (Offset (width, -thick / 2) * rot);
  95   pts.push_back (Offset (width, thick / 2) * rot);
  96   pts.push_back (Offset (0, thick / 2) * rot);
  97   return Lookup::round_filled_polygon (pts, blot);
  98 }
  99
 100 Stencil
 101 Lookup::horizontal_line (Interval w, Real th)
 102 {
 103   SCM at = scm_list_n (ly_symbol2scm ("draw-line"),
 104                        scm_from_double (th),
 105                        scm_from_double (w[LEFT]),
 106                        scm_from_double (0),
 107                        scm_from_double (w[RIGHT]),
 108                        scm_from_double (0),
 109                        SCM_UNDEFINED);
 110
 111   Box box;
 112   box[X_AXIS] = w;
 113   box[Y_AXIS] = Interval (-th / 2, th / 2);
 114
 115   return Stencil (box, at);
 116 }
 117
 118 Stencil
 119 Lookup::blank (Box b)
 120 {
 121   return Stencil (b, scm_string (SCM_EOL));
 122 }
 123
 124 Stencil
 125 Lookup::circle (Real rad, Real thick, bool filled)
 126 {
 127   Box b (Interval (-rad, rad), Interval (-rad, rad));
 128   return Stencil (b, scm_list_4 (ly_symbol2scm ("circle"),
 129                                  scm_from_double (rad),
 130                                  scm_from_double (thick),
 131                                  scm_from_bool (filled)));
 132 }
 133
 134 Stencil
 135 Lookup::filled_box (Box b)
 136 {
 137   return round_filled_box (b, 0.0);
 138 }
 139
 140 /*
 141  * round filled box:
 142  *
 143  *   __________________________________
 144  *  /     \  ^           /     \      ^
 145  * |         |blot              |     |
 146  * |       | |dia       |       |     |
 147  * |         |meter             |     |
 148  * |\ _ _ /  v           \ _ _ /|     |
 149  * |                            |     |
 150  * |                            |     | Box
 151  * |                    <------>|     | extent
 152  * |                      blot  |     | (Y_AXIS)
 153  * |                    diameter|     |
 154  * |                            |     |
 155  * |  _ _                  _ _  |     |
 156  * |/     \              /     \|     |
 157  * |                            |     |
 158  * |       |            |       |     |
 159  * |                            |     |
 160  * x\_____/______________\_____/|_____v
 161  * |(0, 0)                       |
 162  * |                            |
 163  * |                            |
 164  * |<-------------------------->|
 165  *       Box extent (X_AXIS)
 166  */
 167 Stencil
 168 Lookup::round_filled_box (Box b, Real blotdiameter)
 169 {
 170   Real width = b.x ().delta ();
 171   blotdiameter = min (blotdiameter, width);
 172   Real height = b.y ().delta ();
 173   blotdiameter = min (blotdiameter, height);
 174
 175   if (blotdiameter < 0.0)
 176     {
 177       if (!isinf (blotdiameter))
 178         warning (_f ("Not drawing a box with negative dimension, %.2f by %.2f.",
 179                      width, height));
 180       return Stencil (b, SCM_EOL);
 181     }
 182
 183   SCM at = (scm_list_n (ly_symbol2scm ("round-filled-box"),
 184                         scm_from_double (-b[X_AXIS][LEFT]),
 185                         scm_from_double (b[X_AXIS][RIGHT]),
 186                         scm_from_double (-b[Y_AXIS][DOWN]),
 187                         scm_from_double (b[Y_AXIS][UP]),
 188                         scm_from_double (blotdiameter),
 189                         SCM_UNDEFINED));
 190
 191   return Stencil (b, at);
 192 }
 193
 194 /*
 195  * Create Stencil that represents a filled polygon with round edges.
 196  *
 197  * LIMITATIONS:
 198  *
 199  * (a) Only outer (convex) edges are rounded.
 200  *
 201  * (b) This algorithm works as expected only for polygons whose edges
 202  * do not intersect.  For example, the polygon ((0, 0), (q, 0), (0,
 203  * q), (q, q)) has an intersection at point (q/2, q/2) and therefore
 204  * will give a strange result.  Even non-adjacent edges that just
 205  * touch each other will in general not work as expected for non-null
 206  * blotdiameter.
 207  *
 208  * (c) Given a polygon ((x0, y0), (x1, y1), ... , (x (n-1), y (n-1))),
 209  * if there is a natural number k such that blotdiameter is greater
 210  * than the maximum of { | (x (k mod n), y (k mod n)) - (x ((k+1) mod n),
 211  * y ((k+1) mod n)) |, | (x (k mod n), y (k mod n)) - (x ((k+2) mod n),
 212  * y ((k+2) mod n)) |, | (x ((k+1) mod n), y ((k+1) mod n)) - (x ((k+2)
 213  * mod n), y ((k+2) mod n)) | }, then the outline of the rounded
 214  * polygon will exceed the outline of the core polygon.  In other
 215  * words: Do not draw rounded polygons that have a leg smaller or
 216  * thinner than blotdiameter (or set blotdiameter to a sufficiently
 217  * small value -- maybe even 0.0)!
 218  *
 219  * NOTE: Limitations (b) and (c) arise from the fact that round edges
 220  * are made by moulding sharp edges to round ones rather than adding
 221  * to a core filled polygon.  For details of these two different
 222  * approaches, see the thread upon the ledger lines patch that started
 223  * on March 25, 2002 on the devel mailing list.  The below version of
 224  * round_filled_polygon () sticks to the moulding model, which the
 225  * majority of the list participants finally voted for.  This,
 226  * however, results in the above limitations and a much increased
 227  * complexity of the algorithm, since it has to compute a shrinked
 228  * polygon -- which is not trivial define precisely and unambigously.
 229  * With the other approach, one simply could move a circle of size
 230  * blotdiameter along all edges of the polygon (which is what the
 231  * postscript routine in the backend effectively does, but on the
 232  * shrinked polygon). --jr
 233  */
 234 Stencil
 235 Lookup::round_filled_polygon (vector<Offset> const &points,
 236                               Real blotdiameter)
 237 {
 238   /* TODO: Maybe print a warning if one of the above limitations
 239      applies to the given polygon.  However, this is quite complicated
 240      to check. */
 241
 242   const Real epsilon = 0.01;
 243
 244 #ifdef DEBUG
 245   /* remove consecutive duplicate points */
 246   for (vsize i = 0; i < points.size (); i++)
 247     {
 248       int next = (i + 1) % points.size ();
 249       Real d = (points[i] - points[next]).length ();
 250       if (d < epsilon)
 251         programming_error ("Polygon should not have duplicate points");
 252     }
 253 #endif
 254
 255   /* special cases: degenerated polygons */
 256   if (points.size () == 0)
 257     return Stencil ();
 258   if (points.size () == 1)
 259     {
 260       Stencil circ = circle (0.5 * blotdiameter, 0, true);
 261       circ.translate (points[0]);
 262       return circ;
 263     }
 264   if (points.size () == 2)
 265     return Line_interface::make_line (blotdiameter, points[0], points[1]);
 266
 267   /* shrink polygon in size by 0.5 * blotdiameter */
 268
 269   // first we need to determine the orientation of the polygon in
 270   // order to decide whether shrinking means moving the polygon to the
 271   // left or to the right of the outline.  We do that by calculating
 272   // (double) the oriented area of the polygon.  We first determine the
 273   // center and do the area calculations relative to it.
 274   // Mathematically, the result is not affected by this shift, but
 275   // numerically a lot of cancellation is going on and this keeps its
 276   // effects in check.
 277
 278   Offset center;
 279   for (vsize i = 0; i < points.size (); i++)
 280     center += points[i];
 281   center /= points.size ();
 282
 283   Real area = 0.0;
 284   Offset last = points.back () - center;
 285
 286   for (vsize i = 0; i < points.size (); i++)
 287     {
 288       Offset here = points[i] - center;
 289       area += cross_product (last, here);
 290       last = here;
 291     }
 292
 293   bool ccw = area >= 0.0;  // true if whole shape is counterclockwise oriented
 294
 295   vector<Offset> shrunk_points;
 296   shrunk_points.resize (points.size ());
 297
 298   for (vsize i = 0; i < points.size (); i++)
 299     {
 300       int i0 = i;
 301       int i1 = (i + 1) % points.size ();
 302       int i2 = (i + 2) % points.size ();
 303       Offset p0 = points[i0];
 304       Offset p1 = points[i1];
 305       Offset p2 = points[i2];
 306       Offset p01 = p1 - p0;
 307       Offset p12 = p2 - p1;
 308       Offset inward0 = Offset(-p01[Y_AXIS], p01[X_AXIS]).direction ();
 309       Offset inward2 = Offset(-p12[Y_AXIS], p12[X_AXIS]).direction ();
 310
 311       if (!ccw)
 312         {
 313           inward0 = -inward0;
 314           inward2 = -inward2;
 315         }
 316
 317       Offset middle = 0.5*(inward0 + inward2);
 318
 319       // "middle" now is a vector in the right direction for the
 320       // shrinkage.  Its size needs to be large enough that the
 321       // projection on either of the inward vectors has a size of 1.
 322
 323       Real proj = dot_product (middle, inward0);
 324
 325       // What's the size of proj?  Assuming that we have a corner
 326       // angle of phi where 0 corresponds to a continuing line, the
 327       // length of middle is 0.5 |(1+cos phi, sin phi)| = cos (phi/2),
 328       // so its projection has length
 329       // cos^2 (phi/2) = 0.5 + 0.5 cos (phi).
 330       // We don't really want to move inwards more than 3 blob
 331       // diameters corresponding to 6 blob radii.  So
 332       // cos (phi/2) = 1/6 gives phi ~ 161, meaning that a 20 degree
 333       // corner necessitates moving 3 blob diameters from the corner
 334       // in order to stay inside the lines.  Ruler and circle agree.
 335       // 0.03 is close enough to 1/36.  Basically we want to keep the
 336       // shape from inverting from pulling too far inward.
 337       // 3 diameters is pretty much a handwaving guess.
 338
 339       if (abs (proj) < 0.03)
 340         proj = proj < 0 ? -0.03 : 0.03;
 341
 342       shrunk_points[i1] = p1 + (0.5 * blotdiameter / proj) * middle;
 343     }
 344
 345   /* build scm expression and bounding box */
 346   SCM shrunk_points_scm = SCM_EOL;
 347   Box box;
 348   for (vsize i = 0; i < shrunk_points.size (); i++)
 349     {
 350       SCM x = scm_from_double (shrunk_points[i][X_AXIS]);
 351       SCM y = scm_from_double (shrunk_points[i][Y_AXIS]);
 352       shrunk_points_scm = scm_cons (x, scm_cons (y, shrunk_points_scm));
 353       box.add_point (points[i]);
 354     }
 355   SCM polygon_scm = scm_list_n (ly_symbol2scm ("polygon"),
 356                                 ly_quote_scm (shrunk_points_scm),
 357                                 scm_from_double (blotdiameter),
 358                                 SCM_BOOL_T,
 359                                 SCM_UNDEFINED);
 360
 361   Stencil polygon = Stencil (box, polygon_scm);
 362   shrunk_points.clear ();
 363   return polygon;
 364 }
 365
 366 /*
 367   TODO: deprecate?
 368 */
 369 Stencil
 370 Lookup::frame (Box b, Real thick, Real blot)
 371 {
 372   Stencil m;
 373   for (Axis a = X_AXIS; a < NO_AXES; a = Axis (a + 1))
 374     {
 375       Axis o = Axis ((a + 1) % NO_AXES);
 376       for (LEFT_and_RIGHT (d))
 377         {
 378           Box edges;
 379           edges[a] = b[a][d] + 0.5 * thick * Interval (-1, 1);
 380           edges[o][DOWN] = b[o][DOWN] - thick / 2;
 381           edges[o][UP] = b[o][UP] + thick / 2;
 382
 383           m.add_stencil (round_filled_box (edges, blot));
 384         }
 385     }
 386   return m;
 387 }
 388
 389 /*
 390   Make a smooth curve along the points
 391 */
 392 Stencil
 393 Lookup::slur (Bezier curve, Real curvethick, Real linethick,
 394               SCM dash_details)
 395 {
 396   Stencil return_value;
 397
 398   /*
 399       calculate the offset for the two beziers that make the sandwich
 400       for the slur
 401   */
 402   Real alpha = (curve.control_[3] - curve.control_[0]).arg ();
 403   Bezier back = curve;
 404   Offset perp = curvethick * complex_exp (Offset (0, alpha + M_PI / 2)) * 0.5;
 405   back.control_[1] += perp;
 406   back.control_[2] += perp;
 407
 408   curve.control_[1] -= perp;
 409   curve.control_[2] -= perp;
 410
 411   if (!scm_is_pair (dash_details))
 412     {
 413       /* solid slur  */
 414       return_value = bezier_sandwich (back, curve, linethick);
 415     }
 416   else
 417     {
 418       /* dashed or combination slur */
 419       int num_segments = scm_to_int (scm_length (dash_details));
 420       for (int i = 0; i < num_segments; i++)
 421         {
 422           SCM dash_pattern = scm_list_ref (dash_details, scm_from_int (i));
 423           Real t_min = robust_scm2double (scm_car (dash_pattern), 0);
 424           Real t_max = robust_scm2double (scm_cadr (dash_pattern), 1.0);
 425           Real dash_fraction
 426             = robust_scm2double (scm_caddr (dash_pattern), 1.0);
 427           Real dash_period
 428             = robust_scm2double (scm_cadddr (dash_pattern), 0.75);
 429           Bezier back_segment = back.extract (t_min, t_max);
 430           Bezier curve_segment = curve.extract (t_min, t_max);
 431           if (dash_fraction == 1.0)
 432             return_value.add_stencil (bezier_sandwich (back_segment,
 433                                                        curve_segment,
 434                                                        linethick));
 435           else
 436             {
 437               Bezier back_dash, curve_dash;
 438               Real seg_length = (back_segment.control_[3]
 439                                  - back_segment.control_[0]).length ();
 440               int pattern_count = (int) (seg_length / dash_period);
 441               Real pattern_length = 1.0 / (pattern_count + dash_fraction);
 442               Real start_t, end_t;
 443               for (int p = 0; p <= pattern_count; p++)
 444                 {
 445                   start_t = p * pattern_length;
 446                   end_t = (p + dash_fraction) * pattern_length;
 447                   back_dash
 448                     = back_segment.extract (start_t, end_t);
 449                   curve_dash
 450                     = curve_segment.extract (start_t, end_t);
 451                   return_value.add_stencil (bezier_sandwich (back_dash,
 452                                                              curve_dash,
 453                                                              linethick));
 454                 }
 455             }
 456         }
 457     }
 458   return return_value;
 459 }
 460
 461 /*
 462  * Bezier Sandwich:
 463  *
 464  *                               .|
 465  *                        .       |
 466  *              top .             |
 467  *              . curve           |
 468  *          .                     |
 469  *       .                        |
 470  *     .                          |
 471  *    |                           |
 472  *    |                          .|
 473  *    |                     .
 474  *    |         bottom .
 475  *    |            . curve
 476  *    |         .
 477  *    |      .
 478  *    |   .
 479  *    | .
 480  *    |.
 481  *    |
 482  *
 483  */
 484 Stencil
 485 Lookup::bezier_sandwich (Bezier top_curve, Bezier bottom_curve, Real thickness)
 486 {
 487   SCM commands = scm_list_n (ly_symbol2scm ("moveto"),
 488                              scm_from_double (top_curve.control_[0][X_AXIS]),
 489                              scm_from_double (top_curve.control_[0][Y_AXIS]),
 490                              ly_symbol2scm ("curveto"),
 491                              scm_from_double (top_curve.control_[1][X_AXIS]),
 492                              scm_from_double (top_curve.control_[1][Y_AXIS]),
 493                              scm_from_double (top_curve.control_[2][X_AXIS]),
 494                              scm_from_double (top_curve.control_[2][Y_AXIS]),
 495                              scm_from_double (top_curve.control_[3][X_AXIS]),
 496                              scm_from_double (top_curve.control_[3][Y_AXIS]),
 497                              ly_symbol2scm ("lineto"),
 498                              scm_from_double (bottom_curve.control_[3][X_AXIS]),
 499                              scm_from_double (bottom_curve.control_[3][Y_AXIS]),
 500                              ly_symbol2scm ("curveto"),
 501                              scm_from_double (bottom_curve.control_[2][X_AXIS]),
 502                              scm_from_double (bottom_curve.control_[2][Y_AXIS]),
 503                              scm_from_double (bottom_curve.control_[1][X_AXIS]),
 504                              scm_from_double (bottom_curve.control_[1][Y_AXIS]),
 505                              scm_from_double (bottom_curve.control_[0][X_AXIS]),
 506                              scm_from_double (bottom_curve.control_[0][Y_AXIS]),
 507                              ly_symbol2scm ("closepath"),
 508                              SCM_UNDEFINED);
 509
 510   SCM horizontal_bend = scm_list_n (ly_symbol2scm ("path"),
 511                                     scm_from_double (thickness),
 512                                     ly_quote_scm (commands),
 513                                     ly_quote_scm (ly_symbol2scm ("round")),
 514                                     ly_quote_scm (ly_symbol2scm ("round")),
 515                                     SCM_BOOL_T,
 516                                     SCM_UNDEFINED);
 517
 518   Interval x_extent = top_curve.extent (X_AXIS);
 519   x_extent.unite (bottom_curve.extent (X_AXIS));
 520   Interval y_extent = top_curve.extent (Y_AXIS);
 521   y_extent.unite (bottom_curve.extent (Y_AXIS));
 522   Box b (x_extent, y_extent);
 523
 524   b.widen (0.5 * thickness, 0.5 * thickness);
 525   return Stencil (b, horizontal_bend);
 526 }
 527
 528 Stencil
 529 Lookup::repeat_slash (Real w, Real s, Real t)
 530 {
 531
 532   Real x_width = sqrt ((t * t) + ((t / s) * (t / s)));
 533   Real height = w * s;
 534
 535   SCM controls = scm_list_n (ly_symbol2scm ("moveto"),
 536                              scm_from_double (0),
 537                              scm_from_double (0),
 538                              ly_symbol2scm ("rlineto"),
 539                              scm_from_double (x_width),
 540                              scm_from_double (0),
 541                              ly_symbol2scm ("rlineto"),
 542                              scm_from_double (w),
 543                              scm_from_double (height),
 544                              ly_symbol2scm ("rlineto"),
 545                              scm_from_double (-x_width),
 546                              scm_from_double (0),
 547                              ly_symbol2scm ("closepath"),
 548                              SCM_UNDEFINED);
 549
 550   SCM slashnodot = scm_list_n (ly_symbol2scm ("path"),
 551                                scm_from_double (0),
 552                                ly_quote_scm (controls),
 553                                ly_quote_scm (ly_symbol2scm ("round")),
 554                                ly_quote_scm (ly_symbol2scm ("round")),
 555                                SCM_BOOL_T,
 556                                SCM_UNDEFINED);
 557
 558   Box b (Interval (0, w + sqrt (sqr (t / s) + sqr (t))),
 559          Interval (0, w * s));
 560
 561   return Stencil (b, slashnodot); //  http://slashnodot.org
 562 }
 563
 564 Stencil
 565 Lookup::bracket (Axis a, Interval iv, Real thick, Real protrude, Real blot)
 566 {
 567   Box b;
 568   Axis other = Axis ((a + 1) % 2);
 569   b[a] = iv;
 570   b[other] = Interval (-1, 1) * thick * 0.5;
 571
 572   Stencil m = round_filled_box (b, blot);
 573
 574   b[a] = Interval (iv[UP] - thick, iv[UP]);
 575   Interval oi = Interval (-thick / 2, thick / 2 + fabs (protrude));
 576   oi *= sign (protrude);
 577   b[other] = oi;
 578   m.add_stencil (round_filled_box (b, blot));
 579   b[a] = Interval (iv[DOWN], iv[DOWN] + thick);
 580   m.add_stencil (round_filled_box (b, blot));
 581
 582   return m;
 583 }
 584
 585 Stencil
 586 Lookup::triangle (Interval iv, Real thick, Real protrude)
 587 {
 588   Box b;
 589   b[X_AXIS] = Interval (0, iv.length ());
 590   b[Y_AXIS] = Interval (min (0., protrude), max (0.0, protrude));
 591
 592   vector<Offset> points;
 593   points.push_back (Offset (iv[LEFT], 0));
 594   points.push_back (Offset (iv[RIGHT], 0));
 595   points.push_back (Offset (iv.center (), protrude));
 596   points.push_back (Offset (iv[LEFT], 0));  // close triangle
 597
 598   return points_to_line_stencil (thick, points);
 599
 600 }
 601
 602 Stencil
 603 Lookup::points_to_line_stencil (Real thick, vector<Offset> const &points)
 604 {
 605   Stencil ret;
 606   for (vsize i = 1; i < points.size (); i++)
 607     {
 608       if (points[i - 1].is_sane () && points[i].is_sane ())
 609         {
 610           Stencil line
 611             = Line_interface::make_line (thick, points[i - 1], points[i]);
 612           ret.add_stencil (line);
 613         }
 614     }
 615   return ret;
 616 }