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