X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fpiano-pedal-engraver.cc;h=29ca669ca2c77ac7f0306e061b6ec6d7f88c6591;hb=5b4b0d6e9a197e8f9eb085b7c2ad78b8be3e5cfc;hp=2a04aae68d32a98a8354e628df602f99b4d883de;hpb=8bca46bcb5abd57557cb7c2b5665a4926289dd6b;p=lilypond.git diff --git a/lily/piano-pedal-engraver.cc b/lily/piano-pedal-engraver.cc index 2a04aae68d..29ca669ca2 100644 --- a/lily/piano-pedal-engraver.cc +++ b/lily/piano-pedal-engraver.cc @@ -1,198 +1,249 @@ -/* - piano-pedal-engraver.cc -- implement Piano_pedal_engraver - - source file of the GNU LilyPond music typesetter - - (c) 2000--2004 Jan Nieuwenhuizen - - Chris Jackson - extended to support - bracketed pedals. +/* + piano-pedal-engraver.cc -- implement Piano_pedal_engraver + + source file of the GNU LilyPond music typesetter + + (c) 2000--2008 Jan Nieuwenhuizen , + Erik Sandberg + + Chris Jackson - extended to support + bracketed pedals. */ #include "engraver.hh" -#include "event.hh" -#include "grob.hh" -#include "item.hh" -#include "lily-guile.hh" -#include "side-position-interface.hh" -#include "staff-symbol-referencer.hh" -#include "item.hh" + #include "axis-group-interface.hh" #include "context.hh" - #include "directional-element-interface.hh" +#include "international.hh" +#include "lily-guile.hh" #include "note-column.hh" +#include "side-position-interface.hh" +#include "staff-symbol-referencer.hh" +#include "stream-event.hh" +#include "string-convert.hh" #include "warn.hh" +#include "spanner.hh" +#include "item.hh" + +#include "translator.icc" + +#include /* - Urgh. This engraver is too complex. rewrite. --hwn + TODO: + + * Junk hardcoded sustain/sostenuto/una_corda distinction; + Softcode using (list (sustain-event SustainPedal PianoPedalBracket) ... ) + + * Try to use same engraver for dynamics. + */ +/* Ugh: This declaration is duplicated in piano-pedal-performer */ +enum Pedal_type { + SOSTENUTO, + SUSTAIN, + UNA_CORDA, + NUM_PEDAL_TYPES +}; + +/* + Static precalculated data (symbols and strings) for the different + pedal types +*/ +struct Pedal_type_info +{ + string base_name_; + SCM event_class_sym_; + SCM style_sym_; + SCM strings_sym_; + + const char *pedal_c_str_; + + Pedal_type_info () + { + event_class_sym_ = SCM_EOL; + style_sym_ = SCM_EOL; + strings_sym_ = SCM_EOL; + pedal_c_str_ = 0; + } + void protect () + { + scm_gc_protect_object (event_class_sym_); + scm_gc_protect_object (style_sym_); + scm_gc_protect_object (strings_sym_); + } +}; + struct Pedal_info { - char const * name_; + const Pedal_type_info *type_; /* Event for currently running pedal. */ - Music* current_bracket_ev_; + Stream_event *current_bracket_ev_; /* Event for currently starting pedal, (necessary? - + distinct from current_bracket_ev_, since current_bracket_ev_ only necessary for brackets, not for text style. */ - Music* start_ev_; - + Stream_event *start_ev_; - /* Events that were found in this timestep. */ - Drul_array event_drul_; - Item* item_; - Spanner* bracket_; // A single portion of a pedal bracket - Spanner* finished_bracket_; - - /* - This grob contains all the pedals of the same type on the same staff - */ - Spanner* line_spanner_; - Spanner* finished_line_spanner_; + Drul_array event_drul_; + Item *item_; + Spanner *bracket_; // A single portion of a pedal bracket + Spanner *finished_bracket_; }; +static Pedal_type_info pedal_types_[NUM_PEDAL_TYPES]; class Piano_pedal_engraver : public Engraver { public: TRANSLATOR_DECLARATIONS (Piano_pedal_engraver); - ~Piano_pedal_engraver (); + protected: virtual void initialize (); virtual void finalize (); - virtual bool try_music (Music*); - virtual void stop_translation_timestep (); - virtual void acknowledge_grob (Grob_info); - virtual void process_music (); + DECLARE_TRANSLATOR_LISTENER (sustain); + DECLARE_TRANSLATOR_LISTENER (una_corda); + DECLARE_TRANSLATOR_LISTENER (sostenuto); + DECLARE_ACKNOWLEDGER (note_column); + void stop_translation_timestep (); + void process_music (); private: + Pedal_info info_list_[NUM_PEDAL_TYPES + 1]; - Pedal_info *info_list_; - - /* - Record a stack of the current pedal spanners, so if more than one pedal - occurs simultaneously then extra space can be added between them. - */ - - Link_array previous_; - void del_linespanner (Spanner*); - void create_text_grobs (Pedal_info *p, bool); void create_bracket_grobs (Pedal_info *p, bool); - void typeset_all (Pedal_info*p); + void typeset_all (Pedal_info *p); }; +static void +init_pedal_types () +{ + const char *names [NUM_PEDAL_TYPES]; + names[SOSTENUTO] = "Sostenuto"; + names[SUSTAIN] = "Sustain"; + names[UNA_CORDA] = "UnaCorda"; + + for (int i = 0; i < NUM_PEDAL_TYPES; i++) + { + const char *name = names[i]; + /* FooBar */ + string base_name = name; + /* foo-bar */ + string base_ident = ""; + int prev_pos=0; + int cur_pos; + for (cur_pos = 1; name[cur_pos]; cur_pos++) + if (isupper (name[cur_pos])) + { + base_ident = base_ident + String_convert::to_lower (string (name, prev_pos, cur_pos - prev_pos)) + "-"; + prev_pos = cur_pos; + } + base_ident += String_convert::to_lower (string (name, prev_pos, cur_pos - prev_pos)); + + /* + be careful, as we don't want to loose references to the _sym_ members. + */ + Pedal_type_info info; + info.event_class_sym_ = scm_str2symbol ((base_ident + "-event").c_str ()); + info.style_sym_ = scm_str2symbol (("pedal" + base_name + "Style").c_str ()); + info.strings_sym_ = scm_str2symbol (("pedal" + base_name + "Strings").c_str ()); + + info.base_name_ = name; + info.pedal_c_str_ = strdup ((base_name + "Pedal").c_str ()); + + info.protect (); + + pedal_types_[i] = info; + } +} + +ADD_SCM_INIT_FUNC (Piano_pedal_engraver_init_pedal_types_, init_pedal_types); + Piano_pedal_engraver::Piano_pedal_engraver () { - info_list_ = 0; } void Piano_pedal_engraver::initialize () { - char * names [] = { "Sostenuto", "Sustain", "UnaCorda", 0 }; - - info_list_ = new Pedal_info[sizeof (names)/ sizeof (const char*)]; - Pedal_info *p = info_list_; - - char **np = names ; - do + for (int i = 0; i < NUM_PEDAL_TYPES; i++) { - p->name_ = *np; - p->item_ = 0; - p->bracket_ = 0; - p->finished_bracket_ = 0; - p->line_spanner_ = 0; - p->finished_line_spanner_ = 0; - p->current_bracket_ev_ = 0; - p->event_drul_[START] = 0; - p->event_drul_[STOP] = 0; - p->start_ev_ = 0; - - p++; + Pedal_type_info *s = &pedal_types_[i]; + Pedal_info *info = &info_list_[i]; + + info->type_ = s; + info->item_ = 0; + info->bracket_ = 0; + info->finished_bracket_ = 0; + info->current_bracket_ev_ = 0; + info->event_drul_[START] = 0; + info->event_drul_[STOP] = 0; + info->start_ev_ = 0; } - while (* (np ++)); + info_list_[NUM_PEDAL_TYPES].type_ = 0; } -Piano_pedal_engraver::~Piano_pedal_engraver () -{ - delete[] info_list_; -} /* Urg: Code dup I'm a script */ void -Piano_pedal_engraver::acknowledge_grob (Grob_info info) +Piano_pedal_engraver::acknowledge_note_column (Grob_info info) { - for (Pedal_info*p = info_list_; p && p->name_; p ++) + for (Pedal_info *p = info_list_; p->type_; p++) { - if (Note_column::has_interface (info.grob_)) - { - if (p->line_spanner_) - { - Side_position_interface::add_support (p->line_spanner_, info.grob_); - add_bound_item (p->line_spanner_,info.grob_); - } - if (p->bracket_) - add_bound_item (p->bracket_,info.grob_); - if (p->finished_bracket_) - add_bound_item (p->finished_bracket_,info.grob_); - } + if (p->bracket_) + add_bound_item (p->bracket_, info.grob ()); + if (p->finished_bracket_) + add_bound_item (p->finished_bracket_, info.grob ()); } } -bool -Piano_pedal_engraver::try_music (Music *m) +IMPLEMENT_TRANSLATOR_LISTENER (Piano_pedal_engraver, sostenuto); +void +Piano_pedal_engraver::listen_sostenuto (Stream_event *ev) { - if (m->is_mus_type ("pedal-event")) - { - for (Pedal_info*p = info_list_; p->name_; p ++) - { - String nm = p->name_ + String ("Event"); - if (gh_equal_p (m->get_property ("name") , - gh_symbol2scm (nm.to_str0()))) - { - Direction d = to_dir (m->get_property ("span-direction")); - p->event_drul_[d] = m; - return true; - } - } - } - return false; + Direction d = to_dir (ev->get_property ("span-direction")); + ASSIGN_EVENT_ONCE (info_list_[SOSTENUTO].event_drul_[d], ev); +} + +IMPLEMENT_TRANSLATOR_LISTENER (Piano_pedal_engraver, sustain); +void +Piano_pedal_engraver::listen_sustain (Stream_event *ev) +{ + Direction d = to_dir (ev->get_property ("span-direction")); + ASSIGN_EVENT_ONCE (info_list_[SUSTAIN].event_drul_[d], ev); +} + +IMPLEMENT_TRANSLATOR_LISTENER (Piano_pedal_engraver, una_corda); +void +Piano_pedal_engraver::listen_una_corda (Stream_event *ev) +{ + Direction d = to_dir (ev->get_property ("span-direction")); + ASSIGN_EVENT_ONCE (info_list_[UNA_CORDA].event_drul_[d], ev); } void Piano_pedal_engraver::process_music () { - for (Pedal_info*p = info_list_; p && p->name_; p ++) + for (Pedal_info *p = info_list_; p->type_; p++) { if (p->event_drul_[STOP] || p->event_drul_[START]) { - if (!p->line_spanner_) - { - String name = String (p->name_) + "PedalLineSpanner"; - p->line_spanner_ = make_spanner (name.to_str0 ()); - - Music * rq = (p->event_drul_[START] ? p->event_drul_[START] : p->event_drul_[STOP]); - - - announce_grob (p->line_spanner_, rq->self_scm ()); - } - /* Choose the appropriate grobs to add to the line spanner These can be text items or text-spanners */ @@ -206,16 +257,14 @@ Piano_pedal_engraver::process_music () mixed: Ped. _____/\____| */ - - String prop = String ("pedal") + p->name_ + "Style"; - SCM style = get_property (prop.to_str0 ()); + SCM style = internal_get_property (p->type_->style_sym_); bool mixed = style == ly_symbol2scm ("mixed"); bool bracket = (mixed || style == ly_symbol2scm ("bracket")); bool text = (style == ly_symbol2scm ("text") || mixed); - + if (text && !p->item_) create_text_grobs (p, mixed); if (bracket) @@ -228,81 +277,60 @@ void Piano_pedal_engraver::create_text_grobs (Pedal_info *p, bool mixed) { SCM s = SCM_EOL; - SCM strings = get_property ( ("pedal" + String (p->name_) + "Strings").to_str0 ()); + SCM strings = internal_get_property (p->type_->strings_sym_); if (scm_ilength (strings) < 3) { - Music * m = p->event_drul_[START]; + Stream_event *m = p->event_drul_[START]; if (!m) m = p->event_drul_ [STOP]; - String msg = _ ("Need 3 strings for piano pedals. No pedal made. "); + string msg = _f ("expect 3 strings for piano pedals, found: %ld", + scm_ilength (strings)); if (m) m->origin ()->warning (msg); else warning (msg); - - return ; + + return; } - - if (p->event_drul_[STOP] && p->event_drul_[START]) + + if (p->event_drul_[STOP] && p->event_drul_[START]) { if (!mixed) { if (!p->start_ev_) - { - p->event_drul_[STOP]->origin ()->warning (_f ("can't find start of piano pedal: `%s'", p->name_)); - } + p->event_drul_[STOP]->origin ()->warning (_f ("cannot find start of piano pedal: `%s'", p->type_->base_name_.c_str ())); else - { - s = ly_cadr (strings); - } + s = scm_cadr (strings); p->start_ev_ = p->event_drul_[START]; } } else if (p->event_drul_[STOP]) - { + { if (!mixed) { if (!p->start_ev_) - { - p->event_drul_[STOP]->origin ()->warning (_f ("can't find start of piano pedal: `%s'", p->name_)); - } + p->event_drul_[STOP]->origin ()->warning (_f ("cannot find start of piano pedal: `%s'", p->type_->base_name_.c_str ())); else - { - s = ly_caddr (strings); - } + s = scm_caddr (strings); p->start_ev_ = 0; } } else if (p->event_drul_[START]) { p->start_ev_ = p->event_drul_[START]; - s = ly_car (strings); - if (!mixed) - { - /* - Code dup?! see below. - */ - if (previous_.size ()) - // add extra space below the previous already-occuring pedal - Side_position_interface::add_support (p->line_spanner_, - previous_.top ()); - previous_.push (p->line_spanner_); - } - } - - if (gh_string_p (s)) + s = scm_car (strings); + } + + if (scm_is_string (s)) { - String propname = String (p->name_) + "Pedal"; + const char *propname = p->type_->pedal_c_str_; + + p->item_ = make_item (propname, (p->event_drul_[START] + ? p->event_drul_[START] + : p->event_drul_[STOP])->self_scm ()); - p->item_ = make_item (propname.to_str0 ()); p->item_->set_property ("text", s); - Axis_group_interface::add_element (p->line_spanner_, p->item_); - - announce_grob (p->item_, - (p->event_drul_[START] - ? p->event_drul_[START] - : p->event_drul_[STOP])->self_scm ()); } if (!mixed) @@ -312,20 +340,19 @@ Piano_pedal_engraver::create_text_grobs (Pedal_info *p, bool mixed) } } - void Piano_pedal_engraver::create_bracket_grobs (Pedal_info *p, bool mixed) { if (!p->bracket_ && p->event_drul_[STOP]) { - String msg =_f ("can't find start of piano pedal bracket: `%s'", p->name_); + string msg = _f ("cannot find start of piano pedal bracket: `%s'", p->type_->base_name_.c_str ()); p->event_drul_[STOP]->origin ()->warning (msg); - p->event_drul_[STOP] = 0; + p->event_drul_[STOP] = 0; } if (p->event_drul_[STOP]) { - assert (!p->finished_bracket_); + assert (!p->finished_bracket_); Grob *cmc = unsmob_grob (get_property ("currentMusicalColumn")); @@ -340,12 +367,16 @@ Piano_pedal_engraver::create_bracket_grobs (Pedal_info *p, bool mixed) if (!p->event_drul_[START]) { SCM flare = p->bracket_->get_property ("bracket-flare"); - p->bracket_->set_property ("bracket-flare", scm_cons (gh_car (flare), - gh_double2scm (0))); + if (scm_is_pair (flare)) + p->bracket_->set_property ("bracket-flare", scm_cons (scm_car (flare), + scm_from_double (0))); } p->finished_bracket_ = p->bracket_; p->bracket_ = 0; + + announce_end_grob (p->finished_bracket_, p->event_drul_[STOP]->self_scm ()); + p->current_bracket_ev_ = 0; } @@ -354,7 +385,7 @@ Piano_pedal_engraver::create_bracket_grobs (Pedal_info *p, bool mixed) p->start_ev_ = p->event_drul_[START]; p->current_bracket_ev_ = p->event_drul_[START]; - p->bracket_ = make_spanner ("PianoPedalBracket"); + p->bracket_ = make_spanner ("PianoPedalBracket", p->event_drul_[START]->self_scm ()); /* Set properties so that the stencil-creating function will @@ -364,11 +395,10 @@ Piano_pedal_engraver::create_bracket_grobs (Pedal_info *p, bool mixed) if (!p->finished_bracket_) { SCM flare = p->bracket_->get_property ("bracket-flare"); - p->bracket_->set_property ("bracket-flare", scm_cons (gh_double2scm (0),gh_cdr (flare))); + p->bracket_->set_property ("bracket-flare", scm_cons (scm_from_double (0), scm_cdr (flare))); } - - /* Set this property for 'mixed style' pedals, Ped._______/\ , + /* Set this property for 'mixed style' pedals, Ped._______/\ , so the stencil function will shorten the ____ line by the length of the Ped. text. */ @@ -384,39 +414,7 @@ Piano_pedal_engraver::create_bracket_grobs (Pedal_info *p, bool mixed) WTF is pedal-text not the bound of the object? --hwn */ if (p->item_) - p->bracket_->set_property ("pedal-text", p->item_->self_scm ()); - } - - - /* - We do not use currentMusicalColumn for the left span-point. - If the column as accidentals (eg on a different stave), the - currentMusicalColumn is too wide, making the bracket too big. - - TODO: - - Hmm. What do we do when there are no notes when the spanner starts? - - TODO: - - what about the right span point? - - */ - Axis_group_interface::add_element (p->line_spanner_, p->bracket_); - announce_grob (p->bracket_, p->event_drul_[START]->self_scm ()); - - if (!p->event_drul_[STOP]) - { - - /* - code dup. --hwn. - - // position new pedal spanner below the current one - */ - if (previous_.size ()) - Side_position_interface::add_support (p->line_spanner_, previous_.top ()); - - previous_.push (p->line_spanner_); + p->bracket_->set_object ("pedal-text", p->item_->self_scm ()); } } @@ -426,137 +424,94 @@ Piano_pedal_engraver::create_bracket_grobs (Pedal_info *p, bool mixed) void Piano_pedal_engraver::finalize () -{ - for (Pedal_info*p = info_list_; p && p->name_; p ++) +{ + for (Pedal_info *p = info_list_; p->type_; p++) { - /* - suicide? - */ - if (p->line_spanner_ - && !p->line_spanner_->live ()) - p->line_spanner_ = 0; - if (p->bracket_ - && !p->bracket_->live ()) + && !p->bracket_->is_live ()) p->bracket_ = 0; - + if (p->bracket_) { SCM cc = get_property ("currentCommandColumn"); Item *c = unsmob_item (cc); - if (p->line_spanner_) - { - p->line_spanner_->set_bound (RIGHT, c); - } - p->bracket_ ->set_bound (RIGHT, c); + p->bracket_->set_bound (RIGHT, c); p->finished_bracket_ = p->bracket_; p->bracket_ = 0; - p->finished_line_spanner_ = p->line_spanner_; - p->line_spanner_ = 0; typeset_all (p); } - if (p->line_spanner_) - { - p->finished_line_spanner_ = p->line_spanner_; - typeset_all (p); - } } } -void -Piano_pedal_engraver::del_linespanner (Spanner *g) -{ - int idx = previous_.find_index (g); - if (idx >= 0) - previous_.del (idx); -} - void Piano_pedal_engraver::stop_translation_timestep () { - for (Pedal_info*p = info_list_; p && p->name_; p ++) + for (Pedal_info *p = info_list_; p->type_; p++) { - if (!p->bracket_) - { - p->finished_line_spanner_ = p->line_spanner_; - p->line_spanner_ = 0; - del_linespanner (p->finished_line_spanner_); - } typeset_all (p); + if (p->bracket_ && !p->bracket_->get_bound (LEFT)) + { + Grob *cmc = unsmob_grob (get_property ("currentMusicalColumn")); + + if (!p->bracket_->get_bound (LEFT)) + p->bracket_->set_bound (LEFT, cmc); + } } - - for (Pedal_info*p = info_list_; p->name_; p ++) + for (Pedal_info *p = info_list_; p->type_; p++) { p->event_drul_[STOP] = 0; p->event_drul_[START] = 0; } } - void -Piano_pedal_engraver::typeset_all (Pedal_info * p) +Piano_pedal_engraver::typeset_all (Pedal_info *p) { /* - Handle suicide. + Handle suicide. */ - if (p->finished_line_spanner_ - && !p->finished_line_spanner_->live ()) - p->finished_line_spanner_ = 0; if (p->finished_bracket_ - && !p->finished_bracket_->live ()) + && !p->finished_bracket_->is_live ()) p->finished_bracket_ = 0; - if (p->item_) - { - typeset_grob (p->item_); - p->item_ = 0; - } - + p->item_ = 0; + if (p->finished_bracket_) { - Grob * r = p->finished_bracket_->get_bound (RIGHT); + Grob *r = p->finished_bracket_->get_bound (RIGHT); if (!r) - { - p->finished_bracket_->set_bound (RIGHT, unsmob_grob (get_property ("currentMusicalColumn"))); - } - - typeset_grob (p->finished_bracket_); - - p->finished_bracket_ =0; - } + p->finished_bracket_->set_bound (RIGHT, unsmob_grob (get_property ("currentMusicalColumn"))); - if (p->finished_line_spanner_) - { - Grob * l = p->finished_line_spanner_->get_bound (LEFT); - Grob * r = p->finished_line_spanner_->get_bound (RIGHT); - if (!r && l) - p->finished_line_spanner_->set_bound (RIGHT, l); - else if (!l && r) - p->finished_line_spanner_->set_bound (LEFT, r); - else if (!r && !l) - { - Grob * cc = unsmob_grob (get_property ("currentMusicalColumn")); - Item * ci = dynamic_cast (cc); - p->finished_line_spanner_->set_bound (RIGHT, ci); - p->finished_line_spanner_->set_bound (LEFT, ci); - } - typeset_grob (p->finished_line_spanner_); - p->finished_line_spanner_ = 0; + p->finished_bracket_ = 0; } } -ENTER_DESCRIPTION (Piano_pedal_engraver, - /* descr */ "Engrave piano pedal symbols and brackets.", - /* creats*/ "SostenutoPedal SustainPedal UnaCordaPedal SostenutoPedalLineSpanner SustainPedalLineSpanner UnaCordaPedalLineSpanner", - /* accepts */ "pedal-event", - /* acks */ "note-column-interface", - /* reads */ "currentCommandColumn " - "pedalSostenutoStrings pedalSustainStrings " - "pedalUnaCordaStrings pedalSostenutoStyle " - "pedalSustainStyle pedalUnaCordaStyle", - /* write */ ""); +ADD_ACKNOWLEDGER (Piano_pedal_engraver, note_column); + +ADD_TRANSLATOR (Piano_pedal_engraver, + /* doc */ + "Engrave piano pedal symbols and brackets.", + + /* create */ + "PianoPedalBracket " + "SostenutoPedal " + "SustainPedal " + "UnaCordaPedal ", + + /* read */ + "currentCommandColumn " + "pedalSostenutoStrings " + "pedalSostenutoStyle " + "pedalSustainStrings " + "pedalSustainStyle " + "pedalUnaCordaStrings " + "pedalUnaCordaStyle ", + + /* write */ + "" + );