3D Audio GSoC:
[blender.git] / intern / audaspace / intern / AUD_ChannelMapperReader.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/intern/AUD_ChannelMapperReader.h
28  *  \ingroup audaspaceintern
29  */
30
31
32 #ifndef AUD_CHANNELMAPPERREADER
33 #define AUD_CHANNELMAPPERREADER
34
35 #include "AUD_EffectReader.h"
36 #include "AUD_Buffer.h"
37
38 /**
39  * This class maps a sound source's channels to a specific output channel count.
40  * \note The input sample format must be float.
41  */
42 class AUD_ChannelMapperReader : public AUD_EffectReader
43 {
44 private:
45         /**
46          * The sound reading buffer.
47          */
48         AUD_Buffer m_buffer;
49
50         /**
51          * The output specification.
52          */
53         AUD_Specs m_specs;
54
55         /**
56          * The channel count of the reader.
57          */
58         int m_rch;
59
60         /**
61          * The mapping specification.
62          */
63         float **m_mapping;
64
65         // hide copy constructor and operator=
66         AUD_ChannelMapperReader(const AUD_ChannelMapperReader&);
67         AUD_ChannelMapperReader& operator=(const AUD_ChannelMapperReader&);
68
69 public:
70         /**
71          * Creates a channel mapper reader.
72          * \param reader The reader to map.
73          * \param mapping The mapping specification as two dimensional float array.
74          */
75         AUD_ChannelMapperReader(AUD_Reference<AUD_IReader> reader, float **mapping);
76
77         /**
78          * Destroys the reader.
79          */
80         ~AUD_ChannelMapperReader();
81
82         virtual AUD_Specs getSpecs() const;
83         virtual void read(int & length, sample_t* buffer);
84 };
85
86 #endif //AUD_CHANNELMAPPERREADER