soundbuffer.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 */
28 
29 
30 #pragma once
31 
32 #include "api_sound.h"
33 #include <memory>
34 #include "soundbuffer_session.h"
35 #include "../Core/Resources/resource.h"
36 
37 namespace clan
38 {
41 
42 class XMLResourceDocument;
43 class SoundOutput;
44 class SoundProvider;
45 class SoundBuffer_Session;
46 class SoundFilter;
47 class SoundBuffer_Impl;
48 class IODevice;
49 class FileSystem;
50 class ResourceManager;
51 
57 class CL_API_SOUND SoundBuffer
58 {
61 
62 public:
64  SoundBuffer();
65 
67 
81  SoundProvider *provider);
82 
84  const std::string &fullname,
85  bool streamed = false,
86  const std::string &format = "");
87 
89  const std::string &filename,
90  bool streamed,
91  const FileSystem &fs,
92  const std::string &type = "");
93 
95  IODevice &file,
96  bool streamed,
97  const std::string &type);
98 
100 
103 public:
104 
105 
111  static Resource<SoundBuffer> resource(const std::string &id, const ResourceManager &resources);
112 
114  static SoundBuffer load(const std::string &id, const XMLResourceDocument &doc);
115 
116  virtual ~SoundBuffer();
117 
121 
122 public:
124  SoundProvider *get_provider() const;
125 
127  float get_volume() const;
128 
130  float get_pan() const;
131 
133  bool is_null() const { return !impl; }
134 
136  void throw_if_null() const;
137 
141 
142 public:
143 
145 
148  void set_volume(float new_volume);
149 
151 
155  void set_pan(float new_pan);
156 
160  void add_filter(SoundFilter &filter);
161 
163  void remove_filter(SoundFilter &filter);
164 
171  SoundBuffer_Session play(bool looping = false, SoundOutput *output = 0);
172 
178  SoundBuffer_Session prepare(bool looping = false, SoundOutput *output = 0);
179 
183 
184 private:
185  std::shared_ptr<SoundBuffer_Impl> impl;
187 };
188 
189 }
190 
Resource proxy of a specific type.
Definition: resource.h:59
Sound provider.
Definition: soundprovider.h:46
I/O Device interface.
Definition: iodevice.h:51
SoundBuffer_Session provides control over a playing soundeffect.
Definition: soundbuffer_session.h:52
SoundOutput interface in ClanLib.
Definition: soundoutput.h:49
bool is_null() const
Returns true if this object is invalid.
Definition: soundbuffer.h:133
Sample interface in ClanLib.
Definition: soundbuffer.h:57
Virtual File System (VFS).
Definition: file_system.h:48
Sound Filter Class.
Definition: soundfilter.h:45
Resource manager.
Definition: resource_manager.h:45
XML Resource Document.
Definition: xml_resource_document.h:49