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

/**
        @file
                DLIB_PSI_Parser.h

        @brief
                

*/


#ifndef __DLIB_PSI_PARSER_H__
#define __DLIB_PSI_PARSER_H__


#include "DHL_PSI.h"

#include "DLIB_PSI.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

/**
ParsePAT will parse a PAT, given a PSI descriptor. It should
be called in response to a psiDataReceived event.
*/
DHL_RESULT ParsePAT(const tDHL_PSI_DataArray *desc, MPEG_PAT **returnPat);

/**
ParsePMT will parse a PMT, given a PSI descriptor. It should
be called in response to a psiDataReceived event.
*/
DHL_RESULT ParsePMT(const tDHL_PSI_DataArray *desc, MPEG_PMT **returnPmt);

/**
FlattenPMT creates an MPEG program map section from a PMT structure
*/
DHL_RESULT FlattenPMT(const MPEG_PMT *pmt, UINT32 *pmtSectionLength, UINT8 **pmtSection);


/** @brief Parses an PAT section and returns the decoded section via the provided handle.

        @param[in] section Pointer to the first byte of the section.
        @param[out] patSectionPtr Return pointer to a parsed PAT section.

        @return 
*/
DHL_RESULT ParsePatSection (UINT8 *section, MPEG_PAT * *patSectionPtr);


/**     @brief Attempts to retrieve a descriptor of the specified type from a list of 
        unparsed descriptors.  The instance parameter allows searching for more 
        than    one descriptor instance of the same type.

        @param[in]      descriptors     Pointer to the un-parsed descriptors.
        @param[in]      len                     Length in bytes of the un-parsed descriptors.
        @param[in]      tag                     descriptor_tag to be searched for.
        @param[in]      instance                The instance of the descriptor to be returned.
        @param[out]     descriptor      Returned Pointer to the start of the descriptor.

        @return
        
*/
DHL_RESULT GetMpegDescriptor (UINT8 *descriptors, UINT16 len, UINT8 tag, 
                                                        UINT16 instance, UINT8 **descriptor);


/**     @brief  Frees the memory associated with a parsed descriptor.

        @param[in]      descriptorPtr   Pointer to a parsed descriptor.
*/
void FreeMpegDescriptor (void *descriptorPtr);


/**
This is an alternative, synchronous function for receiving PAT's when on-going
event monitoring is not desired. The timeout parameter specifies the number
of ticks to wait for a PAT, or 0 to wait indefinitely.
*/
DHL_RESULT GetPAT(tDHL_TSD *tsd, MPEG_PAT **returnPat, int timeOut);

/**
FreePAT will delete a PAT returned by ParsePAT or GetPAT
*/
void FreePAT(MPEG_PAT *pat);


/**
This is an alternative, synchronous function for receiving the current PMT 
at the given PID and program_number when on-going event monitoring is not desired. 
The timeout parameter specifies the number of ticks to wait for a PMT, or 0 to wait 
indefinitely.
*/
DHL_RESULT GetPMT(tDHL_TSD *tsd,
                                UINT16 pid, 
                                UINT16 program_number, 
                                MPEG_PMT **returnPmt, 
                                int timeOut );

/**
FreePMT will delete a PMT returned by ParsePMT or GetPMT
*/
void FreePMT(MPEG_PMT *pmt);


/** 
MonitorDIT will set up a PSI monitor waiting for a Discontinuity 
Indicator Table (DIT). 
The eventProc will be called after the first DIT received, and
then again depending on updateMode until CancelPSIPidMonitor
is called. 
*/




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



#endif  /* __DLIB_PSI_PARSER_H__ */