devsound/devsoundrefplugin/src/platsec/server/AudioServer/MmfDevSoundServer.h
author hgs
Wed, 13 Oct 2010 12:08:48 +0100
changeset 3 28bdc4aca325
parent 0 79dd3e2336a0
permissions -rw-r--r--
2010wk42_01
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     1
// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     2
// All rights reserved.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     3
// This component and the accompanying materials are made available
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     5
// which accompanies this distribution, and is available
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     7
//
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     8
// Initial Contributors:
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    10
//
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    11
// Contributors:
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    12
//
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    13
// Description:
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    14
//
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    15
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    16
#ifndef __MMFDEVSOUNDSERVER_H__
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    17
#define __MMFDEVSOUNDSERVER_H__
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    18
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    19
#include <e32base.h>
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    20
#include <e32def.h>
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    21
#include <e32std.h>
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    22
#include <mmf/common/mmfipc.h>
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    23
#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    24
#include <mmf/common/mmfipcserver.h>
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    25
#endif
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    26
#include "MmfAudioServer.h"
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    27
#include "MmfDevSoundServerStart.h"
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    28
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    29
/** 
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    30
Panic category and codes that MmfDevSoundServer raises on the client
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    31
@internalTechnology
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    32
*/
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    33
_LIT(KMMFDevSoundClientPanicCategory, "DevSoundClient");
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    34
enum TMMFDevSoundClientPanicCodes
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    35
	{
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    36
	EMMFDevSoundPlayDataWithoutInitialize,
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    37
	EMMFDevSoundRecordDataWithoutInitialize
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    38
	};
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    39
	
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    40
class CMMFDevSoundServer; // declared here.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    41
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    42
NONSHARABLE_CLASS( CMMFDevSoundServer ): public CMmfIpcServer
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    43
/**
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    44
*@internalTechnology
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    45
*/
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    46
	{
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    47
public:
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    48
	IMPORT_C static CMMFDevSoundServer* NewL(CMMFAudioServer* aAudioServer, TProcessId& aClientPID);
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    49
	~CMMFDevSoundServer();
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    50
	CMmfIpcSession* NewSessionL(const TVersion &aVersion) const;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    51
	void IncrementSessionId();
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    52
	void DecrementSessionId();
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    53
	void SendEventToClient(TInt aSessionToAlert, TInt aSessionToBeLaunched);
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    54
	void LaunchRequest(TInt aSessionId);
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    55
	TInt DevSoundSessionId() {return iDevSoundSessionId;};
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    56
	TBool CheckClientCapabilities();
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    57
	void SetClientCapabilitiesL(TThreadId aTid);
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    58
	
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    59
	IMPORT_C static TInt StartThread(TAny* aParams);
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    60
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    61
private:
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    62
    
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    63
    CMMFDevSoundServer(CMMFAudioServer* aAudioServer, TProcessId& aClientPID);
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    64
	void ConstructL();
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    65
	static void RenamePrioritizeServer();
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    66
	static void StartThreadL(TDevSoundServerStart& aStart);
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    67
	class CDelayDevSoundShutDown : public CActive
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    68
        {
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    69
    public:
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    70
        // Construct/destruct
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    71
        static CDelayDevSoundShutDown* NewL();
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    72
        ~CDelayDevSoundShutDown(); 
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    73
        // Request
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    74
        void SetDelay(TTimeIntervalMicroSeconds32 aDelay);   
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    75
    private:
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    76
        // Construct/destruct
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    77
        CDelayDevSoundShutDown();
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    78
        void ConstructL();
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    79
    
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    80
        // From CActive
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    81
        void RunL();
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    82
        void DoCancel();   
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    83
    private:
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    84
        RTimer iTimer;      // Has
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    85
        };
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    86
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    87
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    88
private:
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    89
	TInt iDevSoundSessionId;	
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    90
	TInt iSessionToBeLaunched;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    91
	TProcessId iClientPID;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    92
	TBool iClientHasCaps;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    93
	CDelayDevSoundShutDown* iDelayDevSoundShutDown;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    94
	CMMFAudioServer* iAudioServer;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    95
	};
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    96
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    97
GLDEF_C void PanicClient(const RMmfIpcMessage& aMessage, TMMFDevSoundClientPanicCodes aPanicCode);
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    98
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    99
/**
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   100
@SYMPatchable
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   101
@publishedPartner
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   102
 
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   103
Patchable constant for licencee to set devsound server thread priority
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   104
Licencees should ensure that the devsound server thread priority is equal to the system server priority for better responsiveness.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   105
If SYMBIAN_CURB_SYSTEMSERVER_PRIORITIES is defined, setting devsound server thread priority to EPriorityAbsoluteHigh will ensure
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   106
devsound server's thread priority is set to system server's priority.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   107
If the macro is unavailable it is recommended to use EPriorityAbsoluteRealTime1. Usage of EPriorityAbsoluteRealTime1 requires ProtServ capability.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   108
The constant can be changed at ROM build time using patchdata OBY keyword.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   109
 */
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   110
IMPORT_C extern const TInt KDevsoundServerPriority;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   111
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   112
#endif