soundfilter.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 ** Mark Page
28 */
29 
30 
31 #pragma once
32 
33 #include <memory>
34 
35 namespace clan
36 {
39 
40 class SoundFilter_Impl;
41 class SoundFilterProvider;
42 
45 {
48 
49 public:
50 
53 
58 
60 
64 public:
66  bool operator==(const SoundFilter &other) const
67  {
68  return impl==other.impl;
69  }
70 
72  bool operator!=(const SoundFilter &other) const
73  {
74  return impl!=other.impl;
75  }
76 
80 
81 public:
82 
84  bool is_null() const { return !impl; }
85 
87  void throw_if_null() const;
88 
91 
93 
97  void filter(float **sample_data, int num_samples, int channels);
98 
102 
103 public:
104  std::shared_ptr<SoundFilter_Impl> impl;
106 };
107 
108 }
109 
Sound Filter Interface.
Definition: soundfilter_provider.h:41
bool operator==(const SoundFilter &other) const
Equality operator.
Definition: soundfilter.h:66
SoundFilterProvider * get_provider() const
Retrieves the provider.
void filter(float **sample_data, int num_samples, int channels)
Filter callback.
SoundFilter()
Constructs a NULL instance.
Definition: soundfilter.h:52
bool operator!=(const SoundFilter &other) const
Inequality operator.
Definition: soundfilter.h:72
Sound Filter Class.
Definition: soundfilter.h:45
std::shared_ptr< SoundFilter_Impl > impl
Definition: soundfilter.h:104
SoundFilter(SoundFilterProvider *provider)
Constructs a sound filter.
Definition: clanapp.h:36
void throw_if_null() const
Throw an exception if this object is invalid.
bool is_null() const
Returns true if this object is invalid.
Definition: soundfilter.h:84