c423326489d6fe8eb21a867a4e00b4c6d72134bc
[blender.git] / intern / audaspace / intern / AUD_ResampleReader.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_ResampleReader.h
26  *  \ingroup audaspaceintern
27  */
28
29 #ifndef __AUD_RESAMPLEREADER_H__
30 #define __AUD_RESAMPLEREADER_H__
31
32 #include "AUD_EffectReader.h"
33
34 /**
35  * This is the base class for all resampling readers.
36  */
37 class AUD_ResampleReader : public AUD_EffectReader
38 {
39 protected:
40         /**
41          * The target sampling rate.
42          */
43         AUD_SampleRate m_rate;
44
45         /**
46          * Creates a resampling reader.
47          * \param reader The reader to mix.
48          * \param rate The target sampling rate.
49          */
50         AUD_ResampleReader(AUD_Reference<AUD_IReader> reader, AUD_SampleRate rate);
51
52 public:
53         /**
54          * Sets the sample rate.
55          * \param rate The target sampling rate.
56          */
57         virtual void setRate(AUD_SampleRate rate);
58
59         /**
60          * Retrieves the sample rate.
61          * \return The target sampling rate.
62          */
63         virtual AUD_SampleRate getRate();
64 };
65
66 #endif // __AUD_RESAMPLEREADER_H__