lily/grob-pq-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2001--2015  Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "context.hh"
  21 #include "engraver.hh"
  22 #include "grob.hh"
  23 #include "warn.hh"
  24
  25 #include "translator.icc"
  26
  27 struct Grob_pq_entry
  28 {
  29   Grob *grob_;
  30   Moment end_;
  31 };
  32
  33 bool
  34 operator < (Grob_pq_entry const &a, Grob_pq_entry const &b)
  35 {
  36   return a.end_ < b.end_;
  37 }
  38
  39 class Grob_pq_engraver : public Engraver
  40 {
  41 public:
  42   TRANSLATOR_DECLARATIONS (Grob_pq_engraver);
  43 protected:
  44   virtual void initialize ();
  45   void acknowledge_grob (Grob_info);
  46   void start_translation_timestep ();
  47   void stop_translation_timestep ();
  48   void process_acknowledged ();
  49
  50   vector<Grob_pq_entry> started_now_;
  51 };
  52
  53 Grob_pq_engraver::Grob_pq_engraver (Context *c)
  54   : Engraver (c)
  55 {
  56 }
  57
  58 void
  59 Grob_pq_engraver::initialize ()
  60 {
  61   context ()->set_property ("busyGrobs", SCM_EOL);
  62 }
  63
  64 LY_DEFINE (ly_grob_pq_less_p, "ly:grob-pq<?",
  65            2, 0, 0, (SCM a, SCM b),
  66            "Compare two grob priority queue entries."
  67            "  This is an internal function.")
  68 {
  69   if (Moment::compare (*unsmob<Moment> (scm_car (a)),
  70                        *unsmob<Moment> (scm_car (b))) < 0)
  71     return SCM_BOOL_T;
  72   else
  73     return SCM_BOOL_F;
  74 }
  75
  76 void
  77 Grob_pq_engraver::acknowledge_grob (Grob_info gi)
  78 {
  79   Stream_event *ev = gi.event_cause ();
  80
  81   if (ev
  82       && !gi.grob ()->internal_has_interface (ly_symbol2scm ("multi-measure-interface")))
  83     {
  84       Moment n = now_mom ();
  85       Moment l = get_event_length (ev, n);
  86
  87       if (!l.to_bool ())
  88         return;
  89
  90       Moment end = n + l;
  91
  92       Grob_pq_entry e;
  93       e.grob_ = gi.grob ();
  94       e.end_ = end;
  95
  96       started_now_.push_back (e);
  97     }
  98 }
  99
 100 void
 101 Grob_pq_engraver::process_acknowledged ()
 102 {
 103   vector_sort (started_now_, less<Grob_pq_entry> ());
 104   SCM lst = SCM_EOL;
 105   SCM *tail = &lst;
 106   for (vsize i = 0; i < started_now_.size (); i++)
 107     {
 108       *tail = scm_acons (started_now_[i].end_.smobbed_copy (),
 109                          started_now_[i].grob_->self_scm (),
 110                          SCM_EOL);
 111       tail = SCM_CDRLOC (*tail);
 112     }
 113
 114   SCM busy = get_property ("busyGrobs");
 115   busy = scm_merge_x (lst, busy, ly_grob_pq_less_p_proc);
 116   context ()->set_property ("busyGrobs", busy);
 117
 118   started_now_.clear ();
 119 }
 120
 121 void
 122 Grob_pq_engraver::stop_translation_timestep ()
 123 {
 124   Moment now = now_mom ();
 125   SCM start_busy = get_property ("busyGrobs");
 126   SCM busy = start_busy;
 127   while (scm_is_pair (busy) && *unsmob<Moment> (scm_caar (busy)) == now)
 128     busy = scm_cdr (busy);
 129
 130 }
 131
 132 void
 133 Grob_pq_engraver::start_translation_timestep ()
 134 {
 135   Moment now = now_mom ();
 136
 137   SCM start_busy = get_property ("busyGrobs");
 138   SCM busy = start_busy;
 139   while (scm_is_pair (busy) && *unsmob<Moment> (scm_caar (busy)) < now)
 140     {
 141       /*
 142         The grob-pq-engraver is not water tight, and stuff like
 143         tupletSpannerDuration confuses it.
 144       */
 145       busy = scm_cdr (busy);
 146     }
 147
 148   if (!scm_is_eq (start_busy, busy))
 149     context ()->set_property ("busyGrobs", busy);
 150 }
 151
 152 void
 153 Grob_pq_engraver::boot ()
 154 {
 155   ADD_ACKNOWLEDGER (Grob_pq_engraver, grob);
 156 }
 157
 158 ADD_TRANSLATOR (Grob_pq_engraver,
 159                 /* doc */
 160                 "Administrate when certain grobs (e.g., note heads) stop"
 161                 " playing.",
 162
 163                 /* create */
 164                 "",
 165
 166                 /* read */
 167                 "busyGrobs ",
 168
 169                 /* write */
 170                 "busyGrobs "
 171                );