mmaudio_pub/audio_effects_api/inc/AudioEqualizerData.h
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:  This file contains definitions of audio effects data structures for
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    15
*                equalizer.
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
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    21
#ifndef EQUALIZERDATA_H
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    22
#define EQUALIZERDATA_H
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    23
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    24
//  INCLUDES
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    25
#include <e32std.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    26
#include <s32mem.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    27
#include <AudioEffectData.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    28
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    29
// CLASS DECLARATION
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    30
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    31
/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    32
*  This class defines the effect data structure of a particular frequency band.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    33
*
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    34
*  @lib EqualizerEffect.lib
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    35
*  @since 3.0
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    36
*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    37
class TEfAudioEqualizerBand
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    38
    {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    39
    public:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    40
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    41
        /**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    42
        * Constructor.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    43
        */
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    44
        TEfAudioEqualizerBand() {}
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    45
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    46
        void ExternalizeL( RWriteStream& aStream ) const
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    47
        	{
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    48
			aStream.WriteUint8L(iBandId);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    49
			aStream.WriteUint32L(iBandLevel);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    50
			aStream.WriteUint32L(iBandWidth);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    51
			aStream.WriteUint32L(iCenterFrequency);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    52
			aStream.WriteUint32L(iCrossoverFrequency);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    53
			}
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    54
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    55
        void InternalizeL( RReadStream& aStream )
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    56
        	{
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    57
			iBandId = aStream.ReadUint8L();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    58
			iBandLevel = aStream.ReadUint32L();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    59
			iBandWidth = aStream.ReadUint32L();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    60
			iCenterFrequency = aStream.ReadUint32L();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    61
			iCrossoverFrequency = aStream.ReadUint32L();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    62
			}
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    63
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    64
		TUint8 iBandId;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    65
		TInt32 iBandLevel;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    66
		TInt32 iBandWidth;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    67
		TInt32 iCenterFrequency;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    68
		TInt32 iCrossoverFrequency;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    69
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    70
    };
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    71
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    72
/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    73
*  This class defines the effect data structure to be passed between client and
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    74
*  server.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    75
*
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    76
*  @lib EqualizerEffect.lib
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    77
*  @since 3.0
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    78
*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    79
class TEfAudioEqualizer : public TEfCommon
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    80
    {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    81
    public:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    82
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    83
        /**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    84
        * Constructor.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    85
        */
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    86
        TEfAudioEqualizer() {}
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    87
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    88
        /**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    89
        * Constructor.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    90
        */
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    91
        TEfAudioEqualizer( TInt32 aMindB, TInt32 aMaxdB ) :
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    92
        	iMindB(aMindB), iMaxdB(aMaxdB) {}
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    93
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    94
		TInt32 iMindB;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    95
		TInt32 iMaxdB;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    96
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
class TEfAudioEqualizerCombined : public TEfAudioEqualizer, public TEfAudioEqualizerBand
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   101
    {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   102
    public:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   103
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   104
		// Indicates the data is valid for Equalizer
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   105
		TBool iAudioEqualizerDataValid;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   106
		// Indicates the data is valid for Equalizer Band
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   107
		TBool iAudioEqualizerBandDataValid;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   108
    };
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   109
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   110
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   111
typedef TPckgBuf<TEfAudioEqualizer> TEfAudioEqualizerDataPckg;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   112
typedef TPckgBuf<TEfAudioEqualizerBand> TEfAudioEqualizerBandDataPckg;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   113
typedef TPckgBuf<TEfAudioEqualizerCombined> TEfAudioEqualizerCombinedDataPckg;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   114
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   115
#endif      // EQUALIZERDATA_H
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   116
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   117
// End of File