AEModule.h

Go to the documentation of this file.

//
// AEModule.h
// TheAmazingAudioEngine
//
// Created by Michael Tyson on 23/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 "AEBufferStack.h"
#import "AERenderer.h"

@class AEModule;

void AEModuleProcess(__unsafe_unretained AEModule * _Nonnull module, const AERenderContext * _Nonnull context);

BOOL AEModuleIsActive(__unsafe_unretained AEModule * _Nonnull module);
 
typedef void (*AEModuleProcessFunc)(__unsafe_unretained AEModule * _Nonnull self, const AERenderContext * _Nonnull context);

typedef BOOL (*AEModuleIsActiveFunc)(__unsafe_unretained AEModule * _Nonnull self);
 
@interface AEModule : NSObject

- (instancetype _Nullable)initWithRenderer:(AERenderer * _Nullable)renderer NS_DESIGNATED_INITIALIZER;

- (instancetype _Nonnull)init NS_UNAVAILABLE;

- (void)rendererDidChangeSampleRate;

- (void)rendererDidChangeNumberOfChannels;

@property (nonatomic) AEModuleProcessFunc _Nonnull processFunction;

@property (nonatomic) AEModuleIsActiveFunc _Nullable isActiveFunction;

@property (nonatomic, weak) AERenderer * _Nullable renderer;

@end

#ifdef __cplusplus
}
#endif