svn merge -r39781:39792 https://svn.blender.org/svnroot/bf-blender/trunk/blender...
[blender-staging.git] / intern / audaspace / FX / AUD_SuperposeFactory.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * Copyright 2009-2011 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 General Public License as published by
12  * the Free Software Foundation; either version 2 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 General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with Audaspace; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file audaspace/FX/AUD_SuperposeFactory.h
28  *  \ingroup audfx
29  */
30
31
32 #ifndef AUD_SUPERPOSEFACTORY
33 #define AUD_SUPERPOSEFACTORY
34
35 #include "AUD_IFactory.h"
36
37 /**
38  * This factory mixes two other factories, playing them the same time.
39  * \note Readers from the underlying factories must have the same sample rate
40  *       and channel count.
41  */
42 class AUD_SuperposeFactory : public AUD_IFactory
43 {
44 private:
45         /**
46          * First played factory.
47          */
48         AUD_Reference<AUD_IFactory> m_factory1;
49
50         /**
51          * Second played factory.
52          */
53         AUD_Reference<AUD_IFactory> m_factory2;
54
55         // hide copy constructor and operator=
56         AUD_SuperposeFactory(const AUD_SuperposeFactory&);
57         AUD_SuperposeFactory& operator=(const AUD_SuperposeFactory&);
58
59 public:
60         /**
61          * Creates a new superpose factory.
62          * \param factory1 The first input factory.
63          * \param factory2 The second input factory.
64          */
65         AUD_SuperposeFactory(AUD_Reference<AUD_IFactory> factory1, AUD_Reference<AUD_IFactory> factory2);
66
67         virtual AUD_Reference<AUD_IReader> createReader();
68 };
69
70 #endif //AUD_SUPERPOSEFACTORY