FFTLIB User Guide
FFTLIB_fft1dBatched_i32f_c32fc_o32fc.h
Go to the documentation of this file.
1 /*******************************************************************************
2 **+--------------------------------------------------------------------------+**
3 **| **** |**
4 **| **** |**
5 **| ******o*** |**
6 **| ********_///_**** |**
7 **| ***** /_//_/ **** |**
8 **| ** ** (__/ **** |**
9 **| ********* |**
10 **| **** |**
11 **| *** |**
12 **| |**
13 **| Copyright (c) 2017 Texas Instruments Incorporated |**
14 **| |**
15 **| All rights reserved not granted herein. |**
16 **| |**
17 **| Limited License. |**
18 **| |**
19 **| Texas Instruments Incorporated grants a world-wide, royalty-free, |**
20 **| non-exclusive license under copyrights and patents it now or |**
21 **| hereafter owns or controls to make, have made, use, import, offer to |**
22 **| sell and sell ("Utilize") this software subject to the terms herein. |**
23 **| With respect to the foregoing patent license, such license is granted |**
24 **| solely to the extent that any such patent is necessary to Utilize the |**
25 **| software alone. The patent license shall not apply to any |**
26 **| combinations which include this software, other than combinations |**
27 **| with devices manufactured by or for TI ("TI Devices"). No hardware |**
28 **| patent is licensed hereunder. |**
29 **| |**
30 **| Redistributions must preserve existing copyright notices and |**
31 **| reproduce this license (including the above copyright notice and the |**
32 **| disclaimer and (if applicable) source code license limitations below) |**
33 **| in the documentation and/or other materials provided with the |**
34 **| distribution |**
35 **| |**
36 **| Redistribution and use in binary form, without modification, are |**
37 **| permitted provided that the following conditions are met: |**
38 **| |**
39 **| * No reverse engineering, decompilation, or disassembly of this |**
40 **| software is permitted with respect to any software provided in binary |**
41 **| form. |**
42 **| |**
43 **| * any redistribution and use are licensed by TI for use only with |**
44 **| TI Devices. |**
45 **| |**
46 **| * Nothing shall obligate TI to provide you with source code for |**
47 **| the software licensed and provided to you in object code. |**
48 **| |**
49 **| If software source code is provided to you, modification and |**
50 **| redistribution of the source code are permitted provided that the |**
51 **| following conditions are met: |**
52 **| |**
53 **| * any redistribution and use of the source code, including any |**
54 **| resulting derivative works, are licensed by TI for use only with TI |**
55 **| Devices. |**
56 **| |**
57 **| * any redistribution and use of any object code compiled from the |**
58 **| source code and any resulting derivative works, are licensed by TI |**
59 **| for use only with TI Devices. |**
60 **| |**
61 **| Neither the name of Texas Instruments Incorporated nor the names of |**
62 **| its suppliers may be used to endorse or promote products derived from |**
63 **| this software without specific prior written permission. |**
64 **| |**
65 **| DISCLAIMER. |**
66 **| |**
67 **| THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "AS IS" AND ANY |**
68 **| EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |**
69 **| IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |**
70 **| PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL TI AND TI'S LICENSORS BE |**
71 **| LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |**
72 **| CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |**
73 **| SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR |**
74 **| BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, |**
75 **| WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE |**
76 **| OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, |**
77 **| EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |**
78 **+--------------------------------------------------------------------------+**
79 *******************************************************************************/
80 
81 #ifndef FFTLIB_FFT1DBATCHED_I32F_C32FC_O32FC_H_
82 #define FFTLIB_FFT1DBATCHED_I32F_C32FC_O32FC_H_ 1
83 
84 #include "../../common/FFTLIB_types.h"
85 
109 /* PBLOCK has to accommodate certain number of SE/SA configurations */
110 #define FFTLIB_FFT1DBATCHED_I32F_C32FC_O32FC_PBLOCK_SIZE (25 * SE_PARAM_SIZE)
111 
112 #ifdef __cplusplus
113 extern "C" {
114 #endif
115 
148 FFTLIB_STATUS
149 FFTLIB_fft1dBatched_i32f_c32fc_o32fc_init(FFTLIB_F32* pX,
150  FFTLIB_bufParams1D_t* bufParamsX,
151  FFTLIB_F32* pW,
152  FFTLIB_bufParams1D_t* bufParamsW,
153  FFTLIB_F32* pXFFT,
154  FFTLIB_bufParams1D_t* bufParamsXFFT,
155  FFTLIB_F32* pSf,
156  FFTLIB_bufParams1D_t* bufParamsSf,
157  FFTLIB_F32* pY,
158  FFTLIB_bufParams1D_t* bufParamsY,
159  uint32_t numPoints,
160  uint32_t numChannels,
161  uint8_t outmode,
162  void* pBlock);
163 
193 FFTLIB_STATUS
194 FFTLIB_fft1dBatched_i32f_c32fc_o32fc_kernel(FFTLIB_F32* restrict pX,
195  FFTLIB_bufParams1D_t* bufParamsX,
196  FFTLIB_F32* restrict pW,
197  FFTLIB_bufParams1D_t* bufParamsW,
198  FFTLIB_F32* restrict pXFFT,
199  FFTLIB_bufParams1D_t* bufParamsXFFT,
200  FFTLIB_F32* restrict pSf,
201  FFTLIB_bufParams1D_t* bufParamsSf,
202  FFTLIB_F32* restrict pY,
203  FFTLIB_bufParams1D_t* bufParamsY,
204  uint32_t numPoints,
205  uint32_t numChannels,
206  uint8_t outmode,
207  void* pBlock);
208 
234 FFTLIB_STATUS
235 FFTLIB_fft1dBatched_i32f_c32fc_o32fc_checkParams(FFTLIB_F32* pX,
236  FFTLIB_bufParams1D_t* bufParamsX,
237  FFTLIB_F32* pW,
238  FFTLIB_bufParams1D_t* bufParamsW,
239  FFTLIB_F32* pY,
240  FFTLIB_bufParams1D_t* bufParamsY,
241  uint32_t numPoints,
242  uint32_t numChannels,
243  uint8_t outmode,
244  void* pBlock);
251 void split_factor_gen_r2c(FFTLIB_F32* pSFactor, int32_t numPoints);
252 
259 void tw_gen_r2c(FFTLIB_F32* pW, int32_t numPoints);
260 
263 #ifdef __cplusplus
264 }
265 #endif
266 
267 #endif
FFTLIB_STATUS_NAME
FFTLIB_STATUS_NAME
The enumeration of all status codes.
Definition: FFTLIB_types.h:172
FFTLIB_F32
float FFTLIB_F32
Single precision floating point.
Definition: FFTLIB_types.h:169
tw_gen_r2c
void tw_gen_r2c(FFTLIB_F32 *pW, int32_t numPoints)
This function generates twiddle factors required for the N/2-point FFT.
Definition: FFTLIB_fft1d_i32f_c32fc_o32fc_tw_gen.cpp:5
FFTLIB_fft1dBatched_i32f_c32fc_o32fc_kernel
FFTLIB_STATUS FFTLIB_fft1dBatched_i32f_c32fc_o32fc_kernel(FFTLIB_F32 *restrict pX, FFTLIB_bufParams1D_t *bufParamsX, FFTLIB_F32 *restrict pW, FFTLIB_bufParams1D_t *bufParamsW, FFTLIB_F32 *restrict pXFFT, FFTLIB_bufParams1D_t *bufParamsXFFT, FFTLIB_F32 *restrict pSf, FFTLIB_bufParams1D_t *bufParamsSf, FFTLIB_F32 *restrict pY, FFTLIB_bufParams1D_t *bufParamsY, uint32_t numPoints, uint32_t numChannels, uint8_t outmode, void *pBlock)
This function is the main kernel compute function.
Definition: FFTLIB_fft1dBatched_i32f_c32fc_o32fc_ci.cpp:161
split_factor_gen_r2c
void split_factor_gen_r2c(FFTLIB_F32 *pSFactor, int32_t numPoints)
This function generates the split factors required to post process the N/2-point FFT output.
Definition: FFTLIB_fft1d_i32f_c32fc_o32fc_tw_gen.cpp:30
FFTLIB_fft1dBatched_i32f_c32fc_o32fc_init
FFTLIB_STATUS FFTLIB_fft1dBatched_i32f_c32fc_o32fc_init(FFTLIB_F32 *pX, FFTLIB_bufParams1D_t *bufParamsX, FFTLIB_F32 *pW, FFTLIB_bufParams1D_t *bufParamsW, FFTLIB_F32 *pXFFT, FFTLIB_bufParams1D_t *bufParamsXFFT, FFTLIB_F32 *pSf, FFTLIB_bufParams1D_t *bufParamsSf, FFTLIB_F32 *pY, FFTLIB_bufParams1D_t *bufParamsY, uint32_t numPoints, uint32_t numChannels, uint8_t outmode, void *pBlock)
This function should be called before the FFTLIB_fft1dBatched_i32f_c32fc_o32fc_kernel function is cal...
Definition: FFTLIB_fft1dBatched_i32f_c32fc_o32fc_ci.cpp:47
FFTLIB_fft1dBatched_i32f_c32fc_o32fc_checkParams
FFTLIB_STATUS FFTLIB_fft1dBatched_i32f_c32fc_o32fc_checkParams(FFTLIB_F32 *pX, FFTLIB_bufParams1D_t *bufParamsX, FFTLIB_F32 *pW, FFTLIB_bufParams1D_t *bufParamsW, FFTLIB_F32 *pY, FFTLIB_bufParams1D_t *bufParamsY, uint32_t numPoints, uint32_t numChannels, uint8_t outmode, void *pBlock)
This function checks the validity of the parameters passed to FFTLIB_fft1dBatched_i32f_c32fc_o32fc_in...
Definition: FFTLIB_fft1dBatched_i32f_c32fc_o32fc_ci.cpp:370
FFTLIB_bufParams1D_t
A structure for a 1 dimensional buffer descriptor.
Definition: FFTLIB_bufParams.h:83