soundprovider_vorbis.h Source File - ClanLib SDK
Description: soundprovider_vorbis.h Source File

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