devsoundextensions/effects/BassBoost/BassBoostMessageHandler/src/BassBoostMessageHandler.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 bassboost effect message handler class.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 // INCLUDE FILES
       
    21 #include "BassBoostMessageHandler.h"
       
    22 #include "BassBoostMessageTypes.h"
       
    23 #include "EffectDataQueItem.h"
       
    24 #include <BassBoostBase.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 CBassBoostMessageHandler::CBassBoostMessageHandler(
       
    35 	CBassBoost* aBassBoost )
       
    36     :	CMMFObject(KUidBassBoostEffect),
       
    37     	iBassBoost(NULL),
       
    38     	iMessage(NULL),
       
    39     	iRegistered(EFalse),
       
    40     	iEffectDataQue(NULL)
       
    41     {
       
    42     iBassBoost = aBassBoost;
       
    43     }
       
    44 
       
    45 
       
    46 EXPORT_C CBassBoostMessageHandler* CBassBoostMessageHandler::NewL(
       
    47 	TAny* aCustomInterface )
       
    48     {
       
    49     CBassBoost* bassboost = (CBassBoost*)aCustomInterface;
       
    50     CBassBoostMessageHandler* self = new (ELeave) CBassBoostMessageHandler(bassboost);
       
    51 	self->ConstructL();
       
    52     return self;
       
    53     }
       
    54 
       
    55 
       
    56 // -----------------------------------------------------------------------------
       
    57 // CBassBoostMessageHandler::ConstructL
       
    58 // Symbian 2nd phase constructor can leave.
       
    59 // Create and initializes the effect data queue.
       
    60 // -----------------------------------------------------------------------------
       
    61 //
       
    62 void CBassBoostMessageHandler::ConstructL()
       
    63 	{
       
    64 	iEffectDataQue = new(ELeave) TSglQue<CEffectDataQueItem>(_FOFF(CEffectDataQueItem, iLink));
       
    65 	}
       
    66 
       
    67 
       
    68 // -----------------------------------------------------------------------------
       
    69 // CBassBoostMessageHandler::~CBassBoostMessageHandler
       
    70 // Before going away, unregister with the CI BassBoost object.
       
    71 // The observation message must be completed if outstanding.
       
    72 // The effect data queue must be emptied and destroyed.
       
    73 // -----------------------------------------------------------------------------
       
    74 //
       
    75 CBassBoostMessageHandler::~CBassBoostMessageHandler()
       
    76 	{
       
    77 
       
    78 #ifdef _DEBUG
       
    79     RDebug::Print(_L("CBassBoostMessageHandler::~CBassBoostMessageHandler"));
       
    80 #endif
       
    81 
       
    82     if(iBassBoost)
       
    83     	iBassBoost->UnRegisterObserver(*this);
       
    84 	iRegistered = EFalse;
       
    85 
       
    86 	if(iMessage)
       
    87 	{
       
    88 		if ( !iMessage->IsCompleted() )
       
    89 			{
       
    90 			iMessage->Complete(KErrCancel);
       
    91 			delete iMessage;
       
    92 			}
       
    93 	}
       
    94 
       
    95     if ( iEffectDataQue )
       
    96         {
       
    97         CEffectDataQueItem* queItem;
       
    98         while ( !iEffectDataQue->IsEmpty() )
       
    99             {
       
   100             queItem = iEffectDataQue->First();
       
   101             iEffectDataQue->Remove(*queItem);
       
   102             delete queItem;
       
   103             }
       
   104 
       
   105         delete iEffectDataQue;
       
   106         }
       
   107 
       
   108      delete iBassBoost;
       
   109 
       
   110 	}
       
   111 
       
   112 
       
   113 // ---------------------------------------------------------
       
   114 // CBassBoostMessageHandler::HandleRequest
       
   115 // (other items were commented in a header).
       
   116 // ---------------------------------------------------------
       
   117 //
       
   118 void CBassBoostMessageHandler::HandleRequest(
       
   119 	TMMFMessage& aMessage )
       
   120 	{
       
   121 	ASSERT(aMessage.Destination().InterfaceId() == KUidBassBoostEffect);
       
   122 	TRAPD(error,DoHandleRequestL(aMessage));
       
   123 	if ( error )
       
   124 		{
       
   125 		aMessage.Complete(error);
       
   126 		}
       
   127 	}
       
   128 
       
   129 // ---------------------------------------------------------
       
   130 // CBassBoostMessageHandler::DoHandleRequestL
       
   131 // Dispatches the message to the appropriate handler.
       
   132 // ---------------------------------------------------------
       
   133 //
       
   134 void CBassBoostMessageHandler::DoHandleRequestL(
       
   135 	TMMFMessage& aMessage )
       
   136 	{
       
   137 	switch( aMessage.Function() )
       
   138 		{
       
   139 		case EBfInitialize: // Request to initialize the bassboost
       
   140 			{
       
   141 			DoInitializeL(aMessage);
       
   142 			break;
       
   143 			}
       
   144 		case EBfApply: // Request to apply the bassboost settings
       
   145 			{
       
   146 			DoApplyL(aMessage);
       
   147 			break;
       
   148 			}
       
   149 		case EBfObserve: // Observation request
       
   150 			{
       
   151 			DoObserveL(aMessage);
       
   152 			break;
       
   153 			}
       
   154 		default:
       
   155 			{
       
   156 			aMessage.Complete(KErrNotSupported);
       
   157 			}
       
   158 		}
       
   159 	}
       
   160 
       
   161 // ---------------------------------------------------------
       
   162 // CBassBoostMessageHandler::DoInitializeL
       
   163 // ---------------------------------------------------------
       
   164 //
       
   165 void CBassBoostMessageHandler::DoInitializeL(TMMFMessage& aMessage)
       
   166 	{
       
   167 	aMessage.WriteDataToClient(iBassBoost->DoEffectData());
       
   168 	aMessage.Complete(KErrNone);
       
   169 	}
       
   170 
       
   171 // ---------------------------------------------------------
       
   172 // CBassBoostMessageHandler::DoApplyL
       
   173 // Extracts the data from the message. The client bassboost data
       
   174 // is applied to the CI bassboost object.
       
   175 // ---------------------------------------------------------
       
   176 //
       
   177 void CBassBoostMessageHandler::DoApplyL(
       
   178 	TMMFMessage& aMessage )
       
   179 	{
       
   180     TEfBassBoostDataPckg bassboostPckgFromClient;
       
   181     aMessage.ReadData1FromClient(bassboostPckgFromClient);
       
   182 
       
   183 	iBassBoost->SetEffectData(bassboostPckgFromClient);
       
   184 	iBassBoost->ApplyL();
       
   185 	aMessage.Complete(KErrNone);
       
   186 	}
       
   187 
       
   188 // ---------------------------------------------------------
       
   189 // CBassBoostMessageHandler::DoObserveL
       
   190 // Receives the observation request message and depending
       
   191 // on the status of the effect data queue, the message is
       
   192 // completed immediately or saved for later completion.
       
   193 // ---------------------------------------------------------
       
   194 //
       
   195 void CBassBoostMessageHandler::DoObserveL(
       
   196 	TMMFMessage& aMessage )
       
   197 	{
       
   198 
       
   199 #ifdef _DEBUG
       
   200     RDebug::Print(_L("CBassBoostMessageHandler::DoObserveL"));
       
   201 #endif
       
   202 
       
   203 	if ( !iRegistered ) // Don't register again if we're registered.
       
   204 		{
       
   205 		iBassBoost->RegisterObserverL(*this);
       
   206 		iRegistered = ETrue;
       
   207 		}
       
   208 
       
   209 	if ( iEffectDataQue->IsEmpty() )
       
   210 		{
       
   211 		// Message is saved and completed when an event occurs
       
   212 		iMessage = new(ELeave) TMMFMessage(aMessage);
       
   213 		}
       
   214 	else
       
   215 		{
       
   216 		TEfBassBoostDataPckg dataPckg;
       
   217 		CEffectDataQueItem* item = iEffectDataQue->First();
       
   218 		dataPckg.Copy(item->EffectData());
       
   219 		aMessage.WriteDataToClient(dataPckg);
       
   220 		aMessage.Complete(KErrNone);
       
   221 		iEffectDataQue->Remove(*item);
       
   222 		delete item;
       
   223 		}
       
   224 	}
       
   225 
       
   226 // ---------------------------------------------------------
       
   227 // CBassBoostMessageHandler::EffectChanged
       
   228 // The CI bassboost object has changed state.
       
   229 // The observation message is completed if no data has been
       
   230 // queued up. Otherwise, the CI bassboost object's data is
       
   231 // packaged and queued.
       
   232 // ---------------------------------------------------------
       
   233 //
       
   234 void CBassBoostMessageHandler::EffectChanged(
       
   235 	const CAudioEffect* aAudioEffect,
       
   236 	 TUint8 /*aEvent*/ )
       
   237 	{
       
   238 #ifdef _DEBUG
       
   239     RDebug::Print(_L("CBassBoostMessageHandler::EffectChanged"));
       
   240 #endif
       
   241 
       
   242 	if ( iMessage && !iMessage->IsCompleted() && iEffectDataQue->IsEmpty() )
       
   243 		{
       
   244 		iMessage->WriteDataToClient(((CBassBoost*)aAudioEffect)->DoEffectData());
       
   245 		iMessage->Complete(KErrNone);
       
   246 		delete iMessage;
       
   247 		iMessage = NULL;
       
   248 		}
       
   249 	else // no message pending and there is no event queued up
       
   250 		{
       
   251 		// Saves the data and complete an observation message next time when
       
   252 		// there is a pending message.
       
   253 		// Saves the data and complete an observation message next time around.
       
   254 		HBufC8* data = NULL;
       
   255 		TRAPD(err1,data = ((CBassBoost*)aAudioEffect)->DoEffectData().AllocL());
       
   256 		if(!err1)
       
   257 			{
       
   258 				//CleanupStack::PushL(data);
       
   259 				CEffectDataQueItem* item = NULL;
       
   260 				TRAPD(err2,item = CEffectDataQueItem::NewL(data));
       
   261 				if(!err2)
       
   262 				{
       
   263 					iEffectDataQue->AddLast(*item);
       
   264 				}
       
   265 				else
       
   266 				{
       
   267 					delete data;
       
   268 				}
       
   269 			}
       
   270 		else
       
   271 			{
       
   272 #ifdef _DEBUG
       
   273 				RDebug::Print(_L("CBassBoostMessageHandler::EffectChanged Error Allocating Memory %d"),err1);
       
   274 #endif
       
   275 			}
       
   276 		}
       
   277 	}
       
   278 
       
   279 
       
   280 // ========================== OTHER EXPORTED FUNCTIONS =========================
       
   281 
       
   282 
       
   283 
       
   284 
       
   285 // End of File