os/mm/devsoundextensions/telephonyaudiorouting/TelephonyAudioRoutingBase/src/TelephonyAudioRoutingProxy.cpp
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
sl@0
     1
/*
sl@0
     2
* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies). 
sl@0
     3
* All rights reserved.
sl@0
     4
* This component and the accompanying materials are made available
sl@0
     5
* under the terms of "Eclipse Public License v1.0"
sl@0
     6
* which accompanies this distribution, and is available
sl@0
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     8
*
sl@0
     9
* Initial Contributors:
sl@0
    10
* Nokia Corporation - initial contribution.
sl@0
    11
*
sl@0
    12
* Contributors:
sl@0
    13
*
sl@0
    14
* Description:   Handles client-side telephony audio routing requests.
sl@0
    15
*
sl@0
    16
*/
sl@0
    17
sl@0
    18
sl@0
    19
sl@0
    20
// INCLUDE FILES
sl@0
    21
#include <e32base.h>
sl@0
    22
#include <e32svr.h>
sl@0
    23
#include <e32std.h>
sl@0
    24
sl@0
    25
#include "TelephonyAudioRouting.h"
sl@0
    26
#include "TelephonyAudioRoutingProxy.h"
sl@0
    27
#include "TelephonyAudioRoutingClientServer.h"
sl@0
    28
#include "TelephonyAudioRoutingSession.h"
sl@0
    29
#include "MTelephonyAudioRoutingObserver.h"
sl@0
    30
sl@0
    31
sl@0
    32
    
sl@0
    33
// ================= MEMBER FUNCTIONS =======================
sl@0
    34
sl@0
    35
// C++ default constructor can NOT contain any code, that
sl@0
    36
// might leave.
sl@0
    37
//
sl@0
    38
CTelephonyAudioRoutingProxy::CTelephonyAudioRoutingProxy(
sl@0
    39
	MTelephonyAudioRoutingObserver& aObserver)
sl@0
    40
	: 	iObserver(aObserver),
sl@0
    41
		iAvailableOutputs(0, NULL, NULL)
sl@0
    42
    {
sl@0
    43
   
sl@0
    44
    }
sl@0
    45
    
sl@0
    46
    
sl@0
    47
// -----------------------------------------------------------------------------
sl@0
    48
// CTelephonyAudioRoutingProxy::ConstructL
sl@0
    49
// Symbian 2nd phase constructor can leave.
sl@0
    50
// -----------------------------------------------------------------------------
sl@0
    51
//
sl@0
    52
void CTelephonyAudioRoutingProxy::ConstructL()
sl@0
    53
	{
sl@0
    54
	TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t CTelephonyAudioRoutingProxy[%x]::ConstructL"),this);
sl@0
    55
	User::LeaveIfError(iSession.ConnectL(*this, iObserver));	
sl@0
    56
sl@0
    57
	// Make sure session is set up with default values from server for its local variables:
sl@0
    58
	iSession.GetDefaultValuesL();
sl@0
    59
	
sl@0
    60
	CTelephonyAudioRouting::TAudioOutput audioOutput = Output();
sl@0
    61
sl@0
    62
	// Get stored values for audio output and array and store values in local variables:
sl@0
    63
	TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t CTelephonyAudioRoutingProxy::ConstructL, current iAudioOutput retrieved from server: %d"), audioOutput);	
sl@0
    64
	
sl@0
    65
	TArray<CTelephonyAudioRouting::TAudioOutput> availableOutputArray = AvailableOutputs();
sl@0
    66
	TInt count = availableOutputArray.Count();
sl@0
    67
	TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t ConstructL: Count = %d "), count);
sl@0
    68
	for(TInt i = 0; i < count; i++)
sl@0
    69
	{
sl@0
    70
		TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t ConstructL: availableOutputs[i] = %d "),availableOutputArray[i]);
sl@0
    71
	}	
sl@0
    72
sl@0
    73
	iSession.NotifyIfOutputChanged();
sl@0
    74
	iSession.NotifyIfAvailableOutputsChanged();
sl@0
    75
sl@0
    76
	}
