/*

* Copyright (c) 2005-2008 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:  This file defines the protocol independent interface of the Phone Engine.

*

*/

#ifndef PEVIRTUALENGINE_H

#define PEVIRTUALENGINE_H

// INCLUDES

#include <badesca.h>

#include <bldvariant.hrh>   //protocol definition, component configuration definitions

#include <cphcntcontactid.h>

#include <ctsydomainpskeys.h>

#include <etelmm.h>

#include <exterror.h>

#include <fbs.h>

#include <mccecall.h>

#include <mmtsy_names.h>

#include <NetworkHandlingDomainPSKeys.h>

#include <PhCltTypes.h>

#include <Profile.hrh>

#include <rmmcustomapi.h>

#include <RSSSettings.h>

#include <sysutil.h>

// CONSTANTS

//Call origin types

enum TPECallOrigin

    {

    EPECallOriginPhone,

    EPECallOriginClient,

    EPECallOriginSAT

    };

//Output types

enum TPEAudioOutput

    {

    EPENotActive,

    EPEHandset,

    EPELoudspeaker,

    EPEWiredAudioAccessory,

    EPEBTAudioAccessory,

    EPETTY

    };

//Error types

enum TPEErrorType

    {

    EPECcp = 0,

    EPECch

    };

// PhoneEngine Errors

const TInt KErrPhoneEngineErrorBase = -30000;

const TInt KErrPhoneEngineNoWcdmaNetwork = KErrPhoneEngineErrorBase - 1;

const TInt KErrPhoneEngineVideoCallNotAllowedDuringRestore = KErrPhoneEngineErrorBase - 2;

const TInt KErrPhoneEngineVideoCallSetupFailed = KErrPhoneEngineErrorBase - 3;

// Phone Engine dll uid

const TUid KUidPhoneEngine = { 0x1000A86C };

// Maximum length of phone number 

const TInt KPEPhoneNumberMaxLength = 100;

//Phone number type defined using the custom maximum length

typedef TBuf<KPEPhoneNumberMaxLength> TPEPhoneNumber;

//Maximum length of dtmf string        

const TInt KPEDtmfMaxLength = KPEPhoneNumberMaxLength;

//Maximum number of the SS service groups

const TInt KPEMaxServiceGroup = 53; // Maximum value taken from etelmm.h(TMobileService)    

const TInt KPEAutomaticAnswerTimeout = 5000000; // 5 seconds;

// Enumerations for variant messages

// For enumeration TPEMessagesToPhoneEngine

const TInt KPEMessagesToPhoneEngineGsmFirst = 11000;

const TInt KPEMessagesToPhoneEngineGsmLast = 12999;

const TInt KPEMessagesToPhoneEngineVariantFirst = KPEMessagesToPhoneEngineGsmFirst;

// For enumeration TPEMessagesFromPhoneEngine

const TInt KPEMessagesFromPhoneEngineGsmFirst = 11000;

const TInt KPEMessagesFromPhoneEngineGsmLast = 12999;

const TInt KPEMessagesFromPhoneEngineVariantFirst = KPEMessagesFromPhoneEngineGsmFirst;

// Lifetimer data in hours and minutes

NONSHARABLE_STRUCT( TPELifeTimeData )                      

    {

	TUint32 iHours;                         //range 0-999999 

	TUint8 iMinutes;                        //range 0-59

    };

// Used when initializing number variables with non negative value range.

const TInt KPENumberInitValue = -1; 

//CallId not used in SendErrorMessageL

const TInt KPECallIdNotUsed = -1;            

//ErrorCode not used in SendErrorMessageL

const TInt KPEErrorCodeNotUsed = -1;        

// Informs to phone engine that dont send message to the phone application

const TInt KPEDontSendMessage = 1;

// Maximum lenght of timer

const TInt KPESsTimerMaxLength = 2;

// Audio player repeats tone forever

const TInt KPEAudioPlayerRepeatForever = -2;

