X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fdynamic-engraver.cc;h=18ebeda94301a50fa6bf962f50da52b6dd633a09;hb=01cdf1ac7e78505f63eae27894fe709ea50c0c96;hp=15b6561b1be3a1dc86fac8475b9319e5220e1c9b;hpb=c0270765c0df9cceda34a6584f7da324eed5fc2a;p=lilypond.git diff --git a/lily/dynamic-engraver.cc b/lily/dynamic-engraver.cc index 15b6561b1b..18ebeda943 100644 --- a/lily/dynamic-engraver.cc +++ b/lily/dynamic-engraver.cc @@ -3,342 +3,456 @@ source file of the GNU LilyPond music typesetter - (c) 1997--2000 Han-Wen Nienhuys + (c) 1997--2007 Han-Wen Nienhuys */ -#include "debug.hh" + +#include "axis-group-interface.hh" +#include "context.hh" #include "dimensions.hh" -#include "crescendo.hh" -#include "musical-request.hh" -#include "paper-column.hh" +#include "directional-element-interface.hh" +#include "engraver.hh" +#include "hairpin.hh" +#include "international.hh" +#include "interval.hh" #include "note-column.hh" -#include "item.hh" +#include "paper-column.hh" +#include "pointer-group-interface.hh" +#include "script-interface.hh" +#include "self-alignment-interface.hh" #include "side-position-interface.hh" -#include "engraver.hh" -#include "group-interface.hh" -#include "directional-element-interface.hh" -#include "translator-group.hh" -#include "axis-group-interface.hh" +#include "staff-symbol-referencer.hh" +#include "stream-event.hh" +#include "warn.hh" +#include "spanner.hh" +#include "text-interface.hh" +#include "translator.icc" /* TODO: - * direction of text-dynamic-request if not equal to direction of + * direction of text-dynamic-event if not equal to direction of line-spanner + + - TODO: this engraver is too complicated. We should split it into + the handling of the basic grobs and the linespanner + + - TODO: the line-spanner is not killed after the (de)crescs are + finished. */ /** print text & hairpin dynamics. - */ +*/ class Dynamic_engraver : public Engraver { - Item * script_p_; - Spanner * finished_cresc_p_; - Spanner * cresc_p_; + Item *script_; + Spanner *line_spanner_; + Spanner *cresc_; - Text_script_req* script_req_l_; - - Span_req * current_cresc_req_; - Drul_array accepted_spanreqs_drul_; + Spanner *finished_line_spanner_; + Spanner *finished_cresc_; - Spanner* line_spanner_; - Spanner* finished_line_spanner_; + Stream_event *script_ev_; + Stream_event *current_cresc_ev_; + + Drul_array accepted_spanevents_drul_; + + vector pending_columns_; + vector pending_elements_; - Link_array pending_column_arr_; - Link_array pending_element_arr_; - void typeset_all (); -public: - VIRTUAL_COPY_CONS(Translator); - Dynamic_engraver (); - + TRANSLATOR_DECLARATIONS (Dynamic_engraver); + DECLARE_ACKNOWLEDGER (note_column); + DECLARE_TRANSLATOR_LISTENER (absolute_dynamic); + DECLARE_TRANSLATOR_LISTENER (span_dynamic); + protected: virtual void finalize (); - virtual void acknowledge_grob (Grob_info); - virtual bool try_music (Music *req_l); - virtual void stop_translation_timestep (); - virtual void create_grobs (); - virtual void start_translation_timestep (); + void stop_translation_timestep (); + void process_music (); }; -ADD_THIS_TRANSLATOR (Dynamic_engraver); - - Dynamic_engraver::Dynamic_engraver () { - script_p_ = 0; - finished_cresc_p_ = 0; + script_ = 0; + finished_cresc_ = 0; line_spanner_ = 0; finished_line_spanner_ = 0; - current_cresc_req_ = 0; - cresc_p_ =0; + current_cresc_ev_ = 0; + cresc_ = 0; - script_req_l_ = 0; - accepted_spanreqs_drul_[START] = 0; - accepted_spanreqs_drul_[STOP] = 0; + script_ev_ = 0; + accepted_spanevents_drul_[START] = 0; + accepted_spanevents_drul_[STOP] = 0; } +IMPLEMENT_TRANSLATOR_LISTENER (Dynamic_engraver, absolute_dynamic); void -Dynamic_engraver::start_translation_timestep () +Dynamic_engraver::listen_absolute_dynamic (Stream_event *ev) { - script_req_l_ = 0; - accepted_spanreqs_drul_[START] = 0; - accepted_spanreqs_drul_[STOP] = 0; + /* + TODO: probably broken. + */ + ASSIGN_EVENT_ONCE (script_ev_, ev); } -bool -Dynamic_engraver::try_music (Music * m) +IMPLEMENT_TRANSLATOR_LISTENER (Dynamic_engraver, span_dynamic); +void +Dynamic_engraver::listen_span_dynamic (Stream_event *ev) { - if (dynamic_cast (m) - && m->get_mus_property ("text-type") == ly_symbol2scm ("dynamic")) - { - script_req_l_ = dynamic_cast (m); - return true; - } - else if (Span_req* s = dynamic_cast (m)) - { - String t = ly_scm2string (s->get_mus_property ("span-type")); - if (t== "abort") - { - accepted_spanreqs_drul_[LEFT] = 0; - accepted_spanreqs_drul_[RIGHT] = 0; - if (line_spanner_) - line_spanner_->suicide (); - line_spanner_ = 0; - if (cresc_p_) - cresc_p_->suicide (); - cresc_p_ = 0; - } - else if (t == "crescendo" - || t == "decrescendo") - { - accepted_spanreqs_drul_[s->get_span_dir()] = s; - return true; - } - } - return false; + Direction d = to_dir (ev->get_property ("span-direction")); + + if (d == START) + ASSIGN_EVENT_ONCE (accepted_spanevents_drul_[START], ev); + + /* Cancel any ongoing crescendo, either explicitly by \! or + implicitly by a new crescendo. Also avoid warning if cresc is + cancelled both implicitly and explicitly. */ + if ((d == STOP || current_cresc_ev_) && !accepted_spanevents_drul_[STOP]) + ASSIGN_EVENT_ONCE (accepted_spanevents_drul_[STOP], ev); } void -Dynamic_engraver::create_grobs () +Dynamic_engraver::process_music () { - if (accepted_spanreqs_drul_[START] || accepted_spanreqs_drul_[STOP] || script_req_l_) - + if (accepted_spanevents_drul_[START] || accepted_spanevents_drul_[STOP] || script_ev_) { if (!line_spanner_) { - line_spanner_ = new Spanner (get_property ("DynamicLineSpanner")); - - Side_position::set_axis (line_spanner_, Y_AXIS); - Axis_group_interface::set_interface (line_spanner_); - Axis_group_interface::set_axes (line_spanner_, Y_AXIS, Y_AXIS); - - Music * rq = accepted_spanreqs_drul_[START]; - if (script_req_l_) - rq = script_req_l_ ; - announce_grob (line_spanner_, rq); - - + Stream_event *rq = accepted_spanevents_drul_[START]; + line_spanner_ = make_spanner ("DynamicLineSpanner", rq ? rq->self_scm () : SCM_EOL); + if (script_ev_) + rq = script_ev_; } } /* - finish side position alignment if the (de)cresc ends here, and - there are no new dynamics. - - */ - else if (accepted_spanreqs_drul_[STOP] - && !accepted_spanreqs_drul_[START] && !script_req_l_) - { - finished_line_spanner_ = line_spanner_; - line_spanner_ = 0; - } - - /* - todo: resurrect dynamic{direction, padding,minimumspace} - */ - /* - During a (de)crescendo, pending request will not be cleared, - and a line-spanner will always be created, as \< \! are already - two requests. - - Maybe always creating a line-spanner for a (de)crescendo (see - below) is not a good idea: - - a\< b\p \!c + During a (de)crescendo, pending event will not be cleared, + and a line-spanner will always be created, as \< \! are already + two events. - the \p will be centred on the line-spanner, and thus clash - with the hairpin. When axis-group code is in place, the \p - should move below the hairpin, which is probably better? - - Urg, but line-spanner must always have at least same duration - as (de)crecsendo, b.o. line-breaking. - */ - - + Note: line-spanner must always have at least same duration + as (de)crecsendo, b.o. line-breaking. + */ /* maybe we should leave dynamic texts to the text-engraver and simply acknowledge them? */ - if (script_req_l_) + if (script_ev_) { - script_p_ = new Item (get_property ("DynamicText")); - script_p_->set_grob_property ("text", - script_req_l_->get_mus_property ("text")); - if (Direction d = script_req_l_->get_direction ()) - Directional_element_interface::set (line_spanner_, d); + script_ = make_item ("DynamicText", script_ev_->self_scm ()); + script_->set_property ("text", + script_ev_->get_property ("text")); - Axis_group_interface::add_element (line_spanner_, script_p_); + if (Direction d = to_dir (script_ev_->get_property ("direction"))) + set_grob_direction (line_spanner_, d); + else if (Direction d = to_dir (line_spanner_->get_property ("direction"))) + set_grob_direction (script_, d); - announce_grob (script_p_, script_req_l_); + Axis_group_interface::add_element (line_spanner_, script_); } - if (accepted_spanreqs_drul_[STOP]) + Stream_event *stop_ev = accepted_spanevents_drul_ [STOP] + ? accepted_spanevents_drul_[STOP] : script_ev_; + + if (accepted_spanevents_drul_[STOP] || script_ev_) { - if (!cresc_p_) + /* + finish side position alignment if the (de)cresc ends here, and + there are no new dynamics. + */ + + if (cresc_) { - accepted_spanreqs_drul_[STOP]->origin ()->warning - (_ ("can't find start of (de)crescendo")); + assert (!finished_cresc_ && cresc_); + + if (script_) + { + cresc_->set_bound (RIGHT, script_); + add_bound_item (line_spanner_, script_); + } + + finished_cresc_ = cresc_; + cresc_ = 0; + current_cresc_ev_ = 0; } - else + else if (accepted_spanevents_drul_[STOP]) { - assert (!finished_cresc_p_); - Grob* cc = unsmob_grob (get_property ("currentMusicalColumn")); - - cresc_p_->set_bound (RIGHT, cc); - - finished_cresc_p_ = cresc_p_; - cresc_p_ = 0; - current_cresc_req_ = 0; + accepted_spanevents_drul_[STOP]->origin ()->warning (_ ("cannot find start of (de)crescendo")); + stop_ev = 0; } } - if (accepted_spanreqs_drul_[START]) + if (accepted_spanevents_drul_[START]) { - if (current_cresc_req_) + if (current_cresc_ev_) { - accepted_spanreqs_drul_[START]->origin ()->warning - (current_cresc_req_->get_span_dir() == 1 - ? _ ("already have a crescendo") - : _ ("already have a decrescendo")); + string msg = _ ("already have a decrescendo"); + if (current_cresc_ev_->in_event_class ("crescendo-event")) + msg = _ ("already have a crescendo"); + + accepted_spanevents_drul_[START]->origin ()->warning (msg); + current_cresc_ev_->origin ()->warning (_ ("cresc starts here")); } else { - current_cresc_req_ = accepted_spanreqs_drul_[START]; + current_cresc_ev_ = accepted_spanevents_drul_[START]; + + if (Direction d = to_dir (current_cresc_ev_->get_property ("direction"))) + set_grob_direction (line_spanner_, d); /* TODO: Use symbols. - */ - - String start_type = ly_scm2string (accepted_spanreqs_drul_[START]->get_mus_property ("span-type")); + */ + + SCM start_sym = current_cresc_ev_->get_property ("class"); + string start_type; + + if (start_sym == ly_symbol2scm ("decrescendo-event")) + start_type = "decrescendo"; + else if (start_sym == ly_symbol2scm ("crescendo-event")) + start_type = "crescendo"; + else + { + programming_error ("unknown dynamic spanner type"); + return; + } /* - ugh. Use push/pop? + UGH. TODO: should read from original event, so appearance + may be altered with \tweak. */ - SCM s = get_property ((start_type + "Spanner").ch_C()); - if (!gh_symbol_p (s) || s == ly_symbol2scm ("hairpin")) + SCM s = get_property ((start_type + "Spanner").c_str ()); + if (!scm_is_symbol (s) || s == ly_symbol2scm ("hairpin")) { - cresc_p_ = new Spanner (get_property ("Crescendo")); - cresc_p_->set_grob_property ("grow-direction", - gh_int2scm ((start_type == "crescendo") - ? BIGGER : SMALLER)); - + cresc_ = make_spanner ("Hairpin", accepted_spanevents_drul_[START]->self_scm ()); + if (finished_cresc_) + { + Pointer_group_interface::add_grob (finished_cresc_, + ly_symbol2scm ("adjacent-hairpins"), + cresc_); + + Pointer_group_interface::add_grob (cresc_, + ly_symbol2scm ("adjacent-hairpins"), + finished_cresc_); + } } + /* This is a convenient (and legacy) interface to TextSpanners for use in (de)crescendi. Hmm. - */ + */ else { - cresc_p_ = new Spanner (get_property ("TextSpanner")); - cresc_p_->set_grob_property ("type", s); - daddy_trans_l_->set_property (start_type - + "Spanner", SCM_UNDEFINED); - s = get_property ((start_type + "Text").ch_C()); - if (gh_string_p (s)) + cresc_ = make_spanner ("DynamicTextSpanner", accepted_spanevents_drul_[START]->self_scm ()); + cresc_->set_property ("style", s); + context ()->set_property ((start_type + + "Spanner").c_str (), SCM_EOL); + s = get_property ((start_type + "Text").c_str ()); + if (Text_interface::is_markup (s)) + { + cresc_->set_property ("text", s); + context ()->set_property ((start_type + "Text").c_str (), + SCM_EOL); + } + + if (script_) { - cresc_p_->set_grob_property ("edge-text", - gh_cons (s, ly_str02scm (""))); - daddy_trans_l_->set_property (start_type + "Text", - SCM_UNDEFINED); + set_nested_property (cresc_, + scm_list_3 (ly_symbol2scm ("bound-details"), + ly_symbol2scm ("left"), + ly_symbol2scm ("attach-dir") + ), + scm_from_int (RIGHT)); } } - cresc_p_->set_bound (LEFT, script_p_ - ? script_p_ - : unsmob_grob (get_property ("currentMusicalColumn"))); - - Axis_group_interface::add_element (line_spanner_, cresc_p_); - announce_grob (cresc_p_, accepted_spanreqs_drul_[START]); + + if (script_) + { + cresc_->set_bound (LEFT, script_); + add_bound_item (line_spanner_, cresc_->get_bound (LEFT)); + } + + Axis_group_interface::add_element (line_spanner_, cresc_); } } - script_req_l_ = 0; - accepted_spanreqs_drul_[START] = 0; - accepted_spanreqs_drul_[STOP] = 0; } void Dynamic_engraver::stop_translation_timestep () { + if (!current_cresc_ev_ && line_spanner_) + { + assert (!finished_line_spanner_); + finished_line_spanner_ = line_spanner_; + line_spanner_ = 0; + } + typeset_all (); + + if (cresc_ && !cresc_->get_bound (LEFT)) + { + cresc_->set_bound (LEFT, unsmob_grob (get_property ("currentMusicalColumn"))); + add_bound_item (line_spanner_, cresc_->get_bound (LEFT)); + } + + script_ev_ = 0; + accepted_spanevents_drul_[START] = 0; + accepted_spanevents_drul_[STOP] = 0; } void Dynamic_engraver::finalize () { typeset_all (); + + if (line_spanner_ + && !line_spanner_->is_live ()) + line_spanner_ = 0; if (line_spanner_) { finished_line_spanner_ = line_spanner_; typeset_all (); } - if (cresc_p_) + if (cresc_ + && !cresc_->is_live ()) + cresc_ = 0; + if (cresc_) { - current_cresc_req_->origin ()->warning (_ ("unterminated (de)crescendo")); - cresc_p_->suicide (); - cresc_p_ = 0; + current_cresc_ev_->origin ()->warning (_ ("unterminated (de)crescendo")); + cresc_->suicide (); + cresc_ = 0; } } void Dynamic_engraver::typeset_all () -{ - if (finished_cresc_p_) - { - finished_cresc_p_->set_bound (RIGHT, script_p_ - ? script_p_ - : unsmob_grob (get_property ("currentMusicalColumn"))); - - typeset_grob (finished_cresc_p_); - finished_cresc_p_ =0; - } - - if (script_p_) +{ + if (finished_cresc_) { - typeset_grob (script_p_); - script_p_ = 0; + bool use_bar = to_boolean (get_property ("hairpinToBarline")) + && scm_is_string (get_property ("whichBar")) + && !script_ev_; + + + if (!finished_cresc_->get_bound (RIGHT) + || use_bar) + { + + Grob *column_bound = 0; + if (use_bar) + { + column_bound = unsmob_grob (get_property ("breakableSeparationItem")); + } + + if (!column_bound) + column_bound = unsmob_grob (use_bar + ? get_property ("currentCommandColumn") + : get_property ("currentMusicalColumn")); + + finished_cresc_->set_bound (RIGHT, script_ + ? script_ + : column_bound); + + if (finished_line_spanner_) + add_bound_item (finished_line_spanner_, + finished_cresc_->get_bound (RIGHT)); + } + finished_cresc_ = 0; } + + script_ = 0; if (finished_line_spanner_) { - Side_position::add_staff_support (finished_line_spanner_); - extend_spanner_over_elements (finished_line_spanner_); - typeset_grob (finished_line_spanner_); + /* + We used to have + + extend-spanner-over-elements (finished_line_spanner_); + + but this is rather kludgy, since finished_line_spanner_ + typically has a staff-symbol field set , extending it over the + entire staff. + + */ + + Grob *l = finished_line_spanner_->get_bound (LEFT); + Grob *r = finished_line_spanner_->get_bound (RIGHT); + if (!r && l) + finished_line_spanner_->set_bound (RIGHT, l); + else if (!l && r) + finished_line_spanner_->set_bound (LEFT, r); + else if (!r && !l) + { + /* + This is a isolated dynamic apparently, and does not even have + any interesting support item. + */ + Grob *cc = unsmob_grob (get_property ("currentMusicalColumn")); + Item *ci = dynamic_cast (cc); + finished_line_spanner_->set_bound (RIGHT, ci); + finished_line_spanner_->set_bound (LEFT, ci); + } + finished_line_spanner_ = 0; } } void -Dynamic_engraver::acknowledge_grob (Grob_info i) +Dynamic_engraver::acknowledge_note_column (Grob_info info) { - if (Note_column::has_interface (i.elem_l_)) + if (!line_spanner_) + return; + + if (line_spanner_ + /* Don't refill killed spanner */ + && line_spanner_->is_live ()) + { + Side_position_interface::add_support (line_spanner_, info.grob ()); + add_bound_item (line_spanner_, dynamic_cast (info.grob ())); + } + + if (script_ && !script_->get_parent (X_AXIS)) { - if (line_spanner_) + extract_grob_set (info.grob (), "note-heads", heads); + if (heads.size ()) { - Side_position::add_support (line_spanner_,i.elem_l_); - add_bound_item (line_spanner_,dynamic_cast(i.elem_l_)); + Grob *head = heads[0]; + script_->set_parent (head, X_AXIS); + Self_alignment_interface::set_center_parent (script_, X_AXIS); } } + + if (cresc_) + { + if (!cresc_->get_bound (LEFT)) + { + cresc_->set_bound (LEFT, info.grob ()); + add_bound_item (line_spanner_, cresc_->get_bound (LEFT)); + } + } + + if (finished_cresc_ && !finished_cresc_->get_bound (RIGHT)) + finished_cresc_->set_bound (RIGHT, info.grob ()); } + +ADD_ACKNOWLEDGER (Dynamic_engraver, note_column); + +ADD_TRANSLATOR (Dynamic_engraver, + /* doc */ + "This engraver creates hairpins, dynamic texts, and their vertical\n" + "alignments. The symbols are collected onto a DynamicLineSpanner grob\n" + "which takes care of vertical positioning. ", + + /* create */ + "DynamicLineSpanner " + "DynamicText " + "Hairpin " + "TextSpanner ", + + /* read */ "", + /* write */ "");