-;;
-;; framework-svg.scm -- structure for SVG output
+;;;; This file is part of LilyPond, the GNU music typesetter.
;;;;
-;;;; source file of the GNU LilyPond music typesetter
-;;;;
-;;;; (c) 2004--2007 Jan Nieuwenhuizen <janneke@gnu.org>
+;;;; Copyright (C) 2004--2015 Jan Nieuwenhuizen <janneke@gnu.org>
+;;;; Patrick McCarty <pnorcks@gmail.com>
+;;;;
+;;;; 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/>.
-(define-module (scm framework-svg))
+;;;; Recommendations:
+;;;; http://www.w3.org/TR/SVG11/
+;;;; http://www.w3.org/TR/SVGTiny12/
+;;;;
+;;;; Working draft:
+;;;; http://www.w3.org/TR/SVGPrint/ -- for <pageSet> and <page>
-(use-modules (guile)
- (lily)
- (scm page)
- (scm output-svg))
+;;;; TODO:
+;;;; * Once <pageSet> and <page> are supported by Inkscape and
+;;;; other user agents, add a -d option (-dsvg-multiple-page)
+;;;; that will create a single SVG file containing all pages
+;;;; of output. --pmccarty
-(use-modules (srfi srfi-1)
- (srfi srfi-2)
- (srfi srfi-13)
- (ice-9 regex))
+(define-module (scm framework-svg))
+
+(use-modules
+ (guile)
+ (lily)
+ (scm page)
+ (scm paper-system)
+ (scm output-svg)
+ (srfi srfi-1)
+ (srfi srfi-2)
+ (srfi srfi-13)
+ (ice-9 regex))
(define format ergonomic-simple-format)
-(define-public (output-framework basename book scopes fields)
- (let* ((filename (format "~a.svg" basename))
- (outputter (ly:make-paper-outputter (open-file filename "wb")
- (ly:get-option 'backend)))
- (dump (lambda (str) (display str (ly:outputter-port outputter))))
- (paper (ly:paper-book-paper book))
- (unit-length (ly:output-def-lookup paper 'output-scale))
- (output-scale (* lily-unit->mm-factor
- unit-length))
- (page-stencils (map page-stencil (ly:paper-book-pages book)))
- (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
- (page-number (1- (ly:output-def-lookup paper 'first-page-number)))
- (page-count (length page-stencils))
- (paper-width (ly:output-def-lookup paper 'paper-width))
- (paper-height (ly:output-def-lookup paper 'paper-height))
- (page-width (inexact->exact (ceiling (* output-scale paper-width))))
- (page-height (inexact->exact (ceiling (* output-scale paper-height))))
- (page-set? (or (> page-count 1) landscape?)))
+(define (svg-begin . rest)
+ (eo 'svg
+ '(xmlns . "http://www.w3.org/2000/svg")
+ '(xmlns:xlink . "http://www.w3.org/1999/xlink")
+ '(version . "1.2")
+ `(width . ,(ly:format "~2fmm" (first rest)))
+ `(height . ,(ly:format "~2fmm" (second rest)))
+ `(viewBox . ,(ly:format "~4f ~4f ~4f ~4f"
+ (third rest) (fourth rest)
+ (fifth rest) (sixth rest)))))
+
+(define (svg-end)
+ (ec 'svg))
+
+(define (mkdirs dir-name mode)
+ (let loop ((dir-name (string-split dir-name #\/)) (root ""))
+ (if (pair? dir-name)
+ (let ((dir (string-append root (car dir-name))))
+ (if (not (file-exists? dir))
+ (mkdir dir mode))
+ (loop (cdr dir-name) (string-append dir "/"))))))
+
+(define output-dir #f)
+(define (svg-define-font font font-name scaling)
+ (let* ((base-file-name (basename (if (list? font) (pango-pf-file-name font)
+ (ly:font-file-name font)) ".otf"))
+ (woff-file-name (string-regexp-substitute "([.]otf)?$" ".woff"
+ base-file-name))
+ (woff-file (or (ly:find-file woff-file-name) "/no-such-file.woff"))
+ (url (string-append output-dir "/fonts/" (lilypond-version) "/"
+ (basename woff-file-name)))
+ (lower-name (string-downcase font-name)))
+ (if (file-exists? woff-file)
+ (begin
+ (if (not (file-exists? url))
+ (begin
+ (ly:message (_ "Updating font into: ~a") url)
+ (mkdirs (string-append output-dir "/" (dirname url)) #o700)
+ (copy-file woff-file url)
+ (ly:progress "\n")))
+ (ly:format
+ "@font-face {
+font-family: '~a';
+font-weight: normal;
+font-style: normal;
+src: url('~a');
+}
+"
+ font-name url))
+ "")))
+
+(define (woff-header paper dir)
+ "TODO:
+ * add (ly:version) to font name
+ * copy woff font with version alongside svg output
+"
+ (set! output-dir dir)
+ (string-append
+ (eo 'defs)
+ (eo 'style '(text . "style/css"))
+ "<![CDATA[
+"
+ (define-fonts paper svg-define-font svg-define-font)
+ "]]>
+"
+ (ec 'style)
+ (ec 'defs)))
+
+(define (dump-page paper filename page page-number page-count)
+ (let* ((outputter (ly:make-paper-outputter (open-file filename "wb") 'svg))
+ (dump (lambda (str) (display str (ly:outputter-port outputter))))
+ (lookup (lambda (x) (ly:output-def-lookup paper x)))
+ (unit-length (lookup 'output-scale))
+ (output-scale (* lily-unit->mm-factor unit-length))
+ (device-width (lookup 'paper-width))
+ (device-height (lookup 'paper-height))
+ (page-width (* output-scale device-width))
+ (page-height (* output-scale device-height)))
+
+ (if (ly:get-option 'svg-woff)
+ (module-define! (ly:outputter-module outputter) 'paper paper))
+ (dump (svg-begin page-width page-height
+ 0 0 device-width device-height))
+ (if (ly:get-option 'svg-woff)
+ (module-remove! (ly:outputter-module outputter) 'paper))
+ (if (ly:get-option 'svg-woff)
+ (dump (woff-header paper (dirname filename))))
+ (dump (comment (format #f "Page: ~S/~S" page-number page-count)))
(ly:outputter-output-scheme outputter
- `(begin (set! lily-unit-length ,unit-length) ""))
- (dump (eo 'svg
- '(xmlns . "http://www.w3.org/2000/svg")
- '(xmlns:xlink . "http://www.w3.org/1999/xlink")
- '(version . "1.2")
-
- ;; Argggghhhh: SVG takes the px <-> mm mapping from the windowing system
- `(width . ,(format "~s" page-width))
- `(height . ,(format "~s" page-height))))
-
- (dump (dump-fonts outputter paper))
- (dump
- (string-append
- ;; FIXME: only use pages if there are more than one, pageSet is
- ;; not supported by all SVG applications yet.
- (if page-set? (eo 'pageSet) "")
- (eo 'g `(transform . ,(format "scale(~a, ~a) "
- output-scale output-scale)))))
-
+ `(begin (set! lily-unit-length ,unit-length)
+ ""))
+ (ly:outputter-dump-stencil outputter page)
+ (dump (svg-end))
+ (ly:outputter-close outputter)))
+
+(define (dump-preview paper stencil filename)
+ (let* ((outputter (ly:make-paper-outputter (open-file filename "wb") 'svg))
+ (dump (lambda (str) (display str (ly:outputter-port outputter))))
+ (lookup (lambda (x) (ly:output-def-lookup paper x)))
+ (unit-length (lookup 'output-scale))
+ (x-extent (ly:stencil-extent stencil X))
+ (y-extent (ly:stencil-extent stencil Y))
+ (left-x (car x-extent))
+ (top-y (cdr y-extent))
+ (device-width (interval-length x-extent))
+ (device-height (interval-length y-extent))
+ (output-scale (* lily-unit->mm-factor unit-length))
+ (svg-width (* output-scale device-width))
+ (svg-height (* output-scale device-height)))
+
+ (if (ly:get-option 'svg-woff)
+ (module-define! (ly:outputter-module outputter) 'paper paper))
+ (dump (svg-begin svg-width svg-height
+ left-x (- top-y) device-width device-height))
+ (if (ly:get-option 'svg-woff)
+ (module-remove! (ly:outputter-module outputter) 'paper))
+ (if (ly:get-option 'svg-woff)
+ (dump (woff-header paper (dirname filename))))
+ (ly:outputter-output-scheme outputter
+ `(begin (set! lily-unit-length ,unit-length)
+ ""))
+ (ly:outputter-dump-stencil outputter stencil)
+ (dump (svg-end))
+ (ly:outputter-close outputter)))
+
+
+(define (output-framework basename book scopes fields)
+ (let* ((paper (ly:paper-book-paper book))
+ (page-stencils (map page-stencil (ly:paper-book-pages book)))
+ (page-number (1- (ly:output-def-lookup paper 'first-page-number)))
+ (page-count (length page-stencils))
+ (filename "")
+ (file-suffix (lambda (num)
+ (if (= page-count 1) "" (format #f "-page-~a" num)))))
(for-each
(lambda (page)
(set! page-number (1+ page-number))
- (dump-page outputter page page-number page-count landscape? page-set?))
- page-stencils)
-
- (if page-set? (eo 'pageSet) "")
- (dump
- (string-append
- (ec 'g)
- (if page-set? (ec 'pageSet) "")
- (ec 'svg)))
-
- (ly:outputter-close outputter)
- ))
-
-(define (dump-page outputter page page-number page-count landscape? page-set?)
- (define (dump str) (display str (ly:outputter-port outputter)))
-
- (dump (comment (format "Page: ~S/~S" page-number page-count)))
- (if (or landscape? page-set?)
- (dump
- (if landscape?
- (eo 'page '(page-orientation . "270"))
- (eo 'page))))
-
- (dump (string-append (eo 'g )))
- (ly:outputter-dump-stencil outputter page)
- (dump (string-append (ec 'g)))
- (if (or landscape? page-set?)
- (dump (ec 'page))))
-
-(define (embed-font string)
- (let ((start (string-contains string "<defs>"))
- (end (string-contains string "</defs>")))
- (substring string (+ start 7) (- end 1))))
-
-(define (dump-fonts outputter paper)
- (let* ((fonts (ly:paper-fonts paper))
- (font-names (uniq-list (sort
- (filter string?
- (map ly:font-file-name fonts)) string<?)))
- (svgs (map
- (lambda (x)
- (let ((file-name (ly:find-file (string-append x ".svg"))))
- (if file-name (embed-font (cached-file-contents file-name))
- (begin (ly:warning "cannot find SVG font ~S" x) ""))))
- (filter string? font-names))))
- (entity 'defs (string-join svgs "\n"))))
+ (set! filename (format #f "~a~a.svg"
+ basename
+ (file-suffix page-number)))
+ (dump-page paper filename page page-number page-count))
+ page-stencils)))
+
+(define (output-preview-framework basename book scopes fields)
+ (let* ((paper (ly:paper-book-paper book))
+ (systems (relevant-book-systems book))
+ (to-dump-systems (relevant-dump-systems systems)))
+ (dump-preview paper
+ (stack-stencils Y DOWN 0.0
+ (map paper-system-stencil
+ (reverse to-dump-systems)))
+ (format #f "~a.preview.svg" basename))))
+(define (output-crop-framework basename book scopes fields)
+ (let* ((paper (ly:paper-book-paper book))
+ (systems (relevant-book-systems book))
+ (page-stencils (stack-stencils Y DOWN 0.0
+ (map paper-system-stencil
+ (reverse (reverse systems))))))
+ (dump-preview paper page-stencils (format #f "~a.cropped.svg" basename))))
projects / lilypond.git / blobdiff