AECircularBuffer.h

Go to the documentation of this file.

//
// AECircularBuffer.h
// TheAmazingAudioEngine
//
// Created by Michael Tyson on 29/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 "TPCircularBuffer.h"
#import <AudioToolbox/AudioToolbox.h>

#define AECircularBufferCopyAll UINT32_MAX

typedef struct {
 TPCircularBuffer buffer;
 AudioStreamBasicDescription audioDescription;
} AECircularBuffer;

BOOL AECircularBufferInit(AECircularBuffer * buffer, UInt32 capacityInFrames, int channelCount, double sampleRate);

void AECircularBufferCleanup(AECircularBuffer *buffer);

void AECircularBufferClear(AECircularBuffer *buffer);

void AECircularBufferSetAtomic(AECircularBuffer *buffer, BOOL atomic);

void AECircularBufferSetChannelCountAndSampleRate(AECircularBuffer * buffer,
 int channelCount,
 double sampleRate);

#pragma mark - Producing

UInt32 AECircularBufferGetAvailableSpace(AECircularBuffer *buffer);

BOOL AECircularBufferEnqueue(AECircularBuffer *buffer,
 const AudioBufferList *bufferList,
 const AudioTimeStamp *timestamp,
 UInt32 frames);

AudioBufferList * AECircularBufferPrepareEmptyAudioBufferList(AECircularBuffer *buffer,
 UInt32 frameCount,
 const AudioTimeStamp *timestamp);

void AECircularBufferProduceAudioBufferList(AECircularBuffer *buffer);

#pragma mark - Consuming
 
UInt32 AECircularBufferPeek(AECircularBuffer *buffer, AudioTimeStamp *outTimestamp);

void AECircularBufferDequeue(AECircularBuffer *buffer,
 UInt32 *ioLengthInFrames,
 const AudioBufferList *outputBufferList,
 AudioTimeStamp *outTimestamp);

AudioBufferList * AECircularBufferNextBufferList(AECircularBuffer *buffer,
 AudioTimeStamp *outTimestamp,
 const AudioBufferList * lastBufferList);

void AECircularBufferConsumeNextBufferList(AECircularBuffer *buffer);

void AECircularBufferConsumeNextBufferListPartial(AECircularBuffer *buffer, UInt32 frames);

#ifdef __cplusplus
}
#endif