devsoundextensions/effects/EffectBase/src/AudioEffectBase.cpp
author hgs
Tue, 02 Nov 2010 12:28:51 +0000
changeset 6 fe9d1bf55678
parent 0 b8ed18f6c07b
permissions -rw-r--r--
2010wk46_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     1
/*
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     2
* Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies). 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     3
* All rights reserved.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     8
*
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     9
* Initial Contributors:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    11
*
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    12
* Contributors:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    13
*
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    14
* Description:   Implementation of the base class for effects.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    15
*
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    16
*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    17
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    18
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    19
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    20
// INCLUDE FILES
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    21
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    22
#ifdef _DEBUG
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    23
#include <e32svr.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    24
#endif
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    25
#include <AudioEffectBase.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    26
#include <MAudioEffectObserver.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    27
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    28
// ============================ MEMBER FUNCTIONS ===============================
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    29
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    30
// -----------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    31
// CAudioEffect::CAudioEffect
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    32
// C++ default constructor can NOT contain any code, that
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    33
// might leave.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    34
// -----------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    35
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    36
EXPORT_C CAudioEffect::CAudioEffect()
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    37
    : 	iEnabled(EFalse),
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    38
    	iEnforced(EFalse),
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    39
    	iHaveUpdateRights(ETrue)
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    40
    {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    41
    }
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    42
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    43
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    44
// Destructor
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    45
EXPORT_C CAudioEffect::~CAudioEffect()
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    46
    {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    47
	iObservers.Close();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    48
    }
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    49
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    50
// -----------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    51
// CAudioEffect::IsEnable
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    52
// -----------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    53
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    54
EXPORT_C TBool CAudioEffect::IsEnabled() const
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    55
    {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    56
	return iEnabled;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    57
    }
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    58
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    59
// -----------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    60
// CAudioEffect::Enable
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    61
// -----------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    62
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    63
EXPORT_C void CAudioEffect::EnableL()
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    64
    {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    65
	iEnabled = ETrue;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    66
	ApplyL();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    67
    }
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    68
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    69
// -----------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    70
// CAudioEffect::Disable
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    71
// -----------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    72
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    73
EXPORT_C void CAudioEffect::DisableL()
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    74
    {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    75
	iEnabled = EFalse;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    76
	ApplyL();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    77
    }
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    78
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    79
// -----------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    80
// CAudioEffect::Enforce
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    81
// -----------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    82
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    83
EXPORT_C void CAudioEffect::EnforceL(
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    84
	TBool aEnforced )
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    85
    {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    86
	iEnforced = aEnforced;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    87
	ApplyL();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    88
    }
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    89
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    90
// -----------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    91
// CAudioEffect::HaveUpdateRights
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    92
// -----------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    93
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    94
EXPORT_C TBool CAudioEffect::HaveUpdateRights() const
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    95
    {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    96
	return iHaveUpdateRights;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    97
    }
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    98
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    99
// -----------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   100
// CAudioEffect::IsEnforced
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   101
// -----------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   102
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   103
EXPORT_C TBool CAudioEffect::IsEnforced() const
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   104
    {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   105
	return iEnforced;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   106
    }
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   107
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   108
// -----------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   109
// CVolume::RegisterObserverL
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   110
// -----------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   111
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   112
EXPORT_C void CAudioEffect::RegisterObserverL(
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   113
	MAudioEffectObserver& aObserver )
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   114
	{
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   115
	User::LeaveIfError(iObservers.Append(&aObserver));
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   116
	}
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   117
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   118
// -----------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   119
// CVolume::UnRegisterObserver
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   120
// -----------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   121
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   122
EXPORT_C void CAudioEffect::UnRegisterObserver(
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   123
	MAudioEffectObserver& aObserver )
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   124
	{
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   125
	TInt index = iObservers.Find(&aObserver);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   126
	if( index != KErrNotFound )
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   127
		{
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   128
		iObservers.Remove(index);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   129
		}
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   130
	}
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   131
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   132
// ========================== OTHER EXPORTED FUNCTIONS =========================
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   133
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   134
// End of File