FFTPlan_8h_source.html

/*******************************************************************************

* Copyright 2015-2016 Juan Francisco Crespo Galán

*

* Licensed under the Apache License, Version 2.0 (the "License");

* you may not use this file except in compliance with the License.

* You may obtain a copy of the License at

*

*   http://www.apache.org/licenses/LICENSE-2.0

*

* Unless required by applicable law or agreed to in writing, software

* distributed under the License is distributed on an "AS IS" BASIS,

* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

* See the License for the specific language governing permissions and

* limitations under the License.

******************************************************************************/


#pragma once


#include <complex>

#include <fftw3.h>

#include "Audaspace.h"


#include <memory>

#include <vector>


#define DEFAULT_N 4096


AUD_NAMESPACE_BEGIN


class AUD_API FFTPlan

{

private:

    int m_N;


    fftwf_plan m_fftPlanR2C;


    fftwf_plan m_fftPlanC2R;


    unsigned int m_bufferSize;


    // delete copy constructor and operator=

    FFTPlan(const FFTPlan&) = delete;

    FFTPlan& operator=(const FFTPlan&) = delete;


public:

    FFTPlan(double measureTime = 0);


    FFTPlan(int n, double measureTime = 0);

    ~FFTPlan();


    int getSize();


    void FFT(void* buffer);


    void IFFT(void* buffer);


    void* getBuffer();


    void freeBuffer(void* buffer);

};


AUD_NAMESPACE_END

Audaspace.h
The main header file of the library defining the namespace and basic data types.

AUD_NAMESPACE_END
#define AUD_NAMESPACE_END
Closes the audaspace namespace aud.
Definition Audaspace.h:119

AUD_NAMESPACE_BEGIN
#define AUD_NAMESPACE_BEGIN
Opens the audaspace namespace aud.
Definition Audaspace.h:116

AUD_API
#define AUD_API
Used for exporting symbols in the shared library.
Definition Audaspace.h:93

FFTPlan::getSize
int getSize()
Retrieves the size of the FFT plan.

FFTPlan::FFT
void FFT(void *buffer)
Calculates the FFT of an input buffer with the current plan.

FFTPlan::FFTPlan
FFTPlan(int n, double measureTime=0)
Creates a new FFTPlan object with a custom size.

FFTPlan::freeBuffer
void freeBuffer(void *buffer)
Frees one of the buffers reserved with the getRealOnlyBuffer(), getComplexOnlyBuffer() or getInplaceB...

FFTPlan::getBuffer
void * getBuffer()
Reserves memory for a buffer that can be used for inplace transformations with this plan.

FFTPlan::IFFT
void IFFT(void *buffer)
Calculates the IFFT of an input buffer with the current plan.

FFTPlan::FFTPlan
FFTPlan(double measureTime=0)
Creates a new FFTPlan object with DEFAULT_N size (4096).