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 using namespace std;
  23
  24 #include "articulations.hh"
  25 #include "context.hh"
  26 #include "item.hh"
  27 #include "engraver.hh"
  28 #include "pitch.hh"
  29 #include "stream-event.hh"
  30 #include "warn.hh"
  31
  32 #include "translator.icc"
  33
  34 /**
  35    make (guitar-like) tablature note
  36 */
  37 class Fretboard_engraver : public Engraver
  38 {
  39   Item *fret_board_;
  40
  41   vector<Stream_event *> note_events_;
  42   vector<Stream_event *> tabstring_events_;
  43   vector<Stream_event *> fingering_events_;
  44 public:
  45   TRANSLATOR_DECLARATIONS (Fretboard_engraver);
  46
  47 protected:
  48   void stop_translation_timestep ();
  49   void process_music ();
  50   virtual void derived_mark () const;
  51   void listen_note (Stream_event *);
  52   void listen_string_number (Stream_event *);
  53   void listen_fingering (Stream_event *);
  54
  55 private:
  56   SCM last_placements_;
  57 };
  58
  59 void
  60 Fretboard_engraver::derived_mark () const
  61 {
  62   scm_gc_mark (last_placements_);
  63 }
  64
  65 Fretboard_engraver::Fretboard_engraver (Context *c)
  66   : Engraver (c)
  67 {
  68   fret_board_ = 0;
  69   last_placements_ = SCM_BOOL_F;
  70 }
  71
  72 void
  73 Fretboard_engraver::listen_note (Stream_event *ev)
  74 {
  75   note_events_.push_back (ev);
  76 }
  77
  78 void
  79 Fretboard_engraver::listen_string_number (Stream_event *ev)
  80 {
  81   tabstring_events_.push_back (ev);
  82 }
  83
  84 void
  85 Fretboard_engraver::listen_fingering (Stream_event *ev)
  86 {
  87   fingering_events_.push_back (ev);
  88 }
  89
  90 void
  91 Fretboard_engraver::process_music ()
  92 {
  93   if (!note_events_.size ())
  94     return;
  95
  96   SCM tab_strings = articulation_list (note_events_,
  97                                        tabstring_events_,
  98                                        "string-number-event");
  99   SCM fingers = articulation_list (note_events_,
 100                                    fingering_events_,
 101                                    "fingering-event");
 102   fret_board_ = make_item ("FretBoard", note_events_[0]->self_scm ());
 103   SCM fret_notes = ly_cxx_vector_to_list (note_events_);
 104   SCM proc = get_property ("noteToFretFunction");
 105   if (ly_is_procedure (proc))
 106     scm_call_4 (proc,
 107                 context ()->self_scm (),
 108                 fret_notes,
 109                 scm_list_2 (tab_strings, fingers),
 110                 fret_board_->self_scm ());
 111   SCM changes = get_property ("chordChanges");
 112   SCM placements = fret_board_->get_property ("dot-placement-list");
 113   if (to_boolean (changes)
 114       && ly_is_equal (last_placements_, placements))
 115     fret_board_->set_property ("begin-of-line-visible", SCM_BOOL_T);
 116
 117   last_placements_ = placements;
 118 }
 119
 120 void
 121 Fretboard_engraver::stop_translation_timestep ()
 122 {
 123   fret_board_ = 0;
 124   note_events_.clear ();
 125   tabstring_events_.clear ();
 126   fingering_events_.clear ();
 127 }
 128
 129 void
 130 Fretboard_engraver::boot ()
 131 {
 132   ADD_LISTENER (Fretboard_engraver, note);
 133   ADD_LISTENER (Fretboard_engraver, string_number);
 134   ADD_LISTENER (Fretboard_engraver, fingering);
 135 }
 136
 137 ADD_TRANSLATOR (Fretboard_engraver,
 138                 /* doc */
 139                 "Generate fret diagram from one or more events of type"
 140                 " @code{NoteEvent}.",
 141
 142                 /* create */
 143                 "FretBoard ",
 144
 145                 /* read */
 146                 "chordChanges "
 147                 "defaultStrings "
 148                 "highStringOne "
 149                 "maximumFretStretch "
 150                 "minimumFret "
 151                 "noteToFretFunction "
 152                 "predefinedDiagramTable "
 153                 "stringTunings "
 154                 "tablatureFormat ",
 155
 156                 /* write */
 157                 ""
 158                );
 159