2 piano-pedal-engraver.cc -- implement Piano_pedal_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 2000--2006 Jan Nieuwenhuizen <janneke@gnu.org>,
7 Erik Sandberg <mandolaerik@gmail.com>
9 Chris Jackson <chris@fluffhouse.org.uk> - extended to support
13 #include "engraver.hh"
15 #include "axis-group-interface.hh"
17 #include "directional-element-interface.hh"
18 #include "international.hh"
19 #include "lily-guile.hh"
20 #include "note-column.hh"
21 #include "side-position-interface.hh"
22 #include "staff-symbol-referencer.hh"
23 #include "stream-event.hh"
24 #include "string-convert.hh"
26 #include "protected-scm.hh"
27 #include "translator.icc"
32 * Junk hardcoded sustain/sostenuto/una_corda distinction;
33 Softcode using (list (sustain-event SustainPedal PianoPedalBracket) ... )
35 * Try to use same engraver for dynamics.
39 /* Ugh: This declaration is duplicated in piano-pedal-performer */
40 typedef enum Pedal_type {
48 Static precalculated data (symbols and strings) for the different
51 struct Pedal_type_info
58 const char *pedal_c_str_;
62 event_class_sym_ = SCM_EOL;
64 strings_sym_ = SCM_EOL;
69 scm_gc_protect_object (event_class_sym_);
70 scm_gc_protect_object (style_sym_);
71 scm_gc_protect_object (strings_sym_);
77 const Pedal_type_info *type_;
80 Event for currently running pedal.
82 Stream_event *current_bracket_ev_;
85 Event for currently starting pedal, (necessary?
87 distinct from current_bracket_ev_, since current_bracket_ev_ only
88 necessary for brackets, not for text style.
90 Stream_event *start_ev_;
93 Events that were found in this timestep.
95 Drul_array<Stream_event *> event_drul_;
97 Spanner *bracket_; // A single portion of a pedal bracket
98 Spanner *finished_bracket_;
101 static Pedal_type_info pedal_types_[NUM_PEDAL_TYPES];
103 class Piano_pedal_engraver : public Engraver
106 TRANSLATOR_DECLARATIONS (Piano_pedal_engraver);
109 virtual void initialize ();
110 virtual void finalize ();
111 DECLARE_TRANSLATOR_LISTENER (sustain);
112 DECLARE_TRANSLATOR_LISTENER (una_corda);
113 DECLARE_TRANSLATOR_LISTENER (sostenuto);
114 DECLARE_ACKNOWLEDGER (note_column);
115 void stop_translation_timestep ();
116 void process_music ();
119 Pedal_info info_list_[NUM_PEDAL_TYPES + 1];
121 void create_text_grobs (Pedal_info *p, bool);
122 void create_bracket_grobs (Pedal_info *p, bool);
123 void typeset_all (Pedal_info *p);
130 const char *names [NUM_PEDAL_TYPES];
131 names[SOSTENUTO] = "Sostenuto";
132 names[SUSTAIN] = "Sustain";
133 names[UNA_CORDA] = "UnaCorda";
135 for (int i = 0; i < NUM_PEDAL_TYPES; i++)
137 const char *name = names[i];
139 string base_name = name;
141 string base_ident = "";
144 for (cur_pos = 1; name[cur_pos]; cur_pos++)
145 if (isupper (name[cur_pos]))
147 base_ident = base_ident + String_convert::to_lower (string (name, prev_pos, cur_pos - prev_pos)) + "-";
150 base_ident += String_convert::to_lower (string (name, prev_pos, cur_pos - prev_pos));
153 be careful, as we don't want to loose references to the _sym_ members.
155 Pedal_type_info info;
156 info.event_class_sym_ = scm_str2symbol ((base_ident + "-event").c_str ());
157 info.style_sym_ = scm_str2symbol (("pedal" + base_name + "Style").c_str ());
158 info.strings_sym_ = scm_str2symbol (("pedal" + base_name + "Strings").c_str ());
160 info.base_name_ = name;
161 info.pedal_c_str_ = strdup ((base_name + "Pedal").c_str ());
165 pedal_types_[i] = info;
169 ADD_SCM_INIT_FUNC (Piano_pedal_engraver_init_pedal_types_, init_pedal_types);
171 Piano_pedal_engraver::Piano_pedal_engraver ()
176 Piano_pedal_engraver::initialize ()
178 for (int i = 0; i < NUM_PEDAL_TYPES; i++)
180 Pedal_type_info *s = &pedal_types_[i];
181 Pedal_info *info = &info_list_[i];
186 info->finished_bracket_ = 0;
187 info->current_bracket_ev_ = 0;
188 info->event_drul_[START] = 0;
189 info->event_drul_[STOP] = 0;
192 info_list_[NUM_PEDAL_TYPES].type_ = 0;
201 Piano_pedal_engraver::acknowledge_note_column (Grob_info info)
203 for (Pedal_info *p = info_list_; p->type_; p++)
206 add_bound_item (p->bracket_, info.grob ());
207 if (p->finished_bracket_)
208 add_bound_item (p->finished_bracket_, info.grob ());
212 IMPLEMENT_TRANSLATOR_LISTENER (Piano_pedal_engraver, sostenuto);
214 Piano_pedal_engraver::listen_sostenuto (Stream_event *ev)
216 Direction d = to_dir (ev->get_property ("span-direction"));
217 ASSIGN_EVENT_ONCE (info_list_[SOSTENUTO].event_drul_[d], ev);
220 IMPLEMENT_TRANSLATOR_LISTENER (Piano_pedal_engraver, sustain);
222 Piano_pedal_engraver::listen_sustain (Stream_event *ev)
224 Direction d = to_dir (ev->get_property ("span-direction"));
225 ASSIGN_EVENT_ONCE (info_list_[SUSTAIN].event_drul_[d], ev);
228 IMPLEMENT_TRANSLATOR_LISTENER (Piano_pedal_engraver, una_corda);
230 Piano_pedal_engraver::listen_una_corda (Stream_event *ev)
232 Direction d = to_dir (ev->get_property ("span-direction"));
233 ASSIGN_EVENT_ONCE (info_list_[UNA_CORDA].event_drul_[d], ev);
237 Piano_pedal_engraver::process_music ()
239 for (Pedal_info *p = info_list_; p->type_; p++)
241 if (p->event_drul_[STOP] || p->event_drul_[START])
243 /* Choose the appropriate grobs to add to the line spanner
244 These can be text items or text-spanners
248 ugh, code dup, should read grob to create from other
251 bracket: |_________/\____|
253 mixed: Ped. _____/\____|
256 SCM style = internal_get_property (p->type_->style_sym_);
258 bool mixed = style == ly_symbol2scm ("mixed");
259 bool bracket = (mixed
260 || style == ly_symbol2scm ("bracket"));
261 bool text = (style == ly_symbol2scm ("text")
264 if (text && !p->item_)
265 create_text_grobs (p, mixed);
267 create_bracket_grobs (p, mixed);
273 Piano_pedal_engraver::create_text_grobs (Pedal_info *p, bool mixed)
276 SCM strings = internal_get_property (p->type_->strings_sym_);
278 if (scm_ilength (strings) < 3)
280 Stream_event *m = p->event_drul_[START];
281 if (!m) m = p->event_drul_ [STOP];
283 string msg = _f ("expect 3 strings for piano pedals, found: %ld",
284 scm_ilength (strings));
286 m->origin ()->warning (msg);
293 if (p->event_drul_[STOP] && p->event_drul_[START])
298 p->event_drul_[STOP]->origin ()->warning (_f ("can't find start of piano pedal: `%s'", p->type_->base_name_.c_str ()));
300 s = scm_cadr (strings);
301 p->start_ev_ = p->event_drul_[START];
304 else if (p->event_drul_[STOP])
309 p->event_drul_[STOP]->origin ()->warning (_f ("can't find start of piano pedal: `%s'", p->type_->base_name_.c_str ()));
311 s = scm_caddr (strings);
315 else if (p->event_drul_[START])
317 p->start_ev_ = p->event_drul_[START];
318 s = scm_car (strings);
321 if (scm_is_string (s))
323 const char *propname = p->type_->pedal_c_str_;
325 p->item_ = make_item (propname, (p->event_drul_[START]
326 ? p->event_drul_[START]
327 : p->event_drul_[STOP])->self_scm ());
329 p->item_->set_property ("text", s);
334 p->event_drul_[START] = 0;
335 p->event_drul_[STOP] = 0;
340 Piano_pedal_engraver::create_bracket_grobs (Pedal_info *p, bool mixed)
342 if (!p->bracket_ && p->event_drul_[STOP])
344 string msg = _f ("can't find start of piano pedal bracket: `%s'", p->type_->base_name_.c_str ());
345 p->event_drul_[STOP]->origin ()->warning (msg);
346 p->event_drul_[STOP] = 0;
349 if (p->event_drul_[STOP])
351 assert (!p->finished_bracket_);
353 Grob *cmc = unsmob_grob (get_property ("currentMusicalColumn"));
355 if (!p->bracket_->get_bound (RIGHT))
356 p->bracket_->set_bound (RIGHT, cmc);
359 Set properties so that the stencil-creating function will
360 know whether the right edge should be flared ___/
363 if (!p->event_drul_[START])
365 SCM flare = p->bracket_->get_property ("bracket-flare");
366 if (scm_is_pair (flare))
367 p->bracket_->set_property ("bracket-flare", scm_cons (scm_car (flare),
368 scm_from_double (0)));
371 p->finished_bracket_ = p->bracket_;
374 announce_end_grob (p->finished_bracket_, p->event_drul_[STOP]->self_scm ());
376 p->current_bracket_ev_ = 0;
379 if (p->event_drul_[START])
381 p->start_ev_ = p->event_drul_[START];
382 p->current_bracket_ev_ = p->event_drul_[START];
384 p->bracket_ = make_spanner ("PianoPedalBracket", p->event_drul_[START]->self_scm ());
387 Set properties so that the stencil-creating function will
388 know whether the left edge should be flared \___
391 if (!p->finished_bracket_)
393 SCM flare = p->bracket_->get_property ("bracket-flare");
394 p->bracket_->set_property ("bracket-flare", scm_cons (scm_from_double (0), scm_cdr (flare)));
397 /* Set this property for 'mixed style' pedals, Ped._______/\ ,
398 so the stencil function will shorten the ____ line by the length of the Ped. text.
404 Mixed style: Store a pointer to the preceding text for use in
405 calculating the length of the line
410 WTF is pedal-text not the bound of the object? --hwn
413 p->bracket_->set_object ("pedal-text", p->item_->self_scm ());
417 p->event_drul_[START] = 0;
418 p->event_drul_[STOP] = 0;
422 Piano_pedal_engraver::finalize ()
424 for (Pedal_info *p = info_list_; p->type_; p++)
427 && !p->bracket_->is_live ())
432 SCM cc = get_property ("currentCommandColumn");
433 Item *c = unsmob_item (cc);
434 p->bracket_->set_bound (RIGHT, c);
436 p->finished_bracket_ = p->bracket_;
445 Piano_pedal_engraver::stop_translation_timestep ()
447 for (Pedal_info *p = info_list_; p->type_; p++)
451 if (p->bracket_ && !p->bracket_->get_bound (LEFT))
453 Grob *cmc = unsmob_grob (get_property ("currentMusicalColumn"));
455 if (!p->bracket_->get_bound (LEFT))
456 p->bracket_->set_bound (LEFT, cmc);
460 for (Pedal_info *p = info_list_; p->type_; p++)
462 p->event_drul_[STOP] = 0;
463 p->event_drul_[START] = 0;
468 Piano_pedal_engraver::typeset_all (Pedal_info *p)
473 if (p->finished_bracket_
474 && !p->finished_bracket_->is_live ())
475 p->finished_bracket_ = 0;
480 if (p->finished_bracket_)
482 Grob *r = p->finished_bracket_->get_bound (RIGHT);
484 p->finished_bracket_->set_bound (RIGHT, unsmob_grob (get_property ("currentMusicalColumn")));
486 p->finished_bracket_ = 0;
490 ADD_ACKNOWLEDGER (Piano_pedal_engraver, note_column);
492 ADD_TRANSLATOR (Piano_pedal_engraver,
495 "Engrave piano pedal symbols and brackets.",
504 "currentCommandColumn "
505 "pedalSostenutoStrings "
506 "pedalSostenutoStyle "
507 "pedalSustainStrings "
509 "pedalUnaCordaStrings "
510 "pedalUnaCordaStyle",