AELimiter.h
Go to the documentation of this file.
1 //
2 // AELimiter.h
3 // TheAmazingAudioEngine
4 //
5 // Created by Michael Tyson on 20/04/2012.
6 //
7 // This software is provided 'as-is', without any express or implied
8 // warranty. In no event will the authors be held liable for any damages
9 // arising from the use of this software.
10 //
11 // Permission is granted to anyone to use this software for any purpose,
12 // including commercial applications, and to alter it and redistribute it
13 // freely, subject to the following restrictions:
14 //
15 // 1. The origin of this software must not be misrepresented; you must not
16 // claim that you wrote the original software. If you use this software
17 // in a product, an acknowledgment in the product documentation would be
18 // appreciated but is not required.
19 //
20 // 2. Altered source versions must be plainly marked as such, and must not be
21 // misrepresented as being the original software.
22 //
23 // 3. This notice may not be removed or altered from any source distribution.
24 //
25 
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29 
30 #import <Foundation/Foundation.h>
31 #import <AudioToolbox/AudioToolbox.h>
32 
50 @interface AELimiter : NSObject
51 
58 - (id)initWithNumberOfChannels:(int)numberOfChannels sampleRate:(Float32)sampleRate;
59 
73 BOOL AELimiterEnqueue(AELimiter *limiter, float** buffers, UInt32 length, const AudioTimeStamp *timestamp);
74 
92 void AELimiterDequeue(AELimiter *limiter, float** buffers, UInt32 *ioLength, AudioTimeStamp *timestamp);
93 
104 UInt32 AELimiterFillCount(AELimiter *limiter, AudioTimeStamp *timestamp, UInt32 *trueFillCount);
105 
119 void AELimiterDrain(AELimiter *limiter, float** buffers, UInt32 *ioLength, AudioTimeStamp *timestamp);
120 
126 void AELimiterReset(AELimiter *limiter);
127 
136 @property (nonatomic, assign) UInt32 hold;
137 
149 @property (nonatomic, assign) UInt32 attack;
150 
160 @property (nonatomic, assign) UInt32 decay;
161 
177 @property (nonatomic, assign) float level;
178 
179 @end
180 
181 #ifdef __cplusplus
182 }
183 #endif