am_va_info.h

Motorola synergy audio component

#ifndef AM_VA_INFO_CLASS_INCLUDE
#define AM_VA_INFO_CLASS_INCLUDE

/* (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: 
       This file defines the AM_VA_Info class.

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

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

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

   00-09-01   blamers     CR - CSGce61298
              Complete functionality for VA FF/Rew
              - Add save va offset functionality

   98-11-04   blamers     CR - CSGce23508
              Whitecap VR Event Handler Changes
              - Rid AM of compiler warning.

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

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

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

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

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

/************** CLASS DEFINITIONS *********************************************/
class AM_VA_Info
{
private:

    /*
     * Overload the new and delete operators to prevent calls to the 
     * system's new and delete functions.
     */ 
    inline void * operator new(size_t) { return(NULL); }
    inline void operator delete(void *, size_t) {}

public:

    /*
     * class constructor
     */
    AM_VA_Info 
    ( AM_VA_INFO *va_info_ptr );

    /* 
     * class destructor, do nothing, but prevents allocation of __Ptbl in 
     * everyfile that includes this .H file.
     */
    ~AM_VA_Info (void) {};
    
    /*
     * clear va record
     */
    void
    clear ( void );

    /*
     * save va data
     */
    void save(UINT8 va_command_audio_path,
              UINT8 voice_note_id);

    void save(UINT8 va_command_audio_path,
              UINT8 voice_note_id,
              AM_VA_OFFSET va_offset);

    void save(AM_VA_OFFSET va_offset);
    
    /*
     * save vst data
     */
    void save(UINT16 &filename);

    /*
     * return audio path for the VA command
     */
    inline UINT8 get_va_command_audio_path ( void )
    {
        return( va_ptr->va_command_audio_path );
    }

    /*
     * return voice note id
     */
    inline UINT8 get_voice_note_id ( void )
    {
        return( va_ptr->voice_note_id );
    }

    /*
     * return voice note offset
     */
    inline AM_VA_OFFSET get_va_offset ( void )
    {
        return( va_ptr->va_offset );
    }


private:

   AM_VA_INFO *va_ptr;
};

#endif //end of AM_VA_INFO_CLASS_INCLUDE