/*

* Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:

*

*/

#ifndef FMTXDATA_

#define FMTXDATA_

// DATA TYPES

/**

* Possible FM Tx states

* 

@publishedPartner

@released

*/

enum TFmTxState

    {

    // Unknown HW error condition

    EFmTxStateUnknown   = 0x0, 

    // Transmitter HW is disabled 

    EFmTxStateOff       = 0x1, 

    // Transmitter HW is enabled.  Audio is currently routed to the transmitter.

    EFmTxStateActive    = 0x2, 

    // Transmitter HW is enabled, in standby mode.  Audio is not currently 

    // routed to the transmitter. 

    EFmTxStateInactive  = 0x4, 

	// Transmitter HW is disabled.  This occurs after a 

	// timeout period has elapsed, from EFmTxStateInactive mode.

    EFmTxStatePowerSaveInactivity = 0x8, 

	// Transmitter HW is disabled.  This occurs after a 

	// mutually exclusive accessory has been attached.

	// When accessory is detached, transition to EFmTxStateOff will occur.

    EFmTxStatePowerSaveAccessory = 0x10,     

    // Transmitter HW is enabled, and is scanning for the next clear frequency.			

    EFmTxStateScanning  = 0x20  

    };

/**

* Frequency range & step size (kHz)

@publishedPartner

@released

*/    

struct TFmTxFrequencyRange

	{

	TInt iMinFrequency;

	TInt iMaxFrequency;

	TInt iStepSize;

	};

/**

* Clear frequency search

@publishedPartner

@released

*/

const TInt KClearFrequencyArrayMax = 10;

typedef TFixedArray<TUint32,KClearFrequencyArrayMax> TClearFrequencyArray;

/**

 * RDS Programme Service

@publishedPartner

@released

 */

const TInt KMaxRdsPsLength = 8;

typedef TBuf<KMaxRdsPsLength> TRdsProgrammeService;

#ifndef EXCLUDE_RDS_PROGRAMME_TYPE_DEFS

/**

 * RDS (& RBDS) Programme Types. There are some differences in numbering of programme types

 * between these two standards.

@publishedPartner

@released

*/

typedef TInt TRdsProgrammeType;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyNone                = 0;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyNews                = 1;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyCurrentAffairs      = 2;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyInformation         = 3;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtySport               = 4;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyEducation           = 5;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyDrama               = 6;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyCulture             = 7;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyScience             = 8;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyVariedSpeech        = 9;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyPopMusic            = 10;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyRockMusic           = 11;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyEasyListening       = 12;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyLightClassical      = 13;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtySeriousClassical    = 14;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyOtherMusic          = 15;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyWeather             = 16;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyFinance             = 17;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyChildrensProgrammes = 18;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtySocialAffairs       = 19;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyReligion            = 20;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyPhoneIn             = 21;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyTravel              = 22;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyLeisure             = 23;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyJazzMusic           = 24;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyCountryMusic        = 25;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyNationalMusic       = 26;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyOldiesMusic         = 27;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyFolkMusic           = 28;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyDocumentary         = 29;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyAlarmTest           = 30;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRdsPtyAlarm               = 31;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyNone               = 0;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyNews               = 1;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyInformation        = 2;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtySports             = 3;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyTalk               = 4;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyRock               = 5;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyClassicRock        = 6;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyAdultHits          = 7;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtySoftRock           = 8;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyTop40              = 9;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyCountry            = 10;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyOldies             = 11;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtySoft               = 12;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyNostalgia          = 13;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyJazz               = 14;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyClassical          = 15;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyRhythmAndBlues     = 16;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtySoftRhythmAndBlues = 17;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyLanguage           = 18;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyReligiousMusic     = 19;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyReligiousTalk      = 20;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyPersonality        = 21;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyPublic             = 22;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyCollege            = 23;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyUnassigned1        = 24;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyUnassigned2        = 25;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyUnassigned3        = 26;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyUnassigned4        = 27;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyUnassigned5        = 28;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyWeather            = 29;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyEmergencyTest      = 30;

/**

*

* @publishedPartner

* @released

*/

const TRdsProgrammeType KRbdsPtyEmergency          = 31;

/**

 * RDS Programme Type Name.

*

* @publishedPartner

* @released

*/

const TUint8 KMaxRdsPtynLength = 8;

typedef TBuf<KMaxRdsPtynLength> TRdsProgrammeTypeName;

#endif // EXCLUDE_RDS_PROGRAMME_TYPE_DEFS

/**

 * RDS Language IDs.

*

* @publishedPartner

* @released

 */

typedef TInt TRdsLanguageIdType;

/**

* FM Tx RDS data

* These data items may set, using the HWRM FM Tx API

*

* @publishedPartner

* @released

*/

struct TFmTxRdsData

    {

    TRdsProgrammeType     iPty;        // Programme Type

    TRdsProgrammeTypeName iPtyn;       // Programme Type Name

    TBool                 iMs;         // Music/Speech flag

    TRdsLanguageIdType    iLanguageId; // Language ID

    };

/**

*

* @publishedPartner

* @released

*/

const TRdsLanguageIdType KRdsLanguageUnknown 		= 0x00; // Unknown/not applicable 

/**

*

* @publishedPartner

* @released

*/

const TRdsLanguageIdType KRdsLanguageAlbanian 		= 0x01; // Albanian 

/**

*

* @publishedPartner

* @released

*/

const TRdsLanguageIdType KRdsLanguageBreton 		= 0x02; // Breton

/**