Updated TODO.
[ahxm.git] / README
blob8d5782a7d0de926bace318ae630bf0596d7aefef
1 Ann Hell Ex Machina README
2 ==========================
4  Ann Hell Ex Machina - Music programming language and compiler
5  Copyright (C) 2003-2006 Angel Ortega <angel@triptico.com>
6  Home Page: http://www.triptico.com/software/ahxm.html
7  Mailing List: mp-subscribe@lists.triptico.com
9 This software is GPL. NO WARRANTY. See file 'COPYING' for details.
11 Introduction
12 ------------
14 Ann Hell Ex Machina (AHXM) is a set of tools for composing and generating
15 music. Given a text file in a special-purpose music definition programming
16 language (the Ann Hell Scripting, or AHS for short), it outputs
17 multi-channel wave files much like a music compiler. The included software
18 synthesizer supports raw PCM, .WAV and .PAT files as instrument definitions
19 and a full set of digital filters as echoes, flangers and reverbs. MIDI
20 output to external synthesizers is also supported.
22 The AHS language resembles text-based music markup as the one in Lilypond,
23 with more specialized commands for the PCM wave generation, digital effects
24 or the MIDI definitions. Simple notes and chords, repeating blocks,
25 patterns, arpeggiators, tempo and measure changes, transpositions, staccato
26 / tenuto, marks, random blocks, are all usable via simple (usually
27 one-letter) commands. Stereo, quad, 5.1 or whatever desired number of audio
28 channels can be used and each software synthesizer note be mapped to any of
29 them freely. Input formats not directly supported can be used via external
30 filters.
32 This is a very personal project and its features are fitted to my own way of
33 making music, so there may be missing capabilities that you, as a musician,
34 consider essential, and others that you may see as superfluous. I don't
35 care. This software is made for me, by me. I'll consider any patch from
36 external developers, but only accept the ones I feel meet my needs.
38 This software is designed for Unix/Linux systems.
40 If you want to hear examples of music made with Ann Hell Ex Machina, go to
41 http://www.triptico.com/annhell/ (the Ann Hell Home Page).
43 Compiling and installing
44 ------------------------
46 As always,
48         ./config.sh
49         make
50         su -c "make install"
52 As this program relies heavily in floating pointing arithmetic, it can
53 benefit greatly from compiler optimizations, so you can try:
55         CFLAGS="-O2 -ffast-math" ./config.sh
56         make
57         su -c "make install"
59 ----
60 Angel Ortega - http://www.triptico.com