mmhais/refacladapt/src/shared/audiostreamadaptation.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) 2006-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 AUDIOSTREAMADAPTATION_H
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    17
#define AUDIOSTREAMADAPTATION_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 <ecom/ecom.h>
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    21
#include <badesca.h>
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    22
#include <a3f/a3fbase.h>
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    23
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    24
/**
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    25
@publishedAll
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    26
@released
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    27
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    28
Implementation of the Audio Component Version
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    29
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    30
*/
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    31
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    32
class TAudioComponentInfo
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    33
	{
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    34
	TInt iVersion;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    35
	};
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    36
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    37
/**
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    38
@publishedAll
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    39
@released
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    40
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    41
Implementation of the Stream Adaptation
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    42
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    43
*/
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    44
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    45
class MAudioStreamAdaptationObserver;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    46
class CFourCCConvertor;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    47
class MLogicalChain;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    48
class MAudioContext;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    49
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    50
const TUid KAudioComponentManagerUid = {0x10283462};
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    51
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    52
// Messages flags
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    53
const TInt KServerStopping = 0x01;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    54
const TInt KPreemptionRequest = 0x02;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    55
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    56
/**
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    57
@publishedAll
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    58
@released
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    59
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    60
This is the interface to AudioStreamAdaptation.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    61
This is represent the stream loaded when the MMRC server 
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    62
selects the adaptation.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    63
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    64
This functionality includes audio playback and recording using different formats
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    65
CAudioStreamAdaptation provides the access point for clients to Adaptation Layer.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    66
It is responsible for initializing connections to various subsystems
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    67
in audio adaptation. These include setting up and managing connection 
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    68
to the low level audio adaptation API implementations. The connections are then made
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    69
available .
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    70
*/
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    71
class CAudioStreamAdaptation : public CBase
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    72
	{
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    73
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    74
public:
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    75
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    76
	/**
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    77
	Constructs, and returns a pointer to, a new CAudioComponentManager object.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    78
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    79
	@return A pointer to the CAudioComponentManager instance.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    80
	*/
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    81
	static CAudioStreamAdaptation* NewL(TUid aType);
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    82
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    83
	/**
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    84
	Destructor.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    85
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    86
	Deletes all objects and releases all resource owned by this instance.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    87
	*/
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    88
	virtual ~CAudioStreamAdaptation();
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    89
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    90
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    91
	/**
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    92
	Returns if a message was passed through the adaptation.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    93
	
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    94
	@param MLogicalChain
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    95
		Logical Current Chain
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    96
	@param MLogicalChain
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    97
		Desired Chain after message
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    98
	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    99
		another of the system-wide error codes.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   100
	*/
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   101
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   102
	virtual TInt Message(MLogicalChain& aCurrentChain, MLogicalChain& aDesiredChain, MAudioContext& aContext, TInt aFlags) = 0;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   103
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   104
	/**
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   105
	Returns if a Audio Stream Observer was Registered.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   106
	
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   107
	@param MAudioStreamAdaptationObserver
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   108
		Observer object witch will be registered
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   109
	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   110
		another of the system-wide error codes.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   111
	*/
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   112
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   113
	virtual TInt RegisterAudioStreamObserver(MAudioStreamAdaptationObserver& aObserver) = 0 ;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   114
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   115
	/**
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   116
	Returns if a Audio Stream Observer was UnRegistered.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   117
	
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   118
	@param MAudioStreamAdaptationObserver
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   119
		Observer object witch will be unregistered
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   120
	*/
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   121
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   122
	virtual void UnregisterAudioStreamObserver(MAudioStreamAdaptationObserver& aObserver) = 0;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   123
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   124
	virtual void UnregisterAllAudioStreamObserver() = 0;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   125
	
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   126
	virtual void SetFourCC(const CFourCCConvertor& aFourCCConvertor) = 0;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   127
	
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   128
	
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   129
private:
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   130
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   131
	/**	iDtor_ID_Key Instance identifier key. When instance	of an
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   132
	*	implementation is created by ECOM framework, the
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   133
	*	framework will assign UID for it. The UID is used in
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   134
	*	destructor to notify framework that	this instance is
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   135
	*	being destroyed	and	resources can be released.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   136
	*/
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   137
	TUid iDtor_ID_Key;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   138
	};
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   139
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   140
#include "audiostreamadaptation.inl"
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   141
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   142
#endif // C_AUDIOCOMPONENTMANAGER_H