Audaspace:
[blender.git] / intern / audaspace / FX / AUD_LoopFactory.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_LoopFactory.h
26  *  \ingroup audfx
27  */
28
29
30 #ifndef __AUD_LOOPFACTORY_H__
31 #define __AUD_LOOPFACTORY_H__
32
33 #include "AUD_EffectFactory.h"
34
35 /**
36  * This factory loops another factory.
37  * \note The reader has to be seekable.
38  */
39 class AUD_LoopFactory : public AUD_EffectFactory
40 {
41 private:
42         /**
43          * The loop count.
44          */
45         const int m_loop;
46
47         // hide copy constructor and operator=
48         AUD_LoopFactory(const AUD_LoopFactory&);
49         AUD_LoopFactory& operator=(const AUD_LoopFactory&);
50
51 public:
52         /**
53          * Creates a new loop factory.
54          * \param factory The input factory.
55          * \param loop The desired loop count, negative values result in endless
56          *        looping.
57          */
58         AUD_LoopFactory(boost::shared_ptr<AUD_IFactory> factory, int loop = -1);
59
60         /**
61          * Returns the loop count.
62          */
63         int getLoop() const;
64
65         virtual boost::shared_ptr<AUD_IReader> createReader();
66 };
67
68 #endif //__AUD_LOOPFACTORY_H__