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