X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Ffret-diagrams.scm;h=5f69f817de3a8c8a83358c8d7301ac1613c13663;hb=f2f3bda6c3dd0ee1a1be7b2a5ca6a2c3d836ba9c;hp=b9689eedf67f5a951aaa84cdc8d1b3786643a08b;hpb=ec83f6cdee0c4261783f3ae0f6cbd155d7ddd978;p=lilypond.git diff --git a/scm/fret-diagrams.scm b/scm/fret-diagrams.scm index b9689eedf6..5f69f817de 100644 --- a/scm/fret-diagrams.scm +++ b/scm/fret-diagrams.scm @@ -2,10 +2,7 @@ ;;;; ;;;; source file of the GNU LilyPond music typesetter ;;;; -;;;; (c) 2004 Carl D. Sorensen - -(define ly:paper-lookup ly:output-def-lookup) ; compat for 2.3, remove when using 2.2 -(define my-font-encoding 'TeX-text ) +;;;; (c) 2004--2006 Carl D. Sorensen (define (fret-parse-marking-list marking-list fret-count) (let* ((fret-range (list 1 fret-count)) @@ -24,7 +21,8 @@ ((eq? my-code 'place-fret) (set! dot-list (cons* (cdr my-item) dot-list)))) (parse-item (cdr mylist))))) - ; calculate fret-range + + ;; calculate fret-range (let ((maxfret 0) (minfret 99)) (let updatemax ((fret-list dot-list)) (if (null? fret-list) @@ -43,7 +41,9 @@ (acons 'barre-list barre-list (acons 'dot-list dot-list (acons 'xo-list xo-list '())))))) - + + + (define (subtract-base-fret base-fret dot-list) "Subtract @var{base-fret} from every fret in @var{dot-list}" (if (null? dot-list) @@ -54,261 +54,402 @@ (third this-list))) (subtract-base-fret base-fret (cdr dot-list)))))) -(define (draw-strings string-count fret-range th size) -"Draw the strings (vertical 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}. " +(define (sans-serif-stencil layout props mag text) +"create a stencil in sans-serif font based on @var{layout} and @var{props} +with magnification @varr{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))) + + +(define (draw-strings string-count fret-range th size orientation) +"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}. " (let* ((fret-count (+ (- (cadr fret-range) (car fret-range)) 1)) (sl (* (+ fret-count 1) size)) (sth (* size th)) (half-thickness (* sth 0.5)) (gap (- size sth)) - (string-stencil (ly:make-stencil (list 'draw-line sth 0 0 0 sl) + (string-stencil + (if (eq? orientation 'normal) + (ly:make-stencil (list 'draw-line sth 0 0 0 sl) (cons (- half-thickness) half-thickness) - (cons (- half-thickness) (+ sl half-thickness))))) + (cons (- half-thickness) (+ sl half-thickness))) + (ly:make-stencil (list 'draw-line sth 0 0 sl 0) + (cons (- half-thickness) (+ sl half-thickness)) + (cons (- half-thickness) half-thickness))))) (if (= string-count 1) string-stencil + (if (eq? orientation 'normal) (ly:stencil-combine-at-edge - (draw-strings (- string-count 1) fret-range th size) X RIGHT + (draw-strings (- string-count 1) fret-range th size orientation) X RIGHT string-stencil - gap 0)))) - -(define (draw-fret-lines fret-count string-count th size) - "Draw @var{fret-count} frets (horizontal lines) for a fret diagram with @var{string-count} strings. - Line thickness is given by @var{th}, fret & string spacing by @var{size}. " + gap) + (ly:stencil-combine-at-edge + (draw-strings (- string-count 1) fret-range th size orientation) Y UP + string-stencil + gap))))) + +(define (draw-fret-lines fret-count string-count th size orientation) + "Draw @var{fret-count} fret lines for a fret diagram +with @var{string-count} strings. Line thickness is given by @var{th}, +fret & string spacing by @var{size}. Orientation is given by @var{orientation}" + (let* (;(fret-length (* (- string-count 1) size)) + (sth (* size th)) + ;(half-thickness (* sth 0.5)) + (gap (- size sth)) + (fret-line (draw-fret-line string-count th size orientation))) + (if (= fret-count 1) + fret-line + (if (eq? orientation 'normal) + (ly:stencil-combine-at-edge (draw-fret-lines (- fret-count 1) string-count th size orientation) Y UP + fret-line + gap 0) + (ly:stencil-combine-at-edge (draw-fret-lines (- fret-count 1) string-count th size orientation) X RIGHT + fret-line + gap 0))))) + +(define (draw-fret-line string-count th size orientation) + "Draw a fret line for a fret diagram." (let* ((fret-length (* (- string-count 1) size)) (sth (* size th)) - (half-thickness (* sth 0.5)) - (gap (- size sth)) - (fret-line (ly:make-stencil (list 'draw-line sth half-thickness size (- fret-length half-thickness) size) - (cons 0 fret-length) - (cons (- size half-thickness) (+ size half-thickness))))) - (if (= fret-count 1) - fret-line - (ly:stencil-combine-at-edge fret-line Y UP - (draw-fret-lines (- fret-count 1) string-count th size) - gap 0)))) - -(define (draw-thick-top-fret props string-count th size) - "Draw a thick top fret for a fret diagram whose base fret is not 1." - (let* ((sth (* th size)) - (top-fret-thick (* sth (chain-assoc-get 'top-fret-thickness props 3.0))) - (top-half-thick (* top-fret-thick 0.5)) - (half-thick (* sth 0.5)) - (x1 half-thick) - (x2 (+ half-thick (* size (- string-count 1)))) - (y1 0) - (y2 top-fret-thick) - (x-extent (cons (- x1) x2)) - (y-extent (cons 0 y2))) - (ly:make-stencil (list 'round-filled-box x1 x2 y1 y2 th) - x-extent y-extent))) - - -(define (draw-frets paper props fret-range string-count th size) - "Draw the frets (horizontal 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}. " - (let* ((top-fret-thick (* th (chain-assoc-get 'top-fret-thickness props 3.0))) - (fret-count (+ (- (cadr fret-range) (car fret-range)) 1)) + (half-thickness (* sth 0.5))) + (if (eq? orientation 'normal) + (ly:make-stencil (list 'draw-line sth half-thickness size + (- fret-length half-thickness) size) + (cons 0 fret-length) + (cons (- half-thickness) half-thickness)) + (ly:make-stencil (list 'draw-line sth 0 half-thickness + 0 (- fret-length half-thickness)) + (cons (- half-thickness) half-thickness) + (cons 0 fret-length))))) + +(define (draw-thick-zero-fret props string-count th size orientation) + "Draw a thick zeroth fret for a fret diagram whose base fret is not 1." + (let* ((sth (* th size)) + ; (top-fret-thick (* sth (chain-assoc-get 'top-fret-thickness props 3.0))) + (top-fret-thick (* sth 3.0)) + ; (top-half-thick (* top-fret-thick 0.5)) + (half-thick (* sth 0.5)) + (x1 half-thick) + (x2 (+ half-thick (* size (- string-count 1)))) + (y1 (- half-thick)) + (y2 (+ top-fret-thick half-thick)) + (x-extent (cons (- x1) x2)) + (y-extent (cons 0 y2))) + (if (eq? orientation 'normal) + (ly:make-stencil (list 'round-filled-box x1 x2 y1 y2 sth) + x-extent y-extent) + (ly:make-stencil (list 'round-filled-box y1 y2 x1 x2 sth) + y-extent x-extent)))) + + +(define (draw-frets layout props fret-range string-count th size orientation) + "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}." + (let* ((fret-count (+ (- (cadr fret-range) (car fret-range)) 1)) (fret-length (* (- string-count 1) size)) (half-thickness (* th 0.5)) - (base-fret (car fret-range))) - (ly:stencil-combine-at-edge - (draw-fret-lines fret-count string-count th size) Y UP - (if (= base-fret 1) - (draw-thick-top-fret props string-count th size) - (draw-fret-lines 1 string-count th size)) - (- size th) 0))) - - -(define (centered-stencil stencil) - "Center stencil @var{stencil} in both the X and Y directions" - (let* ((output-stencil stencil)) -; (if (= (cadr (ly:version)) 3) - (begin - (ly:stencil-align-to! output-stencil Y 0) - (ly:stencil-align-to! output-stencil X 0) - output-stencil))) -; (ly:stencil-align-to (ly:stencil-align-to text-stencil X 0) Y 0)))) - -(define (draw-dots paper props string-count fret-range size finger-code dot-position dot-radius dot-list) + (base-fret (car fret-range)) + (fret-zero (draw-fret-line string-count th size orientation))) + (if (eq? orientation 'normal) + (ly:stencil-combine-at-edge + (draw-fret-lines fret-count string-count th size orientation) Y UP + fret-zero + (- size th)) + (ly:stencil-combine-at-edge + fret-zero X RIGHT + (draw-fret-lines fret-count string-count th size orientation) + (- size th))))) + + +(define (draw-dots layout props string-count fret-count fret-range size finger-code + dot-position dot-radius dot-thickness dot-list orientation) "Make dots for fret diagram." + (let* ((scale-dot-radius (* size dot-radius)) + (scale-dot-thick (* size dot-thickness)) (dot-color (chain-assoc-get 'dot-color props 'black)) - (finger-xoffset (chain-assoc-get 'finger-xoffset props -0.25)) - (finger-yoffset (chain-assoc-get 'finger-yoffset props (- size))) - (dot-label-font-mag (* scale-dot-radius (chain-assoc-get 'dot-label-font-mag props 1.0))) - (string-label-font-mag (* size (chain-assoc-get 'string-label-font-mag props 0.6))) - (fret-count (+ (- (cadr fret-range) (car fret-range) 1))) +; (finger-xoffset (chain-assoc-get 'finger-xoffset props -0.25)) +; (finger-yoffset (chain-assoc-get 'finger-yoffset props (- size))) + (finger-xoffset -0.25) + (finger-yoffset (- (* size 0.5))) +; (dot-label-font-mag (* scale-dot-radius (chain-assoc-get 'dot-label-font-mag props 1.0))) + (dot-label-font-mag scale-dot-radius) +; (string-label-font-mag (* size (chain-assoc-get 'label-font-mag props 0.7))) + (string-label-font-mag (* size 0.6)) +; (fret-count (+ (- (cadr fret-range) (car fret-range) 1))) (mypair (car dot-list)) (restlist (cdr dot-list)) - (xpos (* size (- string-count (car mypair)))) + (string (car mypair)) + (fret (cadr mypair)) + (xpos (* size (if (eq? orientation 'normal) + (- string-count string) + (+ (- fret 1 ) dot-position)))) ;TODO -- figure out what 4 is and get rid of it ;UGH -- 4? - (ypos (* size (+ 4 (- fret-count (cadr mypair) dot-position )))) + (ypos (* size (if (eq? orientation 'normal) + (+ 2 (- fret-count fret dot-position )) + (- string-count string)))) (extent (cons (- scale-dot-radius) scale-dot-radius)) (finger (caddr mypair)) (finger (if (number? finger) (number->string finger) finger)) - (string-label-font (ly:paper-get-font paper `(((font-family . sans)(font-encoding . ,my-font-encoding)(font-series . medium) (font-shape . upright) - (font-size . ,(stepmag string-label-font-mag)))))) - (dot-label-font (ly:paper-get-font paper `(((font-family . sans)(font-encoding . ,my-font-encoding)(font-series . medium) (font-shape . upright) - (font-size . ,(stepmag dot-label-font-mag)))))) (dotstencil (if (eq? dot-color 'white) - (begin - (ly:make-stencil (list 'white-dot 0 0 scale-dot-radius) extent extent)) - (ly:make-stencil (list 'dot 0 0 scale-dot-radius ) extent extent))) - (positioned-dot (ly:stencil-translate-axis - (ly:stencil-translate-axis dotstencil xpos X) - ypos Y)) + (ly:stencil-add + (make-circle-stencil scale-dot-radius scale-dot-thick #t) + (ly:stencil-in-color + (make-circle-stencil + (- scale-dot-radius (* 0.5 scale-dot-thick)) 0 #t) + 1 1 1)) + (make-circle-stencil scale-dot-radius scale-dot-thick #t))) + (positioned-dot (begin + ;(display dotstencil) + (ly:stencil-translate-axis + (ly:stencil-translate-axis dotstencil xpos X) + ypos Y))) + (labeled-dot-stencil (if (or (eq? finger '())(eq? finger-code 'none)) positioned-dot - (if (eq? finger-code 'in-dot) - (let* ((dot-proc (if (eq? dot-color 'white) 'white-dot 'dot))) - (ly:stencil-add - (ly:stencil-translate-axis - (ly:stencil-translate-axis - (if (eq? dot-color 'white) - (centered-stencil (fontify-text dot-label-font finger)) - (centered-stencil (fontify-text-white dot-label-font-mag - dot-label-font finger))) - xpos X) - ypos Y) - (ly:stencil-translate-axis - (ly:stencil-translate-axis - (ly:make-stencil (list dot-proc 0 0 scale-dot-radius) extent extent) + (if (eq? finger-code 'in-dot) + (let* ((finger-label (centered-stencil + (sans-serif-stencil layout props + dot-label-font-mag finger)))) + (ly:stencil-translate-axis + (ly:stencil-translate-axis + (ly:stencil-add + dotstencil + (if (eq? dot-color 'white) + finger-label + (ly:stencil-in-color finger-label 1 1 1))) xpos X) - ypos Y))) + ypos Y)) (if (eq? finger-code 'below-string) (ly:stencil-add positioned-dot + (if (eq? orientation 'normal) (ly:stencil-translate-axis (ly:stencil-translate-axis - (centered-stencil (fontify-text string-label-font finger)) xpos X) - (* size finger-yoffset) Y)) + (centered-stencil (sans-serif-stencil layout props + string-label-font-mag finger)) + xpos X) + (* size finger-yoffset) Y) + (ly:stencil-translate-axis + (ly:stencil-translate-axis + (centered-stencil (sans-serif-stencil layout props + string-label-font-mag finger)) + (* size (+ 2 fret-count finger-yoffset)) X) + ypos Y))) ;unknown finger-code positioned-dot))))) (if (null? restlist) labeled-dot-stencil (ly:stencil-add - (draw-dots paper props string-count fret-range size finger-code - dot-position dot-radius restlist) + (draw-dots layout props string-count fret-count fret-range size finger-code + dot-position dot-radius dot-thickness restlist orientation) labeled-dot-stencil)))) -(define (draw-xo paper props string-count fret-range size xo-list) +(define (draw-xo layout props string-count fret-range size xo-list orientation) "Put open and mute string indications on diagram, as contained in @var{xo-list}." (let* ((fret-count (+ (- (cadr fret-range) (car fret-range) 1))) (xo-font-mag (* size (chain-assoc-get 'xo-font-magnification props 0.5))) - (xo-horizontal-offset (* size (chain-assoc-get 'xo-horizontal-offset props -0.35))) - (font (ly:paper-get-font paper `(((font-encoding . ,my-font-encoding)(font-family . sans) - (font-series . medium) (font-shape . upright) - (font-size . ,(stepmag (* size xo-font-mag))))))) +; (xo-font-mag (* size 0.5)) +; (xo-horizontal-offset (* size (chain-assoc-get 'xo-horizontal-offset props -0.35))) + (xo-horizontal-offset (* size -0.35)) (mypair (car xo-list)) (restlist (cdr xo-list)) - (glyph-string (if (eq? (car mypair) 'mute) "X" "O")) + (glyph-string (if (eq? (car mypair) 'mute) + (chain-assoc-get 'mute-string props "X") + (chain-assoc-get 'open-string props "O"))) (xpos (+ (* (- string-count (cadr mypair)) size) xo-horizontal-offset )) - (glyph-stencil (ly:stencil-translate-axis (fontify-text font glyph-string) xpos X))) + (glyph-stencil (if (eq? orientation 'normal) + (ly:stencil-translate-axis + (sans-serif-stencil layout props (* size xo-font-mag) glyph-string) + xpos X) + (ly:stencil-translate-axis + (sans-serif-stencil layout props (* size xo-font-mag) glyph-string) + xpos Y)))) +;(display "def-xo-mag" default-xo-magnification) (if (null? restlist) glyph-stencil (ly:stencil-add - (draw-xo paper props string-count fret-range size restlist) + (draw-xo layout props string-count fret-range size restlist orientation) glyph-stencil)))) -(define (make-bezier-sandwich-list left right bottom height thickness) -" Make the argument list for a horizontal bezier sandwich from @var{left} to @var{right} with a bottom at @var{bottom}, - a height of @var{height}, and a thickness of @var{thickness}." - (let* ((width (+ (- right left) 1)) - (x1 (+ (* width thickness) left)) - (x2 (- right (* width thickness))) - (bottom-control-point-height (+ bottom (- height thickness))) - (top-control-point-height (+ bottom height))) +(define (make-bezier-sandwich-list start stop base height thickness orientation) +" Make the argument list for a bezier sandwich from +@var{start} to @var{stop} with a baseline at @var{base}, a height of +@var{height}, and a thickness of @var{thickness}. If @var{orientation} is +@var{'normal}, @var{base} is a y coordinate, otherwise it's an x coordinate." + (let* ((width (+ (- stop start) 1)) + (x1 (+ (* width thickness) start)) + (x2 (- stop (* width thickness))) + (bottom-control-point-height (if (eq? orientation 'normal) + (+ base (- height thickness)) + (- base (- height thickness)))) + (top-control-point-height (if (eq? orientation 'normal) + (+ base height) + (- base height)))) ; order of 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 (cons x1 bottom-control-point-height) (cons x2 bottom-control-point-height) (cons right bottom) (cons left bottom) - (cons x2 top-control-point-height) (cons x1 top-control-point-height) (cons left bottom) (cons right bottom)))) - -(define (draw-barre paper props string-count fret-range size finger-code dot-position dot-radius barre-list) + (if (eq? orientation 'normal) + (list (cons x1 bottom-control-point-height) + (cons x2 bottom-control-point-height) + (cons stop base) + (cons start base) + (cons x2 top-control-point-height) + (cons x1 top-control-point-height) + (cons start base) + (cons stop base)) + (list (cons bottom-control-point-height x1) + (cons bottom-control-point-height x2) + (cons base stop) + (cons base start) + (cons top-control-point-height x2) + (cons top-control-point-height x1) + (cons base start) + (cons base stop))))) + +(define (draw-barre layout props string-count fret-range size finger-code dot-position dot-radius barre-list orientation) "Create barre indications for a fret diagram" (if (not (null? barre-list)) (let* ((string1 (caar barre-list)) (string2 (cadar barre-list)) - (fret (caddar barre-list)) + (fret (caddar barre-list)) + (top-fret (cadr fret-range)) + (low-fret (car fret-range)) (barre-type (chain-assoc-get 'barre-type props 'curved)) (scale-dot-radius (* size dot-radius)) - (barre-vertical-offset (chain-assoc-get 'barre-vertical-offset props 0.5)) - ; 2 is 1 for empty fret at bottom of figure + 1 for interval (top-fret - fret + 1) -- not an arbitrary constant - (dot-center-y (* size (- (+ 2 (- (cadr fret-range) fret))dot-position) )) - (bottom (+ dot-center-y (* barre-vertical-offset scale-dot-radius))) + (barre-vertical-offset 0.5) +; (barre-vertical-offset (chain-assoc-get 'barre-vertical-offset props 0.5)) + ;; 2 is 1 for empty fret at bottom of figure + 1 for interval (top-fret - fret + 1) -- not an arbitrary constant + (dot-center-y (* size + (- (+ 2 (- (cadr fret-range) fret)) dot-position))) + (dot-center-fret-coordinate (+ (- fret low-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)) + (bottom (+ dot-center-y (* barre-vertical-offset scale-dot-radius))) (left (* size (- string-count string1))) (right (* size (- string-count string2))) - (bezier-thick (chain-assoc-get 'bezier-thickness props 0.1)) - (bezier-height (chain-assoc-get 'bezier-height props 0.5)) - (bezier-list (make-bezier-sandwich-list left right bottom (* size bezier-height) (* size bezier-thick))) +;; (bezier-thick (chain-assoc-get 'bezier-thickness props 0.1)) + (bezier-thick 0.1) +;; (bezier-height (chain-assoc-get 'bezier-height props 0.5)) + (bezier-height 0.5) + (bezier-list (if (eq? orientation 'normal) + (make-bezier-sandwich-list + (* size barre-start-string-coordinate) + (* size barre-end-string-coordinate) + (* size (+ 1 (- top-fret fret) barre-fret-coordinate)) + (* size bezier-height) + (* size bezier-thick) + orientation) + (make-bezier-sandwich-list + (* size barre-start-string-coordinate) + (* size barre-end-string-coordinate) + (* size barre-fret-coordinate) + (* size bezier-height) + (* size bezier-thick) + orientation))) (barre-stencil (if (eq? barre-type 'straight) + (if (eq? orientation 'normal) (ly:make-stencil (list 'draw-line (* size dot-radius) left dot-center-y right dot-center-y) (cons left right) (cons (- dot-center-y scale-dot-radius) (+ dot-center-y scale-dot-radius))) - (ly:make-stencil (list 'bezier-sandwich `(quote ,bezier-list) (* size bezier-thick) ) + (ly:make-stencil (list 'draw-line (* size dot-radius) + (* size barre-fret-coordinate) + (* size barre-start-string-coordinate) + (* size barre-fret-coordinate) + (* size barre-end-string-coordinate)) + (cons (- (* size barre-fret-coordinate) scale-dot-radius) + (+ (* size barre-fret-coordinate) scale-dot-radius)) + (cons (* size barre-start-string-coordinate) + (* size barre-end-string-coordinate)))) + (if (eq? orientation 'normal) + (ly:make-stencil (list 'bezier-sandwich `(quote ,bezier-list) (* size bezier-thick)) (cons left right) - (cons bottom (+ bottom (* size bezier-height))))))) + (cons bottom (+ bottom (* size bezier-height)))) + (ly:make-stencil (list 'bezier-sandwich `(quote ,bezier-list) (* size bezier-thick)) + (cons bottom (+ bottom (* size bezier-height))) + (cons left right)))))) (if (not (null? (cdr barre-list))) (ly:stencil-add barre-stencil - (draw-barre paper props string-count fret-range size finger-code + (draw-barre layout props string-count fret-range size finger-code dot-position dot-radius (cdr barre-list))) barre-stencil )))) - (define (stepmag mag) "Calculate the font step necessary to get a desired magnification" (* 6 (/ (log mag) (log 2)))) -(define (label-fret paper props string-count fret-range size) +(define (label-fret layout props string-count fret-range size orientation) "Label the base fret on a fret diagram" (let* ((base-fret (car fret-range)) - (label-font-mag (chain-assoc-get 'fret-label-font-magnification props 0.7)) - (label-vertical-offset (chain-assoc-get 'fret-label-vertical-offset props -0.2)) +; (label-font-mag (chain-assoc-get 'label-font-mag props 0.7)) + (label-font-mag 0.5) +; (label-vertical-offset (chain-assoc-get 'fret-label-vertical-offset props -0.2)) + (label-vertical-offset -0.2) + (number-type (chain-assoc-get 'number-type props 'roman-lower)) (fret-count (+ (- (cadr fret-range) (car fret-range)) 1)) - (font (ly:paper-get-font paper `(((font-encoding . ,my-font-encoding)(font-family . sans) - (font-series . medium) (font-shape . upright) - (font-size . ,(stepmag (* size label-font-mag)))))))) - (ly:stencil-translate-axis (fontify-text font (format #f "~(~:@r~)" base-fret)) - (* size (+ fret-count label-vertical-offset)) Y))) + (label-text + (cond + ((equal? number-type 'roman-lower) (format #f "~(~:@r~)" base-fret)) + ((equal? number-type 'roman-upper) (format #f "~:@r" base-fret)) + ((equal? 'arabic number-type) (format #f "~d" base-fret)) + (else (format #f "~(~:@r~)" base-fret))))) + (if (eq? orientation 'normal) + (ly:stencil-translate-axis + (sans-serif-stencil layout props (* size label-font-mag) label-text) + (* size (+ fret-count label-vertical-offset)) Y) + (ly:stencil-translate-axis + (sans-serif-stencil layout props (* size label-font-mag) label-text) + (* size (+ 1 label-vertical-offset)) X)))) -(def-markup-command (fret-diagram-verbose paper props marking-list) +(define-builtin-markup-command (fret-diagram-verbose layout props marking-list) (list?) - "Make a fret diagram containing the symbols indicated in @var{marking-list} - - Syntax: \\fret-diagram marking-list - + "Make a fret diagram containing the symbols indicated in @var{marking-list}. + For example, - + @example - \\markup \\fret-diagram #'((mute 6) (mute 5) (open 4) (place-fret 3 2) (place-fret 2 3) (place-fret 1 2)) +\\markup \\fret-diagram-verbose + #'((mute 6) (mute 5) (open 4) + (place-fret 3 2) (place-fret 2 3) (place-fret 1 2)) @end example - - will produce a standard D chord diagram without fingering indications. + +@noindent +produces a standard D@tie{}chord diagram without fingering indications. Possible elements in @var{marking-list}: -@table @asis -@item (mute string-number) -Place a small 'x' at the top of string @var{string-number} - -@item (open string-number) -Place a small 'o' at the top of string @var{string-number} - -@item (barre start-string end-string 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 (place-fret string-number fret-number finger-value) -Place a fret playing indication on string @var{string-number} at fret @var{fret-number} with an optional -fingering label @var{finger-value}. By default, the fret playing indicator is a solid dot. This can be -changed by setting the value of the variable @var{dot-color}. If the @var{finger} -part of the 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 paper props 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 (place-fret @var{string-number} @var{fret-number} @var{finger-value}) +Place a fret playing indication on string @var{string-number} at fret +@var{fret-number} with an optional fingering label @var{finger-value}. +By default, the fret playing indicator is a solid dot. This can be +changed by setting the value of the variable @var{dot-color}. 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 (make-fret-diagram paper props marking-list) +(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 @@ -320,52 +461,72 @@ part of the place-fret element is present, @var{finger-value} will be displayed ;TODO -- adjust padding for fret label? it appears to be too close to dots (string-count (chain-assoc-get 'string-count props 6)) ; needed for everything (fret-count (chain-assoc-get 'fret-count props 4)) ; needed for everything + (orientation (chain-assoc-get 'orientation props 'normal)) ; needed for everything (finger-code (chain-assoc-get 'finger-code props 'none)) ; needed for both draw-dots and draw-barre - (default-dot-radius (if (eq? finger-code 'in-dot) 0.45 0.25)) ; bigger dots if labeled - (default-dot-position (if (eq? finger-code 'in-dot) (- 1 default-dot-radius) 0.6)) ; move up to make room for bigger if labeled + (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 if labeled (dot-radius (chain-assoc-get 'dot-radius props default-dot-radius)) ; needed for both draw-dots and draw-barre (dot-position (chain-assoc-get 'dot-position props default-dot-position)) ; needed for both draw-dots and draw-barre - (th (* (ly:paper-lookup paper 'linethickness) + (th (* (ly:output-def-lookup layout 'line-thickness) (chain-assoc-get 'thickness props 0.5))) ; needed for both draw-frets and draw-strings - (alignment (chain-assoc-get 'alignment props -0.4)) ; needed only here - (xo-padding (* th (chain-assoc-get 'xo-padding props 2))) ; needed only here - + (alignment (chain-assoc-get 'align-dir props -0.4)) ; needed only here +; (xo-padding (* th (chain-assoc-get 'padding props 2))) ; needed only here + (label-space (* 0.25 size)) + (xo-padding (* th size 5)) + (label-dir (chain-assoc-get 'label-dir props RIGHT)) (parameters (fret-parse-marking-list marking-list fret-count)) (dot-list (cdr (assoc 'dot-list parameters))) (xo-list (cdr (assoc 'xo-list parameters))) (fret-range (cdr (assoc 'fret-range parameters))) (barre-list (cdr (assoc 'barre-list parameters))) (fret-diagram-stencil (ly:stencil-add - (draw-strings string-count fret-range th size) - (draw-frets paper props fret-range string-count th size)))) + (draw-strings string-count fret-range th size orientation) + (draw-frets layout props fret-range string-count th size orientation)))) (if (not (null? barre-list)) (set! fret-diagram-stencil (ly:stencil-add - (draw-barre paper props string-count fret-range size finger-code - dot-position dot-radius barre-list) + (draw-barre layout props string-count fret-range size finger-code + dot-position dot-radius barre-list orientation) fret-diagram-stencil))) (if (not (null? dot-list)) (set! fret-diagram-stencil (ly:stencil-add - (draw-dots paper props string-count fret-range size finger-code - dot-position dot-radius dot-list) - fret-diagram-stencil))) + fret-diagram-stencil + (draw-dots layout props string-count fret-count fret-range size finger-code + dot-position dot-radius th dot-list orientation)))) + (if (= (car fret-range) 1) + (set! fret-diagram-stencil + (if (eq? orientation 'normal) + (ly:stencil-combine-at-edge fret-diagram-stencil Y UP + (draw-thick-zero-fret props string-count th size orientation)) + (ly:stencil-combine-at-edge fret-diagram-stencil X LEFT + (draw-thick-zero-fret props string-count th size orientation))))) (if (not (null? xo-list)) - (set! fret-diagram-stencil (ly:stencil-combine-at-edge - fret-diagram-stencil Y UP - (draw-xo paper props string-count fret-range size xo-list) xo-padding 0))) + (set! fret-diagram-stencil + (if (eq? orientation 'normal) + (ly:stencil-combine-at-edge fret-diagram-stencil Y UP + (draw-xo layout props string-count fret-range size xo-list orientation) xo-padding ) + (ly:stencil-combine-at-edge fret-diagram-stencil X LEFT + (draw-xo layout props string-count fret-range size xo-list orientation) xo-padding)))) (if (> (car fret-range) 1) (set! fret-diagram-stencil - (ly:stencil-combine-at-edge fret-diagram-stencil X RIGHT - (label-fret paper props string-count fret-range size) 0 0))) - (ly:stencil-align-to! fret-diagram-stencil X alignment) - fret-diagram-stencil)) + (if (eq? orientation 'normal) + (ly:stencil-combine-at-edge fret-diagram-stencil X label-dir + (label-fret layout props string-count fret-range size orientation) label-space) + (ly:stencil-combine-at-edge fret-diagram-stencil Y label-dir + (label-fret layout props string-count fret-range size orientation) label-space)))) + + (ly:stencil-aligned-to fret-diagram-stencil X alignment) + )) -(def-markup-command (fret-diagram paper props definition-string) +(define-builtin-markup-command (fret-diagram layout props definition-string) (string?) - "Syntax: \\fret-diagram definition-string - -eg: \\markup \\fret-diagram #\"s:0.75;6-x;5-x;4-o;3-2;2-3;1-2;\" + "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}: @@ -379,47 +540,56 @@ Possible items: @itemize @bullet @item -s:number -- set the fret spacing of the diagram (in staff spaces). Default 1 +@code{s:}@var{number} -- Set the fret spacing of the diagram (in staff +spaces). +Default:@tie{}1. @item -t:number -- set the line thickness (in staff spaces). Default 0.05 +@code{t:}@var{number} -- Set the line thickness (in staff spaces). +Default:@tie{}0.05. @item -h:number -- set the height of the diagram in frets. Default 4 +@code{h:}@var{number} -- Set the height of the diagram in frets. +Default:@tie{}4. @item -w:number -- set the width of the diagram in strings. Default 6 +@code{w:}@var{number} -- Set the width of the diagram in strings. +Default:@tie{}6. @item -f:number -- set fingering label type (0 = none, 1 = in circle on string, 2 = below string) Default 0 +@code{f:}@var{number} -- Set fingering label type +(0@tie{}= none, 1@tie{}= in circle on string, 2@tie{}= below string). +Default:@tie{}0. @item -d:number -- set radius of dot, in terms of fret spacing. Default 0.25 +@code{d:}@var{number} -- Set radius of dot, in terms of fret spacing. +Default:@tie{}0.25. @item -p:number -- set the position of the dot in the fret space. 0.5 is centered; 1 is on lower fret bar, -0 is on upper fret bar. Default 0.6 +@code{p:}@var{number} -- Set the position of the dot in the fret space. +0.5 is centered; 1@tie{}is on lower fret bar, 0@tie{}is on upper fret bar. +Default:@tie{}0.6. @item -c:string1-string2-fret -- include a barre mark from string1 to string2 on fret +@code{c:}@var{string1}@code{-}@var{string2}@code{-}@var{fret} -- Include a +barre mark from @var{string1} to @var{string2} on @var{fret}. @item -string-fret -- place a dot on string at fret. If fret is o, string is identified -as open. If fret is x, string is identified as muted. +@var{string}@code{-}@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 -string-fret-fingering -- place a dot on string at fret, and label with fingering as -defined by f: code. - +@var{string}@code{-}@var{fret}@code{-}@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 - -" +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))) - (make-fret-diagram paper (car definition-list) (cdr definition-list)))) + (make-fret-diagram layout (car definition-list) (cdr definition-list)))) (define (fret-parse-definition-string props definition-string) "parse a fret diagram string and return a pair containing: @@ -477,7 +647,7 @@ Note: There is no limit to the number of fret indications per string. (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) ))) + (string->number (substring keystring 2 (string-length keystring)))) (define (numerify mylist) "Convert string values to numeric or character" @@ -488,15 +658,21 @@ Note: There is no limit to the number of fret indications per string. (cons* numeric-value (numerify (cdr mylist))) (cons* (car (string->list (car mylist))) (numerify (cdr mylist))))))) -(def-markup-command (fret-diagram-terse paper props definition-string) +(define-builtin-markup-command (fret-diagram-terse layout props definition-string) (string?) "Make a fret diagram markup using terse string-based syntax. -Syntax: \\fret-diagram-terse definition-string +Here an example + +@example +\\markup \\fret-diagram-terse #\"x;x;o;2;3;2;\" +@end example -eg: \\markup \\fret-diagram #\"x;x;o;2;3;2;\" for a D chord diagram. +@noindent +for a D@tie{}chord diagram. Syntax rules for @var{definition-string}: + @itemize @bullet @item @@ -504,10 +680,10 @@ Strings are terminated by semicolons; the number of semicolons is the number of strings in the diagram. @item -Mute strings are indicated by \"x\". +Mute strings are indicated by @samp{x}. @item -Open strings are indicated by \"o\". +Open strings are indicated by @samp{o}. @item A number indicates a fret indication at that fret. @@ -517,17 +693,18 @@ 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 \"-\", -followed by the finger indicator, e.g. 3-2 for playing the third +Fingerings are given by following the fret number with a @code{-}, +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 \"-(\" to start a barre and \"-)\" to end the barre. +with @code{-(} to start a barre and @code{-)} to end the barre. + @end itemize" ;TODO -- change syntax to fret\string-finger (let ((definition-list (fret-parse-terse-definition-string props definition-string))) - (make-fret-diagram paper (car definition-list) (cdr definition-list)))) + (make-fret-diagram layout (car definition-list) (cdr definition-list)))) (define (fret-parse-terse-definition-string props definition-string) "parse a fret diagram string that uses terse syntax; return a pair containing: