Audaspace:
[blender.git] / intern / audaspace / FX / AUD_PitchReader.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/FX/AUD_PitchReader.h
26  *  \ingroup audfx
27  */
28
29
30 #ifndef __AUD_PITCHREADER_H__
31 #define __AUD_PITCHREADER_H__
32
33 #include "AUD_EffectReader.h"
34
35 /**
36  * This class reads another reader and changes it's pitch.
37  */
38 class AUD_PitchReader : public AUD_EffectReader
39 {
40 private:
41         /**
42          * The pitch level.
43          */
44         float m_pitch;
45
46         // hide copy constructor and operator=
47         AUD_PitchReader(const AUD_PitchReader&);
48         AUD_PitchReader& operator=(const AUD_PitchReader&);
49
50 public:
51         /**
52          * Creates a new pitch reader.
53          * \param reader The reader to read from.
54          * \param pitch The pitch value.
55          */
56         AUD_PitchReader(boost::shared_ptr<AUD_IReader> reader, float pitch);
57
58         virtual AUD_Specs getSpecs() const;
59
60         /**
61          * Retrieves the pitch.
62          * \return The current pitch value.
63          */
64         float getPitch() const;
65
66         /**
67          * Sets the pitch.
68          * \param pitch The new pitch value.
69          */
70         void setPitch(float pitch);
71 };
72
73 #endif //__AUD_PITCHREADER_H__