FIFE  2008.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Pages
soundclip.h
1 /***************************************************************************
2  * Copyright (C) 2005-2011 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 
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 
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 
79  uint32_t countBuffers() const {
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 
93  uint32_t beginStreaming();
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 
115  bool getStream(uint32_t streamid, ALuint buffer);
116 
119  void quitStreaming(uint32_t streamid);
120 
123  void adobtDecoder(SoundDecoder* decoder) { m_decoder = decoder; m_deletedecoder = true; }
124 
127  void setDecoder(SoundDecoder* decoder) { m_decoder = decoder; m_deletedecoder = false; }
128 
131  SoundDecoder* getDecoder() const {
132  return m_decoder;
133  }
134 
135  virtual size_t getSize() { return 0; }
136 
137  virtual void load();
138  virtual void free();
139 
140  private:
141  bool m_isstream; // is stream?
142  SoundDecoder* m_decoder; // attached decoder
143  bool m_deletedecoder; // when loadFromDecoder-method is used, decoder shouldn't be deleted
144  std::vector<SoundBufferEntry*> m_buffervec;
145 
146  std::string createUniqueClipName();
147  };
148 
149  typedef SharedPtr<SoundClip> SoundClipPtr;
150 }
151 
152 #endif