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