lily/ledger-line-spanner.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2004--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include <map>
  21 using namespace std;
  22
  23 #include "note-head.hh"
  24 #include "staff-symbol-referencer.hh"
  25 #include "staff-symbol.hh"
  26 #include "lookup.hh"
  27 #include "spanner.hh"
  28 #include "pointer-group-interface.hh"
  29 #include "paper-column.hh"
  30
  31 struct Ledger_line_spanner
  32 {
  33   DECLARE_SCHEME_CALLBACK (print, (SCM));
  34   DECLARE_SCHEME_CALLBACK (set_spacing_rods, (SCM));
  35   DECLARE_GROB_INTERFACE ();
  36 };
  37
  38 static void
  39 set_rods (Drul_array<Interval> const &current_extents,
  40           Drul_array<Interval> const &previous_extents,
  41           Item *current_column,
  42           Item *previous_column,
  43           Real min_length_fraction)
  44 {
  45   Direction d = UP;
  46   do
  47     {
  48       if (!current_extents[d].is_empty ()
  49           && !previous_extents[d].is_empty ())
  50         {
  51           Real total_head_length = previous_extents[d].length ()
  52                                    + current_extents[d].length ();
  53
  54           Rod rod;
  55           rod.distance_ = total_head_length
  56                           * (3 / 2 * min_length_fraction)
  57                           /*
  58                             we go from right to left.
  59                           */
  60                           - previous_extents[d][LEFT]
  61                           + current_extents[d][RIGHT];
  62
  63           rod.item_drul_[LEFT] = current_column;
  64           rod.item_drul_[RIGHT] = previous_column;
  65           rod.add_to_cols ();
  66         }
  67     }
  68   while (flip (&d) != DOWN);
  69 }
  70
  71 MAKE_SCHEME_CALLBACK (Ledger_line_spanner, set_spacing_rods, 1);
  72 SCM
  73 Ledger_line_spanner::set_spacing_rods (SCM smob)
  74 {
  75   Spanner *me = dynamic_cast<Spanner *> (unsmob_grob (smob));
  76
  77   // find size of note heads.
  78   Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
  79   if (!staff)
  80     {
  81       me->suicide ();
  82       return SCM_EOL;
  83     }
  84
  85   Real min_length_fraction
  86     = robust_scm2double (me->get_property ("minimum-length-fraction"), 0.15);
  87
  88   Drul_array<Interval> current_extents;
  89   Drul_array<Interval> previous_extents;
  90   Item *previous_column = 0;
  91   Item *current_column = 0;
  92
  93   Real halfspace = Staff_symbol::staff_space (staff) / 2;
  94
  95   Interval staff_extent = staff->extent (staff, Y_AXIS);
  96   staff_extent *= 1 / halfspace;
  97
  98   /*
  99     Run through heads using a loop. Since Ledger_line_spanner can
 100     contain a lot of noteheads, superlinear performance is too slow.
 101   */
 102   extract_item_set (me, "note-heads", heads);
 103   for (vsize i = heads.size (); i--;)
 104     {
 105       Item *h = heads[i];
 106
 107       int pos = Staff_symbol_referencer::get_rounded_position (h);
 108       if (staff_extent.contains (pos))
 109         continue;
 110
 111       Item *column = h->get_column ();
 112       if (current_column != column)
 113         {
 114           set_rods (current_extents, previous_extents,
 115                     current_column, previous_column,
 116                     min_length_fraction);
 117
 118           previous_column = current_column;
 119           current_column = column;
 120           previous_extents = current_extents;
 121
 122           current_extents[DOWN].set_empty ();
 123           current_extents[UP].set_empty ();
 124         }
 125
 126       Interval head_extent = h->extent (column, X_AXIS);
 127       Direction vdir = Direction (sign (pos));
 128       if (!vdir)
 129         continue;
 130
 131       current_extents[vdir].unite (head_extent);
 132     }
 133
 134   if (previous_column && current_column)
 135     set_rods (current_extents, previous_extents,
 136               current_column, previous_column,
 137               min_length_fraction);
 138
 139   return SCM_UNSPECIFIED;
 140 }
 141
 142 struct Ledger_request
 143 {
 144   Interval ledger_extent_;
 145   Interval head_extent_;
 146   int position_;
 147   bool excentric_;
 148   Ledger_request ()
 149   {
 150     ledger_extent_.set_empty ();
 151     head_extent_.set_empty ();
 152     position_ = 0;
 153   }
 154 };
 155
 156 typedef map < int, Drul_array<Ledger_request> > Ledger_requests;
 157
 158 /*
 159   TODO: ledger share a lot of info. Lots of room to optimize away
 160   common use of objects/variables.
 161 */
 162 MAKE_SCHEME_CALLBACK (Ledger_line_spanner, print, 1);
 163 SCM
 164 Ledger_line_spanner::print (SCM smob)
 165 {
 166   Spanner *me = dynamic_cast<Spanner *> (unsmob_grob (smob));
 167
 168   extract_grob_set (me, "note-heads", heads);
 169
 170   if (heads.empty ())
 171     return SCM_EOL;
 172
 173   // find size of note heads.
 174   Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
 175   if (!staff)
 176     return SCM_EOL;
 177
 178   Real halfspace = Staff_symbol::staff_space (staff) / 2;
 179
 180   Interval staff_extent = staff->extent (staff, Y_AXIS);
 181   staff_extent *= 1 / halfspace;
 182
 183   Real length_fraction
 184     = robust_scm2double (me->get_property ("length-fraction"), 0.25);
 185
 186   Stencil ledgers;
 187
 188   Grob *common[NO_AXES];
 189
 190   for (int i = X_AXIS; i < NO_AXES; i++)
 191     {
 192       Axis a = Axis (i);
 193       common[a] = common_refpoint_of_array (heads, me, a);
 194       for (vsize i = heads.size (); i--;)
 195         if (Grob *g = unsmob_grob (me->get_object ("accidental-grob")))
 196           common[a] = common[a]->common_refpoint (g, a);
 197     }
 198
 199   Ledger_requests reqs;
 200   for (vsize i = heads.size (); i--;)
 201     {
 202       Item *h = dynamic_cast<Item *> (heads[i]);
 203
 204       int pos = Staff_symbol_referencer::get_rounded_position (h);
 205       if (pos && !staff_extent.contains (pos))
 206         {
 207           Interval head_extent = h->extent (common[X_AXIS], X_AXIS);
 208           Interval ledger_extent = head_extent;
 209           ledger_extent.widen (length_fraction * head_extent.length ());
 210
 211           Direction vdir = Direction (sign (pos));
 212           int rank = h->get_column ()->get_rank ();
 213
 214           reqs[rank][vdir].ledger_extent_.unite (ledger_extent);
 215           reqs[rank][vdir].head_extent_.unite (head_extent);
 216           reqs[rank][vdir].position_
 217             = vdir * max (vdir * reqs[rank][vdir].position_, vdir * pos);
 218         }
 219     }
 220
 221   // determine maximum size for non-colliding ledger.
 222   Real gap = robust_scm2double (me->get_property ("gap"), 0.1);
 223   Ledger_requests::iterator last (reqs.end ());
 224   for (Ledger_requests::iterator i (reqs.begin ());
 225        i != reqs.end (); last = i++)
 226     {
 227       if (last == reqs.end ())
 228         continue;
 229
 230       Direction d = DOWN;
 231       do
 232         {
 233           if (!staff_extent.contains (last->second[d].position_)
 234               && !staff_extent.contains (i->second[d].position_))
 235             {
 236               Real center
 237                 = (last->second[d].head_extent_[RIGHT]
 238                    + i->second[d].head_extent_[LEFT]) / 2;
 239
 240               Direction which = LEFT;
 241               do
 242                 {
 243                   Ledger_request &lr = ((which == LEFT) ? * last : *i).second[d];
 244
 245                   // due tilt of quarter note-heads
 246                   /* FIXME */
 247                   bool both
 248                     = (!staff_extent.contains (last->second[d].position_
 249                                                - sign (last->second[d].position_))
 250                        && !staff_extent.contains (i->second[d].position_
 251                                                   - sign (i->second[d].position_)));
 252                   Real limit = (center + (both ? which * gap / 2 : 0));
 253                   lr.ledger_extent_.at (-which)
 254                     = which * max (which * lr.ledger_extent_[-which], which * limit);
 255                 }
 256               while (flip (&which) != LEFT);
 257             }
 258         }
 259       while (flip (&d) != DOWN);
 260     }
 261
 262   // create ledgers for note heads
 263   Real ledgerlinethickness
 264     = Staff_symbol::get_ledger_line_thickness (staff);
 265   for (vsize i = heads.size (); i--;)
 266     {
 267       Item *h = dynamic_cast<Item *> (heads[i]);
 268
 269       int pos = Staff_symbol_referencer::get_rounded_position (h);
 270       vector<Real> ledger_positions = Staff_symbol::ledger_positions (staff, pos);
 271       if (!ledger_positions.empty ())
 272         {
 273           int ledger_count = ledger_positions.size ();
 274           Interval head_size = h->extent (common[X_AXIS], X_AXIS);
 275           Interval ledger_size = head_size;
 276           ledger_size.widen (ledger_size.length () * length_fraction);
 277
 278           if (pos && !staff_extent.contains (pos))
 279             {
 280               Interval max_size = reqs[h->get_column ()->get_rank ()]
 281                                   [Direction (sign (pos))].ledger_extent_;
 282
 283               if (!max_size.is_empty ())
 284                 ledger_size.intersect (max_size);
 285             }
 286
 287           for (int i = 0; i < ledger_count; i++)
 288             {
 289               Real lpos = ledger_positions[i];
 290               Interval x_extent = ledger_size;
 291
 292               if (i == 0)
 293                 if (Grob *g = unsmob_grob (h->get_object ("accidental-grob")))
 294                   {
 295                     Interval accidental_size = g->extent (common[X_AXIS], X_AXIS);
 296                     Real d
 297                       = linear_combination (Drul_array<Real> (accidental_size[RIGHT],
 298                                                               head_size[LEFT]),
 299                                             0.0);
 300
 301                     Real left_shorten = max (-ledger_size[LEFT] + d, 0.0);
 302
 303                     x_extent[LEFT] += left_shorten;
 304                     /*
 305                       TODO: shorten 2 ledger lines for the case natural +
 306                       downstem.
 307                     */
 308                   }
 309
 310               Real blotdiameter = ledgerlinethickness;
 311               Interval y_extent
 312                 = Interval (-0.5 * (ledgerlinethickness),
 313                             +0.5 * (ledgerlinethickness));
 314               Stencil ledger_line
 315                 = Lookup::round_filled_box (Box (x_extent, y_extent), blotdiameter);
 316
 317               ledger_line.translate_axis ( lpos * halfspace, Y_AXIS);
 318               ledgers.add_stencil (ledger_line);
 319             }
 320         }
 321     }
 322
 323   ledgers.translate_axis (-me->relative_coordinate (common[X_AXIS], X_AXIS),
 324                           X_AXIS);
 325
 326   return ledgers.smobbed_copy ();
 327 }
 328
 329 ADD_INTERFACE (Ledger_line_spanner,
 330                "This spanner draws the ledger lines of a staff.  This is a"
 331                " separate grob because it has to process all potential"
 332                " collisions between all note heads.",
 333
 334                /* properties */
 335                "gap "
 336                "length-fraction "
 337                "minimum-length-fraction "
 338                "note-heads "
 339                "thickness "
 340               );
 341
 342 struct Ledgered_interface
 343 {
 344   DECLARE_GROB_INTERFACE ();
 345 };
 346
 347 ADD_INTERFACE (Ledgered_interface,
 348                "Objects that need ledger lines, typically note heads.  See"
 349                " also @ref{ledger-line-spanner-interface}.",
 350
 351                /* properties */
 352                "no-ledgers "
 353               );