alternative new version of the AppleUtility library
[ardour.git] / libs / appleutility / CoreAudio / PublicUtility / AUOutputBL.cpp
1 /*
2      File: AUOutputBL.cpp
3  Abstract: AUOutputBL.h
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 #include "AUOutputBL.h"
48 #if !defined(__COREAUDIO_USE_FLAT_INCLUDES__)
49         #include <AudioUnit/AUComponent.h>
50 #else
51         #include <AUComponent.h>
52 #endif
53 /*
54 struct AudioBufferList
55 {
56         UInt32          mNumberBuffers;
57         AudioBuffer     mBuffers[1];
58 };
59 struct AudioBuffer
60 {
61         UInt32  mNumberChannels;        //      number of interleaved channels in the buffer
62         UInt32  mDataByteSize;          //      the size of the buffer pointed to by mData
63         void*   mData;                          //      the pointer to the buffer
64 };
65 */
66
67 AUOutputBL::AUOutputBL (const CAStreamBasicDescription &inDesc, UInt32 inDefaultNumFrames) 
68                 : mFormat (inDesc),
69                   mBufferMemory(NULL),
70                   mBufferList (NULL),
71                   mNumberBuffers (0), // keep this here, so can ensure integrity of ABL
72                   mBufferSize (0),
73                   mFrames(inDefaultNumFrames)
74 {
75         mNumberBuffers = mFormat.IsInterleaved() ? 1 : mFormat.NumberChannels();
76         mBufferList = reinterpret_cast<AudioBufferList*>(new Byte[offsetof(AudioBufferList, mBuffers) + (mNumberBuffers * sizeof(AudioBuffer))]);
77 }
78
79 AUOutputBL::~AUOutputBL()
80 {
81         if (mBufferMemory)
82                 delete[] mBufferMemory;
83
84         if (mBufferList)
85                 delete [] (Byte *)mBufferList;
86 }
87
88 void    AUOutputBL::Prepare (UInt32 inNumFrames, bool inWantNullBufferIfAllocated) 
89 {
90         UInt32 channelsPerBuffer = mFormat.IsInterleaved() ? mFormat.NumberChannels() : 1;
91         
92         if (mBufferMemory == NULL || inWantNullBufferIfAllocated)
93         {
94                 mBufferList->mNumberBuffers = mNumberBuffers;
95                 AudioBuffer *buf = &mBufferList->mBuffers[0];
96                 for (UInt32 i = 0; i < mNumberBuffers; ++i, ++buf) {
97                         buf->mNumberChannels = channelsPerBuffer;
98                         buf->mDataByteSize = mFormat.FramesToBytes (inNumFrames);
99                         buf->mData = NULL;
100                 }
101         }
102         else
103         {
104                 UInt32 nBytes = mFormat.FramesToBytes (inNumFrames);
105                 if ((nBytes * mNumberBuffers) > AllocatedBytes())
106                         throw OSStatus(kAudioUnitErr_TooManyFramesToProcess);
107                         
108                 mBufferList->mNumberBuffers = mNumberBuffers;
109                 AudioBuffer *buf = &mBufferList->mBuffers[0];
110                 Byte* p = mBufferMemory;
111                 for (UInt32 i = 0; i < mNumberBuffers; ++i, ++buf) {
112                         buf->mNumberChannels = channelsPerBuffer;
113                         buf->mDataByteSize = nBytes;
114                         buf->mData = p;
115                         p += mBufferSize;
116                 }
117         }
118 }
119
120
121 void    AUOutputBL::Allocate (UInt32 inNumFrames)
122 {
123         if (inNumFrames) 
124         {
125                 UInt32 nBytes = mFormat.FramesToBytes (inNumFrames);
126                 
127                 if (nBytes <= AllocatedBytes()) 
128                         return;
129                 
130                         // align successive buffers for Altivec and to take alternating
131                         // cache line hits by spacing them by odd multiples of 16
132                 if (mNumberBuffers > 1)
133                         nBytes = (nBytes + (0x10 - (nBytes & 0xF))) | 0x10;
134                 
135                 mBufferSize = nBytes;
136                 
137                 UInt32 memorySize = mBufferSize * mNumberBuffers;
138                 Byte *newMemory = new Byte[memorySize];
139                 memset(newMemory, 0, memorySize);       // make buffer "hot"
140                 
141                 Byte *oldMemory = mBufferMemory;
142                 mBufferMemory = newMemory;
143                 delete[] oldMemory;
144                 
145                 mFrames = inNumFrames;
146         } 
147         else 
148         {
149                 if (mBufferMemory) {
150                         delete [] mBufferMemory;
151                         mBufferMemory = NULL;
152                 }
153                 mBufferSize = 0;
154                 mFrames = 0;
155         }
156 }
157
158 #if DEBUG
159 void                    AUOutputBL::Print()
160 {
161         printf ("AUOutputBL::Print\n");
162         mFormat.Print();
163         printf ("Num Buffers:%d, mFrames:%d, allocatedMemory:%c\n", (int)mBufferList->mNumberBuffers, (int)mFrames, (mBufferMemory != NULL ? 'T' : 'F'));
164         AudioBuffer *buf = &mBufferList->mBuffers[0];
165         for (UInt32 i = 0; i < mBufferList->mNumberBuffers; ++i, ++buf)
166                 printf ("\tBuffer:%d, Size:%d, Chans:%d, Buffer:%p\n", (int)i, (int)buf->mDataByteSize, (int)buf->mNumberChannels, buf->mData);
167 }
168 #endif
169