2 dynamic-engraver.cc -- implement Dynamic_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
9 #include "axis-group-interface.hh"
11 #include "dimensions.hh"
12 #include "directional-element-interface.hh"
13 #include "engraver.hh"
15 #include "international.hh"
16 #include "interval.hh"
17 #include "note-column.hh"
18 #include "paper-column.hh"
19 #include "pointer-group-interface.hh"
20 #include "script-interface.hh"
21 #include "self-alignment-interface.hh"
22 #include "side-position-interface.hh"
23 #include "staff-symbol-referencer.hh"
26 #include "translator.icc"
31 * direction of text-dynamic-event if not equal to direction of
34 - TODO: this engraver is too complicated. We should split it into
35 the handling of the basic grobs and the linespanner
37 - TODO: the line-spanner is not killed after the (de)crescs are
42 print text & hairpin dynamics.
44 class Dynamic_engraver : public Engraver
47 Spanner *line_spanner_;
50 Spanner *finished_line_spanner_;
51 Spanner *finished_cresc_;
54 Music *current_cresc_ev_;
56 Drul_array<Music *> accepted_spanevents_drul_;
58 vector<Note_column*> pending_columns_;
59 vector<Grob*> pending_elements_;
63 TRANSLATOR_DECLARATIONS (Dynamic_engraver);
64 DECLARE_ACKNOWLEDGER (accidental);
65 DECLARE_ACKNOWLEDGER (script);
66 DECLARE_ACKNOWLEDGER (stem_tremolo);
67 DECLARE_ACKNOWLEDGER (note_column);
68 DECLARE_ACKNOWLEDGER (slur);
71 virtual void finalize ();
72 virtual bool try_music (Music *event);
73 void stop_translation_timestep ();
74 void process_music ();
77 Dynamic_engraver::Dynamic_engraver ()
82 finished_line_spanner_ = 0;
83 current_cresc_ev_ = 0;
87 accepted_spanevents_drul_[START] = 0;
88 accepted_spanevents_drul_[STOP] = 0;
92 Dynamic_engraver::try_music (Music *m)
94 if (m->is_mus_type ("absolute-dynamic-event"))
97 TODO: probably broken.
102 else if (m->is_mus_type ("decrescendo-event")
103 || m->is_mus_type ("crescendo-event"))
105 Direction d = to_dir (m->get_property ("span-direction"));
107 accepted_spanevents_drul_[d] = m;
108 if (current_cresc_ev_ && d == START)
109 accepted_spanevents_drul_[STOP] = m;
116 Dynamic_engraver::process_music ()
118 if (accepted_spanevents_drul_[START] || accepted_spanevents_drul_[STOP] || script_ev_)
122 Music *rq = accepted_spanevents_drul_[START];
123 line_spanner_ = make_spanner ("DynamicLineSpanner", rq ? rq->self_scm () : SCM_EOL);
130 During a (de)crescendo, pending event will not be cleared,
131 and a line-spanner will always be created, as \< \! are already
134 Note: line-spanner must always have at least same duration
135 as (de)crecsendo, b.o. line-breaking.
139 maybe we should leave dynamic texts to the text-engraver and
140 simply acknowledge them?
144 script_ = make_item ("DynamicText", script_ev_->self_scm ());
145 script_->set_property ("text",
146 script_ev_->get_property ("text"));
148 if (Direction d = to_dir (script_ev_->get_property ("direction")))
149 set_grob_direction (line_spanner_, d);
150 else if (Direction d = to_dir (line_spanner_->get_property ("direction")))
151 set_grob_direction (script_, d);
153 Axis_group_interface::add_element (line_spanner_, script_);
156 Music *stop_ev = accepted_spanevents_drul_ [STOP]
157 ? accepted_spanevents_drul_[STOP] : script_ev_;
159 if (accepted_spanevents_drul_[STOP] || script_ev_)
162 finish side position alignment if the (de)cresc ends here, and
163 there are no new dynamics.
168 assert (!finished_cresc_ && cresc_);
172 cresc_->set_bound (RIGHT, script_);
173 add_bound_item (line_spanner_, script_);
176 finished_cresc_ = cresc_;
178 current_cresc_ev_ = 0;
180 else if (accepted_spanevents_drul_[STOP])
182 accepted_spanevents_drul_[STOP]->origin ()->warning (_ ("can't find start of (de)crescendo"));
187 if (accepted_spanevents_drul_[START])
189 if (current_cresc_ev_)
191 string msg = _ ("already have a decrescendo");
192 if (current_cresc_ev_->is_mus_type ("decrescendo-event"))
193 msg = _ ("already have a crescendo");
195 accepted_spanevents_drul_[START]->origin ()->warning (msg);
196 current_cresc_ev_->origin ()->warning (_ ("cresc starts here"));
200 current_cresc_ev_ = accepted_spanevents_drul_[START];
202 if (Direction d = to_dir (current_cresc_ev_->get_property ("direction")))
203 set_grob_direction (line_spanner_, d);
210 = ly_symbol2string (current_cresc_ev_->get_property ("name"));
212 if (start_type == "DecrescendoEvent")
213 start_type = "decrescendo";
214 else if (start_type == "CrescendoEvent")
215 start_type = "crescendo";
220 UGH. TODO: should read from original event, so appearance
221 may be altered with \tweak.
223 SCM s = get_property ((start_type + "Spanner").c_str ());
224 if (!scm_is_symbol (s) || s == ly_symbol2scm ("hairpin"))
226 cresc_ = make_spanner ("Hairpin", accepted_spanevents_drul_[START]->self_scm ());
229 Pointer_group_interface::add_grob (finished_cresc_,
230 ly_symbol2scm ("adjacent-hairpins"),
233 Pointer_group_interface::add_grob (cresc_,
234 ly_symbol2scm ("adjacent-hairpins"),
237 cresc_->set_property ("grow-direction",
238 scm_from_int ((start_type == "crescendo")
239 ? BIGGER : SMALLER));
243 This is a convenient (and legacy) interface to TextSpanners
244 for use in (de)crescendi.
249 cresc_ = make_spanner ("DynamicTextSpanner", accepted_spanevents_drul_[START]->self_scm ());
250 cresc_->set_property ("style", s);
251 context ()->set_property ((start_type
252 + "Spanner").c_str (), SCM_EOL);
253 s = get_property ((start_type + "Text").c_str ());
255 FIXME: use get_markup () to check type.
257 if (scm_is_string (s) || scm_is_pair (s))
259 cresc_->set_property ("edge-text",
260 scm_cons (s, scm_makfrom0str ("")));
261 context ()->set_property ((start_type + "Text").c_str (),
268 cresc_->set_bound (LEFT, script_);
269 add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
272 Axis_group_interface::add_element (line_spanner_, cresc_);
278 Dynamic_engraver::stop_translation_timestep ()
280 if (!current_cresc_ev_ && line_spanner_)
282 assert (!finished_line_spanner_);
283 finished_line_spanner_ = line_spanner_;
289 if (cresc_ && !cresc_->get_bound (LEFT))
291 cresc_->set_bound (LEFT, unsmob_grob (get_property ("currentMusicalColumn")));
292 add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
296 accepted_spanevents_drul_[START] = 0;
297 accepted_spanevents_drul_[STOP] = 0;
301 Dynamic_engraver::finalize ()
306 && !line_spanner_->is_live ())
310 finished_line_spanner_ = line_spanner_;
315 && !cresc_->is_live ())
319 current_cresc_ev_->origin ()->warning (_ ("unterminated (de)crescendo"));
326 Dynamic_engraver::typeset_all ()
330 bool use_bar = to_boolean (get_property ("hairpinToBarline"))
331 && scm_is_string (get_property ("whichBar"))
335 if (!finished_cresc_->get_bound (RIGHT)
338 Grob *column_bound = unsmob_grob (use_bar
339 ? get_property ("currentCommandColumn")
340 : get_property ("currentMusicalColumn"));
342 finished_cresc_->set_bound (RIGHT, script_
346 if (finished_line_spanner_)
347 add_bound_item (finished_line_spanner_,
348 finished_cresc_->get_bound (RIGHT));
354 if (finished_line_spanner_)
359 extend-spanner-over-elements (finished_line_spanner_);
361 but this is rather kludgy, since finished_line_spanner_
362 typically has a staff-symbol field set , extending it over the
367 Grob *l = finished_line_spanner_->get_bound (LEFT);
368 Grob *r = finished_line_spanner_->get_bound (RIGHT);
370 finished_line_spanner_->set_bound (RIGHT, l);
372 finished_line_spanner_->set_bound (LEFT, r);
376 This is a isolated dynamic apparently, and does not even have
377 any interesting support item.
379 Grob *cc = unsmob_grob (get_property ("currentMusicalColumn"));
380 Item *ci = dynamic_cast<Item *> (cc);
381 finished_line_spanner_->set_bound (RIGHT, ci);
382 finished_line_spanner_->set_bound (LEFT, ci);
385 finished_line_spanner_ = 0;
391 Dynamic_engraver::acknowledge_accidental (Grob_info info)
394 Side_position_interface::add_support (line_spanner_, info.grob ());
399 Dynamic_engraver::acknowledge_stem_tremolo (Grob_info info)
402 Side_position_interface::add_support (line_spanner_, info.grob ());
407 Dynamic_engraver::acknowledge_slur (Grob_info info)
410 Side_position_interface::add_support (line_spanner_, info.grob ());
415 Dynamic_engraver::acknowledge_note_column (Grob_info info)
421 /* Don't refill killed spanner */
422 && line_spanner_->is_live ())
424 Side_position_interface::add_support (line_spanner_, info.grob ());
425 add_bound_item (line_spanner_, dynamic_cast<Item *> (info.grob ()));
428 if (script_ && !script_->get_parent (X_AXIS))
430 extract_grob_set (info.grob (), "note-heads", heads);
433 Grob *head = heads[0];
434 script_->set_parent (head, X_AXIS);
435 Self_alignment_interface::set_center_parent (script_, X_AXIS);
441 if (!cresc_->get_bound (LEFT))
443 cresc_->set_bound (LEFT, info.grob ());
444 add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
448 if (finished_cresc_ && !finished_cresc_->get_bound (RIGHT))
449 finished_cresc_->set_bound (RIGHT, info.grob ());
453 Dynamic_engraver::acknowledge_script (Grob_info info)
455 if (!line_spanner_ || !script_)
458 SCM p = info.grob ()->get_property ("script-priority");
463 DynamicText doesn't really have a script-priority field.
465 if (scm_is_number (p)
467 < scm_to_int (script_->get_property ("script-priority")))
468 Side_position_interface::add_support (line_spanner_, info.grob ());
471 ADD_ACKNOWLEDGER (Dynamic_engraver, accidental);
472 ADD_ACKNOWLEDGER (Dynamic_engraver, script);
473 ADD_ACKNOWLEDGER (Dynamic_engraver, note_column);
474 ADD_ACKNOWLEDGER (Dynamic_engraver, slur);
475 ADD_ACKNOWLEDGER (Dynamic_engraver, stem_tremolo);
477 ADD_TRANSLATOR (Dynamic_engraver,
479 "This engraver creates hairpins, dynamic texts, and their vertical\n"
480 "alignments. The symbols are collected onto a DynamicLineSpanner grob\n"
481 "which takes care of vertical positioning. ",
483 /* create */ "DynamicLineSpanner DynamicText Hairpin TextSpanner",
484 /* accept */ "absolute-dynamic-event crescendo-event decrescendo-event",