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

soundprovider_session.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
30#pragma once
31
32#include <memory>
33#include "../soundformat.h"
34
35namespace clan
36{
39
40 class SoundProvider_Session_Impl;
41
45 class SoundProvider_Session
46 {
47 public:
48 SoundProvider_Session();
49 virtual ~SoundProvider_Session();
50
52 virtual int get_num_samples() const = 0;
53
55
56 virtual int get_frequency() const = 0;
57
59 virtual int get_position() const = 0;
60
62 virtual int get_num_channels() const = 0;
63
65
67 virtual bool set_looping(bool /* loop */) { return false; }
68
70
71 virtual bool eof() const = 0;
72
74 virtual void stop() = 0;
75
77
78 virtual bool play() = 0;
79
85 virtual bool set_position(int pos) = 0;
86
92 virtual bool set_end_position(int pos) = 0;
93
99 virtual int get_data(float **data_ptr, int data_requested) = 0;
100 };
101
103}
clan::SoundProvider_Session
Sound provider playback session.
Definition soundprovider_session.h:46
clan::SoundProvider_Session::set_position
virtual bool set_position(int pos)=0
Sets the position within the current stream.
clan::SoundProvider_Session::get_frequency
virtual int get_frequency() const =0
Returns the playback frequency of the input data.
clan::SoundProvider_Session::get_data
virtual int get_data(float **data_ptr, int data_requested)=0
Called when a playback session needs more sample data.
clan::SoundProvider_Session::play
virtual bool play()=0
Start/continue playing of the stream.
clan::SoundProvider_Session::~SoundProvider_Session
virtual ~SoundProvider_Session()
clan::SoundProvider_Session::eof
virtual bool eof() const =0
Returns true if no more input data is available.
clan::SoundProvider_Session::set_looping
virtual bool set_looping(bool)
Enable/disable session looping.
Definition soundprovider_session.h:67
clan::SoundProvider_Session::stop
virtual void stop()=0
Stops the current stream.
clan::SoundProvider_Session::set_end_position
virtual bool set_end_position(int pos)=0
Sets the end position within the current stream.
clan::SoundProvider_Session::get_num_samples
virtual int get_num_samples() const =0
Returns the number of samples in the soundbuffer.
clan::SoundProvider_Session::SoundProvider_Session
SoundProvider_Session()
clan::SoundProvider_Session::get_position
virtual int get_position() const =0
Returns the current position in the playback stream.
clan::SoundProvider_Session::get_num_channels
virtual int get_num_channels() const =0
Returns the number of channels filled when get_data is called.
clan
Definition clanapp.h:36