X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Ftie-engraver.cc;h=1aecbe526cb16b4a18ca5bc8e5cd0a81b93e1c23;hb=3af0951f9a11677240efa6228683dd4fcea13eaf;hp=b507048eed0e0b39e5b8cdb954887b730521f123;hpb=76f13ab50fc726c89fa7c96f3deed519d2d773dc;p=lilypond.git diff --git a/lily/tie-engraver.cc b/lily/tie-engraver.cc index b507048eed..2a016b31be 100644 --- a/lily/tie-engraver.cc +++ b/lily/tie-engraver.cc @@ -1,272 +1,408 @@ -/* - ctie-engraver.cc -- implement Tie_engraver - - source file of the GNU LilyPond music typesetter - - (c) 1998--2000 Han-Wen Nienhuys - - */ - -#include "tie-engraver.hh" -#include "command-request.hh" -#include "note-head.hh" -#include "musical-request.hh" -#include "tie.hh" -#include "translator-group.hh" -#include "tie-column.hh" -#include "pqueue.hh" -#include "engraver.hh" +/* + This file is part of LilyPond, the GNU music typesetter. -struct CHead_melodic_tuple { - Melodic_req *req_l_ ; - Note_head *head_l_; - Moment end_; - CHead_melodic_tuple (); - CHead_melodic_tuple (Note_head*, 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--2015 Han-Wen Nienhuys -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 . +*/ +#include "engraver.hh" + +#include "context.hh" +#include "international.hh" +#include "item.hh" +#include "note-head.hh" +#include "pitch.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: should share code with Beam_engraver, Extender_engraver? - */ + 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. ~ 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 past_notes_pq_; - Tie_req *req_l_; - Array now_heads_; - Array stopped_heads_; - Link_array tie_p_arr_; - - Tie_column * tie_column_p_; - - void set_melisma (bool); - -protected: - virtual void do_post_move_processing (); - virtual void do_pre_move_processing (); - virtual void acknowledge_element (Score_element_info); - virtual bool do_try_music (Music*); - virtual void do_process_music (); - virtual void process_acknowledged (); + /* + 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 now_heads_; + vector heads_to_tie_; + vector ties_; + + Spanner *tie_column_; + bool tie_notehead (Grob *h, bool enharmonic); +protected: + void process_acknowledged (); + void stop_translation_timestep (); + void start_translation_timestep (); + void acknowledge_note_head (Grob_info); + void listen_tie (Stream_event *); + void process_music (); + void typeset_tie (Spanner *); + 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() +Tie_engraver::Tie_engraver () { - req_l_ = 0; - tie_column_p_ = 0; + event_ = 0; + tie_column_ = 0; + event_processed_ = false; } +void +Tie_engraver::listen_tie (Stream_event *ev) +{ + if (!to_boolean (get_property ("skipTypesetting"))) + { + ASSIGN_EVENT_ONCE (event_, ev); + } +} -bool -Tie_engraver::do_try_music (Music *m) +void Tie_engraver::report_unterminated_tie (Head_event_tuple const &tie_start) { - if (Tie_req * c = dynamic_cast (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 ~ g + if (!tie_start.tie_from_chord_created) { - 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_element (Score_element_info i) +bool +Tie_engraver::tie_notehead (Grob *h, bool enharmonic) { - if (Note_head *nh = dynamic_cast (i.elem_l_)) + bool found = false; + + for (vsize i = 0; i < heads_to_tie_.size (); i++) { - Note_req * m = dynamic_cast (i.req_l_); - if (!m) - return; - now_heads_.push (CHead_melodic_tuple (nh, m, now_mom()+ m->length_mom ())); + Grob *th = heads_to_tie_[i].head_; + Stream_event *right_ev = unsmob (h->get_property ("cause")); + Stream_event *left_ev = unsmob (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. + */ + SCM p1 = left_ev->get_property ("pitch"); + SCM p2 = right_ev->get_property ("pitch"); + if ((enharmonic + ? (unsmob (p1) && unsmob (p2) && + unsmob (p1)->tone_pitch () == unsmob (p2)->tone_pitch ()) + : ly_is_equal (p1, p2)) + && (!Tie_engraver::has_autosplit_end (left_ev))) + { + Spanner *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); + + found = true; + /* + 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 + ~ 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; + } + break; + } } + return found; } void -Tie_engraver::do_process_music () +Tie_engraver::acknowledge_note_head (Grob_info i) { - if (req_l_) + Grob *h = i.grob (); + + now_heads_.push_back (h); + + if (!tie_notehead (h, false)) + tie_notehead (h, true); + + if (ties_.size () && ! tie_column_) + tie_column_ = make_spanner ("TieColumn", ties_[0]->self_scm ()); + + if (tie_column_) + for (vsize i = 0; i < ties_.size (); i++) + Tie_column::add_tie (tie_column_, ties_[i]); +} + +void +Tie_engraver::start_translation_timestep () +{ + if (heads_to_tie_.size () && !to_boolean (get_property ("tieWaitForNote"))) { Moment now = now_mom (); - Link_array nharr; - - stopped_heads_.clear (); - while (past_notes_pq_.size () - && past_notes_pq_.front ().end_ == now) - stopped_heads_.push (past_notes_pq_.get ()); + 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::process_acknowledged () { - if (req_l_) + bool wait = to_boolean (get_property ("tieWaitForNote")); + if (ties_.size ()) { - 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 - = Musical_pitch::compare (now_heads_[i].req_l_->pitch_ , - stopped_heads_[j].req_l_->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 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)); - - Tie * p = new Tie (SCM_EOL); - p->set_head (LEFT, dynamic_cast (unsmob_element (gh_car (pair)))); - p->set_head (RIGHT, dynamic_cast (unsmob_element (gh_cdr (pair)))); - - tie_p_arr_.push (p); - announce_element (Score_element_info (p, req_l_)); - } - else for (SCM s = head_list; gh_pair_p (s); s = gh_cdr (s)) - { - Tie * p = new Tie (SCM_EOL); - p->set_head (LEFT, dynamic_cast (unsmob_element (gh_caar (s)))); - p->set_head (RIGHT, dynamic_cast (unsmob_element (gh_cdar (s)))); - - tie_p_arr_.push (p); - announce_element (Score_element_info (p, req_l_)); - } - - if (!tie_p_arr_.size ()) - { - req_l_->warning (_ ("No ties were created!")); - } - else if (tie_p_arr_.size () > 1 && !tie_column_p_) - { - tie_column_p_ = new Tie_column (SCM_EOL); - for (int i = tie_p_arr_.size (); i--; ) - tie_column_p_->add_tie (tie_p_arr_ [i]); - announce_element (Score_element_info (tie_column_p_, 0)); - } + if (!wait) + { + vector::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; } -} + vector new_heads_to_tie; -void -Tie_engraver::do_pre_move_processing () -{ - for (int i=0; i < now_heads_.size (); i++) + + for (vsize i = 0; i < now_heads_.size (); i++) { - past_notes_pq_.insert (now_heads_[i]); + Grob *head = now_heads_[i]; + Stream_event *left_ev + = unsmob (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 (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); + } } - now_heads_.clear (); - for (int i=0; i< tie_p_arr_.size (); i++) - { - typeset_element (tie_p_arr_[i]); - } - tie_p_arr_.clear (); - if (tie_column_p_) + if (!wait && new_heads_to_tie.size ()) { - typeset_element (tie_column_p_); - tie_column_p_ =0; + vector::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::do_post_move_processing () +Tie_engraver::stop_translation_timestep () { - SCM m = get_property ("automaticMelismata"); - if (to_boolean (m)) - { - set_melisma (false); - } - req_l_ = 0; - Moment now = now_mom (); - while (past_notes_pq_.size () && past_notes_pq_.front ().end_ < now) - past_notes_pq_.delmin (); + /* + Discard event only if it has been processed with at least one + appropriate note. + */ + if (event_processed_) + event_ = 0; + + event_processed_ = false; } -ADD_THIS_TRANSLATOR(Tie_engraver); +void +Tie_engraver::typeset_tie (Spanner *her) +{ + Grob *left_head = Tie::head (her, LEFT); + Grob *right_head = Tie::head (her, RIGHT); + if (!left_head || !right_head) + { + warning (_ ("lonely tie")); + if (!left_head) + left_head = right_head; + else + right_head = left_head; + } -CHead_melodic_tuple::CHead_melodic_tuple () -{ - head_l_ =0; - req_l_ =0; - end_ = 0; + her->set_bound (LEFT, left_head); + her->set_bound (RIGHT, right_head); } -CHead_melodic_tuple::CHead_melodic_tuple (Note_head *h, Melodic_req*m, Moment mom) +void +Tie_engraver::boot () { - head_l_ = h; - req_l_ = m; - end_ = mom; + ADD_LISTENER (Tie_engraver, tie); + ADD_ACKNOWLEDGER (Tie_engraver, note_head); } -int -CHead_melodic_tuple::pitch_compare (CHead_melodic_tuple const&h1, - CHead_melodic_tuple const &h2) -{ - return Melodic_req::compare (*h1.req_l_, *h2.req_l_); -} +ADD_TRANSLATOR (Tie_engraver, + /* doc */ + "Generate ties between note heads of equal pitch.", -int -CHead_melodic_tuple::time_compare (CHead_melodic_tuple const&h1, - CHead_melodic_tuple const &h2) -{ - return (h1.end_ - h2.end_ ).sign (); -} + /* create */ + "Tie " + "TieColumn ", + + /* read */ + "skipTypesetting " + "tieWaitForNote ", + + /* write */ + "tieMelismaBusy " + );