sl@0
    77
sl@0
    78
// Two-phased constructor.
sl@0
    79
EXPORT_C CTelephonyAudioRoutingProxy* CTelephonyAudioRoutingProxy::NewL(MTelephonyAudioRoutingObserver& aObserver)
sl@0
    80
    {
sl@0
    81
	CTelephonyAudioRoutingProxy* self = new(ELeave) CTelephonyAudioRoutingProxy(aObserver);
sl@0
    82
	CleanupStack::PushL(self);
sl@0
    83
	self->ConstructL();
sl@0
    84
	CleanupStack::Pop(self);
sl@0
    85
	return self;
sl@0
    86
    }
sl@0
    87
sl@0
    88
sl@0
    89
// Destructor
sl@0
    90
CTelephonyAudioRoutingProxy::~CTelephonyAudioRoutingProxy()
sl@0
    91
    { 
sl@0
    92
	TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t CTelephonyAudioRoutingProxy::~CTelephonyAudioRoutingProxy[%x]"),this);    
sl@0
    93
    iSession.Close();
sl@0
    94
    }
sl@0
    95
sl@0
    96
sl@0
    97
sl@0
    98
// ---------------------------------------------------------
sl@0
    99
// CTelephonyAudioRoutingProxy::AvailableOutputs
sl@0
   100
// Provides caller with an array of available audio outputs
sl@0
   101
// ---------------------------------------------------------
sl@0
   102
//
sl@0
   103
const TArray<CTelephonyAudioRouting::TAudioOutput>& CTelephonyAudioRoutingProxy::AvailableOutputs()
sl@0
   104
	{
sl@0
   105
	TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t CTelephonyAudioRoutingProxy[%x]::AvailableOutputs"),this);
sl@0
   106
	
sl@0
   107
	TRAP_IGNORE(iSession.GetAvailableOutputsL());  // Session will get values from Server and store in its iAvailableOutputs
sl@0
   108
		
sl@0
   109
	TInt count = (iSession.AvailableOutputs()).Count();	
sl@0
   110
	
sl@0
   111
	iAvailableOutputs = (iSession.AvailableOutputs()).Array();
sl@0
   112
	
sl@0
   113
	TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t CTelephonyAudioRoutingProxy::AvailableOutputs: Count = %d "), count);
sl@0
   114
	for(TInt i = 0; i < count; i++)
sl@0
   115
	{
sl@0
   116
		TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t CTelephonyAudioRoutingProxy::AvailableOutputs: availableOutputs[i] = %d "),iAvailableOutputs[i]);
sl@0
   117
	}			
sl@0
   118
	return iAvailableOutputs;
sl@0
   119
	}
sl@0
   120
	
sl@0
   121
// ---------------------------------------------------------
sl@0
   122
// CTelephonyAudioRoutingProxy::Output
sl@0
   123
// Provides caller with the current audio output setting.
sl@0
   124
// (other items were commented in a header).
sl@0
   125
// ---------------------------------------------------------
sl@0
   126
//
sl@0
   127
CTelephonyAudioRouting::TAudioOutput CTelephonyAudioRoutingProxy::Output()
sl@0
   128
	{
sl@0
   129
	TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t CTelephonyAudioRoutingProxy[%x]::Output"),this);
sl@0
   130
	
sl@0
   131
	TAudioOutput audioOutput = (iSession.CurrentAudioOutputPkg())();
sl@0
   132
sl@0
   133
	TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t CTelephonyAudioRoutingProxy::Output: iSession's Audio Output = %d"),audioOutput);		
sl@0
   134
	return audioOutput;
sl@0
   135
	}
sl@0
   136
sl@0
   137
// ---------------------------------------------------------
sl@0
   138
// CTelephonyAudioRoutingProxy::SetOutputL
sl@0
   139
// Allows caller to set audio output to a particular value.
sl@0
   140
// (other items were commented in a header).
sl@0
   141
// ---------------------------------------------------------
sl@0
   142
//
sl@0
   143
sl@0
   144
