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