Cherry pick merge: /branches/soc-2011-pepper/intern/audaspace/OpenAL:r38630
[blender.git] / intern / audaspace / intern / AUD_DefaultMixer.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_DefaultMixer.h
28  *  \ingroup audaspaceintern
29  */
30
31
32 #ifndef AUD_DEFAULTMIXER
33 #define AUD_DEFAULTMIXER
34
35 #include "AUD_Mixer.h"
36
37 /**
38  * This class is able to mix audiosignals of different channel count and sample
39  * rate and convert it to a specific output format.
40  * It uses a default ChannelMapperFactory and a SRCResampleFactory for
41  * the perparation.
42  */
43 class AUD_DefaultMixer : public AUD_Mixer
44 {
45 public:
46         /**
47          * Creates the mixer.
48          */
49         AUD_DefaultMixer(AUD_DeviceSpecs specs);
50
51         /**
52          * This funuction prepares a reader for playback.
53          * \param reader The reader to prepare.
54          * \return The reader that should be used for playback.
55          */
56         virtual AUD_IReader* prepare(AUD_IReader* reader);
57 };
58
59 #endif //AUD_DEFAULTMIXER