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