lily/multi-measure-rest.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1998--2012 Jan Nieuwenhuizen <janneke@gnu.org>
   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 "multi-measure-rest.hh"
  21
  22 #include "duration.hh"
  23 #include "font-interface.hh"
  24 #include "international.hh"
  25 #include "lookup.hh"
  26 #include "misc.hh"
  27 #include "moment.hh"
  28 #include "output-def.hh"
  29 #include "paper-column.hh" // urg
  30 #include "percent-repeat-item.hh"
  31 #include "rest.hh"
  32 #include "separation-item.hh"
  33 #include "spacing-options.hh"
  34 #include "spanner.hh"
  35 #include "staff-symbol.hh"
  36 #include "staff-symbol-referencer.hh"
  37 #include "system.hh"
  38 #include "text-interface.hh"
  39 #include "warn.hh"
  40
  41 Interval
  42 Multi_measure_rest::bar_width (Spanner *me)
  43 {
  44   SCM spacing_pair = me->get_property ("spacing-pair");
  45   Interval iv;
  46   for (LEFT_and_RIGHT (d))
  47     {
  48       Item *col = me->get_bound (d)->get_column ();
  49       SCM align_sym
  50         = (scm_is_pair (spacing_pair)
  51            ? index_get_cell (spacing_pair, d)
  52            : ly_symbol2scm ("staff-bar"));
  53       Interval coldim = Paper_column::break_align_width (col, align_sym);
  54
  55       iv[d] = coldim[-d];
  56     }
  57
  58   return iv;
  59 }
  60
  61 MAKE_SCHEME_CALLBACK (Multi_measure_rest, percent, 1);
  62 SCM
  63 Multi_measure_rest::percent (SCM smob)
  64 {
  65   Grob *me = unsmob_grob (smob);
  66   Spanner *sp = dynamic_cast<Spanner *> (me);
  67
  68   Stencil r = Percent_repeat_item_interface::x_percent (me, 1);
  69   r.translate_axis (-r.extent (X_AXIS).center (), X_AXIS);
  70
  71   // ugh copy & paste.
  72
  73   Grob *common_x = sp->get_bound (LEFT)->common_refpoint (sp->get_bound (RIGHT),
  74                                                           X_AXIS);
  75   Interval sp_iv = bar_width (sp);
  76   Real x_off = 0.0;
  77
  78   Real rx = sp->get_bound (LEFT)->relative_coordinate (common_x, X_AXIS);
  79   /*
  80     we gotta stay clear of sp_iv, so move a bit to the right if
  81     needed.
  82   */
  83   x_off += max (sp_iv[LEFT] - rx, 0.0);
  84
  85   /*
  86     center between stuff.
  87   */
  88   x_off += sp_iv.length () / 2;
  89
  90   r.translate_axis (x_off, X_AXIS);
  91
  92   return r.smobbed_copy ();
  93 }
  94
  95 MAKE_SCHEME_CALLBACK (Multi_measure_rest, print, 1);
  96 SCM
  97 Multi_measure_rest::print (SCM smob)
  98 {
  99   Grob *me = unsmob_grob (smob);
 100   Spanner *sp = dynamic_cast<Spanner *> (me);
 101
 102   Interval sp_iv = bar_width (sp);
 103   Real space = sp_iv.length ();
 104
 105   Real rx = sp->get_bound (LEFT)->relative_coordinate (0, X_AXIS);
 106   /*
 107     we gotta stay clear of sp_iv, so move a bit to the right if
 108     needed.
 109   */
 110   Real x_off = max (sp_iv[LEFT] - rx, 0.0);
 111
 112   Stencil mol;
 113   mol.add_stencil (symbol_stencil (me, space));
 114
 115   mol.translate_axis (x_off, X_AXIS);
 116   return mol.smobbed_copy ();
 117 }
 118
 119 MAKE_SCHEME_CALLBACK (Multi_measure_rest, height, 1);
 120 SCM
 121 Multi_measure_rest::height (SCM smob)
 122 {
 123   Grob *me = unsmob_grob (smob);
 124
 125   Real space = 1000000; // something very large...
 126
 127   Stencil mol;
 128   mol.add_stencil (symbol_stencil (me, space));
 129
 130   return ly_interval2scm (mol.extent (Y_AXIS));
 131 }
 132
 133 int
 134 calc_closest_duration_log (Grob *me, double duration, bool force_round_up, bool paranoid)
 135 {
 136   bool round_up = force_round_up
 137                   || to_boolean (me->get_property ("round-up-to-longer-rest"));
 138   int closest_usable_duration_log;
 139
 140   // Out of range initial values.
 141   if (round_up)
 142     closest_usable_duration_log = -15; // high value
 143   else
 144     closest_usable_duration_log = 15; // low value
 145   int minimum_usable_duration_log = -15;
 146   int maximum_usable_duration_log = 15;
 147
 148   SCM duration_logs_list = me->get_property ("usable-duration-logs");
 149   if (paranoid
 150       && (to_boolean (scm_null_p (duration_logs_list))
 151           || !to_boolean (scm_list_p (duration_logs_list))))
 152     {
 153       warning (_ ("usable-duration-logs must be a non-empty list."
 154                   "  Falling back to whole rests."));
 155       closest_usable_duration_log = 0;
 156     }
 157   else
 158     {
 159       for (SCM s = duration_logs_list; scm_is_pair (s); s = scm_cdr (s))
 160         {
 161           int dur_log = scm_to_int (scm_car (s));
 162           if (dur_log > minimum_usable_duration_log)
 163             minimum_usable_duration_log = dur_log;
 164           if (dur_log < maximum_usable_duration_log)
 165             maximum_usable_duration_log = dur_log;
 166           double dur = pow (2.0, -dur_log);
 167           if (round_up)
 168             {
 169               if (duration <= dur && dur_log > closest_usable_duration_log)
 170                 closest_usable_duration_log = dur_log;
 171             }
 172           else
 173             {
 174               if (duration >= dur && dur_log < closest_usable_duration_log)
 175                 closest_usable_duration_log = dur_log;
 176             }
 177         }
 178     }
 179
 180   if (closest_usable_duration_log == 15)
 181     closest_usable_duration_log = minimum_usable_duration_log;
 182   if (closest_usable_duration_log == -15)
 183     closest_usable_duration_log = maximum_usable_duration_log;
 184
 185   return closest_usable_duration_log;
 186 }
 187
 188 int
 189 calc_measure_duration_log (Grob *me, bool paranoid)
 190 {
 191   SCM sml = dynamic_cast<Spanner *> (me)->get_bound (LEFT)
 192             ->get_property ("measure-length");
 193   Rational ml = (unsmob_moment (sml)) ? unsmob_moment (sml)->main_part_
 194                 : Rational (1);
 195   double measure_duration = ml.Rational::to_double ();
 196   bool force_round_up = to_boolean (scm_list_p (scm_member (scm_cons (scm_from_int64 (ml.numerator ()),
 197                                                             scm_from_int64 (ml.denominator ())),
 198                                                             me->get_property ("round-up-exceptions"))));
 199
 200   return calc_closest_duration_log (me, measure_duration, force_round_up, paranoid);
 201 }
 202
 203 Stencil
 204 Multi_measure_rest::symbol_stencil (Grob *me, Real space)
 205 {
 206   int measure_count = 0;
 207   SCM m (me->get_property ("measure-count"));
 208   if (scm_is_number (m))
 209     measure_count = scm_to_int (m);
 210   if (measure_count <= 0)
 211     return Stencil ();
 212
 213   SCM limit = me->get_property ("expand-limit");
 214   if (measure_count > scm_to_int (limit))
 215     {
 216       Real padding = 0.15;
 217       Stencil s = big_rest (me, (1.0 - 2 * padding) * space);
 218       s.translate_axis (padding * space, X_AXIS);
 219       return s;
 220     }
 221
 222   Font_metric *musfont = Font_interface::get_default_font (me);
 223   int mdl = calc_measure_duration_log (me, true);
 224
 225   if (measure_count == 1)
 226     {
 227       if (mdl == 0 && me->get_property ("staff-position") == SCM_EOL)
 228         {
 229           Real pos = Rest::staff_position_internal (me, mdl, 0);
 230           me->set_property ("staff-position", scm_from_double (pos));
 231         }
 232
 233       Stencil s = musfont->find_by_name (Rest::glyph_name (me, mdl, "", true));
 234
 235       s.translate_axis ((space - s.extent (X_AXIS).length ()) / 2, X_AXIS);
 236       return s;
 237     }
 238   else
 239     return church_rest (me, musfont, measure_count, space);
 240 }
 241
 242 /*
 243   WIDTH can also be 0 to determine the minimum size of the object.
 244 */
 245 Stencil
 246 Multi_measure_rest::big_rest (Grob *me, Real width)
 247 {
 248   Real thick_thick = robust_scm2double (me->get_property ("thick-thickness"), 1.0);
 249   Real hair_thick = robust_scm2double (me->get_property ("hair-thickness"), .1);
 250
 251   Real ss = Staff_symbol_referencer::staff_space (me);
 252   Real slt = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
 253   Real y = slt * thick_thick / 2 * ss;
 254   Real ythick = hair_thick * slt * ss;
 255   Box b (Interval (0.0, max (0.0, (width - 2 * ythick))), Interval (-y, y));
 256
 257   Real blot = width ? (.8 * min (y, ythick)) : 0.0;
 258
 259   Stencil m = Lookup::round_filled_box (b, blot);
 260   Stencil yb = Lookup::round_filled_box (Box (Interval (-0.5, 0.5) * ythick, Interval (-ss, ss)), blot);
 261
 262   m.add_at_edge (X_AXIS, RIGHT, yb, 0);
 263   m.add_at_edge (X_AXIS, LEFT, yb, 0);
 264
 265   m.align_to (X_AXIS, LEFT);
 266
 267   return m;
 268 }
 269
 270 /*
 271   Kirchenpause (?)
 272 */
 273 Stencil
 274 Multi_measure_rest::church_rest (Grob *me, Font_metric *musfont, int measure_count,
 275                                  Real space)
 276 {
 277   SCM mols = SCM_EOL;
 278   int symbol_count = 0;
 279   Real symbols_width = 0.0;
 280   double total_duration = measure_count * pow (2.0, -calc_measure_duration_log (me, true));
 281
 282   while (total_duration > 0)
 283     {
 284       int dl = calc_closest_duration_log (me, total_duration, false, true);
 285       double duration = pow (2.0, -dl);
 286
 287       total_duration -= duration;
 288
 289       Stencil r = musfont->find_by_name (Rest::glyph_name (me, dl, "", true));
 290       if (dl == 0)
 291         {
 292           Real staff_space = Staff_symbol_referencer::staff_space (me);
 293           r.translate_axis (staff_space, Y_AXIS);
 294         }
 295       symbols_width += r.extent (X_AXIS).length ();
 296       mols = scm_cons (r.smobbed_copy (), mols);
 297       symbol_count++;
 298     }
 299
 300   /* Make outer padding this much bigger.  */
 301   Real outer_padding_factor = 1.5;
 302   Real inner_padding = (space - symbols_width)
 303                        / (2 * outer_padding_factor + (symbol_count - 1));
 304   if (inner_padding < 0)
 305     inner_padding = 1.0;
 306
 307   Stencil mol;
 308   for (SCM s = mols; scm_is_pair (s); s = scm_cdr (s))
 309     mol.add_at_edge (X_AXIS, LEFT, *unsmob_stencil (scm_car (s)),
 310                      inner_padding);
 311   mol.align_to (X_AXIS, LEFT);
 312   mol.translate_axis (outer_padding_factor * inner_padding, X_AXIS);
 313
 314   return mol;
 315 }
 316
 317 void
 318 Multi_measure_rest::add_column (Grob *me, Item *c)
 319 {
 320   add_bound_item (dynamic_cast<Spanner *> (me), c);
 321 }
 322
 323 void
 324 Multi_measure_rest::calculate_spacing_rods (Grob *me, Real length)
 325 {
 326   Spanner *sp = dynamic_cast<Spanner *> (me);
 327   if (! (sp->get_bound (LEFT) && sp->get_bound (RIGHT)))
 328     {
 329       programming_error ("Multi_measure_rest::get_rods (): I am not spanned!");
 330       return;
 331     }
 332
 333   Item *li = sp->get_bound (LEFT)->get_column ();
 334   Item *ri = sp->get_bound (RIGHT)->get_column ();
 335   Item *lb = li->find_prebroken_piece (RIGHT);
 336   Item *rb = ri->find_prebroken_piece (LEFT);
 337   Grob *spacing = unsmob_grob (li->get_object ("spacing"));
 338   if (!spacing)
 339     spacing = unsmob_grob (ri->get_object ("spacing"));
 340   if (!spacing)
 341     me->warning (_ ("Using naive multi measure rest spacing."));
 342   else
 343     {
 344       Spacing_options options;
 345       options.init_from_grob (me);
 346       int dl = calc_measure_duration_log (me, false);
 347       Duration dur = Duration (dl, 0);
 348       Rational rat = dur.get_length ();
 349       length = max (length, options.get_duration_space (rat));
 350     }
 351
 352   Item *combinations[4][2] = {{li, ri},
 353     {lb, ri},
 354     {li, rb},
 355     {lb, rb}
 356   };
 357
 358   for (int i = 0; i < 4; i++)
 359     {
 360       Item *li = combinations[i][0];
 361       Item *ri = combinations[i][1];
 362
 363       if (!li || !ri)
 364         continue;
 365
 366       Rod rod;
 367       rod.item_drul_[LEFT] = li;
 368       rod.item_drul_[RIGHT] = ri;
 369
 370       rod.distance_ = Paper_column::minimum_distance (li, ri)
 371                       + length
 372                       + 2 * robust_scm2double (me->get_property ("bound-padding"), 1.0);
 373
 374       Real minlen = robust_scm2double (me->get_property ("minimum-length"), 0);
 375       rod.distance_ = max (rod.distance_, minlen);
 376       rod.add_to_cols ();
 377     }
 378 }
 379
 380 MAKE_SCHEME_CALLBACK (Multi_measure_rest, set_spacing_rods, 1);
 381 SCM
 382 Multi_measure_rest::set_spacing_rods (SCM smob)
 383 {
 384   Grob *me = unsmob_grob (smob);
 385   Real sym_width = symbol_stencil (me, 0.0).extent (X_AXIS).length ();
 386   calculate_spacing_rods (me, sym_width);
 387
 388   return SCM_UNSPECIFIED;
 389 }
 390
 391 MAKE_SCHEME_CALLBACK (Multi_measure_rest, set_text_rods, 1);
 392 SCM
 393 Multi_measure_rest::set_text_rods (SCM smob)
 394 {
 395   Grob *me = unsmob_grob (smob);
 396   Stencil *stil = me->get_stencil ();
 397
 398   /* FIXME uncached */
 399   Real len = (stil && !stil->extent (X_AXIS).is_empty ())
 400              ? stil->extent (X_AXIS).length ()
 401              : 0.0;
 402   calculate_spacing_rods (me, len);
 403
 404   return SCM_UNSPECIFIED;
 405 }
 406
 407 ADD_INTERFACE (Multi_measure_rest,
 408                "A rest that spans a whole number of measures.",
 409
 410                /* properties */
 411                "bound-padding "
 412                "expand-limit "
 413                "hair-thickness "
 414                "measure-count "
 415                "minimum-length "
 416                "round-up-exceptions "
 417                "round-up-to-longer-rest "
 418                "spacing-pair "
 419                "thick-thickness "
 420                "usable-duration-logs "
 421               );