void CTelephonyAudioRoutingProxy::SetOutputL(TAudioOutput aOutput)
sl@0
   145
	{
sl@0
   146
		TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t CTelephonyAudioRoutingProxy[%x]::SetOutput"),this);	
sl@0
   147
		TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t CTelephonyAudioRoutingProxy::SetOutput with: %d"), aOutput);	
sl@0
   148
sl@0
   149
		TBool validOutput = ETrue;
sl@0
   150
		// Verify request is valid: (not necessary for ENone or ENotActive)
sl@0
   151
		if ((aOutput != CTelephonyAudioRouting::ENotActive) && (aOutput != CTelephonyAudioRouting::ENone))
sl@0
   152
		{
sl@0
   153
			validOutput = ValidateOutputRequest(aOutput);
sl@0
   154
		}
sl@0
   155
			
sl@0
   156
		if (validOutput)
sl@0
   157
		{
sl@0
   158
    		iSession.SetOutput(aOutput, iShowNote); 
sl@0
   159
    		// Reset iShowNote once it's sent
sl@0
   160
    		iShowNote = EFalse;   	
sl@0
   161
		}
sl@0
   162
		else
sl@0
   163
		{
sl@0
   164
			TELAUDRTNG_RDEBUG(_L("[TELAUDRTNG]\t CTelephonyAudioRoutingProxy::SetOutput: Error: Requested output not in array"));
sl@0
   165
			// reset session's iOkToGetShowNoteMode flag, since it errored
sl@0
   166
			iSession.ResetShowNoteMode();			
sl@0
   167
			User::Leave(KErrHardwareNotAvailable);		
sl@0
   168
		}
sl@0
   169
	}
sl@0
   170
	
sl@0
   171
// ---------------------------------------------------------
sl@0
   172
// CTelephonyAudioRoutingProxy::PreviousOutput
sl@0
   173
// Provides caller with current value of previous audio output value.
sl@0
   174
// (other items were commented in a header).
sl@0
   175
// ---------------------------------------------------------
sl@0
   176
//
sl@0
   177
sl@0
   178
CTelephonyAudioRouting::TAudioOutput CTelephonyAudioRoutingProxy::PreviousOutput()
sl@0
   179
	{
sl@0
   180
	TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t CTelephonyAudioRoutingProxy[%x]::PreviousOutput"), this);
sl@0
   181
	TAudioOutput prevOutput = (iSession.PreviousAudioOutputPkg())();
sl@0
   182
sl@0
   183
	TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t CTelephonyAudioRoutingProxy::PreviousOutput: iSession's Previous Audio Output = %d"),prevOutput);		
sl@0
   184
	return prevOutput;	
sl@0
   185
	}	
sl@0
   186
	
sl@0
   187
// ---------------------------------------------------------
sl@0
   188
// CTelephonyAudioRoutingProxy::ValidateOutputRequest
sl@0
   189
// Checks that output requested is in list of available outputs.
sl@0
   190
// (other items were commented in a header).
sl@0
   191
// ---------------------------------------------------------
sl@0
   192
//
sl@0
   193
sl@0
   194
TBool CTelephonyAudioRoutingProxy::ValidateOutputRequest(TAudioOutput aOutput)
sl@0
   195
	{
sl@0
   196
	TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t CTelephonyAudioRoutingProxy[%x]::ValidateOutputRequest"),this);		
sl@0
   197
	TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t CTelephonyAudioRoutingProxy::ValidateOutputRequest for: %d"),aOutput);
sl@0
   198
	
sl@0
   199
	TArray<CTelephonyAudioRouting::TAudioOutput> availableOutputs = (iSession.AvailableOutputs()).Array();
sl@0
   200
	
sl@0
   201
	TBool found = EFalse;	
sl@0
   202
	TInt count = availableOutputs.Count();
sl@0
   203
	for(TInt i = 0; i < count; i++)
sl@0
   204
		{
sl@0
   205
			if (aOutput == availableOutputs[i])
sl@0
   206
			{
sl@0
   207
				found = ETrue;
sl@0
   208
				break;
sl@0
   209
			}
sl@0
   210
		}
sl@0
   211
		return found;		
sl@0
   212
	}	
