svn merge -r 31060:31144 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[blender.git] / intern / audaspace / intern / AUD_SinusReader.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_SINUSREADER
27 #define AUD_SINUSREADER
28
29 #include "AUD_IReader.h"
30 #include "AUD_Buffer.h"
31
32 /**
33  * This class is used for sine tone playback.
34  * The output format is in the 16 bit format and stereo, the sample rate can be
35  * specified.
36  * As the two channels both play the same the output could also be mono, but
37  * in most cases this will result in having to resample for output, so stereo
38  * sound is created directly.
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 playback buffer.
55          */
56         AUD_Buffer m_buffer;
57
58         /**
59          * The sample rate for the output.
60          */
61         const AUD_SampleRate m_sampleRate;
62
63         // hide copy constructor and operator=
64         AUD_SinusReader(const AUD_SinusReader&);
65         AUD_SinusReader& operator=(const AUD_SinusReader&);
66
67 public:
68         /**
69          * Creates a new reader.
70          * \param frequency The frequency of the sine wave.
71          * \param sampleRate The output sample rate.
72          */
73         AUD_SinusReader(float frequency, AUD_SampleRate sampleRate);
74
75         virtual bool isSeekable() const;
76         virtual void seek(int position);
77         virtual int getLength() const;
78         virtual int getPosition() const;
79         virtual AUD_Specs getSpecs() const;
80         virtual void read(int & length, sample_t* & buffer);
81 };
82
83 #endif //AUD_SINUSREADER