1 /*
2 This file is part of LilyPond, the GNU music typesetter.
3
4 Copyright (C) 2006--2020 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 "articulations.hh"
21 #include "context.hh"
22 #include "item.hh"
23 #include "engraver.hh"
24 #include "pitch.hh"
25 #include "stream-event.hh"
26 #include "warn.hh"
27
28 #include "translator.icc"
29
30 #include <cctype>
31 #include <cstdio>
32
33 using std::vector;
34
35 /**
36 make (guitar-like) tablature note
37 */
38 class Fretboard_engraver : public Engraver
39 {
40 Item *fret_board_;
41
42 vector<Stream_event *> note_events_;
43 vector<Stream_event *> tabstring_events_;
44 vector<Stream_event *> fingering_events_;
45 public:
46 TRANSLATOR_DECLARATIONS (Fretboard_engraver);
47
48 protected:
49 void stop_translation_timestep ();
50 void process_music ();
51 void derived_mark () const override;
52 void listen_note (Stream_event *);
53 void listen_string_number (Stream_event *);
54 void listen_fingering (Stream_event *);
55
56 private:
57 SCM last_placements_;
58 };
59
60 void
derived_mark() const61 Fretboard_engraver::derived_mark () const
62 {
63 scm_gc_mark (last_placements_);
64 }
65
Fretboard_engraver(Context * c)66 Fretboard_engraver::Fretboard_engraver (Context *c)
67 : Engraver (c)
68 {
69 fret_board_ = 0;
70 last_placements_ = SCM_BOOL_F;
71 }
72
73 void
listen_note(Stream_event * ev)74 Fretboard_engraver::listen_note (Stream_event *ev)
75 {
76 note_events_.push_back (ev);
77 }
78
79 void
listen_string_number(Stream_event * ev)80 Fretboard_engraver::listen_string_number (Stream_event *ev)
81 {
82 tabstring_events_.push_back (ev);
83 }
84
85 void
listen_fingering(Stream_event * ev)86 Fretboard_engraver::listen_fingering (Stream_event *ev)
87 {
88 fingering_events_.push_back (ev);
89 }
90
91 void
process_music()92 Fretboard_engraver::process_music ()
93 {
94 if (!note_events_.size ())
95 return;
96
97 SCM tab_strings = articulation_list (note_events_,
98 tabstring_events_,
99 "string-number-event");
100 SCM fingers = articulation_list (note_events_,
101 fingering_events_,
102 "fingering-event");
103 fret_board_ = make_item ("FretBoard", note_events_[0]->self_scm ());
104 SCM fret_notes = to_scm_list (note_events_);
105 SCM proc = get_property (this, "noteToFretFunction");
106 if (ly_is_procedure (proc))
107 scm_call_4 (proc,
108 context ()->self_scm (),
109 fret_notes,
110 scm_list_2 (tab_strings, fingers),
111 fret_board_->self_scm ());
112 SCM changes = get_property (this, "chordChanges");
113 SCM placements = get_property (fret_board_, "dot-placement-list");
114 if (from_scm<bool> (changes)
115 && ly_is_equal (last_placements_, placements))
116 set_property (fret_board_, "begin-of-line-visible", SCM_BOOL_T);
117
118 last_placements_ = placements;
119 }
120
121 void
stop_translation_timestep()122 Fretboard_engraver::stop_translation_timestep ()
123 {
124 fret_board_ = 0;
125 note_events_.clear ();
126 tabstring_events_.clear ();
127 fingering_events_.clear ();
128 }
129
130 void
boot()131 Fretboard_engraver::boot ()
132 {
133 ADD_LISTENER (Fretboard_engraver, note);
134 ADD_LISTENER (Fretboard_engraver, string_number);
135 ADD_LISTENER (Fretboard_engraver, fingering);
136 }
137
138 ADD_TRANSLATOR (Fretboard_engraver,
139 /* doc */
140 "Generate fret diagram from one or more events of type"
141 " @code{NoteEvent}.",
142
143 /* create */
144 "FretBoard ",
145
146 /* read */
147 "chordChanges "
148 "defaultStrings "
149 "highStringOne "
150 "maximumFretStretch "
151 "minimumFret "
152 "noteToFretFunction "
153 "predefinedDiagramTable "
154 "stringTunings "
155 "tablatureFormat ",
156
157 /* write */
158 ""
159 );
160