-/*
- piano-pedal-engraver.cc -- implement Piano_pedal_engraver
-
- source file of the GNU LilyPond music typesetter
-
- (c) 2000 Jan Nieuwenhuizen <janneke@gnu.org>
- */
+/*
+ This file is part of LilyPond, the GNU music typesetter.
+
+ Copyright (C) 2000--2015 Jan Nieuwenhuizen <janneke@gnu.org>,
+ Erik Sandberg <mandolaerik@gmail.com>
+
+ Chris Jackson <chris@fluffhouse.org.uk> - extended to support
+ bracketed pedals.
+
+ LilyPond is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
+*/
#include "engraver.hh"
-#include "musical-request.hh"
-#include "score-element.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 "rhythmic-head.hh"
-#include "stem.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 <string.h>
/*
- TODO:
- * it would be really cool if an engraver could be initialised with a
- string, ie:
+ TODO:
- Piano_pedal_engraver::"sostenuto"
- Piano_pedal_engraver::"sustain"
- Piano_pedal_engraver::"una-chorda"
+ * 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
+};
/*
- Would it? The semantics are unclear, and real benefits are muddy
- too. --hwn
+ 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
+{
+ const Pedal_type_info *type_;
+
+ /*
+ Event for currently running pedal.
+ */
+ 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.
+ */
+ Stream_event *start_ev_;
+
+ /*
+ Events that were found in this timestep.
+ */
+ Drul_array<Stream_event *> 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];
-/**
- engrave Piano pedals symbols.
- */
class Piano_pedal_engraver : public Engraver
{
public:
- VIRTUAL_COPY_CONS (Translator);
- Piano_pedal_engraver ();
- ~Piano_pedal_engraver ();
+ TRANSLATOR_DECLARATIONS (Piano_pedal_engraver);
+
protected:
- virtual void do_creation_processing ();
- virtual bool do_try_music (Music*);
- virtual void do_process_music ();
- virtual void do_pre_move_processing ();
- virtual void do_post_move_processing ();
- virtual void acknowledge_element (Score_element_info);
+ virtual void initialize ();
+ virtual void finalize ();
+ DECLARE_TRANSLATOR_LISTENER (sustain);
+ DECLARE_TRANSLATOR_LISTENER (una_corda);
+ DECLARE_TRANSLATOR_LISTENER (sostenuto);
+ void stop_translation_timestep ();
+ void process_music ();
private:
- struct Pedal_info
- {
- char const * name_;
- Span_req* start_req_l_;
- Drul_array<Span_req*> req_l_drul_;
- Item* item_p_;
- };
+ Pedal_info info_list_[NUM_PEDAL_TYPES + 1];
-
- Pedal_info *info_list_;
+ void create_text_grobs (Pedal_info *p, bool);
+ void create_bracket_grobs (Pedal_info *p, bool);
+ void typeset_all (Pedal_info *p);
};
-ADD_THIS_TRANSLATOR (Piano_pedal_engraver);
+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_from_locale_symbol ((base_ident + "-event").c_str ());
+ info.style_sym_ = scm_from_locale_symbol (("pedal" + base_name + "Style").c_str ());
+ info.strings_sym_ = scm_from_locale_symbol (("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::do_creation_processing()
+Piano_pedal_engraver::initialize ()
{
- info_list_ = new Pedal_info[4];
- Pedal_info *p = info_list_;
-
-
- char * names [] = { "Sostenuto", "Sustain", "UnaChorda", 0 };
- char **np = names ;
- do
+ for (int i = 0; i < NUM_PEDAL_TYPES; i++)
{
- p->name_ = *np;
- p->item_p_ = 0;
- p->req_l_drul_[START] = 0;
- p->req_l_drul_[STOP] = 0;
- p->start_req_l_ = 0;
+ Pedal_type_info *s = &pedal_types_[i];
+ Pedal_info *info = &info_list_[i];
- p++;
+ 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()
+IMPLEMENT_TRANSLATOR_LISTENER (Piano_pedal_engraver, sostenuto);
+void
+Piano_pedal_engraver::listen_sostenuto (Stream_event *ev)
{
- delete[] info_list_;
+ Direction d = to_dir (ev->get_property ("span-direction"));
+ ASSIGN_EVENT_ONCE (info_list_[SOSTENUTO].event_drul_[d], ev);
}
-/*
- Urg: Code dup
- I'm a script
- */
+IMPLEMENT_TRANSLATOR_LISTENER (Piano_pedal_engraver, sustain);
void
-Piano_pedal_engraver::acknowledge_element (Score_element_info info)
-{
- for (Pedal_info*p = info_list_; p->name_; p ++)
- {
- if (p->item_p_)
- {
- if (Rhythmic_head::has_interface (info.elem_l_))
- {
- Side_position::add_support (p->item_p_, info.elem_l_);
-
- if (Side_position::get_axis(p->item_p_) == X_AXIS
- && !p->item_p_->parent_l (Y_AXIS))
- p->item_p_->set_parent (info.elem_l_, Y_AXIS);
- }
- if (Stem::has_interface (info.elem_l_))
- {
- Side_position::add_support (p->item_p_,info.elem_l_);
- }
- }
+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->type_; p++)
+ {
+ if (p->event_drul_[STOP] || p->event_drul_[START])
+ {
+ /* Choose the appropriate grobs to add to the line spanner
+ These can be text items or text-spanners
+ */
+
+ /*
+ ugh, code dup, should read grob to create from other
+ property.
+
+ bracket: |_________/\____|
+ text: Ped. *Ped. *
+ mixed: Ped. _____/\____|
+ */
+
+ SCM style = 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)
+ create_bracket_grobs (p, mixed);
+ }
}
}
-bool
-Piano_pedal_engraver::do_try_music (Music *m)
+void
+Piano_pedal_engraver::create_text_grobs (Pedal_info *p, bool mixed)
{
- if (Span_req * s = dynamic_cast<Span_req*>(m))
+ SCM s = SCM_EOL;
+ SCM strings = get_property (p->type_->strings_sym_);
+
+ if (scm_ilength (strings) < 3)
{
- for (Pedal_info*p = info_list_; p->name_; p ++)
- {
- if (s->span_type_str_ == p->name_)
- {
- p->req_l_drul_[s->span_dir_] = s;
- return true;
- }
- }
+ Stream_event *m = p->event_drul_[START];
+ if (!m) m = p->event_drul_ [STOP];
+
+ string msg = _f ("expect 3 strings for piano pedals, found: %ld",
+ scm_ilength (strings));
+ if (m)
+ m->origin ()->warning (msg);
+ else
+ warning (msg);
+
+ return;
+ }
+
+ if (p->event_drul_[STOP] && p->event_drul_[START])
+ {
+ if (!mixed)
+ {
+ if (!p->start_ev_)
+ p->event_drul_[STOP]->origin ()->warning (_f ("cannot find start of piano pedal: `%s'", p->type_->base_name_.c_str ()));
+ else
+ 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 ("cannot find start of piano pedal: `%s'", p->type_->base_name_.c_str ()));
+ else
+ s = scm_caddr (strings);
+ p->start_ev_ = 0;
+ }
+ }
+ else if (p->event_drul_[START])
+ {
+ p->start_ev_ = p->event_drul_[START];
+ s = scm_car (strings);
+ }
+
+ if (scm_is_string (s))
+ {
+ 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_->set_property ("text", s);
+ }
+
+ if (!mixed)
+ {
+ p->event_drul_[START] = 0;
+ p->event_drul_[STOP] = 0;
}
- return false;
}
void
-Piano_pedal_engraver::do_process_music ()
-{
- for (Pedal_info*p = info_list_; p->name_; p ++)
- {
- SCM s = SCM_UNDEFINED;
- if (p->req_l_drul_[STOP] && p->req_l_drul_[START])
- {
- if (!p->start_req_l_)
- {
- p->req_l_drul_[STOP]->origin ()->warning (_f ("can't find start of piano pedal: %s", p->name_ ));
- }
- else
- {
- s = get_property (("stopStart" + String (p->name_ )).ch_C());
- }
- p->start_req_l_ = p->req_l_drul_[START];
- }
- else if (p->req_l_drul_[STOP])
- {
- if (!p->start_req_l_)
- {
- p->req_l_drul_[STOP]->origin ()->warning (_f ("can't find start of piano pedal: %s", p->name_ ));
- }
- else
- {
- s = get_property (("stop" + String (p->name_ )).ch_C());
- }
- p->start_req_l_ = 0;
- }
- else if (p->req_l_drul_[START])
- {
- p->start_req_l_ = p->req_l_drul_[START];
- s = get_property (("start" + String (p->name_ )).ch_C());
- }
-
- if (gh_string_p (s))
- {
- String propname = String (p->name_) + "Pedal";
- p->item_p_ = new Item (get_property (propname.ch_C()));
- p->item_p_->set_elt_property ("text", s);
-
- announce_element (p->item_p_,
- p->req_l_drul_[START]
- ? p->req_l_drul_[START]
- : p->req_l_drul_[STOP]);
- }
+Piano_pedal_engraver::create_bracket_grobs (Pedal_info *p, bool mixed)
+{
+ if (!p->bracket_ && p->event_drul_[STOP])
+ {
+ 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;
+ }
+
+ if (p->event_drul_[STOP])
+ {
+ assert (!p->finished_bracket_);
+
+ Grob *cmc = Grob::unsmob (get_property ("currentMusicalColumn"));
+ p->bracket_->set_bound (RIGHT, cmc);
+
+ /*
+ Set properties so that the stencil-creating function will
+ know whether the right edge should be flared ___/
+ */
+
+ if (!p->event_drul_[START])
+ {
+ SCM flare = p->bracket_->get_property ("bracket-flare");
+ 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;
+ }
+
+ if (p->event_drul_[START])
+ {
+ p->start_ev_ = p->event_drul_[START];
+ p->current_bracket_ev_ = p->event_drul_[START];
+
+ p->bracket_ = make_spanner ("PianoPedalBracket", p->event_drul_[START]->self_scm ());
+
+ /*
+ Set properties so that the stencil-creating function will
+ know whether the left edge should be flared \___
+ */
+
+ if (!p->finished_bracket_)
+ {
+ SCM flare = p->bracket_->get_property ("bracket-flare");
+ p->bracket_->set_property ("bracket-flare", scm_cons (scm_from_double (0), scm_cdr (flare)));
+ }
+
+ /* Set this property for 'mixed style' pedals, Ped._______/\ ,
+ so the stencil function will shorten the ____ line by the length of the Ped. text.
+ */
+
+ if (mixed)
+ {
+ /*
+ Mixed style: Store a pointer to the preceding text for use in
+ calculating the length of the line
+
+
+ TODO:
+
+ WTF is pedal-text not the bound of the object? --hwn
+ */
+ if (p->item_)
+ p->bracket_->set_object ("pedal-text", p->item_->self_scm ());
+ }
+ }
+
+ p->event_drul_[START] = 0;
+ p->event_drul_[STOP] = 0;
+}
+
+void
+Piano_pedal_engraver::finalize ()
+{
+ for (Pedal_info *p = info_list_; p->type_; p++)
+ {
+ if (p->bracket_
+ && !p->bracket_->is_live ())
+ p->bracket_ = 0;
+
+ if (p->bracket_)
+ {
+ SCM cc = get_property ("currentCommandColumn");
+ Item *c = Item::unsmob (cc);
+ p->bracket_->set_bound (RIGHT, c);
+
+ p->finished_bracket_ = p->bracket_;
+ p->bracket_ = 0;
+ typeset_all (p);
+ }
+
}
}
void
-Piano_pedal_engraver::do_pre_move_processing ()
-{
- Item * sustain = 0;
- for (Pedal_info*p = info_list_; p->name_; p ++)
- {
- if (p->name_ == String ("Sustain"))
- sustain = p->item_p_;
- }
-
- for (Pedal_info*p = info_list_; p->name_; p ++)
- {
- if (p->item_p_)
- {
- Side_position::add_staff_support (p->item_p_);
- /*
- Hmm.
- */
- if (p->name_ != String ("Sustain"))
- {
- if (sustain)
- {
- Side_position::add_support (p->item_p_,sustain);
- }
- }
- typeset_element (p->item_p_);
- }
- p->item_p_ = 0;
+Piano_pedal_engraver::stop_translation_timestep ()
+{
+ for (Pedal_info *p = info_list_; p->type_; p++)
+ {
+
+ typeset_all (p);
+ if (p->bracket_ && !p->bracket_->get_bound (LEFT))
+ {
+ Grob *cmc = Grob::unsmob (get_property ("currentMusicalColumn"));
+ p->bracket_->set_bound (LEFT, cmc);
+ }
+ }
+
+ for (Pedal_info *p = info_list_; p->type_; p++)
+ {
+ p->event_drul_[STOP] = 0;
+ p->event_drul_[START] = 0;
}
}
void
-Piano_pedal_engraver::do_post_move_processing ()
+Piano_pedal_engraver::typeset_all (Pedal_info *p)
{
- for (Pedal_info*p = info_list_; p->name_; p ++)
+ /*
+ Handle suicide.
+ */
+ if (p->finished_bracket_
+ && !p->finished_bracket_->is_live ())
+ p->finished_bracket_ = 0;
+
+ if (p->item_)
+ p->item_ = 0;
+
+ if (p->finished_bracket_)
{
- p->req_l_drul_[STOP] = 0;
- p->req_l_drul_[START] = 0;
+ Grob *r = p->finished_bracket_->get_bound (RIGHT);
+ if (!r)
+ p->finished_bracket_->set_bound (RIGHT, Grob::unsmob (get_property ("currentMusicalColumn")));
+
+ p->finished_bracket_ = 0;
}
}
+
+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 */
+ ""
+ );
projects / lilypond.git / blobdiff