// Default Audio volume value

const TInt KPEDefaultAudioVolume = 7;

// Default volume value for accessory

const TInt KPEDefaultAccessoryVolume = 5;

// Default keypad volume

const TProfileKeypadVolume KPEDefaultKeypadVolume = EProfileKeypadVolumeLevel2;

// Dtmf stop character, PE handles internally DTMF characters as lowercase.

const TUint KPEDtmfStopCharLowercase = 'w';

const TUint KPEDtmfStopCharUppercase = 'W';

const TUint KPEDtmfPauseCharLowercase = 'p';

const TUint KPEDtmfPauseCharUppercase = 'P';

const TUint KPEDtmfPlusChar = '+';

enum TPELoggingIndicator

    {

    EPENormalLogging = 0,

    EPEContinuousLogging 

    };

// Maximum Length of profile name

const TInt KPEProfileNameLength = 64;

// Profile is alerting all incoming calls.

_LIT( KPEAlertForAllCalls, "1");

// Informs how many profiles there are

const TInt KPEProfileGroups = 3;

// Informs how much time it take's to change ringing tone volume from minimum to maximum(Ascending)

const TInt KPERingingToneRampDuration = 5000000;

// Informs how many ringing tone volume levels there are in the profile db

const TInt KPEProfileRingingToneLevels = 10;

// Includes default tone volume

const TInt KPEDefaultToneVolume = 30000;

// Contact group id string length

const TInt KPEContactGroupString = 100;

//The length of a pause created during dialling by the comma character (',') measured in seconds.  

const TUint KPEDefaultInterval = 2;

// CommDB constants for Data calls

// Internet Access Point service type

_LIT( KPEIAPServiceTypeName, "IAP\\IAPServiceType" );

// Dial Out Internet Serivce Provider Table name

_LIT( KPEIAPDialOutISPTableName, "DialOutISP" );

// Dial In Internet Service Provider Table name

_LIT( KPEIAPDialInISPTableName, "DialInISP" );

// Access Point Name column on IAP table

_LIT( KPEIAPAccessPointName, "IAP\\NAME" );

const TInt KPEMaxAudioOutputs = EPETTY + 1; // enum count

// DATA TYPES

// Contact name definition

typedef TBuf<KCntMaxTextFieldLength> TPEContactName;

// Contact company definition

typedef TBuf<KCntMaxTextFieldLength> TPEContactCompany;

// Contact group definition

typedef TBuf<KCntMaxTextFieldLength> TPEContactGroup;

// Contact filename definition

typedef TBuf<KMaxFileName>         TPEContactFileName;

// Contact group ids sting

typedef TBuf<KPEContactGroupString> TPEContactGroupId;

//Dtmf-string definition

typedef TBuf<KPEDtmfMaxLength> TPEDtmfString;

//Profile name definition

typedef TBuf<KPEProfileNameLength> TPEProfileName;

//Call control caps

typedef TUint32 TPECallControlCaps;

//User to user info

typedef TBuf<KPhCltUUILength> TPEUserToUserInfo;

// Phone identity parameters type.

typedef TBuf<RMobilePhone::KPhoneManufacturerIdSize> TPEManufacturer;

typedef TBuf<RMobilePhone::KPhoneModelIdSize> TPEModel;

typedef TBuf<KSysUtilVersionTextLength> TPERevision;

typedef TBuf<RMobilePhone::KPhoneSerialNumberSize> TPESerialNumber;

//Call States

typedef TUint TPEState;

