/*

* Copyright (c) 2005 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:  The class implements the core functionality of the

*                Radio Engine

*

*/

#ifndef FMRADIOENGINE_H

#define FMRADIOENGINE_H

#include <e32base.h>

#include <AccMonitorCapabilities.h>

#include <fmradiointernalpskeys.h>

#include <RadioUtility.h>

#include <RadioFmTunerUtility.h>

#include <RadioPlayerUtility.h>

#include <RadioPresetUtility.h>

#include <RadioFmPresetUtility.h>

#include <etelmm.h>

#include "fmradiosystemeventdetectorobserver.h"

#include "fmradionetworkchangeobserver.h"

#include "fmradiordsobserver.h"

#include "fmradioengine.hrh"

#include "fmradioheadseteventobserver.h"

#ifndef __ACCESSORY_FW

#include <DosSvrServices.h>

#endif

// CONSTANTS

const TUint8 KPresetNameLength = 32;

const TInt KDefaultRadioFrequency = 87500000;

_LIT(KFMRadioEngineResourceFile, "fmradioengine.rsc");

const TInt KFMRadioFreqMultiplier = 1000;

// FORWARD DECLARATIONS

class CAudioOutput;

class CCentralRepositoryHandler;

class CDesC16Array;

class CFMRadioAccessoryObserver;

class CFMRadioContextPublisher;

class CFMRadioMobileNetworkInfoListener;

class CFMRadioPubSub;

class CFMRadioRdsReceiverBase;

class CFMRadioSystemEventDetector;

class CRadioStateHandler;

class MRadioEngineStateChangeCallback;

class TRadioSettings;

#ifndef __ACCESSORY_FW

class RDosServer;

class CDosServerObserver;

#endif

// CLASS DECLARATION

/**

 * This class implements the core functionality of the Radio Engine

 *

 * @since S60 3.2

 */

