Debian Codegraph @

engine/core/audio/soundclip.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_SOUNDCLIP_H_
23 #define FIFE_SOUNDCLIP_H_
24
25 // Standard C++ library includes
26 #include <vector>
27
28 // Platform specific includes
29
30 // 3rd party library includes
31
32 // FIFE includes
33 // These includes are split up in two parts, separated by one empty line
34 // First block: files included from the FIFE root src directory
35 // Second block: files included from the same folder
36 #include "util/resource/resource.h"
37
38 #include "sounddecoder.h"
39
40 namespace FIFE {
41
42 /** Different types of audio-file positions
43 */
44 enum SoundPositionType {
45 SD_SAMPLE_POS,
46 SD_TIME_POS,
47 SD_BYTE_POS
48 };
49
50 struct SoundBufferEntry {
51 ALuint buffers[BUFFER_NUM];
52 uint32_t usedbufs;
53 uint64_t deccursor;
54 };
55
56 /** Class to handle the buffers of an audio file
57 */
58 class SoundClip : public IResource {
59 public:
60
61 SoundClip(IResourceLoader* loader = 0);
62 SoundClip(const std::string& name, IResourceLoader* loader = 0);
63
64 ~SoundClip();
65
66 /** Does this SoundClip require a streaming mechanism?
67 *
68 * @return Returns true if streaming is required, false if not.
69 */
70 bool isStream() const;
71
72 /** Returns the number of buffers used by the SoundClip
73 * (only for non-streaming sound clips)
74 *
75 * @return Returns the number of buffers.
76 */
77 uint32_t countBuffers() const;
78
79 /** Returns the array of buffers for queuing
80 *
81 */
82 ALuint* getBuffers(uint32_t streamid = 0) const;
83
84 /** Starts streaming the soundclip
85 * @return Returns the streamid
86 */
87 uint32_t beginStreaming();
88
89 /** Fills the streaming-buffers with initial data
90 *
91 * @param streamid The stream ID
92 */
93 void acquireStream(uint32_t streamid);
94
95 /** Sets the stream position
96 * @return True if position is invalid (EOF has been reached)
97 */
98 bool setStreamPos(uint32_t streamid, SoundPositionType type, float value);
99
100 /** Gets the stream position
101 */
102 float getStreamPos(uint32_t streamid, SoundPositionType type) const;
103
104 /** Refill a processed buffer with new data
105 *
106 * @return True if file was EOF
107 * @param streamid The stream ID
108 * @param buffer The OpenAL buffer ID
109 */
110 bool getStream(uint32_t streamid, ALuint buffer);
111
112 /** Quits Streaming
113 */
114 void quitStreaming(uint32_t streamid);
115
116 /** Ends streaming, invalidate also the stream id.
117 */
118 void endStreaming(uint32_t streamid);
119
120 /** Adopts a decoder to use so DONT delete it
121 */
122 void adobtDecoder(SoundDecoder* decoder);
123
124 /** Sets the decoder to use so DONT delete it before this SoundClip is done with it
125 */
126 void setDecoder(SoundDecoder* decoder);
127
128 /** Returns the attached decoder
129 */
130 SoundDecoder* getDecoder() const;
131
132 virtual size_t getSize();
133
134 virtual void load();
135 virtual void free();
136
137 private:
138 // is stream?
139 bool m_isStream;
140 // attached decoder
141 SoundDecoder* m_decoder;
142 // when loadFromDecoder-method is used, decoder shouldn't be deleted
143 bool m_deleteDecoder;
144 std::vector<SoundBufferEntry*> m_buffervec;
145
146 std::string createUniqueClipName();
147 };
148
149 typedef SharedPtr<SoundClip> SoundClipPtr;
150 }
151
152 #endif