soundfilter.h

Go to the documentation of this file.
00001 /*
00002 **  ClanLib SDK
00003 **  Copyright (c) 1997-2011 The ClanLib Team
00004 **
00005 **  This software is provided 'as-is', without any express or implied
00006 **  warranty.  In no event will the authors be held liable for any damages
00007 **  arising from the use of this software.
00008 **
00009 **  Permission is granted to anyone to use this software for any purpose,
00010 **  including commercial applications, and to alter it and redistribute it
00011 **  freely, subject to the following restrictions:
00012 **
00013 **  1. The origin of this software must not be misrepresented; you must not
00014 **     claim that you wrote the original software. If you use this software
00015 **     in a product, an acknowledgment in the product documentation would be
00016 **     appreciated but is not required.
00017 **  2. Altered source versions must be plainly marked as such, and must not be
00018 **     misrepresented as being the original software.
00019 **  3. This notice may not be removed or altered from any source distribution.
00020 **
00021 **  Note: Some of the libraries ClanLib may link to may have additional
00022 **  requirements or restrictions.
00023 **
00024 **  File Author(s):
00025 **
00026 **    Magnus Norddahl
00027 **    Mark Page
00028 */
00029 
00032 
00033 #pragma once
00034 
00035 #include "api_sound.h"
00036 #include "../Core/System/sharedptr.h"
00037 
00038 class CL_SoundFilter_Impl;
00039 class CL_SoundFilterProvider;
00040 
00044 class CL_API_SOUND CL_SoundFilter
00045 {
00048 
00049 public:
00050 
00052         CL_SoundFilter() {};
00053 
00057         CL_SoundFilter(CL_SoundFilterProvider *provider);
00058 
00059         ~CL_SoundFilter();
00060 
00064 public:
00066         bool operator==(const CL_SoundFilter &other) const
00067         {
00068                 return impl==other.impl;
00069         }
00070 
00072         bool operator!=(const CL_SoundFilter &other) const
00073         {
00074                 return impl!=other.impl;
00075         }
00076 
00080 
00081 public:
00082 
00084         bool is_null() const { return !impl; }
00085 
00087         void throw_if_null() const;
00088 
00090         CL_SoundFilterProvider *get_provider() const;
00091 
00093 
00097         void filter(float **sample_data, int num_samples, int channels);
00098 
00102 
00103 public:
00104         CL_SharedPtr<CL_SoundFilter_Impl> impl;
00106 };
00107