Sound:
[blender-staging.git] / intern / audaspace / FX / AUD_LoopFactory.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN LGPL LICENSE BLOCK *****
5  *
6  * Copyright 2009 Jörg Hermann Müller
7  *
8  * This file is part of AudaSpace.
9  *
10  * AudaSpace is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU Lesser General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * AudaSpace is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * along with AudaSpace.  If not, see <http://www.gnu.org/licenses/>.
22  *
23  * ***** END LGPL LICENSE BLOCK *****
24  */
25
26 #ifndef AUD_LOOPFACTORY
27 #define AUD_LOOPFACTORY
28
29 #include "AUD_EffectFactory.h"
30
31 /**
32  * This factory loops another factory.
33  * \note The reader has to be seekable.
34  */
35 class AUD_LoopFactory : public AUD_EffectFactory
36 {
37 private:
38         /**
39          * The loop count.
40          */
41         int m_loop;
42
43 public:
44         /**
45          * Creates a new loop factory.
46          * \param factory The input factory.
47          * \param loop The desired loop count, negative values result in endless
48          *        looping.
49          */
50         AUD_LoopFactory(AUD_IFactory* factory = 0, int loop = -1);
51
52         /**
53          * Creates a new loop factory.
54          * \param loop The desired loop count, negative values result in endless
55          *        looping.
56          */
57         AUD_LoopFactory(int loop);
58
59         /**
60          * Returns the loop count.
61          */
62         int getLoop();
63
64         /**
65          * Sets the loop count.
66          * \param loop The desired loop count, negative values result in endless
67          *        looping.
68          */
69         void setLoop(int loop);
70
71         virtual AUD_IReader* createReader();
72 };
73
74 #endif //AUD_LOOPFACTORY