2 piano-pedal-engraver.cc -- implement Piano_pedal_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 2000--2009 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"
29 #include "translator.icc"
37 * Junk hardcoded sustain/sostenuto/una_corda distinction;
38 Softcode using (list (sustain-event SustainPedal PianoPedalBracket) ... )
40 * Try to use same engraver for dynamics.
44 /* Ugh: This declaration is duplicated in piano-pedal-performer */
53 Static precalculated data (symbols and strings) for the different
56 struct Pedal_type_info
63 const char *pedal_c_str_;
67 event_class_sym_ = SCM_EOL;
69 strings_sym_ = SCM_EOL;
74 scm_gc_protect_object (event_class_sym_);
75 scm_gc_protect_object (style_sym_);
76 scm_gc_protect_object (strings_sym_);
82 const Pedal_type_info *type_;
85 Event for currently running pedal.
87 Stream_event *current_bracket_ev_;
90 Event for currently starting pedal, (necessary?
92 distinct from current_bracket_ev_, since current_bracket_ev_ only
93 necessary for brackets, not for text style.
95 Stream_event *start_ev_;
98 Events that were found in this timestep.
100 Drul_array<Stream_event *> event_drul_;
102 Spanner *bracket_; // A single portion of a pedal bracket
103 Spanner *finished_bracket_;
106 static Pedal_type_info pedal_types_[NUM_PEDAL_TYPES];
108 class Piano_pedal_engraver : public Engraver
111 TRANSLATOR_DECLARATIONS (Piano_pedal_engraver);
114 virtual void initialize ();
115 virtual void finalize ();
116 DECLARE_TRANSLATOR_LISTENER (sustain);
117 DECLARE_TRANSLATOR_LISTENER (una_corda);
118 DECLARE_TRANSLATOR_LISTENER (sostenuto);
119 DECLARE_ACKNOWLEDGER (note_column);
120 void stop_translation_timestep ();
121 void process_music ();
124 Pedal_info info_list_[NUM_PEDAL_TYPES + 1];
126 void create_text_grobs (Pedal_info *p, bool);
127 void create_bracket_grobs (Pedal_info *p, bool);
128 void typeset_all (Pedal_info *p);
135 const char *names [NUM_PEDAL_TYPES];
136 names[SOSTENUTO] = "Sostenuto";
137 names[SUSTAIN] = "Sustain";
138 names[UNA_CORDA] = "UnaCorda";
140 for (int i = 0; i < NUM_PEDAL_TYPES; i++)
142 const char *name = names[i];
144 string base_name = name;
146 string base_ident = "";
149 for (cur_pos = 1; name[cur_pos]; cur_pos++)
150 if (isupper (name[cur_pos]))
152 base_ident = base_ident + String_convert::to_lower (string (name, prev_pos, cur_pos - prev_pos)) + "-";
155 base_ident += String_convert::to_lower (string (name, prev_pos, cur_pos - prev_pos));
158 be careful, as we don't want to loose references to the _sym_ members.
160 Pedal_type_info info;
161 info.event_class_sym_ = scm_str2symbol ((base_ident + "-event").c_str ());
162 info.style_sym_ = scm_str2symbol (("pedal" + base_name + "Style").c_str ());
163 info.strings_sym_ = scm_str2symbol (("pedal" + base_name + "Strings").c_str ());
165 info.base_name_ = name;
166 info.pedal_c_str_ = strdup ((base_name + "Pedal").c_str ());
170 pedal_types_[i] = info;
174 ADD_SCM_INIT_FUNC (Piano_pedal_engraver_init_pedal_types_, init_pedal_types);
176 Piano_pedal_engraver::Piano_pedal_engraver ()
181 Piano_pedal_engraver::initialize ()
183 for (int i = 0; i < NUM_PEDAL_TYPES; i++)
185 Pedal_type_info *s = &pedal_types_[i];
186 Pedal_info *info = &info_list_[i];
191 info->finished_bracket_ = 0;
192 info->current_bracket_ev_ = 0;
193 info->event_drul_[START] = 0;
194 info->event_drul_[STOP] = 0;
197 info_list_[NUM_PEDAL_TYPES].type_ = 0;
206 Piano_pedal_engraver::acknowledge_note_column (Grob_info info)
208 for (Pedal_info *p = info_list_; p->type_; p++)
211 add_bound_item (p->bracket_, info.grob ());
212 if (p->finished_bracket_)
213 add_bound_item (p->finished_bracket_, info.grob ());
217 IMPLEMENT_TRANSLATOR_LISTENER (Piano_pedal_engraver, sostenuto);
219 Piano_pedal_engraver::listen_sostenuto (Stream_event *ev)
221 Direction d = to_dir (ev->get_property ("span-direction"));
222 ASSIGN_EVENT_ONCE (info_list_[SOSTENUTO].event_drul_[d], ev);
225 IMPLEMENT_TRANSLATOR_LISTENER (Piano_pedal_engraver, sustain);
227 Piano_pedal_engraver::listen_sustain (Stream_event *ev)
229 Direction d = to_dir (ev->get_property ("span-direction"));
230 ASSIGN_EVENT_ONCE (info_list_[SUSTAIN].event_drul_[d], ev);
233 IMPLEMENT_TRANSLATOR_LISTENER (Piano_pedal_engraver, una_corda);
235 Piano_pedal_engraver::listen_una_corda (Stream_event *ev)
237 Direction d = to_dir (ev->get_property ("span-direction"));
238 ASSIGN_EVENT_ONCE (info_list_[UNA_CORDA].event_drul_[d], ev);
242 Piano_pedal_engraver::process_music ()
244 for (Pedal_info *p = info_list_; p->type_; p++)
246 if (p->event_drul_[STOP] || p->event_drul_[START])
248 /* Choose the appropriate grobs to add to the line spanner
249 These can be text items or text-spanners
253 ugh, code dup, should read grob to create from other
256 bracket: |_________/\____|
258 mixed: Ped. _____/\____|
261 SCM style = internal_get_property (p->type_->style_sym_);
263 bool mixed = style == ly_symbol2scm ("mixed");
264 bool bracket = (mixed
265 || style == ly_symbol2scm ("bracket"));
266 bool text = (style == ly_symbol2scm ("text")
269 if (text && !p->item_)
270 create_text_grobs (p, mixed);
272 create_bracket_grobs (p, mixed);
278 Piano_pedal_engraver::create_text_grobs (Pedal_info *p, bool mixed)
281 SCM strings = internal_get_property (p->type_->strings_sym_);
283 if (scm_ilength (strings) < 3)
285 Stream_event *m = p->event_drul_[START];
286 if (!m) m = p->event_drul_ [STOP];
288 string msg = _f ("expect 3 strings for piano pedals, found: %ld",
289 scm_ilength (strings));
291 m->origin ()->warning (msg);
298 if (p->event_drul_[STOP] && p->event_drul_[START])
303 p->event_drul_[STOP]->origin ()->warning (_f ("cannot find start of piano pedal: `%s'", p->type_->base_name_.c_str ()));
305 s = scm_cadr (strings);
306 p->start_ev_ = p->event_drul_[START];
309 else if (p->event_drul_[STOP])
314 p->event_drul_[STOP]->origin ()->warning (_f ("cannot find start of piano pedal: `%s'", p->type_->base_name_.c_str ()));
316 s = scm_caddr (strings);
320 else if (p->event_drul_[START])
322 p->start_ev_ = p->event_drul_[START];
323 s = scm_car (strings);
326 if (scm_is_string (s))
328 const char *propname = p->type_->pedal_c_str_;
330 p->item_ = make_item (propname, (p->event_drul_[START]
331 ? p->event_drul_[START]
332 : p->event_drul_[STOP])->self_scm ());
334 p->item_->set_property ("text", s);
339 p->event_drul_[START] = 0;
340 p->event_drul_[STOP] = 0;
345 Piano_pedal_engraver::create_bracket_grobs (Pedal_info *p, bool mixed)
347 if (!p->bracket_ && p->event_drul_[STOP])
349 string msg = _f ("cannot find start of piano pedal bracket: `%s'", p->type_->base_name_.c_str ());
350 p->event_drul_[STOP]->origin ()->warning (msg);
351 p->event_drul_[STOP] = 0;
354 if (p->event_drul_[STOP])
356 assert (!p->finished_bracket_);
358 Grob *cmc = unsmob_grob (get_property ("currentMusicalColumn"));
360 if (!p->bracket_->get_bound (RIGHT))
361 p->bracket_->set_bound (RIGHT, cmc);
364 Set properties so that the stencil-creating function will
365 know whether the right edge should be flared ___/
368 if (!p->event_drul_[START])
370 SCM flare = p->bracket_->get_property ("bracket-flare");
371 if (scm_is_pair (flare))
372 p->bracket_->set_property ("bracket-flare", scm_cons (scm_car (flare),
373 scm_from_double (0)));
376 p->finished_bracket_ = p->bracket_;
379 announce_end_grob (p->finished_bracket_, p->event_drul_[STOP]->self_scm ());
381 p->current_bracket_ev_ = 0;
384 if (p->event_drul_[START])
386 p->start_ev_ = p->event_drul_[START];
387 p->current_bracket_ev_ = p->event_drul_[START];
389 p->bracket_ = make_spanner ("PianoPedalBracket", p->event_drul_[START]->self_scm ());
392 Set properties so that the stencil-creating function will
393 know whether the left edge should be flared \___
396 if (!p->finished_bracket_)
398 SCM flare = p->bracket_->get_property ("bracket-flare");
399 p->bracket_->set_property ("bracket-flare", scm_cons (scm_from_double (0), scm_cdr (flare)));
402 /* Set this property for 'mixed style' pedals, Ped._______/\ ,
403 so the stencil function will shorten the ____ line by the length of the Ped. text.
409 Mixed style: Store a pointer to the preceding text for use in
410 calculating the length of the line
415 WTF is pedal-text not the bound of the object? --hwn
418 p->bracket_->set_object ("pedal-text", p->item_->self_scm ());
422 p->event_drul_[START] = 0;
423 p->event_drul_[STOP] = 0;
427 Piano_pedal_engraver::finalize ()
429 for (Pedal_info *p = info_list_; p->type_; p++)
432 && !p->bracket_->is_live ())
437 SCM cc = get_property ("currentCommandColumn");
438 Item *c = unsmob_item (cc);
439 p->bracket_->set_bound (RIGHT, c);
441 p->finished_bracket_ = p->bracket_;
450 Piano_pedal_engraver::stop_translation_timestep ()
452 for (Pedal_info *p = info_list_; p->type_; p++)
456 if (p->bracket_ && !p->bracket_->get_bound (LEFT))
458 Grob *cmc = unsmob_grob (get_property ("currentMusicalColumn"));
460 if (!p->bracket_->get_bound (LEFT))
461 p->bracket_->set_bound (LEFT, cmc);
465 for (Pedal_info *p = info_list_; p->type_; p++)
467 p->event_drul_[STOP] = 0;
468 p->event_drul_[START] = 0;
473 Piano_pedal_engraver::typeset_all (Pedal_info *p)
478 if (p->finished_bracket_
479 && !p->finished_bracket_->is_live ())
480 p->finished_bracket_ = 0;
485 if (p->finished_bracket_)
487 Grob *r = p->finished_bracket_->get_bound (RIGHT);
489 p->finished_bracket_->set_bound (RIGHT, unsmob_grob (get_property ("currentMusicalColumn")));
491 p->finished_bracket_ = 0;
495 ADD_ACKNOWLEDGER (Piano_pedal_engraver, note_column);
497 ADD_TRANSLATOR (Piano_pedal_engraver,
499 "Engrave piano pedal symbols and brackets.",
508 "currentCommandColumn "
509 "pedalSostenutoStrings "
510 "pedalSostenutoStyle "
511 "pedalSustainStrings "
513 "pedalUnaCordaStrings "
514 "pedalUnaCordaStyle ",