Debian Codegraph @

aeolus/README

raw
1 AEOLUS 0.8.4 RELEASE NOTES 14/03/2010
2 ============================
3
4 * Five new temperaments provided by Hanno Hoffstadt
5 and Adam Sampson.
6 * Added -s option to select Jack server.
7 * Now using libclalsdrv-2.0.0.
8 * Compiles without warnings with gcc-4.4.3.
9
10
11 AEOLUS 0.8.0 RELEASE NOTES 29/01/2008
12 ============================
13
14 **** Experimental release. ****
15
16 * Requires JACK >= 0.109
17 * Receives MIDI over JACK and via ALSA sequencer.
18 * -C option has been removed, use AmbDec instead.
19 * -B option via ALSA removed.
20
21
22
23 AEOLUS 0.6.6 RELEASE NOTES
24 ============================
25
26
27 1. The stops directory
28 ----------------------
29
30 The aeolus binary itself is a generic organ synth and
31 does not define any instrument. In order to use Aeolus
32 you need a directory containing definitions of stops
33 and of an instrument. The one supplied with the current
34 release has this structure:
35
36
37 stops-0.3.0
38 |
39 |___ Aeolus
40 | |
41 | |____ definition
42 | |____ presets
43 |
44 |___ Aeolus1
45 | |
46 | |____ definition
47 | |____ presets
48 |
49 |___ Aeolus2
50 | |
51 | |____ definition
52 | |____ presets
53 |
54 |___ ***.ae0
55 |___ ***.ae0
56 |___ ***.ae0
57 |___ ...
58 |
59 |___ waves
60 |
61 |___ ***.ae1
62 |___ ***.ae1
63 |___ ***.ae1
64 |___ ...
65
66
67 The 'Aeolus' directory is the default instrument
68 directory. It contains two files: a 'definition'
69 file that specifies the layout of the organ, and
70 'presets' that contains registration and midi presets.
71
72 There can be more than one instrument definition
73 directory (in fact there are two more examples
74 in the supplied stops-0.3.0). These can be selected
75 with a command line option (see below).
76
77 The data in 'presets' only makes sense for one
78 particular instrument, and that's why these files
79 are kept together with the corresponding instrument
80 definition. For binary distributions, there is a
81 configuration option that will make Aeolus save the
82 presets in the users's home (see below). This will
83 allow the user to save presets for one instrument.
84
85 The *.ae0 files contain parameters for the additive
86 synthesis. There is one such file for each rank of
87 pipes in the organ. These are binary files and they
88 should not be edited. 'Power users' can use the built-in
89 synthesis editor to modify them (see section 5).
90
91 The waves directory will be empty initially. When
92 Aeolus starts up, it will compute wavetables, one for
93 each pipe. This is indicated by the flashing stop buttons.
94 The same will happen whenever the tuning or temperament is
95 changed. These wavetables can be saved (so Aeolus will be
96 ready for use much faster next time), but only if the stops
97 directory is writeable for the user. This will not be the
98 case for a binary installation as the stops dir will be
99 system-wide (e.g. /usr/share/Aeolus/stops-0.3.0).
100
101 In order to be able to save wavetables or edited stops
102 the stops directory must be copied to a location where
103 it can be modified by the user, (e.g. ~/stops-0.3.0).
104
105
106 2. Run-time configuration
107 -------------------------
108
109 Aeolus takes run-time options from three sources:
110
111 * the file /etc/aeolus.conf
112 * the file ~/.aeolusrc
113 * command line options
114
115 Apart from empty lines and comments (lines starting with '#')
116 either of the files should just contain the command line options
117 you want to use, on a single line (examples given below).
118
119 If the file in the home directory exists (even empty) then the
120 one in /etc is not used. Options given on the command line override
121 those given in either file.
122
123 Command line options are:
124
125 (audio interface)
126
127 -J Use JACK. This is also the default. The option
128 can be used to override a -A in the files.
129
130 -A Use ALSA. Aeolus should work with the "default"
131 device, but in recent ALSA releases this has a
132 very large buffer size, and this may result in
133 excessive latency. Use of a hardware device and
134 the options below is recommended.
135
136 Sub-options for ALSA and their defaults are:
137
138 -d <device> (default)
139 -r <sample rate> (48000)
140 -p <period size> (1024)
141 -n <number of periods> (2)
142
143 (output channels)
144
145 -C <number of channels>
146
147 The default is 2 (stereo). Other legal values
148 are 4 for four speakers in a square and 8 for
149 eight speaker in cube setup. The built-in
150 Ambisonics decoder used for the latter two
151 formats is quite primitive and will be removed
152 in future versions, to be replaced with a much
153 better external application.
154
155 Speaker order for -C 4 is clockwise starting at
156 front-left. For -C 8 the first four outputs are
157 the 'bottom' speakers, and the next four the
158 'top' ones, each of them in the same order as
159 for -C 4.
160
161 -B This options selects direct Ambisionics first order
162 B-format output, to be used for recording or with
163 an external decoder.
164
165 (resources)
166
167 -S <stops directory>
168
169 The default is ./stops.
170
171 -I <instrument directory>
172
173 This is relative to the stops directory.
174 The default is 'Aeolus'.
175
176 -W <waves directory>
177
178 This is relative to the stops directory.
179 The default is 'waves'. This options mainly exists
180 for use during development and should not be used.
181
182 -u This option is for use with binary distributions
183 only. When used, the presets file will be stored
184 into the user's home directory instead of within
185 the system wide instrument directory.
186
187 (general)
188
189 -t Selects the text mode user interface. With this
190 option Aeolus does not in any way depend on X11.
191 In the current version the text mode UI is just
192 an empty stub and should not be used.
193
194 -h Prints version information and a summary of all
195 command line options.
196
197
198 For example if you always use Aeolus with ALSA device hw:0,
199 using 3 periods of 512 frames and a sample rate of 44.1 kHz,
200 and you have copied the stops directory to your home, then
201 your ~/.aeolusrc could look like this:
202
203 # Aeolus default options
204 -A -d hw:0 -n 2 -p 512 -r 44100 -S /home/login/stops-0.3.0
205
206 where 'login' is your login name.
207
208
209 3. Binary packages
210 ------------------
211
212 This release permits packagers to install a working Aeolus
213 without touching a users's home directory, as follows.
214
215 * Install the aeolus binary in /usr/bin and the two
216 plugins in /usr/lib.
217 * Install the stops directory in /usr/share/Aeolus.
218 * Install this README into /usr/share/doc/packages/Aeolus.
219 * Create the file /etc/aeolus.conf containing:
220
221 # Aeolus default options
222 -u -A -S /usr/share/Aeolus/stops-0.3.0
223
224 This will use the default instrument 'Aeolus', and save the
225 presets in .aeolus-presets in the users's home directory.
226
227
228 4. A quick tour of the GUI
229 --------------------------
230
231 4.1 The main window
232
233 TBC
234
235 4.2 The instrument window
236
237 TBC
238
239 4.3 The audio window
240
241 TBC
242
243 4.4 The midi window
244
245 TBC
246
247
248 5. Editing the synthesis parameters
249 -----------------------------------
250
251 TBC
252
253
254 6. Midi control of stop buttons
255 -------------------------------
256
257 The protocol uses one controller number. The default is #98, but you
258 can change this in global.h. The message is accepted only on channels
259 enabled for control in the midi matrix.
260
261 The value is interpreted as follows:
262
263 v = 01mm0ggg
264
265 This type of messages (bit 6 set) selects a group, and either
266 resets all stops in that group or sets the mode for the second
267 form below.
268
269 mm = mode. This can be:
270
271 00 disabled, also resets all elements in the group.
272 01 set off
273 10 set on
274 11 toggle
275
276 ggg = group, one of the button groups as defined in the instrument
277 definition. In the GUI groups start at the top, the first one (for
278 division III) being group #0.
279
280 The values of mm and ggg are stored and need not be repeated unless
281 they change.
282
283 v = 000bbbbb
284
285 According to the current state of mode, this command switches a
286 stop on or off, or toggles its state, or does nothing at all.
287
288 bbbbb = button index within the group.
289
290 Buttons are numbered left to right, top to bottom within each
291 group. The first one is #0.
292
293
294 EOF
295