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 "rhythmic-head.hh"
  14 #include "output-def.hh"
  15 #include "music.hh"
  16 #include "dots.hh"
  17 #include "dot-column.hh"
  18 #include "staff-symbol-referencer.hh"
  19 #include "item.hh"
  20 #include "score-engraver.hh"
  21 #include "warn.hh"
  22 #include "duration.hh"
  23
  24 /**
  25    make (guitar-like) tablature note
  26 */
  27 class Tab_note_heads_engraver : public Engraver
  28 {
  29   Link_array<Item> notes_;
  30
  31   Link_array<Item> dots_;
  32   Link_array<Music> note_events_;
  33   Link_array<Music> tabstring_events_;
  34 public:
  35   TRANSLATOR_DECLARATIONS (Tab_note_heads_engraver);
  36
  37 protected:
  38   virtual bool try_music (Music *event);
  39   void process_music ();
  40
  41   void stop_translation_timestep ();
  42 };
  43
  44 Tab_note_heads_engraver::Tab_note_heads_engraver ()
  45 {
  46 }
  47
  48 bool
  49 Tab_note_heads_engraver::try_music (Music *m)
  50 {
  51   if (m->is_mus_type ("note-event"))
  52     {
  53       note_events_.push (m);
  54       return true;
  55     }
  56   else if (m->is_mus_type ("string-number-event"))
  57     {
  58       tabstring_events_.push (m);
  59       return true;
  60     }
  61   else if (m->is_mus_type ("busy-playing-event"))
  62     return note_events_.size ();
  63
  64   return false;
  65 }
  66
  67 void
  68 Tab_note_heads_engraver::process_music ()
  69 {
  70   int j = 0;
  71   for (int i = 0; i < note_events_.size (); i++)
  72     {
  73       SCM stringTunings = get_property ("stringTunings");
  74       int number_of_strings = ((int) ly_length (stringTunings));
  75       bool high_string_one = to_boolean (get_property ("highStringOne"));
  76
  77       Music *event = note_events_[i];
  78       Item *note = make_item ("TabNoteHead", event->self_scm ());
  79
  80       Music *tabstring_event = 0;
  81
  82       for (SCM s = event->get_property ("articulations");
  83            !tabstring_event && scm_is_pair (s); s = scm_cdr (s))
  84         {
  85           Music *art = unsmob_music (scm_car (s));
  86
  87           if (art->is_mus_type ("string-number-event"))
  88             tabstring_event = art;
  89         }
  90
  91       if (!tabstring_event && j < tabstring_events_.size ())
  92         {
  93           tabstring_event = tabstring_events_[j];
  94           if (j +1 < tabstring_events_.size ())
  95             j++;
  96         }
  97
  98       int tab_string;
  99       bool string_found;
 100       if (tabstring_event)
 101         {
 102           tab_string = scm_to_int (tabstring_event->get_property ("string-number"));
 103           string_found = true;
 104         }
 105       else
 106         {
 107           tab_string = high_string_one ? 1 : number_of_strings;
 108           string_found = false;
 109         }
 110
 111       Duration dur = *unsmob_duration (event->get_property ("duration"));
 112       note->set_property ("duration-log",
 113                           scm_from_int (dur.duration_log ()));
 114
 115       if (dur.dot_count ())
 116         {
 117           Item *d = make_item ("Dots", event->self_scm ());
 118           Rhythmic_head::set_dots (note, d);
 119
 120           if (dur.dot_count ()
 121               != scm_to_int (d->get_property ("dot-count")))
 122             d->set_property ("dot-count", scm_from_int (dur.dot_count ()));
 123
 124           d->set_parent (note, Y_AXIS);
 125
 126           dots_.push (d);
 127         }
 128
 129       SCM scm_pitch = event->get_property ("pitch");
 130       SCM proc = get_property ("tablatureFormat");
 131       SCM min_fret_scm = get_property ("minimumFret");
 132       int min_fret = scm_is_number (min_fret_scm) ? scm_to_int (min_fret_scm) : 0;
 133
 134       while (!string_found)
 135         {
 136           int fret = unsmob_pitch (scm_pitch)->semitone_pitch ()
 137             - scm_to_int (scm_list_ref (stringTunings, scm_from_int (tab_string - 1)));
 138           if (fret < min_fret)
 139             tab_string += high_string_one ? 1 : -1;
 140           else
 141             string_found = true;
 142         }
 143
 144       SCM text = scm_call_3 (proc, scm_from_int (tab_string), stringTunings, scm_pitch);
 145
 146       int pos = 2 * tab_string - number_of_strings - 1; // No tab-note between the string !!!
 147       if (to_boolean (get_property ("stringOneTopmost")))
 148         pos = -pos;
 149
 150       note->set_property ("text", text);
 151
 152       note->set_property ("staff-position", scm_from_int (pos));
 153       notes_.push (note);
 154     }
 155 }
 156
 157 void
 158 Tab_note_heads_engraver::stop_translation_timestep ()
 159 {
 160   notes_.clear ();
 161   dots_.clear ();
 162   note_events_.clear ();
 163   tabstring_events_.clear ();
 164 }
 165
 166 #include "translator.icc"
 167
 168 ADD_TRANSLATOR (Tab_note_heads_engraver,
 169                 /* doc */ "Generate one or more tablature noteheads from Music of type NoteEvent.",
 170                 /* create */ "TabNoteHead Dots",
 171                 /* accept */ "note-event string-number-event busy-playing-event",
 172                 /* read */ "middleCPosition stringTunings minimumFret tablatureFormat highStringOne stringOneTopmost",
 173                 /* write */ "");
 174