AEIOAudioUnit.h

Go to the documentation of this file.

//
//  AEIOAudioUnit.h
//  TheAmazingAudioEngine
//
//  Created by Michael Tyson on 4/04/2016.
//  Copyright © 2016 A Tasty Pixel. All rights reserved.
//
//  This software is provided 'as-is', without any express or implied
//  warranty.  In no event will the authors be held liable for any damages
//  arising from the use of this software.
//
//  Permission is granted to anyone to use this software for any purpose,
//  including commercial applications, and to alter it and redistribute it
//  freely, subject to the following restrictions:
//
//  1. The origin of this software must not be misrepresented; you must not
//     claim that you wrote the original software. If you use this software
//     in a product, an acknowledgment in the product documentation would be
//     appreciated but is not required.
//
//  2. Altered source versions must be plainly marked as such, and must not be
//     misrepresented as being the original software.
//
//  3. This notice may not be removed or altered from any source distribution.
//

#ifdef __cplusplus
extern "C" {
#endif
    
#import <Foundation/Foundation.h>
#import <AudioToolbox/AudioToolbox.h>
#import "AETime.h"

typedef void (^AEIOAudioUnitRenderBlock)(AudioBufferList * _Nonnull ioData,
                                         UInt32 frames,
                                         const AudioTimeStamp * _Nonnull timestamp);

extern NSString * const _Nonnull AEIOAudioUnitDidSetupNotification;

extern NSString * const _Nonnull AEIOAudioUnitDidUpdateStreamFormatNotification;

@interface AEIOAudioUnit : NSObject

- (BOOL)setup:(NSError * __autoreleasing _Nullable * _Nullable)error;

- (BOOL)start:(NSError * __autoreleasing _Nullable * _Nullable)error;

- (void)stop;

AudioUnit _Nullable AEIOAudioUnitGetAudioUnit(__unsafe_unretained AEIOAudioUnit * _Nonnull unit);

OSStatus AEIOAudioUnitRenderInput(__unsafe_unretained AEIOAudioUnit * _Nonnull unit,
                                  const AudioBufferList * _Nonnull buffer, UInt32 frames);

AudioTimeStamp AEIOAudioUnitGetInputTimestamp(__unsafe_unretained AEIOAudioUnit * _Nonnull unit);

double AEIOAudioUnitGetSampleRate(__unsafe_unretained AEIOAudioUnit * _Nonnull unit);

#if TARGET_OS_IPHONE

AESeconds AEIOAudioUnitGetInputLatency(__unsafe_unretained AEIOAudioUnit * _Nonnull unit);

AESeconds AEIOAudioUnitGetOutputLatency(__unsafe_unretained AEIOAudioUnit * _Nonnull unit);

#endif

@property (nonatomic, readonly) AudioUnit _Nullable audioUnit;

@property (nonatomic) double sampleRate;

@property (nonatomic, readonly) double currentSampleRate;

@property (nonatomic, readonly) BOOL running;

@property (nonatomic) BOOL outputEnabled;

@property (nonatomic, copy) AEIOAudioUnitRenderBlock _Nullable renderBlock;

@property (nonatomic, readonly) int numberOfOutputChannels;

@property (nonatomic) BOOL inputEnabled;

@property (nonatomic) double inputGain;

@property (nonatomic) int maximumInputChannels;

@property (nonatomic, readonly) int numberOfInputChannels;

@property (nonatomic) AESeconds IOBufferDuration;

#if TARGET_OS_IPHONE

@property (nonatomic) BOOL latencyCompensation;

#endif
@end

#ifdef __cplusplus
}
#endif