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