Merged changes from branches/supertux-milestone2-grumbel/ to trunk/supertux/
[supertux.git] / src / audio / sound_file.hpp
1 //  SuperTux
2 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
3 //
4 //  This program is free software: you can redistribute it and/or modify
5 //  it under the terms of the GNU General Public License as published by
6 //  the Free Software Foundation, either version 3 of the License, or
7 //  (at your option) any later version.
8 //
9 //  This program is distributed in the hope that it will be useful,
10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 //  GNU General Public License for more details.
13 //
14 //  You should have received a copy of the GNU General Public License
15 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
16
17 #ifndef HEADER_SUPERTUX_AUDIO_SOUND_FILE_HPP
18 #define HEADER_SUPERTUX_AUDIO_SOUND_FILE_HPP
19
20 #include <iostream>
21
22 class SoundFile
23 {
24 public:
25   SoundFile() :
26     channels(),
27     rate(),
28     bits_per_sample(),
29     size()
30   {}
31
32   virtual ~SoundFile()
33   { }
34
35   virtual size_t read(void* buffer, size_t buffer_size) = 0;
36   virtual void reset() = 0;
37
38   int channels;
39   int rate;
40   int bits_per_sample;
41   /// size in bytes
42   size_t size;
43 };
44
45 SoundFile* load_sound_file(const std::string& filename);
46
47 #endif
48
49 /* EOF */