1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 2004--2015 Carl D. Sorensen <c_sorensen@byu.edu>
5 ;;;; LilyPond is free software: you can redistribute it and/or modify
6 ;;;; it under the terms of the GNU General Public License as published by
7 ;;;; the Free Software Foundation, either version 3 of the License, or
8 ;;;; (at your option) any later version.
10 ;;;; LilyPond is distributed in the hope that it will be useful,
11 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
12 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 ;;;; GNU General Public License for more details.
15 ;;;; You should have received a copy of the GNU General Public License
16 ;;;; along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
20 (define (string-x-extent start-point end-point)
21 "Return the x-extent of a string that goes from start-point
23 (let ((x1 (car start-point))
29 (define (string-y-extent start-point end-point)
30 "Return the y-extent of a string that goes from start-point
32 (let ((y1 (cdr start-point))
39 (define (cons-fret new-value old-list)
40 "Put together a fret-list in the format desired by parse-string"
41 (if (eq? old-list '())
43 (cons* new-value old-list)))
45 (define (get-numeric-from-key keystring)
46 "Get the numeric value from a key of the form k:val"
47 (let* ((entry (substring keystring 2 (string-length keystring)))
48 (numeric-entry (string->number entry)))
49 ;; throw an error, if `entry' can't be transformed into a number
53 "Unhandled entry in fret-diagram \"~a\" in \"~a\""
57 (define (numerify mylist)
58 "Convert string values to numeric or character"
61 (let ((numeric-value (string->number (car mylist))))
63 (cons* numeric-value (numerify (cdr mylist)))
64 (cons* (car (string->list (car mylist)))
65 (numerify (cdr mylist)))))))
68 "Calculate the font step necessary to get a desired magnification"
69 (* 6 (/ (log mag) (log 2))))
71 (define (fret-count fret-range)
72 "Calculate the fret count for the diagram given the range of frets in the diagram."
73 (1+ (- (cdr fret-range) (car fret-range))))
75 (define (dot-has-color dot-settings)
76 "Return a color-name as symbol, if found in @var{dot-settings} otherwise @code{#f}"
77 (cond ((null? dot-settings)
79 ;; Don't bother the user with quote/unquote.
80 ;; We use the name-symbol for the color, looking up in 'x11-color-list'
81 ((member (car dot-settings) (map car x11-color-list))
83 (else (dot-has-color (cdr dot-settings)))))
85 (define (dot-is-inverted dot-settings)
86 "Return @code{'inverted}, if found in @var{dot-settings} otherwise @code{'()}"
87 (let ((inverted (member 'inverted dot-settings)))
92 (define (dot-is-parenthesized dot-settings)
93 "Return @code{'parenthesized}, if found in @var{dot-settings} otherwise @code{'()}"
94 (let ((parenthesized (member 'parenthesized dot-settings)))
99 ;; If @code{'default-paren-color} is not set, the parenthesis will take their
100 ;; color from the dot.
101 ;; Setting @code{'default-paren-color} will result in taking the color from
102 ;; `what-color', see below.
103 (define (default-paren-color dot-settings)
104 "Return @code{'default-paren-color}, if found in @var{dot-settings} otherwise @code{'()}"
105 (let ((default-color (member 'default-paren-color dot-settings)))
110 (define (subtract-base-fret base-fret dot-list)
111 "Subtract @var{base-fret} from every fret in @var{dot-list}"
114 (let ((this-list (car dot-list)))
119 (- (second this-list) base-fret)
120 ;; finger-number or markup
121 (if (and (not (null? (cddr this-list)))
122 (or (markup? (caddr this-list))
123 (number? (caddr this-list))))
127 (dot-is-inverted this-list)
129 (dot-is-parenthesized this-list)
132 (default-paren-color this-list)
134 (let ((colored (dot-has-color this-list)))
138 (subtract-base-fret base-fret (cdr dot-list))))))
140 (define (drop-paren item-list)
141 "Drop a final parentheses from a fret indication list
142 @code{item-list} resulting from a terse string specification of barre."
143 (if (> (length item-list) 0)
144 (let* ((max-index (- (length item-list) 1))
145 (last-element (car (list-tail item-list max-index))))
146 (if (or (equal? last-element ")") (equal? last-element "("))
147 (list-head item-list max-index)
151 (define (get-sub-list value master-list)
152 "Get a sub-list whose cadr is equal to @var{value} from @var{master-list}"
153 (if (eq? master-list '())
155 (let ((sublist (car master-list)))
156 (if (equal? (cadr sublist) value)
158 (get-sub-list value (cdr master-list))))))
160 (define (merge-details key alist-list . default)
161 "Return @code{alist-list} entries for @code{key}, in one combined alist.
162 There can be two @code{alist-list} entries for a given key. The first
163 comes from the override-markup function, the second comes
164 from property settings during a regular override.
165 This is necessary because some details can be set in one
166 place, while others are set in the other. Both details
167 lists must be merged into a single alist.
168 Return @code{default} (optional, else #f) if not
171 (define (helper key alist-list default)
172 (if (null? alist-list)
174 (let* ((entry (assoc-get key (car alist-list))))
176 (append entry (chain-assoc-get key (cdr alist-list) '()))
177 (helper key (cdr alist-list) default)))))
179 (helper key alist-list
180 (if (pair? default) (car default) #f)))
182 ;; Conversions between fret/string coordinate system and x-y coordinate
185 ;; Fret coordinates are measured down the fretboard from the nut,
188 ;; String coordinates are measured from the lowest string, starting at 0.
190 ;; The x-y origin is at the intersection of the nut and the lowest string.
192 ;; X coordinates are positive to the right.
193 ;; Y coordinates are positive up.
195 (define (negate-extent extent)
196 "Return the extent in an axis opposite to the axis of @code{extent}."
197 (cons (- (cdr extent)) (- (car extent))))
199 (define (stencil-fretboard-extent stencil fretboard-axis orientation)
200 "Return the extent of @code{stencil} in the @code{fretboard-axis}
202 (if (eq? fretboard-axis 'fret)
203 (cond ((eq? orientation 'landscape)
204 (ly:stencil-extent stencil X))
205 ((eq? orientation 'opposing-landscape)
206 (negate-extent (ly:stencil-extent stencil X)))
208 (negate-extent (ly:stencil-extent stencil Y))))
209 ;; else -- eq? fretboard-axis 'string
210 (cond ((eq? orientation 'landscape)
211 (ly:stencil-extent stencil Y))
212 ((eq? orientation 'opposing-landscape)
213 (negate-extent (ly:stencil-extent stencil Y)))
215 (ly:stencil-extent stencil Y)))))
218 (define (stencil-fretboard-offset stencil fretboard-axis orientation)
219 "Return a the stencil coordinates of the center of @code{stencil}
220 in the @code{fretboard-axis} direction."
221 (* 0.5 (interval-length
222 (stencil-fretboard-extent stencil fretboard-axis orientation))))
225 (define (string-thickness string thickness-factor)
226 (expt (1+ thickness-factor) (1- string)))
228 ;; Functions that create stencils used in the fret diagram
230 (define (sans-serif-stencil layout props mag text)
231 "Create a stencil in sans-serif font based on @var{layout} and @var{props}
232 with magnification @var{mag} of the string @var{text}."
235 'font-size (stepmag mag)
236 (prepend-alist-chain 'font-family 'sans props))))
237 (interpret-markup layout my-props text)))
239 ;; markup commands and associated functions
241 (define (fret-parse-marking-list marking-list my-fret-count)
242 "Parse a fret-diagram-verbose marking list into component sublists"
243 (let* ((fret-range (cons 1 my-fret-count))
249 (let parse-item ((mylist marking-list))
250 (if (not (null? mylist))
251 (let* ((my-item (car mylist)) (my-code (car my-item)))
253 ((or (eq? my-code 'open)(eq? my-code 'mute))
254 (set! xo-list (cons* my-item xo-list)))
255 ((eq? my-code 'barre)
256 (if (every number? (cdr my-item))
257 (set! barre-list (cons* (cdr my-item) barre-list))
259 "barre-indications should contain only numbers: ~a"
262 (set! capo-fret (cadr my-item)))
263 ((eq? my-code 'place-fret)
264 (set! dot-list (cons* (cdr my-item) dot-list))))
265 (parse-item (cdr mylist)))))
266 ;; calculate fret-range
268 (minfret (if (> capo-fret 0) capo-fret 99)))
269 (let updatemax ((fret-list dot-list)) ;CHANGE THIS TO HELPER FUNCTION?
270 (if (null? fret-list)
272 (let ((fretval (second (car fret-list))))
273 (if (> fretval maxfret) (set! maxfret fretval))
274 (if (< fretval minfret) (set! minfret fretval))
275 (updatemax (cdr fret-list)))))
276 ;; take frets of 'barre-settings into account
277 (if (not (null? barre-list))
278 (set! minfret (apply min minfret (map last barre-list))))
279 (if (or (> maxfret my-fret-count) (> capo-fret 1))
282 (let ((upfret (- (+ minfret my-fret-count) 1)))
283 (if (> maxfret upfret) maxfret upfret)))))
284 (set! capo-fret (1+ (- capo-fret minfret)))
285 ;; subtract fret from dots
286 (set! dot-list (subtract-base-fret (- (car fret-range) 1) dot-list)))
287 (acons 'fret-range fret-range
288 (acons 'barre-list barre-list
289 (acons 'dot-list dot-list
290 (acons 'xo-list xo-list
291 (acons 'capo-fret capo-fret '())))))))
293 (define (make-fret-diagram layout props marking-list)
294 "Make a fret diagram markup"
296 ;; note: here we get items from props that are needed in this routine,
297 ;; or that are needed in more than one of the procedures
298 ;; called from this routine. If they're only used in one of the
299 ;; sub-procedure, they're obtained in that procedure
300 (size (chain-assoc-get 'size props 1.0)) ; needed for everything
301 ;;TODO -- get string-count directly from length of stringTunings;
302 ;; from FretBoard engraver, but not from markup call
303 (details (merge-details 'fret-diagram-details props '()))
305 (assoc-get 'string-count details 6)) ;; needed for everything
307 (assoc-get 'fret-count details 4)) ;; needed for everything
309 (assoc-get 'orientation details 'normal)) ;; needed for everything
312 'finger-code details 'none)) ;; needed for draw-dots and draw-barre
314 (if (eq? finger-code 'in-dot) 0.425 0.25)) ;; bigger dots if labeled
315 (default-dot-position
316 (if (eq? finger-code 'in-dot)
317 (- 0.95 default-dot-radius)
318 0.6)) ; move up to make room for bigger dot if labeled
321 'dot-radius details default-dot-radius))
322 ;; needed for draw-dots and draw-barre
325 'dot-position details default-dot-position))
326 ;; needed for draw-dots and draw-barre
328 (* (ly:output-def-lookup layout 'line-thickness)
329 (chain-assoc-get 'thickness props 0.5)))
330 ;; needed for draw-frets and draw-strings
332 (thickness-factor (assoc-get 'string-thickness-factor details 0))
333 (paren-padding (assoc-get 'paren-padding details 0.05))
335 (chain-assoc-get 'align-dir props -0.4)) ;; needed only here
336 (xo-padding (assoc-get 'xo-padding details 0.2)) ;; needed only here
337 (parameters (fret-parse-marking-list marking-list my-fret-count))
338 (capo-fret (assoc-get 'capo-fret parameters 0))
339 (dot-list (assoc-get 'dot-list parameters))
340 (xo-list (assoc-get 'xo-list parameters))
341 (fret-range (assoc-get 'fret-range parameters))
342 (my-fret-count (fret-count fret-range))
343 (barre-list (assoc-get 'barre-list parameters))
345 (assoc-get 'barre-type details 'curved))
346 (fret-diagram-stencil '()))
348 ;; Here are the fret diagram helper functions that depend on the
349 ;; fret diagram parameters. The functions are here because the
350 ;; diagram parameters are part of the lexical scope here.
352 (define (stencil-coordinates fret-coordinate string-coordinate)
353 "Return a pair @code{(x-coordinate . y-coordinate)}
354 in stencil coordinate system."
356 ((eq? orientation 'landscape)
357 (cons fret-coordinate
358 (- string-coordinate (1- string-count))))
359 ((eq? orientation 'opposing-landscape)
360 (cons (- fret-coordinate) (- string-coordinate)))
362 (cons string-coordinate (- fret-coordinate)))))
364 (define (stencil-coordinate-offset fret-offset string-offset)
365 "Return a pair @code{(x-offset . y-offset)}
366 for translation in stencil coordinate system."
368 ((eq? orientation 'landscape)
369 (cons fret-offset (- string-offset)))
370 ((eq? orientation 'opposing-landscape)
371 (cons (- fret-offset) string-offset))
373 (cons string-offset (- fret-offset)))))
377 (define (make-bezier-sandwich-list start stop base height
379 "Make the argument list for a bezier sandwich from
380 string coordinate @var{start} to string-coordinate @var{stop} with a
381 baseline at fret coordinate @var{base}, a height of
382 @var{height}, and a half thickness of @var{half-thickness}."
383 (let* ((width (+ (- stop start) 1))
384 (cp-left-width (+ (* width half-thickness) start))
385 (cp-right-width (- stop (* width half-thickness)))
386 (bottom-control-point-height
387 (- base (- height half-thickness)))
388 (top-control-point-height
391 (stencil-coordinates base start))
393 (stencil-coordinates base stop))
394 (left-upper-control-point
396 top-control-point-height cp-left-width))
397 (left-lower-control-point
399 bottom-control-point-height cp-left-width))
400 (right-upper-control-point
402 top-control-point-height cp-right-width))
403 (right-lower-control-point
405 bottom-control-point-height cp-right-width)))
407 ;; order of bezier control points is:
408 ;; left cp low, right cp low, right end low, left end low
409 ;; right cp high, left cp high, left end high, right end high.
411 (list left-lower-control-point
412 right-lower-control-point
415 right-upper-control-point
416 left-upper-control-point
420 (define (draw-strings)
421 "Draw the string lines for a fret diagram with
422 @var{string-count} strings and frets as indicated in @var{fret-range}.
423 Line thickness is given by @var{th}, fret & string spacing by
424 @var{size}. Orientation is determined by @var{orientation}."
428 (string-stencil (car x))
430 (string-stencil (car x))
433 (let* ((string-list (map 1+ (iota string-count))))
434 (helper string-list)))
436 (define (string-stencil string)
437 "Make a stencil for @code{string}, given the fret-diagram
439 (let* ((string-coordinate (- string-count string))
440 (current-string-thickness
441 (* th size (string-thickness string thickness-factor)))
442 (fret-half-thickness (* size th 0.5))
443 (half-string (* current-string-thickness 0.5))
446 (- fret-half-thickness)
447 (- (* size string-coordinate) half-string)))
450 (+ fret-half-thickness (* size (1+ (fret-count fret-range))))
451 (+ half-string (* size string-coordinate)))))
453 (string-x-extent start-coordinates end-coordinates)
454 (string-y-extent start-coordinates end-coordinates)
458 "Draw the fret lines for a fret diagram with
459 @var{string-count} strings and frets as indicated in @var{fret-range}.
460 Line thickness is given by @var{th}, fret & string spacing by
461 @var{size}. Orientation is given by @var{orientation}."
464 (fret-stencil (car x))
466 (fret-stencil (car x))
469 (let ((fret-list (iota (1+ my-fret-count))))
472 (define (fret-stencil fret)
473 "Make a stencil for @code{fret}, given the
474 fret-diagram overall parameters."
475 (let* ((low-string-half-thickness
479 (string-thickness string-count thickness-factor)))
480 (fret-half-thickness (* 0.5 size th))
484 (- fret-half-thickness low-string-half-thickness)))
488 (* size (1- string-count)))))
491 (car start-coordinates) (cdr start-coordinates)
492 (car end-coordinates) (cdr end-coordinates))))
494 (define (draw-barre barre-list)
495 "Create barre indications for a fret diagram"
496 (if (not (null? barre-list))
497 (let* ((string1 (caar barre-list))
498 (string2 (cadar barre-list))
499 (barre-fret (caddar barre-list))
500 (top-fret (cdr fret-range))
501 (low-fret (car fret-range))
502 (fret (1+ (- barre-fret low-fret)))
503 (barre-vertical-offset 0.5)
504 (dot-center-fret-coordinate (+ (1- fret) dot-position))
505 (barre-fret-coordinate
506 (+ dot-center-fret-coordinate
507 (* (- barre-vertical-offset 0.5) dot-radius)))
508 (barre-start-string-coordinate (- string-count string1))
509 (barre-end-string-coordinate (- string-count string2))
510 (scale-dot-radius (* size dot-radius))
511 (barre-type (assoc-get 'barre-type details 'curved))
514 ((eq? barre-type 'straight)
515 (make-straight-barre-stencil
516 barre-fret-coordinate
517 barre-start-string-coordinate
518 barre-end-string-coordinate
520 ((eq? barre-type 'curved)
521 (make-curved-barre-stencil
522 barre-fret-coordinate
523 barre-start-string-coordinate
524 barre-end-string-coordinate
525 scale-dot-radius)))))
526 (if (not (null? (cdr barre-list)))
529 (draw-barre (cdr barre-list)))
532 (define (make-straight-barre-stencil
534 start-string-coordinate
535 end-string-coordinate
537 "Create a straight barre stencil."
540 (* size fret-coordinate)
541 (* size start-string-coordinate)))
544 (* size fret-coordinate)
545 (* size end-string-coordinate))))
553 (define (make-curved-barre-stencil
555 start-string-coordinate
556 end-string-coordinate
558 "Create a curved barre stencil."
559 (let* ((bezier-thick 0.1)
562 (make-bezier-sandwich-list
563 (* size start-string-coordinate)
564 (* size end-string-coordinate)
565 (* size fret-coordinate)
566 (* size bezier-height)
567 (* size bezier-thick)))
570 (+ (* size fret-coordinate) half-thickness)
571 (- (* size start-string-coordinate) half-thickness)))
574 (- (* size fret-coordinate)
575 (* size bezier-height)
577 (+ (* size end-string-coordinate) half-thickness)))
578 (x-extent (cons (car box-lower-left) (car box-upper-right)))
579 (y-extent (cons (cdr box-lower-left) (cdr box-upper-right))))
580 (make-bezier-sandwich-stencil
582 (* size bezier-thick)
586 (define (draw-dots dot-list)
587 "Make dots for fret diagram."
589 (let* ( (scale-dot-radius (* size dot-radius))
590 (scale-dot-thick (* size th))
591 (default-dot-color (assoc-get 'dot-color details))
592 (finger-label-padding 0.3)
595 (assoc-get 'dot-label-font-mag details 1.0)))
596 (string-label-font-mag
599 'string-label-font-mag details
600 (cond ((or (eq? orientation 'landscape)
601 (eq? orientation 'opposing-landscape))
604 (mypair (car dot-list))
605 (restlist (cdr dot-list))
606 (string (car mypair))
608 (fret-coordinate (* size (+ (1- fret) dot-position)))
609 (string-coordinate (* size (- string-count string)))
611 (stencil-coordinates fret-coordinate string-coordinate))
612 (extent (cons (- scale-dot-radius) scale-dot-radius))
613 (finger (caddr mypair))
614 (finger (if (number? finger) (number->string finger) finger))
616 (if (not (null? (dot-is-parenthesized mypair)))
617 (dot-is-parenthesized mypair)
620 (if (not (null? (default-paren-color mypair)))
621 (default-paren-color mypair)
624 (if (not (null? (dot-is-inverted mypair)))
625 (dot-is-inverted mypair)
629 (and (eq? default-dot-color 'white) (not inverted))))
633 (not (dot-has-color mypair))
634 (not (eq? default-dot-color 'white)))
635 (or default-dot-color 'black))
637 (or (dot-has-color mypair) 'black))
639 (or (dot-has-color mypair)
647 scale-dot-radius scale-dot-thick #t)
651 (- scale-dot-radius (* 0.5 scale-dot-thick))
653 (x11-color 'white)))))
655 (if dot-color-is-white?
656 (inverted-stil what-color)
659 scale-dot-radius scale-dot-thick #t)
663 (if (and parenthesis-color
664 (not (eq? default-dot-color 'white)))
665 (x11-color (or default-dot-color 'black))
668 (parenthesize-stencil
669 dot-stencil ;; stencil
670 (* size th 0.75) ;; half-thickness
671 (* 0.15 size) ;;width
673 paren-padding ;; padding
681 (ly:stencil-translate final-dot-stencil dot-coordinates))
684 ((or (eq? finger '())(eq? finger-code 'none))
686 ((eq? finger-code 'in-dot)
688 (if (not (null? finger))
690 layout props dot-label-font-mag finger)
693 (interval-length (ly:stencil-extent finger-stil X)))
695 (interval-length (ly:stencil-extent finger-stil Y)))
697 (/ (interval-length (ly:stencil-extent dot-stencil Y))
700 (/ dot-stencil-radius
701 ;; Calculate the radius of the circle through the
702 ;; corners of the box containing the finger-stil.
703 ;; Give it a little padding. The value, (* 2 th),
707 (+ (expt (/ finger-stil-length 2) 2)
708 (expt (/ finger-stil-height 2) 2)))
717 scale-factor scale-factor))))
718 (ly:stencil-translate
721 (if dot-color-is-white?
725 (stencil-with-color finger-label white)))
727 ((eq? finger-code 'below-string)
728 (let* ((label-stencil
731 layout props string-label-font-mag
734 (stencil-fretboard-offset
735 label-stencil 'fret orientation))
736 (label-fret-coordinate
738 (+ 1 my-fret-count finger-label-padding))
740 (label-string-coordinate string-coordinate)
743 label-fret-coordinate
744 label-string-coordinate)))
747 (ly:stencil-translate
749 label-translation))))
750 (else ;unknown finger-code
756 labeled-dot-stencil))))
758 (define (draw-thick-zero-fret)
759 "Draw a thick zeroth fret for a fret diagram whose base fret is 1."
760 (let* ((half-lowest-string-thickness
761 (* 0.5 th (string-thickness string-count thickness-factor)))
762 (half-thick (* 0.5 sth))
764 (* sth (assoc-get 'top-fret-thickness details 3.0)))
765 (start-string-coordinate (- half-lowest-string-thickness))
766 (end-string-coordinate (+ (* size (1- string-count)) half-thick))
767 (start-fret-coordinate half-thick)
768 (end-fret-coordinate (- half-thick top-fret-thick))
771 start-fret-coordinate start-string-coordinate))
774 end-fret-coordinate end-string-coordinate)))
776 ;; Put limits in order, or else the intervals are considered empty
777 (ordered-cons (car lower-left) (car upper-right))
778 (ordered-cons (cdr lower-left) (cdr upper-right))
781 (define (draw-xo xo-list)
782 "Put open and mute string indications on diagram, as contained in
785 (assoc-get 'xo-font-magnification details
786 (cond ((or (eq? orientation 'landscape)
787 (eq? orientation 'opposing-landscape))
790 (mypair (car xo-list))
791 (restlist (cdr xo-list))
792 (glyph-string (if (eq? (car mypair) 'mute)
793 (assoc-get 'mute-string details "X")
794 (assoc-get 'open-string details "O")))
795 (glyph-string-coordinate (* (- string-count (cadr mypair)) size))
799 layout props (* size xo-font-mag) glyph-string)))
800 (glyph-stencil-coordinates
801 (stencil-coordinates 0 glyph-string-coordinate))
803 (ly:stencil-translate
805 glyph-stencil-coordinates)))
810 (draw-xo restlist)))))
812 (define (draw-capo fret)
813 "Draw a capo indicator across the full width of the fret-board
816 (* size (assoc-get 'capo-thickness details 0.5)))
817 (half-thick (* capo-thick 0.5))
818 (last-string-position 0)
819 (first-string-position (* size (- string-count 1)))
820 (fret-position ( * size (1- (+ dot-position fret))))
824 first-string-position))
828 last-string-position)))
831 (car start-point) (cdr start-point)
832 (car end-point) (cdr end-point))))
834 (define (label-fret fret-range)
835 "Label the base fret on a fret diagram"
836 (let* ((base-fret (car fret-range))
837 (label-font-mag (assoc-get 'fret-label-font-mag details 0.5))
838 (label-space (* 0.5 size))
839 (label-dir (assoc-get 'label-dir details RIGHT))
840 (label-vertical-offset
841 (assoc-get 'fret-label-vertical-offset details 0))
842 (label-horizontal-offset
843 (assoc-get 'fret-label-horizontal-offset details 0))
845 (assoc-get 'number-type details 'roman-lower))
847 (number-format number-type base-fret
848 (assoc-get 'fret-label-custom-format
853 layout props (* size label-font-mag) label-text)))
855 (stencil-fretboard-offset
859 (label-outside-diagram
861 (* size label-horizontal-offset)
863 (ly:stencil-translate
866 (* size (+ 1.0 label-vertical-offset))
867 (if (eq? label-dir LEFT)
868 (- label-outside-diagram)
869 (+ (* size (1- string-count)) label-outside-diagram))))))
871 ;; Here is the body of make-fret-diagram
873 (set! fret-diagram-stencil
874 (ly:stencil-add (draw-strings) (draw-frets)))
875 (if (and (not (null? barre-list))
876 (not (eq? 'none barre-type)))
877 (set! fret-diagram-stencil
879 (draw-barre barre-list)
880 fret-diagram-stencil)))
881 (if (not (null? dot-list))
882 (set! fret-diagram-stencil
885 (draw-dots dot-list))))
886 (if (= (car fret-range) 1)
887 (set! fret-diagram-stencil
890 (draw-thick-zero-fret))))
891 (if (not (null? xo-list))
892 (let* ((diagram-fret-top
893 (car (stencil-fretboard-extent
897 (xo-stencil (draw-xo xo-list))
899 (stencil-fretboard-offset
900 xo-stencil 'fret orientation))
902 (stencil-coordinate-offset
907 (set! fret-diagram-stencil
910 (ly:stencil-translate
912 xo-stencil-offset)))))
914 (set! fret-diagram-stencil
917 (draw-capo capo-fret))))
918 (if (> (car fret-range) 1)
919 (set! fret-diagram-stencil
922 (label-fret fret-range))))
923 (ly:stencil-aligned-to fret-diagram-stencil X alignment)))
925 (define (fret-parse-definition-string props definition-string)
926 "Parse a fret diagram string and return a pair containing:
927 @var{props}, modified as necessary by the definition-string
928 a fret-indication list with the appropriate values"
929 (let* ((fret-count 4)
931 (fret-range (cons 1 fret-count))
937 (details (merge-details 'fret-diagram-details props '()))
938 ;; remove whitespace-characters from definition-string
939 (cleared-string (remove-whitespace definition-string))
940 (items (string-split cleared-string #\;)))
941 (let parse-item ((myitems items))
942 (if (not (null? (cdr myitems)))
943 (let ((test-string (car myitems)))
944 (case (car (string->list (substring test-string 0 1)))
945 ((#\s) (let ((size (get-numeric-from-key test-string)))
946 (set! props (prepend-alist-chain 'size size props))))
947 ((#\t) (let ((th (get-numeric-from-key test-string)))
948 (set! props (prepend-alist-chain 'thickness th props))))
949 ((#\f) (let* ((finger-code (get-numeric-from-key test-string))
950 (finger-id (case finger-code
953 ((2) 'below-string))))
955 (acons 'finger-code finger-id details))))
956 ((#\c) (set! output-list
961 (string-split (substring test-string 2) #\-)))
963 ((#\h) (let ((fret-count (get-numeric-from-key test-string)))
965 (acons 'fret-count fret-count details))))
966 ((#\w) (let ((string-count (get-numeric-from-key test-string)))
968 (acons 'string-count string-count details))))
969 ((#\d) (let ((dot-size (get-numeric-from-key test-string)))
971 (acons 'dot-radius dot-size details))))
972 ((#\p) (let ((dot-position (get-numeric-from-key test-string)))
974 (acons 'dot-position dot-position details))))
976 (let* ((this-list (string-split test-string #\-))
977 (fret-number (string->number (car this-list))))
978 ;; If none of the above applies, `fret-number' needs to be a
979 ;; number. Throw an error, if not.
980 (if (not fret-number)
982 "Unhandled entry in fret-diagrams \"~a\" in \"~a\""
985 (if (string->number (cadr this-list))
988 (cons 'place-fret (numerify this-list))
990 (if (equal? (cadr this-list) "x" )
993 (list 'mute fret-number)
997 (list 'open fret-number)
999 (parse-item (cdr myitems)))))
1000 ;; add the modified details
1002 (prepend-alist-chain 'fret-diagram-details details props))
1003 `(,props . ,output-list))) ;ugh -- hard-coded spell -- procedure better
1006 (fret-parse-terse-definition-string props definition-string)
1007 "Parse a fret diagram string that uses terse syntax;
1008 return a pair containing:
1009 @var{props}, modified to include the string-count determined by the
1010 definition-string, and
1011 a fret-indication list with the appropriate values"
1012 ;; TODO -- change syntax to fret\string-finger
1014 (let* ((details (merge-details 'fret-diagram-details props '()))
1015 (barre-start-list '())
1018 (items (string-split definition-string #\;))
1019 (string-count (- (length items) 1)))
1020 (let parse-item ((myitems items))
1021 (if (not (null? (cdr myitems)))
1022 (let* ((test-string (car myitems))
1023 (current-string (- (length myitems) 1))
1024 (indicators (string-split test-string #\ )))
1025 (let parse-indicators ((myindicators indicators))
1026 (if (not (eq? '() myindicators))
1027 (let* ((this-list (string-split (car myindicators) #\-))
1028 (max-element-index (- (length this-list) 1))
1030 (car (list-tail this-list max-element-index)))
1032 (if (string->number (car this-list))
1033 (string->number (car this-list))
1035 (if (equal? last-element "(")
1037 (set! barre-start-list
1038 (cons-fret (list current-string fret)
1041 (list-head this-list max-element-index))))
1042 (if (equal? last-element ")")
1044 (get-sub-list fret barre-start-list))
1045 (insert-index (- (length this-barre) 1)))
1047 (cons-fret (cons* 'barre
1053 (list-head this-list max-element-index))))
1060 (drop-paren (numerify this-list)))
1062 (if (equal? (car this-list) "x" )
1066 (list 'mute current-string)
1071 (list 'open current-string)
1073 (parse-indicators (cdr myindicators)))))
1074 (parse-item (cdr myitems)))))
1075 (set! details (acons 'string-count string-count details))
1076 (set! props (prepend-alist-chain 'fret-diagram-details details props))
1077 `(,props . ,output-list))) ; ugh -- hard coded; proc is better
1080 (define-markup-command
1081 (fret-diagram-verbose layout props marking-list)
1082 (pair?) ; argument type (list, but use pair? for speed)
1083 #:category instrument-specific-markup ; markup type
1084 #:properties ((align-dir -0.4) ; properties and defaults
1086 (fret-diagram-details)
1088 "Make a fret diagram containing the symbols indicated in @var{marking-list}.
1093 \\markup \\fret-diagram-verbose
1094 #'((mute 6) (mute 5) (open 4)
1095 (place-fret 3 2) (place-fret 2 3) (place-fret 1 2))
1099 produces a standard D@tie{}chord diagram without fingering indications.
1101 Possible elements in @var{marking-list}:
1104 @item (mute @var{string-number})
1105 Place a small @q{x} at the top of string @var{string-number}.
1107 @item (open @var{string-number})
1108 Place a small @q{o} at the top of string @var{string-number}.
1110 @item (barre @var{start-string} @var{end-string} @var{fret-number})
1111 Place a barre indicator (much like a tie) from string @var{start-string}
1112 to string @var{end-string} at fret @var{fret-number}.
1114 @item (capo @var{fret-number})
1115 Place a capo indicator (a large solid bar) across the entire fretboard
1116 at fret location @var{fret-number}. Also, set fret @var{fret-number}
1117 to be the lowest fret on the fret diagram.
1119 (place-fret @var{string-number}
1121 [@var{finger-value}]
1122 [@var{color-modifier}]
1124 [@code{'parenthesized} [@code{'default-paren-color}]])
1125 Place a fret playing indication on string @var{string-number} at fret
1126 @var{fret-number} with an optional fingering label @var{finger-value},
1127 an optional color modifier @var{color-modifier}, an optional color
1128 @var{color}, an optional parenthesis @code{'parenthesized} and an
1129 optional paranthesis color @code{'default-paren-color}.
1130 By default, the fret playing indicator is a solid dot. This can be
1131 globally changed by setting the value of the variable @var{dot-color}
1132 or for a single dot by setting the value of @var{color}. The dot can
1133 be parenthesized by adding @code{'parenthesized}. By default the
1134 color for the parenthesis is taken from the dot. Adding
1135 @code{'default-paren-color} will take the parenthesis-color from the
1136 global @var{dot-color}, as a fall-back black will be used.
1137 Setting @var{color-modifier} to @code{inverted} inverts the dot color
1138 for a specific fingering.
1139 The values for @var{string-number}, @var{fret-number}, and the optional
1140 @var{finger} should be entered first in that order.
1141 The order of the other optional arguments does not matter.
1142 If the @var{finger} part of the @code{place-fret} element is present,
1143 @var{finger-value} will be displayed according to the setting of the
1144 variable @var{finger-code}. There is no limit to the number of fret
1145 indications per string.
1148 (make-fret-diagram layout props marking-list))
1151 (define-markup-command (fret-diagram layout props definition-string)
1152 (string?) ; argument type
1153 #:category instrument-specific-markup ; markup category
1154 #:properties (fret-diagram-verbose-markup) ; properties and defaults
1155 "Make a (guitar) fret diagram. For example, say
1158 \\markup \\fret-diagram #\"s:0.75;6-x;5-x;4-o;3-2;2-3;1-2;\"
1162 for fret spacing 3/4 of staff space, D chord diagram
1164 Syntax rules for @var{definition-string}:
1168 Diagram items are separated by semicolons.
1175 @code{s:}@var{number} -- Set the fret spacing of the diagram (in staff
1180 @code{t:}@var{number} -- Set the line thickness (relative to normal
1185 @code{h:}@var{number} -- Set the height of the diagram in frets.
1189 @code{w:}@var{number} -- Set the width of the diagram in strings.
1193 @code{f:}@var{number} -- Set fingering label type
1194 (0@tie{}= none, 1@tie{}= in circle on string, 2@tie{}= below string).
1198 @code{d:}@var{number} -- Set radius of dot, in terms of fret spacing.
1202 @code{p:}@var{number} -- Set the position of the dot in the fret space.
1203 0.5 is centered; 1@tie{}is on lower fret bar, 0@tie{}is on upper fret bar.
1207 @code{c:}@var{string1}@code{-}@var{string2}@code{-}@var{fret} -- Include a
1208 barre mark from @var{string1} to @var{string2} on @var{fret}.
1211 @var{string}@code{-}@var{fret} -- Place a dot on @var{string} at @var{fret}.
1212 If @var{fret} is @samp{o}, @var{string} is identified as open.
1213 If @var{fret} is @samp{x}, @var{string} is identified as muted.
1216 @var{string}@code{-}@var{fret}@code{-}@var{fingering} -- Place a dot on
1217 @var{string} at @var{fret}, and label with @var{fingering} as defined
1218 by the @code{f:} code.
1222 Note: There is no limit to the number of fret indications per string.
1224 (let ((definition-list
1225 (fret-parse-definition-string props definition-string)))
1226 (fret-diagram-verbose-markup
1227 layout (car definition-list) (cdr definition-list))))
1229 (define-markup-command
1230 (fret-diagram-terse layout props definition-string)
1231 (string?) ; argument type
1232 #:category instrument-specific-markup ; markup category
1233 #:properties (fret-diagram-verbose-markup) ; properties
1234 "Make a fret diagram markup using terse string-based syntax.
1239 \\markup \\fret-diagram-terse #\"x;x;o;2;3;2;\"
1243 for a D@tie{}chord diagram.
1245 Syntax rules for @var{definition-string}:
1250 Strings are terminated by semicolons; the number of semicolons
1251 is the number of strings in the diagram.
1254 Mute strings are indicated by @samp{x}.
1257 Open strings are indicated by @samp{o}.
1260 A number indicates a fret indication at that fret.
1263 If there are multiple fret indicators desired on a string, they
1264 should be separated by spaces.
1267 Fingerings are given by following the fret number with a @w{@code{-},}
1268 followed by the finger indicator, e.g. @samp{3-2} for playing the third
1269 fret with the second finger.
1272 Where a barre indicator is desired, follow the fret (or fingering) symbol
1273 with @w{@code{-(}} to start a barre and @w{@code{-)}} to end the barre.
1276 ;; TODO -- change syntax to fret\string-finger
1277 (let ((definition-list
1278 (fret-parse-terse-definition-string props definition-string)))
1279 (fret-diagram-verbose-markup layout
1280 (car definition-list)
1281 (cdr definition-list))))