mmfenh/enhancedmediaclient/Client/src/Components/AudioEffects/DistanceAttenuationEffectImpl.cpp
changeset 0 71ca22bcf22a
equal deleted inserted replaced
-1:000000000000 0:71ca22bcf22a
       
     1 /*
       
     2 * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Project file for EnhancedMediaClient Utility
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #include "DistanceAttenuationEffectImpl.h"
       
    20 #include <DistanceAttenuationBase.h>
       
    21 #include <ControlObserver.h>
       
    22 
       
    23 using namespace multimedia;
       
    24 
       
    25 CDistanceAttenuationEffect::CDistanceAttenuationEffect()
       
    26     {
       
    27     // No Impl
       
    28     }
       
    29 
       
    30 CDistanceAttenuationEffect::~CDistanceAttenuationEffect()
       
    31     {
       
    32 	delete iPrevDistanceAttenuationProxy;
       
    33 	delete  iDistanceAttenuationProxy;
       
    34 	iObservers.Close();
       
    35     }
       
    36 
       
    37 TInt CDistanceAttenuationEffect::PostConstructor()
       
    38     {
       
    39     TRAPD( status, CEffectControlBase::ConstructL(KUidDistanceAttenuationEffect) );
       
    40     return status;
       
    41     }
       
    42 
       
    43 // From MControl begins
       
    44 TInt CDistanceAttenuationEffect::AddObserver( MControlObserver& aObserver )
       
    45     {
       
    46     return iObservers.Append(&aObserver);
       
    47     }
       
    48 
       
    49 TInt CDistanceAttenuationEffect::RemoveObserver( MControlObserver& aObserver )
       
    50     {
       
    51 	TInt index = iObservers.Find(&aObserver);
       
    52 	if( index != KErrNotFound )
       
    53 		{
       
    54 		iObservers.Remove(index);
       
    55 		}
       
    56 	return index;
       
    57     }
       
    58 
       
    59 TUid CDistanceAttenuationEffect::Type()
       
    60     {
       
    61     return KDistanceAttenuationEffectControl;
       
    62     }
       
    63 
       
    64 TControlType CDistanceAttenuationEffect::ControlType()
       
    65     {
       
    66 	return EEffectControl;
       
    67     }
       
    68 
       
    69 // From MControl ends
       
    70 
       
    71 // From MEffectControl begins
       
    72 TInt CDistanceAttenuationEffect::Apply()
       
    73     {
       
    74     return DoApply();
       
    75     }
       
    76 
       
    77 // From MEffectControl ends
       
    78 
       
    79 TInt CDistanceAttenuationEffect::DoApply()
       
    80     {
       
    81     TInt error(KErrNone);    
       
    82 	if(iDistanceAttenuationProxy)
       
    83 		{
       
    84 		TRAP(error,iDistanceAttenuationProxy->ApplyL());	
       
    85 		}	
       
    86 	else
       
    87 		{
       
    88 		error = KErrNotReady;	
       
    89 		}			
       
    90     return error;    
       
    91     }
       
    92 
       
    93 // From MDistanceAttenuationEffect begins
       
    94 
       
    95 /**
       
    96 * Gets the Distance Attenuation of the listener.
       
    97 * @since 3.0
       
    98 * @param aRMin The source-to-listener distance below which the sound level is constant
       
    99 * @param aRMax The source-to-listener distance above which the sound level is constant or zero
       
   100 * @param aMuteAfterMax Indicate if the sound is muted beyond RMax
       
   101 * @param aRollOffFactor Multiplier factor to source-to-listener distance
       
   102 * @param aRoomRollOffFactor Multiplier factor to source-to-listener distance for Room effect.
       
   103 * @return -
       
   104 */
       
   105 TInt CDistanceAttenuationEffect::DistanceAttenuation( TInt& aRMin, TInt& aRMax, TBool& aMuteAfterMax,
       
   106                                    TUint& aRollOffFactor, TUint& aRoomRollOffFactor )
       
   107 	{
       
   108 	TInt status(KErrNone);
       
   109 	if(iDistanceAttenuationProxy)
       
   110 		{
       
   111 		TInt32 a,b;
       
   112 		TBool c;
       
   113 		TUint32 d,e;
       
   114 		iDistanceAttenuationProxy->DistanceAttenuation(a,b,c,d,e);	
       
   115 		aRMin = a;
       
   116 		aRMax = b;
       
   117 		aMuteAfterMax = c;	
       
   118 		aRollOffFactor = d;
       
   119 		aRoomRollOffFactor = e;
       
   120 		}	
       
   121 	else
       
   122 		{
       
   123 		status = KErrNotReady;	
       
   124 		}			
       
   125 	return status;			
       
   126 	}
       
   127                                    
       
   128 
       
   129 /**
       
   130 * Get roll off factor maximum value.
       
   131 * @since 3.0
       
   132 * @param aRollOffFactor The maximum multiplier factor to source-to-listener distance for Room effect.
       
   133 * @return -
       
   134 */
       
   135 TInt CDistanceAttenuationEffect::RollOffFactorMax( TUint& aRollOfFactorMax )
       
   136 	{
       
   137 	TInt status(KErrNone);
       
   138 	if(iDistanceAttenuationProxy)
       
   139 		{
       
   140 		TUint32 factormax;
       
   141 		iDistanceAttenuationProxy->RollOffFactorMax(factormax);	
       
   142 		aRollOfFactorMax = factormax;
       
   143 		}	
       
   144 	else
       
   145 		{
       
   146 		status = KErrNotReady;	
       
   147 		}			
       
   148 	return status;			
       
   149 	}
       
   150 
       
   151 /**
       
   152 * Get room roll off factor maximum value.
       
   153 * @since 3.0
       
   154 * @param aRollOffFactor The maximum multiplier factor to source-to-listener distance for Room effect.
       
   155 * @return -
       
   156 */
       
   157 TInt CDistanceAttenuationEffect::RoomRollOffFactorMax( TUint& aRoomRollOfFactorMax )
       
   158 	{
       
   159 	TInt status(KErrNone);
       
   160 	if(iDistanceAttenuationProxy)
       
   161 		{
       
   162 		TUint32 factormax;
       
   163 		iDistanceAttenuationProxy->RoomRollOffFactorMax(factormax);	
       
   164 		aRoomRollOfFactorMax = factormax;
       
   165 		}	
       
   166 	else
       
   167 		{
       
   168 		status = KErrNotReady;	
       
   169 		}			
       
   170 	return status;			
       
   171 	}
       
   172 
       
   173 /**
       
   174 * Sets the Distance Attenuation
       
   175 * @since 3.0
       
   176 * @param aRMin The source-to-listener distance below which the sound level is constant
       
   177 * @param aRMax The source-to-listener distance above which the sound level is constant or zero
       
   178 * @param aMuteAfterMax Indicate if the sound is muted beyond RMax
       
   179 * @param aRollOffFactor Multiplier factor to source-to-listener distance
       
   180 * @param aRoomRollOffFactor Multiplier factor to source-to-listener distance for Room effect.
       
   181 * @return -
       
   182 */
       
   183 TInt CDistanceAttenuationEffect::SetDistanceAttenuation( TInt aRMin, TInt aRMax, TBool aMuteAfterMax,
       
   184                                        TUint aRollOffFactor, TUint aRoomRollOffFactor )
       
   185 	{
       
   186 	TInt status(KErrNone);
       
   187 	if(iDistanceAttenuationProxy)
       
   188 		{
       
   189 		TInt32 a,b;
       
   190 		TBool c;	
       
   191 		TUint32 d,e;
       
   192 		a = aRMin;
       
   193 		b = aRMax;
       
   194 		c = aMuteAfterMax;
       
   195 		d = aRollOffFactor;
       
   196 		e = aRoomRollOffFactor;
       
   197 		
       
   198 		TRAP(status,iDistanceAttenuationProxy->SetDistanceAttenuationL(a,b,c,d,e));	
       
   199 		}	
       
   200 	else
       
   201 		{
       
   202 		status = KErrNotReady;	
       
   203 		}			
       
   204 	return status;	
       
   205 	}
       
   206 
       
   207 // From MDistanceAttenuationEffect ends
       
   208 
       
   209 // From MAudioEffectControl
       
   210 /**
       
   211 * Disable the effect
       
   212 * @since 5.0
       
   213 */
       
   214 TInt CDistanceAttenuationEffect::Disable()
       
   215 	{
       
   216 	TInt status(KErrNone);
       
   217 	if(iDistanceAttenuationProxy)
       
   218 		{
       
   219 		TRAP(status,iDistanceAttenuationProxy->DisableL());	
       
   220 		}	
       
   221 	else
       
   222 		{
       
   223 		status = KErrNotReady;	
       
   224 		}			
       
   225 	return status;				
       
   226 	}
       
   227 
       
   228 /**
       
   229 * Enable the effect
       
   230 * @since 5.0
       
   231 */
       
   232 TInt CDistanceAttenuationEffect::Enable()
       
   233 	{
       
   234 	TInt status(KErrNone);
       
   235 	RDebug::Print(_L("CDistanceAttenuationEffect::Enable() [%x]"),iDistanceAttenuationProxy);
       
   236 	if(iDistanceAttenuationProxy)
       
   237 		{
       
   238 		TRAP(status,iDistanceAttenuationProxy->EnableL());	
       
   239 		}	
       
   240 	else
       
   241 		{
       
   242 		status = KErrNotReady;	
       
   243 		}			
       
   244 	return status;					
       
   245 	}
       
   246 
       
   247 /**
       
   248 * Enforce the effect.
       
   249 * @since 5.0
       
   250 * @param aEnforced Indicate the effect is to be enforced or not. ETrue = Enforced.
       
   251 */
       
   252 TInt CDistanceAttenuationEffect::Enforce( TBool &aEnforced )
       
   253 	{
       
   254 	TInt status(KErrNone);
       
   255 	if(iDistanceAttenuationProxy)
       
   256 		{
       
   257 		TRAP(status,iDistanceAttenuationProxy->EnforceL(aEnforced));	
       
   258 		}	
       
   259 	else
       
   260 		{
       
   261 		status = KErrNotReady;	
       
   262 		}					
       
   263 	return status;		
       
   264 	}
       
   265 
       
   266 /**
       
   267 * Check if this effect object currently has update rights.
       
   268 * A client can lose update rights in some hardware platforms where there are a limited
       
   269 * number of instances of an effect that can exist at the same time. When an effect instance
       
   270 * has lost update rights the user can still change settings, but any calls to Apply the
       
   271 * settings will be deferred until update rights are regained.
       
   272 * @since 5.0
       
   273 * @param ETrue if this object currently has rights to update the settings of this effect,
       
   274 *         EFalse otherwise.
       
   275 */
       
   276 TInt CDistanceAttenuationEffect::HaveUpdateRights(TBool &aHaveUpdateRights)
       
   277 	{
       
   278 	TInt status(KErrNone);
       
   279 	if(iDistanceAttenuationProxy)
       
   280 		{
       
   281 		aHaveUpdateRights = iDistanceAttenuationProxy->HaveUpdateRights();	
       
   282 		}	
       
   283 	else
       
   284 		{
       
   285 		status = KErrNotReady;	
       
   286 		}			
       
   287 	return status;	
       
   288 	}
       
   289 
       
   290 /**
       
   291 * Check if the effect is enabled
       
   292 * @since 5.0
       
   293 * @param ETrue if the effect is enabled, EFalse if the effect is disabled.
       
   294 */
       
   295 TInt CDistanceAttenuationEffect::IsEnabled(TBool &aEnabled)
       
   296 	{
       
   297 	TInt status(KErrNone);
       
   298 	if(iDistanceAttenuationProxy)
       
   299 		{
       
   300 		aEnabled = iDistanceAttenuationProxy->IsEnabled();	
       
   301 		}	
       
   302 	else
       
   303 		{
       
   304 		status = KErrNotReady;	
       
   305 		}			
       
   306 	return status;			
       
   307 	}
       
   308 
       
   309 /**
       
   310 * Check if the effect is enforced.
       
   311 * @since 5.0
       
   312 * @param ETrue if the effect is enforced, EFalse if the effect isn ot enforced.
       
   313 */
       
   314 TInt CDistanceAttenuationEffect::IsEnforced(TBool &aEnforced)
       
   315 	{
       
   316 	TInt status(KErrNone);
       
   317 	if(iDistanceAttenuationProxy)
       
   318 		{
       
   319 		aEnforced = iDistanceAttenuationProxy->IsEnforced();	
       
   320 		}	
       
   321 	else
       
   322 		{
       
   323 		status = KErrNotReady;	
       
   324 		}			
       
   325 	return status;			
       
   326 	}
       
   327 
       
   328 /*
       
   329 * Get the unique identifier of the audio effect
       
   330 * @since 5.0
       
   331 * @param Unique identifier of the audio effect object.
       
   332 */
       
   333 TInt CDistanceAttenuationEffect::Uid(TUid &aUid)
       
   334 	{
       
   335 	TInt status(KErrNone);
       
   336 	if(iDistanceAttenuationProxy)
       
   337 		{
       
   338 		aUid = iDistanceAttenuationProxy->Uid();	
       
   339 		}	
       
   340 	else
       
   341 		{
       
   342 		status = KErrNotReady;	
       
   343 		}			
       
   344 	return status;			
       
   345 	}
       
   346 // From MAudioEffectControl Ends
       
   347 
       
   348 
       
   349 // From CEffectControlBase begins
       
   350 void CDistanceAttenuationEffect::Event( TEffectControlEvent aEvent )
       
   351     {
       
   352 	TInt status(KErrNone);    	
       
   353     // Controller Loaded with ECIBuilderCreated
       
   354     if ( aEvent == ECIBuilderCreated )
       
   355         {
       
   356     	RDebug::Print(_L("Deleting Proxy"));	
       
   357 		status = DeleteEffectProxy();
       
   358 		RDebug::Print(_L("Deleting Proxy [%d]"),status);	
       
   359 		status = CreateEffectProxy();	
       
   360 		RDebug::Print(_L("Creating Proxy [%d]"),status);	
       
   361 		if(status == KErrNone)
       
   362 			{
       
   363 			SavePreviousSettings();	
       
   364 			}
       
   365 		else
       
   366 			{
       
   367 			for ( TInt i = 0; i < iObservers.Count(); i++ )
       
   368 				{
       
   369 				iObservers[i]->Event(this,MAudioEffectControl::KDisabled,NULL);
       
   370 				} 		
       
   371 			}	
       
   372         }
       
   373     else if ( aEvent == EMessageHandlerDeleted )
       
   374         {
       
   375         if(status == KErrNone)
       
   376         	{
       
   377         	DeleteEffectProxy();	
       
   378         	}
       
   379         }
       
   380     }
       
   381 
       
   382 // From CEffectControlBase ends
       
   383 
       
   384 TInt CDistanceAttenuationEffect::CreateEffectProxy()
       
   385 	{
       
   386 	TInt status(KErrNone);
       
   387 	status = GetMessageHandle(iMsgHndlrHandlePckg);
       
   388 	if(status != KErrNone)
       
   389 		{
       
   390 		return status;	
       
   391 		}
       
   392 	iCustomCommand = GetCustomCommand();		
       
   393 	if(!iCustomCommand)
       
   394 		{
       
   395 		return KErrNotReady;	
       
   396 		}
       
   397 
       
   398 	TRAP(status,iDistanceAttenuationProxy = CDistanceAttenuationProxy::NewL(iMsgHndlrHandlePckg, *iCustomCommand, NULL));	
       
   399 	if(status == KErrNone)
       
   400 		{
       
   401 		TRAP(status,iDistanceAttenuationProxy->RegisterObserverL(*this));	
       
   402 		}		
       
   403 
       
   404 	return status;
       
   405 	}
       
   406 
       
   407 TInt CDistanceAttenuationEffect::DeleteEffectProxy()
       
   408 	{
       
   409 	TInt status(KErrNone);	
       
   410 	if(iDistanceAttenuationProxy)
       
   411 		{
       
   412 		iPrevDistanceAttenuationProxy = iDistanceAttenuationProxy;	
       
   413 		}
       
   414 	iDistanceAttenuationProxy = NULL;	
       
   415 	return status;
       
   416 	}
       
   417 
       
   418 TInt CDistanceAttenuationEffect::SavePreviousSettings()
       
   419 	{
       
   420 	TInt status(KErrNone);	
       
   421 	if(iPrevDistanceAttenuationProxy)
       
   422 		{
       
   423 		TBool enforce = iPrevDistanceAttenuationProxy->IsEnforced();
       
   424 		iDistanceAttenuationProxy->EnforceL(enforce);	
       
   425 
       
   426 		TBool enable = iPrevDistanceAttenuationProxy->IsEnabled();
       
   427 		if(enable)
       
   428 			{
       
   429 			iDistanceAttenuationProxy->EnableL();	
       
   430 			}
       
   431 
       
   432 		delete iPrevDistanceAttenuationProxy;
       
   433 		iPrevDistanceAttenuationProxy = NULL;
       
   434 		}				
       
   435 	return status;	
       
   436 	}
       
   437 
       
   438  void CDistanceAttenuationEffect::EffectChanged( const CAudioEffect* /*aObservedEffect*/, TUint8 aEvent )
       
   439  	{
       
   440 	for ( TInt i = 0; i < iObservers.Count(); i++ )
       
   441 		{
       
   442 		iObservers[i]->Event(this,aEvent,NULL);
       
   443 		} 		
       
   444  	}
       
   445 
       
   446 // End of file