ee9e94d91aed9a08f4820e3862b4b41a83b9cb77
[ep-processor-libraries/dsplib.git] / ti / dsplib / src / DSP_fft16x16r / c64P / DSP_fft16x16r.h
1 /* ======================================================================= */
2 /* DSP_fft16x16r.h -- 16x16r Mixed Radix FFT                               */
3 /*                    Serial ASM Implementation                            */
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 /* ======================================================================= */
40 #ifndef DSP_FFT16X16R_H_
41 #define DSP_FFT16X16R_H_ 1
43 #ifndef __TI_COMPILER_VERSION__           // for non TI compiler
44 #include "assert.h"                       // intrinsics prototypes
45 #include "C6xSimulator.h"                 // intrinsics prototypes
46 #include "C6xSimulator_type_modifiers.h"  // define/undefine typing keywords
47 #endif
49 /** @ingroup FFT */
50 /* @{ */
52 /** @defgroup DSP_fft16x16r */
53 /** @ingroup DSP_fft16x16r */
54 /* @{ */
56 /**
57  *      This routine implements a complex forward mixed radix FFT 
58  *      with scaling, rounding and digit reversal. Input data x[ ], 
59  *      output data y[ ], and coefficients w[ ] are 16-bit. The output 
60  *      is returned in the separate array y[ ] in normal order. Each 
61  *      complex value is stored as interleaved 16-bit real and imaginary 
62  *      parts. The code uses a special ordering of FFT coefficients
63  *      (also called twiddle factors).
64  *
65  *      This redundant set of twiddle factors is size 2*N short samples.
66  *      As pointed out in subsequent sections, dividing these twiddle 
67  *      factors by 2 will give an effective divide by 4 at each stage 
68  *      to guarantee no overflow. The function is accurate to about 68dB 
69  *      of signal to noise ratio to the DFT function as follows.
70  *
71  *          @param  n      = length of fft in complex samples
72  *          @param  ptr_x  = pointer to complex data input
73  *          @param  ptr_w  = pointer to complex twiddle factor
74  *          @param  ptr_y  = pointer to complex data output
75  *          @param  radix  = smallest fft butterfly used in computation
76  *          @param  offset = index in complex samples of sub-fft from start of main fft
77  *          @param  n_max  = size of main fft in complex samples
78  *
79  * @par Algorithm:
80  * DSP_fft16x16r_cn.c is the natural C equivalent of the optimized intrinsic
81  * C code without restrictions. Note that the intrinsic C code is optimized
82  * and restrictions may apply.  
83  * 
84  * @par Assumptions:
85  *     In-place computation is not allowed. <BR>                            
86  *     Size of FFT, nx, must be power of 2 and 16<=nx<=65536. <BR>                                 
87  *     The arrays for the complex input data x[], complex output data y[]
88  *        and twiddle factor w[] must be double word aligned. <BR>
89  *     The input and output data are complex, with the real/imaginary 
90  *        components stored in adjacent locations in the array.  The real
91  *        components are stored at even array indices, and the imaginary 
92  *        components are stored at odd array indices. <BR>
93  *     All data are in short precision or Q.15 format. Allowed input 
94  *        dynamic range is 16 - (log2(nx)-ceil[log4(nx)-1]). <BR>                    
95  *
96  * @par Implementation Notes:
97  *    The intrinsic optimized C code supports both big and little endian modes. <BR> 
98  *    The linear assembly code supports little endian mode only. <BR> 
99  * @b Interruptibility: The code is interruptible. <BR>
100  *
101  */
103 void DSP_fft16x16r (
104     int n,
105     short * restrict ptr_x,
106     const short * restrict ptr_w,
107     short * restrict ptr_y,
108     int radix,
109     int offset,
110     int n_max
111 );
113 #endif
115 /* ======================================================================== */
116 /*  End of file:  DSP_fft16x16r.h                                           */
117 /* ------------------------------------------------------------------------ */
118 /*            Copyright (c) 2011 Texas Instruments, Incorporated.           */
119 /*                           All Rights Reserved.                           */
120 /* ======================================================================== */