lily/beam-engraver.cc

   1 /*
   2   beam-engraver.cc -- implement Beam_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "beam.hh"
  10 #include "beaming-pattern.hh"
  11 #include "context.hh"
  12 #include "drul-array.hh"
  13 #include "duration.hh"
  14 #include "engraver.hh"
  15 #include "international.hh"
  16 #include "item.hh"
  17 #include "rest.hh"
  18 #include "spanner.hh"
  19 #include "stream-event.hh"
  20 #include "stem.hh"
  21 #include "warn.hh"
  22
  23 #include "translator.icc"
  24
  25 class Beam_engraver : public Engraver
  26 {
  27 public:
  28   DECLARE_ACKNOWLEDGER (stem);
  29   DECLARE_ACKNOWLEDGER (rest);
  30 protected:
  31   Stream_event *start_ev_;
  32
  33   Spanner *finished_beam_;
  34   Spanner *beam_;
  35   Stream_event *prev_start_ev_;
  36
  37   Stream_event *now_stop_ev_;
  38
  39   Beaming_pattern *beam_info_;
  40   Beaming_pattern *finished_beam_info_;
  41
  42   /// location  within measure where beam started.
  43   Moment beam_start_location_;
  44
  45   /// moment (global time) where beam started.
  46   Moment beam_start_mom_;
  47
  48   bool subdivide_beams_;
  49   Moment beat_length_;
  50
  51   void typeset_beam ();
  52   void set_melisma (bool);
  53
  54   Moment last_stem_added_at_;
  55   void stop_translation_timestep ();
  56   void start_translation_timestep ();
  57   virtual void finalize ();
  58
  59   void process_music ();
  60
  61   virtual bool valid_start_point ();
  62   virtual bool valid_end_point ();
  63
  64   DECLARE_TRANSLATOR_LISTENER (beam);
  65 public:
  66   TRANSLATOR_DECLARATIONS (Beam_engraver);
  67 };
  68
  69 /*
  70   Hmm. this isn't necessary, since grace beams and normal beams are
  71   always nested.
  72 */
  73 bool
  74 Beam_engraver::valid_start_point ()
  75 {
  76   Moment n = now_mom ();
  77
  78   return n.grace_part_ == Rational (0);
  79 }
  80
  81 bool
  82 Beam_engraver::valid_end_point ()
  83 {
  84   return valid_start_point ();
  85 }
  86
  87 Beam_engraver::Beam_engraver ()
  88 {
  89   beam_ = 0;
  90   finished_beam_ = 0;
  91   finished_beam_info_ = 0;
  92   beam_info_ = 0;
  93   now_stop_ev_ = 0;
  94   start_ev_ = 0;
  95   prev_start_ev_ = 0;
  96 }
  97
  98 IMPLEMENT_TRANSLATOR_LISTENER (Beam_engraver, beam);
  99 void
 100 Beam_engraver::listen_beam (Stream_event *ev)
 101 {
 102   Direction d = to_dir (ev->get_property ("span-direction"));
 103
 104   if (d == START && valid_start_point ())
 105     ASSIGN_EVENT_ONCE (start_ev_, ev);
 106   else if (d == STOP && valid_end_point ())
 107     ASSIGN_EVENT_ONCE (now_stop_ev_, ev);
 108 }
 109
 110 void
 111 Beam_engraver::set_melisma (bool ml)
 112 {
 113   SCM b = get_property ("autoBeaming");
 114   if (!to_boolean (b))
 115     context ()->set_property ("beamMelismaBusy", ml ? SCM_BOOL_T : SCM_BOOL_F);
 116 }
 117
 118 void
 119 Beam_engraver::process_music ()
 120 {
 121   if (beam_ && !to_boolean (get_property ("allowBeamBreak")))
 122     context ()->get_score_context ()->set_property ("forbidBreak", SCM_BOOL_T);
 123
 124   if (start_ev_)
 125     {
 126       if (beam_)
 127         {
 128           start_ev_->origin ()->warning (_ ("already have a beam"));
 129           return;
 130         }
 131
 132       set_melisma (true);
 133       prev_start_ev_ = start_ev_;
 134       beam_ = make_spanner ("Beam", start_ev_->self_scm ());
 135       Moment mp (robust_scm2moment (get_property ("measurePosition"), Moment (0)));
 136
 137       beam_start_location_ = mp;
 138       beam_start_mom_ = now_mom ();
 139
 140       beam_info_ = new Beaming_pattern;
 141       /* urg, must copy to Auto_beam_engraver too */
 142     }
 143 }
 144
 145 void
 146 Beam_engraver::typeset_beam ()
 147 {
 148   if (finished_beam_)
 149     {
 150       if (!finished_beam_->get_bound (RIGHT))
 151         finished_beam_->set_bound (RIGHT, finished_beam_->get_bound (LEFT));
 152
 153       finished_beam_info_->beamify (context ());
 154       Beam::set_beaming (finished_beam_, finished_beam_info_);
 155
 156       delete finished_beam_info_;
 157       finished_beam_info_ = 0;
 158       finished_beam_ = 0;
 159     }
 160 }
 161
 162 void
 163 Beam_engraver::start_translation_timestep ()
 164 {
 165   start_ev_ = 0;
 166
 167   if (beam_)
 168     {
 169       set_melisma (true);
 170     }
 171 }
 172
 173 void
 174 Beam_engraver::stop_translation_timestep ()
 175 {
 176   typeset_beam ();
 177   if (now_stop_ev_)
 178     {
 179       finished_beam_ = beam_;
 180       finished_beam_info_ = beam_info_;
 181
 182       now_stop_ev_ = 0;
 183       beam_ = 0;
 184       beam_info_ = 0;
 185       typeset_beam ();
 186       set_melisma (false);
 187     }
 188 }
 189
 190 void
 191 Beam_engraver::finalize ()
 192 {
 193   typeset_beam ();
 194   if (beam_)
 195     {
 196       prev_start_ev_->origin ()->warning (_ ("unterminated beam"));
 197
 198       /*
 199         we don't typeset it, (we used to, but it was commented
 200         out. Reason unknown) */
 201       beam_->suicide ();
 202       delete beam_info_;
 203     }
 204 }
 205
 206 void
 207 Beam_engraver::acknowledge_rest (Grob_info info)
 208 {
 209   if (beam_)
 210     {
 211       chain_offset_callback (info.grob(),
 212                              Beam::rest_collision_callback_proc, Y_AXIS);
 213     }
 214 }
 215
 216
 217
 218 void
 219 Beam_engraver::acknowledge_stem (Grob_info info)
 220 {
 221   if (!beam_)
 222     return;
 223
 224   Moment now = now_mom ();
 225   if (!valid_start_point ())
 226     return;
 227
 228   Item *stem = dynamic_cast<Item *> (info.grob ());
 229   if (Stem::get_beam (stem))
 230     return;
 231
 232
 233
 234   Stream_event *ev = info.ultimate_event_cause ();
 235   if (!ev->in_event_class ("rhythmic-event"))
 236     {
 237       info.grob ()->warning (_ ("stem must have Rhythmic structure"));
 238       return;
 239     }
 240
 241   last_stem_added_at_ = now;
 242   int durlog = unsmob_duration (ev->get_property ("duration"))->duration_log ();
 243   if (durlog <= 2)
 244     {
 245       ev->origin ()->warning (_ ("stem doesn't fit in beam"));
 246       prev_start_ev_->origin ()->warning (_ ("beam was started here"));
 247       /*
 248         don't return, since
 249
 250         [r4 c8] can just as well be modern notation.
 251       */
 252     }
 253
 254   stem->set_property ("duration-log",
 255                       scm_from_int (durlog));
 256   Moment stem_location = now - beam_start_mom_ + beam_start_location_;
 257   beam_info_->add_stem (stem_location,
 258                         max (durlog- 2, 0));
 259   Beam::add_stem (beam_, stem);
 260 }
 261
 262 ADD_ACKNOWLEDGER (Beam_engraver, stem);
 263 ADD_ACKNOWLEDGER (Beam_engraver, rest);
 264
 265 ADD_TRANSLATOR (Beam_engraver,
 266                 /* doc */
 267
 268                 "Handles Beam events by engraving Beams.  If omitted, then notes will be "
 269                 "printed with flags instead of beams.",
 270
 271                 /* create */ "Beam",
 272                 /* accept */ "beam-event",
 273
 274                 /* read */
 275                 "beamMelismaBusy "
 276                 "beatLength "
 277                 "subdivideBeams "
 278                 ,
 279                 /* write */
 280                 "forbidBreak");
 281
 282 class Grace_beam_engraver : public Beam_engraver
 283 {
 284 public:
 285   TRANSLATOR_DECLARATIONS (Grace_beam_engraver);
 286
 287   DECLARE_TRANSLATOR_LISTENER (beam);
 288
 289 protected:
 290   virtual bool valid_start_point ();
 291   virtual bool valid_end_point ();
 292 };
 293
 294 Grace_beam_engraver::Grace_beam_engraver ()
 295 {
 296 }
 297
 298 bool
 299 Grace_beam_engraver::valid_start_point ()
 300 {
 301   Moment n = now_mom ();
 302
 303   return n.grace_part_ != Rational (0);
 304 }
 305
 306 bool
 307 Grace_beam_engraver::valid_end_point ()
 308 {
 309   return beam_ && valid_start_point ();
 310 }
 311
 312 /*
 313   Ugh, C&P code.
 314  */
 315 IMPLEMENT_TRANSLATOR_LISTENER (Grace_beam_engraver, beam);
 316 void
 317 Grace_beam_engraver::listen_beam (Stream_event *ev)
 318 {
 319   Direction d = to_dir (ev->get_property ("span-direction"));
 320
 321   if (d == START && valid_start_point ())
 322     start_ev_ = ev;
 323   else if (d == STOP && valid_end_point ())
 324     now_stop_ev_ = ev;
 325 }
 326
 327
 328 ADD_ACKNOWLEDGER (Grace_beam_engraver, stem);
 329 ADD_ACKNOWLEDGER (Grace_beam_engraver, rest);
 330
 331 ADD_TRANSLATOR (Grace_beam_engraver,
 332
 333                 /* doc */
 334
 335                 "Handles Beam events by engraving Beams.  If omitted, then notes will "
 336                 "be printed with flags instead of beams. Only engraves beams when we "
 337                 " are at grace points in time. ",
 338
 339                 /* create */ "Beam",
 340                 /* accept */ "beam-event",
 341                 /* read */
 342                 "beamMelismaBusy "
 343                 "beatLength "
 344                 "allowBeamBreak "
 345                 "subdivideBeams "
 346                 ,
 347                 /* write */ "");
 348