FCL/sf/app/mmsharinguis: comparison mmsharing/mmshengine/inc/musengmcesession.h

equal deleted inserted replaced

-:73a1feb507fb
+:bc78a40cd63c
 * Description:
 *
 */
-#ifndef MUSENGMCESESSION_H
+#ifndef MUSHENGMCESESSION_H
-#define MUSENGMCESESSION_H
+#define MUSHENGMCESESSION_H
 // USER
+#include "musengsession.h"
 #include "musengsessiondurationtimerobserver.h"
 #include "musunittesting.h"
 #include "mussipprofileuser.h"
-#include "musengdisplayhandler.h"
-#include "musengaudioroutingobserver.h"
 // SYSTEM
-#include <lcsession.h>
-#include <lcaudiocontrol.h>
 #include <mcesessionobserver.h>
 #include <mceinsessionobserver.h>
 #include <mcestreamobserver.h>
 #include <mcertpobserver.h>
 #include <mcetransactiondatacontainer.h>
-#include <mcemediasource.h>
-// FORWARD DECLARATIONS
 class CMceManager;
 class CMceSession;
 class CMceVideoStream;
 class CMceAudioStream;
 class CMceVideoCodec;
 class CMceAudioCodec;
 class CMusEngSessionDurationTimer;
+class MMusEngSessionObserver;
 class CMusSipProfileHandler;
-class CMusEngTelephoneUtils;
-class MMusEngAudioRoutingObserver;
-class MLcSessionObserver;
 // CONSTANTS
 _LIT8( KMusEngAcceptContactHeader,
 "Accept-Contact: *;+g.3gpp.cs-voice; explicit" );
 _LIT8( KMusAcceptHeader,
 "Accept: application/sdp" );
 _LIT8( KMusEngSessionSdpLineXApplication, "a=X-application:com.nokia.rtvs\r\n" );
 _LIT8( KMusEngSessionSdpLineApplication , "a=application:com.gsma.rts\r\n" );
 _LIT8( KMusEngSessionSdpLineType, "a=type:videolive\r\n" );
-_LIT8( KMusEngSessionSdpLineBandwidthLine  , "b=AS:" );
+_LIT8( KMusEngSessionSdpLineBandwidthLine  , "b=AS" );
 _LIT8( KMusEngSessionSdpLineBandwidthField  , "b=AS:85\r\n" );
-_LIT8( KMusEngSessionSdpLineTiasLine  , "b=TIAS:" );
 _LIT8( KMusPPreferredIdentity, "P-Preferred-Identity" );
-_LIT8( KMusEngNewLine  , "\r\n" );
+_LIT8( KMusPrivacyHeader, "Privacy" );
+_LIT8( KMusAnonymousHeader, "\"Anonymous\" <sip:anonymous@anonymous.invalid>" );
-const TInt KMusTiasMultiplier = 1000;
-const TUint8 KMusEngRtpKeepAliveTimer = 5;
+const TInt KMusEngMaxVolume = 10;
-const TUint8 KMusEngKeepAlivePayloadTypeVideoH263 = 96;
+const TInt KMusEngMinVolume = 0;
-const TUint8 KMusEngKeepAlivePayloadTypeAudio = 97;
-const TUint8 KMusEngKeepAlivePayloadTypeVideoAvc = 98;
-// Value for uninitialized rect
-const TInt KMusEngRectNotInit = 1000;
 // CLASS DECLARATION
 /**
 * Base class for Multimedia Sharing Engine MCE sessions, inherited by
 * MCE Sessions to user interface. Also splits observers messy events
 * to simplified function calls.
 *
 * @lib musengine.lib
 */
-class CMusEngMceSession : public CBase,
+class CMusEngMceSession : public CMusEngSession,
-public MLcSession,
-public MLcAudioControl,
 public MMceSessionObserver,
 public MMceInSessionObserver,
 public MMceStreamObserver,
 public MMceRtpObserver,
 public MMusEngSessionDurationTimerObserver,
