unify include guard defines, __$FILENAME__
[blender-staging.git] / intern / audaspace / intern / AUD_ConverterReader.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_ConverterReader.h
26  *  \ingroup audaspaceintern
27  */
28
29
30 #ifndef __AUD_CONVERTERREADER_H__
31 #define __AUD_CONVERTERREADER_H__
32
33 #include "AUD_EffectReader.h"
34 #include "AUD_ConverterFunctions.h"
35 #include "AUD_Buffer.h"
36
37 /**
38  * This class converts a sound source from one to another format.
39  */
40 class AUD_ConverterReader : public AUD_EffectReader
41 {
42 private:
43         /**
44          * The sound output buffer.
45          */
46         AUD_Buffer m_buffer;
47
48         /**
49          * The target specification.
50          */
51         AUD_SampleFormat m_format;
52
53         /**
54          * Converter function.
55          */
56         AUD_convert_f m_convert;
57
58         // hide copy constructor and operator=
59         AUD_ConverterReader(const AUD_ConverterReader&);
60         AUD_ConverterReader& operator=(const AUD_ConverterReader&);
61
62 public:
63         /**
64          * Creates a converter reader.
65          * \param reader The reader to convert.
66          * \param specs The target specification.
67          */
68         AUD_ConverterReader(AUD_Reference<AUD_IReader> reader, AUD_DeviceSpecs specs);
69
70         virtual void read(int& length, bool& eos, sample_t* buffer);
71 };
72
73 #endif //__AUD_CONVERTERREADER_H__