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