td_aud_tone_req_tone_type.h

来自「Motorola synergy audio component」· C头文件 代码 · 共 275 行

#ifndef TD_AUD_TONE_REQ_TONE_TYPE_INCLUDE
#define TD_AUD_TONE_REQ_TONE_TYPE_INCLUDE

#ifdef __cplusplus
extern "C" {
#endif

/* (c) Copyright Motorola 1997, All rights reserved.        
   Motorola Confidential Proprietary
   Contains confidential proprietary information of Motorola, Inc.
   Reverse engineering is prohibited.
   The copyright notice does not imply publication.
  
   DESCRIPTION: 
       Define tone types to request Audio Manager to
       begin or stop tone generation.

 ************** REVISION HISTORY **********************************************
  
   Date       Author      Reference
   ========   ========    ==========================
   04-02-23   w18944      CR - LIBdd72710
              WAV UI sounds

   03-11-03   a18984      CR - LIBdd46249
              Moved macro INVALID_VOLUME_STEP to this file

   02-11-14   brb032      CR - LIBbb56504
              Audio Media support.

   01-12-20   ktang       CR - LIBbb13753
              Audio Media Request Redirection

   00-09-22   hchuang     CSGce66038
              Provide an interface function for retrieving tone information
			  - create port_am_tone_detail function

   00-08-04   ktang       PR - CSGce67917
              Update audio Manager to support Synergy Lite tone defs

   00-05-05   shagino     CR - CSGce56425
              Implement handsfree_status funtion
              - Changed DL_AUDIO_TONE_TYPE to DL_AUDIO_TONE_TYPE_T.

   00-04-04   ktang      PR - CSGce53448
              AM DL interface update
              - Added typedef TD_AUD_VOLUME_SETTING_T

   00-02-02   cfarrel     PR - CSGce47853
              SiERRA Audio: Update Phase 6 Headers
              - Add typedefs for for new aud_tone_req and 
                aud_tone_keyfeedback_req parameters

   99-10-22   ktang       PR - CSGce40785
              GRiEF Audio: DL Audio Tone Types and DL DB Feature IDs
              - included "dl_audio_auf.h"
              - erased the original enum

   99-10-05   ktang       PR - CSGce39515
              Feature DB for Ringer/Music/Pwr Up Phase II Grief Audio
              - Added POWER_DOWN tone entry at the end of the key tone block.

   99-06-16   mkloza      PR - CSGce32922
              FM RADIO - Audio Manager
              - added AUD_TONE_RADIO

   99-03-30   mkloza      PR - CSGce30284
              Change LOWBAT tone for LEAP to come out of spkr not alert
              - moved LOWBAT tone ( not LOWBAT alert tone ) into 
                status tones section

   98-07-06   aliang      CR - CSGce19444
              AM Changes for User Selectable SMS Alert
              - added new tone AUD_TONE_SAMPLE_SMS_MSG_ALERT.

   98-06-18   dmichau     CR - CSGce19897
              New Tones for SIM Toolkit
              - Added two optional GSM tones: dial tone and radio path ack.
              - Added two new Motorola Proprietary tones: Pos and Neg ack.
              - Added one new PCS tone: dial tone.

   98-04-10   gswanson    PR - CSGce18195
              Smart keypad tone gets stuck on when Single tone is on.
              - Moved  AUD_TONE_SMART_KEY_SHORT and  AUD_TONE_SMART_KEY_LONG 
                from the keypress section to the status tone section.
                This means that they are unaffected by the Keypad Tones Setting
                (e.g. single tone, no tones, etc.) 
              - Removed AUD_TONE_SAMPLE_ALERT_LOW_VOL, AUD_TONE_SAMPLE_ALERT_MED_VOL,
                and AUD_TONE_SAMPLE_ALERT_HIGH_VOL because they are no longer used.

   98-04-01   rentring    PR - CSGce16647
              No aux alert during music ringer
              - make a SENTINEL tone to keep queue from empty during 
                MUSIC alert ringer

   98-03-03   mrisop      PR - CSGce15153
              Support of USA Supervisory Tones through flexing
              - adding unique USA tone definitions to enum table.  
              - adding an unmovable alert tone and vib tone for factory testing purposes.

   98-02-26   mbonness    PR - CSGce17138
              VA Capacity Reached Tone
              - add memory full tone

   98-02-03   slam        PR - CSGce16188
              VA/VR Warm Plug Handling
              - Add AUD_TONE_WARM_PLUG.

   97-12-29   slam        PR - CSGce15146
              Integration of VA/VR
              - Merge VA/VR development into the latest code.

   97-12-05   gswanson    PR - CSGce15192
              Power Toggle Beep is not always heard
              - make a one-shot tone specifically for power toggle
                It will be called AUD_TONE_POWER_TOGGLE_TONE and will be 
                100 ms long.

   97-12-05   slam        PR - CSGce15147
              Reformat DSP flash for VA and VR
              - Add AUD_TONE_VA_VR_REFORMAT.

   97-11-12   lindan      PR - CSGce13656
              Smart Key Headset Functionality
              - Added two new tone types for Smart Key tones.

   97-10-30   joshuag     PR - CSGce14102
              VR User Interface Redesign
              - Updated to meet coding standard.
              - Added AUD_TONE_VR_GENERIC_TONE identical to
                AUD_TONE_VA_GENERIC_TONE.
                
   97-09-25   slam        PR - CSGce13131
              - Remove AUD_TONE_VA_INCALL_RECORDING timer tone since MMI
                is now in charge of playing the in-call recording tone
                every 10 seconds.

   97-09-22   slam        PR - CSGce11610
              Voice Annotation development
              - Rename AUD_TONE_VA_WARNING_TONE to AUD_TONE_VA_VR_WARNING_TONE
              - Rename AUD_TONE_VR_READY to AUD_TONE_PROMPT_VOICE_INPUT.
              - Remove in-call low battery tone & in-call switch battery tone.
              - Move VA tones to status tones rather than alert tones.
              - Change VA Generic tone to continuous tone.
              - Change AUD_TONE_LOC_LOWBAT_NOT_IN_CALL to 
                AUD_TONE_LOC_LOWBAT_ALERT.
              - Add new VA audio events. 
              - Replace AUD_TONE_VR_ACTIVATED with AUD_TONE_VA_GENERIC_TONE.
              
   97-07-15   slam        PR - CSGce10240
              Speaker Dependent Voice Recognition development
              - Add AUD_TONE_SDVR_GET_MODELS.
              - Renove AUD_TONE_SDVR_W_TONE, AUD_TONE_SDVR_CAPTURE_W_TONE.
              - Adjust AUD_TONE_NUMBER_OF_TONES accordingly.
              - Add new VR audio tones 
                (AUD_TONE_VR_READY & AUD_TONE_VR_ACTIVATED).
              - Add new VR audio events.
  
*/

/************** HEADER FILE INCLUDES ******************************************/
#include <MME/mm_auf_common_defs.h>
#include <ENGINE_HAPI/hapi_portlist.h>
#ifndef DL_AUDIO_AUF_INCLUDE
#include <SYNERGY_DEVICE_LAYER/dl_audio_auf.h>
#endif
/************** CONSTANTS *****************************************************/

#define ONE_SHOT_MASK     DL_AUDIO_ONESHOT_TONE_MASK
#define DL_MEDIA_MASK     DL_AUDIO_MEDIA_START_TONE_MASK
#define TONE_ID_MASK      (ONE_SHOT_MASK - 1)
#define PWRUP_MASK        DL_AUDIO_POWERUP_TONE_MASK
#define INVALID_BITS      (0xFFFF ^ (TONE_ID_MASK | ONE_SHOT_MASK | PWRUP_MASK | DL_MEDIA_MASK))
#define INVALID_VOLUME_STEP  DL_AUDIO_VOLUME_SETTING_CURRENT


/************** STRUCTURES, ENUMS, AND TYPEDEFS *******************************/
enum
{
    GET_DURATION,
    PLAY_CUSTOM_NOTE,
    PLAY_CUSTOM_TUNE,
    SEND_DL_MSG
};

typedef UINT8 AUD_CUSTOM_TYPE;

/* TONE TYPES DEFINITION
  
  The tone type definitions are in file included above. This is the old file of
  such definitions. The old tone type TD_AUD_TONE_REQ_TONE_TYPE is defined to 
  be the new one, DL_DB_FEATURE_ID_T, as in the above included file.
*/


typedef DL_AUDIO_TONE_TYPE_T TD_AUD_TONE_REQ_TONE_TYPE_T;
typedef DL_AUDIO_VOLUME_SETTING_T TD_AUD_VOLUME_SETTING_T;
typedef UINT32 TD_AUD_TONE_SEQUENCE_NUMBER_T;
typedef BOOL TD_AUD_TONE_UPLINK_T;
typedef UINT8 TD_AUD_TONE_KEY_TYPE_T;

typedef union
{
    TD_AUD_TONE_REQ_TONE_TYPE_T              type;
    struct
    {
        TD_AUD_TONE_REQ_TONE_TYPE_T          send_dl_msg:1;
        TD_AUD_TONE_REQ_TONE_TYPE_T          media:1;
        TD_AUD_TONE_REQ_TONE_TYPE_T          rerun:1;
        TD_AUD_TONE_REQ_TONE_TYPE_T          pwrup:1;
        TD_AUD_TONE_REQ_TONE_TYPE_T          one_shot:1;
        TD_AUD_TONE_REQ_TONE_TYPE_T          id:11;
    } fields;
} TD_AUD_TONE_UNION_T;

typedef struct
{
    MMSS_MEDIA_HANDLE_T handle;
    UINT32              seq;
} TD_AUD_MEDIA_INFO_T;

enum
{
    TD_AUD_AUDIO_STATE_NORMAL = 0,
    TD_AUD_AUDIO_STATE_SUSPENDED
};

typedef UINT8 TD_AUD_STATE_T;   

#if (AUDIO_RAINBOW == TRUE || (MAKE_NEPTUNE_CHIPSET && MAKE_HDW_BB_IC == MAKE_HDW_NEPTUNE_LTS))
enum
{
    AM_SAMPLING_RATE_08_00 = HAPI_ST_DAC_SR_08_00,
    AM_SAMPLING_RATE_11_03 = HAPI_ST_DAC_SR_11_03,
    AM_SAMPLING_RATE_12_00 = HAPI_ST_DAC_SR_12_00,
    AM_SAMPLING_RATE_16_00 = HAPI_ST_DAC_SR_16_00,
    AM_SAMPLING_RATE_22_05 = HAPI_ST_DAC_SR_22_05,
    AM_SAMPLING_RATE_24_00 = HAPI_ST_DAC_SR_24_00,
    AM_SAMPLING_RATE_32_00 = HAPI_ST_DAC_SR_32_00,
    AM_SAMPLING_RATE_44_10 = HAPI_ST_DAC_SR_44_10,
    AM_SAMPLING_RATE_48_00 = HAPI_ST_DAC_SR_48_00
};
#else
//on non-lts/lte products, the hapi signals aren't defined.  Just define for compilation on other 
//products.
enum
{
    AM_SAMPLING_RATE_08_00, 
    AM_SAMPLING_RATE_11_03, 
    AM_SAMPLING_RATE_12_00,
    AM_SAMPLING_RATE_16_00, 
    AM_SAMPLING_RATE_22_05,
    AM_SAMPLING_RATE_24_00,
    AM_SAMPLING_RATE_32_00,
    AM_SAMPLING_RATE_44_10,
    AM_SAMPLING_RATE_48_00
};
#endif


typedef UINT8 TD_AM_SAMPLING_RATE_T;

/************** FUNCTION PROTOTYPES *******************************************/

/************** MACROS ********************************************************/

/************** CLASS DEFINITIONS *********************************************/

/************** GLOBAL VARIABLES **********************************************/

#ifdef __cplusplus
}
#endif
#endif