class CRadioEngine : public CBase,

                     public MRadioPlayerObserver,

                     public MRadioFmTunerObserver,

                     public MRadioPresetObserver,

                     public MFMRadioSystemEventDetectorObserver,

                     public MFMRadioNetworkChangeObserver,

                     public MFMRadioRdsObserver,

                     public MFMRadioHeadsetEventObserver

    {

public:

    typedef TBuf<KPresetNameLength> TStationName;

    enum TRadioMode

        {

        ERadioTunerMode,

        ERadioPresetMode

        };

    enum TFMRadioAudioMode

        {

        EFMRadioStereo = 0,

        EFMRadioMono

        };

    enum TFMRadioAudioOutput

        {

        EFMRadioOutputHeadset = 0,

        EFMRadioOutputIHF

        };

public:

    /**

    * Two-phased class constructor.

    * @return pointer to CRadioEngine class instance

    */

    IMPORT_C static CRadioEngine* NewL( MRadioEngineStateChangeCallback& aCallback );

    /**

    * Destructor of CRadioEngine class.

    */

    IMPORT_C virtual ~CRadioEngine();

public: // New functions

    /**

    * Set radio settings to their default values.

    * @since Series 60 3.0

    * @return none

    */

    IMPORT_C void InitializeRadio();

    /**

    * Retrieves the current radio mode .

    * @since Series 60 3.0

    * @return tune/preset

    */

    IMPORT_C TRadioMode GetRadioMode() const;

    /**

    * Gets the current audio mode.

    * @since Series 60 3.0

    * @return stereo/mono

    * @retval 0 = stereo

    * @retval 1 = mono

    */

    IMPORT_C TInt GetAudioMode() const;

    /**

    * Set the radio's audio mode.

    * @since Series 60 3.0

    * @param aAudioMode the new audio mode

    * @return none

    */

    IMPORT_C void SetAudioMode( const TFMRadioAudioMode aAudioMode );

    /**

    * get the currently selected channel index.

    * @since Series 60 3.0

    * @return none

    */

    IMPORT_C TInt GetPresetIndex() const;

    /**

    * Update the channel located at the index to use the frequency specified.

    * @since Series 60 3.0

    * @param aIndex index into the channel array.

    * @param aStationName name of the channel

    * @param aFrequency frequency value to be used.

    * @return none

    */

    IMPORT_C void SetPresetNameFrequencyL( TInt aIndex, const TStationName& aStationName, TInt aFrequency );

    /**

    * Retrieve the channel frequency at the index specified

    * @since Series 60 3.0

    * @param aIndex  index into the channel array.

    * @return the frequency

    */

    IMPORT_C TInt GetPresetFrequencyL(TInt aIndex) const;

    /**

    * Retrieve the channel name at the index specified

    * @since Series 60 3.0

    * @param aIndex  index into the channel array.

    * @return the channel name

    */

    IMPORT_C CRadioEngine::TStationName& GetPresetNameL( TInt aIndex );

    /**

    * Retrieve the channel name and the frequency at the index specified

    * @param aIndex station index

    * @param aName stored station name

    * @param aFrequency preset frequency

    */

    IMPORT_C void GetPresetNameAndFrequencyL( TInt aIndex, TDes& aName, TInt& aFrequency );

    /**

    * Starts the radio.

    * @since Series 60 3.0

    * @return none

    */

    IMPORT_C void RadioOn();

    /**

    * Stops the radio.

    * @since Series 60 3.0

    * @return none

    */

    IMPORT_C void RadioOff();

    /**

     * Returns the radio status

     * @since ??

     * @return ETrue = radio is on, EFalse = radio is off

     */

    IMPORT_C TBool IsRadioOn();

    /**

     * Checks if offine profile is current active profile

     * @since ??

     * @return True / False

     */

    IMPORT_C TBool IsOfflineProfileL();

    /**

    * Tune to the specified frequency

    * @since Series 60 3.0

    * @param aFrequency - frequency to lock onto.

    * @param aRadioMode - The radio mode to be used. Tuner mode by default

    * @return none

    */

    IMPORT_C void Tune( TInt aFrequency, TRadioMode aRadioMode = ERadioTunerMode );

    /*

     * Sets tuner mode on i.e. preset channel is not active.

     * Active preset Channel P&S data is also cleared.

     * Useful for example when preset channel is deleted.

     */

    IMPORT_C void SetTunerModeOn();

    /**

    * Scan up to the next available frequency.

    * @since Series 60 3.0

    * @return none

    */

    IMPORT_C void ScanUp();

    /**

    * Scan down to the last available frequency.

    * @since Series 60 3.0

    * @return none

    */

    IMPORT_C void ScanDown();

    /**

    * Cancel previously requested scan, and

    * return to the already tuned frequency.

    * @since Series 60 3.0

    * @return none

    */

    IMPORT_C void CancelScan();

    /**

    * Sets the audio mute state

    * @since Series 60 3.0

    * @param aMuteOn - flag to determine whether mute should be turned on or off

    * @return none

    */

    IMPORT_C void SetMuteOn(TBool aMuteOn);

    /**

    * Gets the audio mute state

    * @since Series 60 3.0

    * @return ETrue or EFalse to indicate whether mute is currently on.

    */

    IMPORT_C TBool IsMuteOn() const;

    /**

    * Sets the volume level of the FM radio

    * @since Series 60 3.0

    * @param aVolume - the volume to be used.

    * @return none

    */

    IMPORT_C void SetVolume(TInt aVolume);

    /**

    * Gets the volumelevel.

    * @since Series 60 3.0

    * @return the current volume

    */

    IMPORT_C TInt GetVolume() const;

    /**

    * Gets the max volumelevel.

    * @since Series 60 3.0

    * @return the max volume

    */

    IMPORT_C TInt GetMaxVolume() const;

    /**

    * Sets the audio Output

    * @since Series 60 3.0

    * @param aAudioOutput - where should the audio be routed?

    * @return none

    */

    IMPORT_C void SetAudioOutput( const TFMRadioAudioOutput aAudioOutput );

    /**

    * Sets the rds af search enabled

    * @param aEnabled ETrue if rds af search is enabled; EFalse otherwise.

    * @return none

    */

    IMPORT_C void SetRdsAfSearchEnable( TBool aEnabled );

     /**

     * Check whether flight mode is currently enabled

     * @since Series 60 3.0

     * @return ETrue or EFalse dependent on whether flightmode is enabled

     */

     IMPORT_C TBool IsRdsAfSearchEnabled() const;

     /**

      * @return reference to settings

      */

     IMPORT_C TRadioSettings& RadioSettings( );

    /**

    * Retrieve the current audio output

    * @since Series 60 3.0

    * @return EFMRadioOutputIHF or EFMRadioOutputHeadset

    */

    IMPORT_C TFMRadioAudioOutput GetAudioOutput() const;

    /**

    * Tunes to the chosen channel.

    * @since Series 60 3.0

    * @param aIndex - the index number of the channel you wish to tune to.

    * @return none

    */

    IMPORT_C void TunePresetL(TInt aIndex);

    /**

    * Retrieves the current frequency.

    * @since Series 60 3.0

    * @return the frequency

    */

    IMPORT_C TInt GetTunedFrequency() const;

    /**

    * Check whether flight mode is currently enabled

    * @since Series 60 3.0

    * @return ETrue or EFalse dependent on whether flightmode is enabled

    */

    IMPORT_C TBool IsFlightModeEnabled() const;

    /**

    * Get the frequency range (in Hertz) of the specified band.

    * This function should be used to enquire the frequency range

    * of the bands that GetCapabilities reports as supported.

    * @since Series 60 3.0

    * @param aBottomFrequency The variable to set to the lowest frequency allowed

    * @param aTopFrequency The variable to set to the highest frequency allowed

    * @return A standard system error code

    **/

    IMPORT_C TInt GetFrequencyBandRange( TInt& aBottomFrequency, TInt& aTopFrequency );

    /**

    * Check whether call is in progress

    * @since Series 60 3.1

    * @return ETrue or EFalse to indicate whether call is in progress

    */

    IMPORT_C TBool IsInCall() const;

    /**

    * Has the frequency been set by RDS AF search or not.

    *

    * @return ETrue if frequency was set by RDS AF, otherwise EFalse

    */

    IMPORT_C TBool FrequencySetByRdsAf() const;

    /**

    * Getter for RDS receiver

    *

    * @return Reference to CFMRadioRdsReceiver

    */

    IMPORT_C CFMRadioRdsReceiverBase& RdsReceiver();

    /**

    * Notifies UI that the headset button has been pressed

    */

    void HandleHeadsetButtonPress();

    /**

    * Switches the engine into flight mode, and notifies the UI of

    * the change in status.

    */

    void HandleFlightModeEnabled();

    /**

    * Switches the engine out of flight mode, and notifies the UI of

    * the change in status

    */

    void HandleFlightModeDisabled();

    /**

    * Calls the User Interface callback function, indicating the event code and

    * error code.

    */

    void HandleCallback(TInt aEventCode, TInt aErrorCode );

    /**

    * Gets the headset status

    * @return ETrue if headset connected

    */

    IMPORT_C TBool IsHeadsetConnected() const;

    /**

     * From MRadioPlayerObserver.

     * Called when Radio state changed.

     *

     * @since S60 3.2

     * @param aState Radio player state

     * @param aError A standard system error code, only used when aState is ERadioPlayerIdle

     */

    void MrpoStateChange( TPlayerState aState, TInt aError );

    /**

     * From MRadioPlayerObserver.

     * Called when volume changes. This may be caused by other applications.

     *

     * @since S60 3.2

     * @param aVolume Current volume.

     */

    void MrpoVolumeChange( TInt aVolume );

    /**

     * From MRadioPlayerObserver.

     * Called when mute setting changes. This may be caused by other applications.

     *

     * @since S60 3.2

     * @param aMute ETrue indicates audio is muted.

     */

    void MrpoMuteChange( TBool aMute );

    /**

     * From MRadioPlayerObserver.

     * Called when mute setting changes. This may be caused by other applications.

     *

     * Called when balance setting changes. This may be caused by other applications.

     *

     * @since S60 3.2

     * @param aLeftPercentage

     *        Left speaker volume percentage. This can be any value from zero to 100.

     *        Zero value means left speaker is muted.

     * @param aRightPercentage

     *        Right speaker volume percentage. This can be any value from zero to 100.

     *        Zero value means right speaker is muted.

     */

    void MrpoBalanceChange( TInt aLeftPercentage, TInt aRightPercentage );

    /**

     * From MRadioFmTunerObserver.

     * Called when Request for tuner control completes.

     *

     * @since S60 3.2

     * @param aError A standard system error code or FM tuner error (TFmRadioTunerError).

     */

    void MrftoRequestTunerControlComplete( TInt aError );

    /**

     * From MRadioFmTunerObserver.

     * Set frequency range complete event. This event is asynchronous and is received after

     * a call to CRadioFmTunerUtility::SetFrequencyRange.

     *

     * @since S60 3.2

     * @param aError A standard system error code or FM tuner error (TFmRadioTunerError).

     */

    void MrftoSetFrequencyRangeComplete( TInt aError );

    /**

     * From MRadioFmTunerObserver.

     * Set frequency complete event. This event is asynchronous and is received after a call to

     * CRadioFmTunerUtility::SetFrequency.

     *

     * @since S60 3.2

     * @param aError A standard system error code or FM tuner error (TFmRadioTunerError).

     */

    void MrftoSetFrequencyComplete( TInt aError );

    /**

     * From MRadioFmTunerObserver.

     * Station seek complete event. This event is asynchronous and is received after a call to

     * CRadioFmTunerUtility::StationSeek.

     *

     * @since S60 3.2

     * @param aError A standard system error code or FM tuner error (TFmRadioTunerError).

     * @param aFrequency The frequency(Hz) of the radio station that was found.

     */

    void MrftoStationSeekComplete( TInt aError, TInt aFrequency );

    /**

     * From MRadioFmTunerObserver.

     * Called when FM Transmitter status changes (if one is present in the device). Tuner receiver

     * is forced to be turned off due to hardware conflicts when FM transmitter is activated.

     *

     * @since S60 3.2

     * @param aActive ETrue if FM transmitter is active; EFalse otherwise.

     */

    void MrftoFmTransmitterStatusChange( TBool aActive );

    /**

     * From MRadioFmTunerObserver.

     * Called when antenna status changes.

     *

     * @since S60 3.2

     * @param aAttached ETrue if antenna is attached; EFalse otherwise.

     */

    void MrftoAntennaStatusChange( TBool aAttached );

    /**

     * From MRadioFmTunerObserver.

     * Called when offline mode status changes.

     * @since S60 3.2

     *

     * @param aOfflineMode ETrue if offline mode is enabled; EFalse otherwise.

     */

    void MrftoOfflineModeStatusChange( TBool aOfflineMode );

    /**

     * From MRadioFmTunerObserver.

     * Called when the frequency range changes. This may be caused by other applications.

     *

     * @since S60 3.2

     * @param aBand New frequency range.

     */

    void MrftoFrequencyRangeChange(TFmRadioFrequencyRange aBand );