AEMixerBuffer.h

Go to the documentation of this file.

//
//  AEMixerBuffer.h
//  The Amazing Audio Engine
//
//  Created by Michael Tyson on 12/04/2012.
//
//  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>

typedef void* AEMixerBufferSource;

#define AEMixerBufferSourceInactive (UINT32_MAX-1)

typedef void (*AEMixerBufferSourceRenderCallback) (AEMixerBufferSource       source,
                                                   UInt32                    frames,
                                                   AudioBufferList          *audio,
                                                   const AudioTimeStamp     *inTimeStamp,
                                                   void                     *userInfo);

typedef UInt32 (*AEMixerBufferSourcePeekCallback) (AEMixerBufferSource  source,
                                                   AudioTimeStamp      *outTimestamp,
                                                   void                *userInfo);


@interface AEMixerBuffer : NSObject

- (id)initWithClientFormat:(AudioStreamBasicDescription)clientFormat;

void AEMixerBufferEnqueue(AEMixerBuffer *mixerBuffer, AEMixerBufferSource source, AudioBufferList *audio, UInt32 lengthInFrames, const AudioTimeStamp *timestamp);

- (void)setRenderCallback:(AEMixerBufferSourceRenderCallback)renderCallback peekCallback:(AEMixerBufferSourcePeekCallback)peekCallback userInfo:(void *)userInfo forSource:(AEMixerBufferSource)source;

void AEMixerBufferDequeue(AEMixerBuffer *mixerBuffer, AudioBufferList *bufferList, UInt32 *ioLengthInFrames, AudioTimeStamp *outTimestamp);

void AEMixerBufferDequeueSingleSource(AEMixerBuffer *mixerBuffer, AEMixerBufferSource source, AudioBufferList *bufferList, UInt32 *ioLengthInFrames, AudioTimeStamp *outTimestamp);

UInt32 AEMixerBufferPeek(AEMixerBuffer *mixerBuffer, AudioTimeStamp *outNextTimestamp);

void AEMixerBufferEndTimeInterval(AEMixerBuffer *mixerBuffer);

void AEMixerBufferMarkSourceIdle(AEMixerBuffer *mixerBuffer, AEMixerBufferSource source);

- (void)setAudioDescription:(AudioStreamBasicDescription)audioDescription forSource:(AEMixerBufferSource)source;

- (void)setVolume:(float)volume forSource:(AEMixerBufferSource)source;

- (float)volumeForSource:(AEMixerBufferSource)source;

- (void)setPan:(float)pan forSource:(AEMixerBufferSource)source;

- (float)panForSource:(AEMixerBufferSource)source;

- (void)unregisterSource:(AEMixerBufferSource)source;

@property (nonatomic, assign) AudioStreamBasicDescription clientFormat;

@property (nonatomic, assign) NSTimeInterval sourceIdleThreshold;

@property (nonatomic, assign) BOOL assumeInfiniteSources;

@property (nonatomic, assign) int debugLevel;

@end

#ifdef __cplusplus
}
#endif