soundfilter.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 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 "api_sound.h"
34 #include <memory>
35 
36 namespace clan
37 {
40 
41 class SoundFilter_Impl;
42 class SoundFilterProvider;
43 
45 class CL_API_SOUND SoundFilter
46 {
49 
50 public:
51 
54 
59 
60  ~SoundFilter();
61 
65 public:
67  bool operator==(const SoundFilter &other) const
68  {
69  return impl==other.impl;
70  }
71 
73  bool operator!=(const SoundFilter &other) const
74  {
75  return impl!=other.impl;
76  }
77 
81 
82 public:
83 
85  bool is_null() const { return !impl; }
86 
88  void throw_if_null() const;
89 
91  SoundFilterProvider *get_provider() const;
92 
94 
98  void filter(float **sample_data, int num_samples, int channels);
99 
103 
104 public:
105  std::shared_ptr<SoundFilter_Impl> impl;
107 };
108 
109 }
110 
bool operator==(const SoundFilter &other) const
Equality operator.
Definition: soundfilter.h:67
std::shared_ptr< SoundFilter_Impl > impl
Definition: soundfilter.h:105
Sound Filter Class.
Definition: soundfilter.h:45
bool is_null() const
Returns true if this object is invalid.
Definition: soundfilter.h:85
Sound Filter Interface.
Definition: soundfilter_provider.h:41
bool operator!=(const SoundFilter &other) const
Inequality operator.
Definition: soundfilter.h:73
SoundFilter()
Constructs a NULL instance.
Definition: soundfilter.h:53