2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2000--2011 Jan Nieuwenhuizen <janneke@gnu.org>,
5 Erik Sandberg <mandolaerik@gmail.com>
7 Chris Jackson <chris@fluffhouse.org.uk> - extended to support
10 LilyPond is free software: you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation, either version 3 of the License, or
13 (at your option) any later version.
15 LilyPond is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
24 #include "engraver.hh"
26 #include "axis-group-interface.hh"
28 #include "directional-element-interface.hh"
29 #include "international.hh"
30 #include "lily-guile.hh"
31 #include "note-column.hh"
32 #include "side-position-interface.hh"
33 #include "staff-symbol-referencer.hh"
34 #include "stream-event.hh"
35 #include "string-convert.hh"
40 #include "translator.icc"
48 * Junk hardcoded sustain/sostenuto/una_corda distinction;
49 Softcode using (list (sustain-event SustainPedal PianoPedalBracket) ... )
51 * Try to use same engraver for dynamics.
55 /* Ugh: This declaration is duplicated in piano-pedal-performer */
64 Static precalculated data (symbols and strings) for the different
67 struct Pedal_type_info
74 const char *pedal_c_str_;
78 event_class_sym_ = SCM_EOL;
80 strings_sym_ = SCM_EOL;
85 scm_gc_protect_object (event_class_sym_);
86 scm_gc_protect_object (style_sym_);
87 scm_gc_protect_object (strings_sym_);
93 const Pedal_type_info *type_;
96 Event for currently running pedal.
98 Stream_event *current_bracket_ev_;
101 Event for currently starting pedal, (necessary?
103 distinct from current_bracket_ev_, since current_bracket_ev_ only
104 necessary for brackets, not for text style.
106 Stream_event *start_ev_;
109 Events that were found in this timestep.
111 Drul_array<Stream_event *> event_drul_;
113 Spanner *bracket_; // A single portion of a pedal bracket
114 Spanner *finished_bracket_;
117 static Pedal_type_info pedal_types_[NUM_PEDAL_TYPES];
119 class Piano_pedal_engraver : public Engraver
122 TRANSLATOR_DECLARATIONS (Piano_pedal_engraver);
125 virtual void initialize ();
126 virtual void finalize ();
127 DECLARE_TRANSLATOR_LISTENER (sustain);
128 DECLARE_TRANSLATOR_LISTENER (una_corda);
129 DECLARE_TRANSLATOR_LISTENER (sostenuto);
130 DECLARE_ACKNOWLEDGER (note_column);
131 void stop_translation_timestep ();
132 void process_music ();
135 Pedal_info info_list_[NUM_PEDAL_TYPES + 1];
137 void create_text_grobs (Pedal_info *p, bool);
138 void create_bracket_grobs (Pedal_info *p, bool);
139 void typeset_all (Pedal_info *p);
146 const char *names [NUM_PEDAL_TYPES];
147 names[SOSTENUTO] = "Sostenuto";
148 names[SUSTAIN] = "Sustain";
149 names[UNA_CORDA] = "UnaCorda";
151 for (int i = 0; i < NUM_PEDAL_TYPES; i++)
153 const char *name = names[i];
155 string base_name = name;
157 string base_ident = "";
160 for (cur_pos = 1; name[cur_pos]; cur_pos++)
161 if (isupper (name[cur_pos]))
163 base_ident = base_ident + String_convert::to_lower (string (name, prev_pos, cur_pos - prev_pos)) + "-";
166 base_ident += String_convert::to_lower (string (name, prev_pos, cur_pos - prev_pos));
169 be careful, as we don't want to loose references to the _sym_ members.
171 Pedal_type_info info;
172 info.event_class_sym_ = scm_from_locale_symbol ((base_ident + "-event").c_str ());
173 info.style_sym_ = scm_from_locale_symbol (("pedal" + base_name + "Style").c_str ());
174 info.strings_sym_ = scm_from_locale_symbol (("pedal" + base_name + "Strings").c_str ());
176 info.base_name_ = name;
177 info.pedal_c_str_ = strdup ((base_name + "Pedal").c_str ());
181 pedal_types_[i] = info;
185 ADD_SCM_INIT_FUNC (Piano_pedal_engraver_init_pedal_types_, init_pedal_types);
187 Piano_pedal_engraver::Piano_pedal_engraver ()
192 Piano_pedal_engraver::initialize ()
194 for (int i = 0; i < NUM_PEDAL_TYPES; i++)
196 Pedal_type_info *s = &pedal_types_[i];
197 Pedal_info *info = &info_list_[i];
202 info->finished_bracket_ = 0;
203 info->current_bracket_ev_ = 0;
204 info->event_drul_[START] = 0;
205 info->event_drul_[STOP] = 0;
208 info_list_[NUM_PEDAL_TYPES].type_ = 0;
217 Piano_pedal_engraver::acknowledge_note_column (Grob_info info)
219 for (Pedal_info *p = info_list_; p->type_; p++)
222 add_bound_item (p->bracket_, info.grob ());
223 if (p->finished_bracket_)
224 add_bound_item (p->finished_bracket_, info.grob ());
228 IMPLEMENT_TRANSLATOR_LISTENER (Piano_pedal_engraver, sostenuto);
230 Piano_pedal_engraver::listen_sostenuto (Stream_event *ev)
232 Direction d = to_dir (ev->get_property ("span-direction"));
233 ASSIGN_EVENT_ONCE (info_list_[SOSTENUTO].event_drul_[d], ev);
236 IMPLEMENT_TRANSLATOR_LISTENER (Piano_pedal_engraver, sustain);
238 Piano_pedal_engraver::listen_sustain (Stream_event *ev)
240 Direction d = to_dir (ev->get_property ("span-direction"));
241 ASSIGN_EVENT_ONCE (info_list_[SUSTAIN].event_drul_[d], ev);
244 IMPLEMENT_TRANSLATOR_LISTENER (Piano_pedal_engraver, una_corda);
246 Piano_pedal_engraver::listen_una_corda (Stream_event *ev)
248 Direction d = to_dir (ev->get_property ("span-direction"));
249 ASSIGN_EVENT_ONCE (info_list_[UNA_CORDA].event_drul_[d], ev);
253 Piano_pedal_engraver::process_music ()
255 for (Pedal_info *p = info_list_; p->type_; p++)
257 if (p->event_drul_[STOP] || p->event_drul_[START])
259 /* Choose the appropriate grobs to add to the line spanner
260 These can be text items or text-spanners
264 ugh, code dup, should read grob to create from other
267 bracket: |_________/\____|
269 mixed: Ped. _____/\____|
272 SCM style = internal_get_property (p->type_->style_sym_);
274 bool mixed = style == ly_symbol2scm ("mixed");
275 bool bracket = (mixed
276 || style == ly_symbol2scm ("bracket"));
277 bool text = (style == ly_symbol2scm ("text")
280 if (text && !p->item_)
281 create_text_grobs (p, mixed);
283 create_bracket_grobs (p, mixed);
289 Piano_pedal_engraver::create_text_grobs (Pedal_info *p, bool mixed)
292 SCM strings = internal_get_property (p->type_->strings_sym_);
294 if (scm_ilength (strings) < 3)
296 Stream_event *m = p->event_drul_[START];
297 if (!m) m = p->event_drul_ [STOP];
299 string msg = _f ("expect 3 strings for piano pedals, found: %ld",
300 scm_ilength (strings));
302 m->origin ()->warning (msg);
309 if (p->event_drul_[STOP] && p->event_drul_[START])
314 p->event_drul_[STOP]->origin ()->warning (_f ("cannot find start of piano pedal: `%s'", p->type_->base_name_.c_str ()));
316 s = scm_cadr (strings);
317 p->start_ev_ = p->event_drul_[START];
320 else if (p->event_drul_[STOP])
325 p->event_drul_[STOP]->origin ()->warning (_f ("cannot find start of piano pedal: `%s'", p->type_->base_name_.c_str ()));
327 s = scm_caddr (strings);
331 else if (p->event_drul_[START])
333 p->start_ev_ = p->event_drul_[START];
334 s = scm_car (strings);
337 if (scm_is_string (s))
339 const char *propname = p->type_->pedal_c_str_;
341 p->item_ = make_item (propname, (p->event_drul_[START]
342 ? p->event_drul_[START]
343 : p->event_drul_[STOP])->self_scm ());
345 p->item_->set_property ("text", s);
350 p->event_drul_[START] = 0;
351 p->event_drul_[STOP] = 0;
356 Piano_pedal_engraver::create_bracket_grobs (Pedal_info *p, bool mixed)
358 if (!p->bracket_ && p->event_drul_[STOP])
360 string msg = _f ("cannot find start of piano pedal bracket: `%s'", p->type_->base_name_.c_str ());
361 p->event_drul_[STOP]->origin ()->warning (msg);
362 p->event_drul_[STOP] = 0;
365 if (p->event_drul_[STOP])
367 assert (!p->finished_bracket_);
369 Grob *cmc = unsmob_grob (get_property ("currentMusicalColumn"));
371 if (!p->bracket_->get_bound (RIGHT))
372 p->bracket_->set_bound (RIGHT, cmc);
375 Set properties so that the stencil-creating function will
376 know whether the right edge should be flared ___/
379 if (!p->event_drul_[START])
381 SCM flare = p->bracket_->get_property ("bracket-flare");
382 if (scm_is_pair (flare))
383 p->bracket_->set_property ("bracket-flare", scm_cons (scm_car (flare),
384 scm_from_double (0)));
387 p->finished_bracket_ = p->bracket_;
390 announce_end_grob (p->finished_bracket_, p->event_drul_[STOP]->self_scm ());
392 p->current_bracket_ev_ = 0;
395 if (p->event_drul_[START])
397 p->start_ev_ = p->event_drul_[START];
398 p->current_bracket_ev_ = p->event_drul_[START];
400 p->bracket_ = make_spanner ("PianoPedalBracket", p->event_drul_[START]->self_scm ());
403 Set properties so that the stencil-creating function will
404 know whether the left edge should be flared \___
407 if (!p->finished_bracket_)
409 SCM flare = p->bracket_->get_property ("bracket-flare");
410 p->bracket_->set_property ("bracket-flare", scm_cons (scm_from_double (0), scm_cdr (flare)));
413 /* Set this property for 'mixed style' pedals, Ped._______/\ ,
414 so the stencil function will shorten the ____ line by the length of the Ped. text.
420 Mixed style: Store a pointer to the preceding text for use in
421 calculating the length of the line
426 WTF is pedal-text not the bound of the object? --hwn
429 p->bracket_->set_object ("pedal-text", p->item_->self_scm ());
433 p->event_drul_[START] = 0;
434 p->event_drul_[STOP] = 0;
438 Piano_pedal_engraver::finalize ()
440 for (Pedal_info *p = info_list_; p->type_; p++)
443 && !p->bracket_->is_live ())
448 SCM cc = get_property ("currentCommandColumn");
449 Item *c = unsmob_item (cc);
450 p->bracket_->set_bound (RIGHT, c);
452 p->finished_bracket_ = p->bracket_;
461 Piano_pedal_engraver::stop_translation_timestep ()
463 for (Pedal_info *p = info_list_; p->type_; p++)
467 if (p->bracket_ && !p->bracket_->get_bound (LEFT))
469 Grob *cmc = unsmob_grob (get_property ("currentMusicalColumn"));
471 if (!p->bracket_->get_bound (LEFT))
472 p->bracket_->set_bound (LEFT, cmc);
476 for (Pedal_info *p = info_list_; p->type_; p++)
478 p->event_drul_[STOP] = 0;
479 p->event_drul_[START] = 0;
484 Piano_pedal_engraver::typeset_all (Pedal_info *p)
489 if (p->finished_bracket_
490 && !p->finished_bracket_->is_live ())
491 p->finished_bracket_ = 0;
496 if (p->finished_bracket_)
498 Grob *r = p->finished_bracket_->get_bound (RIGHT);
500 p->finished_bracket_->set_bound (RIGHT, unsmob_grob (get_property ("currentMusicalColumn")));
502 p->finished_bracket_ = 0;
506 ADD_ACKNOWLEDGER (Piano_pedal_engraver, note_column);
508 ADD_TRANSLATOR (Piano_pedal_engraver,
510 "Engrave piano pedal symbols and brackets.",
519 "currentCommandColumn "
520 "pedalSostenutoStrings "
521 "pedalSostenutoStyle "
522 "pedalSustainStrings "
524 "pedalUnaCordaStrings "
525 "pedalUnaCordaStyle ",