2 dynamic-engraver.cc -- implement Dynamic_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2007 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"
24 #include "stream-event.hh"
27 #include "text-interface.hh"
29 #include "translator.icc"
34 * direction of text-dynamic-event if not equal to direction of
37 - TODO: this engraver is too complicated. We should split it into
38 the handling of the basic grobs and the linespanner
40 - TODO: the line-spanner is not killed after the (de)crescs are
45 print text & hairpin dynamics.
47 class Dynamic_engraver : public Engraver
50 Spanner *line_spanner_;
53 Spanner *finished_line_spanner_;
54 Spanner *finished_cresc_;
56 Stream_event *script_ev_;
57 Stream_event *current_cresc_ev_;
59 Drul_array<Stream_event *> accepted_spanevents_drul_;
61 vector<Note_column*> pending_columns_;
62 vector<Grob*> pending_elements_;
66 TRANSLATOR_DECLARATIONS (Dynamic_engraver);
67 DECLARE_ACKNOWLEDGER (note_column);
68 DECLARE_TRANSLATOR_LISTENER (absolute_dynamic);
69 DECLARE_TRANSLATOR_LISTENER (span_dynamic);
72 virtual void finalize ();
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;
91 IMPLEMENT_TRANSLATOR_LISTENER (Dynamic_engraver, absolute_dynamic);
93 Dynamic_engraver::listen_absolute_dynamic (Stream_event *ev)
96 TODO: probably broken.
98 ASSIGN_EVENT_ONCE (script_ev_, ev);
101 IMPLEMENT_TRANSLATOR_LISTENER (Dynamic_engraver, span_dynamic);
103 Dynamic_engraver::listen_span_dynamic (Stream_event *ev)
105 Direction d = to_dir (ev->get_property ("span-direction"));
108 ASSIGN_EVENT_ONCE (accepted_spanevents_drul_[START], ev);
110 /* Cancel any ongoing crescendo, either explicitly by \! or
111 implicitly by a new crescendo. Also avoid warning if cresc is
112 cancelled both implicitly and explicitly. */
113 if ((d == STOP || current_cresc_ev_) && !accepted_spanevents_drul_[STOP])
114 ASSIGN_EVENT_ONCE (accepted_spanevents_drul_[STOP], ev);
118 Dynamic_engraver::process_music ()
120 if (accepted_spanevents_drul_[START] || accepted_spanevents_drul_[STOP] || script_ev_)
124 Stream_event *rq = accepted_spanevents_drul_[START];
125 line_spanner_ = make_spanner ("DynamicLineSpanner", rq ? rq->self_scm () : SCM_EOL);
132 During a (de)crescendo, pending event will not be cleared,
133 and a line-spanner will always be created, as \< \! are already
136 Note: line-spanner must always have at least same duration
137 as (de)crecsendo, b.o. line-breaking.
141 maybe we should leave dynamic texts to the text-engraver and
142 simply acknowledge them?
146 script_ = make_item ("DynamicText", script_ev_->self_scm ());
147 script_->set_property ("text",
148 script_ev_->get_property ("text"));
150 if (Direction d = to_dir (script_ev_->get_property ("direction")))
151 set_grob_direction (line_spanner_, d);
152 else if (Direction d = to_dir (line_spanner_->get_property ("direction")))
153 set_grob_direction (script_, d);
155 Axis_group_interface::add_element (line_spanner_, script_);
158 Stream_event *stop_ev = accepted_spanevents_drul_ [STOP]
159 ? accepted_spanevents_drul_[STOP] : script_ev_;
161 if (accepted_spanevents_drul_[STOP] || script_ev_)
164 finish side position alignment if the (de)cresc ends here, and
165 there are no new dynamics.
170 assert (!finished_cresc_ && cresc_);
174 cresc_->set_bound (RIGHT, script_);
175 add_bound_item (line_spanner_, script_);
178 finished_cresc_ = cresc_;
180 current_cresc_ev_ = 0;
182 else if (accepted_spanevents_drul_[STOP])
184 accepted_spanevents_drul_[STOP]->origin ()->warning (_ ("cannot find start of (de)crescendo"));
189 if (accepted_spanevents_drul_[START])
191 if (current_cresc_ev_)
193 string msg = _ ("already have a decrescendo");
194 if (current_cresc_ev_->in_event_class ("crescendo-event"))
195 msg = _ ("already have a crescendo");
197 accepted_spanevents_drul_[START]->origin ()->warning (msg);
198 current_cresc_ev_->origin ()->warning (_ ("cresc starts here"));
202 current_cresc_ev_ = accepted_spanevents_drul_[START];
204 if (Direction d = to_dir (current_cresc_ev_->get_property ("direction")))
205 set_grob_direction (line_spanner_, d);
211 SCM start_sym = current_cresc_ev_->get_property ("class");
214 if (start_sym == ly_symbol2scm ("decrescendo-event"))
215 start_type = "decrescendo";
216 else if (start_sym == ly_symbol2scm ("crescendo-event"))
217 start_type = "crescendo";
220 programming_error ("unknown dynamic spanner type");
225 UGH. TODO: should read from original event, so appearance
226 may be altered with \tweak.
228 SCM s = get_property ((start_type + "Spanner").c_str ());
229 if (!scm_is_symbol (s) || s == ly_symbol2scm ("hairpin"))
231 cresc_ = make_spanner ("Hairpin", accepted_spanevents_drul_[START]->self_scm ());
234 Pointer_group_interface::add_grob (finished_cresc_,
235 ly_symbol2scm ("adjacent-hairpins"),
238 Pointer_group_interface::add_grob (cresc_,
239 ly_symbol2scm ("adjacent-hairpins"),
245 This is a convenient (and legacy) interface to TextSpanners
246 for use in (de)crescendi.
251 cresc_ = make_spanner ("DynamicTextSpanner", accepted_spanevents_drul_[START]->self_scm ());
252 cresc_->set_property ("style", s);
253 context ()->set_property ((start_type
254 + "Spanner").c_str (), SCM_EOL);
255 s = get_property ((start_type + "Text").c_str ());
256 if (Text_interface::is_markup (s))
258 cresc_->set_property ("text", s);
259 context ()->set_property ((start_type + "Text").c_str (),
265 set_nested_property (cresc_,
266 scm_list_3 (ly_symbol2scm ("bound-details"),
267 ly_symbol2scm ("left"),
268 ly_symbol2scm ("attach-dir")
270 scm_from_int (RIGHT));
276 cresc_->set_bound (LEFT, script_);
277 add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
280 Axis_group_interface::add_element (line_spanner_, cresc_);
286 Dynamic_engraver::stop_translation_timestep ()
288 if (!current_cresc_ev_ && line_spanner_)
290 assert (!finished_line_spanner_);
291 finished_line_spanner_ = line_spanner_;
297 if (cresc_ && !cresc_->get_bound (LEFT))
299 cresc_->set_bound (LEFT, unsmob_grob (get_property ("currentMusicalColumn")));
300 add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
304 accepted_spanevents_drul_[START] = 0;
305 accepted_spanevents_drul_[STOP] = 0;
309 Dynamic_engraver::finalize ()
314 && !line_spanner_->is_live ())
318 finished_line_spanner_ = line_spanner_;
323 && !cresc_->is_live ())
327 current_cresc_ev_->origin ()->warning (_ ("unterminated (de)crescendo"));
334 Dynamic_engraver::typeset_all ()
338 bool use_bar = to_boolean (get_property ("hairpinToBarline"))
339 && scm_is_string (get_property ("whichBar"))
343 if (!finished_cresc_->get_bound (RIGHT)
347 Grob *column_bound = 0;
350 column_bound = unsmob_grob (get_property ("breakableSeparationItem"));
354 column_bound = unsmob_grob (use_bar
355 ? get_property ("currentCommandColumn")
356 : get_property ("currentMusicalColumn"));
358 finished_cresc_->set_bound (RIGHT, script_
362 if (finished_line_spanner_)
363 add_bound_item (finished_line_spanner_,
364 finished_cresc_->get_bound (RIGHT));
370 if (finished_line_spanner_)
375 extend-spanner-over-elements (finished_line_spanner_);
377 but this is rather kludgy, since finished_line_spanner_
378 typically has a staff-symbol field set , extending it over the
383 Grob *l = finished_line_spanner_->get_bound (LEFT);
384 Grob *r = finished_line_spanner_->get_bound (RIGHT);
386 finished_line_spanner_->set_bound (RIGHT, l);
388 finished_line_spanner_->set_bound (LEFT, r);
392 This is a isolated dynamic apparently, and does not even have
393 any interesting support item.
395 Grob *cc = unsmob_grob (get_property ("currentMusicalColumn"));
396 Item *ci = dynamic_cast<Item *> (cc);
397 finished_line_spanner_->set_bound (RIGHT, ci);
398 finished_line_spanner_->set_bound (LEFT, ci);
401 finished_line_spanner_ = 0;
406 Dynamic_engraver::acknowledge_note_column (Grob_info info)
412 /* Don't refill killed spanner */
413 && line_spanner_->is_live ())
415 Side_position_interface::add_support (line_spanner_, info.grob ());
416 add_bound_item (line_spanner_, dynamic_cast<Item *> (info.grob ()));
419 if (script_ && !script_->get_parent (X_AXIS))
421 extract_grob_set (info.grob (), "note-heads", heads);
424 Grob *head = heads[0];
425 script_->set_parent (head, X_AXIS);
426 Self_alignment_interface::set_center_parent (script_, X_AXIS);
432 if (!cresc_->get_bound (LEFT))
434 cresc_->set_bound (LEFT, info.grob ());
435 add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
439 if (finished_cresc_ && !finished_cresc_->get_bound (RIGHT))
440 finished_cresc_->set_bound (RIGHT, info.grob ());
443 ADD_ACKNOWLEDGER (Dynamic_engraver, note_column);
445 ADD_TRANSLATOR (Dynamic_engraver,
447 "This engraver creates hairpins, dynamic texts, and their vertical\n"
448 "alignments. The symbols are collected onto a DynamicLineSpanner grob\n"
449 "which takes care of vertical positioning. ",
452 "DynamicLineSpanner "