Debian Codegraph @

engine/core/loaders/native/audio/sounddecoder_ogg.h

raw
1 /***************************************************************************
2 * Copyright (C) 2005-2019 by the FIFE team *
3 * http://www.fifengine.net *
4 * This file is part of FIFE. *
5 * *
6 * FIFE is free software; you can redistribute it and/or *
7 * modify it under the terms of the GNU Lesser General Public *
8 * License as published by the Free Software Foundation; either *
9 * version 2.1 of the License, or (at your option) any later version. *
10 * *
11 * This library is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
14 * Lesser General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU Lesser General Public *
17 * License along with this library; if not, write to the *
18 * Free Software Foundation, Inc., *
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
20 ***************************************************************************/
21
22 #ifndef FIFE_SOUNDDECODER_OGG_H
23 #define FIFE_SOUNDDECODER_OGG_H
24
25 // Standard C++ library includes
26 #include <memory>
27
28 // Platform specific includes
29
30 // 3rd party library includes
31 #include <vorbis/vorbisfile.h>
32
33 // FIFE includes
34 // These includes are split up in two parts, separated by one empty line
35 // First block: files included from the FIFE root src directory
36 // Second block: files included from the same folder
37 #include "vfs/raw/rawdata.h"
38 #include "audio/sounddecoder.h"
39
40 namespace FIFE {
41 class SoundDecoderOgg : public SoundDecoder {
42 public:
43
44 SoundDecoderOgg(RawData* ptr);
45
46 ~SoundDecoderOgg();
47
48 /** Returns the decoded length of the file in bytes
49 */
50 uint64_t getDecodedLength() const{
51 return m_declength;
52 }
53
54 /** Sets the current position in the file (in bytes)
55 *
56 * @return True, if the positioning was successful
57 */
58 bool setCursor(uint64_t pos);
59
60 /** Request the decoding of the next part of the stream.
61 *
62 * @param length The length of the decoded part
63 * @return 0 (False), if decoding was successful
64 */
65 bool decode(uint64_t length);
66
67 /** Returns the next decoded buffer.
68 *
69 * The length of the buffer is returned by getBufferSize().
70 */
71 void* getBuffer() const{
72 return m_data;
73 }
74
75 /** Returns the byte-size of the buffer returned by getBuffer().
76 */
77 uint64_t getBufferSize() {
78 return m_datasize;
79 }
80
81 /** Releases the buffer returned by getBuffer()
82 */
83 void releaseBuffer();
84
85 private:
86 std::unique_ptr<RawData> m_file;
87 uint64_t m_declength;
88 uint64_t m_datasize;
89 char* m_data;
90 OggVorbis_File m_ovf;
91 };
92 }
93
94 #endif