aud_tone_req.h

Motorola synergy audio component

#ifndef AUD_TONE_REQ_INCLUDE
#define AUD_TONE_REQ_INCLUDE
#ifdef __cplusplus
extern "C" {
#endif

/* (c) Copyright Motorola 1990-2005, 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: 
        DATA STRUCTURE DEFINITIONS To Request Audio Manager To Begin Or Stop 
        Generation Of The Specified Tone.
 
 ************** REVISION HISTORY **********************************************
  
   Date       Author      Reference
   ========   ========    ==========================
   2005-07-05 rkamath1    LIBgg65242
              Feature 16017 - aud_tone_req now returns BOOL.
              Also removed unused code relating to Operator Ringtone behavior. 

   04-02-23   w18944      CR - LIBdd72710
              WAV UI sounds

   03-12-10   a18985      CR - LIBdd61220
              To fix dump file for C650

   03-12-08   a18985      CR - LIBdd57220
              Include the definition of AUD_CTG_ADD_RSRC_RETRY_TIMER_T
              to fix the error in dump generation 

   03-06-06   a18985      CR - LIBdd08704
              Synchronization in drums playing
              - Mymix Edit Mode

   02-04-14   brb032      CR - LIBbb90240
               Add DRM support.
   
   03-05-13   a18985      CR - LIBbb90227
              MME Enhancements for OKI
              Support for Mymix Edit on E380

   03-03-16   a18984      CR - LIBbb76996
              Support for MFT on E380

   03-02-18   a3177c      CR - LIBbb77026
              OKI Support. Support for MIDI playback.

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

   02-10-30   bof010      CR - LIBbb65108
              Invalid format in stored melody (Port the fix from TALON)

   02-10-07   stlee       CR - LIBbb55179
              Melody Required Fields Not Present on Mobile
              Originiated Ring Tones

   02-08-19   brb032      CR - LIBbb49461
              Add tone_mask to TD_AUD_FILE_REFERENCE_T struct.

   02-06-23   bmd031      CR - LIBbb39271
              Sending big EMS cause panic.

   02-06-10   ktang       CR - LIBbb30667
                          M Services - Sound preview bar is always full

   02-02-25   brl022      CR - LIBbb21281
              add MyTone DB to LCA phone
              
   02-02-02   ktang       CR - LIBbb10803
              midi support

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

   01-07-27   rchebolu    LIBbb00912
              Operator Defined Ringer Support
              - Added new struct def for AM_OPERATOR_RING_TUNE_DEF_T for
                operator defined ringer tune definition and AM_OPERATOR_RING_DEF_T
                for operator defined ringer definition.

   00-09-21   ktang       CSGcs73690
              Fix to remove correct sample alert from tone table in DL
              - Added struct def of AUD_TONE_STOP_IND_T for tone stop 
                confirmation to DL

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

   00-07-24   davidb      CR - CSGce66238
              Add Ringer/Vibrate functionality
   
   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
              - Modified struct AUD_TONE_REQ

   00-02-02   cfarrel     PR - CSGce47853
              SiERRA Audio: Update Phase 6 Headers
              - Add a sequence number to the aud_tone_req
                function prototype.  
              - Add an uplink parameter to the
                aud_tone_keyfeedback_req function prototype.

   99-10-26   ktang       PR - CSGce40785
              GRiEF Audio: DL Audio Tone Types and DL DB Feature IDs
              - Replaced old tone types to DL tone types

   99-08-99   mgilot      CR - CSGce35457
              GRiEF: Phase I Audio Interface Implementation
              - Added prototye definition for the function, aud_tone_keyfeedback_req 
              - Removed all td_primitive_header references to make code SUAPI
                compliant
  
*/
/************** HEADER FILE INCLUDES ******************************************/
#include <ENGINE_AUDIO/audio_conditional_compile_def.h>
#ifndef SUAPI_INCLUDE
#include <SUAPI/suapi.h>
#endif
#include <ENGINE_AUDIO/audio_conditional_compile_def.h>   
#include <SYNERGY_DEVICE_LAYER/dl_file_system_auf.h>

#ifndef TD_AUD_TONE_REQ_TYPE_INCLUDE
#include <ENGINE_AUDIO/td_aud_tone_req_type.h>
#endif

#ifndef TD_AUD_TONE_REQ_TONE_TYPE_INCLUDE
#include <ENGINE_AUDIO/td_aud_tone_req_tone_type.h>
#endif

#ifndef min
#define min(x,y)    (((x)<(y))?(x):(y))
#endif

#if (MAKE_HDW_OKI == TRUE) 
#define MSG_DATA_SIZE 122
#define MIDI_CHANNELS_EXCLUDING_DRUM 12
#endif

/************** STRUCTURES, ENUMS, AND TYPEDEFS *******************************/
typedef enum
{
    AUD_MEDIA_COMPLETE,
    AUD_MEDIA_OPEN_SUCCESS,
    AUD_MEDIA_START_ERROR,    
    AUD_MEDIA_ERROR,
    AUD_MEDIA_STARTED
}AUD_MEDIA_STATUS_T;

typedef struct
{
    TD_AUD_TONE_REQ_TYPE           req_type;        /*  Type of Request.     */
    TD_AUD_TONE_UNION_T            tone;            /*  Type Of Tone.        */
    TD_AUD_TONE_REQ_TONE_TYPE_T    vibrate_type;    /*  Type of Vibrate Pattern */
    TD_AUD_TONE_SEQUENCE_NUMBER_T  sequence_number; /*  Tone sequence number */
    TD_AUD_VOLUME_SETTING_T        vol_step;        /*  default volume       */
    TD_AUD_TONE_UPLINK_T           uplink;          /*  uplink on ?          */
    TD_AUD_MEDIA_INFO_T            media_info;       /*  MME seq number       */
    TD_AM_SAMPLING_RATE_T          sampling_rate;   /*sampling rate of audio */
} AUD_TONE_REQ;


typedef struct
{
    TD_AUD_TONE_REQ_TONE_TYPE_T tone_type;
    UINT32 sequence_number;
} AUD_TONE_STOP_IND_T;

typedef struct
{
    AUD_MEDIA_STATUS_T   status;
    MMSS_MEDIA_HANDLE_T  media_handle;
    UINT32               seq_num;
    UINT32               msg_value; 
} AUD_MEDIA_TONE_IND_T;

typedef struct
{
    DL_FS_HANDLE_REFERENCE_T fRef;
    MMSS_FILE_FORMAT_T       format;
    DL_AUDIO_TONE_TYPE_T     tone_mask; 
} TD_AUD_FILE_REFERENCE_T;

#if (MAKE_HDW_OKI == TRUE) 

typedef struct
{
    TD_AUD_TONE_REQ_TYPE           req_type;
    TD_AUD_TONE_UNION_T            tone;
    TD_AUD_VOLUME_SETTING_T        vol_step;
} AUD_SOUNDLIB_TONE_REQ_T;

typedef struct
{
    UINT8 data[MSG_DATA_SIZE];
    UINT8 filetype;
    UINT16 length;
} AUD_SOUNDLIB_MIDI_DATA_IND_T;

typedef struct 
{
   UINT8 part;
   UINT8 variation;
} AUD_SOUNDLIB_MYMIX_GRID_VALUE_T;

#if (MAKE_HDW_MFT == TRUE) 
typedef struct
{
   UINT8 type;
} AUD_SOUNDLIB_VIBRATE_REQ_T;
#endif

typedef struct
{
    BOOL midion;
} AUD_SOUNDLIB_MIDI_ON_T;

typedef struct
{
   UINT16 tempo_msw;
   UINT16 tempo_lsw;
   UINT8 program[MIDI_CHANNELS_EXCLUDING_DRUM];
}AUD_SOUNDLIB_MYMIX_PREFILL_CTRL_T;

#endif

typedef struct AUD_CTG_ADD_RSRC_RETRY_TIMER_S
{
   SU_TIMER_HANDLE t_handle;
} AUD_CTG_ADD_RSRC_RETRY_TIMER_T;

/************** FUNCTION PROTOTYPES *******************************************/
UINT32 aud_tone_custom_notes_req(TD_AUD_TONE_REQ_TYPE_T req_type,
                                 UINT8* user_note,
                                 TD_AUD_TONE_SEQUENCE_NUMBER_T sequence,
								 UINT16 beats,
                                 TD_AUD_VOLUME_SETTING_T default_volume,
                                 AUD_CUSTOM_TYPE length);

UINT32 aud_tone_custom_file_req(TD_AUD_TONE_REQ_TYPE_T req_type,
                                TD_AUD_FILE_REFERENCE_T aud_ref,
                                TD_AUD_TONE_SEQUENCE_NUMBER_T sequence,
                                TD_AUD_VOLUME_SETTING_T vol_step,
                                AUD_CUSTOM_TYPE action);

#if (MAKE_FTR_16017_TRANSFLASH_RINGTONES == TRUE)
BOOL
#else   /* MAKE_FTR_16017_TRANSFLASH_RINGTONES */
void
#endif  /* MAKE_FTR_16017_TRANSFLASH_RINGTONES */
     aud_tone_req(TD_AUD_TONE_REQ_TYPE_T req_type,
                  TD_AUD_TONE_REQ_TONE_TYPE_T tone_type,
                  TD_AUD_TONE_SEQUENCE_NUMBER_T sequence_number,
                  TD_AUD_VOLUME_SETTING_T default_volume);

void aud_tone_keyfeedback_req(TD_AUD_TONE_REQ_TYPE_T req_type,
                              TD_AUD_TONE_KEY_TYPE_T key_type,
                              TD_AUD_TONE_UPLINK_T uplink);

void aud_tone_vibrate_req(TD_AUD_TONE_REQ_TYPE_T req_type,
                          TD_AUD_TONE_REQ_TONE_TYPE_T tone_type, 
                          TD_AUD_TONE_REQ_TONE_TYPE_T viberate_type,
                          TD_AUD_TONE_SEQUENCE_NUMBER_T sequence_number,
                          TD_AUD_VOLUME_SETTING_T default_volume);

void aud_audio_update_req(void);

#if (MAKE_FTR_16017_TRANSFLASH_RINGTONES == TRUE)
BOOL
#else   /* MAKE_FTR_16017_TRANSFLASH_RINGTONES */
void
#endif  /* MAKE_FTR_16017_TRANSFLASH_RINGTONES */
     aud_tone_vib_mm_req(TD_AUD_TONE_REQ_TYPE_T req_type,
                         TD_AUD_TONE_REQ_TONE_TYPE_T tone_type,
                         TD_AUD_TONE_REQ_TONE_TYPE_T viberate_type,
                         TD_AUD_TONE_SEQUENCE_NUMBER_T sequence_number,
                         TD_AUD_VOLUME_SETTING_T default_volume,
                         TD_AM_SAMPLING_RATE_T sampling_rate);

UINT8 aud_get_media_playback_percentage(UINT32 sequence_number);


void aud_media_req(TD_AUD_TONE_REQ_TYPE_T req_type,
                   TD_AUD_TONE_REQ_TONE_TYPE_T tone_type);
                   
MMSS_MEDIA_HANDLE_T aud_get_media_handle_with_seq(UINT32 media_seq_number);

TD_AUD_TONE_REQ_TONE_TYPE_T aud_map_keytype_to_tonetype(TD_AUD_TONE_KEY_TYPE_T key_type);
                   
/************** MACROS ********************************************************/

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

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


#ifdef __cplusplus
}
#endif
#endif