2 dynamic-engraver.cc -- implement Dynamic_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2004 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 "group-interface.hh"
18 #include "new-slur.hh"
19 #include "note-column.hh"
20 #include "paper-column.hh"
21 #include "script-interface.hh"
22 #include "side-position-interface.hh"
23 #include "staff-symbol-referencer.hh"
29 * direction of text-dynamic-event if not equal to direction of
32 - TODO: this engraver is too complicated. We should split it into
33 the handling of the basic grobs and the linespanner
35 - 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_;
50 Spanner *finished_line_spanner_;
51 Spanner *finished_cresc_;
54 Music *current_cresc_ev_;
56 Drul_array<Music*> accepted_spanreqs_drul_;
58 Link_array<Note_column> pending_columns_;
59 Link_array<Grob> pending_elements_;
63 TRANSLATOR_DECLARATIONS (Dynamic_engraver);
66 virtual void finalize ();
67 virtual void acknowledge_grob (Grob_info);
68 virtual bool try_music (Music *req);
69 virtual void stop_translation_timestep ();
70 virtual void process_music ();
76 Dynamic_engraver::Dynamic_engraver ()
82 finished_line_spanner_ = 0;
83 current_cresc_ev_ = 0;
87 accepted_spanreqs_drul_[START] = 0;
88 accepted_spanreqs_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_spanreqs_drul_[d] = m;
108 if (current_cresc_ev_ && d == START)
109 accepted_spanreqs_drul_[STOP] = m;
116 Dynamic_engraver::process_music ()
118 if (accepted_spanreqs_drul_[START] || accepted_spanreqs_drul_[STOP] || script_ev_)
122 Music * rq = accepted_spanreqs_drul_[START];
123 line_spanner_ = make_spanner ("DynamicLineSpanner", rq ? rq->self_scm (): SCM_EOL );
131 During a (de)crescendo, pending event will not be cleared,
132 and a line-spanner will always be created, as \< \! are already
135 Note: line-spanner must always have at least same duration
136 as (de)crecsendo, b.o. line-breaking.
142 maybe we should leave dynamic texts to the text-engraver and
143 simply acknowledge them?
147 script_ = make_item ("DynamicText", script_ev_->self_scm ());
148 script_->set_property ("text",
149 script_ev_->get_property ("text"));
152 if (Direction d = to_dir (script_ev_->get_property ("direction")))
153 set_grob_direction (line_spanner_, d);
155 Axis_group_interface::add_element (line_spanner_, script_);
158 Music *stop_ev = accepted_spanreqs_drul_ [STOP] ?
159 accepted_spanreqs_drul_[STOP] : script_ev_;
161 if (accepted_spanreqs_drul_[STOP] || script_ev_)
164 finish side position alignment if the (de)cresc ends here, and
165 there are no new dynamics.
171 assert (!finished_cresc_ && cresc_);
173 cresc_->set_bound (RIGHT, script_
175 : unsmob_grob (get_property ("currentMusicalColumn")));
176 add_bound_item (line_spanner_, cresc_->get_bound (RIGHT));
179 finished_cresc_ = cresc_;
181 current_cresc_ev_ = 0;
183 else if (accepted_spanreqs_drul_[STOP])
185 accepted_spanreqs_drul_[STOP]->origin ()->warning (_ ("can't find start of (de)crescendo"));
191 if (accepted_spanreqs_drul_[START])
193 if (current_cresc_ev_)
195 String msg = _ ("already have a decrescendo");
196 if (current_cresc_ev_->is_mus_type ("decrescendo-event"))
197 msg = _ ("already have a crescendo");
199 accepted_spanreqs_drul_[START]->origin ()->warning (msg);
200 current_cresc_ev_->origin ()->warning (_("Cresc started here"));
204 current_cresc_ev_ = accepted_spanreqs_drul_[START];
206 if (Direction d = to_dir (current_cresc_ev_->get_property ("direction")))
207 set_grob_direction (line_spanner_, d);
214 ly_symbol2string (current_cresc_ev_->get_property ("name"));
219 if (start_type == "DecrescendoEvent")
220 start_type = "decrescendo";
221 else if (start_type == "CrescendoEvent")
222 start_type = "crescendo";
224 SCM s = get_property ((start_type + "Spanner").to_str0 ());
225 if (!ly_c_symbol_p (s) || s == ly_symbol2scm ("hairpin"))
227 cresc_ = make_spanner ("Hairpin", accepted_spanreqs_drul_[START]->self_scm ());
228 cresc_->set_property ("grow-direction",
229 scm_int2num ((start_type == "crescendo")
230 ? BIGGER : SMALLER));
236 This is a convenient (and legacy) interface to TextSpanners
237 for use in (de)crescendi.
242 cresc_ = make_spanner ("DynamicTextSpanner", accepted_spanreqs_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 (ly_c_string_p (s) || ly_c_pair_p (s))
252 cresc_->set_property ("edge-text",
253 scm_cons (s, scm_makfrom0str ("")));
254 context ()->set_property ((start_type + "Text").to_str0 (),
259 cresc_->set_bound (LEFT, script_
261 : unsmob_grob (get_property ("currentMusicalColumn")));
263 Axis_group_interface::add_element (line_spanner_, cresc_);
265 add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
271 Dynamic_engraver::stop_translation_timestep ()
274 if (!current_cresc_ev_)
277 finished_line_spanner_ = line_spanner_;
284 accepted_spanreqs_drul_[START] = 0;
285 accepted_spanreqs_drul_[STOP] = 0;
289 Dynamic_engraver::finalize ()
294 && !line_spanner_->is_live ())
298 finished_line_spanner_ = line_spanner_;
303 && !cresc_->is_live ())
307 current_cresc_ev_->origin ()->warning (_ ("unterminated (de)crescendo"));
314 Dynamic_engraver::typeset_all ()
316 /* Simplistic slur collision handling. This fixes simple collisions
321 which are unacceptable, but it most probably breaks for more
322 interesting cases. Maybe make a new colission engraver. */
323 if (finished_line_spanner_ && slur_
324 && get_slur_dir (slur_) == get_grob_direction (finished_line_spanner_))
326 Real ss = Staff_symbol_referencer::staff_space (finished_line_spanner_);
327 Real pad = robust_scm2double (finished_line_spanner_->get_property ("padding"), 0);
328 /* FIXME: 1ss padding hardcoded */
329 finished_line_spanner_->set_property ("padding",
330 scm_make_real (pad + ss));
335 if (!finished_cresc_->get_bound (RIGHT))
337 finished_cresc_->set_bound (RIGHT, script_
339 : unsmob_grob (get_property ("currentMusicalColumn")));
341 if (finished_line_spanner_)
342 add_bound_item (finished_line_spanner_,
343 finished_cresc_->get_bound (RIGHT));
349 if (finished_line_spanner_)
354 extend-spanner-over-elements (finished_line_spanner_);
356 but this is rather kludgy, since finished_line_spanner_
357 typically has a staff-symbol field set , extending it over the
362 Grob * l = finished_line_spanner_->get_bound (LEFT);
363 Grob * r = finished_line_spanner_->get_bound (RIGHT);
365 finished_line_spanner_->set_bound (RIGHT, l);
367 finished_line_spanner_->set_bound (LEFT, r);
371 This is a isolated dynamic apparently, and does not even have
372 any interesting support item.
374 Grob * cc = unsmob_grob (get_property ("currentMusicalColumn"));
375 Item * ci = dynamic_cast<Item*>(cc);
376 finished_line_spanner_->set_bound (RIGHT, ci);
377 finished_line_spanner_->set_bound (LEFT, ci);
380 finished_line_spanner_ = 0;
385 Dynamic_engraver::acknowledge_grob (Grob_info i)
390 if (Note_column::has_interface (i.grob_))
393 /* Don't refill killed spanner */
394 && line_spanner_->is_live ())
396 Side_position_interface::add_support (line_spanner_,i.grob_);
397 add_bound_item (line_spanner_,dynamic_cast<Item*> (i.grob_));
400 if (script_ && !script_->get_parent (X_AXIS))
402 SCM head = scm_last_pair (i.grob_->get_property ("note-heads"));
403 if (ly_c_pair_p (head))
404 script_->set_parent (unsmob_grob (ly_car (head)), X_AXIS);
407 else if (Script_interface::has_interface (i.grob_) && script_)
409 SCM p = i.grob_->get_property ("script-priority");
414 DynamicText doesn't really have a script-priority field.
416 if (ly_c_number_p (p)
418 < ly_scm2int (script_->get_property ("script-priority")))
419 Side_position_interface::add_support (line_spanner_, i.grob_);
421 else if (New_slur::has_interface (i.grob_) && line_spanner_)
425 ENTER_DESCRIPTION (Dynamic_engraver,
427 "This engraver creates hairpins, dynamic texts, and their vertical\n"
428 "alignments. The symbols are collected onto a DynamicLineSpanner grob\n"
429 "which takes care of vertical positioning. "
432 /* creats*/ "DynamicLineSpanner DynamicText Hairpin TextSpanner",
433 /* accepts */ "absolute-dynamic-event crescendo-event decrescendo-event",
434 /* acks */ "note-column-interface script-interface new-slur-interface",