lily/tab-note-heads-engraver.cc

   1 /*
   2   tab-note-heads-engraver.cc -- part of GNU LilyPond
   3
   4   based on note-heads-engraver.cc, by Jean-Baptiste Lamy <jiba@tuxfamily.org>,
   5
   6   (c) 2002--2006
   7 */
   8
   9 #include <cctype>
  10 #include <cstdio>
  11 using namespace std;
  12
  13 #include "dot-column.hh"
  14 #include "dots.hh"
  15 #include "duration.hh"
  16 #include "item.hh"
  17 #include "output-def.hh"
  18 #include "pitch.hh"
  19 #include "rhythmic-head.hh"
  20 #include "score-engraver.hh"
  21 #include "staff-symbol-referencer.hh"
  22 #include "stream-event.hh"
  23 #include "warn.hh"
  24
  25 #include "translator.icc"
  26
  27 /**
  28    make (guitar-like) tablature note
  29 */
  30 class Tab_note_heads_engraver : public Engraver
  31 {
  32   vector<Item*> notes_;
  33
  34   vector<Stream_event*> note_events_;
  35   vector<Stream_event*> tabstring_events_;
  36 public:
  37   TRANSLATOR_DECLARATIONS (Tab_note_heads_engraver);
  38
  39 protected:
  40   DECLARE_TRANSLATOR_LISTENER (note);
  41   DECLARE_TRANSLATOR_LISTENER (string_number);
  42   void process_music ();
  43
  44   void stop_translation_timestep ();
  45 };
  46
  47 Tab_note_heads_engraver::Tab_note_heads_engraver ()
  48 {
  49 }
  50
  51 IMPLEMENT_TRANSLATOR_LISTENER (Tab_note_heads_engraver, note);
  52 void
  53 Tab_note_heads_engraver::listen_note (Stream_event *ev)
  54 {
  55   note_events_.push_back (ev);
  56 }
  57
  58 IMPLEMENT_TRANSLATOR_LISTENER (Tab_note_heads_engraver, string_number);
  59 void
  60 Tab_note_heads_engraver::listen_string_number (Stream_event *ev)
  61 {
  62   tabstring_events_.push_back (ev);
  63 }
  64
  65 void
  66 Tab_note_heads_engraver::process_music ()
  67 {
  68   vsize j = 0;
  69   for (vsize i = 0; i < note_events_.size (); i++)
  70     {
  71       SCM stringTunings = get_property ("stringTunings");
  72       int number_of_strings = ((int) ly_length (stringTunings));
  73       bool high_string_one = to_boolean (get_property ("highStringOne"));
  74
  75       Stream_event *event = note_events_[i];
  76       Item *note = make_item ("TabNoteHead", event->self_scm ());
  77
  78       Stream_event *tabstring_event = 0;
  79
  80       for (SCM s = event->get_property ("articulations");
  81            !tabstring_event && scm_is_pair (s); s = scm_cdr (s))
  82         {
  83           Stream_event *art = unsmob_stream_event (scm_car (s));
  84
  85           if (art->in_event_class ("string-number-event"))
  86             tabstring_event = art;
  87         }
  88
  89       if (!tabstring_event && j < tabstring_events_.size ())
  90         {
  91           tabstring_event = tabstring_events_[j];
  92           if (j + 1 < tabstring_events_.size ())
  93             j++;
  94         }
  95
  96       int tab_string;
  97       bool string_found;
  98       if (tabstring_event)
  99         {
 100           tab_string = scm_to_int (tabstring_event->get_property ("string-number"));
 101           string_found = true;
 102         }
 103       else
 104         {
 105           tab_string = high_string_one ? 1 : number_of_strings;
 106           string_found = false;
 107         }
 108
 109       Duration dur = *unsmob_duration (event->get_property ("duration"));
 110
 111       SCM scm_pitch = event->get_property ("pitch");
 112       SCM proc = get_property ("tablatureFormat");
 113       SCM min_fret_scm = get_property ("minimumFret");
 114       int min_fret = scm_is_number (min_fret_scm) ? scm_to_int (min_fret_scm) : 0;
 115
 116       while (!string_found)
 117         {
 118           int fret = unsmob_pitch (scm_pitch)->semitone_pitch ()
 119             - scm_to_int (scm_list_ref (stringTunings, scm_from_int (tab_string - 1)));
 120           if (fret < min_fret)
 121             tab_string += high_string_one ? 1 : -1;
 122           else
 123             string_found = true;
 124         }
 125
 126       SCM text = scm_call_3 (proc, scm_from_int (tab_string), stringTunings, scm_pitch);
 127
 128       int pos = 2 * tab_string - number_of_strings - 1; // No tab-note between the string !!!
 129       if (to_boolean (get_property ("stringOneTopmost")))
 130         pos = -pos;
 131
 132       note->set_property ("text", text);
 133
 134       note->set_property ("staff-position", scm_from_int (pos));
 135       notes_.push_back (note);
 136     }
 137 }
 138
 139 void
 140 Tab_note_heads_engraver::stop_translation_timestep ()
 141 {
 142   notes_.clear ();
 143   note_events_.clear ();
 144   tabstring_events_.clear ();
 145 }
 146
 147 ADD_TRANSLATOR (Tab_note_heads_engraver,
 148                 /* doc */ "Generate one or more tablature noteheads from event of type NoteEvent.",
 149                 /* create */
 150                 "TabNoteHead "
 151                 ,
 152
 153                 /* accept */
 154                 "note-event "
 155                 "string-number-event ",
 156
 157                 /* read */
 158                 "middleCPosition "
 159                 "stringTunings "
 160                 "minimumFret "
 161                 "tablatureFormat "
 162                 "highStringOne "
 163                 "stringOneTopmost ",
 164
 165                 /* write */ "");
 166