X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fdynamic-engraver.cc;h=ee6518118f89c05697333deb102981cfe7e4122d;hb=2ab74abbadbb2aed67c3ae6d42272db92988f8b9;hp=967dcc188693e0561fddb4f04d501996ba4ec703;hpb=0af2486a28f1c60b9de929a9101964d880927e54;p=lilypond.git diff --git a/lily/dynamic-engraver.cc b/lily/dynamic-engraver.cc index 967dcc1886..ee6518118f 100644 --- a/lily/dynamic-engraver.cc +++ b/lily/dynamic-engraver.cc @@ -1,344 +1,459 @@ /* - dynamic-engraver.cc -- implement Dynamic_engraver + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 1997--2010 Han-Wen Nienhuys - (c) 1997--2000 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 "debug.hh" + +#include "axis-group-interface.hh" +#include "context.hh" +#include "engraver.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 * text_p_; - Spanner * finished_cresc_p_; - Spanner * cresc_p_; + Item *script_; + Spanner *line_spanner_; + Spanner *cresc_; - Text_script_req* text_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 do_removal_processing (); - virtual void acknowledge_element (Score_element_info); - virtual bool do_try_music (Music *req_l); - virtual void do_process_music (); - virtual void do_pre_move_processing (); - virtual void do_post_move_processing (); + virtual void finalize (); + void stop_translation_timestep (); + void process_music (); }; -ADD_THIS_TRANSLATOR (Dynamic_engraver); - - Dynamic_engraver::Dynamic_engraver () { - text_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; - text_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::do_post_move_processing () +Dynamic_engraver::listen_absolute_dynamic (Stream_event *ev) { - text_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::do_try_music (Music * m) +IMPLEMENT_TRANSLATOR_LISTENER (Dynamic_engraver, span_dynamic); +void +Dynamic_engraver::listen_span_dynamic (Stream_event *ev) { - if (Text_script_req* d = dynamic_cast (m)) - { - if (d->style_str_ == "dynamic") - { - text_req_l_ = d; - return true; - } - } - else if (Span_req* s = dynamic_cast (m)) - { - if ((s->span_type_str_ == "crescendo" - || s->span_type_str_ == "decrescendo")) - { - accepted_spanreqs_drul_[s->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::do_process_music () +Dynamic_engraver::process_music () { - if (accepted_spanreqs_drul_[START] || accepted_spanreqs_drul_[STOP] || text_req_l_) - + if (accepted_spanevents_drul_[START] || accepted_spanevents_drul_[STOP] || script_ev_) { if (!line_spanner_) { - line_spanner_ = new Spanner (get_property ("basicDynamicLineSpannerProperties")); - - 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); - announce_element (Score_element_info - (line_spanner_, - text_req_l_ ? text_req_l_ : accepted_spanreqs_drul_[START])); - + Stream_event *rq = accepted_spanevents_drul_[START]; + line_spanner_ = make_spanner ("DynamicLineSpanner", rq ? rq->self_scm () : SCM_EOL); + if (script_ev_) + rq = script_ev_; } } /* - TODO: should finish and create new spanner if vertical dyn-direction is changed. - */ - else if (!accepted_spanreqs_drul_[START] && !text_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. + During a (de)crescendo, pending event will not be cleared, + and a line-spanner will always be created, as \< \! are already + two events. - Maybe always creating a line-spanner for a (de)crescendo (see - below) is not a good idea: + Note: line-spanner must always have at least same duration + as (de)crecsendo, b.o. line-breaking. + */ - a\< b\p \!c + /* + maybe we should leave dynamic texts to the text-engraver and + simply acknowledge them? + */ + if (script_ev_) + { + script_ = make_item ("DynamicText", script_ev_->self_scm ()); + script_->set_property ("text", + script_ev_->get_property ("text")); - 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? + 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); - Urg, but line-spanner must always have at least same duration - as (de)crecsendo, b.o. line-breaking. - */ + Axis_group_interface::add_element (line_spanner_, script_); + } + Stream_event *stop_ev = accepted_spanevents_drul_ [STOP] + ? accepted_spanevents_drul_[STOP] : script_ev_; - if (text_req_l_) + if (accepted_spanevents_drul_[STOP] || script_ev_) { - String loud = text_req_l_->text_str_; + /* + finish side position alignment if the (de)cresc ends here, and + there are no new dynamics. + */ - text_p_ = new Item (get_property ("basicDynamicTextProperties")); - text_p_->set_elt_property ("text", ly_str02scm (loud.ch_C ())); - if (Direction d=text_req_l_->get_direction ()) - Directional_element_interface (line_spanner_).set (d); - - Axis_group_interface::add_element (line_spanner_, text_p_); + if (cresc_) + { + assert (!finished_cresc_ && cresc_); - text_p_->add_offset_callback (Side_position::aligned_on_self, - Y_AXIS); - announce_element (Score_element_info (text_p_, text_req_l_)); - } + if (script_) + { + cresc_->set_bound (RIGHT, script_); + add_bound_item (line_spanner_, script_); + } - if (accepted_spanreqs_drul_[STOP]) - { - if (!cresc_p_) - { - accepted_spanreqs_drul_[STOP]->warning - (_ ("can't find start of (de)crescendo")); + finished_cresc_ = cresc_; + announce_end_grob (finished_cresc_, SCM_EOL); + cresc_ = 0; + current_cresc_ev_ = 0; } - else + else if (accepted_spanevents_drul_[STOP]) { - assert (!finished_cresc_p_); - cresc_p_->set_bound (RIGHT, unsmob_element (get_property ("currentMusicalColumn"))); - 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]->warning - (current_cresc_req_->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]; - cresc_p_ = new Spanner (get_property ("basicCrescendoProperties")); - Crescendo::set_interface (cresc_p_); - cresc_p_->set_elt_property - ("grow-direction", - gh_int2scm ((accepted_spanreqs_drul_[START]->span_type_str_ == "crescendo") - ? BIGGER : SMALLER)); - - SCM s = get_property ((accepted_spanreqs_drul_[START]->span_type_str_ + "Text").ch_C()); - if (gh_string_p (s)) - { - cresc_p_->set_elt_property ("start-text", s); - daddy_trans_l_->set_property (accepted_spanreqs_drul_[START]->span_type_str_ - + "Text", SCM_UNDEFINED); - } - - s = get_property ((accepted_spanreqs_drul_[START]->span_type_str_ + "Spanner").ch_C()); + 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. - */ - if (gh_string_p (s)) //&& ly_scm2string (s) != "hairpin") + */ + + 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 { - cresc_p_->set_elt_property ("spanner", s); - daddy_trans_l_->set_property (accepted_spanreqs_drul_[START]->span_type_str_ - + "Spanner", SCM_UNDEFINED); + programming_error ("unknown dynamic spanner type"); + return; } - cresc_p_->set_bound (LEFT, unsmob_element (get_property ("currentMusicalColumn"))); - - - /* - We know how wide the text is, if we can be sure that the - text already has relevant pointers into the paperdef, - and it has its font-size property set. - - Since font-size may be set by a context higher up, we - can not be sure of the size. - + /* + UGH. TODO: should read from original event, so appearance + may be altered with \tweak. + */ + SCM s = get_property ((start_type + "Spanner").c_str ()); + if (!scm_is_symbol (s) || s == ly_symbol2scm ("hairpin")) + { + 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_); + } + } - We shouldn't try to do this stuff here, the Item should - do it when the score is finished. We could maybe - set a callback to have the Item do the alignment if - it is not a special symbol, like Crescendo. + /* + This is a convenient (and legacy) interface to TextSpanners + for use in (de)crescendi. + Hmm. */ - - - if (text_p_) + else { - index_set_cell (cresc_p_->get_elt_property ("dynamic-drul"), - LEFT, text_p_->self_scm_); - if (finished_cresc_p_) - index_set_cell (finished_cresc_p_->get_elt_property ("dynamic-drul"), - RIGHT, text_p_->self_scm_); + 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_) + { + set_nested_property (cresc_, + scm_list_3 (ly_symbol2scm ("bound-details"), + ly_symbol2scm ("left"), + ly_symbol2scm ("attach-dir") + ), + scm_from_int (RIGHT)); + } } - Axis_group_interface::add_element (line_spanner_, cresc_p_); - cresc_p_->set_elt_property ("self-alignment-Y", gh_int2scm (0)); - cresc_p_->add_offset_callback - (Side_position::aligned_on_self, Y_AXIS); - announce_element (Score_element_info (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_); } } } void -Dynamic_engraver::do_pre_move_processing () +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::do_removal_processing () +Dynamic_engraver::finalize () { typeset_all (); - - if (cresc_p_) - { - typeset_element (cresc_p_ ); - finished_cresc_p_ = cresc_p_; - current_cresc_req_->warning (_ ("unterminated (de)crescendo")); - } + + if (line_spanner_ + && !line_spanner_->is_live ()) + line_spanner_ = 0; if (line_spanner_) { finished_line_spanner_ = line_spanner_; + typeset_all (); + } + + if (cresc_ + && !cresc_->is_live ()) + cresc_ = 0; + if (cresc_) + { + current_cresc_ev_->origin ()->warning (_ ("unterminated (de)crescendo")); + cresc_->suicide (); + cresc_ = 0; } - typeset_all (); } void Dynamic_engraver::typeset_all () -{ - if (finished_cresc_p_) - { - typeset_element (finished_cresc_p_); - finished_cresc_p_ =0; - } - - if (text_p_) +{ + if (finished_cresc_) { - typeset_element (text_p_); - text_p_ = 0; + if (!finished_cresc_->get_bound (RIGHT)) + { + + Grob *column_bound = unsmob_grob (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_); + /* + 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. - if (!finished_line_spanner_->get_bound (LEFT)) + */ + + 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) { - Score_element * cmc - = unsmob_element (get_property ("currentMusicalColumn")); - finished_line_spanner_->set_bound (LEFT, cmc); + /* + 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); } - if (!finished_line_spanner_->get_bound (RIGHT)) - finished_line_spanner_->set_bound (RIGHT, - finished_line_spanner_->get_bound (LEFT)); - - - typeset_element (finished_line_spanner_); finished_line_spanner_ = 0; } } void -Dynamic_engraver::acknowledge_element (Score_element_info i) +Dynamic_engraver::acknowledge_note_column (Grob_info info) { - if (Note_column* n = dynamic_cast (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_,n); - add_bound_item (line_spanner_,n); + 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 */ + "Create hairpins, dynamic texts, and their vertical" + " alignments. The symbols are collected onto a" + " @code{DynamicLineSpanner} grob which takes care of vertical" + " positioning.", + + /* create */ + "DynamicLineSpanner " + "DynamicTextSpanner " + "DynamicText " + "Hairpin ", + + /* read */ + "", + + /* write */ + "" + );