aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--doxygen_libdvbv5.cfg1
-rw-r--r--lib/include/libdvbv5/desc_terrestrial_delivery.h96
2 files changed, 95 insertions, 2 deletions
diff --git a/doxygen_libdvbv5.cfg b/doxygen_libdvbv5.cfg
index a2e5f514..f8ba50de 100644
--- a/doxygen_libdvbv5.cfg
+++ b/doxygen_libdvbv5.cfg
@@ -785,6 +785,7 @@ INPUT = $(SRCDIR)/doc/libdvbv5-index.doc \
$(SRCDIR)/lib/include/libdvbv5/desc_service.h \
$(SRCDIR)/lib/include/libdvbv5/desc_service_list.h \
$(SRCDIR)/lib/include/libdvbv5/desc_t2_delivery.h \
+ $(SRCDIR)/lib/include/libdvbv5/desc_terrestrial_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_terrestrial_delivery.h b/lib/include/libdvbv5/desc_terrestrial_delivery.h
index cd4e52c5..e7212be4 100644
--- a/lib/include/libdvbv5/desc_terrestrial_delivery.h
+++ b/lib/include/libdvbv5/desc_terrestrial_delivery.h
@@ -21,11 +21,48 @@
*
*/
+/**
+ * @file desc_terrestrial_delivery.h
+ * @ingroup descriptors
+ * @brief Provides the descriptors for the DVB-T terrestrial delivery system descriptor
+ * @copyright GNU General Public License version 2 (GPLv2)
+ * @author Mauro Carvalho Chehab
+ * @author Andre Roth
+ *
+ * @par Relevant specs
+ * The descriptor described herein is defined at:
+ * - ETSI EN 300 468 V1.11.1
+ *
+ * @par Bug Report
+ * Please submit bug reports and patches to linux-media@vger.kernel.org
+ */
+
#ifndef _TERRESTRIAL_DELIVERY_H
#define _TERRESTRIAL_DELIVERY_H
#include <libdvbv5/descriptors.h>
+/**
+ * @struct dvb_desc_terrestrial_delivery
+ * @ingroup descriptors
+ * @brief Structure containing the DVB-T terrestrial delivery system descriptor
+ *
+ * @param type descriptor tag
+ * @param length descriptor length
+ * @param next pointer to struct dvb_desc
+ * @param centre_frequency centre frequency, multiplied by 10 Hz
+ * @param bandwidth bandwidth
+ * @param priority priority (0 = LP, 1 = HP)
+ * @param time_slice_indicator time slicing indicator
+ * @param mpe_fec_indicator mpe fec indicator. If 1, MPE-FEC is not used.
+ * @param constellation constellation
+ * @param hierarchy_information hierarchy information
+ * @param code_rate_hp_stream code rate hp stream
+ * @param code_rate_lp_stream code rate lp stream
+ * @param guard_interval guard interval
+ * @param transmission_mode transmission mode
+ * @param other_frequency_flag other frequency flag
+ */
struct dvb_desc_terrestrial_delivery {
uint8_t type;
uint8_t length;
@@ -53,13 +90,68 @@ struct dvb_v5_fe_parms;
extern "C" {
#endif
-int dvb_desc_terrestrial_delivery_init (struct dvb_v5_fe_parms *parms, const uint8_t *buf, struct dvb_desc *desc);
-void dvb_desc_terrestrial_delivery_print(struct dvb_v5_fe_parms *parms, const struct dvb_desc *desc);
+/**
+ * @brief Initializes and parses the DVB-T terrestrial delivery system descriptor
+ *
+ * @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 initializes and makes sure that all fields will follow the CPU
+ * endianness. Due to that, the content of the buffer may change.
+ *
+ * Currently, no memory is allocated internally.
+ *
+ * @return On success, it returns the size of the allocated struct.
+ * A negative value indicates an error.
+ */
+int dvb_desc_terrestrial_delivery_init(struct dvb_v5_fe_parms *parms,
+ const uint8_t *buf,
+ struct dvb_desc *desc);
+
+/**
+ * @brief Prints the content of the DVB-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 dvb_desc_terrestrial_delivery_print(struct dvb_v5_fe_parms *parms,
+ const struct dvb_desc *desc);
+
+/**
+ * @brief converts from internal representation into bandwidth in Hz
+ */
extern const unsigned dvbt_bw[];
+
+/**
+ * @brief converts from the descriptor's modulation into enum fe_modulation,
+ * as defined by DVBv5 API.
+ */
extern const unsigned dvbt_modulation[];
+
+/**
+ * @brief converts from the descriptor's hierarchy into enum fe_hierarchy,
+ * as defined by DVBv5 API.
+ */
extern const unsigned dvbt_hierarchy[];
+
+/**
+ * @brief converts from the descriptor's FEC into enum fe_code_rate,
+ * as defined by DVBv5 API.
+ */
extern const unsigned dvbt_code_rate[];
+
+/**
+ * @brief converts from internal representation into enum fe_guard_interval,
+ * as defined at DVBv5 API.
+ */
extern const uint32_t dvbt_interval[];
+
+/**
+ * @brief converts from the descriptor's transmission mode into
+ * enum fe_transmit_mode, as defined by DVBv5 API.
+ */
extern const unsigned dvbt_transmission_mode[];
#ifdef __cplusplus

Privacy Policy