epoc32/include/audioequalizerdata.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:  This file contains definitions of audio effects data structures for
williamr@2
    15
*                equalizer.
williamr@2
    16
*
williamr@2
    17
*/
williamr@2
    18
williamr@2
    19
williamr@2
    20
williamr@2
    21
#ifndef EQUALIZERDATA_H
williamr@2
    22
#define EQUALIZERDATA_H
williamr@2
    23
williamr@2
    24
//  INCLUDES
williamr@2
    25
#include <e32std.h>
williamr@2
    26
#include <s32mem.h>
williamr@2
    27
#include <AudioEffectData.h>
williamr@2
    28
williamr@2
    29
// CLASS DECLARATION
williamr@2
    30
williamr@2
    31
/**
williamr@2
    32
*  This class defines the effect data structure of a particular frequency band.
williamr@2
    33
*
williamr@2
    34
*  @lib EqualizerEffect.lib
williamr@2
    35
*  @since 3.0
williamr@2
    36
*/
williamr@2
    37
class TEfAudioEqualizerBand
williamr@2
    38
    {
williamr@2
    39
    public:
williamr@2
    40
williamr@2
    41
        /**
williamr@2
    42
        * Constructor.
williamr@2
    43
        */
williamr@2
    44
        TEfAudioEqualizerBand() {}
williamr@2
    45
williamr@2
    46
        void ExternalizeL( RWriteStream& aStream ) const
williamr@2
    47
        	{
williamr@2
    48
			aStream.WriteUint8L(iBandId);
williamr@2
    49
			aStream.WriteUint32L(iBandLevel);
williamr@2
    50
			aStream.WriteUint32L(iBandWidth);
williamr@2
    51
			aStream.WriteUint32L(iCenterFrequency);
williamr@2
    52
			aStream.WriteUint32L(iCrossoverFrequency);
williamr@2
    53
			}
williamr@2
    54
williamr@2
    55
        void InternalizeL( RReadStream& aStream )
williamr@2
    56
        	{
williamr@2
    57
			iBandId = aStream.ReadUint8L();
williamr@2
    58
			iBandLevel = aStream.ReadUint32L();
williamr@2
    59
			iBandWidth = aStream.ReadUint32L();
williamr@2
    60
			iCenterFrequency = aStream.ReadUint32L();
williamr@2
    61
			iCrossoverFrequency = aStream.ReadUint32L();
williamr@2
    62
			}
williamr@2
    63
williamr@2
    64
		TUint8 iBandId;
williamr@2
    65
		TInt32 iBandLevel;
williamr@2
    66
		TInt32 iBandWidth;
williamr@2
    67
		TInt32 iCenterFrequency;
williamr@2
    68
		TInt32 iCrossoverFrequency;
williamr@2
    69
williamr@2
    70
    };
williamr@2
    71
williamr@2
    72
/**
williamr@2
    73
*  This class defines the effect data structure to be passed between client and
williamr@2
    74
*  server.
williamr@2
    75
*
williamr@2
    76
*  @lib EqualizerEffect.lib
williamr@2
    77
*  @since 3.0
williamr@2
    78
*/
williamr@2
    79
class TEfAudioEqualizer : public TEfCommon
williamr@2
    80
    {
williamr@2
    81
    public:
williamr@2
    82
williamr@2
    83
        /**
williamr@2
    84
        * Constructor.
williamr@2
    85
        */
williamr@2
    86
        TEfAudioEqualizer() {}
williamr@2
    87
williamr@2
    88
        /**
williamr@2
    89
        * Constructor.
williamr@2
    90
        */
williamr@2
    91
        TEfAudioEqualizer( TInt32 aMindB, TInt32 aMaxdB ) :
williamr@2
    92
        	iMindB(aMindB), iMaxdB(aMaxdB) {}
williamr@2
    93
williamr@2
    94
		TInt32 iMindB;
williamr@2
    95
		TInt32 iMaxdB;
williamr@2
    96
williamr@2
    97
    };
williamr@2
    98
williamr@2
    99
williamr@2
   100
class TEfAudioEqualizerCombined : public TEfAudioEqualizer, public TEfAudioEqualizerBand
williamr@2
   101
    {
williamr@2
   102
    public:
williamr@2
   103
williamr@2
   104
		// Indicates the data is valid for Equalizer
williamr@2
   105
		TBool iAudioEqualizerDataValid;
williamr@2
   106
		// Indicates the data is valid for Equalizer Band
williamr@2
   107
		TBool iAudioEqualizerBandDataValid;
williamr@2
   108
    };
williamr@2
   109
williamr@2
   110
williamr@2
   111
typedef TPckgBuf<TEfAudioEqualizer> TEfAudioEqualizerDataPckg;
williamr@2
   112
typedef TPckgBuf<TEfAudioEqualizerBand> TEfAudioEqualizerBandDataPckg;
williamr@2
   113
typedef TPckgBuf<TEfAudioEqualizerCombined> TEfAudioEqualizerCombinedDataPckg;
williamr@2
   114
williamr@2
   115
#endif      // EQUALIZERDATA_H
williamr@2
   116
williamr@2
   117
// End of File