lily/fretboard-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2006--2010 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 "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 /**
  34    make (guitar-like) tablature note
  35 */
  36 class Fretboard_engraver : public Engraver
  37 {
  38   Item *fret_board_;
  39
  40   vector<Stream_event*> note_events_;
  41   vector<Stream_event*> tabstring_events_;
  42 public:
  43   TRANSLATOR_DECLARATIONS (Fretboard_engraver);
  44
  45 protected:
  46   void stop_translation_timestep ();
  47   void process_music ();
  48   virtual void derived_mark() const;
  49   DECLARE_TRANSLATOR_LISTENER (note);
  50   DECLARE_TRANSLATOR_LISTENER (string_number);
  51
  52 private:
  53   SCM last_fret_notes_;
  54 };
  55
  56
  57 void
  58 Fretboard_engraver::derived_mark () const
  59 {
  60   scm_gc_mark (last_fret_notes_);
  61 }
  62
  63 Fretboard_engraver::Fretboard_engraver ()
  64 {
  65   fret_board_ = 0;
  66   last_fret_notes_ = SCM_EOL;
  67 }
  68
  69 IMPLEMENT_TRANSLATOR_LISTENER (Fretboard_engraver, note);
  70 void
  71 Fretboard_engraver::listen_note (Stream_event *ev)
  72 {
  73   note_events_.push_back (ev);
  74 }
  75
  76 IMPLEMENT_TRANSLATOR_LISTENER (Fretboard_engraver, string_number);
  77 void
  78 Fretboard_engraver::listen_string_number (Stream_event *ev)
  79 {
  80   tabstring_events_.push_back (ev);
  81 }
  82
  83 void
  84 Fretboard_engraver::process_music ()
  85 {
  86   if (!note_events_.size ())
  87     return ;
  88
  89   fret_board_ = make_item ("FretBoard", note_events_[0]->self_scm ());
  90   SCM fret_notes = ly_cxx_vector_to_list (note_events_);
  91   SCM proc = get_property ("noteToFretFunction");
  92   if (ly_is_procedure (proc))
  93      scm_call_4 (proc,
  94                  context ()->self_scm (),
  95                  fret_notes,
  96                  ly_cxx_vector_to_list (tabstring_events_),
  97                  fret_board_->self_scm ());
  98   SCM changes = get_property ("chordChanges");
  99   if (to_boolean (changes) && scm_is_pair (last_fret_notes_)
 100       && ly_is_equal (last_fret_notes_, fret_notes))
 101     fret_board_->set_property ("begin-of-line-visible", SCM_BOOL_T);
 102
 103   last_fret_notes_ = fret_notes;
 104 }
 105
 106 void
 107 Fretboard_engraver::stop_translation_timestep ()
 108 {
 109   fret_board_ = 0;
 110   note_events_.clear ();
 111   tabstring_events_.clear ();
 112 }
 113
 114 ADD_TRANSLATOR (Fretboard_engraver,
 115                 /* doc */
 116                 "Generate fret diagram from one or more events of type"
 117                 " @code{NoteEvent}.",
 118
 119                 /* create */
 120                 "FretBoard ",
 121
 122                 /* read */
 123                 "chordChanges "
 124                 "highStringOne "
 125                 "maximumFretStretch "
 126                 "minimumFret "
 127                 "noteToFretFunction "
 128                 "predefinedDiagramTable "
 129                 "stringTunings "
 130                 "tablatureFormat ",
 131
 132                 /* write */
 133                 ""
 134                 );
 135