aud_dsp_am_reply.h

Motorola synergy audio component

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

/* (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: 
       Contains class definition of AUD_DSP_Reply_RX, and inline function
       for obtaining the primitive value.

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

   Date       Author      Reference
   ========   ========    ==========================
   00-12-21   mtaraba     CSGce82934
              main_comp_hardware.h within engine_audio vob should be removed

   00-04-14   hchuang     CR - CSGce54805
              update current prim id to HAPI generic prim id
              - replace sc_prim_ids with hapi_mdi_message_ids

   99-12-14   ktang       CR - CSGce42434
              Common Tone Generator
              - Redefined the class, still as a child class of TD_Primitive_Header
  
   99-01-26   blamers     CR - CSGce27361
              Quick changes in ringer volume clips ring tones on kramer
              - Added a global to track the DSP command time stamp to determine
                whether we respond to the corresponding DSP reply.

   98-09-26   blamers     CR - CSGce23508
              Whitecap VR Audio Event Handler Changes
              - Added a parse method to retrieve data from the primitive.

   98-09-26   blamers     CR - CSGce17243
              Whitecap VA Audio Event Handler Changes
              - Updated to coding standard
              - Added #include

   97-10-01   gdrumma     CR - CSGce12568
              Whitecap DSP Audio Reply handling in AM
              - new class
*/
/************** HEADER FILE INCLUDES ******************************************/

#include <ENGINE_AUDIO/audio_conditional_compile_def.h>

#ifndef TD_DSP_AUD_REPLY_BUFF_INCLUDE
#include <ENGINE_AUDIO/td_dsp_aud_reply_buff.h>
#endif
#include <ENGINE_HAPI/hapi_mdi_message_ids.h>

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

/************** STRUCTURES, ENUMS, AND TYPEDEFS *******************************/

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

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

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

class AUD_DSP_Reply_RX
{
public:

    /*
     *  Constructor
     */
    AUD_DSP_Reply_RX(void *msg);


    BOOL parse_message(void);

    inline AUD_DSP_REPLY_WORD get_message_id(void);

private:
    void *primitive_data_ptr;
    AUD_DSP_REPLY_WORD msg_id;
    AUD_DSP_REPLY_WORD *next_msg_pos;

}; // End of AUD_DSP_Reply_RX Class 

#endif /* end of - prevent inadvertently including a header file twice */