saf_utility_fft.h

Go to the documentation of this file.

/*
 * Copyright 2019 Leo McCormack
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */
 
#ifndef SAF_FFT_H_INCLUDED
#define SAF_FFT_H_INCLUDED
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#include "saf_utility_complex.h"
 
typedef enum {
    SAF_STFT_BANDS_CH_TIME, 
    SAF_STFT_TIME_CH_BANDS  
}SAF_STFT_FDDATA_FORMAT;
 
/* ========================================================================== */
/*                               Misc. Functions                              */
/* ========================================================================== */
 
void getUniformFreqVector(int fftSize,
                          float fs,
                          float* freqVector);
 
void fftconv(float* x,
             float* h,
             int x_len,
             int h_len,
             int nCH,
             float* y);
 
void fftfilt(float* x,
             float* h,
             int x_len,
             int h_len,
             int nCH,
             float* y);
 
void hilbert(float_complex* x,
             int x_len,
             float_complex* y);
 
 
/* ========================================================================== */
/*                     Short-time Fourier Transform (STFT)                    */
/* ========================================================================== */
 
void saf_stft_create(void ** const phSTFT,
                     int winsize,
                     int hopsize,
                     int nCHin,
                     int nCHout,
                     SAF_STFT_FDDATA_FORMAT FDformat);
 
void saf_stft_destroy(void ** const phSTFT);
 
void saf_stft_forward(void * const hSTFT,
                      float** dataTD,
                      int framesize,
                      float_complex*** dataFD);
 
void saf_stft_backward(void * const hSTFT,
                       float_complex*** dataFD,
                       int framesize,
                       float** dataTD);
 
void saf_stft_flushBuffers(void * const hSTFT);
 
void saf_stft_channelChange(void * const hSTFT,
                            int new_nCHin,
                            int new_nCHout);
 
 
/* ========================================================================== */
/*                Real<->Half-Complex (Conjugate-Symmetric) FFT               */
/* ========================================================================== */
 
void saf_rfft_create(void ** const phFFT,
                     int N);
 
void saf_rfft_destroy(void ** const phFFT);
 
void saf_rfft_forward(void * const hFFT,
                      float* inputTD,
                      float_complex* outputFD);
 
void saf_rfft_backward(void * const hFFT,
                       float_complex* inputFD,
                       float* outputTD);
 
 
/* ========================================================================== */
/*                            Complex<->Complex FFT                           */
/* ========================================================================== */
 
void saf_fft_create(void ** const phFFT,
                    int N);
 
void saf_fft_destroy(void ** const phFFT);
 
void saf_fft_forward(void * const hFFT,
                     float_complex* inputTD,
                     float_complex* outputFD);
 
void saf_fft_backward(void * const hFFT,
                      float_complex* inputFD,
                      float_complex* outputTD);
 
 
#ifdef __cplusplus
}/* extern "C" */
#endif /* __cplusplus */
 
#endif /* SAF_FFT_H_INCLUDED */
 
 /* doxygen addtogroup Utilities */