lily/tie-engraver.cc

   1 /*
   2   tie-engraver.cc --  implement Tie_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8  */
   9
  10 #include "tie-engraver.hh"
  11 #include "command-request.hh"
  12 #include "rhythmic-head.hh"
  13 #include "musical-request.hh"
  14 #include "tie.hh"
  15 #include "translator-group.hh"
  16 #include "spanner.hh"
  17 #include "tie-column.hh"
  18 #include "pqueue.hh"
  19 #include "engraver.hh"
  20 #include "item.hh"
  21
  22 struct CHead_melodic_tuple {
  23   Melodic_req *req_l_ ;
  24   Score_element *head_l_;
  25   Moment end_;
  26   CHead_melodic_tuple ();
  27   CHead_melodic_tuple (Score_element*, Melodic_req*, Moment);
  28   static int pitch_compare (CHead_melodic_tuple const &, CHead_melodic_tuple const &);
  29   static int time_compare (CHead_melodic_tuple const &, CHead_melodic_tuple const &);
  30 };
  31
  32 inline int compare (CHead_melodic_tuple const &a, CHead_melodic_tuple const &b)
  33 {
  34   return CHead_melodic_tuple::time_compare (a,b);
  35 }
  36
  37
  38 /**
  39    Manufacture ties.  Acknowledge noteheads, and put them into a
  40    priority queue. If we have a Tie_req, connect the notes that finish
  41    just at this time, and note that start at this time.
  42
  43    TODO: junk the pq.
  44  */
  45 class Tie_engraver : public Engraver
  46 {
  47   PQueue<CHead_melodic_tuple> past_notes_pq_;
  48   Moment end_mom_;
  49   Moment next_end_mom_;
  50
  51   Tie_req *req_l_;
  52   Array<CHead_melodic_tuple> now_heads_;
  53   Array<CHead_melodic_tuple> stopped_heads_;
  54   Link_array<Score_element> tie_p_arr_;
  55
  56   Spanner * tie_column_p_;
  57
  58   void set_melisma (bool);
  59
  60 protected:
  61   virtual void do_post_move_processing ();
  62   virtual void do_pre_move_processing ();
  63   virtual void acknowledge_element (Score_element_info);
  64   virtual bool do_try_music (Music*);
  65   virtual void do_process_music ();
  66   virtual void process_acknowledged ();
  67   void typeset_tie (Score_element*);
  68 public:
  69   VIRTUAL_COPY_CONS(Translator);
  70   Tie_engraver();
  71 };
  72
  73
  74
  75 Tie_engraver::Tie_engraver()
  76 {
  77   req_l_ = 0;
  78   tie_column_p_ = 0;
  79 }
  80
  81
  82 bool
  83 Tie_engraver::do_try_music (Music *m)
  84 {
  85   if (Tie_req * c = dynamic_cast<Tie_req*> (m))
  86     {
  87       /*      if (end_mom_ > now_mom ())
  88        return false;
  89       */
  90       req_l_ = c;
  91       SCM m = get_property ("automaticMelismata");
  92       bool am = gh_boolean_p (m) &&gh_scm2bool (m);
  93       if (am)
  94         {
  95           set_melisma (true);
  96         }
  97       return true;
  98     }
  99   return false;
 100 }
 101
 102 void
 103 Tie_engraver::set_melisma (bool m)
 104 {
 105   daddy_trans_l_->set_property ("tieMelismaBusy", m ? SCM_BOOL_T : SCM_BOOL_F);
 106 }
 107
 108 void
 109 Tie_engraver::acknowledge_element (Score_element_info i)
 110 {
 111   if (Rhythmic_head::has_interface (i.elem_l_))
 112     {
 113       Note_req * m = dynamic_cast<Note_req* > (i.req_l_);
 114       if (!m)
 115         return;
 116       now_heads_.push (CHead_melodic_tuple (i.elem_l_, m, now_mom()+ m->length_mom ()));
 117     }
 118 }
 119
 120 void
 121 Tie_engraver::do_process_music ()
 122 {
 123   if (req_l_)
 124     {
 125       Moment now = now_mom ();
 126       stopped_heads_.clear ();
 127       while (past_notes_pq_.size ()
 128              && past_notes_pq_.front ().end_ == now)
 129         stopped_heads_.push (past_notes_pq_.get ());
 130     }
 131 }
 132
 133 void
 134 Tie_engraver::process_acknowledged ()
 135 {
 136   if (req_l_)
 137     {
 138       now_heads_.sort (CHead_melodic_tuple::pitch_compare);
 139       stopped_heads_.sort(CHead_melodic_tuple::pitch_compare);
 140
 141       SCM head_list = SCM_EOL;
 142
 143       int j = stopped_heads_.size ()-1;
 144       int i = now_heads_.size ()-1;
 145
 146       while  (i >= 0 && j >=0)
 147         {
 148           int comp
 149             = Musical_pitch::compare (*unsmob_pitch (now_heads_[i].req_l_->get_mus_property ("pitch") ),
 150                                       *unsmob_pitch (stopped_heads_[j].req_l_->get_mus_property ("pitch")));
 151
 152           if (comp)
 153             {
 154               (comp < 0) ? j -- : i--;
 155               continue;
 156             }
 157           else
 158             {
 159               head_list  = gh_cons (gh_cons (stopped_heads_[j].head_l_->self_scm (),
 160                                              now_heads_[i].head_l_->self_scm ()),
 161                                     head_list);
 162
 163               past_notes_pq_. insert (now_heads_[i]);
 164               now_heads_.del (i);
 165               stopped_heads_.del (j);
 166               i--;
 167               j--;
 168             }
 169         }
 170
 171       SCM basic = get_property ("Tie");
 172       SCM sparse = get_property ("sparseTies");
 173       if (to_boolean (sparse))
 174         {
 175           int i = scm_ilength (head_list);
 176
 177           if (!i)
 178             return;
 179
 180           SCM pair = gh_list_ref (head_list, gh_int2scm (i/2));
 181
 182           Spanner * p = new Spanner (basic);
 183           Tie::set_head (p,LEFT, dynamic_cast<Item*> (unsmob_element (gh_car (pair))));
 184           Tie::set_head (p,RIGHT, dynamic_cast<Item*> (unsmob_element (gh_cdr (pair))));
 185
 186           tie_p_arr_.push (p);
 187           announce_element (p, req_l_);
 188         }
 189       else for (SCM s = head_list; gh_pair_p (s); s = gh_cdr (s))
 190         {
 191           Score_element * p = new Spanner (basic);
 192           Tie::set_interface (p);
 193
 194           Tie::set_head (p, LEFT, dynamic_cast<Item*> (unsmob_element (gh_caar (s))));
 195           Tie::set_head (p, RIGHT, dynamic_cast<Item*> (unsmob_element (gh_cdar (s))));
 196
 197           tie_p_arr_.push (p);
 198           announce_element (p, req_l_);
 199         }
 200
 201       if (!tie_p_arr_.size ())
 202         {
 203           req_l_->origin ()->warning (_ ("No ties were created!"));
 204         }
 205       else if (tie_p_arr_.size () > 1 && !tie_column_p_)
 206         {
 207           tie_column_p_ = new Spanner (get_property ("TieColumn"));
 208           Tie_column::set_interface (tie_column_p_);
 209           for (int i = tie_p_arr_.size (); i--; )
 210             Tie_column::add_tie (tie_column_p_,tie_p_arr_ [i]);
 211           announce_element (tie_column_p_, 0);
 212         }
 213     }
 214 }
 215
 216
 217 void
 218 Tie_engraver::do_pre_move_processing ()
 219 {
 220   for (int i=0; i < now_heads_.size (); i++)
 221     {
 222       past_notes_pq_.insert (now_heads_[i]);
 223     }
 224   now_heads_.clear ();
 225
 226   for (int i=0; i<  tie_p_arr_.size (); i++)
 227    {
 228       typeset_tie (tie_p_arr_[i]);
 229     }
 230   tie_p_arr_.clear ();
 231   if (tie_column_p_)
 232     {
 233       typeset_element (tie_column_p_);
 234       tie_column_p_ =0;
 235     }
 236 }
 237
 238 void
 239 Tie_engraver::typeset_tie (Score_element *her)
 240 {
 241   if (!(Tie::head (her,LEFT) && Tie::head (her,RIGHT)))
 242     warning (_ ("lonely tie"));
 243
 244   Direction d = LEFT;
 245   Drul_array<Score_element *> new_head_drul;
 246   new_head_drul[LEFT] = Tie::head(her,LEFT);
 247   new_head_drul[RIGHT] = Tie::head (her,RIGHT);
 248   do {
 249     if (!Tie::head (her,d))
 250       new_head_drul[d] = Tie::head(her,(Direction)-d);
 251   } while (flip(&d) != LEFT);
 252
 253   index_set_cell (her->get_elt_property ("heads"), LEFT, new_head_drul[LEFT]->self_scm () );
 254   index_set_cell (her->get_elt_property ("heads"), RIGHT, new_head_drul[RIGHT]->self_scm () );
 255
 256   typeset_element (her);
 257 }
 258
 259 void
 260 Tie_engraver::do_post_move_processing ()
 261 {
 262   SCM m = get_property ("automaticMelismata");
 263   if (to_boolean (m))
 264     {
 265       set_melisma (false);
 266     }
 267   req_l_ = 0;
 268   Moment now = now_mom ();
 269   while (past_notes_pq_.size () && past_notes_pq_.front ().end_ < now)
 270     past_notes_pq_.delmin ();
 271 }
 272
 273 ADD_THIS_TRANSLATOR(Tie_engraver);
 274
 275
 276 CHead_melodic_tuple::CHead_melodic_tuple ()
 277 {
 278   head_l_ =0;
 279   req_l_ =0;
 280   end_ = 0;
 281 }
 282
 283 CHead_melodic_tuple::CHead_melodic_tuple (Score_element *h, Melodic_req*m, Moment mom)
 284 {
 285   head_l_ = h;
 286   req_l_ = m;
 287   end_ = mom;
 288 }
 289
 290 int
 291 CHead_melodic_tuple::pitch_compare (CHead_melodic_tuple const&h1,
 292                              CHead_melodic_tuple const &h2)
 293 {
 294   SCM p1  = h1.req_l_->get_mus_property ("pitch");
 295   SCM p2  = h2.req_l_->get_mus_property ("pitch");
 296
 297   return Musical_pitch::equal_p (p1,p2) == SCM_BOOL_T;
 298 }
 299
 300 int
 301 CHead_melodic_tuple::time_compare (CHead_melodic_tuple const&h1,
 302                              CHead_melodic_tuple const &h2)
 303 {
 304   return (h1.end_ - h2.end_ ).sign ();
 305 }