svn merge -r39781:39792 https://svn.blender.org/svnroot/bf-blender/trunk/blender...
[blender-staging.git] / intern / audaspace / intern / AUD_Mixer.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_Mixer.h
28  *  \ingroup audaspaceintern
29  */
30
31
32 #ifndef AUD_MIXER
33 #define AUD_MIXER
34
35 #include "AUD_ConverterFunctions.h"
36 #include "AUD_Buffer.h"
37 #include "AUD_Reference.h"
38 class AUD_IReader;
39
40 /**
41  * This abstract class is able to mix audiosignals with same channel count
42  * and sample rate and convert it to a specific output format.
43  */
44 class AUD_Mixer
45 {
46 protected:
47         /**
48          * The output specification.
49          */
50         AUD_DeviceSpecs m_specs;
51
52         /**
53          * The length of the mixing buffer.
54          */
55         int m_length;
56
57         /**
58          * The mixing buffer.
59          */
60         AUD_Buffer m_buffer;
61
62         /**
63          * Converter function.
64          */
65         AUD_convert_f m_convert;
66
67 public:
68         /**
69          * Creates the mixer.
70          */
71         AUD_Mixer(AUD_DeviceSpecs specs);
72
73         /**
74          * Destroys the mixer.
75          */
76         virtual ~AUD_Mixer() {}
77
78         /**
79          * Returns the target specification for superposing.
80          * \return The target specification.
81          */
82         AUD_DeviceSpecs getSpecs() const;
83
84         /**
85          * Sets the target specification for superposing.
86          * \param specs The target specification.
87          */
88         void setSpecs(AUD_Specs specs);
89
90         /**
91          * Mixes a buffer.
92          * \param buffer The buffer to superpose.
93          * \param start The start sample of the buffer.
94          * \param length The length of the buffer in samples.
95          * \param volume The mixing volume. Must be a value between 0.0 and 1.0.
96          */
97         void mix(sample_t* buffer, int start, int length, float volume);
98
99         /**
100          * Writes the mixing buffer into an output buffer.
101          * \param buffer The target buffer for superposing.
102          * \param volume The mixing volume. Must be a value between 0.0 and 1.0.
103          */
104         void read(data_t* buffer, float volume);
105
106         /**
107          * Clears the mixing buffer.
108          * \param length The length of the buffer in samples.
109          */
110         void clear(int length);
111 };
112
113 #endif //AUD_MIXER