jack: Use boundary as hw_ptr wrap around
[alsa-plugins.git] / doc / upmix.txt
1 UPMIX PLUGIN
2 ============
3
4 The upmix plugin is an easy-to-use plugin for upmixing to 4 or
5 6-channel stream.  The number of channels to be expanded is determined
6 by the slave PCM or explicitly via channel option.  For example, the
7 following PCM defines upmixing to 5.1 from 1-6 channels input:
8
9         pcm.upmix51 {
10                 type upmix
11                 slave.pcm "surround51"
12         }
13
14 You can use this PCM as a default one by defining below:
15
16         pcm.!default "plug:upmix51"
17
18 The upmix plugin copies left and right channels to rear left and right
19 with a certain delay.  The delay size can be specified by "delay" PCM
20 option in msec.  For example, to set 10ms delay in the above case:
21
22         pcm.upmix51 {
23                 type upmix
24                 slave.pcm "surround51"
25                 delay 10
26         }
27
28 As default, 15ms delay is used.
29
30 The channel option specifies the number of channels of output.  Either
31 4 or 6 channels are supported.  When 0 is passed, the plugin tries 4
32 or 6 channels appropriately suitable for the slave pcm.  The channel
33 option is useful if the slave PCM has no strict input condition (like
34 plug or route plugin).
35
36         pcm.myupmix {
37                 type upmix
38                 slave.pcm "something"
39                 channels 6
40         }
41
42 The center and LFE channels are the average of sum of left and right
43 signals.
44
45 The accepted format is currently only S16.