Updated TODO.
[ahxm.git] / TODO
blob3cc29af8904653c0c5fa3962432801550ee2497d
1 Ann Hell Ex Machina TODO / Bug List
2 ===================================
4 Release Critical Bugs
5 ---------------------
7  * 1017: mp_doccer documentation is severely outdated.
8  * 1022: Add file name to compiler errors.
9  * 1030: Refactorize the output system to always use a forked process.
10  * 1032: Refactorize input, ss_gen and ss_ins to always use pointers to
11    struct ss_wave instead of copies of them.
12  * 1040: Get rid of all _ prefixed symbols.
13  * 1041: Consider the possibility to avoid having #define CHANNELS at all
14    and always use it as dynamic structures or buffers.
15  * 1042: Add multiple MIDI devices; a configuration file will match device
16    numbers to real addresses in /dev. Then each track in the song file could
17    have a command to set which MIDI device will the events be sent to.
18  * 1043: The same as the multiple MIDI devices, there should exist multiple
19    dsp devices. This way, a unique computer with more than one sound card
20    can output multichannel songs at a time.
22 Open Bugs
23 ---------
25  * 1034: tempo_from_wave() will never work; when the wave is loaded, it's
26    too late for the tempo to be set, as the ss_song stream has no tempo
27    information. The only solution is to just print the optimal tempo, for
28    the ahxm programmer to change it manually.
30 Pending Enhancements
31 --------------------
33  * 1002: Build an audio filtering tool to test effects.
34  * 1003: There should exist 'some kind' of effect for note volumes
35    to add a random variation, to add 'humanity'. This cannot
36    be a standard digital effect as it should be different
37    for each note.
38  * 1005: Vibrato should be variable (from 'no-vibrato' to 'some-vibrato'
39    in the same note).
40  * 1006: A 'choose' option, to take randomly one block or another
41    (blocks seem appropriate, but further study is necessary). A random
42    seed script command is also necessary.
43  * 1007: Support for 'tonalities'; fixed transpositions for each note of
44    the octave so that, for example, a 'f' is always a 'f#'.
45  * 1008: Support for 'keyboard splits': ranges of notes that a track will
46    ignore. This should allow to have multiple tracks playing the same
47    notes but with different channel maps and, for example, having a
48    guitar glissando pan from left to right.
49  * 1010: Loop stretching ('stretch wave without pitch change to last
50    exactly N time units').
51  * 1011: Loop matching ('change wave pitch to last exactly N time units').
52  * 1020: When a source file includes multiple songs, there should exist a
53    way to mark song / track changes. This should be used to include text
54    messages as ID3 tags or even to generate .cue / .toc files.
56 Closed
57 ------
59  * 1000: Convert current event queue to two event queues. The first
60    stage queue should store notes and the second note on / note off
61    events (Tue, 17 Aug 2004 12:00:00 +0200).
62  * 1004: Vibrato for generators (Fri, 13 Aug 2004 11:05:00 +0200).
63  * 1009: Set tempo from a sample loop ('set tempo so that this wave
64    will match exactly one/N measures') (Fri, 16 Aug 2004 18:08:00 +0200).
65  * 1013: Volume should be a command ('v', for example) and not be
66    inherited from previous notes. There should also be settable as
67    relative inc/decrements (as octaves) (Mon, 30 Aug 2004 14:37:59 +0200).
68  * 1014: doc/language.txt is severely outdated
69    (Mon, 30 Aug 2004 15:13:00 +0200)
70  * 1015: Upgrade build system (new config.sh, makefile.in, etc.).
71    (Thu, 09 Sep 2004 18:56:29 +0200).
72  * 1016: Integrate the new compiler (Sun, 12 Sep 2004 16:13:11 +0200).
73  * 1001: Generator should use queues of active / free generators.
74    (Sun, 17 Oct 2004 12:50:10 +0200).
75  * 1012: Portamento should not have a 'time', only a frequency
76    inc/decrement per time unit (Sun, 17 Oct 2004 13:18:04 +0200).
77  * 1018: The 'default' driver should not be bound to the first usable
78    one, but be a sequential try of all available drivers
79    (Thu, 11 Nov 2004 12:18:12 +0100).
80  * 1019: Add libartsc support (Thu, 11 Nov 2004 12:30:02 +0100).
81  * 1023: The SS_FRAMES lex/yacc token should be SS_MSECS, that is,
82    the compiler should not use frames but milliseconds
83    (Tue, 19 Apr 2005 20:05:46 +0200).
84  * 1024: The 'event1' and 'event2' stuff is ugly. It should be called,
85    respectively, 'note stream' (as it's, more or less, device independent)
86    and 'ss stream', which depends of softsynth, frames and such. In the
87    future, there could exist a 'midi stream' if MIDI output is supported
88    (Closed by #1025; Wed, 20 Apr 2005 17:30:31 +0200).
89  * 1033: SONG_EV_SS_NOTE won't work, because freq can't be calculated
90    on compilation time; instead, it should be a generic message
91    (Sat, 23 Apr 2005 10:52:35 +0200).
92  * 1026: Get rid of event.c and event.h (Sat, 23 Apr 2005 12:28:47 +0200).
93  * 1027: Get rid of effect.c and effect.h (Sat, 23 Apr 2005 12:28:51 +0200).
94  * 1031: Add lex/yacc code for processing absolute notes (A1, C#4, F&3)
95    (Sat, 23 Apr 2005 16:14:21 +0200).
96  * 1036: Unify song event types; ss_song should use the same event types
97    (Sun, 24 Apr 2005 10:29:22 +0200).
98  * 1035: The number of compiled tracks should be available somewhere
99    (Sun, 24 Apr 2005 10:35:19 +0200).
100  * 1037: ss_ins_frame() is flawed; as it directly mixes into frame[],
101    each intrument's ss effects affect the previous ones
102    (Mon, 25 Apr 2005 16:42:28 +0200).
103  * 1025: 'event1' has been moved to song.c (generic song event stream)
104    and 'event2' has been moved to ss_song.c (softsynth song event stream),
105    but due to almost all of ss_song.c being private, there is no way to
106    order the instruments and the effects to do anything until a way of
107    storing them is decided. So, project state is really critical now as
108    nothing works (last working version was 'cvs update -D 20050419').
109    (Mon, 25 Apr 2005 18:16:48 +0200).
110  * 1039: Volumes can't be set as integer numbers (0 and 1 should be valid)
111    (Mon, 25 Apr 2005 18:26:06 +0200).
112  * 1038: Comments can't be written inside extended commands
113    (Mon, 25 Apr 2005 18:31:55 +0200).
114  * 1021: Add line number to compiler errors (Mon, 25 Apr 2005 19:11:01 +0200).
115  * 1028: input.c should be ss_input.c (Wed, 27 Apr 2005 08:08:49 +0200).
116  * 1029: output.c should be ss_output.c (Wed, 27 Apr 2005 16:59:34 +0200).
118 Email bugs to angel@triptico.com