1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; (c) 1998--2010 Han-Wen Nienhuys <hanwen@xs4all.nl>
4 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
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.
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.
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/>.
20 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
23 (define-public (format-metronome-markup text dur count context)
24 (let* ((hide-note (eq? #t (ly:context-property context 'tempoHideNote))))
25 (metronome-markup text dur count hide-note)))
27 (define-public (metronome-markup text dur count hide-note)
28 (let* ((note-mark (if (and (not hide-note) (ly:duration? dur))
30 (make-note-by-number-markup (ly:duration-log dur)
31 (ly:duration-dot-count dur)
34 (note-markup (if (and (not hide-note) (number? count) (> count 0) )
37 (make-general-align-markup Y DOWN note-mark)
38 (make-simple-markup " ")
39 (make-simple-markup "=")
40 (make-simple-markup " ")
41 (make-simple-markup (number->string count))))
43 (text-markup (if (not (null? text))
44 (make-bold-markup text)
47 (if (and note-markup (not hide-note))
48 (make-line-markup (list text-markup
50 (list (make-simple-markup "(")
52 (make-simple-markup ")")))))
53 (make-line-markup (list text-markup)))
55 (make-line-markup (list note-markup))
56 (make-null-markup)))))
58 (define-public (format-mark-alphabet mark context)
59 (make-bold-markup (make-markalphabet-markup (1- mark))))
61 (define-public (format-mark-box-alphabet mark context)
62 (make-bold-markup (make-box-markup (make-markalphabet-markup (1- mark)))))
64 (define-public (format-mark-circle-alphabet mark context)
65 (make-bold-markup (make-circle-markup (make-markalphabet-markup (1- mark)))))
67 (define-public (format-mark-letters mark context)
68 (make-bold-markup (make-markletter-markup (1- mark))))
70 (define-public (format-mark-numbers mark context)
71 (make-bold-markup (number->string mark)))
73 (define-public (format-mark-barnumbers mark context)
74 (make-bold-markup (number->string (ly:context-property context
77 (define-public (format-mark-box-letters mark context)
78 (make-bold-markup (make-box-markup (make-markletter-markup (1- mark)))))
80 (define-public (format-mark-circle-letters mark context)
81 (make-bold-markup (make-circle-markup (make-markletter-markup (1- mark)))))
83 (define-public (format-mark-box-numbers mark context)
84 (make-bold-markup (make-box-markup (number->string mark))))
86 (define-public (format-mark-circle-numbers mark context)
87 (make-bold-markup (make-circle-markup (number->string mark))))
89 (define-public (format-mark-box-barnumbers mark context)
90 (make-bold-markup (make-box-markup
91 (number->string (ly:context-property context
92 'currentBarNumber)))))
94 (define-public (format-mark-circle-barnumbers mark context)
95 (make-bold-markup (make-circle-markup
96 (number->string (ly:context-property context
97 'currentBarNumber)))))
100 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
103 (define-public (format-bass-figure figure event context)
104 (let* ((fig (ly:event-property event 'figure))
105 (fig-markup (if (number? figure)
107 ;; this is not very elegant, but center-aligning
108 ;; all digits is problematic with other markups,
109 ;; and shows problems in the (lack of) overshoot
110 ;; of feta-alphabet glyphs.
112 (lambda (y) (make-translate-scaled-markup
117 ((eq? #t (ly:event-property event 'diminished))
118 (markup #:slashed-digit figure))
119 ((eq? #t (ly:event-property event 'augmented-slash))
120 (markup #:backslashed-digit figure))
121 (else (markup #:number (number->string figure 10)))))
124 (alt (ly:event-property event 'alteration))
128 #:general-align Y DOWN #:fontsize
129 (if (not (= alt DOUBLE-SHARP))
131 (alteration->text-accidental-markup alt))
134 (plus-markup (if (eq? #t (ly:event-property event 'augmented))
135 (markup #:number "+")
138 (alt-dir (ly:context-property context 'figuredBassAlterationDirection))
139 (plus-dir (ly:context-property context 'figuredBassPlusDirection)))
141 (if (and (not fig-markup) alt-markup)
143 (set! fig-markup (markup #:left-align #:pad-around 0.3 alt-markup))
144 (set! alt-markup #f)))
147 ;; hmm, how to get figures centered between note, and
148 ;; lone accidentals too?
150 ;; (if (markup? fig-markup)
152 ;; fig-markup (markup #:translate (cons 1.0 0)
153 ;; #:center-align fig-markup)))
157 (markup #:put-adjacent
158 X (if (number? alt-dir)
162 #:pad-x 0.2 alt-markup)))
167 (markup #:put-adjacent
168 X (if (number? plus-dir)
172 #:pad-x 0.2 plus-markup)
175 (if (markup? fig-markup)
176 (markup #:fontsize -2 fig-markup)
180 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
183 (define (create-fretboard context grob placement-list)
184 "Convert @var{placement-list} into a fretboard @var{grob}."
186 (let* ((tunings (ly:context-property context 'stringTunings))
187 (my-string-count (length tunings))
188 (details (ly:grob-property grob 'fret-diagram-details)))
190 ;; Add string-count from string-tunings to fret-diagram-details.
191 (set! (ly:grob-property grob 'fret-diagram-details)
192 (acons 'string-count my-string-count details))
193 ;; Create the dot-placement list for the grob
194 (set! (ly:grob-property grob 'dot-placement-list) placement-list)))
197 (determine-frets context notes defined-strings . rest)
198 "Determine string numbers and frets for playing @var{notes}
199 as a chord, given specified string numbers @var{defined-strings}.
200 Will look for predefined fretboards if @code{predefinedFretboardTable}
201 is not @code {#f}. If @var{rest} is present, it contains the
202 FretBoard grob, and a fretboard will be
203 created. Otherwise, a list of (string fret finger) lists will
208 (define (string-frets->placement-list string-frets string-count)
209 "Convert @var{string-frets} to @code{fret-diagram-verbose}
210 dot placement entries."
211 (let* ((placements (list->vector
212 (map (lambda (x) (list 'mute (1+ x)))
213 (iota string-count)))))
215 (for-each (lambda (sf)
216 (let* ((string (car sf))
220 placements (1- string)
224 (list 'place-fret string fret finger)
225 (list 'place-fret string fret))))))
227 (vector->list placements)))
229 (define (placement-list->string-frets placement-list)
230 "Convert @var{placement-list} to string-fret list."
231 (map (lambda (x) (cdr x))
232 (filter (lambda (l) (eq? (cdr l) 'place-fret) placement-list))))
235 (define (get-predefined-fretboard predefined-fret-table tuning pitches)
236 "Search through @var{predefined-fret-table} looking for a predefined
237 fretboard with a key of @var{(tuning . pitches)}. The search will check
238 both up and down an octave in order to accomodate transposition of the
239 chords. Returns a placement-list."
241 (define (get-fretboard key)
243 (hash-get-handle predefined-fret-table key)))
245 (cdr hash-handle) ; return table entry
248 ;; body of get-predefined-fretboard
249 (let ((test-fretboard (get-fretboard (cons tuning pitches))))
250 (if (not (null? test-fretboard))
252 (let ((test-fretboard
254 (cons tuning (map (lambda (x) (shift-octave x 1)) pitches)))))
255 (if (not (null? test-fretboard))
258 (cons tuning (map (lambda (x) (shift-octave x -1))
261 ;; body of determine-frets
262 (let* ((predefined-fret-table
263 (ly:context-property context 'predefinedDiagramTable))
264 (tunings (ly:context-property context 'stringTunings))
265 (string-count (length tunings))
266 (grob (if (null? rest) '() (car rest)))
267 (pitches (map (lambda (x) (ly:event-property x 'pitch)) notes))
268 (predefined-fretboard
269 (if predefined-fret-table
270 (get-predefined-fretboard
271 predefined-fret-table
276 (if (null? predefined-fretboard)
278 (determine-frets-and-strings
281 (ly:context-property context 'minimumFret 0)
282 (ly:context-property context 'maximumFretStretch 4)
287 context grob (string-frets->placement-list
288 string-frets string-count))))
290 (placement-list->string-frets predefined-fretboard)
291 (create-fretboard context grob predefined-fretboard)))))
294 (define (determine-frets-and-strings
295 notes defined-strings minimum-fret maximum-stretch tuning)
297 (define (calc-fret pitch string tuning)
298 (- (ly:pitch-semitones pitch) (list-ref tuning (1- string))))
300 (define (note-pitch a)
301 (ly:event-property a 'pitch))
303 (define (note-pitch>? a b)
304 (ly:pitch<? (note-pitch b)
307 (define (note-finger ev)
308 (let* ((articulations (ly:event-property ev 'articulations))
312 (let* ((num (ly:event-property art 'digit)))
314 (if (and (eq? 'fingering-event (ly:event-property art 'class))
316 (set! finger-found num))))
321 (define (string-number event)
322 (let ((num (ly:event-property event 'string-number)))
328 (define (delete-free-string string)
331 (delete string free-strings))))
333 (define free-strings '())
334 (define unassigned-notes '())
335 (define specified-frets '())
337 (define (close-enough fret)
338 (if (null? specified-frets)
344 (map (lambda (specced-fret)
345 (> maximum-stretch (abs (- fret specced-fret))))
348 (define (string-qualifies string pitch)
349 (let* ((fret (calc-fret pitch string tuning)))
350 (and (>= fret minimum-fret)
351 (close-enough fret))))
353 (define string-fret-fingering-tuples '())
355 (define (set-fret note string)
356 (let ((this-fret (calc-fret (ly:event-property note 'pitch)
359 (set! string-fret-fingering-tuples
363 string-fret-fingering-tuples))
364 (delete-free-string string)
365 (set! specified-frets (cons this-fret specified-frets))))
367 ;;; body of determine-frets-and-strings
368 (set! free-strings (map 1+ (iota (length tuning))))
370 ;; get defined-strings same length as notes
371 (while (< (length defined-strings) (length notes))
372 (set! defined-strings (append defined-strings '(()))))
374 ;; handle notes with strings assigned
376 (lambda (note string)
378 (set! unassigned-notes (cons note unassigned-notes))
379 (let ((this-string (string-number string)))
380 (delete-free-string this-string)
381 (set-fret note this-string))))
382 notes defined-strings)
384 ;; handle notes without strings assigned
388 (find (lambda (string)
389 (string-qualifies string (note-pitch note)))
392 (set-fret note fit-string)
393 (ly:warning "No string for pitch ~a (given frets ~a)"
396 (sort unassigned-notes note-pitch>?))
398 string-fret-fingering-tuples)
400 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
403 ;; The TabNoteHead tablatureFormat callbacks.
405 ;; Calculate the fret from pitch and string number as letter
406 ;; The fret letter is taken from 'fretLabels if present
407 (define-public (fret-letter-tablature-format
408 context string-number fret-number)
409 (let ((labels (ly:context-property context 'fretLabels)))
412 ((= 0 (length labels))
413 (string (integer->char (+ fret-number (char->integer #\a)))))
414 ((and (<= 0 fret-number) (< fret-number (length labels)))
415 (list-ref labels fret-number))
417 (ly:warning "No label for fret ~a (on string ~a);
418 only ~a fret labels provided"
419 fret-number string-number (length labels))
422 ;; Display the fret number as a number
423 (define-public (fret-number-tablature-format
424 context string-number fret-number)
426 (format "~a" fret-number)))
428 ;; The 5-string banjo has got a extra string, the fifth (duh), which
429 ;; starts at the fifth fret on the neck. Frets on the fifth string
430 ;; are referred to relative to the other frets:
431 ;; the "first fret" on the fifth string is really the sixth fret
432 ;; on the banjo neck.
433 ;; We solve this by defining a new fret-number-tablature function:
434 (define-public (fret-number-tablature-format-banjo
435 context string-number fret-number)
437 (number->string (cond
438 ((and (> fret-number 0) (= string-number 5))
440 (else fret-number)))))
442 ;; Tab note head staff position functions
444 ;; Define where in the staff to display a given string. Some forms of
445 ;; tablature put the tab note heads in the spaces, rather than on the
448 (define-public (tablature-position-on-lines context string-number)
449 (let* ((string-tunings (ly:context-property context 'stringTunings))
450 (string-count (length string-tunings))
451 (string-one-topmost (ly:context-property context 'stringOneTopmost))
452 (staff-line (- (* 2 string-number) string-count 1)))
453 (if string-one-topmost
457 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
460 (define-public ((every-nth-bar-number-visible n) barnum)
461 (= 0 (modulo barnum n)))
463 (define-public ((modulo-bar-number-visible n m) barnum)
464 (and (> barnum 1) (= m (modulo barnum n))))
466 (define-public ((set-bar-number-visibility n) tr)
467 (let ((bn (ly:context-property tr 'currentBarNumber)))
468 (ly:context-set-property! tr 'barNumberVisibility
469 (modulo-bar-number-visible n (modulo bn n)))))
471 (define-public (first-bar-number-invisible barnum) (> barnum 1))
473 (define-public (all-bar-numbers-visible barnum) #t)
476 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
477 ;; percent repeat counters
479 (define-public ((every-nth-repeat-count-visible n) count context)
480 (= 0 (modulo count n)))
482 (define-public (all-repeat-counts-visible count context) #t)