aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <m.chehab@samsung.com>2014-09-22 10:55:57 -0300
committerMauro Carvalho Chehab <m.chehab@samsung.com>2014-09-22 10:56:55 -0300
commit4d006bc412e457e0c6950850e7c7aa8aed566c4c (patch)
tree2e1316807d00db6debd15d807e98535bb6dab952
parent52a58427a64f53d82831c07bb773e59945bda6e4 (diff)
libdvbv5: Add documentation for ISDB-T terrestrial descriptor
Signed-off-by: Mauro Carvalho Chehab <m.chehab@samsung.com>
-rw-r--r--doxygen_libdvbv5.cfg1
-rw-r--r--lib/include/libdvbv5/desc_isdbt_delivery.h79
2 files changed, 77 insertions, 3 deletions
diff --git a/doxygen_libdvbv5.cfg b/doxygen_libdvbv5.cfg
index fd3ebfb1..db108883 100644
--- a/doxygen_libdvbv5.cfg
+++ b/doxygen_libdvbv5.cfg
@@ -776,6 +776,7 @@ INPUT = $(SRCDIR)/doc/libdvbv5-index.doc \
$(SRCDIR)/lib/include/libdvbv5/desc_extension.h \
$(SRCDIR)/lib/include/libdvbv5/desc_frequency_list.h \
$(SRCDIR)/lib/include/libdvbv5/desc_hierarchy.h \
+ $(SRCDIR)/lib/include/libdvbv5/desc_isdbt_delivery.h \
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
diff --git a/lib/include/libdvbv5/desc_isdbt_delivery.h b/lib/include/libdvbv5/desc_isdbt_delivery.h
index 5b6688ee..05e6d6e6 100644
--- a/lib/include/libdvbv5/desc_isdbt_delivery.h
+++ b/lib/include/libdvbv5/desc_isdbt_delivery.h
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2013 - Mauro Carvalho Chehab <m.chehab@samsung.com>
+ * Copyright (c) 2013-2014 - Mauro Carvalho Chehab <m.chehab@samsung.com>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@@ -19,11 +19,42 @@
* Described on ARIB STD-B10 as Terrestrial delivery system descriptor
*/
+/**
+ * @file desc_isdbt_delivery.h
+ * @ingroup descriptors
+ * @brief Provides the descriptors for the ISDB-T terrestrial delivery system
+ * @copyright GNU General Public License version 2 (GPLv2)
+ * @author Mauro Carvalho Chehab
+ *
+ * @par Relevant specs
+ * The descriptor described herein is defined at:
+ * - ARIB STD-B10
+ *
+ * @par Bug Report
+ * Please submit bug reports and patches to linux-media@vger.kernel.org
+ */
+
#ifndef _ISDBT_DELIVERY_H
#define _ISDBT_DELIVERY_H
#include <libdvbv5/descriptors.h>
+/**
+ * @struct isdbt_desc_terrestrial_delivery_system
+ * @ingroup descriptors
+ * @brief Struct containing the ISDB-T terrestrial delivery system
+ *
+ * @param type descriptor tag
+ * @param length descriptor length
+ * @param next pointer to struct dvb_desc
+ * @param area_code area code. The area code definition varies from
+ * Country to Country.
+ * @param guard_interval guard interval
+ * @param transmission_mode transmission mode
+ * @param frequency vector with center frequencies
+ * @param num_freqs number of frequencies at the
+ * isdbt_desc_terrestrial_delivery_system::frequency vector
+ */
struct isdbt_desc_terrestrial_delivery_system {
uint8_t type;
uint8_t length;
@@ -48,11 +79,53 @@ struct dvb_v5_fe_parms;
extern "C" {
#endif
-int isdbt_desc_delivery_init(struct dvb_v5_fe_parms *parms, const uint8_t *buf, struct dvb_desc *desc);
-void isdbt_desc_delivery_print(struct dvb_v5_fe_parms *parms, const struct dvb_desc *desc);
+/**
+ * @brief Initializes and parses the ISDB-T terrestrial delivery system
+ * descriptor
+ * @ingroup descriptors
+ *
+ * @param parms struct dvb_v5_fe_parms pointer to the opened device
+ * @param buf buffer containing the descriptor's raw data
+ * @param desc pointer to struct dvb_desc to be allocated and filled
+ *
+ * This function allocates a the descriptor 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.
+ */
+int isdbt_desc_delivery_init(struct dvb_v5_fe_parms *parms,
+ const uint8_t *buf, struct dvb_desc *desc);
+
+/**
+ * @brief Prints the content of the ISDB-T terrestrial delivery system
+ * descriptor
+ * @ingroup descriptors
+ *
+ * @param parms struct dvb_v5_fe_parms pointer to the opened device
+ * @param desc pointer to struct dvb_desc
+ */
+void isdbt_desc_delivery_print(struct dvb_v5_fe_parms *parms,
+ const struct dvb_desc *desc);
+
+/**
+ * @brief Frees all data allocated by the ISDB-T terrestrial delivery system
+ * descriptor
+ * @ingroup descriptors
+ *
+ * @param desc pointer to struct dvb_desc to be freed
+ */
void isdbt_desc_delivery_free(struct dvb_desc *desc);
+/**
+ * Converts an ISDB-T Interval code into a string
+ */
extern const uint32_t isdbt_interval[];
+
+/**
+ * Converts an ISDB-T mode into a string
+ */
extern const uint32_t isdbt_mode[];
#ifdef __cplusplus

Privacy Policy