Blame doc/upmix.txt

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