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