doc/language2.txt

   1 Ann Hell Ex Machina Scripting - II: Extended Commands
   2 =====================================================
   3
   4  Angel Ortega <angel@triptico.com>
   5
   6 Overview
   7 --------
   8
   9 Those directives that are not pure music instructions or are specific to a
  10 given output mode are called extended commands. They are expressed as
  11 curly bracket-enclosed blocks of keywords directly followed by their
  12 optional, respective arguments. As for the basic commands, formatting and
  13 indentation is free-form.
  14
  15 Extended commands are interleaved with basic commands, they are inserted
  16 exactly where found and can be enclosed in blocks or group structures as
  17 well.
  18
  19 Software synthesizer commands
  20 -----------------------------
  21
  22 wav
  23 ~~~
  24
  25  wav "file.wav" <base note>
  26  wav "file.wav" <base note> <min note> <max note>
  27  wav "file.wav" <base note> <min note> <max note> <loop start> <loop end>
  28
  29 pat
  30 ~~~
  31
  32  pat "file.pat"
  33
  34 sustain
  35 ~~~~~~~
  36
  37  sustain <time>
  38
  39 vibrato
  40 ~~~~~~~
  41
  42  vibrato <depth> <frequency>
  43
  44 Examples
  45
  46  /* depth values from 0.45 to 0.68 are fine, as well as 6hz */
  47  vibrato 0.45ms 6
  48
  49 channel
  50 ~~~~~~~
  51
  52  channel <channel #> <volume>
  53
  54 vol
  55 ~~~
  56
  57  vol <volume>
  58  vol <volume> <volume>
  59  vol <volume> <volume> <volume>
  60  vol <volume> <volume> <volume> <volume>
  61  vol <volume> <volume> <volume> <volume> <volume> <volume>
  62
  63 pitch_stretch
  64 ~~~~~~~~~~~~~
  65
  66  pitch_stretch <note> <length in wholes> <volume>
  67
  68 time_stretch
  69 ~~~~~~~~~~~~
  70
  71  time_stretch <note> <length in wholes> <volume>
  72
  73 This command is NOT IMPLEMENTED.
  74
  75 Digital effect commands
  76 -----------------------
  77
  78 delay
  79 ~~~~~
  80
  81  delay <channel> <time>
  82
  83 echo
  84 ~~~~
  85
  86  echo <channel> <time> <gain>
  87
  88 comb
  89 ~~~~
  90
  91  comb <channel> <time> <gain>
  92
  93 allpass
  94 ~~~~~~~
  95
  96  allpass <channel> <time> <gain>
  97
  98 flanger
  99 ~~~~~~~
 100
 101  flanger <channel> <time> <gain> <depth> <freq> <phase>
 102
 103 Examples
 104
 105  /* good stereo flanger */
 106  flanger 0 1s 0.9 3.40ms 0.1 0
 107  flanger 1 1s 0.9 3.40ms 0.1 0.25
 108
 109 wobble
 110 ~~~~~~
 111
 112  wobble <channel> <freq> <phase>
 113
 114 square_wobble
 115 ~~~~~~~~~~~~~
 116
 117  square_wobble <channel> <freq> <phase>
 118
 119 fader
 120 ~~~~~
 121
 122  fader <channel> <size> <initial volume> <final volume>
 123
 124 reverb
 125 ~~~~~~
 126
 127  reverb <channel>
 128
 129 This reverb is defined as
 130
 131  allpass 0 20ms 0.9
 132  allpass 0 36ms 0.9
 133  allpass 0 39ms 0.9
 134
 135 off
 136 ~~~
 137
 138  off <channel>
 139
 140 This command resets the digital effect chain for <channel>.
 141
 142 MIDI commands
 143 -------------
 144
 145 midi_channel
 146 ~~~~~~~~~~~~
 147
 148  midi_channel <channel #>
 149
 150 midi_program
 151 ~~~~~~~~~~~~
 152
 153  midi_program <program #>
 154
 155 ----
 156 Angel Ortega - http://www.triptico.com