soundfilter.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 ** Mark Page
28 */
29 
30 #pragma once
31 
32 #include <memory>
33 
34 namespace clan
35 {
38 
39  class SoundFilter_Impl;
40  class SoundFilterProvider;
41 
44  {
45  public:
48 
53 
54  ~SoundFilter();
55 
57  bool operator==(const SoundFilter &other) const
58  {
59  return impl == other.impl;
60  }
61 
63  bool operator!=(const SoundFilter &other) const
64  {
65  return impl != other.impl;
66  }
67 
69  bool is_null() const { return !impl; }
70 
72  void throw_if_null() const;
73 
76 
78 
82  void filter(float **sample_data, int num_samples, int channels);
83 
84  std::shared_ptr<SoundFilter_Impl> impl;
85  };
86 
88 }
Definition: clanapp.h:35
bool is_null() const
Returns true if this object is invalid.
Definition: soundfilter.h:69
SoundFilterProvider * get_provider() const
Retrieves the provider.
Sound Filter Class.
Definition: soundfilter.h:43
void throw_if_null() const
Throw an exception if this object is invalid.
void filter(float **sample_data, int num_samples, int channels)
Filter callback.
SoundFilter()
Constructs a NULL instance.
Definition: soundfilter.h:47
bool operator==(const SoundFilter &other) const
Equality operator.
Definition: soundfilter.h:57
bool operator!=(const SoundFilter &other) const
Inequality operator.
Definition: soundfilter.h:63
std::shared_ptr< SoundFilter_Impl > impl
Definition: soundfilter.h:84
Sound Filter Interface.
Definition: soundfilter_provider.h:38