lilypond-1.0.13
[lilypond.git] / TODO
blob0ff8de840f9de981939ae15213e004d053c14e59
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         * fix \n after proccing
15  Summary of minor spelling irregularities:
16 >   capitalization/use of underscores in property names
17 >   \lyric vs \notes  \lyric vs \type Lyrics  (\lyric should have an -s)
19         * fix Score.skipBars
21         * repeat bars: need distance after ":|" and before "|:"
23         * \shape 1st dim skipped? 
25         * fix marks/barnumbers/marginal notes
27 ****
30         * uniformise property names.
32         * ydirection <-> yDirection
34         * typo checks on property names?
36         * egcs-1.1 support
38         * make engraver hacking robust.
40         * use streambufs and iostream
41         to provide IO handling for TeX stream, mudela stream, data-file.
43         * seriously buffer TeX output (do profile of writing .5 mb TeX file.)
45         * strip EXEs before installing
47         * zip target for binary windows dist (JBR)
49         * text continuationss
51         * revise documentation
53         * abbrev -> tremolo
55         * junking \skip req in lyrics
57         * Language:
58         - general plet mechanism.
60                 \plet 2/3 { c8 c8 c8 }
62         ie.
64                 Music: PLET int '/' int Music
66         - \type -> \context ?
67         - \translator -> ?
68         - fix \partial 
69         - \bla {} vs \bla ; 
70         - mix engraver hacking with music ?
71         - \once\property  KEY = VAL
72         - \addtranslator, \removetranslator
73         - junk ^ and _ for scripts
74         - junk _ for lyrics.
75         - abstract grammar.
77         * install TeX stuff into tex/generic directory.
79         * /etc/profile.d support for RPM.
81         * percussion note heads
83         * mi2mu empty staffs.
85         * include MIDI list 
87         * make GNU style webpages.
89         * There seems to be an install error in lilypond-1.0.0.  Most of the
90         files in the "init" directory don't get installed in the
91         /usr/local/share/lilypond directory.  The files installed are of
92         the form feta*.ly.  In particular init.ly doesn't get installed.
93         I installed the files by hand and then the system seems to work.
95         * midi_instrument -> midiInstrument
97         * horizontal centering of dynamics 
99         * \font\fontA=feta20.afm (.afm?)
101         * gzip RH manpage
103         * stable make/config stuff
105         * stemup/stemdown; see test/updown.fly
106           - check examples; add \type Staff hither and thether
108         * $DEPENDENCIES_OUTPUT support
110         * use a fake-yodl.sh to mimick yodl when yodl is not installed
112         * fix BUGs
114         * fix weird behaviour when .AFMs not found.
116         * Xdvi zooming ?!
117                 gs: Error: /undefined in draw_beam
118                 gs: Operand stack:
120         * run texhash after installing .tex
122         * fix vertical alignment and stafflines
124         * GrandStaff needs more work -- I want a single word
125         `harpsichord' to the left of the grandstaff, not one on each
126         stave.  (Organ staff -- with separate pedal -- but common
127         properties may be something to think about.  Of course for
128         organ you want to be able to give stop indications on the way
129         through, so the \property Voice.Instrument would be a stop,
130         and \property GrandStaff.instrument would be PipeOrgan...)
132         * make Tie_req a "command" { <c g> ~ <c g> }
134         * bib ep1988
136         * revise the Score_priority_align_engraver concept.  It sucks. 
138         * ly2xdvi, ly2ps
140         * make new VoiceOne, VoiceTwo, VoiceThree contexts with
141 ydirection and hshift preset
143         * *.yo: fix pod manpage layout legacy
145         * text-items clash with stems/beams
147         * --include, -I option for ly2dvi (pass on to lily)
149         * fix placement of beam-less abbrev
151         * \meter 3/4;
152         <{\voiceone cis4. cis8 cis4 | cis4 cis cis | r1 }
153          {\voicetwo cis,4 r r | r2. | r1 }> |
154         }
156         * try to use template<Type> iso MACRO(Type)
158         - NEWS: ... Musical_pitch (analogous to Duration and Rhythmic_req)
159           think about, analogous to pitch: 
160            * { a4 a16 } c <-- duration of c?
161            * <a4 b8> c <-- duration of c?
163         * \tempo 4. = 90;
165         * fix audio-items (don't use (input) requests, but copy data)
167         * junk My_lily_parser::abbrev_beam_type_i_ 
169         * make sure all ex's have a mudela-version
171         * do rest-collisions for Multi_measure_rests as well.
173         * split error/warning in error/warning/non_fatal_error
175         * add a Duration_convert member to Duration_iter to set parameters.
176         Junk global duration settings. 
178         * deps for ly2dvi
180         * clean up abbrev/plet/beam/abbrevbeam/duration mess in parser.
182         * minimum length second part broken tie
184         * en-,discouraged linebreaking: 
185           - handle DISALLOW < penalty > FORCE
186           - discourage breaking of slurs
188         * multibar rest
189           - symbol(s)
191         * fix variable define/lookup parser global<->paper
193         * fix title/instrument placements; see input/test/title.ly
195         * <\voiceone c4. \voicetwo c4>
197         * add full cello suites to web site (kom op, Maarten!)
199         * Rethink Time_description
200           * \cadenza , \meter, \grouping should all be \properties
202         * rename
203           - plet -> tuplet
204           - measure -> bar
205           - abbreviation-beam -> (measured/unmeasured) tremolo
206           - partial -> anacrouse
208         * libtoolize flowerlib
210         * shared lib
212         * robustify Beam (in case of no stems, 32nd notes)
214         * decentralised spring factory
216         * move paper vars into engraver properties
218         * check for groff / troff/ nroff et
220         * more intelligent file searching
221         - use kpsepath
222         - make LilyPond fully relocatable
224         * use kpsepath to find all TeX dirs
225         - configure.in 
226         - clean-fonts.sh
228         * nicen examples:
229         - break-up heavily-nested score blocks
231         * disable spaces in TeX stuff
232         
233         * handle ^C for tmp/file creation.
235         * dots & rest collisions.
237         * documentation
238         - introduction?
239         - info?
240         - LaTeX?
241         - more manpages?
243         * versioning for Feta
245         * the warning about the negative slur/tie length appears twice
246         which is irritating.
248         * The `3' in the meter key is a one or two pixels too thin (at 600dpi)
249         in the middle:
251         * the bracket is ugly (wings are too parabolic, should be more circular)
253         * better hshift (dots, distance, head dependent)
255         * clefs (AG): The "8" should appear closer to the actual clef,
256           touching it.
258         * scoping for properties?
260         {       c4
261                 \multi 2  < { \stemup .. } { \stemdown .. } >
262                 c2 
263         }
265         this modifies \stem for the c2
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         * egcs-1.03 ice: stem.cc:327; should localize bug (mine's still 10K)
314         * gcc 2.8.1: see ice and RESIZE_ICE
316         * xdvi: PS in magnifying glass.
318         * GNU diff 2.7: diff -rN does not see a new directory with empty file
320         * GNU patch 2.1: <must find simple example> if patch chokes on a
321           hunk, or on allegedly unsorted hunks in a diff, it may stop 
322           without a trace of failure (create .rej file, print error or 
323           dump core) and just ignore any further diffs.
325         * glibc 2.0:
327           f = fopen ("/dev/null", "r")
328           assert (feof (f))
330 3RD PARTY PROJECTS:
332         * GNU indent: handle C++
334         * GNU make: move hardcoded builtin rules to runtime ?
336         * GNU patch 
337           - 'double-fix' mode: ignore identical fix, rather than suggest 
338             to revert patch direction when (more or less? exactly) the same 
339             thing is fixed
341 PROJECTS
343         * Scripts:
344         - fix position of bar number
345         - stack scripts in chords:
346           % fingering:        footing:
347             < a-4 c-2 g-1 >   < c-\ltoe e-\lheel >
348         - script-spacing
349         - slur parts as a script
350         - stack parameterised scripts for fingering and footing:
352         * convert-mudela:
353         - automatically add  a \version if not present.
354         - better parsing
355         - make smarter
356         - convert-mudela -e empty.ly
358         * emacs mudela-mode
359         -  should handle block comments too.
360         -  handle lexer modes (\header, \melodic, \lyric) etc.
361         -  indentation
362         -  notenames?
363         -  fontlock: \melodic \melodic
366         * use properties for:
367         - plet?
368         - Staff_sym size
369         - default tempo.
370         - font size
371         - bartypes (get rid of derived Span_bar_engravers)
372         - cadenza mode? 
374         * page handling:
375         - PS output
376         - optimal pagebreaking.
378         * Unicode support? -> man 7 unicode
379         - 16 bit Strings
380         - -u switch
381         - detect of 16/8 bit files
382         - examples to go with it.
384         * Spring_spacer:
385         - write a faster Spring_spacer (without matrices if possible)
386         - use straight LP to find minimal "fitting force"
387         - relate energybound to linelen unitspace fontsize etc.
388         - used fixed point fp
390         * \header
391         - output header info to MIDI too.
393         * a musical dictionary. See Documentation/vocabulary-*, other
394         languages:
395         - explanations
396         - italian
397         - german
398         - dutch
399         - swedish
400          .. ?
402         * chords
403         - guitar chords
404         - chord names
405         - basso continuo
406         - Syntax/parser
407         - MIDI output?
408         - typesetting
410         * Debug logs:
411         - derive lily_stream, Dstream, texstream from ostream?
412         - indentable stream as baseclass for TeX stream, lily stream, Dstream.
413         - use dstream feature in mi2mu
414         - integrate IO checking into stream class
416         * input converters
417         - NIFF?
418         - ABC? 
419         - SMDL?
421         * add to MIDI output:
422         - tempo change
423         - ornaments (and trills?)
424         - repeat
425         - slurs
426         - accents
427         - dynamics
428         - account for rhythmic position in measure
429         - etc.
431         * grace notes
432         - make separate class for Grace_*_engravers 
433         (which is at Voice_gravs level)
434         - make encapsulated spacing problems.
436         * accidentals per Voice_group
438         * Output class, handles : (smallish)
439         - help text /(c) notice?
440         - version line
441         - warning /errors/progress
442         - abort on error/warning; exit status
443         - quiet/ignore-version options
444         - logfile output
446         * piano staff
448         * elaborate Staff_side baseclass:
449         - scripts
450         - text
451         - slur start/end
453         * PS 
454         - speed up PS code.
455         - PS lines to .eps files
456         - write custom prolog
459         * Output an output format independent (ofi) typeset file; and 
460           make ofi2 TeX, MusiXTex, Display PostScript, PostScript,
461           Ascii... interpreters. (difficult)
463         - NIFF ?
464         - Common Music Notation
465         - PostScript output (esp. Beams, Slurs, etc)
466         - Move all Score_elems, into libmutype.a
467         - SGML
470         * Documentation
471         - Doc (C) stuff of sheet music
472         - a better format?  SGML?  TeX?  Info?
473         - a tutorial
475         * more spanners (smallish)
476         - Glissando
477         - trill
479         * Rewrite Stem, Beam and Rhythmic_grouping (hairy)
480         - [c8. c32 c32]
481         - doc on Rhythmic_grouping
482         - general shaving on Beam and Stem
483         - use plet grouping
484         - separate visual from rhythmic info even more
485         - beams over bars
486         - endbeam req should be *after* the duration, so you can do
487         < { [c4]    }
488           { c8. c16 } >
491         * lines:
492         - Ledger lines, should be separate item: Ledger_lines, Ledger_lines
493         - set different line sizes / thicknesses
494         - beam stem showthrough, inter beam sizes (french vs german style)
496         * Collisions
497         - left/right note balls should be handled by Collision:
498         < \multi 2; { \stem 1; <b c> } { <f as b> } >
500         * Keys:
501         - merge key{item} & localkey{item}?
502         - Major/Minor
503         - spacing, national styles?
505         * Support for TAB
506         - redo Notehead to allow digits as heads
507         - add a \tablature {} lexer mode for easy entering
509         * should adjust stemlength for flag number.
511         * breaking:
512         - caching breakpoints
513         - saving them
514         - specify number of lines
516         * markers
518 INPUTLANGUAGE
520         * c4 4 4 4 for c4 c4 c4 c4?
522         * neatly (and readably) expressing concurrent
523         voices
525         * <c f a>4 ?
527         * Viola mode?
529                 @c c g e g 
530         for
531                 c g es g, 
533                 @A c g e g
534         for
535                 cis gis e gis
537         * relative mode for pitch entering
539         * bracket: volta 1,2
541         * configure pitch_byte
543         * rest name configurable
545 SMALLISH PROJECTS
547         * limit memory usage; the full coriolan takes up too much resources.
549         * fix confusing naming in Engraver vs Engraver_group_engraver (context)
551         * progress when creating MIDI elts.
553         * A range for context errors (eg. mark both { and }. )
555         * lyric in staff  (sharpsharp in staff, text below)
557         * half sharps/flats
559         * write Dynamic_line (to group dynamics horizontally)
561         * use Real for all y positions.
562         - use translate_axis( .. ,Y_AXIS)  iso separate variables.
564         * half-sharps, half-flats
566         * adaptive accidental spacing.
568         * handle EOF graciously in error messages.
570         * centered whole rest
572         * declare notenametab?
574         * midi esp.: use I32 iso int where 32 bits are needed (or assumed...)
576         * Flower types:
577         - A decent scalar type
578         - String hash
579         - Pointer hash
581         * binsearch/hash for identifiers
583         * stafftypes: voice names/ instrument names.
585         * lily \tempo
587         * C meter iso 4/4, idem for alla breve, etc.
589         * textspanner: center position
591         *   % toe to bheel   four to five
592             %   ^_u            4_5  
593             %     -                           
594             %  --|x--         --|x--
595             %  --|---         --|---
596             %  --|---         --|---
597           (where "to" is a tiny bow)
599         * auxilliary file for caching info.
601         * Text_crescendo
603         * clean solution for staffsize in items.
605         * revise calcideal
607         * volta
609 IDEAS
612         * Output data structures of Mudela in XML/SGML.
614         * create libmudela, or liblily_frontend
616         * move MIDI stuff (including Quantization) to a ANSI C libmidi library.
618         * use an embedded language: Python, Scheme
619         for: 
620                 - Score_elems
621                 - Translators
623         * y -dims in internote? Staff-space? X-dimensions?
625         * Spacing_request for manually adjusting spacing
627         * caching breakpoints
629         * breath marks 
631         * used fixedpoint arithmetic for min. energy.
633         * move towards incremental algorithms.
635         * far fetched language ideas
636         - design meta-language like TeX and Metafont
637         - programming/macros input
639         * versioning stuff (cvt mudela, mudela, etc.)
641         * Klavarskribo?
643         * lyrics in chords still fuck up.
645         * Use hooks/dependency graphs for properties