a962fe8c96dd016508c89ecb6968aa315a484759
[ep-processor-libraries/dsplib.git] / ti / dsplib / src / DSP_fft16x16r / c66 / DSP_fft16x16r.h
1 /* ======================================================================= */
2 /* DSP_fft16x16r.h -- 16x16r Mixed Radix FFT                               */
3 /*                    Intrinsic C Implementation                           */
4 /*                                                                         */
5 /* Rev 0.0.1                                                               */
6 /*                                                                         */
7 /*                                                                         */
8 /* Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/  */ 
9 /*                                                                         */
10 /*                                                                         */
11 /*  Redistribution and use in source and binary forms, with or without     */
12 /*  modification, are permitted provided that the following conditions     */
13 /*  are met:                                                               */
14 /*                                                                         */
15 /*    Redistributions of source code must retain the above copyright       */
16 /*    notice, this list of conditions and the following disclaimer.        */
17 /*                                                                         */
18 /*    Redistributions in binary form must reproduce the above copyright    */
19 /*    notice, this list of conditions and the following disclaimer in the  */
20 /*    documentation and/or other materials provided with the               */
21 /*    distribution.                                                        */
22 /*                                                                         */
23 /*    Neither the name of Texas Instruments Incorporated nor the names of  */
24 /*    its contributors may be used to endorse or promote products derived  */
25 /*    from this software without specific prior written permission.        */
26 /*                                                                         */
27 /*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS    */
28 /*  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT      */
29 /*  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR  */
30 /*  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT   */
31 /*  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,  */
32 /*  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT       */
33 /*  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,  */
34 /*  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY  */
35 /*  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT    */
36 /*  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE  */
37 /*  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.   */
38 /*                                                                         */
39 /* ======================================================================= */
41 #ifndef DSP_FFT16X16R_H_
42 #define DSP_FFT16X16R_H_ 1
44 #ifndef __TI_COMPILER_VERSION__           // for non TI compiler
45 #include "assert.h"                       // intrinsics prototypes
46 #include "C6xSimulator.h"                 // intrinsics prototypes
47 #include "C6xSimulator_type_modifiers.h"  // define/undefine typing keywords
48 #endif
50 /** @ingroup FFT */
51 /* @{ */
53 /** @defgroup  DSP_fft16x16r */
54 /** @ingroup DSP_fft16x16r */
55 /* @{ */
57 /**
58  *      This routine implements a complex forward mixed radix FFT 
59  *      with scaling, rounding and digit reversal. Input data x[ ], 
60  *      output data y[ ], and coefficients w[ ] are 16-bit. The output 
61  *      is returned in the separate array y[ ] in normal order. Each 
62  *      complex value is stored as interleaved 16-bit real and imaginary 
63  *      parts.
64  *
65  *          @param  n      = length of fft in complex samples
66  *          @param  ptr_x  = pointer to complex data input
67  *          @param  ptr_w  = pointer to complex twiddle factor
68  *          @param  ptr_y  = pointer to complex data output
69  *          @param  radix  = smallest fft butterfly used in computation
70  *          @param  offset = index in complex samples of sub-fft from start of main fft
71  *          @param  n_max  = size of main fft in complex samples
72  *
73  * @par Algorithm:
74  * DSP_fft16x16r_cn.c is the natural C equivalent of the optimized intrinsic
75  * C code without restrictions. Note that the intrinsic C code is optimized
76  * and restrictions may apply.  
77  * 
78  * @par Assumptions:
79  *     In-place computation is not allowed. <BR>                             
80  *     Size of FFT, nx, must be power of 2 and 16<=nx<=65536. <BR>                                 
81  *     The arrays for the complex input data x[], complex output data y[]
82  *        and twiddle factor w[] must be double word aligned. <BR>
83  *     The input and output data are complex, with the real/imaginary 
84  *        components stored in adjacent locations in the array.  The real
85  *        components are stored at even array indices, and the imaginary 
86  *        components are stored at odd array indices. <BR>
87  *     All data are in short precision or Q.15 format. Allowed input 
88  *        dynamic range is 16 - (log2(nx)-ceil[log4(nx)-1]). <BR>                    
89  *
90  * @par Implementation Notes:
91  * @b Endian Support: The code supports both big and little endian modes. <BR> 
92  * @b Interruptibility: The code is interruptible. <BR>
93  *
94  */
96 void DSP_fft16x16r (
97     int n,
98     short * restrict ptr_x,
99     const short * restrict ptr_w,
100     short * restrict ptr_y,
101     int radix,
102     int offset,
103     int n_max
104 );
106 #endif
108 /* ======================================================================== */
109 /*  End of file:  DSP_fft16x16r.h                                           */
110 /* ------------------------------------------------------------------------ */
111 /*            Copyright (c) 2011 Texas Instruments, Incorporated.           */
112 /*                           All Rights Reserved.                           */
113 /* ======================================================================== */