soundprovider_wave.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2015 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 "soundprovider.h"
33 #include "../../Core/IOData/file_system.h"
34
35 namespace clan
36 {
39
40 class InputSourceProvider;
41 class SoundProvider_Wave_Impl;
42
44 class SoundProvider_Wave : public SoundProvider
45 {
48
49 public:
55 SoundProvider_Wave(
56 const std::string &filename,
57 const FileSystem &fs,
58 bool stream = false);
59
60 SoundProvider_Wave(
61 const std::string &fullname,
62 bool stream = false);
63
64 SoundProvider_Wave(
65 IODevice &file,
66 bool stream = false);
67
68 virtual ~SoundProvider_Wave();
69
73
74 public:
76
77 virtual SoundProvider_Session *begin_session() override;
78
80
82 virtual void end_session(SoundProvider_Session *session) override;
83
87
88 private:
89 std::shared_ptr<SoundProvider_Wave_Impl> impl;
90
91 friend class SoundProvider_Wave_Session;
93 };
94
95 }
96
clan
Definition: clanapp.h:35
clan::SoundProvider
Sound provider.
Definition: soundprovider.h:45
clan::IODevice
I/O Device interface.
Definition: iodevice.h:50
clan::SoundProvider_Wave::SoundProvider_Wave
SoundProvider_Wave(const std::string &filename, const FileSystem &fs, bool stream=false)
Constructs a sound provider based on a Windows wave (.wav) file.
clan::SoundProvider_Wave::end_session
virtual void end_session(SoundProvider_Session *session) override
Called by SoundBuffer when a session has finished. After this call,.
clan::StyleTokenType::string
@ keyword
clan::SoundProvider_Wave::begin_session
virtual SoundProvider_Session * begin_session() override
Called by SoundBuffer when a new session starts.
clan::SoundProvider_Wave::SoundProvider_Wave_Session
friend class SoundProvider_Wave_Session
Definition: soundprovider_wave.h:91
clan::FileSystem
Virtual File System (VFS).
Definition: file_system.h:47
clan::SoundProvider_Session
Sound provider playback session.
Definition: soundprovider_session.h:45
clan::SoundProvider_Wave::~SoundProvider_Wave
virtual ~SoundProvider_Wave()
clan::SoundProvider_Wave
Windows WAVE sample format (.wav) sound provider.
Definition: soundprovider_wave.h:44