am_va_info.h

Motorola synergy audio component

#ifndef AM_VA_INFO_INCLUDE /* To prevent inadvertently including a header twice */
#define AM_VA_INFO_INCLUDE

#ifdef __cplusplus  /* allow #include in a C++ file (only put this in .h files) */
extern "C" {
#endif

/* (c) Copyright Motorola 1998, 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:
       This file defines the VA data info structure.

 ************** REVISION HISTORY **********************************************

   Date       Author      Reference
   ========   ========    ==========================
   04-11-23   aja099      libff38547
              VST VR Port

   03-05-13   Chiarulli   LIBdd01040
              Modify Audio Manager to accept VST VR port from CDMA T730

   00-12-21   mtaraba     CSGce82934
              main_comp_hardware.h within engine_audio vob should be removed

   00-10-03   blamers     CR - CSGce75176
              VA resume after VA pause restarts play from the beginning
              - Change the value of the AM_VA_OFFSET constants.  Zero can not
                be used for no change because it must be used to assign a
                zero byte offset for the pause command.

   00-09-01   blamers     CR - CSGce61298
              Complete functionality for VA FF/Rew
              - Add an offset parameter for VA messaging

   98-09-29   jkraisor    CR - CSGce22626
              Audio Manager Support for VA cmds to DSP in Whitecap
              - Modified the #defines for audio path according to 
                DSP Interface V1.5

   97-07-28   slam        PR - CSGce11610
              - Initial release
*/
/************** HEADER FILE INCLUDES ******************************************/
#ifndef SUAPI_INCLUDE
#include <SUAPI/suapi.h>
#endif

#include <ENGINE_HAPI/hapi_mdi_message_ids.h>

/************** CONSTANTS *****************************************************/

/* Note:  These bits are from version 1.2 of the MDI spec.  They are out of date.
   However, TDMA DSP is still using them.  Chris Fries 2/28/01 */

#define AM_LOCAL_VA_RECORD             0  /* all bits are clear - local audio  */
#define AM_LOCAL_VA_PLAYBACK           0  /* all bits are clear - local audio  */
#define AM_UPLINK_DOWNLINK_VA_RECORD   1  /* bit 0 is set for both uplink & downlink audio */
#define AM_UPLINK_DOWNLINK_VA_PLAYBACK 1  /* bit 0 is set for both uplink & downlink audio */
#define AM_DOWNLINK_VA_RECORD          2  /* bit 1 is set for downlink audio */
#define AM_UPLINK_VA_PLAYBACK          2  /* bit 1 is set for uplink playback */

#define AM_NON_AUDIO_PATH              3  /* bit 0 and bit 1 are set for non-audio */

#define AM_IN_CALL_PLAY_AUDIO_PATH    AM_LOCAL_VA_PLAYBACK
#define AM_NO_CALL_PLAY_AUDIO_PATH    AM_LOCAL_VA_PLAYBACK
#define AM_IN_CALL_RECORD_AUDIO_PATH  AM_UPLINK_DOWNLINK_VA_RECORD
#define AM_NO_CALL_RECORD_AUDIO_PATH  AM_LOCAL_VA_RECORD
/* Need to add one #define here for Delayed Answer feature, P2K R1.2, TDMA Only */

#define AM_MCOUNT_VA                   4       /* No. of msg. blocks between GINT */

#define AM_VA_PATH_FIELD_MASK       0x07    /* masked off bit 0, 1 and 2 for audio path in VA playback command */

#define AM_ABORT_VA_IMMEDIATELY        0x0001  /* bit 0 is set to abort va immediately */
#define AM_FINISH_PLAYBACK_VA          0x0000  /* bit 0 is not set, so DSP will finish playback */


#define AM_VA_INVALID_VOICE_NOTE_ID 0xfe    /* invalid voice note identifier */
#define SCM_VA_ALL_VOICE_NOTES      0xffff  /* all voice notes to SCM */

#define AM_VA_PACKETS_PER_SEC 50
#define AM_VA_UINT16_PER_PACKET MCU_DSP_VA_PLAYBACK_DATA_WORD_LEN

#define AM_VA_OFFSET_BEGIN     0x80000000
#define AM_VA_OFFSET_NO_CHANGE 0x7FFFFFFE
#define AM_VA_OFFSET_END       0x7FFFFFFF

/************** STRUCTURES, ENUMS, AND TYPEDEFS *******************************/
typedef INT32 AM_VA_OFFSET;

typedef struct
{
    AM_VA_OFFSET va_offset;             /* Start byte offset for VA */
    UINT8        va_command_audio_path; /* Playback or record audio path */
    UINT8        voice_note_id;         /* Identifier of a voice note */
    UINT16       *filename;              /* VST Filename for playing vocoded data */
} AM_VA_INFO;

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

/************** MACROS ********************************************************/
#define am_va_ticks(uint16)\
    ((uint16 * (13000 / AM_VA_PACKETS_PER_SEC)) / (60 * AM_VA_UINT16_PER_PACKET))

#define am_va_byte_per_sec(sec)\
    (2 * (AM_VA_UINT16_PER_PACKET * AM_VA_PACKETS_PER_SEC * sec))

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

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


#ifdef __cplusplus /* allow #include in a C++ file (only put this in .h files) */
}
#endif
#endif /* end of - prevent inadvertently including a header file twice */