blender/intern/audaspace/fftw/AUD_BandPassReader.h
Campbell Barton 8c68ed6df1 Cleanup: remove redundant, invalid info from headers
BF-admins agree to remove header information that isn't useful,
to reduce noise.

- BEGIN/END license blocks

  Developers should add non license comments as separate comment blocks.
  No need for separator text.

- Contributors

  This is often invalid, outdated or misleading
  especially when splitting files.

  It's more useful to git-blame to find out who has developed the code.

See P901 for script to perform these edits.
2019-02-02 02:40:00 +11:00

99 lines
2.1 KiB
C++

/*
* Copyright 2009-2011 Jörg Hermann Müller
*
* This file is part of AudaSpace.
*
* Audaspace is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* AudaSpace is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Audaspace; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file audaspace/fftw/AUD_BandPassReader.h
* \ingroup audfftw
*/
#ifndef __AUD_BANDPASSREADER_H__
#define __AUD_BANDPASSREADER_H__
#include <fftw3.h>
#include "AUD_EffectReader.h"
class AUD_Buffer;
/**
* This class only passes a specific frequency band of another reader.
*/
class AUD_BandPassReader : public AUD_EffectReader
{
private:
/**
* The playback buffer.
*/
AUD_Buffer *m_buffer;
/**
* The input buffer for fourier transformations.
*/
AUD_Buffer *m_in;
/**
* The output buffer for fourier transformations.
*/
AUD_Buffer *m_out;
/**
* The lowest passed frequency.
*/
float m_low;
/**
* The highest passed frequency.
*/
float m_high;
/**
* The fftw plan for forward transformation.
*/
fftw_plan m_forward;
/**
* The fftw plan for backward transformation.
*/
fftw_plan m_backward;
/**
* The length of the plans.
*/
int m_length;
public:
/**
* Creates a new band pass reader.
* \param reader The reader to read from.
* \param low The lowest passed frequency.
* \param high The highest passed frequency.
*/
AUD_BandPassReader(AUD_IReader* reader, float low, float high);
/**
* Destroys the reader.
*/
virtual ~AUD_BandPassReader();
virtual AUD_ReaderType getType();
virtual void read(int & length, sample_t* & buffer);
};
#endif //__AUD_BANDPASSREADER_H__