lilypond-1.0.19
[lilypond.git] / TODO
blob6c18aa1a12005c94c03c95b129be1fc09aa21e76
1 Features you cannot find in the doco as working, should be mentioned here.
4 This is an assorted collection of stuff that will be done, might be
5 done, or is an idea that I want to think about
7 Most of the items are marked in the code as well, with full explanation. 
8 grep for TODO and ugh/ugr/urg
11 BUGS:
13         * document new TeX/mf layout
15         * egcs-1.1 -O2 -finline-functions  causes crash
17         * formatting of input stuff. 
19         * use real RTTI iso access_Stuff.
21         * \notes{ a \< b \cr } vs \notes{ a \< b \! }
23         * if possible, it might be nice for a warning to appear if someone does
24         \translator with no name and without assigning it to an
25         identifier.  
27         * space after bars?
29         * [/3 c8 c16 c c c]/1
30   
31         * fix singleStaffBracket
32   
33         * repeat bars: need distance after ":|" and before "|:"
35         * The time signature warnings still remain, will be fixed later.
37         Summary of minor spelling irregularities:
38         -  capitalization/use of underscores in property names
40         * fix Score.skipBars
42         * repeat bars: need distance after ":|" and before "|:"
44         * \shape 1st dim skipped? 
46         * fix marks/barnumbers/marginal notes
48         * broken scripts:
49         lbheel = \script { "bheel" 0 0 -1  0 0 }
50         rbheel = \script { "bheel" 0 0 1 0 0 }
51         lbtoe = \script { "btoe" 0 0 -1 0 0 }
52         rbtoe = \script { "btoe" 0 0 1 0 0 }
53         lfheel = \script { "fheel" 0 0 -1  0 0 }
54         rfheel = \script { "fheel" 0 0 1 0 0 }
55         lftoe = \script { "ftoe" 0 0 -1 0 0 }
56         rftoe = \script { "ftoe" 0 0 1 0 0 }
57         
58         and also
59         
60         portato= \script { "portato" 0 -1 0 1 0 }
62         * Align_element::padding  ?
64         * uniformise property names.
66         * ydirection <-> yDirection
68         * typo checks on property names?
70         * make engraver hacking robust.
72         * use streambufs and iostream
73         to provide IO handling for TeX stream, mudela stream, data-file.
75         * seriously buffer TeX output (do profile of writing .5 mb TeX file.)
77         * strip EXEs before installing
79         * zip target for binary windows dist (JBR)
81         * text continuations
83         * revise documentation
85         * abbrev -> tremolo
87         * junking \skip req in lyrics
89         * Language:
90         - \type -> \context ?
91         - \translator -> ?
92         - fix \partial 
93         - \bla {} vs \bla ; 
94         - mix engraver hacking with music ?
95         - \once\property  KEY = VAL
96         - \addtranslator, \removetranslator
97         - junk ^ and _ for scripts
98         - junk _ for lyrics.
99         - abstract grammar.
101         * install TeX stuff into tex/generic directory.
103         * percussion note heads
105         * mi2mu empty staffs.
107         * include MIDI list 
109         * make GNU style webpages.
111         * midi_instrument -> midiInstrument
113         * horizontal centering of dynamics 
115         * \font\fontA=feta20.afm (.afm?)
117         * gzip RH manpage
119         * stable make/config stuff
121         * stemup/stemdown; see test/updown.fly
122           - check examples; add \type Staff hither and thether
124         * $DEPENDENCIES_OUTPUT support
126         * use a fake-yodl.sh to mimick yodl when yodl is not installed
128         * fix BUGs
130         * fix weird behaviour when .AFMs not found.
132         * Xdvi zooming ?!
133                 gs: Error: /undefined in draw_beam
134                 gs: Operand stack:
136         * run texhash after installing .tex
138         * fix vertical alignment and stafflines
140         * GrandStaff needs more work -- I want a single word
141         `harpsichord' to the left of the grandstaff, not one on each
142         stave.  (Organ staff -- with separate pedal -- but common
143         properties may be something to think about.  Of course for
144         organ you want to be able to give stop indications on the way
145         through, so the \property Voice.Instrument would be a stop,
146         and \property GrandStaff.instrument would be PipeOrgan...)
148         * make Tie_req a "command" { <c g> ~ <c g> }
150         * bib ep1988
152         * revise the Score_priority_align_engraver concept.  It sucks. 
154         * ly2xdvi, ly2ps
156         * make new VoiceOne, VoiceTwo, VoiceThree contexts with
157 ydirection and hshift preset
159         * *.yo: fix pod manpage layout legacy
161         * text-items clash with stems/beams
163         * --include, -I option for ly2dvi (pass on to lily)
165         * fix placement of beam-less abbrev
167         * \meter 3/4;
168         <{\voiceone cis4. cis8 cis4 | cis4 cis cis | r1 }
169          {\voicetwo cis,4 r r | r2. | r1 }> |
170         }
172         * try to use template<Type> iso MACRO(Type)
174         - NEWS: ... Musical_pitch (analogous to Duration and Rhythmic_req)
175           think about, analogous to pitch: 
176            * { a4 a16 } c <-- duration of c?
177            * <a4 b8> c <-- duration of c?
179         * \tempo 4. = 90;
181         * fix audio-items (don't use (input) requests, but copy data)
183         * junk My_lily_parser::abbrev_beam_type_i_ 
185         * make sure all ex's have a mudela-version
187         * do rest-collisions for Multi_measure_rests as well.
189         * split error/warning in error/warning/non_fatal_error
191         * add a Duration_convert member to Duration_iter to set parameters.
192         Junk global duration settings. 
194         * deps for ly2dvi
196         * clean up abbrev/plet/beam/abbrevbeam/duration mess in parser.
198         * minimum length second part broken tie
200         * en-,discouraged linebreaking: 
201           - handle DISALLOW < penalty > FORCE
202           - discourage breaking of slurs
204         * multibar rest
205           - symbol(s)
207         * fix variable define/lookup parser global<->paper
209         * fix title/instrument placements; see input/test/title.ly
211         * <\voiceone c4. \voicetwo c4>
213         * add full cello suites to web site (kom op, Maarten!)
215         * Rethink Time_description
216           * \cadenza , \meter, \grouping should all be \properties
218         * rename
219           - plet -> tuplet
220           - measure -> bar
221           - abbreviation-beam -> (measured/unmeasured) tremolo
222           - partial -> anacrouse
224         * shared lib
226         * robustify Beam (in case of no stems, 32nd notes)
228         * decentralised spring factory
230         * move paper vars into engraver properties
232         * check for groff / troff/ nroff et
234         * more intelligent file searching
235         - make LilyPond RPM fully relocatable
237         * nicen examples:
238         - break-up heavily-nested score blocks
240         * disable spaces in TeX stuff
241         
242         * handle ^C for tmp/file creation.
244         * dots & rest collisions.
246         * documentation
247         - introduction?
248         - info?
249         - LaTeX?
250         - more manpages?
252         * versioning for Feta
254         * the warning about the negative slur/tie length appears twice
255         which is irritating.
257         * The `3' in the meter key is a one or two pixels too thin (at 600dpi)
258         in the middle:
260         * the bracket is ugly (wings are too parabolic, should be more circular)
262         * better hshift (dots, distance, head dependent)
264         * clefs (AG): The "8" should appear closer to the actual clef,
265           touching it.
267         * put errorlevel in Input class
269         * junk nesting slurs
271         * integrate midi-elts from mi2mu and lily?
273         * cautionary accidental
275         * score-bar-scripts
276         FMR: Free memory read:
277           * This is occurring while in:
278                 Bar_column::do_substitute_dependency(Score_element*,Score_element*) [bar
279         -column.cc:29]
280                 Score_element::unlink() [score-elem.cc:383]
281                 Paper_score::set_breaking(const Array<Column_x_positions>&) [p-score.cc:
282         150]
283                 Paper_score::calc_breaking() [p-score.cc:189]
284                 Paper_score::process() [p-score.cc:203]
285                 Score::run_translator(Music_output_def*) [score.cc:117]
286           * Reading 4 bytes from 0x65d3a0 in the heap.
287           * Address 0x65d3a0 is 160 bytes into a freed  block at 0x65d300 of 208 bytes.
288           * This block was allocated from:
289                 malloc         [rtlib.o]
290                 __builtin_new  [libgcc.a]
291                 Span_score_bar::clone()const [span-score-bar.hh:20]
292                 Item::copy_breakable_items() [item.cc:69]
293                 Item::do_breakable_col_processing() [item.cc:89]
294                 Score_element::calcalute_dependencies(int,int,void(Score_element::*)()*)
295          [score-elem.cc:171]
296           * There have been 22 frees since this block was freed from:
297                 free           [rtlib.o]
298                 __builtin_delete [libgcc.a]
299                 Span_score_bar::~Span_score_bar() [span-score-bar.hh:18]
300                 Paper_score::set_breaking(const Array<Column_x_positions>&) [p-score.cc:
301         156]
302                 Paper_score::calc_breaking() [p-score.cc:189]
303                 Paper_score::process() [p-score.cc:203]
304         Postprocessing elements... 
305         TeX output to score-bar-scripts.tex...
308 3RD PARTY BUGS:
310         * redhat (v?) graphical install bomb-out?
312         * GNU diff 2.7: diff -rN does not see a new directory with empty file
314         * GNU patch 2.1: <must find simple example> if patch chokes on a
315           hunk, or on allegedly unsorted hunks in a diff, it may stop 
316           without a trace of failure (create .rej file, print error or 
317           dump core) and just ignore any further diffs.
319         * glibc 2.0:
321           f = fopen ("/dev/null", "r")
322           assert (feof (f))
324 3RD PARTY PROJECTS:
326         * GNU indent: handle C++
328         * GNU patch 
329           - 'double-fix' mode: ignore identical fix, rather than suggest 
330             to revert patch direction when (more or less? exactly) the same 
331             thing is fixed
333 PROJECTS
335         * Scripts:
336         - fix position of bar number
337         - stack scripts in chords:
338           % fingering:        footing:
339             < a-4 c-2 g-1 >   < c-\ltoe e-\lheel >
340         - script-spacing
341         - slur parts as a script
342         - stack parameterised scripts for fingering and footing:
344         * convert-mudela:
345         - automatically add  a \version if not present.
346         - better parsing
347         - make smarter
348         - convert-mudela -e empty.ly
350         * emacs mudela-mode
351         -  should handle block comments too.
352         -  handle lexer modes (\header, \melodic, \lyric) etc.
353         -  indentation
354         -  notenames?
355         -  fontlock: \melodic \melodic
358         * use properties for:
359         - plet?
360         - Staff_sym size
361         - default tempo.
362         - font size
363         - bartypes (get rid of derived Span_bar_engravers)
364         - cadenza mode? 
366         * page handling:
367         - PS output
368         - optimal pagebreaking.
370         * Unicode support? -> man 7 unicode
371         - 16 bit Strings
372         - -u switch
373         - detect of 16/8 bit files
374         - examples to go with it.
376         * Spring_spacer:
377         - write a faster Spring_spacer (without matrices if possible)
378         - use straight LP to find minimal "fitting force"
379         - relate energybound to linelen unitspace fontsize etc.
380         - used fixed point fp
382         * \header
383         - output header info to MIDI too.
385         * a musical dictionary. See Documentation/vocabulary-*, other
386         languages:
387         - explanations
388         - italian
389         - german
390         - dutch
391         - swedish
392          .. ?
394         * chords
395         - guitar chords
396         - chord names
397         - basso continuo
398         - Syntax/parser
399         - MIDI output?
400         - typesetting
402         * Debug logs:
403         - derive lily_stream, Dstream, texstream from ostream?
404         - indentable stream as baseclass for TeX stream, lily stream, Dstream.
405         - use dstream feature in mi2mu
406         - integrate IO checking into stream class
408         * input converters
409         - NIFF?
410         - ABC? 
411         - SMDL?
413         * add to MIDI output:
414         - tempo change
415         - ornaments (and trills?)
416         - repeat
417         - slurs
418         - accents
419         - dynamics
420         - account for rhythmic position in measure
421         - etc.
423         * grace notes
424         - make separate class for Grace_*_engravers 
425         (which is at Voice_gravs level)
426         - make encapsulated spacing problems.
428         * accidentals per Voice_group
430         * Output class, handles : (smallish)
431         - help text /(c) notice?
432         - version line
433         - warning /errors/progress
434         - abort on error/warning; exit status
435         - quiet/ignore-version options
436         - logfile output
438         * piano staff
440         * elaborate Staff_side baseclass:
441         - scripts
442         - text
443         - slur start/end
445         * PS 
446         - speed up PS code.
447         - PS lines to .eps files
448         - write custom prolog
451         * Output an output format independent (ofi) typeset file; and 
452           make ofi2 TeX, MusiXTex, Display PostScript, PostScript,
453           Ascii... interpreters. (difficult)
455         - NIFF ?
456         - Common Music Notation
457         - PostScript output (esp. Beams, Slurs, etc)
458         - Move all Score_elems, into libmutype.a
459         - SGML
461         * Documentation
462         - Doc (C) stuff of sheet music
463         - a better format?  SGML?  TeX?  Info?
464         - a tutorial
466         * more spanners (smallish)
467         - Glissando
468         - trill
470         * Rewrite Stem, Beam and Rhythmic_grouping (hairy)
471         - [c8. c32 c32]
472         - doc on Rhythmic_grouping
473         - general shaving on Beam and Stem
474         - use plet grouping
475         - separate visual from rhythmic info even more
476         - beams over bars
477         - endbeam req should be *after* the duration, so you can do
478         < { [c4]    }
479           { c8. c16 } >
482         * lines:
483         - Ledger lines, should be separate item: Ledger_lines, Ledger_lines
484         - set different line sizes / thicknesses
485         - beam stem showthrough, inter beam sizes (french vs german style)
487         * Collisions
488         - left/right note balls should be handled by Collision:
489         < \multi 2; { \stem 1; <b c> } { <f as b> } >
491         * Keys:
492         - merge key{item} & localkey{item}?
493         - Major/Minor
494         - spacing, national styles?
496         * Support for TAB
497         - redo Notehead to allow digits as heads
498         - add a \tablature {} lexer mode for easy entering
500         * should adjust stemlength for flag number.
502         * breaking:
503         - caching breakpoints
504         - saving them
505         - specify number of lines
507         * markers
509 INPUTLANGUAGE
511         * c4 4 4 4 for c4 c4 c4 c4?
513         * neatly (and readably) expressing concurrent
514         voices
516         * <c f a>4 ?
518         * Viola mode?
520                 @c c g e g 
521         for
522                 c g es g, 
524                 @A c g e g
525         for
526                 cis gis e gis
528         * relative mode for pitch entering
530         * bracket: volta 1,2
532         * configure pitch_byte
534         * rest name configurable
536 SMALLISH PROJECTS
538         * limit memory usage; the full coriolan takes up too much resources.
540         * fix confusing naming in Engraver vs Engraver_group_engraver (context)
542         * progress when creating MIDI elts.
544         * A range for context errors (eg. mark both { and }. )
546         * lyric in staff  (sharpsharp in staff, text below)
548         * half sharps/flats
550         * write Dynamic_line (to group dynamics horizontally)
552         * use Real for all y positions.
553         - use translate_axis( .. ,Y_AXIS)  iso separate variables.
555         * half-sharps, half-flats
557         * adaptive accidental spacing.
559         * handle EOF graciously in error messages.
561         * centered whole rest
563         * declare notenametab?
565         * midi esp.: use I32 iso int where 32 bits are needed (or assumed...)
567         * Flower types:
568         - A decent scalar type
569         - String hash
570         - Pointer hash
572         * binsearch/hash for identifiers
574         * stafftypes: voice names/ instrument names.
576         * lily \tempo
578         * C meter iso 4/4, idem for alla breve, etc.
580         * textspanner: center position
582         *   % toe to bheel   four to five
583             %   ^_u            4_5  
584             %     -                           
585             %  --|x--         --|x--
586             %  --|---         --|---
587             %  --|---         --|---
588           (where "to" is a tiny bow)
590         * auxilliary file for caching info.
592         * Text_crescendo
594         * clean solution for staffsize in items.
596         * revise calcideal
598         * volta
600 IDEAS
603         * Output data structures of Mudela in XML/SGML.
605         * create libmudela, or liblily_frontend
607         * move MIDI stuff (including Quantization) to a ANSI C libmidi library.
609         * use an embedded language: Python, Scheme
610         for: 
611                 - Score_elems
612                 - Translators
614         * y -dims in internote? Staff-space? X-dimensions?
616         * Spacing_request for manually adjusting spacing
618         * caching breakpoints
620         * breath marks 
622         * used fixedpoint arithmetic for min. energy.
624         * move towards incremental algorithms.
626         * far fetched language ideas
627         - design meta-language like TeX and Metafont
628         - programming/macros input
630         * versioning stuff (cvt mudela, mudela, etc.)
632         * Klavarskribo?
634         * lyrics in chords still fuck up.
636         * Use hooks/dependency graphs for properties