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
  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 *now_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   now_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 (now_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
 143 void
 144 Beam_engraver::typeset_beam ()
 145 {
 146   if (finished_beam_)
 147     {
 148       if (!finished_beam_->get_bound (RIGHT))
 149         finished_beam_->set_bound (RIGHT, finished_beam_->get_bound (LEFT));
 150
 151       finished_beam_info_->beamify (context ());
 152       Beam::set_beaming (finished_beam_, finished_beam_info_);
 153
 154       delete finished_beam_info_;
 155       finished_beam_info_ = 0;
 156       finished_beam_ = 0;
 157     }
 158 }
 159
 160 void
 161 Beam_engraver::start_translation_timestep ()
 162 {
 163   start_ev_ = 0;
 164
 165   if (beam_)
 166     {
 167       set_melisma (true);
 168     }
 169 }
 170
 171 void
 172 Beam_engraver::stop_translation_timestep ()
 173 {
 174   typeset_beam ();
 175   if (now_stop_ev_)
 176     {
 177       finished_beam_ = beam_;
 178       finished_beam_info_ = beam_info_;
 179
 180       now_stop_ev_ = 0;
 181       beam_ = 0;
 182       beam_info_ = 0;
 183       typeset_beam ();
 184       set_melisma (false);
 185     }
 186 }
 187
 188 void
 189 Beam_engraver::finalize ()
 190 {
 191   typeset_beam ();
 192   if (beam_)
 193     {
 194       prev_start_ev_->origin ()->warning (_ ("unterminated beam"));
 195
 196       /*
 197         we don't typeset it, (we used to, but it was commented
 198         out. Reason unknown) */
 199       beam_->suicide ();
 200       delete beam_info_;
 201     }
 202 }
 203
 204 void
 205 Beam_engraver::acknowledge_rest (Grob_info info)
 206 {
 207   if (beam_
 208       && !scm_is_number (info.grob ()->get_property_data ("staff-position")))
 209     {
 210       chain_offset_callback (info.grob(),
 211                              Beam::rest_collision_callback_proc, Y_AXIS);
 212     }
 213 }
 214
 215
 216
 217 void
 218 Beam_engraver::acknowledge_stem (Grob_info info)
 219 {
 220   if (!beam_)
 221     return;
 222
 223   Moment now = now_mom ();
 224   if (!valid_start_point ())
 225     return;
 226
 227   Item *stem = dynamic_cast<Item *> (info.grob ());
 228   if (Stem::get_beam (stem))
 229     return;
 230
 231
 232
 233   Stream_event *ev = info.ultimate_event_cause ();
 234   if (!ev->in_event_class ("rhythmic-event"))
 235     {
 236       info.grob ()->warning (_ ("stem must have Rhythmic structure"));
 237       return;
 238     }
 239
 240   last_stem_added_at_ = now;
 241   int durlog = unsmob_duration (ev->get_property ("duration"))->duration_log ();
 242   if (durlog <= 2)
 243     {
 244       ev->origin ()->warning (_ ("stem does not fit in beam"));
 245       prev_start_ev_->origin ()->warning (_ ("beam was started here"));
 246       /*
 247         don't return, since
 248
 249         [r4 c8] can just as well be modern notation.
 250       */
 251     }
 252
 253   stem->set_property ("duration-log",
 254                       scm_from_int (durlog));
 255   Moment stem_location = now - beam_start_mom_ + beam_start_location_;
 256   beam_info_->add_stem (stem_location,
 257                         max (durlog- 2, 0));
 258   Beam::add_stem (beam_, stem);
 259 }
 260
 261 ADD_ACKNOWLEDGER (Beam_engraver, stem);
 262 ADD_ACKNOWLEDGER (Beam_engraver, rest);
 263
 264 ADD_TRANSLATOR (Beam_engraver,
 265                 /* doc */
 266
 267                 "Handles Beam events by engraving Beams.  If omitted, then notes will be "
 268                 "printed with flags instead of beams.",
 269
 270                 /* create */ "Beam",
 271
 272                 /* read */
 273                 "beamMelismaBusy "
 274                 "beatLength "
 275                 "subdivideBeams "
 276                 ,
 277                 /* write */
 278                 "forbidBreak");
 279
 280 class Grace_beam_engraver : public Beam_engraver
 281 {
 282 public:
 283   TRANSLATOR_DECLARATIONS (Grace_beam_engraver);
 284
 285   DECLARE_TRANSLATOR_LISTENER (beam);
 286
 287 protected:
 288   virtual bool valid_start_point ();
 289   virtual bool valid_end_point ();
 290 };
 291
 292 Grace_beam_engraver::Grace_beam_engraver ()
 293 {
 294 }
 295
 296 bool
 297 Grace_beam_engraver::valid_start_point ()
 298 {
 299   Moment n = now_mom ();
 300
 301   return n.grace_part_ != Rational (0);
 302 }
 303
 304 bool
 305 Grace_beam_engraver::valid_end_point ()
 306 {
 307   return beam_ && valid_start_point ();
 308 }
 309
 310 /*
 311   Ugh, C&P code.
 312  */
 313 IMPLEMENT_TRANSLATOR_LISTENER (Grace_beam_engraver, beam);
 314 void
 315 Grace_beam_engraver::listen_beam (Stream_event *ev)
 316 {
 317   Direction d = to_dir (ev->get_property ("span-direction"));
 318
 319   if (d == START && valid_start_point ())
 320     start_ev_ = ev;
 321   else if (d == STOP && valid_end_point ())
 322     now_stop_ev_ = ev;
 323 }
 324
 325
 326 ADD_ACKNOWLEDGER (Grace_beam_engraver, stem);
 327 ADD_ACKNOWLEDGER (Grace_beam_engraver, rest);
 328
 329 ADD_TRANSLATOR (Grace_beam_engraver,
 330
 331                 /* doc */
 332
 333                 "Handles Beam events by engraving Beams.  If omitted, then notes will "
 334                 "be printed with flags instead of beams. Only engraves beams when we "
 335                 " are at grace points in time. ",
 336
 337                 /* create */ "Beam",
 338                 /* read */
 339                 "beamMelismaBusy "
 340                 "beatLength "
 341                 "subdivideBeams "
 342                 ,
 343                 /* write */ "");
 344