Spinning Topp Logo BlackTopp Studios
inc
filter.h
1 // © Copyright 2010 - 2016 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 // Copyright (c) 2008-2010 Raynaldo (Wildicv) Rivera, Joshua (Dark_Kilauea) Jones
41 // This file is part of the "cAudio Engine"
42 // For conditions of distribution and use, see copyright notice in cAudio-ZLIBLicense.txt
43 #ifndef _audiofilter_h
44 #define _audiofilter_h
45 
46 #include "datatypes.h"
47 #include "Audio/audioenumerations.h"
48 
49 namespace Mezzanine
50 {
51  namespace Audio
52  {
53  ///////////////////////////////////////////////////////////////////////////////
54  /// @brief This is an interface class for the application of filters to audio playback.
55  /// @details
56  ///////////////////////////////////////
57  class iFilter
58  {
59  public:
60  /// @brief Class constructor.
61  iFilter() { }
62  /// @brief Class destructor.
63  virtual ~iFilter() { }
64 
65  ///////////////////////////////////////////////////////////////////////////////
66  // Utility
67 
68  /// @brief Gets whether or not this filter is ready to be used.
69  /// @return Returns true if this filter is ready for use, or false if there is an error.
70  virtual Boole IsValid() const = 0;
71 
72  /// @brief Sets the type of filter this is.
73  /// @param FilType The type of filter to set this as. See enum @ref FilterType for more information.
74  virtual void SetType(const FilterType FilType) = 0;
75  /// @brief Gets the type of filter this is.
76  /// @return Returns the type of filter this filter is currently set as.
77  virtual FilterType GetType() const = 0;
78 
79  /// @brief Sets the master volume of this filter.
80  /// @note Valid range: 0.0 to 1.0.
81  /// @param Vol The volume scale to apply to all audio passed through this filter.
82  virtual void SetVolume(const Real Vol) = 0;
83  /// @brief Gets the master volume of this filter.
84  /// @return Returns a Real representing the volume scale being applied to all audio passing through this filter.
85  virtual Real GetVolume() const = 0;
86  /// @brief Sets the high frequency volume of this filter.
87  /// @note Valid range: 0.0 to 1.0.
88  /// @param HFVol The volume scale to apply to higher frequency audio passed through this filter.
89  virtual void SetHighFrequencyVolume(const Real HFVol) = 0;
90  /// @brief Gets the high frequency volume of this filter.
91  /// @return Returns a Real representing the volume scale being applied to higher frequency audio passing through this filter.
92  virtual Real GetHighFrequencyVolume() const = 0;
93  /// @brief Sets the low frequency volume of this filter.
94  /// @note Valid range: 0.0 to 1.0.
95  /// @param LFVol The volume scale to apply to lower frequency audio passed through this filter.
96  virtual void SetLowFrequencyVolume(const Real LFVol) = 0;
97  /// @brief Gets the low frequency volume of this filter.
98  /// @return Returns a Real representing the volume scale being applied to lower frequency audio passing through this filter.
99  virtual Real GetLowFrequencyVolume() const = 0;
100  };//iFilter
101  }//Audio
102 }//Mezzanine
103 
104 #endif
bool Boole
Generally acts a single bit, true or false.
Definition: datatypes.h:173
virtual ~iFilter()
Class destructor.
Definition: filter.h:63
FilterType
Used by the iFilter class to describe what type of filter it is.
All the definitions for datatypes as well as some basic conversion functions are defined here...
virtual FilterType GetType() const =0
Gets the type of filter this is.
virtual Real GetVolume() const =0
Gets the master volume of this filter.
virtual Real GetHighFrequencyVolume() const =0
Gets the high frequency volume of this filter.
float Real
A Datatype used to represent a real floating point number.
Definition: datatypes.h:141
virtual void SetType(const FilterType FilType)=0
Sets the type of filter this is.
virtual void SetLowFrequencyVolume(const Real LFVol)=0
Sets the low frequency volume of this filter.
virtual void SetVolume(const Real Vol)=0
Sets the master volume of this filter.
virtual Real GetLowFrequencyVolume() const =0
Gets the low frequency volume of this filter.
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
This is an interface class for the application of filters to audio playback.
Definition: filter.h:57
virtual void SetHighFrequencyVolume(const Real HFVol)=0
Sets the high frequency volume of this filter.
virtual Boole IsValid() const =0
Gets whether or not this filter is ready to be used.
iFilter()
Class constructor.
Definition: filter.h:61