lily/auto-beam-engraver.cc

   1 /*
   2   auto-beam-engraver.cc --  implement Auto_beam_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1999--2004 Jan Nieuwenhuizen <janneke@gnu.org>
   7
   8  */
   9
  10 #include "beaming.hh"
  11 #include "event.hh"
  12 #include "beam.hh"
  13 #include "stem.hh"
  14 #include "warn.hh"
  15 #include "engraver-group-engraver.hh"
  16 #include "bar-line.hh"
  17 #include "rest.hh"
  18 #include "engraver.hh"
  19 #include "item.hh"
  20 #include "spanner.hh"
  21 #include "duration.hh"
  22 #include "context.hh"
  23
  24 class Auto_beam_engraver : public Engraver
  25 {
  26   TRANSLATOR_DECLARATIONS (Auto_beam_engraver);
  27 protected:
  28   virtual void stop_translation_timestep ();
  29   virtual void start_translation_timestep ();
  30   virtual void process_music ();
  31   virtual bool try_music (Music*);
  32   virtual void finalize ();
  33   virtual void acknowledge_grob (Grob_info);
  34   virtual void process_acknowledged_grobs ();
  35
  36 private:
  37   bool test_moment (Direction, Moment);
  38   void consider_begin (Moment);
  39   void consider_end (Moment);
  40   Spanner* create_beam ();
  41   void begin_beam ();
  42   void end_beam ();
  43   void junk_beam ();
  44   bool is_same_grace_state (Grob* e);
  45   void typeset_beam ();
  46
  47   Music *forbid_;
  48   /*
  49     shortest_mom is the shortest note in the beam.
  50    */
  51   Moment shortest_mom_;
  52   Spanner *finished_beam_;
  53   Link_array<Item>* stems_;
  54
  55
  56   int count_;
  57   Moment last_add_mom_;
  58   /*
  59     Projected ending of the  beam we're working on.
  60    */
  61   Moment extend_mom_;
  62   Moment beam_start_moment_;
  63   Moment beam_start_location_;
  64
  65   bool subdivide_beams_;
  66   Moment beat_length_;
  67
  68   // We act as if beam were created, and start a grouping anyway.
  69   Beaming_info_list*grouping_;
  70   SCM beam_settings_ ;          // ugh. should protect ?
  71
  72   Beaming_info_list*finished_grouping_;
  73 };
  74
  75 void
  76 Auto_beam_engraver::process_music ()
  77 {
  78   if (scm_is_string (get_property ("whichBar")))
  79     {
  80       consider_end (shortest_mom_);
  81       junk_beam ();
  82     }
  83
  84   if (forbid_)
  85     {
  86       consider_end (shortest_mom_);
  87       junk_beam ();
  88     }
  89 }
  90
  91
  92 Auto_beam_engraver::Auto_beam_engraver ()
  93 {
  94   forbid_ = 0;
  95   count_ = 0;
  96   stems_ = 0;
  97   shortest_mom_ = Moment (Rational (1, 8));
  98   finished_beam_ = 0;
  99   finished_grouping_ = 0;
 100   grouping_ = 0;
 101   beam_settings_ = SCM_EOL;
 102 }
 103
 104
 105 bool
 106 Auto_beam_engraver::try_music (Music*m)
 107 {
 108   if (m->is_mus_type  ("beam-forbid-event"))
 109     {
 110       forbid_ = m;
 111       return true;
 112     }
 113
 114   return false;
 115 }
 116
 117 /*
 118   Determine end moment for auto beaming (or begin moment, but mostly
 119   0==anywhere) In order of increasing priority:
 120
 121   i.   begin anywhere, end at every beat
 122   ii.  end   *    <num> <den>
 123   iii. end <type> <num> <den>
 124
 125   iv.  end   *      *     *
 126   v.   end <type>   *     *
 127
 128
 129   Rationale:
 130
 131   [to be defined in config file]
 132   i.   easy catch-all rule
 133   ii.  exceptions for time signature
 134   iii. exceptions for time signature, for specific duration type
 135
 136   [user override]
 137   iv.  generic override
 138   v.   override for specific duration type
 139
 140 */
 141 bool
 142 Auto_beam_engraver::test_moment (Direction dir, Moment test_mom)
 143 {
 144   Moment now = now_mom ();
 145   if (dir == START
 146       && now.grace_part_)
 147     {
 148       return false;
 149     }
 150
 151   SCM wild = scm_list_n (ly_symbol2scm ("*"), ly_symbol2scm ("*"), SCM_UNDEFINED);
 152   SCM function;
 153   if (dir == START)
 154     function = scm_list_n (ly_symbol2scm ("begin"), SCM_UNDEFINED);
 155   else
 156     function = scm_list_n (ly_symbol2scm ("end"), SCM_UNDEFINED);
 157
 158   Moment beat_length (1,4);
 159   if (Moment * m = unsmob_moment (get_property ("beatLength")))
 160     {
 161       beat_length = *m;
 162     }
 163   Moment measure_length (1,1);
 164   int num = 4;
 165   if (Moment* m = unsmob_moment (get_property ("measureLength")))
 166     {
 167       num = int ((*m / beat_length).main_part_);
 168     }
 169
 170   int den = beat_length.den ();
 171   SCM time = scm_list_n (scm_int2num (num), scm_int2num (den), SCM_UNDEFINED);
 172
 173   SCM type = scm_list_n (scm_int2num (test_mom.num ()),
 174                       scm_int2num (test_mom.den ()), SCM_UNDEFINED);
 175
 176   /*
 177     UGH UGH.
 178     settings aren't grob-properties.
 179    */
 180   SCM settings = get_property ("autoBeamSettings");
 181
 182   /* first guess */
 183
 184   /* begin beam at any position
 185  (and fallback for end) */
 186   Moment moment (0);
 187
 188   /* end beam at end of beat */
 189   if (dir == STOP)
 190     {
 191       moment = robust_scm2moment (get_property ("beatLength"), moment);
 192     }
 193
 194   /* second guess: property generic time exception */
 195   SCM m = scm_assoc (ly_append3 (function, wild, time), settings);
 196
 197   if (m != SCM_BOOL_F && unsmob_moment (scm_cdr (m)))
 198     moment = * unsmob_moment (scm_cdr (m));
 199
 200   /* third guess: property time exception, specific for duration type */
 201   m = scm_assoc (ly_append3 (function, type, time), settings);
 202   if (m != SCM_BOOL_F && unsmob_moment (scm_cdr (m)))
 203     moment = * unsmob_moment (scm_cdr (m));
 204
 205   /* fourth guess [user override]: property plain generic */
 206   m = scm_assoc (ly_append3 (function, wild, wild), settings);
 207   if (m != SCM_BOOL_F && unsmob_moment (scm_cdr (m)))
 208     moment = * unsmob_moment (scm_cdr (m));
 209
 210   /* fifth guess [user override]: property plain, specific for duration type */
 211   m = scm_assoc (ly_append3 (function, type, wild), settings);
 212   if (m != SCM_BOOL_F && unsmob_moment (scm_cdr (m)))
 213     moment = * unsmob_moment (scm_cdr (m));
 214
 215   Rational r;
 216   if (moment.to_bool ())
 217     {
 218       /* Ugh? measurePosition can be negative, when \partial
 219          We may have to fix this elsewhere (timing translator)
 220         r = unsmob_moment (get_property ("measurePosition"))->mod_rat (moment);
 221       */
 222       Moment pos (0);
 223       if (Moment  *m = unsmob_moment (get_property ("measurePosition")))
 224         {
 225           pos = *m;
 226         }
 227
 228       if (pos < Moment (0))
 229         {
 230           Moment length(1);
 231
 232           if ( Moment *m =  unsmob_moment (get_property ("measureLength")))
 233             {
 234               length = *m;
 235             }
 236           pos = length - pos;
 237         }
 238       r = pos.main_part_.mod_rat (moment.main_part_);
 239     }
 240   else
 241     {
 242       if (dir == START)
 243         /* if undefined, starting is ok */
 244         r = 0;
 245       else
 246         /* but ending is not */
 247         r = 1;
 248     }
 249
 250   return !r;
 251 }
 252
 253 void
 254 Auto_beam_engraver::consider_begin (Moment test_mom)
 255 {
 256   bool on = to_boolean (get_property ("autoBeaming"));
 257   if (!stems_ && on
 258       && !forbid_)
 259     {
 260       bool b = test_moment (START, test_mom);
 261       if (b)
 262         begin_beam ();
 263     }
 264 }
 265
 266 void
 267 Auto_beam_engraver::consider_end (Moment test_mom)
 268 {
 269   if (stems_)
 270     {
 271       /* Allow already started autobeam to end:
 272          don't check for autoBeaming */
 273       bool b = test_moment (STOP, test_mom);
 274       if (b)
 275         end_beam ();
 276     }
 277 }
 278
 279 Spanner *
 280 Auto_beam_engraver::create_beam ()
 281 {
 282   if (to_boolean (get_property ("skipTypesetting")))
 283     return 0;
 284
 285   Spanner *beam = new Spanner (beam_settings_);
 286   for (int i = 0; i < stems_->size (); i++)
 287     {
 288       /*
 289         watch out for stem tremolos and abbreviation beams
 290        */
 291       if (Stem::get_beam ((*stems_)[i]))
 292         {
 293           scm_gc_unprotect_object (beam->self_scm ());
 294           return 0;
 295         }
 296       Beam::add_stem (beam, (*stems_)[i]);
 297     }
 298
 299   announce_grob (beam, (*stems_)[0]->self_scm ());
 300
 301   return beam;
 302 }
 303
 304 void
 305 Auto_beam_engraver::begin_beam ()
 306 {
 307   if (stems_ || grouping_ )
 308     {
 309       programming_error ("already have autobeam");
 310       return;
 311     }
 312
 313   stems_ = new Link_array<Item>;
 314   grouping_ = new Beaming_info_list;
 315   beam_settings_ = updated_grob_properties (context (), ly_symbol2scm ("Beam"));
 316
 317   beam_start_moment_ = now_mom ();
 318   beam_start_location_ =
 319     robust_scm2moment (get_property ("measurePosition"), Moment(0));
 320   subdivide_beams_ = ly_scm2bool (get_property ("subdivideBeams"));
 321   beat_length_ = robust_scm2moment (get_property ("beatLength"), Moment(1,4));
 322 }
 323
 324 void
 325 Auto_beam_engraver::junk_beam ()
 326 {
 327   if (!stems_)
 328     return ;
 329
 330   delete stems_;
 331   stems_ = 0;
 332   delete grouping_;
 333   grouping_ = 0;
 334   beam_settings_ = SCM_EOL;
 335
 336   shortest_mom_ = Moment (Rational (1, 8));
 337 }
 338
 339 void
 340 Auto_beam_engraver::end_beam ()
 341 {
 342   if (stems_->size () < 2)
 343     {
 344       junk_beam ();
 345     }
 346   else
 347     {
 348       finished_beam_ = create_beam ();
 349       if (finished_beam_)
 350         finished_grouping_ = grouping_;
 351       delete stems_;
 352       stems_ = 0;
 353       grouping_ = 0;
 354       beam_settings_ = SCM_EOL;
 355     }
 356
 357   shortest_mom_ = Moment (Rational (1, 8));
 358 }
 359
 360 void
 361 Auto_beam_engraver::typeset_beam ()
 362 {
 363   if (finished_beam_)
 364     {
 365       finished_grouping_->beamify (beat_length_, subdivide_beams_);
 366       Beam::set_beaming (finished_beam_, finished_grouping_);
 367       finished_beam_ = 0;
 368
 369       delete finished_grouping_;
 370       finished_grouping_= 0;
 371     }
 372 }
 373
 374 void
 375 Auto_beam_engraver::start_translation_timestep ()
 376 {
 377   count_ = 0;
 378   /*
 379     don't beam over skips
 380    */
 381   if (stems_)
 382     {
 383       Moment now = now_mom ();
 384       if (extend_mom_ < now)
 385         {
 386           end_beam ();
 387         }
 388     }
 389   forbid_ = 0;
 390 }
 391
 392 void
 393 Auto_beam_engraver::stop_translation_timestep ()
 394 {
 395   typeset_beam ();
 396 }
 397
 398 void
 399 Auto_beam_engraver::finalize ()
 400 {
 401   /* finished beams may be typeset */
 402   typeset_beam ();
 403   /* but unfinished may need another announce/acknowledge pass */
 404   if (stems_)
 405     junk_beam ();
 406 }
 407
 408
 409 void
 410 Auto_beam_engraver::acknowledge_grob (Grob_info info)
 411 {
 412   if (stems_)
 413     {
 414       if (Beam::has_interface (info.grob_))
 415         {
 416           end_beam ();
 417         }
 418       else if (Bar_line::has_interface (info.grob_))
 419         {
 420           end_beam ();
 421         }
 422       else if (Rest::has_interface (info.grob_))
 423         {
 424           end_beam ();
 425         }
 426     }
 427
 428   if (Stem::has_interface (info.grob_))
 429     {
 430       Item* stem = dynamic_cast<Item *> (info.grob_);
 431       Music* m = info.music_cause ();
 432       if (!m->is_mus_type ("rhythmic-event"))
 433         {
 434           programming_error ("Stem must have rhythmic structure");
 435           return;
 436         }
 437
 438       /*
 439         Don't (start) auto-beam over empty stems; skips or rests
 440         */
 441       if (!Stem::head_count (stem))
 442         {
 443           if (stems_)
 444             end_beam ();
 445           return;
 446         }
 447
 448       if (Stem::get_beam (stem))
 449         {
 450           if (stems_)
 451             junk_beam ();
 452           return ;
 453         }
 454
 455       int durlog  = unsmob_duration (m->get_property ("duration"))->duration_log ();
 456
 457       if (durlog <= 2)
 458         {
 459           if (stems_)
 460             end_beam ();
 461           return;
 462         }
 463
 464
 465       /*
 466         ignore grace notes.
 467        */
 468       if (bool (beam_start_location_.grace_part_) != bool (now_mom ().grace_part_))
 469         return ;
 470
 471
 472       Moment dur = unsmob_duration (m->get_property ("duration"))->get_length ();
 473       /* FIXME:
 474
 475         This comment has been here since long:
 476
 477            if shortest duration would change
 478             consider ending and beginning beam first.
 479
 480         but the code didn't match: */
 481 #if 1
 482       consider_end (dur);
 483       consider_begin (dur);
 484
 485       if (dur < shortest_mom_)
 486         shortest_mom_ = dur;
 487 #else
 488       /* I very much suspect that we wanted: */
 489
 490       consider_end (shortest_mom_);
 491       if (dur < shortest_mom_)
 492         {
 493           shortest_mom_ = dur;
 494           consider_end (shortest_mom_);
 495         }
 496       consider_begin (shortest_mom_);
 497 #endif
 498
 499       if (!stems_)
 500         return;
 501
 502       Moment now = now_mom ();
 503
 504       grouping_->add_stem (now - beam_start_moment_ + beam_start_location_,
 505                              durlog - 2);
 506       stems_->push (stem);
 507       last_add_mom_ = now;
 508       extend_mom_ = (extend_mom_ >? now) + m->get_length ();
 509     }
 510 }
 511
 512 void
 513 Auto_beam_engraver::process_acknowledged_grobs ()
 514 {
 515   if (!count_)
 516     {
 517       consider_end (shortest_mom_);
 518       consider_begin (shortest_mom_);
 519     }
 520   else if (count_ > 1)
 521     {
 522       if (stems_)
 523         {
 524           Moment now = now_mom ();
 525           if ((extend_mom_ < now)
 526               || ((extend_mom_ == now) && (last_add_mom_ != now)))
 527             {
 528               end_beam ();
 529             }
 530           else if (!stems_->size ())
 531             {
 532               junk_beam ();
 533             }
 534         }
 535     }
 536
 537   count_ ++;
 538 }
 539
 540 ENTER_DESCRIPTION (Auto_beam_engraver,
 541 /* descr */       "Generate beams based on measure characteristics and observed "
 542 "Stems.  Uses beatLength, measureLength and measurePosition to decide "
 543 "when to start and stop a beam.  Overriding beaming is done through "
 544 "@ref{Stem_engraver} properties @code{stemLeftBeamCount} and "
 545 "@code{stemRightBeamCount}. "
 546 ,
 547 /* creats*/       "Beam",
 548 /* accepts */     "beam-forbid-event",
 549 /* acks  */      "stem-interface rest-interface beam-interface bar-line-interface",
 550 /* reads */       "autoBeaming autoBeamSettings beatLength subdivideBeams",
 551 /* write */       "");