• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2011-2012 - Mauro Carvalho Chehab
3  * Copyright (c) 2012 - Andre Roth <neolynx@gmail.com>
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU Lesser General Public License as published by
7  * the Free Software Foundation version 2.1 of the License.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  * Or, point your browser to http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
18  *
19  */
20 
21 /**
22  * @file desc_hierarchy.h
23  * @ingroup descriptors
24  * @brief Provides the descriptors for the hierarchy descriptor
25  * @copyright GNU Lesser General Public License version 2.1 (LGPLv2.1)
26  * @author Mauro Carvalho Chehab
27  * @author Andre Roth
28  *
29  * @par Relevant specs
30  * The descriptor described herein is defined at:
31  * - ISO/IEC 13818-1
32  *
33  * @see
34  *
35  * @par Bug Report
36  * Please submit bug reports and patches to linux-media@vger.kernel.org
37  */
38 
39 #ifndef _HIERARCHY_H
40 #define _HIERARCHY_H
41 
42 #include <libdvbv5/descriptors.h>
43 
44 /**
45  * @struct dvb_desc_hierarchy
46  * @ingroup descriptors
47  * @brief Structure containing the hierarchy descriptor
48  *
49  * @param type			descriptor tag
50  * @param length		descriptor length
51  * @param next			pointer to struct dvb_desc
52  * @param hierarchy_type	hierarchy type
53  * @param layer			hierarchy layer index
54  * @param embedded_layer	hierarchy embedded layer  index
55  * @param channel		hierarchy channel
56  */
57 struct dvb_desc_hierarchy {
58 	uint8_t type;
59 	uint8_t length;
60 	struct dvb_desc *next;
61 
62 	uint8_t hierarchy_type:4;
63 	uint8_t reserved:4;
64 
65 	uint8_t layer:6;
66 	uint8_t reserved2:2;
67 
68 	uint8_t embedded_layer:6;
69 	uint8_t reserved3:2;
70 
71 	uint8_t channel:6;
72 	uint8_t reserved4:2;
73 } __attribute__((packed));
74 
75 struct dvb_v5_fe_parms;
76 
77 #ifdef __cplusplus
78 extern "C" {
79 #endif
80 
81 /**
82  * @brief Initializes and parses the hierarchy descriptor
83  * @ingroup descriptors
84  *
85  * @param parms	struct dvb_v5_fe_parms pointer to the opened device
86  * @param buf	buffer containing the descriptor's raw data
87  * @param desc	pointer to struct dvb_desc to be allocated and filled
88  *
89  * This function initializes and makes sure that all fields will follow the CPU
90  * endianness. Due to that, the content of the buffer may change.
91  *
92  * Currently, no memory is allocated internally.
93  *
94  * @return On success, it returns the size of the allocated struct.
95  *	   A negative value indicates an error.
96  */
97 int dvb_desc_hierarchy_init (struct dvb_v5_fe_parms *parms,
98 			     const uint8_t *buf, struct dvb_desc *desc);
99 
100 /**
101  * @brief Prints the content of the hierarchy descriptor
102  * @ingroup descriptors
103  *
104  * @param parms	struct dvb_v5_fe_parms pointer to the opened device
105  * @param desc	pointer to struct dvb_desc
106  */
107 void dvb_desc_hierarchy_print(struct dvb_v5_fe_parms *parms,
108 			      const struct dvb_desc *desc);
109 
110 #ifdef __cplusplus
111 }
112 #endif
113 
114 #endif
115