-;;;; fret-diagrams.scm -- \r
-;;;;\r
-;;;; source file of the GNU LilyPond music typesetter\r
-;;;; \r
-;;;; (c) 2004 Carl D. Sorensen <c_sorensen@byu.edu>\r
-\r
-\r
-(define (fret-parse-marking-list marking-list fret-count)\r
- (let* ((fret-range (list 1 fret-count))\r
- (barre-list '())\r
- (dot-list '())\r
- (xo-list '())\r
- (output-alist '()))\r
- (let parse-item ((mylist marking-list))\r
- (if (not (null? mylist))\r
- (let* ((my-item (car mylist)) (my-code (car my-item)))\r
- (cond\r
- ((or (eq? my-code 'open)(eq? my-code 'mute))\r
- (set! xo-list (cons* my-item xo-list)))\r
- ((eq? my-code 'barre)\r
- (set! barre-list (cons* (cdr my-item) barre-list)))\r
- ((eq? my-code 'place-fret)\r
- (set! dot-list (cons* (cdr my-item) dot-list))))\r
- (parse-item (cdr mylist)))))\r
- ; calculate fret-range\r
- (let ((maxfret 0) (minfret 99))\r
- (let updatemax ((fret-list dot-list))\r
- (if (null? fret-list)\r
- '()\r
- (let ((fretval (second (car fret-list))))\r
- (if (> fretval maxfret) (set! maxfret fretval))\r
- (if (< fretval minfret) (set! minfret fretval))\r
- (updatemax (cdr fret-list)))))\r
- (if (> maxfret fret-count)\r
- (set! fret-range (list minfret\r
- (let ((upfret (- (+ minfret fret-count) 1)))\r
- (if (> maxfret upfret) maxfret upfret)))))\r
- ; subtract fret from dots\r
- (set! dot-list (subtract-base-fret (- (car fret-range) 1) dot-list)))\r
-; (display "barre-list ") (display barre-list) (display "\n")\r
- (acons 'fret-range fret-range\r
- (acons 'barre-list barre-list\r
- (acons 'dot-list dot-list\r
- (acons 'xo-list xo-list '()))))))\r
- \r
-(define (subtract-base-fret base-fret dot-list)\r
-"Subtract @var{base-fret} from every fret in @var{dot-list}" \r
- (if (null? dot-list)\r
- '()\r
- (let ((this-list (car dot-list)))\r
- (cons* (list (car this-list) (- (second this-list) base-fret) (if (null? (cddr this-list))\r
- '()\r
- (third this-list)))\r
- (subtract-base-fret base-fret (cdr dot-list))))))\r
-\r
-(define (draw-strings string-count fret-range th size)\r
-"Draw the strings (vertical lines) for a fret diagram with @var{string-count} strings and frets as indicated\r
- in @var{fret-range}. Line thickness is given by @var{th}, fret & string spacing by @var{size}. "\r
- (let* ((fret-count (+ (- (cadr fret-range) (car fret-range)) 1))\r
- (sl (* (+ fret-count 1) size))\r
- (sth (* size th))\r
- (half-thickness (* sth 0.5))\r
- (gap (- size sth))\r
- (string-stencil (ly:make-stencil (list 'draw-line sth 0 0 0 sl)\r
- (cons (- half-thickness) half-thickness)\r
- (cons (- half-thickness) (+ sl half-thickness)))))\r
- (if (= string-count 1)\r
- string-stencil\r
- (ly:stencil-combine-at-edge\r
- (draw-strings (- string-count 1) fret-range th size) X RIGHT\r
- string-stencil\r
- gap 0))))\r
-\r
-(define (draw-fret-lines fret-count string-count th size)\r
- "Draw @var{fret-count} frets (horizontal lines) for a fret diagram with @var{string-count} strings.\r
- Line thickness is given by @var{th}, fret & string spacing by @var{size}. "\r
- (let* ((fret-length (* (- string-count 1) size))\r
- (sth (* size th))\r
- (half-thickness (* sth 0.5))\r
- (gap (- size sth))\r
- (fret-line (ly:make-stencil (list 'draw-line sth half-thickness size (- fret-length half-thickness) size)\r
- (cons 0 fret-length)\r
- (cons (- size half-thickness) (+ size half-thickness)))))\r
- (if (= fret-count 1)\r
- fret-line\r
- (ly:stencil-combine-at-edge fret-line Y UP\r
- (draw-fret-lines (- fret-count 1) string-count th size)\r
- gap 0))))\r
- \r
-(define (draw-thick-top-fret props string-count th size)\r
- "Draw a thick top fret for a fret diagram whose base fret is not 1."\r
- (let* ((sth (* th size))\r
- (top-fret-thick (* sth (chain-assoc-get 'top-fret-thickness props 3.0)))\r
- (top-half-thick (* top-fret-thick 0.5))\r
- (half-thick (* sth 0.5))\r
- (x1 half-thick)\r
- (x2 (+ half-thick (* size (- string-count 1))))\r
- (y1 0)\r
- (y2 top-fret-thick)\r
- (x-extent (cons (- x1) x2))\r
- (y-extent (cons 0 y2)))\r
- (ly:make-stencil (list 'round-filled-box x1 x2 y1 y2 th)\r
- x-extent y-extent))) \r
- \r
- \r
-(define (draw-frets paper props fret-range string-count th size)\r
- "Draw the frets (horizontal lines) for a fret diagram with @var{string-count} strings and frets as indicated\r
- in @var{fret-range}. Line thickness is given by @var{th}, fret & string spacing by @var{size}. "\r
- (let* ((top-fret-thick (* th (chain-assoc-get 'top-fret-thickness props 3.0)))\r
- (fret-count (+ (- (cadr fret-range) (car fret-range)) 1))\r
- (fret-length (* (- string-count 1) size))\r
- (half-thickness (* th 0.5))\r
- (base-fret (car fret-range)))\r
- (ly:stencil-combine-at-edge\r
- (draw-fret-lines fret-count string-count th size) Y UP\r
- (if (= base-fret 1)\r
- (draw-thick-top-fret props string-count th size)\r
- (draw-fret-lines 1 string-count th size)) \r
- (- size th) 0))) \r
- \r
-(define (get-center-shift extent)\r
-"Return the amount of shift required to make @var{extent} be centered"\r
- (let ((minval (car extent))\r
- (maxval (cdr extent)))\r
- (/ (- minval maxval) 2)))\r
-\r
-\r
-;; ly:stencil-get-extent is missing from 2.2 on\r
-;(define (centered-text-stencil font text)\r
-;"Create a centered text stencil of @var{text} in font @var{font}"\r
-;(let* ((text-stencil (fontify-text font text))\r
-; (x-shift (get-center-shift (ly:stencil-get-extent text-stencil X)))\r
-; (y-shift (get-center-shift y-extent (ly:stencil-get-extent text-stencil Y))))\r
-; (ly:stencil-translate-axis \r
-; (ly:stencil-translate-axis text-stencil x-shift X)\r
-; y-shift Y))) \r
-\r
-(define (draw-dots paper props string-count fret-range size dot-position dot-list)\r
- "Make dots for fret diagram."\r
-; (display "In draw-dots" dot-list)\r
- (let* ((finger-code (chain-assoc-get 'finger-code props 'none))\r
- (dot-radius (* size (chain-assoc-get 'dot-radius props 0.25)))\r
- (finger-xoffset (chain-assoc-get 'finger-xoffset props -0.25))\r
- (finger-yoffset (chain-assoc-get 'finger-yoffset props (- size)))\r
- (label-font-name (chain-assoc-get 'label-font-name props "cmss8"))\r
- (dot-label-font-mag (* size (chain-assoc-get 'dot-label-font-mag props .45)))\r
- (dot-circle-font-mag (* size (chain-assoc-get 'dot-circle-font-mag props .75)))\r
- (string-label-font-mag (* size (chain-assoc-get 'string-label-font-mag props 0.6)))\r
- (fret-count (+ (- (cadr fret-range) (car fret-range) 1)))\r
- (mypair (car dot-list))\r
- (restlist (cdr dot-list))\r
- (xpos (* size (- string-count (car mypair))))\r
-;TODO -- figure out what 4 is and get rid of it\r
-;UGH -- 4?\r
- (ypos (* size (+ 4 (- fret-count (cadr mypair) dot-position ))))\r
- (finger (caddr mypair))\r
- (finger (if (number? finger) (number->string finger) finger))\r
- (string-label-font (ly:paper-get-font paper `(((font-magnification . ,string-label-font-mag)\r
- (font-name . ,label-font-name)))))\r
- (dot-label-font (ly:paper-get-font paper `(((font-magnification . ,dot-label-font-mag)\r
- (font-name . ,label-font-name)))))\r
- (dot-circle-font (ly:paper-get-font paper `(((font-magnification . ,dot-circle-font-mag)\r
- (font-name . ,label-font-name)))))\r
- (extent (cons (- dot-radius) dot-radius))\r
- (dotstencil (if (or (eq? finger '())(eq? finger-code 'none))\r
- (ly:make-stencil (list 'dot xpos ypos dot-radius ) extent extent)\r
- (if (eq? finger-code 'white-circled)\r
-; TODO -- Get nice circled numbers in the font, instead of this kludge\r
-; UGH -- Constants in here need to go\r
-; Note: for finger (this stencil) xpos should be related only to font size, ypos should be related to both font size and dot-position\r
-; These are not yet worked out, and should be. But perhaps I'd like first to get a nice font for circled numbers / letters \r
- (ly:stencil-add \r
- (ly:stencil-translate-axis \r
- (ly:stencil-translate-axis \r
- (fontify-text dot-label-font finger) (- xpos (* size 0.2)) X)\r
- (- ypos (* 1 dot-radius size)) Y)\r
-; These lines are a better way to do it, but they require ly:stencil-get-extent, which is missing from 2.2.0\r
-; (centered-text-stencil dot-label-font finger) xpos X)\r
-; ypos Y)\r
- ;UGH -- Constants in xpos and ypos need to go. xpos should be related to font mag,\r
- ; ypos should be related to both font magnification and dot-position. Again, I may want to wait for the nice font with\r
- ; convenient zero point (right at the center of the dot). \r
- ;TODO -- Alternatively, perhaps I should query for the extent of the glyph,\r
- ; and place it accordingly. That actually sounds better\r
- (ly:stencil-translate-axis\r
- (ly:stencil-translate-axis \r
- (fontify-text dot-circle-font "O") (- xpos (* 0.6 dot-circle-font-mag)) X)\r
- (- ypos (* 0.5 dot-circle-font-mag)) Y))\r
-; These lines are a better way to do it, but they require ly:stencil-get-exten, which is missing from 2.2.0\r
-; (centered-text-stencil dot-circle-font "O") xpos X)\r
-; ypos Y))\r
- (if (eq? finger-code 'below-string) \r
- (ly:stencil-add \r
- (ly:make-stencil (list 'dot xpos ypos dot-radius ) extent extent)\r
- (ly:stencil-translate-axis \r
- (ly:stencil-translate-axis \r
- (fontify-text string-label-font finger) (+ xpos (* size finger-xoffset)) X)\r
- (* size finger-yoffset) Y)))))))\r
- (if (null? restlist)\r
- dotstencil\r
- (ly:stencil-add (draw-dots paper props string-count fret-range size dot-position restlist)\r
- dotstencil))))\r
-\r
-(define (draw-xo paper props string-count fret-range size xo-list) \r
-"Put open and mute string indications on diagram, as contained in @var{xo-list}."\r
- (let* ((fret-count (+ (- (cadr fret-range) (car fret-range) 1)))\r
- (xo-font-mag (* size (chain-assoc-get 'xo-font-magnification props 0.5)))\r
- (xo-font-name (chain-assoc-get 'xo-font-name props "cmss8"))\r
- (xo-horizontal-offset (* size (chain-assoc-get 'xo-horizontal-offset props -0.35)))\r
- (font (ly:paper-get-font paper `(((font-magnification . ,xo-font-mag)\r
- (font-name . ,xo-font-name)))))\r
- (mypair (car xo-list))\r
- (restlist (cdr xo-list))\r
- (glyph-string (if (eq? (car mypair) 'mute) "X" "O"))\r
- (xpos (+ (* (- string-count (cadr mypair)) size) xo-horizontal-offset ))\r
- (glyph-stencil (ly:stencil-translate-axis (fontify-text font glyph-string) xpos X)))\r
- (if (null? restlist)\r
- glyph-stencil\r
- (ly:stencil-add\r
- (draw-xo paper props string-count fret-range size restlist)\r
- glyph-stencil))))\r
-\r
-(define (make-bezier-sandwich-list left right bottom height thickness)\r
-" Make the argument list for a horizontal bezier sandwich from @var{left} to @var{right} with a bottom at @var{bottom}, \r
- a height of @var{height}, and a thickness of @var{thickness}."\r
- (let* ((width (+ (- right left) 1))\r
- (x1 (+ (* width thickness) left))\r
- (x2 (- right (* width thickness)))\r
- (bottom-control-point-height (+ bottom (- height thickness)))\r
- (top-control-point-height (+ bottom height)))\r
- ; order of points is: left cp low, right cp low, right end low, left end low\r
- ; right cp high, left cp high, left end high, right end high.\r
- (list (cons x1 bottom-control-point-height) (cons x2 bottom-control-point-height) (cons right bottom) (cons left bottom)\r
- (cons x2 top-control-point-height) (cons x1 top-control-point-height) (cons left bottom) (cons right bottom))))\r
-\r
-(define (draw-barre paper props string-count fret-range size dot-position barre-list)\r
- "Create barre indications for a fret diagram"\r
- (if (not (null? barre-list))\r
- (let* ((string1 (caar barre-list))\r
- (string2 (cadar barre-list))\r
- (fret (caddar barre-list))\r
- ; 2 is 1 for empty fret at bottom of figure + 1 for interval (top-fret - fret + 1) -- not an arbitrary constant\r
- (bottom (* size (- (+ 2 (- (cadr fret-range) fret)) dot-position)))\r
- (left (* size (- string-count string1)))\r
- (right (* size (- string-count string2)))\r
- (bezier-thick (chain-assoc-get 'bezier-thickness props 0.1))\r
- (bezier-height (chain-assoc-get 'bezier-height props 0.5))\r
- (bezier-list (make-bezier-sandwich-list left right bottom (* size bezier-height) (* size bezier-thick)))\r
- (sandwich-stencil (ly:make-stencil (list 'bezier-sandwich `(quote ,bezier-list) (* size bezier-thick) )\r
- (cons 0 right)\r
- (cons 0 (+ bottom (* size bezier-height))))))\r
- (if (not (null? (cdr barre-list)))\r
- (ly:stencil-add sandwich-stencil\r
- (draw-barre paper props string-count fret-range size dot-position (cdr barre-list)))\r
- sandwich-stencil ))))\r
- \r
-(define (label-fret paper props string-count fret-range size)\r
- "Label the base fret on a fret diagram"\r
- (let* ((base-fret (car fret-range))\r
- (label-font-mag (chain-assoc-get 'fret-label-font-magnification props 0.8))\r
- (label-horizontal-offset (chain-assoc-get 'fret-label-horizontal-offset props -0.5))\r
- (label-vertical-offset (chain-assoc-get 'fret-label-vertical-offset props -0.2))\r
- (fret-count (+ (- (cadr fret-range) (car fret-range)) 1))\r
- (font (ly:paper-get-font paper `(((font-magnification . ,(* label-font-mag size))(font-name . "cmss8")\r
- (font-encoding Tex-text))))))\r
- (ly:stencil-translate-axis \r
- (ly:stencil-translate-axis (fontify-text font (if (> base-fret 1)\r
- (format #f "~(~:@r~)" base-fret)\r
- " ")) (* size (+ string-count label-horizontal-offset)) X)\r
- (* size (+ fret-count label-vertical-offset)) Y)))\r
- \r
-(def-markup-command (fret-diagram-verbose paper props marking-list)\r
- (list?)\r
- "Make a fret diagram containing the symbols indicated in @var{marking-list}\r
- Syntax: \\fret-diagram marking-list\r
- For example,\r
- @verbatim\r
- \\markup \\fret-diagram #\'((mute 6) (mute 5) (open 4) (place-fret 3 2) (place-fret 2 3) (place-fret 1 2))\r
- @end verbatim \r
- will produce a standard D chord diagram without fingering indications.\r
- Possible elements in @var{marking-list}:\r
- (mute string-number) -- place a small 'x' at the top of string @var{string-number}\r
- (open string-number) -- place a small 'o' at the top of string @var{string-number}\r
- (barre start-string end-string fret-number) -- place a barre indicator (much like a tie) from string @var{start-string}\r
- to string @var{end-string} at fret @var{fret-number}\r
- (place-fret string-number fret-number finger-value) -- place a fret playing indication\r
- on string @var{string-number} at fret @var{fret-number} with an optional fingering label @var{finger-value}\r
- By default, the fret playing indicator is a solid dot. If the @var{finger} part of the place-fret element is present,\r
- @var{finger-value} will be displayed according to the setting of the variable @var{finger-code}\r
- There is no limit to the number of fret indications per string."\r
- (make-fret-diagram paper props marking-list))\r
- \r
-(define (make-fret-diagram paper props marking-list)\r
-" Make a fret diagram markup" \r
- (let* (\r
- ; note: here we get items from props that are needed in this routine, or that are needed in more than one\r
- ; of the procedures called from this routine. If they're only used in one of the sub-procedure, they're \r
- ; obtained in that procedure\r
- \r
- (size (chain-assoc-get 'size props 1.0)) ; needed for everything\r
-;TODO -- get string-count directly from length of stringTunings; requires FretDiagram engraver, which is not yet available\r
- (string-count (chain-assoc-get 'string-count props 6)) ; needed for everything\r
- (fret-count (chain-assoc-get 'fret-count props 4)) ; needed for everything\r
- (dot-position (chain-assoc-get 'dot-position props 0.6)) ; needed for both draw-dots and draw-barre\r
- (th (* (ly:paper-lookup paper 'linethickness)\r
- (chain-assoc-get 'thickness props 0.5))) ; needed for both draw-frets and draw-strings\r
- \r
- (alignment (chain-assoc-get 'alignment props -0.4)) ; needed only here\r
- (xo-padding (* th (chain-assoc-get 'xo-padding props 2))) ; needed only here\r
-\r
- (parameters (fret-parse-marking-list marking-list fret-count))\r
- (dot-list (cdr (assoc 'dot-list parameters)))\r
- (xo-list (cdr (assoc 'xo-list parameters)))\r
- (fret-range (cdr (assoc 'fret-range parameters)))\r
- (barre-list (cdr (assoc 'barre-list parameters)))\r
- (fret-diagram-stencil (ly:stencil-add\r
- (draw-strings string-count fret-range th size)\r
- (draw-frets paper props fret-range string-count th size))))\r
- (if (not (null? dot-list))\r
- (set! fret-diagram-stencil (ly:stencil-add\r
- (draw-dots paper props string-count fret-range size dot-position dot-list)\r
- fret-diagram-stencil)))\r
- (if (not (null? xo-list))\r
- (set! fret-diagram-stencil (ly:stencil-combine-at-edge\r
- fret-diagram-stencil Y UP\r
- (draw-xo paper props string-count fret-range size xo-list) xo-padding 0)))\r
- (if (not (null? barre-list))\r
- (set! fret-diagram-stencil (ly:stencil-add\r
- (draw-barre paper props string-count fret-range size dot-position barre-list)\r
- fret-diagram-stencil)))\r
- (set! fret-diagram-stencil (ly:stencil-add fret-diagram-stencil (label-fret paper props string-count fret-range size)))\r
- (ly:stencil-align-to! fret-diagram-stencil X alignment)\r
- fret-diagram-stencil))\r
- \r
-(def-markup-command (fret-diagram paper props size definition-string)\r
- (number? string?)\r
- "Syntax: \\fret-diagram size definition-string\r
- eg: \\markup \\fret-diagram #0.75 #\"6-x;5-x;4-o;3-2;2-3;1-2;\"\r
- for fret spacing 3/4 of staff space, D chord diagram\r
- Syntax rules for @var{definition-string}:\r
- Diagram items are separated by semicolons.\r
- Possible items:\r
- t:number -- set the line thickness (in staff spaces). Default 0.05\r
- h:number -- set the height of the diagram in frets. Default 4\r
- w:number -- set the width of the diagram in strings. Default 6\r
- f:number -- set fingering label type \r
- (0 = none, 1 = in circle on string, 2 = below string) Default 0\r
- d:number -- set radius of dot, in terms of fret spacing. Default 0.25\r
- p:number -- set the position of the dot in the fret space. 0.5 is centered; 1 is on lower fret bar,\r
- 0 is on upper fret bar. Default 0.6 \r
- c:string1-string2-fret -- include a barre mark from string1 to string2 on fret\r
- string-fret -- place a dot on string at fret. If fret is o, string is identified\r
- as open. If fret is x, string is identified as muted.\r
- string-fret-fingering -- place a dot on string at fret, and label with fingering as \r
- defined by f: code.\r
- Note: There is no limit to the number of fret indications per string."\r
- (set! props (acons 'size size props))\r
- (let ((definition-list (parse-definition-string props definition-string)))\r
- (make-fret-diagram paper (car definition-list) (cdr definition-list))))\r
-\r
-(define (parse-definition-string props definition-string)\r
- "parse a fret diagram string and return a pair containing:\r
- props, modified as necessary by the definition-string\r
- a fret-indication list with the appropriate values"\r
- (let* ((fret-count 4)\r
- (string-count 6)\r
- (thickness 0.05)\r
- (finger-code 0)\r
- (dot-size 0.25)\r
- (dot-position 0.6)\r
- (fret-range (list 1 fret-count))\r
- (barre-list '())\r
- (dot-list '())\r
- (xo-list '())\r
- (output-list '())\r
- (items (string-split definition-string #\;)))\r
- (let parse-item ((myitems items))\r
- (if (not (null? (cdr myitems))) \r
- (let ((test-string (car myitems)))\r
- (case (car (string->list (substring test-string 0 1))) \r
- ((#\f) (let* ((finger-code (get-numeric-from-key test-string))\r
- (finger-id (case finger-code\r
- ((0) 'none)\r
- ((1) 'white-circled) \r
- ((2) 'below-string))))\r
- (set! props\r
- (acons 'finger-code finger-id props))))\r
- ((#\t) (let ((thickness (get-numeric-from-key test-string)))\r
- (set! props (acons 'thickness thickness props))))\r
- ((#\c) (set! output-list (cons-fret (cons 'barre (numerify (string-split (substring test-string 2) #\-)))\r
- output-list)))\r
- ((#\h) (let ((fret-count (get-numeric-from-key test-string)))\r
- (set! props (acons 'fret-count fret-count props))))\r
- ((#\w) (let ((string-count (get-numeric-from-key test-string)))\r
- (set! props (acons 'string-count string-count props))))\r
- ((#\d) (let ((dot-size (get-numeric-from-key test-string)))\r
- (set! props (acons 'dot-radius dot-size props))))\r
- ((#\p) (let ((dot-position (get-numeric-from-key test-string)))\r
- (set! props (acons 'dot-position dot-position props))))\r
- (else \r
- (let ((this-list (string-split test-string #\-)))\r
- (if (string->number (cadr this-list))\r
- (set! output-list (cons-fret (cons 'place-fret (numerify this-list)) output-list))\r
- (if (equal? (cadr this-list) "x" )\r
- (set! output-list (cons-fret (list 'mute (string->number (car this-list))) output-list))\r
- (set! output-list (cons-fret (list 'open (string->number (car this-list))) output-list)))))))\r
- (parse-item (cdr myitems)))))\r
- `((,props) . ,output-list)))\r
-\r
-(define (cons-fret new-value old-list)\r
-" Put together a fret-list in the format desired by parse-string "\r
- (if (eq? old-list '())\r
- (list new-value)\r
- (cons* new-value old-list)))\r
- \r
-(define (get-numeric-from-key keystring)\r
- "Get the numeric value from a key of the form k:val"\r
- (string->number (substring keystring 2 (string-length keystring) )))\r
- \r
-(define (numerify mylist)\r
- "Convert string values to numeric or character"\r
- (if (null? mylist)\r
- '()\r
- (let ((numeric-value (string->number (car mylist))))\r
- (if numeric-value\r
- (cons* numeric-value (numerify (cdr mylist)))\r
- (cons* (car (string->list (car mylist))) (numerify (cdr mylist)))))))\r
- \r
+;;;; This file is part of LilyPond, the GNU music typesetter.
+;;;;
+;;;; Copyright (C) 2004--2015 Carl D. Sorensen <c_sorensen@byu.edu>
+;;;;
+;;;; 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 <http://www.gnu.org/licenses/>.
+
+;; 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
+ (if (or (null? (cddr this-list))
+ (not (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))
+ (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))
+ positioned-dot)
+ ((eq? finger-code 'in-dot)
+ (let ((finger-label
+ (centered-stencil
+ (sans-serif-stencil
+ layout props dot-label-font-mag 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
+ (number-format number-type base-fret
+ (assoc-get 'fret-label-custom-format
+ details "~a")))
+ (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 D@tie{}chord 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}
+ [@var{finger-value}]
+ [@var{color-modifier}]
+ [@var{color}]
+ [@code{'parenthesized} [@code{'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:}@var{number} -- Set the fret spacing of the diagram (in staff
+spaces).
+Default:@tie{}1.
+
+@item
+@code{t:}@var{number} -- Set the line thickness (relative to normal
+line thickness).
+Default:@tie{}0.5.
+
+@item
+@code{h:}@var{number} -- Set the height of the diagram in frets.
+Default:@tie{}4.
+
+@item
+@code{w:}@var{number} -- Set the width of the diagram in strings.
+Default:@tie{}6.
+
+@item
+@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
+@code{d:}@var{number} -- Set radius of dot, in terms of fret spacing.
+Default:@tie{}0.25.
+
+@item
+@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
+@code{c:}@var{string1}@code{-}@var{string2}@code{-}@var{fret} -- Include a
+barre mark from @var{string1} to @var{string2} on @var{fret}.
+
+@item
+@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
+@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"
+ (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 D@tie{}chord 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 @w{@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 @w{@code{-(}} to start a barre and @w{@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)))
+ (fret-diagram-verbose-markup layout
+ (car definition-list)
+ (cdr definition-list))))
projects / lilypond.git / blobdiff