Merge with trunk r37757.
[blender.git] / intern / audaspace / intern / AUD_SinusReader.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * Copyright 2009-2011 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 General Public License as published by
12  * the Free Software Foundation; either version 2 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 General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with Audaspace; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file audaspace/intern/AUD_SinusReader.h
28  *  \ingroup audaspaceintern
29  */
30
31
32 #ifndef AUD_SINUSREADER
33 #define AUD_SINUSREADER
34
35 #include "AUD_IReader.h"
36 #include "AUD_Buffer.h"
37
38 /**
39  * This class is used for sine tone playback.
40  * The output format is in the 16 bit format and stereo, the sample rate can be
41  * specified.
42  * As the two channels both play the same the output could also be mono, but
43  * in most cases this will result in having to resample for output, so stereo
44  * sound is created directly.
45  */
46 class AUD_SinusReader : public AUD_IReader
47 {
48 private:
49         /**
50          * The frequency of the sine wave.
51          */
52         const float m_frequency;
53
54         /**
55          * The current position in samples.
56          */
57         int m_position;
58
59         /**
60          * The sample rate for the output.
61          */
62         const AUD_SampleRate m_sampleRate;
63
64         // hide copy constructor and operator=
65         AUD_SinusReader(const AUD_SinusReader&);
66         AUD_SinusReader& operator=(const AUD_SinusReader&);
67
68 public:
69         /**
70          * Creates a new reader.
71          * \param frequency The frequency of the sine wave.
72          * \param sampleRate The output sample rate.
73          */
74         AUD_SinusReader(float frequency, AUD_SampleRate sampleRate);
75
76         virtual bool isSeekable() const;
77         virtual void seek(int position);
78         virtual int getLength() const;
79         virtual int getPosition() const;
80         virtual AUD_Specs getSpecs() const;
81         virtual void read(int& length, bool& eos, sample_t* buffer);
82 };
83
84 #endif //AUD_SINUSREADER