aboutsummaryrefslogtreecommitdiffstats
path: root/lib/include/libdvbv5/desc_isdbt_delivery.h
blob: 05e6d6e6a9dc0ea8efdab743f01ff879c7714f98 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/*
 * 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
 * as published by the Free Software Foundation version 2
 * of the License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 * Or, point your browser to http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 *
 * 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;
	struct dvb_desc *next;

	uint32_t *frequency;
	unsigned num_freqs;

	union {
		uint16_t bitfield;
		struct {
			uint16_t transmission_mode:2;
			uint16_t guard_interval:2;
			uint16_t area_code:12;
		} __attribute__((packed));
	} __attribute__((packed));
} __attribute__((packed));

struct dvb_v5_fe_parms;

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @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
}
#endif

#endif

Privacy Policy