os/mm/mmhais/a3facl/src/audiogaincontrol/logicalaudiogaincontrol.h
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-2009 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:
sl@0
    15
* Name        : logicalaudiogaincontrol.h
sl@0
    16
* Part of     : ACL Logical Layer
sl@0
    17
*
sl@0
    18
*/
sl@0
    19
sl@0
    20
sl@0
    21
sl@0
    22
#ifndef LOGICALAUDIOGAINCONTROL_H
sl@0
    23
#define LOGICALAUDIOGAINCONTROL_H
sl@0
    24
sl@0
    25
#include <e32base.h>
sl@0
    26
#include <a3f/a3f_trace_utils.h>
sl@0
    27
#include <a3f/a3fbase.h>
sl@0
    28
#include <a3f/maudiogaincontrol.h>
sl@0
    29
#include <a3f/maudiogaincontrolobserver.h>
sl@0
    30
sl@0
    31
#include "audioprocessingunit.h"
sl@0
    32
sl@0
    33
sl@0
    34
class MLogicalSettingObserver;
sl@0
    35
sl@0
    36
/**
sl@0
    37
Implementation of audio gain control API.
sl@0
    38
sl@0
    39
@lib audiogaincontrol.lib
sl@0
    40
*/
sl@0
    41
sl@0
    42
NONSHARABLE_CLASS(CLogicalAudioGainControl) : 	public CAudioProcessingUnit,
sl@0
    43
												public MAudioGainControl,
sl@0
    44
												public MAudioGainControlObserver
sl@0
    45
	{
sl@0
    46
friend class CAudioContext;
sl@0
    47
friend class CLogicalAudioStream;
sl@0
    48
sl@0
    49
public:
sl@0
    50
sl@0
    51
	/**
sl@0
    52
	Destructor.
sl@0
    53
sl@0
    54
	Deletes all objects and releases all resource owned by this instance.
sl@0
    55
	*/
sl@0
    56
	virtual ~CLogicalAudioGainControl();
sl@0
    57
sl@0
    58
	// from base class MAudioGainControl
sl@0
    59
	virtual TInt GetMaxGain(TInt& aMaxGain) const;
sl@0
    60
	virtual TInt GetMaxRampTime(TTimeIntervalMicroSeconds& aMaxRampTime)const;
sl@0
    61
	virtual TInt SetGain(RArray<TAudioChannelGain>& aChannels, TUid aRampOperation, const TTimeIntervalMicroSeconds& aRampDuration);
sl@0
    62
	virtual TInt SetGain(RArray<TAudioChannelGain>& aChannels);
sl@0
    63
	virtual TInt GetGain(RArray<TAudioChannelGain>& aChannels) const;
sl@0
    64
	virtual TInt RegisterAudioGainControlObserver(MAudioGainControlObserver& aObserver);
sl@0
    65
	virtual void UnregisterAudioGainControlObserver(MAudioGainControlObserver& aObserver);
sl@0
    66
sl@0
    67
	// from base class CAudioProcessingUnit
sl@0
    68
	virtual TBool IsTypeOf(TUid aTypeId) const;
sl@0
    69
	virtual TAny* Interface(TUid aType);
sl@0
    70
sl@0
    71
	// from base class MAudioGainControlObserver
sl@0
    72
	void MaxRampTimeChanged(MAudioGainControl& aGain);
sl@0
    73
	void MaxGainChanged(MAudioGainControl& aGain);
sl@0
    74
	void GainChanged(MAudioGainControl& aGain, TInt aError);
sl@0
    75
sl@0
    76
	/**
sl@0
    77
	Create a new instance.
sl@0
    78
sl@0
    79
	@param aGaincontrol the gain implementation. Ownership of the pointer
sl@0
    80
			is transferred to the  create CAudioGainControl object instance.
sl@0
    81
	@return CAudioGainControl* a pointer to the created instance.
sl@0
    82
	*/
sl@0
    83
	static CLogicalAudioGainControl* NewL(TAny* aParam);
sl@0
    84
sl@0
    85
sl@0
    86
private:
sl@0
    87
sl@0
    88
	void ConstructL();
sl@0
    89
sl@0
    90
	CLogicalAudioGainControl(TAny* aParam);
sl@0
    91
sl@0
    92
protected:
sl@0
    93
	RArray<TAudioChannelGain> iActiveChannels;
sl@0
    94
sl@0
    95
	RArray<TAudioChannelGain> iDesiredChannels;
sl@0
    96
sl@0
    97
	TTimeIntervalMicroSeconds iDesiredRampTime;
sl@0
    98
sl@0
    99
	TUid iDesiredRampOperation;
sl@0
   100
sl@0
   101
private:
sl@0
   102
	// Maximum value for ramp time
sl@0
   103
	TTimeIntervalMicroSeconds iMaxRampTime;
sl@0
   104
sl@0
   105
	// The adaptation gain control
sl@0
   106
	MAudioGainControl* iAdaptationGain;
sl@0
   107
sl@0
   108
	RPointerArray<MAudioGainControlObserver> iGainObservers;
sl@0
   109
	};
sl@0
   110
sl@0
   111
#endif // LOGICALAUDIOGAINCONTROL_H