Blame doc/upmix.txt

Packit Service cd2a00
UPMIX PLUGIN
Packit Service cd2a00
============
Packit Service cd2a00
Packit Service cd2a00
The upmix plugin is an easy-to-use plugin for upmixing to 4 or
Packit Service cd2a00
6-channel stream.  The number of channels to be expanded is determined
Packit Service cd2a00
by the slave PCM or explicitly via channel option.  For example, the
Packit Service cd2a00
following PCM defines upmixing to 5.1 from 1-6 channels input:
Packit Service cd2a00
Packit Service cd2a00
	pcm.upmix51 {
Packit Service cd2a00
		type upmix
Packit Service cd2a00
		slave.pcm "surround51"
Packit Service cd2a00
	}
Packit Service cd2a00
Packit Service cd2a00
You can use this PCM as a default one by defining below:
Packit Service cd2a00
Packit Service cd2a00
	pcm.!default "plug:upmix51"
Packit Service cd2a00
Packit Service cd2a00
The upmix plugin copies left and right channels to rear left and right
Packit Service cd2a00
with a certain delay.  The delay size can be specified by "delay" PCM
Packit Service cd2a00
option in msec.  For example, to set 10ms delay in the above case:
Packit Service cd2a00
Packit Service cd2a00
	pcm.upmix51 {
Packit Service cd2a00
		type upmix
Packit Service cd2a00
		slave.pcm "surround51"
Packit Service cd2a00
		delay 10
Packit Service cd2a00
	}
Packit Service cd2a00
Packit Service cd2a00
As default, 15ms delay is used.
Packit Service cd2a00
Packit Service cd2a00
The channel option specifies the number of channels of output.  Either
Packit Service cd2a00
4 or 6 channels are supported.  When 0 is passed, the plugin tries 4
Packit Service cd2a00
or 6 channels appropriately suitable for the slave pcm.  The channel
Packit Service cd2a00
option is useful if the slave PCM has no strict input condition (like
Packit Service cd2a00
plug or route plugin).
Packit Service cd2a00
Packit Service cd2a00
	pcm.myupmix {
Packit Service cd2a00
		type upmix
Packit Service cd2a00
		slave.pcm "something"
Packit Service cd2a00
		channels 6
Packit Service cd2a00
	}
Packit Service cd2a00
Packit Service cd2a00
The center and LFE channels are the average of sum of left and right
Packit Service cd2a00
signals.
Packit Service cd2a00
Packit Service cd2a00
The accepted format is currently only S16.