Cinder  0.8.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
CinderCoreAudio.h
Go to the documentation of this file.
1 /*
2  Copyright (c) 2014, The Cinder Project
3 
4  This code is intended to be used with the Cinder C++ library, http://libcinder.org
5 
6  Redistribution and use in source and binary forms, with or without modification, are permitted provided that
7  the following conditions are met:
8 
9  * Redistributions of source code must retain the above copyright notice, this list of conditions and
10  the following disclaimer.
11  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
12  the following disclaimer in the documentation and/or other materials provided with the distribution.
13 
14  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
15  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
16  PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
17  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
18  TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
19  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
20  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
21  POSSIBILITY OF SUCH DAMAGE.
22 */
23 
24 #pragma once
25 
27 
28 #include <memory>
29 #include <vector>
30 #include <AudioToolbox/AudioToolbox.h>
31 
32 struct AudioStreamBasicDescription;
33 
34 namespace cinder { namespace audio { namespace cocoa {
35 
37 void printASBD( const ::AudioStreamBasicDescription &asbd );
38 
40  void operator()( ::AudioBufferList *bufferList )
41  {
42  for( size_t i = 0; i < bufferList->mNumberBuffers; i++ )
43  free( bufferList->mBuffers[i].mData );
44  free( bufferList );
45  }
46 };
47 
49  void operator()( ::AudioBufferList *bufferList )
50  {
51  free( bufferList );
52  }
53 };
54 
55 typedef std::unique_ptr<::AudioBufferList, AudioBufferListDeleter> AudioBufferListPtr;
56 typedef std::unique_ptr<::AudioBufferList, AudioBufferListShallowDeleter> AudioBufferListShallowPtr;
57 
58 AudioBufferListPtr createNonInterleavedBufferList( size_t numFrames, size_t numChannels );
60 
61 
62 ::AudioComponent findAudioComponent( const ::AudioComponentDescription &componentDescription );
63 void findAndCreateAudioComponent( const ::AudioComponentDescription &componentDescription, ::AudioComponentInstance *componentInstance );
64 
65 ::AudioStreamBasicDescription createFloatAsbd( size_t sampleRate, size_t numChannels, bool isInterleaved = false );
66 ::AudioStreamBasicDescription createInt16Asbd( size_t sampleRate, size_t numChannels, bool isInterleaved = false );
67 
68 inline void copyToBufferList( ::AudioBufferList *bufferList, const Buffer *buffer )
69 {
70  for( UInt32 i = 0; i < bufferList->mNumberBuffers; i++ )
71  memcpy( bufferList->mBuffers[i].mData, buffer->getChannel( i ), bufferList->mBuffers[i].mDataByteSize );
72 }
73 
74 inline void copyFromBufferList( Buffer *buffer, const ::AudioBufferList *bufferList )
75 {
76  for( UInt32 i = 0; i < bufferList->mNumberBuffers; i++ )
77  memcpy( buffer->getChannel( i ), bufferList->mBuffers[i].mData, bufferList->mBuffers[i].mDataByteSize );
78 }
79 
80 inline void zeroBufferList( const ::AudioBufferList *bufferList )
81 {
82  for( UInt32 i = 0; i < bufferList->mNumberBuffers; i++ )
83  memset( bufferList->mBuffers[i].mData, 0, bufferList->mBuffers[i].mDataByteSize );
84 }
85 
86 // ----------------------------------------------------------------------------------------------------
87 // MARK: - ConverterImplCoreAudio
88 // ----------------------------------------------------------------------------------------------------
89 
91  public:
92  ConverterImplCoreAudio( size_t sourceSampleRate, size_t destSampleRate, size_t sourceNumChannels, size_t destNumChannels, size_t sourceMaxFramesPerBlock );
93  virtual ~ConverterImplCoreAudio();
94 
95  virtual std::pair<size_t,size_t> convert( const Buffer *sourceBuffer, Buffer *destBuffer ) override;
96  virtual void clear() override;
97 
98  private:
99  std::pair<size_t,size_t> convertComplexImpl( const Buffer *sourceBuffer, Buffer *destBuffer );
100  static OSStatus converterCallback( ::AudioConverterRef inAudioConverter, UInt32 *ioNumberDataPackets, ::AudioBufferList *ioData, ::AudioStreamPacketDescription **outDataPacketDescription, void *inUserData);
101 
102  Buffer mMixingBuffer;
103  const Buffer *mSourceBuffer;
104  size_t mNumReadFramesNeeded, mNumSourceBufferFramesUsed;
105 
106  AudioBufferListShallowPtr mOutputBufferList;
107  ::AudioConverterRef mAudioConverter;
108 };
109 
110 // ----------------------------------------------------------------------------------------------------
111 // MARK: - Audio Unit Utils
112 // ----------------------------------------------------------------------------------------------------
113 
114 ::AudioComponentDescription getOutputAudioUnitDesc();
115 ::AudioStreamBasicDescription getAudioUnitASBD( ::AudioUnit audioUnit, ::AudioUnitScope scope, ::AudioUnitElement bus );
116 
117 template <typename PropT>
118 inline void setAudioUnitProperty( ::AudioUnit audioUnit, ::AudioUnitPropertyID propertyId, const PropT &property, ::AudioUnitScope scope, ::AudioUnitElement bus )
119 {
120  OSStatus status = ::AudioUnitSetProperty( audioUnit, propertyId, scope, bus, &property, sizeof( property ) );
121  CI_VERIFY( status == noErr );
122 }
123 
124 template <typename PropT>
125 inline PropT getAudioUnitProperty( ::AudioUnit audioUnit, ::AudioUnitPropertyID propertyId, ::AudioUnitScope scope, ::AudioUnitElement bus )
126 {
127  PropT result;
128  UInt32 resultSize = sizeof( result );
129  OSStatus status = ::AudioUnitGetProperty( audioUnit, propertyId, scope, bus, &result, &resultSize );
130  CI_VERIFY( status == noErr );
131  return result;
132 }
133 
134 template <typename ResultT>
135 inline void getAudioUnitParam( ::AudioUnit audioUnit, ::AudioUnitParameterID paramId, ResultT &result, ::AudioUnitScope scope, size_t bus )
136 {
137  ::AudioUnitParameterValue param;
138  ::AudioUnitElement busElement = static_cast<::AudioUnitElement>( bus );
139  OSStatus status = ::AudioUnitGetParameter( audioUnit, paramId, scope, busElement, &param );
140  CI_VERIFY( status == noErr );
141  result = static_cast<ResultT>( param );
142 }
143 
144 template <typename ParamT>
145 inline void setAudioUnitParam( ::AudioUnit audioUnit, ::AudioUnitParameterID paramId, const ParamT &param, ::AudioUnitScope scope, size_t bus )
146 {
147  ::AudioUnitParameterValue value = static_cast<::AudioUnitParameterValue>( param );
148  ::AudioUnitElement busElement = static_cast<::AudioUnitElement>( bus );
149  OSStatus status = ::AudioUnitSetParameter( audioUnit, paramId, scope, busElement, value, 0 );
150  CI_VERIFY( status == noErr );
151 }
152 
153 inline std::vector<::AUChannelInfo> getAudioUnitChannelInfo( ::AudioUnit audioUnit, ::AudioUnitElement bus )
154 {
155  std::vector<::AUChannelInfo> result;
156  UInt32 resultSize;
157  OSStatus status = ::AudioUnitGetPropertyInfo( audioUnit, kAudioUnitProperty_SupportedNumChannels, kAudioUnitScope_Global, 0, &resultSize, NULL );
158  if( status == kAudioUnitErr_InvalidProperty ) {
159  // "if this property is NOT implemented an FX unit is expected to deal with same channel valance in and out" - CAPublicUtility / CAAudioUnit.cpp
160  return result;
161  } else
162  CI_VERIFY( status == noErr );
163 
164  result.resize( resultSize / sizeof( ::AUChannelInfo ) );
165  status = ::AudioUnitGetProperty( audioUnit, kAudioUnitProperty_SupportedNumChannels, kAudioUnitScope_Global, 0, result.data(), &resultSize );
166  CI_VERIFY( status == noErr );
167 
168  return result;
169 }
170 
171 } } } // namespace cinder::audio::cocoa
T * getChannel(size_t ch)
Returns a pointer offset to the first sample of channel ch.
Definition: Buffer.h:97
AudioBufferListPtr createNonInterleavedBufferList(size_t numFrames, size_t numChannels)
Definition: CinderCoreAudio.cpp:178
void setAudioUnitParam(::AudioUnit audioUnit,::AudioUnitParameterID paramId, const ParamT &param,::AudioUnitScope scope, size_t bus)
Definition: CinderCoreAudio.h:145
void operator()(::AudioBufferList *bufferList)
Definition: CinderCoreAudio.h:49
A platform-specific converter that supports samplerate and channel conversion.
Definition: Converter.h:33
::AudioStreamBasicDescription createFloatAsbd(size_t sampleRate, size_t numChannels, bool isInterleaved=false)
Definition: CinderCoreAudio.cpp:220
void getAudioUnitParam(::AudioUnit audioUnit,::AudioUnitParameterID paramId, ResultT &result,::AudioUnitScope scope, size_t bus)
Definition: CinderCoreAudio.h:135
ConverterImplCoreAudio(size_t sourceSampleRate, size_t destSampleRate, size_t sourceNumChannels, size_t destNumChannels, size_t sourceMaxFramesPerBlock)
Definition: CinderCoreAudio.cpp:52
AudioBufferListShallowPtr createNonInterleavedBufferListShallow(size_t numChannels)
Definition: CinderCoreAudio.cpp:192
std::vector<::AUChannelInfo > getAudioUnitChannelInfo(::AudioUnit audioUnit,::AudioUnitElement bus)
Definition: CinderCoreAudio.h:153
virtual void clear() override
Clears the state of the converter, discarding / flushing accumulated samples. Optional for implementa...
Definition: CinderCoreAudio.cpp:151
#define CI_VERIFY(expr)
Definition: CinderAssert.h:80
void copyToBufferList(::AudioBufferList *bufferList, const Buffer *buffer)
Definition: CinderCoreAudio.h:68
void zeroBufferList(const ::AudioBufferList *bufferList)
Definition: CinderCoreAudio.h:80
std::unique_ptr<::AudioBufferList, AudioBufferListShallowDeleter > AudioBufferListShallowPtr
Definition: CinderCoreAudio.h:56
GLuint buffer
Definition: GLee.h:2065
void printASBD(const ::AudioStreamBasicDescription &asbd)
convience function for pretty printing asbd
Definition: CinderCoreAudio.cpp:162
virtual std::pair< size_t, size_t > convert(const Buffer *sourceBuffer, Buffer *destBuffer) override
Definition: CinderCoreAudio.cpp:85
PropT getAudioUnitProperty(::AudioUnit audioUnit,::AudioUnitPropertyID propertyId,::AudioUnitScope scope,::AudioUnitElement bus)
Definition: CinderCoreAudio.h:125
Definition: CinderCoreAudio.h:39
GLsizei const GLfloat * value
Definition: GLee.h:2487
void findAndCreateAudioComponent(const ::AudioComponentDescription &componentDescription,::AudioComponentInstance *componentInstance)
Definition: CinderCoreAudio.cpp:213
std::unique_ptr<::AudioBufferList, AudioBufferListDeleter > AudioBufferListPtr
Definition: CinderCoreAudio.h:55
void copyFromBufferList(Buffer *buffer, const ::AudioBufferList *bufferList)
Definition: CinderCoreAudio.h:74
Definition: CinderCoreAudio.h:90
::AudioStreamBasicDescription createInt16Asbd(size_t sampleRate, size_t numChannels, bool isInterleaved=false)
Definition: CinderCoreAudio.cpp:246
void setAudioUnitProperty(::AudioUnit audioUnit,::AudioUnitPropertyID propertyId, const PropT &property,::AudioUnitScope scope,::AudioUnitElement bus)
Definition: CinderCoreAudio.h:118
::AudioStreamBasicDescription getAudioUnitASBD(::AudioUnit audioUnit,::AudioUnitScope scope,::AudioUnitElement bus)
Definition: CinderCoreAudio.cpp:284
::AudioComponentDescription getOutputAudioUnitDesc()
Definition: CinderCoreAudio.cpp:271
::AudioComponent findAudioComponent(const ::AudioComponentDescription &componentDescription)
Definition: CinderCoreAudio.cpp:206
virtual ~ConverterImplCoreAudio()
Definition: CinderCoreAudio.cpp:77
GLfloat param
Definition: GLee.h:1737
void operator()(::AudioBufferList *bufferList)
Definition: CinderCoreAudio.h:40