os/mm/devsoundextensions/effects/BassBoost/BassBoostMessageHandler/src/BassBoostMessageHandler.cpp
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/mm/devsoundextensions/effects/BassBoost/BassBoostMessageHandler/src/BassBoostMessageHandler.cpp Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,285 @@
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 bassboost effect message handler class.
1.18 +*
1.19 +*/
1.20 +
1.21 +
1.22 +
1.23 +// INCLUDE FILES
1.24 +#include "BassBoostMessageHandler.h"
1.25 +#include "BassBoostMessageTypes.h"
1.26 +#include "EffectDataQueItem.h"
1.27 +#include <BassBoostBase.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 +CBassBoostMessageHandler::CBassBoostMessageHandler(
1.38 + CBassBoost* aBassBoost )
1.39 + : CMMFObject(KUidBassBoostEffect),
1.40 + iBassBoost(NULL),
1.41 + iMessage(NULL),
1.42 + iRegistered(EFalse),
1.43 + iEffectDataQue(NULL)
1.44 + {
1.45 + iBassBoost = aBassBoost;
1.46 + }
1.47 +
1.48 +
1.49 +EXPORT_C CBassBoostMessageHandler* CBassBoostMessageHandler::NewL(
1.50 + TAny* aCustomInterface )
1.51 + {
1.52 + CBassBoost* bassboost = (CBassBoost*)aCustomInterface;
1.53 + CBassBoostMessageHandler* self = new (ELeave) CBassBoostMessageHandler(bassboost);
1.54 + self->ConstructL();
1.55 + return self;
1.56 + }
1.57 +
1.58 +
1.59 +// -----------------------------------------------------------------------------
1.60 +// CBassBoostMessageHandler::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 CBassBoostMessageHandler::ConstructL()
1.66 + {
1.67 + iEffectDataQue = new(ELeave) TSglQue<CEffectDataQueItem>(_FOFF(CEffectDataQueItem, iLink));
1.68 + }
1.69 +
1.70 +
1.71 +// -----------------------------------------------------------------------------
1.72 +// CBassBoostMessageHandler::~CBassBoostMessageHandler
1.73 +// Before going away, unregister with the CI BassBoost 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 +CBassBoostMessageHandler::~CBassBoostMessageHandler()
1.79 + {
1.80 +
1.81 +#ifdef _DEBUG
1.82 + RDebug::Print(_L("CBassBoostMessageHandler::~CBassBoostMessageHandler"));
1.83 +#endif
1.84 +
1.85 + if(iBassBoost)
1.86 + iBassBoost->UnRegisterObserver(*this);
1.87 + iRegistered = EFalse;
1.88 +
1.89 + if(iMessage)
1.90 + {
1.91 + if ( !iMessage->IsCompleted() )
1.92 + {
1.93 + iMessage->Complete(KErrCancel);
1.94 + delete iMessage;
1.95 + }
1.96 + }
1.97 +
1.98 + if ( iEffectDataQue )
1.99 + {
1.100 + CEffectDataQueItem* queItem;
1.101 + while ( !iEffectDataQue->IsEmpty() )
1.102 + {
1.103 + queItem = iEffectDataQue->First();
1.104 + iEffectDataQue->Remove(*queItem);
1.105 + delete queItem;
1.106 + }
1.107 +
1.108 + delete iEffectDataQue;
1.109 + }
1.110 +
1.111 + delete iBassBoost;
1.112 +
1.113 + }
1.114 +
1.115 +
1.116 +// ---------------------------------------------------------
1.117 +// CBassBoostMessageHandler::HandleRequest
1.118 +// (other items were commented in a header).
1.119 +// ---------------------------------------------------------
1.120 +//
1.121 +void CBassBoostMessageHandler::HandleRequest(
1.122 + TMMFMessage& aMessage )
1.123 + {
1.124 + ASSERT(aMessage.Destination().InterfaceId() == KUidBassBoostEffect);
1.125 + TRAPD(error,DoHandleRequestL(aMessage));
1.126 + if ( error )
1.127 + {
1.128 + aMessage.Complete(error);
1.129 + }
1.130 + }
1.131 +
1.132 +// ---------------------------------------------------------
1.133 +// CBassBoostMessageHandler::DoHandleRequestL
1.134 +// Dispatches the message to the appropriate handler.
1.135 +// ---------------------------------------------------------
1.136 +//
1.137 +void CBassBoostMessageHandler::DoHandleRequestL(
1.138 + TMMFMessage& aMessage )
1.139 + {
1.140 + switch( aMessage.Function() )
1.141 + {
1.142 + case EBfInitialize: // Request to initialize the bassboost
1.143 + {
1.144 + DoInitializeL(aMessage);
1.145 + break;
1.146 + }
1.147 + case EBfApply: // Request to apply the bassboost settings
1.148 + {
1.149 + DoApplyL(aMessage);
1.150 + break;
1.151 + }
1.152 + case EBfObserve: // Observation request
1.153 + {
1.154 + DoObserveL(aMessage);
1.155 + break;
1.156 + }
1.157 + default:
1.158 + {
1.159 + aMessage.Complete(KErrNotSupported);
1.160 + }
1.161 + }
1.162 + }
1.163 +
1.164 +// ---------------------------------------------------------
1.165 +// CBassBoostMessageHandler::DoInitializeL
1.166 +// ---------------------------------------------------------
1.167 +//
1.168 +void CBassBoostMessageHandler::DoInitializeL(TMMFMessage& aMessage)
1.169 + {
1.170 + aMessage.WriteDataToClient(iBassBoost->DoEffectData());
1.171 + aMessage.Complete(KErrNone);
1.172 + }
1.173 +
1.174 +// ---------------------------------------------------------
1.175 +// CBassBoostMessageHandler::DoApplyL
1.176 +// Extracts the data from the message. The client bassboost data
1.177 +// is applied to the CI bassboost object.
1.178 +// ---------------------------------------------------------
1.179 +//
1.180 +void CBassBoostMessageHandler::DoApplyL(
1.181 + TMMFMessage& aMessage )
1.182 + {
1.183 + TEfBassBoostDataPckg bassboostPckgFromClient;
1.184 + aMessage.ReadData1FromClient(bassboostPckgFromClient);
1.185 +
1.186 + iBassBoost->SetEffectData(bassboostPckgFromClient);
1.187 + iBassBoost->ApplyL();
1.188 + aMessage.Complete(KErrNone);
1.189 + }
1.190 +
1.191 +// ---------------------------------------------------------
1.192 +// CBassBoostMessageHandler::DoObserveL
1.193 +// Receives the observation request message and depending
1.194 +// on the status of the effect data queue, the message is
1.195 +// completed immediately or saved for later completion.
1.196 +// ---------------------------------------------------------
1.197 +//
1.198 +void CBassBoostMessageHandler::DoObserveL(
1.199 + TMMFMessage& aMessage )
1.200 + {
1.201 +
1.202 +#ifdef _DEBUG
1.203 + RDebug::Print(_L("CBassBoostMessageHandler::DoObserveL"));
1.204 +#endif
1.205 +
1.206 + if ( !iRegistered ) // Don't register again if we're registered.
1.207 + {
1.208 + iBassBoost->RegisterObserverL(*this);
1.209 + iRegistered = ETrue;
1.210 + }
1.211 +
1.212 + if ( iEffectDataQue->IsEmpty() )
1.213 + {
1.214 + // Message is saved and completed when an event occurs
1.215 + iMessage = new(ELeave) TMMFMessage(aMessage);
1.216 + }
1.217 + else
1.218 + {
1.219 + TEfBassBoostDataPckg dataPckg;
1.220 + CEffectDataQueItem* item = iEffectDataQue->First();
1.221 + dataPckg.Copy(item->EffectData());
1.222 + aMessage.WriteDataToClient(dataPckg);
1.223 + aMessage.Complete(KErrNone);
1.224 + iEffectDataQue->Remove(*item);
1.225 + delete item;
1.226 + }
1.227 + }
1.228 +
1.229 +// ---------------------------------------------------------
1.230 +// CBassBoostMessageHandler::EffectChanged
1.231 +// The CI bassboost object has changed state.
1.232 +// The observation message is completed if no data has been
1.233 +// queued up. Otherwise, the CI bassboost object's data is
1.234 +// packaged and queued.
1.235 +// ---------------------------------------------------------
1.236 +//
1.237 +void CBassBoostMessageHandler::EffectChanged(
1.238 + const CAudioEffect* aAudioEffect,
1.239 + TUint8 /*aEvent*/ )
1.240 + {
1.241 +#ifdef _DEBUG
1.242 + RDebug::Print(_L("CBassBoostMessageHandler::EffectChanged"));
1.243 +#endif
1.244 +
1.245 + if ( iMessage && !iMessage->IsCompleted() && iEffectDataQue->IsEmpty() )
1.246 + {
1.247 + iMessage->WriteDataToClient(((CBassBoost*)aAudioEffect)->DoEffectData());
1.248 + iMessage->Complete(KErrNone);
1.249 + delete iMessage;
1.250 + iMessage = NULL;
1.251 + }
1.252 + else // no message pending and there is no event queued up
1.253 + {
1.254 + // Saves the data and complete an observation message next time when
1.255 + // there is a pending message.
1.256 + // Saves the data and complete an observation message next time around.
1.257 + HBufC8* data = NULL;
1.258 + TRAPD(err1,data = ((CBassBoost*)aAudioEffect)->DoEffectData().AllocL());
1.259 + if(!err1)
1.260 + {
1.261 + //CleanupStack::PushL(data);
1.262 + CEffectDataQueItem* item = NULL;
1.263 + TRAPD(err2,item = CEffectDataQueItem::NewL(data));
1.264 + if(!err2)
1.265 + {
1.266 + iEffectDataQue->AddLast(*item);
1.267 + }
1.268 + else
1.269 + {
1.270 + delete data;
1.271 + }
1.272 + }
1.273 + else
1.274 + {
1.275 +#ifdef _DEBUG
1.276 + RDebug::Print(_L("CBassBoostMessageHandler::EffectChanged Error Allocating Memory %d"),err1);
1.277 +#endif
1.278 + }
1.279 + }
1.280 + }
1.281 +
1.282 +
1.283 +// ========================== OTHER EXPORTED FUNCTIONS =========================
1.284 +
1.285 +
1.286 +
1.287 +
1.288 +// End of File