2 dynamic-engraver.cc -- implement Dynamic_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
9 #include "axis-group-interface.hh"
11 #include "dimensions.hh"
12 #include "directional-element-interface.hh"
13 #include "engraver.hh"
15 #include "interval.hh"
16 #include "note-column.hh"
17 #include "paper-column.hh"
18 #include "script-interface.hh"
19 #include "side-position-interface.hh"
20 #include "staff-symbol-referencer.hh"
22 #include "self-alignment-interface.hh"
23 #include "pointer-group-interface.hh"
25 #include "translator.icc"
30 * direction of text-dynamic-event if not equal to direction of
33 - TODO: this engraver is too complicated. We should split it into
34 the handling of the basic grobs and the linespanner
36 - TODO: the line-spanner is not killed after the (de)crescs are
41 print text & hairpin dynamics.
43 class Dynamic_engraver : public Engraver
46 Spanner *line_spanner_;
49 Spanner *finished_line_spanner_;
50 Spanner *finished_cresc_;
53 Music *current_cresc_ev_;
55 Drul_array<Music *> accepted_spanevents_drul_;
57 Link_array<Note_column> pending_columns_;
58 Link_array<Grob> pending_elements_;
62 TRANSLATOR_DECLARATIONS (Dynamic_engraver);
63 DECLARE_ACKNOWLEDGER(script);
64 DECLARE_ACKNOWLEDGER(note_column);
68 virtual void finalize ();
69 virtual bool try_music (Music *event);
70 void stop_translation_timestep ();
71 void process_music ();
74 Dynamic_engraver::Dynamic_engraver ()
79 finished_line_spanner_ = 0;
80 current_cresc_ev_ = 0;
84 accepted_spanevents_drul_[START] = 0;
85 accepted_spanevents_drul_[STOP] = 0;
89 Dynamic_engraver::try_music (Music *m)
91 if (m->is_mus_type ("absolute-dynamic-event"))
94 TODO: probably broken.
99 else if (m->is_mus_type ("decrescendo-event")
100 || m->is_mus_type ("crescendo-event"))
102 Direction d = to_dir (m->get_property ("span-direction"));
104 accepted_spanevents_drul_[d] = m;
105 if (current_cresc_ev_ && d == START)
106 accepted_spanevents_drul_[STOP] = m;
113 Dynamic_engraver::process_music ()
115 if (accepted_spanevents_drul_[START] || accepted_spanevents_drul_[STOP] || script_ev_)
119 Music *rq = accepted_spanevents_drul_[START];
120 line_spanner_ = make_spanner ("DynamicLineSpanner", rq ? rq->self_scm () : SCM_EOL);
128 During a (de)crescendo, pending event will not be cleared,
129 and a line-spanner will always be created, as \< \! are already
132 Note: line-spanner must always have at least same duration
133 as (de)crecsendo, b.o. line-breaking.
137 maybe we should leave dynamic texts to the text-engraver and
138 simply acknowledge them?
142 script_ = make_item ("DynamicText", script_ev_->self_scm ());
143 script_->set_property ("text",
144 script_ev_->get_property ("text"));
146 if (Direction d = to_dir (script_ev_->get_property ("direction")))
147 set_grob_direction (line_spanner_, d);
149 Axis_group_interface::add_element (line_spanner_, script_);
152 Music *stop_ev = accepted_spanevents_drul_ [STOP]
153 ? accepted_spanevents_drul_[STOP] : script_ev_;
155 if (accepted_spanevents_drul_[STOP] || script_ev_)
158 finish side position alignment if the (de)cresc ends here, and
159 there are no new dynamics.
164 assert (!finished_cresc_ && cresc_);
168 cresc_->set_bound (RIGHT, script_);
169 add_bound_item (line_spanner_, script_);
172 finished_cresc_ = cresc_;
174 current_cresc_ev_ = 0;
176 else if (accepted_spanevents_drul_[STOP])
178 accepted_spanevents_drul_[STOP]->origin ()->warning (_ ("can't find start of (de)crescendo"));
183 if (accepted_spanevents_drul_[START])
185 if (current_cresc_ev_)
187 String msg = _ ("already have a decrescendo");
188 if (current_cresc_ev_->is_mus_type ("decrescendo-event"))
189 msg = _ ("already have a crescendo");
191 accepted_spanevents_drul_[START]->origin ()->warning (msg);
192 current_cresc_ev_->origin ()->warning (_ ("cresc starts here"));
196 current_cresc_ev_ = accepted_spanevents_drul_[START];
198 if (Direction d = to_dir (current_cresc_ev_->get_property ("direction")))
199 set_grob_direction (line_spanner_, d);
206 = ly_symbol2string (current_cresc_ev_->get_property ("name"));
211 if (start_type == "DecrescendoEvent")
212 start_type = "decrescendo";
213 else if (start_type == "CrescendoEvent")
214 start_type = "crescendo";
216 SCM s = get_property ((start_type + "Spanner").to_str0 ());
217 if (!scm_is_symbol (s) || s == ly_symbol2scm ("hairpin"))
219 cresc_ = make_spanner ("Hairpin", accepted_spanevents_drul_[START]->self_scm ());
222 Pointer_group_interface::add_grob (finished_cresc_,
223 ly_symbol2scm ("adjacent-hairpins"),
226 Pointer_group_interface::add_grob (cresc_,
227 ly_symbol2scm ("adjacent-hairpins"),
230 cresc_->set_property ("grow-direction",
231 scm_int2num ((start_type == "crescendo")
232 ? BIGGER : SMALLER));
236 This is a convenient (and legacy) interface to TextSpanners
237 for use in (de)crescendi.
242 cresc_ = make_spanner ("DynamicTextSpanner", accepted_spanevents_drul_[START]->self_scm ());
243 cresc_->set_property ("style", s);
244 context ()->set_property ((start_type
245 + "Spanner").to_str0 (), SCM_EOL);
246 s = get_property ((start_type + "Text").to_str0 ());
248 FIXME: use get_markup () to check type.
250 if (scm_is_string (s) || scm_is_pair (s))
252 cresc_->set_property ("edge-text",
253 scm_cons (s, scm_makfrom0str ("")));
254 context ()->set_property ((start_type + "Text").to_str0 (),
261 cresc_->set_bound (LEFT, script_);
262 add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
265 Axis_group_interface::add_element (line_spanner_, cresc_);
271 Dynamic_engraver::stop_translation_timestep ()
273 if (!current_cresc_ev_ && line_spanner_)
275 assert (!finished_line_spanner_);
276 finished_line_spanner_ = line_spanner_;
282 if (cresc_ && !cresc_->get_bound (LEFT))
284 cresc_->set_bound (LEFT, unsmob_grob (get_property ("currentMusicalColumn")));
285 add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
289 accepted_spanevents_drul_[START] = 0;
290 accepted_spanevents_drul_[STOP] = 0;
294 Dynamic_engraver::finalize ()
299 && !line_spanner_->is_live ())
303 finished_line_spanner_ = line_spanner_;
308 && !cresc_->is_live ())
312 current_cresc_ev_->origin ()->warning (_ ("unterminated (de)crescendo"));
319 Dynamic_engraver::typeset_all ()
323 if (!finished_cresc_->get_bound (RIGHT))
325 finished_cresc_->set_bound (RIGHT, script_
327 : unsmob_grob (get_property ("currentMusicalColumn")));
329 if (finished_line_spanner_)
330 add_bound_item (finished_line_spanner_,
331 finished_cresc_->get_bound (RIGHT));
337 if (finished_line_spanner_)
342 extend-spanner-over-elements (finished_line_spanner_);
344 but this is rather kludgy, since finished_line_spanner_
345 typically has a staff-symbol field set , extending it over the
350 Grob *l = finished_line_spanner_->get_bound (LEFT);
351 Grob *r = finished_line_spanner_->get_bound (RIGHT);
353 finished_line_spanner_->set_bound (RIGHT, l);
355 finished_line_spanner_->set_bound (LEFT, r);
359 This is a isolated dynamic apparently, and does not even have
360 any interesting support item.
362 Grob *cc = unsmob_grob (get_property ("currentMusicalColumn"));
363 Item *ci = dynamic_cast<Item *> (cc);
364 finished_line_spanner_->set_bound (RIGHT, ci);
365 finished_line_spanner_->set_bound (LEFT, ci);
368 finished_line_spanner_ = 0;
373 Dynamic_engraver::acknowledge_note_column (Grob_info info)
379 /* Don't refill killed spanner */
380 && line_spanner_->is_live ())
382 Side_position_interface::add_support (line_spanner_, info.grob ());
383 add_bound_item (line_spanner_, dynamic_cast<Item *> (info.grob ()));
386 if (script_ && !script_->get_parent (X_AXIS))
388 extract_grob_set (info.grob (), "note-heads", heads);
391 Grob *head = heads[0];
392 script_->set_parent (head, X_AXIS);
393 script_->add_offset_callback (Self_alignment_interface::centered_on_parent_proc,
401 if (!cresc_->get_bound (LEFT))
403 cresc_->set_bound (LEFT, info.grob ());
404 add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
408 if (finished_cresc_ && !finished_cresc_->get_bound (RIGHT))
410 finished_cresc_->set_bound (RIGHT, info.grob ());
415 Dynamic_engraver::acknowledge_script (Grob_info info)
417 if (!line_spanner_ || !script_)
420 SCM p = info.grob ()->get_property ("script-priority");
425 DynamicText doesn't really have a script-priority field.
427 if (scm_is_number (p)
429 < scm_to_int (script_->get_property ("script-priority")))
430 Side_position_interface::add_support (line_spanner_, info.grob ());
434 ADD_ACKNOWLEDGER(Dynamic_engraver,script);
435 ADD_ACKNOWLEDGER(Dynamic_engraver,note_column);
437 ADD_TRANSLATOR (Dynamic_engraver,
439 "This engraver creates hairpins, dynamic texts, and their vertical\n"
440 "alignments. The symbols are collected onto a DynamicLineSpanner grob\n"
441 "which takes care of vertical positioning. ",
443 /* creats*/ "DynamicLineSpanner DynamicText Hairpin TextSpanner",
444 /* accepts */ "absolute-dynamic-event crescendo-event decrescendo-event",