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 ("beam-event"))
  98     {
  99       Direction d = to_dir (m->get_mus_property ("span-direction"));
 100       if (d == START && !valid_start_point ())
 101         return false;
 102       if (d == STOP && !valid_end_point ())
 103         return false;
 104
 105       if (d == START)
 106         {
 107           evs_drul_[d] = m;
 108         }
 109       else if (d==STOP)
 110         {
 111           now_stop_ev_ = m;
 112         }
 113       return true;
 114     }
 115   return false;
 116 }
 117
 118 void
 119 Beam_engraver::set_melisma (bool ml)
 120 {
 121   SCM b = get_property ("autoBeaming");
 122   if (!to_boolean (b))
 123     daddy_trans_->set_property ("beamMelismaBusy", ml ? SCM_BOOL_T :SCM_BOOL_F);
 124 }
 125
 126 void
 127 Beam_engraver::process_music ()
 128 {
 129   if (evs_drul_[STOP])
 130     {
 131       prev_start_ev_ =0;
 132       finished_beam_ = beam_;
 133       finished_beam_info_ = beam_info_;
 134
 135       beam_info_ =0;
 136       beam_ = 0;
 137     }
 138
 139   if (beam_ && !to_boolean (get_property ("allowBeamBreak")))
 140     {
 141       top_engraver ()->forbid_breaks ();
 142     }
 143
 144   if (evs_drul_[START])
 145     {
 146       if (beam_)
 147         {
 148           evs_drul_[START]->origin ()->warning (_ ("already have a beam"));
 149           return;
 150         }
 151
 152       set_melisma (true);
 153       prev_start_ev_ = evs_drul_[START];
 154       beam_ = make_spanner ("Beam");
 155       SCM smp = get_property ("measurePosition");
 156       Moment mp = (unsmob_moment (smp)) ? *unsmob_moment (smp) : Moment (0);
 157
 158       beam_start_location_ = mp;
 159       beam_start_mom_ = now_mom ();
 160
 161       beam_info_ = new Beaming_info_list;
 162
 163       /* urg, must copy to Auto_beam_engraver too */
 164       announce_grob (beam_, evs_drul_[START]->self_scm());
 165     }
 166
 167 }
 168
 169
 170 void
 171 Beam_engraver::typeset_beam ()
 172 {
 173   if (finished_beam_)
 174     {
 175       finished_beam_info_->beamify(beat_length_, subdivide_beams_);
 176       Beam::set_beaming (finished_beam_, finished_beam_info_);
 177       typeset_grob (finished_beam_);
 178       delete finished_beam_info_;
 179       finished_beam_info_ =0;
 180       finished_beam_ = 0;
 181     }
 182 }
 183
 184 void
 185 Beam_engraver::start_translation_timestep ()
 186 {
 187   evs_drul_ [START] =0;
 188   evs_drul_[STOP] = 0;
 189
 190   if (beam_)
 191     {
 192       set_melisma (true);
 193
 194       subdivide_beams_ = to_boolean(get_property("subdivideBeams"));
 195       beat_length_ = *unsmob_moment (get_property ("beatLength"));
 196     }
 197 }
 198
 199 void
 200 Beam_engraver::stop_translation_timestep ()
 201 {
 202   typeset_beam ();
 203   if (now_stop_ev_ )
 204     {
 205       finished_beam_ = beam_;
 206       finished_beam_info_ = beam_info_;
 207
 208       now_stop_ev_ = 0;
 209       beam_ = 0;
 210       beam_info_ = 0;
 211       typeset_beam();
 212           set_melisma (false);
 213     }
 214 }
 215
 216 void
 217 Beam_engraver::finalize ()
 218 {
 219   typeset_beam ();
 220   if (beam_)
 221     {
 222       prev_start_ev_->origin ()->warning (_ ("unterminated beam"));
 223
 224       /*
 225         we don't typeset it, (we used to, but it was commented
 226         out. Reason unknown) */
 227       beam_->suicide ();
 228       delete beam_info_;
 229     }
 230 }
 231
 232 void
 233 Beam_engraver::acknowledge_grob (Grob_info info)
 234 {
 235   if (beam_)
 236     {
 237       if (Rest::has_interface (info.grob_))
 238         {
 239           info.grob_->add_offset_callback (Beam::rest_collision_callback_proc, Y_AXIS);
 240         }
 241       else if (Stem::has_interface (info.grob_))
 242         {
 243           Moment now = now_mom();
 244
 245           if (!valid_start_point ())
 246             return ;
 247
 248           Item *stem = dynamic_cast<Item*> (info.grob_);
 249           if (Stem::get_beam (stem))
 250             return;
 251
 252           Music* m = info.music_cause();
 253           if (!m->is_mus_type ("rhythmic-event"))
 254             {
 255               String s = _ ("stem must have Rhythmic structure");
 256               if (info.music_cause ())
 257                 info.music_cause ()->origin ()->warning (s);
 258               else
 259                 ::warning (s);
 260
 261               return;
 262             }
 263
 264
 265           last_stem_added_at_ = now;
 266           int durlog  = unsmob_duration (m->get_mus_property ("duration"))-> duration_log ();
 267           if (durlog <= 2)
 268             {
 269               m->origin ()->warning (_ ("stem doesn't fit in beam"));
 270               prev_start_ev_->origin ()->warning (_ ("beam was started here"));
 271               /*
 272                 don't return, since
 273
 274                 [r4 c8] can just as well be modern notation.
 275               */
 276             }
 277
 278           stem->set_grob_property ("duration-log",
 279                                     scm_int2num (durlog));
 280           Moment stem_location = now - beam_start_mom_ + beam_start_location_;
 281           beam_info_->add_stem (stem_location,
 282  (durlog- 2) >? 0);
 283           Beam::add_stem (beam_, stem);
 284         }
 285     }
 286 }
 287
 288
 289
 290
 291
 292 ENTER_DESCRIPTION(Beam_engraver,
 293 /* descr */       "Handles Beam events by engraving Beams.    If omitted, then notes will be "
 294 "printed with flags instead of beams.",
 295 /* creats*/       "Beam",
 296 /* accepts */     "beam-event",
 297 /* acks  */      "stem-interface rest-interface",
 298 /* reads */       "beamMelismaBusy beatLength subdivideBeams",
 299 /* write */       "");
 300
 301
 302 class Grace_beam_engraver : public Beam_engraver
 303 {
 304 public:
 305   TRANSLATOR_DECLARATIONS(Grace_beam_engraver);
 306
 307 protected:
 308   virtual bool valid_start_point();
 309   virtual bool valid_end_point ();
 310 };
 311
 312 Grace_beam_engraver::Grace_beam_engraver()
 313 {
 314 }
 315
 316 bool
 317 Grace_beam_engraver::valid_start_point()
 318 {
 319   Moment n = now_mom ();
 320
 321   return n.grace_part_ != Rational (0);
 322 }
 323
 324
 325 bool
 326 Grace_beam_engraver::valid_end_point ()
 327 {
 328   return beam_ && valid_start_point ();
 329 }
 330
 331
 332
 333 ENTER_DESCRIPTION(Grace_beam_engraver,
 334 /* descr */       "Handles Beam events by engraving Beams.  If omitted, then notes will "
 335 "be printed with flags instead of beams. Only engraves beams when we "
 336 " are at grace points in time. "
 337 ,
 338 /* creats*/       "Beam",
 339 /* accepts */     "beam-event",
 340 /* acks  */      "stem-interface rest-interface",
 341 /* reads */       "beamMelismaBusy beatLength allowBeamBreak subdivideBeams",
 342 /* write */       "");
 343