lily/fretboard-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2006--2015 Han-Wen Nienhuys
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include <cctype>
  21 #include <cstdio>
  22
  23 #include "articulations.hh"
  24 #include "context.hh"
  25 #include "item.hh"
  26 #include "engraver.hh"
  27 #include "pitch.hh"
  28 #include "stream-event.hh"
  29 #include "warn.hh"
  30
  31 #include "translator.icc"
  32
  33 using std::vector;
  34
  35 /**
  36    make (guitar-like) tablature note
  37 */
  38 class Fretboard_engraver : public Engraver
  39 {
  40   Item *fret_board_;
  41
  42   vector<Stream_event *> note_events_;
  43   vector<Stream_event *> tabstring_events_;
  44   vector<Stream_event *> fingering_events_;
  45 public:
  46   TRANSLATOR_DECLARATIONS (Fretboard_engraver);
  47
  48 protected:
  49   void stop_translation_timestep ();
  50   void process_music ();
  51   virtual void derived_mark () const;
  52   DECLARE_TRANSLATOR_LISTENER (note);
  53   DECLARE_TRANSLATOR_LISTENER (string_number);
  54   DECLARE_TRANSLATOR_LISTENER (fingering);
  55
  56 private:
  57   SCM last_placements_;
  58 };
  59
  60 void
  61 Fretboard_engraver::derived_mark () const
  62 {
  63   scm_gc_mark (last_placements_);
  64 }
  65
  66 Fretboard_engraver::Fretboard_engraver ()
  67 {
  68   fret_board_ = 0;
  69   last_placements_ = SCM_BOOL_F;
  70 }
  71
  72 IMPLEMENT_TRANSLATOR_LISTENER (Fretboard_engraver, note);
  73 void
  74 Fretboard_engraver::listen_note (Stream_event *ev)
  75 {
  76   note_events_.push_back (ev);
  77 }
  78
  79 IMPLEMENT_TRANSLATOR_LISTENER (Fretboard_engraver, string_number);
  80 void
  81 Fretboard_engraver::listen_string_number (Stream_event *ev)
  82 {
  83   tabstring_events_.push_back (ev);
  84 }
  85
  86 IMPLEMENT_TRANSLATOR_LISTENER (Fretboard_engraver, fingering);
  87 void
  88 Fretboard_engraver::listen_fingering (Stream_event *ev)
  89 {
  90   fingering_events_.push_back (ev);
  91 }
  92
  93 void
  94 Fretboard_engraver::process_music ()
  95 {
  96   if (!note_events_.size ())
  97     return;
  98
  99   SCM tab_strings = articulation_list (note_events_,
 100                                        tabstring_events_,
 101                                        "string-number-event");
 102   SCM fingers = articulation_list (note_events_,
 103                                    fingering_events_,
 104                                    "fingering-event");
 105   fret_board_ = make_item ("FretBoard", note_events_[0]->self_scm ());
 106   SCM fret_notes = ly_cxx_vector_to_list (note_events_);
 107   SCM proc = get_property ("noteToFretFunction");
 108   if (ly_is_procedure (proc))
 109     scm_call_4 (proc,
 110                 context ()->self_scm (),
 111                 fret_notes,
 112                 scm_list_2 (tab_strings, fingers),
 113                 fret_board_->self_scm ());
 114   SCM changes = get_property ("chordChanges");
 115   SCM placements = fret_board_->get_property ("dot-placement-list");
 116   if (to_boolean (changes)
 117       && ly_is_equal (last_placements_, placements))
 118     fret_board_->set_property ("begin-of-line-visible", SCM_BOOL_T);
 119
 120   last_placements_ = placements;
 121 }
 122
 123 void
 124 Fretboard_engraver::stop_translation_timestep ()
 125 {
 126   fret_board_ = 0;
 127   note_events_.clear ();
 128   tabstring_events_.clear ();
 129   fingering_events_.clear ();
 130 }
 131
 132 ADD_TRANSLATOR (Fretboard_engraver,
 133                 /* doc */
 134                 "Generate fret diagram from one or more events of type"
 135                 " @code{NoteEvent}.",
 136
 137                 /* create */
 138                 "FretBoard ",
 139
 140                 /* read */
 141                 "chordChanges "
 142                 "defaultStrings "
 143                 "highStringOne "
 144                 "maximumFretStretch "
 145                 "minimumFret "
 146                 "noteToFretFunction "
 147                 "predefinedDiagramTable "
 148                 "stringTunings "
 149                 "tablatureFormat ",
 150
 151                 /* write */
 152                 ""
 153                );
 154