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