FIFE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
soundclip.h
Go to the documentation of this file.
1 /***************************************************************************
2  * Copyright (C) 2005-2013 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 
48  };
49 
53  uint64_t deccursor;
54  };
55 
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 
70  bool isStream() const {
71  return m_isstream;
72  }
73 
80  return m_buffervec.at(0)->usedbufs;
81  }
82 
86  ALuint* getBuffers(uint32_t streamid = 0) const {
87  return m_buffervec.at(streamid)->buffers;
88  }
89 
94 
99  void acquireStream(uint32_t streamid);
100 
104  bool setStreamPos(uint32_t streamid, SoundPositionType type, float value);
105 
108  float getStreamPos(uint32_t streamid, SoundPositionType type) const;
109 
116  bool getStream(uint32_t streamid, ALuint buffer);
117 
120  void quitStreaming(uint32_t streamid);
121 
124  void adobtDecoder(SoundDecoder* decoder) { m_decoder = decoder; m_deletedecoder = true; }
125 
128  void setDecoder(SoundDecoder* decoder) { m_decoder = decoder; m_deletedecoder = false; }
129 
133  return m_decoder;
134  }
135 
136  virtual size_t getSize() { return 0; }
137 
138  virtual void load();
139  virtual void free();
140 
141  private:
142  bool m_isstream; // is stream?
143  SoundDecoder* m_decoder; // attached decoder
144  bool m_deletedecoder; // when loadFromDecoder-method is used, decoder shouldn't be deleted
145  std::vector<SoundBufferEntry*> m_buffervec;
146 
147  std::string createUniqueClipName();
148  };
149 
151 }
152 
153 #endif
bool getStream(uint32_t streamid, ALuint buffer)
Refill a processed buffer with new data.
Definition: soundclip.cpp:196
SharedPtr< SoundClip > SoundClipPtr
Definition: soundclip.h:150
bool m_deletedecoder
Definition: soundclip.h:144
ALuint buffers[BUFFER_NUM]
Definition: soundclip.h:51
bool isStream() const
Does this SoundClip require a streaming mechanism?
Definition: soundclip.h:70
virtual void load()
Definition: soundclip.cpp:58
void adobtDecoder(SoundDecoder *decoder)
Adopts a decoder to use so DONT delete it.
Definition: soundclip.h:124
virtual void free()
Definition: soundclip.cpp:110
void acquireStream(uint32_t streamid)
Fills the streaming-buffers with initial data.
Definition: soundclip.cpp:187
SoundPositionType
Different types of audio-file positions.
Definition: soundclip.h:44
uint32_t usedbufs
Definition: soundclip.h:52
std::string createUniqueClipName()
Definition: soundclip.cpp:243
Definition: soundclip.h:50
float getStreamPos(uint32_t streamid, SoundPositionType type) const
Gets the stream position.
Definition: soundclip.cpp:174
SoundDecoder * getDecoder() const
Returns the attached decoder.
Definition: soundclip.h:132
std::vector< SoundBufferEntry * > m_buffervec
Definition: soundclip.h:145
void setDecoder(SoundDecoder *decoder)
Sets the decoder to use so DONT delete it before this SoundClip is done with it.
Definition: soundclip.h:128
void quitStreaming(uint32_t streamid)
Quits Streaming.
Definition: soundclip.cpp:227
uint64_t deccursor
Definition: soundclip.h:53
virtual size_t getSize()
Definition: soundclip.h:136
ALuint * getBuffers(uint32_t streamid=0) const
Returns the array of buffers for queuing.
Definition: soundclip.h:86
SoundClip(IResourceLoader *loader=0)
Definition: soundclip.cpp:42
uint32_t countBuffers() const
Returns the number of buffers used by the SoundClip (only for non-streaming sound clips) ...
Definition: soundclip.h:79
const int16_t BUFFER_NUM
Definition: soundconfig.h:43
unsigned int uint32_t
Definition: core.h:40
SoundDecoder * m_decoder
Definition: soundclip.h:143
bool setStreamPos(uint32_t streamid, SoundPositionType type, float value)
Sets the stream position.
Definition: soundclip.cpp:149
uint32_t beginStreaming()
Starts streaming the soundclip.
Definition: soundclip.cpp:136
Class to handle the buffers of an audio file.
Definition: soundclip.h:58