sl@0
   213
	
sl@0
   214
	
sl@0
   215
// ---------------------------------------------------------
sl@0
   216
// CTelephonyAudioRoutingProxy::ShowNoteMode
sl@0
   217
// Provides caller with the current ShowNoteMode setting in server.
sl@0
   218
// (other items were commented in a header).
sl@0
   219
// ---------------------------------------------------------
sl@0
   220
//
sl@0
   221
TBool CTelephonyAudioRoutingProxy::ShowNoteMode()
sl@0
   222
	{
sl@0
   223
	TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t CTelephonyAudioRoutingProxy[%x]::ShowNoteMode"),this);
sl@0
   224
	
sl@0
   225
	TPckgBuf<TBool> showNoteModePkg = iSession.ShowNoteMode();
sl@0
   226
	TBool showNoteMode = showNoteModePkg();
sl@0
   227
	
sl@0
   228
	TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t CTelephonyAudioRoutingProxy::ShowNoteMode: = %d"), showNoteMode);		
sl@0
   229
	return showNoteMode;
sl@0
   230
	}
sl@0
   231
sl@0
   232
	
sl@0
   233
// ---------------------------------------------------------
sl@0
   234
// CTelephonyAudioRoutingProxy::SetShowNote
sl@0
   235
// 
sl@0
   236
// (other items were commented in a header).
sl@0
   237
// ---------------------------------------------------------
sl@0
   238
//
sl@0
   239
sl@0
   240
TInt CTelephonyAudioRoutingProxy::SetShowNote( TBool aMode )
sl@0
   241
	{
sl@0
   242
	TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t CTelephonyAudioRoutingProxy[%x]::SetShowNote"),this);		
sl@0
   243
	TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t CTelephonyAudioRoutingProxy::SetShowNote With: %d"),aMode);	
sl@0
   244
sl@0
   245
	// Note: Will set aMode on a GetShowNote call after SetOutputComplete called
sl@0
   246
	iShowNote = aMode; 	
sl@0
   247
	return KErrNone;
sl@0
   248
	}
sl@0
   249
// ---------------------------------------------------------
sl@0
   250
// CTelephonyAudioRoutingProxy::GetShowNote
sl@0
   251
// 
sl@0
   252
// (other items were commented in a header).
sl@0
   253
// ---------------------------------------------------------
sl@0
   254
//
sl@0
   255
sl@0
   256
TInt CTelephonyAudioRoutingProxy::GetShowNote( TBool& aMode )
sl@0
   257
	{
sl@0
   258
	TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t CTelephonyAudioRoutingProxy[%x]::GetShowNote"),this);
sl@0
   259
sl@0
   260
	// Check with session if Ok to retrieve iShowNoteMode from server:
sl@0
   261
	TBool okToGetShowNoteMode = iSession.OkToGetShowNoteMode();
sl@0
   262
	
sl@0
   263
	TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t GetShowNote: Session: Ok to get show note = %d"),okToGetShowNoteMode);	
sl@0
   264
	
sl@0
   265
	if (okToGetShowNoteMode)
sl@0
   266
	{
sl@0
   267
		aMode = ShowNoteMode();	
sl@0
   268
	}
sl@0
   269
	else
sl@0
   270
	{
sl@0
   271
		aMode = EFalse;
sl@0
   272
		TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t CTelephonyAudioRoutingProxy::GetShowNote: (Not OK to Get Value from Server) Returning ShowNoteMode = %d"), aMode);			
sl@0
   273
	}
sl@0
   274
		
sl@0
   275
	// reset session's iOkToGetShowNoteMode flag once it has been retrieved
sl@0
   276
	iSession.ResetShowNoteMode();
sl@0
   277
sl@0
   278
	TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t CTelephonyAudioRoutingProxy::GetShowNote: Returning ShowNoteMode = %d"), aMode);		
sl@0
   279
sl@0
   280
	return KErrNone;
sl@0
   281
	}
sl@0
   282
// End of File