scm/framework-ps.scm

   1 ;;;; framework-ps.scm --
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c) 2004--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   6
   7 (define-module (scm framework-ps))
   8
   9 ;;; this is still too big a mess.
  10
  11 (use-modules (ice-9 regex)
  12              (ice-9 string-fun)
  13              (ice-9 format)
  14              (guile)
  15              (srfi srfi-1)
  16              (srfi srfi-13)
  17              (lily))
  18
  19 (define framework-ps-module (current-module))
  20
  21 ;;(define pdebug stderr)
  22 (define (pdebug . rest) #f)
  23
  24 (define mm-to-bigpoint
  25   (/ 72 25.4))
  26
  27
  28 (define-public (ps-font-command font)
  29   (let* ((name (munge-lily-font-name (ly:font-file-name font)))
  30          (magnify (ly:font-magnification font)))
  31
  32     (string-append
  33      "magfont"
  34      (string-regexp-substitute "[ /%]" "_" name)
  35      "m" (string-encode-integer (inexact->exact (round (* 1000 magnify)))))))
  36
  37 (define (tex-font? fontname)
  38   (or
  39    (equal? (substring fontname 0 2) "cm")
  40    (equal? (substring fontname 0 2) "ec")))
  41
  42
  43 (define (define-fonts paper)
  44   (define font-list (ly:paper-fonts paper))
  45   (define (define-font command fontname scaling)
  46     (string-append
  47      "/" command " { /" fontname " findfont "
  48      (ly:number->string scaling) " output-scale div scalefont } bind def\n"))
  49
  50   (define (standard-tex-font? x)
  51     (or (equal? (substring x 0 2) "ms")
  52         (equal? (substring x 0 2) "cm")))
  53
  54   (define (font-load-command font)
  55     (let* ((specced-font-name (ly:font-name font))
  56            (fontname (if specced-font-name
  57                          (munge-lily-font-name specced-font-name)
  58                          (ly:font-file-name font)))
  59            (command (ps-font-command font))
  60
  61            ;; FIXME -- see (ps-font-command )
  62            (plain (ps-font-command font))
  63            (designsize (ly:font-design-size font))
  64            (magnification (* (ly:font-magnification font)))
  65            (ops (ly:output-def-lookup paper 'outputscale))
  66            (scaling (* ops magnification designsize)))
  67
  68       ;; Bluesky pfbs have UPCASE names (sigh.)
  69       ;; FIXME - don't support Bluesky?
  70       (if (standard-tex-font? fontname)
  71           (set! fontname (string-upcase fontname)))
  72       (if (equal? fontname "unknown")
  73           (display (list font fontname)))
  74       (define-font plain fontname scaling)))
  75
  76
  77   (apply string-append
  78          (map (lambda (x) (font-load-command x))
  79               (filter (lambda (x) (not (ly:pango-font? x)))
  80                       font-list))))
  81
  82 ;; FIXME: duplicated in other output backends
  83 ;; FIXME: silly interface name
  84 (define (output-variables layout)
  85   ;; FIXME: duplicates output-layout's scope-entry->string, mostly
  86   (define (value->string  val)
  87     (cond
  88      ((string? val) (string-append "(" val ")"))
  89      ((symbol? val) (symbol->string val))
  90      ((number? val) (number->string val))
  91      (else "")))
  92
  93   (define (output-entry ps-key ly-key)
  94     (string-append
  95      "/" ps-key " "
  96      (value->string (ly:output-def-lookup layout ly-key)) " def\n"))
  97
  98   (string-append
  99    "/lily-output-units "
 100      (number->string mm-to-bigpoint)
 101      " def %% millimeter\n"
 102    (output-entry "staff-line-thickness" 'linethickness)
 103    (output-entry "line-width" 'linewidth)
 104    (output-entry "paper-size" 'papersizename)
 105    (output-entry "staff-height" 'staffheight)   ;junkme.
 106    "/output-scale "
 107      (number->string (ly:output-def-lookup layout 'outputscale))
 108      " def\n"
 109    (output-entry "page-height" 'vsize)
 110    (output-entry "page-width" 'hsize)))
 111
 112 (define (dump-page outputter page page-number page-count landscape?)
 113   (ly:outputter-dump-string
 114    outputter
 115    (string-append
 116     "%%Page: "
 117     (number->string page-number) " " (number->string page-count) "\n"
 118
 119     "%%BeginPageSetup\n"
 120     (if landscape?
 121         "page-width output-scale lily-output-units mul mul 0 translate 90 rotate\n"
 122         "")
 123     "%%EndPageSetup\n"
 124
 125     "start-page { "
 126     "set-ps-scale-to-lily-scale "
 127     "\n"))
 128   (ly:outputter-dump-stencil outputter page)
 129   (ly:outputter-dump-string outputter "} stop-system \nshowpage\n"))
 130
 131 (define (supplies-or-needs paper load-fonts?)
 132   (define (extract-names font)
 133     (if (ly:pango-font? font)
 134         (map car (ly:pango-font-physical-fonts font))
 135         (list (munge-lily-font-name (ly:font-name font)))))
 136
 137   (let* ((fonts (ly:paper-fonts paper))
 138          (names (apply append (map extract-names fonts))))
 139
 140     (apply string-append
 141            (map (lambda (f)
 142                   (format
 143                    (if load-fonts?
 144                     "%%DocumentSuppliedResources: font ~a\n"
 145                     "%%DocumentNeededResources: font ~a\n")
 146                    f))
 147                 (uniq-list (sort names string<?))))))
 148
 149 (define (eps-header paper bbox load-fonts?)
 150   (string-append "%!PS-Adobe-2.0 EPSF-2.0\n"
 151                  "%%Creator: LilyPond\n"
 152                  "%%BoundingBox: "
 153                  (string-join (map ly:number->string bbox) " ") "\n"
 154                  "%%Orientation: "
 155                  (if (eq? (ly:output-def-lookup paper 'landscape) #t)
 156                      "Landscape\n"
 157                      "Portrait\n")
 158                  (supplies-or-needs paper load-fonts?)
 159                  "%%EndComments\n"))
 160
 161 (define (page-header paper page-count load-fonts?)
 162   (string-append "%!PS-Adobe-3.0\n"
 163                  "%%Creator: LilyPond\n"
 164                  "%%Pages: " (number->string page-count) "\n"
 165                  "%%PageOrder: Ascend\n"
 166                  "%%Orientation: "
 167                  (if (eq? (ly:output-def-lookup paper 'landscape) #t)
 168                      "Landscape\n"
 169                      "Portrait\n")
 170                  "%%DocumentPaperSizes: "
 171                  (ly:output-def-lookup paper 'papersizename) "\n"
 172                  (supplies-or-needs paper load-fonts?)
 173                  "%%EndComments\n"))
 174
 175 (define (procset file-name)
 176   (string-append
 177    (format
 178     "%%BeginResource: procset (~a) 1 0
 179 ~a
 180 %%EndResource
 181 "
 182     file-name (cached-file-contents file-name))))
 183
 184 (define (setup paper)
 185   (string-append
 186    "\n"
 187    "%%BeginSetup\n"
 188    (define-fonts paper)
 189    (output-variables paper)
 190    "%%EndSetup\n"))
 191
 192 (define-public (munge-lily-font-name name)
 193   (regexp-substitute/global #f "([eE]mmentaler|[aA]ybabtu)"
 194                             name 'pre "PFA" 1 'post))
 195
 196 (define (cff-font? font)
 197   (let*
 198       ((cff-string  (ly:otf-font-table-data font "CFF ")))
 199     (> (string-length cff-string) 0)))
 200
 201 (define-public (ps-embed-cff body font-set-name version)
 202   (let* ((binary-data
 203           (string-append
 204            (format "/~a ~s StartData " font-set-name (string-length body))
 205            body))
 206
 207          (header
 208           (format
 209            "%%BeginResource: font ~a
 210 %!PS-Adobe-3.0 Resource-FontSet
 211 %%DocumentNeededResources: ProcSet (FontSetInit)
 212 %%Title: (FontSet/~a)
 213 %%Version: ~s
 214 %%EndComments
 215 %%IncludeResource: ProcSet (FontSetInit)
 216 %%BeginResource: FontSet (~a)
 217 /FontSetInit /ProcSet findresource begin
 218 %%BeginData: ~s Binary Bytes
 219 "
 220            font-set-name font-set-name version font-set-name
 221            (string-length binary-data)))
 222          (footer "\n%%EndData
 223 %%EndResource
 224 %%EOF
 225 %%EndResource\n"))
 226
 227     (string-append
 228      header
 229      binary-data
 230      footer)))
 231
 232
 233 (define (write-preamble paper load-fonts? port)
 234
 235   (define (load-font-via-GS font-name-filename)
 236     (define (ps-load-file name)
 237       (format "(~a) (r) file .loadfont " name))
 238
 239     (let* ((font (car font-name-filename))
 240            (name (cadr font-name-filename))
 241            (file-name (caddr font-name-filename))
 242            (bare-file-name (ly:find-file file-name)))
 243
 244       (cons
 245        (munge-lily-font-name name)
 246        (cond
 247         ((string-match "([eE]mmentaler|[Aa]ybabtu)" file-name)
 248          (ps-load-file (ly:find-file (format "~a.pfa" (munge-lily-font-name file-name)))))
 249         ((string? bare-file-name)
 250          (ps-load-file (munge-lily-font-name file-name)))
 251         (else
 252          (ly:warning (_ "don't know how to embed ~S=~S") name file-name)
 253           ""))
 254        )))
 255
 256   (define (load-font font-name-filename)
 257     (let* ((font (car font-name-filename))
 258            (name (cadr font-name-filename))
 259            (file-name (caddr font-name-filename))
 260            (bare-file-name (ly:find-file file-name)))
 261
 262       (cons
 263        (munge-lily-font-name name)
 264        (cond
 265         ((and bare-file-name (string-match "\\.pfa" bare-file-name))
 266          (cached-file-contents bare-file-name))
 267         ((and bare-file-name (string-match "\\.pfb" bare-file-name))
 268          (ly:pfb->pfa bare-file-name))
 269         ((and bare-file-name (string-match "\\.ttf" bare-file-name))
 270          (ly:ttf->pfa bare-file-name))
 271
 272         ((string-match "([eE]mmentaler|[Aa]ybabtu)" file-name)
 273          (cached-file-contents
 274           (format "~a.pfa" (munge-lily-font-name file-name))))
 275
 276         ((and bare-file-name (string-match "\\.otf" bare-file-name))
 277          (ps-embed-cff (ly:otf->cff bare-file-name) name 0))
 278
 279         ((and bare-file-name (string-match "\\.ttf" bare-file-name))
 280          (ly:ttf->pfa bare-file-name))
 281
 282         ((and font (cff-font? font))
 283          (ps-embed-cff (ly:otf-font-table-data font "CFF ")
 284                        name
 285                        0))
 286         (else
 287          (ly:warning (_ "don't know how to embed ~S=~S") name file-name)
 288           ""))
 289        )))
 290
 291   (define (load-fonts paper)
 292     (let* ((fonts (ly:paper-fonts paper))
 293
 294            (all-font-names
 295             (map
 296              (lambda (font)
 297                (cond
 298                 ((string? (ly:font-file-name font))
 299                  (list (list
 300                         font
 301                         (ly:font-name font)
 302                         (ly:font-file-name font))))
 303                 ((ly:pango-font? font)
 304                  (map
 305                   (lambda (name-psname-pair)
 306                     (list #f
 307                           (car name-psname-pair)
 308                           (cdr name-psname-pair)))
 309                    (ly:pango-font-physical-fonts font)))
 310                 (else
 311                  (ly:font-sub-fonts font))))
 312
 313              fonts))
 314            (font-names
 315             (uniq-list
 316              (sort (apply append all-font-names)
 317                    (lambda (x y) (string<? (cadr x) (cadr y))))))
 318
 319            (pfas (map load-font font-names)))
 320       pfas))
 321
 322   (if load-fonts?
 323       (for-each
 324        (lambda (f)
 325          (format port "\n%%BeginFont: ~a\n" (car f))
 326          (display (cdr f) port)
 327          (display "\n%%EndFont\n" port))
 328        (load-fonts paper)))
 329
 330   (display (setup paper) port)
 331
 332   ; adobe note 5002: should initialize variables before loading routines.
 333   (display (procset "music-drawing-routines.ps") port)
 334   (display (procset "lilyponddefs.ps") port)
 335   (display "init-lilypond-parameters\n" port)
 336
 337   )
 338
 339 (define-public (output-framework basename book scopes fields)
 340   (let* ((filename (format "~a.ps" basename))
 341          (outputter  (ly:make-paper-outputter filename "ps"))
 342          (paper (ly:paper-book-paper book))
 343          (pages (ly:paper-book-pages book))
 344          (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
 345          (page-number (1- (ly:output-def-lookup paper 'firstpagenumber)))
 346          (page-count (length pages))
 347          (port (ly:outputter-port outputter)))
 348
 349     (output-scopes scopes fields basename)
 350     (display (page-header paper page-count #t) port)
 351     (write-preamble paper #t  port)
 352
 353     (for-each
 354      (lambda (page)
 355        (set! page-number (1+ page-number))
 356        (dump-page outputter page page-number page-count landscape?))
 357      pages)
 358
 359     (display "%%Trailer\n%%EOF\n" port)
 360     (ly:outputter-close outputter)
 361     (postprocess-output book framework-ps-module filename
 362                          (completize-formats (ly:output-formats)))))
 363
 364 (if (not (defined? 'nan?))
 365     (define (nan? x) #f))
 366
 367 (if (not (defined? 'inf?))
 368     (define (inf? x) #f))
 369
 370 (define-public (dump-stencil-as-EPS paper dump-me filename load-fonts?)
 371   (define (mm-to-bp-box mmbox)
 372     (let* ((scale  (ly:output-def-lookup paper 'outputscale))
 373            (box (map
 374                  (lambda (x)
 375                    (inexact->exact
 376                     (round (* x scale mm-to-bigpoint)))) mmbox)))
 377
 378     (list (car box) (cadr box)
 379           (max (1+ (car box)) (caddr box))
 380           (max (1+ (cadr box)) (cadddr box)))))
 381
 382   (let* ((outputter (ly:make-paper-outputter (format "~a.eps" filename) "ps"))
 383          (port (ly:outputter-port outputter))
 384          (xext (ly:stencil-extent dump-me X))
 385          (yext (ly:stencil-extent dump-me Y))
 386          (bbox
 387           (map
 388            (lambda (x)
 389              (if (or (nan? x) (inf? x))
 390                  0.0 x))
 391            (list (car xext) (car yext)
 392                (cdr xext) (cdr yext))))
 393          (rounded-bbox (mm-to-bp-box bbox))
 394          (port (ly:outputter-port outputter))
 395          (header (eps-header paper rounded-bbox load-fonts?)))
 396
 397     (display header port)
 398     (write-preamble paper load-fonts? port)
 399     (display "start-system { set-ps-scale-to-lily-scale \n" port)
 400     (ly:outputter-dump-stencil outputter dump-me)
 401     (display "} stop-system\n%%Trailer\n%%EOF\n" port)
 402     (ly:outputter-close outputter)))
 403
 404
 405 (define-public (output-preview-framework basename book scopes fields)
 406
 407   (let* ((paper (ly:paper-book-paper book))
 408          (systems (ly:paper-book-systems book))
 409          (scale (ly:output-def-lookup paper 'outputscale))
 410          (to-dump-systems '())
 411          )
 412
 413
 414
 415     ;; skip booktitles.
 416     (if (and
 417          (not
 418           (cdr (assoc
 419                'preview-include-book-title
 420                (ly:get-option 'command-line-settings)
 421                )))
 422          (< 1 (length systems))
 423          (ly:paper-system-title? (list-ref systems 0))
 424          (ly:paper-system-title? (list-ref systems 1)))
 425         (set! systems (cdr systems)))
 426
 427     (for-each
 428      (lambda (sys)
 429        (if (or
 430             (ly:paper-system-title? sys)
 431             (not (pair? to-dump-systems))
 432             (ly:paper-system-title? (car to-dump-systems)))
 433            (set! to-dump-systems (cons sys to-dump-systems))))
 434      systems)
 435
 436     (dump-stencil-as-EPS
 437      paper
 438      (stack-stencils Y DOWN 0.0
 439                      (map ly:paper-system-stencil (reverse to-dump-systems)))
 440      (format "~a.preview" basename)
 441      #t)
 442
 443     (postprocess-output book framework-ps-module
 444                         (format "~a.preview.eps" basename)
 445                         (completize-formats (cons "png" (ly:output-formats))))
 446
 447     ))
 448 (if #f
 449     (define-public (output-preview-framework basename book scopes fields)
 450
 451       (let* ((paper (ly:paper-book-paper book))
 452              (systems (ly:paper-book-systems book))
 453              (scale (ly:output-def-lookup paper 'outputscale))
 454              (titles (take-while ly:paper-system-title? systems))
 455              (non-title (find (lambda (x)
 456                                 (not (ly:paper-system-title? x))) systems))
 457              (dump-me
 458               (stack-stencils Y DOWN 0.0
 459                               (map ly:paper-system-stencil
 460                                    (append titles (list non-title))))))
 461         (output-scopes scopes fields basename)
 462         (dump-stencil-as-EPS paper dump-me
 463                              (format "~a.preview" basename)
 464                              #t)
 465
 466         (postprocess-output book framework-ps-module
 467                             (format "~a.preview.eps" basename)
 468                             (completize-formats (ly:output-formats)))
 469
 470         ))
 471     )
 472 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 473
 474 (define-public (convert-to-pdf book name)
 475   (let* ((defs (ly:paper-book-paper book))
 476          (papersizename (ly:output-def-lookup defs 'papersizename)))
 477
 478     (if (equal? (basename name ".ps") "-")
 479         (ly:warning (_ "can't convert <stdout> to ~S" "PDF"))
 480         (postscript->pdf (if (string? papersizename) papersizename "a4")
 481                          name))))
 482
 483 (define-public (convert-to-png book name)
 484   (let* ((defs (ly:paper-book-paper book))
 485          (defs-resolution (ly:output-def-lookup defs 'pngresolution))
 486          (resolution (if (number? defs-resolution)
 487                          defs-resolution
 488                          (cdr (assoc 'resolution
 489                                 (ly:get-option 'command-line-settings)))))
 490          (papersizename (ly:output-def-lookup defs 'papersizename)))
 491
 492     (postscript->png resolution
 493                      (if (string? papersizename)
 494                          papersizename "a4")
 495
 496                      name)))
 497
 498 (define-public (convert-to-dvi book name)
 499   (ly:warning (_ "can't generate ~S using the postscript back-end") "DVI"))
 500
 501 (define-public (convert-to-tex book name)
 502   (ly:warning (_ "can't generate ~S using the postscript back-end") "TeX"))
 503
 504 (define-public (convert-to-ps book name)
 505   #t)