alternative new version of the AppleUtility library

1 files changed, 403 insertions, 0 deletions

diff --git a/libs/appleutility/CoreAudio/AudioUnits/AUPublic/AUCarbonViewBase/AUCarbonViewBase.cpp b/libs/appleutility/CoreAudio/AudioUnits/AUPublic/AUCarbonViewBase/AUCarbonViewBase.cpp
new file mode 100644
index 0000000000..332475335d
--- /dev/null
+++ b/libs/appleutility/CoreAudio/AudioUnits/AUPublic/AUCarbonViewBase/AUCarbonViewBase.cpp
@@ -0,0 +1,403 @@
+/*
+     File: AUCarbonViewBase.cpp
+ Abstract: AUCarbonViewBase.h
+  Version: 1.1
+ 
+ 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.
+ 
+ Copyright (C) 2014 Apple Inc. All Rights Reserved.
+ 
+*/
+#include "AUCarbonViewBase.h"
+#include "AUCarbonViewControl.h"
+#include <algorithm>
+
+AUCarbonViewBase::AUCarbonViewBase(AudioUnitCarbonView inInstance, Float32 inNotificationInterval /* in seconds */) :
+	ComponentBase(inInstance),
+	mEditAudioUnit(0),
+	mParameterListener(NULL),
+#if !__LP64__
+	mEventListener(NULL),
+#endif
+	mTimerRef (NULL),
+	mTimerUPP (NULL),
+	mCarbonWindow(NULL),
+	mCarbonPane(NULL),
+	mXOffset(0), 
+	mYOffset(0)
+{
+	AUEventListenerCreate (ParameterListener, this,
+			CFRunLoopGetCurrent(), kCFRunLoopCommonModes, 
+			inNotificationInterval, inNotificationInterval,
+			&mParameterListener);
+}
+
+AUCarbonViewBase::~AUCarbonViewBase()
+{
+#if !__LP64__
+	if (mCarbonPane)
+		DisposeControl(mCarbonPane);
+
+	for (ControlList::iterator it = mControlList.begin(); it != mControlList.end(); ++it) {
+		AUCarbonViewControl *ctl = *it;
+		delete ctl;
+	}
+	AUListenerDispose(mParameterListener);
+
+	if (mTimerRef)
+		::RemoveEventLoopTimer (mTimerRef);
+		
+	if (mTimerUPP)
+		DisposeEventLoopTimerUPP (mTimerUPP);
+#endif
+}
+	
+void	AUCarbonViewBase::AddControl(AUCarbonViewControl *control)
+{
+	ControlList::iterator it = find(mControlList.begin(), mControlList.end(), control);
+	if (it == mControlList.end())
+		mControlList.push_back(control);
+}
+
+void	AUCarbonViewBase::RemoveControl(AUCarbonViewControl *control)
+{
+	ControlList::iterator it = find(mControlList.begin(), mControlList.end(), control);
+	if (it != mControlList.end()) {
+		AUCarbonViewControl *ctl = *it;
+		mControlList.erase(it);
+		delete ctl;
+	}
+}
+
+void	AUCarbonViewBase::ClearControls ()
+{
+	for (ControlList::iterator it = mControlList.begin(); it != mControlList.end(); ++it) {
+		AUCarbonViewControl *ctl = *it;
+		delete ctl;
+	}
+	mControlList.clear();
+}
+
+void	AUCarbonViewBase::ParameterListener(void *				inCallbackRefCon,
+									void *						inObject,
+									const AudioUnitEvent *		inEvent,
+									UInt64						inEventHostTime,
+									Float32						inParameterValue)
+{
+	if (inEvent->mEventType == kAudioUnitEvent_ParameterValueChange) {
+		AUCarbonViewControl *ctl = (AUCarbonViewControl *)inObject;
+		ctl->ParameterToControl(inParameterValue);
+	}
+}
+
+									
+OSStatus			AUCarbonViewBase::CreateCarbonView(AudioUnit inAudioUnit, WindowRef inWindow, ControlRef inParentControl, const Float32Point &inLocation, const Float32Point &inSize, ControlRef &outParentControl)
+{
+#if !__LP64__
+	mEditAudioUnit = inAudioUnit;
+	mCarbonWindow = inWindow;
+
+	WindowAttributes attributes;
+	verify_noerr(GetWindowAttributes(mCarbonWindow, &attributes));
+	mCompositWindow = (attributes & kWindowCompositingAttribute) != 0;
+
+	Rect area;
+	area.left = short(inLocation.x); area.top = short(inLocation.y);
+	area.right = short(area.left + inSize.x); area.bottom = short(area.top + inSize.y);
+	OSStatus err = ::CreateUserPaneControl(inWindow, &area, 
+						kControlSupportsEmbedding,
+						&mCarbonPane);	// subclass can resize mCarbonPane to taste
+	verify_noerr(err);
+	if (err) return err;
+	outParentControl = mCarbonPane;
+	
+	// register for mouse-down in our pane -- we want to clear focus
+	EventTypeSpec paneEvents[] = {
+		{ kEventClassControl, kEventControlClick }
+	};
+	WantEventTypes(GetControlEventTarget(mCarbonPane), GetEventTypeCount(paneEvents), paneEvents);
+	
+	if (IsCompositWindow()) {
+		verify_noerr(::HIViewAddSubview(inParentControl, mCarbonPane));
+		mXOffset = 0;
+		mYOffset = 0;
+	}
+	else {
+		verify_noerr(::EmbedControl(mCarbonPane, inParentControl));
+		mXOffset = inLocation.x;
+		mYOffset = inLocation.y;
+	}
+	mBottomRight.h = mBottomRight.v = 0;
+	
+	SizeControl(mCarbonPane, 0, 0);
+	if (err = CreateUI(mXOffset, mYOffset))
+		return err;
+
+	// we should only resize the control if a subclass has embedded
+	// controls in this AND this is done with the EmbedControl call below
+	// if mBottomRight is STILL equal to zero, then that wasn't done
+	// so don't size the control
+	Rect paneBounds;
+	GetControlBounds(mCarbonPane, &paneBounds);
+	// only resize mCarbonPane if it has not already been resized during CreateUI
+	if ((paneBounds.top == paneBounds.bottom) && (paneBounds.left == paneBounds.right)) {
+		if (mBottomRight.h != 0 && mBottomRight.v != 0)
+			SizeControl(mCarbonPane, (short) (mBottomRight.h - mXOffset), (short) (mBottomRight.v - mYOffset));
+	}
+
+	if (IsCompositWindow()) {
+		// prepare for handling scroll-events
+		EventTypeSpec scrollEvents[] = {
+			{ kEventClassScrollable, kEventScrollableGetInfo },
+			{ kEventClassScrollable, kEventScrollableScrollTo }
+		};
+		
+		WantEventTypes(GetControlEventTarget(mCarbonPane), GetEventTypeCount(scrollEvents), scrollEvents);
+	
+		mCurrentScrollPoint.x = mCurrentScrollPoint.y = 0.0f;
+	}
+	
+	return err;
+#else
+	return noErr;
+#endif
+}
+
+OSStatus	AUCarbonViewBase::CreateUI(Float32	inXOffset, Float32 	inYOffset)
+{
+	return noErr;
+}
+
+OSStatus	AUCarbonViewBase::EmbedControl(ControlRef ctl)
+{
+#if !__LP64__
+	Rect r;
+	::GetControlBounds(ctl, &r);
+	if (r.right > mBottomRight.h) mBottomRight.h = r.right;
+	if (r.bottom > mBottomRight.v) mBottomRight.v = r.bottom;
+
+	if (IsCompositWindow()) 
+		return ::HIViewAddSubview(mCarbonPane, ctl);
+	else 
+		return ::EmbedControl(ctl, mCarbonPane);	
+#else
+	return noErr;
+#endif
+}
+
+void	AUCarbonViewBase::AddCarbonControl(AUCarbonViewControl::ControlType type, const CAAUParameter &param, ControlRef control)
+{
+	verify_noerr(EmbedControl(control));
+    
+	AUCarbonViewControl *auvc = new AUCarbonViewControl(this, mParameterListener, type, param, control);
+	auvc->Bind();
+	AddControl(auvc);
+}
+
+bool	AUCarbonViewBase::HandleEvent(EventHandlerCallRef inHandlerRef, EventRef event)
+{	
+#if !__LP64__
+	UInt32 eclass = GetEventClass(event);
+	UInt32 ekind = GetEventKind(event);
+	ControlRef control;
+	
+	switch (eclass) {
+		case kEventClassControl:
+		{
+			switch (ekind) {
+			case kEventControlClick:
+				GetEventParameter(event, kEventParamDirectObject, typeControlRef, NULL, sizeof(ControlRef), NULL, &control);
+				if (control == mCarbonPane) {
+					ClearKeyboardFocus(mCarbonWindow);
+					return true;
+				}
+			}
+		}
+		break;
+		
+		case kEventClassScrollable:
+		{
+			switch (ekind) {
+			case kEventScrollableGetInfo:
+				{
+					// [1/4]
+					/*	<--	kEventParamImageSize (out, typeHISize)
+					 *		On exit, contains the size of the entire scrollable view.
+					 */
+					HISize originalSize = { mBottomRight.h, mBottomRight.v };
+					verify_noerr(SetEventParameter(event, kEventParamImageSize, typeHISize, sizeof(HISize), &originalSize));
+					
+					// [2/4]
+					/*	<--	kEventParamViewSize (out, typeHISize)
+					 *		On exit, contains the amount of the scrollable view that is
+					 *		visible.
+					 */
+					HIViewRef parentView = HIViewGetSuperview(mCarbonPane);
+					HIRect parentBounds;
+					verify_noerr(HIViewGetBounds(parentView, &parentBounds));
+					//HISize windowSize = {	float(windowBounds.right - windowBounds.left),
+					//						float(windowBounds.bottom - windowBounds.top) };
+					verify_noerr(SetEventParameter(event, kEventParamViewSize, typeHISize, sizeof(HISize), &(parentBounds.size)));
+					
+					// [3/4]
+					/*	<--	kEventParamLineSize (out, typeHISize)
+					 *		On exit, contains the amount that should be scrolled in
+					 *		response to a single click on a scrollbar arrow.
+					 */
+					 HISize scrollIncrementSize = { 16.0f, float(20) };
+					 verify_noerr(SetEventParameter(event, kEventParamLineSize, typeHISize, sizeof(HISize), &scrollIncrementSize));
+					 
+					// [4/4]
+					/*	<-- kEventParamOrigin (out, typeHIPoint)
+					 *		On exit, contains the scrollable viewÕs current origin (the
+					 *		view-relative coordinate that is drawn at the top left
+					 *		corner of its frame). These coordinates should always be
+					 *		greater than or equal to zero. They should be less than or
+					 *		equal to the viewÕs image size minus its view size.
+					 */
+					 verify_noerr(SetEventParameter(event, kEventParamOrigin, typeHIPoint, sizeof(HIPoint), &mCurrentScrollPoint));
+				}
+				return true;
+				
+			case kEventScrollableScrollTo:
+				{
+					/*
+					 *  kEventClassScrollable / kEventScrollableScrollTo
+					 *  
+					 *  Summary:
+					 *    Requests that an HIScrollViewÕs scrollable view should scroll to
+					 *    a particular origin.
+					 */
+					
+					/*	-->	kEventParamOrigin (in, typeHIPoint)
+					 *		The new origin for the scrollable view. The origin
+					 *		coordinates will vary from (0,0) to scrollable viewÕs image
+					 *		size minus its view size.
+					 */
+					HIPoint pointToScrollTo;
+					verify_noerr(GetEventParameter(event, kEventParamOrigin, typeHIPoint, NULL, sizeof(HIPoint), NULL, &pointToScrollTo));
+					
+					float xDelta = mCurrentScrollPoint.x - pointToScrollTo.x;
+					float yDelta = mCurrentScrollPoint.y - pointToScrollTo.y;
+					// move visible portion the appropriate amount
+					verify_noerr(HIViewScrollRect(mCarbonPane, NULL, xDelta, yDelta));
+					// set new content to be drawn
+					verify_noerr(HIViewSetBoundsOrigin(mCarbonPane, pointToScrollTo.x, pointToScrollTo.y));
+					
+					mCurrentScrollPoint = pointToScrollTo;
+				}
+				return true;
+				
+			default:
+				break;
+			}
+		}
+		break;
+		
+		default:
+			break;
+	}
+#endif
+	return false;
+}
+
+/*! @method TellListener */
+void	AUCarbonViewBase::TellListener (const CAAUParameter &auvp, AudioUnitCarbonViewEventID event, void *evpar)
+{
+#if !__LP64__
+	if (mEventListener)
+		(*mEventListener)(mEventListenerUserData, mComponentInstance, &auvp, event, evpar);
+#endif
+
+	AudioUnitEvent	auEvent;
+	auEvent.mArgument.mParameter = auvp;
+	if (event == kAudioUnitCarbonViewEvent_MouseDownInControl) {
+		auEvent.mEventType = kAudioUnitEvent_BeginParameterChangeGesture;
+	} else {
+		auEvent.mEventType = kAudioUnitEvent_EndParameterChangeGesture;
+	}
+	AUEventListenerNotify(mParameterListener, this, &auEvent);									
+}
+
+
+void			AUCarbonViewBase::Update (bool inUIThread)
+{
+	for (ControlList::iterator iter = mControlList.begin(); iter != mControlList.end(); ++iter)
+	{
+		(*iter)->Update(inUIThread);
+	}
+}
+
+pascal void		AUCarbonViewBase::TheTimerProc (EventLoopTimerRef inTimer, void *inUserData)
+{
+	AUCarbonViewBase* This = reinterpret_cast<AUCarbonViewBase*>(inUserData);
+	This->RespondToEventTimer (inTimer);
+}
+
+void			AUCarbonViewBase::RespondToEventTimer (EventLoopTimerRef inTimer) 
+{}
+
+/* 
+	THESE are reasonable values for these two times
+	0.005 // delay 
+	0.050 // interval
+*/
+
+OSStatus	AUCarbonViewBase::CreateEventLoopTimer (Float32 inDelay, Float32 inInterval) 
+{
+	if (mTimerUPP)
+		return noErr;
+	
+	mTimerUPP = NewEventLoopTimerUPP(TheTimerProc);
+	
+	EventLoopRef mainEventLoop = GetMainEventLoop();
+	
+		//doesn't seem to like too small a value
+	if (inDelay < 0.005)
+		inDelay = 0.005;
+			
+	OSStatus timerResult =  ::InstallEventLoopTimer(
+									mainEventLoop,
+									inDelay,
+									inInterval,
+									mTimerUPP,
+									this,
+									&mTimerRef);                       
+	return timerResult;
+}