Diffstat (limited to 'Documentation/dtas-xdelay.txt')
1 files changed, 57 insertions, 0 deletions
diff --git a/Documentation/dtas-xdelay.txt b/Documentation/dtas-xdelay.txt
new file mode 100644
@@ -0,0 +1,57 @@
+% dtas-xdelay(1) dtas user manual
+dtas-xdelay - play audio with a crossover delay
+dtas-xdelay [OPTIONS] INPUT1 INPUT2 DELAY
+dtas-xdelay will delay an audio band by a given delay (in seconds or
+fractions thereof). This can be useful for tuning a sub/sat speaker
+system. It is intended for use a dtas-player sink command as displayed
+in the synopsis.
+The INPUT arguments (/dev/fd/lo and /dev/fd/hi) are automatically
+changed by dtas-player to match the given file descriptors of the pipes.
+Both descriptors receive the same audio data, but will be split using a
+Linkwitz-Riley crossover. The high-band (second argument) will be
+delayed by default.
+To set this via dtas-player to delay the high frequencies by 20ms.
+ dtas-ctl sink ed SINKNAME \
+ command='dtas-xdelay /dev/fd/lo /dev/fd/hi 0.020'
+-x, \--crossover-frequency FREQUENCY
+: Frequency at which to set the crossover. This defaults to 80 (Hz).
+: Delay the lowpass frequency instead of the highpass one.
+SOXFMT - this environment is automatically set if used as a dtas-player
+DTAS_PLAYER_SOCK - the path to the dtas-player control socket.
+This defaults to ~/.dtas/player.sock
+The author of this knows little about signal processing and is just
+parroting things he's learned on the sox documentation and mailing list.
+Corrections greatly appreciated (email Eric Wong email@example.com)
+# SEE ALSO
+dtas-player(1), dtas-player_protocol(7), dtas-ctl(1), sox(1)