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 "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     get_score_engraver ()->forbid_breaks ();
 130
 131   if (start_ev_)
 132     {
 133       if (beam_)
 134         {
 135           start_ev_->origin ()->warning (_ ("already have a beam"));
 136           return;
 137         }
 138
 139       set_melisma (true);
 140       prev_start_ev_ = start_ev_;
 141       beam_ = make_spanner ("Beam", start_ev_->self_scm ());
 142       Moment mp (robust_scm2moment (get_property ("measurePosition"), Moment (0)));
 143
 144       beam_start_location_ = mp;
 145       beam_start_mom_ = now_mom ();
 146
 147       beam_info_ = new Beaming_info_list;
 148
 149       /* urg, must copy to Auto_beam_engraver too */
 150     }
 151 }
 152
 153 void
 154 Beam_engraver::typeset_beam ()
 155 {
 156   if (finished_beam_)
 157     {
 158       finished_beam_info_->beamify (beat_length_, subdivide_beams_);
 159       Beam::set_beaming (finished_beam_, finished_beam_info_);
 160
 161       delete finished_beam_info_;
 162       finished_beam_info_ = 0;
 163       finished_beam_ = 0;
 164     }
 165 }
 166
 167 void
 168 Beam_engraver::start_translation_timestep ()
 169 {
 170   start_ev_ = 0;
 171
 172   if (beam_)
 173     {
 174       set_melisma (true);
 175
 176       subdivide_beams_ = to_boolean (get_property ("subdivideBeams"));
 177       beat_length_ = robust_scm2moment (get_property ("beatLength"), Moment (1, 4));
 178     }
 179 }
 180
 181 void
 182 Beam_engraver::stop_translation_timestep ()
 183 {
 184   typeset_beam ();
 185   if (now_stop_ev_)
 186     {
 187       finished_beam_ = beam_;
 188       finished_beam_info_ = beam_info_;
 189
 190       now_stop_ev_ = 0;
 191       beam_ = 0;
 192       beam_info_ = 0;
 193       typeset_beam ();
 194       set_melisma (false);
 195     }
 196 }
 197
 198 void
 199 Beam_engraver::finalize ()
 200 {
 201   typeset_beam ();
 202   if (beam_)
 203     {
 204       prev_start_ev_->origin ()->warning (_ ("unterminated beam"));
 205
 206       /*
 207         we don't typeset it, (we used to, but it was commented
 208         out. Reason unknown) */
 209       beam_->suicide ();
 210       delete beam_info_;
 211     }
 212 }
 213
 214 void
 215 Beam_engraver::acknowledge_rest (Grob_info info)
 216 {
 217   if (beam_)
 218     {
 219       chain_offset_callback (info.grob(),
 220                              Beam::rest_collision_callback_proc, Y_AXIS);
 221     }
 222 }
 223
 224
 225
 226 void
 227 Beam_engraver::acknowledge_stem (Grob_info info)
 228 {
 229   if (!beam_)
 230     return;
 231
 232   Moment now = now_mom ();
 233   if (!valid_start_point ())
 234     return;
 235
 236   Item *stem = dynamic_cast<Item *> (info.grob ());
 237   if (Stem::get_beam (stem))
 238     return;
 239
 240
 241
 242   Music *m = info.ultimate_music_cause ();
 243   if (!m->is_mus_type ("rhythmic-event"))
 244     {
 245       String s = _ ("stem must have Rhythmic structure");
 246       if (info.music_cause ())
 247         info.music_cause ()->origin ()->warning (s);
 248       else
 249         ::warning (s);
 250
 251       return;
 252     }
 253
 254   last_stem_added_at_ = now;
 255   int durlog = unsmob_duration (m->get_property ("duration"))->duration_log ();
 256   if (durlog <= 2)
 257     {
 258       m->origin ()->warning (_ ("stem doesn't fit in beam"));
 259       prev_start_ev_->origin ()->warning (_ ("beam was started here"));
 260       /*
 261         don't return, since
 262
 263         [r4 c8] can just as well be modern notation.
 264       */
 265     }
 266
 267   stem->set_property ("duration-log",
 268                       scm_from_int (durlog));
 269   Moment stem_location = now - beam_start_mom_ + beam_start_location_;
 270   beam_info_->add_stem (stem_location,
 271                         max (durlog- 2, 0));
 272   Beam::add_stem (beam_, stem);
 273 }
 274
 275 ADD_ACKNOWLEDGER (Beam_engraver, stem);
 276 ADD_ACKNOWLEDGER (Beam_engraver, rest);
 277
 278 ADD_TRANSLATOR (Beam_engraver,
 279                 /* doc */ "Handles Beam events by engraving Beams.    If omitted, then notes will be "
 280                 "printed with flags instead of beams.",
 281                 /* create */ "Beam",
 282                 /* accept */ "beam-event",
 283                 /* read */ "beamMelismaBusy beatLength subdivideBeams",
 284                 /* write */ "");
 285
 286 class Grace_beam_engraver : public Beam_engraver
 287 {
 288 public:
 289   TRANSLATOR_DECLARATIONS (Grace_beam_engraver);
 290
 291 protected:
 292   virtual bool valid_start_point ();
 293   virtual bool valid_end_point ();
 294 };
 295
 296 Grace_beam_engraver::Grace_beam_engraver ()
 297 {
 298 }
 299
 300 bool
 301 Grace_beam_engraver::valid_start_point ()
 302 {
 303   Moment n = now_mom ();
 304
 305   return n.grace_part_ != Rational (0);
 306 }
 307
 308 bool
 309 Grace_beam_engraver::valid_end_point ()
 310 {
 311   return beam_ && valid_start_point ();
 312 }
 313
 314 ADD_ACKNOWLEDGER (Grace_beam_engraver, stem);
 315 ADD_ACKNOWLEDGER (Grace_beam_engraver, rest);
 316 ADD_TRANSLATOR (Grace_beam_engraver,
 317                 /* doc */ "Handles Beam events by engraving Beams.  If omitted, then notes will "
 318                 "be printed with flags instead of beams. Only engraves beams when we "
 319                 " are at grace points in time. ",
 320                 /* create */ "Beam",
 321                 /* accept */ "beam-event",
 322                 /* read */ "beamMelismaBusy beatLength allowBeamBreak subdivideBeams",
 323                 /* write */ "");
 324