blender/intern/audaspace/FX/AUD_AccumulatorFactory.h
Joerg Mueller 02d2472baa 3D Audio GSoC:
Code documentation.

Also:
* Fix: rlint for MSVC.
* Minor other small fixes/changes.
2011-08-16 13:00:55 +00:00

72 lines
2.1 KiB
C++

/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* 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.
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file audaspace/FX/AUD_AccumulatorFactory.h
* \ingroup audfx
*/
#ifndef AUD_ACCUMULATORFACTORY
#define AUD_ACCUMULATORFACTORY
#include "AUD_EffectFactory.h"
class AUD_CallbackIIRFilterReader;
/**
* This factory creates an accumulator reader.
*
* The accumulator adds the difference at the input to the last output in case
* it's positive. In additive mode it additionaly adds the difference always.
* So in case the difference is positive, it's added twice.
*/
class AUD_AccumulatorFactory : public AUD_EffectFactory
{
private:
/**
* Whether the accumulator is additive.
*/
const bool m_additive;
// hide copy constructor and operator=
AUD_AccumulatorFactory(const AUD_AccumulatorFactory&);
AUD_AccumulatorFactory& operator=(const AUD_AccumulatorFactory&);
public:
/**
* Creates a new accumulator factory.
* \param factory The input factory.
* \param additive Whether the accumulator is additive.
*/
AUD_AccumulatorFactory(AUD_Reference<AUD_IFactory> factory, bool additive = false);
virtual AUD_Reference<AUD_IReader> createReader();
static sample_t accumulatorFilterAdditive(AUD_CallbackIIRFilterReader* reader, void* useless);
static sample_t accumulatorFilter(AUD_CallbackIIRFilterReader* reader, void* useless);
};
#endif //AUD_ACCUMULATORFACTORY