devsoundextensions/effects/EnvReverb/EnvironmentalReverbMessageHandler/src/EnvironmentalReverbMessageHandler.cpp
changeset 0 b8ed18f6c07b
child 2 5c1df44f2eed
equal deleted inserted replaced
-1:000000000000 0:b8ed18f6c07b
       
     1 /*
       
     2 * Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:   Implementation of the EnvironmentalReverb effect message handler class.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 // INCLUDE FILES
       
    21 #include "EnvironmentalReverbMessageHandler.h"
       
    22 #include "EnvironmentalReverbMessageTypes.h"
       
    23 #include <EnvironmentalReverbBase.h>
       
    24 #include "EffectDataQueItem.h"
       
    25 #ifdef _DEBUG
       
    26 #include <e32svr.h>
       
    27 #endif
       
    28 
       
    29 // ================= MEMBER FUNCTIONS =======================
       
    30 
       
    31 // C++ default constructor can NOT contain any code, that
       
    32 // might leave.
       
    33 //
       
    34 CEnvironmentalReverbMessageHandler::CEnvironmentalReverbMessageHandler(
       
    35 	CEnvironmentalReverb* aEnvironmentalReverb )
       
    36     :	CMMFObject(KUidEnvironmentalReverbEffect),
       
    37     	iEnvironmentalReverb(NULL),
       
    38     	iMessage(NULL),
       
    39     	iRegistered(EFalse),
       
    40     	iEffectDataQue(NULL)
       
    41     {
       
    42     iEnvironmentalReverb = aEnvironmentalReverb;
       
    43     }
       
    44 
       
    45 
       
    46 EXPORT_C CEnvironmentalReverbMessageHandler* CEnvironmentalReverbMessageHandler::NewL(
       
    47 	TAny* aCustomInterface )
       
    48     {
       
    49     CEnvironmentalReverb* environmentalReverb = (CEnvironmentalReverb*)aCustomInterface;
       
    50     CEnvironmentalReverbMessageHandler* self = new (ELeave) CEnvironmentalReverbMessageHandler(environmentalReverb);
       
    51 	self->ConstructL();
       
    52     return self;
       
    53     }
       
    54 
       
    55 
       
    56 // -----------------------------------------------------------------------------
       
    57 // CEnvironmentalReverbMessageHandler::ConstructL
       
    58 // Symbian 2nd phase constructor can leave.
       
    59 // Create and initializes the effect data queue.
       
    60 // -----------------------------------------------------------------------------
       
    61 //
       
    62 void CEnvironmentalReverbMessageHandler::ConstructL()
       
    63 	{
       
    64 	iEffectDataQue = new(ELeave) TSglQue<CEffectDataQueItem>(_FOFF(CEffectDataQueItem, iLink));
       
    65 	}
       
    66 
       
    67 
       
    68 // -----------------------------------------------------------------------------
       
    69 // CEnvironmentalReverbMessageHandler::~CEnvironmentalReverbMessageHandler
       
    70 // Before going away, unregister with the CI EnvironmentalReverb object.
       
    71 // The observation message must be completed if outstanding.
       
    72 // The effect data queue must be emptied and destroyed.
       
    73 // -----------------------------------------------------------------------------
       
    74 //
       
    75 CEnvironmentalReverbMessageHandler::~CEnvironmentalReverbMessageHandler()
       
    76 	{
       
    77 
       
    78 #ifdef _DEBUG
       
    79     RDebug::Print(_L("CEnvironmentalReverbMessageHandler::~CEnvironmentalReverbMessageHandler"));
       
    80 #endif
       
    81     if(iEnvironmentalReverb)
       
    82 	    iEnvironmentalReverb->UnRegisterObserver(*this);
       
    83 	iRegistered = EFalse;
       
    84 
       
    85 	if(iMessage)
       
    86 	{
       
    87 		if ( !iMessage->IsCompleted() )
       
    88 			{
       
    89 			iMessage->Complete(KErrCancel);
       
    90 			delete iMessage;
       
    91 			}
       
    92 	}
       
    93 
       
    94     if ( iEffectDataQue )
       
    95         {
       
    96         CEffectDataQueItem* queItem;
       
    97         while ( !iEffectDataQue->IsEmpty() )
       
    98             {
       
    99             queItem = iEffectDataQue->First();
       
   100             iEffectDataQue->Remove(*queItem);
       
   101             delete queItem;
       
   102             }
       
   103 
       
   104         delete iEffectDataQue;
       
   105         }
       
   106 
       
   107     delete iEnvironmentalReverb;
       
   108 
       
   109 	}
       
   110 
       
   111 
       
   112 // ---------------------------------------------------------
       
   113 // CEnvironmentalReverbMessageHandler::HandleRequest
       
   114 // (other items were commented in a header).
       
   115 // ---------------------------------------------------------
       
   116 //
       
   117 void CEnvironmentalReverbMessageHandler::HandleRequest(
       
   118 	TMMFMessage& aMessage )
       
   119 	{
       
   120 	ASSERT(aMessage.Destination().InterfaceId() == KUidEnvironmentalReverbEffect);
       
   121 	TRAPD(error,DoHandleRequestL(aMessage));
       
   122 	if ( error )
       
   123 		{
       
   124 		aMessage.Complete(error);
       
   125 		}
       
   126 	}
       
   127 
       
   128 // ---------------------------------------------------------
       
   129 // CEnvironmentalReverbMessageHandler::DoHandleRequestL
       
   130 // Dispatches the message to the appropriate handler.
       
   131 // ---------------------------------------------------------
       
   132 //
       
   133 void CEnvironmentalReverbMessageHandler::DoHandleRequestL(
       
   134 	TMMFMessage& aMessage )
       
   135 	{
       
   136 	switch( aMessage.Function() )
       
   137 		{
       
   138 		case EErfInitialize:
       
   139 			{
       
   140 			DoInitializeL(aMessage);
       
   141 			break;
       
   142 			}
       
   143 		case EErfApply:
       
   144 			{
       
   145 			DoApplyL(aMessage);
       
   146 			break;
       
   147 			}
       
   148 		case EErfObserve:
       
   149 			{
       
   150 			DoObserveL(aMessage);
       
   151 			break;
       
   152 			}
       
   153 			
       
   154 			
       
   155 			
       
   156 		default:
       
   157 			{
       
   158 			aMessage.Complete(KErrNotSupported);
       
   159 			}
       
   160 		}
       
   161 	}
       
   162 
       
   163 // ---------------------------------------------------------
       
   164 // CEnvironmentalReverbMessageHandler::DoInitializeL
       
   165 // ---------------------------------------------------------
       
   166 //
       
   167 void CEnvironmentalReverbMessageHandler::DoInitializeL(TMMFMessage& aMessage)
       
   168 	{
       
   169 #ifdef _DEBUG
       
   170     RDebug::Print(_L("CEnvironmentalReverbMessageHandler::DoInitializeL"));
       
   171 #endif
       
   172 	aMessage.WriteDataToClient(iEnvironmentalReverb->DoEffectData());
       
   173 	aMessage.Complete(KErrNone);
       
   174 	}
       
   175 
       
   176 
       
   177 
       
   178 // ---------------------------------------------------------
       
   179 // CEnvironmentalReverbMessageHandler::DoApplyL
       
   180 // Extracts the data from the message. The client EnvironmentalReverb
       
   181 // data is applied to the CI EnvironmentalReverb object.
       
   182 // ---------------------------------------------------------
       
   183 //
       
   184 void CEnvironmentalReverbMessageHandler::DoApplyL(
       
   185 	TMMFMessage& aMessage )
       
   186 	{
       
   187 #ifdef _DEBUG
       
   188     RDebug::Print(_L("CEnvironmentalReverbMessageHandler::DoApplyL"));
       
   189 #endif
       
   190     TEfEnvReverbDataPckg environmentalReverbPckgFromClient;
       
   191     aMessage.ReadData1FromClient(environmentalReverbPckgFromClient);
       
   192 	iEnvironmentalReverb->SetEffectData(environmentalReverbPckgFromClient);
       
   193 	iEnvironmentalReverb->ApplyL();
       
   194 	aMessage.Complete(KErrNone);
       
   195 	}
       
   196 
       
   197 // ---------------------------------------------------------
       
   198 // CEnvironmentalReverbMessageHandler::DoObserveL
       
   199 // Receives the observation request message and depending
       
   200 // on the status of the effect data queue, the message is
       
   201 // completed immediately or saved for later completion.
       
   202 // ---------------------------------------------------------
       
   203 //
       
   204 void CEnvironmentalReverbMessageHandler::DoObserveL(
       
   205 	TMMFMessage& aMessage )
       
   206 	{
       
   207 
       
   208 #ifdef _DEBUG
       
   209     RDebug::Print(_L("CEnvironmentalReverbMessageHandler::DoObserveL"));
       
   210 #endif
       
   211 
       
   212 	if ( !iRegistered )
       
   213 		{
       
   214 		iEnvironmentalReverb->RegisterObserverL(*this);
       
   215 		iRegistered = ETrue;
       
   216 		}
       
   217 
       
   218 	if ( iEffectDataQue->IsEmpty() )
       
   219 		{
       
   220 		//iMessage = &aMessage;
       
   221 		iMessage = new(ELeave) TMMFMessage(aMessage);
       
   222 		}
       
   223 	else
       
   224 		{
       
   225 		TEfEnvReverbDataPckg dataPckg;
       
   226 		CEffectDataQueItem* item = iEffectDataQue->First();
       
   227 		dataPckg.Copy(item->EffectData());
       
   228 		aMessage.WriteDataToClient(dataPckg);
       
   229 		aMessage.Complete(KErrNone);
       
   230 		iEffectDataQue->Remove(*item);
       
   231 		delete item;
       
   232 		}
       
   233 	}
       
   234 
       
   235 // ---------------------------------------------------------
       
   236 // CEnvironmentalReverbMessageHandler::EffectChanged
       
   237 // The CI EnvironmentalReverb object has changed state.
       
   238 // The observation message is completed if no data has been
       
   239 // queued up. Otherwise, the CI EnvironmentalReverb object's data is
       
   240 // packaged and queued.
       
   241 // ---------------------------------------------------------
       
   242 //
       
   243 void CEnvironmentalReverbMessageHandler::EffectChanged(
       
   244 	const CAudioEffect* aAudioEffect,
       
   245 	TUint8 /*aEvent*/ )
       
   246 	{
       
   247 #ifdef _DEBUG
       
   248     RDebug::Print(_L("CEnvironmentalReverbMessageHandler::EffectChanged"));
       
   249 #endif
       
   250 
       
   251 	if ( iMessage && !iMessage->IsCompleted() && iEffectDataQue->IsEmpty() )
       
   252 		{
       
   253 		iMessage->WriteDataToClient(((CEnvironmentalReverb*)aAudioEffect)->DoEffectData());
       
   254 		iMessage->Complete(KErrNone);
       
   255 		delete iMessage;
       
   256 		iMessage = NULL;
       
   257 		}
       
   258 	else
       
   259 		{
       
   260 		// Saves the data and complete an observation message next time around.
       
   261 		HBufC8* data = NULL;
       
   262 		TRAPD(err1,data = ((CEnvironmentalReverb*)aAudioEffect)->DoEffectData().AllocL());
       
   263 		if(!err1)
       
   264 			{
       
   265 				//CleanupStack::PushL(data);
       
   266 				CEffectDataQueItem* item = NULL;
       
   267 				TRAPD(err2,item = CEffectDataQueItem::NewL(data));
       
   268 				if(!err2)
       
   269 				{
       
   270 					iEffectDataQue->AddLast(*item);
       
   271 				}
       
   272 				else
       
   273 				{
       
   274 					delete data;
       
   275 				}
       
   276 			}
       
   277 		else
       
   278 			{
       
   279 #ifdef _DEBUG
       
   280 				RDebug::Print(_L("CEnvironmentalReverbMessageHandler::EffectChanged Error Allocating Memory %d"),err1);
       
   281 #endif
       
   282 			}
       
   283 		}
       
   284 
       
   285 	}
       
   286 
       
   287 
       
   288 
       
   289 // ========================== OTHER EXPORTED FUNCTIONS =========================
       
   290 
       
   291 
       
   292 // End of File