/*
- chord-name-engraver.cc -- implement Chord_name_engraver
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 1998--2015 Jan Nieuwenhuizen <janneke@gnu.org>
- (c) 1998 Jan Nieuwenhuizen <janneke@gnu.org>
-*/
+ 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.
-#include "chord-name-engraver.hh"
-#include "musical-request.hh"
-#include "paper-def.hh"
-#include "lookup.hh"
-#include "paper-def.hh"
-#include "main.hh"
-#include "dimensions.hh"
-#include "g-text-item.hh"
+ 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.
-ADD_THIS_TRANSLATOR (Chord_name_engraver);
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
+*/
-Chord_name_engraver::Chord_name_engraver ()
+#include "chord-name.hh"
+#include "context.hh"
+#include "dimensions.hh"
+#include "engraver.hh"
+#include "font-interface.hh"
+#include "item.hh"
+#include "output-def.hh"
+#include "pitch.hh"
+#include "protected-scm.hh"
+#include "stream-event.hh"
+#include "text-interface.hh"
+#include "warn.hh"
+
+#include "translator.icc"
+
+class Chord_name_engraver : public Engraver
{
-}
+ TRANSLATOR_DECLARATIONS (Chord_name_engraver);
+protected:
+ void stop_translation_timestep ();
+ void process_music ();
+ virtual void finalize ();
+ void listen_note (Stream_event *);
+ void listen_rest (Stream_event *);
+private:
+ vector<Stream_event *> notes_;
+
+ Stream_event *rest_event_;
+};
void
-Chord_name_engraver::acknowledge_element (Score_element_info i)
+Chord_name_engraver::finalize ()
{
- if (Note_req* n = dynamic_cast<Note_req*> (i.req_l_))
- pitch_arr_.push (n->pitch_);
}
-bool
-Chord_name_engraver::do_try_music (Music* m)
+Chord_name_engraver::Chord_name_engraver (Context *c)
+ : Engraver (c)
{
- if (Note_req* n = dynamic_cast<Note_req*> (m))
- {
- pitch_arr_.push (n->pitch_);
- return true;
- }
- return false;
+ rest_event_ = 0;
}
- /*
- find tonic: after longest line of triads
- */
-int
-Chord_name_engraver::find_tonic_i () const
+void
+Chord_name_engraver::process_music ()
{
- int tonic_i = 0;
- int longest_i = 0;
- for (int i = 0; i < pitch_arr_.size (); i++)
- for (int j = 0; j < pitch_arr_.size (); j++)
- {
- int gap = pitch_arr_[(i + j + 1) % pitch_arr_.size ()].notename_i_
- - pitch_arr_[(i + j) % pitch_arr_.size ()].notename_i_;
- while (gap < 0)
- gap += 7;
- gap %= 7;
- if (gap != 2)
- {
- if (j > longest_i)
- {
- longest_i = j;
- tonic_i = i;
- }
- break;
- }
- }
-
- int biggest_i = 0;
- if (!longest_i)
- for (int i = 0; i < pitch_arr_.size (); i++)
- {
- int gap = pitch_arr_[i].notename_i_
- - pitch_arr_[(i - 1 + pitch_arr_.size ())
- % pitch_arr_.size ()].notename_i_;
- while (gap < 0)
- gap += 7;
- gap %= 7;
- if (gap > biggest_i)
- {
- biggest_i = gap;
- tonic_i = i;
- }
- }
- return tonic_i;
-}
+ if (!rest_event_ && notes_.empty ())
+ return;
-Array<Musical_pitch>
-Chord_name_engraver::rebuild_pitch_arr (int tonic_i) const
-{
- Musical_pitch last (0, 0, -5);
- Array<Musical_pitch> pitches;
- for (int i = 0; i < pitch_arr_.size (); i++)
+ SCM markup;
+ SCM bass = SCM_EOL;
+ SCM inversion = SCM_EOL;
+ SCM pitches = SCM_EOL;
+ Item *chord_name = 0;
+
+ // rest events present a hen-and-egg problem with regard to
+ // overriding the text property of the ChordName grob since we
+ // cannot create a ChordName grob, look at its text property and, if
+ // not set, use noChordSymbol to decide whether we should not have
+ // created the grob in the first place.
+ if (rest_event_)
{
- Musical_pitch p = pitch_arr_[(tonic_i + i) % pitch_arr_.size ()];
- if (p < last)
- {
- p.octave_i_ = last.octave_i_;
- if (p < last)
- p.octave_i_++;
- }
- pitches.push (p);
- last = p;
+ SCM no_chord_markup = get_property ("noChordSymbol");
+ if (!Text_interface::is_markup (no_chord_markup))
+ return;
+ markup = no_chord_markup;
+ chord_name = make_item ("ChordName", rest_event_->self_scm ());
+ chord_name->set_property ("text", markup);
}
- return pitches;
-}
-
-void
-Chord_name_engraver::do_process_requests ()
-{
- if (text_p_arr_.size ())
- return;
- if (!pitch_arr_.size ())
- return;
+ else
+ {
+ chord_name = make_item ("ChordName", notes_[0]->self_scm ());
+ // We cannot actually delay fetching the text property in case
+ // it is a callback since we need to compare the generated
+ // markups for the sake of chordChanges
+ markup = chord_name->get_property ("text");
+ if (!Text_interface::is_markup (markup))
+ {
+ for (vsize i = 0; i < notes_.size (); i++)
+ {
+ Stream_event *n = notes_[i];
+ SCM p = n->get_property ("pitch");
+ if (!unsmob<Pitch> (p))
+ continue;
+
+ if (to_boolean (n->get_property ("bass")))
+ bass = p;
+ else
+ {
+ SCM oct = n->get_property ("octavation");
+ if (scm_is_number (oct))
+ {
+ Pitch orig = unsmob<Pitch> (p)->transposed (Pitch (-scm_to_int (oct), 0));
+ pitches = scm_cons (orig.smobbed_copy (), pitches);
+ }
+ else
+ pitches = scm_cons (p, pitches);
+ if (to_boolean (n->get_property ("inversion")))
+ {
+ inversion = p;
+ if (!scm_is_number (oct))
+ programming_error ("inversion does not have original pitch");
+ }
+ }
+ }
- /*
- Banter style chord names (almost).
- TODO:
- - move this stuff to new Item class Chord_name
- - switch on property, add american (?) chordNameStyle
+ pitches = scm_sort_list (pitches, Pitch::less_p_proc);
- Scalar chordNameStyle = get_property ("chordNameStyle", 0);
- if (chordNameStyle == "Banter")
- chord = pitches_to_banter (pitch_arr_));
+ SCM name_proc = get_property ("chordNameFunction");
+ markup = scm_call_4 (name_proc, pitches, bass, inversion,
+ context ()->self_scm ());
+ if (!Text_interface::is_markup (markup))
+ {
+ // Ugh, we created a grob, now we better populate it.
+ // Use an empty string.
+ markup = scm_string (SCM_EOL);
+ }
+ chord_name->set_property ("text", markup);
+ }
+ }
- */
+ SCM chord_changes = get_property ("chordChanges");
+ SCM last_chord = get_property ("lastChord");
+ if (to_boolean (chord_changes) && ly_is_equal (markup, last_chord))
+ chord_name->set_property ("begin-of-line-visible", SCM_BOOL_T);
- int tonic_i = 0;
- Musical_pitch inversion = pitch_arr_[0];
- Scalar chord_inversions = get_property ("chordInversion", 0);
- if (chord_inversions.to_bool ())
- {
- tonic_i = find_tonic_i ();
- if (tonic_i)
- pitch_arr_ = rebuild_pitch_arr (tonic_i);
- }
-
-
- G_text_item* item_p = new G_text_item;
-
- item_p->text_str_ = banter_str (pitch_arr_, tonic_i, inversion);
-
- Scalar style = get_property ("textstyle", 0);
- if (style.length_i ())
- item_p->style_str_ = style;
-
- text_p_arr_.push (item_p);
- announce_element (Score_element_info (item_p, 0));
+ context ()->set_property ("lastChord", markup);
}
void
-Chord_name_engraver::do_pre_move_processing ()
+Chord_name_engraver::listen_note (Stream_event *ev)
{
- for (int i=0; i < text_p_arr_.size (); i++)
- {
- typeset_element (text_p_arr_[i]);
- }
- text_p_arr_.clear ();
- pitch_arr_.clear ();
+ notes_.push_back (ev);
}
-String
-Chord_name_engraver::banter_str (Array<Musical_pitch> pitch_arr, int tonic_i, Musical_pitch inversion) const
+void
+Chord_name_engraver::listen_rest (Stream_event *ev)
{
- Musical_pitch tonic = pitch_arr[0];
-
- Array<Musical_pitch> scale;
- scale.push (Musical_pitch (0)); // c
- scale.push (Musical_pitch (1)); // d
- scale.push (Musical_pitch (2)); // e
- scale.push (Musical_pitch (3)); // f
- scale.push (Musical_pitch (4)); // g
- scale.push (Musical_pitch (5)); // a
- // 7 always means 7-...
- scale.push (Musical_pitch (6, -1)); // b
-
-
- for (int i = 0; i < scale.size (); i++)
- scale[i].transpose (tonic);
-
- //urg, should do translation in scheme.
- char const *acc[] = {"\\textflat\\textflat ", "\\textflat ", "", "\\textsharp " , "\\textsharp\\textsharp "};
- String tonic_str = tonic.str ();
- tonic_str = tonic_str.left_str (1).upper_str ()
- + acc[tonic.accidental_i_ + 2];
-
- String add_str;
- String sub_str;
- String sep_str;
- int last_trap = 1;
- for (int i=1; i < pitch_arr.size (); i++)
- {
- Musical_pitch p = pitch_arr[i];
- int trap = p.notename_i_ - tonic.notename_i_
- + (p.octave_i_ - tonic.octave_i_) * 7 + 1;
- while (trap - last_trap > 2)
- {
- last_trap += 2;
- sub_str += sep_str + "no" + to_str (last_trap);
- sep_str = "/";
- }
- last_trap = trap;
- int accidental = p.accidental_i_ - scale[(trap - 1) % 7].accidental_i_;
- if ((trap == 3) && (accidental == -1))
- tonic_str += "m"; // hmm
- else if (accidental || (!(trap % 2) || ((i + 1 == pitch_arr.size ()) && (trap > 5))))
- {
- add_str += sep_str;
- if ((trap == 7) && (accidental == 1))
- add_str += "maj7";
- else
- {
- add_str += to_str (trap);
- if (accidental)
- add_str += accidental < 0 ? "-" : "+";
- }
- sep_str = "/";
- }
- }
-
- String inversion_str;
- if (tonic_i)
- {
- inversion_str = inversion.str ();
- inversion_str = "/" + inversion_str.left_str (1).upper_str ()
- + acc[tonic.accidental_i_ + 2];
+ ASSIGN_EVENT_ONCE (rest_event_, ev);
+}
- }
+void
+Chord_name_engraver::stop_translation_timestep ()
+{
+ notes_.clear ();
+ rest_event_ = 0;
+}
- String str = tonic_str + "$^{" + add_str + sub_str + "}$" + inversion_str;
- return str;
+/*
+ The READs description is not strictly accurate:
+ which properties are read depend on the chord naming function active.
+*/
+void
+Chord_name_engraver::boot ()
+{
+ ADD_LISTENER (Chord_name_engraver, note);
+ ADD_LISTENER (Chord_name_engraver, rest);
}
+
+ADD_TRANSLATOR (Chord_name_engraver,
+ /* doc */
+ "Catch note and rest events and generate the appropriate chordname.",
+
+ /* create */
+ "ChordName ",
+
+ /* read */
+ "chordChanges "
+ "chordNameExceptions "
+ "chordNameFunction "
+ "chordNoteNamer "
+ "chordRootNamer "
+ "chordNameExceptions "
+ "lastChord "
+ "majorSevenSymbol "
+ "noChordSymbol ",
+
+ /* write */
+ "lastChord "
+ );
projects / lilypond.git / blobdiff