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