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