• 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_language.h
23  * @ingroup descriptors
24  * @brief Provides the descriptors for the ISO639 language 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  * @par Bug Report
34  * Please submit bug reports and patches to linux-media@vger.kernel.org
35  */
36 
37 #ifndef _DESC_LANGUAGE_H
38 #define _DESC_LANGUAGE_H
39 
40 #include <libdvbv5/descriptors.h>
41 
42 /**
43  * @struct dvb_desc_language
44  * @ingroup descriptors
45  * @brief Structure containing the ISO639 language descriptor
46  *
47  * @param type			descriptor tag
48  * @param length		descriptor length
49  * @param next			pointer to struct dvb_desc
50  * @param language		ISO639 language string
51  * @param audio_type		audio type: 0 = undefined, 1 = clean effects,
52  *				2 = hearing impaired, 3 = visual impired
53  *				comentary, other values are reserved.
54  */
55 struct dvb_desc_language {
56 	uint8_t type;
57 	uint8_t length;
58 	struct dvb_desc *next;
59 
60 	unsigned char language[4];
61 	uint8_t audio_type;
62 } __attribute__((packed));
63 
64 struct dvb_v5_fe_parms;
65 
66 #ifdef __cplusplus
67 extern "C" {
68 #endif
69 
70 /**
71  * @brief Initializes and parses the language descriptor
72  * @ingroup descriptors
73  *
74  * @param parms	struct dvb_v5_fe_parms pointer to the opened device
75  * @param buf	buffer containing the descriptor's raw data
76  * @param desc	pointer to struct dvb_desc to be allocated and filled
77  *
78  * This function initializes and makes sure that all fields will follow the CPU
79  * endianness. Due to that, the content of the buffer may change.
80  *
81  * Currently, no memory is allocated internally.
82  *
83  * @return On success, it returns the size of the allocated struct.
84  *	   A negative value indicates an error.
85  */
86 int dvb_desc_language_init(struct dvb_v5_fe_parms *parms, const uint8_t *buf,
87 			   struct dvb_desc *desc);
88 
89 /**
90  * @brief Prints the content of the language descriptor
91  * @ingroup descriptors
92  *
93  * @param parms	struct dvb_v5_fe_parms pointer to the opened device
94  * @param desc	pointer to struct dvb_desc
95  */
96 void dvb_desc_language_print(struct dvb_v5_fe_parms *parms,
97 			     const struct dvb_desc *desc);
98 
99 #ifdef __cplusplus
100 }
101 #endif
102 
103 #endif
104