enum

    {

    // Call states                        0 - 499

    EPEStateUnknown                     = 0,

    EPEStateIdle,

    EPEStateDialing,

    EPEStateEmergencyDialing,

    EPEStateRinging,

    EPEStateConnecting,

    EPEStateConnected,

    EPEStateHangingUp,

    EPEStateHeld,

    EPEStateAnswering,

    EPEStateRejecting,

    EPEStateDisconnecting,

    // conference call states

    EPEStateConferenceIdle,

    EPEStateConnectedConference,

    EPEStateHeldConference,

    EPEStateCreatingConference,

    EPEStateHangingUpConference,

    EPEStateSwappingConference,

    EPEStateResumeHoldConference,        

    EPEStateGoingOneToOne,

    EPEStateAddingConferenceMember,

    EPEStateAddedConferenceMember,

    EPEStateDroppingConferenceMember,

    EPEStateDroppedConferenceMember,

    // maximum value for boundary checks

    EPEStateMaximumState                = 1000

    };

NONSHARABLE_STRUCT( TPEErrorInfo )

    {

	//Symbian OS error code

	TInt iErrorCode;

	//Call Id number, equals KPECallIdNotUsed if call id is not available or is

	//invalid for this error condition

	TInt iCallId;

	// Error type( Cch or Ccp )

	TPEErrorType iErrorType;

    };

enum TPECallType

    { // maintain compatibility with P&S type enum

    // Used to initialize call type information

    EPECallTypeUninitialized    = EPSCTsyCallTypeUninitialized,

    // Circuit switched voice call

    EPECallTypeCSVoice          = EPSCTsyCallTypeCSVoice,

    // Circuit switched multimedia call

    EPECallTypeVideo            = EPSCTsyCallTypeH324Multimedia,

    // Packet switched voice call

    EPECallTypeVoIP             = EPSCTsyCallTypeVoIP

    };

enum TPEPinCode 

    {

    EPEPinCode,

    EPEPin2Code

    };

enum TPEPhoneCommandType

    {

    EPESendingFlash

    };

// Enumeration which defines the search keys with which

// contact information is searched

enum TPEFindContactKey

    {

    //Search keys

    EPEFindWithPhoneNumber = 0,

    EPEFindWithContactId,

    EPEFindKeyNotDefined

    };

enum TPESecurityCommand 

    {

    EPESecurityCommandUnknown,

    EPESecurityCommandChangePinCode,

    EPESecurityCommandUnblockPinCode,

    EPESecurityCommandChangeBarringPassword,

    EPESecurityCommandChangeSimLock

    };

enum TPEPhoneNumberIdType

    {

    EPEUnknownNumber,

    EPEMobileNumber,

    EPEPager,

    EPETelephoneNumber,

    EPEVmbxNumberLine1,

    EPEVmbxNumberLine2,

    EPEPrivateNumber,

    EPEEmergencyNumber,

    EPEFaxNumber,

    EPEVoipNumber,

    EPEVideoNumber,

    EPEAssistantNumber,

    EPECarNumber,

    EPEHomeNumber,

    EPEWorkNumber

    };

enum TPERxTimeSlots

    {

    EPERxSlots1 = 1,

    EPERxSlots2 = 2,

    EPERxSlots3 = 3

    };

//VoiceMailBoxNumbers

NONSHARABLE_STRUCT( TPEVoiceMailBoxNumberInfo )

    {

    TPEPhoneNumber iVMBXL1; // Line 1 VoiceMailBoxNumber

	TPEPhoneNumber iVMBXL2; // Line 2 VoiceMailBoxNumber

	TPEPhoneNumber iDTMFVMBXL1; // Line 1 DTMFVoiceMailBoxNumber

	TPEPhoneNumber iDTMFVMBXL2; // Line 2 DTMFVoiceMailBoxNumber

    };

// Contains information of PhoneIdentity paramteres

NONSHARABLE_STRUCT( TPEPhoneIdentityParameters )

    {

	TPEManufacturer iManufacturer;

	TPEModel iModel;

	TPERevision iRevision;

	TPESerialNumber iSerialNumber;

    };

// Contains information of call audio route parameters

NONSHARABLE_STRUCT( TPEPhoneAudioRouteParameters )

    {

	TPEAudioOutput iAudioOutput;

	TPEAudioOutput iPreviousOutput;

	TBool iShowNote;

    };

