1 /* 2 File: AUOutputBL.h 3 Abstract: Part of CoreAudio Utility Classes 4 Version: 1.1 5 6 Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple 7 Inc. ("Apple") in consideration of your agreement to the following 8 terms, and your use, installation, modification or redistribution of 9 this Apple software constitutes acceptance of these terms. If you do 10 not agree with these terms, please do not use, install, modify or 11 redistribute this Apple software. 12 13 In consideration of your agreement to abide by the following terms, and 14 subject to these terms, Apple grants you a personal, non-exclusive 15 license, under Apple's copyrights in this original Apple software (the 16 "Apple Software"), to use, reproduce, modify and redistribute the Apple 17 Software, with or without modifications, in source and/or binary forms; 18 provided that if you redistribute the Apple Software in its entirety and 19 without modifications, you must retain this notice and the following 20 text and disclaimers in all such redistributions of the Apple Software. 21 Neither the name, trademarks, service marks or logos of Apple Inc. may 22 be used to endorse or promote products derived from the Apple Software 23 without specific prior written permission from Apple. Except as 24 expressly stated in this notice, no other rights or licenses, express or 25 implied, are granted by Apple herein, including but not limited to any 26 patent rights that may be infringed by your derivative works or by other 27 works in which the Apple Software may be incorporated. 28 29 The Apple Software is provided by Apple on an "AS IS" basis. APPLE 30 MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION 31 THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS 32 FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND 33 OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS. 34 35 IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL 36 OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 37 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 38 INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, 39 MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED 40 AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), 41 STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE 42 POSSIBILITY OF SUCH DAMAGE. 43 44 Copyright (C) 2014 Apple Inc. All Rights Reserved. 45 46 */ 47 #ifndef __AUOutputBL_h__ 48 #define __AUOutputBL_h__ 49 50 #include "CAStreamBasicDescription.h" 51 #if !defined(__COREAUDIO_USE_FLAT_INCLUDES__) 52 #else 53 #endif 54 55 // ____________________________________________________________________________ 56 // 57 // AUOutputBL - Simple Buffer List wrapper targetted to use with retrieving AU output 58 // Works in one of two ways (both adjustable)... Can use it with NULL pointers, or allocate 59 // memory to receive the data in. 60 61 // Before using this with any call to AudioUnitRender, it needs to be Prepared 62 // as some calls to AudioUnitRender can reset the ABL 63 64 class AUOutputBL { 65 public: 66 67 // you CANNOT use one of these - it will crash! 68 // AUOutputBL (); 69 70 // this is the constructor that you use 71 // it can't be reset once you've constructed it 72 AUOutputBL (const CAStreamBasicDescription &inDesc, UInt32 inDefaultNumFrames = 512); 73 ~AUOutputBL(); 74 Prepare()75 void Prepare () 76 { 77 Prepare (mFrames); 78 } 79 80 // this version can throw if this is an allocted ABL and inNumFrames is > AllocatedFrames() 81 // you can set the bool to true if you want a NULL buffer list even if allocated 82 // inNumFrames must be a valid number (will throw if inNumFrames is 0) 83 void Prepare (UInt32 inNumFrames, bool inWantNullBufferIfAllocated = false); 84 ABL()85 AudioBufferList* ABL() { return mBufferList; } 86 87 // You only need to call this if you want to allocate a buffer list 88 // if you want an empty buffer list, just call Prepare() 89 // if you want to dispose previously allocted memory, pass in 0 90 // then you either have an empty buffer list, or you can re-allocate 91 // Memory is kept around if an Allocation request is less than what is currently allocated 92 void Allocate (UInt32 inNumberFrames); 93 AllocatedFrames()94 UInt32 AllocatedFrames() const { return mFrames; } 95 GetFormat()96 const CAStreamBasicDescription& GetFormat() const { return mFormat; } 97 98 #if DEBUG 99 void Print(); 100 #endif 101 102 private: AllocatedBytes()103 UInt32 AllocatedBytes () const { return (mBufferSize * mNumberBuffers); } 104 105 CAStreamBasicDescription mFormat; 106 Byte* mBufferMemory; 107 AudioBufferList* mBufferList; 108 UInt32 mNumberBuffers; 109 UInt32 mBufferSize; 110 UInt32 mFrames; 111 112 // don't want to copy these.. can if you want, but more code to write! AUOutputBL()113 AUOutputBL () {} 114 AUOutputBL (const AUOutputBL &c); 115 AUOutputBL& operator= (const AUOutputBL& c); 116 }; 117 118 #endif // __AUOutputBL_h__ 119