ti/dsplib/src/DSPF_sp_fir_cplx/c674/DSPF_sp_fir_cplx.h

   1 /* ======================================================================= */
   2 /* DSPF_sp_fir_cplx.h -- Complex FIR Filter                                */
   3 /*              Optimized C Implementation (w/ Intrinsics)                 */
   4 /*                                                                         */
   5 /* Rev 0.0.1                                                               */
   6 /*                                                                         */
   7 /* Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/  */
   8 /*                                                                         */
   9 /*                                                                         */
  10 /*  Redistribution and use in source and binary forms, with or without     */
  11 /*  modification, are permitted provided that the following conditions     */
  12 /*  are met:                                                               */
  13 /*                                                                         */
  14 /*    Redistributions of source code must retain the above copyright       */
  15 /*    notice, this list of conditions and the following disclaimer.        */
  16 /*                                                                         */
  17 /*    Redistributions in binary form must reproduce the above copyright    */
  18 /*    notice, this list of conditions and the following disclaimer in the  */
  19 /*    documentation and/or other materials provided with the               */
  20 /*    distribution.                                                        */
  21 /*                                                                         */
  22 /*    Neither the name of Texas Instruments Incorporated nor the names of  */
  23 /*    its contributors may be used to endorse or promote products derived  */
  24 /*    from this software without specific prior written permission.        */
  25 /*                                                                         */
  26 /*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS    */
  27 /*  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT      */
  28 /*  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR  */
  29 /*  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT   */
  30 /*  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,  */
  31 /*  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT       */
  32 /*  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,  */
  33 /*  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY  */
  34 /*  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT    */
  35 /*  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE  */
  36 /*  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.   */
  37 /*                                                                         */
  38 /* ======================================================================= */
  39
  40 #ifndef DSPF_SP_FIR_CPLX_H_
  41 #define DSPF_SP_FIR_CPLX_H_
  42
  43 /** @ingroup FILTCONV */
  44 /* @{ */
  45
  46 /** @defgroup  DSPF_sp_fir_cplx */
  47 /** @ingroup DSPF_sp_fir_cplx */
  48 /* @{ */
  49
  50 /**
  51  *   This function implements the FIR filter for complex input data.
  52  *   The filter has nr output samples and nh coefficients. Each array
  53  *   consists of an even and odd term with even terms representing the
  54  *   real part and the odd terms the imaginary part of the element.
  55  *   The coefficients are expected in normal order.
  56  *
  57  *     @param x[2*(nr+nh-1)]  Pointer to complex input array.
  58  *                            The input data pointer x must point to
  59  *                            the (nh)th complex element.
  60  *     @param h[2*nh]         Pointer to complex coefficient array.
  61  *     @param r[2*nr]         Pointer to complex output array.
  62  *     @param nh              Number of complex coefficients in vector h.
  63  *     @param nr              Number of complex output samples to calculate.
  64  *
  65  * @par Algorithm:
  66  * DSPF_sp_fir_cplx_cn.c is the natural C equivalent of the optimized
  67  * linear assembly code without restrictions. Note that the linear
  68  * assembly code is optimized and restrictions may apply.
  69  *
  70  * @par Assumptions:
  71  *    nr is a multiple of 2 and greater than or equal to 2. <BR>
  72  *    nh is a multiple of 2 and greater than or equal to 5. <BR>
  73  *    x, h and r are double-word aligned. <BR>
  74  *    x points to 2*(nh-1)th input element. <BR>
  75  *
  76  * @par Implementation Notes:
  77  * @b Interruptibility: The code is interruptible. <BR>
  78  * @b Endian Support: The code supports both big and little endian modes. <BR>
  79  *
  80  */
  81
  82 void DSPF_sp_fir_cplx(const float * x, const float * h,
  83     float * restrict y, int nh, int nr);
  84
  85 void DSPF_sp_fir_cplx_opt(const float * x, const float * h,
  86     float * restrict y, int nh, int ny);
  87
  88 #endif /* DSPF_SP_FIR_CPLX_H_ */
  89
  90 /* ======================================================================= */
  91 /*  End of file:  DSPF_sp_fir_cplx.h                                       */
  92 /* ----------------------------------------------------------------------- */
  93 /*            Copyright (c) 2011 Texas Instruments, Incorporated.          */
  94 /*                           All Rights Reserved.                          */
  95 /* ======================================================================= */
  96