Changes

Jump to navigation Jump to search
6,227 bytes added ,  14:39, 5 February 2023
updates for LilyPond 2.24
< [[Graphics]] | [[Using Graphics]] > ((Please leave this page orphaned until LilyPond integration is ready!))
[http://www.lilypond.org LilyPond] is a great music engraver, and this page is for future you can include LilyPond integration in ConTeXtsource using [https://github. At com/adityam/filter the moment you can use LilyPond's PDFs as graphics just finefilter module] with some setup. This is different from using the lilypond-book preprocessor with LaTeX. (For LaTeX there’s also a package that works similar to our ConTeXt setup here: [https://github.com/jperon/lyluatex lyluatex].)
== Simple Filter Setup ==
* First This works with ConTeXt MkII and MkIV, but takes only the first page of multi-pages scores, and you need a working [httpmust create the folder "lilytemp" manually://www.lilypond.org LilyPond] installation plus dependencies like GhostScript.* see <cmd>setupLilyPond</cmd>
<texcode>\def\readPDFfile#1{\externalfigure[#1]} \usemodule[filter]\defineexternalfilter[lilypond] [continue=yes, readcommand= Snippets \readPDFfile, directory=lilytemp/, % directory for LilyPond's files output={\externalfilterbasefile.pdf}, filtercommand={lilypond -dtall-page-formats=pdf -dseparate-page-formats=pdf -o"lilytemp/\externalfilterbasefile" "\externalfilterinputfile"}]</texcode> == Multi Page Filter Setup == This uses Lua and therefore only works with ConTeXt MkIV and up. It includes all pages of multi-page scores.It doesn’t look into the complete (multi-page) PDF, but reads a "-system.count" auxiliary file written by LilyPond that contains the number of systems (pages) and includes the single-system PDFs. <texcode>\def\LILYTEMP{lilytemp} % name of folder for LilyPond/buffer files \def\ParseLilypondFile#1% #1 is the name of the output file {\ctxlua{thirddata.parselilypondfile("#1")}} \startluacode thirddata = thirddata or {} -- create temp folder if missing if not lfs.isdir("\LILYTEMP") then lfs.mkdir("\LILYTEMP") end function thirddata.parselilypondfile(name) -- include all systems (pages) -- name is like \LILYTEMP/mainfile-temp-lilypond-21.pdf logs.report("LILYPOND","name='" .. name .. "'") local scname = string.gsub(name, '%.pdf$', '-systems.count') local syco = tonumber(io.loaddata(scname)) or 0 for nr = 1, syco do logs.report("LILYPOND","including system no." .. nr) context("\\externalfigure[" .. string.gsub(name, '%.pdf$', '-' .. nr) .. "]") end end\stopluacode \usemodule[filter]\defineexternalfilter[lilypond] [continue=yes, cache=yes, readcommand=\ParseLilypondFile, directory=\LILYTEMP/, output={\externalfilterbasefile.pdf}, filtercommand={lilypond -dtall-page-formats=pdf -dseparate-page-formats=pdf -daux-files -o"\LILYTEMP/\externalfilterbasefile/" "\externalfilterinputfile"},]</texcode>  == LilyPond Settings == Collect your LilyPond settings in a .ly file, put it in your lilytemp directory and include it from within your lilypond block like this: <texcode>\startlilypond\include "mysettings.ly"...\stoplilypond</texcode> You can avoid this \include line following [http://modules.contextgarden.net/dl/t-filter/doc/context/third/filter/filter.txt filter module documentation], section "Prepend and append text".In short: you can inline your complete LilyPond settings or at least the include line:
<texcode>
There are some notes \LilyPond{ startbuffer[lilypond::settings]\include "mysettings.ly"\stopbuffer \relativedefineexternalfilter[lilypond][ ... bufferbefore={bes a c blilypond::settings} } embedded in this line, ...]
</texcode>
== Sections = Sample Include File ===
E"mysettings.g. for a songbook you want to place big chunks of LilyPond output (i.e. note staffs) in your text. It behaves ly" could look like any other graphics, especially similar to embedded [[Metapost|MetaPost]] codethis:
<texcode>
\sectionversion "2.24.0"#(ly:set-option (quote no-point-and-click))#(set-global-staff-size 14) % --- start of setup for single-line output files ---% from lilypond-book-preamble.ly#(define default-toplevel-book-handler print-book-with-defaults-as-systems ) #(define toplevel-book-handler (lambda ( . rest) (set! output-empty-score-list #f) (apply print-book-with-defaults rest))) #(define toplevel-music-handler (lambda ( . rest) (apply collect-music-for-book rest))) #(define toplevel-score-handler (lambda ( . rest) (apply collect-scores-for-book rest))) #(define toplevel-text-handler (lambda ( . rest) (apply collect-scores-for-book rest))) #(set! output-empty-score-list #t) % --- stop single-line setup --- \paper {A Tune #(define dump-extents #t) indent = 0\mm ragged-bottom = ##t ragged-last-bottom = ##t print-page-number = ##f line-width = 120\mm oddFooterMarkup = ##f oddHeaderMarkup = ##f bookTitleMarkup = ##f scoreTitleMarkup = ##f}
\startLilyPondlayout { #(layout-set-staff-size 14) % beware, this resets fonts!\relative { % set fonts for rm / ss / tt #(define fonts (make-pango-font-tree "TeX Gyre Schola" "LMSans10" "LMTypewriter10 Regular" (/ 14 20))) \repeat volta 2 context {\Score \partial 4 e4 | a2 c4 d | e2 f4 e | d2. c4 | b4. c8 d4 e | a,2 c4 d | e2 f4 e | g,2 a |remove "Bar_number_engraver" \partial 2. b2. |override PaperColumn #'keep-inside-line = ##t } % some example settings \repeat volta 2 context {\Staff \partial 4 r4 | foverride TimeSignature #'style = #' g f d | e f e c | a b c d | e2. e4 | f g f8 e d4 | e f e c |numbered a c b8 a g4 | } \alternative context {\ChordNames { \partial 2. g2. }chordChanges = ##t majorSevenSymbol = \markup{ \partial 2. a2. 7+ }
}
}
\stopLilyPond</texcode>
There's nothing Please look up the meaning of settings in [http://lilypond.org/doc/v2.24/Documentation/web/manuals LilyPond’s great documentation]! If you’d like to say about exchange measures like text width between ConTeXt and LilyPond, you could write those into the LilyPond buffer (see below). To give LilyPond measures to ConTeXt, you would need to write them into a temp file (using Scheme) and read that in again (using Lua).For the time being this tune yetis left as an exercise to the user. ; my friend heard it from Lúnasa) Unfortunately you can’t define LilyPond’s text (lyrics) size with an absolute value, but only relative to staff size. == Named Buffers == Normally, your LilyPond snippets just get a running number. If you re-order your scores, each one gets re-rendered. You can avoid that if you name your LilyPond snippets: just add <tt>[name=myfunnyname]</tt> to {{cmd|startlilypond}}. If you have just one LilyPond part per component (e.g. songs in a songbook), you could use <tt>[name=\currentcomponent]</tt>. == Automatical width adaption == If you want to set your note line width automatically to your current text width, try this:  -- this goes after "create temp folder" io.savedata("\LILYTEMP/texsettings.ly", "\\paper { line-width = " .. string.gsub(number.todimen(tex.dimen.textwidth),"pt","\\pt") .. " } \n") and then adapt your snippets or preamble buffer:<texcode>\include "../mysettings.ly"\include "texsettings.ly"
</texcode>
You must comment/delete the "line-width" setting in mysettings.ly, otherwise it won’t work. == DeveloperExample == Here's Corner ==an example of placing score snippets in the body of the text, with fonts in the score & body matching: <texcode>\def\LILYTEMP{lilytemp} % name of folder for LilyPond/buffer files
I need to figure out how LilyPond's LaTeX integration in <tt>lilypond-book</tt> works. It \def\ParseLilypondFile#1% #1 is a different approach: LilyPond preprocesses the LaTeX code, replaces LilyPond code with images and runs LaTeX. Instead with ConTeXt, texexec would do this preprocessing step, avoiding name of the need to run different programs yourselfoutput file {\ctxlua{thirddata.I guess I can copy the needed setup parselilypondfile(LilyPond stub file"#1") from <tt>lilypond-book</tt> (a messy Python script).}}
I don't yet know how to prepare <cmd>setupLilyPond</cmd>. It should be able to:\startluacode* set the text font (default should be ConTeXt's bodyfont instead of LilyPond's)* set line width* set staff and text size* access most other layout parameters thirddata = thirddata or {}
LilyPond uses fontconfig for font search -- create temp folder if missing if not lfs.isdir("\LILYTEMP") then lfs.mkdir("\LILYTEMP") end  function thirddata.parselilypondfile(name) -- include all systems (pages) -- name is like \LILYTEMP/mainfile-temp-lilypond-21.pdf logs.report("LILYPOND","name='" .. name .. "'") local scname = string.gsub(name, '%. At least on MacOS X itpdf$', 's very restricted what kind of fonts it can use - only single-style TrueType systems.count') local syco = tonumber(io.loaddata(scname)) or 0  for nr = 1, syco do logs.report("LILYPOND","including dfontsystem no." .. nr) context("\\setupfloats[location=right,frame=off]\\placefigure[none]{}{\\externalfigure[" .. string. I didngsub(name, 't manage yet to use fonts from the TeX tree%. (That doesnpdf$'t seem to be fontconfig, 's fault - it writes appropriate font ' .. nr) .. "]}") end end\stopluacode \usemodule[filter]\defineexternalfilter[lilypond] [continue=yes, cache =yes, readcommand=\ParseLilypondFile, directory=\LILYTEMP/, output={\externalfilterbasefile.pdf}, filtercommand={lilypond -dtall-page-formats=pdf -dseparate-page-formats=pdf -daux-files everywhere.-o"\LILYTEMP/\externalfilterbasefile" "\externalfilterinputfile"}] \setuplayout[textwidth=6in] % matches line-width below\definefontfeature[main][protrusion=quality, expansion=quality]\definefontfamily[mainface][rm][Adobe Jenson Pro][features=main]\setupbodyfont[mainface,13pt]\setupalign[hz,hanging] \starttext \input zapf \startlilypond \layout{ indent=0\mm ragged-right = ##f}\paper {myStaffSize = #20 #(define fonts (make-pango-font-tree "Adobe Jenson Pro" "Myriad Pro" "Myriad Pro"(/ myStaffSize 20)))line-width=6\in oddFooterMarkup=##f oddHeaderMarkup=##f bookTitleMarkup = ##f scoreTitleMarkup = ##f }melody = \relative c'' { \clef treble \key c \major \time 4/4  a b c d} text = \lyricmode {Aaa Bee Cee Dee} upper = \relative c'' { \clef treble \key c \major \time 2/4  a4 b c d} lower = \relative c { \clef bass \key c \major \time 2/4  a2 c} \score { << \new Voice = "mel" { \autoBeamOff \melody } \new Lyrics \lyricsto mel \text \new PianoStaff << \new Staff = "upper" \upper \new Staff = "lower" \lower >> >> \layout { \context { \Staff \RemoveEmptyStaves } }} \stoplilypond\input tufte \stoptext</texcode>
To remember:* see [http://lilypond.org/doc/v2.7/Documentation/out-www/ LilyPond Docs]!* How do we handle version/syntax changes of LilyPond?* !! How do we get clean PDFs (EPS for DVI mode), without anything around the staffs? Is lilypond-book's setup enough?== Too many open files ==
With bigger projects and the above setup you might run into "too many open files" errors, at least in older Linux, OSX and other Unix--[[Userlike OSes.Ask your shell about the open files maximum and set it higher:Hraban|Hraban]] 2005-08-20
== Workarounds == $ ulimit -n 256 $ ulimit -S -n 2048
Calling lilypond from command line in Windows fails. (Seems like a bug in lilypond.) You have to modify the module, so that lilypond is called with the whole path (<code>C:/prog/lilypond/usr/bin/lilypond</code> for example instead of <code>lilypond</code> alone).
[[Category:Modules]]
[[Category:Music]]
[[Category:Requests]]

Navigation menu