/****************************************************************************
Copyright (C) Cambridge Silicon Radio Ltd. 2004

FILE NAME
    headset_tones.h
    
DESCRIPTION
    header file which defines all of the tones which can be used in BC4 headset
    
*/  

#ifndef HEADSET_TONES_H
#define HEADSET_TONES_H

#include "headset_soundmanager.h"



/****************************************************************************
FUNCTIONS
*/

/****************************************************************************
NAME    
    TonesInit
    
DESCRIPTION
  	Initialise the tones functions
    
RETURNS
    void
*/
void TonesInit ( hsTaskData * pApp ) ;

/****************************************************************************
NAME    
    TonesConfigureEvent
    
DESCRIPTION
  	Configures a tones event mapping - used to playback a tone
    
RETURNS
    void
*/
void TonesConfigureEvent ( hsTaskData * pApp , headsetEvents_t pEvent , HeadsetTone_t pTone )  ;

/****************************************************************************
NAME    
    TonesPlayTone
    
DESCRIPTION
  	Playsback the tone given by the heasdsetTone_t index
    
RETURNS
    void
*/
void TonesPlayTone ( hsTaskData * pApp , HeadsetTone_t pTone ) ;
/****************************************************************************
NAME    
    ToneIsDefined
    
DESCRIPTION
  	Helper fn to determine if a tone has been defined or not
    
RETURNS
    bool 
*/
bool ToneIsDefined ( HeadsetTone_t pTone ) ;
#endif