X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Ftie-engraver.cc;h=40da0d3e8410663881acd57eb0d191a87626ee35;hb=1ec2219310abbe4099370ecf8da03a40fce6e379;hp=72cb2e06d43a652710e36a573b7e843324952801;hpb=a0b072ed070ca6abb36a11e015073b117103e35d;p=lilypond.git diff --git a/lily/tie-engraver.cc b/lily/tie-engraver.cc index 72cb2e06d4..40da0d3e84 100644 --- a/lily/tie-engraver.cc +++ b/lily/tie-engraver.cc @@ -1,286 +1,378 @@ -/* - tie-engraver.cc -- implement Tie_engraver - - source file of the GNU LilyPond music typesetter - - (c) 1998--2002 Han-Wen Nienhuys - - */ - -#include "command-request.hh" -#include "musical-request.hh" -#include "tie.hh" -#include "translator-group.hh" -#include "spanner.hh" -#include "tie-column.hh" +/* + This file is part of LilyPond, the GNU music typesetter. + + Copyright (C) 1998--2012 Han-Wen Nienhuys + + 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 "grob-pitch-tuple.hh" -#include "warn.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: Remove the dependency on musical info. We should tie on the - basis of position and duration-log of the heads (not of the reqs). - + basis of position and duration-log of the heads (not of the events). */ + +struct Head_event_tuple +{ + Grob *head_; + Moment end_moment_; + SCM tie_definition_; + Stream_event *tie_stream_event_; + Stream_event *tie_event_; + // 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_definition_ = SCM_EOL; + tie_event_ = 0; + tie_stream_event_ = 0; + tie_from_chord_created = false; + } +}; + class Tie_engraver : public Engraver { - Moment end_mom_; - Moment next_end_mom_; - - Tie_req *req_l_; - Link_array now_heads_; - Link_array stopped_heads_; - Link_array tie_p_arr_; - - Spanner * tie_column_p_; - - void set_melisma (bool); - + Stream_event *event_; + vector now_heads_; + vector heads_to_tie_; + vector 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 process_acknowledged_grobs (); - void typeset_tie (Grob*); + void stop_translation_timestep (); + virtual void derived_mark () const; + 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: - TRANSLATOR_DECLARATIONS(Tie_engraver); + TRANSLATOR_DECLARATIONS (Tie_engraver); }; - +void +Tie_engraver::derived_mark () const +{ + Engraver::derived_mark (); + for (vsize i = 0; i < heads_to_tie_.size (); i++) + scm_gc_mark (heads_to_tie_[i].tie_definition_); +} Tie_engraver::Tie_engraver () { - req_l_ = 0; - tie_column_p_ = 0; + event_ = 0; + tie_column_ = 0; +} + +IMPLEMENT_TRANSLATOR_LISTENER (Tie_engraver, tie); +void +Tie_engraver::listen_tie (Stream_event *ev) +{ + ASSIGN_EVENT_ONCE (event_, ev); } +void Tie_engraver::report_unterminated_tie (Head_event_tuple const &tie_start) +{ + // 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) + tie_start.head_->warning (_ ("unterminated tie")); +} +/* + Determines whether the end of an event was created by + a split in Completion_heads_engraver or by user input. +*/ bool -Tie_engraver::try_music (Music *m) +Tie_engraver::has_autosplit_end (Stream_event *event) { - if (Tie_req * c = dynamic_cast (m)) - { - /* 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; - } + 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 (Note_head::has_interface (i.grob_l_)) + Grob *h = i.grob (); + + now_heads_.push_back (h); + for (vsize i = heads_to_tie_.size (); i--;) { - now_heads_.push (i.grob_l_); + 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 = new Spanner (heads_to_tie_[i].tie_definition_); + Moment end = heads_to_tie_[i].end_moment_; + + SCM cause = heads_to_tie_[i].tie_event_ + ? heads_to_tie_[i].tie_event_->self_scm () + : heads_to_tie_[i].tie_stream_event_->self_scm (); + + announce_grob (p, cause); + Tie::set_head (p, LEFT, th); + Tie::set_head (p, RIGHT, h); + + if (is_direction (unsmob_stream_event (cause)->get_property ("direction"))) + { + Direction d = to_dir (unsmob_stream_event (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 + ~ 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; + } + } } -} -int -head_pitch_compare (Grob *const&a,Grob *const&b) -{ - Music *m1 =unsmob_music (a->get_grob_property ("cause")); - Music *m2 =unsmob_music (b->get_grob_property ("cause")); + if (ties_.size () && ! tie_column_) + tie_column_ = make_spanner ("TieColumn", ties_[0]->self_scm ()); - return Pitch::compare (* unsmob_pitch (m1->get_mus_property ("pitch")), - * unsmob_pitch (m2->get_mus_property ("pitch"))); + if (tie_column_) + for (vsize i = ties_.size (); i--;) + Tie_column::add_tie (tie_column_, ties_[i]); } void -Tie_engraver::process_acknowledged_grobs () +Tie_engraver::start_translation_timestep () { - if (req_l_) + if (heads_to_tie_.size () && !to_boolean (get_property ("tieWaitForNote"))) { - now_heads_.sort (&head_pitch_compare); - /* - We could sort stopped_heads_ as well (and use a linear alg. in - stead of nested loop), but we'd have to use a stable sorting - algorithm, since the ordering of the stopped heads (of the - same pitch) is relevant. - */ - - SCM head_list = SCM_EOL; - - for (int i = now_heads_.size(); i--;) - { - for (int j = stopped_heads_.size(); j--;) - { - int comp - = head_pitch_compare (now_heads_[i], stopped_heads_[j]); - - if (!comp) - { - head_list = gh_cons (gh_cons (stopped_heads_[j]->self_scm (), - now_heads_[i]->self_scm ()), - head_list); - - now_heads_.del (i); - stopped_heads_.del (j); - break ; - } - } - } - - 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 = scm_list_ref (head_list, gh_int2scm (i/2)); - - Spanner * p = new Spanner (basic); - - Tie::set_interface (p); // cannot remove. - Tie::set_head (p,LEFT, dynamic_cast (unsmob_grob (ly_car (pair)))); - Tie::set_head (p,RIGHT, dynamic_cast (unsmob_grob (ly_cdr (pair)))); - - tie_p_arr_.push (p); - announce_grob(p, req_l_->self_scm()); - } - else for (SCM s = head_list; gh_pair_p (s); s = ly_cdr (s)) - { - Grob * p = new Spanner (basic); - Tie::set_interface (p); // cannot remove yet! - - Tie::set_head (p, LEFT, dynamic_cast (unsmob_grob (ly_caar (s)))); - Tie::set_head (p, RIGHT, dynamic_cast (unsmob_grob (ly_cdar (s)))); - - tie_p_arr_.push (p); - announce_grob(p, req_l_->self_scm()); - } - - if (tie_p_arr_.size () > 1 && !tie_column_p_) - { - tie_column_p_ = new Spanner (get_property ("TieColumn")); - - for (int i = tie_p_arr_.size (); i--;) - Tie_column::add_tie (tie_column_p_,tie_p_arr_ [i]); - announce_grob(tie_column_p_, SCM_EOL); - } + 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 () { - req_l_ = 0; + bool wait = to_boolean (get_property ("tieWaitForNote")); + if (ties_.size ()) + { + 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; + } - now_heads_.clear (); + vector new_heads_to_tie; /* - we don't warn for no ties, since this happens naturally when you - use skipTypesetting. */ - - for (int i=0; i< tie_p_arr_.size (); i++) - { - typeset_tie (tie_p_arr_[i]); - } - tie_p_arr_.clear (); - if (tie_column_p_) + Whether tie event has been processed and can be deleted or should + be kept for later portions of a split note. + */ + bool event_processed = false; + + for (vsize i = 0; i < now_heads_.size (); i++) { - typeset_grob (tie_column_p_); - tie_column_p_ =0; + 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; + + SCM start_definition + = updated_grob_properties (context (), ly_symbol2scm ("Tie")); + + event_tup.head_ = head; + event_tup.tie_definition_ = start_definition; + event_tup.tie_event_ = tie_event; + event_tup.tie_stream_event_ = tie_stream_event; + + 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); + } } -} -void -Tie_engraver::typeset_tie (Grob *her) -{ - if (! (Tie::head (her,LEFT) && Tie::head (her,RIGHT))) - warning (_ ("lonely tie")); + if (!wait && new_heads_to_tie.size ()) + { + vector::iterator it = heads_to_tie_.begin (); + for (; it < heads_to_tie_.end (); it++) + report_unterminated_tie (*it); + heads_to_tie_.clear (); + } - Direction d = LEFT; - Drul_array 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); + // 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]); - 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 ()); + /* + Discard event only if it has been processed with at least one + appropriate note. + */ + if (event_processed) + event_ = 0; - typeset_grob (her); + now_heads_.clear (); } void -Tie_engraver::start_translation_timestep () +Tie_engraver::typeset_tie (Grob *her) { - SCM m = get_property ("automaticMelismata"); - if (to_boolean (m)) - { - set_melisma (false); - } + if (! (Tie::head (her, LEFT) && Tie::head (her, RIGHT))) + warning (_ ("lonely tie")); - SCM grobs = get_property ("busyGrobs"); - Moment now = now_mom(); - stopped_heads_.clear (); - - for (; gh_pair_p (grobs); grobs = gh_cdr (grobs)) + Drul_array new_head_drul; + new_head_drul[LEFT] = Tie::head (her, LEFT); + new_head_drul[RIGHT] = Tie::head (her, RIGHT); + for (LEFT_and_RIGHT (d)) { - Grob * grob = unsmob_grob (gh_cdar (grobs)); - Moment end =*unsmob_moment (gh_caar (grobs)); - - /* - This is slightly ugh: we are now confunding the frontend - (iterators) and the backend (note heads) */ - if (end > now) - break; - else if (end == now - && Note_head::has_interface (grob)) - stopped_heads_.push (grob); + if (!Tie::head (her, d)) + new_head_drul[d] = Tie::head (her, (Direction) - d); } + Spanner *sp = dynamic_cast (her); + sp->set_bound (LEFT, new_head_drul[LEFT]); + sp->set_bound (RIGHT, new_head_drul[RIGHT]); +} - /* - - The list starts with entries that start earlier. By going through - it, we reverse the order, where as we'd like to use the `last' - heads first. - - This makes a difference for grace notes. If we have - - c4 \grace c8 ~ c4 - - Then busyGrobs will have ((1/4 . gc8) (1/4 . c4)). +ADD_ACKNOWLEDGER (Tie_engraver, note_head); +ADD_TRANSLATOR (Tie_engraver, + /* doc */ + "Generate ties between note heads of equal pitch.", - We want stopped_heads_ to contain (c4 gc8), because we start with - it at the top. - */ - stopped_heads_.reverse(); -} + /* create */ + "Tie " + "TieColumn ", + /* read */ + "tieWaitForNote ", -ENTER_DESCRIPTION(Tie_engraver, -/* descr */ "Generate ties between noteheads of equal pitch.", -/* creats*/ "Tie TieColumn", -/* acks */ "rhythmic-head-interface", -/* reads */ "sparseTies tieMelismaBusy", -/* write */ ""); + /* write */ + "tieMelismaBusy " + );