gardener, Interface administrators, Administrators
1,540
edits
Changes
Jump to navigation
Jump to search
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:
You can't use == 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 reads a "-system.count" auxiliary file written by LilyPond that contains the number of systems (pages) and includes the single-system PDFs. <cmdtexcode>setuplilypond\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 -dbackend=eps -ddelete-intermediate-files -o"\LILYTEMP/\externalfilterbasefile/" "\externalfilterinputfile"},]</cmdtexcode> any more, but there is a better replacement: == 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:
Here's an example of placing score snippets in the body of the 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, with fonts in ".In short: you can inline your complete LilyPond settings or at least the score & body matchinginclude line:
\traceexternalfilters=== Sample Include File ===
\defineexternalfilter [lilypond] [\c!output=\externalfilterbasefile"mysettings.pdf, \c!filtercommand=\lilypondcommand, \c!continue=\v!yes, \c!readcommand=\readlilypondoutput, %\c!directory=output, ]ly" could look like this:
% frame=on is for testing<texcode>\def\readlilypondoutput#1{\setupfloats[location=right,frame=off]\placefigure[]{From \sc{http://lsrversion "2.dsi18.unimi.it/LSR/Search?q=piano}}{\externalfigure[2"#1]}} \def\lilypondcommand% {lilypond (ly:set-dbackend=eps option (quote no-dnopoint-gsand-loadclick))#(set-fonts global-dincludestaff-eps-fonts \externalfilterinputfile}\protectsize 14)
\setuplayout[textwidth=6in] % matches --- start of setup for single-lineoutput files ---width below\usetypescript[palatino]#(define default-toplevel-book-handler\setupbodyfont[palatino,13pt] print-book-with-defaults-as-systems )
\starttext#(define toplevel-book-handler (lambda ( . rest) (set! output-empty-score-list #f) (apply print-book-with-defaults rest)))
\input zapf #(define toplevel-music-handler (lambda ( . rest) (apply collect-music-for-book rest)))
\startlilypond\layout{#(define toplevel-score-handler indent=0\mm ragged-right = ##f}\paper { myStaffSize = #20 #(define fontslambda ( . rest) (makeapply collect-pangoscores-fontfor-tree "palatino" "palatino" "palatino" (/ myStaffSize 20book rest))) line-width=6\in oddFooterMarkup=##f oddHeaderMarkup=##f bookTitleMarkup = ##f scoreTitleMarkup = ##f }global = { \key c \major \time 4/4}
sopMusic = \relative c'' {#(define toplevel-text-handler c4 c c8[( blambda ( . rest)] c4}sopWords = \lyricmode { hi hi hi hi} (apply collect-scores-for-book rest)))
altoMusic = \relative c' { e4 f d e}altoWords =\lyricmode { ha ha ha ha}#(set! output-empty-score-list #t)
tenorMusic = \relative c' { g4 a f g}tenorWords = \lyricmode { hu hu hu hu}% --- stop single-line setup ---
bassMusic \paper { #(define dump-extents #t) indent = 0\relative c {mm ragged-bottom = ##t c4 c g c ragged-last-bottom = ##t} print-page-number = ##fbassWords line-width = 120\lyricmode {mm oddFooterMarkup = ##f oddHeaderMarkup = ##f bookTitleMarkup = ##f ho ho ho hø scoreTitleMarkup = ##f
\stoplilypond
\input zapf
\stoptext
<\texcode>
== Setup ==
* 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>
\usemodule[lilypond]
* 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 ==={| 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 !! Please look up the meaning|-| staffsize || number (pt) || 20 || height of the staff|-| linewidth || measure || <cmd>localhsize<settings in [http:/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.elilypond. show time signature, draw bars, split the staff)?|-| clef || yesorg/no || yes || show the clef?|-| fragment || yesdoc/no || no || typeset only a snippet (instead of a whole line)?|-| barnumbers || yes/no || no || show measure numbers?|-| showempty || yesv2.22/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" || ".Documentation/lilytemp" || directory for temporary files (.tmp, .md5, .eps); gets created if not existant|-| imgdir || "name" || ".web/lilypdfs" || directory for LilyPond PDFs; gets created if not existant|}manuals LilyPond’s great documentation]!
== Snippets ==If you’d like to exchange measures like text width between ConTeXt and LilyPond, you could write those into the LilyPond buffer (see below).
<texcode>There are some notes \lilypond{ \relative{bes To give LilyPond measures to ConTeXt, you would need to write them into a c b} } embedded temp file (using Scheme) and read that in again (using Lua).For the time being this lineis left as an exercise to the user.</texcode>;)
== Sections ==Unfortunately you can’t define LilyPond’s text (lyrics) size with an absolute value, but only relative to staff size...
E.g. for a songbook you want to place big chunks of LilyPond output (i.e. note staffs) in your text. It behaves like any other graphics, especially similar to embedded [[MetaPost]] code:== Named Buffers ==
<texcode>\section{A Tune}Normally, your LilyPond snippets just get a running number. If you re-order your scores, each one gets re-rendered.
\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 There's nothing to say about this tune yet; someone heard it from Lúnasa.You can avoid that if you name your LilyPond snippets: just add </texcodett> <texcode>\section{Starlight (round)} \startlilypond<<\context Staff [name= onlyone myfunnyname]<< \clef treble \key a \major \time 6/8 \context Voice = one tt> to { \relative c'' { a4.^\markup{1.} e' cmd| e8( d cis) b4. | e4.^\markup{2.startlilypond} d4 d8 | cis( b) a b4 e,8 | a4 a8 gis( a) b | cis4 cis8 b( cis d) | cis( d) e e4 e,8 | fis4 fis8 gis4. } }>>\lyricsto one \new Lyrics { \lyricmode { Star -- light, star -- bright, first star I see to -- night; I wish I may, I wish I might have the wish I wish to -- night. }}>> \stoplilypond</texcode>
LilyPond depends on the fonts that pango/fontconfig can find. But not even all of those will work, e.g. no fonts from the TeX tree (don't know why), only one face per font file etc.Therefore it doesn't use ConTeXt's font setup.== Automatical width adaption ==
LilyPond's default text font is Century Schoolbook -- this goes after "create temp folder" io.savedata("\LILYTEMP/texsettings.ly", "\\paper { line-width = " .. You can use it in ConTeXt like this: string.gsub(number.todimen(tex.dimen.textwidth),"pt","\\pt") .. " } \n")
== Current workarounds ==You must comment/delete the "line-width" setting in mysettings.ly, otherwise it doesn’t work.
This section lists workarounds needed in some circumstances; we surely hope to move them to [[#Older_Workarounds|'''Older Workarounds''']] as soon as possible!== Example ==
=== Something (LilyPondHere's an example of placing score snippets in the body of the text, GhostScript etc.) isn't found ===with fonts in the score & body matching:
Depending on your setup (path, installation directories, ...) you must call the lilypond app with the full path.<texcode>\def\LILYTEMP{lilytemp} % name of folder for LilyPond/buffer files
If <tt>pstopdf</tt> can't create PDFs \def\ParseLilypondFile#1% #1 is the name of the output file {\ctxlua{thirddata.parselilypondfile(but LilyPond has made EPS files"#1") it might be that you must set the environment variable <tt>GS_LIB</tt> for GhostScript.}}
The module as of 2009 -05-03 works only with LilyPond 2create temp folder if missing if not lfs.12 isdir(probably also with some versions of 2"\LILYTEMP") then lfs.11mkdir("\LILYTEMP"). end
For older versions of LilyPond please use an older version of the module function thirddata. 2008parselilypondfile(name) -09 fits LilyPond 2- 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.10loaddata(scname)) or 0
Lilypond has commands to typeset fret diagrams for the guitar chords. The most important one is called <code>\fret-diagram<usemodule[filter]\defineexternalfilter[lilypond] [continue=yes, cache=yes, readcommand=\ParseLilypondFile, directory=\LILYTEMP/code> and if you want to use it, you need to play a bit with the catcode of the <code>minus</code> sign since ConTeXt is apparently confused by this output={\externalfilterbasefile. In additionpdf}, you can't type the example found in [http:// filtercommand={lilypond.org/doc/v2.10/Documentation/user/lilypond/Overview-ofdbackend=eps -dinclude-eps-fonts -textdno-markupgs-commands#indexload-g_t_0040code_007bfret_002ddiagram_007dfonts -935 the Lilypond documentationo"\LILYTEMP/\externalfilterbasefile" "\externalfilterinputfile"}] 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 \setuplayout[textwidth=6in] % matches line-width below\definefontfeature[main][protrusion=quality, something like this will work:expansion=quality]\definefontfamily[mainface][rm][Adobe Jenson Pro][features=main]\setupbodyfont[mainface,13pt]\setupalign[hz,hanging]
<texcode>
\usemodule[lilypond]
\catcode`\-=11
D chord:\blankinput zapf
d'' ^ \markup { \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
If you find a real solution to the <code>catcode</code> problem, please document it here, or report it to the list -- [[User:Arthur|Arthur]]b c d}
For information how the integration works, please check the module code and its PDF version (both available from [[modules:t-lilypond|LilyPond on Modules]]). Unlike <tt>lilypond-book<upper = \relative c'' { \clef treble \key c \major \time 2/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.4
Known bugs: a4 b c d* LilyPond's EPS bounding box is sometimes a bit too small, so sometimes the content is cropped. Perhaps call eps2eps or the like to fix that?}
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?idlower =107])\relative c {* get information from LilyPond about the baseline, for run-in music fragments \clef bass* tell LilyPond how much space is left on the first page \key c \major* check and probably work on proper multi-page music* it's not possible to set variables in LilyPond* lots of features \time 2/4
To remember: a2 c* see [http://lilypond.org/doc/v2.12/Documentation/ LilyPond Docs]!}
--[[User:ChristopherCreutzig|Christopher Creutzig]] after ideas by [[User:Hraban|Hraban]]\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 } }}
== Older Workarounds ==\stoplilypond\input tufte
'''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!''' === Fonts with ConTeXt MkII === For the latest versions of the module work with ConTeXt MkIV (LuaTeX) exclusively, so we moved this to "Older": <texcode>\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 \usetypescript [wiki] [songbook]\setupbodyfont[songbook, rm, 8.5pt]stoptext
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:Music]]
[[Category:Requests]]
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 ==
<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>
<texcode>
</texcode>
<texcode>
\unprotectstartbuffer[lilypond::settings]\include "mysettings.ly"\stopbuffer
\usemoduledefineexternalfilter[filterlilypond][ ... bufferbefore={lilypond::settings}, ...]</texcode>
}
\score layout { << #(layout-set-staff-size 14) % beware, this resets fonts! \new ChoirStaff << % set fonts for rm / ss / tt \new Lyrics = #(define fonts (make-pango-font-tree "sopranosTeX Gyre Schola" \new Staff = "womenLMSans10" << \new Voice = "sopranosLMTypewriter10 Regular" { \voiceOne << \global \sopMusic >> }(/ 14 20))) \new Voice = "altos" context { \voiceTwo << \global \altoMusic >> }Score >> \new Lyrics = remove "altosBar_number_engraver" \new Lyrics override PaperColumn #'keep-inside-line = "tenors" \new Staff = "men" << \clef bass##t \new Voice = "tenors" { \voiceOne << \global \tenorMusic >> } \new Voice = "basses" { \voiceTwo << \global \bassMusic >> } >>% some example settings \new Lyrics = "basses" \context Lyrics = "sopranos" { \lyricsto "sopranos" \sopWordsStaff \context Lyrics override TimeSignature #'style = "altos" \lyricsto "altos" \altoWords#'numbered \context Lyrics = "tenors" \lyricsto "tenors" \tenorWords } \context Lyrics = "basses" \lyricsto "basses" { \bassWordsChordNames >> \new PianoStaff << \new Staff << \set Staff.printPartCombineTexts chordChanges = ##ft \partcombine << \global \sopMusic >> << \global \altoMusic >> >> \new Staff << \clef bass \set Staff.printPartCombineTexts majorSevenSymbol = ##f \partcombinemarkup{ 7+ } << \global \tenorMusic >> << \global \bassMusic >> >> >> >> }
}
</texcode>
If you have just one LilyPond part per component (e.g. songs in a songbook), you could use <tt>[name== Font hints ==\currentcomponent]</tt>.
If you want to know which fonts of set your system LilyPond can see with which namesnote line width automatically to your current text width, try lilypond -dshow-available-fonts any(The 3rd parameter is necessary, but can be anything.)this:
and then adapt your snippets or preamble buffer:
<texcode>
\usetypescriptfile[type-otf] \starttypescript[wiki][songbook] \usetypescript [serif] [schoolbook] \definetypeface [songbook] [rm] [serif] [schola] [default] \definetypeface [songbook] [ss] [sans] [default][default] \definetypeface [songbook] [tt] [mono] [default][default]\stoptypescript \usetypescript [wiki] [songbook]include "../mysettings.ly"\setupbodyfont[songbook, rm, 8include "texsettings.5pt]ly"
</texcode>
\startluacode thirddata === LilyPond pre-2.12 ===thirddata or {}
for nr =1, syco do logs.report("LILYPOND","including system no." .. nr) context("\\setupfloats[location=right,frame= Typesetting fret diagrams ===off]\\placefigure[none]{}{\\externalfigure[" .. string.gsub(name, '%.pdf$', '-' .. nr) .. "]}") end end\stopluacode
\starttext
\startlilypond
\stoptextlayout{< 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/texcode>4
text == Developer's Corner ==\lyricmode {Aaa Bee Cee Dee}
</texcode>
==Too many open files = LilyPond is not found === Calling lilypond from command line in Windows fails. You have two options:* 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 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</tt> 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" == "--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/" $@
[[Category:Modules]]
