mmlibs/mmfw/inc/mmf/server/mmfdatapathproxy.h
author hgs
Tue, 02 Nov 2010 12:28:51 +0000
changeset 6 fe9d1bf55678
parent 0 b8ed18f6c07b
permissions -rw-r--r--
2010wk46_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     1
// Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     2
// All rights reserved.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     3
// This component and the accompanying materials are made available
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     5
// which accompanies this distribution, and is available
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     7
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     8
// Initial Contributors:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    10
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    11
// Contributors:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    12
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    13
// Description:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    14
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    15
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    16
#ifndef __MMFDATAPATHPROXY_H__
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    17
#define __MMFDATAPATHPROXY_H__
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    18
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    19
#include <e32base.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    20
#include <e32std.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    21
#include <ecom/ecom.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    22
#include <mmf/server/mmfdatapath.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    23
#include <mmf/server/mmfsubthreadbase.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    24
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    25
#define KMMFDataPathProxyVersion TVersion(8,0,0)
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    26
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    27
/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    28
The amount of time that is allowed for the datapath to close down before the its thread is killed.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    29
*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    30
#define  KMMFDataPathProxyShutdownTimeout TTimeIntervalMicroSeconds32(10000000)
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    31
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    32
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    33
/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    34
@publishedAll
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    35
@released
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    36
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    37
Mixin class that the user of the class CMMFDataPathEventMonitor must derive from.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    38
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    39
@since 7.0s
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    40
*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    41
class MMMFDataPathEventMonitorObserver
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    42
	{
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    43
public:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    44
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    45
	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    46
	Handles an event that has been generated by the datapath.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    47
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    48
	Called by CMMFDataPathEventMonitor::RunL().
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    49
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    50
	@param  aEvent
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    51
	        The event to be handled.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    52
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    53
	@since  7.0s
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    54
	*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    55
	virtual void HandleEvent(const TMMFEvent& aEvent) = 0;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    56
	};
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    57
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    58
class RMMFDataPathProxy; //forward reference
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    59
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    60
/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    61
@publishedAll
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    62
@released
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    63
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    64
Active object utility class that can be used to monitor a datapath that is running in its own
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    65
thread for events. If an event occurs, the client will be notified via the
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    66
MMMFDataPathEventMonitorObserver interface.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    67
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    68
@since  7.0s
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    69
*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    70
class CMMFDataPathEventMonitor : public CActive
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    71
	{
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    72
public:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    73
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    74
	IMPORT_C static CMMFDataPathEventMonitor* NewL(MMMFDataPathEventMonitorObserver& aObserver,
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    75
		RMMFDataPathProxy& aMMFDataPathProxy);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    76
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    77
	IMPORT_C ~CMMFDataPathEventMonitor();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    78
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    79
	IMPORT_C void Start();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    80
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    81
	IMPORT_C void RunL();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    82
protected:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    83
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    84
	void DoCancel();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    85
private:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    86
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    87
	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    88
	Constructs a datapath event monitor object.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    89
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    90
	@param  aObserver
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    91
	        A reference to the observer of the active object. The observer will be
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    92
	        notified when an event occurs.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    93
	@param  aMMFDataPathProxy
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    94
	        A reference to the datapath proxy class.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    95
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    96
	@since  7.0s
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    97
	*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    98
	CMMFDataPathEventMonitor(MMMFDataPathEventMonitorObserver& aObserver, 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    99
		RMMFDataPathProxy& aMMFDataPathProxy);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   100
private:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   101
	MMMFDataPathEventMonitorObserver& iObserver;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   102
	RMMFDataPathProxy& iMMFDataPathProxy;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   103
	TMMFEventPckg iEventPckg;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   104
	};
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   105
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   106
/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   107
@publishedAll
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   108
@released
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   109
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   110
Proxy class used to create a datapath in a new subthread.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   111
*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   112
class RMMFDataPathProxy : public RMMFSubThreadBase
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   113
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   114
	{
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   115
public:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   116
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   117
	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   118
	Constuctor.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   119
	*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   120
	RMMFDataPathProxy() : RMMFSubThreadBase(KMMFDataPathProxyShutdownTimeout) {};
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   121
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   122
	IMPORT_C TInt CreateSubThread();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   123
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   124
	IMPORT_C TInt LoadDataPath();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   125
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   126
	IMPORT_C TInt LoadDataPath(TMediaId aMediaId);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   127
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   128
	IMPORT_C TInt LoadDataPath(TUid aCodecUid); 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   129
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   130
	IMPORT_C TInt LoadDataPath(TUid aCodecUid, TMediaId aMediaId);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   131
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   132
	IMPORT_C TInt AddDataSource(MDataSource* aSource);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   133
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   134
	IMPORT_C TInt AddDataSink(MDataSink* aSink);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   135
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   136
	IMPORT_C TInt Prime();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   137
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   138
	IMPORT_C TInt Play();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   139
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   140
	IMPORT_C TInt Pause();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   141
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   142
	IMPORT_C TInt Stop();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   143
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   144
	IMPORT_C TInt GetPosition(TTimeIntervalMicroSeconds& aPosition) const;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   145
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   146
	IMPORT_C TInt SetPosition(const TTimeIntervalMicroSeconds& aPosition);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   147
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   148
	IMPORT_C TInt SetPlayWindow( const TTimeIntervalMicroSeconds& aStart, const TTimeIntervalMicroSeconds& aEnd ) ;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   149
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   150
	IMPORT_C TInt ClearPlayWindow() ;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   151
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   152
	IMPORT_C TInt State( TInt& aState ) ;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   153
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   154
	IMPORT_C void Close();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   155
	};
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   156
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   157
#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   158
#include <mmf/server/mmfdatapathproxyserver.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   159
#endif
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   160
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   161
#endif
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   162