/*

* Copyright (c) 2006 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:      implements playback state machinery for media renderer

*

*/

#ifndef C_UPNPPLAYBACKSESSION_H

#define C_UPNPPLAYBACKSESSION_H

// INCLUDE FILES

// System

#include <e32base.h>

// upnp stack api

#include <upnpavcontrolpointobserver.h>

// upnpframework / avcontroller api

#include "upnpavcontroller.h"

#include "upnpavrenderingsessionobserver.h"

// FORWARD DECLARATIONS

class MUPnPAVMediaObserver;

class CUpnpItem;

class CUpnpObject;

class CUPnPFileSharingActive;

class RUpnpMediaServerClient;

class CUpnpAVRequest;

class CUpnpAVDeviceExtended;

class TUnsolicitedEventC;

class CUPnPXMLEventParser;

class CUpnpAVControllerServer;

class CUpnpAttribute;

class CUpnpAVControlPoint;

class CUPnPPeriodic;

/**

 * Implements the server side playback session. Provides functionality to

 * Set URI/Next URI, control playback and to get position info.

 *

 * @since S60 v3.1

 */

class CUPnPPlaybackSession :    public CBase,

                                public MUpnpAVControlPointObserver

    {

private:

    /**

     * Defines current playback state.

     */

    enum TPlaybackState

        {

        EUninitialized = 0,

        EStopped,

        EPlaying,

        EPaused,

        EPlaySent

        };

    enum TMuteState

        {

        EUnknown    = -1,

        ENotMuted   = 0,

        EMuted      = 1

        };    

public:

    /**

     * Static 1st phase constructor.

     *

     * @param aControlPoint AV Control Point reference

     * @param aClient S60 Media Server session reference

     * @param aDispatcher observer callback disparcher reference

     * @param aRepository device repository

     * @param aSessionId session id

     * @param aUuid device Uuid

     * @return new instance

     */

    static CUPnPPlaybackSession* NewL

        (

        RUpnpMediaServerClient& aClient,

        CUpnpAVControllerServer& aServer,

        TInt aSessionId,   

        const TDesC8& aUuid

        );

    /**

     * Destructor

     */

    virtual ~CUPnPPlaybackSession();

private:

    /**

     * Private constructor.

     *

     * @param aControlPoint AV Control Point reference

     * @param aClient S60 Media Server session reference

     * @param aDispatcher observer callback disparcher reference

     * @param aRepository device repository

     * @param aSessionId session id

     * @param aUuid device Uuid

     */

    CUPnPPlaybackSession

        (

        RUpnpMediaServerClient& aClient,

        CUpnpAVControllerServer& aServer,

        TInt aSessionId

        );    

    /**

     * 2nd phase construct

     *

     * @param aUuid device Uuid

     */

    void ConstructL( const TDesC8& aUuid );

protected: // From MUpnpAVControlPointObserver

    /**

     * Observer callback for rendering control Set Volume.

     * @since Series 60 2.6

     * @param aUuid Source device UUID. 

     * @param aSessionId 

     * @param aErr UPnP error code.

     * @param aInstance rendering instance.

     * @param aChannel audio channel.

     * @param aDesiredVolume 

     */

    void RcSetVolumeResponse(

        const TDesC8& aUuid,

        TInt aSessionId,

        TInt aErr, 

        const TDesC8& aInstance, 

        const TDesC8& aChannel, 

        const TDesC8& aDesiredVolume);

    /**

     * Observer callback for rendering control Get Volume.

     * @since Series 60 2.6

     * @param aUuid Source device UUID. 

     * @param aSessionId 

     * @param aErr UPnP error code.

     * @param aInstance rendering instance.

     * @param aChannel audio channel.

     * @param aCurrentVolume 

     */

    void RcVolumeResponse(

        const TDesC8& aUuid,

        TInt aSessionId,

        TInt aErr, 

        const TDesC8& aInstance, 

        const TDesC8& aChannel, 

        const TDesC8& aCurrentVolume);

    /**

     * Observer callback for rendering control Set Mute.

     * @since Series 60 2.6

     * @param aUuid Source device UUID. 

     * @param aSessionId 

     * @param aErr UPnP error code.

     * @param aInstance rendering instance.

     * @param aChannel audio channel.

     * @param aDesiredMute 

     */

    void RcSetMuteResponse(

        const TDesC8& aUuid,

        TInt aSessionId,

        TInt aErr, 

        const TDesC8& aInstance, 

        const TDesC8& aChannel, 

        const TDesC8& aDesiredMute);

    /**

     * Observer callback for rendering control Get Mute.

     * @since Series 60 2.6

     * @param aUuid Source device UUID. 

     * @param aSessionId 

     * @param aErr UPnP error code.

     * @param aInstance rendering instance.

     * @param aChannel audio channel.

     * @param aCurrentMute 

     */

    void RcMuteResponse(

        const TDesC8& aUuid,

        TInt aSessionId,

        TInt aErr, 

        const TDesC8& aInstance, 

        const TDesC8& aChannel, 

        const TDesC8& aCurrentMute); 

    /**

     * Observer callback for rendering control AV set transport uri.

     * @since Series 60 2.6

     * @param aUuid Source device UUID. 

     * @param aSessionId 

     * @param aErr UPnP error code.

     * @param aInstance rendering instance.

     * @param aCurrentUri Current transport URI.

     * @param Current transport URI Metadata. 

     */

    void AvtSetTransportUriResponse(

        const TDesC8& aUuid,

        TInt aSessionId,

        TInt aErr,

        const TDesC8& aInstanceId,

        const TDesC8& aCurrentUri,

        const TDesC8& aCurrentUriMetaData);

    /**

     * Observer callback for rendering control AV set next transport uri.

     * @since Series 60 2.6

     * @param aUuid Source device UUID. 

     * @param aSessionId 

     * @param aErr UPnP error code.

     * @param aInstance rendering instance.

     * @param aCurrentUri Current transport URI.

     * @param Current transport URI Metadata. 

     */

    virtual void AvtSetNextTransportUriResponse(

        const TDesC8& aUuid,

        TInt aSessionId,

        TInt aErr,

        const TDesC8& aInstanceId,

        const TDesC8& aNextUri,

        const TDesC8& aNextUriMetaData);

    /**

     * Observer callback for rendering control AV get media info response.

     * @since Series 60 2.6

     * @param aUuid Source device UUID. 

     * @param aSessionId 

     * @param aErr UPnP error code.

     * @param aInstance rendering instance.

     * @param aNrTracks Number of tracks.

     * @param aMediaDuration 

     * @param aCurrentUri Current transport URI.

     * @param aCurrentUriMetaData Metadata of current trransport uri. 

     * @param aNextUri Next transport URI.

     * @param aNextUriMetaData Metadata of next trransport uri.

     * @param aPlayMedium

     * @param aRecordMedium

     * @param aWriteStatus

     */

    void AvtMediaInfoResponse(

        const TDesC8& aUuid,

        TInt aSessionId,

        TInt aErr,

        const TDesC8& aInstanceId,

        const TDesC8& aNrTracks,

        const TDesC8& aMediaDuration,

        const TDesC8& aCurrentUri,

        const TDesC8& aCurrentUriMetaData,

        const TDesC8& aNextUri,

        const TDesC8& aNextUriMetaData,

        const TDesC8& aPlayMedium,

        const TDesC8& aRecordMedium,

        const TDesC8& aWriteStatus);

    /**

     * Observer callback for rendering control AV get transport info response.

     * @since Series 60 2.6

     * @param aUuid Source device UUID. 

     * @param aSessionId

     * @param aErr UPnP error code.

     * @param aInstance rendering instance.

     * @param aCurrenTransportState

     * @param aCurrentTransportStatus

     * @param aCurrentUri aCurrentSpeed

     */

    void AvtGetTransportInfoResponse(

        const TDesC8& aUuid,

        TInt aSessionId,

        TInt aErr,

        const TDesC8& aInstanceId,

        const TDesC8& aCurrenTransportState,

        const TDesC8& aCurrentTransportStatus,

        const TDesC8& aCurrentSpeed);

    /**

     * Observer callback for rendering control AV get position info response.

     * @since Series 60 2.6

     * @param aUuid Source device UUID. 

     * @param aSessionId 

     * @param aErr UPnP error code.

     * @param aTrack rendering instance.

     * @param aTrackDuration 

     * @param aTrackMetaData

     * @param aTrackURI

     * @param aRelTime

     * @param aAbsTime

     * @param aRelCount

     * @param aAbsCount

     */

    void AvtPositionInfoResponse(

        const TDesC8& aUuid,

        TInt aSessionId,

        TInt aErr,

        const TDesC8& aInstanceId,

        const TDesC8& aTrack,

        const TDesC8& aTrackDuration,

        const TDesC8& aTrackMetaData,

        const TDesC8& aTrackURI,

        const TDesC8& aRelTime,

        const TDesC8& aAbsTime,

        const TDesC8& aRelCount,

        const TDesC8& aAbsCount);

    /**

     * Observer callback for rendering control AV get device

     * capabilities response.

     * @since Series 60 2.6

     * @param aUuid Source device UUID. 

     * @param aSessionId 

     * @param aErr UPnP error code.

     * @param aPlayMedia

     * @param aRecMedia 

     * @param aRecQualityModes

     */

    void AvtDeviceCapabilitiesResponse(

        const TDesC8& aUuid,

        TInt aSessionId,

        TInt aErr,

        const TDesC8& aInstanceId,

        const TDesC8& aPlayMedia,

        const TDesC8& aRecMedia,

        const TDesC8& aRecQualityMode);

    /**

     * Observer callback for rendering control AV get transport

     * settings response.

     * @since Series 60 2.6

     * @param aUuid Source device UUID. 

     * @param aSessionId

     * @param aInstanceId

     * @param aErr UPnP error code.        

     * @param aPlayMode

     * @param aRecQualityMode

     */

    void AvtTransportSettingsResponse(

        const TDesC8& aUuid,

        TInt aSessionId,

        TInt aErr,

        const TDesC8& aInstanceId,

        const TDesC8& aPlayMode,

        const TDesC8& aRecQualityMode);

    /**

     * Observer callback for rendering control AV Stop response.

     * @since Series 60 2.6

     * @param aUuid Source device UUID. 

     * @param aSessionId 

     * @param aErr UPnP error code.

     */

    void AvtStopResponse(

        const TDesC8& aUuid,

        TInt aSessionId,

        TInt aErr,

        const TDesC8& aInstanceId);

    /**

     * Observer callback for rendering control AV Play response.

     * @since Series 60 2.6

     * @param aUuid Source device UUID. 

     * @param aSessionId 

     * @param aErr UPnP error code.

     * @param aSpeed

     */

    void AvtPlayResponse(

        const TDesC8& aUuid,

        TInt aSessionId,

        TInt aErr,

        const TDesC8& aInstanceId,

        const TDesC8& aSpeed);

    /**

     * Observer callback for rendering control AV Pause response.

     * @since Series 60 2.6

     * @param aUuid Source device UUID. 

     * @param aSessionId 

     * @param aErr UPnP error code.

     */

    void AvtPauseResponse(

        const TDesC8& aUuid,

        TInt aSessionId,

        TInt aErr,

        const TDesC8& aInstanceId);

    /**

     * Observer callback for rendering control AV Record response.

     * @since Series 60 2.6

     * @param aUuid Source device UUID. 

     * @param aSessionId 

     * @param aErr UPnP error code.

     */

    void AvtRecordResponse(

        const TDesC8& aUuid,

        TInt aSessionId,

        TInt aErr,

        const TDesC8& aInstanceId);

    /**

     * Observer callback for rendering control AV Seek response.

     * @since Series 60 2.6

     * @param aSessionId 

     * @param aErr UPnP error code.

     * @param aUnit

     * @param aTarget

     */

    void AvtSeekResponse(

        const TDesC8& aUuid,

        TInt aSessionId,

        TInt aErr,

        const TDesC8& aInstanceId,

        const TDesC8& aUnit,

        const TDesC8& aTarget);

    /**

     * Observer callback for rendering control AV Next response.

     * @since Series 60 2.6

     * @param aUuid Source device UUID. 

     * @param aSessionId 

     * @param aErr UPnP error code.

     */

    void AvtNextResponse(

        const TDesC8& aUuid,

        TInt aSessionId,

        TInt aErr,

        const TDesC8& aInstanceId);

    /**

     * Observer callback for rendering control AV Previous response.

     * @since Series 60 2.6

     * @param aUuid Source device UUID. 

     * @param aSessionId 

     * @param aErr UPnP error code.

     */

    void AvtPreviousResponse(

        const TDesC8& aUuid,

        TInt aSessionId,

        TInt aErr,

        const TDesC8& aInstanceId);

    /**

     * Observer callback for rendering control AV setplay mode response.

     * @since Series 60 2.6

     * @param aUuid Source device UUID. 

     * @param aSessionId 

     * @param aErr UPnP error code.

     * @param aNewPlayMode

     */

    void AvtSetPlayModeResponse(

        const TDesC8& aUuid,

        TInt aSessionId,

        TInt aErr,

        const TDesC8& aInstanceId,

        const TDesC8& aNewPlayMode);

    /**

     * Observer callback for rendering control AV set record qualityresponse.

     * @since Series 60 2.6

     * @param aUuid Source device UUID. 

     * @param aSessionId 

     * @param aErr UPnP error code.

     * @param aNewRecordQuality

     */

    void AvtSetRecordModeResponse(

        const TDesC8& aUuid,

        TInt aSessionId,

        TInt aErr,

        const TDesC8& aInstanceId,

        const TDesC8& aNewRecordQuality);

    /**

     * Observer callback for Content Directory GetSearchCapabilities function.

     * @since Series 60 2.6

     * @param aUuid Source device UUID. 

     * @param aSessionId 

     * @param aErr UPnP error code.

     * @param aSearchCaps

     */

    void CdsSearchCapabilitiesResponse(

        const TDesC8& aUuid,

        TInt aSessionId,

        TInt aErr,

        const TDesC8& aSearchCaps);

    /**

     * Observer callback for Content Directory GetSortCapabilities function.

     * @since Series 60 2.6

     * @param aUuid Source device UUID. 

     * @param aSessionId 

     * @param aErr UPnP error code.

     * @param aSortCaps

     */

    void CdsSortCapabilitiesResponse(

        const TDesC8& aUuid,

        TInt aSessionId,

        TInt aErr,

        const TDesC8& aSortCaps);

    /**

     * Observer callback for Content Directory GetSystemUpdateID function.

     * @since Series 60 2.6

     * @param aSessionId 

     * @param aErr UPnP error code.

     * @param aSystemUpdateId

     */

    void CdsSystemUpdateIdResponse(