/* Copyright © 2007 Apple Inc. All Rights Reserved. Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple Inc. ("Apple") in consideration of your agreement to the following terms, and your use, installation, modification or redistribution of this Apple software constitutes acceptance of these terms. If you do not agree with these terms, please do not use, install, modify or redistribute this Apple software. In consideration of your agreement to abide by the following terms, and subject to these terms, Apple grants you a personal, non-exclusive license, under Apple's copyrights in this original Apple software (the "Apple Software"), to use, reproduce, modify and redistribute the Apple Software, with or without modifications, in source and/or binary forms; provided that if you redistribute the Apple Software in its entirety and without modifications, you must retain this notice and the following text and disclaimers in all such redistributions of the Apple Software. Neither the name, trademarks, service marks or logos of Apple Inc. may be used to endorse or promote products derived from the Apple Software without specific prior written permission from Apple. Except as expressly stated in this notice, no other rights or licenses, express or implied, are granted by Apple herein, including but not limited to any patent rights that may be infringed by your derivative works or by other works in which the Apple Software may be incorporated. The Apple Software is provided by Apple on an "AS IS" basis. APPLE MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS. IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #ifndef __ComponentBase_h__ #define __ComponentBase_h__ #include #include "CADebugMacros.h" #if !defined(__COREAUDIO_USE_FLAT_INCLUDES__) #include #include #if !TARGET_OS_IPHONE #include #if (MAC_OS_X_VERSION_MAX_ALLOWED <= MAC_OS_X_VERSION_10_5) #define AudioComponentInstance ComponentInstance #define AudioComponentDescription ComponentDescription #define AudioComponent Component #define CA_DO_NOT_USE_AUDIO_COMPONENT 1 #endif #endif #if MAC_OS_X_VERSION_MAX_ALLOWED <= MAC_OS_X_VERSION_10_4 typedef Float32 AudioUnitParameterValue; #endif #if COREAUDIOTYPES_VERSION < 1051 typedef Float32 AudioUnitSampleType; #endif #include #else #include "CoreAudioTypes.h" #include "Components.h" #include "AudioUnit.h" #include "CAGuard.h" #endif #ifndef COMPONENT_THROW #if VERBOSE_COMPONENT_THROW #define COMPONENT_THROW(err) \ do { DebugMessage(#err); throw static_cast(err); } while (0) #else #define COMPONENT_THROW(err) \ throw static_cast(err) #endif #endif #define COMPONENT_CATCH \ catch (std::bad_alloc &) { result = -108/*memFullErr*/; } \ catch (OSStatus err) { result = err; } \ catch (OSErr err) { result = err; } \ catch (...) { result = -1; } class ComponentInitLocker { #if TARGET_OS_MAC public: ComponentInitLocker() { pthread_mutex_lock(&sComponentOpenMutex); } ~ComponentInitLocker() { pthread_mutex_unlock(&sComponentOpenMutex); } private: static pthread_mutex_t sComponentOpenMutex; #elif TARGET_OS_WIN32 public: bool sNeedsUnlocking; ComponentInitLocker() { sNeedsUnlocking = sComponentOpenGuard.Lock(); } ~ComponentInitLocker() { if(sNeedsUnlocking) { sComponentOpenGuard.Unlock(); } } private: static CAGuard sComponentOpenGuard; #endif }; #if !TARGET_OS_IPHONE /*! @class ComponentEntryPoint */ template class ComponentEntryPoint { public: /*! @method Dispatch */ static OSStatus Dispatch(ComponentParameters *params, Class *obj) { OSStatus result = noErr; try { if (params->what == kComponentOpenSelect) { // solve a host of initialization thread safety issues. ComponentInitLocker lock; ComponentInstance ci = (ComponentInstance)(params->params[0]); Class *This = new Class((AudioComponentInstance)ci); This->PostConstructor(); // allows base class to do additional initialization // once the derived class is fully constructed #if !CA_AU_IS_ONLY_PLUGIN SetComponentInstanceStorage(ci, (Handle)This); #endif } else result = Class::ComponentEntryDispatch(params, obj); } COMPONENT_CATCH return result; } /*! @method Register */ static Component Register(OSType compType, OSType subType, OSType manufacturer) { ComponentDescription description = {compType, subType, manufacturer, 0, 0}; Component component = RegisterComponent(&description, (ComponentRoutineUPP) Dispatch, registerComponentGlobal, NULL, NULL, NULL); if (component != NULL) { SetDefaultComponent(component, defaultComponentAnyFlagsAnyManufacturerAnySubType); } return component; } }; #if TARGET_OS_MAC && TARGET_CPU_PPC && !TARGET_RT_MAC_MACHO // for OS 9, a PPC native component's entry point must be a routine descriptor #define COMPONENT_ENTRY(Class) \ extern "C" __attribute__ ((visibility("default"))) OSStatus Class##Entry(ComponentParameters *params, Class *obj); \ extern "C" __attribute__ ((visibility("default"))) OSStatus Class##Entry(ComponentParameters *params, Class *obj) { \ return ComponentEntryPoint::Dispatch(params, obj); \ } \ \ struct RoutineDescriptor Class##EntryRD = \ BUILD_ROUTINE_DESCRIPTOR((kPascalStackBased | RESULT_SIZE (kFourByteCode) | \ STACK_ROUTINE_PARAMETER (1, kFourByteCode) | \ STACK_ROUTINE_PARAMETER (2, kFourByteCode)), Class##Entry); #else #define COMPONENT_ENTRY(Class) \ extern "C" __attribute__ ((visibility("default"))) OSStatus Class##Entry(ComponentParameters *params, Class *obj); \ extern "C" __attribute__ ((visibility("default"))) OSStatus Class##Entry(ComponentParameters *params, Class *obj) { \ return ComponentEntryPoint::Dispatch(params, obj); \ } #endif /*! @class ComponentRegistrar */ template class ComponentRegistrar { public: /*! @ctor ComponentRegistrar */ ComponentRegistrar() { ComponentEntryPoint::Register(Type, Subtype, Manufacturer); } }; #define COMPONENT_REGISTER(Class,Type,Subtype,Manufacturer) \ static ComponentRegistrar gRegistrar##Class #else #define COMPONENT_ENTRY(Class) #define COMPONENT_REGISTER(Class) #endif // !TARGET_OS_IPHONE /*! @class ComponentBase */ class ComponentBase { public: // classic MacErrors enum { noErr = 0, paramErr = -50, memFullErr = -108 }; /*! @ctor ComponentBase */ ComponentBase(AudioComponentInstance inInstance) : mComponentInstance(inInstance) { } /*! @dtor ~ComponentBase */ virtual ~ComponentBase(); /*! @method PostConstructor */ virtual void PostConstructor(); /*! @method PreDestructor */ virtual void PreDestructor(); #if !TARGET_OS_IPHONE /*! @method Version */ virtual OSStatus Version(); /*! @method ComponentEntryDispatch */ static OSStatus ComponentEntryDispatch(ComponentParameters *p, ComponentBase *This); #endif /*! @method GetComponentInstance */ AudioComponentInstance GetComponentInstance() const { return mComponentInstance; } /*! @method GetComponentDescription */ AudioComponentDescription GetComponentDescription() const; protected: /*! @var mComponentInstance */ AudioComponentInstance mComponentInstance; }; #endif // __ComponentBase_h__