AEAudioBufferListUtilities.h

Go to the documentation of this file.

//
//  AEAudioBufferListUtilities.h
//  TheAmazingAudioEngine
//
//  Created by Michael Tyson on 24/03/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 "AETypes.h"

AudioBufferList *AEAudioBufferListCreate(int frameCount);

AudioBufferList *AEAudioBufferListCreateWithFormat(AudioStreamBasicDescription audioFormat, int frameCount);

#define AEAudioBufferListCreateOnStack(name) \
    AEAudioBufferListCreateOnStackWithFormat(name, AEAudioDescription)

#define AEAudioBufferListCreateOnStackWithFormat(name, audioFormat) \
    int name ## _numberBuffers = audioFormat.mFormatFlags & kAudioFormatFlagIsNonInterleaved \
                                    ? audioFormat.mChannelsPerFrame : 1; \
    char name ## _bytes[sizeof(AudioBufferList)+(sizeof(AudioBuffer)*(name ## _numberBuffers-1))]; \
    memset(&name ## _bytes, 0, sizeof(name ## _bytes)); \
    AudioBufferList * name = (AudioBufferList*)name ## _bytes; \
    name->mNumberBuffers = name ## _numberBuffers; \
    for ( int i=0; i<name->mNumberBuffers; i++ ) { \
        name->mBuffers[i].mNumberChannels \
            = audioFormat.mFormatFlags & kAudioFormatFlagIsNonInterleaved ? 1 : audioFormat.mChannelsPerFrame; \
    }

#define AEAudioBufferListCopyOnStack(name, sourceBufferList, offsetFrames) \
    AEAudioBufferListCopyOnStackWithByteOffset(name, sourceBufferList, offsetFrames * AEAudioDescription.mBytesPerFrame)

#define AEAudioBufferListCopyOnStackWithByteOffset(name, sourceBufferList, offsetBytes) \
    char name ## _bytes[sizeof(AudioBufferList)+(sizeof(AudioBuffer)*(sourceBufferList->mNumberBuffers-1))]; \
    memcpy(name ## _bytes, sourceBufferList, sizeof(name ## _bytes)); \
    AudioBufferList * name = (AudioBufferList*)name ## _bytes; \
    for ( int i=0; i<name->mNumberBuffers; i++ ) { \
        name->mBuffers[i].mData = (char*)name->mBuffers[i].mData + offsetBytes; \
        name->mBuffers[i].mDataByteSize -= offsetBytes; \
    }

#define AEAudioBufferListCopyOnStackWithChannelSubset(name, sourceBufferList, channelSet) \
    int name ## _bufferCount = MIN(sourceBufferList->mNumberBuffers-1, channelSet.lastChannel) - \
                               MIN(sourceBufferList->mNumberBuffers-1, channelSet.firstChannel) + 1; \
    char name ## _bytes[sizeof(AudioBufferList)+(sizeof(AudioBuffer)*(name ## _bufferCount-1))]; \
    AudioBufferList * name = (AudioBufferList*)name ## _bytes; \
    name->mNumberBuffers = name ## _bufferCount; \
    memcpy(name->mBuffers, &sourceBufferList->mBuffers[MIN(sourceBufferList->mNumberBuffers-1, channelSet.firstChannel)], \
        sizeof(AudioBuffer) * name ## _bufferCount);

AudioBufferList *AEAudioBufferListCopy(const AudioBufferList *original);

void AEAudioBufferListFree(AudioBufferList *bufferList);

UInt32 AEAudioBufferListGetLength(const AudioBufferList *bufferList, int *oNumberOfChannels);

UInt32 AEAudioBufferListGetLengthWithFormat(const AudioBufferList *bufferList,
                                            AudioStreamBasicDescription audioFormat,
                                            int *oNumberOfChannels);

void AEAudioBufferListSetLength(AudioBufferList *bufferList, UInt32 frames);

void AEAudioBufferListSetLengthWithFormat(AudioBufferList *bufferList,
                                          AudioStreamBasicDescription audioFormat,
                                          UInt32 frames);

void AEAudioBufferListOffset(AudioBufferList *bufferList, UInt32 frames);

void AEAudioBufferListOffsetWithFormat(AudioBufferList *bufferList,
                                       AudioStreamBasicDescription audioFormat,
                                       UInt32 frames);

void AEAudioBufferListAssign(AudioBufferList * target, const AudioBufferList * source, UInt32 offset, UInt32 length);
    
void AEAudioBufferListAssignWithFormat(AudioBufferList * target, const AudioBufferList * source,
                                       AudioStreamBasicDescription audioFormat, UInt32 offset, UInt32 length);

void AEAudioBufferListSilence(const AudioBufferList *bufferList, UInt32 offset, UInt32 length);

void AEAudioBufferListSilenceWithFormat(const AudioBufferList *bufferList,
                                        AudioStreamBasicDescription audioFormat,
                                        UInt32 offset,
                                        UInt32 length);

void AEAudioBufferListCopyContents(const AudioBufferList * target,
                                   const AudioBufferList * source,
                                   UInt32 targetOffset,
                                   UInt32 sourceOffset,
                                   UInt32 length);

void AEAudioBufferListCopyContentsWithFormat(const AudioBufferList * target,
                                             const AudioBufferList * source,
                                             AudioStreamBasicDescription audioFormat,
                                             UInt32 targetOffset,
                                             UInt32 sourceOffset,
                                             UInt32 length);

static inline size_t AEAudioBufferListGetStructSize(const AudioBufferList *bufferList) {
    return sizeof(AudioBufferList) + (bufferList->mNumberBuffers-1) * sizeof(AudioBuffer);
}
    
#ifdef __cplusplus
}
#endif