Commit 89570ee7 authored by Jean-Paul Saman's avatar Jean-Paul Saman

Documentation fixes.

parent d3b5bbb6
...@@ -4,7 +4,7 @@ Changes between 0.2.2 and 1.0.0: ...@@ -4,7 +4,7 @@ Changes between 0.2.2 and 1.0.0:
* new example application dvbinfo * new example application dvbinfo
* updated documentation (new api howto) * updated documentation (new api howto)
* add log callback (remove fprintf's) * add log callback (remove fprintf's)
* make API more consistent * make API more consistent, see doxygen "howto-new-api" section for converting your code:
- introduces dvbpsi_t typedef - introduces dvbpsi_t typedef
- removed dvbpis_handle - removed dvbpis_handle
* EIT table generation * EIT table generation
......
...@@ -26,18 +26,24 @@ describes how to use it and the "C" API.</p> ...@@ -26,18 +26,24 @@ describes how to use it and the "C" API.</p>
<p>libdvbpsi was originally released under the GPLv2 and later relicensed under the LGPLv2. All versions prior to version 0.2.0 are GPLv2, versions 0.2.0 and later are LGPLv2.1.<p> <p>libdvbpsi was originally released under the GPLv2 and later relicensed under the LGPLv2. All versions prior to version 0.2.0 are GPLv2, versions 0.2.0 and later are LGPLv2.1.<p>
<h2>Tables and Descriptors</h2> <h2>Tables and Descriptors</h2>
<p>libdvbpsi supports the following PSI tables and many descriptors regularly found in MPEG/DVB Transport streams</p> <p>libdvbpsi supports the following PSI tables and many descriptors regularly found in MPEG/DVB/ATSC Transport streams</p>
<ul> <ul>
<li>Bouquet Association Table (<em>BAT</em>)</li> <li>Bouquet Association Table (<em>BAT</em>)</li>
<li>Conditional Access Table (<em>CAT</em>)</li> <li>Conditional Access Table (<em>CAT</em>)</li>
<li>EPG Information Table (<em>EIT</em>)</li> <li>Event Information Table (<em>EIT</em>)</li>
<li>Network Information Table (<em>NIT</em>)</li> <li>Network Information Table (<em>NIT</em>)</li>
<li>Program Association Table (<em>PAT</em>)</li> <li>Program Association Table (<em>PAT</em>)</li>
<li>Program Map Table (<em>PMT</em>)</li> <li>Program Map Table (<em>PMT</em>)</li>
<li>Running Status Table(<em>RST</em></li>
<li>Section Description Table (<em>SDT</em>)</li> <li>Section Description Table (<em>SDT</em>)</li>
<li>Splice Information Section Table (<em>SIS</em>)</li> <li>Splice Information Section Table (<em>SIS</em>)</li>
<li>TOT/TDT Table (<em>TOT</em>)</li> <li>TOT/TDT Table (<em>TOT</em>)</li>
<li>PSIP Event Information Table(<em>ATSC EIT</em>)</li>
<li>PSIP Extended Text Table(<em>ATSC ETT</em>)</li>
<li>PSIP Master Guide Table(<em>ATSC MGT</em>)</li>
<li>PSIP System Time Table(<em>ATSC STT</em>)</li>
<li>PSIP Virtual Channel Table(<em>ATSC VCT</em>)</li>
</ul> </ul>
<h2>Usage</h2> <h2>Usage</h2>
......
...@@ -20,6 +20,13 @@ dr_13.h ...@@ -20,6 +20,13 @@ dr_13.h
Decode Carousel id Descriptor. Decode Carousel id Descriptor.
*/ */
/*!
* \file dr_13.h
* \author Adam Charrett
* \brief Decode Carousel id Descriptor.
*/
#ifndef _DR_13_H #ifndef _DR_13_H
#define _DR_13_H #define _DR_13_H
......
...@@ -20,6 +20,13 @@ dr_14.h ...@@ -20,6 +20,13 @@ dr_14.h
Decode Association Tag Descriptor. Decode Association Tag Descriptor.
*/ */
/*!
* \file dr_14.h
* \author Adam Charrett
* \brief Decode Association Tag Descriptor.
*/
#ifndef _DR_14_H #ifndef _DR_14_H
#define _DR_14_H #define _DR_14_H
......
...@@ -21,6 +21,12 @@ Decode Frequency List Descriptor. ...@@ -21,6 +21,12 @@ Decode Frequency List Descriptor.
*/ */
/*!
* \file dr_62.h
* \author Adam Charrett
* \brief Decode Frequency List Descriptor.
*/
#ifndef _DR_62_H #ifndef _DR_62_H
#define _DR_62_H #define _DR_62_H
......
...@@ -20,6 +20,13 @@ dr_66.h ...@@ -20,6 +20,13 @@ dr_66.h
Decode Data Broadcast id Descriptor. Decode Data Broadcast id Descriptor.
*/ */
/*!
* \file dr_66.h
* \author Adam Charrett
* \brief Decode Data Broadcast id Descriptor.
*/
#ifndef _DR_66_H #ifndef _DR_66_H
#define _DR_66_H #define _DR_66_H
......
...@@ -21,6 +21,12 @@ Decode Default Authority Descriptor. ...@@ -21,6 +21,12 @@ Decode Default Authority Descriptor.
*/ */
/*!
* \file dr_73.h
* \author Adam Charrett
* \brief Decode Default Authority Descriptor.
*/
#ifndef _DR_73_H #ifndef _DR_73_H
#define _DR_73_H #define _DR_73_H
......
...@@ -21,6 +21,12 @@ Decode Content Identifier Descriptor. ...@@ -21,6 +21,12 @@ Decode Content Identifier Descriptor.
*/ */
/*!
* \file dr_76.h
* \author Adam Charrett
* \brief Decode Content Identifier Descriptor
*/
#ifndef _DR_76_H #ifndef _DR_76_H
#define _DR_76_H #define _DR_76_H
......
...@@ -46,126 +46,67 @@ extern "C" { ...@@ -46,126 +46,67 @@ extern "C" {
*/ */
/*! /*!
* \typedef enum dvbpsi_aac_profile_and_level_s dvbpsi_aac_profile_and_level_t * \typedef enum dvbpsi_aac_profile_and_level_s dvbpsi_aac_profile_and_level_t
* \brief AAC profile and level as specified in ISO/IEC 13818-1:2007 table 2.71 * \brief AAC profile and level as specified in ISO/IEC 13818-1:2007 table 2.71.
value description
===== ===========
0x00-0x0F Reserved
0x10 Main profile, level 1
0x11 Main profile, level 2
0x12 Main profile, level 3
0x13 Main profile, level 4
0x14-0x17 Reserved
0x18 Scalable Profile, level 1
0x19 Scalable Profile, level 2
0x1A Scalable Profile, level 3
0x1B Scalable Profile, level 4
0x1C-0x1F Reserved
0x20 Speech profile, level 1
0x21 Speech profile, level 2
0x22-0x27 Reserved
0x28 Synthesis profile, level 1
0x29 Synthesis profile, level 2
0x2A Synthesis profile, level 3
0x2B-0x2F Reserved
0x30 High quality audio profile, level 1
0x31 High quality audio profile, level 2
0x32 High quality audio profile, level 3
0x33 High quality audio profile, level 4
0x34 High quality audio profile, level 5
0x35 High quality audio profile, level 6
0x36 High quality audio profile, level 7
0x37 High quality audio profile, level 8
0x38 Low delay audio profile, level 1
0x39 Low delay audio profile, level 2
0x3A Low delay audio profile, level 3
0x3B Low delay audio profile, level 4
0x3C Low delay audio profile, level 5
0x3D Low delay audio profile, level 6
0x3E Low delay audio profile, level 7
0x3F Low delay audio profile, level 8
0x40 Natural audio profile, level 1
0x41 Natural audio profile, level 2
0x42 Natural audio profile, level 3
0x43 Natural audio profile, level 4
0x44-0x47 Reserved
0x48 Mobile audio internetworking profile, level 1
0x49 Mobile audio internetworking profile, level 2
0x4A Mobile audio internetworking profile, level 3
0x4B Mobile audio internetworking profile, level 4
0x4C Mobile audio internetworking profile, level 5
0x4D Mobile audio internetworking profile, level 6
0x4E-0x4F Reserved
0x50 AAC profile, level 1
0x51 AAC profile, level 2
0x52 AAC profile, level 4
0x53 AAC profile, level 5
0x54-0x57 Reserved
0x58 High efficiency AAC profile, level 2
0x59 High efficiency AAC profile, level 3
0x5A High efficiency AAC profile, level 4
0x5B High efficiency AAC profile, level 5
0x5C-0xFF Reserved
*/ */
typedef enum dvbpsi_aac_profile_and_level_s typedef enum dvbpsi_aac_profile_and_level_s
{ {
DVBPSI_AAC_PROFILE_RESERVED = 0x00, /* 0x00-0x0F Reserved */ DVBPSI_AAC_PROFILE_RESERVED = 0x00, /*!< 0x00-0x0F Reserved */
DVBPSI_AAC_PROFILE_MAIN_LEVEL_1 = 0x10, DVBPSI_AAC_PROFILE_MAIN_LEVEL_1 = 0x10, /*!< Main profile, level 1 */
DVBPSI_AAC_PROFILE_MAIN_LEVEL_2 = 0x11, DVBPSI_AAC_PROFILE_MAIN_LEVEL_2 = 0x11, /*!< Main profile, level 2 */
DVBPSI_AAC_PROFILE_MAIN_LEVEL_3 = 0x12, DVBPSI_AAC_PROFILE_MAIN_LEVEL_3 = 0x12, /*!< Main profile, level 3 */
DVBPSI_AAC_PROFILE_MAIN_LEVEL_4 = 0x13, DVBPSI_AAC_PROFILE_MAIN_LEVEL_4 = 0x13, /*!< Main profile, level 4 */
/* 0x14-0x17 Reserved */ /** 0x14-0x17 Reserved */
DVBPSI_AAC_PROFILE_SCALABLE_LEVEL_1 = 0x18, DVBPSI_AAC_PROFILE_SCALABLE_LEVEL_1 = 0x18, /*!< Scalable Profile, level 1 */
DVBPSI_AAC_PROFILE_SCALABLE_LEVEL_2 = 0x19, DVBPSI_AAC_PROFILE_SCALABLE_LEVEL_2 = 0x19, /*!< Scalable Profile, level 2 */
DVBPSI_AAC_PROFILE_SCALABLE_LEVEL_3 = 0x1A, DVBPSI_AAC_PROFILE_SCALABLE_LEVEL_3 = 0x1A, /*!< Scalable Profile, level 3 */
DVBPSI_AAC_PROFILE_SCALABLE_LEVEL_4 = 0x1B, DVBPSI_AAC_PROFILE_SCALABLE_LEVEL_4 = 0x1B, /*!< Scalable Profile, level 4 */
/* 0x1C-0x1F Reserved */ /** 0x1C-0x1F Reserved */
DVBPSI_AAC_PROFILE_SPEECH_LEVEL_1 = 0x20, DVBPSI_AAC_PROFILE_SPEECH_LEVEL_1 = 0x20, /*!< Speech profile, level 1 */
DVBPSI_AAC_PROFILE_SPEECH_LEVEL_2 = 0x21, DVBPSI_AAC_PROFILE_SPEECH_LEVEL_2 = 0x21, /*!< Speech profile, level 2 */
/* 0x22-0x27 Reserved */ /** 0x22-0x27 Reserved */
DVBPSI_AAC_PROFILE_SYNTHESIS_LEVEL_1 = 0x28, DVBPSI_AAC_PROFILE_SYNTHESIS_LEVEL_1 = 0x28, /*!< Synthesis profile, level 1 */
DVBPSI_AAC_PROFILE_SYNTHESIS_LEVEL_2 = 0x29, DVBPSI_AAC_PROFILE_SYNTHESIS_LEVEL_2 = 0x29, /*!< Synthesis profile, level 2 */
DVBPSI_AAC_PROFILE_SYNTHESIS_LEVEL_3 = 0x2A, DVBPSI_AAC_PROFILE_SYNTHESIS_LEVEL_3 = 0x2A, /*!< Synthesis profile, level 3 */
/* 0x2B-0x2F Reserved */ /** 0x2B-0x2F Reserved */
DVBPSI_AAC_PROFILE_HQ_LEVEL_1 = 0x30, DVBPSI_AAC_PROFILE_HQ_LEVEL_1 = 0x30, /*!< High quality audio profile, level 1 */
DVBPSI_AAC_PROFILE_HQ_LEVEL_2 = 0x31, DVBPSI_AAC_PROFILE_HQ_LEVEL_2 = 0x31, /*!< High quality audio profile, level 2 */
DVBPSI_AAC_PROFILE_HQ_LEVEL_3 = 0x32, DVBPSI_AAC_PROFILE_HQ_LEVEL_3 = 0x32, /*!< High quality audio profile, level 3 */
DVBPSI_AAC_PROFILE_HQ_LEVEL_4 = 0x33, DVBPSI_AAC_PROFILE_HQ_LEVEL_4 = 0x33, /*!< High quality audio profile, level 4 */
DVBPSI_AAC_PROFILE_HQ_LEVEL_5 = 0x34, DVBPSI_AAC_PROFILE_HQ_LEVEL_5 = 0x34, /*!< High quality audio profile, level 5 */
DVBPSI_AAC_PROFILE_HQ_LEVEL_6 = 0x35, DVBPSI_AAC_PROFILE_HQ_LEVEL_6 = 0x35, /*!< High quality audio profile, level 6 */
DVBPSI_AAC_PROFILE_HQ_LEVEL_7 = 0x36, DVBPSI_AAC_PROFILE_HQ_LEVEL_7 = 0x36, /*!< High quality audio profile, level 7 */
DVBPSI_AAC_PROFILE_HQ_LEVEL_8 = 0x37, DVBPSI_AAC_PROFILE_HQ_LEVEL_8 = 0x37, /*!< High quality audio profile, level 8 */
DVBPSI_AAC_PROFILE_LOW_DELAY_LEVEL_1 = 0x38, DVBPSI_AAC_PROFILE_LOW_DELAY_LEVEL_1 = 0x38, /*!< Low delay audio profile, level 1 */
DVBPSI_AAC_PROFILE_LOW_DELAY_LEVEL_2 = 0x39, DVBPSI_AAC_PROFILE_LOW_DELAY_LEVEL_2 = 0x39, /*!< Low delay audio profile, level 2 */
DVBPSI_AAC_PROFILE_LOW_DELAY_LEVEL_3 = 0x3A, DVBPSI_AAC_PROFILE_LOW_DELAY_LEVEL_3 = 0x3A, /*!< Low delay audio profile, level 3 */
DVBPSI_AAC_PROFILE_LOW_DELAY_LEVEL_4 = 0x3B, DVBPSI_AAC_PROFILE_LOW_DELAY_LEVEL_4 = 0x3B, /*!< Low delay audio profile, level 4 */
DVBPSI_AAC_PROFILE_LOW_DELAY_LEVEL_5 = 0x3C, DVBPSI_AAC_PROFILE_LOW_DELAY_LEVEL_5 = 0x3C, /*!< Low delay audio profile, level 5 */
DVBPSI_AAC_PROFILE_LOW_DELAY_LEVEL_6 = 0x3D, DVBPSI_AAC_PROFILE_LOW_DELAY_LEVEL_6 = 0x3D, /*!< Low delay audio profile, level 6 */
DVBPSI_AAC_PROFILE_LOW_DELAY_LEVEL_7 = 0x3E, DVBPSI_AAC_PROFILE_LOW_DELAY_LEVEL_7 = 0x3E, /*!< Low delay audio profile, level 7 */
DVBPSI_AAC_PROFILE_LOW_DELAY_LEVEL_8 = 0x3F, DVBPSI_AAC_PROFILE_LOW_DELAY_LEVEL_8 = 0x3F, /*!< Low delay audio profile, level 8 */
DVBPSI_AAC_PROFILE_NATURAL_LEVEL_1 = 0x40, DVBPSI_AAC_PROFILE_NATURAL_LEVEL_1 = 0x40, /*!< Natural audio profile, level 1 */
DVBPSI_AAC_PROFILE_NATURAL_LEVEL_2 = 0x41, DVBPSI_AAC_PROFILE_NATURAL_LEVEL_2 = 0x41, /*!< Natural audio profile, level 2 */
DVBPSI_AAC_PROFILE_NATURAL_LEVEL_3 = 0x42, DVBPSI_AAC_PROFILE_NATURAL_LEVEL_3 = 0x42, /*!< Natural audio profile, level 3 */
DVBPSI_AAC_PROFILE_NATURAL_LEVEL_4 = 0x43, DVBPSI_AAC_PROFILE_NATURAL_LEVEL_4 = 0x43, /*!< Natural audio profile, level 4 */
/* 0x44-0x47 Reserved */ /** 0x44-0x47 Reserved */
DVBPSI_AAC_PROFILE_MOBILE_LEVEL_1 = 0x48, DVBPSI_AAC_PROFILE_MOBILE_LEVEL_1 = 0x48, /*!< Mobile audio internetworking profile, level 1 */
DVBPSI_AAC_PROFILE_MOBILE_LEVEL_2 = 0x49, DVBPSI_AAC_PROFILE_MOBILE_LEVEL_2 = 0x49, /*!< Mobile audio internetworking profile, level 2 */
DVBPSI_AAC_PROFILE_MOBILE_LEVEL_3 = 0x4A, DVBPSI_AAC_PROFILE_MOBILE_LEVEL_3 = 0x4A, /*!< Mobile audio internetworking profile, level 3 */
DVBPSI_AAC_PROFILE_MOBILE_LEVEL_4 = 0x4B, DVBPSI_AAC_PROFILE_MOBILE_LEVEL_4 = 0x4B, /*!< Mobile audio internetworking profile, level 4 */
DVBPSI_AAC_PROFILE_MOBILE_LEVEL_5 = 0x4C, DVBPSI_AAC_PROFILE_MOBILE_LEVEL_5 = 0x4C, /*!< Mobile audio internetworking profile, level 5 */
DVBPSI_AAC_PROFILE_MOBILE_LEVEL_6 = 0x4D, DVBPSI_AAC_PROFILE_MOBILE_LEVEL_6 = 0x4D, /*!< Mobile audio internetworking profile, level 6 */
/* 0x4E-0x4F Reserved */ /** 0x4E-0x4F Reserved */
DVBPSI_AAC_PROFILE_LEVEL_1 = 0x50, DVBPSI_AAC_PROFILE_LEVEL_1 = 0x50, /*!< AAC profile, level 1 */
DVBPSI_AAC_PROFILE_LEVEL_2 = 0x51, DVBPSI_AAC_PROFILE_LEVEL_2 = 0x51, /*!< AAC profile, level 2 */
DVBPSI_AAC_PROFILE_LEVEL_4 = 0x52, DVBPSI_AAC_PROFILE_LEVEL_4 = 0x52, /*!< AAC profile, level 4 */
DVBPSI_AAC_PROFILE_LEVEL_5 = 0x53, DVBPSI_AAC_PROFILE_LEVEL_5 = 0x53, /*!< AAC profile, level 5 */
/* 0x54-0x57 RESERVED */ /** 0x54-0x57 RESERVED */
DVBPSI_HE_AAC_PROFILE_LEVEL_2 = 0x58, DVBPSI_HE_AAC_PROFILE_LEVEL_2 = 0x58, /*!< High efficiency AAC profile, level 2 */
DVBPSI_HE_AAC_PROFILE_LEVEL_3 = 0x59, DVBPSI_HE_AAC_PROFILE_LEVEL_3 = 0x59, /*!< High efficiency AAC profile, level 3 */
DVBPSI_HE_AAC_PROFILE_LEVEL_4 = 0x5A, DVBPSI_HE_AAC_PROFILE_LEVEL_4 = 0x5A, /*!< High efficiency AAC profile, level 4 */
DVBPSI_HE_AAC_PROFILE_LEVEL_5 = 0x5B DVBPSI_HE_AAC_PROFILE_LEVEL_5 = 0x5B /*!< High efficiency AAC profile, level 5 */
/* 0x5C-0xFF RESERVED */ /** 0x5C-0xFF RESERVED */
} dvbpsi_aac_profile_and_level_t; } dvbpsi_aac_profile_and_level_t;
/*! /*!
...@@ -178,31 +119,7 @@ typedef enum dvbpsi_aac_profile_and_level_s ...@@ -178,31 +119,7 @@ typedef enum dvbpsi_aac_profile_and_level_s
/*! /*!
* \typedef enum dvbpsi_aac_type_s dvbpsi_aac_type_t * \typedef enum dvbpsi_aac_type_s dvbpsi_aac_type_t
* \brief AAC type information as descripted in table 26, page 41 where column * \brief AAC type information as descripted in table 26, page 41 where column
* 'stream_content' has value 0x06. The following values are excepted: * 'stream_content' has value 0x06.
type description
==== ======================
0x00 reserved for future use
0x01 HE-AAC audio, single mono channel
0x02 reserved for future use
0x03 HE-AAC audio, stereo
0x04 reserved for future use
0x05 HE-AAC audio, surround sound
0x06 to 0x3F reserved for future use
0x40 HE-AAC audio description for the visually impaired
0x41 HE-AAC audio for the hard of hearing
0x42 HE-AAC receiver-mixed supplementary audio as per annex E of TS 101 154
0x43 HE-AAC v2 audio, stereo
0x44 HE-AAC v2 audio description for the visually impaired
0x45 HE-AAC v2 audio for the hard of hearing
0x46 HE-AAC v2 receiver-mixed supplementary audio as per annex E of TS 101 154
0x47 HE-AAC receiver mix audio description for the visually impaired
0x48 HE-AAC broadcaster mix audio description for the visually impaired
0x49 HE-AAC v2 receiver mix audio description for the visually impaired
0x4A HE-AAC v2 broadcaster mix audio description for the visually impaired
0x4B to 0xAF reserved for future use
0xB0 to 0xFE user-defined
0xFF reserved for future use
*/ */
typedef enum dvbpsi_aac_type_s typedef enum dvbpsi_aac_type_s
{ {
...@@ -232,8 +149,8 @@ typedef enum dvbpsi_aac_type_s ...@@ -232,8 +149,8 @@ typedef enum dvbpsi_aac_type_s
description for the visually impaired */ description for the visually impaired */
DVBPSI_HE_AAC_V2_BROADCAST_MIXED_IMPAIRED = 0x4A, /*!< HE-AAC v2 broadcaster DVBPSI_HE_AAC_V2_BROADCAST_MIXED_IMPAIRED = 0x4A, /*!< HE-AAC v2 broadcaster
mix audio description for the visually impaired */ mix audio description for the visually impaired */
DVBPSI_AAC_RESERVED4 = 0x4B, /*!< to 0xAF reserved for future use */ DVBPSI_AAC_RESERVED4 = 0x4B, /*!< 0x4B to 0xAF reserved for future use */
DVBPSI_AAC_USER = 0xB0, /*!< to 0xFE user-defined */ DVBPSI_AAC_USER = 0xB0, /*!< 0xB0 to 0xFE user-defined */
DVBPSI_AAC_RESERVED5 = 0xFF /*!< reserved for future use */ DVBPSI_AAC_RESERVED5 = 0xFF /*!< reserved for future use */
} dvbpsi_aac_type_t; } dvbpsi_aac_type_t;
......
...@@ -21,6 +21,12 @@ Decode Logical Channel Number Descriptor. ...@@ -21,6 +21,12 @@ Decode Logical Channel Number Descriptor.
*/ */
/*!
* \file dr_83.h
* \author Adam Charrett
* \brief Decode Logical Channel Number Descriptor.
*/
#ifndef _DR_83_H #ifndef _DR_83_H
#define _DR_83_H #define _DR_83_H
......
...@@ -17,9 +17,14 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA ...@@ -17,9 +17,14 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
eit.h eit.h
Decode PSIP Event Information Table.
*/ */
/*!
* \file atsc_eit.h
* \author Adam Charrett
* \brief Decode PSIP Event Information Table (ATSC EIT).
*/
#ifndef _ATSC_EIT_H #ifndef _ATSC_EIT_H
#define _ATSC_EIT_H #define _ATSC_EIT_H
...@@ -32,7 +37,7 @@ extern "C" { ...@@ -32,7 +37,7 @@ extern "C" {
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \struct dvbpsi_atsc_eit_event_s * \struct dvbpsi_atsc_eit_event_s
* \brief EIT Event structure. * \brief ATSC EIT Event structure.
* *
* This structure is used to store decoded event information. * This structure is used to store decoded event information.
*/ */
...@@ -60,7 +65,7 @@ typedef struct dvbpsi_atsc_eit_event_s ...@@ -60,7 +65,7 @@ typedef struct dvbpsi_atsc_eit_event_s
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \struct dvbpsi_atsc_eit_s * \struct dvbpsi_atsc_eit_s
* \brief EIT structure. * \brief ATSC EIT structure.
* *
* This structure is used to store a decoded EIT. * This structure is used to store a decoded EIT.
*/ */
......
...@@ -17,9 +17,14 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA ...@@ -17,9 +17,14 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
ett.h ett.h
Decode PSIP Extended Text Table.
*/ */
/*!
* \file atsc_ett.h
* \author Adam Charrett
* \brief Decode PSIP Extented Text Table (ATSC ETT).
*/
#ifndef _ATSC_ETT_H #ifndef _ATSC_ETT_H
#define _ATSC_ETT_H #define _ATSC_ETT_H
...@@ -32,7 +37,7 @@ extern "C" { ...@@ -32,7 +37,7 @@ extern "C" {
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \struct dvbpsi_atsc_ett_s * \struct dvbpsi_atsc_ett_s
* \brief ETT structure. * \brief ATSC ETT structure.
* *
* The Extended Text Table (ETT) contains Extended Text Message (ETM) streams. They * The Extended Text Table (ETT) contains Extended Text Message (ETM) streams. They
* provide detailed descriptions of virtual channels (channel ETM) and (event ETM). * provide detailed descriptions of virtual channels (channel ETM) and (event ETM).
......
...@@ -21,6 +21,13 @@ mgt.h ...@@ -21,6 +21,13 @@ mgt.h
Decode PSIP Master Guide Table. Decode PSIP Master Guide Table.
*/ */
/*!
* \file atsc_mgt.h
* \author Adam Charrett and Michael Krufky
* \brief Decode PSIP Master Guide Table (ATSC MGT).
*/
#ifndef _ATSC_MGT_H #ifndef _ATSC_MGT_H
#define _ATSC_MGT_H #define _ATSC_MGT_H
......
...@@ -17,9 +17,14 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA ...@@ -17,9 +17,14 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
stt.h stt.h
Decode PSIP System Time Table.
*/ */
/*!
* \file atsc_stt.h
* \author Adam Charrett
* \brief Decode PSIP System Time Table (ATSC STT).
*/
#ifndef _ATSC_STT_H #ifndef _ATSC_STT_H
#define _ATSC_STT_H #define _ATSC_STT_H
......
...@@ -20,6 +20,13 @@ vct.h ...@@ -20,6 +20,13 @@ vct.h
Decode PSIP Virtual Channel Table. Decode PSIP Virtual Channel Table.
*/ */
/*!
* \file atsc_vct.h
* \author Adam Charrett
* \brief Decode PSIP Virtual Channel Table. (ATSC VCT).
*/
#ifndef _ATSC_VCT_H #ifndef _ATSC_VCT_H
#define _ATSC_VCT_H #define _ATSC_VCT_H
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment