svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r22704:22717
[blender.git] / intern / audaspace / SRC / AUD_SRCResampleReader.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_SRCRESAMPLEREADER
27 #define AUD_SRCRESAMPLEREADER
28
29 #include "AUD_EffectReader.h"
30 class AUD_Buffer;
31
32 #include <samplerate.h>
33
34 /**
35  * This class mixes a sound source with help of the SDL library.
36  * Unfortunately SDL is only capable of 8 and 16 bit audio, mono and stereo, as
37  * well as resampling only 2^n sample rate relationships where n is a natural
38  * number.
39  * \warning Although SDL can only resample 2^n sample rate relationships, this
40  *          class doesn't check for compliance, so in case of other factors,
41  *          the behaviour is undefined.
42  */
43 class AUD_SRCResampleReader : public AUD_EffectReader
44 {
45 private:
46         /**
47          * The resampling factor.
48          */
49         double m_factor;
50
51         /**
52          * The sound output buffer.
53          */
54         AUD_Buffer *m_buffer;
55
56         /**
57          * The target specification.
58          */
59         AUD_Specs m_tspecs;
60
61         /**
62          * The sample specification of the source.
63          */
64         AUD_Specs m_sspecs;
65
66         /**
67          * The src state structure.
68          */
69         SRC_STATE* m_src;
70
71 public:
72         /**
73          * Creates a resampling reader.
74          * \param reader The reader to mix.
75          * \param specs The target specification.
76          * \exception AUD_Exception Thrown if the source specification cannot be
77          *            mixed to the target specification or if the reader is
78          *            NULL.
79          */
80         AUD_SRCResampleReader(AUD_IReader* reader, AUD_Specs specs);
81
82         /**
83          * Destroys the reader.
84          */
85         ~AUD_SRCResampleReader();
86
87         /**
88          * The callback function for SRC.
89          * \warning Do not call!
90          * \param data The pointer to the float data.
91          * \return The count of samples in the float data.
92          */
93         long doCallback(float** data);
94
95         virtual void seek(int position);
96         virtual int getLength();
97         virtual int getPosition();
98         virtual AUD_Specs getSpecs();
99         virtual void read(int & length, sample_t* & buffer);
100 };
101
102 #endif //AUD_SRCRESAMPLEREADER