AEMessageQueue.h

Go to the documentation of this file.

//
//  AEMessageQueue.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 <Foundation/Foundation.h>
#import "AETime.h"

typedef struct {
    BOOL isValue;
    const void * _Nullable data;
    size_t length;
} AEArgument;

extern AEArgument AEArgumentNone;

#define AEArgumentScalar(argument) \
    (AEArgument){ YES, &(typeof(argument)){argument}, sizeof(argument) }

#define AEArgumentStruct(argument) \
    (AEArgument){ YES, &(argument), sizeof(argument) }

#define AEArgumentData(buffer, size) \
    (AEArgument) { NO, buffer, size }

typedef void (^AEMessageQueueBlock)();

@interface AEMessageQueue : NSObject

- (instancetype _Nonnull)init;

- (instancetype _Nullable)initWithBufferCapacity:(size_t)bufferCapacity;

- (void)performBlockOnAudioThread:(AEMessageQueueBlock _Nonnull)block;

- (void)performBlockOnAudioThread:(AEMessageQueueBlock _Nonnull)block
                  completionBlock:(AEMessageQueueBlock _Nullable)completionBlock;

BOOL AEMessageQueuePerformSelectorOnMainThread(__unsafe_unretained AEMessageQueue * _Nonnull messageQueue,
                                               __unsafe_unretained id _Nonnull target,
                                               SEL _Nonnull selector,
                                               AEArgument arguments, ...);

- (void)beginMessageGroup;

- (void)endMessageGroup;

void AEMessageQueuePoll(__unsafe_unretained AEMessageQueue * _Nonnull THIS);

@end

#ifdef __cplusplus
}
#endif