--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/devsound/a3fdevsound/src/mmfdevsoundproxy/mmfdevsoundcallbackhandler.cpp Thu Oct 07 22:34:12 2010 +0100
@@ -0,0 +1,459 @@
+// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
+// All rights reserved.
+// This component and the accompanying materials are made available
+// under the terms of "Eclipse Public License v1.0"
+// which accompanies this distribution, and is available
+// at the URL "http://www.eclipse.org/legal/epl-v10.html".
+//
+// Initial Contributors:
+// Nokia Corporation - initial contribution.
+//
+// Contributors:
+//
+// Description:
+//
+
+
+
+// INCLUDE FILES
+#include "mmfdevsoundproxy.h"
+#include "mmfdevsoundcallbackhandler.h"
+#ifdef _DEBUG
+#include <e32debug.h>
+
+#define SYMBIAN_DEBPRN0(str) RDebug::Print(str, this)
+#define SYMBIAN_DEBPRN1(str, val1) RDebug::Print(str, this, val1)
+#define SYMBIAN_DEBPRN2(str, val1, val2) RDebug::Print(str, this, val1, val2)
+#else
+#define SYMBIAN_DEBPRN0(str)
+#define SYMBIAN_DEBPRN1(str, val1)
+#define SYMBIAN_DEBPRN2(str, val1, val2)
+#endif //_DEBUG
+
+// ============================ MEMBER FUNCTIONS ==============================
+
+// ----------------------------------------------------------------------------
+// CMsgQueueHandler::NewL
+// Two-phased constructor.
+// ----------------------------------------------------------------------------
+//
+CMsgQueueHandler* CMsgQueueHandler::NewL(
+ RMMFDevSoundProxy* aDevSoundProxy,
+ MDevSoundObserver& aDevSoundObserver,
+ RMsgQueue<TMMFDevSoundQueueItem>* aMsgQueue,
+ MMMFDevSoundCustomInterfaceObserver& aDevSoundCIObserver)
+ {
+ CMsgQueueHandler* self = new(ELeave) CMsgQueueHandler(aDevSoundProxy,
+ aDevSoundObserver,
+ aMsgQueue,
+ aDevSoundCIObserver);
+ CleanupStack::PushL(self);
+ self->ConstructL();
+ CleanupStack::Pop(self);
+ return self;
+ }
+
+// ----------------------------------------------------------------------------
+// CMsgQueueHandler::CMsgQueueHandler
+// C++ default constructor can NOT contain any code, that might leave.
+// ----------------------------------------------------------------------------
+//
+CMsgQueueHandler::CMsgQueueHandler (RMMFDevSoundProxy* aDevSoundProxy,
+ MDevSoundObserver& aDevSoundObserver,
+ RMsgQueue<TMMFDevSoundQueueItem>* aMsgQueue,
+ MMMFDevSoundCustomInterfaceObserver& aDevSoundCIObserver)
+: CActive(EPriorityStandard),
+ iDevSoundProxy(aDevSoundProxy),
+ iDevSoundObserver(aDevSoundObserver),
+ iMsgQueue(aMsgQueue),
+ iChunkDataPtr(0, 0, 0),
+ iDevSoundCIObserver(aDevSoundCIObserver)
+ {
+ CActiveScheduler::Add(this);
+ }
+
+// ----------------------------------------------------------------------------
+// CMsgQueueHandler::ConstructL
+// Symbian 2nd phase constructor can leave.
+// ----------------------------------------------------------------------------
+//
+void CMsgQueueHandler::ConstructL()
+ {
+ iEmptyBuffer = CMMFDescriptorBuffer::NewL(0);
+ iAsyncQueueFinish = new (ELeave) CAsyncCallBack(CActive::EPriorityStandard);
+ TCallBack asyncCallback(AsyncQueueFinishCallback, this);
+ iAsyncQueueFinish->Set(asyncCallback);
+ }
+
+// ----------------------------------------------------------------------------
+// CMsgQueueHandler::~CMsgQueueHandler
+// Destructor.
+// ----------------------------------------------------------------------------
+//
+CMsgQueueHandler::~CMsgQueueHandler()
+ {
+ Cancel();
+ if ( iMsgQueue )
+ {
+ iMsgQueue->Close();
+ }
+ iChunk.Close();
+
+ delete iDataBuffer;
+ delete iEmptyBuffer;
+ delete iAsyncQueueFinish;
+ }
+
+// ----------------------------------------------------------------------------
+// CMsgQueueHandler::ReceiveEvents
+// Subscribes for Play Error event from the DevSound server.
+// ----------------------------------------------------------------------------
+//
+void CMsgQueueHandler::ReceiveEvents()
+ {
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::ReceiveEvents - Enter"));
+ if (!IsActive())
+ {
+ iMsgQueue->NotifyDataAvailable(iStatus);
+ SetActive();
+ }
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::ReceiveEvents - Exit"));
+ }
+
+// ----------------------------------------------------------------------------
+// CMsgQueueHandler::RunL
+// Handles active object’s request completion event.
+//
+// ----------------------------------------------------------------------------
+//
+void CMsgQueueHandler::RunL()
+ {
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::RunL - Enter"));
+ TInt err = iMsgQueue->Receive(iCurrentItem);
+
+ if (err == KErrNone || err == KErrUnderflow)
+ {
+ // Signal that we're ready to process the next message
+ ReceiveEvents();
+ }
+
+ if (err == KErrNone)
+ {
+ switch (iCurrentItem.iRequest)
+ {
+ case EMMFDevSoundProxyICEvent:
+ {
+ DoInitComplete();
+ break;
+ }
+ case EMMFDevSoundProxyBTBFEvent:
+ {
+ iAsyncQueueFinish->Cancel(); // if still active, means previous cycle did not Finish(). Cancel.
+ TRAP(err, DoBTBFCompleteL());
+ if (err)
+ {
+ iAsyncQueueFinish->CallBack(); // async call to Finish()
+ iDevSoundObserver.PlayError(err);
+ }
+ }
+ break;
+ case EMMFDevSoundProxyBTBEEvent:
+ {
+ iAsyncQueueFinish->Cancel(); // if still active, means previous cycle did not Finish(). Cancel.
+ TRAP(err, DoBTBECompleteL());
+ if (err)
+ {
+ iAsyncQueueFinish->CallBack(); // async call to Finish()
+ iDevSoundObserver.RecordError(err);
+ }
+ }
+ break;
+ case EMMFDevSoundProxyPEEvent:
+ {
+ if (iCurrentItem.iErrorCode == KErrDied ||
+ iCurrentItem.iErrorCode == KErrNotReady)
+ {
+ DoPlayErrorComplete();
+ // "this" pointer is no longer valid here as the associated
+ // instance of the DevSound has been deleted along with this
+ // CMsgQueueHandler object. So, we can only return here.
+ return;
+ }
+ else
+ {
+ DoPlayErrorComplete();
+ break;
+ }
+ }
+ case EMMFDevSoundProxyREEvent:
+ {
+ DoRecordErrorComplete();
+ break;
+ }
+ case EMMFDevSoundProxyTFEvent:
+ {
+ DoToneFinishedComplete();
+ break;
+ }
+ case EMMFDevSoundProxySETCEvent:
+ {
+ DoSendEventToClientComplete();
+ break;
+ }
+ case EMMFDevSoundCustomCommandCloseMuxDemuxPair:
+ {
+ TMMFEvent pckgevent = iCurrentItem.iEventPckg();
+ TInt handle = pckgevent.iEventType.iUid;
+ iDevSoundCIObserver.CloseCustomInterface(handle);
+ break;
+ }
+ case EMMFDevSoundProxyPausedRecordCompleteEvent:
+ {
+ DoPausedRecordComplete();
+ break;
+ }
+ default:
+ {
+ break;
+ }
+ }
+ }
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::RunL - Exit"));
+ }
+
+// ----------------------------------------------------------------------------
+// CMsgQueueHandler::RunError
+// Called by CActive object framework if RunL leaves.
+// ----------------------------------------------------------------------------
+//
+TInt CMsgQueueHandler::RunError(TInt aError)
+ {
+ SYMBIAN_DEBPRN1(_L("CMsgQueueHandler[0x%x]::RunError - Enter. Error [%d]"), aError);
+ TMMFEvent event;
+ event.iErrorCode = aError;
+ iDevSoundObserver.SendEventToClient(event);
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::RunError - Exit"));
+ return KErrNone;
+ }
+
+// ----------------------------------------------------------------------------
+// CMsgQueueHandler::DoCancel
+// Called when client cancels the wait for a completion of an outstanding
+// request.
+// ----------------------------------------------------------------------------
+//
+void CMsgQueueHandler::DoCancel()
+ {
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::DoCancel - Enter"));
+ iMsgQueue->CancelDataAvailable();
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::DoCancel - Exit"));
+ }
+
+// ----------------------------------------------------------------------------
+// CMsgQueueHandler::DoInitComplete
+// Handles initialization completion event.
+// ----------------------------------------------------------------------------
+//
+void CMsgQueueHandler::DoInitComplete()
+ {
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::DoInitComplete - Enter"));
+ iDevSoundObserver.InitializeComplete(iCurrentItem.iErrorCode);
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::DoInitComplete - Exit"));
+ }
+
+// ----------------------------------------------------------------------------
+// CMsgQueueHandler::DoPlayErrorComplete
+// Handles play completion or cancel event.
+// ----------------------------------------------------------------------------
+//
+void CMsgQueueHandler::DoPlayErrorComplete()
+ {
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::DoPlayErrorComplete - Enter"));
+ iAsyncQueueFinish->CallBack(); // async call to Finish()
+ iDevSoundObserver.PlayError(iCurrentItem.iErrorCode);
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::DoPlayErrorComplete - Exit"));
+ }
+
+// ----------------------------------------------------------------------------
+// CMsgQueueHandler::DoBTBFCompleteL
+// Handles CMMFDevSound object's data request event to supply CMMFDevSound
+// with the buffer that it needs to play.
+// ----------------------------------------------------------------------------
+//
+void CMsgQueueHandler::DoBTBFCompleteL()
+ {
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::DoBTBFCompleteL - Enter"));
+ // Returns either chunk handle or NULL
+ // any error is assumed to be due to a pending PlayError(), so the error here is ignored - the PlayError() call will ensure the client remains lively
+ // the chunk has been closed by the server. No action should be taken.
+ TBool requestChunk = iDataBuffer==NULL; // if we have no buffer, tell server we need a chunk handle
+ TInt handle = iDevSoundProxy->BufferToBeFilledData(requestChunk, iSetPckg);
+ if(handle >= KErrNone)
+ {
+ if ( iSetPckg().iChunkOp == EOpen )
+ {
+ AssignDataBufferToChunkL(handle);
+ }
+ else
+ {
+ UpdateDataBufferL();
+ }
+ iDataBuffer->SetStatus(EAvailable);
+
+ // Let the MMF fill the buffer with data
+
+ iDevSoundObserver.BufferToBeFilled(iDataBuffer);
+ }
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::DoBTBFCompleteL - Exit"));
+ }
+
+// ----------------------------------------------------------------------------
+// CMsgQueueHandler::DoBTBECompleteL
+// Handles CMMFDevSound object's data request event to supply CMMFDevSound
+// with the buffer that it needs to record.
+// ----------------------------------------------------------------------------
+//
+void CMsgQueueHandler::DoBTBECompleteL()
+ {
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::DoBTBECompleteL - Enter"));
+ // Returns either chunk handle or NULL
+ // any error is assumed to be due to a pending RecordError(), so the error here is ignored - the RecordError() call will ensure the client remains lively
+ // the chunk has been closed by the server. No action should be taken.
+ TInt handle = iDevSoundProxy->BufferToBeEmptiedData(iSetPckg);
+ if(handle >= KErrNone)
+ {
+ if ( iSetPckg().iChunkOp == EOpen )
+ {
+ AssignDataBufferToChunkL(handle);
+ }
+ iDataBuffer->SetStatus(EFull);
+ iDataBuffer->Data().SetLength(iSetPckg().iRequestSize);
+ iDevSoundObserver.BufferToBeEmptied(iDataBuffer);
+ }
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::DoBTBECompleteL - Exit"));
+ }
+
+// ----------------------------------------------------------------------------
+// CMsgQueueHandler::DoRecordErrorComplete
+// Handles record completion or cancel event.
+// ----------------------------------------------------------------------------
+//
+void CMsgQueueHandler::DoRecordErrorComplete()
+ {
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::DoRecordErrorComplete - Enter"));
+ iAsyncQueueFinish->CallBack(); // async call to Finish()
+ iDevSoundObserver.RecordError(iCurrentItem.iErrorCode);
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::DoRecordErrorComplete - Exit"));
+ }
+
+// ----------------------------------------------------------------------------
+// CMsgQueueHandler::DoToneFinishedComplete
+// Handles tone play completion event.
+// ----------------------------------------------------------------------------
+//
+void CMsgQueueHandler::DoToneFinishedComplete()
+ {
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::DoToneFinishedComplete - Enter"));
+ iDevSoundObserver.ToneFinished(iCurrentItem.iErrorCode);
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::DoToneFinishedComplete - Exit"));
+ }
+
+// ----------------------------------------------------------------------------
+// CMsgQueueHandler::DoSendEventToClientComplete
+// Sends DevSound server event completion notification to the client.
+// ----------------------------------------------------------------------------
+//
+void CMsgQueueHandler::DoSendEventToClientComplete()
+ {
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::DoSendEventToClientComplete - Enter"));
+ iDevSoundObserver.SendEventToClient(iCurrentItem.iEventPckg());
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::DoSendEventToClientComplete - Exit"));
+ }
+
+// ----------------------------------------------------------------------------
+// CMsgQueueHandler::DoPausedRecordComplete
+// Handles CMMFDevSound object's data request event to supply CMMFDevSound
+// with the last buffer that it needs to record.
+// ----------------------------------------------------------------------------
+//
+void CMsgQueueHandler::DoPausedRecordComplete()
+ {
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::DoPausedRecordComplete - Enter"));
+ ASSERT(iEmptyBuffer);
+ iEmptyBuffer->SetLastBuffer(ETrue);
+ iDevSoundObserver.BufferToBeEmptied(iEmptyBuffer);
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::DoPausedRecordComplete - Exit"));
+ }
+
+// ----------------------------------------------------------------------------
+// CMsgQueueHandler::AssignDataBufferToChunkL
+// Updates chunk handle.
+// ----------------------------------------------------------------------------
+//
+void CMsgQueueHandler::AssignDataBufferToChunkL(TInt aHandle)
+ {
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::AssignDataBufferToChunkL - Enter"));
+ if ( iChunk.Handle() )
+ {
+ iChunk.Close();
+ }
+ User::LeaveIfError(iChunk.SetReturnedHandle(aHandle));
+ // Adjust ptr to map only requested size
+ // The existing clients should handle TPtr with length zero and max length
+ // iSetPckg().iBufferSize.
+ // When we make sure every client handles it, replace second parameter with
+ // zero.
+ //iChunkDataPtr.Set(iChunk.Base(), 0, iSetPckg().iBufferSize);
+ iChunkDataPtr.Set(iChunk.Base(), iSetPckg().iBufferSize, iSetPckg().iBufferSize);
+ if (!iDataBuffer)
+ {
+ iDataBuffer = CMMFPtrBuffer::NewL();
+ }
+ UpdateDataBufferL();
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::AssignDataBufferToChunkL - Exit"));
+ }
+
+void CMsgQueueHandler::UpdateDataBufferL()
+ {
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::UpdateDataBufferL - Enter"));
+ ASSERT(iDataBuffer); // to get here, we should have a data buffer
+ iDataBuffer->SetPtr(iChunkDataPtr);
+ iDataBuffer->SetRequestSizeL(iSetPckg().iRequestSize);
+ iDataBuffer->SetLastBuffer(EFalse);
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::UpdateDataBufferL - Exit"));
+ }
+
+void CMsgQueueHandler::Finish()
+ {
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::Finish - Enter"));
+ if (iDataBuffer)
+ {
+ delete iDataBuffer;
+ iDataBuffer = NULL;
+ }
+ if (iChunk.Handle())
+ {
+ iChunk.Close();
+ }
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::Finish - Exit"));
+ }
+
+// AsyncQueueStartCallback
+
+
+TInt CMsgQueueHandler::AsyncQueueFinishCallback(TAny* aPtr)
+ {
+ CMsgQueueHandler* self = static_cast<CMsgQueueHandler*>(aPtr);
+ self->DoAsyncQueueFinishCallback();
+ return KErrNone;
+ }
+
+void CMsgQueueHandler::DoAsyncQueueFinishCallback()
+ {
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::DoAsyncQueueFinishCallback - Enter"));
+ Finish();
+ SYMBIAN_DEBPRN0(_L("CMsgQueueHandler[0x%x]::DoAsyncQueueFinishCallback - Exit"));
+ }
+
+
+// End of File