unify include guard defines, __$FILENAME__
[blender-staging.git] / intern / audaspace / intern / AUD_SinusReader.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_SinusReader.h
26  *  \ingroup audaspaceintern
27  */
28
29
30 #ifndef __AUD_SINUSREADER_H__
31 #define __AUD_SINUSREADER_H__
32
33 #include "AUD_IReader.h"
34 #include "AUD_Buffer.h"
35
36 /**
37  * This class is used for sine tone playback.
38  * The sample rate can be specified, the signal is mono.
39  */
40 class AUD_SinusReader : public AUD_IReader
41 {
42 private:
43         /**
44          * The frequency of the sine wave.
45          */
46         const float m_frequency;
47
48         /**
49          * The current position in samples.
50          */
51         int m_position;
52
53         /**
54          * The sample rate for the output.
55          */
56         const AUD_SampleRate m_sampleRate;
57
58         // hide copy constructor and operator=
59         AUD_SinusReader(const AUD_SinusReader&);
60         AUD_SinusReader& operator=(const AUD_SinusReader&);
61
62 public:
63         /**
64          * Creates a new reader.
65          * \param frequency The frequency of the sine wave.
66          * \param sampleRate The output sample rate.
67          */
68         AUD_SinusReader(float frequency, AUD_SampleRate sampleRate);
69
70         virtual bool isSeekable() const;
71         virtual void seek(int position);
72         virtual int getLength() const;
73         virtual int getPosition() const;
74         virtual AUD_Specs getSpecs() const;
75         virtual void read(int& length, bool& eos, sample_t* buffer);
76 };
77
78 #endif //__AUD_SINUSREADER_H__