aboutsummaryrefslogtreecommitdiffstats
path: root/lib/include/libdvbv5/cat.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/include/libdvbv5/cat.h')
-rw-r--r--lib/include/libdvbv5/cat.h59
1 files changed, 56 insertions, 3 deletions
diff --git a/lib/include/libdvbv5/cat.h b/lib/include/libdvbv5/cat.h
index 134e3e5c..0b3375fe 100644
--- a/lib/include/libdvbv5/cat.h
+++ b/lib/include/libdvbv5/cat.h
@@ -18,6 +18,16 @@
*
*/
+/**
+ * @file cat.h
+ * @brief Provides the table parser for the CAT (Conditional Access Table)
+ * @copyright GNU General Public License version 2 (GPLv2)
+ * @author Andre Roth
+ *
+ * @par Bug Report
+ * Please submit bug reports and patches to linux-media@vger.kernel.org
+ */
+
#ifndef _CAT_H
#define _CAT_H
@@ -26,9 +36,22 @@
#include <libdvbv5/header.h>
+/**
+ * @def DVB_TABLE_CAT
+ * @brief ATSC CAT table ID
+ * @def DVB_TABLE_CAT_PID
+ * @brief ATSC PID table ID
+ */
#define DVB_TABLE_CAT 0x01
#define DVB_TABLE_CAT_PID 0x0001
+/**
+ * @struct dvb_table_cat
+ * @brief ATSC CAT table
+ *
+ * @param header struct dvb_table_header content
+ * @param descriptor pointer to struct dvb_desc
+ */
struct dvb_table_cat {
struct dvb_table_header header;
struct dvb_desc *descriptor;
@@ -40,9 +63,39 @@ struct dvb_v5_fe_parms;
extern "C" {
#endif
-ssize_t dvb_table_cat_init (struct dvb_v5_fe_parms *parms, const uint8_t *buf, ssize_t buflen, struct dvb_table_cat **table);
-void dvb_table_cat_free(struct dvb_table_cat *cat);
-void dvb_table_cat_print(struct dvb_v5_fe_parms *parms, struct dvb_table_cat *t);
+/**
+ * @brief Initializes and parses CAT table
+ *
+ * @param parms struct dvb_v5_fe_parms pointer to the opened device
+ * @param buf buffer containing the CAT raw data
+ * @param buflen length of the buffer
+ * @param table pointer to struct dvb_table_cat to be allocated and filled
+ *
+ * This function allocates an CAT table and fills the fields inside
+ * the struct. It also makes sure that all fields will follow the CPU
+ * endianness. Due to that, the content of the buffer may change.
+ *
+ * @return On success, it returns the size of the allocated struct.
+ * A negative value indicates an error.
+ */
+ssize_t dvb_table_cat_init(struct dvb_v5_fe_parms *parms, const uint8_t *buf,
+ ssize_t buflen, struct dvb_table_cat **table);
+
+/**
+ * @brief Frees all data allocated by the CAT table parser
+ *
+ * @param table pointer to struct dvb_table_cat to be freed
+ */
+void dvb_table_cat_free(struct dvb_table_cat *table);
+
+/**
+ * @brief Prints the content of the CAT table
+ *
+ * @param parms struct dvb_v5_fe_parms pointer to the opened device
+ * @param table pointe to struct dvb_table_cat
+ */
+void dvb_table_cat_print(struct dvb_v5_fe_parms *parms,
+ struct dvb_table_cat *table);
#ifdef __cplusplus
}

Privacy Policy