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 MAKE_SCHEME_CALLBACK (Multi_measure_rest, height, 1);
 119 SCM
 120 Multi_measure_rest::height (SCM smob)
 121 {
 122   Grob *me = unsmob_grob (smob);
 123
 124   Real space = 1000000; // something very large...
 125
 126   Stencil mol;
 127   mol.add_stencil (symbol_stencil (me, space));
 128
 129   return ly_interval2scm (mol.extent (Y_AXIS));
 130 }
 131
 132 int
 133 calc_closest_duration_log (Grob *me, double duration, bool force_round_up, bool paranoid)
 134 {
 135   bool round_up = force_round_up
 136                   || to_boolean (me->get_property ("round-up-to-longer-rest"));
 137   int closest_usable_duration_log;
 138
 139   // Out of range initial values.
 140   if (round_up)
 141     closest_usable_duration_log = -15; // high value
 142   else
 143     closest_usable_duration_log = 15; // low value
 144   int minimum_usable_duration_log = -15;
 145   int maximum_usable_duration_log = 15;
 146
 147   SCM duration_logs_list = me->get_property ("usable-duration-logs");
 148   if (paranoid
 149       && (to_boolean (scm_null_p (duration_logs_list))
 150           || !to_boolean (scm_list_p (duration_logs_list))))
 151     {
 152       warning (_ ("usable-duration-logs must be a non-empty list."
 153                   "  Falling back to whole rests."));
 154       closest_usable_duration_log = 0;
 155     }
 156   else
 157     {
 158       for (SCM s = duration_logs_list; scm_is_pair (s); s = scm_cdr (s))
 159         {
 160           int dur_log = scm_to_int (scm_car (s));
 161           if (dur_log > minimum_usable_duration_log)
 162             minimum_usable_duration_log = dur_log;
 163           if (dur_log < maximum_usable_duration_log)
 164             maximum_usable_duration_log = dur_log;
 165           double dur = pow (2.0, -dur_log);
 166           if (round_up)
 167             {
 168               if (duration <= dur && dur_log > closest_usable_duration_log)
 169                 closest_usable_duration_log = dur_log;
 170             }
 171           else
 172             {
 173               if (duration >= dur && dur_log < closest_usable_duration_log)
 174                 closest_usable_duration_log = dur_log;
 175             }
 176         }
 177     }
 178
 179   if (closest_usable_duration_log == 15)
 180     closest_usable_duration_log = minimum_usable_duration_log;
 181   if (closest_usable_duration_log == -15)
 182     closest_usable_duration_log = maximum_usable_duration_log;
 183
 184   return closest_usable_duration_log;
 185 }
 186
 187 int
 188 calc_measure_duration_log (Grob *me, bool paranoid)
 189 {
 190   SCM sml = dynamic_cast<Spanner *> (me)->get_bound (LEFT)
 191             ->get_property ("measure-length");
 192   Rational ml = (unsmob_moment (sml)) ? unsmob_moment (sml)->main_part_
 193                 : Rational (1);
 194   double measure_duration = ml.Rational::to_double ();
 195   bool force_round_up = to_boolean (scm_list_p (scm_member (scm_cons (scm_from_int64 (ml.numerator ()),
 196                                                             scm_from_int64 (ml.denominator ())),
 197                                                             me->get_property ("round-up-exceptions"))));
 198
 199   return calc_closest_duration_log (me, measure_duration, force_round_up, paranoid);
 200 }
 201
 202 Stencil
 203 Multi_measure_rest::symbol_stencil (Grob *me, Real space)
 204 {
 205   int measure_count = 0;
 206   SCM m (me->get_property ("measure-count"));
 207   if (scm_is_number (m))
 208     measure_count = scm_to_int (m);
 209   if (measure_count <= 0)
 210     return Stencil ();
 211
 212   SCM limit = me->get_property ("expand-limit");
 213   if (measure_count > scm_to_int (limit))
 214     {
 215       Real padding = 0.15;
 216       Stencil s = big_rest (me, (1.0 - 2 * padding) * space);
 217       s.translate_axis (padding * space, X_AXIS);
 218       return s;
 219     }
 220
 221   Font_metric *musfont = Font_interface::get_default_font (me);
 222   int mdl = calc_measure_duration_log (me, true);
 223
 224   if (measure_count == 1)
 225     {
 226       if (mdl == 0 && me->get_property ("staff-position") == SCM_EOL)
 227         {
 228           if (Staff_symbol_referencer::on_staff_line (me, 2))
 229             me->set_property ("staff-position", scm_from_int (2));
 230           else if (Staff_symbol_referencer::on_staff_line (me, 3))
 231             me->set_property ("staff-position", scm_from_int (3));
 232         }
 233
 234       Stencil s = musfont->find_by_name (Rest::glyph_name (me, mdl, "", true));
 235
 236       s.translate_axis ((space - s.extent (X_AXIS).length ()) / 2, X_AXIS);
 237       return s;
 238     }
 239   else
 240     return church_rest (me, musfont, measure_count, space);
 241 }
 242
 243 /*
 244   WIDTH can also be 0 to determine the minimum size of the object.
 245 */
 246 Stencil
 247 Multi_measure_rest::big_rest (Grob *me, Real width)
 248 {
 249   Real thick_thick = robust_scm2double (me->get_property ("thick-thickness"), 1.0);
 250   Real hair_thick = robust_scm2double (me->get_property ("hair-thickness"), .1);
 251
 252   Real ss = Staff_symbol_referencer::staff_space (me);
 253   Real slt = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
 254   Real y = slt * thick_thick / 2 * ss;
 255   Real ythick = hair_thick * slt * ss;
 256   Box b (Interval (0.0, max (0.0, (width - 2 * ythick))), Interval (-y, y));
 257
 258   Real blot = width ? (.8 * min (y, ythick)) : 0.0;
 259
 260   Stencil m = Lookup::round_filled_box (b, blot);
 261   Stencil yb = Lookup::round_filled_box (Box (Interval (-0.5, 0.5) * ythick, Interval (-ss, ss)), blot);
 262
 263   m.add_at_edge (X_AXIS, RIGHT, yb, 0);
 264   m.add_at_edge (X_AXIS, LEFT, yb, 0);
 265
 266   m.align_to (X_AXIS, LEFT);
 267
 268   return m;
 269 }
 270
 271 /*
 272   Kirchenpause (?)
 273 */
 274 Stencil
 275 Multi_measure_rest::church_rest (Grob *me, Font_metric *musfont, int measure_count,
 276                                  Real space)
 277 {
 278   SCM mols = SCM_EOL;
 279   int symbol_count = 0;
 280   Real symbols_width = 0.0;
 281   double total_duration = measure_count * pow (2.0, -calc_measure_duration_log (me, true));
 282
 283   while (total_duration > 0)
 284     {
 285       int dl = calc_closest_duration_log (me, total_duration, false, true);
 286       double duration = pow (2.0, -dl);
 287
 288       total_duration -= duration;
 289
 290       Stencil r = musfont->find_by_name (Rest::glyph_name (me, dl, "", true));
 291       if (dl == 0)
 292         {
 293           Real staff_space = Staff_symbol_referencer::staff_space (me);
 294           r.translate_axis (staff_space, Y_AXIS);
 295         }
 296       symbols_width += r.extent (X_AXIS).length ();
 297       mols = scm_cons (r.smobbed_copy (), mols);
 298       symbol_count++;
 299     }
 300
 301   /* Make outer padding this much bigger.  */
 302   Real outer_padding_factor = 1.5;
 303   Real inner_padding = (space - symbols_width)
 304                        / (2 * outer_padding_factor + (symbol_count - 1));
 305   if (inner_padding < 0)
 306     inner_padding = 1.0;
 307
 308   Stencil mol;
 309   for (SCM s = mols; scm_is_pair (s); s = scm_cdr (s))
 310     mol.add_at_edge (X_AXIS, LEFT, *unsmob_stencil (scm_car (s)),
 311                      inner_padding);
 312   mol.align_to (X_AXIS, LEFT);
 313   mol.translate_axis (outer_padding_factor * inner_padding, X_AXIS);
 314
 315   return mol;
 316 }
 317
 318 void
 319 Multi_measure_rest::add_column (Grob *me, Item *c)
 320 {
 321   add_bound_item (dynamic_cast<Spanner *> (me), c);
 322 }
 323
 324 void
 325 Multi_measure_rest::calculate_spacing_rods (Grob *me, Real length)
 326 {
 327   Spanner *sp = dynamic_cast<Spanner *> (me);
 328   if (! (sp->get_bound (LEFT) && sp->get_bound (RIGHT)))
 329     {
 330       programming_error ("Multi_measure_rest::get_rods (): I am not spanned!");
 331       return;
 332     }
 333
 334   Item *li = sp->get_bound (LEFT)->get_column ();
 335   Item *ri = sp->get_bound (RIGHT)->get_column ();
 336   Item *lb = li->find_prebroken_piece (RIGHT);
 337   Item *rb = ri->find_prebroken_piece (LEFT);
 338   Grob *spacing = unsmob_grob (li->get_object ("spacing"));
 339   if (!spacing)
 340     spacing = unsmob_grob (ri->get_object ("spacing"));
 341   if (!spacing)
 342     me->warning (_ ("Using naive multi measure rest spacing."));
 343   else
 344     {
 345       Spacing_options options;
 346       options.init_from_grob (me);
 347       int dl = calc_measure_duration_log (me, false);
 348       Duration dur = Duration (dl, 0);
 349       Rational rat = dur.get_length ();
 350       length = max (length, options.get_duration_space (rat));
 351     }
 352
 353   Item *combinations[4][2] = {{li, ri},
 354     {lb, ri},
 355     {li, rb},
 356     {lb, rb}
 357   };
 358
 359   for (int i = 0; i < 4; i++)
 360     {
 361       Item *li = combinations[i][0];
 362       Item *ri = combinations[i][1];
 363
 364       if (!li || !ri)
 365         continue;
 366
 367       Rod rod;
 368       rod.item_drul_[LEFT] = li;
 369       rod.item_drul_[RIGHT] = ri;
 370
 371       rod.distance_ = Paper_column::minimum_distance (li, ri)
 372                       + length
 373                       + 2 * robust_scm2double (me->get_property ("bound-padding"), 1.0);
 374
 375       Real minlen = robust_scm2double (me->get_property ("minimum-length"), 0);
 376       rod.distance_ = max (rod.distance_, minlen);
 377       rod.add_to_cols ();
 378     }
 379 }
 380
 381 MAKE_SCHEME_CALLBACK (Multi_measure_rest, set_spacing_rods, 1);
 382 SCM
 383 Multi_measure_rest::set_spacing_rods (SCM smob)
 384 {
 385   Grob *me = unsmob_grob (smob);
 386   Real sym_width = symbol_stencil (me, 0.0).extent (X_AXIS).length ();
 387   calculate_spacing_rods (me, sym_width);
 388
 389   return SCM_UNSPECIFIED;
 390 }
 391
 392 MAKE_SCHEME_CALLBACK (Multi_measure_rest, set_text_rods, 1);
 393 SCM
 394 Multi_measure_rest::set_text_rods (SCM smob)
 395 {
 396   Grob *me = unsmob_grob (smob);
 397   Stencil *stil = me->get_stencil ();
 398
 399   /* FIXME uncached */
 400   Real len = (stil && !stil->extent (X_AXIS).is_empty ())
 401              ? stil->extent (X_AXIS).length ()
 402              : 0.0;
 403   calculate_spacing_rods (me, len);
 404
 405   return SCM_UNSPECIFIED;
 406 }
 407
 408 ADD_INTERFACE (Multi_measure_rest,
 409                "A rest that spans a whole number of measures.",
 410
 411                /* properties */
 412                "bound-padding "
 413                "expand-limit "
 414                "hair-thickness "
 415                "measure-count "
 416                "minimum-length "
 417                "round-up-exceptions "
 418                "round-up-to-longer-rest "
 419                "spacing-pair "
 420                "thick-thickness "
 421                "usable-duration-logs "
 422               );