AEAudioFileReader.h

Go to the documentation of this file.

//
//  AEAudioFileReader.h
//  TheAmazingAudioEngine
//
//  Created by Michael Tyson on 17/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 (^AEAudioFileReaderLoadBlock)(AudioBufferList * _Nullable audio,
                                           UInt32 length,
                                           NSError * _Nullable error);

typedef void (^AEAudioFileReaderIncrementalReadBlock)(const AudioBufferList * _Nonnull audio, UInt32 length);

typedef void (^AEAudioFileReaderCompletionBlock)(NSError * _Nullable error);

@class AEAudioFileReader;

@interface AEAudioFileReader : NSObject

+ (BOOL)infoForFileAtURL:(NSURL * _Nonnull)url
        audioDescription:(AudioStreamBasicDescription * _Nullable)audioDescription
                  length:(UInt32 * _Nullable)lengthInFrames
                   error:(NSError * _Nullable * _Nullable)error;

+ (instancetype _Nonnull)loadFileAtURL:(NSURL * _Nonnull)url
                targetAudioDescription:(AudioStreamBasicDescription)targetAudioDescription
                       completionBlock:(AEAudioFileReaderLoadBlock _Nonnull)block;

+ (instancetype _Nonnull)readFileAtURL:(NSURL * _Nonnull)url
                targetAudioDescription:(AudioStreamBasicDescription)targetAudioDescription
                             readBlock:(AEAudioFileReaderIncrementalReadBlock _Nullable)readBlock
                       completionBlock:(AEAudioFileReaderCompletionBlock _Nonnull)completionBlock;

+ (instancetype _Nonnull)readFileAtURL:(NSURL * _Nonnull)url
                targetAudioDescription:(AudioStreamBasicDescription)targetAudioDescription
                             readBlock:(AEAudioFileReaderIncrementalReadBlock _Nullable)readBlock
                       completionBlock:(AEAudioFileReaderCompletionBlock _Nonnull)completionBlock
                             blockSize:(UInt32)blockSize;


- (void)cancel;

@end

#ifdef __cplusplus
}
#endif