copying 2.5 over to trunk
[blender.git] / intern / audaspace / intern / AUD_ChannelMapperFactory.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_CHANNELMAPPERFACTORY
27 #define AUD_CHANNELMAPPERFACTORY
28
29 #include "AUD_MixerFactory.h"
30
31 /**
32  * This factory creates a reader that maps a sound source's channels to a
33  * specific output channel count.
34  */
35 class AUD_ChannelMapperFactory : public AUD_MixerFactory
36 {
37 private:
38         /**
39          * The mapping specification.
40          */
41         float **m_mapping[9];
42
43 public:
44         AUD_ChannelMapperFactory(AUD_IReader* reader, AUD_Specs specs);
45         AUD_ChannelMapperFactory(AUD_IFactory* factory, AUD_Specs specs);
46         AUD_ChannelMapperFactory(AUD_Specs specs);
47
48         virtual ~AUD_ChannelMapperFactory();
49
50         /**
51          * Returns the mapping array for editing.
52          * \param ic The count of input channels the array should have.
53          * \note The count of output channels is read of the desired output specs.
54          */
55         float** getMapping(int ic);
56
57         /**
58          * Deletes the current channel mapping.
59          */
60         void deleteMapping(int ic);
61
62         virtual AUD_IReader* createReader();
63 };
64
65 #endif //AUD_CHANNELMAPPERFACTORY