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