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