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