os/mm/devsoundextensions/effects/EnvReverb/EnvironmentalReverbMessageHandler/src/EnvironmentalReverbMessageHandler.cpp
changeset 0 bde4ae8d615e
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/mm/devsoundextensions/effects/EnvReverb/EnvironmentalReverbMessageHandler/src/EnvironmentalReverbMessageHandler.cpp	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,292 @@
     1.4 +/*
     1.5 +* Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies). 
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of "Eclipse Public License v1.0"
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:   Implementation of the EnvironmentalReverb effect message handler class.
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +
    1.23 +// INCLUDE FILES
    1.24 +#include "EnvironmentalReverbMessageHandler.h"
    1.25 +#include "EnvironmentalReverbMessageTypes.h"
    1.26 +#include <EnvironmentalReverbBase.h>
    1.27 +#include "EffectDataQueItem.h"
    1.28 +#ifdef _DEBUG
    1.29 +#include <e32svr.h>
    1.30 +#endif
    1.31 +
    1.32 +// ================= MEMBER FUNCTIONS =======================
    1.33 +
    1.34 +// C++ default constructor can NOT contain any code, that
    1.35 +// might leave.
    1.36 +//
    1.37 +CEnvironmentalReverbMessageHandler::CEnvironmentalReverbMessageHandler(
    1.38 +	CEnvironmentalReverb* aEnvironmentalReverb )
    1.39 +    :	CMMFObject(KUidEnvironmentalReverbEffect),
    1.40 +    	iEnvironmentalReverb(NULL),
    1.41 +    	iMessage(NULL),
    1.42 +    	iRegistered(EFalse),
    1.43 +    	iEffectDataQue(NULL)
    1.44 +    {
    1.45 +    iEnvironmentalReverb = aEnvironmentalReverb;
    1.46 +    }
    1.47 +
    1.48 +
    1.49 +EXPORT_C CEnvironmentalReverbMessageHandler* CEnvironmentalReverbMessageHandler::NewL(
    1.50 +	TAny* aCustomInterface )
    1.51 +    {
    1.52 +    CEnvironmentalReverb* environmentalReverb = (CEnvironmentalReverb*)aCustomInterface;
    1.53 +    CEnvironmentalReverbMessageHandler* self = new (ELeave) CEnvironmentalReverbMessageHandler(environmentalReverb);
    1.54 +	self->ConstructL();
    1.55 +    return self;
    1.56 +    }
    1.57 +
    1.58 +
    1.59 +// -----------------------------------------------------------------------------
    1.60 +// CEnvironmentalReverbMessageHandler::ConstructL
    1.61 +// Symbian 2nd phase constructor can leave.
    1.62 +// Create and initializes the effect data queue.
    1.63 +// -----------------------------------------------------------------------------
    1.64 +//
    1.65 +void CEnvironmentalReverbMessageHandler::ConstructL()
    1.66 +	{
    1.67 +	iEffectDataQue = new(ELeave) TSglQue<CEffectDataQueItem>(_FOFF(CEffectDataQueItem, iLink));
    1.68 +	}
    1.69 +
    1.70 +
    1.71 +// -----------------------------------------------------------------------------
    1.72 +// CEnvironmentalReverbMessageHandler::~CEnvironmentalReverbMessageHandler
    1.73 +// Before going away, unregister with the CI EnvironmentalReverb object.
    1.74 +// The observation message must be completed if outstanding.
    1.75 +// The effect data queue must be emptied and destroyed.
    1.76 +// -----------------------------------------------------------------------------
    1.77 +//
    1.78 +CEnvironmentalReverbMessageHandler::~CEnvironmentalReverbMessageHandler()
    1.79 +	{
    1.80 +
    1.81 +#ifdef _DEBUG
    1.82 +    RDebug::Print(_L("CEnvironmentalReverbMessageHandler::~CEnvironmentalReverbMessageHandler"));
    1.83 +#endif
    1.84 +    if(iEnvironmentalReverb)
    1.85 +	    iEnvironmentalReverb->UnRegisterObserver(*this);
    1.86 +	iRegistered = EFalse;
    1.87 +
    1.88 +	if(iMessage)
    1.89 +	{
    1.90 +		if ( !iMessage->IsCompleted() )
    1.91 +			{
    1.92 +			iMessage->Complete(KErrCancel);
    1.93 +			delete iMessage;
    1.94 +			}
    1.95 +	}
    1.96 +
    1.97 +    if ( iEffectDataQue )
    1.98 +        {
    1.99 +        CEffectDataQueItem* queItem;
   1.100 +        while ( !iEffectDataQue->IsEmpty() )
   1.101 +            {
   1.102 +            queItem = iEffectDataQue->First();
   1.103 +            iEffectDataQue->Remove(*queItem);
   1.104 +            delete queItem;
   1.105 +            }
   1.106 +
   1.107 +        delete iEffectDataQue;
   1.108 +        }
   1.109 +
   1.110 +    delete iEnvironmentalReverb;
   1.111 +
   1.112 +	}
   1.113 +
   1.114 +
   1.115 +// ---------------------------------------------------------
   1.116 +// CEnvironmentalReverbMessageHandler::HandleRequest
   1.117 +// (other items were commented in a header).
   1.118 +// ---------------------------------------------------------
   1.119 +//
   1.120 +void CEnvironmentalReverbMessageHandler::HandleRequest(
   1.121 +	TMMFMessage& aMessage )
   1.122 +	{
   1.123 +	ASSERT(aMessage.Destination().InterfaceId() == KUidEnvironmentalReverbEffect);
   1.124 +	TRAPD(error,DoHandleRequestL(aMessage));
   1.125 +	if ( error )
   1.126 +		{
   1.127 +		aMessage.Complete(error);
   1.128 +		}
   1.129 +	}
   1.130 +
   1.131 +// ---------------------------------------------------------
   1.132 +// CEnvironmentalReverbMessageHandler::DoHandleRequestL
   1.133 +// Dispatches the message to the appropriate handler.
   1.134 +// ---------------------------------------------------------
   1.135 +//
   1.136 +void CEnvironmentalReverbMessageHandler::DoHandleRequestL(
   1.137 +	TMMFMessage& aMessage )
   1.138 +	{
   1.139 +	switch( aMessage.Function() )
   1.140 +		{
   1.141 +		case EErfInitialize:
   1.142 +			{
   1.143 +			DoInitializeL(aMessage);
   1.144 +			break;
   1.145 +			}
   1.146 +		case EErfApply:
   1.147 +			{
   1.148 +			DoApplyL(aMessage);
   1.149 +			break;
   1.150 +			}
   1.151 +		case EErfObserve:
   1.152 +			{
   1.153 +			DoObserveL(aMessage);
   1.154 +			break;
   1.155 +			}
   1.156 +			
   1.157 +			
   1.158 +			
   1.159 +		default:
   1.160 +			{
   1.161 +			aMessage.Complete(KErrNotSupported);
   1.162 +			}
   1.163 +		}
   1.164 +	}
   1.165 +
   1.166 +// ---------------------------------------------------------
   1.167 +// CEnvironmentalReverbMessageHandler::DoInitializeL
   1.168 +// ---------------------------------------------------------
   1.169 +//
   1.170 +void CEnvironmentalReverbMessageHandler::DoInitializeL(TMMFMessage& aMessage)
   1.171 +	{
   1.172 +#ifdef _DEBUG
   1.173 +    RDebug::Print(_L("CEnvironmentalReverbMessageHandler::DoInitializeL"));
   1.174 +#endif
   1.175 +	aMessage.WriteDataToClient(iEnvironmentalReverb->DoEffectData());
   1.176 +	aMessage.Complete(KErrNone);
   1.177 +	}
   1.178 +
   1.179 +
   1.180 +
   1.181 +// ---------------------------------------------------------
   1.182 +// CEnvironmentalReverbMessageHandler::DoApplyL
   1.183 +// Extracts the data from the message. The client EnvironmentalReverb
   1.184 +// data is applied to the CI EnvironmentalReverb object.
   1.185 +// ---------------------------------------------------------
   1.186 +//
   1.187 +void CEnvironmentalReverbMessageHandler::DoApplyL(
   1.188 +	TMMFMessage& aMessage )
   1.189 +	{
   1.190 +#ifdef _DEBUG
   1.191 +    RDebug::Print(_L("CEnvironmentalReverbMessageHandler::DoApplyL"));
   1.192 +#endif
   1.193 +    TEfEnvReverbDataPckg environmentalReverbPckgFromClient;
   1.194 +    aMessage.ReadData1FromClient(environmentalReverbPckgFromClient);
   1.195 +	iEnvironmentalReverb->SetEffectData(environmentalReverbPckgFromClient);
   1.196 +	iEnvironmentalReverb->ApplyL();
   1.197 +	aMessage.Complete(KErrNone);
   1.198 +	}
   1.199 +
   1.200 +// ---------------------------------------------------------
   1.201 +// CEnvironmentalReverbMessageHandler::DoObserveL
   1.202 +// Receives the observation request message and depending
   1.203 +// on the status of the effect data queue, the message is
   1.204 +// completed immediately or saved for later completion.
   1.205 +// ---------------------------------------------------------
   1.206 +//
   1.207 +void CEnvironmentalReverbMessageHandler::DoObserveL(
   1.208 +	TMMFMessage& aMessage )
   1.209 +	{
   1.210 +
   1.211 +#ifdef _DEBUG
   1.212 +    RDebug::Print(_L("CEnvironmentalReverbMessageHandler::DoObserveL"));
   1.213 +#endif
   1.214 +
   1.215 +	if ( !iRegistered )
   1.216 +		{
   1.217 +		iEnvironmentalReverb->RegisterObserverL(*this);
   1.218 +		iRegistered = ETrue;
   1.219 +		}
   1.220 +
   1.221 +	if ( iEffectDataQue->IsEmpty() )
   1.222 +		{
   1.223 +		//iMessage = &aMessage;
   1.224 +		iMessage = new(ELeave) TMMFMessage(aMessage);
   1.225 +		}
   1.226 +	else
   1.227 +		{
   1.228 +		TEfEnvReverbDataPckg dataPckg;
   1.229 +		CEffectDataQueItem* item = iEffectDataQue->First();
   1.230 +		dataPckg.Copy(item->EffectData());
   1.231 +		aMessage.WriteDataToClient(dataPckg);
   1.232 +		aMessage.Complete(KErrNone);
   1.233 +		iEffectDataQue->Remove(*item);
   1.234 +		delete item;
   1.235 +		}
   1.236 +	}
   1.237 +
   1.238 +// ---------------------------------------------------------
   1.239 +// CEnvironmentalReverbMessageHandler::EffectChanged
   1.240 +// The CI EnvironmentalReverb object has changed state.
   1.241 +// The observation message is completed if no data has been
   1.242 +// queued up. Otherwise, the CI EnvironmentalReverb object's data is
   1.243 +// packaged and queued.
   1.244 +// ---------------------------------------------------------
   1.245 +//
   1.246 +void CEnvironmentalReverbMessageHandler::EffectChanged(
   1.247 +	const CAudioEffect* aAudioEffect,
   1.248 +	TUint8 /*aEvent*/ )
   1.249 +	{
   1.250 +#ifdef _DEBUG
   1.251 +    RDebug::Print(_L("CEnvironmentalReverbMessageHandler::EffectChanged"));
   1.252 +#endif
   1.253 +
   1.254 +	if ( iMessage && !iMessage->IsCompleted() && iEffectDataQue->IsEmpty() )
   1.255 +		{
   1.256 +		iMessage->WriteDataToClient(((CEnvironmentalReverb*)aAudioEffect)->DoEffectData());
   1.257 +		iMessage->Complete(KErrNone);
   1.258 +		delete iMessage;
   1.259 +		iMessage = NULL;
   1.260 +		}
   1.261 +	else
   1.262 +		{
   1.263 +		// Saves the data and complete an observation message next time around.
   1.264 +		HBufC8* data = NULL;
   1.265 +		TRAPD(err1,data = ((CEnvironmentalReverb*)aAudioEffect)->DoEffectData().AllocL());
   1.266 +		if(!err1)
   1.267 +			{
   1.268 +				//CleanupStack::PushL(data);
   1.269 +				CEffectDataQueItem* item = NULL;
   1.270 +				TRAPD(err2,item = CEffectDataQueItem::NewL(data));
   1.271 +				if(!err2)
   1.272 +				{
   1.273 +					iEffectDataQue->AddLast(*item);
   1.274 +				}
   1.275 +				else
   1.276 +				{
   1.277 +					delete data;
   1.278 +				}
   1.279 +			}
   1.280 +		else
   1.281 +			{
   1.282 +#ifdef _DEBUG
   1.283 +				RDebug::Print(_L("CEnvironmentalReverbMessageHandler::EffectChanged Error Allocating Memory %d"),err1);
   1.284 +#endif
   1.285 +			}
   1.286 +		}
   1.287 +
   1.288 +	}
   1.289 +
   1.290 +
   1.291 +
   1.292 +// ========================== OTHER EXPORTED FUNCTIONS =========================
   1.293 +
   1.294 +
   1.295 +// End of File