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

/**
        @file
                DLIB_PSIP_Parser.h

        @brief
                

*/


#ifndef __DLIB_PSIP_PARSER_H__
#define __DLIB_PSIP_PARSER_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

/** @brief Frees the memory associated with a section.

        @param[in] sectionPtr   Pointer to a section.
*/
void FreeMpegSection (void *sectionPtr);



/** @name Section Parsing functions 
@{
The section parsing functions take an unparsed section (as an array of bytes)
and parses it into a structure representing the fields as defined in the PSIP
specification.  These section structures are found in this header file before
the API functions.  For the STT, MGT, RRT, and ETT tables the parsed section
represents the complete table because these are specified to be contained
entirely in a single section.  For the multi-section TVCT, CVCT, and EIT tables,
corresponding table parsing functions (below) exist to offer the option of
parsing complete tables.

The FreeAtscSection() function frees the memory associated with a PARSED section
structure.  It is the responsibility of the ParseXxxSection() caller to free
the resulting parsed section structure.
*/
DHL_RESULT ParseSttSection (UINT8 *section, sttSectionPtr_t *sttSectionPtr);
DHL_RESULT ParseMgtSection (UINT8 *section, mgtSectionPtr_t *mgtSectionPtr);
DHL_RESULT ParseTvctSection (UINT8 *section, tvctSectionPtr_t *tvctSectionPtr);
DHL_RESULT ParseCvctSection (UINT8 *section, cvctSectionPtr_t *cvctSectionPtr);
DHL_RESULT ParseRrtSection (UINT8 *section, rrtSectionPtr_t *rrtSectionPtr);
DHL_RESULT ParseEitSection (UINT8 *section, eitSectionPtr_t *eitSectionPtr);
DHL_RESULT ParseEttSection (UINT8 *section, ettSectionPtr_t *ettSectionPtr);
DHL_RESULT ParseDcctSection (UINT8 *section, dcctSectionPtr_t *dccSectionPtr);
DHL_RESULT ParseDccsctSection (UINT8 *section, dccsctSectionPtr_t *dccsctSectionPtr);
DHL_RESULT ParseEASSection (UINT8 *section, easSectionPtr_t *easSectionPtr);
void FreeAtscSection (void *sectionPtr);
/*@}*/


/** @name Table Parsing functions 
@{
The table parsing functions take an array of unparsed sections (as an array of bytes)
and parses it into a structure representing the fields as defined in the PSIP
specification.  These table structures are found in this header file before
the API functions.  Table parsing function exist only for the multi-section
TVCT, CVCT, and EIT tables.  For the single-section STT, MGT, RRT, and ETT tables,
the section parsing function should be used.

The FreeAtscTable() function frees the memory associated with a PARSED table
structure.  It is the responsibility of the ParseXxx() caller to free
the resulting parsed table structure.
*/
DHL_RESULT ParseTvct (UINT8 **sectionArr, tvctPtr_t *tvctPtr);
DHL_RESULT ParseCvct (UINT8 **sectionArr, cvctPtr_t *cvctPtr);
DHL_RESULT ParseVct (UINT8 **sectionArr, xvctPtr_t *vctPtr);
DHL_RESULT ParseEit (UINT8 **sectionArr, eitPtr_t *eitPtr);
void FreeAtscTable (void *tablePtr);
/*@}*/

/** @name Descriptor Parsing functions 
@{
The descriptor parsing functions take an unparsed descriptor (as an array of bytes)
and parses it into a structure representing the fields as defined in the PSIP
specification.  These descriptor structures are found in this header file before
the API functions.

The FreeMpegDescriptor() function (part of the MPEG_SI API) frees the memory
associated with a PARSED descriptor structure.  It is the responsibility of the
ParseXxxDescriptor() caller to free the resulting parsed descriptor structure.
*/
DHL_RESULT ParseAc3AudioStreamDescriptor (UINT8* p,
                                                        ac3AudioStreamDescriptorPtr_t *descripPtr);
DHL_RESULT ParseCaptionServiceDescriptor (UINT8* p,
                                                        captionServiceDescriptorPtr_t *descripPtr);
DHL_RESULT ParseContentAdvisoryDescriptor (UINT8* p,
                                                        contentAdvisoryDescriptorPtr_t *descripPtr);
DHL_RESULT ParseExtendedChannelNameDescriptor (UINT8* p,
                                                        extendedChannelNameDescriptorPtr_t *descripPtr);
DHL_RESULT ParseServiceLocationDescriptor (UINT8* p,
                                                        serviceLocationDescriptorPtr_t *descripPtr);
DHL_RESULT ParseTimeShiftedServiceDescriptor (UINT8* p,
                                                        timeShiftedServiceDescriptorPtr_t *descripPtr);
DHL_RESULT ParseComponentNameDescriptor (UINT8* p,
                                                        componentNameDescriptorPtr_t *descripPtr);
DHL_RESULT ParseDccDepartingRequestDescriptor (UINT8* p,
                                                        dccDRDescriptorPtr_t *descripPtr);
DHL_RESULT ParseDccArrivingRequestDescriptor (UINT8* p,
                                                        dccARDescriptorPtr_t *descripPtr);
DHL_RESULT ParseRedistributionControlDescriptor (UINT8* p,
                                                        rcDescriptorPtr_t *descripPtr);
/*@}*/

/** @name Multiple String Parsing 
@{
The ParseMultipleString() function is used to parse a MultipleString byte array.

The FreeMultipleString() function frees the memory associated with a PARSED
MultipleString structure.  It is the responsibility of the ParseMultipleString()
caller to free the parsed MultipleString structure.
*/
DHL_RESULT ParseMultipleString (UINT8 *buffer, UINT16 len, multipleStringPtr_t *mStringPtr);
void FreeMultipleString (multipleStringPtr_t multipleStringPtr);
/*@}*/




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



#endif  /* __DLIB_PSIP_PARSER_H__ */