;;;; This file is part of LilyPond, the GNU music typesetter.
;;;;
;;;; Copyright (C) 2004--2014 Carl D. Sorensen
;;;;
;;;; LilyPond is free software: you can redistribute it and/or modify
;;;; it under the terms of the GNU General Public License as published by
;;;; the Free Software Foundation, either version 3 of the License, or
;;;; (at your option) any later version.
;;;;
;;;; LilyPond is distributed in the hope that it will be useful,
;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;;;; GNU General Public License for more details.
;;;;
;;;; You should have received a copy of the GNU General Public License
;;;; along with LilyPond. If not, see .
;; Utility functions
(define (string-x-extent start-point end-point)
"Return the x-extent of a string that goes from start-point
to end-point."
(let ((x1 (car start-point))
(x2 (car end-point)))
(if (> x1 x2)
(cons x2 x1)
(cons x1 x2))))
(define (string-y-extent start-point end-point)
"Return the y-extent of a string that goes from start-point
to end-point."
(let ((y1 (cdr start-point))
(y2 (cdr end-point)))
(if (> y1 y2)
(cons y2 y1)
(cons y1 y2))))
(define (cons-fret new-value old-list)
"Put together a fret-list in the format desired by parse-string"
(if (eq? old-list '())
(list new-value)
(cons* new-value old-list)))
(define (get-numeric-from-key keystring)
"Get the numeric value from a key of the form k:val"
(string->number (substring keystring 2 (string-length keystring))))
(define (numerify mylist)
"Convert string values to numeric or character"
(if (null? mylist)
'()
(let ((numeric-value (string->number (car mylist))))
(if numeric-value
(cons* numeric-value (numerify (cdr mylist)))
(cons* (car (string->list (car mylist)))
(numerify (cdr mylist)))))))
(define (stepmag mag)
"Calculate the font step necessary to get a desired magnification"
(* 6 (/ (log mag) (log 2))))
(define (fret-count fret-range)
"Calculate the fret count for the diagram given the range of frets in the diagram."
(1+ (- (cdr fret-range) (car fret-range))))
(define (dot-has-color dot-settings)
"Return a color-name as symbol, if found in @var{dot-settings} otherwise @code{#f}"
(cond ((null? dot-settings)
#f)
;; Don't bother the user with quote/unquote.
;; We use the name-symbol for the color, looking up in 'x11-color-list'
((member (car dot-settings) (map car x11-color-list))
(car dot-settings))
(else (dot-has-color (cdr dot-settings)))))
(define (dot-is-inverted dot-settings)
"Return @code{'inverted}, if found in @var{dot-settings} otherwise @code{'()}"
(let ((inverted (member 'inverted dot-settings)))
(if inverted
(car inverted)
'())))
(define (dot-is-parenthesized dot-settings)
"Return @code{'parenthesized}, if found in @var{dot-settings} otherwise @code{'()}"
(let ((parenthesized (member 'parenthesized dot-settings)))
(if parenthesized
(car parenthesized)
'())))
;; If @code{'default-paren-color} is not set, the parenthesis will take their
;; color from the dot.
;; Setting @code{'default-paren-color} will result in taking the color from
;; `what-color', see below.
(define (default-paren-color dot-settings)
"Return @code{'default-paren-color}, if found in @var{dot-settings} otherwise @code{'()}"
(let ((default-color (member 'default-paren-color dot-settings)))
(if default-color
(car default-color)
'())))
(define (subtract-base-fret base-fret dot-list)
"Subtract @var{base-fret} from every fret in @var{dot-list}"
(if (null? dot-list)
'()
(let ((this-list (car dot-list)))
(cons* (list
;; string
(car this-list)
;; fret
(- (second this-list) base-fret)
;; finger-number or string
(if (and (not (null? (cddr this-list)))
(or (markup? (caddr this-list))
(number? (caddr this-list))))
(third this-list)
'())
;; inverted
(dot-is-inverted this-list)
;; parenthesis
(dot-is-parenthesized this-list)
;; color modifiers
;; parenthesis
(default-paren-color this-list)
;; dots
(let ((colored (dot-has-color this-list)))
(if colored
colored
'())))
(subtract-base-fret base-fret (cdr dot-list))))))
(define (drop-paren item-list)
"Drop a final parentheses from a fret indication list
@code{item-list} resulting from a terse string specification of barre."
(if (> (length item-list) 0)
(let* ((max-index (- (length item-list) 1))
(last-element (car (list-tail item-list max-index))))
(if (or (equal? last-element ")") (equal? last-element "("))
(list-head item-list max-index)
item-list))
item-list))
(define (get-sub-list value master-list)
"Get a sub-list whose cadr is equal to @var{value} from @var{master-list}"
(if (eq? master-list '())
#f
(let ((sublist (car master-list)))
(if (equal? (cadr sublist) value)
sublist
(get-sub-list value (cdr master-list))))))
(define (merge-details key alist-list . default)
"Return @code{alist-list} entries for @code{key}, in one combined alist.
There can be two @code{alist-list} entries for a given key. The first
comes from the override-markup function, the second comes
from property settings during a regular override.
This is necessary because some details can be set in one
place, while others are set in the other. Both details
lists must be merged into a single alist.
Return @code{default} (optional, else #f) if not
found."
(define (helper key alist-list default)
(if (null? alist-list)
default
(let* ((entry (assoc-get key (car alist-list))))
(if entry
(append entry (chain-assoc-get key (cdr alist-list) '()))
(helper key (cdr alist-list) default)))))
(helper key alist-list
(if (pair? default) (car default) #f)))
;; Conversions between fret/string coordinate system and x-y coordinate
;; system.
;;
;; Fret coordinates are measured down the fretboard from the nut,
;; starting at 0.
;;
;; String coordinates are measured from the lowest string, starting at 0.
;;
;; The x-y origin is at the intersection of the nut and the lowest string.
;;
;; X coordinates are positive to the right.
;; Y coordinates are positive up.
(define (negate-extent extent)
"Return the extent in an axis opposite to the axis of @code{extent}."
(cons (- (cdr extent)) (- (car extent))))
(define (stencil-fretboard-extent stencil fretboard-axis orientation)
"Return the extent of @code{stencil} in the @code{fretboard-axis}
direction."
(if (eq? fretboard-axis 'fret)
(cond ((eq? orientation 'landscape)
(ly:stencil-extent stencil X))
((eq? orientation 'opposing-landscape)
(negate-extent (ly:stencil-extent stencil X)))
(else
(negate-extent (ly:stencil-extent stencil Y))))
;; else -- eq? fretboard-axis 'string
(cond ((eq? orientation 'landscape)
(ly:stencil-extent stencil Y))
((eq? orientation 'opposing-landscape)
(negate-extent (ly:stencil-extent stencil Y)))
(else
(ly:stencil-extent stencil Y)))))
(define (stencil-fretboard-offset stencil fretboard-axis orientation)
"Return a the stencil coordinates of the center of @code{stencil}
in the @code{fretboard-axis} direction."
(* 0.5 (interval-length
(stencil-fretboard-extent stencil fretboard-axis orientation))))
(define (string-thickness string thickness-factor)
(expt (1+ thickness-factor) (1- string)))
;; Functions that create stencils used in the fret diagram
(define (sans-serif-stencil layout props mag text)
"Create a stencil in sans-serif font based on @var{layout} and @var{props}
with magnification @var{mag} of the string @var{text}."
(let* ((my-props
(prepend-alist-chain
'font-size (stepmag mag)
(prepend-alist-chain 'font-family 'sans props))))
(interpret-markup layout my-props text)))
;; markup commands and associated functions
(define (fret-parse-marking-list marking-list my-fret-count)
"Parse a fret-diagram-verbose marking list into component sublists"
(let* ((fret-range (cons 1 my-fret-count))
(capo-fret 0)
(barre-list '())
(dot-list '())
(xo-list '())
(output-alist '()))
(let parse-item ((mylist marking-list))
(if (not (null? mylist))
(let* ((my-item (car mylist)) (my-code (car my-item)))
(cond
((or (eq? my-code 'open)(eq? my-code 'mute))
(set! xo-list (cons* my-item xo-list)))
((eq? my-code 'barre)
(set! barre-list (cons* (cdr my-item) barre-list)))
((eq? my-code 'capo)
(set! capo-fret (cadr my-item)))
((eq? my-code 'place-fret)
(set! dot-list (cons* (cdr my-item) dot-list))))
(parse-item (cdr mylist)))))
;; calculate fret-range
(let ((maxfret 0)
(minfret (if (> capo-fret 0) capo-fret 99)))
(let updatemax ((fret-list dot-list)) ;CHANGE THIS TO HELPER FUNCTION?
(if (null? fret-list)
'()
(let ((fretval (second (car fret-list))))
(if (> fretval maxfret) (set! maxfret fretval))
(if (< fretval minfret) (set! minfret fretval))
(updatemax (cdr fret-list)))))
(if (or (> maxfret my-fret-count) (> capo-fret 1))
(set! fret-range
(cons minfret
(let ((upfret (- (+ minfret my-fret-count) 1)))
(if (> maxfret upfret) maxfret upfret)))))
(set! capo-fret (1+ (- capo-fret minfret)))
;; subtract fret from dots
(set! dot-list (subtract-base-fret (- (car fret-range) 1) dot-list)))
(acons 'fret-range fret-range
(acons 'barre-list barre-list
(acons 'dot-list dot-list
(acons 'xo-list xo-list
(acons 'capo-fret capo-fret '())))))))
(define (make-fret-diagram layout props marking-list)
"Make a fret diagram markup"
(let* (
;; note: here we get items from props that are needed in this routine,
;; or that are needed in more than one of the procedures
;; called from this routine. If they're only used in one of the
;; sub-procedure, they're obtained in that procedure
(size (chain-assoc-get 'size props 1.0)) ; needed for everything
;;TODO -- get string-count directly from length of stringTunings;
;; from FretBoard engraver, but not from markup call
(details (merge-details 'fret-diagram-details props '()))
(string-count
(assoc-get 'string-count details 6)) ;; needed for everything
(my-fret-count
(assoc-get 'fret-count details 4)) ;; needed for everything
(orientation
(assoc-get 'orientation details 'normal)) ;; needed for everything
(finger-code
(assoc-get
'finger-code details 'none)) ;; needed for draw-dots and draw-barre
(default-dot-radius
(if (eq? finger-code 'in-dot) 0.425 0.25)) ;; bigger dots if labeled
(default-dot-position
(if (eq? finger-code 'in-dot)
(- 0.95 default-dot-radius)
0.6)) ; move up to make room for bigger dot if labeled
(dot-radius
(assoc-get
'dot-radius details default-dot-radius))
;; needed for draw-dots and draw-barre
(dot-position
(assoc-get
'dot-position details default-dot-position))
;; needed for draw-dots and draw-barre
(th
(* (ly:output-def-lookup layout 'line-thickness)
(chain-assoc-get 'thickness props 0.5)))
;; needed for draw-frets and draw-strings
(sth (* size th))
(thickness-factor (assoc-get 'string-thickness-factor details 0))
(paren-padding (assoc-get 'paren-padding details 0.05))
(alignment
(chain-assoc-get 'align-dir props -0.4)) ;; needed only here
(xo-padding (assoc-get 'xo-padding details 0.2)) ;; needed only here
(parameters (fret-parse-marking-list marking-list my-fret-count))
(capo-fret (assoc-get 'capo-fret parameters 0))
(dot-list (assoc-get 'dot-list parameters))
(xo-list (assoc-get 'xo-list parameters))
(fret-range (assoc-get 'fret-range parameters))
(my-fret-count (fret-count fret-range))
(barre-list (assoc-get 'barre-list parameters))
(barre-type
(assoc-get 'barre-type details 'curved))
(fret-diagram-stencil '()))
;; Here are the fret diagram helper functions that depend on the
;; fret diagram parameters. The functions are here because the
;; diagram parameters are part of the lexical scope here.
(define (stencil-coordinates fret-coordinate string-coordinate)
"Return a pair @code{(x-coordinate . y-coordinate)}
in stencil coordinate system."
(cond
((eq? orientation 'landscape)
(cons fret-coordinate
(- string-coordinate (1- string-count))))
((eq? orientation 'opposing-landscape)
(cons (- fret-coordinate) (- string-coordinate)))
(else
(cons string-coordinate (- fret-coordinate)))))
(define (stencil-coordinate-offset fret-offset string-offset)
"Return a pair @code{(x-offset . y-offset)}
for translation in stencil coordinate system."
(cond
((eq? orientation 'landscape)
(cons fret-offset (- string-offset)))
((eq? orientation 'opposing-landscape)
(cons (- fret-offset) string-offset))
(else
(cons string-offset (- fret-offset)))))
(define (make-bezier-sandwich-list start stop base height
half-thickness)
"Make the argument list for a bezier sandwich from
string coordinate @var{start} to string-coordinate @var{stop} with a
baseline at fret coordinate @var{base}, a height of
@var{height}, and a half thickness of @var{half-thickness}."
(let* ((width (+ (- stop start) 1))
(cp-left-width (+ (* width half-thickness) start))
(cp-right-width (- stop (* width half-thickness)))
(bottom-control-point-height
(- base (- height half-thickness)))
(top-control-point-height
(- base height))
(left-end-point
(stencil-coordinates base start))
(right-end-point
(stencil-coordinates base stop))
(left-upper-control-point
(stencil-coordinates
top-control-point-height cp-left-width))
(left-lower-control-point
(stencil-coordinates
bottom-control-point-height cp-left-width))
(right-upper-control-point
(stencil-coordinates
top-control-point-height cp-right-width))
(right-lower-control-point
(stencil-coordinates
bottom-control-point-height cp-right-width)))
;; order of bezier control points is:
;; left cp low, right cp low, right end low, left end low
;; right cp high, left cp high, left end high, right end high.
(list left-lower-control-point
right-lower-control-point
right-end-point
left-end-point
right-upper-control-point
left-upper-control-point
left-end-point
right-end-point)))
(define (draw-strings)
"Draw the string lines for a fret diagram with
@var{string-count} strings and frets as indicated in @var{fret-range}.
Line thickness is given by @var{th}, fret & string spacing by
@var{size}. Orientation is determined by @var{orientation}."
(define (helper x)
(if (null? (cdr x))
(string-stencil (car x))
(ly:stencil-add
(string-stencil (car x))
(helper (cdr x)))))
(let* ((string-list (map 1+ (iota string-count))))
(helper string-list)))
(define (string-stencil string)
"Make a stencil for @code{string}, given the fret-diagram
overall parameters."
(let* ((string-coordinate (- string-count string))
(current-string-thickness
(* th size (string-thickness string thickness-factor)))
(fret-half-thickness (* size th 0.5))
(half-string (* current-string-thickness 0.5))
(start-coordinates
(stencil-coordinates
(- fret-half-thickness)
(- (* size string-coordinate) half-string)))
(end-coordinates
(stencil-coordinates
(+ fret-half-thickness (* size (1+ (fret-count fret-range))))
(+ half-string (* size string-coordinate)))))
(ly:round-filled-box
(string-x-extent start-coordinates end-coordinates)
(string-y-extent start-coordinates end-coordinates)
(* th size))))
(define (draw-frets)
"Draw the fret lines for a fret diagram with
@var{string-count} strings and frets as indicated in @var{fret-range}.
Line thickness is given by @var{th}, fret & string spacing by
@var{size}. Orientation is given by @var{orientation}."
(define (helper x)
(if (null? (cdr x))
(fret-stencil (car x))
(ly:stencil-add
(fret-stencil (car x))
(helper (cdr x)))))
(let ((fret-list (iota (1+ my-fret-count))))
(helper fret-list)))
(define (fret-stencil fret)
"Make a stencil for @code{fret}, given the
fret-diagram overall parameters."
(let* ((low-string-half-thickness
(* 0.5
size
th
(string-thickness string-count thickness-factor)))
(fret-half-thickness (* 0.5 size th))
(start-coordinates
(stencil-coordinates
(* size fret)
(- fret-half-thickness low-string-half-thickness)))
(end-coordinates
(stencil-coordinates
(* size fret)
(* size (1- string-count)))))
(make-line-stencil
(* size th)
(car start-coordinates) (cdr start-coordinates)
(car end-coordinates) (cdr end-coordinates))))
(define (draw-barre barre-list)
"Create barre indications for a fret diagram"
(if (not (null? barre-list))
(let* ((string1 (caar barre-list))
(string2 (cadar barre-list))
(barre-fret (caddar barre-list))
(top-fret (cdr fret-range))
(low-fret (car fret-range))
(fret (1+ (- barre-fret low-fret)))
(barre-vertical-offset 0.5)
(dot-center-fret-coordinate (+ (1- fret) dot-position))
(barre-fret-coordinate
(+ dot-center-fret-coordinate
(* (- barre-vertical-offset 0.5) dot-radius)))
(barre-start-string-coordinate (- string-count string1))
(barre-end-string-coordinate (- string-count string2))
(scale-dot-radius (* size dot-radius))
(barre-type (assoc-get 'barre-type details 'curved))
(barre-stencil
(cond
((eq? barre-type 'straight)
(make-straight-barre-stencil
barre-fret-coordinate
barre-start-string-coordinate
barre-end-string-coordinate
scale-dot-radius))
((eq? barre-type 'curved)
(make-curved-barre-stencil
barre-fret-coordinate
barre-start-string-coordinate
barre-end-string-coordinate
scale-dot-radius)))))
(if (not (null? (cdr barre-list)))
(ly:stencil-add
barre-stencil
(draw-barre (cdr barre-list)))
barre-stencil ))))
(define (make-straight-barre-stencil
fret-coordinate
start-string-coordinate
end-string-coordinate
half-thickness)
"Create a straight barre stencil."
(let ((start-point
(stencil-coordinates
(* size fret-coordinate)
(* size start-string-coordinate)))
(end-point
(stencil-coordinates
(* size fret-coordinate)
(* size end-string-coordinate))))
(make-line-stencil
half-thickness
(car start-point)
(cdr start-point)
(car end-point)
(cdr end-point))))
(define (make-curved-barre-stencil
fret-coordinate
start-string-coordinate
end-string-coordinate
half-thickness)
"Create a curved barre stencil."
(let* ((bezier-thick 0.1)
(bezier-height 0.5)
(bezier-list
(make-bezier-sandwich-list
(* size start-string-coordinate)
(* size end-string-coordinate)
(* size fret-coordinate)
(* size bezier-height)
(* size bezier-thick)))
(box-lower-left
(stencil-coordinates
(+ (* size fret-coordinate) half-thickness)
(- (* size start-string-coordinate) half-thickness)))
(box-upper-right
(stencil-coordinates
(- (* size fret-coordinate)
(* size bezier-height)
half-thickness)
(+ (* size end-string-coordinate) half-thickness)))
(x-extent (cons (car box-lower-left) (car box-upper-right)))
(y-extent (cons (cdr box-lower-left) (cdr box-upper-right))))
(make-bezier-sandwich-stencil
bezier-list
(* size bezier-thick)
x-extent
y-extent)))
(define (draw-dots dot-list)
"Make dots for fret diagram."
(let* ( (scale-dot-radius (* size dot-radius))
(scale-dot-thick (* size th))
(default-dot-color (assoc-get 'dot-color details))
(finger-label-padding 0.3)
(dot-label-font-mag
(* scale-dot-radius
(assoc-get 'dot-label-font-mag details 1.0)))
(string-label-font-mag
(* size
(assoc-get
'string-label-font-mag details
(cond ((or (eq? orientation 'landscape)
(eq? orientation 'opposing-landscape))
0.5)
(else 0.6)))))
(mypair (car dot-list))
(restlist (cdr dot-list))
(string (car mypair))
(fret (cadr mypair))
(fret-coordinate (* size (+ (1- fret) dot-position)))
(string-coordinate (* size (- string-count string)))
(dot-coordinates
(stencil-coordinates fret-coordinate string-coordinate))
(extent (cons (- scale-dot-radius) scale-dot-radius))
(finger (caddr mypair))
(finger (if (number? finger) (number->string finger) finger))
(finger-stil
(if (not (null? finger))
(sans-serif-stencil
layout props dot-label-font-mag finger)
empty-stencil))
(finger-stil-length (interval-length (ly:stencil-extent finger-stil X)))
(parenthesized
(if (not (null? (dot-is-parenthesized mypair)))
(dot-is-parenthesized mypair)
#f))
(parenthesis-color
(if (not (null? (default-paren-color mypair)))
(default-paren-color mypair)
#f))
(inverted
(if (not (null? (dot-is-inverted mypair)))
(dot-is-inverted mypair)
#f))
(dot-color-is-white?
(or inverted
(and (eq? default-dot-color 'white) (not inverted))))
(what-color
(x11-color
(cond ((and inverted
(not (dot-has-color mypair))
(not (eq? default-dot-color 'white)))
(or default-dot-color 'black))
(dot-color-is-white?
(or (dot-has-color mypair) 'black))
(else
(or (dot-has-color mypair)
default-dot-color
'black)))))
(inverted-stil
(lambda (color)
(ly:stencil-add
(stencil-with-color
(make-circle-stencil
scale-dot-radius scale-dot-thick #t)
color)
(stencil-with-color
(make-circle-stencil
(- scale-dot-radius (* 0.5 scale-dot-thick))
0 #t)
(x11-color 'white)))))
(dot-stencil
(if dot-color-is-white?
(inverted-stil what-color)
(stencil-with-color
(make-circle-stencil
scale-dot-radius scale-dot-thick #t)
what-color)))
(par-dot-stencil
(let ((paren-color
(if (and parenthesis-color
(not (eq? default-dot-color 'white)))
(x11-color (or default-dot-color 'black))
what-color)))
(stencil-with-color
(parenthesize-stencil
dot-stencil ;; stencil
(* size th 0.75) ;; half-thickness
(* 0.15 size) ;;width
0 ;; angularity
paren-padding ;; padding
)
paren-color)))
(final-dot-stencil
(if parenthesized
par-dot-stencil
dot-stencil))
(positioned-dot
(ly:stencil-translate final-dot-stencil dot-coordinates))
(labeled-dot-stencil
(cond
((or (eq? finger '())(eq? finger-code 'none))
(newline)
(display finger)
positioned-dot)
((eq? finger-code 'in-dot)
(let ((finger-label
(centered-stencil
(sans-serif-stencil
layout props
;; Ugh, calculation foung by trial and error
;; TODO: replace with proper calculation
(/ dot-label-font-mag
(cond
((> finger-stil-length 12)
(- (sqrt finger-stil-length) (/ scale-dot-radius 7)))
((> finger-stil-length 6)
(- (sqrt finger-stil-length) (/ scale-dot-radius 5)))
((> finger-stil-length 3)
(- (sqrt finger-stil-length) (/ scale-dot-radius 2.5)))
(else 1)))
finger))))
(ly:stencil-translate
(ly:stencil-add
final-dot-stencil
(if dot-color-is-white?
(stencil-with-color
finger-label
what-color)
(stencil-with-color finger-label white)))
dot-coordinates)))
((eq? finger-code 'below-string)
(let* ((label-stencil
(centered-stencil
(sans-serif-stencil
layout props string-label-font-mag
finger)))
(label-fret-offset
(stencil-fretboard-offset
label-stencil 'fret orientation))
(label-fret-coordinate
(+ (* size
(+ 1 my-fret-count finger-label-padding))
label-fret-offset))
(label-string-coordinate string-coordinate)
(label-translation
(stencil-coordinates
label-fret-coordinate
label-string-coordinate)))
(ly:stencil-add
positioned-dot
(ly:stencil-translate
label-stencil
label-translation))))
(else ;unknown finger-code
positioned-dot))))
(if (null? restlist)
labeled-dot-stencil
(ly:stencil-add
(draw-dots restlist)
labeled-dot-stencil))))
(define (draw-thick-zero-fret)
"Draw a thick zeroth fret for a fret diagram whose base fret is 1."
(let* ((half-lowest-string-thickness
(* 0.5 th (string-thickness string-count thickness-factor)))
(half-thick (* 0.5 sth))
(top-fret-thick
(* sth (assoc-get 'top-fret-thickness details 3.0)))
(start-string-coordinate (- half-lowest-string-thickness))
(end-string-coordinate (+ (* size (1- string-count)) half-thick))
(start-fret-coordinate half-thick)
(end-fret-coordinate (- half-thick top-fret-thick))
(lower-left
(stencil-coordinates
start-fret-coordinate start-string-coordinate))
(upper-right
(stencil-coordinates
end-fret-coordinate end-string-coordinate)))
(ly:round-filled-box
;; Put limits in order, or else the intervals are considered empty
(ordered-cons (car lower-left) (car upper-right))
(ordered-cons (cdr lower-left) (cdr upper-right))
sth)))
(define (draw-xo xo-list)
"Put open and mute string indications on diagram, as contained in
@var{xo-list}."
(let* ((xo-font-mag
(assoc-get 'xo-font-magnification details
(cond ((or (eq? orientation 'landscape)
(eq? orientation 'opposing-landscape))
0.4)
(else 0.4))))
(mypair (car xo-list))
(restlist (cdr xo-list))
(glyph-string (if (eq? (car mypair) 'mute)
(assoc-get 'mute-string details "X")
(assoc-get 'open-string details "O")))
(glyph-string-coordinate (* (- string-count (cadr mypair)) size))
(glyph-stencil
(centered-stencil
(sans-serif-stencil
layout props (* size xo-font-mag) glyph-string)))
(glyph-stencil-coordinates
(stencil-coordinates 0 glyph-string-coordinate))
(positioned-glyph
(ly:stencil-translate
glyph-stencil
glyph-stencil-coordinates)))
(if (null? restlist)
positioned-glyph
(ly:stencil-add
positioned-glyph
(draw-xo restlist)))))
(define (draw-capo fret)
"Draw a capo indicator across the full width of the fret-board
at @var{fret}."
(let* ((capo-thick
(* size (assoc-get 'capo-thickness details 0.5)))
(half-thick (* capo-thick 0.5))
(last-string-position 0)
(first-string-position (* size (- string-count 1)))
(fret-position ( * size (1- (+ dot-position fret))))
(start-point
(stencil-coordinates
fret-position
first-string-position))
(end-point
(stencil-coordinates
fret-position
last-string-position)))
(make-line-stencil
capo-thick
(car start-point) (cdr start-point)
(car end-point) (cdr end-point))))
(define (label-fret fret-range)
"Label the base fret on a fret diagram"
(let* ((base-fret (car fret-range))
(label-font-mag (assoc-get 'fret-label-font-mag details 0.5))
(label-space (* 0.5 size))
(label-dir (assoc-get 'label-dir details RIGHT))
(label-vertical-offset
(assoc-get 'fret-label-vertical-offset details 0))
(label-horizontal-offset
(assoc-get 'fret-label-horizontal-offset details 0))
(number-type
(assoc-get 'number-type details 'roman-lower))
(label-text
(cond
((equal? number-type 'roman-lower)
(fancy-format #f "~(address@hidden)" base-fret))
((equal? number-type 'roman-upper)
(fancy-format #f "address@hidden" base-fret))
((equal? 'arabic number-type)
(fancy-format #f "~d" base-fret))
((equal? 'custom number-type)
(fancy-format #f
(assoc-get 'fret-label-custom-format
details "~a")
base-fret))
(else (fancy-format #f "~(address@hidden)" base-fret))))
(label-stencil
(centered-stencil
(sans-serif-stencil
layout props (* size label-font-mag) label-text)))
(label-half-width
(stencil-fretboard-offset
label-stencil
'string
orientation))
(label-outside-diagram
(+ label-space
(* size label-horizontal-offset)
label-half-width)))
(ly:stencil-translate
label-stencil
(stencil-coordinates
(* size (+ 1.0 label-vertical-offset))
(if (eq? label-dir LEFT)
(- label-outside-diagram)
(+ (* size (1- string-count)) label-outside-diagram))))))
;; Here is the body of make-fret-diagram
(set! fret-diagram-stencil
(ly:stencil-add (draw-strings) (draw-frets)))
(if (and (not (null? barre-list))
(not (eq? 'none barre-type)))
(set! fret-diagram-stencil
(ly:stencil-add
(draw-barre barre-list)
fret-diagram-stencil)))
(if (not (null? dot-list))
(set! fret-diagram-stencil
(ly:stencil-add
fret-diagram-stencil
(draw-dots dot-list))))
(if (= (car fret-range) 1)
(set! fret-diagram-stencil
(ly:stencil-add
fret-diagram-stencil
(draw-thick-zero-fret))))
(if (not (null? xo-list))
(let* ((diagram-fret-top
(car (stencil-fretboard-extent
fret-diagram-stencil
'fret
orientation)))
(xo-stencil (draw-xo xo-list))
(xo-fret-offset
(stencil-fretboard-offset
xo-stencil 'fret orientation))
(xo-stencil-offset
(stencil-coordinate-offset
(- diagram-fret-top
xo-fret-offset
(* size xo-padding))
0)))
(set! fret-diagram-stencil
(ly:stencil-add
fret-diagram-stencil
(ly:stencil-translate
xo-stencil
xo-stencil-offset)))))
(if (> capo-fret 0)
(set! fret-diagram-stencil
(ly:stencil-add
fret-diagram-stencil
(draw-capo capo-fret))))
(if (> (car fret-range) 1)
(set! fret-diagram-stencil
(ly:stencil-add
fret-diagram-stencil
(label-fret fret-range))))
(ly:stencil-aligned-to fret-diagram-stencil X alignment)))
(define (fret-parse-definition-string props definition-string)
"Parse a fret diagram string and return a pair containing:
@var{props}, modified as necessary by the definition-string
a fret-indication list with the appropriate values"
(let* ((fret-count 4)
(string-count 6)
(fret-range (cons 1 fret-count))
(barre-list '())
(dot-list '())
(xo-list '())
(output-list '())
(new-props '())
(details (merge-details 'fret-diagram-details props '()))
(items (string-split definition-string #\;)))
(let parse-item ((myitems items))
(if (not (null? (cdr myitems)))
(let ((test-string (car myitems)))
(case (car (string->list (substring test-string 0 1)))
((#\s) (let ((size (get-numeric-from-key test-string)))
(set! props (prepend-alist-chain 'size size props))))
((#\t) (let ((th (get-numeric-from-key test-string)))
(set! props (prepend-alist-chain 'thickness th props))))
((#\f) (let* ((finger-code (get-numeric-from-key test-string))
(finger-id (case finger-code
((0) 'none)
((1) 'in-dot)
((2) 'below-string))))
(set! details
(acons 'finger-code finger-id details))))
((#\c) (set! output-list
(cons-fret
(cons
'barre
(numerify
(string-split (substring test-string 2) #\-)))
output-list)))
((#\h) (let ((fret-count (get-numeric-from-key test-string)))
(set! details
(acons 'fret-count fret-count details))))
((#\w) (let ((string-count (get-numeric-from-key test-string)))
(set! details
(acons 'string-count string-count details))))
((#\d) (let ((dot-size (get-numeric-from-key test-string)))
(set! details
(acons 'dot-radius dot-size details))))
((#\p) (let ((dot-position (get-numeric-from-key test-string)))
(set! details
(acons 'dot-position dot-position details))))
(else
(let ((this-list (string-split test-string #\-)))
(if (string->number (cadr this-list))
(set! output-list
(cons-fret
(cons 'place-fret (numerify this-list))
output-list))
(if (equal? (cadr this-list) "x" )
(set! output-list
(cons-fret
(list 'mute (string->number (car this-list)))
output-list))
(set! output-list
(cons-fret
(list 'open (string->number (car this-list)))
output-list)))))))
(parse-item (cdr myitems)))))
;; add the modified details
(set! props
(prepend-alist-chain 'fret-diagram-details details props))
`(,props . ,output-list))) ;ugh -- hard-coded spell -- procedure better
(define-public
(fret-parse-terse-definition-string props definition-string)
"Parse a fret diagram string that uses terse syntax;
return a pair containing:
@var{props}, modified to include the string-count determined by the
definition-string, and
a fret-indication list with the appropriate values"
;; TODO -- change syntax to fret\string-finger
(let* ((details (merge-details 'fret-diagram-details props '()))
(barre-start-list '())
(output-list '())
(new-props '())
(items (string-split definition-string #\;))
(string-count (- (length items) 1)))
(let parse-item ((myitems items))
(if (not (null? (cdr myitems)))
(let* ((test-string (car myitems))
(current-string (- (length myitems) 1))
(indicators (string-split test-string #\ )))
(let parse-indicators ((myindicators indicators))
(if (not (eq? '() myindicators))
(let* ((this-list (string-split (car myindicators) #\-))
(max-element-index (- (length this-list) 1))
(last-element
(car (list-tail this-list max-element-index)))
(fret
(if (string->number (car this-list))
(string->number (car this-list))
(car this-list))))
(if (equal? last-element "(")
(begin
(set! barre-start-list
(cons-fret (list current-string fret)
barre-start-list))
(set! this-list
(list-head this-list max-element-index))))
(if (equal? last-element ")")
(let* ((this-barre
(get-sub-list fret barre-start-list))
(insert-index (- (length this-barre) 1)))
(set! output-list
(cons-fret (cons* 'barre
(car this-barre)
current-string
(cdr this-barre))
output-list))
(set! this-list
(list-head this-list max-element-index))))
(if (number? fret)
(set!
output-list
(cons-fret (cons*
'place-fret
current-string
(drop-paren (numerify this-list)))
output-list))
(if (equal? (car this-list) "x" )
(set!
output-list
(cons-fret
(list 'mute current-string)
output-list))
(set!
output-list
(cons-fret
(list 'open current-string)
output-list))))
(parse-indicators (cdr myindicators)))))
(parse-item (cdr myitems)))))
(set! details (acons 'string-count string-count details))
(set! props (prepend-alist-chain 'fret-diagram-details details props))
`(,props . ,output-list))) ; ugh -- hard coded; proc is better
(define-markup-command
(fret-diagram-verbose layout props marking-list)
(pair?) ; argument type (list, but use pair? for speed)
#:category instrument-specific-markup ; markup type
#:properties ((align-dir -0.4) ; properties and defaults
(size 1.0)
(fret-diagram-details)
(thickness 0.5))
"Make a fret diagram containing the symbols indicated in @var{marking-list}.
For example,
@example
\\markup \\fret-diagram-verbose
#'((mute 6) (mute 5) (open 4)
(place-fret 3 2) (place-fret 2 3) (place-fret 1 2))
@end example
@noindent
produces a standard address@hidden diagram without fingering indications.
Possible elements in @var{marking-list}:
@table @code
@item (mute @var{string-number})
Place a small @q{x} at the top of string @var{string-number}.
@item (open @var{string-number})
Place a small @q{o} at the top of string @var{string-number}.
@item (barre @var{start-string} @var{end-string} @var{fret-number})
Place a barre indicator (much like a tie) from string @var{start-string}
to string @var{end-string} at fret @var{fret-number}.
@item (capo @var{fret-number})
Place a capo indicator (a large solid bar) across the entire fretboard
at fret location @var{fret-number}. Also, set fret @var{fret-number}
to be the lowest fret on the fret diagram.
@item
(place-fret @var{string-number}
@var{fret-number}
address@hidden
address@hidden
address@hidden
address@hidden'parenthesized} address@hidden'default-paren-color}]])
Place a fret playing indication on string @var{string-number} at fret
@var{fret-number} with an optional fingering label @var{finger-value},
an optional color modifier @var{color-modifier}, an optional color
@var{color}, an optional parenthesis @code{'parenthesized} and an
optional paranthesis color @code{'default-paren-color}.
By default, the fret playing indicator is a solid dot. This can be
globally changed by setting the value of the variable @var{dot-color}
or for a single dot by setting the value of @var{color}. The dot can
be parenthesized by adding @code{'parenthesized}. By default the
color for the parenthesis is taken from the dot. Adding
@code{'default-paren-color} will take the parenthesis-color from the
global @var{dot-color}, as a fall-back black will be used.
Setting @var{color-modifier} to @code{inverted} inverts the dot color
for a specific fingering.
The values for @var{string-number}, @var{fret-number}, and the optional
@var{finger} should be entered first in that order.
The order of the other optional arguments does not matter.
If the @var{finger} part of the @code{place-fret} element is present,
@var{finger-value} will be displayed according to the setting of the
variable @var{finger-code}. There is no limit to the number of fret
indications per string.
@end table"
(make-fret-diagram layout props marking-list))
(define-markup-command (fret-diagram layout props definition-string)
(string?) ; argument type
#:category instrument-specific-markup ; markup category
#:properties (fret-diagram-verbose-markup) ; properties and defaults
"Make a (guitar) fret diagram. For example, say
@example
\\markup \\fret-diagram #\"s:0.75;6-x;5-x;4-o;3-2;2-3;1-2;\"
@end example
@noindent
for fret spacing 3/4 of staff space, D chord diagram
Syntax rules for @var{definition-string}:
@itemize @minus
@item
Diagram items are separated by semicolons.
@item
Possible items:
@itemize @bullet
@item
@code{s:address@hidden -- Set the fret spacing of the diagram (in staff
spaces).
Default:@tie{}1.
@item
@code{t:address@hidden -- Set the line thickness (relative to normal
line thickness).
Default:@tie{}0.5.
@item
@code{h:address@hidden -- Set the height of the diagram in frets.
Default:@tie{}4.
@item
@code{w:address@hidden -- Set the width of the diagram in strings.
Default:@tie{}6.
@item
@code{f:address@hidden -- Set fingering label type
(address@hidden none, address@hidden in circle on string, address@hidden below string).
Default:@tie{}0.
@item
@code{d:address@hidden -- Set radius of dot, in terms of fret spacing.
Default:@tie{}0.25.
@item
@code{p:address@hidden -- Set the position of the dot in the fret space.
0.5 is centered; address@hidden on lower fret bar, address@hidden on upper fret bar.
Default:@tie{}0.6.
@item
@code{c:address@hidden@address@hidden@address@hidden -- Include a
barre mark from @var{string1} to @var{string2} on @var{fret}.
@item
@address@hidden@var{fret} -- Place a dot on @var{string} at @var{fret}.
If @var{fret} is @samp{o}, @var{string} is identified as open.
If @var{fret} is @samp{x}, @var{string} is identified as muted.
@item
@address@hidden@address@hidden@var{fingering} -- Place a dot on
@var{string} at @var{fret}, and label with @var{fingering} as defined
by the @code{f:} code.
@end itemize
@item
Note: There is no limit to the number of fret indications per string.
@end itemize"
(let ((definition-list
(fret-parse-definition-string props definition-string)))
(fret-diagram-verbose-markup
layout (car definition-list) (cdr definition-list))))
(define-markup-command
(fret-diagram-terse layout props definition-string)
(string?) ; argument type
#:category instrument-specific-markup ; markup category
#:properties (fret-diagram-verbose-markup) ; properties
"Make a fret diagram markup using terse string-based syntax.
Here is an example
@example
\\markup \\fret-diagram-terse #\"x;x;o;2;3;2;\"
@end example
@noindent
for a address@hidden diagram.
Syntax rules for @var{definition-string}:
@itemize @bullet
@item
Strings are terminated by semicolons; the number of semicolons
is the number of strings in the diagram.
@item
Mute strings are indicated by @samp{x}.
@item
Open strings are indicated by @samp{o}.
@item
A number indicates a fret indication at that fret.
@item
If there are multiple fret indicators desired on a string, they
should be separated by spaces.
@item
Fingerings are given by following the fret number with a @address@hidden,}
followed by the finger indicator, e.g. @samp{3-2} for playing the third
fret with the second finger.
@item
Where a barre indicator is desired, follow the fret (or fingering) symbol
with @address@hidden(}} to start a barre and @address@hidden)}} to end the barre.
@end itemize"
;; TODO -- change syntax to fret\string-finger
(let ((definition-list
(fret-parse-terse-definition-string props definition-string)))
(fret-diagram-verbose-markup layout
(car definition-list)
(cdr definition-list))))