lily/rest-collision.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   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 "rest-collision.hh"
  21
  22 #include <cmath>                // ceil.
  23 using namespace std;
  24
  25 #include "directional-element-interface.hh"
  26 #include "duration.hh"
  27 #include "international.hh"
  28 #include "item.hh"
  29 #include "note-column.hh"
  30 #include "output-def.hh"
  31 #include "pointer-group-interface.hh"
  32 #include "rest.hh"
  33 #include "rhythmic-head.hh"
  34 #include "staff-symbol-referencer.hh"
  35 #include "stem.hh"
  36 #include "grob.hh"
  37 #include "unpure-pure-container.hh"
  38 #include "warn.hh"
  39 #include "lily-imports.hh"
  40
  41 using std::vector;
  42
  43 MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Rest_collision, force_shift_callback_rest, 2, 1, "");
  44 SCM
  45 Rest_collision::force_shift_callback_rest (SCM rest, SCM offset)
  46 {
  47   Grob *rest_grob = unsmob<Grob> (rest);
  48   Grob *parent = rest_grob->get_parent (X_AXIS);
  49
  50   /*
  51     translate REST; we need the result of this translation later on,
  52     while the offset probably still is 0/calculation-in-progress.
  53    */
  54   if (scm_is_number (offset))
  55     rest_grob->translate_axis (scm_to_double (offset), Y_AXIS);
  56
  57   if (has_interface<Note_column> (parent) && Note_column::has_rests (parent))
  58     {
  59       Grob *collision = unsmob<Grob> (parent->get_object ("rest-collision"));
  60
  61       if (collision)
  62         (void) collision->get_property ("positioning-done");
  63     }
  64
  65   return scm_from_double (0.0);
  66 }
  67
  68 void
  69 Rest_collision::add_column (Grob *me, Grob *p)
  70 {
  71   Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), p);
  72
  73   p->set_object ("rest-collision", me->self_scm ());
  74
  75   Grob *rest = unsmob<Grob> (p->get_object ("rest"));
  76   if (rest)
  77     {
  78       chain_offset_callback (rest,
  79                              Unpure_pure_container::make_smob
  80                              (Rest_collision::force_shift_callback_rest_proc,
  81                               Lily::pure_chain_offset_callback),
  82                              Y_AXIS);
  83     }
  84 }
  85
  86 static bool
  87 rest_shift_less (Grob *const &r1, Grob *const &r2)
  88 {
  89   Grob *col1 = r1->get_parent (X_AXIS);
  90   Grob *col2 = r2->get_parent (X_AXIS);
  91   return Note_column::shift_less (col1, col2);
  92 }
  93
  94 /*
  95   TODO: look at horizontal-shift to determine ordering between rests
  96   for more than two voices.
  97 */
  98 MAKE_SCHEME_CALLBACK (Rest_collision, calc_positioning_done, 1);
  99 SCM
 100 Rest_collision::calc_positioning_done (SCM smob)
 101 {
 102   Grob *me = unsmob<Grob> (smob);
 103
 104   me->set_property ("positioning-done", SCM_BOOL_T);
 105
 106   extract_grob_set (me, "elements", elts);
 107
 108   vector<Grob *> rests;
 109   vector<Grob *> notes;
 110
 111   for (vsize i = 0; i < elts.size (); i++)
 112     {
 113       Grob *e = elts[i];
 114       if (has_interface<Note_column> (e))
 115         {
 116           if (unsmob<Grob> (e->get_object ("rest")))
 117             rests.push_back (e);
 118           else
 119             notes.push_back (e);
 120         }
 121     }
 122
 123   /*
 124     handle rest-rest and rest-note collisions
 125
 126     [todo]
 127     * decide not to print rest if too crowded?
 128     */
 129
 130   /*
 131     no partners to collide with
 132   */
 133   if (rests.size () + notes.size () < 2)
 134     return SCM_BOOL_T;
 135
 136   Real staff_space = Staff_symbol_referencer::staff_space (me);
 137   /*
 138     only rests
 139   */
 140   if (!notes.size ())
 141     {
 142
 143       /*
 144         This is incomplete: in case of an uneven number of rests, the
 145         center one should be centered on the staff.
 146       */
 147       Drul_array<vector<Grob *> > ordered_rests;
 148       for (vsize i = 0; i < rests.size (); i++)
 149         {
 150           Grob *r = Note_column::get_rest (rests[i]);
 151
 152           Direction d = get_grob_direction (r);
 153           if (d)
 154             ordered_rests[d].push_back (r);
 155           else
 156             rests[d]->warning (_ ("cannot resolve rest collision: rest direction not set"));
 157         }
 158
 159       for (LEFT_and_RIGHT (d))
 160         vector_sort (ordered_rests[d], rest_shift_less);
 161
 162       for (LEFT_and_RIGHT (d))
 163         {
 164           if (ordered_rests[d].size () < 1)
 165             {
 166               if (ordered_rests[-d].size () > 1)
 167                 ordered_rests[-d][0]->warning (_ ("too many colliding rests"));
 168
 169               return SCM_BOOL_T;
 170             }
 171         }
 172
 173       Grob *common = common_refpoint_of_array (ordered_rests[DOWN], me, Y_AXIS);
 174       common = common_refpoint_of_array (ordered_rests[UP], common, Y_AXIS);
 175
 176       Real diff
 177         = (ordered_rests[DOWN].back ()->extent (common, Y_AXIS)[UP]
 178            - ordered_rests[UP].back ()->extent (common, Y_AXIS)[DOWN]) / staff_space;
 179
 180       if (diff > 0)
 181         {
 182           int amount_down = (int) ceil (diff / 2);
 183           diff -= amount_down;
 184           Rest::translate (ordered_rests[DOWN].back (),
 185                            -2 * amount_down);
 186           if (diff > 0)
 187             Rest::translate (ordered_rests[UP].back (),
 188                              2 * int (ceil (diff)));
 189         }
 190
 191       for (LEFT_and_RIGHT (d))
 192         {
 193           for (vsize i = ordered_rests[d].size () - 1; i-- > 0;)
 194             {
 195               Real last_y = ordered_rests[d][i + 1]->extent (common, Y_AXIS)[d];
 196               Real y = ordered_rests[d][i]->extent (common, Y_AXIS)[-d];
 197
 198               Real diff = d * ((last_y - y) / staff_space);
 199               if (diff > 0)
 200                 Rest::translate (ordered_rests[d][i], d * (int) ceil (diff) * 2);
 201             }
 202         }
 203     }
 204   else
 205     {
 206       /*
 207         Rests and notes.
 208       */
 209       // Count how many rests we move
 210       Drul_array<int> rcount (0, 0);
 211
 212       for (vsize i = 0; i < rests.size (); i++)
 213         {
 214           Grob *rcol = rests[i];
 215           Grob *rest = Note_column::get_rest (rcol);
 216
 217           Direction dir = get_grob_direction (rest);
 218           if (!dir)
 219             dir = Note_column::dir (rcol);
 220
 221           // Do not compute a translation for pre-positioned rests,
 222           //  nor count them for the "too many colliding rests" warning
 223           if (scm_is_number (rest->get_property ("staff-position")))
 224             continue;
 225
 226           Grob *common = common_refpoint_of_array (notes, rcol, Y_AXIS);
 227           Interval restdim = rest->extent (common, Y_AXIS);
 228           if (restdim.is_empty ())
 229             continue;
 230
 231           Real staff_space = Staff_symbol_referencer::staff_space (rcol);
 232           Real minimum_dist = robust_scm2double (me->get_property ("minimum-distance"), 1.0) * staff_space;
 233
 234           Interval notedim;
 235           for (vsize i = 0; i < notes.size (); i++)
 236             {
 237               if (Note_column::dir (notes[i]) == -dir
 238                   // If the note has already happened (but it has a long
 239                   // duration, so there is a collision), don't look at the stem.
 240                   // If we do, the rest gets shifted down a lot and it looks bad.
 241                   || dynamic_cast<Item *> (notes[i])->get_column () != dynamic_cast<Item *> (rest)->get_column ())
 242                 {
 243                   /* try not to look at the stem, as looking at a beamed
 244                      note may trigger beam positioning prematurely.
 245
 246                      This happens with dotted rests, which need Y
 247                      positioning to compute X-positioning.
 248                   */
 249                   Grob *head = Note_column::first_head (notes[i]);
 250                   if (head)
 251                     notedim.unite (head->extent (common, Y_AXIS));
 252                   else
 253                     programming_error ("Note_column without first_head()");
 254                 }
 255               else
 256                 notedim.unite (notes[i]->extent (common, Y_AXIS));
 257             }
 258
 259           Real y = dir * max (0.0,
 260                               -dir * restdim[-dir] + dir * notedim[dir] + minimum_dist);
 261
 262           // move discretely by half spaces.
 263           int discrete_y = dir * int (ceil (y / (0.5 * dir * staff_space)));
 264
 265           Interval staff_span = Staff_symbol_referencer::staff_span (rest);
 266           staff_span.widen (1);
 267           // move by whole spaces inside the staff.
 268           if (staff_span.contains
 269               (Staff_symbol_referencer::get_position (rest) + discrete_y))
 270             {
 271               discrete_y = dir * int (ceil (dir * discrete_y / 2.0) * 2.0);
 272             }
 273
 274           Rest::translate (rest, discrete_y);
 275           if (rcount[dir]++)
 276             rest->warning (_ ("too many colliding rests"));
 277         }
 278     }
 279   return SCM_BOOL_T;
 280 }
 281
 282 ADD_INTERFACE (Rest_collision,
 283                "Move ordinary rests (not multi-measure nor pitched rests)"
 284                " to avoid conflicts.",
 285
 286                /* properties */
 287                "minimum-distance "
 288                "positioning-done "
 289                "elements "
 290               );
 291