0de9b7fc7dc5caf8f7e923d87709fdcb26e8c974
[blender-staging.git] / intern / audaspace / intern / AUD_Mixer.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * Copyright 2009-2011 Jörg Hermann Müller
5  *
6  * This file is part of AudaSpace.
7  *
8  * Audaspace is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * AudaSpace is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with Audaspace; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /** \file audaspace/intern/AUD_Mixer.h
26  *  \ingroup audaspaceintern
27  */
28
29
30 #ifndef __AUD_MIXER_H__
31 #define __AUD_MIXER_H__
32
33 #include "AUD_ConverterFunctions.h"
34 #include "AUD_Buffer.h"
35 #include "AUD_Reference.h"
36 class AUD_IReader;
37
38 /**
39  * This abstract class is able to mix audiosignals with same channel count
40  * and sample rate and convert it to a specific output format.
41  */
42 class AUD_Mixer
43 {
44 protected:
45         /**
46          * The output specification.
47          */
48         AUD_DeviceSpecs m_specs;
49
50         /**
51          * The length of the mixing buffer.
52          */
53         int m_length;
54
55         /**
56          * The mixing buffer.
57          */
58         AUD_Buffer m_buffer;
59
60         /**
61          * Converter function.
62          */
63         AUD_convert_f m_convert;
64
65 public:
66         /**
67          * Creates the mixer.
68          */
69         AUD_Mixer(AUD_DeviceSpecs specs);
70
71         /**
72          * Destroys the mixer.
73          */
74         virtual ~AUD_Mixer() {}
75
76         /**
77          * Returns the target specification for superposing.
78          * \return The target specification.
79          */
80         AUD_DeviceSpecs getSpecs() const;
81
82         /**
83          * Sets the target specification for superposing.
84          * \param specs The target specification.
85          */
86         void setSpecs(AUD_Specs specs);
87
88         /**
89          * Mixes a buffer.
90          * \param buffer The buffer to superpose.
91          * \param start The start sample of the buffer.
92          * \param length The length of the buffer in samples.
93          * \param volume The mixing volume. Must be a value between 0.0 and 1.0.
94          */
95         void mix(sample_t* buffer, int start, int length, float volume);
96
97         /**
98          * Writes the mixing buffer into an output buffer.
99          * \param buffer The target buffer for superposing.
100          * \param volume The mixing volume. Must be a value between 0.0 and 1.0.
101          */
102         void read(data_t* buffer, float volume);
103
104         /**
105          * Clears the mixing buffer.
106          * \param length The length of the buffer in samples.
107          */
108         void clear(int length);
109 };
110
111 #endif //__AUD_MIXER_H__