/****************************************************************************
Copyright (C) Cambridge Silicon Radio Ltd. 2004-2006
Part of BlueLab 3.6.2-release

FILE NAME
    headset_volume.h
    
DESCRIPTION
    
*/

#ifndef _HEADSET_VOLUME_H_
#define _HEADSET_VOLUME_H_


/*************************************************************************
NAME    
     initialiseVolume
    
DESCRIPTION
     Setup the volume on startup
*/
void initialiseVolume(headsetTaskData* app);

/*************************************************************************
NAME    
     headsetHandleAvVolUp
    
DESCRIPTION
     Handle volume up for the AV
*/
void headsetHandleAvVolUp(headsetTaskData* app);


/*************************************************************************
NAME    
     headsetHandleAvVolDown
    
DESCRIPTION
     Handle volume down for the AV
*/
void headsetHandleAvVolDown(headsetTaskData* app);


/*************************************************************************
NAME    
     headsetHandleHfVolUp
    
DESCRIPTION
     Handle volume up for the Hands free
*/
void headsetHandleHfVolUp(headsetTaskData* app);


/*************************************************************************
NAME    
     headsetHandleHfVolDown
    
DESCRIPTION
     Handle volume down for the Hands free
*/
void headsetHandleHfVolDown(headsetTaskData* app);


/*************************************************************************
NAME    
     headsetCheckHfVolLimits
    
DESCRIPTION
     Check to see if HF limits are reached, and if so play a tone
*/
void headsetCheckHfVolLimits(headsetTaskData* app);


/*************************************************************************
NAME    
     headsetUpdateVolume
    
DESCRIPTION
     Set the codec gain to an absolute value
*/
void headsetUpdateVolume(Task codec_task, uint8 gain);
/****************************************************************************
NAME    
    headsetMicrophoneMuteToggle
    
DESCRIPTION
   Turn the microphone on or off depending on the current state
*/
void headsetMicrophoneMuteToggle(headsetTaskData *app);
/****************************************************************************
NAME    
    headsetMicrophoneMuteOn
    
DESCRIPTION
   Turn the microphone on
   */
void headsetMicrophoneMuteOn(headsetTaskData *app);

/****************************************************************************
NAME    
    headsetMicrophoneMuteOff
    
DESCRIPTION
   Turn the microphone off
   */
void headsetMicrophoneMuteOff(headsetTaskData *app);


/****************************************************************************
NAME    
    headsetVolumeSetMicLevel
    
DESCRIPTION
   Set the microphone level
   */


void headsetVolumeSetMicLevel (headsetTaskData *app , uint16 micGain);
		
		
/****************************************************************************
NAME    
    headsetVolumeCompleteUnmuteMicrophone
    
DESCRIPTION
   Unmute the microphone
   */		
void headsetVolumeCompleteUnmuteMicrophone (headsetTaskData *app);

/****************************************************************************
NAME    
    VolumeMuteRemind
    
DESCRIPTION
   Play tone to indicate the headset is currently muted
   */		

void VolumeMuteRemind (headsetTaskData *app);


#endif /* _HEADSET_VOLUME_H_ */