-public MMusSipProfileUser,
+public MMusSipProfileUser
-public MMusEngDisplayHandler,
-public MMusEngAudioRoutingObserver
 {
+public:
+/*
+* Defines possible rotations
+*/
+enum TDisplayOrientation
+{
+EPortrait, // Normal
+ELandscape // 90 degree's clockwise rotation
+};
 public:
 /**
 * Destructor
 */
 ~CMusEngMceSession();
-public: //  from MMusEngDisplayHandler
+public: // API FUNCTIONS
 /**
-* Returns currently assigned drawing area
+* Terminates session.
 *
-* @return TRect This session drawing area rectangle
+* @pre Session is established
-*/
+* @post Session is ready to be deleted
-TRect Rect() const;
+* @leave KErrNotReady if precondition is not fullfilled
+*/
-/**
+IMPORT_C void TerminateL();
-* Sets new drawing area
-*
+/**
-* @param TRect This session new drawing area rectangle
+* Get session time return estabilished session time
-*/
+*
-void SetRectL( const TRect& aRect );
+* @return TTime returns time if connection established else < 0
+*/
-/**
+IMPORT_C TTimeIntervalSeconds GetSessionTime() const;
-* Sets secondary rect (e.g. viewfinder in twoway session)
-* @param TRect This session new secondary drawing area rectangle
+/**
-*/
+* Returns current connection state
-void SetSecondaryRectL( const TRect& aSecondaryRect );
+*
+* @return TBool returns current connection state
-/**
+*/
-* Gets secondary rect.
+IMPORT_C TBool ConnectionActive() const;
-* @return TRect This session secondary drawing area rectangle
-*/
+/**
-virtual TRect SecondaryRect() const;
+* Returns presence or absence of audio in session.
+*
+* @pre Session is ongoing
+* @return ETrue if session contains audio.
+* @leave KErrNotReady if precondition is not fullfilled
+*/
+IMPORT_C TBool ContainsAudioL();
+/**
+* Returns state of local playback meaning if playback is muted or not.
+*
+* @pre Session is ongoing
+* @return ETrue if session does not contain audio or contained
+*         audio is muted.
+* @leave KErrNotReady if precondition is not fullfilled
+*/
+IMPORT_C TBool IsMutedL();
 /**
 * Returns current display orientation.
 *
 * @pre Session is ongoing
 * @return Current display orientation
 * @leave KErrNotReady if precondition is not fullfilled
 */
-TDisplayOrientation OrientationL();
+IMPORT_C TDisplayOrientation OrientationL();
 /**
 * Sets display orientation.
 *
 * @pre Session is ongoing
 * @return Sets display orientation
 * @leave KErrNotReady if precondition is not fullfilled
 */
-void SetOrientationL( TDisplayOrientation aOrientation );
+IMPORT_C void SetOrientationL( TDisplayOrientation aOrientation );
+/**
+* Returns state of the screen device.
+*
+* @pre Session is ongoing
+*/
+IMPORT_C TBool IsDisplayEnabledL();
+public: // VIRTUAL API
+// No virtual api
+public: //  from CMusEngSession
+/**
+* Increases volume level by one
+*
+* @pre Session is ongoing
+*/
+IMPORT_C void VolumeUpL();
+/**
+* Decreases volume level by one
+*
+* @pre Session is ongoing
+*/
+IMPORT_C void VolumeDownL();
+/**
+* Set volume value
+* @pre Session is ongoing
+* @param aVal the value of volume
+*/
+IMPORT_C void SetVolumeL( TInt aVal );
 /**
 * Permission to draw on screen device.
 *
 * @pre Session is ongoing
 */
-void EnableDisplayL( TBool aEnable );
+IMPORT_C void EnableDisplayL( TBool aEnable );
 /**
-* Implements virtual from MMusEngDisplayHandler
+* Implements virtual from CMusEngSession
 *
 * @pre Session is ongoing
 */
-TBool IsDisplayEnabled();
+IMPORT_C void MuteL();
 /**
-* Implements virtual from MMusEngDisplayHandler
+* Implements virtual from CMusEngSession
 *
 * @pre Session is ongoing
 */
-TBool IsDisplayActive();
+IMPORT_C void UnmuteL();
+void RefreshOrientationL();
-public: // From MMusEngAudioRoutingObserver
-void AudioRoutingChanged();
-public: // From MLcSession
-virtual TLcSessionState LcSessionState() const;
-void SetLcSessionObserver( MLcSessionObserver* aObserver );
-void SetLcUiProvider( MLcUiProvider* aUiProvider );
-virtual MLcVideoPlayer* RemoteVideoPlayer();
-virtual MLcVideoPlayer* LocalVideoPlayer();
-virtual const TDesC& LocalDisplayName();
-virtual const TDesC& RemoteDisplayName();
-TInt SetParameter( TInt aId, TInt aValue );
-TInt ParameterValue( TInt aId );
-TBool IsBackgroundStartup();
-TInt SetForegroundStatus( TBool aIsForeground );
-const TDesC& RemoteDetails();
-void UpdateLcSessionL();
-TBool SendDialTone( TChar aKey);
-public: // From MLcAudioControl
-TBool IsLcAudioMutedL();
-void MuteLcAudioL( TBool aMute );
-TBool IsLcMicMutedL();
-void MuteLcMicL( TBool aMute );
-TBool IsEnablingLcLoudspeakerAllowed();
-void EnableLcLoudspeakerL( TBool aEnabled );
-TBool IsLcLoudspeakerEnabled();
-TInt LcVolumeL();
-void SetLcVolumeL( TInt aValue );
-void IncreaseLcVolumeL();
-void DecreaseLcVolumeL();
-public:
-MLcSessionObserver* LcSessionObserver();
-MLcUiProvider* LcUiProvider();
 protected: // CONSTRUCTORS
 /**
 * Constructor
 *
 */
-CMusEngMceSession();
+CMusEngMceSession( const TRect& aRect,
+MMusEngSessionObserver& aSessionObserver );
 /**
 * Second-phase constructor
+*
 */
 void ConstructL();
 protected: // VIRTUAL HELPER FUNCTIONS
 /**
 * Sets Multimediasharing specific video codec settings. This functions
 * gets called for every video codec in session. To be overridden in
 * sibling classes if needed.
 */
-virtual void AdjustVideoCodecL( CMceVideoCodec& aVideoCodec,
+virtual void AdjustVideoCodecL( CMceVideoCodec& aVideoCodec );
-TMceSourceType aSourceType );
 /**
 * Sets Multimediasharing specific audio codec settings like audio MMF
 * priority and preference. This functions gets called for every audio
 * codec in session. To be overridden in sibling classes if needed.
 * Additionally selects just the one with best quality from selected mode.
 * @param aVideoStream
 */
 virtual void DoCodecSelectionL( CMceVideoStream& aVideoStream );
-virtual void RectChangedL();
 protected: // HELPER FUNCTIONS
-void InformObserverAboutSessionStateChange();
+/**
+*
-void InformObserverAboutSessionUpdate();
+*/
+void RectChangedL();
-void InformObserverAboutSessionFailure( TInt aReason );
-void InformObserverAboutPlayerStateChange( MLcVideoPlayer* aPlayer );
-void InformObserverAboutPlayerUpdate( MLcVideoPlayer* aPlayer );
-void InformObserverAboutPlayerFailure(
-MLcVideoPlayer* aPlayer,
-TInt aReason );
-void InformUiProviderAboutReceivingStart();
-MLcUiProvider& LcUiProviderL();
 /**
 * Sets session specific SDP lines to a session.
 */
 void SetSessionSdpLinesL( CMceSession& aSession,
 * Calls CMceInSession::RejectL() inside TRAP_IGNORE
 */
 void Reject( CMceInSession& aSession,
 const TDesC8& aReason = KNullDesC8(),
 TUint32 aCode = 0 );
-void SaveContactL( const TDesC8& aAddress );
+protected:  // from CMusEngSession
+/**
+*
+*/
+void VolumeChanged( TInt aVolume, TBool aAudioRouteChanged );
 protected: // from MMceInSessionObserver
 /**
 * Incoming session invitation. The CMceInSession is given to the
 * application as a callback. This default implementation rejects
 * @param aSsrc removed SSRC identifier
 */
 void SsrcRemoved( CMceMediaStream& aStream,
 CMceRtpSource& aSource,
 TUint aSsrc );
+	private: // from MMusSipProfileUser
-private: // from MMusSipProfileUser
+TBool IsRoamingBetweenAPsAllowed();
-virtual TBool IsRoamingBetweenAPsAllowed();
-virtual void ProfileRegistered();
 private: // HELPER FUNCTIONS
-/**
-* Adds b=AS and b=TIAS lines to the array
-*/
-void AddSdpBandwidthAttributesL( CDesC8Array& aSdpLinesArray,
-TInt aBandwidthAs );
-/**
-* Checks whether AS or TIAS bandwidth attributes present in the array
-*/
-TBool IsBandwidthAttributeSet( MDesC8Array* aSdpLinesArray );
 /**
 * Callback
 */
 void UpdateTimerEvent();
 void DoBitrateBasedRemovalL( CMceVideoStream& aVideoStream,
 const CMceVideoCodec& aBestBitrateVideoCodec );
 void DoCodecModeBasedRemovalL( CMceVideoStream& aVideoStream );
+/**
-/**
+* This function currently used to remove the AVC codec support based on
-* Get session time return estabilished session time
+* cenrep encoder device uid value.
-* @return TTime returns time if connection established else < 0
-*/
-TTimeIntervalSeconds GetSessionTime() const;
-protected:
-/**
-* Reads from CenRep and sets encoding device for a codec.
-*/
-void SetEncodingDeviceL( CMceVideoCodec& aVideoCodec );
-/**
-* Sets configuration key for a codec
-*/
-void SetCodecConfigKeyL( CMceVideoCodec& aVideoCodec );
-/**
-* Reads proper configuration key for a codec. NULL if not available.
-* Ownership is transferred.
-*/
-HBufC8* ReadCodecConfigKeyL( const CMceVideoCodec& aVideoCodec ) const;
-/**
-* Constructs and stores to cenrep a concatenation of all AVC config keys.
-*/
-void StoreEncoderConfigInfoL() const;
-/**
-* Returns config key id for the provided codec. Ownership is transferred
-*/
-const TPtrC8 ConfigKeyIdL( const CMceVideoCodec& aVideoCodec ) const;
-protected: // Data
-/**
-* Drawing area rect.
-*/
-TRect iRect;
-/**
-* Telephone utilities.
-*/
-CMusEngTelephoneUtils* iTelephoneUtils;
-/**
-* UID used to identify application, needed to create MCE manager
 */
-TUid iMceManagerUid;
+void DoCodecConfigurationBasedRemovalL( CMceVideoStream& aVideoStream );
+protected: // MEMBERS
+/**
+* Callback reference to session observer interface.
+*/
+MMusEngSessionObserver& iSessionObserver;
 /**
 * Class for connecting to MCE server.
 * This class provides the connection to the MCE server and
 * provides functions
 /**
 * ETrue if operator specific behavior is expected
 */
 TBool iOperatorVariant;
-/**
+		/**
 * The handler for the SIP profile related to this session
 */
 CMusSipProfileHandler* iSipProfileHandler;
-/**
+private:
-* Session state for MLcSession
-*/
-MLcSession::TLcSessionState iLcSessionState;
-/**
-* If true, configuration key of current AVC codec must be written to
-* CenRep after session establishment.
-*/
-TBool iStoreEncoderConfigInfo;
-/**
-* Remote details
-*/
-HBufC* iRemoteDetails;
-private: // New functions
-void StreamStreaming( CMceMediaStream& aStream );
-private: // Data
-/**
-* The session observer, if present.
-*/
-MLcSessionObserver* iLcSessionObserver;
-/**
-* The UI provider, if present.
-*/
-MLcUiProvider* iLcUiProvider;
 /**
 * It is assumed, that user has only one instance of this class.
 * The same instance is passed between MCE and user, but the data
 * inside of this container is just updated for each event.
 */
 /**
 * Session time. Acts simultaneously as RTCP inactivity timer.
 */
 TTime iStartTime;
-CMusEngSessionDurationTimer* iUpdateTimer;
+CMusEngSessionDurationTimer*   iUpdateTimer;
 /**
 * Value indicating seconds gone since last received RTCP sender or
 * receiver report. Value 20 indicates RTCP inactivity timeout.
 */
 /**
 * Value indicating if speaker is explicitly muted instead of
 * muted as part of disabling bundled display sink
 */
 TBool iExplicitlyMuted;
-/**
-* Value indicates whether session was started in background mode.
-* (see IsBackgroundStartup()). Once application comes to foreground,
-* iBackground is set to EFalse
-*/
-TBool iBackground;
 MUS_UNITTEST( UT_CMusEngSession )
 MUS_UNITTEST( UT_CMusEngMceSession )
 MUS_UNITTEST( UT_CMusEngReceiveSession )
-MUS_UNITTEST( UT_CMusEngSessionManager )
 };
-#endif // MUSENGMCESESSION_H
+#endif //MUSHENGMCESESSION_H

branch	RCL_3
changeset 33	bc78a40cd63c
parent 32	73a1feb507fb