Audaspace:
[blender.git] / intern / audaspace / FX / AUD_SuperposeFactory.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_SuperposeFactory.h
26  *  \ingroup audfx
27  */
28
29
30 #ifndef __AUD_SUPERPOSEFACTORY_H__
31 #define __AUD_SUPERPOSEFACTORY_H__
32
33 #include "AUD_IFactory.h"
34
35 /**
36  * This factory mixes two other factories, playing them the same time.
37  * \note Readers from the underlying factories must have the same sample rate
38  *       and channel count.
39  */
40 class AUD_SuperposeFactory : public AUD_IFactory
41 {
42 private:
43         /**
44          * First played factory.
45          */
46         boost::shared_ptr<AUD_IFactory> m_factory1;
47
48         /**
49          * Second played factory.
50          */
51         boost::shared_ptr<AUD_IFactory> m_factory2;
52
53         // hide copy constructor and operator=
54         AUD_SuperposeFactory(const AUD_SuperposeFactory&);
55         AUD_SuperposeFactory& operator=(const AUD_SuperposeFactory&);
56
57 public:
58         /**
59          * Creates a new superpose factory.
60          * \param factory1 The first input factory.
61          * \param factory2 The second input factory.
62          */
63         AUD_SuperposeFactory(boost::shared_ptr<AUD_IFactory> factory1, boost::shared_ptr<AUD_IFactory> factory2);
64
65         virtual boost::shared_ptr<AUD_IReader> createReader();
66 };
67
68 #endif //__AUD_SUPERPOSEFACTORY_H__