TODO

   1 -*-outline-layout:(2 (-1 -1 0 :) 0);outline-stylish-prefixes:nil -*-
   2
   3 * GNU LilyPond TODO
   4 Features you cannot find in the doco as working, should be
   5 mentioned here.  This is an assorted collection of stuff that will be
   6 done, might be done, or is an idea that I want to think about
   7
   8 Most of the items are marked in the code as well
   9 Grep for TODO and ugh/ugr/urg.
  10
  11 .* BUGS
  12 . * indent = 0.0 with linewidth=-1.0
  13 . * music ending in grace notes.
  14 . * PostScript
  15 .  * header for PS enteredby = "bla <bla@bar.com>"
  16 .  * ps/lily.ps see comments.
  17 . * didot / big point.
  18 . * midi key.
  19 . * fix singleStaffBracket
  20 . * declare performers in \midi
  21 . * check EGCS version
  22 . * input/test/stem-spacing.ly: 12/4 touches first note
  23 . * timesig: sometimes bottom digit  too high
  24 . * [<c8. d> <c16 d> <c8. d> <c16 d> <c8. d> <c16 d>]
  25 . * I'm using lilypond version 1.1.50 and have a problem with repeat/alternative.
  26 I tried this code
  27
  28  \time 4/4;
  29  \repeat semi 2
  30  {
  31   \partial 4; f'8 g' | a'4 a'8 a'4 g'8 f'4 | f' d'8 c'( )c'2 |
  32   f'4 f'
  33  }
  34  \alternative
  35  {
  36   { [g'8 f'] g' a'( | )a'2 r4 }
  37   { \partial 2; [g'8 f'] e' f'( | )f'2 r2 }
  38  }
  39 . * fix MIDI
  40 . * \shape 1st dim skipped?
  41 . * turn slope-damping on/off
  42 . * We need feta-din*.mf files for more sizes than 10.
  43 . * fix dynamics decently, ie. use kerning & ligatures.
  44 . * dots & rest collisions?
  45 . * mudela-book.py
  46 .  * fix \mudelafile{} to have decent functionality
  47 .  * P.P.S. It can be cool in mudela-book to distinguish in
  48 pre,postMudelaExample, whether MudelaExample is epsed or not: ( if
  49 this fragment is floating eps, than 1, otherwise 2). say
  50 preMudelaExample[eps]{}, and change it in document body sometimes.
  51 .  * use less RE's
  52 . * junk _ in lyric mode for " "
  53 . * Lyrics and scripts collide.
  54 . * a note with a circle after it, meaning:
  55
  56    note + circle = note + 1/4 of its length
  57
  58    the circle is like a dot that's not filled in.  for example, on
  59    page three, the c-sharp on the second line should be a quarter with
  60    a circle, not a quarter tied to a sixteenth.  is this at all
  61    possible with lily?
  62 . * grace_align_item -> stackingdir = left, weird placement.
  63 . * tuplets that are written as "number : note", for example
  64    "3 : [image of a half note here]".  possible?
  65
  66 . * Matanya's tips:
  67 .  * don't  shorten stems/staffs closer to each other.
  68 .  * accidentals closer to note head
  69 .  * to space the staffs/staffgroups contained in the score.
  70 .  * heavier beams?
  71
  72 .* Cleanups needed
  73 . * \$ and $ identifier syntax in examples.
  74 . * Key_engraver, Local_key_item
  75 . * Think of comprehensive solution for "if (grace_b == self_grace_b_)"
  76 . * Y dimension units: staffspace vs. Point
  77 . * Beam
  78 . * Stem
  79 . * Rhythmic_column and interaction stem/rhythmic_column/note_head/dots.
  80 . * Slur
  81 . * Rhythmic_grouping
  82 . * Duration
  83 . * clef engraver
  84 . * parser
  85
  86 .* TODO before 1.2
  87 . * Grace_slur_engraver.
  88 . * Morally pure LilyPond.
  89 .  * Remove non-free software links.
  90 .  * Remove meta article LilyPond.
  91 . * break priority setting from SCM.
  92 . * Gade score
  93 .  * remove [] in favour of auto-beamer
  94 . * hangOnClef with non-breakable clefs.
  95 . * Aha, the problem is the new TeX code generation for changing fonts.
  96 > (The explanation below is mostly intended for Han-Wen and Jan)
  97 > Before, the font was changed with macros declared separately for
  98 > pure TeX and LaTeX, but now all the fonts are declared directly in
  99 > the generated code using the low-level TeX commands. This circumvents
 100 > the fontencoding mechanism of LaTeX and is a potential source of
 101 > problems also for us users of the Latin-1 character set.
 102 > I think it still works since the inputencoding latin1 is
 103 > declared by ly2dvi, but it still means that e.g. an o with
 104 > umlaut is typeset as a combination of the two symbols 'o' and
 105 > 'umlaut' instead of as a single character, as would be the case
 106 > if fontencoding OT1 had been used. This shouldn't give any
 107 > difference in layout, though. One of the main argument for using
 108 > fontencoding OT1 is for the hyphenation mechanism to work, an
 109 > argument that's clearly irrelevant in our application. Yet we
 110 > see the problem for August.
 111 . * Abstraction for engravers:
 112 .  * make "in-between" engraver (Tie, Extender)
 113 .  * make wide_spanner_engraver (line_group_spanner, staff_symbol)
 114 . * do scaled fonts generally
 115 . * The Lilypond accidental symbols are available through the TeX macros,
 116 \textflat, \textsharp and \textnatural defined in the init file
 117 lilyponddefs.tex. All the symbols are defined in the files fetaXX.tex
 118 where XX corresponds to the size. I don't know where (or even if) they
 119 are installed but they are generated in the mf/out/ directory during the
 120 compilation.
 121 . * make dependencies () a virtual function.
 122 . * store req -> element, element -> element causes for warnings
 123 . * include examples in RPM.
 124 . * fix partial measures in meaningful way.
 125 . * relative mode for mi2mu
 126 . * uniformise recent feta contributions.
 127 .  * bigger and fatter 4/4 C
 128 . * sort out directory stuff.
 129 .  * --prefix option?
 130 .  * -I option per filetype?
 131 .  * kpathsea?
 132 . * ly2dvi/lilypond logfile.
 133 . * fractional chord durs.
 134 . * hang Item on Spanner
 135 . * do --safe for PS output?
 136 . * convert-mudela --output
 137 . * Staff_margin (with a partial measure.)
 138 . * fix convert-mudela manpage
 139 . * decimal point in \paper {}
 140 . * {  \voiceone <a'4.*2/3  d''4.*2/3 fis''4.*2/3>  [g''8 fis'' e''] d''4 |}
 141          and
 142          { \voicetwo  d'4 d'2.*2/3 } spacing
 143 . * tied notes for MIDI
 144 . * sharp / flat on trills (in MIDI ??)
 145 . * scm-ify \property values.
 146 . * move class Lookup {} into scm
 147 . * msgfmt -o check?
 148 . * add new glyphs to font.ly
 149 . * formatting of input stuff.
 150 . * \notes{ a \< b \cr } vs \notes{ a \< b \! }
 151 . * broken scripts:
 152         lbheel = \script { "bheel" 0 0 -1  0 0 }
 153         rbheel = \script { "bheel" 0 0 1 0 0 }
 154         lbtoe = \script { "btoe" 0 0 -1 0 0 }
 155         rbtoe = \script { "btoe" 0 0 1 0 0 }
 156         lfheel = \script { "fheel" 0 0 -1  0 0 }
 157         rfheel = \script { "fheel" 0 0 1 0 0 }
 158         lftoe = \script { "ftoe" 0 0 -1 0 0 }
 159         rftoe = \script { "ftoe" 0 0 1 0 0 }
 160         and also
 161         portato= \script { "portato" 0 -1 0 1 0 }
 162 . * ly2dvi
 163 .  * bottomnote for ly2dvi
 164 .  * deps for ly2dvi
 165
 166 .* STUFF
 167 . * compulsory hshift
 168 . *
 169 My wish list for lyrics. I dream of a time when I will have enough time to
 170 become familiar enough with the source code to be able to implement some of
 171 these myself, but I don't know when that will be, so I thought I'd "publish"
 172 my suggestions in case someone else is in a position to give them some
 173 priority. Otherwise, perhaps they could go on the todo list?
 174
 175 If any of these are already implemented, please let me what the syntax is to
 176 use them!
 177
 178 1. Stanza numbering. Numbering at the beginning of a song with the number
 179 set to the left of the first note. It would also be nice (but not as
 180 important) to be able to have some form of automatic numbering at the
 181 beginning of each new line. This would make it easier to follow songs with a
 182 large number of stanzas.
 183
 184 2. Hyphens between syllables. At the moment there appears to be no easy way
 185 to position a hyphen mid-way between the syllables it breaks.
 186
 187 3. Notes centred above/below lyrics rather than left-aligned.
 188
 189 4. It would be very nice to be able to build some kind of phrasing into the
 190 lyrics of hymns, etc, so that the first words of a phrase are left aligned
 191 with each other, the last words are right aligned, and the words in between
 192 are centred.
 193
 194 5. In a song, with (say) four stanzas and a chorus, it would be nice to be
 195 able to vertically align the chorus midway between the staves.
 196
 197 6. It would be nice to be able to put vertical brackets either side of a
 198 repeated section with different words for each repeat.
 199
 200 . * Give # lines in linebreaking.
 201 . * arrows on slurs.
 202 . * rewrite context defs using Scheme
 203 . * \selectmusic to cut pieces from music.
 204 . * TODO: merge atom & molecule; make  tree from molecule.
 205 . * Align_element::padding  ?
 206 . * typo checks on property names?
 207 . * use streambufs and iostream
 208         to provide IO handling for TeX stream, mudela stream, data-file.
 209 . * seriously buffer TeX output (do profile of writing .5 mb TeX file.)
 210 . * strip EXEs before installing
 211 . * zip target for binary windows dist (JBR)
 212 . * junking \skip req in lyrics
 213 . * mi2mu empty staffs.
 214 . * use Fourier transformation for rhythmic quantisation.
 215 . * horizontal centering of dynamics
 216 . * $DEPENDENCIES_OUTPUT support
 217 . * fix vertical alignment and stafflines
 218 . * declaring Performers
 219 . * *.yo: fix pod manpage layout legacy
 220 . * text-items clash with stems/beams
 221 . * --include, -I option for ly2dvi (pass on to lily)
 222 . * fix placement of beam-less abbrev
 223 . * \meter 3/4;
 224         <{\voiceone cis4. cis8 cis4 | cis4 cis cis | r1 }
 225          {\voicetwo cis,4 r r | r2. | r1 }> |
 226         }
 227 . * Musical_pitch (analogous to Duration and Rhythmic_req)
 228           think about, analogous to pitch:
 229            * { a4 a16 } c <-- duration of c?
 230            * < a4 b8 > c <-- duration of c?
 231 . * \tempo 4. = 90;
 232 . * fix audio-items (don't use (input) requests, but copy data)
 233 . * make sure all ex's have a mudela-version
 234 . * do rest-collisions for Multi_measure_rests as well.
 235 . * split error/warning in error/warning/non_fatal_error
 236 . * add a Duration_convert member to Duration_iter to set parameters.
 237         Junk global duration settings.
 238 . * en-,discouraged linebreaking:
 239 .  * handle DISALLOW < penalty > FORCE
 240 .  * discourage breaking of slurs
 241 . * fix variable define/lookup parser global<->paper
 242 . * fix title/instrument placements; see input/test/title.ly
 243 . * <\voiceone c4. \voicetwo c4>
 244 . * add full cello suites to web site (kom op, Maarten!)
 245 . * add mudela-book-doc source to webstie.
 246 . * Rethink Time_description
 247 \cadenza , \meter, \grouping should all be \properties
 248 . * fix singleStaffBracket
 249 . * rename
 250 .  * measure -> bar
 251 .  * abbreviation-beam -> (measured/unmeasured) tremolo
 252 .  * partial -> anacrouse
 253 . * robustify Beam (in case of no stems, 32nd notes)
 254 . * move paper vars into engraver properties
 255 . * check for groff / troff/ nroff et
 256 . * more intelligent file searching
 257 . * disable spaces in TeX stuff
 258 . * handle ^C for tmp/file creation.
 259 . * make LilyPond RPM fully relocatable
 260 . * dots & rest collisions.
 261 . * the warning about the negative slur/tie length appears twice
 262 which is irritating.
 263 . * better hshift (dots, distance, head dependent)
 264 . * clefs (AG): The "8" should appear closer to the actual clef,
 265 touching it.
 266 . * put errorlevel in Input class
 267 . * junk nesting slurs
 268 . * integrate midi-elts from mi2mu and lily?
 269 . * distinguish between unset and empty properties.
 270
 271 .* FONT
 272 . * the bracket is ugly (wings are too parabolic, should be more circular)
 273 . * versioning for Feta
 274 . * rewrite dynamic signs.  They're kind of spaghetti now.
 275 . * The `3' in the meter key is a one or two pixels too thin (at 600dpi)
 276         in the middle:
 277 . * design macro for penstroke with rounded endings
 278 . * timesig C: fat yet less curved.  Check out relations.
 279 . * design decent macro for bulbed endings
 280 . * printer dependencies.
 281 . * versioning
 282 . * lo-res fixes.
 283 . * work out sizes of character fonts.
 284 . * more symbols
 285 .  * piano pedals: Ped/*
 286 .  * maxima notehead
 287 .  * coda signs: Segno, O+
 288 .  * glissando, arpeggio
 289 .  * lengthened trill
 290 . * include important spacing dims in fetalog
 291 . * scalability: use blot_diameter everywhere, make font chubbier for
 292     small sizes.
 293
 294 .* 3RD PARTY BUGS
 295 . * UMR: Uninitialized memory read
 296       This is occurring while in:
 297             qst            [qsort.c]
 298             qsort          [libc.so.1]
 299             Keyword_table::Keyword_table(Keyword_ent*) [keyword.cc:28]
 300             My_lily_lexer::My_lily_lexer() [my-lily-lexer.cc:78]
 301             My_lily_parser::parse_file(String,String) [my-lily-parser.cc:54]
 302             do_one_file(String,String) [scores.cc:124]
 303       Reading 4 bytes from 0xefffeca8 on the stack.
 304       Address 0xefffeca8 is 728 bytes below frame pointer in function
 305 . * GNU diff 2.7: diff -rN does not see a new directory with empty file
 306 . * mf-to-table -> add space before ; in AFM output.  (-> check AFM
 307     spec. Is this a bug in afm2tfm?)
 308 . * check out GCC signatures?
 309 . * glibc 2.0:
 310           f = fopen ("/dev/null", "r")
 311           assert (feof (f))
 312
 313 . * tetex: mfplain.mem
 314 .* 3RD PARTY PROJECTS:
 315 . * make GCC warn about ctor that leaves member vars  uninitialised.
 316 . * GNU patch
 317 .  * 'double-fix' mode: ignore identical fix, rather than suggest
 318             to revert patch direction when (more or less? exactly) the same
 319             thing is fixed
 320 .* PROJECTS
 321 . * Scripts:
 322 .  * stack scripts in chords:
 323           % fingering:        footing:
 324             < a-4 c-2 g-1 >   < c-\ltoe e-\lheel >
 325 .  * script-spacing
 326 .  * slur parts as a script
 327 .  * stack parameterised scripts for fingering and footing:
 328
 329 . * convert-mudela:
 330 .  * automatically add  a \version if not present.
 331 .  * better parsing
 332 .  * make smarter
 333 .  * convert-mudela -e empty.ly
 334
 335 . * emacs mudela-mode
 336 .  *  should handle block comments too.
 337 .  *  handle lexer modes (\header, \melodic, \lyric) etc.
 338 .  *  indentation
 339 .  *  notenames?
 340 .  *  fontlock: \melodic \melodic
 341
 342 . * use properties for:
 343 .  * default tempo.
 344 .  * cadenza mode?
 345
 346 . * page handling:
 347 .  * PS output
 348 .  * optimal pagebreaking.
 349
 350 . * Unicode support? -> man 7 unicode
 351 .  * 16 bit Strings
 352 .  * -u switch
 353 .  * detect of 16/8 bit files
 354 .  * examples to go with it.
 355
 356 . * \header
 357 .  * output header info to MIDI too.
 358
 359 . * a musical dictionary. See Documentation/vocabulary-*, other
 360 languages:
 361 .  * explanations
 362 .  * italian
 363 .  * german
 364 .  * dutch
 365 .  * swedish
 366          .. ?
 367
 368 . * chords
 369 .  * guitar chords (fret diagrams)
 370 .  * other chord name styles (american(?) style)
 371 .  * basso continuo
 372 .  * MIDI output?
 373
 374 . * Debug logs:
 375 .  * derive lily_stream, Dstream, texstream from ostream?
 376 .  * indentable stream as baseclass for TeX stream, lily stream, Dstream.
 377 .  * use dstream feature in mi2mu
 378 .  * integrate IO checking into stream class
 379
 380 . * input converters
 381 .  * NIFF?
 382 .  * ABC?
 383 .  * SMDL?
 384
 385 . * add to MIDI output:
 386 .  * tempo change
 387 .  * ornaments (and trills?)
 388 .  * slurs
 389 .  * accents
 390 .  * dynamics
 391 > Would it be hard to add support for proper dynamics in MIDI output?  I
 392 > would really like to have this feature...
 393
 394 Concretely spoken, for dynamics you have to write a performer
 395 (Dynamics_performer), that will take the input requests. If I
 396 understand correctly, every MIDI note played must have its dynamic
 397 strength set separately.  That means the the Dynamics_performer must
 398 set the strength of every Audio_note it finds.  This means that one
 399 has to modify existing Audio items.  The best way of doing this is
 400 with a broadcast/acknowledge process.
 401
 402 So the best way of handling this, is
 403
 404   1 supporting dynamic settings in Audio_note
 405
 406   2 Write a Dynamics_performer that will modify
 407   any notes it finds to set appropriate strengths.
 408
 409 I'd say that the work involved is not hard, but you have to be fluent
 410 with C++ and need some insight into the working of Notation Contexts
 411 and friends.  I guess I could do it in a day or so, but if you are not
 412 so fluent with the inner workings of LilyPond, it could take you some
 413 more time (A few more days?).
 414
 415 Please note, that I am *not* going to code this myself: my days are
 416 valuable, and I think I have more interesting things to do than fixing
 417 the MIDI output (I don't even have a soundcard).  But I *do* want to help
 418 you or other people with implementing this, so if you need help, don't
 419 hesitate to ask.
 420 .  * account for rhythmic position in measure
 421 .  * etc.
 422
 423 . * accidentals per Voice_group
 424
 425 . * Output class, handles : (smallish)
 426 .  * help text /(c) notice?
 427 .  * version line
 428 .  * warning /errors/progress
 429 .  * abort on error/warning; exit status
 430 .  * quiet/ignore-version options
 431 .  * logfile output
 432
 433 . * PS
 434 .  * speed up PS code.
 435 .  * PS lines to .eps files
 436 .  * write custom prolog
 437
 438 . * SGML input
 439
 440 . * Documentation
 441 .  * remove links to non-free SW.
 442 .  * internal documentation
 443 .  * a general paper.
 444 .  * \properties
 445 .   * left/rightbeamcount
 446 .   * various other new properties.
 447 .  * introduction?
 448 .  * info?
 449 .  * LaTeX?
 450 .  * more manpages?
 451 .  * Doc (C) stuff of sheet music
 452 .  * a better format?  SGML?  TeX?  Info?
 453 .  * a better tutorial
 454
 455 . * more spanners (smallish)
 456 .  * Glissando
 457 .  * trill
 458
 459 . * Rewrite Stem, Beam and Rhythmic_grouping (hairy)
 460 .  * [c8. c32 c32]
 461 .  * doc on Rhythmic_grouping
 462 .  * general shaving on Beam and Stem
 463 .  * use plet grouping
 464 .  * separate visual from rhythmic info even more
 465 .  * beams over bars
 466
 467 . * lines:
 468 .  * Ledger lines, should be separate item: Ledger_lines
 469 .  * set different line sizes / thicknesses
 470 .  * beam stem showthrough, inter beam sizes (french vs german style)
 471
 472 . * Collisions
 473 .  * left/right note balls should be handled by Collision:
 474         < \multi 2; { \stem 1; <b c> } { <f as b> } >
 475
 476 . * Keys:
 477 .  * merge key{item} & localkey{item}?
 478 .  * spacing, national styles?
 479
 480 . * Support for TAB
 481 .  * redo Notehead to allow digits as heads
 482 .  * add a \tablature {} lexer mode for easy entering
 483
 484 . * should adjust stemlength for flag number.
 485
 486 . * breaking:
 487 .  * caching breakpoints
 488 .  * saving them
 489 .  * specify number of lines
 490
 491 .* INPUTLANGUAGE
 492 . * \rhythms 4 16 16 16 16; c c c c c -> c4 c16 etc.
 493 . * convention for slurs vs. phrasing marks.
 494 . * Language:
 495 .  * \translator -> ?
 496 .  * fix \partial
 497 .  * \bla {} vs \bla ;
 498 .  * mix engraver hacking with music ?
 499 .  * \once\property  KEY = VAL
 500 .  * input property
 501 .  * abstract grammar.
 502 . * Figure out semicolons.
 503 . * c4 4 4 4 for c4 c4 c4 c4?
 504 . * <c f a>4 ?
 505 . * Viola mode?
 506
 507                 @c c g e g
 508         for
 509                 c g es g,
 510
 511                 @A c g e g
 512         for
 513                 cis gis e gis
 514 . * configure pitch_byte
 515 . * rest name configurable
 516
 517
 518 .* SMALLISH PROJECTS
 519
 520 . * Faulenzer sign (% repeat).  Perhaps also use \repeat syntax?
 521
 522 . * fix confusing naming in Engraver vs Engraver_group_engraver (context)
 523
 524 . * progress when creating MIDI elts.
 525
 526 . * A range for context errors (eg. mark both { and }. )
 527
 528 . * lyric in staff  (sharpsharp in staff, text below)
 529
 530 . * write Dynamic_line (to group dynamics horizontally)
 531
 532 . * use Real for all y positions.
 533
 534 . * half-sharps, half-flats
 535
 536 . * adaptive accidental spacing.
 537
 538 . * handle EOF graciously in error messages.
 539
 540 . * midi esp.: use I32 iso int where 32 bits are needed (or assumed...)
 541
 542 . * lily \tempo
 543
 544 . *   % toe to bheel   four to five
 545             %   ^_u            4_5
 546             %     -
 547             %  --|x--         --|x--
 548             %  --|---         --|---
 549             %  --|---         --|---
 550           (where "to" is a tiny bow)
 551
 552 . * auxilliary file for caching info.
 553 . * Text_crescendo
 554
 555 .* IDEAS
 556 . * Output data structures of Mudela in XML/SGML.
 557 . * create libmudela, or liblily_frontend
 558 . * move MIDI stuff (including Quantization) to a ANSI C libmidi library.
 559 . * Spacing_request for manually adjusting spacing
 560 . * caching breakpoints
 561 . * used fixedpoint arithmetic for min. energy.
 562
 563 * OUTLINE SETUP
 564 .* .EMACS
 565 ;;; from outline.el
 566 (defvar outline-font-lock-keywords
 567   '(;; Highlight headings according to the level.
 568     ;; must change this to allout node layout
 569     ;;("^\\(\\*+\\)[ \t]*\\(.+\\)?[ \t]*$"
 570     ("^\\([.]*[ ]*[*]\\)[ \t]*\\(.*\\)$"
 571      (1 font-lock-string-face)
 572      (2 (let ((len (- (match-end 1) (match-beginning 1))))
 573           (or (cdr (assq len '((1 . font-lock-function-name-face)
 574                                (2 . font-lock-keyword-face)
 575                                (3 . font-lock-comment-face))))
 576               font-lock-variable-name-face))
 577         nil t))
 578     ;; Highlight citations of the form [1] and [Mar94].
 579     ("\\[\\([A-Z][A-Za-z]+\\)*[0-9]+\\]" . font-lock-type-face))
 580   "Additional expressions to highlight in Outline mode.")
 581
 582 (add-hook 'outline-mode-hook
 583           '(lambda ()
 584             (setq font-lock-maximum-decoration t)
 585             (setq font-lock-maximum-decoration t)
 586             (make-local-variable 'font-lock-defaults)
 587             (setq font-lock-defaults '(outline-font-lock-keywords t))
 588             (font-lock-mode global-font-lock-mode)
 589         ))
 590
 591 (require 'allout)
 592 (outline-init 't)