/*------------------------------------------------------------------------*
*                                                                         *
*   THIS IS AN UNPUBLISHED WORK CONTAINING CONFIDENTIAL AND PROPRIETARY   *
*   INFORMATION.  IF PUBLICATION OCCURS, THE FOLLOWING NOTICE APPLIES:    *
*      "COPYRIGHT 2001 MIKET DSP SOLUTIONS, ALL RIGHTS RESERVED"          *
*                                                                         *
*-------------------------------------------------------------------------*/
#ifndef DTMF_MIKET_
#define DTMF_MIKET_

#include <std.h>                 
#include <idtmf.h>


/*--------------------- public defs ---------------------------------------*/

/* sizes of database and scrath-pad in long words */
#define DTMF_MIKET_DB_LSZ	(49)
#define DTMF_MIKET_SC_LSZ	(95)

/*--------------------- public vars ---------------------------------------*/

extern const IALG_Fxns 		DTMF_MIKET_IALG; 
extern const IDTMF_Fxns 	DTMF_MIKET_IDTMF; 
extern const IDTMF_tCfg 	IDTMF_MIKET_DefaultCfg;
extern const IDTMF_Params 	IDTMF_MIKET_DefaultParams;
extern const char 			DTMF_MIKET_aVersion[];

/*--------------------- local vars ----------------------------------------*/
/*--------------------- local functions -----------------------------------*/
/*--------------------- public  functions ---------------------------------*/
/*
 *  Required module finalization function : THIS FUNCTION IS EMPTY
 */
extern Void DTMF_MIKET_exit(Void);

/*
 *  Required module initialization function: THIS FUNCTION IS EMPTY
 */
extern Void DTMF_MIKET_init(Void);

/* ---- Native API ----- */

/*  Initialises database. (mem[1]) */
extern void DTMF_MIKET_init_db   (void *pDb, IDTMF_tCfg *pCfg);

/*  pCfg in pStatus can point to the same config data for any number of DTMF
    detector instances. 
    If RESET is not or-ed with OFF, the detector starts running.
    It is not recommened to apply OFF without RESET due to
    the obvious consequences of calling _control(pDb, 0); afterwards. 
    Asynchronous calling _control() and _process() from different tasks
    is not recommended. */
extern void DTMF_MIKET_control(void *pDb, Int Cmd, IDTMF_Status *pStatus );

/*  returns report word:
        - MSByte as event and 
        - LSByte as tone ID. 

    pDb must point to initialized database (mem[1]).

    pSc must point to scratch pad (mem[2])
    pScratch shall point to DARAM if max speed is required,
    otherwise MIPS will almost double.

    pIn shall point to a frame (40|80 samples) of continuous data. 
    
    If DTMF receiver was turned off, then pSc and pIn
    can point anywhere. */           
    
extern Int  DTMF_MIKET_process(void *pDb, void *pSc, Int *pIn);

#endif  /* DTMF_MIKET_ */