/*
- dynamic-reg.cc -- implement Dynamic_engraver
+ dynamic-engraver.cc -- implement Dynamic_engraver
source file of the GNU LilyPond music typesetter
- (c) 1997--1998 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
*/
-#include "debug.hh"
-#include "crescendo.hh"
-#include "dynamic-engraver.hh"
-#include "musical-request.hh"
-#include "text-item.hh"
-#include "lookup.hh"
-#include "paper-def.hh"
-#include "score-column.hh"
-#include "staff-sym.hh"
+
+#include "axis-group-interface.hh"
+#include "context.hh"
+#include "dimensions.hh"
+#include "directional-element-interface.hh"
+#include "engraver.hh"
+#include "hairpin.hh"
+#include "interval.hh"
#include "note-column.hh"
+#include "paper-column.hh"
+#include "script-interface.hh"
+#include "side-position-interface.hh"
+#include "staff-symbol-referencer.hh"
+#include "warn.hh"
+
+/*
+ TODO:
+
+ * 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.
+*/
-Dynamic_engraver::Dynamic_engraver()
+/**
+ print text & hairpin dynamics.
+*/
+class Dynamic_engraver : public Engraver
{
- do_post_move_processing();
- dir_ = CENTER;
- dynamic_p_ =0;
- to_end_cresc_p_ = cresc_p_ = 0;
- cresc_req_l_ = 0;
-}
+ Item *script_;
+ Spanner *line_spanner_;
+ Spanner *cresc_;
-void
-Dynamic_engraver::do_post_move_processing()
+ Spanner *finished_line_spanner_;
+ Spanner *finished_cresc_;
+
+ Music *script_ev_;
+ Music *current_cresc_ev_;
+
+ Drul_array<Music *> accepted_spanreqs_drul_;
+
+ Link_array<Note_column> pending_columns_;
+ Link_array<Grob> pending_elements_;
+
+ void typeset_all ();
+
+ TRANSLATOR_DECLARATIONS (Dynamic_engraver);
+
+protected:
+ virtual void finalize ();
+ virtual void acknowledge_grob (Grob_info);
+ virtual bool try_music (Music *req);
+ virtual void stop_translation_timestep ();
+ virtual void process_music ();
+};
+
+Dynamic_engraver::Dynamic_engraver ()
{
- dynamic_req_l_arr_.clear();
+ script_ = 0;
+ finished_cresc_ = 0;
+ line_spanner_ = 0;
+ finished_line_spanner_ = 0;
+ current_cresc_ev_ = 0;
+ cresc_ = 0;
+
+ script_ev_ = 0;
+ accepted_spanreqs_drul_[START] = 0;
+ accepted_spanreqs_drul_[STOP] = 0;
}
bool
-Dynamic_engraver::do_try_music (Music * r)
+Dynamic_engraver::try_music (Music *m)
{
- if(Dynamic_req * d = dynamic_cast <Dynamic_req *> (r))
+ if (m->is_mus_type ("absolute-dynamic-event"))
+ {
+ /*
+ TODO: probably broken.
+ */
+ script_ev_ = m;
+ return true;
+ }
+ else if (m->is_mus_type ("decrescendo-event")
+ || m->is_mus_type ("crescendo-event"))
{
- for (int i=0; i < dynamic_req_l_arr_.size (); i++)
- if (d->equal_b (dynamic_req_l_arr_[i]))
- return true;
-
- dynamic_req_l_arr_.push (d);
+ Direction d = to_dir (m->get_property ("span-direction"));
+
+ accepted_spanreqs_drul_[d] = m;
+ if (current_cresc_ev_ && d == START)
+ accepted_spanreqs_drul_[STOP] = m;
return true;
}
return false;
}
+
void
-Dynamic_engraver::do_process_requests()
+Dynamic_engraver::process_music ()
{
- Crescendo* new_cresc_p=0;
- for (int i=0; i < dynamic_req_l_arr_.size(); i++)
+ if (accepted_spanreqs_drul_[START] || accepted_spanreqs_drul_[STOP] || script_ev_)
+ {
+ if (!line_spanner_)
+ {
+ Music *rq = accepted_spanreqs_drul_[START];
+ line_spanner_ = make_spanner ("DynamicLineSpanner", rq ? rq->self_scm () : SCM_EOL);
+
+ if (script_ev_)
+ rq = script_ev_;
+ }
+ }
+
+ /*
+ During a (de)crescendo, pending event will not be cleared,
+ and a line-spanner will always be created, as \< \! are already
+ two events.
+
+ 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_ev_)
{
- Dynamic_req *dreq_l = dynamic_req_l_arr_[i];
- if (Absolute_dynamic_req *absd = dynamic_cast<Absolute_dynamic_req *> (dreq_l))
+ script_ = make_item ("DynamicText", script_ev_->self_scm ());
+ script_->set_property ("text",
+ script_ev_->get_property ("text"));
+
+ if (Direction d = to_dir (script_ev_->get_property ("direction")))
+ set_grob_direction (line_spanner_, d);
+
+ Axis_group_interface::add_element (line_spanner_, script_);
+ }
+
+ Music *stop_ev = accepted_spanreqs_drul_ [STOP]
+ ? accepted_spanreqs_drul_[STOP] : script_ev_;
+
+ if (accepted_spanreqs_drul_[STOP] || script_ev_)
+ {
+ /*
+ finish side position alignment if the (de)cresc ends here, and
+ there are no new dynamics.
+ */
+
+ if (cresc_)
{
+ assert (!finished_cresc_ && cresc_);
- if (dynamic_p_)
+ if (script_)
{
- dynamic_req_l_arr_[i]->warning (_("Got a dynamic already. Continuing dazed and confused"));
- continue;
+ cresc_->set_bound (RIGHT, script_);
+ add_bound_item (line_spanner_, script_);
}
- Text_def * td_p = new Text_def;
- String loud = absd->loudness_str ();
- td_p->text_str_ = paper ()->lookup_l (0)->dynamic (loud).str_; // ugh
- td_p->style_str_ = "dynamic";
- td_p->align_dir_ = RIGHT; // Ugh, Doesn't give any effect?
- Real nw_f = paper ()->note_width () * 0.8;
+ finished_cresc_ = cresc_;
+ cresc_ = 0;
+ current_cresc_ev_ = 0;
+ }
+ else if (accepted_spanreqs_drul_[STOP])
+ {
+ accepted_spanreqs_drul_[STOP]->origin ()->warning (_ ("can't find start of (de)crescendo"));
+ stop_ev = 0;
+ }
+ }
- dynamic_p_ = new Text_item (td_p);
- // dynamic_p_->translate (Offset (nw_f, 0)); // Removed, Mats B
+ if (accepted_spanreqs_drul_[START])
+ {
+ if (current_cresc_ev_)
+ {
+ String msg = _ ("already have a decrescendo");
+ if (current_cresc_ev_->is_mus_type ("decrescendo-event"))
+ msg = _ ("already have a crescendo");
- announce_element (Score_element_info (dynamic_p_, dreq_l));
+ accepted_spanreqs_drul_[START]->origin ()->warning (msg);
+ current_cresc_ev_->origin ()->warning (_ ("cresc starts here"));
}
- else if (Span_dynamic_req *span_l = dynamic_cast <Span_dynamic_req *> (dreq_l))
+ else
{
- if (span_l->spantype_ == STOP)
+ current_cresc_ev_ = accepted_spanreqs_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_symbol2string (current_cresc_ev_->get_property ("name"));
+
+ /*
+ ugh. Use push/pop?
+ */
+ if (start_type == "DecrescendoEvent")
+ start_type = "decrescendo";
+ else if (start_type == "CrescendoEvent")
+ start_type = "crescendo";
+
+ SCM s = get_property ((start_type + "Spanner").to_str0 ());
+ if (!scm_is_symbol (s) || s == ly_symbol2scm ("hairpin"))
{
- if (!cresc_p_)
+ cresc_ = make_spanner ("Hairpin", accepted_spanreqs_drul_[START]->self_scm ());
+ if (finished_cresc_)
{
- span_l->warning (_ ("can't find (de)crescendo to end"));
+ Pointer_group_interface::add_grob (finished_cresc_,
+ ly_symbol2scm ("adjacent-hairpins"),
+ cresc_);
+
+ Pointer_group_interface::add_grob (cresc_,
+ ly_symbol2scm ("adjacent-hairpins"),
+ finished_cresc_);
}
- else
+ cresc_->set_property ("grow-direction",
+ scm_int2num ((start_type == "crescendo")
+ ? BIGGER : SMALLER));
+ }
+
+ /*
+ This is a convenient (and legacy) interface to TextSpanners
+ for use in (de)crescendi.
+ Hmm.
+ */
+ else
+ {
+ cresc_ = make_spanner ("DynamicTextSpanner", accepted_spanreqs_drul_[START]->self_scm ());
+ cresc_->set_property ("style", s);
+ context ()->set_property ((start_type
+ + "Spanner").to_str0 (), SCM_EOL);
+ s = get_property ((start_type + "Text").to_str0 ());
+ /*
+ FIXME: use get_markup () to check type.
+ */
+ if (scm_is_string (s) || scm_is_pair (s))
{
- assert (!to_end_cresc_p_);
- to_end_cresc_p_ =cresc_p_;
- cresc_p_ = 0;
+ cresc_->set_property ("edge-text",
+ scm_cons (s, scm_makfrom0str ("")));
+ context ()->set_property ((start_type + "Text").to_str0 (),
+ SCM_EOL);
}
}
- else if (span_l->spantype_ == START)
+
+ if (script_)
{
- cresc_req_l_ = span_l;
- assert (!new_cresc_p);
- new_cresc_p = new Crescendo;
- new_cresc_p->grow_dir_ = span_l->dynamic_dir_;
- announce_element (Score_element_info (new_cresc_p, span_l));
+ cresc_->set_bound (LEFT, script_);
+ add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
}
- }
- }
- if (new_cresc_p)
- {
- if (cresc_p_)
- {
- ::warning (_ ("Too many crescendi here"));
- typeset_element (cresc_p_);
- cresc_p_ = 0;
- }
-
- cresc_p_ = new_cresc_p;
- cresc_p_->set_bounds(LEFT,get_staff_info().musical_l ());
- if (dynamic_p_)
- {
- cresc_p_->dyn_b_drul_[LEFT] = true;
+ Axis_group_interface::add_element (line_spanner_, cresc_);
}
}
}
void
-Dynamic_engraver::do_pre_move_processing()
+Dynamic_engraver::stop_translation_timestep ()
{
- Staff_symbol* s_l = get_staff_info().staff_sym_l_;
- if (to_end_cresc_p_)
+ typeset_all ();
+ if (!current_cresc_ev_)
{
- if (dynamic_p_)
- to_end_cresc_p_->dyn_b_drul_[RIGHT]=true;
-
-
- Scalar prop = get_property ("dynamicdir");
- if (prop.isnum_b ())
- {
- to_end_cresc_p_->dir_ = (Direction) (int) prop;
- }
- to_end_cresc_p_->set_bounds(RIGHT,get_staff_info().musical_l ());
- to_end_cresc_p_->add_support (s_l);
- typeset_element (to_end_cresc_p_);
- to_end_cresc_p_ = 0;
+ finished_line_spanner_ = line_spanner_;
+ line_spanner_ = 0;
+ typeset_all ();
}
- if (dynamic_p_)
+
+ if (cresc_ && !cresc_->get_bound (LEFT))
{
- Scalar prop = get_property ("dynamicdir");
- if (prop.isnum_b ())
- {
- dynamic_p_->dir_ = (Direction) (int) prop;
- }
-
- dynamic_p_->add_support (s_l);
- typeset_element (dynamic_p_);
- dynamic_p_ = 0;
+ cresc_->set_bound (LEFT, unsmob_grob (get_property ("currentMusicalColumn")));
+ add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
}
+
+ script_ev_ = 0;
+ accepted_spanreqs_drul_[START] = 0;
+ accepted_spanreqs_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 ();
+ }
-ADD_THIS_TRANSLATOR(Dynamic_engraver);
+ if (cresc_
+ && !cresc_->is_live ())
+ cresc_ = 0;
+ if (cresc_)
+ {
+ current_cresc_ev_->origin ()->warning (_ ("unterminated (de)crescendo"));
+ cresc_->suicide ();
+ cresc_ = 0;
+ }
+}
void
-Dynamic_engraver::do_removal_processing ()
+Dynamic_engraver::typeset_all ()
{
- if (cresc_p_)
+ if (finished_cresc_)
{
- typeset_element (cresc_p_ );
-
- cresc_req_l_->warning (_ ("unended crescendo"));
- cresc_p_ =0;
- }
- if (to_end_cresc_p_)
- {
- typeset_element (to_end_cresc_p_);
- to_end_cresc_p_ =0;
+ if (!finished_cresc_->get_bound (RIGHT))
+ {
+ finished_cresc_->set_bound (RIGHT, script_
+ ? script_
+ : unsmob_grob (get_property ("currentMusicalColumn")));
+
+ if (finished_line_spanner_)
+ add_bound_item (finished_line_spanner_,
+ finished_cresc_->get_bound (RIGHT));
+ }
+ finished_cresc_ = 0;
}
- if (dynamic_p_)
+
+ script_ = 0;
+ if (finished_line_spanner_)
{
- typeset_element (dynamic_p_);
- dynamic_p_ =0;
+ /*
+ 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<Item *> (cc);
+ finished_line_spanner_->set_bound (RIGHT, ci);
+ finished_line_spanner_->set_bound (LEFT, ci);
+ }
+
+ finished_line_spanner_ = 0;
}
}
void
-Dynamic_engraver::acknowledge_element (Score_element_info i)
+Dynamic_engraver::acknowledge_grob (Grob_info info)
{
- if (dynamic_cast<Note_column *> (i.elem_l_))
+ if (!line_spanner_)
+ return;
+
+ if (Note_column::has_interface (info.grob_))
{
- if (dynamic_p_)
- dynamic_p_->add_support (i.elem_l_);
+ 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<Item *> (info.grob_));
+ }
- if (to_end_cresc_p_)
- to_end_cresc_p_->add_support (i.elem_l_);
+ if (script_ && !script_->get_parent (X_AXIS))
+ {
+ SCM head = scm_last_pair (info.grob_->get_property ("note-heads"));
+ if (scm_is_pair (head))
+ script_->set_parent (unsmob_grob (scm_car (head)), X_AXIS);
+ }
- if (cresc_p_)
- cresc_p_->add_support (i.elem_l_);
+ 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_);
+ }
+ }
+
+ else if (Script_interface::has_interface (info.grob_) && script_)
+ {
+ SCM p = info.grob_->get_property ("script-priority");
+
+ /*
+ UGH.
+
+ DynamicText doesn't really have a script-priority field.
+ */
+ if (scm_is_number (p)
+ && scm_to_int (p)
+ < scm_to_int (script_->get_property ("script-priority")))
+ Side_position_interface::add_support (line_spanner_, info.grob_);
}
}
+
+ADD_TRANSLATOR (Dynamic_engraver,
+ /* descr */
+ "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. ",
+
+ /* creats*/ "DynamicLineSpanner DynamicText Hairpin TextSpanner",
+ /* accepts */ "absolute-dynamic-event crescendo-event decrescendo-event",
+ /* acks */ "note-column-interface script-interface",
+ /* reads */ "",
+ /* write */ "");
projects / lilypond.git / blobdiff