// Enumerate definitions for MMI Service Codes from MMETel API:

// FUNCTION PROTOTYPES

// None.

// FORWARD DECLARATIONS

class MPEEngineInfo;

// CLASS DECLARATION

/**

*  Offers message interface from phone engine to phone application.

*  

*  @lib phonenegine.lib

*  @since S60 v.4.0

*/

NONSHARABLE_CLASS( MEngineMonitor )

    {

    public:

        enum TPEMessagesFromPhoneEngine

        {

        // Audio messages                     1000 - 1999

        EPEMessageAudioDtmfEvent            = 1000,

        EPEMessageAudioDTMFPlayComplete,

        EPEMessageAudioMuteChanged,

        EPEMessageAudioOutputChanged,

        EPEMessageAudioOutputPreferenceChanged,

        EPEMessageAudioPlayStopped,

        EPEMessageAudioVolumeChanged,

        EPEMessageAvailableAudioOutputsChanged,

        // Call messages                      2000 - 2999

        EPEMessageAnswer                    = 2000,

        EPEMessageAnswering,

        EPEMessageCallAdded,

        EPEMessageCallControlCapsChanged,

        EPEMessageCallWaiting,

        EPEMessageCallWaitingAnswered,

        EPEMessageChangedCallDuration,

        EPEMessageConferenceCapsChange,        

        EPEMessageConferenceIdle,

        EPEMessageConnected,

        EPEMessageConnectedConference,                

        EPEMessageConnecting,

        EPEMessageContinuingDTMFSending,

        EPEMessageDialing,

        EPEMessageDialingError,

        EPEMessageDisconnecting,

        EPEMessageDisconnectingConference,        

        EPEMessageDisconnectingWithInband,  //UI doesn't get this message, it is mapped as EPEMessageDisconnecting

        EPEMessageDTMFSendingAborted,

        EPEMessageHeld,

        EPEMessageHeldConference,        

        EPEMessageIdle,

        EPEMessageIncoming,

        EPEMessageInitiatedEmergencyCall,

        EPEMessageInitiatedEmergencyWhileActiveVideo,

        EPEMessageInitiatedMoCall, // MO call setup has started but not yet in Dialing state

        EPEMessageInvalidSpeedDial,

        EPEMessageIssuingUSSDRequest,

        EPEMessageIssuedUSSDRequest,

        EPEMessagePacketNetworkDetached,   

        EPEMessagePromptSpeedDial,

        EPEMessageRemoteBusy,

        EPEMessageRemoteTerminated,               

        EPEMessageSendingDTMF,

        EPEMessageSentDTMF,

        EPEMessageSentSSString,

        EPEMessageSpeedDialNotAssigned,

        EPEMessageStoppedDTMF,

        EPEMessageSwapped,

        EPEMessageTransferDone,

        EPEMessageTransferring,

        EPEMessageUnknown,

        EPEMessageWentOneToOne,        

        EPEMessageRemotePartyInfoChanged,

        EPEMessageConnectingWithInband, //UI doesn't get this message, it is mapped as EPEMessageConnecting

        EPEMessageUnattendedTransferRequest,

        EPEMessageRemoteForwarding,

        EPEMessageMovedPermanently,        

        EPEMessageMultipleChoices,     

        EPEMessageColpNumberAvailable,

        EPEMessageTransferCallBackRequest,

        // Contact messages                   3000 - 3999

        EPEMessageThumbnailLoadingCompleted  = 3000,

        // Error messages                     4000 - 4999

        EPEMessageError                     = 4000,

        EPEMessageAudioHandlingError,

        EPEMessageCallHandlingError,

        EPEMessageConferenceErrorAddCall,

        EPEMessageConferenceErrorRemoveCall,

        EPEMessageConferenceErrorSwap,

        EPEMessageConferenceErrorHold,

        EPEMessageConferenceErrorResume,

        EPEMessageConferenceErrorGoOneToOne,

        EPEMessageConferenceErrorCurrentCallsToConference,

        EPEMessageConferenceErrorHangUp,

        EPEMessageContactHandlingError,

        EPEMessageLogHandlingError,

        EPEMessageServiceHandlingError,

        // Network messages                   5000 - 5999

        EPEMessageCallSecureStatusChanged= 5000,

        EPEMessageNetworkRegistrationStatusChange,

        // Parser messages                    6000 - 6999

        EPEMessageActivateRfsDeep           = 6000,

        EPEMessageActivateRfsNormal,

        EPEMessageActivateWarrantyMode,

        EPEMessageShowBTDeviceAddress,

        EPEMessageShowBTLoopback,

        EPEMessageShowIMEI,

        EPEMessageShowVersion,

        EPEMessageShowWlanMacAddress,

        EPEMessageSSRequestFailed,

        EPEMessageBTDebugMode,

        // Security messages                  7000 - 7999

        EPEMessageBadBarringPasswordChange  = 7000,

        EPEMessageBadPin1Change,

        EPEMessageBadPin1Unblock,

        EPEMessageBadPin2Change,

        EPEMessageBadPin2Unblock,

        EPEMessageBarringPasswordChanged,

        EPEMessageChangedSimLock,

        EPEMessageFailedChangeSimLock,

        EPEMessageFailedNewPin1AndPin2NotEqual,         // Error message, NewPin1 and NewPin2 are not equal

        EPEMessageFailedSecurityCommandAlreadyActive,   // Error message, SecurityCommand is already active

        EPEMessagePin1Changed,

        EPEMessagePin1Unblocked,

        EPEMessagePin2Changed,

        EPEMessagePin2Unblocked,

        EPEMessageSIMChanged,

        EPEMessageSIMStateChanged,

        // Settings and Shared Data messages  8000 - 8999

        EPEMessageProfileChanged            = 8000,

        // Startup messages                   9000 - 9999

        EPEMessagePEConstructionReady       = 9000,     // Phone Engine is initialized and fully operational

        EPEMessagePEConstructionFailed,

        EPEMessagePEConstructionTwoPhaseReady,

        // Miscellaneous messages             10000 - 10999

        EPEMessageDoNotSendMe               = 10000,

        EPEMessageInValidEmergencyNumber,

        EPEMessageLogEventSaved, 

        EPEMessagePhoneIdentityReady,

        EPEMessageStartATDialing,

        EPEMessageValidEmergencyNumber,

        EPEMessageMuteRingingTone,

        // Audio messages                         11000 - 11199

        // Call messages                          11200 - 11399

        EPEMessageActiveBarring                 = KPEMessagesFromPhoneEngineGsmFirst + 200,

        EPEMessageActiveCallForwarding,

        EPEMessageAddedConferenceMember,

        EPEMessageALSLineChanged,

        EPEMessageCallBarred,

        EPEMessageIncCallIsForw,

        EPEMessageIncCallForwToC,

        EPEMessageOutCallForwToC,

        EPEMessageForwardUnconditionalModeActive,

        EPEMessageForwardConditionallyModeActive,

        EPEMessageDroppedConferenceMember,

        EPEMessageGoingOneToOne,

        EPEMessageRemoteCreatedConference,

        EPEMessageRemoteHeld,

        EPEMessageRemoteResumed,

        EPEMessageTempClirSuppressUnsuccessful,

        EPEMessageTempClirActivationUnsuccessful,

        EPEMessageShowIncCallGroupIndex,

        EPEMessageDataPortLoaned,

        // Contact messages                       11400 - 11599

        // Error messages                         11600 - 11799

        // VoIP service messages                       11800 - 12999

        EPEMessageServiceEnabled               = KPEMessagesFromPhoneEngineGsmFirst + 800,

        EPEMessageServiceEnabling,

        EPEMessageNoService,

        EPEMessageServiceDisabled,