Audaspace:
[blender-staging.git] / intern / audaspace / FX / AUD_DelayFactory.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * Copyright 2009-2011 Jörg Hermann Müller
5  *
6  * This file is part of AudaSpace.
7  *
8  * Audaspace is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * AudaSpace is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with Audaspace; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /** \file audaspace/FX/AUD_DelayFactory.h
26  *  \ingroup audfx
27  */
28
29
30 #ifndef __AUD_DELAYFACTORY_H__
31 #define __AUD_DELAYFACTORY_H__
32
33 #include "AUD_EffectFactory.h"
34
35 /**
36  * This factory plays another factory delayed.
37  */
38 class AUD_DelayFactory : public AUD_EffectFactory
39 {
40 private:
41         /**
42          * The delay in samples.
43          */
44         const float m_delay;
45
46         // hide copy constructor and operator=
47         AUD_DelayFactory(const AUD_DelayFactory&);
48         AUD_DelayFactory& operator=(const AUD_DelayFactory&);
49
50 public:
51         /**
52          * Creates a new delay factory.
53          * \param factory The input factory.
54          * \param delay The desired delay in seconds.
55          */
56         AUD_DelayFactory(boost::shared_ptr<AUD_IFactory> factory, float delay = 0);
57
58         /**
59          * Returns the delay in seconds.
60          */
61         float getDelay() const;
62
63         virtual boost::shared_ptr<AUD_IReader> createReader();
64 };
65
66 #endif //__AUD_DELAYFACTORY_H__