cpd_miket.h

CP detector (CPD) only reports the onset and removal of a tone. The analysis of timing (if required)

/*------------------------------------------------------------------------*
*                                                                         *
*   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 CPD_MIKET_
#define CPD_MIKET_

#include <std.h>                 
#include <icpd.h>


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

extern const IALG_Fxns 		CPD_MIKET_IALG; 
extern const ICPD_Fxns 		CPD_MIKET_ICPD; 
extern const ICPD_Params 	ICPD_MIKET_DefaultParams;
extern const ICPD_tCfg 		ICPD_MIKET_DefaultCfg;

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

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

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

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

/*  pCfg in pStatus can point to the same config data for any number of MF
    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 CPD_MIKET_control(void *pDb, Int Cmd, ICPD_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 samples) of continuous data. 
    
    If MF receiver was turned off, then pSc and pIn
    can point anywhere. */           
    
extern Int  CPD_MIKET_process(void *pDb, void *pSc, Int *pIn);

/* statistics */
typedef struct CPD_MIKET_tStts {

    Int sLoEn;  /* average energy in dBm*170, for low freq comp */
    Int sLoErr; /* average frequency deviation in Hz *170, for low freq comp */
    Int sHiEn;
    Int sHiErr;
} CPD_MIKET_tStts;

extern void CPD_MIKET_get_statistics(void *pDb, CPD_MIKET_tStts *pStts);

#endif  /* CPD_MIKET_ */