lily/rest-collision.cc

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