source: svn/newcon3bcm2_21bu/dst/dlib/src/si/DLIB_PSIP_Monitor.h

/**
        @file
                DLIB_PSIP_Monitor.h

        @brief
                

*/


#ifndef __DLIB_PSIP_MONITOR_H__
#define __DLIB_PSIP_MONITOR_H__


#include "DHL_PSI.h"
#include "DHL_Demux.h"

#include "DLIB_PSIP.h"


#ifdef __cplusplus
extern "C" {
#endif



#if COMMENT
____Overview____(){}
#endif



#if COMMENT
____Config____(){}
#endif



#if COMMENT
____Types____(){}
#endif




#if COMMENT
____Defines____(){}
#endif






#if COMMENT
____API____(){}
#endif

/** @name Asynchronous Monitor calls 
@{
The set of asynchronous monitor functions allow continuous or one-time monitoring
of ATSC PSIP sections and/or tables.  For a detailed description of these 
parameters, see the explanation in PSI.h.

Parameter Description \n
tsd - Specifies from which Transport Stream Demultiplexor the monitored stream is coming.
psiMode -     Specifies the notification type for PSIP sections.  For PSIP
              applications, one of the following PSIMode options should be
              used:
                   sectionMode:     Event triggered for each section received.
                   tableMode:       Event triggered when a complete table received.
                   eagerTableMode:  Event triggered for each new section of a 
                                    table as well as an event when the table is
                                    complete.

For the STT, MGT, RRT, and ETT tables, the PSIMode is internally set to sectionMode
because these tables reside within a single section.

updateMode -  Specifies the update frequency of the monitor.  For PSIP applications,
              one of the following tDHL_PSI_Update options should be used:
                   psiOneShot:      Section or table event triggered only once.
                   psiVersionChange:Table trigger reset when version changes.
                   psiContinuous:   Sections/Tables continously trigger events.

eventProc -   The callback function to receive monitor events.

userParam -   A user-specified field which is sent to the eventProc callback
              function with events.

**psiCtl - Returns a pointer to the Monitor descriptor to the caller.  This identifies the
              specific PSI monitor and can be used to cancel a set monitor.

*/
DHL_RESULT MonitorStt (tDHL_TSD tsd, tDHL_PSI_Update updateMode, tDHL_PSI_EventProc eventProc,
                                                        UINT32 userData, tDHL_PSI_ControlHandle *psiCtl);
DHL_RESULT MonitorMgt (tDHL_TSD tsd, tDHL_PSI_Update updateMode, tDHL_PSI_EventProc eventProc,
                                                        UINT32 userData, tDHL_PSI_ControlHandle *psiCtl);
DHL_RESULT MonitorTvct (tDHL_TSD tsd, tDHL_PSI_Mode psiMode, tDHL_PSI_Update updateMode, tDHL_PSI_EventProc eventProc,
                                                        UINT32 userParam, tDHL_PSI_ControlHandle *psiCtl);
DHL_RESULT MonitorCvct (tDHL_TSD tsd, tDHL_PSI_Mode psiMode, tDHL_PSI_Update updateMode, tDHL_PSI_EventProc eventProc,
                                                        UINT32 userParam, tDHL_PSI_ControlHandle *psiCtl);
DHL_RESULT MonitorRrt (tDHL_TSD tsd, UINT8 region, tDHL_PSI_Update updateMode, tDHL_PSI_EventProc eventProc, UINT32 userData,
                                                        tDHL_PSI_ControlHandle *psiCtl);
DHL_RESULT MonitorEit (tDHL_TSD tsd, UINT16 PID, UINT16 source_id, tDHL_PSI_Mode psiMode, tDHL_PSI_Update updateMode,
                                                        tDHL_PSI_EventProc eventProc, UINT32 userParam, tDHL_PSI_ControlHandle *psiCtl);
DHL_RESULT MonitorEtt (tDHL_TSD tsd, UINT16 PID, UINT32 ETM_id, tDHL_PSI_Update updateMode, tDHL_PSI_EventProc eventProc,
                                                        UINT32 userData, tDHL_PSI_ControlHandle *psiCtl);
DHL_RESULT MonitorDcct (tDHL_TSD tsd,  tDHL_PSI_Update updateMode, tDHL_PSI_EventProc eventProc,
                                                        UINT32 userData, tDHL_PSI_ControlHandle *psiCtl);
DHL_RESULT MonitorDccsct (tDHL_TSD tsd,  tDHL_PSI_Update updateMode, tDHL_PSI_EventProc eventProc,
                                                        UINT32 userData, tDHL_PSI_ControlHandle *psiCtl);
DHL_RESULT MonitorEAS(tDHL_TSD tsd, tDHL_PSI_Update updateMode, tDHL_PSI_EventProc eventProc,
                    UINT32 userParam, tDHL_PSI_ControlHandle *psiCtl);
/*@}*/

/** @name Synchronous calls 
@{
The set of synchronous monitor functions allow one-time retrieval of a PSIP
section or table.  The function suspends until the data is retrieved from the
Transport Stream or until the timeOut period expires.  For the STT, MGT, RRT,
and ETT a section is returned.  For the TVCT, CVCT, and EIT, a table is returned.

The timeout period 'timeOut' is specified in milliseconds.

The parsed section/table must be freed using FreeAtscSection()/FreeAtscTable().
*/
DHL_RESULT GetSttSection (tDHL_TSD tsd, sttSectionPtr_t *sttSectPtr, int timeOut);
DHL_RESULT GetMgtSection (tDHL_TSD tsd, mgtSectionPtr_t *mgtSectPtr, int timeOut);
DHL_RESULT GetRrtSection (tDHL_TSD tsd, UINT8 region, rrtSectionPtr_t *rrtSectPtr, int timeOut);
DHL_RESULT GetEttSection (tDHL_TSD tsd, UINT16 PID, UINT32 ETM_id, ettSectionPtr_t *ettSectPtr, int timeOut);
DHL_RESULT GetDcctSection (tDHL_TSD tsd, dcctSectionPtr_t *dcctSectPtr, int timeOut);
DHL_RESULT GetDccsctSection (tDHL_TSD tsd, dccsctSectionPtr_t *dccsctSectPtr, int timeOut);
DHL_RESULT GetEASSection (tDHL_TSD tsd, easSectionPtr_t *easSectPtr, int timeOut);

DHL_RESULT GetTvct (tDHL_TSD tsd, tvctPtr_t *tvctPtr, int timeOut);
DHL_RESULT GetCvct (tDHL_TSD tsd, cvctPtr_t *cvctPtr, int timeOut);
DHL_RESULT GetEit (tDHL_TSD tsd, UINT16 PID, UINT16 source_id, eitPtr_t *eitPtr, int timeOut);
/*@}*/


#ifdef __cplusplus
} /* extern "C" */
#endif



#endif  /* __DLIB_PSIP_MONITOR_H__ */