Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

OpenSolaris 2009.06 - man page for mlib_signalcrosscorrel_s16s (opensolaris section 3mlib)

mlib_SignalCrossCorrel_S16(3MLIB)			    mediaLib Library Functions				 mlib_SignalCrossCorrel_S16(3MLIB)

NAME
mlib_SignalCrossCorrel_S16, mlib_SignalCrossCorrel_S16S, mlib_SignalCrossCorrel_F32, mlib_SignalCrossCorrel_F32S - signal cross correlation
SYNOPSIS
cc [ flag... ] file... -lmlib [ library... ] #include <mlib.h> mlib_status mlib_SignalCrossCorrel_S16(mlib_d64 *correl, const mlib_s16 *src1, const mlib_s16 *src2, mlib_s32 n); mlib_status mlib_SignalCrossCorrel_S16S(mlib_d64 *correl, const mlib_s16 *src1, const mlib_s16 *src2, mlib_s32 n); mlib_status mlib_SignalCrossCorrel_F32(mlib_d64 *correl, const mlib_f32 *src1, const mlib_f32 *src2, mlib_s32 n); mlib_status mlib_SignalCrossCorrel_F32S(mlib_d64 *correl, const mlib_f32 *src1, const mlib_f32 *src2, mlib_s32 n);
DESCRIPTION
Each of these functions performs cross correlation. For monaural signals, the following equation is used: 1 n-1 correl[0] = --- * SUM (src1[i] * src2[i]) n i=0 For stereo signals, the following equation is used: 1 n-1 correl[0] = --- * SUM (src1[2*i] * src2[2*i]) n i=0 1 n-1 correl[1] = --- * SUM (src1[2*i + 1] * src2[2*i + 1]) n i=0
PARAMETERS
Each of the functions takes the following arguments: correl Pointer to the cross correlation array. In the stereo version, correl[0] contains the cross correlation of channel 0, and cor- rel[1] contains the cross correlation of channel 1. src1 First source signal array. src2 Second source signal array. n Number of samples in the source signal arrays.
RETURN VALUES
Each of the functions returns MLIB_SUCCESS if successful. Otherwise it returns MLIB_FAILURE.
ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Committed | +-----------------------------+-----------------------------+ |MT-Level |MT-Safe | +-----------------------------+-----------------------------+
SEE ALSO
mlib_SignalAutoCorrel_S16(3MLIB), attributes(5) SunOS 5.11 2 Mar 2007 mlib_SignalCrossCorrel_S16(3MLIB)

Featured Tech Videos