Manual Pages for UNIX Operating System command usage for man mlib_SignalCrossCorrel_S16

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_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:





SunOS 5.11           Last change: 2 Mar 2007                    1






mediaLib Library Functions      mlib_SignalCrossCorrel_S16(3MLIB)



     correl    Pointer to the cross  correlation  array.  In  the
               stereo   version,  correl[0]  contains  the  cross
               correlation of channel 0, and  correl[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  attri-
     butes:



     ____________________________________________________________
    |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
    |_____________________________|_____________________________|
    | Interface Stability         | Committed                   |
    |_____________________________|_____________________________|
    | MT-Level                    | MT-Safe                     |
    |_____________________________|_____________________________|


SEE ALSO
     mlib_SignalAutoCorrel_S16(3MLIB), attributes(5)



















SunOS 5.11           Last change: 2 Mar 2007                    2