soundprovider_vorbis.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2016 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 #pragma once
30 
31 #include "soundprovider.h"
32 #include "../../Core/IOData/file_system.h"
33 
34 namespace clan
35 {
38 
39  class InputSourceProvider;
40  class SoundProvider_Vorbis_Impl;
41 
44  {
45  public:
52  const std::string &filename,
53  const FileSystem &fs,
54  bool stream = false);
55 
57  const std::string &fullname,
58  bool stream = false);
59 
61  IODevice &file,
62  bool stream = false);
63 
64  virtual ~SoundProvider_Vorbis();
65 
67 
68  virtual SoundProvider_Session *begin_session() override;
69 
71 
73  virtual void end_session(SoundProvider_Session *session) override;
74 
75  private:
76  std::shared_ptr<SoundProvider_Vorbis_Impl> impl;
77 
79  };
80 
82 }
Ogg Vorbis format sound provider.
Definition: soundprovider_vorbis.h:43
Definition: clanapp.h:35
Sound provider.
Definition: soundprovider.h:45
I/O Device interface.
Definition: iodevice.h:49
SoundProvider_Vorbis(const std::string &filename, const FileSystem &fs, bool stream=false)
Constructs a sound provider based on an ogg vorbis (.ogg) file.
Virtual File System (VFS).
Definition: file_system.h:46
virtual SoundProvider_Session * begin_session() override
Called by SoundBuffer when a new session starts.
virtual void end_session(SoundProvider_Session *session) override
Called by SoundBuffer when a session has finished. After this call,.
Sound provider playback session.
Definition: soundprovider_session.h:45
friend class SoundProvider_Vorbis_Session
Definition: soundprovider_vorbis.h:78