lily/tab-note-heads-engraver.cc

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