X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fambitus-engraver.cc;h=221c1e8881ee950c70da5af60b29f202236d30ef;hb=d000ba690e920b568ec8272d12de46f92aa20f68;hp=85dbbd46b87f3b396dd01c5b350651ed946bd942;hpb=0a0f8863aa70cf42b69ca374cbb12c061ccd0547;p=lilypond.git diff --git a/lily/ambitus-engraver.cc b/lily/ambitus-engraver.cc index 85dbbd46b8..221c1e8881 100644 --- a/lily/ambitus-engraver.cc +++ b/lily/ambitus-engraver.cc @@ -1,187 +1,238 @@ /* - ambitus-engraver.cc -- implement Ambitus_engraver + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 2002--2011 Juergen Reuter - (C) 2002 Juergen Reuter + Han-Wen Nienhuys . */ #include "engraver.hh" + +#include "accidental-placement.hh" +#include "axis-group-interface.hh" #include "item.hh" #include "note-head.hh" +#include "pitch-interval.hh" +#include "pointer-group-interface.hh" +#include "protected-scm.hh" +#include "side-position-interface.hh" +#include "separation-item.hh" #include "staff-symbol-referencer.hh" -#include "musical-request.hh" -#include "pitch.hh" +#include "stream-event.hh" + +#include "translator.icc" -/* - * This class implements an engraver for ambitus grobs. - * - * TODO: There are quite some conceptional issues left open: - * - * - Many publishers put ambitus _before_ the first occurrence of a - * clef. Hence, formally the pitches are undefined in this case. Of - * course, one could always silently assume that ambitus pitches refer - * to the first occurrence of a clef. Or should we, by default, put - * the ambitus always after the first clef, if any? - * - * - Enharmonically equal pitches: Assume piece contains once a "gis", - * another time an "aes" as highest pitch. Which one should be - * selected for the ambitus grob? The "aes", because it is - * musically/notationally "higher" than "gis"? Or "gis", because (if - * using pure temperament) it has a slightly higher frequency? Or - * that pitch that come closer to the key signature? But there may be - * key signature changes in the piece... - * - * - Multiple voices in single staff: Assume a vocal piece of music, - * where the soprano voice and the alto voice are put into the same - * staff (this is generally a bad idea, but unfortunately common - * practice). Then, there probably should be two ambitus grobs, one - * for each voice. But how can you see which ambitus grob refers to - * which voice? Most probably you can guess it from the fact that the - * ambitus of the alto voice typically lies in a lower range than that - * of the soprano voice, but this is just a heuristic rather than a - * generally valid rule. In the case of only two voices, using stems - * in the ambitus grob might help, but probably looks quite ugly. - * - * - If a piece consists of several loosely coupled sections, should - * there be multiple ambitus grobs allowed, one for each section? - * Then there probably should be some "\ambitus" request added to - * mudela, stating where an ambitus grob should be placed. This - * ambitus grob should then represent the ambitus in the range of time - * between this "\ambitus" request and the next one (or the end of the - * piece, if there is no more such request). To be compliant with the - * current implementation, we might implicitly assume an "\ambitus" - * request at the beginning of the piece, but then the question where - * to put this first ambitus grob (before/after the clef?) becomes - * even more urgent. - * - * - Incipits of transcribed music may need special treatment for - * ambitus, since, for readability, the ambitus most probably should - * not refer to the ancient clefs of the incipit, but rather to the - * clefs used in the transcribed parts. - */ class Ambitus_engraver : public Engraver { public: -TRANSLATOR_DECLARATIONS(Ambitus_engraver); - virtual void acknowledge_grob (Grob_info); - virtual void stop_translation_timestep (); + TRANSLATOR_DECLARATIONS (Ambitus_engraver); +protected: + DECLARE_ACKNOWLEDGER (note_head); + + void process_music (); + void stop_translation_timestep (); virtual void finalize (); + virtual void derived_mark () const; private: void create_ambitus (); - Item *ambitus_p_; - int isActive; - Pitch pitch_min, pitch_max; + Item *ambitus_; + Item *group_; + Drul_array heads_; + Drul_array accidentals_; + Drul_array causes_; + Pitch_interval pitch_interval_; + bool is_typeset_; + int start_c0_; + SCM start_key_sig_; }; -Ambitus_engraver::Ambitus_engraver () +void +Ambitus_engraver::derived_mark () const { - ambitus_p_ = 0; isActive = 0; - - // (pitch_min > pitch_max) means that pitches are not yet - // initialized - pitch_min = Pitch (0, 0, +1); - pitch_max = Pitch (0, 0, -1); + scm_gc_mark (start_key_sig_); } void -Ambitus_engraver::stop_translation_timestep () +Ambitus_engraver::create_ambitus () { - if (!ambitus_p_) { - // Create ambitus not before stopping timestep. centralCPosition - // will then be the same as that for the first timestep. - // - // TODO: is this really a good idea? At least, creating the - // ambitus in start_translation_timestep is a *bad* idea, since we - // may then oversee a clef that is defined in a staff context if - // we are in a voice context; centralCPosition would then be - // assumed to be 0. - create_ambitus (); - } - if (ambitus_p_ && isActive) + ambitus_ = make_item ("AmbitusLine", SCM_EOL); + group_ = make_item ("Ambitus", SCM_EOL); + Direction d = DOWN; + do { - SCM key_signature = get_property ("keySignature"); - ambitus_p_->set_grob_property ("keySignature", key_signature); - typeset_grob (ambitus_p_); - isActive = 0; + heads_[d] = make_item ("AmbitusNoteHead", SCM_EOL); + accidentals_[d] = make_item ("AmbitusAccidental", SCM_EOL); + accidentals_[d]->set_parent (heads_[d], Y_AXIS); + heads_[d]->set_object ("accidental-grob", + accidentals_[d]->self_scm ()); + Axis_group_interface::add_element (group_, heads_[d]); + Axis_group_interface::add_element (group_, accidentals_[d]); } + while (flip (&d) != DOWN); + + ambitus_->set_parent (heads_[DOWN], X_AXIS); + Axis_group_interface::add_element (group_, ambitus_); + + is_typeset_ = false; +} + +Ambitus_engraver::Ambitus_engraver () +{ + ambitus_ = 0; + heads_.set (0, 0); + accidentals_.set (0, 0); + group_ = 0; + is_typeset_ = false; + start_key_sig_ = SCM_EOL; } void -Ambitus_engraver::acknowledge_grob (Grob_info info) +Ambitus_engraver::process_music () { - if (!ambitus_p_) { + /* + * Ensure that ambitus is created in the very first timestep + */ + if (!ambitus_) create_ambitus (); - } - if (!ambitus_p_) - return; - Item *item = dynamic_cast (info.grob_l_); - if (item) +} + +void +Ambitus_engraver::stop_translation_timestep () +{ + if (ambitus_ && !is_typeset_) { - if (Note_head::has_interface (info.grob_l_)) - { - Note_req *nr = dynamic_cast (info.music_cause ()); - if (nr) - { - Pitch pitch = *unsmob_pitch (nr->get_mus_property ("pitch")); - if (Pitch::compare (pitch_min, pitch_max) > 0) // already init'd? - { - // not yet init'd; use current pitch to init min/max - pitch_min = pitch; - pitch_max = pitch; - } - else if (Pitch::compare (pitch, pitch_max) > 0) // new max? - { - pitch_max = pitch; - } - else if (Pitch::compare (pitch, pitch_min) < 0) // new min? - { - pitch_min = pitch; - } - } - } + /* + * Evaluate middleCPosition not until now, since otherwise we + * may then oversee a clef that is defined in a staff context if + * we are in a voice context; middleCPosition would then be + * assumed to be 0. + */ + start_c0_ = robust_scm2int (get_property ("middleCPosition"), 0); + start_key_sig_ = get_property ("keySignature"); + + is_typeset_ = true; } } void -Ambitus_engraver::create_ambitus () +Ambitus_engraver::acknowledge_note_head (Grob_info info) { - SCM basicProperties = get_property ("Ambitus"); - SCM c0 = get_property ("centralCPosition"); - ambitus_p_ = new Item (basicProperties); isActive = 1; - ambitus_p_->set_grob_property ("centralCPosition", c0); - announce_grob (ambitus_p_, SCM_EOL); + Stream_event *nr = info.event_cause (); + if (nr && nr->in_event_class ("note-event")) + { + SCM p = nr->get_property ("pitch"); + /* + If the engraver is added to a percussion context, + filter out unpitched note heads. + */ + if (!unsmob_pitch (p)) + return; + Pitch pitch = *unsmob_pitch (p); + Drul_array expands = pitch_interval_.add_point (pitch); + if (expands[UP]) + causes_[UP] = nr; + if (expands[DOWN]) + causes_[DOWN] = nr; + } } void Ambitus_engraver::finalize () { - if (ambitus_p_) + if (ambitus_ && !pitch_interval_.is_empty ()) { - if (Pitch::compare (pitch_min, pitch_max) <= 0) + Grob *accidental_placement = + make_item ("AccidentalPlacement", accidentals_[DOWN]->self_scm ()); + + Direction d = DOWN; + do { - ambitus_p_->set_grob_property ("pitch-min", - pitch_min.smobbed_copy ()); - ambitus_p_->set_grob_property ("pitch-max", - pitch_max.smobbed_copy ()); + Pitch p = pitch_interval_[d]; + heads_[d]->set_property ("cause", causes_[d]->self_scm()); + heads_[d]->set_property ("staff-position", + scm_from_int (start_c0_ + p.steps ())); + + SCM handle = scm_assoc (scm_cons (scm_from_int (p.get_octave ()), + scm_from_int (p.get_notename ())), + start_key_sig_); + + if (handle == SCM_BOOL_F) + handle = scm_assoc (scm_from_int (p.get_notename ()), + start_key_sig_); + + Rational sig_alter = (handle != SCM_BOOL_F) + ? robust_scm2rational (scm_cdr (handle), Rational (0)) + : Rational (0); + + const Pitch other = pitch_interval_[-d]; + + if (sig_alter == p.get_alteration () + && !((p.steps () == other.steps ()) + && (p.get_alteration () != other.get_alteration ()))) + { + accidentals_[d]->suicide (); + heads_[d]->set_object ("accidental-grob", SCM_EOL); + } + else + accidentals_[d]-> + set_property ("alteration", + ly_rational2scm (p.get_alteration ())); + Separation_item::add_conditional_item (heads_[d], + accidental_placement); + Accidental_placement::add_accidental (accidental_placement, + accidentals_[d]); + Pointer_group_interface::add_grob (ambitus_, + ly_symbol2scm ("note-heads"), + heads_[d]); } - else // have not seen any pitch, so forget about the ambitus + while (flip (&d) != DOWN); + + Axis_group_interface::add_element (group_, accidental_placement); + } + else + { + Direction d = DOWN; + do { - // Do not print a warning on empty ambitus range, since this - // most probably arises from an empty voice, such as shared - // global timesig/clef definitions. -#if 0 - ambitus_p_->warning("empty ambitus range [ignored]"); -#endif - ambitus_p_->suicide(); + accidentals_[d]->suicide (); + heads_[d]->suicide (); } + while (flip (&d) != DOWN); + + ambitus_->suicide (); } } -ENTER_DESCRIPTION(Ambitus_engraver, -/* descr */ "", -/* creats*/ "Ambitus", -/* acks */ "note-head-interface", -/* reads */ "", -/* write */ ""); +ADD_ACKNOWLEDGER (Ambitus_engraver, note_head); +ADD_TRANSLATOR (Ambitus_engraver, + /* doc */ + "Create an ambitus.", + + /* create */ + "AccidentalPlacement " + "Ambitus " + "AmbitusAccidental " + "AmbitusLine " + "AmbitusNoteHead ", + + /* read */ + "keySignature " + "middleCPosition ", + + /* write */ + "" + );