lily/rest-collision.cc

   1 /*
   2   rest-collision.cc -- implement Rest_collision
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "rest-collision.hh"
  10
  11 #include <cmath>                // ceil.
  12 using namespace std;
  13
  14 #include "directional-element-interface.hh"
  15 #include "duration.hh"
  16 #include "international.hh"
  17 #include "note-column.hh"
  18 #include "output-def.hh"
  19 #include "pointer-group-interface.hh"
  20 #include "rest.hh"
  21 #include "rhythmic-head.hh"
  22 #include "staff-symbol-referencer.hh"
  23 #include "stem.hh"
  24 #include "grob.hh"
  25 #include "warn.hh"
  26
  27 MAKE_SCHEME_CALLBACK (Rest_collision, force_shift_callback, 1);
  28 SCM
  29 Rest_collision::force_shift_callback (SCM smob)
  30 {
  31   Grob *them = unsmob_grob (smob);
  32   if (Note_column::has_rests (them))
  33     {
  34       Grob *collision = unsmob_grob (them->get_object ("rest-collision"));
  35
  36       if (collision)
  37         {
  38           (void) collision->get_property ("positioning-done");
  39         }
  40     }
  41   return scm_from_double (0.0);
  42 }
  43
  44 MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Rest_collision, force_shift_callback_rest, 2, 1);
  45 SCM
  46 Rest_collision::force_shift_callback_rest (SCM rest, SCM offset)
  47 {
  48   Grob *rest_grob = unsmob_grob (rest);
  49   Grob *parent = rest_grob->get_parent (X_AXIS);
  50
  51   /*
  52     translate REST; we need the result of this translation later on,
  53     while the offset probably still is 0/calculation-in-progress.
  54    */
  55   if (scm_is_number (offset))
  56     rest_grob->translate_axis (scm_to_double (offset), Y_AXIS);
  57
  58   if (Note_column::has_interface (parent))
  59     force_shift_callback (parent->self_scm ());
  60
  61   return scm_from_double (0.0);
  62 }
  63
  64 void
  65 Rest_collision::add_column (Grob *me, Grob *p)
  66 {
  67   Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), p);
  68
  69   /*
  70     only add callback for the rests, since we don't move anything
  71     else.
  72
  73     (not?)
  74   */
  75   add_offset_callback (p, Rest_collision::force_shift_callback_proc, Y_AXIS);
  76   p->set_object ("rest-collision", me->self_scm ());
  77
  78   Grob *rest = unsmob_grob (p->get_object ("rest"));
  79   if (rest)
  80     {
  81       chain_offset_callback (rest,
  82                              Rest_collision::force_shift_callback_rest_proc, Y_AXIS);
  83     }
  84 }
  85
  86 /*
  87   TODO: look at horizontal-shift to determine ordering between rests
  88   for more than two voices.
  89 */
  90 MAKE_SCHEME_CALLBACK(Rest_collision, calc_positioning_done, 1);
  91 SCM
  92 Rest_collision::calc_positioning_done (SCM smob)
  93 {
  94   Grob *me = unsmob_grob (smob);
  95   extract_grob_set (me, "elements", elts);
  96
  97   vector<Grob*> rests;
  98   vector<Grob*> notes;
  99
 100   for (vsize i = 0; i < elts.size (); i++)
 101     {
 102       Grob *e = elts[i];
 103       if (unsmob_grob (e->get_object ("rest")))
 104         rests.push_back (e);
 105       else
 106         notes.push_back (e);
 107     }
 108
 109   /*
 110     handle rest-rest and rest-note collisions
 111
 112     [todo]
 113     * decide not to print rest if too crowded?
 114     */
 115
 116   /*
 117     no partners to collide with
 118   */
 119   if (rests.size () + notes.size () < 2)
 120     return SCM_UNSPECIFIED;
 121
 122   Real staff_space = Staff_symbol_referencer::staff_space (me);
 123   /*
 124     only rests
 125   */
 126   if (!notes.size ())
 127     {
 128
 129       /*
 130         This is incomplete: in case of an uneven number of rests, the
 131         center one should be centered on the staff.
 132       */
 133       Drul_array<vector<Grob*> > ordered_rests;
 134       for (vsize i = 0; i < rests.size (); i++)
 135         {
 136           Grob *r = Note_column::get_rest (rests[i]);
 137
 138           Direction d = get_grob_direction (r);
 139           if (d)
 140             ordered_rests[d].push_back (rests[i]);
 141           else
 142             rests[d]->warning (_ ("cannot resolve rest collision: rest direction not set"));
 143         }
 144
 145       Direction d = LEFT;
 146       do
 147         vector_sort (ordered_rests[d], Note_column::shift_less);
 148       while (flip (&d) != LEFT)
 149         ;
 150
 151       do
 152         {
 153           if (ordered_rests[d].size () < 1)
 154             {
 155               if (ordered_rests[-d].size () > 1)
 156                 ordered_rests[-d][0]->warning (_ ("too many colliding rests"));
 157
 158               return SCM_UNSPECIFIED;
 159             }
 160         }
 161       while (flip (&d) != LEFT);
 162
 163       Grob *common = common_refpoint_of_array (ordered_rests[DOWN], me, Y_AXIS);
 164       common = common_refpoint_of_array (ordered_rests[UP], common, Y_AXIS);
 165
 166       Real diff
 167         = (ordered_rests[DOWN].back ()->extent (common, Y_AXIS)[UP]
 168            - ordered_rests[UP].back ()->extent (common, Y_AXIS)[DOWN]) / staff_space;
 169
 170       if (diff > 0)
 171         {
 172           int amount_down = (int) ceil (diff / 2);
 173           diff -= amount_down;
 174           Note_column::translate_rests (ordered_rests[DOWN].back (),
 175                                         -2 * amount_down);
 176           if (diff > 0)
 177             Note_column::translate_rests (ordered_rests[UP].back (),
 178                                           2 * int (ceil (diff)));
 179         }
 180
 181       do
 182         {
 183           for (vsize i = ordered_rests[d].size () -1; i-- > 0;)
 184             {
 185               Real last_y = ordered_rests[d][i + 1]->extent (common, Y_AXIS)[d];
 186               Real y = ordered_rests[d][i]->extent (common, Y_AXIS)[-d];
 187
 188               Real diff = d * ((last_y - y) / staff_space);
 189               if (diff > 0)
 190                 Note_column::translate_rests (ordered_rests[d][i], d * (int) ceil (diff) * 2);
 191             }
 192         }
 193       while (flip (&d) != LEFT);
 194     }
 195   else
 196     {
 197       /*
 198         Rests and notes.
 199       */
 200       if (rests.size () > 1)
 201         warning (_ ("too many colliding rests"));
 202       Grob *rcol = 0;
 203       Direction dir = CENTER;
 204
 205       for (vsize i = rests.size (); !rcol && i--;)
 206         if (Note_column::dir (rests[i]))
 207           {
 208             rcol = rests[i];
 209             dir = Note_column::dir (rcol);
 210           }
 211
 212       if (!rcol)
 213         return SCM_UNSPECIFIED;
 214
 215       Grob *rest = Note_column::get_rest (rcol);
 216       Grob *common = common_refpoint_of_array (notes, rcol, Y_AXIS);
 217
 218       Interval restdim = rcol->extent (common, Y_AXIS);
 219       if (restdim.is_empty ())
 220         return SCM_UNSPECIFIED;
 221
 222       Real staff_space = Staff_symbol_referencer::staff_space (rcol);
 223       Real minimum_dist = robust_scm2double (me->get_property ("minimum-distance"), 1.0) * staff_space;
 224
 225       Interval notedim;
 226       for (vsize i = 0; i < notes.size (); i++)
 227         notedim.unite (notes[i]->extent (common, Y_AXIS));
 228
 229
 230       Real y = dir * max (0.0,
 231                           -dir * restdim[-dir] + dir * notedim[dir]  + minimum_dist);
 232
 233       int stafflines = Staff_symbol_referencer::line_count (me);
 234       if (!stafflines)
 235         {
 236           programming_error ("no staff line count");
 237           stafflines = 5;
 238         }
 239
 240       // move discretely by half spaces.
 241       int discrete_y = dir * int (ceil (y / (0.5 * dir * staff_space)));
 242
 243       // move by whole spaces inside the staff.
 244       if (fabs (Staff_symbol_referencer::get_position (rest)
 245                 + discrete_y) < stafflines + 1)
 246         {
 247           discrete_y = dir * int (ceil (dir * discrete_y / 2.0) * 2.0);
 248         }
 249
 250       Note_column::translate_rests (rcol, discrete_y);
 251     }
 252   return SCM_UNSPECIFIED;
 253 }
 254
 255 ADD_INTERFACE (Rest_collision,
 256                "Move around ordinary rests (not multi-measure-rests) to avoid "
 257                "conflicts.",
 258
 259                /* properties */
 260                "minimum-distance "
 261                "positioning-done "
 262                "elements");
 263