mirror/kissfft
1
0
Fork 0
mirror of https://github.com/mborgerding/kissfft.git synced 2025-05-27 21:20:27 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
lucifetsmith 2019-01-26 12:04:56 +08:00 committed by GitHub
parent 5ba824ceec
commit a74d6edce9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -2,6 +2,7 @@
KISS FFT - A mixed-radix Fast Fourier Transform based up on the principle, KISS FFT - A mixed-radix Fast Fourier Transform based up on the principle,
"Keep It Simple, Stupid." "Keep It Simple, Stupid."
There are many great fft libraries already around. Kiss FFT is not trying There are many great fft libraries already around. Kiss FFT is not trying
to be better than any of them. It only attempts to be a reasonably efficient, to be better than any of them. It only attempts to be a reasonably efficient,
moderately useful FFT that can use fixed or floating data types and can be moderately useful FFT that can use fixed or floating data types and can be
@ -69,16 +70,16 @@ last bit of performance.
**Sometimes simpler is better, even if it's not better.** **Sometimes simpler is better, even if it's not better.**
## FREQUENTLY ASKED QUESTIONS: ## FREQUENTLY ASKED QUESTIONS:
> Q: Can I use kissfft in a project with a ___ license? > Q: Can I use kissfft in a project with a ___ license?</br>
> A: Yes. See LICENSE below. > A: Yes. See LICENSE below.
>Q: Why don't I get the output I expect? > Q: Why don't I get the output I expect?</br>
> A: The two most common causes of this are > A: The two most common causes of this are
> 1) scaling : is there a constant multiplier between what you got and what you want? > 1) scaling : is there a constant multiplier between what you got and what you want?
> 2) mixed build environment -- all code must be compiled with same preprocessor > 2) mixed build environment -- all code must be compiled with same preprocessor
> definitions for FIXED_POINT and kiss_fft_scalar > definitions for FIXED_POINT and kiss_fft_scalar
> Q: Will you write/debug my code for me? > Q: Will you write/debug my code for me?</br>
> A: Probably not unless you pay me. I am happy to answer pointed and topical questions, but > A: Probably not unless you pay me. I am happy to answer pointed and topical questions, but
> I may refer you to a book, a forum, or some other resource. > I may refer you to a book, a forum, or some other resource.
@ -99,7 +100,7 @@ Transforming 5 minutes of CD quality audio takes less than a second (nfft=1024).
Kiss FFT uses a time decimation, mixed-radix, out-of-place FFT. If you give it an input buffer Kiss FFT uses a time decimation, mixed-radix, out-of-place FFT. If you give it an input buffer
and output buffer that are the same, a temporary buffer will be created to hold the data. and output buffer that are the same, a temporary buffer will be created to hold the data.
No static data is used. The core routines of kiss_fft are thread-safe (but not all of the tools directory). No static data is used. The core routines of kiss_fft are thread-safe (but not all of the tools directory).[
No scaling is done for the floating point version (for speed). No scaling is done for the floating point version (for speed).
Scaling is done both ways for the fixed-point version (for overflow prevention). Scaling is done both ways for the fixed-point version (for overflow prevention).