AudioUnitUtils Namespace Reference

Classes
struct	Buffer
struct	Parameter
struct	ParameterInfo
struct	ParameterNameInfo
struct	Property
struct	RenderCallback
struct	StreamBasicDescription
struct	UserPreset

Functions
OSStatus	GetFixedSizePropertyPtr (AudioUnit unit, AudioUnitPropertyID inID, void *pProperty, UInt32 size, AudioUnitScope inScope, AudioUnitElement inElement)
	Type-erased function to get an AudioUnit property of fixed size. More...
template<typename T >
OSStatus	GetFixedSizeProperty (AudioUnit unit, AudioUnitPropertyID inID, T &property, AudioUnitScope inScope=kAudioUnitScope_Global, AudioUnitElement inElement=0)
OSStatus	GetVariableSizePropertyPtr (AudioUnit unit, AudioUnitPropertyID inID, size_t minSize, void *&pObject, size_t &size, AudioUnitScope inScope, AudioUnitElement inElement)
	Type-erased function to get an AudioUnit property of variable size. More...
template<typename T >
OSStatus	GetVariableSizeProperty (AudioUnit unit, AudioUnitPropertyID inID, PackedArray::Ptr< T > &pObject, AudioUnitScope inScope=kAudioUnitScope_Global, AudioUnitElement inElement=0)
OSStatus	SetPropertyPtr (AudioUnit unit, AudioUnitPropertyID inID, const void *pProperty, UInt32 size, AudioUnitScope inScope, AudioUnitElement inElement)
	Type-erased function to set an AudioUnit property. More...
template<typename T >
OSStatus	SetProperty (AudioUnit unit, AudioUnitPropertyID inID, const T &property, AudioUnitScope inScope=kAudioUnitScope_Global, AudioUnitElement inElement=0)

Function Documentation

GetFixedSizeProperty()

template<typename T >

OSStatus AudioUnitUtils::GetFixedSizeProperty	(	AudioUnit	unit,
		AudioUnitPropertyID	inID,
		T &	property,
		AudioUnitScope	inScope = kAudioUnitScope_Global,
		AudioUnitElement	inElement = 0
	)

Get an AudioUnit property of deduced type and fixed size, supplying most often used values as defaults for scope and element

Definition at line 40 of file AudioUnitUtils.h.

   {
      return GetFixedSizePropertyPtr(unit, inID,
         &property, sizeof(property), inScope, inElement);
   }

References GetFixedSizePropertyPtr().

Referenced by AudioUnitWrapper::GetFixedSizeProperty(), AudioUnitInstance::GetLatency(), and AudioUnitWrapper::ParameterInfo::ParameterInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

GetFixedSizePropertyPtr()

OSStatus AudioUnitUtils::GetFixedSizePropertyPtr	(	AudioUnit	unit,
		AudioUnitPropertyID	inID,
		void *	pProperty,
		UInt32	size,
		AudioUnitScope	inScope,
		AudioUnitElement	inElement
	)

Type-erased function to get an AudioUnit property of fixed size.

Definition at line 14 of file AudioUnitUtils.cpp.

{
   auto newSize = size;
   auto result = AudioUnitGetProperty(unit, inID, inScope, inElement,
      pProperty, &newSize);
   assert(newSize <= size);
   return result;
}

References size.

Referenced by GetFixedSizeProperty().

Here is the caller graph for this function:

GetVariableSizeProperty()

template<typename T >

OSStatus AudioUnitUtils::GetVariableSizeProperty	(	AudioUnit	unit,
		AudioUnitPropertyID	inID,
		PackedArray::Ptr< T > &	pObject,
		AudioUnitScope	inScope = kAudioUnitScope_Global,
		AudioUnitElement	inElement = 0
	)

Get an AudioUnit property of deduced type and variable size, supplying most often used values as defaults for scope and element, and seating the raw pointer result into a smart pointer

Definition at line 62 of file AudioUnitUtils.h.

   {
      void *p{};
      size_t size{};
      auto result = GetVariableSizePropertyPtr(unit, inID,
         sizeof(typename PackedArray::Traits<T>::header_type), p, size,
         inScope, inElement);
      if (!result)
         // Construct PackedArray::Ptr
         pObject = {
            static_cast<T*>(p), // the pointer
            size // the size that the deleter must remember
         };
      return result;
   }

References GetVariableSizePropertyPtr(), and size.

Referenced by AudioUnitWrapper::GetVariableSizeProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

GetVariableSizePropertyPtr()

OSStatus AudioUnitUtils::GetVariableSizePropertyPtr	(	AudioUnit	unit,
		AudioUnitPropertyID	inID,
		size_t	minSize,
		void *&	pObject,
		size_t &	size,
		AudioUnitScope	inScope,
		AudioUnitElement	inElement
	)

Type-erased function to get an AudioUnit property of variable size.

Warning: on success, performs a "naked" allocation in pObject! Else, nulls it.

Definition at line 25 of file AudioUnitUtils.cpp.

{
   size = 0;
 
   // Query for statically unknown size of the property first
   UInt32 dataSize;
   auto result = AudioUnitGetPropertyInfo(unit, inID, inScope, inElement,
      &dataSize, nullptr);
   if (result)
      return result;
 
   // Allocate
   auto newSize = std::max<size_t>(minSize, dataSize);
   auto pObj = ::operator new(newSize);
   auto cleanup = finally([&]{
      // In case AudioUnitGetProperty fails
      if (!pObject)
         ::operator delete(pObj);
   });
 
   // Try to get the property
   dataSize = newSize;
   result =
      AudioUnitGetProperty(unit, inID, inScope, inElement, pObj, &dataSize);
   if (result) {
      pObject = nullptr;
      return result;
   }
 
   // Success
   pObject = pObj;
   size = newSize;
   return result;
}

References size.

Referenced by GetVariableSizeProperty().

Here is the caller graph for this function:

SetProperty()

template<typename T >

OSStatus AudioUnitUtils::SetProperty	(	AudioUnit	unit,
		AudioUnitPropertyID	inID,
		const T &	property,
		AudioUnitScope	inScope = kAudioUnitScope_Global,
		AudioUnitElement	inElement = 0
	)

Set an AudioUnit property of deduced type, supplying most often used values as defaults for scope and element

Definition at line 89 of file AudioUnitUtils.h.

   {
      return SetPropertyPtr(unit, inID,
         &property, sizeof(property), inScope, inElement);
   }

References SetPropertyPtr().

Referenced by AudioUnitWrapper::SetProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

SetPropertyPtr()

OSStatus AudioUnitUtils::SetPropertyPtr	(	AudioUnit	unit,
		AudioUnitPropertyID	inID,
		const void *	pProperty,
		UInt32	size,
		AudioUnitScope	inScope,
		AudioUnitElement	inElement
	)

Type-erased function to set an AudioUnit property.

Definition at line 63 of file AudioUnitUtils.cpp.

{
   return AudioUnitSetProperty(unit, inID, inScope, inElement,
      pProperty, size);
}

References size.

Referenced by SetProperty().

Here is the caller graph for this function: