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