Changes

Jump to navigation Jump to search
4,992 bytes removed ,  18:21, 25 January 2021
adapt to current working setup
< [[Graphics]] | [[Using Graphics]] >
[http://lilypond.org LilyPond] is a great music engraver, and you can include LilyPond in ConTeXt source using [[moduleshttps:t-lilypond|//github.com/adityam/filter the lilypond filter 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].)
== Deprecation Warning Simple Filter Setup ==
The LilyPond module doesn't work any more This works with recent versions ConTeXt MkII and MkIV, but takes only the first page of ConTeXt. You can simply replace it with multi-pages scores, and you must create the [http://modules.contextgarden.net/filter Filter module] like thisfolder "lilytemp" manually:
<texcode>
directory=lilytemp/, % directory for LilyPond's files
output={\externalfilterbasefile.pdf},
filtercommand={lilypond -dbackend=eps -dno-gs-load-fonts -dinclude-eps-fonts -ddelete-intermediate-files -o"lilytemp/\externalfilterbasefile" "\externalfilterinputfile"}]
</texcode>
You can't use <cmd>setuplilypond</cmd> any more== Multi Page Filter Setup == This uses Lua and therefore only works with ConTeXt MkIV. It includes all pages of multi-page scores.It doesn’t look into the complete (multi-page) PDF, but there is a better replacement: Collect your LilyPond settings in reads a "-system.ly count" auxiliary file, put it in your lilytemp directory written by LilyPond that contains the number of systems (pages) and include it from within your lilypond block like this:includes the single-system PDFs.
<texcode>
\startlilyponddef\include "mysettings.ly"...\stoplilypond<LILYTEMP{lilytemp} % name of folder for LilyPond/texcode>buffer files
Here's an example of placing score snippets in \def\ParseLilypondFile#1% #1 is the body name of the text, with fonts in the score & body matching:output file {\ctxlua{thirddata.parselilypondfile("#1")}}
<texcode>\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\unprotectstopluacode
\usemodule[filter]
\defineexternalfilter[lilypond]
[continue=yes,
cache=yes,
readcommand=\ParseLilypondFile,
directory=\LILYTEMP/,
output={\externalfilterbasefile.pdf},
filtercommand={lilypond -dbackend=eps -ddelete-intermediate-files -o"\LILYTEMP/\externalfilterbasefile/" "\externalfilterinputfile"},]
</texcode>
\traceexternalfilters
\defineexternalfilter [lilypond] [\c!output=\externalfilterbasefile.pdf, \c!filtercommand=\lilypondcommand, \c!continueLilyPond Settings =\v!yes, \c!readcommand=\readlilypondoutput, %\c!directory=output, ]
% frame=on is for testing\def\readlilypondoutput#1{\setupfloats[location=rightCollect your LilyPond settings in a .ly file,frame=off]\placefigure[]{From \sc{http://lsr.dsi.unimi.put it in your lilytemp directory and include it/LSR/Search?q=piano}}{\externalfigure[#1]}} \def\lilypondcommand% {from within your lilypond -dbackend=eps -dno-gs-load-fonts -dinclude-eps-fonts \externalfilterinputfile}\protect \setuplayout[textwidth=6in] % matches line-width below\usetypescript[palatino]\setupbodyfont[palatino,13pt] \starttext \input zapf block like this:
<texcode>
\startlilypond
\layout{ indent=0\mm ragged-right = ##f}\paper { myStaffSize = #20 #(define fonts (make-pango-font-tree include "palatinomysettings.ly" "palatino" "palatino" (/ myStaffSize 20))) line-width=6\in oddFooterMarkup=##f oddHeaderMarkup=##f bookTitleMarkup = ##f scoreTitleMarkup = ##f }global = { \key c \major \time 4/4} sopMusic = \relative c'' { c4 c c8[( b)] c4}sopWords = \lyricmode { hi hi hi hi} altoMusic = \relative c' { e4 f d e}altoWords =\lyricmode { ha ha ha ha} tenorMusic = \relative c' { g4 a f g}tenorWords = \lyricmode { hu hu hu hu} bassMusic = \relative c { c4 c g c}bassWords = \lyricmode { ho ho ho hø} \score { << \new ChoirStaff << \new Lyrics = "sopranos" \new Staff = "women" << \new Voice = "sopranos" { \voiceOne << \global \sopMusic >> } \new Voice = "altos" { \voiceTwo << \global \altoMusic >> } >> \new Lyrics = "altos" \new Lyrics = "tenors" \new Staff = "men" << \clef bass \new Voice = "tenors" { \voiceOne << \global \tenorMusic >> } \new Voice = "basses" { \voiceTwo << \global \bassMusic >> } >> \new Lyrics = "basses" \context Lyrics = "sopranos" \lyricsto "sopranos" \sopWords \context Lyrics = "altos" \lyricsto "altos" \altoWords \context Lyrics = "tenors" \lyricsto "tenors" \tenorWords \context Lyrics = "basses" \lyricsto "basses" \bassWords >> \new PianoStaff << \new Staff << \set Staff.printPartCombineTexts = ##f \partcombine << \global \sopMusic >> << \global \altoMusic >> >> \new Staff << \clef bass \set Staff.printPartCombineTexts = ##f \partcombine << \global \tenorMusic >> << \global \bassMusic >> >> >> >>}.
\stoplilypond
\input zapf
\stoptext
</texcode>
== Setup ==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:
* First you need a working, recent [http://www.lilypond.org LilyPond] installation (version 2.12.x) plus dependencies like GhostScript.
* Install the lilypond module via [[ConTeXt_Minimals#Installing_third_party_modules|ConTeXt minimals]], or get it from [[modules:t-lilypond|ConteXt garden]] or [http://github.com/fiee/ConTeXt/tree/master/t-lilypond/ github] and install it in one of your TeX trees.
* Include the lilypond module
<texcode>
\usemodulestartbuffer[lilypond::settings]\include "mysettings.ly"\stopbuffer \defineexternalfilter[lilypond][ ... bufferbefore={lilypond::settings}, ...]
</texcode>
* If you want, you can change the default settings using <tt>\setuplilypond</tt>
* If you need lyrics with accented characters (e.g. umlauts), you '''must''' typeset in UTF-8 encoding (see [[Encodings_and_Regimes]]), because LilyPond doesn't understand anything else. And you need to use UTF-8 without BOM (byte order marker), because ConTeXt doesn't understand BOMs.
* Versions from May 2009 on work with LuaTeX ''only.'' Supported is only the latest beta of MkIV.
=== options Sample Include File ==={| style="border: solid 1px black; padding: 0.5em; vertical-align: top; width: 80%;" |- style="border: solid 1px black; padding: 0.5em; vertical-align: top; background: #eeeeee;"! option !! values !! default !! meaning|-| staffsize || number (pt) || 20 || height of the staff|-| linewidth || measure || <cmd>localhsize</cmd> || width of the staff|-| betweensystemspace || measure || 54pt || space between systems|-| align || yes/no || depends on fragment || ragged-right = (not align)|-| indent || measure || 0pt || first line indent|-| time || yes/no || yes || count the time (i.e. show time signature, draw bars, split the staff)?|-| clef || yes/no || yes || show the clef?|-| fragment || yes/no || no || typeset only a snippet (instead of a whole line)?|-| barnumbers || yes/no || no || show measure numbers?|-| showempty || yes/no || no || drop empty staves?|-| seriffont || "name" || "Tex Gyre Schola" || serif font (e.g. for Lyrics and \markup; was Century Schoolbook L before)|-| sansfont || "name" || "LMSans10" || sans serif font (e.g. for chords)|-| monofont || "name" || "LMTypewriter10" || monospace font (normally not used)|-| tmpdir || "name" || "./lilytemp" || directory for temporary files (.tmp, .md5, .eps); gets created if not existant|-| imgdir || "name" || "./lilypdfs" || directory for LilyPond PDFs; gets created if not existant|}
== Snippets =="mysettings.ly" could look like this:
<texcode>
There are some notes \lilypond{ \relative{bes a c b} } embedded in this version "2.18.2"#(ly:set-option (quote no-point-and-click))#(set-global-staff-size 14) % --- start of setup for single-lineoutput files ---#(define default-toplevel-book-handler print-book-with-defaults-as-systems ) #(define toplevel-book-handler (lambda ( .rest) (set! output-empty-score-list #f)</texcode> (apply print-book-with-defaults rest)))
== Sections ==#(define toplevel-music-handler (lambda ( . rest) (apply collect-music-for-book rest)))
E.g#(define toplevel-score-handler (lambda ( . rest) (apply collect-scores-for a songbook you want to place big chunks of LilyPond output (i.e. note staffs-book rest))) in your text. It behaves like any other graphics, especially similar to embedded [[MetaPost]] code:
<texcode>#(define toplevel-text-handler\section{A Tune} (lambda ( . rest) (apply collect-scores-for-book rest)))
\startlilypond\relative { \repeat volta 2 { \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 | \partial 2. b2. | } \repeat volta 2 { \partial 4 r4 | f' g f d | e f e c | a b c d | e2. e4 | f g f8 e d4 | e f e c | a c b8 a g4 | } \alternative { { \partial 2. g2. } { \partial 2. a2. } }}\stoplilypond#(set! output-empty-score-list #t)
There's nothing to say about this tune yet; someone heard it from Lúnasa.</texcode>% --- stop single-line setup ---
<texcode>\sectionpaper {Starlight #(rounddefine 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}
\startlilypond<<\context Staff = onlyone <<layout { \clef treble#(layout-set-staff-size 14) % beware, this resets fonts! \key a \major% set fonts for rm / ss / tt \time 6#(define fonts (make-pango-font-tree "TeX Gyre Schola" "LMSans10" "LMTypewriter10 Regular" (/814 20))) \context Voice = one {\Score \relative cremove "Bar_number_engraver" \override PaperColumn #'' {keep-inside-line = ##t a4.^\markup{1. } e' | e8( d cis) b4. | % some example settings e4.^ \markupcontext {2.} d4 d8 |\Staff cis( b) a b4 e,8 | a4 a8 gis( a) b | \override TimeSignature #'style = #'numbered cis4 cis8 b( cis d) | cis( d) e e4 e,8 | fis4 fis8 gis4. } }>>\lyricsto one \new Lyrics context { \lyricmode {ChordNames Star -- light, star -- bright,chordChanges = ##t first star I see to -- night; I wish I may, I wish I might have the wish I wish to -- night.majorSevenSymbol = \markup{ 7+ }
}
}
>>
\stoplilypond
</texcode>
== Font hints ==Please look up the meaning of settings in [http://lilypond.org/doc/v2.22/Documentation/web/manuals LilyPond’s great documentation]!
If you’d like to exchange measures like text width between ConTeXt and LilyPond depends on the fonts that pango/fontconfig can find. But not even all of , you could write those will work, e.g. no fonts from into the TeX tree LilyPond buffer (don't know whysee below), only one face per font file etc.Therefore it doesn't use ConTeXt's font setup.
If To give LilyPond measures to ConTeXt, you want would need to know which fonts of your system LilyPond can see with which names, try lilypond -dshow-available-fonts anywrite them into a temp file (using Scheme) and read that in again (using Lua).(The 3rd parameter For the time being this is necessary, but can be anythingleft as an exercise to the user.;)
LilyPond's default Unfortunately you can’t define LilyPond’s text font is Century Schoolbook(lyrics) size with an absolute value, but only relative to staff size... You can use it in ConTeXt like this:
<texcode>\usetypescriptfile[type-otf]== Named Buffers ==
\starttypescript[wiki][songbook] \usetypescript [serif] [schoolbook] \definetypeface [songbook] [rm] [serif] [schola] [default] \definetypeface [songbook] [ss] [sans] [default][default] \definetypeface [songbook] [tt] [mono] [default][default]\stoptypescriptNormally, your LilyPond snippets just get a running number. If you re-order your scores, each one gets re-rendered.
\usetypescript [wiki] [songbook]\setupbodyfontYou can avoid that if you name your LilyPond snippets: just add <tt>[songbook, rm, 8.5ptname=myfunnyname]</texcodett>to {{cmd|startlilypond}}.
If you have just one LilyPond part per component (e.g. songs in a songbook), you could use <tt>[name== Current workarounds ==\currentcomponent]</tt>.
This section lists workarounds needed in some circumstances; we surely hope to move them to [[#Older_Workarounds|'''Older Workarounds''']] as soon as possible!== Automatical width adaption ==
=== Something (LilyPondIf you want to set your note line width automatically to your current text width, GhostScript etc.) isn't found ===try this:
Depending on your setup -- this goes after "create temp folder" io.savedata(path, installation directories"\LILYTEMP/texsettings.ly", "\\paper { line-width = " .. string.gsub(number.todimen(tex.dimen.textwidth),"pt","\\pt") you must call the lilypond app with the full path.. " } \n")
If and then adapt your snippets or preamble buffer:<tttexcode>pstopdf<\include "../tt> can't create PDFs (but LilyPond has made EPS files) it might be that you must set the environment variable <tt>GS_LIBmysettings.ly"\include "texsettings.ly"</tttexcode> for GhostScript.
=== LilyPond preYou must comment/delete the "line-2width" setting in mysettings.ly, otherwise it doesn’t work.12 ===
The module as of 2009-05-03 works only with LilyPond 2.12 (probably also with some versions of 2.11).== Example ==
For older versions of LilyPond please use Here's an older version example of placing score snippets in the module. 2008-09 fits LilyPond 2.10 === Typesetting fret diagrams === Lilypond has commands to typeset fret diagrams for body of the guitar chords. The most important one is called <code>\fret-diagram</code> and if you want to use ittext, you need to play a bit with the catcode of the <code>minus</code> sign since ConTeXt is apparently confused by this. In addition, you can't type the example found fonts in [http://lilypond.org/doc/v2.10/Documentation/user/lilypond/Overview-of-text-markup-commands#index-g_t_0040code_007bfret_002ddiagram_007d-935 the Lilypond documentation] on its own because Lilypond won't accept a score with only markup (the fret diagram) and nothing else; you have to place the markup on the page. All in all, something like this will work& body matching:
<texcode>
\usemodule[lilypond]def\starttext\catcode`\-=11LILYTEMP{lilytemp} % name of folder for LilyPond/buffer files
D chord:\def\ParseLilypondFile#1% #1 is the name of the output file {\blankctxlua{thirddata.parselilypondfile("#1")}}
\startlilypondstartluacoded'' ^ \markup thirddata = thirddata or { \fret-diagram #"s:0.75;f:1;6-x;5-x;4-o;3-2-1;2-3-3;1-2-2;" }\stoplilypond\catcode`\-=12
-- create temp folder if missing if not lfs.isdir("\LILYTEMP") then lfs.mkdir("\stoptextLILYTEMP")</texcode> end
If you find a real solution to the <code>catcode< function thirddata.parselilypondfile(name) -- include all systems (pages) -- name is like \LILYTEMP/code> problemmainfile-temp-lilypond-21.pdf logs.report("LILYPOND", please document it here"name='" .. name .. "'") local scname = string.gsub(name, '%.pdf$', '-systems.count') local syco = tonumber(io.loaddata(scname)) or report it to the list -- [[User:Arthur|Arthur]]0
for nr =1, syco do logs.report("LILYPOND","including system no." .. nr) context("\\setupfloats[location= Developerright,frame=off]\\placefigure[none]{}{\\externalfigure[" .. string.gsub(name, '%.pdf$', '-'s Corner ==.. nr) .. "]}") end end\stopluacode
For information how the integration works, please check the module code and its PDF version (both available from \usemodule[filter]\defineexternalfilter[modules:t-lilypond|LilyPond on Modules]]) [continue=yes, cache=yes, readcommand=\ParseLilypondFile, directory=\LILYTEMP/, output={\externalfilterbasefile. Unlike <tt>pdf}, filtercommand={lilypond-book<dbackend=eps -dinclude-eps-fonts -dno-gs-load-fonts -o"\LILYTEMP/tt> for LaTeX, the module does not use a precompiling step and thus can react to local width changes and the like, even if the LilyPond code is stored in a buffer.\externalfilterbasefile" "\externalfilterinputfile"}]
Known bugs: \setuplayout[textwidth=6in] % matches line-width below* LilyPond's EPS bounding box is sometimes a bit too small\definefontfeature[main][protrusion=quality, so sometimes the content is cropped. Perhaps call eps2eps or the like to fix that?expansion=quality]\definefontfamily[mainface][rm][Adobe Jenson Pro][features=main]\setupbodyfont[mainface,13pt]\setupalign[hz,hanging]
Things that have not been implemented yet include:* work with existing PDFs on systems where LilyPond isn't installed.* make lilypond call back on ConTeXt for included TeX (cf. [http://lsr.dsi.unimi.it/LSR/Item?id=107])* get information from LilyPond about the baseline, for run-in music fragments* tell LilyPond how much space is left on the first page* check and probably work on proper multi-page music* it's not possible to set variables in LilyPond* lots of features\starttext
To remember:* see [http://lilypond.org/doc/v2.12/Documentation/ LilyPond Docs]!\input zapf
--[[User:ChristopherCreutzig|Christopher Creutzig]] after ideas by [[User:Hraban|Hraban]]\startlilypond
\layout{ indent=0\mm ragged-right = Older Workarounds ##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
'''Beware: These relate to the old version of the module and older versions of LilyPond (earlier than 2.7)! Nowadays, LilyPond and epstopdf get called via texmfstart, that works without patching!''' a b c d}
text === Fonts with ConTeXt MkII ===\lyricmode {Aaa Bee Cee Dee}
For the latest versions of the module work with ConTeXt MkIV (LuaTeX) exclusively, so we moved this to "Older":upper = \relative c'' { \clef treble \key c \major \time 2/4
<texcode> a4 b c d\starttypescript[wiki][songbook]\usetypescript [serif] [schoolbook] [\defaultencoding]\definetypeface [songbook] [rm] [serif] [schoolbook] [default] [encoding=\defaultencoding]\definetypeface [songbook] [ss] [sans] [default][default] [encoding=ec]\definetypeface [songbook] [tt] [mono] [default][default] [encoding=ec]\stoptypescript}
lower = \usetypescript [wiki] [songbook]relative c { \setupbodyfont[songbook, rm, 8.5pt]clef bass< \key c \major \time 2/texcode>4
=== LilyPond is not found === a2 c}
Calling lilypond from command line in Windows fails.\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 } }}
You have two options:\stoplilypond* 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).* place a <code>lilypond.bat</code> somewhere in your search path, calling c:/prog/lilypond/usr/bin/lilypond %1 %2 %3 %4 %5 %6 %7 %8 %9\input tufte
Calling lilypond from ConTeXt via shell exit (write18) in MacOS X also fails, even if the shell's path is right. (Seems more like write18 wouldn't use the environment.) Modify the module (try <tt>which lilypond\stoptext</tttexcode> to get its path).
LilyPond 2.7.26 comes without a command line "version", at least in the MacOS X edition, i.e. the <tt>lilypond.sh</tt> script is missing.Here's it's relevant content:  #!/bin/sh ## where was the app installed? INSTALLDIR=/Applications if [ "$1" =Too many open files = "--print-appdir" ]; then echo "$INSTALLDIR/LilyPond.app/" exit 0 fi # where to put the output export LILYPOND_DESTDIR=`pwd` # run the program python "$INSTALLDIR/LilyPond.app/Contents/Resources/lilycall.py" \ "$INSTALLDIR/LilyPond.app/" $@
Save this as <tt>lilypond.sh</tt>, make it executable With bigger projects and symlink it the above setup you might run into a directory on your path"too many open files" errors, at least in older Linux, e.gOSX and other Unix-like OSes. chmod a+x lilypond.sh sudo ln -s lilypond.sh /usr/local/bin/lilypondAsk your shell about the open files maximum and set it higher:
=== LilyPond stops with an 'Unbound variable' error === $ ulimit -n 256 $ ulimit -S -n 2048
The [http://modules.contextgarden.net/t-lilypond LilyPond module] as of 2005-09-12 uses some commands in its header that work only with LilyPond 2.6 (at least no more with 2.7.25); replace "ly:parser-print-score" with "print-score-with-defaults" and "ly:music-scorify" with "scorify-music" for LilyPond 2.7 series.
[[Category:Modules]]
[[Category:Requests]]

Navigation menu