• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2011-2014 - 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_event_extended.h
23  * @ingroup descriptors
24  * @brief Provides the descriptors for the extended event 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  * - ETSI EN 300 468 V1.11.1
32  *
33  * @par Bug Report
34  * Please submit bug reports and patches to linux-media@vger.kernel.org
35  */
36 
37 #ifndef _DESC_EVENT_EXTENDED_H
38 #define _DESC_EVENT_EXTENDED_H
39 
40 #include <libdvbv5/descriptors.h>
41 
42 struct dvb_desc_event_extended_item {
43 	char *description;
44 	char *description_emph;
45 	char *item;
46 	char *item_emph;
47 };
48 
49 /**
50  * @struct dvb_desc_event_extended
51  * @ingroup descriptors
52  * @brief Structure containing the extended event descriptor
53  *
54  * @param type			descriptor tag
55  * @param length		descriptor length
56  * @param next			pointer to struct dvb_desc
57  * @param id			descriptor number
58  * @param last_id		last descriptor number
59  * @param language		ISO 639 language code
60  * @param text			text string
61  * @param text_emph		text emphasis string
62  *
63  * @details
64  * The emphasis text is the one that uses asterisks. For example, in the text:
65  *	"the quick *fox* jumps over the lazy table" the emphasis would be "fox".
66  */
67 
68 struct dvb_desc_event_extended {
69 	uint8_t type;
70 	uint8_t length;
71 	struct dvb_desc *next;
72 
73 	union {
74 		struct {
75 			uint8_t last_id:4;
76 			uint8_t id:4;
77 		} __attribute__((packed));
78 		uint8_t ids;
79 	} __attribute__((packed));
80 
81 	unsigned char language[4];
82 	char *text;
83 	char *text_emph;
84 	struct dvb_desc_event_extended_item *items;
85 	int num_items;
86 } __attribute__((packed));
87 
88 struct dvb_v5_fe_parms;
89 
90 #ifdef __cplusplus
91 extern "C" {
92 #endif
93 
94 /**
95  * @brief Initializes and parses the extended event descriptor
96  * @ingroup descriptors
97  *
98  * @param parms	struct dvb_v5_fe_parms pointer to the opened device
99  * @param buf	buffer containing the descriptor's raw data
100  * @param desc	pointer to struct dvb_desc to be allocated and filled
101  *
102  * This function allocates a the descriptor and fills the fields inside
103  * the struct. It also makes sure that all fields will follow the CPU
104  * endianness. Due to that, the content of the buffer may change.
105  *
106  * @return On success, it returns the size of the allocated struct.
107  *	   A negative value indicates an error.
108  */
109 int dvb_desc_event_extended_init(struct dvb_v5_fe_parms *parms,
110 				 const uint8_t *buf, struct dvb_desc *desc);
111 
112 /**
113  * @brief Prints the content of the extended event descriptor
114  * @ingroup descriptors
115  *
116  * @param parms	struct dvb_v5_fe_parms pointer to the opened device
117  * @param desc	pointer to struct dvb_desc
118  */
119 void dvb_desc_event_extended_print(struct dvb_v5_fe_parms *parms,
120 				   const struct dvb_desc *desc);
121 
122 /**
123  * @brief Frees all data allocated by the extended event descriptor
124  * @ingroup descriptors
125  *
126  * @param desc pointer to struct dvb_desc to be freed
127  */
128 void dvb_desc_event_extended_free(struct dvb_desc *desc);
129 
130 #ifdef __cplusplus
131 }
132 #endif
133 
134 #endif
135