-/*
- tie-engraver.cc -- implement Tie_engraver
-
- source file of the GNU LilyPond music typesetter
-
- (c) 1998--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-
- */
-
-#include "command-request.hh"
-#include "rhythmic-head.hh"
-#include "musical-request.hh"
-#include "tie.hh"
-#include "translator-group.hh"
-#include "spanner.hh"
-#include "tie-column.hh"
-#include "pqueue.hh"
-#include "engraver.hh"
-#include "item.hh"
+/*
+ This file is part of LilyPond, the GNU music typesetter.
-struct CHead_melodic_tuple {
- Melodic_req *req_l_ ;
- Grob *head_l_;
- Moment end_;
- CHead_melodic_tuple ();
- CHead_melodic_tuple (Grob*, Melodic_req*, Moment);
- static int pitch_compare (CHead_melodic_tuple const &, CHead_melodic_tuple const &);
- static int time_compare (CHead_melodic_tuple const &, CHead_melodic_tuple const &);
-};
+ Copyright (C) 1998--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
-inline int compare (CHead_melodic_tuple const &a, CHead_melodic_tuple const &b)
-{
- return CHead_melodic_tuple::time_compare (a,b);
-}
+ LilyPond is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
+*/
+#include "engraver.hh"
+
+#include "context.hh"
+#include "international.hh"
+#include "item.hh"
+#include "note-head.hh"
+#include "protected-scm.hh"
+#include "spanner.hh"
+#include "staff-symbol-referencer.hh"
+#include "stream-event.hh"
+#include "tie-column.hh"
+#include "tie.hh"
+#include "warn.hh"
+
+#include "translator.icc"
/**
- Manufacture ties. Acknowledge noteheads, and put them into a
- priority queue. If we have a Tie_req, connect the notes that finish
+ Manufacture ties. Acknowledge note heads, and put them into a
+ priority queue. If we have a TieEvent, connect the notes that finish
just at this time, and note that start at this time.
- TODO: junk the pq; the PQ is overkill if we assume that no
- different durations occur in parallel.
+ TODO: Remove the dependency on musical info. We should tie on the
+ basis of position and duration-log of the heads (not of the events).
*/
+
+struct Head_event_tuple
+{
+ Grob *head_;
+ Moment end_moment_;
+ Stream_event *tie_stream_event_;
+ Stream_event *tie_event_;
+ Spanner *tie_;
+ // Indicate whether a tie from the same moment has been processed successfully
+ // This is needed for tied chords, e.g. <c e g>~ g, because otherwise the c
+ // and e will trigger a warning for an unterminated tie!
+ bool tie_from_chord_created;
+
+ Head_event_tuple ()
+ {
+ head_ = 0;
+ tie_event_ = 0;
+ tie_stream_event_ = 0;
+ tie_from_chord_created = false;
+ tie_ = 0;
+ }
+};
+
class Tie_engraver : public Engraver
{
- PQueue<CHead_melodic_tuple> past_notes_pq_;
- Moment end_mom_;
- Moment next_end_mom_;
-
- Tie_req *req_l_;
- Array<CHead_melodic_tuple> now_heads_;
- Array<CHead_melodic_tuple> stopped_heads_;
- Link_array<Grob> tie_p_arr_;
-
- Spanner * tie_column_p_;
-
- void set_melisma (bool);
-
+ /*
+ Whether tie event has been processed and can be deleted or should
+ be kept for later portions of a split note.
+ */
+ bool event_processed_;
+ Stream_event *event_;
+ vector<Grob *> now_heads_;
+ vector<Head_event_tuple> heads_to_tie_;
+ vector<Grob *> ties_;
+
+ Spanner *tie_column_;
+
protected:
- virtual void start_translation_timestep ();
- virtual void stop_translation_timestep ();
- virtual void acknowledge_grob (Grob_info);
- virtual bool try_music (Music*);
- virtual void create_grobs ();
- void typeset_tie (Grob*);
+ void process_acknowledged ();
+ void stop_translation_timestep ();
+ void start_translation_timestep ();
+ DECLARE_ACKNOWLEDGER (note_head);
+ DECLARE_TRANSLATOR_LISTENER (tie);
+ void process_music ();
+ void typeset_tie (Grob *);
+ void report_unterminated_tie (Head_event_tuple const &);
+ bool has_autosplit_end (Stream_event *event);
public:
- VIRTUAL_COPY_CONS (Translator);
- Tie_engraver ();
+ TRANSLATOR_DECLARATIONS (Tie_engraver);
};
-
-
Tie_engraver::Tie_engraver ()
{
- req_l_ = 0;
- tie_column_p_ = 0;
+ event_ = 0;
+ tie_column_ = 0;
+ event_processed_ = false;
}
+IMPLEMENT_TRANSLATOR_LISTENER (Tie_engraver, tie);
+void
+Tie_engraver::listen_tie (Stream_event *ev)
+{
+ if (!to_boolean (get_property ("skipTypesetting")))
+ {
+ ASSIGN_EVENT_ONCE (event_, ev);
+ }
+}
-bool
-Tie_engraver::try_music (Music *m)
+void Tie_engraver::report_unterminated_tie (Head_event_tuple const &tie_start)
{
- if (Tie_req * c = dynamic_cast<Tie_req*> (m))
+ // If tie_from_chord_created is set, we have another note at the same
+ // moment that created a tie, so this is not necessarily an unterminated
+ // tie. Happens e.g. for <c e g>~ g
+ if (!tie_start.tie_from_chord_created)
{
- /* if (end_mom_ > now_mom ())
- return false;
- */
- req_l_ = c;
- SCM m = get_property ("automaticMelismata");
- bool am = gh_boolean_p (m) &&gh_scm2bool (m);
- if (am)
- {
- set_melisma (true);
- }
- return true;
+ tie_start.tie_->warning (_ ("unterminated tie"));
+ tie_start.tie_->suicide ();
}
+}
+
+/*
+ Determines whether the end of an event was created by
+ a split in Completion_heads_engraver or by user input.
+*/
+bool
+Tie_engraver::has_autosplit_end (Stream_event *event)
+{
+ if (event)
+ return to_boolean (event->get_property ("autosplit-end"));
return false;
}
void
-Tie_engraver::set_melisma (bool m)
+Tie_engraver::process_music ()
{
- daddy_trans_l_->set_property ("tieMelismaBusy", m ? SCM_BOOL_T : SCM_BOOL_F);
+ bool busy = event_;
+ for (vsize i = 0; !busy && i < heads_to_tie_.size (); i++)
+ busy |= (heads_to_tie_[i].tie_event_
+ || heads_to_tie_[i].tie_stream_event_);
+
+ if (busy)
+ context ()->set_property ("tieMelismaBusy", SCM_BOOL_T);
}
void
-Tie_engraver::acknowledge_grob (Grob_info i)
+Tie_engraver::acknowledge_note_head (Grob_info i)
{
- if (Rhythmic_head::has_interface (i.elem_l_))
+ Grob *h = i.grob ();
+
+ now_heads_.push_back (h);
+ for (vsize i = heads_to_tie_.size (); i--;)
{
- Note_req * m = dynamic_cast<Note_req* > (i.req_l_);
- if (!m)
- return;
- now_heads_.push (CHead_melodic_tuple (i.elem_l_, m, now_mom ()+ m->length_mom ()));
+ Grob *th = heads_to_tie_[i].head_;
+ Stream_event *right_ev = unsmob_stream_event (h->get_property ("cause"));
+ Stream_event *left_ev = unsmob_stream_event (th->get_property ("cause"));
+
+ /*
+ maybe should check positions too.
+ */
+ if (!right_ev || !left_ev)
+ continue;
+
+ /*
+ Make a tie only if pitches are equal or if event end was not generated by
+ Completion_heads_engraver.
+ */
+ if (ly_is_equal (right_ev->get_property ("pitch"), left_ev->get_property ("pitch"))
+ && (!Tie_engraver::has_autosplit_end (left_ev)))
+ {
+ Grob *p = heads_to_tie_[i].tie_;
+ Moment end = heads_to_tie_[i].end_moment_;
+
+ Stream_event *cause = heads_to_tie_[i].tie_event_
+ ? heads_to_tie_[i].tie_event_
+ : heads_to_tie_[i].tie_stream_event_;
+
+ announce_end_grob (p, cause->self_scm ());
+
+ Tie::set_head (p, LEFT, th);
+ Tie::set_head (p, RIGHT, h);
+
+ if (is_direction (cause->get_property ("direction")))
+ {
+ Direction d = to_dir (cause->get_property ("direction"));
+ p->set_property ("direction", scm_from_int (d));
+ }
+
+ ties_.push_back (p);
+ heads_to_tie_.erase (heads_to_tie_.begin () + i);
+
+ /*
+ Prevent all other tied notes ending at the same moment (assume
+ implicitly the notes have also started at the same moment!)
+ from triggering an "unterminated tie" warning. Needed e.g. for
+ <c e g>~ g
+ */
+ for (vsize j = heads_to_tie_.size (); j--;)
+ {
+ if (heads_to_tie_[j].end_moment_ == end)
+ heads_to_tie_[j].tie_from_chord_created = true;
+ }
+ }
}
-}
+ if (ties_.size () && ! tie_column_)
+ tie_column_ = make_spanner ("TieColumn", ties_[0]->self_scm ());
+
+ if (tie_column_)
+ for (vsize i = ties_.size (); i--;)
+ Tie_column::add_tie (tie_column_, ties_[i]);
+}
void
-Tie_engraver::create_grobs ()
+Tie_engraver::start_translation_timestep ()
{
- if (req_l_)
+ if (heads_to_tie_.size () && !to_boolean (get_property ("tieWaitForNote")))
{
- now_heads_.sort (CHead_melodic_tuple::pitch_compare);
- stopped_heads_.sort (CHead_melodic_tuple::pitch_compare);
-
- SCM head_list = SCM_EOL;
-
- int j = stopped_heads_.size ()-1;
- int i = now_heads_.size ()-1;
-
- while (i >= 0 && j >=0)
- {
- int comp
- = Pitch::compare (*unsmob_pitch (now_heads_[i].req_l_->get_mus_property ("pitch")),
- *unsmob_pitch (stopped_heads_[j].req_l_->get_mus_property ("pitch")));
-
- if (comp)
- {
- (comp < 0) ? j -- : i--;
- continue;
- }
- else
- {
- head_list = gh_cons (gh_cons (stopped_heads_[j].head_l_->self_scm (),
- now_heads_[i].head_l_->self_scm ()),
- head_list);
-
- past_notes_pq_. insert (now_heads_[i]);
- now_heads_.del (i);
- stopped_heads_.del (j);
- i--;
- j--;
- }
- }
-
- SCM basic = get_property ("Tie");
- SCM sparse = get_property ("sparseTies");
- if (to_boolean (sparse))
- {
- int i = scm_ilength (head_list);
-
- if (!i)
- return;
-
- SCM pair = gh_list_ref (head_list, gh_int2scm (i/2));
-
- Spanner * p = new Spanner (basic);
-
- Tie::set_interface (p);
- Tie::set_head (p,LEFT, dynamic_cast<Item*> (unsmob_grob (gh_car (pair))));
- Tie::set_head (p,RIGHT, dynamic_cast<Item*> (unsmob_grob (gh_cdr (pair))));
-
- tie_p_arr_.push (p);
- announce_grob (p, req_l_);
- }
- else for (SCM s = head_list; gh_pair_p (s); s = gh_cdr (s))
- {
- Grob * p = new Spanner (basic);
- Tie::set_interface (p);
-
- Tie::set_head (p, LEFT, dynamic_cast<Item*> (unsmob_grob (gh_caar (s))));
- Tie::set_head (p, RIGHT, dynamic_cast<Item*> (unsmob_grob (gh_cdar (s))));
-
- tie_p_arr_.push (p);
- announce_grob (p, req_l_);
- }
-
- if (tie_p_arr_.size () > 1 && !tie_column_p_)
- {
- tie_column_p_ = new Spanner (get_property ("TieColumn"));
- Tie_column::set_interface (tie_column_p_);
- for (int i = tie_p_arr_.size (); i--;)
- Tie_column::add_tie (tie_column_p_,tie_p_arr_ [i]);
- announce_grob (tie_column_p_, 0);
- }
+ Moment now = now_mom ();
+ for (vsize i = heads_to_tie_.size (); i--;)
+ {
+ if (now > heads_to_tie_[i].end_moment_)
+ {
+ report_unterminated_tie (heads_to_tie_[i]);
+ heads_to_tie_.erase (heads_to_tie_.begin () + i);
+ }
+ }
}
-}
+ context ()->set_property ("tieMelismaBusy",
+ ly_bool2scm (heads_to_tie_.size ()));
+}
void
-Tie_engraver::stop_translation_timestep ()
+Tie_engraver::process_acknowledged ()
{
- for (int i=0; i < now_heads_.size (); i++)
+ bool wait = to_boolean (get_property ("tieWaitForNote"));
+ if (ties_.size ())
{
- past_notes_pq_.insert (now_heads_[i]);
+ if (!wait)
+ {
+ vector<Head_event_tuple>::iterator it = heads_to_tie_.begin ();
+ for (; it < heads_to_tie_.end (); it++)
+ report_unterminated_tie (*it);
+ heads_to_tie_.clear ();
+ }
+
+ for (vsize i = 0; i < ties_.size (); i++)
+ typeset_tie (ties_[i]);
+
+ ties_.clear ();
+ tie_column_ = 0;
}
- now_heads_.clear ();
- if (req_l_ && !tie_p_arr_.size ())
+ vector<Head_event_tuple> new_heads_to_tie;
+
+
+ for (vsize i = 0; i < now_heads_.size (); i++)
{
- /* How to shut up this warning, when no notes appeared because
- they were suicided by Thread_devnull_engraver? */
- req_l_->origin ()->warning (_ ("No ties were created!"));
- }
-
- for (int i=0; i< tie_p_arr_.size (); i++)
- {
- typeset_tie (tie_p_arr_[i]);
+ Grob *head = now_heads_[i];
+ Stream_event *left_ev
+ = unsmob_stream_event (head->get_property ("cause"));
+
+ if (!left_ev)
+ {
+ // may happen for ambitus
+ continue;
+ }
+
+ // We only want real notes to cause ties, not e.g. pitched trills
+ if (!left_ev->in_event_class ("note-event"))
+ continue;
+
+ SCM left_articulations = left_ev->get_property ("articulations");
+
+ Stream_event *tie_event = 0;
+ Stream_event *tie_stream_event = event_;
+ for (SCM s = left_articulations;
+ !tie_event && !tie_stream_event && scm_is_pair (s);
+ s = scm_cdr (s))
+ {
+ Stream_event *ev = unsmob_stream_event (scm_car (s));
+ if (!ev)
+ continue;
+
+ if (ev->in_event_class ("tie-event"))
+ tie_event = ev;
+ }
+
+ if (left_ev && (tie_event || tie_stream_event)
+ && (!Tie_engraver::has_autosplit_end (left_ev)))
+ {
+ event_processed_ = true;
+
+ Head_event_tuple event_tup;
+
+ event_tup.head_ = head;
+ event_tup.tie_event_ = tie_event;
+ event_tup.tie_stream_event_ = tie_stream_event;
+ event_tup.tie_ = make_spanner ("Tie", tie_event
+ ? tie_event->self_scm ()
+ : tie_stream_event->self_scm ());
+
+ Moment end = now_mom ();
+ if (end.grace_part_)
+ {
+ end.grace_part_ += get_event_length (left_ev).main_part_;
+ }
+ else
+ {
+ end += get_event_length (left_ev);
+ }
+ event_tup.end_moment_ = end;
+
+ new_heads_to_tie.push_back (event_tup);
+ }
}
- tie_p_arr_.clear ();
- if (tie_column_p_)
+
+ if (!wait && new_heads_to_tie.size ())
{
- typeset_grob (tie_column_p_);
- tie_column_p_ =0;
+ vector<Head_event_tuple>::iterator it = heads_to_tie_.begin ();
+ for (; it < heads_to_tie_.end (); it++)
+ report_unterminated_tie (*it);
+ heads_to_tie_.clear ();
}
+
+ // hmmm, how to do with copy () ?
+ for (vsize i = 0; i < new_heads_to_tie.size (); i++)
+ heads_to_tie_.push_back (new_heads_to_tie[i]);
+
+ now_heads_.clear ();
}
void
-Tie_engraver::typeset_tie (Grob *her)
+Tie_engraver::stop_translation_timestep ()
{
- if (! (Tie::head (her,LEFT) && Tie::head (her,RIGHT)))
- warning (_ ("lonely tie"));
-
- Direction d = LEFT;
- Drul_array<Grob *> new_head_drul;
- new_head_drul[LEFT] = Tie::head (her,LEFT);
- new_head_drul[RIGHT] = Tie::head (her,RIGHT);
- do {
- if (!Tie::head (her,d))
- new_head_drul[d] = Tie::head (her, (Direction)-d);
- } while (flip (&d) != LEFT);
-
- index_set_cell (her->get_grob_property ("heads"), LEFT, new_head_drul[LEFT]->self_scm ());
- index_set_cell (her->get_grob_property ("heads"), RIGHT, new_head_drul[RIGHT]->self_scm ());
-
- typeset_grob (her);
+ /*
+ Discard event only if it has been processed with at least one
+ appropriate note.
+ */
+ if (event_processed_)
+ event_ = 0;
+
+ event_processed_ = false;
}
void
-Tie_engraver::start_translation_timestep ()
+Tie_engraver::typeset_tie (Grob *her)
{
- SCM m = get_property ("automaticMelismata");
- if (to_boolean (m))
+ if (! (Tie::head (her, LEFT) && Tie::head (her, RIGHT)))
+ warning (_ ("lonely tie"));
+
+ Drul_array<Grob *> new_head_drul;
+ new_head_drul[LEFT] = Tie::head (her, LEFT);
+ new_head_drul[RIGHT] = Tie::head (her, RIGHT);
+ for (LEFT_and_RIGHT (d))
{
- set_melisma (false);
+ if (!Tie::head (her, d))
+ new_head_drul[d] = Tie::head (her, (Direction) - d);
}
- req_l_ = 0;
- Moment now = now_mom ();
- while (past_notes_pq_.size () && past_notes_pq_.front ().end_ < now)
- past_notes_pq_.delmin ();
-
-
- stopped_heads_.clear ();
- while (past_notes_pq_.size ()
- && past_notes_pq_.front ().end_ == now)
- stopped_heads_.push (past_notes_pq_.get ());
+ Spanner *sp = dynamic_cast<Spanner *> (her);
+ sp->set_bound (LEFT, new_head_drul[LEFT]);
+ sp->set_bound (RIGHT, new_head_drul[RIGHT]);
}
-ADD_THIS_TRANSLATOR (Tie_engraver);
+ADD_ACKNOWLEDGER (Tie_engraver, note_head);
+ADD_TRANSLATOR (Tie_engraver,
+ /* doc */
+ "Generate ties between note heads of equal pitch.",
+ /* create */
+ "Tie "
+ "TieColumn ",
-CHead_melodic_tuple::CHead_melodic_tuple ()
-{
- head_l_ =0;
- req_l_ =0;
- end_ = 0;
-}
-
-CHead_melodic_tuple::CHead_melodic_tuple (Grob *h, Melodic_req*m, Moment mom)
-{
- head_l_ = h;
- req_l_ = m;
- end_ = mom;
-}
-
-/*
- signed compare, should use pitch<?
- */
-int
-CHead_melodic_tuple::pitch_compare (CHead_melodic_tuple const&h1,
- CHead_melodic_tuple const &h2)
-{
- SCM p1 = h1.req_l_->get_mus_property ("pitch");
- SCM p2 = h2.req_l_->get_mus_property ("pitch");
-
- return Pitch::compare (*unsmob_pitch (p1),
- *unsmob_pitch (p2));
-}
+ /* read */
+ "skipTypesetting "
+ "tieWaitForNote ",
-int
-CHead_melodic_tuple::time_compare (CHead_melodic_tuple const&h1,
- CHead_melodic_tuple const &h2)
-{
- return (h1.end_ - h2.end_).sign ();
-}
+ /* write */
+ "tieMelismaBusy "
+ );