1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; (c) 1998--2011 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 event context)
24 (let ((hide-note (ly:context-property context 'tempoHideNote #f))
25 (text (ly:event-property event 'text))
26 (dur (ly:event-property event 'tempo-unit))
27 (count (ly:event-property event 'metronome-count)))
29 (metronome-markup text dur count hide-note)))
31 (define-public (metronome-markup text dur count hide-note)
32 (let* ((note-mark (if (and (not hide-note) (ly:duration? dur))
34 (make-note-by-number-markup (ly:duration-log dur)
35 (ly:duration-dot-count dur)
38 (count-markup (cond ((number? count)
40 (make-simple-markup (number->string count))
45 (make-simple-markup (number->string (car count)))
46 (make-simple-markup " ")
47 (make-simple-markup "–")
48 (make-simple-markup " ")
49 (make-simple-markup (number->string (cdr count))))))
51 (note-markup (if (and (not hide-note) count-markup)
54 (make-general-align-markup Y DOWN note-mark)
55 (make-simple-markup " ")
56 (make-simple-markup "=")
57 (make-simple-markup " ")
60 (text-markup (if (not (null? text))
61 (make-bold-markup text)
64 (if (and note-markup (not hide-note))
65 (make-line-markup (list text-markup
67 (list (make-simple-markup "(")
69 (make-simple-markup ")")))))
70 (make-line-markup (list text-markup)))
72 (make-line-markup (list note-markup))
73 (make-null-markup)))))
75 (define-public (format-mark-alphabet mark context)
76 (make-bold-markup (make-markalphabet-markup (1- mark))))
78 (define-public (format-mark-box-alphabet mark context)
79 (make-bold-markup (make-box-markup (make-markalphabet-markup (1- mark)))))
81 (define-public (format-mark-circle-alphabet mark context)
82 (make-bold-markup (make-circle-markup (make-markalphabet-markup (1- mark)))))
84 (define-public (format-mark-letters mark context)
85 (make-bold-markup (make-markletter-markup (1- mark))))
87 (define-public (format-mark-numbers mark context)
88 (make-bold-markup (number->string mark)))
90 (define-public (format-mark-barnumbers mark context)
91 (make-bold-markup (number->string (ly:context-property context
94 (define-public (format-mark-box-letters mark context)
95 (make-bold-markup (make-box-markup (make-markletter-markup (1- mark)))))
97 (define-public (format-mark-circle-letters mark context)
98 (make-bold-markup (make-circle-markup (make-markletter-markup (1- mark)))))
100 (define-public (format-mark-box-numbers mark context)
101 (make-bold-markup (make-box-markup (number->string mark))))
103 (define-public (format-mark-circle-numbers mark context)
104 (make-bold-markup (make-circle-markup (number->string mark))))
106 (define-public (format-mark-box-barnumbers mark context)
107 (make-bold-markup (make-box-markup
108 (number->string (ly:context-property context
109 'currentBarNumber)))))
111 (define-public (format-mark-circle-barnumbers mark context)
112 (make-bold-markup (make-circle-markup
113 (number->string (ly:context-property context
114 'currentBarNumber)))))
117 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
120 (define-public (format-bass-figure figure event context)
121 (let* ((fig (ly:event-property event 'figure))
122 (fig-markup (if (number? figure)
124 ;; this is not very elegant, but center-aligning
125 ;; all digits is problematic with other markups,
126 ;; and shows problems in the (lack of) overshoot
127 ;; of feta-alphabet glyphs.
129 (lambda (y) (make-translate-scaled-markup
134 ((eq? #t (ly:event-property event 'diminished))
135 (markup #:slashed-digit figure))
136 ((eq? #t (ly:event-property event 'augmented-slash))
137 (markup #:backslashed-digit figure))
138 (else (markup #:number (number->string figure 10)))))
141 (alt (ly:event-property event 'alteration))
145 #:general-align Y DOWN #:fontsize
146 (if (not (= alt DOUBLE-SHARP))
148 (alteration->text-accidental-markup alt))
151 (plus-markup (if (eq? #t (ly:event-property event 'augmented))
152 (markup #:number "+")
155 (alt-dir (ly:context-property context 'figuredBassAlterationDirection))
156 (plus-dir (ly:context-property context 'figuredBassPlusDirection)))
158 (if (and (not fig-markup) alt-markup)
160 (set! fig-markup (markup #:left-align #:pad-around 0.3 alt-markup))
161 (set! alt-markup #f)))
164 ;; hmm, how to get figures centered between note, and
165 ;; lone accidentals too?
167 ;; (if (markup? fig-markup)
169 ;; fig-markup (markup #:translate (cons 1.0 0)
170 ;; #:center-align fig-markup)))
174 (markup #:put-adjacent
175 X (if (number? alt-dir)
179 #:pad-x 0.2 alt-markup)))
184 (markup #:put-adjacent
185 X (if (number? plus-dir)
189 #:pad-x 0.2 plus-markup)
192 (if (markup? fig-markup)
193 (markup #:fontsize -2 fig-markup)
197 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
200 (define (create-fretboard context grob placement-list)
201 "Convert @var{placement-list} into a fretboard @var{grob}."
203 (let* ((tunings (ly:context-property context 'stringTunings))
204 (my-string-count (length tunings))
205 (details (ly:grob-property grob 'fret-diagram-details)))
207 ;; Add string-count from string-tunings to fret-diagram-details.
208 (set! (ly:grob-property grob 'fret-diagram-details)
209 (acons 'string-count my-string-count details))
210 ;; Create the dot-placement list for the grob
211 (set! (ly:grob-property grob 'dot-placement-list) placement-list)))
214 (determine-frets context notes specified-info . rest)
215 "Determine string numbers and frets for playing @var{notes}
216 as a chord, given specified information @var{specified-info}.
217 @var{specified-info} is a list with two list elements,
218 specified strings @code{defined-strings} and
219 specified fingerings @code{defined-fingers}. Only a fingering of@tie{}0
220 will affect the fret selection, as it specifies an open string.
221 If @code{defined-strings} is @code{'()}, the context property
222 @code{defaultStrings} will be used as a list of defined strings.
223 Will look for predefined fretboards if @code{predefinedFretboardTable}
224 is not @code {#f}. If @var{rest} is present, it contains the
225 @code{FretBoard} grob, and a fretboard will be
226 created. Otherwise, a list of @code{(string fret finger)} lists will
231 (define (string-frets->placement-list string-frets string-count)
232 "Convert @var{string-frets} to @code{fret-diagram-verbose}
233 dot placement entries."
234 (let* ((placements (list->vector
235 (map (lambda (x) (list 'mute x))
236 (iota string-count 1)))))
238 (for-each (lambda (sf)
239 (let* ((string (car sf))
248 (list 'place-fret string fret finger)
249 (list 'place-fret string fret))))))
251 (vector->list placements)))
253 (define (placement-list->string-frets placement-list)
254 "Convert @var{placement-list} to string-fret list."
255 (map (lambda (x) (if (eq? (car x) 'place-fret)
258 (filter (lambda (l) (or (eq? (car l) 'place-fret)
259 (eq? (car l) 'open)))
262 (define (entry-count art-list)
263 "Count the number of entries in a list of articulations."
264 (length (filter (lambda (x) (not (null? x)))
267 (define (determine-frets-and-strings
274 "Determine the frets and strings used to play the notes in
275 @var{notes}, given @var{defined-strings} and @var{defined-fingers}
276 along with @var{minimum-fret}, @var{maximum-stretch}, and
277 @var{tuning}. Returns a list of @code{(string fret finger) lists."
279 (define specified-frets '())
280 (define free-strings (iota (length tuning) 1))
282 (define (calc-fret pitch string tuning)
283 "Calculate the fret to play @var{pitch} on @var{string} with
285 (- (ly:pitch-semitones pitch) (ly:pitch-semitones (list-ref tuning (1- string)))))
287 (define (note-pitch note)
288 "Get the pitch (in semitones) from @var{note}."
289 (ly:event-property note 'pitch))
291 (define (note-finger ev)
292 "Get the fingering from @var{ev}. Return @var{#f}
293 if no fingering is present."
294 (let* ((articulations (ly:event-property ev 'articulations))
297 (let* ((num (ly:event-property art 'digit)))
299 (if (and (eq? 'fingering-event (ly:event-property art 'class))
302 (set! finger-found num))))
306 (define (string-number event)
307 "Get the string-number from @var{event}. Return @var{#f}
308 if no string-number is present."
309 (let ((num (ly:event-property event 'string-number)))
314 (define (delete-free-string string)
317 (delete string free-strings))))
319 (define (close-enough fret)
320 "Decide if @var{fret} is acceptable, given the already used frets."
321 (if (null? specified-frets)
327 (map (lambda (specced-fret)
328 (or (eq? 0 specced-fret)
329 (>= maximum-stretch (abs (- fret specced-fret)))))
332 (define (string-qualifies string pitch)
333 "Can @var{pitch} be played on @var{string}, given already placed
335 (let* ((fret (calc-fret pitch string tuning)))
336 (and (>= fret minimum-fret)
337 (close-enough fret))))
339 (define (open-string string pitch)
340 "Is @var{pitch} and open-string note on @var{string}, given
342 (let* ((fret (calc-fret pitch string tuning)))
345 (define (set-fret! pitch-entry string finger)
346 (let ((this-fret (calc-fret (car pitch-entry)
350 (ly:warning (_ "Negative fret for pitch ~a on string ~a")
351 (car pitch-entry) string))
352 (delete-free-string string)
353 (set! specified-frets (cons this-fret specified-frets))
354 (list-set! string-fret-fingers
356 (list string this-fret finger))))
358 (define string-fret-fingers
359 (map (lambda (string finger)
362 (list string #f finger)))
363 defined-strings defined-fingers))
365 ;;; body of determine-frets-and-strings
366 (let* ((pitch-alist (apply (lambda (mylist)
370 (set! index (1+ index))
371 (cons (note-pitch note)
375 (pitches (map note-pitch notes)))
377 ;; handle notes with strings assigned and fingering of 0
379 (lambda (pitch-entry string-fret-finger)
380 (let* ((string (list-ref string-fret-finger 0))
381 (finger (if (eq? (length string-fret-finger) 3)
382 (list-ref string-fret-finger 2)
384 (pitch (car pitch-entry))
385 (digit (if (null? finger)
388 (if (or (not (null? string))
391 ;; here we handle fingers of 0 -- open strings
393 (find (lambda (string)
394 (open-string string pitch))
397 (set-fret! pitch-entry fit-string #f)
398 (ly:warning (_ "No open string for pitch ~a")
400 ;; here we handle assigned strings
402 (calc-fret pitch string tuning))
404 (ly:context-property context
407 (cond ((or (>= this-fret 0)
408 (eq? handle-negative 'include))
409 (set-fret! pitch-entry string finger))
410 ((eq? handle-negative 'recalculate)
413 (_ "Requested string for pitch requires negative fret: string ~a pitch ~a")
416 (ly:warning (_ "Ignoring string requesti and recalculating."))
417 (list-set! string-fret-fingers
421 (list '() #f finger)))))
422 ((eq? handle-negative 'ignore)
425 (_ "Requested string for pitch requires negative fret: string ~a pitch ~a")
428 (ly:warning (_ "Ignoring note in tablature."))
429 (list-set! string-fret-fingers
431 (list #f #t))))))))))
432 pitch-alist string-fret-fingers)
433 ;; handle notes without strings assigned -- sorted by pitch, so
434 ;; we need to use the alist to have the note number available
436 (lambda (pitch-entry)
437 (let* ((string-fret-finger (list-ref string-fret-fingers
439 (string (list-ref string-fret-finger 0))
440 (finger (if (eq? (length string-fret-finger) 3)
441 (list-ref string-fret-finger 2)
443 (pitch (car pitch-entry))
445 (find (lambda (string)
446 (string-qualifies string pitch))
448 (if (not (list-ref string-fret-finger 1))
450 (set-fret! pitch-entry fit-string finger)
451 (ly:warning (_ "No string for pitch ~a (given frets ~a)")
454 (sort pitch-alist (lambda (pitch-entry-a pitch-entry-b)
455 (ly:pitch<? (car pitch-entry-b)
456 (car pitch-entry-a)))))
457 string-fret-fingers)) ;; end of determine-frets-and-strings
459 (define (get-predefined-fretboard predefined-fret-table tuning pitches)
460 "Search through @var{predefined-fret-table} looking for a predefined
461 fretboard with a key of @var{(tuning . pitches)}. The search will check
462 both up and down an octave in order to accomodate transposition of the
463 chords. Returns a placement-list."
465 (define (get-fretboard key)
467 (hash-get-handle predefined-fret-table key)))
469 (cdr hash-handle) ; return table entry
472 ;; body of get-predefined-fretboard
473 (let ((test-fretboard (get-fretboard (cons tuning pitches))))
474 (if (not (null? test-fretboard))
476 (let ((test-fretboard
478 (cons tuning (map (lambda (x) (shift-octave x 1)) pitches)))))
479 (if (not (null? test-fretboard))
482 (cons tuning (map (lambda (x) (shift-octave x -1))
485 ;; body of determine-frets
486 (let* ((predefined-fret-table
487 (ly:context-property context 'predefinedDiagramTable))
488 (tunings (ly:context-property context 'stringTunings))
489 (string-count (length tunings))
490 (grob (if (null? rest) '() (car rest)))
491 (pitches (map (lambda (x) (ly:event-property x 'pitch)) notes))
492 (defined-strings (map (lambda (x)
495 (ly:event-property x 'string-number)))
496 (car specified-info)))
497 (defined-fingers (map (lambda (x)
500 (ly:event-property x 'digit)))
501 (cadr specified-info)))
502 (default-strings (ly:context-property context 'defaultStrings '()))
503 (strings-used (if (and (zero? (entry-count defined-strings))
504 (not (zero? (entry-count default-strings))))
507 (predefined-fretboard
508 (if predefined-fret-table
509 (get-predefined-fretboard
510 predefined-fret-table
514 (if (null? predefined-fretboard)
516 (determine-frets-and-strings
520 (ly:context-property context 'minimumFret 0)
521 (ly:context-property context 'maximumFretStretch 4)
526 context grob (string-frets->placement-list
527 string-frets string-count))))
529 (placement-list->string-frets predefined-fretboard)
530 (create-fretboard context grob predefined-fretboard)))))
534 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
537 ;; The TabNoteHead tablatureFormat callbacks.
539 ;; Calculate the fret from pitch and string number as letter
540 ;; The fret letter is taken from 'fretLabels if present
541 (define-public (fret-letter-tablature-format
542 context string-number fret-number)
543 (let ((labels (ly:context-property context 'fretLabels)))
546 ((= 0 (length labels))
547 (string (integer->char (+ fret-number (char->integer #\a)))))
548 ((and (<= 0 fret-number) (< fret-number (length labels)))
549 (list-ref labels fret-number))
551 (ly:warning (_ "No label for fret ~a (on string ~a);
552 only ~a fret labels provided")
553 fret-number string-number (length labels))
556 ;; Display the fret number as a number
557 (define-public (fret-number-tablature-format
558 context string-number fret-number)
560 (format "~a" fret-number)))
562 ;; The 5-string banjo has got a extra string, the fifth (duh), which
563 ;; starts at the fifth fret on the neck. Frets on the fifth string
564 ;; are referred to relative to the other frets:
565 ;; the "first fret" on the fifth string is really the sixth fret
566 ;; on the banjo neck.
567 ;; We solve this by defining a new fret-number-tablature function:
568 (define-public (fret-number-tablature-format-banjo
569 context string-number fret-number)
571 (number->string (cond
572 ((and (> fret-number 0) (= string-number 5))
574 (else fret-number)))))
576 ;; Tab note head staff position functions
578 ;; Define where in the staff to display a given string. Some forms of
579 ;; tablature put the tab note heads in the spaces, rather than on the
582 (define-public (tablature-position-on-lines context string-number)
583 (let* ((string-tunings (ly:context-property context 'stringTunings))
584 (string-count (length string-tunings))
585 (string-one-topmost (ly:context-property context 'stringOneTopmost))
586 (staff-line (- (* 2 string-number) string-count 1)))
587 (if string-one-topmost
591 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
594 (define-public ((every-nth-bar-number-visible n) barnum)
595 (= 0 (modulo barnum n)))
597 (define-public ((modulo-bar-number-visible n m) barnum)
598 (and (> barnum 1) (= m (modulo barnum n))))
600 (define-public ((set-bar-number-visibility n) tr)
601 (let ((bn (ly:context-property tr 'currentBarNumber)))
602 (ly:context-set-property! tr 'barNumberVisibility
603 (modulo-bar-number-visible n (modulo bn n)))))
605 (define-public (first-bar-number-invisible barnum) (> barnum 1))
607 (define-public (all-bar-numbers-visible barnum) #t)
610 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
611 ;; percent repeat counters
613 (define-public ((every-nth-repeat-count-visible n) count context)
614 (= 0 (modulo count n)))
616 (define-public (all-repeat-counts-visible count context) #t)